namespace PhpXmlRpc;
+use PhpXmlRpc\Helper\Logger;
+
+/**
+ * The basic class used to represent a client of an XML-RPC server.
+ */
class Client
{
/// @todo: do these need to be public?
- public $path;
+ public $method = 'http';
public $server;
public $port = 0;
- public $method = 'http';
+ public $path;
+
public $errno;
public $errstr;
public $debug = 0;
+
public $username = '';
public $password = '';
public $authtype = 1;
+
public $cert = '';
public $certpass = '';
public $cacert = '';
public $verifypeer = true;
public $verifyhost = 2;
public $sslversion = 0; // corresponds to CURL_SSLVERSION_DEFAULT
- public $no_multicall = false;
+
public $proxy = '';
public $proxyport = 0;
public $proxy_user = '';
public $proxy_pass = '';
public $proxy_authtype = 1;
+
public $cookies = array();
public $extracurlopts = array();
+ /**
+ * @var bool
+ *
+ * This determines whether the multicall() method will try to take advantage of the system.multicall xmlrpc method
+ * to dispatch to the server an array of requests in a single http roundtrip or simply execute many consecutive http
+ * calls. Defaults to FALSE, but it will be enabled automatically on the first failure of execution of
+ * system.multicall.
+ */
+ public $no_multicall = false;
+
/**
* List of http compression methods accepted by the client for responses.
* NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib.
* curl_version() to determine wheter compression is supported or not
*/
public $accepted_compression = array();
+
/**
* Name of compression scheme to be used for sending requests.
* Either null, gzip or deflate.
*/
+
public $request_compression = '';
/**
* CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
* http://curl.haxx.se/docs/faq.html#7.3).
*/
public $xmlrpc_curl_handle = null;
+
/// Whether to use persistent connections for http 1.1 and https
public $keepalive = false;
+
/// Charset encodings that can be decoded without problems by the client
public $accepted_charset_encodings = array();
- /// Charset encoding to be used in serializing request. NULL = use ASCII
+
+ /**
+ * The charset encoding that will be used for serializing request sent by the client.
+ * If defaults to NULL, which means using US-ASCII and encoding all characters outside of the ASCII range using
+ * their xml character entity representation (this has the benefit that line end characters will not be mangled in
+ * the transfer, a CR-LF will be preserved as well as a singe LF).
+ * Valid values are 'US-ASCII', 'UTF-8' and 'ISO-8859-1'
+ */
public $request_charset_encoding = '';
+
/**
- * Decides the content of Response objects returned by calls to send()
- * valid strings are 'xmlrpcvals', 'phpvals' or 'xml'.
+ * Decides the content of Response objects returned by calls to send() and multicall().
+ * Valid values are 'xmlrpcvals', 'phpvals' or 'xml'.
+ *
+ * Determines whether the value returned inside an Response object as results of calls to the send() and multicall()
+ * methods will be a Value object, a plain php value or a raw xml string.
+ * Allowed values are 'xmlrpcvals' (the default), 'phpvals' and 'xml'.
+ * To allow the user to differentiate between a correct and a faulty response, fault responses will be returned as
+ * Response objects in any case.
+ * Note that the 'phpvals' setting will yield faster execution times, but some of the information from the original
+ * response will be lost. It will be e.g. impossible to tell whether a particular php string value was sent by the
+ * server as an xmlrpc string or base64 value.
*/
public $return_type = 'xmlrpcvals';
+
/**
* Sent to servers in http headers.
*/
public $user_agent;
/**
- * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php
+ * @param string $path either the PATH part of the xmlrpc server URL, or complete server URL (in which case you
+ * should use and empty string for all other parameters)
+ * e.g. /xmlrpc/server.php
+ * e.g. http://phpxmlrpc.sourceforge.net/server.php
+ * e.g. https://james:bond@secret.service.com:443/xmlrpcserver?agent=007
* @param string $server the server name / ip address
- * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used
- * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed
+ * @param integer $port the port the server is listening on, when omitted defaults to 80 or 443 depending on
+ * protocol used
+ * @param string $method the http protocol variant: defaults to 'http'; 'https' and 'http11' can be used if CURL is
+ * installed. The value set here can be overridden in any call to $this->send().
*/
public function __construct($path, $server = '', $port = '', $method = '')
{
// by default the xml parser can support these 3 charset encodings
$this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
+ // Add all charsets which mbstring can handle, but remove junk not found in IANA registry at
+ // in http://www.iana.org/assignments/character-sets/character-sets.xhtml
+ // NB: this is disabled to avoid making all the requests sent huge... mbstring supports more than 80 charsets!
+ /*if (function_exists('mb_list_encodings')) {
+
+ $encodings = array_diff(mb_list_encodings(), array('pass', 'auto', 'wchar', 'BASE64', 'UUENCODE', 'ASCII',
+ 'HTML-ENTITIES', 'Quoted-Printable', '7bit','8bit', 'byte2be', 'byte2le', 'byte4be', 'byte4le'));
+ $this->accepted_charset_encodings = array_unique(array_merge($this->accepted_charset_encodings, $encodings));
+ }*/
+
// initialize user_agent string
$this->user_agent = PhpXmlRpc::$xmlrpcName . ' ' . PhpXmlRpc::$xmlrpcVersion;
}
/**
- * Enables/disables the echoing to screen of the xmlrpc responses received.
+ * Enable/disable the echoing to screen of the xmlrpc responses received. The default is not no output anything.
+ *
+ * The debugging information at level 1 includes the raw data returned from the XML-RPC server it was querying
+ * (including bot HTTP headers and the full XML payload), and the PHP value the client attempts to create to
+ * represent the value returned by the server
+ * At level2, the complete payload of the xmlrpc request is also printed, before being sent t the server.
+ *
+ * This option can be very useful when debugging servers as it allows you to see exactly what the client sends and
+ * the server returns.
*
* @param integer $in values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
*/
- public function setDebug($in)
+ public function setDebug($level)
{
- $this->debug = $in;
+ $this->debug = $level;
}
/**
- * Add some http BASIC AUTH credentials, used by the client to authenticate.
+ * Sets the username and password for authorizing the client to the server.
*
- * @param string $u username
- * @param string $p password
- * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)
+ * With the default (HTTP) transport, this information is used for HTTP Basic authorization.
+ * Note that username and password can also be set using the class constructor.
+ * With HTTP 1.1 and HTTPS transport, NTLM and Digest authentication protocols are also supported. To enable them use
+ * the constants CURLAUTH_DIGEST and CURLAUTH_NTLM as values for the auth type parameter.
+ *
+ * @param string $user username
+ * @param string $password password
+ * @param integer $authType auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC
+ * (basic auth). Note that auth types NTLM and Digest will only work if the Curl php
+ * extension is enabled.
*/
- public function setCredentials($u, $p, $t = 1)
+ public function setCredentials($user, $password, $authType = 1)
{
- $this->username = $u;
- $this->password = $p;
- $this->authtype = $t;
+ $this->username = $user;
+ $this->password = $password;
+ $this->authtype = $authType;
}
/**
- * Add a client-side https certificate.
+ * Set the optional certificate and passphrase used in SSL-enabled communication with a remote server.
*
- * @param string $cert
- * @param string $certpass
+ * Note: to retrieve information about the client certificate on the server side, you will need to look into the
+ * environment variables which are set up by the webserver. Different webservers will typically set up different
+ * variables.
+ *
+ * @param string $cert the name of a file containing a PEM formatted certificate
+ * @param string $certPass the password required to use it
*/
- public function setCertificate($cert, $certpass)
+ public function setCertificate($cert, $certPass = '')
{
$this->cert = $cert;
- $this->certpass = $certpass;
+ $this->certpass = $certPass;
}
/**
- * Add a CA certificate to verify server with (see man page about
- * CURLOPT_CAINFO for more details).
+ * Add a CA certificate to verify server with in SSL-enabled communication when SetSSLVerifypeer has been set to TRUE.
*
- * @param string $cacert certificate file name (or dir holding certificates)
- * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false
+ * See the php manual page about CURLOPT_CAINFO for more details.
+ *
+ * @param string $caCert certificate file name (or dir holding certificates)
+ * @param bool $isDir set to true to indicate cacert is a dir. defaults to false
*/
- public function setCaCertificate($cacert, $is_dir = false)
+ public function setCaCertificate($caCert, $isDir = false)
{
- if ($is_dir) {
- $this->cacertdir = $cacert;
+ if ($isDir) {
+ $this->cacertdir = $caCert;
} else {
- $this->cacert = $cacert;
+ $this->cacert = $caCert;
}
}
/**
- * Set attributes for SSL communication: private SSL key
- * NB: does not work in older php/curl installs
+ * Set attributes for SSL communication: private SSL key.
+ *
+ * NB: does not work in older php/curl installs.
* Thanks to Daniel Convissor.
*
* @param string $key The name of a file containing a private SSL key
- * @param string $keypass The secret password needed to use the private SSL key
+ * @param string $keyPass The secret password needed to use the private SSL key
*/
- public function setKey($key, $keypass)
+ public function setKey($key, $keyPass)
{
$this->key = $key;
- $this->keypass = $keypass;
+ $this->keypass = $keyPass;
}
/**
- * Set attributes for SSL communication: verify server certificate.
+ * Set attributes for SSL communication: verify the remote host's SSL certificate, and cause the connection to fail
+ * if the cert verification fails.
+ *
+ * By default, verification is enabled.
+ * To specify custom SSL certificates to validate the server with, use the setCaCertificate method.
*
* @param bool $i enable/disable verification of peer certificate
*/
}
/**
- * Set attributes for SSL communication: verify match of server cert w. hostname.
+ * Set attributes for SSL communication: verify the remote host's SSL certificate's common name (CN).
*
- * @param int $i
+ * Note that support for value 1 has been removed in cURL 7.28.1
+ *
+ * @param int $i Set to 1 to only the existence of a CN, not that it matches
*/
public function setSSLVerifyHost($i)
{
/**
* Set proxy info.
*
- * @param string $proxyhost
- * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS
- * @param string $proxyusername Leave blank if proxy has public access
- * @param string $proxypassword Leave blank if proxy has public access
- * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy
+ * NB: CURL versions before 7.11.10 cannot use a proxy to communicate with https servers.
+ *
+ * @param string $proxyHost
+ * @param string $proxyPort Defaults to 8080 for HTTP and 443 for HTTPS
+ * @param string $proxyUsername Leave blank if proxy has public access
+ * @param string $proxyPassword Leave blank if proxy has public access
+ * @param int $proxyAuthType defaults to CURLAUTH_BASIC (Basic authentication protocol); set to constant CURLAUTH_NTLM
+ * to use NTLM auth with proxy (has effect only when the client uses the HTTP 1.1 protocol)
*/
- public function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)
+ public function setProxy($proxyHost, $proxyPort, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1)
{
- $this->proxy = $proxyhost;
- $this->proxyport = $proxyport;
- $this->proxy_user = $proxyusername;
- $this->proxy_pass = $proxypassword;
- $this->proxy_authtype = $proxyauthtype;
+ $this->proxy = $proxyHost;
+ $this->proxyport = $proxyPort;
+ $this->proxy_user = $proxyUsername;
+ $this->proxy_pass = $proxyPassword;
+ $this->proxy_authtype = $proxyAuthType;
}
/**
* Enables/disables reception of compressed xmlrpc responses.
- * Note that enabling reception of compressed responses merely adds some standard
- * http headers to xmlrpc requests. It is up to the xmlrpc server to return
- * compressed responses when receiving such requests.
*
- * @param string $compmethod either 'gzip', 'deflate', 'any' or ''
+ * This requires the "zlib" extension to be enabled in your php install. If it is, by default xmlrpc_client
+ * instances will enable reception of compressed content.
+ * Note that enabling reception of compressed responses merely adds some standard http headers to xmlrpc requests.
+ * It is up to the xmlrpc server to return compressed responses when receiving such requests.
+ *
+ * @param string $compMethod either 'gzip', 'deflate', 'any' or ''
*/
- public function setAcceptedCompression($compmethod)
+ public function setAcceptedCompression($compMethod)
{
- if ($compmethod == 'any') {
+ if ($compMethod == 'any') {
$this->accepted_compression = array('gzip', 'deflate');
- } elseif ($compmethod == false) {
+ } elseif ($compMethod == false) {
$this->accepted_compression = array();
} else {
- $this->accepted_compression = array($compmethod);
+ $this->accepted_compression = array($compMethod);
}
}
/**
* Enables/disables http compression of xmlrpc request.
- * Take care when sending compressed requests: servers might not support them
- * (and automatic fallback to uncompressed requests is not yet implemented).
*
- * @param string $compmethod either 'gzip', 'deflate' or ''
+ * This requires the "zlib" extension to be enabled in your php install.
+ * Take care when sending compressed requests: servers might not support them (and automatic fallback to
+ * uncompressed requests is not yet implemented).
+ *
+ * @param string $compMethod either 'gzip', 'deflate' or ''
*/
- public function setRequestCompression($compmethod)
+ public function setRequestCompression($compMethod)
{
- $this->request_compression = $compmethod;
+ $this->request_compression = $compMethod;
}
/**
- * Adds a cookie to list of cookies that will be sent to server.
- * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie:
- * do not do it unless you know what you are doing.
+ * Adds a cookie to list of cookies that will be sent to server with every further request (useful e.g. for keeping
+ * session info outside of the xml-rpc payload).
+ *
+ * NB: By default cookies are sent using the 'original/netscape' format, which is also the same as the RFC 2965;
+ * setting any param but name and value will turn the cookie into a 'version 1' cookie (i.e. RFC 2109 cookie) that
+ * might not be fully supported by the server. Note that RFC 2109 has currently 'historic' status...
*
- * @param string $name
+ * @param string $name nb: will not be escaped in the request's http headers. Take care not to use CTL chars or
+ * separators!
* @param string $value
- * @param string $path
- * @param string $domain
- * @param int $port
+ * @param string $path leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
+ * @param string $domain leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
+ * @param int $port leave this empty unless the xml-rpc server only accepts RFC 2109 cookies
*
- * @todo check correctness of urlencoding cookie value (copied from php way of doing it...)
+ * @todo check correctness of urlencoding cookie value (copied from php way of doing it, but php is generally sending
+ * response not requests. We do the opposite...)
+ * @todo strip invalid chars from cookie name? As per RFC6265, we should follow RFC2616, Section 2.2
*/
public function setCookie($name, $value = '', $path = '', $domain = '', $port = null)
{
}
/**
- * Directly set cURL options, for extra flexibility
+ * Directly set cURL options, for extra flexibility (when in cURL mode).
+ *
* It allows eg. to bind client to a specific IP interface / address.
*
* @param array $options
*/
- public function SetCurlOptions($options)
+ public function setCurlOptions($options)
{
$this->extracurlopts = $options;
}
/**
- * Set user-agent string that will be used by this client instance
- * in http headers sent to the server.
+ * Set user-agent string that will be used by this client instance in http headers sent to the server.
+ *
+ * The default user agent string includes the name of this library and the version number.
+ *
+ * @param string $agentString
*/
- public function SetUserAgent($agentstring)
+ public function setUserAgent($agentString)
{
- $this->user_agent = $agentstring;
+ $this->user_agent = $agentString;
}
/**
- * Send an xmlrpc request.
+ * Send an xmlrpc request to the server.
*
- * @param mixed $msg The request object, or an array of requests for using multicall, or the complete xml representation of a request
- * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply
- * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used
+ * @param Request|Request[]|string $req The Request object, or an array of requests for using multicall, or the
+ * complete xml representation of a request.
+ * When sending an array of Request objects, the client will try to make use of
+ * a single 'system.multicall' xml-rpc method call to forward to the server all
+ * the requests in a single HTTP round trip, unless $this->no_multicall has
+ * been previously set to TRUE (see the multicall method below), in which case
+ * many consecutive xmlrpc requests will be sent. The method will return an
+ * array of Response objects in both cases.
+ * The third variant allows to build by hand (or any other means) a complete
+ * xmlrpc request message, and send it to the server. $req should be a string
+ * containing the complete xml representation of the request. It is e.g. useful
+ * when, for maximal speed of execution, the request is serialized into a
+ * string using the native php xmlrpc functions (see http://www.php.net/xmlrpc)
+ * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply.
+ * This timeout value is passed to fsockopen(). It is also used for detecting server
+ * timeouts during communication (i.e. if the server does not send anything to the client
+ * for $timeout seconds, the connection will be closed).
+ * @param string $method valid values are 'http', 'http11' and 'https'. If left unspecified, the http protocol
+ * chosen during creation of the object will be used.
*
- * @return Response
+ *
+ * @return Response|Response[] Note that the client will always return a Response object, even if the call fails
*/
- public function & send($msg, $timeout = 0, $method = '')
+ public function send($req, $timeout = 0, $method = '')
{
// if user does not specify http protocol, use native method of this client
// (i.e. method set during call to constructor)
$method = $this->method;
}
- if (is_array($msg)) {
- // $msg is an array of Requests
- $r = $this->multicall($msg, $timeout, $method);
+ if (is_array($req)) {
+ // $req is an array of Requests
+ $r = $this->multicall($req, $timeout, $method);
return $r;
- } elseif (is_string($msg)) {
+ } elseif (is_string($req)) {
$n = new Request('');
- $n->payload = $msg;
- $msg = $n;
+ $n->payload = $req;
+ $req = $n;
}
- // where msg is a Request
- $msg->debug = $this->debug;
+ // where req is a Request
+ $req->setDebug($this->debug);
if ($method == 'https') {
$r = $this->sendPayloadHTTPS(
- $msg,
+ $req,
$this->server,
$this->port,
$timeout,
);
} elseif ($method == 'http11') {
$r = $this->sendPayloadCURL(
- $msg,
+ $req,
$this->server,
$this->port,
$timeout,
);
} else {
$r = $this->sendPayloadHTTP10(
- $msg,
+ $req,
$this->server,
$this->port,
$timeout,
$this->proxyport,
$this->proxy_user,
$this->proxy_pass,
- $this->proxy_authtype
+ $this->proxy_authtype,
+ $method
);
}
return $r;
}
- private function sendPayloadHTTP10($msg, $server, $port, $timeout = 0,
- $username = '', $password = '', $authtype = 1, $proxyhost = '',
- $proxyport = 0, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)
+ /**
+ * @param Request $req
+ * @param string $server
+ * @param int $port
+ * @param int $timeout
+ * @param string $username
+ * @param string $password
+ * @param int $authType
+ * @param string $proxyHost
+ * @param int $proxyPort
+ * @param string $proxyUsername
+ * @param string $proxyPassword
+ * @param int $proxyAuthType
+ * @param string $method
+ * @return Response
+ */
+ protected function sendPayloadHTTP10($req, $server, $port, $timeout = 0, $username = '', $password = '',
+ $authType = 1, $proxyHost = '', $proxyPort = 0, $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1,
+ $method='http')
{
if ($port == 0) {
- $port = 80;
+ $port = ( $method === "https" ) ? 443 : 80;
}
// Only create the payload if it was not created previously
- if (empty($msg->payload)) {
- $msg->createPayload($this->request_charset_encoding);
+ if (empty($req->payload)) {
+ $req->createPayload($this->request_charset_encoding);
}
- $payload = $msg->payload;
+ $payload = $req->payload;
// Deflate request body and set appropriate request headers
if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
if ($this->request_compression == 'gzip') {
$a = @gzencode($payload);
if ($a) {
$payload = $a;
- $encoding_hdr = "Content-Encoding: gzip\r\n";
+ $encodingHdr = "Content-Encoding: gzip\r\n";
}
} else {
$a = @gzcompress($payload);
if ($a) {
$payload = $a;
- $encoding_hdr = "Content-Encoding: deflate\r\n";
+ $encodingHdr = "Content-Encoding: deflate\r\n";
}
}
} else {
- $encoding_hdr = '';
+ $encodingHdr = '';
}
// thanks to Grant Rauscher <grant7@firstworld.net> for this
$credentials = '';
if ($username != '') {
$credentials = 'Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
- if ($authtype != 1) {
+ if ($authType != 1) {
error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported with HTTP 1.0');
}
}
- $accepted_encoding = '';
+ $acceptedEncoding = '';
if (is_array($this->accepted_compression) && count($this->accepted_compression)) {
- $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
+ $acceptedEncoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
}
- $proxy_credentials = '';
- if ($proxyhost) {
- if ($proxyport == 0) {
- $proxyport = 8080;
+ $proxyCredentials = '';
+ if ($proxyHost) {
+ if ($proxyPort == 0) {
+ $proxyPort = 8080;
}
- $connectserver = $proxyhost;
- $connectport = $proxyport;
+ $connectServer = $proxyHost;
+ $connectPort = $proxyPort;
+ $transport = "tcp";
$uri = 'http://' . $server . ':' . $port . $this->path;
- if ($proxyusername != '') {
- if ($proxyauthtype != 1) {
+ if ($proxyUsername != '') {
+ if ($proxyAuthType != 1) {
error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported with HTTP 1.0');
}
- $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername . ':' . $proxypassword) . "\r\n";
+ $proxyCredentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyUsername . ':' . $proxyPassword) . "\r\n";
}
} else {
- $connectserver = $server;
- $connectport = $port;
+ $connectServer = $server;
+ $connectPort = $port;
+ /// @todo if supporting https, we should support all its current options as well: peer name verification etc...
+ $transport = ( $method === "https" ) ? "tls" : "tcp";
$uri = $this->path;
}
// Cookie generation, as per rfc2965 (version 1 cookies) or
// netscape's rules (version 0 cookies)
- $cookieheader = '';
+ $cookieHeader = '';
if (count($this->cookies)) {
$version = '';
foreach ($this->cookies as $name => $cookie) {
if ($cookie['version']) {
$version = ' $Version="' . $cookie['version'] . '";';
- $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";';
+ $cookieHeader .= ' ' . $name . '="' . $cookie['value'] . '";';
if ($cookie['path']) {
- $cookieheader .= ' $Path="' . $cookie['path'] . '";';
+ $cookieHeader .= ' $Path="' . $cookie['path'] . '";';
}
if ($cookie['domain']) {
- $cookieheader .= ' $Domain="' . $cookie['domain'] . '";';
+ $cookieHeader .= ' $Domain="' . $cookie['domain'] . '";';
}
if ($cookie['port']) {
- $cookieheader .= ' $Port="' . $cookie['port'] . '";';
+ $cookieHeader .= ' $Port="' . $cookie['port'] . '";';
}
} else {
- $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";";
+ $cookieHeader .= ' ' . $name . '=' . $cookie['value'] . ";";
}
}
- $cookieheader = 'Cookie:' . $version . substr($cookieheader, 0, -1) . "\r\n";
+ $cookieHeader = 'Cookie:' . $version . substr($cookieHeader, 0, -1) . "\r\n";
}
// omit port if 80
'User-Agent: ' . $this->user_agent . "\r\n" .
'Host: ' . $server . $port . "\r\n" .
$credentials .
- $proxy_credentials .
- $accepted_encoding .
- $encoding_hdr .
+ $proxyCredentials .
+ $acceptedEncoding .
+ $encodingHdr .
'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" .
- $cookieheader .
- 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " .
+ $cookieHeader .
+ 'Content-Type: ' . $req->content_type . "\r\nContent-Length: " .
strlen($payload) . "\r\n\r\n" .
$payload;
if ($this->debug > 1) {
- $this->debugMessage("---SENDING---\n$op\n---END---");
+ Logger::instance()->debugMessage("---SENDING---\n$op\n---END---");
}
if ($timeout > 0) {
- $fp = @fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);
+ $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr, $timeout);
} else {
- $fp = @fsockopen($connectserver, $connectport, $this->errno, $this->errstr);
+ $fp = @stream_socket_client("$transport://$connectServer:$connectPort", $this->errno, $this->errstr);
}
if ($fp) {
- if ($timeout > 0 && function_exists('stream_set_timeout')) {
+ if ($timeout > 0) {
stream_set_timeout($fp, $timeout);
}
} else {
$ipd .= fread($fp, 32768);
} while (!feof($fp));
fclose($fp);
- $r = $msg->parseResponse($ipd, false, $this->return_type);
+ $r = $req->parseResponse($ipd, false, $this->return_type);
return $r;
}
- private function sendPayloadHTTPS($msg, $server, $port, $timeout = 0, $username = '',
- $password = '', $authtype = 1, $cert = '', $certpass = '', $cacert = '', $cacertdir = '',
- $proxyhost = '', $proxyport = 0, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1,
- $keepalive = false, $key = '', $keypass = '', $sslversion = 0)
+ /**
+ * @param Request $req
+ * @param string $server
+ * @param int $port
+ * @param int $timeout
+ * @param string $username
+ * @param string $password
+ * @param int $authType
+ * @param string $cert
+ * @param string $certPass
+ * @param string $caCert
+ * @param string $caCertDir
+ * @param string $proxyHost
+ * @param int $proxyPort
+ * @param string $proxyUsername
+ * @param string $proxyPassword
+ * @param int $proxyAuthType
+ * @param bool $keepAlive
+ * @param string $key
+ * @param string $keyPass
+ * @param int $sslVersion
+ * @return Response
+ */
+ protected function sendPayloadHTTPS($req, $server, $port, $timeout = 0, $username = '', $password = '',
+ $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0,
+ $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $keepAlive = false, $key = '', $keyPass = '',
+ $sslVersion = 0)
{
- $r = $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,
- $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,
- $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass, $sslversion);
-
- return $r;
+ return $this->sendPayloadCURL($req, $server, $port, $timeout, $username,
+ $password, $authType, $cert, $certPass, $caCert, $caCertDir, $proxyHost, $proxyPort,
+ $proxyUsername, $proxyPassword, $proxyAuthType, 'https', $keepAlive, $key, $keyPass, $sslVersion);
}
/**
* Contributed by Justin Miller <justin@voxel.net>
* Requires curl to be built into PHP
* NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
+ *
+ * @param Request $req
+ * @param string $server
+ * @param int $port
+ * @param int $timeout
+ * @param string $username
+ * @param string $password
+ * @param int $authType
+ * @param string $cert
+ * @param string $certPass
+ * @param string $caCert
+ * @param string $caCertDir
+ * @param string $proxyHost
+ * @param int $proxyPort
+ * @param string $proxyUsername
+ * @param string $proxyPassword
+ * @param int $proxyAuthType
+ * @param string $method
+ * @param bool $keepAlive
+ * @param string $key
+ * @param string $keyPass
+ * @param int $sslVersion
+ * @return Response
*/
- private function sendPayloadCURL($msg, $server, $port, $timeout = 0, $username = '',
- $password = '', $authtype = 1, $cert = '', $certpass = '', $cacert = '', $cacertdir = '',
- $proxyhost = '', $proxyport = 0, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1, $method = 'https',
- $keepalive = false, $key = '', $keypass = '', $sslversion = 0)
+ protected function sendPayloadCURL($req, $server, $port, $timeout = 0, $username = '', $password = '',
+ $authType = 1, $cert = '', $certPass = '', $caCert = '', $caCertDir = '', $proxyHost = '', $proxyPort = 0,
+ $proxyUsername = '', $proxyPassword = '', $proxyAuthType = 1, $method = 'https', $keepAlive = false, $key = '',
+ $keyPass = '', $sslVersion = 0)
{
if (!function_exists('curl_init')) {
$this->errstr = 'CURL unavailable on this install';
- $r = new Response(0, PhpXmlRpc::$xmlrpcerr['no_curl'], PhpXmlRpc::$xmlrpcstr['no_curl']);
-
- return $r;
+ return new Response(0, PhpXmlRpc::$xmlrpcerr['no_curl'], PhpXmlRpc::$xmlrpcstr['no_curl']);
}
if ($method == 'https') {
if (($info = curl_version()) &&
((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version'])))
) {
$this->errstr = 'SSL unavailable on this install';
- $r = new Response(0, PhpXmlRpc::$xmlrpcerr['no_ssl'], PhpXmlRpc::$xmlrpcstr['no_ssl']);
-
- return $r;
+ return new Response(0, PhpXmlRpc::$xmlrpcerr['no_ssl'], PhpXmlRpc::$xmlrpcstr['no_ssl']);
}
}
}
// Only create the payload if it was not created previously
- if (empty($msg->payload)) {
- $msg->createPayload($this->request_charset_encoding);
+ if (empty($req->payload)) {
+ $req->createPayload($this->request_charset_encoding);
}
// Deflate request body and set appropriate request headers
- $payload = $msg->payload;
+ $payload = $req->payload;
if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
if ($this->request_compression == 'gzip') {
$a = @gzencode($payload);
if ($a) {
$payload = $a;
- $encoding_hdr = 'Content-Encoding: gzip';
+ $encodingHdr = 'Content-Encoding: gzip';
}
} else {
$a = @gzcompress($payload);
if ($a) {
$payload = $a;
- $encoding_hdr = 'Content-Encoding: deflate';
+ $encodingHdr = 'Content-Encoding: deflate';
}
}
} else {
- $encoding_hdr = '';
+ $encodingHdr = '';
}
if ($this->debug > 1) {
- $this->debugMessage("---SENDING---\n$payload\n---END---");
- // let the client see this now in case http times out...
- flush();
+ Logger::instance()->debugMessage("---SENDING---\n$payload\n---END---");
}
- if (!$keepalive || !$this->xmlrpc_curl_handle) {
+ if (!$keepAlive || !$this->xmlrpc_curl_handle) {
$curl = curl_init($method . '://' . $server . ':' . $port . $this->path);
- if ($keepalive) {
+ if ($keepAlive) {
$this->xmlrpc_curl_handle = $curl;
}
} else {
}
// results into variable
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+ curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
- if ($this->debug) {
- curl_setopt($curl, CURLOPT_VERBOSE, 1);
+ if ($this->debug > 1) {
+ curl_setopt($curl, CURLOPT_VERBOSE, true);
+ /// @todo allow callers to redirect curlopt_stderr to some stream which can be buffered
}
curl_setopt($curl, CURLOPT_USERAGENT, $this->user_agent);
// required for XMLRPC: post the data
}
}
// extra headers
- $headers = array('Content-Type: ' . $msg->content_type, 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
+ $headers = array('Content-Type: ' . $req->content_type, 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
// if no keepalive is wanted, let the server know it in advance
- if (!$keepalive) {
+ if (!$keepAlive) {
$headers[] = 'Connection: close';
}
// request compression header
- if ($encoding_hdr) {
- $headers[] = $encoding_hdr;
+ if ($encodingHdr) {
+ $headers[] = $encodingHdr;
}
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
if ($username && $password) {
curl_setopt($curl, CURLOPT_USERPWD, $username . ':' . $password);
if (defined('CURLOPT_HTTPAUTH')) {
- curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);
- } elseif ($authtype != 1) {
+ curl_setopt($curl, CURLOPT_HTTPAUTH, $authType);
+ } elseif ($authType != 1) {
error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported by the current PHP/curl install');
}
}
curl_setopt($curl, CURLOPT_SSLCERT, $cert);
}
// set cert password
- if ($certpass) {
- curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass);
+ if ($certPass) {
+ curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certPass);
}
// whether to verify remote host's cert
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer);
// set ca certificates file/dir
- if ($cacert) {
- curl_setopt($curl, CURLOPT_CAINFO, $cacert);
+ if ($caCert) {
+ curl_setopt($curl, CURLOPT_CAINFO, $caCert);
}
- if ($cacertdir) {
- curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);
+ if ($caCertDir) {
+ curl_setopt($curl, CURLOPT_CAPATH, $caCertDir);
}
// set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
if ($key) {
curl_setopt($curl, CURLOPT_SSLKEY, $key);
}
// set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
- if ($keypass) {
- curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass);
+ if ($keyPass) {
+ curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keyPass);
}
// whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that it matches the hostname used
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost);
// allow usage of different SSL versions
- curl_setopt($curl, CURLOPT_SSLVERSION, $sslversion);
+ curl_setopt($curl, CURLOPT_SSLVERSION, $sslVersion);
}
// proxy info
- if ($proxyhost) {
- if ($proxyport == 0) {
- $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080
+ if ($proxyHost) {
+ if ($proxyPort == 0) {
+ $proxyPort = 8080; // NB: even for HTTPS, local connection is on port 8080
}
- curl_setopt($curl, CURLOPT_PROXY, $proxyhost . ':' . $proxyport);
- //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);
- if ($proxyusername) {
- curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername . ':' . $proxypassword);
+ curl_setopt($curl, CURLOPT_PROXY, $proxyHost . ':' . $proxyPort);
+ if ($proxyUsername) {
+ curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyUsername . ':' . $proxyPassword);
if (defined('CURLOPT_PROXYAUTH')) {
- curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);
- } elseif ($proxyauthtype != 1) {
+ curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyAuthType);
+ } elseif ($proxyAuthType != 1) {
error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported by the current PHP/curl install');
}
}
// the following code does not honour 'expires', 'path' and 'domain' cookie attributes
// set to client obj the the user...
if (count($this->cookies)) {
- $cookieheader = '';
+ $cookieHeader = '';
foreach ($this->cookies as $name => $cookie) {
- $cookieheader .= $name . '=' . $cookie['value'] . '; ';
+ $cookieHeader .= $name . '=' . $cookie['value'] . '; ';
}
- curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2));
+ curl_setopt($curl, CURLOPT_COOKIE, substr($cookieHeader, 0, -2));
}
foreach ($this->extracurlopts as $opt => $val) {
$message .= $name . ': ' . $val . "\n";
}
$message .= "---END---";
- $this->debugMessage($message);
+ Logger::instance()->debugMessage($message);
}
if (!$result) {
$this->errstr = 'no response';
$resp = new Response(0, PhpXmlRpc::$xmlrpcerr['curl_fail'], PhpXmlRpc::$xmlrpcstr['curl_fail'] . ': ' . curl_error($curl));
curl_close($curl);
- if ($keepalive) {
+ if ($keepAlive) {
$this->xmlrpc_curl_handle = null;
}
} else {
- if (!$keepalive) {
+ if (!$keepAlive) {
curl_close($curl);
}
- $resp = $msg->parseResponse($result, true, $this->return_type);
+ $resp = $req->parseResponse($result, true, $this->return_type);
// if we got back a 302, we can not reuse the curl handle for later calls
- if ($resp->faultCode() == PhpXmlRpc::$xmlrpcerr['http_error'] && $keepalive) {
+ if ($resp->faultCode() == PhpXmlRpc::$xmlrpcerr['http_error'] && $keepAlive) {
curl_close($curl);
$this->xmlrpc_curl_handle = null;
}
/**
* Send an array of requests and return an array of responses.
- * Unless $this->no_multicall has been set to true, it will try first
- * to use one single xmlrpc call to server method system.multicall, and
- * revert to sending many successive calls in case of failure.
+ *
+ * Unless $this->no_multicall has been set to true, it will try first to use one single xmlrpc call to server method
+ * system.multicall, and revert to sending many successive calls in case of failure.
* This failure is also stored in $this->no_multicall for subsequent calls.
- * Unfortunately, there is no server error code universally used to denote
- * the fact that multicall is unsupported, so there is no way to reliably
- * distinguish between that and a temporary failure.
- * If you are sure that server supports multicall and do not want to
- * fallback to using many single calls, set the fourth parameter to FALSE.
+ * Unfortunately, there is no server error code universally used to denote the fact that multicall is unsupported,
+ * so there is no way to reliably distinguish between that and a temporary failure.
+ * If you are sure that server supports multicall and do not want to fallback to using many single calls, set the
+ * fourth parameter to FALSE.
*
* NB: trying to shoehorn extra functionality into existing syntax has resulted
* in pretty much convoluted code...
*
- * @param Request[] $msgs an array of Request objects
- * @param integer $timeout connection timeout (in seconds)
- * @param string $method the http protocol variant to be used
- * @param boolean fallback When true, upon receiving an error during multicall, multiple single calls will be attempted
+ * @param Request[] $reqs an array of Request objects
+ * @param integer $timeout connection timeout (in seconds). See the details in the docs for the send() method
+ * @param string $method the http protocol variant to be used. See the details in the docs for the send() method
+ * @param boolean fallback When true, upon receiving an error during multicall, multiple single calls will be
+ * attempted
*
- * @return array
+ * @return Response[]
*/
- public function multicall($msgs, $timeout = 0, $method = '', $fallback = true)
+ public function multicall($reqs, $timeout = 0, $method = '', $fallback = true)
{
if ($method == '') {
$method = $this->method;
}
if (!$this->no_multicall) {
- $results = $this->_try_multicall($msgs, $timeout, $method);
+ $results = $this->_try_multicall($reqs, $timeout, $method);
if (is_array($results)) {
// System.multicall succeeded
return $results;
if ($fallback) {
// system.multicall is (probably) unsupported by server:
// emulate multicall via multiple requests
- foreach ($msgs as $msg) {
- $results[] = $this->send($msg, $timeout, $method);
+ foreach ($reqs as $req) {
+ $results[] = $this->send($req, $timeout, $method);
}
} else {
// user does NOT want to fallback on many single calls:
// since we should always return an array of responses,
// return an array with the same error repeated n times
- foreach ($msgs as $msg) {
+ foreach ($reqs as $req) {
$results[] = $result;
}
}
}
/**
- * Attempt to boxcar $msgs via system.multicall.
- * Returns either an array of xmlrpcreponses, an xmlrpc error response
- * or false (when received response does not respect valid multicall syntax).
+ * Attempt to boxcar $reqs via system.multicall.
+ *
+ * Returns either an array of Response, a single error Response or false (when received response does not respect
+ * valid multicall syntax).
+ *
+ * @param Request[] $reqs
+ * @param int $timeout
+ * @param string $method
+ * @return Response[]|bool|mixed|Response
*/
- private function _try_multicall($msgs, $timeout, $method)
+ private function _try_multicall($reqs, $timeout, $method)
{
// Construct multicall request
$calls = array();
- foreach ($msgs as $msg) {
- $call['methodName'] = new Value($msg->method(), 'string');
- $numParams = $msg->getNumParams();
+ foreach ($reqs as $req) {
+ $call['methodName'] = new Value($req->method(), 'string');
+ $numParams = $req->getNumParams();
$params = array();
for ($i = 0; $i < $numParams; $i++) {
- $params[$i] = $msg->getParam($i);
+ $params[$i] = $req->getParam($i);
}
$call['params'] = new Value($params, 'array');
$calls[] = new Value($call, 'struct');
}
- $multicall = new Request('system.multicall');
- $multicall->addParam(new Value($calls, 'array'));
+ $multiCall = new Request('system.multicall');
+ $multiCall->addParam(new Value($calls, 'array'));
// Attempt RPC call
- $result = $this->send($multicall, $timeout, $method);
+ $result = $this->send($multiCall, $timeout, $method);
if ($result->faultCode() != 0) {
// call to system.multicall failed
if ($this->return_type == 'xml') {
return $rets;
} elseif ($this->return_type == 'phpvals') {
- ///@todo test this code branch...
+ /// @todo test this code branch...
$rets = $result->value();
if (!is_array($rets)) {
return false; // bad return type from system.multicall
}
$numRets = count($rets);
- if ($numRets != count($msgs)) {
+ if ($numRets != count($reqs)) {
return false; // wrong number of return values.
}
if ($rets->kindOf() != 'array') {
return false; // bad return type from system.multicall
}
- $numRets = $rets->arraysize();
- if ($numRets != count($msgs)) {
+ $numRets = $rets->count();
+ if ($numRets != count($reqs)) {
return false; // wrong number of return values.
}
$response = array();
- for ($i = 0; $i < $numRets; $i++) {
- $val = $rets->arraymem($i);
+ foreach($rets as $val) {
switch ($val->kindOf()) {
case 'array':
- if ($val->arraysize() != 1) {
+ if ($val->count() != 1) {
return false; // Bad value
}
// Normal return value
- $response[$i] = new Response($val->arraymem(0));
+ $response[] = new Response($val[0]);
break;
case 'struct':
- $code = $val->structmem('faultCode');
+ $code = $val['faultCode'];
if ($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') {
return false;
}
- $str = $val->structmem('faultString');
+ $str = $val['faultString'];
if ($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') {
return false;
}
- $response[$i] = new Response(0, $code->scalarval(), $str->scalarval());
+ $response[] = new Response(0, $code->scalarval(), $str->scalarval());
break;
default:
return false;
return $response;
}
}
-
- /**
- * Echoes a debug message, taking care of escaping it when not in console mode
- *
- * @param string $message
- */
- protected function debugMessage($message)
- {
- if (PHP_SAPI != 'cli') {
- print "<PRE>\n".htmlentities($message)."\n</PRE>";
- }
- else {
- print "\n$message\n";
- }
- // let the client see this now in case http times out...
- flush();
- }
}
git://git.onelab.eu / plcapi.git / blobdiff