src/Client.php

   1 <?php
   2
   3 namespace PhpXmlRpc;
   4
   5 use PhpXmlRpc\Helper\Logger;
   6
   7 /**
   8  * Used to represent a client of an XML-RPC server.
   9  */
  10 class Client
  11 {
  12     /// @todo: do these need to be public?
  13     public $method = 'http';
  14     public $server;
  15     public $port = 0;
  16     public $path;
  17
  18     public $errno;
  19     public $errstr;
  20     public $debug = 0;
  21
  22     public $username = '';
  23     public $password = '';
  24     public $authtype = 1;
  25
  26     public $cert = '';
  27     public $certpass = '';
  28     public $cacert = '';
  29     public $cacertdir = '';
  30     public $key = '';
  31     public $keypass = '';
  32     public $verifypeer = true;
  33     public $verifyhost = 2;
  34     public $sslversion = 0; // corresponds to CURL_SSLVERSION_DEFAULT
  35
  36     public $proxy = '';
  37     public $proxyport = 0;
  38     public $proxy_user = '';
  39     public $proxy_pass = '';
  40     public $proxy_authtype = 1;
  41
  42     public $cookies = array();
  43     public $extracurlopts = array();
  44
  45     /**
  46      * @var bool
  47      *
  48      * This determines whether the multicall() method will try to take advantage of the system.multicall xmlrpc method
  49      * to dispatch to the server an array of requests in a single http roundtrip or simply execute many consecutive http
  50      * calls. Defaults to FALSE, but it will be enabled automatically on the first failure of execution of
  51      * system.multicall.
  52      */
  53     public $no_multicall = false;
  54
  55     /**
  56      * List of http compression methods accepted by the client for responses.
  57      * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib.
  58      *
  59      * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since
  60      * in those cases it will be up to CURL to decide the compression methods
  61      * it supports. You might check for the presence of 'zlib' in the output of
  62      * curl_version() to determine wheter compression is supported or not
  63      */
  64     public $accepted_compression = array();
  65
  66     /**
  67      * Name of compression scheme to be used for sending requests.
  68      * Either null, gzip or deflate.
  69      */
  70
  71     public $request_compression = '';
  72     /**
  73      * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
  74      * http://curl.haxx.se/docs/faq.html#7.3).
  75      */
  76     public $xmlrpc_curl_handle = null;
  77
  78     /// Whether to use persistent connections for http 1.1 and https
  79     public $keepalive = false;
  80
  81     /// Charset encodings that can be decoded without problems by the client
  82     public $accepted_charset_encodings = array();
  83
  84     /**
  85      * The charset encoding that will be used for serializing request sent by the client.
  86      * It defaults to NULL, which means using US-ASCII and encoding all characters outside of the ASCII range using
  87      * their xml character entity representation (this has the benefit that line end characters will not be mangled in
  88      * the transfer, a CR-LF will be preserved as well as a singe LF).
  89      *  Valid values are 'US-ASCII', 'UTF-8' and 'ISO-8859-1'
  90      */
  91     public $request_charset_encoding = '';
  92
  93     /**
  94      * Decides the content of Response objects returned by calls to send() and multicall().
  95      * Valid values are 'xmlrpcvals', 'phpvals' or 'xml'.
  96      *
  97      * Determines whether the value returned inside an Response object as results of calls to the send() and multicall()
  98      * methods will be a Value object, a plain php value or a raw xml string.
  99      * Allowed values are 'xmlrpcvals' (the default), 'phpvals' and 'xml'.
 100      * To allow the user to differentiate between a correct and a faulty response, fault responses will be returned as
 101      * Response objects in any case.
 102      * Note that the 'phpvals' setting will yield faster execution times, but some of the information from the original
 103      * response will be lost. It will be e.g. impossible to tell whether a particular php string value was sent by the
 104      * server as an xmlrpc string or base64 value.
 105      */
 106     public $return_type = 'xmlrpcvals';
 107
 108     /**
 109      * Sent to servers in http headers.
 110      */
 111     public $user_agent;
 112
 113     /**
 114      * @param string $path either the PATH part of the xmlrpc server URL, or complete server URL (in which case you
 115      *                     should use and empty string for all other parameters)
 116      *                     e.g. /xmlrpc/server.php
 117      *                     e.g. http://phpxmlrpc.sourceforge.net/server.php
 118      *                     e.g. https://james:bond@secret.service.com:443/xmlrpcserver?agent=007
 119      * @param string $server the server name / ip address
 120      * @param integer $port the port the server is listening on, when omitted defaults to 80 or 443 depending on
 121      *                      protocol used
 122      * @param string $method the http protocol variant: defaults to 'http'; 'https' and 'http11' can be used if CURL is
 123      *                       installed. The value set here can be overridden in any call to $this->send().
 124      */
 125     public function __construct($path, $server = '', $port = '', $method = '')
 126     {
 127         // allow user to specify all params in $path
 128         if ($server == '' and $port == '' and $method == '') {
 129             $parts = parse_url($path);
 130             $server = $parts['host'];
 131             $path = isset($parts['path']) ? $parts['path'] : '';
 132             if (isset($parts['query'])) {
 133                 $path .= '?' . $parts['query'];
 134             }
 135             if (isset($parts['fragment'])) {
 136                 $path .= '#' . $parts['fragment'];
 137             }
 138             if (isset($parts['port'])) {
 139                 $port = $parts['port'];
 140             }
 141             if (isset($parts['scheme'])) {
 142                 $method = $parts['scheme'];
 143             }
 144             if (isset($parts['user'])) {
 145                 $this->username = $parts['user'];
 146             }
 147             if (isset($parts['pass'])) {
 148                 $this->password = $parts['pass'];
 149             }
 150         }
 151         if ($path == '' || $path[0] != '/') {
 152             $this->path = '/' . $path;
 153         } else {
 154             $this->path = $path;
 155         }
 156         $this->server = $server;
 157         if ($port != '') {
 158             $this->port = $port;
 159         }
 160         if ($method != '') {
 161             $this->method = $method;
 162         }
 163
 164         // if ZLIB is enabled, let the client by default accept compressed responses
 165         if (function_exists('gzinflate') || (
 166                 function_exists('curl_init') && (($info = curl_version()) &&
 167                     ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
 168             )
 169         ) {
 170             $this->accepted_compression = array('gzip', 'deflate');
 171         }
 172
 173         // keepalives: enabled by default
 174         $this->keepalive = true;
 175
 176         // by default the xml parser can support these 3 charset encodings
 177         $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
 178
 179         // Add all charsets which mbstring can handle, but remove junk not found in IANA registry at
 180         // in http://www.iana.org/assignments/character-sets/character-sets.xhtml
 181         // NB: this is disabled to avoid making all the requests sent huge... mbstring supports more than 80 charsets!
 182         /*if (function_exists('mb_list_encodings')) {
 183
 184             $encodings = array_diff(mb_list_encodings(), array('pass', 'auto', 'wchar', 'BASE64', 'UUENCODE', 'ASCII',
 185                 'HTML-ENTITIES', 'Quoted-Printable', '7bit','8bit', 'byte2be', 'byte2le', 'byte4be', 'byte4le'));
 186             $this->accepted_charset_encodings = array_unique(array_merge($this->accepted_charset_encodings, $encodings));
 187         }*/
 188
 189         // initialize user_agent string
 190         $this->user_agent = PhpXmlRpc::$xmlrpcName . ' ' . PhpXmlRpc::$xmlrpcVersion;
 191     }
 192
 193     /**
 194      * Enable/disable the echoing to screen of the xmlrpc responses received. The default is not no output anything.
 195      *
 196      * The debugging information at level 1 includes the raw data returned from the XML-RPC server it was querying
 197      * (including bot HTTP headers and the full XML payload), and the PHP value the client attempts to create to
 198      * represent the value returned by the server
 199      * At level2, the complete payload of the xmlrpc request is also printed, before being sent t the server.
 200      *
 201      * This option can be very useful when debugging servers as it allows you to see exactly what the client sends and
 202      * the server returns.
 203      *
 204      * @param integer $in values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
 205      */
 206     public function setDebug($level)
 207     {
 208         $this->debug = $level;
 209     }
 210
 211     /**
 212      * Sets the username and password for authorizing the client to the server.
 213      *
 214      * With the default (HTTP) transport, this information is used for HTTP Basic authorization.
 215      * Note that username and password can also be set using the class constructor.
 216      * With HTTP 1.1 and HTTPS transport, NTLM and Digest authentication protocols are also supported. To enable them use
 217      * the constants CURLAUTH_DIGEST and CURLAUTH_NTLM as values for the auth type parameter.
 218      *
 219      * @param string $user username
 220      * @param string $password password
 221      * @param integer $authType auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC
 222      *                          (basic auth). Note that auth types NTLM and Digest will only work if the Curl php
 223      *                          extension is enabled.
 224      */
 225     public function setCredentials($user, $password, $authType = 1)
 226     {
 227         $this->username = $user;
 228         $this->password = $password;
 229         $this->authtype = $authType;
 230     }
 231
 232     /**
 233      * Set the optional certificate and passphrase used in SSL-enabled communication with a remote server.
 234      *
 235      * Note: to retrieve information about the client certificate on the server side, you will need to look into the
 236      * environment variables which are set up by the webserver. Different webservers will typically set up different
 237      * variables.
 238      *
 239      * @param string $cert the name of a file containing a PEM formatted certificate
 240      * @param string $certPass the password required to use it
 241      */
 242     public function setCertificate($cert, $certPass = '')
 243     {
 244         $this->cert = $cert;
 245         $this->certpass = $certPass;
 246     }
 247
 248     /**
 249      * Add a CA certificate to verify server with in SSL-enabled communication when SetSSLVerifypeer has been set to TRUE.
 250      *
 251      * See the php manual page about CURLOPT_CAINFO for more details.
 252      *
 253      * @param string $caCert certificate file name (or dir holding certificates)
 254      * @param bool $isDir set to true to indicate cacert is a dir. defaults to false
 255      */
 256     public function setCaCertificate($caCert, $isDir = false)
 257     {
 258         if ($isDir) {
 259             $this->cacertdir = $caCert;
 260         } else {
 261             $this->cacert = $caCert;
 262         }
 263     }
 264
 265     /**
 266      * Set attributes for SSL communication: private SSL key.
 267      *
 268      * NB: does not work in older php/curl installs.
 269      * Thanks to Daniel Convissor.
 270      *
 271      * @param string $key The name of a file containing a private SSL key
 272      * @param string $keyPass The secret password needed to use the private SSL key
 273      */
 274     public function setKey($key, $keyPass)
 275     {
 276         $this->key = $key;
 277         $this->keypass = $keyPass;
 278     }
 279
 280     /**
 281      * Set attributes for SSL communication: verify the remote host's SSL certificate, and cause the connection to fail
 282      * if the cert verification fails.
 283      *
 284      * By default, verification is enabled.
 285      * To specify custom SSL certificates to validate the server with, use the setCaCertificate method.
 286      *
 287      * @param bool $i enable/disable verification of peer certificate
 288      */
 289     public function setSSLVerifyPeer($i)
 290     {
 291         $this->verifypeer = $i;
 292     }
 293
 294     /**
 295      * Set attributes for SSL communication: verify the remote host's SSL certificate's common name (CN).
 296      *
 297      * Note that support for value 1 has been removed in cURL 7.28.1
 298      *
 299      * @param int $i Set to 1 to only the existence of a CN, not that it matches
 300      */
 301     public function setSSLVerifyHost($i)
 302     {
 303         $this->verifyhost = $i;
 304     }
 305
 306     /**
 307      * Set attributes for SSL communication: SSL version to use. Best left at 0 (default value ): let cURL decide
 308      *
 309      * @param int $i
 310      */
 311     public function setSSLVersion($i)
 312     {
 313         $this->sslversion = $i;
 314     }
 315
 316     /**
 317      * Set proxy info.
 318      *
 319      * NB: CURL versions before 7.11.10 cannot use a proxy to communicate with https servers.
 320      *
 321      * @param string $proxyHost
 322      * @param string $proxyPort Defaults to 8080 for HTTP and 443 for HTTPS
 323      * @param string $proxyUsername Leave blank if proxy has public access
 324      * @param string $proxyPassword Leave blank if proxy has public access
 325      * @param int $proxyAuthType defaults to CURLAUTH_BASIC (Basic authentication protocol); set to constant CURLAUTH_NTLM
 326      *                           to use NTLM auth with proxy (has effect only when the client uses the HTTP 1.1 protocol)
 327      */
 328     public function setProxy($proxyHost, $proxyPort, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1)
 329     {
 330         $this->proxy = $proxyHost;
 331         $this->proxyport = $proxyPort;
 332         $this->proxy_user = $proxyUsername;
 333         $this->proxy_pass = $proxyPassword;
 334         $this->proxy_authtype = $proxyAuthType;
 335     }
 336
 337     /**
 338      * Enables/disables reception of compressed xmlrpc responses.
 339      *
 340      * This requires the "zlib" extension to be enabled in your php install. If it is, by default xmlrpc_client
 341      * instances will enable reception of compressed content.
 342      * Note that enabling reception of compressed responses merely adds some standard http headers to xmlrpc requests.
 343      * It is up to the xmlrpc server to return compressed responses when receiving such requests.
 344      *
 345      * @param string $compMethod either 'gzip', 'deflate', 'any' or ''
 346      */
 347     public function setAcceptedCompression($compMethod)
 348     {
 349         if ($compMethod == 'any') {
 350             $this->accepted_compression = array('gzip', 'deflate');
 351         } elseif ($compMethod == false) {
 352             $this->accepted_compression = array();
 353         } else {
 354             $this->accepted_compression = array($compMethod);
 355         }
 356     }
 357
 358     /**
 359      * Enables/disables http compression of xmlrpc request.
 360      *
 361      * This requires the "zlib" extension to be enabled in your php install.
 362      * Take care when sending compressed requests: servers might not support them (and automatic fallback to
 363      * uncompressed requests is not yet implemented).
 364      *
 365      * @param string $compMethod either 'gzip', 'deflate' or ''
 366      */
 367     public function setRequestCompression($compMethod)
 368     {
 369         $this->request_compression = $compMethod;
 370     }
 371
 372     /**
 373      * Adds a cookie to list of cookies that will be sent to server with every further request (useful e.g. for keeping
 374      * session info outside of the xml-rpc payload).
 375      *
 376      * NB: By default cookies are sent using the 'original/netscape' format, which is also the same as the RFC 2965;
 377      * setting any param but name and value will turn the cookie into a 'version 1' cookie (i.e. RFC 2109 cookie) that
 378      * might not be fully supported by the server. Note that RFC 2109 has currently 'historic' status...
 379      *
 380      * @param string $name nb: will not be escaped in the request's http headers. Take care not to use CTL chars or
 381      *                     separators!
 382      * @param string $value
 383      * @param string $path leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
 384      * @param string $domain leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
 385      * @param int $port leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
 386      *
 387      * @todo check correctness of urlencoding cookie value (copied from php way of doing it, but php is generally sending
 388      *       response not requests. We do the opposite...)
 389      * @todo strip invalid chars from cookie name? As per RFC6265, we should follow RFC2616, Section 2.2
 390      */
 391     public function setCookie($name, $value = '', $path = '', $domain = '', $port = null)
 392     {
 393         $this->cookies[$name]['value'] = urlencode($value);
 394         if ($path || $domain || $port) {
 395             $this->cookies[$name]['path'] = $path;
 396             $this->cookies[$name]['domain'] = $domain;
 397             $this->cookies[$name]['port'] = $port;
 398             $this->cookies[$name]['version'] = 1;
 399         } else {
 400             $this->cookies[$name]['version'] = 0;
 401         }
 402     }
 403
 404     /**
 405      * Directly set cURL options, for extra flexibility (when in cURL mode).
 406      *
 407      * It allows eg. to bind client to a specific IP interface / address.
 408      *
 409      * @param array $options
 410      */
 411     public function setCurlOptions($options)
 412     {
 413         $this->extracurlopts = $options;
 414     }
 415
 416     /**
 417      * Set user-agent string that will be used by this client instance in http headers sent to the server.
 418      *
 419      * The default user agent string includes the name of this library and the version number.
 420      *
 421      * @param string $agentString
 422      */
 423     public function setUserAgent($agentString)
 424     {
 425         $this->user_agent = $agentString;
 426     }
 427
 428     /**
 429      * Send an xmlrpc request to the server.
 430      *
 431      * @param Request|Request[]|string $req The Request object, or an array of requests for using multicall, or the
 432      *                                      complete xml representation of a request.
 433      *                                      When sending an array of Request objects, the client will try to make use of
 434      *                                      a single 'system.multicall' xml-rpc method call to forward to the server all
 435      *                                      the requests in a single HTTP round trip, unless $this->no_multicall has
 436      *                                      been previously set to TRUE (see the multicall method below), in which case
 437      *                                      many consecutive xmlrpc requests will be sent. The method will return an
 438      *                                      array of Response objects in both cases.
 439      *                                      The third variant allows to build by hand (or any other means) a complete
 440      *                                      xmlrpc request message, and send it to the server. $req should be a string
 441      *                                      containing the complete xml representation of the request. It is e.g. useful
 442      *                                      when, for maximal speed of execution, the request is serialized into a
 443      *                                      string using the native php xmlrpc functions (see http://www.php.net/xmlrpc)
 444      * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply.
 445      *                         This timeout value is passed to fsockopen(). It is also used for detecting server
 446      *                         timeouts during communication (i.e. if the server does not send anything to the client
 447      *                         for $timeout seconds, the connection will be closed).
 448      * @param string $method valid values are 'http', 'http11' and 'https'. If left unspecified, the http protocol
 449      *                       chosen during creation of the object will be used.
 450      *
 451      *
 452      * @return Response|Response[] Note that the client will always return a Response object, even if the call fails
 453      */
 454     public function send($req, $timeout = 0, $method = '')
 455     {
 456         // if user does not specify http protocol, use native method of this client
 457         // (i.e. method set during call to constructor)
 458         if ($method == '') {
 459             $method = $this->method;
 460         }
 461
 462         if (is_array($req)) {
 463             // $req is an array of Requests
 464             $r = $this->multicall($req, $timeout, $method);
 465
 466             return $r;
 467         } elseif (is_string($req)) {
 468             $n = new Request('');
 469             $n->payload = $req;
 470             $req = $n;
 471         }
 472
 473         // where req is a Request
 474         $req->setDebug($this->debug);
 475
 476         if ($method == 'https') {
 477             $r = $this->sendPayloadHTTPS(
 478                 $req,
 479                 $this->server,
 480                 $this->port,
 481                 $timeout,
 482                 $this->username,
 483                 $this->password,
 484                 $this->authtype,
 485                 $this->cert,
 486                 $this->certpass,
 487                 $this->cacert,
 488                 $this->cacertdir,
 489                 $this->proxy,
 490                 $this->proxyport,
 491                 $this->proxy_user,
 492                 $this->proxy_pass,
 493                 $this->proxy_authtype,
 494                 $this->keepalive,
 495                 $this->key,
 496                 $this->keypass,
 497                 $this->sslversion
 498             );
 499         } elseif ($method == 'http11') {
 500             $r = $this->sendPayloadCURL(
 501                 $req,
 502                 $this->server,
 503                 $this->port,
 504                 $timeout,
 505                 $this->username,
 506                 $this->password,
 507                 $this->authtype,
 508                 null,
 509                 null,
 510                 null,
 511                 null,
 512                 $this->proxy,
 513                 $this->proxyport,
 514                 $this->proxy_user,
 515                 $this->proxy_pass,
 516                 $this->proxy_authtype,
 517                 'http',
 518                 $this->keepalive
 519             );
 520         } else {
 521             $r = $this->sendPayloadHTTP10(
 522                 $req,
 523                 $this->server,
 524                 $this->port,
 525                 $timeout,
 526                 $this->username,
 527                 $this->password,
 528                 $this->authtype,
 529                 $this->proxy,
 530                 $this->proxyport,
 531                 $this->proxy_user,
 532                 $this->proxy_pass,
 533                 $this->proxy_authtype,
 534                 $method
 535             );
 536         }
 537
 538         return $r;
 539     }
 540
 541     /**
 542      * @param Request $req
 543      * @param string $server
 544      * @param int $port
 545      * @param int $timeout
 546      * @param string $username
 547      * @param string $password
 548      * @param int $authType
 549      * @param string $proxyHost
 550      * @param int $proxyPort
 551      * @param string $proxyUsername
 552      * @param string $proxyPassword
 553      * @param int $proxyAuthType
 554      * @param string $method
 555      * @return Response
 556      */
 557     protected function sendPayloadHTTP10($req, $server, $port, $timeout = 0, $username = '', $password = '',
 558         $authType = 1, $proxyHost = '', $proxyPort = 0, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1,
 559         $method='http')
 560     {
 561         if ($port == 0) {
 562             $port = ( $method === "https" ) ? 443 : 80;
 563         }
 564
 565         // Only create the payload if it was not created previously
 566         if (empty($req->payload)) {
 567             $req->createPayload($this->request_charset_encoding);
 568         }
 569
 570         $payload = $req->payload;
 571         // Deflate request body and set appropriate request headers
 572         if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
 573             if ($this->request_compression == 'gzip') {
 574                 $a = @gzencode($payload);
 575                 if ($a) {
 576                     $payload = $a;
 577                     $encodingHdr = "Content-Encoding: gzip\r\n";
 578                 }
 579             } else {
 580                 $a = @gzcompress($payload);
 581                 if ($a) {
 582                     $payload = $a;
 583                     $encodingHdr = "Content-Encoding: deflate\r\n";
 584                 }
 585             }
 586         } else {
 587             $encodingHdr = '';
 588         }
 589
 590         // thanks to Grant Rauscher <grant7@firstworld.net> for this
 591         $credentials = '';
 592         if ($username != '') {
 593             $credentials = 'Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
 594             if ($authType != 1) {
 595                 error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported with HTTP 1.0');
 596             }
 597         }
 598
 599         $acceptedEncoding = '';
 600         if (is_array($this->accepted_compression) && count($this->accepted_compression)) {
 601             $acceptedEncoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
 602         }
 603
 604         $proxyCredentials = '';
 605         if ($proxyHost) {
 606             if ($proxyPort == 0) {
 607                 $proxyPort = 8080;
 608             }
 609             $connectServer = $proxyHost;
 610             $connectPort = $proxyPort;
 611             $transport = "tcp";
 612             $uri = 'http://' . $server . ':' . $port . $this->path;
 613             if ($proxyUsername != '') {
 614                 if ($proxyAuthType != 1) {
 615                     error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported with HTTP 1.0');
 616                 }
 617                 $proxyCredentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyUsername . ':' . $proxyPassword) . "\r\n";
 618             }
 619         } else {
 620             $connectServer = $server;
 621             $connectPort = $port;
 622             /// @todo if supporting https, we should support all its current options as well: peer name verification etc...
 623             $transport = ( $method === "https" ) ? "tls" : "tcp";
 624             $uri = $this->path;
 625         }
 626
 627         // Cookie generation, as per rfc2965 (version 1 cookies) or
 628         // netscape's rules (version 0 cookies)
 629         $cookieHeader = '';
 630         if (count($this->cookies)) {
 631             $version = '';
 632             foreach ($this->cookies as $name => $cookie) {
 633                 if ($cookie['version']) {
 634                     $version = ' $Version="' . $cookie['version'] . '";';
 635                     $cookieHeader .= ' ' . $name . '="' . $cookie['value'] . '";';
 636                     if ($cookie['path']) {
 637                         $cookieHeader .= ' $Path="' . $cookie['path'] . '";';
 638                     }
 639                     if ($cookie['domain']) {
 640                         $cookieHeader .= ' $Domain="' . $cookie['domain'] . '";';
 641                     }
 642                     if ($cookie['port']) {
 643                         $cookieHeader .= ' $Port="' . $cookie['port'] . '";';
 644                     }
 645                 } else {
 646                     $cookieHeader .= ' ' . $name . '=' . $cookie['value'] . ";";
 647                 }
 648             }
 649             $cookieHeader = 'Cookie:' . $version . substr($cookieHeader, 0, -1) . "\r\n";
 650         }
 651
 652         // omit port if 80
 653         $port = ($port == 80) ? '' : (':' . $port);
 654
 655         $op = 'POST ' . $uri . " HTTP/1.0\r\n" .
 656             'User-Agent: ' . $this->user_agent . "\r\n" .
 657             'Host: ' . $server . $port . "\r\n" .
 658             $credentials .
 659             $proxyCredentials .
 660             $acceptedEncoding .
 661             $encodingHdr .
 662             'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .
 663             $cookieHeader .
 664             'Content-Type: ' . $req->content_type . "\r\nContent-Length: " .
 665             strlen($payload) . "\r\n\r\n" .
 666             $payload;
 667
 668         if ($this->debug > 1) {
 669             Logger::instance()->debugMessage("---SENDING---\n$op\n---END---");
 670         }
 671
 672         if ($timeout > 0) {
 673             $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr, $timeout);
 674         } else {
 675             $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr);
 676         }
 677         if ($fp) {
 678             if ($timeout > 0) {
 679                 stream_set_timeout($fp, $timeout);
 680             }
 681         } else {
 682             $this->errstr = 'Connect error: ' . $this->errstr;
 683             $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr . ' (' . $this->errno . ')');
 684
 685             return $r;
 686         }
 687
 688         if (!fputs($fp, $op, strlen($op))) {
 689             fclose($fp);
 690             $this->errstr = 'Write error';
 691             $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr);
 692
 693             return $r;
 694         } else {
 695             // reset errno and errstr on successful socket connection
 696             $this->errstr = '';
 697         }
 698         // G. Giunta 2005/10/24: close socket before parsing.
 699         // should yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)
 700         $ipd = '';
 701         do {
 702             // shall we check for $data === FALSE?
 703             // as per the manual, it signals an error
 704             $ipd .= fread($fp, 32768);
 705         } while (!feof($fp));
 706         fclose($fp);
 707         $r = $req->parseResponse($ipd, false, $this->return_type);
 708
 709         return $r;
 710     }
 711
 712     /**
 713      * @param Request $req
 714      * @param string $server
 715      * @param int $port
 716      * @param int $timeout
 717      * @param string $username
 718      * @param string $password
 719      * @param int $authType
 720      * @param string $cert
 721      * @param string $certPass
 722      * @param string $caCert
 723      * @param string $caCertDir
 724      * @param string $proxyHost
 725      * @param int $proxyPort
 726      * @param string $proxyUsername
 727      * @param string $proxyPassword
 728      * @param int $proxyAuthType
 729      * @param bool $keepAlive
 730      * @param string $key
 731      * @param string $keyPass
 732      * @param int $sslVersion
 733      * @return Response
 734      */
 735     protected function sendPayloadHTTPS($req, $server, $port, $timeout = 0, $username = '',  $password = '',
 736         $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0,
 737         $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $keepAlive = false, $key = '', $keyPass = '',
 738         $sslVersion = 0)
 739     {
 740         return $this->sendPayloadCURL($req, $server, $port, $timeout, $username,
 741             $password, $authType, $cert, $certPass, $caCert, $caCertDir, $proxyHost, $proxyPort,
 742             $proxyUsername, $proxyPassword, $proxyAuthType, 'https', $keepAlive, $key, $keyPass, $sslVersion);
 743     }
 744
 745     /**
 746      * Contributed by Justin Miller <justin@voxel.net>
 747      * Requires curl to be built into PHP
 748      * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
 749      *
 750      * @param Request $req
 751      * @param string $server
 752      * @param int $port
 753      * @param int $timeout
 754      * @param string $username
 755      * @param string $password
 756      * @param int $authType
 757      * @param string $cert
 758      * @param string $certPass
 759      * @param string $caCert
 760      * @param string $caCertDir
 761      * @param string $proxyHost
 762      * @param int $proxyPort
 763      * @param string $proxyUsername
 764      * @param string $proxyPassword
 765      * @param int $proxyAuthType
 766      * @param string $method
 767      * @param bool $keepAlive
 768      * @param string $key
 769      * @param string $keyPass
 770      * @param int $sslVersion
 771      * @return Response
 772      */
 773     protected function sendPayloadCURL($req, $server, $port, $timeout = 0, $username = '', $password = '',
 774         $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0,
 775         $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $method = 'https', $keepAlive = false, $key = '',
 776         $keyPass = '', $sslVersion = 0)
 777     {
 778         if (!function_exists('curl_init')) {
 779             $this->errstr = 'CURL unavailable on this install';
 780             return new Response(0, PhpXmlRpc::$xmlrpcerr['no_curl'], PhpXmlRpc::$xmlrpcstr['no_curl']);
 781         }
 782         if ($method == 'https') {
 783             if (($info = curl_version()) &&
 784                 ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version'])))
 785             ) {
 786                 $this->errstr = 'SSL unavailable on this install';
 787                 return new Response(0, PhpXmlRpc::$xmlrpcerr['no_ssl'], PhpXmlRpc::$xmlrpcstr['no_ssl']);
 788             }
 789         }
 790
 791         if ($port == 0) {
 792             if ($method == 'http') {
 793                 $port = 80;
 794             } else {
 795                 $port = 443;
 796             }
 797         }
 798
 799         // Only create the payload if it was not created previously
 800         if (empty($req->payload)) {
 801             $req->createPayload($this->request_charset_encoding);
 802         }
 803
 804         // Deflate request body and set appropriate request headers
 805         $payload = $req->payload;
 806         if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
 807             if ($this->request_compression == 'gzip') {
 808                 $a = @gzencode($payload);
 809                 if ($a) {
 810                     $payload = $a;
 811                     $encodingHdr = 'Content-Encoding: gzip';
 812                 }
 813             } else {
 814                 $a = @gzcompress($payload);
 815                 if ($a) {
 816                     $payload = $a;
 817                     $encodingHdr = 'Content-Encoding: deflate';
 818                 }
 819             }
 820         } else {
 821             $encodingHdr = '';
 822         }
 823
 824         if ($this->debug > 1) {
 825             Logger::instance()->debugMessage("---SENDING---\n$payload\n---END---");
 826         }
 827
 828         if (!$keepAlive || !$this->xmlrpc_curl_handle) {
 829             $curl = curl_init($method . '://' . $server . ':' . $port . $this->path);
 830             if ($keepAlive) {
 831                 $this->xmlrpc_curl_handle = $curl;
 832             }
 833         } else {
 834             $curl = $this->xmlrpc_curl_handle;
 835         }
 836
 837         // results into variable
 838         curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
 839
 840         if ($this->debug > 1) {
 841             curl_setopt($curl, CURLOPT_VERBOSE, true);
 842             /// @todo allow callers to redirect curlopt_stderr to some stream which can be buffered
 843         }
 844         curl_setopt($curl, CURLOPT_USERAGENT, $this->user_agent);
 845         // required for XMLRPC: post the data
 846         curl_setopt($curl, CURLOPT_POST, 1);
 847         // the data
 848         curl_setopt($curl, CURLOPT_POSTFIELDS, $payload);
 849
 850         // return the header too
 851         curl_setopt($curl, CURLOPT_HEADER, 1);
 852
 853         // NB: if we set an empty string, CURL will add http header indicating
 854         // ALL methods it is supporting. This is possibly a better option than
 855         // letting the user tell what curl can / cannot do...
 856         if (is_array($this->accepted_compression) && count($this->accepted_compression)) {
 857             //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));
 858             // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
 859             if (count($this->accepted_compression) == 1) {
 860                 curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);
 861             } else {
 862                 curl_setopt($curl, CURLOPT_ENCODING, '');
 863             }
 864         }
 865         // extra headers
 866         $headers = array('Content-Type: ' . $req->content_type, 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
 867         // if no keepalive is wanted, let the server know it in advance
 868         if (!$keepAlive) {
 869             $headers[] = 'Connection: close';
 870         }
 871         // request compression header
 872         if ($encodingHdr) {
 873             $headers[] = $encodingHdr;
 874         }
 875
 876         // Fix the HTTP/1.1 417 Expectation Failed Bug (curl by default adds a 'Expect: 100-continue' header when POST
 877         // size exceeds 1025 bytes, apparently)
 878         $headers[] = 'Expect:';
 879
 880         curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
 881         // timeout is borked
 882         if ($timeout) {
 883             curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);
 884         }
 885
 886         if ($username && $password) {
 887             curl_setopt($curl, CURLOPT_USERPWD, $username . ':' . $password);
 888             if (defined('CURLOPT_HTTPAUTH')) {
 889                 curl_setopt($curl, CURLOPT_HTTPAUTH, $authType);
 890             } elseif ($authType != 1) {
 891                 error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported by the current PHP/curl install');
 892             }
 893         }
 894
 895         if ($method == 'https') {
 896             // set cert file
 897             if ($cert) {
 898                 curl_setopt($curl, CURLOPT_SSLCERT, $cert);
 899             }
 900             // set cert password
 901             if ($certPass) {
 902                 curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certPass);
 903             }
 904             // whether to verify remote host's cert
 905             curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);
 906             // set ca certificates file/dir
 907             if ($caCert) {
 908                 curl_setopt($curl, CURLOPT_CAINFO, $caCert);
 909             }
 910             if ($caCertDir) {
 911                 curl_setopt($curl, CURLOPT_CAPATH, $caCertDir);
 912             }
 913             // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
 914             if ($key) {
 915                 curl_setopt($curl, CURLOPT_SSLKEY, $key);
 916             }
 917             // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
 918             if ($keyPass) {
 919                 curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keyPass);
 920             }
 921             // 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
 922             curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);
 923             // allow usage of different SSL versions
 924             curl_setopt($curl, CURLOPT_SSLVERSION, $sslVersion);
 925         }
 926
 927         // proxy info
 928         if ($proxyHost) {
 929             if ($proxyPort == 0) {
 930                 $proxyPort = 8080; // NB: even for HTTPS, local connection is on port 8080
 931             }
 932             curl_setopt($curl, CURLOPT_PROXY, $proxyHost . ':' . $proxyPort);
 933             if ($proxyUsername) {
 934                 curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyUsername . ':' . $proxyPassword);
 935                 if (defined('CURLOPT_PROXYAUTH')) {
 936                     curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyAuthType);
 937                 } elseif ($proxyAuthType != 1) {
 938                     error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported by the current PHP/curl install');
 939                 }
 940             }
 941         }
 942
 943         // NB: should we build cookie http headers by hand rather than let CURL do it?
 944         // the following code does not honour 'expires', 'path' and 'domain' cookie attributes
 945         // set to client obj the the user...
 946         if (count($this->cookies)) {
 947             $cookieHeader = '';
 948             foreach ($this->cookies as $name => $cookie) {
 949                 $cookieHeader .= $name . '=' . $cookie['value'] . '; ';
 950             }
 951             curl_setopt($curl, CURLOPT_COOKIE, substr($cookieHeader, 0, -2));
 952         }
 953
 954         foreach ($this->extracurlopts as $opt => $val) {
 955             curl_setopt($curl, $opt, $val);
 956         }
 957
 958         $result = curl_exec($curl);
 959
 960         if ($this->debug > 1) {
 961             $message = "---CURL INFO---\n";
 962             foreach (curl_getinfo($curl) as $name => $val) {
 963                 if (is_array($val)) {
 964                     $val = implode("\n", $val);
 965                 }
 966                 $message .= $name . ': ' . $val . "\n";
 967             }
 968             $message .= "---END---";
 969             Logger::instance()->debugMessage($message);
 970         }
 971
 972         if (!$result) {
 973             /// @todo we should use a better check here - what if we get back '' or '0'?
 974
 975             $this->errstr = 'no response';
 976             $resp = new Response(0, PhpXmlRpc::$xmlrpcerr['curl_fail'], PhpXmlRpc::$xmlrpcstr['curl_fail'] . ': ' . curl_error($curl));
 977             curl_close($curl);
 978             if ($keepAlive) {
 979                 $this->xmlrpc_curl_handle = null;
 980             }
 981         } else {
 982             if (!$keepAlive) {
 983                 curl_close($curl);
 984             }
 985             $resp = $req->parseResponse($result, true, $this->return_type);
 986             // if we got back a 302, we can not reuse the curl handle for later calls
 987             if ($resp->faultCode() == PhpXmlRpc::$xmlrpcerr['http_error'] && $keepAlive) {
 988                 curl_close($curl);
 989                 $this->xmlrpc_curl_handle = null;
 990             }
 991         }
 992
 993         return $resp;
 994     }
 995
 996     /**
 997      * Send an array of requests and return an array of responses.
 998      *
 999      * Unless $this->no_multicall has been set to true, it will try first to use one single xmlrpc call to server method
1000      * system.multicall, and revert to sending many successive calls in case of failure.
1001      * This failure is also stored in $this->no_multicall for subsequent calls.
1002      * Unfortunately, there is no server error code universally used to denote the fact that multicall is unsupported,
1003      * so there is no way to reliably distinguish between that and a temporary failure.
1004      * If you are sure that server supports multicall and do not want to fallback to using many single calls, set the
1005      * fourth parameter to FALSE.
1006      *
1007      * NB: trying to shoehorn extra functionality into existing syntax has resulted
1008      * in pretty much convoluted code...
1009      *
1010      * @param Request[] $reqs an array of Request objects
1011      * @param integer $timeout connection timeout (in seconds). See the details in the docs for the send() method
1012      * @param string $method the http protocol variant to be used. See the details in the docs for the send() method
1013      * @param boolean fallback When true, upon receiving an error during multicall, multiple single calls will be
1014      *                         attempted
1015      *
1016      * @return Response[]
1017      */
1018     public function multicall($reqs, $timeout = 0, $method = '', $fallback = true)
1019     {
1020         if ($method == '') {
1021             $method = $this->method;
1022         }
1023         if (!$this->no_multicall) {
1024             $results = $this->_try_multicall($reqs, $timeout, $method);
1025             if (is_array($results)) {
1026                 // System.multicall succeeded
1027                 return $results;
1028             } else {
1029                 // either system.multicall is unsupported by server,
1030                 // or call failed for some other reason.
1031                 if ($fallback) {
1032                     // Don't try it next time...
1033                     $this->no_multicall = true;
1034                 } else {
1035                     if (is_a($results, '\PhpXmlRpc\Response')) {
1036                         $result = $results;
1037                     } else {
1038                         $result = new Response(0, PhpXmlRpc::$xmlrpcerr['multicall_error'], PhpXmlRpc::$xmlrpcstr['multicall_error']);
1039                     }
1040                 }
1041             }
1042         } else {
1043             // override fallback, in case careless user tries to do two
1044             // opposite things at the same time
1045             $fallback = true;
1046         }
1047
1048         $results = array();
1049         if ($fallback) {
1050             // system.multicall is (probably) unsupported by server:
1051             // emulate multicall via multiple requests
1052             foreach ($reqs as $req) {
1053                 $results[] = $this->send($req, $timeout, $method);
1054             }
1055         } else {
1056             // user does NOT want to fallback on many single calls:
1057             // since we should always return an array of responses,
1058             // return an array with the same error repeated n times
1059             foreach ($reqs as $req) {
1060                 $results[] = $result;
1061             }
1062         }
1063
1064         return $results;
1065     }
1066
1067     /**
1068      * Attempt to boxcar $reqs via system.multicall.
1069      *
1070      * Returns either an array of Response, a single error Response or false (when received response does not respect
1071      * valid multicall syntax).
1072      *
1073      * @param Request[] $reqs
1074      * @param int $timeout
1075      * @param string $method
1076      * @return Response[]|bool|mixed|Response
1077      */
1078     private function _try_multicall($reqs, $timeout, $method)
1079     {
1080         // Construct multicall request
1081         $calls = array();
1082         foreach ($reqs as $req) {
1083             $call['methodName'] = new Value($req->method(), 'string');
1084             $numParams = $req->getNumParams();
1085             $params = array();
1086             for ($i = 0; $i < $numParams; $i++) {
1087                 $params[$i] = $req->getParam($i);
1088             }
1089             $call['params'] = new Value($params, 'array');
1090             $calls[] = new Value($call, 'struct');
1091         }
1092         $multiCall = new Request('system.multicall');
1093         $multiCall->addParam(new Value($calls, 'array'));
1094
1095         // Attempt RPC call
1096         $result = $this->send($multiCall, $timeout, $method);
1097
1098         if ($result->faultCode() != 0) {
1099             // call to system.multicall failed
1100             return $result;
1101         }
1102
1103         // Unpack responses.
1104         $rets = $result->value();
1105
1106         if ($this->return_type == 'xml') {
1107             return $rets;
1108         } elseif ($this->return_type == 'phpvals') {
1109             /// @todo test this code branch...
1110             $rets = $result->value();
1111             if (!is_array($rets)) {
1112                 return false;       // bad return type from system.multicall
1113             }
1114             $numRets = count($rets);
1115             if ($numRets != count($reqs)) {
1116                 return false;       // wrong number of return values.
1117             }
1118
1119             $response = array();
1120             for ($i = 0; $i < $numRets; $i++) {
1121                 $val = $rets[$i];
1122                 if (!is_array($val)) {
1123                     return false;
1124                 }
1125                 switch (count($val)) {
1126                     case 1:
1127                         if (!isset($val[0])) {
1128                             return false;       // Bad value
1129                         }
1130                         // Normal return value
1131                         $response[$i] = new Response($val[0], 0, '', 'phpvals');
1132                         break;
1133                     case 2:
1134                         /// @todo remove usage of @: it is apparently quite slow
1135                         $code = @$val['faultCode'];
1136                         if (!is_int($code)) {
1137                             return false;
1138                         }
1139                         $str = @$val['faultString'];
1140                         if (!is_string($str)) {
1141                             return false;
1142                         }
1143                         $response[$i] = new Response(0, $code, $str);
1144                         break;
1145                     default:
1146                         return false;
1147                 }
1148             }
1149
1150             return $response;
1151         } else {
1152             // return type == 'xmlrpcvals'
1153
1154             $rets = $result->value();
1155             if ($rets->kindOf() != 'array') {
1156                 return false;       // bad return type from system.multicall
1157             }
1158             $numRets = $rets->count();
1159             if ($numRets != count($reqs)) {
1160                 return false;       // wrong number of return values.
1161             }
1162
1163             $response = array();
1164             foreach($rets as $val) {
1165                 switch ($val->kindOf()) {
1166                     case 'array':
1167                         if ($val->count() != 1) {
1168                             return false;       // Bad value
1169                         }
1170                         // Normal return value
1171                         $response[] = new Response($val[0]);
1172                         break;
1173                     case 'struct':
1174                         $code = $val['faultCode'];
1175                         if ($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') {
1176                             return false;
1177                         }
1178                         $str = $val['faultString'];
1179                         if ($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') {
1180                             return false;
1181                         }
1182                         $response[] = new Response(0, $code->scalarval(), $str->scalarval());
1183                         break;
1184                     default:
1185                         return false;
1186                 }
1187             }
1188
1189             return $response;
1190         }
1191     }
1192 }