gggeek /
phpxmlrpc
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Client often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Client, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | class Client |
||
| 11 | { |
||
| 12 | const USE_CURL_NEVER = 0; |
||
| 13 | const USE_CURL_ALWAYS = 1; |
||
| 14 | const USE_CURL_AUTO = 2; |
||
| 15 | |||
| 16 | /// @todo: do these need to be public? |
||
| 17 | public $method = 'http'; |
||
| 18 | public $server; |
||
| 19 | public $port = 0; |
||
| 20 | public $path; |
||
| 21 | |||
| 22 | public $errno; |
||
| 23 | public $errstr; |
||
| 24 | public $debug = 0; |
||
| 25 | |||
| 26 | public $username = ''; |
||
| 27 | public $password = ''; |
||
| 28 | public $authtype = 1; |
||
| 29 | |||
| 30 | public $cert = ''; |
||
| 31 | public $certpass = ''; |
||
| 32 | public $cacert = ''; |
||
| 33 | public $cacertdir = ''; |
||
| 34 | public $key = ''; |
||
| 35 | public $keypass = ''; |
||
| 36 | public $verifypeer = true; |
||
| 37 | public $verifyhost = 2; |
||
| 38 | public $sslversion = 0; // corresponds to CURL_SSLVERSION_DEFAULT |
||
| 39 | |||
| 40 | public $proxy = ''; |
||
| 41 | public $proxyport = 0; |
||
| 42 | public $proxy_user = ''; |
||
| 43 | public $proxy_pass = ''; |
||
| 44 | public $proxy_authtype = 1; |
||
| 45 | |||
| 46 | public $cookies = array(); |
||
| 47 | public $extracurlopts = array(); |
||
| 48 | public $use_curl = self::USE_CURL_AUTO; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * @var bool |
||
| 52 | * |
||
| 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 |
||
| 56 | * system.multicall. |
||
| 57 | */ |
||
| 58 | public $no_multicall = false; |
||
| 59 | |||
| 60 | /** |
||
| 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. |
||
| 63 | * |
||
| 64 | * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since |
||
| 65 | * in those cases it will be up to CURL to decide the compression methods |
||
| 66 | * it supports. You might check for the presence of 'zlib' in the output of |
||
| 67 | * curl_version() to determine whether compression is supported or not |
||
| 68 | */ |
||
| 69 | public $accepted_compression = array(); |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Name of compression scheme to be used for sending requests. |
||
| 73 | * Either null, gzip or deflate. |
||
| 74 | */ |
||
| 75 | |||
| 76 | public $request_compression = ''; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: |
||
| 80 | * http://curl.haxx.se/docs/faq.html#7.3). |
||
| 81 | */ |
||
| 82 | public $xmlrpc_curl_handle = null; |
||
| 83 | |||
| 84 | /// Whether to use persistent connections for http 1.1 and https |
||
| 85 | public $keepalive = false; |
||
| 86 | |||
| 87 | /// Charset encodings that can be decoded without problems by the client |
||
| 88 | public $accepted_charset_encodings = array(); |
||
| 89 | |||
| 90 | /** |
||
| 91 | * The charset encoding that will be used for serializing request sent by the client. |
||
| 92 | * It defaults to NULL, which means using US-ASCII and encoding all characters outside of the ASCII range using |
||
| 93 | * their xml character entity representation (this has the benefit that line end characters will not be mangled in |
||
| 94 | * the transfer, a CR-LF will be preserved as well as a singe LF). |
||
| 95 | * Valid values are 'US-ASCII', 'UTF-8' and 'ISO-8859-1' |
||
| 96 | */ |
||
| 97 | public $request_charset_encoding = ''; |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Decides the content of Response objects returned by calls to send() and multicall(). |
||
| 101 | * Valid values are 'xmlrpcvals', 'phpvals' or 'xml'. |
||
| 102 | * |
||
| 103 | * Determines whether the value returned inside an Response object as results of calls to the send() and multicall() |
||
| 104 | * methods will be a Value object, a plain php value or a raw xml string. |
||
| 105 | * Allowed values are 'xmlrpcvals' (the default), 'phpvals' and 'xml'. |
||
| 106 | * To allow the user to differentiate between a correct and a faulty response, fault responses will be returned as |
||
| 107 | * Response objects in any case. |
||
| 108 | * Note that the 'phpvals' setting will yield faster execution times, but some of the information from the original |
||
| 109 | * response will be lost. It will be e.g. impossible to tell whether a particular php string value was sent by the |
||
| 110 | * server as an xmlrpc string or base64 value. |
||
| 111 | */ |
||
| 112 | public $return_type = 'xmlrpcvals'; |
||
| 113 | |||
| 114 | /** |
||
| 115 | * Sent to servers in http headers. |
||
| 116 | */ |
||
| 117 | public $user_agent; |
||
| 118 | |||
| 119 | /** |
||
| 120 | * @param string $path either the PATH part of the xmlrpc server URL, or complete server URL (in which case you |
||
| 121 | * should use and empty string for all other parameters) |
||
| 122 | * e.g. /xmlrpc/server.php |
||
| 123 | * e.g. http://phpxmlrpc.sourceforge.net/server.php |
||
| 124 | * e.g. https://james:[email protected]:443/xmlrpcserver?agent=007 |
||
| 125 | * @param string $server the server name / ip address |
||
| 126 | * @param integer $port the port the server is listening on, when omitted defaults to 80 or 443 depending on |
||
| 127 | * protocol used |
||
| 128 | * @param string $method the http protocol variant: defaults to 'http'; 'https' and 'http11' can be used if CURL is |
||
| 129 | * installed. The value set here can be overridden in any call to $this->send(). |
||
| 130 | */ |
||
| 131 | 605 | public function __construct($path, $server = '', $port = '', $method = '') |
|
| 132 | { |
||
| 133 | // allow user to specify all params in $path |
||
| 134 | 605 | if ($server == '' && $port == '' && $method == '') { |
|
| 135 | $parts = parse_url($path); |
||
| 136 | $server = $parts['host']; |
||
| 137 | $path = isset($parts['path']) ? $parts['path'] : ''; |
||
| 138 | if (isset($parts['query'])) { |
||
| 139 | $path .= '?' . $parts['query']; |
||
| 140 | } |
||
| 141 | if (isset($parts['fragment'])) { |
||
| 142 | $path .= '#' . $parts['fragment']; |
||
| 143 | } |
||
| 144 | if (isset($parts['port'])) { |
||
| 145 | $port = $parts['port']; |
||
| 146 | } |
||
| 147 | if (isset($parts['scheme'])) { |
||
| 148 | $method = $parts['scheme']; |
||
| 149 | } |
||
| 150 | if (isset($parts['user'])) { |
||
| 151 | $this->username = $parts['user']; |
||
| 152 | } |
||
| 153 | if (isset($parts['pass'])) { |
||
| 154 | $this->password = $parts['pass']; |
||
| 155 | } |
||
| 156 | } |
||
| 157 | 605 | if ($path == '' || $path[0] != '/') { |
|
| 158 | $this->path = '/' . $path; |
||
| 159 | } else { |
||
| 160 | 605 | $this->path = $path; |
|
| 161 | } |
||
| 162 | 605 | $this->server = $server; |
|
| 163 | 605 | if ($port != '') { |
|
| 164 | 3 | $this->port = $port; |
|
| 165 | } |
||
| 166 | 605 | if ($method != '') { |
|
| 167 | $this->method = $method; |
||
| 168 | } |
||
| 169 | |||
| 170 | // if ZLIB is enabled, let the client by default accept compressed responses |
||
| 171 | 605 | if (function_exists('gzinflate') || ( |
|
| 172 | function_exists('curl_init') && (($info = curl_version()) && |
||
| 173 | 605 | ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version']))) |
|
| 174 | ) |
||
| 175 | ) { |
||
| 176 | 605 | $this->accepted_compression = array('gzip', 'deflate'); |
|
| 177 | } |
||
| 178 | |||
| 179 | // keepalives: enabled by default |
||
| 180 | 605 | $this->keepalive = true; |
|
| 181 | |||
| 182 | // by default the xml parser can support these 3 charset encodings |
||
| 183 | 605 | $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII'); |
|
| 184 | |||
| 185 | // Add all charsets which mbstring can handle, but remove junk not found in IANA registry at |
||
| 186 | // http://www.iana.org/assignments/character-sets/character-sets.xhtml |
||
| 187 | // NB: this is disabled to avoid making all the requests sent huge... mbstring supports more than 80 charsets! |
||
| 188 | /*if (function_exists('mb_list_encodings')) { |
||
| 189 | |||
| 190 | $encodings = array_diff(mb_list_encodings(), array('pass', 'auto', 'wchar', 'BASE64', 'UUENCODE', 'ASCII', |
||
| 191 | 'HTML-ENTITIES', 'Quoted-Printable', '7bit','8bit', 'byte2be', 'byte2le', 'byte4be', 'byte4le')); |
||
| 192 | $this->accepted_charset_encodings = array_unique(array_merge($this->accepted_charset_encodings, $encodings)); |
||
| 193 | }*/ |
||
| 194 | |||
| 195 | // initialize user_agent string |
||
| 196 | 605 | $this->user_agent = PhpXmlRpc::$xmlrpcName . ' ' . PhpXmlRpc::$xmlrpcVersion; |
|
| 197 | 605 | } |
|
| 198 | |||
| 199 | /** |
||
| 200 | * Enable/disable the echoing to screen of the xmlrpc responses received. The default is not no output anything. |
||
| 201 | * |
||
| 202 | * The debugging information at level 1 includes the raw data returned from the XML-RPC server it was querying |
||
| 203 | * (including bot HTTP headers and the full XML payload), and the PHP value the client attempts to create to |
||
| 204 | * represent the value returned by the server |
||
| 205 | * At level2, the complete payload of the xmlrpc request is also printed, before being sent t the server. |
||
| 206 | * |
||
| 207 | * This option can be very useful when debugging servers as it allows you to see exactly what the client sends and |
||
| 208 | * the server returns. |
||
| 209 | * |
||
| 210 | * @param integer $level values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) |
||
| 211 | */ |
||
| 212 | 605 | public function setDebug($level) |
|
| 216 | |||
| 217 | /** |
||
| 218 | * Sets the username and password for authorizing the client to the server. |
||
| 219 | * |
||
| 220 | * With the default (HTTP) transport, this information is used for HTTP Basic authorization. |
||
| 221 | * Note that username and password can also be set using the class constructor. |
||
| 222 | * With HTTP 1.1 and HTTPS transport, NTLM and Digest authentication protocols are also supported. To enable them use |
||
| 223 | * the constants CURLAUTH_DIGEST and CURLAUTH_NTLM as values for the auth type parameter. |
||
| 224 | * |
||
| 225 | * @param string $user username |
||
| 226 | * @param string $password password |
||
| 227 | * @param integer $authType auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC |
||
| 228 | * (basic auth). Note that auth types NTLM and Digest will only work if the Curl php |
||
| 229 | * extension is enabled. |
||
| 230 | */ |
||
| 231 | 62 | public function setCredentials($user, $password, $authType = 1) |
|
| 237 | |||
| 238 | /** |
||
| 239 | * Set the optional certificate and passphrase used in SSL-enabled communication with a remote server. |
||
| 240 | * |
||
| 241 | * Note: to retrieve information about the client certificate on the server side, you will need to look into the |
||
| 242 | * environment variables which are set up by the webserver. Different webservers will typically set up different |
||
| 243 | * variables. |
||
| 244 | * |
||
| 245 | * @param string $cert the name of a file containing a PEM formatted certificate |
||
| 246 | * @param string $certPass the password required to use it |
||
| 247 | */ |
||
| 248 | public function setCertificate($cert, $certPass = '') |
||
| 253 | |||
| 254 | /** |
||
| 255 | * Add a CA certificate to verify server with in SSL-enabled communication when SetSSLVerifypeer has been set to TRUE. |
||
| 256 | * |
||
| 257 | * See the php manual page about CURLOPT_CAINFO for more details. |
||
| 258 | * |
||
| 259 | * @param string $caCert certificate file name (or dir holding certificates) |
||
| 260 | * @param bool $isDir set to true to indicate cacert is a dir. defaults to false |
||
| 261 | */ |
||
| 262 | public function setCaCertificate($caCert, $isDir = false) |
||
| 263 | { |
||
| 264 | if ($isDir) { |
||
| 265 | $this->cacertdir = $caCert; |
||
| 266 | } else { |
||
| 267 | $this->cacert = $caCert; |
||
| 268 | } |
||
| 269 | } |
||
| 270 | |||
| 271 | /** |
||
| 272 | * Set attributes for SSL communication: private SSL key. |
||
| 273 | * |
||
| 274 | * NB: does not work in older php/curl installs. |
||
| 275 | * Thanks to Daniel Convissor. |
||
| 276 | * |
||
| 277 | * @param string $key The name of a file containing a private SSL key |
||
| 278 | * @param string $keyPass The secret password needed to use the private SSL key |
||
| 279 | */ |
||
| 280 | public function setKey($key, $keyPass) |
||
| 285 | |||
| 286 | /** |
||
| 287 | * Set attributes for SSL communication: verify the remote host's SSL certificate, and cause the connection to fail |
||
| 288 | * if the cert verification fails. |
||
| 289 | * |
||
| 290 | * By default, verification is enabled. |
||
| 291 | * To specify custom SSL certificates to validate the server with, use the setCaCertificate method. |
||
| 292 | * |
||
| 293 | * @param bool $i enable/disable verification of peer certificate |
||
| 294 | */ |
||
| 295 | 93 | public function setSSLVerifyPeer($i) |
|
| 299 | |||
| 300 | /** |
||
| 301 | * Set attributes for SSL communication: verify the remote host's SSL certificate's common name (CN). |
||
| 302 | * |
||
| 303 | * Note that support for value 1 has been removed in cURL 7.28.1 |
||
| 304 | * |
||
| 305 | * @param int $i Set to 1 to only the existence of a CN, not that it matches |
||
| 306 | */ |
||
| 307 | 93 | public function setSSLVerifyHost($i) |
|
| 311 | |||
| 312 | /** |
||
| 313 | * Set attributes for SSL communication: SSL version to use. Best left at 0 (default value ): let cURL decide |
||
| 314 | * |
||
| 315 | * @param int $i |
||
| 316 | */ |
||
| 317 | 93 | public function setSSLVersion($i) |
|
| 321 | |||
| 322 | /** |
||
| 323 | * Set proxy info. |
||
| 324 | * |
||
| 325 | * NB: CURL versions before 7.11.10 cannot use a proxy to communicate with https servers. |
||
| 326 | * |
||
| 327 | * @param string $proxyHost |
||
| 328 | * @param string $proxyPort Defaults to 8080 for HTTP and 443 for HTTPS |
||
| 329 | * @param string $proxyUsername Leave blank if proxy has public access |
||
| 330 | * @param string $proxyPassword Leave blank if proxy has public access |
||
| 331 | * @param int $proxyAuthType defaults to CURLAUTH_BASIC (Basic authentication protocol); set to constant CURLAUTH_NTLM |
||
| 332 | * to use NTLM auth with proxy (has effect only when the client uses the HTTP 1.1 protocol) |
||
| 333 | */ |
||
| 334 | 93 | public function setProxy($proxyHost, $proxyPort, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1) |
|
| 342 | |||
| 343 | /** |
||
| 344 | * Enables/disables reception of compressed xmlrpc responses. |
||
| 345 | * |
||
| 346 | * This requires the "zlib" extension to be enabled in your php install. If it is, by default xmlrpc_client |
||
| 347 | * instances will enable reception of compressed content. |
||
| 348 | * Note that enabling reception of compressed responses merely adds some standard http headers to xmlrpc requests. |
||
| 349 | * It is up to the xmlrpc server to return compressed responses when receiving such requests. |
||
| 350 | * |
||
| 351 | * @param string $compMethod either 'gzip', 'deflate', 'any' or '' |
||
| 352 | */ |
||
| 353 | public function setAcceptedCompression($compMethod) |
||
| 354 | { |
||
| 355 | if ($compMethod == 'any') { |
||
| 356 | $this->accepted_compression = array('gzip', 'deflate'); |
||
| 357 | } elseif ($compMethod == false) { |
||
| 358 | $this->accepted_compression = array(); |
||
| 359 | } else { |
||
| 360 | $this->accepted_compression = array($compMethod); |
||
| 361 | } |
||
| 362 | } |
||
| 363 | |||
| 364 | /** |
||
| 365 | * Enables/disables http compression of xmlrpc request. |
||
| 366 | * |
||
| 367 | * This requires the "zlib" extension to be enabled in your php install. |
||
| 368 | * Take care when sending compressed requests: servers might not support them (and automatic fallback to |
||
| 369 | * uncompressed requests is not yet implemented). |
||
| 370 | * |
||
| 371 | * @param string $compMethod either 'gzip', 'deflate' or '' |
||
| 372 | */ |
||
| 373 | public function setRequestCompression($compMethod) |
||
| 377 | |||
| 378 | /** |
||
| 379 | * Adds a cookie to list of cookies that will be sent to server with every further request (useful e.g. for keeping |
||
| 380 | * session info outside of the xml-rpc payload). |
||
| 381 | * |
||
| 382 | * NB: By default cookies are sent using the 'original/netscape' format, which is also the same as the RFC 2965; |
||
| 383 | * setting any param but name and value will turn the cookie into a 'version 1' cookie (i.e. RFC 2109 cookie) that |
||
| 384 | * might not be fully supported by the server. Note that RFC 2109 has currently 'historic' status... |
||
| 385 | * |
||
| 386 | * @param string $name nb: will not be escaped in the request's http headers. Take care not to use CTL chars or |
||
| 387 | * separators! |
||
| 388 | * @param string $value |
||
| 389 | * @param string $path leave this empty unless the xml-rpc server only accepts RFC 2109 cookies |
||
| 390 | * @param string $domain leave this empty unless the xml-rpc server only accepts RFC 2109 cookies |
||
| 391 | * @param int $port leave this empty unless the xml-rpc server only accepts RFC 2109 cookies |
||
| 392 | * |
||
| 393 | * @todo check correctness of urlencoding cookie value (copied from php way of doing it, but php is generally sending |
||
| 394 | * response not requests. We do the opposite...) |
||
| 395 | * @todo strip invalid chars from cookie name? As per RFC6265, we should follow RFC2616, Section 2.2 |
||
| 396 | */ |
||
| 397 | 507 | public function setCookie($name, $value = '', $path = '', $domain = '', $port = null) |
|
| 398 | { |
||
| 399 | 507 | $this->cookies[$name]['value'] = urlencode($value); |
|
| 400 | 507 | if ($path || $domain || $port) { |
|
| 401 | $this->cookies[$name]['path'] = $path; |
||
| 402 | $this->cookies[$name]['domain'] = $domain; |
||
| 403 | $this->cookies[$name]['port'] = $port; |
||
| 404 | $this->cookies[$name]['version'] = 1; |
||
| 405 | } else { |
||
| 406 | 507 | $this->cookies[$name]['version'] = 0; |
|
| 407 | } |
||
| 408 | 507 | } |
|
| 409 | |||
| 410 | /** |
||
| 411 | * Directly set cURL options, for extra flexibility (when in cURL mode). |
||
| 412 | * |
||
| 413 | * It allows eg. to bind client to a specific IP interface / address. |
||
| 414 | * |
||
| 415 | * @param array $options |
||
| 416 | */ |
||
| 417 | public function setCurlOptions($options) |
||
| 421 | |||
| 422 | /** |
||
| 423 | * @param int $useCurlMode self::USE_CURL_ALWAYS, self::USE_CURL_AUTO or self::USE_CURL_NEVER |
||
| 424 | */ |
||
| 425 | 62 | public function setUseCurl($useCurlMode) |
|
| 429 | |||
| 430 | |||
| 431 | /** |
||
| 432 | * Set user-agent string that will be used by this client instance in http headers sent to the server. |
||
| 433 | * |
||
| 434 | * The default user agent string includes the name of this library and the version number. |
||
| 435 | * |
||
| 436 | * @param string $agentString |
||
| 437 | */ |
||
| 438 | public function setUserAgent($agentString) |
||
| 442 | |||
| 443 | /** |
||
| 444 | * Send an xmlrpc request to the server. |
||
| 445 | * |
||
| 446 | * @param Request|Request[]|string $req The Request object, or an array of requests for using multicall, or the |
||
| 447 | * complete xml representation of a request. |
||
| 448 | * When sending an array of Request objects, the client will try to make use of |
||
| 449 | * a single 'system.multicall' xml-rpc method call to forward to the server all |
||
| 450 | * the requests in a single HTTP round trip, unless $this->no_multicall has |
||
| 451 | * been previously set to TRUE (see the multicall method below), in which case |
||
| 452 | * many consecutive xmlrpc requests will be sent. The method will return an |
||
| 453 | * array of Response objects in both cases. |
||
| 454 | * The third variant allows to build by hand (or any other means) a complete |
||
| 455 | * xmlrpc request message, and send it to the server. $req should be a string |
||
| 456 | * containing the complete xml representation of the request. It is e.g. useful |
||
| 457 | * when, for maximal speed of execution, the request is serialized into a |
||
| 458 | * string using the native php xmlrpc functions (see http://www.php.net/xmlrpc) |
||
| 459 | * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply. |
||
| 460 | * This timeout value is passed to fsockopen(). It is also used for detecting server |
||
| 461 | * timeouts during communication (i.e. if the server does not send anything to the client |
||
| 462 | * for $timeout seconds, the connection will be closed). |
||
| 463 | * @param string $method valid values are 'http', 'http11' and 'https'. If left unspecified, the http protocol |
||
| 464 | * chosen during creation of the object will be used. |
||
| 465 | * |
||
| 466 | * @return Response|Response[] Note that the client will always return a Response object, even if the call fails |
||
| 467 | */ |
||
| 468 | 586 | public function send($req, $timeout = 0, $method = '') |
|
| 469 | { |
||
| 470 | // if user does not specify http protocol, use native method of this client |
||
| 471 | // (i.e. method set during call to constructor) |
||
| 472 | 586 | if ($method == '') { |
|
| 473 | 79 | $method = $this->method; |
|
| 474 | } |
||
| 475 | |||
| 476 | 586 | if (is_array($req)) { |
|
| 477 | // $req is an array of Requests |
||
| 478 | 58 | $r = $this->multicall($req, $timeout, $method); |
|
| 479 | |||
| 480 | 58 | return $r; |
|
| 481 | 586 | } elseif (is_string($req)) { |
|
| 482 | 26 | $n = new Request(''); |
|
| 483 | 26 | $n->payload = $req; |
|
| 484 | 26 | $req = $n; |
|
| 485 | } |
||
| 486 | |||
| 487 | // where req is a Request |
||
| 488 | 586 | $req->setDebug($this->debug); |
|
| 489 | |||
| 490 | /// @todo we could be smarter about this and force usage of curl in scenarios where it is both available and |
||
| 491 | /// needed, such as digest or ntlm auth. Do not attempt to use it for https if not present |
||
| 492 | 586 | $useCurl = ($this->use_curl == self::USE_CURL_ALWAYS) || ($this->use_curl == self::USE_CURL_AUTO && |
|
| 493 | 586 | ($method == 'https' || $method == 'http11')); |
|
| 494 | |||
| 495 | 586 | if ($useCurl) { |
|
| 496 | 242 | $r = $this->sendPayloadCURL( |
|
| 497 | 242 | $req, |
|
| 498 | 242 | $this->server, |
|
| 499 | 242 | $this->port, |
|
| 500 | $timeout, |
||
| 501 | 242 | $this->username, |
|
| 502 | 242 | $this->password, |
|
| 503 | 242 | $this->authtype, |
|
| 504 | 242 | $this->cert, |
|
| 505 | 242 | $this->certpass, |
|
| 506 | 242 | $this->cacert, |
|
| 507 | 242 | $this->cacertdir, |
|
| 508 | 242 | $this->proxy, |
|
| 509 | 242 | $this->proxyport, |
|
| 510 | 242 | $this->proxy_user, |
|
| 511 | 242 | $this->proxy_pass, |
|
| 512 | 242 | $this->proxy_authtype, |
|
| 513 | // bc |
||
| 514 | 242 | $method == 'http11' ? 'http' : $method, |
|
| 515 | 242 | $this->keepalive, |
|
| 516 | 242 | $this->key, |
|
| 517 | 242 | $this->keypass, |
|
| 518 | 242 | $this->sslversion |
|
| 519 | ); |
||
| 520 | } else { |
||
| 521 | // plain 'http 1.0': default to using socket |
||
| 522 | 344 | $r = $this->sendPayloadSocket( |
|
| 523 | 344 | $req, |
|
| 524 | 344 | $this->server, |
|
| 525 | 344 | $this->port, |
|
| 526 | $timeout, |
||
| 527 | 344 | $this->username, |
|
| 528 | 344 | $this->password, |
|
| 529 | 344 | $this->authtype, |
|
| 530 | 344 | $this->cert, |
|
| 531 | 344 | $this->certpass, |
|
| 532 | 344 | $this->cacert, |
|
| 533 | 344 | $this->cacertdir, |
|
| 534 | 344 | $this->proxy, |
|
| 535 | 344 | $this->proxyport, |
|
| 536 | 344 | $this->proxy_user, |
|
| 537 | 344 | $this->proxy_pass, |
|
| 538 | 344 | $this->proxy_authtype, |
|
| 539 | $method, |
||
| 540 | 344 | $this->key, |
|
| 541 | 344 | $this->keypass, |
|
| 542 | 344 | $this->sslversion |
|
| 543 | ); |
||
| 544 | } |
||
| 545 | |||
| 546 | 586 | return $r; |
|
| 547 | } |
||
| 548 | |||
| 549 | /** |
||
| 550 | * @deprecated |
||
| 551 | * @param Request $req |
||
| 552 | * @param string $server |
||
| 553 | * @param int $port |
||
| 554 | * @param int $timeout |
||
| 555 | * @param string $username |
||
| 556 | * @param string $password |
||
| 557 | * @param int $authType |
||
| 558 | * @param string $proxyHost |
||
| 559 | * @param int $proxyPort |
||
| 560 | * @param string $proxyUsername |
||
| 561 | * @param string $proxyPassword |
||
| 562 | * @param int $proxyAuthType |
||
| 563 | * @param string $method |
||
| 564 | * @return Response |
||
| 565 | */ |
||
| 566 | protected function sendPayloadHTTP10($req, $server, $port, $timeout = 0, $username = '', $password = '', |
||
| 573 | |||
| 574 | /** |
||
| 575 | * @deprecated |
||
| 576 | * @param Request $req |
||
| 577 | * @param string $server |
||
| 578 | * @param int $port |
||
| 579 | * @param int $timeout |
||
| 580 | * @param string $username |
||
| 581 | * @param string $password |
||
| 582 | * @param int $authType |
||
| 583 | * @param string $cert |
||
| 584 | * @param string $certPass |
||
| 585 | * @param string $caCert |
||
| 586 | * @param string $caCertDir |
||
| 587 | * @param string $proxyHost |
||
| 588 | * @param int $proxyPort |
||
| 589 | * @param string $proxyUsername |
||
| 590 | * @param string $proxyPassword |
||
| 591 | * @param int $proxyAuthType |
||
| 592 | * @param bool $keepAlive |
||
| 593 | * @param string $key |
||
| 594 | * @param string $keyPass |
||
| 595 | * @param int $sslVersion |
||
| 596 | * @return Response |
||
| 597 | */ |
||
| 598 | protected function sendPayloadHTTPS($req, $server, $port, $timeout = 0, $username = '', $password = '', |
||
| 607 | |||
| 608 | /** |
||
| 609 | * @param Request $req |
||
| 610 | * @param string $server |
||
| 611 | * @param int $port |
||
| 612 | * @param int $timeout |
||
| 613 | * @param string $username |
||
| 614 | * @param string $password |
||
| 615 | * @param int $authType only value supported is 1 |
||
| 616 | * @param string $cert |
||
| 617 | * @param string $certPass |
||
| 618 | * @param string $caCert |
||
| 619 | * @param string $caCertDir |
||
| 620 | * @param string $proxyHost |
||
| 621 | * @param int $proxyPort |
||
| 622 | * @param string $proxyUsername |
||
| 623 | * @param string $proxyPassword |
||
| 624 | * @param int $proxyAuthType only value supported is 1 |
||
| 625 | * @param string $method 'http' (synonym for 'http10'), 'http10' or 'https' |
||
| 626 | * @param string $key |
||
| 627 | * @param string $keyPass @todo not implemented yet. |
||
| 628 | * @param int $sslVersion @todo not implemented yet. See http://php.net/manual/en/migration56.openssl.php |
||
| 629 | * @return Response |
||
| 630 | */ |
||
| 631 | 344 | protected function sendPayloadSocket($req, $server, $port, $timeout = 0, $username = '', $password = '', |
|
| 819 | |||
| 820 | /** |
||
| 821 | * Contributed by Justin Miller <[email protected]> |
||
| 822 | * Requires curl to be built into PHP |
||
| 823 | * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers! |
||
| 824 | * |
||
| 825 | * @param Request $req |
||
| 826 | * @param string $server |
||
| 827 | * @param int $port |
||
| 828 | * @param int $timeout |
||
| 829 | * @param string $username |
||
| 830 | * @param string $password |
||
| 831 | * @param int $authType |
||
| 832 | * @param string $cert |
||
| 833 | * @param string $certPass |
||
| 834 | * @param string $caCert |
||
| 835 | * @param string $caCertDir |
||
| 836 | * @param string $proxyHost |
||
| 837 | * @param int $proxyPort |
||
| 838 | * @param string $proxyUsername |
||
| 839 | * @param string $proxyPassword |
||
| 840 | * @param int $proxyAuthType |
||
| 841 | * @param string $method 'http' (let curl decide), 'http10', 'http11' or 'https' |
||
| 842 | * @param bool $keepAlive |
||
| 843 | * @param string $key |
||
| 844 | * @param string $keyPass |
||
| 845 | * @param int $sslVersion |
||
| 846 | * @return Response |
||
| 847 | */ |
||
| 848 | 242 | protected function sendPayloadCURL($req, $server, $port, $timeout = 0, $username = '', $password = '', |
|
| 1081 | |||
| 1082 | /** |
||
| 1083 | * Send an array of requests and return an array of responses. |
||
| 1084 | * |
||
| 1085 | * Unless $this->no_multicall has been set to true, it will try first to use one single xmlrpc call to server method |
||
| 1086 | * system.multicall, and revert to sending many successive calls in case of failure. |
||
| 1087 | * This failure is also stored in $this->no_multicall for subsequent calls. |
||
| 1088 | * Unfortunately, there is no server error code universally used to denote the fact that multicall is unsupported, |
||
| 1089 | * so there is no way to reliably distinguish between that and a temporary failure. |
||
| 1090 | * If you are sure that server supports multicall and do not want to fallback to using many single calls, set the |
||
| 1091 | * fourth parameter to FALSE. |
||
| 1092 | * |
||
| 1093 | * NB: trying to shoehorn extra functionality into existing syntax has resulted |
||
| 1094 | * in pretty much convoluted code... |
||
| 1095 | * |
||
| 1096 | * @param Request[] $reqs an array of Request objects |
||
| 1097 | * @param integer $timeout connection timeout (in seconds). See the details in the docs for the send() method |
||
| 1098 | * @param string $method the http protocol variant to be used. See the details in the docs for the send() method |
||
| 1099 | * @param boolean fallback When true, upon receiving an error during multicall, multiple single calls will be |
||
| 1100 | * attempted |
||
| 1101 | * |
||
| 1102 | * @return Response[] |
||
| 1103 | */ |
||
| 1104 | 58 | public function multicall($reqs, $timeout = 0, $method = '', $fallback = true) |
|
| 1152 | |||
| 1153 | /** |
||
| 1154 | * Attempt to boxcar $reqs via system.multicall. |
||
| 1155 | * |
||
| 1156 | * Returns either an array of Response, a single error Response or false (when received response does not respect |
||
| 1157 | * valid multicall syntax). |
||
| 1158 | * |
||
| 1159 | * @param Request[] $reqs |
||
| 1160 | * @param int $timeout |
||
| 1161 | * @param string $method |
||
| 1162 | * @return Response[]|bool|mixed|Response |
||
| 1163 | */ |
||
| 1164 | 39 | private function _try_multicall($reqs, $timeout, $method) |
|
| 1280 | } |
||
| 1281 |
Loading history...
This check looks for assignments to scalar types that may be of the wrong type.
To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.