/// @todo: do these need to be public?
public $path;
public $server;
- public $port=0;
- public $method='http';
+ public $port = 0;
+ public $method = 'http';
public $errno;
public $errstr;
- public $debug=0;
- public $username='';
- public $password='';
- public $authtype=1;
- public $cert='';
- public $certpass='';
- public $cacert='';
- public $cacertdir='';
- public $key='';
- public $keypass='';
- public $verifypeer=true;
- public $verifyhost=2;
- 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();
+ public $debug = 0;
+ public $username = '';
+ public $password = '';
+ public $authtype = 1;
+ public $cert = '';
+ public $certpass = '';
+ public $cacert = '';
+ public $cacertdir = '';
+ public $key = '';
+ public $keypass = '';
+ public $verifypeer = true;
+ public $verifyhost = 2;
+ 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();
/**
* 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
+ * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib.
*
* NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since
* in those cases it will be up to CURL to decide the compression methods
public $accepted_compression = array();
/**
* Name of compression scheme to be used for sending requests.
- * Either null, gzip or deflate
+ * 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)
+ * 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 $request_charset_encoding = '';
/**
* Decides the content of Response objects returned by calls to send()
- * valid strings are 'xmlrpcvals', 'phpvals' or 'xml'
+ * valid strings are 'xmlrpcvals', 'phpvals' or 'xml'.
*/
public $return_type = 'xmlrpcvals';
/**
- * Sent to servers in http headers
+ * Sent to servers in http headers.
*/
public $user_agent;
* @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
*/
- function __construct($path, $server='', $port='', $method='')
+ public function __construct($path, $server = '', $port = '', $method = '')
{
// allow user to specify all params in $path
- if($server == '' and $port == '' and $method == '')
- {
+ if ($server == '' and $port == '' and $method == '') {
$parts = parse_url($path);
$server = $parts['host'];
$path = isset($parts['path']) ? $parts['path'] : '';
- if(isset($parts['query']))
- {
- $path .= '?'.$parts['query'];
+ if (isset($parts['query'])) {
+ $path .= '?' . $parts['query'];
}
- if(isset($parts['fragment']))
- {
- $path .= '#'.$parts['fragment'];
+ if (isset($parts['fragment'])) {
+ $path .= '#' . $parts['fragment'];
}
- if(isset($parts['port']))
- {
+ if (isset($parts['port'])) {
$port = $parts['port'];
}
- if(isset($parts['scheme']))
- {
+ if (isset($parts['scheme'])) {
$method = $parts['scheme'];
}
- if(isset($parts['user']))
- {
+ if (isset($parts['user'])) {
$this->username = $parts['user'];
}
- if(isset($parts['pass']))
- {
+ if (isset($parts['pass'])) {
$this->password = $parts['pass'];
}
}
- if($path == '' || $path[0] != '/')
- {
- $this->path='/'.$path;
+ if ($path == '' || $path[0] != '/') {
+ $this->path = '/' . $path;
+ } else {
+ $this->path = $path;
}
- else
- {
- $this->path=$path;
+ $this->server = $server;
+ if ($port != '') {
+ $this->port = $port;
}
- $this->server=$server;
- if($port != '')
- {
- $this->port=$port;
- }
- if($method != '')
- {
- $this->method=$method;
+ if ($method != '') {
+ $this->method = $method;
}
// if ZLIB is enabled, let the client by default accept compressed responses
- if(function_exists('gzinflate') || (
- function_exists('curl_init') && (($info = curl_version()) &&
- ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
- ))
- {
+ if (function_exists('gzinflate') || (
+ function_exists('curl_init') && (($info = curl_version()) &&
+ ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version'])))
+ )
+ ) {
$this->accepted_compression = array('gzip', 'deflate');
}
}
/**
- * Enables/disables the echoing to screen of the xmlrpc responses received
+ * Enables/disables the echoing to screen of the xmlrpc responses received.
+ *
* @param integer $in values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
*/
public function setDebug($in)
{
- $this->debug=$in;
+ $this->debug = $in;
}
/**
- * Add some http BASIC AUTH credentials, used by the client to authenticate
+ * Add some http BASIC AUTH credentials, used by the client to authenticate.
+ *
* @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)
*/
- public function setCredentials($u, $p, $t=1)
+ public function setCredentials($u, $p, $t = 1)
{
- $this->username=$u;
- $this->password=$p;
- $this->authtype=$t;
+ $this->username = $u;
+ $this->password = $p;
+ $this->authtype = $t;
}
/**
- * Add a client-side https certificate
+ * Add a client-side https certificate.
+ *
* @param string $cert
* @param string $certpass
*/
/**
* Add a CA certificate to verify server with (see man page about
- * CURLOPT_CAINFO for more details)
+ * CURLOPT_CAINFO for more details).
+ *
* @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
*/
- public function setCaCertificate($cacert, $is_dir=false)
+ public function setCaCertificate($cacert, $is_dir = false)
{
- if ($is_dir)
- {
+ if ($is_dir) {
$this->cacertdir = $cacert;
- }
- else
- {
+ } else {
$this->cacert = $cacert;
}
}
/**
* Set attributes for SSL communication: private SSL key
* NB: does not work in older php/curl installs
- * Thanks to Daniel Convissor
+ * 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
*/
}
/**
- * Set attributes for SSL communication: verify server certificate
+ * Set attributes for SSL communication: verify server certificate.
+ *
* @param bool $i enable/disable verification of peer certificate
*/
public function setSSLVerifyPeer($i)
}
/**
- * Set attributes for SSL communication: verify match of server cert w. hostname
+ * Set attributes for SSL communication: verify match of server cert w. hostname.
+ *
* @param int $i
*/
public function setSSLVerifyHost($i)
}
/**
- * Set proxy info
+ * 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
* 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)
{
- if ($compmethod == 'any')
+ if ($compmethod == 'any') {
$this->accepted_compression = array('gzip', 'deflate');
- else
- if ($compmethod == false )
- $this->accepted_compression = array();
- else
- $this->accepted_compression = array($compmethod);
+ } elseif ($compmethod == false) {
+ $this->accepted_compression = array();
+ } else {
+ $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)
+ * (and automatic fallback to uncompressed requests is not yet implemented).
+ *
* @param string $compmethod either 'gzip', 'deflate' or ''
*/
public function setRequestCompression($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
+ * do not do it unless you know what you are doing.
+ *
* @param string $name
* @param string $value
* @param string $path
*
* @todo check correctness of urlencoding cookie value (copied from php way of doing it...)
*/
- public function setCookie($name, $value='', $path='', $domain='', $port=null)
+ public function setCookie($name, $value = '', $path = '', $domain = '', $port = null)
{
$this->cookies[$name]['value'] = urlencode($value);
- if ($path || $domain || $port)
- {
+ if ($path || $domain || $port) {
$this->cookies[$name]['path'] = $path;
$this->cookies[$name]['domain'] = $domain;
$this->cookies[$name]['port'] = $port;
$this->cookies[$name]['version'] = 1;
- }
- else
- {
+ } else {
$this->cookies[$name]['version'] = 0;
}
}
/**
* Directly set cURL options, for extra flexibility
- * It allows eg. to bind client to a specific IP interface / address
+ * It allows eg. to bind client to a specific IP interface / address.
+ *
* @param array $options
*/
- 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
+ * in http headers sent to the server.
*/
- function SetUserAgent( $agentstring )
+ public function SetUserAgent($agentstring)
{
$this->user_agent = $agentstring;
}
/**
- * Send an xmlrpc request
+ * Send an xmlrpc request.
+ *
* @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
+ *
* @return Response
*/
- public function& send($msg, $timeout=0, $method='')
+ public function & send($msg, $timeout = 0, $method = '')
{
// if user deos not specify http protocol, use native method of this client
// (i.e. method set during call to constructor)
- if($method == '')
- {
+ if ($method == '') {
$method = $this->method;
}
- if(is_array($msg))
- {
+ if (is_array($msg)) {
// $msg is an array of Requests
$r = $this->multicall($msg, $timeout, $method);
+
return $r;
- }
- elseif(is_string($msg))
- {
+ } elseif (is_string($msg)) {
$n = new Message('');
$n->payload = $msg;
$msg = $n;
}
// where msg is a Request
- $msg->debug=$this->debug;
+ $msg->debug = $this->debug;
- if($method == 'https')
- {
+ if ($method == 'https') {
$r = $this->sendPayloadHTTPS(
$msg,
$this->server,
$this->key,
$this->keypass
);
- }
- elseif($method == 'http11')
- {
+ } elseif ($method == 'http11') {
$r = $this->sendPayloadCURL(
$msg,
$this->server,
'http',
$this->keepalive
);
- }
- else
- {
+ } else {
$r = $this->sendPayloadHTTP10(
$msg,
$this->server,
return $r;
}
- private function sendPayloadHTTP10($msg, $server, $port, $timeout=0,
- $username='', $password='', $authtype=1, $proxyhost='',
- $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)
+ private function sendPayloadHTTP10($msg, $server, $port, $timeout = 0,
+ $username = '', $password = '', $authtype = 1, $proxyhost = '',
+ $proxyport = 0, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1)
{
- if($port==0)
- {
- $port=80;
+ if ($port == 0) {
+ $port = 80;
}
// Only create the payload if it was not created previously
- if(empty($msg->payload))
- {
+ if (empty($msg->payload)) {
$msg->createPayload($this->request_charset_encoding);
}
$payload = $msg->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')
- {
+ if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
+ if ($this->request_compression == 'gzip') {
$a = @gzencode($payload);
- if($a)
- {
+ if ($a) {
$payload = $a;
$encoding_hdr = "Content-Encoding: gzip\r\n";
}
- }
- else
- {
+ } else {
$a = @gzcompress($payload);
- if($a)
- {
+ if ($a) {
$payload = $a;
$encoding_hdr = "Content-Encoding: deflate\r\n";
}
}
- }
- else
- {
+ } else {
$encoding_hdr = '';
}
// thanks to Grant Rauscher <grant7@firstworld.net> for this
- $credentials='';
- if($username!='')
- {
- $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
- if ($authtype != 1)
- {
- error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported with HTTP 1.0');
+ $credentials = '';
+ if ($username != '') {
+ $credentials = 'Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n";
+ if ($authtype != 1) {
+ error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported with HTTP 1.0');
}
}
$accepted_encoding = '';
- if(is_array($this->accepted_compression) && count($this->accepted_compression))
- {
+ if (is_array($this->accepted_compression) && count($this->accepted_compression)) {
$accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n";
}
$proxy_credentials = '';
- if($proxyhost)
- {
- if($proxyport == 0)
- {
+ if ($proxyhost) {
+ if ($proxyport == 0) {
$proxyport = 8080;
}
$connectserver = $proxyhost;
$connectport = $proxyport;
- $uri = 'http://'.$server.':'.$port.$this->path;
- if($proxyusername != '')
- {
- if ($proxyauthtype != 1)
- {
- error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported with HTTP 1.0');
+ $uri = 'http://' . $server . ':' . $port . $this->path;
+ if ($proxyusername != '') {
+ if ($proxyauthtype != 1) {
+ error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported with HTTP 1.0');
}
- $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n";
+ $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername . ':' . $proxypassword) . "\r\n";
}
- }
- else
- {
+ } else {
$connectserver = $server;
$connectport = $port;
$uri = $this->path;
// Cookie generation, as per rfc2965 (version 1 cookies) or
// netscape's rules (version 0 cookies)
- $cookieheader='';
- if (count($this->cookies))
- {
+ $cookieheader = '';
+ if (count($this->cookies)) {
$version = '';
- foreach ($this->cookies as $name => $cookie)
- {
- if ($cookie['version'])
- {
+ foreach ($this->cookies as $name => $cookie) {
+ if ($cookie['version']) {
$version = ' $Version="' . $cookie['version'] . '";';
$cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";';
- if ($cookie['path'])
+ if ($cookie['path']) {
$cookieheader .= ' $Path="' . $cookie['path'] . '";';
- if ($cookie['domain'])
+ }
+ if ($cookie['domain']) {
$cookieheader .= ' $Domain="' . $cookie['domain'] . '";';
- if ($cookie['port'])
+ }
+ if ($cookie['port']) {
$cookieheader .= ' $Port="' . $cookie['port'] . '";';
- }
- else
- {
+ }
+ } else {
$cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";";
}
}
// omit port if 80
$port = ($port == 80) ? '' : (':' . $port);
- $op= 'POST ' . $uri. " HTTP/1.0\r\n" .
+ $op = 'POST ' . $uri . " HTTP/1.0\r\n" .
'User-Agent: ' . $this->user_agent . "\r\n" .
- 'Host: '. $server . $port . "\r\n" .
+ 'Host: ' . $server . $port . "\r\n" .
$credentials .
$proxy_credentials .
$accepted_encoding .
strlen($payload) . "\r\n\r\n" .
$payload;
- if($this->debug > 1)
- {
+ if ($this->debug > 1) {
print "<PRE>\n---SENDING---\n" . htmlentities($op) . "\n---END---\n</PRE>";
// let the client see this now in case http times out...
flush();
}
- if($timeout>0)
- {
- $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);
- }
- else
- {
- $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr);
+ if ($timeout > 0) {
+ $fp = @fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout);
+ } else {
+ $fp = @fsockopen($connectserver, $connectport, $this->errno, $this->errstr);
}
- if($fp)
- {
- if($timeout>0 && function_exists('stream_set_timeout'))
- {
+ if ($fp) {
+ if ($timeout > 0 && function_exists('stream_set_timeout')) {
stream_set_timeout($fp, $timeout);
}
- }
- else
- {
- $this->errstr='Connect error: '.$this->errstr;
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr . ' (' . $this->errno . ')');
+ } else {
+ $this->errstr = 'Connect error: ' . $this->errstr;
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr . ' (' . $this->errno . ')');
+
return $r;
}
- if(!fputs($fp, $op, strlen($op)))
- {
+ if (!fputs($fp, $op, strlen($op))) {
fclose($fp);
- $this->errstr='Write error';
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr);
+ $this->errstr = 'Write error';
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], $this->errstr);
+
return $r;
- }
- else
- {
+ } else {
// reset errno and errstr on successful socket connection
$this->errstr = '';
}
// G. Giunta 2005/10/24: close socket before parsing.
// should yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)
- $ipd='';
- do
- {
+ $ipd = '';
+ do {
// shall we check for $data === FALSE?
// as per the manual, it signals an error
- $ipd.=fread($fp, 32768);
- } while(!feof($fp));
+ $ipd .= fread($fp, 32768);
+ } while (!feof($fp));
fclose($fp);
$r = $msg->parseResponse($ipd, false, $this->return_type);
- return $r;
+ 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='')
+ 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 = '')
{
$r = $this->sendPayloadCURL($msg, $server, $port, $timeout, $username,
$password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport,
$proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass);
+
return $r;
}
* Requires curl to be built into PHP
* NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!
*/
- 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='')
+ 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 = '')
{
- if(!function_exists('curl_init'))
- {
- $this->errstr='CURL unavailable on this install';
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['no_curl'], PhpXmlRpc::$xmlrpcstr['no_curl']);
+ 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;
}
- 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']);
+ 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;
}
}
- if($port == 0)
- {
- if($method == 'http')
- {
+ if ($port == 0) {
+ if ($method == 'http') {
$port = 80;
- }
- else
- {
+ } else {
$port = 443;
}
}
// Only create the payload if it was not created previously
- if(empty($msg->payload))
- {
+ if (empty($msg->payload)) {
$msg->createPayload($this->request_charset_encoding);
}
// Deflate request body and set appropriate request headers
$payload = $msg->payload;
- if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate'))
- {
- if($this->request_compression == 'gzip')
- {
+ if (function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) {
+ if ($this->request_compression == 'gzip') {
$a = @gzencode($payload);
- if($a)
- {
+ if ($a) {
$payload = $a;
$encoding_hdr = 'Content-Encoding: gzip';
}
- }
- else
- {
+ } else {
$a = @gzcompress($payload);
- if($a)
- {
+ if ($a) {
$payload = $a;
$encoding_hdr = 'Content-Encoding: deflate';
}
}
- }
- else
- {
+ } else {
$encoding_hdr = '';
}
- if($this->debug > 1)
- {
+ if ($this->debug > 1) {
print "<PRE>\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n</PRE>";
// let the client see this now in case http times out...
flush();
}
- 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
- {
+ } else {
$curl = $this->xmlrpc_curl_handle;
}
// results into variable
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
- if($this->debug)
- {
+ if ($this->debug) {
curl_setopt($curl, CURLOPT_VERBOSE, 1);
}
curl_setopt($curl, CURLOPT_USERAGENT, $this->user_agent);
// NB: if we set an empty string, CURL will add http header indicating
// ALL methods it is supporting. This is possibly a better option than
// letting the user tell what curl can / cannot do...
- if(is_array($this->accepted_compression) && count($this->accepted_compression))
- {
+ if (is_array($this->accepted_compression) && count($this->accepted_compression)) {
//curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression));
// empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
- if (count($this->accepted_compression) == 1)
- {
+ if (count($this->accepted_compression) == 1) {
curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]);
- }
- else
+ } else {
curl_setopt($curl, CURLOPT_ENCODING, '');
+ }
}
// extra headers
- $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings));
+ $headers = array('Content-Type: ' . $msg->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)
- {
+ if ($encoding_hdr) {
$headers[] = $encoding_hdr;
}
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
// timeout is borked
- if($timeout)
- {
+ if ($timeout) {
curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1);
}
- if($username && $password)
- {
- curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password);
- if (defined('CURLOPT_HTTPAUTH'))
- {
+ if ($username && $password) {
+ curl_setopt($curl, CURLOPT_USERPWD, $username . ':' . $password);
+ if (defined('CURLOPT_HTTPAUTH')) {
curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype);
- }
- else if ($authtype != 1)
- {
- error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported by the current PHP/curl install');
+ } elseif ($authtype != 1) {
+ error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth is supported by the current PHP/curl install');
}
}
- if($method == 'https')
- {
+ if ($method == 'https') {
// set cert file
- if($cert)
- {
+ if ($cert) {
curl_setopt($curl, CURLOPT_SSLCERT, $cert);
}
// set cert password
- if($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)
- {
+ if ($cacert) {
curl_setopt($curl, CURLOPT_CAINFO, $cacert);
}
- if($cacertdir)
- {
+ if ($cacertdir) {
curl_setopt($curl, CURLOPT_CAPATH, $cacertdir);
}
// set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
- if($key)
- {
+ if ($key) {
curl_setopt($curl, CURLOPT_SSLKEY, $key);
}
// set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?)
- if($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
}
// proxy info
- if($proxyhost)
- {
- if($proxyport == 0)
- {
+ 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_PROXY, $proxyhost . ':' . $proxyport);
//curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport);
- if($proxyusername)
- {
- curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword);
- if (defined('CURLOPT_PROXYAUTH'))
- {
+ if ($proxyusername) {
+ curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername . ':' . $proxypassword);
+ if (defined('CURLOPT_PROXYAUTH')) {
curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype);
- }
- else if ($proxyauthtype != 1)
- {
- error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported by the current PHP/curl install');
+ } elseif ($proxyauthtype != 1) {
+ error_log('XML-RPC: ' . __METHOD__ . ': warning. Only Basic auth to proxy is supported by the current PHP/curl install');
}
}
}
// NB: should we build cookie http headers by hand rather than let CURL do it?
// the following code does not honour 'expires', 'path' and 'domain' cookie attributes
// set to client obj the the user...
- if (count($this->cookies))
- {
+ if (count($this->cookies)) {
$cookieheader = '';
- foreach ($this->cookies as $name => $cookie)
- {
+ foreach ($this->cookies as $name => $cookie) {
$cookieheader .= $name . '=' . $cookie['value'] . '; ';
}
curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2));
}
- foreach ($this->extracurlopts as $opt => $val)
- {
+ foreach ($this->extracurlopts as $opt => $val) {
curl_setopt($curl, $opt, $val);
}
$result = curl_exec($curl);
- if ($this->debug > 1)
- {
+ if ($this->debug > 1) {
print "<PRE>\n---CURL INFO---\n";
- foreach(curl_getinfo($curl) as $name => $val)
- {
- if (is_array($val))
- {
+ foreach (curl_getinfo($curl) as $name => $val) {
+ if (is_array($val)) {
$val = implode("\n", $val);
}
print $name . ': ' . htmlentities($val) . "\n";
print "---END---\n</PRE>";
}
- if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'?
- {
- $this->errstr='no response';
- $resp=new Response(0, PhpXmlRpc::$xmlrpcerr['curl_fail'], PhpXmlRpc::$xmlrpcstr['curl_fail']. ': '. curl_error($curl));
+ if (!$result) {
+ /// @todo we should use a better check here - what if we get back '' or '0'?
+
+ $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)
- {
+ } else {
+ if (!$keepalive) {
curl_close($curl);
}
$resp = $msg->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;
}
}
+
return $resp;
}
* @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
+ *
* @return array
*/
- public function multicall($msgs, $timeout=0, $method='', $fallback=true)
+ public function multicall($msgs, $timeout = 0, $method = '', $fallback = true)
{
- if ($method == '')
- {
+ if ($method == '') {
$method = $this->method;
}
- if(!$this->no_multicall)
- {
+ if (!$this->no_multicall) {
$results = $this->_try_multicall($msgs, $timeout, $method);
- if(is_array($results))
- {
+ if (is_array($results)) {
// System.multicall succeeded
return $results;
- }
- else
- {
+ } else {
// either system.multicall is unsupported by server,
// or call failed for some other reason.
- if ($fallback)
- {
+ if ($fallback) {
// Don't try it next time...
$this->no_multicall = true;
- }
- else
- {
- if (is_a($results, '\PhpXmlRpc\Response'))
- {
+ } else {
+ if (is_a($results, '\PhpXmlRpc\Response')) {
$result = $results;
- }
- else
- {
+ } else {
$result = new Response(0, PhpXmlRpc::$xmlrpcerr['multicall_error'], PhpXmlRpc::$xmlrpcstr['multicall_error']);
}
}
}
- }
- else
- {
+ } else {
// override fallback, in case careless user tries to do two
// opposite things at the same time
$fallback = true;
}
$results = array();
- if ($fallback)
- {
+ if ($fallback) {
// system.multicall is (probably) unsupported by server:
// emulate multicall via multiple requests
- foreach($msgs as $msg)
- {
+ foreach ($msgs as $msg) {
$results[] = $this->send($msg, $timeout, $method);
}
- }
- else
- {
+ } 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 ($msgs as $msg) {
$results[] = $result;
}
}
+
return $results;
}
/**
* 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)
+ * or false (when received response does not respect valid multicall syntax).
*/
private function _try_multicall($msgs, $timeout, $method)
{
// Construct multicall request
$calls = array();
- foreach($msgs as $msg)
- {
- $call['methodName'] = new Value($msg->method(),'string');
+ foreach ($msgs as $msg) {
+ $call['methodName'] = new Value($msg->method(), 'string');
$numParams = $msg->getNumParams();
$params = array();
- for($i = 0; $i < $numParams; $i++)
- {
+ for ($i = 0; $i < $numParams; $i++) {
$params[$i] = $msg->getParam($i);
}
$call['params'] = new Value($params, 'array');
// Attempt RPC call
$result = $this->send($multicall, $timeout, $method);
- if($result->faultCode() != 0)
- {
+ if ($result->faultCode() != 0) {
// call to system.multicall failed
return $result;
}
// Unpack responses.
$rets = $result->value();
- if ($this->return_type == 'xml')
- {
- return $rets;
- }
- else if ($this->return_type == 'phpvals')
- {
+ if ($this->return_type == 'xml') {
+ return $rets;
+ } elseif ($this->return_type == 'phpvals') {
///@todo test this code branch...
$rets = $result->value();
- if(!is_array($rets))
- {
+ if (!is_array($rets)) {
return false; // bad return type from system.multicall
}
$numRets = count($rets);
- if($numRets != count($msgs))
- {
+ if ($numRets != count($msgs)) {
return false; // wrong number of return values.
}
$response = array();
- for($i = 0; $i < $numRets; $i++)
- {
+ for ($i = 0; $i < $numRets; $i++) {
$val = $rets[$i];
if (!is_array($val)) {
return false;
}
- switch(count($val))
- {
+ switch (count($val)) {
case 1:
- if(!isset($val[0]))
- {
+ if (!isset($val[0])) {
return false; // Bad value
}
// Normal return value
case 2:
/// @todo remove usage of @: it is apparently quite slow
$code = @$val['faultCode'];
- if(!is_int($code))
- {
+ if (!is_int($code)) {
return false;
}
$str = @$val['faultString'];
- if(!is_string($str))
- {
+ if (!is_string($str)) {
return false;
}
$response[$i] = new Response(0, $code, $str);
return false;
}
}
+
return $response;
- }
- else // return type == 'xmlrpcvals'
- {
+ } else {
+ // return type == 'xmlrpcvals'
+
$rets = $result->value();
- if($rets->kindOf() != 'array')
- {
+ if ($rets->kindOf() != 'array') {
return false; // bad return type from system.multicall
}
$numRets = $rets->arraysize();
- if($numRets != count($msgs))
- {
+ if ($numRets != count($msgs)) {
return false; // wrong number of return values.
}
$response = array();
- for($i = 0; $i < $numRets; $i++)
- {
+ for ($i = 0; $i < $numRets; $i++) {
$val = $rets->arraymem($i);
- switch($val->kindOf())
- {
+ switch ($val->kindOf()) {
case 'array':
- if($val->arraysize() != 1)
- {
+ if ($val->arraysize() != 1) {
return false; // Bad value
}
// Normal return value
break;
case 'struct':
$code = $val->structmem('faultCode');
- if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int')
- {
+ if ($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') {
return false;
}
$str = $val->structmem('faultString');
- if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string')
- {
+ if ($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') {
return false;
}
$response[$i] = new Response(0, $code->scalarval(), $str->scalarval());
return false;
}
}
+
return $response;
}
}
*
* @param Value|Request $xmlrpc_val
* @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects; if 'dates_as_objects' is set xmlrpc datetimes are decoded as php DateTime objects (standard is
+ *
* @return mixed
*/
- function decode($xmlrpc_val, $options=array())
+ public function decode($xmlrpc_val, $options = array())
{
- switch($xmlrpc_val->kindOf())
- {
+ switch ($xmlrpc_val->kindOf()) {
case 'scalar':
- if (in_array('extension_api', $options))
- {
+ if (in_array('extension_api', $options)) {
reset($xmlrpc_val->me);
- list($typ,$val) = each($xmlrpc_val->me);
- switch ($typ)
- {
+ list($typ, $val) = each($xmlrpc_val->me);
+ switch ($typ) {
case 'dateTime.iso8601':
$xmlrpc_val->scalar = $val;
$xmlrpc_val->type = 'datetime';
$xmlrpc_val->timestamp = \PhpXmlRpc\Helper\Date::iso8601_decode($val);
+
return $xmlrpc_val;
case 'base64':
$xmlrpc_val->scalar = $val;
$xmlrpc_val->type = $typ;
+
return $xmlrpc_val;
default:
return $xmlrpc_val->scalarval();
}
}
- if (in_array('dates_as_objects', $options) && $xmlrpc_val->scalartyp() == 'dateTime.iso8601')
- {
+ if (in_array('dates_as_objects', $options) && $xmlrpc_val->scalartyp() == 'dateTime.iso8601') {
// we return a Datetime object instead of a string
// since now the constructor of xmlrpcval accepts safely strings, ints and datetimes,
// we cater to all 3 cases here
$out = $xmlrpc_val->scalarval();
- if (is_string($out))
- {
+ if (is_string($out)) {
$out = strtotime($out);
}
- if (is_int($out))
- {
+ if (is_int($out)) {
$result = new \Datetime();
$result->setTimestamp($out);
+
return $result;
- }
- elseif (is_a($out, 'Datetime'))
- {
+ } elseif (is_a($out, 'Datetime')) {
return $out;
}
}
+
return $xmlrpc_val->scalarval();
case 'array':
$size = $xmlrpc_val->arraysize();
$arr = array();
- for($i = 0; $i < $size; $i++)
- {
+ for ($i = 0; $i < $size; $i++) {
$arr[] = $this->decode($xmlrpc_val->arraymem($i), $options);
}
+
return $arr;
case 'struct':
$xmlrpc_val->structreset();
// shall we check for proper subclass of xmlrpcval instead of
// presence of _php_class to detect what we can do?
if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != ''
- && class_exists($xmlrpc_val->_php_class))
- {
- $obj = @new $xmlrpc_val->_php_class;
- while(list($key,$value)=$xmlrpc_val->structeach())
- {
+ && class_exists($xmlrpc_val->_php_class)
+ ) {
+ $obj = @new $xmlrpc_val->_php_class();
+ while (list($key, $value) = $xmlrpc_val->structeach()) {
$obj->$key = $this->decode($value, $options);
}
+
return $obj;
- }
- else
- {
+ } else {
$arr = array();
- while(list($key,$value)=$xmlrpc_val->structeach())
- {
+ while (list($key, $value) = $xmlrpc_val->structeach()) {
$arr[$key] = $this->decode($value, $options);
}
+
return $arr;
}
case 'msg':
$paramcount = $xmlrpc_val->getNumParams();
$arr = array();
- for($i = 0; $i < $paramcount; $i++)
- {
+ for ($i = 0; $i < $paramcount; $i++) {
$arr[] = $this->decode($xmlrpc_val->getParam($i));
}
+
return $arr;
- }
+ }
}
/**
*
* @param mixed $php_val the value to be converted into an xmlrpcval object
* @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api'
+ *
* @return \PhpXmlrpc\Value
*/
- function encode($php_val, $options=array())
+ public function encode($php_val, $options = array())
{
$type = gettype($php_val);
- switch($type)
- {
+ switch ($type) {
case 'string':
- if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val))
+ if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val)) {
$xmlrpc_val = new Value($php_val, Value::$xmlrpcDateTime);
- else
+ } else {
$xmlrpc_val = new Value($php_val, Value::$xmlrpcString);
+ }
break;
case 'integer':
$xmlrpc_val = new Value($php_val, Value::$xmlrpcInt);
case 'double':
$xmlrpc_val = new Value($php_val, Value::$xmlrpcDouble);
break;
- // <G_Giunta_2001-02-29>
- // Add support for encoding/decoding of booleans, since they are supported in PHP
+ // <G_Giunta_2001-02-29>
+ // Add support for encoding/decoding of booleans, since they are supported in PHP
case 'boolean':
$xmlrpc_val = new Value($php_val, Value::$xmlrpcBoolean);
break;
- // </G_Giunta_2001-02-29>
+ // </G_Giunta_2001-02-29>
case 'array':
// PHP arrays can be encoded to either xmlrpc structs or arrays,
// depending on wheter they are hashes or plain 0..n integer indexed
$j = 0;
$arr = array();
$ko = false;
- foreach($php_val as $key => $val)
- {
+ foreach ($php_val as $key => $val) {
$arr[$key] = $this->encode($val, $options);
- if(!$ko && $key !== $j)
- {
+ if (!$ko && $key !== $j) {
$ko = true;
}
$j++;
}
- if($ko)
- {
+ if ($ko) {
$xmlrpc_val = new Value($arr, Value::$xmlrpcStruct);
- }
- else
- {
+ } else {
$xmlrpc_val = new Value($arr, Value::$xmlrpcArray);
}
break;
case 'object':
- if(is_a($php_val, 'PhpXmlRpc\Value'))
- {
+ if (is_a($php_val, 'PhpXmlRpc\Value')) {
$xmlrpc_val = $php_val;
- }
- else if(is_a($php_val, 'DateTime'))
- {
+ } elseif (is_a($php_val, 'DateTime')) {
$xmlrpc_val = new Value($php_val->format('Ymd\TH:i:s'), Value::$xmlrpcStruct);
- }
- else
- {
+ } else {
$arr = array();
reset($php_val);
- while(list($k,$v) = each($php_val))
- {
+ while (list($k, $v) = each($php_val)) {
$arr[$k] = $this->encode($v, $options);
}
$xmlrpc_val = new Value($arr, Value::$xmlrpcStruct);
- if (in_array('encode_php_objs', $options))
- {
+ if (in_array('encode_php_objs', $options)) {
// let's save original class name into xmlrpcval:
// might be useful later on...
$xmlrpc_val->_php_class = get_class($php_val);
}
break;
case 'NULL':
- if (in_array('extension_api', $options))
- {
+ if (in_array('extension_api', $options)) {
$xmlrpc_val = new Value('', Value::$xmlrpcString);
- }
- else if (in_array('null_extension', $options))
- {
+ } elseif (in_array('null_extension', $options)) {
$xmlrpc_val = new Value('', Value::$xmlrpcNull);
- }
- else
- {
+ } else {
$xmlrpc_val = new Value();
}
break;
case 'resource':
- if (in_array('extension_api', $options))
- {
+ if (in_array('extension_api', $options)) {
$xmlrpc_val = new Value((int)$php_val, Value::$xmlrpcInt);
- }
- else
- {
+ } else {
$xmlrpc_val = new Value();
}
// catch "user function", "unknown type"
// an empty object in case, not a boolean.
$xmlrpc_val = new Value();
break;
- }
- return $xmlrpc_val;
+ }
+
+ return $xmlrpc_val;
}
/**
* Convert the xml representation of a method response, method request or single
- * xmlrpc value into the appropriate object (a.k.a. deserialize)
+ * xmlrpc value into the appropriate object (a.k.a. deserialize).
+ *
* @param string $xml_val
* @param array $options
+ *
* @return mixed false on error, or an instance of either Value, Request or Response
*/
- function decode_xml($xml_val, $options=array())
+ public function decode_xml($xml_val, $options = array())
{
/// @todo 'guestimate' encoding
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
// What if internal encoding is not in one of the 3 allowed?
// we use the broadest one, ie. utf8!
- if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
- {
+ if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
- }
- else
- {
+ } else {
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
}
xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee');
xml_set_character_data_handler($parser, 'xmlrpc_cd');
xml_set_default_handler($parser, 'xmlrpc_dh');
- if(!xml_parse($parser, $xml_val, 1))
- {
+ if (!xml_parse($parser, $xml_val, 1)) {
$errstr = sprintf('XML error: %s at line %d, column %d',
- xml_error_string(xml_get_error_code($parser)),
- xml_get_current_line_number($parser), xml_get_current_column_number($parser));
+ xml_error_string(xml_get_error_code($parser)),
+ xml_get_current_line_number($parser), xml_get_current_column_number($parser));
error_log($errstr);
xml_parser_free($parser);
+
return false;
}
xml_parser_free($parser);
- if ($xmlRpcParser->_xh['isf'] > 1) // test that $xmlrpc->_xh['value'] is an obj, too???
- {
+ if ($xmlRpcParser->_xh['isf'] > 1) {
+ // test that $xmlrpc->_xh['value'] is an obj, too???
+
error_log($xmlRpcParser->_xh['isf_reason']);
+
return false;
}
- switch ($xmlRpcParser->_xh['rt'])
- {
+ switch ($xmlRpcParser->_xh['rt']) {
case 'methodresponse':
- $v =& $xmlRpcParser->_xh['value'];
- if ($xmlRpcParser->_xh['isf'] == 1)
- {
+ $v = &$xmlRpcParser->_xh['value'];
+ if ($xmlRpcParser->_xh['isf'] == 1) {
$vc = $v->structmem('faultCode');
$vs = $v->structmem('faultString');
$r = new Response(0, $vc->scalarval(), $vs->scalarval());
- }
- else
- {
+ } else {
$r = new Response($v);
}
+
return $r;
case 'methodcall':
$m = new Request($xmlRpcParser->_xh['method']);
- for($i=0; $i < count($xmlRpcParser->_xh['params']); $i++)
- {
+ for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
$m->addParam($xmlRpcParser->_xh['params'][$i]);
}
+
return $m;
case 'value':
return $xmlRpcParser->_xh['value'];
}
}
-
/**
* xml charset encoding guessing helper function.
* Tries to determine the charset encoding of an XML chunk received over HTTP.
*
* @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!
*/
- static function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null)
+ public static function guess_encoding($httpheader = '', $xmlchunk = '', $encoding_prefs = null)
{
// discussion: see http://www.yale.edu/pclt/encoding/
// 1 - test if encoding is specified in HTTP HEADERS
/// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it?
$matches = array();
- if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches))
- {
+ if (preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches)) {
return strtoupper(trim($matches[1], " \t\""));
}
// in the xml declaration, and verify if they match.
/// @todo implement check as described above?
/// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM)
- if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk))
- {
+ if (preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk)) {
return 'UCS-4';
- }
- elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk))
- {
+ } elseif (preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk)) {
return 'UTF-16';
- }
- elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk))
- {
+ } elseif (preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk)) {
return 'UTF-8';
}
// Details:
// SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+
// EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]*
- if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))".
+ if (preg_match('/^<\?xml\s+version\s*=\s*' . "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))" .
'\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/",
- $xmlchunk, $matches))
- {
+ $xmlchunk, $matches)) {
return strtoupper(substr($matches[2], 1, -1));
}
// 4 - if mbstring is available, let it do the guesswork
// NB: we favour finding an encoding that is compatible with what we can process
- if(extension_loaded('mbstring'))
- {
- if($encoding_prefs)
- {
+ if (extension_loaded('mbstring')) {
+ if ($encoding_prefs) {
$enc = mb_detect_encoding($xmlchunk, $encoding_prefs);
- }
- else
- {
+ } else {
$enc = mb_detect_encoding($xmlchunk);
}
// NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII...
// IANA also likes better US-ASCII, so go with it
- if($enc == 'ASCII')
- {
- $enc = 'US-'.$enc;
+ if ($enc == 'ASCII') {
+ $enc = 'US-' . $enc;
}
+
return $enc;
- }
- else
- {
+ } else {
// no encoding specified: as per HTTP1.1 assume it is iso-8859-1?
// Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types
// this should be the standard. And we should be getting text/xml as request and response.
return PhpXmlRpc::$xmlrpc_defencoding;
}
}
-
-}
\ No newline at end of file
+}
class Charset
{
-
// tables used for transcoding different charsets into us-ascii xml
protected $xml_iso88591_Entities = array("in" => array(), "out" => array());
*/
protected $charset_supersets = array(
- 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
+ 'US-ASCII' => array('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4',
'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8',
'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12',
'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8',
- 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN')
+ 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN',),
);
protected static $instance = null;
/**
- * This class is singleton for performance reasons
+ * This class is singleton for performance reasons.
+ *
* @return Charset
*/
public static function instance()
{
- if(self::$instance === null)
- {
+ if (self::$instance === null) {
self::$instance = new self();
}
private function __construct()
{
- for($i = 0; $i < 32; $i++) {
+ for ($i = 0; $i < 32; $i++) {
$this->xml_iso88591_Entities["in"][] = chr($i);
$this->xml_iso88591_Entities["out"][] = "&#{$i};";
}
- for($i = 160; $i < 256; $i++) {
+ for ($i = 160; $i < 256; $i++) {
$this->xml_iso88591_Entities["in"][] = chr($i);
$this->xml_iso88591_Entities["out"][] = "&#{$i};";
}
{
$this->xml_cp1252_Entities['in'][] = chr($i);
}*/
-
}
/**
* @param string $data
* @param string $src_encoding
* @param string $dest_encoding
+ *
* @return string
*/
- public function encode_entities($data, $src_encoding='', $dest_encoding='')
+ public function encode_entities($data, $src_encoding = '', $dest_encoding = '')
{
- if ($src_encoding == '')
- {
+ if ($src_encoding == '') {
// lame, but we know no better...
$src_encoding = PhpXmlRpc::$xmlrpc_internalencoding;
}
- switch(strtoupper($src_encoding.'_'.$dest_encoding))
- {
+ switch (strtoupper($src_encoding . '_' . $dest_encoding)) {
case 'ISO-8859-1_':
case 'ISO-8859-1_US-ASCII':
$escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data);
// NB: this will choke on invalid UTF-8, going most likely beyond EOF
$escaped_data = '';
// be kind to users creating string xmlrpcvals out of different php types
- $data = (string) $data;
- $ns = strlen ($data);
- for ($nn = 0; $nn < $ns; $nn++)
- {
+ $data = (string)$data;
+ $ns = strlen($data);
+ for ($nn = 0; $nn < $ns; $nn++) {
$ch = $data[$nn];
$ii = ord($ch);
//1 7 0bbbbbbb (127)
- if ($ii < 128)
- {
+ if ($ii < 128) {
/// @todo shall we replace this with a (supposedly) faster str_replace?
- switch($ii){
+ switch ($ii) {
case 34:
$escaped_data .= '"';
break;
default:
$escaped_data .= $ch;
} // switch
- }
- //2 11 110bbbbb 10bbbbbb (2047)
- else if ($ii>>5 == 6)
- {
+ } //2 11 110bbbbb 10bbbbbb (2047)
+ elseif ($ii >> 5 == 6) {
$b1 = ($ii & 31);
- $ii = ord($data[$nn+1]);
+ $ii = ord($data[$nn + 1]);
$b2 = ($ii & 63);
$ii = ($b1 * 64) + $b2;
- $ent = sprintf ('&#%d;', $ii);
+ $ent = sprintf('&#%d;', $ii);
$escaped_data .= $ent;
$nn += 1;
- }
- //3 16 1110bbbb 10bbbbbb 10bbbbbb
- else if ($ii>>4 == 14)
- {
+ } //3 16 1110bbbb 10bbbbbb 10bbbbbb
+ elseif ($ii >> 4 == 14) {
$b1 = ($ii & 15);
- $ii = ord($data[$nn+1]);
+ $ii = ord($data[$nn + 1]);
$b2 = ($ii & 63);
- $ii = ord($data[$nn+2]);
+ $ii = ord($data[$nn + 2]);
$b3 = ($ii & 63);
$ii = ((($b1 * 64) + $b2) * 64) + $b3;
- $ent = sprintf ('&#%d;', $ii);
+ $ent = sprintf('&#%d;', $ii);
$escaped_data .= $ent;
$nn += 2;
- }
- //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
- else if ($ii>>3 == 30)
- {
+ } //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb
+ elseif ($ii >> 3 == 30) {
$b1 = ($ii & 7);
- $ii = ord($data[$nn+1]);
+ $ii = ord($data[$nn + 1]);
$b2 = ($ii & 63);
- $ii = ord($data[$nn+2]);
+ $ii = ord($data[$nn + 2]);
$b3 = ($ii & 63);
- $ii = ord($data[$nn+3]);
+ $ii = ord($data[$nn + 3]);
$b4 = ($ii & 63);
$ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4;
- $ent = sprintf ('&#%d;', $ii);
+ $ent = sprintf('&#%d;', $ii);
$escaped_data .= $ent;
$nn += 3;
}
$escaped_data = '';
error_log("Converting from $src_encoding to $dest_encoding: not supported...");
}
+
return $escaped_data;
}
/**
* Checks if a given charset encoding is present in a list of encodings or
- * if it is a valid subset of any encoding in the list
+ * if it is a valid subset of any encoding in the list.
+ *
* @param string $encoding charset to be tested
* @param string|array $validList comma separated list of valid charsets (or array of charsets)
+ *
* @return bool
*/
public function is_valid_charset($encoding, $validList)
{
-
- if (is_string($validList))
+ if (is_string($validList)) {
$validList = explode(',', $validList);
- if (@in_array(strtoupper($encoding), $validList))
+ }
+ if (@in_array(strtoupper($encoding), $validList)) {
return true;
- else
- {
- if (array_key_exists($encoding, $this->charset_supersets))
- foreach ($validList as $allowed)
- if (in_array($allowed, $this->charset_supersets[$encoding]))
+ } else {
+ if (array_key_exists($encoding, $this->charset_supersets)) {
+ foreach ($validList as $allowed) {
+ if (in_array($allowed, $this->charset_supersets[$encoding])) {
return true;
+ }
+ }
+ }
+
return false;
}
}
-
-}
\ No newline at end of file
+}
*
* @param int $timet (timestamp)
* @param int $utc (0 or 1)
+ *
* @return string
*/
- public static function iso8601_encode($timet, $utc=0)
+ public static function iso8601_encode($timet, $utc = 0)
{
- if(!$utc)
- {
- $t=strftime("%Y%m%dT%H:%M:%S", $timet);
- }
- else
- {
- if(function_exists('gmstrftime'))
- {
+ if (!$utc) {
+ $t = strftime("%Y%m%dT%H:%M:%S", $timet);
+ } else {
+ if (function_exists('gmstrftime')) {
// gmstrftime doesn't exist in some versions
// of PHP
- $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet);
- }
- else
- {
- $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z'));
+ $t = gmstrftime("%Y%m%dT%H:%M:%S", $timet);
+ } else {
+ $t = strftime("%Y%m%dT%H:%M:%S", $timet - date('Z'));
}
}
+
return $t;
}
/**
- * Given an ISO8601 date string, return a timet in the localtime, or UTC
+ * Given an ISO8601 date string, return a timet in the localtime, or UTC.
+ *
* @param string $idate
* @param int $utc either 0 or 1
+ *
* @return int (datetime)
*/
- public static function iso8601_decode($idate, $utc=0)
+ public static function iso8601_decode($idate, $utc = 0)
{
- $t=0;
- if(preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs))
- {
- if($utc)
- {
- $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
- }
- else
- {
- $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
+ $t = 0;
+ if (preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs)) {
+ if ($utc) {
+ $t = gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
+ } else {
+ $t = mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]);
}
}
+
return $t;
}
-}
\ No newline at end of file
+}
/**
* decode a string that is encoded w/ "chunked" transfer encoding
* as defined in rfc2068 par. 19.4.6
- * code shamelessly stolen from nusoap library by Dietrich Ayala
+ * code shamelessly stolen from nusoap library by Dietrich Ayala.
*
* @param string $buffer the string to be decoded
+ *
* @return string
*/
public static function decode_chunked($buffer)
// read chunk-size, chunk-extension (if any) and crlf
// get the position of the linebreak
- $chunkend = strpos($buffer,"\r\n") + 2;
- $temp = substr($buffer,0,$chunkend);
- $chunk_size = hexdec( trim($temp) );
+ $chunkend = strpos($buffer, "\r\n") + 2;
+ $temp = substr($buffer, 0, $chunkend);
+ $chunk_size = hexdec(trim($temp));
$chunkstart = $chunkend;
- while($chunk_size > 0)
- {
+ while ($chunk_size > 0) {
$chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size);
// just in case we got a broken connection
- if($chunkend == false)
- {
- $chunk = substr($buffer,$chunkstart);
+ if ($chunkend == false) {
+ $chunk = substr($buffer, $chunkstart);
// append chunk-data to entity-body
$new .= $chunk;
$length += strlen($chunk);
}
// read chunk-data and crlf
- $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart);
+ $chunk = substr($buffer, $chunkstart, $chunkend - $chunkstart);
// append chunk-data to entity-body
$new .= $chunk;
// length := length + chunk-size
// read chunk-size and crlf
$chunkstart = $chunkend + 2;
- $chunkend = strpos($buffer,"\r\n",$chunkstart)+2;
- if($chunkend == false)
- {
+ $chunkend = strpos($buffer, "\r\n", $chunkstart) + 2;
+ if ($chunkend == false) {
break; //just in case we got a broken connection
}
- $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart);
- $chunk_size = hexdec( trim($temp) );
+ $temp = substr($buffer, $chunkstart, $chunkend - $chunkstart);
+ $chunk_size = hexdec(trim($temp));
$chunkstart = $chunkend;
}
+
return $new;
}
-
-}
\ No newline at end of file
+}
use PhpXmlRpc\Value;
/**
- * Deals with parsing the XML
+ * Deals with parsing the XML.
*/
class XMLParser
{
'method' => false, // so we can check later if we got a methodname or not
'params' => array(),
'pt' => array(),
- 'rt' => ''
+ 'rt' => '',
);
public $xmlrpc_valid_parents = array(
'PARAMS' => array('METHODCALL', 'METHODRESPONSE'),
'FAULT' => array('METHODRESPONSE'),
'NIL' => array('VALUE'), // only used when extension activated
- 'EX:NIL' => array('VALUE') // only used when extension activated
+ 'EX:NIL' => array('VALUE'), // only used when extension activated
);
/**
- * xml parser handler function for opening element tags
+ * xml parser handler function for opening element tags.
*/
- function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false)
+ public function xmlrpc_se($parser, $name, $attrs, $accept_single_vals = false)
{
// if invalid xmlrpc already detected, skip all processing
- if ($this->_xh['isf'] < 2)
- {
+ if ($this->_xh['isf'] < 2) {
// check for correct element nesting
// top level element can only be of 2 types
/// @todo optimization creep: save this check into a bool variable, instead of using count() every time:
/// there is only a single top level element in xml anyway
- if (count($this->_xh['stack']) == 0)
- {
+ if (count($this->_xh['stack']) == 0) {
if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && (
- $name != 'VALUE' && !$accept_single_vals))
- {
+ $name != 'VALUE' && !$accept_single_vals)
+ ) {
$this->_xh['isf'] = 2;
$this->_xh['isf_reason'] = 'missing top level xmlrpc element';
+
return;
- }
- else
- {
+ } else {
$this->_xh['rt'] = strtolower($name);
}
- }
- else
- {
+ } else {
// not top level element: see if parent is OK
$parent = end($this->_xh['stack']);
- if (!array_key_exists($name, $this->xmlrpc_valid_parents) || !in_array($parent, $this->xmlrpc_valid_parents[$name]))
- {
+ if (!array_key_exists($name, $this->xmlrpc_valid_parents) || !in_array($parent, $this->xmlrpc_valid_parents[$name])) {
$this->_xh['isf'] = 2;
$this->_xh['isf_reason'] = "xmlrpc element $name cannot be child of $parent";
+
return;
}
}
- switch($name)
- {
+ switch ($name) {
// optimize for speed switch cases: most common cases first
case 'VALUE':
/// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element
- $this->_xh['vt']='value'; // indicator: no value found yet
- $this->_xh['ac']='';
- $this->_xh['lv']=1;
- $this->_xh['php_class']=null;
+ $this->_xh['vt'] = 'value'; // indicator: no value found yet
+ $this->_xh['ac'] = '';
+ $this->_xh['lv'] = 1;
+ $this->_xh['php_class'] = null;
break;
case 'I4':
case 'INT':
case 'DOUBLE':
case 'DATETIME.ISO8601':
case 'BASE64':
- if ($this->_xh['vt']!='value')
- {
+ if ($this->_xh['vt'] != 'value') {
//two data elements inside a value: an error occurred!
$this->_xh['isf'] = 2;
$this->_xh['isf_reason'] = "$name element following a {$this->_xh['vt']} element inside a single value";
+
return;
}
- $this->_xh['ac']=''; // reset the accumulator
+ $this->_xh['ac'] = ''; // reset the accumulator
break;
case 'STRUCT':
case 'ARRAY':
- if ($this->_xh['vt']!='value')
- {
+ if ($this->_xh['vt'] != 'value') {
//two data elements inside a value: an error occurred!
$this->_xh['isf'] = 2;
$this->_xh['isf_reason'] = "$name element following a {$this->_xh['vt']} element inside a single value";
+
return;
}
// create an empty array to hold child values, and push it onto appropriate stack
$cur_val['type'] = $name;
// check for out-of-band information to rebuild php objs
// and in case it is found, save it
- if (@isset($attrs['PHP_CLASS']))
- {
+ if (@isset($attrs['PHP_CLASS'])) {
$cur_val['php_class'] = $attrs['PHP_CLASS'];
}
$this->_xh['valuestack'][] = $cur_val;
- $this->_xh['vt']='data'; // be prepared for a data element next
+ $this->_xh['vt'] = 'data'; // be prepared for a data element next
break;
case 'DATA':
- if ($this->_xh['vt']!='data')
- {
+ if ($this->_xh['vt'] != 'data') {
//two data elements inside a value: an error occurred!
$this->_xh['isf'] = 2;
$this->_xh['isf_reason'] = "found two data elements inside an array element";
+
return;
}
case 'METHODCALL':
case 'METHODNAME':
case 'NAME':
/// @todo we could check for 2 NAME elements inside a MEMBER element
- $this->_xh['ac']='';
+ $this->_xh['ac'] = '';
break;
case 'FAULT':
- $this->_xh['isf']=1;
+ $this->_xh['isf'] = 1;
break;
case 'MEMBER':
- $this->_xh['valuestack'][count($this->_xh['valuestack'])-1]['name']=''; // set member name to null, in case we do not find in the xml later on
+ $this->_xh['valuestack'][count($this->_xh['valuestack']) - 1]['name'] = ''; // set member name to null, in case we do not find in the xml later on
//$this->_xh['ac']='';
// Drop trough intentionally
case 'PARAM':
// clear value type, so we can check later if no value has been passed for this param/member
- $this->_xh['vt']=null;
+ $this->_xh['vt'] = null;
break;
case 'NIL':
case 'EX:NIL':
- if (PhpXmlRpc::$xmlrpc_null_extension)
- {
- if ($this->_xh['vt']!='value')
- {
+ if (PhpXmlRpc::$xmlrpc_null_extension) {
+ if ($this->_xh['vt'] != 'value') {
//two data elements inside a value: an error occurred!
$this->_xh['isf'] = 2;
$this->_xh['isf_reason'] = "$name element following a {$this->_xh['vt']} element inside a single value";
+
return;
}
- $this->_xh['ac']=''; // reset the accumulator
+ $this->_xh['ac'] = ''; // reset the accumulator
break;
}
// we do not support the <NIL/> extension, so
$this->_xh['stack'][] = $name;
/// @todo optimization creep: move this inside the big switch() above
- if($name!='VALUE')
- {
- $this->_xh['lv']=0;
+ if ($name != 'VALUE') {
+ $this->_xh['lv'] = 0;
}
}
}
/**
- * Used in decoding xml chunks that might represent single xmlrpc values
+ * Used in decoding xml chunks that might represent single xmlrpc values.
*/
- function xmlrpc_se_any($parser, $name, $attrs)
+ public function xmlrpc_se_any($parser, $name, $attrs)
{
$this->xmlrpc_se($parser, $name, $attrs, true);
}
/**
- * xml parser handler function for close element tags
+ * xml parser handler function for close element tags.
*/
- function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)
+ public function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true)
{
- if ($this->_xh['isf'] < 2)
- {
+ if ($this->_xh['isf'] < 2) {
// push this element name from stack
// NB: if XML validates, correct opening/closing is guaranteed and
// we do not have to check for $name == $curr_elem.
// we also checked for proper nesting at start of elements...
$curr_elem = array_pop($this->_xh['stack']);
- switch($name)
- {
+ switch ($name) {
case 'VALUE':
// This if() detects if no scalar was inside <VALUE></VALUE>
- if ($this->_xh['vt']=='value')
- {
- $this->_xh['value']=$this->_xh['ac'];
- $this->_xh['vt']=Value::$xmlrpcString;
+ if ($this->_xh['vt'] == 'value') {
+ $this->_xh['value'] = $this->_xh['ac'];
+ $this->_xh['vt'] = Value::$xmlrpcString;
}
- if ($rebuild_xmlrpcvals)
- {
+ if ($rebuild_xmlrpcvals) {
// build the xmlrpc val out of the data received, and substitute it
$temp = new Value($this->_xh['value'], $this->_xh['vt']);
// in case we got info about underlying php class, save it
// in the object we're rebuilding
- if (isset($this->_xh['php_class']))
+ if (isset($this->_xh['php_class'])) {
$temp->_php_class = $this->_xh['php_class'];
+ }
// check if we are inside an array or struct:
// if value just built is inside an array, let's move it into array on the stack
$vscount = count($this->_xh['valuestack']);
- if ($vscount && $this->_xh['valuestack'][$vscount-1]['type']=='ARRAY')
- {
- $this->_xh['valuestack'][$vscount-1]['values'][] = $temp;
- }
- else
- {
+ if ($vscount && $this->_xh['valuestack'][$vscount - 1]['type'] == 'ARRAY') {
+ $this->_xh['valuestack'][$vscount - 1]['values'][] = $temp;
+ } else {
$this->_xh['value'] = $temp;
}
- }
- else
- {
+ } else {
/// @todo this needs to treat correctly php-serialized objects,
/// since std deserializing is done by php_xmlrpc_decode,
/// which we will not be calling...
- if (isset($this->_xh['php_class']))
- {
+ if (isset($this->_xh['php_class'])) {
}
// check if we are inside an array or struct:
// if value just built is inside an array, let's move it into array on the stack
$vscount = count($this->_xh['valuestack']);
- if ($vscount && $this->_xh['valuestack'][$vscount-1]['type']=='ARRAY')
- {
- $this->_xh['valuestack'][$vscount-1]['values'][] = $this->_xh['value'];
+ if ($vscount && $this->_xh['valuestack'][$vscount - 1]['type'] == 'ARRAY') {
+ $this->_xh['valuestack'][$vscount - 1]['values'][] = $this->_xh['value'];
}
}
break;
case 'DOUBLE':
case 'DATETIME.ISO8601':
case 'BASE64':
- $this->_xh['vt']=strtolower($name);
+ $this->_xh['vt'] = strtolower($name);
/// @todo: optimization creep - remove the if/elseif cycle below
/// since the case() in which we are already did that
- if ($name=='STRING')
- {
- $this->_xh['value']=$this->_xh['ac'];
- }
- elseif ($name=='DATETIME.ISO8601')
- {
- if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $this->_xh['ac']))
- {
- error_log('XML-RPC: invalid value received in DATETIME: '.$this->_xh['ac']);
+ if ($name == 'STRING') {
+ $this->_xh['value'] = $this->_xh['ac'];
+ } elseif ($name == 'DATETIME.ISO8601') {
+ if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $this->_xh['ac'])) {
+ error_log('XML-RPC: invalid value received in DATETIME: ' . $this->_xh['ac']);
}
- $this->_xh['vt']=Value::$xmlrpcDateTime;
- $this->_xh['value']=$this->_xh['ac'];
- }
- elseif ($name=='BASE64')
- {
+ $this->_xh['vt'] = Value::$xmlrpcDateTime;
+ $this->_xh['value'] = $this->_xh['ac'];
+ } elseif ($name == 'BASE64') {
/// @todo check for failure of base64 decoding / catch warnings
- $this->_xh['value']=base64_decode($this->_xh['ac']);
- }
- elseif ($name=='BOOLEAN')
- {
+ $this->_xh['value'] = base64_decode($this->_xh['ac']);
+ } elseif ($name == 'BOOLEAN') {
// special case here: we translate boolean 1 or 0 into PHP
// constants true or false.
// Strings 'true' and 'false' are accepted, even though the
// spec never mentions them (see eg. Blogger api docs)
// NB: this simple checks helps a lot sanitizing input, ie no
// security problems around here
- if ($this->_xh['ac']=='1' || strcasecmp($this->_xh['ac'], 'true') == 0)
- {
- $this->_xh['value']=true;
- }
- else
- {
+ if ($this->_xh['ac'] == '1' || strcasecmp($this->_xh['ac'], 'true') == 0) {
+ $this->_xh['value'] = true;
+ } else {
// log if receiving something strange, even though we set the value to false anyway
- if ($this->_xh['ac']!='0' && strcasecmp($this->_xh['ac'], 'false') != 0)
- error_log('XML-RPC: invalid value received in BOOLEAN: '.$this->_xh['ac']);
- $this->_xh['value']=false;
+ if ($this->_xh['ac'] != '0' && strcasecmp($this->_xh['ac'], 'false') != 0) {
+ error_log('XML-RPC: invalid value received in BOOLEAN: ' . $this->_xh['ac']);
+ }
+ $this->_xh['value'] = false;
}
- }
- elseif ($name=='DOUBLE')
- {
+ } elseif ($name == 'DOUBLE') {
// we have a DOUBLE
// we must check that only 0123456789-.<space> are characters here
// NOTE: regexp could be much stricter than this...
- if (!preg_match('/^[+-eE0123456789 \t.]+$/', $this->_xh['ac']))
- {
+ if (!preg_match('/^[+-eE0123456789 \t.]+$/', $this->_xh['ac'])) {
/// @todo: find a better way of throwing an error than this!
- error_log('XML-RPC: non numeric value received in DOUBLE: '.$this->_xh['ac']);
- $this->_xh['value']='ERROR_NON_NUMERIC_FOUND';
- }
- else
- {
+ error_log('XML-RPC: non numeric value received in DOUBLE: ' . $this->_xh['ac']);
+ $this->_xh['value'] = 'ERROR_NON_NUMERIC_FOUND';
+ } else {
// it's ok, add it on
- $this->_xh['value']=(double)$this->_xh['ac'];
+ $this->_xh['value'] = (double)$this->_xh['ac'];
}
- }
- else
- {
+ } else {
// we have an I4/INT
// we must check that only 0123456789-<space> are characters here
- if (!preg_match('/^[+-]?[0123456789 \t]+$/', $this->_xh['ac']))
- {
+ if (!preg_match('/^[+-]?[0123456789 \t]+$/', $this->_xh['ac'])) {
/// @todo find a better way of throwing an error than this!
- error_log('XML-RPC: non numeric value received in INT: '.$this->_xh['ac']);
- $this->_xh['value']='ERROR_NON_NUMERIC_FOUND';
- }
- else
- {
+ error_log('XML-RPC: non numeric value received in INT: ' . $this->_xh['ac']);
+ $this->_xh['value'] = 'ERROR_NON_NUMERIC_FOUND';
+ } else {
// it's ok, add it on
- $this->_xh['value']=(int)$this->_xh['ac'];
+ $this->_xh['value'] = (int)$this->_xh['ac'];
}
}
//$this->_xh['ac']=''; // is this necessary?
- $this->_xh['lv']=3; // indicate we've found a value
+ $this->_xh['lv'] = 3; // indicate we've found a value
break;
case 'NAME':
- $this->_xh['valuestack'][count($this->_xh['valuestack'])-1]['name'] = $this->_xh['ac'];
+ $this->_xh['valuestack'][count($this->_xh['valuestack']) - 1]['name'] = $this->_xh['ac'];
break;
case 'MEMBER':
//$this->_xh['ac']=''; // is this necessary?
// add to array in the stack the last element built,
// unless no VALUE was found
- if ($this->_xh['vt'])
- {
+ if ($this->_xh['vt']) {
$vscount = count($this->_xh['valuestack']);
- $this->_xh['valuestack'][$vscount-1]['values'][$this->_xh['valuestack'][$vscount-1]['name']] = $this->_xh['value'];
- } else
+ $this->_xh['valuestack'][$vscount - 1]['values'][$this->_xh['valuestack'][$vscount - 1]['name']] = $this->_xh['value'];
+ } else {
error_log('XML-RPC: missing VALUE inside STRUCT in received xml');
+ }
break;
case 'DATA':
//$this->_xh['ac']=''; // is this necessary?
- $this->_xh['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty
+ $this->_xh['vt'] = null; // reset this to check for 2 data elements in a row - even if they're empty
break;
case 'STRUCT':
case 'ARRAY':
// fetch out of stack array of values, and promote it to current value
$curr_val = array_pop($this->_xh['valuestack']);
$this->_xh['value'] = $curr_val['values'];
- $this->_xh['vt']=strtolower($name);
- if (isset($curr_val['php_class']))
- {
+ $this->_xh['vt'] = strtolower($name);
+ if (isset($curr_val['php_class'])) {
$this->_xh['php_class'] = $curr_val['php_class'];
}
break;
case 'PARAM':
// add to array of params the current value,
// unless no VALUE was found
- if ($this->_xh['vt'])
- {
- $this->_xh['params'][]=$this->_xh['value'];
- $this->_xh['pt'][]=$this->_xh['vt'];
- }
- else
+ if ($this->_xh['vt']) {
+ $this->_xh['params'][] = $this->_xh['value'];
+ $this->_xh['pt'][] = $this->_xh['vt'];
+ } else {
error_log('XML-RPC: missing VALUE inside PARAM in received xml');
+ }
break;
case 'METHODNAME':
- $this->_xh['method']=preg_replace('/^[\n\r\t ]+/', '', $this->_xh['ac']);
+ $this->_xh['method'] = preg_replace('/^[\n\r\t ]+/', '', $this->_xh['ac']);
break;
case 'NIL':
case 'EX:NIL':
- if (PhpXmlRpc::$xmlrpc_null_extension)
- {
- $this->_xh['vt']='null';
- $this->_xh['value']=null;
- $this->_xh['lv']=3;
+ if (PhpXmlRpc::$xmlrpc_null_extension) {
+ $this->_xh['vt'] = 'null';
+ $this->_xh['value'] = null;
+ $this->_xh['lv'] = 3;
break;
}
// drop through intentionally if nil extension not enabled
}
/**
- * Used in decoding xmlrpc requests/responses without rebuilding xmlrpc Values
+ * Used in decoding xmlrpc requests/responses without rebuilding xmlrpc Values.
*/
- function xmlrpc_ee_fast($parser, $name)
+ public function xmlrpc_ee_fast($parser, $name)
{
$this->xmlrpc_ee($parser, $name, false);
}
/**
- * xml parser handler function for character data
+ * xml parser handler function for character data.
*/
- function xmlrpc_cd($parser, $data)
+ public function xmlrpc_cd($parser, $data)
{
// skip processing if xml fault already detected
- if ($this->_xh['isf'] < 2)
- {
+ if ($this->_xh['isf'] < 2) {
// "lookforvalue==3" means that we've found an entire value
// and should discard any further character data
- if($this->_xh['lv']!=3)
- {
+ if ($this->_xh['lv'] != 3) {
// G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2
//if($this->_xh['lv']==1)
//{
//{
// $this->_xh['ac'] = '';
//}
- $this->_xh['ac'].=$data;
+ $this->_xh['ac'] .= $data;
}
}
}
* xml parser handler function for 'other stuff', ie. not char data or
* element start/end tag. In fact it only gets called on unknown entities...
*/
- function xmlrpc_dh($parser, $data)
+ public function xmlrpc_dh($parser, $data)
{
// skip processing if xml fault already detected
- if ($this->_xh['isf'] < 2)
- {
- if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';')
- {
+ if ($this->_xh['isf'] < 2) {
+ if (substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';') {
// G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2
//if($this->_xh['lv']==1)
//{
// $this->_xh['lv']=2;
//}
- $this->_xh['ac'].=$data;
+ $this->_xh['ac'] .= $data;
}
}
+
return true;
}
-
-}
\ No newline at end of file
+}
class PhpXmlRpc
{
static public $xmlrpcerr = array(
- 'unknown_method'=>1,
- 'invalid_return'=>2,
- 'incorrect_params'=>3,
- 'introspect_unknown'=>4,
- 'http_error'=>5,
- 'no_data'=>6,
- 'no_ssl'=>7,
- 'curl_fail'=>8,
- 'invalid_request'=>15,
- 'no_curl'=>16,
- 'server_error'=>17,
- 'multicall_error'=>18,
- 'multicall_notstruct'=>9,
- 'multicall_nomethod'=>10,
- 'multicall_notstring'=>11,
- 'multicall_recursion'=>12,
- 'multicall_noparams'=>13,
- 'multicall_notarray'=>14,
+ 'unknown_method' => 1,
+ 'invalid_return' => 2,
+ 'incorrect_params' => 3,
+ 'introspect_unknown' => 4,
+ 'http_error' => 5,
+ 'no_data' => 6,
+ 'no_ssl' => 7,
+ 'curl_fail' => 8,
+ 'invalid_request' => 15,
+ 'no_curl' => 16,
+ 'server_error' => 17,
+ 'multicall_error' => 18,
+ 'multicall_notstruct' => 9,
+ 'multicall_nomethod' => 10,
+ 'multicall_notstring' => 11,
+ 'multicall_recursion' => 12,
+ 'multicall_noparams' => 13,
+ 'multicall_notarray' => 14,
- 'cannot_decompress'=>103,
- 'decompress_fail'=>104,
- 'dechunk_fail'=>105,
- 'server_cannot_decompress'=>106,
- 'server_decompress_fail'=>107
+ 'cannot_decompress' => 103,
+ 'decompress_fail' => 104,
+ 'dechunk_fail' => 105,
+ 'server_cannot_decompress' => 106,
+ 'server_decompress_fail' => 107,
);
static public $xmlrpcstr = array(
- 'unknown_method'=>'Unknown method',
- 'invalid_return'=>'Invalid return payload: enable debugging to examine incoming payload',
- 'incorrect_params'=>'Incorrect parameters passed to method',
- 'introspect_unknown'=>"Can't introspect: method unknown",
- 'http_error'=>"Didn't receive 200 OK from remote server.",
- 'no_data'=>'No data received from server.',
- 'no_ssl'=>'No SSL support compiled in.',
- 'curl_fail'=>'CURL error',
- 'invalid_request'=>'Invalid request payload',
- 'no_curl'=>'No CURL support compiled in.',
- 'server_error'=>'Internal server error',
- 'multicall_error'=>'Received from server invalid multicall response',
- 'multicall_notstruct'=>'system.multicall expected struct',
- 'multicall_nomethod'=>'missing methodName',
- 'multicall_notstring'=>'methodName is not a string',
- 'multicall_recursion'=>'recursive system.multicall forbidden',
- 'multicall_noparams'=>'missing params',
- 'multicall_notarray'=>'params is not an array',
+ 'unknown_method' => 'Unknown method',
+ 'invalid_return' => 'Invalid return payload: enable debugging to examine incoming payload',
+ 'incorrect_params' => 'Incorrect parameters passed to method',
+ 'introspect_unknown' => "Can't introspect: method unknown",
+ 'http_error' => "Didn't receive 200 OK from remote server.",
+ 'no_data' => 'No data received from server.',
+ 'no_ssl' => 'No SSL support compiled in.',
+ 'curl_fail' => 'CURL error',
+ 'invalid_request' => 'Invalid request payload',
+ 'no_curl' => 'No CURL support compiled in.',
+ 'server_error' => 'Internal server error',
+ 'multicall_error' => 'Received from server invalid multicall response',
+ 'multicall_notstruct' => 'system.multicall expected struct',
+ 'multicall_nomethod' => 'missing methodName',
+ 'multicall_notstring' => 'methodName is not a string',
+ 'multicall_recursion' => 'recursive system.multicall forbidden',
+ 'multicall_noparams' => 'missing params',
+ 'multicall_notarray' => 'params is not an array',
- 'cannot_decompress'=>'Received from server compressed HTTP and cannot decompress',
- 'decompress_fail'=>'Received from server invalid compressed HTTP',
- 'dechunk_fail'=>'Received from server invalid chunked HTTP',
- 'server_cannot_decompress'=>'Received from client compressed HTTP request and cannot decompress',
- 'server_decompress_fail'=>'Received from client invalid compressed HTTP request'
+ 'cannot_decompress' => 'Received from server compressed HTTP and cannot decompress',
+ 'decompress_fail' => 'Received from server invalid compressed HTTP',
+ 'dechunk_fail' => 'Received from server invalid chunked HTTP',
+ 'server_cannot_decompress' => 'Received from client compressed HTTP request and cannot decompress',
+ 'server_decompress_fail' => 'Received from client invalid compressed HTTP request',
);
// The charset encoding used by the server for received requests and
public static function exportGlobals()
{
$reflection = new \ReflectionClass('PhpXmlRpc\PhpXmlRpc');
- foreach ($reflection->getStaticProperties() as $name => $value)
- {
+ foreach ($reflection->getStaticProperties() as $name => $value) {
$GLOBALS[$name] = $value;
}
$reflection = new \ReflectionClass('PhpXmlRpc\Value');
- foreach ($reflection->getStaticProperties() as $name => $value)
- {
+ foreach ($reflection->getStaticProperties() as $name => $value) {
$GLOBALS[$name] = $value;
}
}
* 1. include xmlrpc.inc
* 2. set the values, e.g. $GLOBALS['xmlrpc_internalencoding'] = 'UTF-8';
* 3. import them: PhpXmlRpc\PhpXmlRpc::importGlobals();
- * 4. run your own code
+ * 4. run your own code.
*/
public static function importGlobals()
{
$reflection = new \ReflectionClass('PhpXmlRpc\PhpXmlRpc');
$staticProperties = $reflection->getStaticProperties();
- foreach ($staticProperties as $name => $value)
- {
- if(isset($GLOBALS[$name]))
+ foreach ($staticProperties as $name => $value) {
+ if (isset($GLOBALS[$name])) {
self::$$name = $GLOBALS[$name];
+ }
}
}
}
class Request
{
-
/// @todo: do these need to be public?
public $payload;
public $methodname;
- public $params=array();
- public $debug=0;
+ public $params = array();
+ public $debug = 0;
public $content_type = 'text/xml';
// holds data while parsing the response. NB: Not a full Response object
* @param string $methodName the name of the method to invoke
* @param array $params array of parameters to be passed to the method (xmlrpcval objects)
*/
- function __construct($methodName, $params=array())
+ public function __construct($methodName, $params = array())
{
$this->methodname = $methodName;
- foreach($params as $param)
- {
+ foreach ($params as $param) {
$this->addParam($param);
}
}
- public function xml_header($charset_encoding='')
+ public function xml_header($charset_encoding = '')
{
- if ($charset_encoding != '')
- {
+ if ($charset_encoding != '') {
return "<?xml version=\"1.0\" encoding=\"$charset_encoding\" ?" . ">\n<methodCall>\n";
- }
- else
- {
+ } else {
return "<?xml version=\"1.0\"?" . ">\n<methodCall>\n";
}
}
}
/**
- * Kept the old name even if class was renamed, for compatibility
+ * Kept the old name even if class was renamed, for compatibility.
+ *
* @return string
*/
private function kindOf()
return 'msg';
}
- public function createPayload($charset_encoding='')
+ public function createPayload($charset_encoding = '')
{
- if ($charset_encoding != '')
+ if ($charset_encoding != '') {
$this->content_type = 'text/xml; charset=' . $charset_encoding;
- else
+ } else {
$this->content_type = 'text/xml';
- $this->payload=$this->xml_header($charset_encoding);
- $this->payload.='<methodName>' . $this->methodname . "</methodName>\n";
- $this->payload.="<params>\n";
- foreach($this->params as $p)
- {
- $this->payload.="<param>\n" . $p->serialize($charset_encoding) .
- "</param>\n";
}
- $this->payload.="</params>\n";
- $this->payload.=$this->xml_footer();
+ $this->payload = $this->xml_header($charset_encoding);
+ $this->payload .= '<methodName>' . $this->methodname . "</methodName>\n";
+ $this->payload .= "<params>\n";
+ foreach ($this->params as $p) {
+ $this->payload .= "<param>\n" . $p->serialize($charset_encoding) .
+ "</param>\n";
+ }
+ $this->payload .= "</params>\n";
+ $this->payload .= $this->xml_footer();
}
/**
- * Gets/sets the xmlrpc method to be invoked
+ * Gets/sets the xmlrpc method to be invoked.
+ *
* @param string $meth the method to be set (leave empty not to set it)
+ *
* @return string the method that will be invoked
*/
- public function method($methodName='')
+ public function method($methodName = '')
{
- if($methodName!='')
- {
- $this->methodname=$methodName;
+ if ($methodName != '') {
+ $this->methodname = $methodName;
}
+
return $this->methodname;
}
/**
- * Returns xml representation of the message. XML prologue included
+ * Returns xml representation of the message. XML prologue included.
+ *
* @param string $charset_encoding
+ *
* @return string the xml representation of the message, xml prologue included
*/
- public function serialize($charset_encoding='')
+ public function serialize($charset_encoding = '')
{
$this->createPayload($charset_encoding);
+
return $this->payload;
}
/**
- * Add a parameter to the list of parameters to be used upon method invocation
+ * Add a parameter to the list of parameters to be used upon method invocation.
+ *
* @param Value $par
+ *
* @return boolean false on failure
*/
public function addParam($param)
{
// add check: do not add to self params which are not xmlrpcvals
- if(is_object($param) && is_a($param, 'PhpXmlRpc\Value'))
- {
- $this->params[]=$param;
+ if (is_object($param) && is_a($param, 'PhpXmlRpc\Value')) {
+ $this->params[] = $param;
+
return true;
- }
- else
- {
+ } else {
return false;
}
}
/**
* Returns the nth parameter in the request. The index zero-based.
+ *
* @param integer $i the index of the parameter to fetch (zero based)
+ *
* @return Value the i-th parameter
*/
- public function getParam($i) { return $this->params[$i]; }
+ public function getParam($i)
+ {
+ return $this->params[$i];
+ }
/**
* Returns the number of parameters in the messge.
+ *
* @return integer the number of parameters currently set
*/
- public function getNumParams() { return count($this->params); }
+ public function getNumParams()
+ {
+ return count($this->params);
+ }
/**
* Given an open file handle, read all data available and parse it as axmlrpc response.
* But since checking for feof(null) returns false, we would risk an
* infinite loop in that case, because we cannot trust the caller
* to give us a valid pointer to an open file...
+ *
* @param resource $fp stream pointer
+ *
* @return Response
+ *
* @todo add 2nd & 3rd param to be passed to ParseResponse() ???
*/
public function parseResponseFile($fp)
{
- $ipd='';
- while($data=fread($fp, 32768))
- {
- $ipd.=$data;
+ $ipd = '';
+ while ($data = fread($fp, 32768)) {
+ $ipd .= $data;
}
//fclose($fp);
return $this->parseResponse($ipd);
/**
* Parses HTTP headers and separates them from data.
+ *
* @return null|Response null on success, or a Response on error
*/
- private function parseResponseHeaders(&$data, $headers_processed=false)
+ private function parseResponseHeaders(&$data, $headers_processed = false)
{
$this->httpResponse['headers'] = array();
$this->httpResponse['cookies'] = array();
// Support "web-proxy-tunelling" connections for https through proxies
- if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data))
- {
+ if (preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data)) {
// Look for CR/LF or simple LF as line separator,
// (even though it is not valid http)
- $pos = strpos($data,"\r\n\r\n");
- if($pos || is_int($pos))
- {
- $bd = $pos+4;
- }
- else
- {
- $pos = strpos($data,"\n\n");
- if($pos || is_int($pos))
- {
- $bd = $pos+2;
- }
- else
- {
+ $pos = strpos($data, "\r\n\r\n");
+ if ($pos || is_int($pos)) {
+ $bd = $pos + 4;
+ } else {
+ $pos = strpos($data, "\n\n");
+ if ($pos || is_int($pos)) {
+ $bd = $pos + 2;
+ } else {
// No separation between response headers and body: fault?
$bd = 0;
}
}
- if ($bd)
- {
+ if ($bd) {
// this filters out all http headers from proxy.
// maybe we could take them into account, too?
$data = substr($data, $bd);
- }
- else
- {
- error_log('XML-RPC: '.__METHOD__.': HTTPS via proxy error, tunnel connection possibly failed');
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], PhpXmlRpc::$xmlrpcstr['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)');
+ } else {
+ error_log('XML-RPC: ' . __METHOD__ . ': HTTPS via proxy error, tunnel connection possibly failed');
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], PhpXmlRpc::$xmlrpcstr['http_error'] . ' (HTTPS via proxy error, tunnel connection possibly failed)');
+
return $r;
}
}
// Strip HTTP 1.1 100 Continue header if present
- while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data))
- {
+ while (preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data)) {
$pos = strpos($data, 'HTTP', 12);
// server sent a Continue header without any (valid) content following...
// give the client a chance to know it
- if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5
- {
+ if (!$pos && !is_int($pos)) {
+ // works fine in php 3, 4 and 5
+
break;
}
$data = substr($data, $pos);
}
- if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data))
- {
- $errstr= substr($data, 0, strpos($data, "\n")-1);
- error_log('XML-RPC: '.__METHOD__.': HTTP error, got response: ' .$errstr);
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], PhpXmlRpc::$xmlrpcstr['http_error']. ' (' . $errstr . ')');
+ if (!preg_match('/^HTTP\/[0-9.]+ 200 /', $data)) {
+ $errstr = substr($data, 0, strpos($data, "\n") - 1);
+ error_log('XML-RPC: ' . __METHOD__ . ': HTTP error, got response: ' . $errstr);
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['http_error'], PhpXmlRpc::$xmlrpcstr['http_error'] . ' (' . $errstr . ')');
+
return $r;
}
// be tolerant to usage of \n instead of \r\n to separate headers and data
// (even though it is not valid http)
- $pos = strpos($data,"\r\n\r\n");
- if($pos || is_int($pos))
- {
- $bd = $pos+4;
- }
- else
- {
- $pos = strpos($data,"\n\n");
- if($pos || is_int($pos))
- {
- $bd = $pos+2;
- }
- else
- {
+ $pos = strpos($data, "\r\n\r\n");
+ if ($pos || is_int($pos)) {
+ $bd = $pos + 4;
+ } else {
+ $pos = strpos($data, "\n\n");
+ if ($pos || is_int($pos)) {
+ $bd = $pos + 2;
+ } else {
// No separation between response headers and body: fault?
// we could take some action here instead of going on...
$bd = 0;
}
// be tolerant to line endings, and extra empty lines
$ar = preg_split("/\r?\n/", trim(substr($data, 0, $pos)));
- while(list(,$line) = @each($ar))
- {
+ while (list(, $line) = @each($ar)) {
// take care of multi-line headers and cookies
- $arr = explode(':',$line,2);
- if(count($arr) > 1)
- {
+ $arr = explode(':', $line, 2);
+ if (count($arr) > 1) {
$header_name = strtolower(trim($arr[0]));
/// @todo some other headers (the ones that allow a CSV list of values)
/// do allow many values to be passed using multiple header lines.
/// We should add content to $xmlrpc->_xh['headers'][$header_name]
/// instead of replacing it for those...
- if ($header_name == 'set-cookie' || $header_name == 'set-cookie2')
- {
- if ($header_name == 'set-cookie2')
- {
+ if ($header_name == 'set-cookie' || $header_name == 'set-cookie2') {
+ if ($header_name == 'set-cookie2') {
// version 2 cookies:
// there could be many cookies on one line, comma separated
$cookies = explode(',', $arr[1]);
- }
- else
- {
+ } else {
$cookies = array($arr[1]);
}
- foreach ($cookies as $cookie)
- {
+ foreach ($cookies as $cookie) {
// glue together all received cookies, using a comma to separate them
// (same as php does with getallheaders())
- if (isset($this->httpResponse['headers'][$header_name]))
+ if (isset($this->httpResponse['headers'][$header_name])) {
$this->httpResponse['headers'][$header_name] .= ', ' . trim($cookie);
- else
+ } else {
$this->httpResponse['headers'][$header_name] = trim($cookie);
+ }
// parse cookie attributes, in case user wants to correctly honour them
// feature creep: only allow rfc-compliant cookie attributes?
// @todo support for server sending multiple time cookie with same name, but using different PATHs
$cookie = explode(';', $cookie);
- foreach ($cookie as $pos => $val)
- {
+ foreach ($cookie as $pos => $val) {
$val = explode('=', $val, 2);
$tag = trim($val[0]);
$val = trim(@$val[1]);
/// @todo with version 1 cookies, we should strip leading and trailing " chars
- if ($pos == 0)
- {
+ if ($pos == 0) {
$cookiename = $tag;
$this->httpResponse['cookies'][$tag] = array();
$this->httpResponse['cookies'][$cookiename]['value'] = urldecode($val);
- }
- else
- {
- if ($tag != 'value')
- {
+ } else {
+ if ($tag != 'value') {
$this->httpResponse['cookies'][$cookiename][$tag] = $val;
}
}
}
}
- }
- else
- {
+ } else {
$this->httpResponse['headers'][$header_name] = trim($arr[1]);
}
- }
- elseif(isset($header_name))
- {
+ } elseif (isset($header_name)) {
/// @todo version1 cookies might span multiple lines, thus breaking the parsing above
$this->httpResponse['headers'][$header_name] .= ' ' . trim($line);
}
$data = substr($data, $bd);
/// @todo when in CLI mode, do not html-encode the output
- if($this->debug && count($this->httpResponse['headers']))
- {
+ if ($this->debug && count($this->httpResponse['headers'])) {
print "</PRE>\n";
- foreach($this->httpResponse['headers'] as $header => $value)
- {
+ foreach ($this->httpResponse['headers'] as $header => $value) {
print htmlentities("HEADER: $header: $value\n");
}
- foreach($this->httpResponse['cookies'] as $header => $value)
- {
+ foreach ($this->httpResponse['cookies'] as $header => $value) {
print htmlentities("COOKIE: $header={$value['value']}\n");
}
print "</PRE>\n";
// if CURL was used for the call, http headers have been processed,
// and dechunking + reinflating have been carried out
- if(!$headers_processed)
- {
+ if (!$headers_processed) {
// Decode chunked encoding sent by http 1.1 servers
- if(isset($this->httpResponse['headers']['transfer-encoding']) && $this->httpResponse['headers']['transfer-encoding'] == 'chunked')
- {
- if(!$data = Http::decode_chunked($data))
- {
- error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to rebuild the chunked data received from server');
+ if (isset($this->httpResponse['headers']['transfer-encoding']) && $this->httpResponse['headers']['transfer-encoding'] == 'chunked') {
+ if (!$data = Http::decode_chunked($data)) {
+ error_log('XML-RPC: ' . __METHOD__ . ': errors occurred when trying to rebuild the chunked data received from server');
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['dechunk_fail'], PhpXmlRpc::$xmlrpcstr['dechunk_fail']);
+
return $r;
}
}
// Decode gzip-compressed stuff
// code shamelessly inspired from nusoap library by Dietrich Ayala
- if(isset($this->httpResponse['headers']['content-encoding']))
- {
+ if (isset($this->httpResponse['headers']['content-encoding'])) {
$this->httpResponse['headers']['content-encoding'] = str_replace('x-', '', $this->httpResponse['headers']['content-encoding']);
- if($this->httpResponse['headers']['content-encoding'] == 'deflate' || $this->httpResponse['headers']['content-encoding'] == 'gzip')
- {
+ if ($this->httpResponse['headers']['content-encoding'] == 'deflate' || $this->httpResponse['headers']['content-encoding'] == 'gzip') {
// if decoding works, use it. else assume data wasn't gzencoded
- if(function_exists('gzinflate'))
- {
- if($this->httpResponse['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data))
- {
+ if (function_exists('gzinflate')) {
+ if ($this->httpResponse['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) {
$data = $degzdata;
- if($this->debug)
- print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
- }
- elseif($this->httpResponse['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))
- {
+ if ($this->debug) {
+ print "<PRE>---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
+ }
+ } elseif ($this->httpResponse['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
$data = $degzdata;
- if($this->debug)
- print "<PRE>---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
- }
- else
- {
- error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to decode the deflated data received from server');
+ if ($this->debug) {
+ print "<PRE>---INFLATED RESPONSE---[" . strlen($data) . " chars]---\n" . htmlentities($data) . "\n---END---</PRE>";
+ }
+ } else {
+ error_log('XML-RPC: ' . __METHOD__ . ': errors occurred when trying to decode the deflated data received from server');
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['decompress_fail'], PhpXmlRpc::$xmlrpcstr['decompress_fail']);
+
return $r;
}
- }
- else
- {
- error_log('XML-RPC: '.__METHOD__.': the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
+ } else {
+ error_log('XML-RPC: ' . __METHOD__ . ': the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['cannot_decompress'], PhpXmlRpc::$xmlrpcstr['cannot_decompress']);
+
return $r;
}
}
}
} // end of 'if needed, de-chunk, re-inflate response'
- return null;
+ return;
}
/**
* Parse the xmlrpc response contained in the string $data and return a Response object.
+ *
* @param string $data the xmlrpc response, eventually including http headers
* @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
* @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
+ *
* @return Response
*/
- public function parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals')
+ public function parseResponse($data = '', $headers_processed = false, $return_type = 'xmlrpcvals')
{
- if($this->debug)
- {
+ if ($this->debug) {
// by maHo, replaced htmlspecialchars with htmlentities
print "<PRE>---GOT---\n" . htmlentities($data) . "\n---END---\n</PRE>";
}
$this->httpResponse['headers'] = array();
$this->httpResponse['cookies'] = array();
- if($data == '')
- {
- error_log('XML-RPC: '.__METHOD__.': no response received from server.');
+ if ($data == '') {
+ error_log('XML-RPC: ' . __METHOD__ . ': no response received from server.');
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['no_data'], PhpXmlRpc::$xmlrpcstr['no_data']);
+
return $r;
}
// parse the HTTP headers of the response, if present, and separate them from data
- if(substr($data, 0, 4) == 'HTTP')
- {
+ if (substr($data, 0, 4) == 'HTTP') {
$r = $this->parseResponseHeaders($data, $headers_processed);
- if ($r)
- {
+ if ($r) {
// failed processing of HTTP response headers
// save into response obj the full payload received, for debugging
$r->raw_data = $data;
+
return $r;
}
}
- if($this->debug)
- {
+ if ($this->debug) {
$start = strpos($data, '<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
- if ($start)
- {
+ if ($start) {
$start += strlen('<!-- SERVER DEBUG INFO (BASE64 ENCODED):');
$end = strpos($data, '-->', $start);
- $comments = substr($data, $start, $end-$start);
- print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n</PRE>";
+ $comments = substr($data, $start, $end - $start);
+ print "<PRE>---SERVER DEBUG INFO (DECODED) ---\n\t" . htmlentities(str_replace("\n", "\n\t", base64_decode($comments))) . "\n---END---\n</PRE>";
}
}
// be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts)
// idea from Luca Mariano <luca.mariano@email.it> originally in PEARified version of the lib
$pos = strrpos($data, '</methodResponse>');
- if($pos !== false)
- {
- $data = substr($data, 0, $pos+17);
+ if ($pos !== false) {
+ $data = substr($data, 0, $pos + 17);
}
// if user wants back raw xml, give it to him
- if ($return_type == 'xml')
- {
+ if ($return_type == 'xml') {
$r = new Response($data, 0, '', 'xml');
$r->hdrs = $this->httpResponse['headers'];
$r->_cookies = $this->httpResponse['cookies'];
$r->raw_data = $this->httpResponse['raw_data'];
+
return $r;
}
// if response charset encoding is not known / supported, try to use
// the default encoding and parse the xml anyway, but log a warning...
- if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
- // the following code might be better for mb_string enabled installs, but
- // makes the lib about 200% slower...
- //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
- {
- error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received response: '.$resp_encoding);
+ if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
+ // the following code might be better for mb_string enabled installs, but
+ // makes the lib about 200% slower...
+ //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
+
+ error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received response: ' . $resp_encoding);
$resp_encoding = PhpXmlRpc::$xmlrpc_defencoding;
}
$parser = xml_parser_create($resp_encoding);
// we use the broadest one, ie. utf8
// This allows to send data which is native in various charset,
// by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
- if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
- {
+ if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
- }
- else
- {
+ } else {
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
}
$xmlRpcParser = new XMLParser();
xml_set_object($parser, $xmlRpcParser);
- if ($return_type == 'phpvals')
- {
+ if ($return_type == 'phpvals') {
xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
- }
- else
- {
+ } else {
xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
}
xml_set_default_handler($parser, 'xmlrpc_dh');
// first error check: xml not well formed
- if(!xml_parse($parser, $data, count($data)))
- {
+ if (!xml_parse($parser, $data, count($data))) {
// thanks to Peter Kocks <peter.kocks@baygate.com>
- if((xml_get_current_line_number($parser)) == 1)
- {
+ if ((xml_get_current_line_number($parser)) == 1) {
$errstr = 'XML error at line 1, check URL';
- }
- else
- {
+ } else {
$errstr = sprintf('XML error: %s at line %d, column %d',
xml_error_string(xml_get_error_code($parser)),
xml_get_current_line_number($parser), xml_get_current_column_number($parser));
}
error_log($errstr);
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], PhpXmlRpc::$xmlrpcstr['invalid_return'].' ('.$errstr.')');
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'], PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' (' . $errstr . ')');
xml_parser_free($parser);
- if($this->debug)
- {
+ if ($this->debug) {
print $errstr;
}
$r->hdrs = $this->httpResponse['headers'];
$r->_cookies = $this->httpResponse['cookies'];
$r->raw_data = $this->httpResponse['raw_data'];
+
return $r;
}
xml_parser_free($parser);
// second error check: xml well formed but not xml-rpc compliant
- if ($xmlRpcParser->_xh['isf'] > 1)
- {
- if ($this->debug)
- {
+ if ($xmlRpcParser->_xh['isf'] > 1) {
+ if ($this->debug) {
/// @todo echo something for user?
}
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
- PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
+ PhpXmlRpc::$xmlrpcstr['invalid_return'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
}
// third error check: parsing of the response has somehow gone boink.
// NB: shall we omit this check, since we trust the parsing code?
- elseif ($return_type == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value']))
- {
+ elseif ($return_type == 'xmlrpcvals' && !is_object($xmlRpcParser->_xh['value'])) {
// something odd has happened
// and it's time to generate a client side error
// indicating something odd went on
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['invalid_return'],
PhpXmlRpc::$xmlrpcstr['invalid_return']);
- }
- else
- {
- if ($this->debug)
- {
+ } else {
+ if ($this->debug) {
print "<PRE>---PARSED---\n";
// somehow htmlentities chokes on var_export, and some full html string...
//print htmlentitites(var_export($xmlRpcParser->_xh['value'], true));
}
// note that using =& will raise an error if $xmlRpcParser->_xh['st'] does not generate an object.
- $v =& $xmlRpcParser->_xh['value'];
+ $v = &$xmlRpcParser->_xh['value'];
- if($xmlRpcParser->_xh['isf'])
- {
+ if ($xmlRpcParser->_xh['isf']) {
/// @todo we should test here if server sent an int and a string,
/// and/or coerce them into such...
- if ($return_type == 'xmlrpcvals')
- {
+ if ($return_type == 'xmlrpcvals') {
$errno_v = $v->structmem('faultCode');
$errstr_v = $v->structmem('faultString');
$errno = $errno_v->scalarval();
$errstr = $errstr_v->scalarval();
- }
- else
- {
+ } else {
$errno = $v['faultCode'];
$errstr = $v['faultString'];
}
- if($errno == 0)
- {
+ if ($errno == 0) {
// FAULT returned, errno needs to reflect that
$errno = -1;
}
$r = new Response(0, $errno, $errstr);
- }
- else
- {
- $r=new Response($v, 0, '', $return_type);
+ } else {
+ $r = new Response($v, 0, '', $return_type);
}
}
$r->hdrs = $this->httpResponse['headers'];
$r->_cookies = $this->httpResponse['cookies'];
- $r->raw_data = $this->httpResponse['raw_data'];;
+ $r->raw_data = $this->httpResponse['raw_data'];
+
return $r;
}
}
class Response
{
-
/// @todo: do these need to be public?
public $val = 0;
public $valtyp;
* NB: as of now we do not do it, since it might be either an xmlrpcval or a plain
* php val, or a complete xml chunk, depending on usage of Client::send() inside which creator is called...
*/
- function __construct($val, $fcode = 0, $fstr = '', $valtyp='')
+ public function __construct($val, $fcode = 0, $fstr = '', $valtyp = '')
{
- if($fcode != 0)
- {
+ if ($fcode != 0) {
// error response
$this->errno = $fcode;
$this->errstr = $fstr;
//$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later.
- }
- else
- {
+ } else {
// successful response
$this->val = $val;
- if ($valtyp == '')
- {
+ if ($valtyp == '') {
// user did not declare type of response value: try to guess it
- if (is_object($this->val) && is_a($this->val, 'PhpXmlRpc\Value'))
- {
+ if (is_object($this->val) && is_a($this->val, 'PhpXmlRpc\Value')) {
$this->valtyp = 'xmlrpcvals';
- }
- else if (is_string($this->val))
- {
+ } elseif (is_string($this->val)) {
$this->valtyp = 'xml';
- }
- else
- {
+ } else {
$this->valtyp = 'phpvals';
}
- }
- else
- {
+ } else {
// user declares type of resp value: believe him
$this->valtyp = $valtyp;
}
/**
* Returns the error code of the response.
+ *
* @return integer the error code of this response (0 for not-error responses)
*/
public function faultCode()
/**
* Returns the error code of the response.
+ *
* @return string the error string of this response ('' for not-error responses)
*/
public function faultString()
/**
* Returns the value received by the server.
+ *
* @return mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured Client objects
*/
public function value()
* NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)
* are still present in the array. It is up to the user-defined code to decide
* how to use the received cookies, and whether they have to be sent back with the next
- * request to the server (using Client::setCookie) or not
+ * request to the server (using Client::setCookie) or not.
+ *
* @return array array of cookies received from the server
*/
public function cookies()
}
/**
- * Returns xml representation of the response. XML prologue not included
+ * Returns xml representation of the response. XML prologue not included.
+ *
* @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
+ *
* @return string the xml representation of the response
*/
- public function serialize($charset_encoding='')
+ public function serialize($charset_encoding = '')
{
- if ($charset_encoding != '')
+ if ($charset_encoding != '') {
$this->content_type = 'text/xml; charset=' . $charset_encoding;
- else
+ } else {
$this->content_type = 'text/xml';
- if (PhpXmlRpc::$xmlrpc_null_apache_encoding)
- {
- $result = "<methodResponse xmlns:ex=\"".PhpXmlRpc::$xmlrpc_null_apache_encoding_ns."\">\n";
}
- else
- {
+ if (PhpXmlRpc::$xmlrpc_null_apache_encoding) {
+ $result = "<methodResponse xmlns:ex=\"" . PhpXmlRpc::$xmlrpc_null_apache_encoding_ns . "\">\n";
+ } else {
$result = "<methodResponse>\n";
}
- if($this->errno)
- {
+ if ($this->errno) {
// G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients
// by xml-encoding non ascii chars
$charsetEncoder =
$result .= "<fault>\n" .
-"<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .
-"</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .
-Charset::instance()->encode_entities($this->errstr, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "</string></value>\n</member>\n" .
-"</struct>\n</value>\n</fault>";
- }
- else
- {
- if(!is_object($this->val) || !is_a($this->val, 'PhpXmlRpc\Value'))
- {
- if (is_string($this->val) && $this->valtyp == 'xml')
- {
+ "<value>\n<struct><member><name>faultCode</name>\n<value><int>" . $this->errno .
+ "</int></value>\n</member>\n<member>\n<name>faultString</name>\n<value><string>" .
+ Charset::instance()->encode_entities($this->errstr, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "</string></value>\n</member>\n" .
+ "</struct>\n</value>\n</fault>";
+ } else {
+ if (!is_object($this->val) || !is_a($this->val, 'PhpXmlRpc\Value')) {
+ if (is_string($this->val) && $this->valtyp == 'xml') {
$result .= "<params>\n<param>\n" .
$this->val .
"</param>\n</params>";
- }
- else
- {
+ } else {
/// @todo try to build something serializable?
die('cannot serialize xmlrpc response objects whose content is native php values');
}
- }
- else
- {
+ } else {
$result .= "<params>\n<param>\n" .
$this->val->serialize($charset_encoding) .
"</param>\n</params>";
}
$result .= "\n</methodResponse>";
$this->payload = $result;
+
return $result;
}
}
class Server
{
/**
- * Array defining php functions exposed as xmlrpc methods by this server
- */
- protected $dmap=array();
- /**
+ * Array defining php functions exposed as xmlrpc methods by this server.
+ */
+ protected $dmap = array();
+ /*
* Defines how functions in dmap will be invoked: either using an xmlrpc msg object
* or plain php values.
* valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'
*/
- var $functions_parameters_type='xmlrpcvals';
- /**
+ public $functions_parameters_type = 'xmlrpcvals';
+ /*
* Option used for fine-tuning the encoding the php values returned from
* functions registered in the dispatch map when the functions_parameters_types
* member is set to 'phpvals'
* @see php_xmlrpc_encode for a list of values
*/
- var $phpvals_encoding_options = array( 'auto_dates' );
+ public $phpvals_encoding_options = array('auto_dates');
/// controls whether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3
- var $debug = 1;
- /**
+ public $debug = 1;
+ /*
* Controls behaviour of server when invoked user function throws an exception:
* 0 = catch it and return an 'internal error' xmlrpc response (default)
* 1 = catch it and return an xmlrpc response with the error corresponding to the exception
* 2 = allow the exception to float to the upper layers
*/
- var $exception_handling = 0;
- /**
+ public $exception_handling = 0;
+ /*
* When set to true, it will enable HTTP compression of the response, in case
* the client has declared its support for compression in the request.
*/
- var $compress_response = false;
- /**
+ public $compress_response = false;
+ /*
* List of http compression methods accepted by the server for requests.
* NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
*/
- var $accepted_compression = array();
+ public $accepted_compression = array();
/// shall we serve calls to system.* methods?
- var $allow_system_funcs = true;
+ public $allow_system_funcs = true;
/// list of charset encodings natively accepted for requests
- var $accepted_charset_encodings = array();
- /**
+ public $accepted_charset_encodings = array();
+ /*
* charset encoding to be used for response.
* NB: if we can, we will convert the generated response from internal_encoding to the intended one.
* can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),
* or 'auto' (use client-specified charset encoding or same as request if request headers do not specify it (unless request is US-ASCII: then use library default anyway).
* NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
*/
- var $response_charset_encoding = '';
+ public $response_charset_encoding = '';
/**
- * Storage for internal debug info
- */
+ * Storage for internal debug info.
+ */
protected $debug_info = '';
- /**
+ /*
* Extra data passed at runtime to method handling functions. Used only by EPI layer
*/
- var $user_data = null;
+ public $user_data = null;
- static protected $_xmlrpc_debuginfo = '';
- static protected $_xmlrpcs_occurred_errors = '';
- static $_xmlrpcs_prev_ehandler = '';
+ protected static $_xmlrpc_debuginfo = '';
+ protected static $_xmlrpcs_occurred_errors = '';
+ public static $_xmlrpcs_prev_ehandler = '';
/**
- * @param array $dispmap the dispatch map with definition of exposed services
- * @param boolean $servicenow set to false to prevent the server from running upon construction
- */
- function __construct($dispMap=null, $serviceNow=true)
+ * @param array $dispmap the dispatch map with definition of exposed services
+ * @param boolean $servicenow set to false to prevent the server from running upon construction
+ */
+ public function __construct($dispMap = null, $serviceNow = true)
{
// if ZLIB is enabled, let the server by default accept compressed requests,
// and compress responses sent to clients that support them
- if(function_exists('gzinflate'))
- {
+ if (function_exists('gzinflate')) {
$this->accepted_compression = array('gzip', 'deflate');
$this->compress_response = true;
}
* instead, you can use the class add_to_map() function
* to add functions manually (borrowed from SOAPX4)
*/
- if($dispMap)
- {
+ if ($dispMap) {
$this->dmap = $dispMap;
- if($serviceNow)
- {
+ if ($serviceNow) {
$this->service();
}
}
}
/**
- * Set debug level of server.
- * @param integer $in debug lvl: determines info added to xmlrpc responses (as xml comments)
- * 0 = no debug info,
- * 1 = msgs set from user with debugmsg(),
- * 2 = add complete xmlrpc request (headers and body),
- * 3 = add also all processing warnings happened during method processing
- * (NB: this involves setting a custom error handler, and might interfere
- * with the standard processing of the php function exposed as method. In
- * particular, triggering an USER_ERROR level error will not halt script
- * execution anymore, but just end up logged in the xmlrpc response)
- * Note that info added at level 2 and 3 will be base64 encoded
- */
- function setDebug($in)
+ * Set debug level of server.
+ *
+ * @param integer $in debug lvl: determines info added to xmlrpc responses (as xml comments)
+ * 0 = no debug info,
+ * 1 = msgs set from user with debugmsg(),
+ * 2 = add complete xmlrpc request (headers and body),
+ * 3 = add also all processing warnings happened during method processing
+ * (NB: this involves setting a custom error handler, and might interfere
+ * with the standard processing of the php function exposed as method. In
+ * particular, triggering an USER_ERROR level error will not halt script
+ * execution anymore, but just end up logged in the xmlrpc response)
+ * Note that info added at level 2 and 3 will be base64 encoded
+ */
+ public function setDebug($in)
{
- $this->debug=$in;
+ $this->debug = $in;
}
/**
* as part of the response message.
* Note that for best compatibility, the debug string should be encoded using
* the PhpXmlRpc::$xmlrpc_internalencoding character set.
+ *
* @param string $m
* @access public
*/
}
/**
- * Return a string with the serialized representation of all debug info
- * @param string $charset_encoding the target charset encoding for the serialization
- * @return string an XML comment (or two)
- */
- function serializeDebug($charset_encoding='')
+ * Return a string with the serialized representation of all debug info.
+ *
+ * @param string $charset_encoding the target charset encoding for the serialization
+ *
+ * @return string an XML comment (or two)
+ */
+ public function serializeDebug($charset_encoding = '')
{
// Tough encoding problem: which internal charset should we assume for debug info?
// It might contain a copy of raw data received from client, ie with unknown encoding,
// so we split it: system debug is base 64 encoded,
// user debug info should be encoded by the end user using the INTERNAL_ENCODING
$out = '';
- if ($this->debug_info != '')
- {
- $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n".base64_encode($this->debug_info)."\n-->\n";
+ if ($this->debug_info != '') {
+ $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n" . base64_encode($this->debug_info) . "\n-->\n";
}
- if( static::$_xmlrpc_debuginfo!='')
- {
-
+ if (static::$_xmlrpc_debuginfo != '') {
$out .= "<!-- DEBUG INFO:\n" . Charset::instance()->encode_entities(str_replace('--', '_-', static::$_xmlrpc_debuginfo), PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "\n-->\n";
// NB: a better solution MIGHT be to use CDATA, but we need to insert it
// into return payload AFTER the beginning tag
//$out .= "<![CDATA[ DEBUG INFO:\n\n" . str_replace(']]>', ']_]_>', static::$_xmlrpc_debuginfo) . "\n]]>\n";
}
+
return $out;
}
/**
- * Execute the xmlrpc request, printing the response
+ * Execute the xmlrpc request, printing the response.
+ *
* @param string $data the request body. If null, the http POST request will be examined
* @param bool $return_payload When true, return the response but do not echo it or any http header
+ *
* @return Response the response object (usually not used by caller...)
*/
- function service($data=null, $return_payload=false)
+ public function service($data = null, $return_payload = false)
{
- if ($data === null)
- {
+ if ($data === null) {
// workaround for a known bug in php ver. 5.2.2 that broke $HTTP_RAW_POST_DATA
$data = file_get_contents('php://input');
}
$this->debug_info = '';
// Echo back what we received, before parsing it
- if($this->debug > 1)
- {
+ if ($this->debug > 1) {
$this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
}
$r = $this->parseRequestHeaders($data, $req_charset, $resp_charset, $resp_encoding);
- if (!$r)
- {
- $r=$this->parseRequest($data, $req_charset);
+ if (!$r) {
+ $r = $this->parseRequest($data, $req_charset);
}
// save full body of request into response, for more debugging usages
$r->raw_data = $raw_data;
- if($this->debug > 2 && static::$_xmlrpcs_occurred_errors)
- {
+ if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors) {
$this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
static::$_xmlrpcs_occurred_errors . "+++END+++");
}
- $payload=$this->xml_header($resp_charset);
- if($this->debug > 0)
- {
+ $payload = $this->xml_header($resp_charset);
+ if ($this->debug > 0) {
$payload = $payload . $this->serializeDebug($resp_charset);
}
// G. Giunta 2006-01-27: do not create response serialization if it has
// already happened. Helps building json magic
- if (empty($r->payload))
- {
+ if (empty($r->payload)) {
$r->serialize($resp_charset);
}
$payload = $payload . $r->payload;
- if ($return_payload)
- {
+ if ($return_payload) {
return $payload;
}
// if we get a warning/error that has output some text before here, then we cannot
// add a new header. We cannot say we are sending xml, either...
- if(!headers_sent())
- {
- header('Content-Type: '.$r->content_type);
+ if (!headers_sent()) {
+ header('Content-Type: ' . $r->content_type);
// we do not know if client actually told us an accepted charset, but if he did
// we have to tell him what we did
header("Vary: Accept-Charset");
// if we can do it, and we want to do it, and client asked us to,
// and php ini settings do not force it already
$php_no_self_compress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');
- if($this->compress_response && function_exists('gzencode') && $resp_encoding != ''
- && $php_no_self_compress)
- {
- if(strpos($resp_encoding, 'gzip') !== false)
- {
+ if ($this->compress_response && function_exists('gzencode') && $resp_encoding != ''
+ && $php_no_self_compress
+ ) {
+ if (strpos($resp_encoding, 'gzip') !== false) {
$payload = gzencode($payload);
header("Content-Encoding: gzip");
header("Vary: Accept-Encoding");
- }
- elseif (strpos($resp_encoding, 'deflate') !== false)
- {
+ } elseif (strpos($resp_encoding, 'deflate') !== false) {
$payload = gzcompress($payload);
header("Content-Encoding: deflate");
header("Vary: Accept-Encoding");
// do not output content-length header if php is compressing output for us:
// it will mess up measurements
- if($php_no_self_compress)
- {
+ if ($php_no_self_compress) {
header('Content-Length: ' . (int)strlen($payload));
}
- }
- else
- {
- error_log('XML-RPC: '.__METHOD__.': http headers already sent before response is fully generated. Check for php warning or error messages');
+ } else {
+ error_log('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
}
print $payload;
}
/**
- * Add a method to the dispatch map
- * @param string $methodname the name with which the method will be made available
- * @param string $function the php function that will get invoked
- * @param array $sig the array of valid method signatures
- * @param string $doc method documentation
- * @param array $sigdoc the array of valid method signatures docs (one string per param, one for return type)
- */
- function add_to_map($methodname,$function,$sig=null,$doc=false,$sigdoc=false)
+ * Add a method to the dispatch map.
+ *
+ * @param string $methodname the name with which the method will be made available
+ * @param string $function the php function that will get invoked
+ * @param array $sig the array of valid method signatures
+ * @param string $doc method documentation
+ * @param array $sigdoc the array of valid method signatures docs (one string per param, one for return type)
+ */
+ public function add_to_map($methodname, $function, $sig = null, $doc = false, $sigdoc = false)
{
$this->dmap[$methodname] = array(
'function' => $function,
- 'docstring' => $doc
+ 'docstring' => $doc,
);
- if ($sig)
- {
+ if ($sig) {
$this->dmap[$methodname]['signature'] = $sig;
}
- if ($sigdoc)
- {
+ if ($sigdoc) {
$this->dmap[$methodname]['signature_docs'] = $sigdoc;
}
}
/**
- * Verify type and number of parameters received against a list of known signatures
- * @param array $in array of either xmlrpcval objects or xmlrpc type definitions
- * @param array $sig array of known signatures to match against
- * @return array
- */
+ * Verify type and number of parameters received against a list of known signatures.
+ *
+ * @param array $in array of either xmlrpcval objects or xmlrpc type definitions
+ * @param array $sig array of known signatures to match against
+ *
+ * @return array
+ */
protected function verifySignature($in, $sig)
{
// check each possible signature in turn
- if (is_object($in))
- {
+ if (is_object($in)) {
$numParams = $in->getNumParams();
- }
- else
- {
+ } else {
$numParams = count($in);
}
- foreach($sig as $cursig)
- {
- if(count($cursig)==$numParams+1)
- {
- $itsOK=1;
- for($n=0; $n<$numParams; $n++)
- {
- if (is_object($in))
- {
- $p=$in->getParam($n);
- if($p->kindOf() == 'scalar')
- {
- $pt=$p->scalartyp();
- }
- else
- {
- $pt=$p->kindOf();
+ foreach ($sig as $cursig) {
+ if (count($cursig) == $numParams + 1) {
+ $itsOK = 1;
+ for ($n = 0; $n < $numParams; $n++) {
+ if (is_object($in)) {
+ $p = $in->getParam($n);
+ if ($p->kindOf() == 'scalar') {
+ $pt = $p->scalartyp();
+ } else {
+ $pt = $p->kindOf();
}
- }
- else
- {
- $pt= $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
+ } else {
+ $pt = $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
}
// param index is $n+1, as first member of sig is return type
- if($pt != $cursig[$n+1] && $cursig[$n+1] != Value::$xmlrpcValue)
- {
- $itsOK=0;
- $pno=$n+1;
- $wanted=$cursig[$n+1];
- $got=$pt;
+ if ($pt != $cursig[$n + 1] && $cursig[$n + 1] != Value::$xmlrpcValue) {
+ $itsOK = 0;
+ $pno = $n + 1;
+ $wanted = $cursig[$n + 1];
+ $got = $pt;
break;
}
}
- if($itsOK)
- {
- return array(1,'');
+ if ($itsOK) {
+ return array(1, '');
}
}
}
- if(isset($wanted))
- {
+ if (isset($wanted)) {
return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
- }
- else
- {
+ } else {
return array(0, "No method signature matches number of parameters");
}
}
/**
- * Parse http headers received along with xmlrpc request. If needed, inflate request
- * @return mixed null on success or a Response
- */
+ * Parse http headers received along with xmlrpc request. If needed, inflate request.
+ *
+ * @return mixed null on success or a Response
+ */
protected function parseRequestHeaders(&$data, &$req_encoding, &$resp_encoding, &$resp_compression)
{
// check if $_SERVER is populated: it might have been disabled via ini file
// (this is true even when in CLI mode)
- if (count($_SERVER) == 0)
- {
- error_log('XML-RPC: '.__METHOD__.': cannot parse request headers as $_SERVER is not populated');
+ if (count($_SERVER) == 0) {
+ error_log('XML-RPC: ' . __METHOD__ . ': cannot parse request headers as $_SERVER is not populated');
}
- if($this->debug > 1)
- {
- if(function_exists('getallheaders'))
- {
+ if ($this->debug > 1) {
+ if (function_exists('getallheaders')) {
$this->debugmsg(''); // empty line
- foreach(getallheaders() as $name => $val)
- {
+ foreach (getallheaders() as $name => $val) {
$this->debugmsg("HEADER: $name: $val");
}
}
-
}
- if(isset($_SERVER['HTTP_CONTENT_ENCODING']))
- {
+ if (isset($_SERVER['HTTP_CONTENT_ENCODING'])) {
$content_encoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);
- }
- else
- {
+ } else {
$content_encoding = '';
}
// check if request body has been compressed and decompress it
- if($content_encoding != '' && strlen($data))
- {
- if($content_encoding == 'deflate' || $content_encoding == 'gzip')
- {
+ if ($content_encoding != '' && strlen($data)) {
+ if ($content_encoding == 'deflate' || $content_encoding == 'gzip') {
// if decoding works, use it. else assume data wasn't gzencoded
- if(function_exists('gzinflate') && in_array($content_encoding, $this->accepted_compression))
- {
- if($content_encoding == 'deflate' && $degzdata = @gzuncompress($data))
- {
+ if (function_exists('gzinflate') && in_array($content_encoding, $this->accepted_compression)) {
+ if ($content_encoding == 'deflate' && $degzdata = @gzuncompress($data)) {
$data = $degzdata;
- if($this->debug > 1)
- {
- $this->debugmsg("\n+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++");
+ if ($this->debug > 1) {
+ $this->debugmsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
}
- }
- elseif($content_encoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10)))
- {
+ } elseif ($content_encoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
$data = $degzdata;
- if($this->debug > 1)
- $this->debugmsg("+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++");
- }
- else
- {
+ if ($this->debug > 1) {
+ $this->debugmsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
+ }
+ } else {
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'], PhpXmlRpc::$xmlrpcstr['server_decompress_fail']);
+
return $r;
}
- }
- else
- {
+ } else {
//error_log('The server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'], PhpXmlRpc::$xmlrpcstr['server_cannot_decompress']);
+
return $r;
}
}
// check if client specified accepted charsets, and if we know how to fulfill
// the request
- if ($this->response_charset_encoding == 'auto')
- {
+ if ($this->response_charset_encoding == 'auto') {
$resp_encoding = '';
- if (isset($_SERVER['HTTP_ACCEPT_CHARSET']))
- {
+ if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
// here we should check if we can match the client-requested encoding
// with the encodings we know we can generate.
/// @todo we should parse q=0.x preferences instead of getting first charset specified...
$client_accepted_charsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));
// Give preference to internal encoding
$known_charsets = array(PhpXmlRpc::$xmlrpc_internalencoding, 'UTF-8', 'ISO-8859-1', 'US-ASCII');
- foreach ($known_charsets as $charset)
- {
- foreach ($client_accepted_charsets as $accepted)
- if (strpos($accepted, $charset) === 0)
- {
+ foreach ($known_charsets as $charset) {
+ foreach ($client_accepted_charsets as $accepted) {
+ if (strpos($accepted, $charset) === 0) {
$resp_encoding = $charset;
break;
}
- if ($resp_encoding)
+ }
+ if ($resp_encoding) {
break;
+ }
}
}
- }
- else
- {
+ } else {
$resp_encoding = $this->response_charset_encoding;
}
- if (isset($_SERVER['HTTP_ACCEPT_ENCODING']))
- {
+ if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
$resp_compression = $_SERVER['HTTP_ACCEPT_ENCODING'];
- }
- else
- {
+ } else {
$resp_compression = '';
}
$req_encoding = Encoder::guess_encoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',
$data);
- return null;
+ return;
}
/**
- * Parse an xml chunk containing an xmlrpc request and execute the corresponding
- * php function registered with the server
- * @param string $data the xml request
- * @param string $req_encoding (optional) the charset encoding of the xml request
- * @return Response
- */
- public function parseRequest($data, $req_encoding='')
+ * Parse an xml chunk containing an xmlrpc request and execute the corresponding
+ * php function registered with the server.
+ *
+ * @param string $data the xml request
+ * @param string $req_encoding (optional) the charset encoding of the xml request
+ *
+ * @return Response
+ */
+ public function parseRequest($data, $req_encoding = '')
{
// 2005/05/07 commented and moved into caller function code
//if($data=='')
//$data = xmlrpc_html_entity_xlate($data);
// decompose incoming XML into request structure
- if ($req_encoding != '')
- {
- if (!in_array($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
- // the following code might be better for mb_string enabled installs, but
- // makes the lib about 200% slower...
- //if (!is_valid_charset($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
- {
- error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received request: '.$req_encoding);
+ if ($req_encoding != '') {
+ if (!in_array($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
+ // the following code might be better for mb_string enabled installs, but
+ // makes the lib about 200% slower...
+ //if (!is_valid_charset($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
+
+ error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $req_encoding);
$req_encoding = PhpXmlRpc::$xmlrpc_defencoding;
}
/// @BUG this will fail on PHP 5 if charset is not specified in the xml prologue,
// the encoding is not UTF8 and there are non-ascii chars in the text...
/// @todo use an empty string for php 5 ???
$parser = xml_parser_create($req_encoding);
- }
- else
- {
+ } else {
$parser = xml_parser_create();
}
// we use the broadest one, ie. utf8
// This allows to send data which is native in various charset,
// by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
- if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
- {
+ if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
- }
- else
- {
+ } else {
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
}
$xmlRpcParser = new XMLParser();
xml_set_object($parser, $xmlRpcParser);
- if ($this->functions_parameters_type != 'xmlrpcvals')
+ if ($this->functions_parameters_type != 'xmlrpcvals') {
xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
- else
+ } else {
xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
+ }
xml_set_character_data_handler($parser, 'xmlrpc_cd');
xml_set_default_handler($parser, 'xmlrpc_dh');
- if(!xml_parse($parser, $data, 1))
- {
+ if (!xml_parse($parser, $data, 1)) {
// return XML error as a faultCode
- $r=new Response(0,
- PhpXmlRpc::$xmlrpcerrxml+xml_get_error_code($parser),
- sprintf('XML error: %s at line %d, column %d',
- xml_error_string(xml_get_error_code($parser)),
- xml_get_current_line_number($parser), xml_get_current_column_number($parser)));
+ $r = new Response(0,
+ PhpXmlRpc::$xmlrpcerrxml + xml_get_error_code($parser),
+ sprintf('XML error: %s at line %d, column %d',
+ xml_error_string(xml_get_error_code($parser)),
+ xml_get_current_line_number($parser), xml_get_current_column_number($parser)));
xml_parser_free($parser);
- }
- elseif ($xmlRpcParser->_xh['isf'])
- {
+ } elseif ($xmlRpcParser->_xh['isf']) {
xml_parser_free($parser);
- $r=new Response(0,
+ $r = new Response(0,
PhpXmlRpc::$xmlrpcerr['invalid_request'],
PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
- }
- else
- {
+ } else {
xml_parser_free($parser);
// small layering violation in favor of speed and memory usage:
// we should allow the 'execute' method handle this, but in the
// most common scenario (xmlrpcvals type server with some methods
// registered as phpvals) that would mean a useless encode+decode pass
- if ($this->functions_parameters_type != 'xmlrpcvals' || (isset($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type']) && ($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type'] == 'phpvals')))
- {
- if($this->debug > 1)
- {
- $this->debugmsg("\n+++PARSED+++\n".var_export($xmlRpcParser->_xh['params'], true)."\n+++END+++");
+ if ($this->functions_parameters_type != 'xmlrpcvals' || (isset($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type']) && ($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type'] == 'phpvals'))) {
+ if ($this->debug > 1) {
+ $this->debugmsg("\n+++PARSED+++\n" . var_export($xmlRpcParser->_xh['params'], true) . "\n+++END+++");
}
$r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
- }
- else
- {
+ } else {
// build a Request object with data parsed from xml
- $m=new Request($xmlRpcParser->_xh['method']);
+ $m = new Request($xmlRpcParser->_xh['method']);
// now add parameters in
- for($i=0; $i<count($xmlRpcParser->_xh['params']); $i++)
- {
+ for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
$m->addParam($xmlRpcParser->_xh['params'][$i]);
}
- if($this->debug > 1)
- {
- $this->debugmsg("\n+++PARSED+++\n".var_export($m, true)."\n+++END+++");
+ if ($this->debug > 1) {
+ $this->debugmsg("\n+++PARSED+++\n" . var_export($m, true) . "\n+++END+++");
}
$r = $this->execute($m);
}
}
+
return $r;
}
/**
- * Execute a method invoked by the client, checking parameters used
- * @param mixed $m either a Request obj or a method name
- * @param array $params array with method parameters as php types (if m is method name only)
- * @param array $paramtypes array with xmlrpc types of method parameters (if m is method name only)
- * @return Response
- */
- protected function execute($m, $params=null, $paramtypes=null)
+ * Execute a method invoked by the client, checking parameters used.
+ *
+ * @param mixed $m either a Request obj or a method name
+ * @param array $params array with method parameters as php types (if m is method name only)
+ * @param array $paramtypes array with xmlrpc types of method parameters (if m is method name only)
+ *
+ * @return Response
+ */
+ protected function execute($m, $params = null, $paramtypes = null)
{
- if (is_object($m))
- {
+ if (is_object($m)) {
$methName = $m->method();
- }
- else
- {
+ } else {
$methName = $m;
}
$sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);
$dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
- if(!isset($dmap[$methName]['function']))
- {
+ if (!isset($dmap[$methName]['function'])) {
// No such method
return new Response(0,
PhpXmlRpc::$xmlrpcerr['unknown_method'],
}
// Check signature
- if(isset($dmap[$methName]['signature']))
- {
+ if (isset($dmap[$methName]['signature'])) {
$sig = $dmap[$methName]['signature'];
- if (is_object($m))
- {
+ if (is_object($m)) {
list($ok, $errstr) = $this->verifySignature($m, $sig);
- }
- else
- {
+ } else {
list($ok, $errstr) = $this->verifySignature($paramtypes, $sig);
}
- if(!$ok)
- {
+ if (!$ok) {
// Didn't match.
return new Response(
0,
$func = $dmap[$methName]['function'];
// let the 'class::function' syntax be accepted in dispatch maps
- if(is_string($func) && strpos($func, '::'))
- {
+ if (is_string($func) && strpos($func, '::')) {
$func = explode('::', $func);
}
// verify that function to be invoked is in fact callable
- if(!is_callable($func))
- {
- error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler is not callable");
+ if (!is_callable($func)) {
+ error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler is not callable");
+
return new Response(
0,
PhpXmlRpc::$xmlrpcerr['server_error'],
// If debug level is 3, we should catch all errors generated during
// processing of user function, and log them as part of response
- if($this->debug > 2)
- {
+ if ($this->debug > 2) {
$GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
}
- try
- {
+ try {
// Allow mixed-convention servers
- if (is_object($m))
- {
- if($sysCall)
- {
+ if (is_object($m)) {
+ if ($sysCall) {
$r = call_user_func($func, $this, $m);
- }
- else
- {
+ } else {
$r = call_user_func($func, $m);
}
- if (!is_a($r, 'PhpXmlRpc\Response'))
- {
- error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler does not return an xmlrpc response object");
- if (is_a($r, 'PhpXmlRpc\Value'))
- {
+ if (!is_a($r, 'PhpXmlRpc\Response')) {
+ error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler does not return an xmlrpc response object");
+ if (is_a($r, 'PhpXmlRpc\Value')) {
$r = new Response($r);
- }
- else
- {
+ } else {
$r = new Response(
0,
PhpXmlRpc::$xmlrpcerr['server_error'],
);
}
}
- }
- else
- {
+ } else {
// call a 'plain php' function
- if($sysCall)
- {
+ if ($sysCall) {
array_unshift($params, $this);
$r = call_user_func_array($func, $params);
- }
- else
- {
+ } else {
// 3rd API convention for method-handling functions: EPI-style
- if ($this->functions_parameters_type == 'epivals')
- {
+ if ($this->functions_parameters_type == 'epivals') {
$r = call_user_func_array($func, array($methName, $params, $this->user_data));
// mimic EPI behaviour: if we get an array that looks like an error, make it
// an eror response
- if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r))
- {
+ if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) {
$r = new Response(0, (integer)$r['faultCode'], (string)$r['faultString']);
- }
- else
- {
+ } else {
// functions using EPI api should NOT return resp objects,
// so make sure we encode the return type correctly
$r = new Response(php_xmlrpc_encode($r, array('extension_api')));
}
- }
- else
- {
+ } else {
$r = call_user_func_array($func, $params);
}
}
// the return type can be either a Response object or a plain php value...
- if (!is_a($r, '\PhpXmlRpc\Response'))
- {
+ if (!is_a($r, '\PhpXmlRpc\Response')) {
// what should we assume here about automatic encoding of datetimes
// and php classes instances???
$r = new Response(php_xmlrpc_encode($r, $this->phpvals_encoding_options));
}
}
- }
- catch(\Exception $e)
- {
+ } catch (\Exception $e) {
// (barring errors in the lib) an uncatched exception happened
// in the called function, we wrap it in a proper error-response
- switch($this->exception_handling)
- {
+ switch ($this->exception_handling) {
case 2:
throw $e;
break;
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
}
}
- if($this->debug > 2)
- {
+ if ($this->debug > 2) {
// note: restore the error handler we found before calling the
// user func, even if it has been changed inside the func itself
- if($GLOBALS['_xmlrpcs_prev_ehandler'])
- {
+ if ($GLOBALS['_xmlrpcs_prev_ehandler']) {
set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);
- }
- else
- {
+ } else {
restore_error_handler();
}
}
+
return $r;
}
/**
- * add a string to the 'internal debug message' (separate from 'user debug message')
- * @param string $string
- */
+ * add a string to the 'internal debug message' (separate from 'user debug message').
+ *
+ * @param string $string
+ */
protected function debugmsg($string)
{
- $this->debug_info .= $string."\n";
+ $this->debug_info .= $string . "\n";
}
- protected function xml_header($charset_encoding='')
+ protected function xml_header($charset_encoding = '')
{
- if ($charset_encoding != '')
- {
+ if ($charset_encoding != '') {
return "<?xml version=\"1.0\" encoding=\"$charset_encoding\"?" . ">\n";
- }
- else
- {
+ } else {
return "<?xml version=\"1.0\"?" . ">\n";
}
}
/**
- * A debugging routine: just echoes back the input packet as a string value
- * DEPRECATED!
- */
- function echoInput()
+ * A debugging routine: just echoes back the input packet as a string value
+ * DEPRECATED!
+ */
+ public function echoInput()
{
- $r=new Response(new Value( "'Aha said I: '" . $GLOBALS['HTTP_RAW_POST_DATA'], 'string'));
+ $r = new Response(new Value("'Aha said I: '" . $GLOBALS['HTTP_RAW_POST_DATA'], 'string'));
print $r->serialize();
}
'function' => 'PhpXmlRpc\Server::_xmlrpcs_getCapabilities',
'signature' => array(array(Value::$xmlrpcStruct)),
'docstring' => 'This method lists all the capabilites that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to',
- 'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec'))
- )
+ 'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec')),
+ ),
);
}
- public static function _xmlrpcs_getCapabilities($server, $m=null)
+ public static function _xmlrpcs_getCapabilities($server, $m = null)
{
$outAr = array(
// xmlrpc spec: always supported
'xmlrpc' => new Value(array(
'specUrl' => new Value('http://www.xmlrpc.com/spec', 'string'),
- 'specVersion' => new Value(1, 'int')
+ 'specVersion' => new Value(1, 'int'),
), 'struct'),
// if we support system.xxx functions, we always support multicall, too...
// Note that, as of 2006/09/17, the following URL does not respond anymore
'system.multicall' => new Value(array(
'specUrl' => new Value('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),
- 'specVersion' => new Value(1, 'int')
+ 'specVersion' => new Value(1, 'int'),
), 'struct'),
// introspection: version 2! we support 'mixed', too
'introspection' => new Value(array(
'specUrl' => new Value('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),
- 'specVersion' => new Value(2, 'int')
- ), 'struct')
+ 'specVersion' => new Value(2, 'int'),
+ ), 'struct'),
);
// NIL extension
if (PhpXmlRpc::$xmlrpc_null_extension) {
$outAr['nil'] = new Value(array(
'specUrl' => new Value('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),
- 'specVersion' => new Value(1, 'int')
+ 'specVersion' => new Value(1, 'int'),
), 'struct');
}
+
return new Response(new Value($outAr, 'struct'));
}
- public static function _xmlrpcs_listMethods($server, $m=null) // if called in plain php values mode, second param is missing
+ public static function _xmlrpcs_listMethods($server, $m = null) // if called in plain php values mode, second param is missing
{
-
- $outAr=array();
- foreach($server->dmap as $key => $val)
- {
- $outAr[]=new Value($key, 'string');
+ $outAr = array();
+ foreach ($server->dmap as $key => $val) {
+ $outAr[] = new Value($key, 'string');
}
- if($server->allow_system_funcs)
- {
- foreach($server->getSystemDispatchMap() as $key => $val)
- {
- $outAr[]=new Value($key, 'string');
+ if ($server->allow_system_funcs) {
+ foreach ($server->getSystemDispatchMap() as $key => $val) {
+ $outAr[] = new Value($key, 'string');
}
}
+
return new Response(new Value($outAr, 'array'));
}
public static function _xmlrpcs_methodSignature($server, $m)
{
// let accept as parameter both an xmlrpcval or string
- if (is_object($m))
- {
- $methName=$m->getParam(0);
- $methName=$methName->scalarval();
- }
- else
- {
- $methName=$m;
- }
- if(strpos($methName, "system.") === 0)
- {
- $dmap=$server->getSystemDispatchMap();
- }
- else
- {
- $dmap=$server->dmap;
- }
- if(isset($dmap[$methName]))
- {
- if(isset($dmap[$methName]['signature']))
- {
- $sigs=array();
- foreach($dmap[$methName]['signature'] as $inSig)
- {
- $cursig=array();
- foreach($inSig as $sig)
- {
- $cursig[]=new Value($sig, 'string');
+ if (is_object($m)) {
+ $methName = $m->getParam(0);
+ $methName = $methName->scalarval();
+ } else {
+ $methName = $m;
+ }
+ if (strpos($methName, "system.") === 0) {
+ $dmap = $server->getSystemDispatchMap();
+ } else {
+ $dmap = $server->dmap;
+ }
+ if (isset($dmap[$methName])) {
+ if (isset($dmap[$methName]['signature'])) {
+ $sigs = array();
+ foreach ($dmap[$methName]['signature'] as $inSig) {
+ $cursig = array();
+ foreach ($inSig as $sig) {
+ $cursig[] = new Value($sig, 'string');
}
- $sigs[]=new Value($cursig, 'array');
+ $sigs[] = new Value($cursig, 'array');
}
- $r=new Response(new Value($sigs, 'array'));
- }
- else
- {
+ $r = new Response(new Value($sigs, 'array'));
+ } else {
// NB: according to the official docs, we should be returning a
// "none-array" here, which means not-an-array
- $r=new Response(new Value('undef', 'string'));
+ $r = new Response(new Value('undef', 'string'));
}
+ } else {
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
}
- else
- {
- $r=new Response(0,PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
- }
+
return $r;
}
public static function _xmlrpcs_methodHelp($server, $m)
{
// let accept as parameter both an xmlrpcval or string
- if (is_object($m))
- {
- $methName=$m->getParam(0);
- $methName=$methName->scalarval();
- }
- else
- {
- $methName=$m;
- }
- if(strpos($methName, "system.") === 0)
- {
- $dmap=$server->getSystemDispatchMap();
- }
- else
- {
- $dmap=$server->dmap;
- }
- if(isset($dmap[$methName]))
- {
- if(isset($dmap[$methName]['docstring']))
- {
- $r=new Response(new Value($dmap[$methName]['docstring']), 'string');
- }
- else
- {
- $r=new Response(new Value('', 'string'));
- }
+ if (is_object($m)) {
+ $methName = $m->getParam(0);
+ $methName = $methName->scalarval();
+ } else {
+ $methName = $m;
+ }
+ if (strpos($methName, "system.") === 0) {
+ $dmap = $server->getSystemDispatchMap();
+ } else {
+ $dmap = $server->dmap;
}
- else
- {
- $r=new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
+ if (isset($dmap[$methName])) {
+ if (isset($dmap[$methName]['docstring'])) {
+ $r = new Response(new Value($dmap[$methName]['docstring']), 'string');
+ } else {
+ $r = new Response(new Value('', 'string'));
+ }
+ } else {
+ $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
}
+
return $r;
}
public static function _xmlrpcs_multicall_error($err)
{
- if(is_string($err))
- {
+ if (is_string($err)) {
$str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
$code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
- }
- else
- {
+ } else {
$code = $err->faultCode();
$str = $err->faultString();
}
$struct = array();
$struct['faultCode'] = new Value($code, 'int');
$struct['faultString'] = new Value($str, 'string');
+
return new Value($struct, 'struct');
}
public static function _xmlrpcs_multicall_do_call($server, $call)
{
- if($call->kindOf() != 'struct')
- {
+ if ($call->kindOf() != 'struct') {
return static::_xmlrpcs_multicall_error('notstruct');
}
$methName = @$call->structmem('methodName');
- if(!$methName)
- {
+ if (!$methName) {
return static::_xmlrpcs_multicall_error('nomethod');
}
- if($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string')
- {
+ if ($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') {
return static::_xmlrpcs_multicall_error('notstring');
}
- if($methName->scalarval() == 'system.multicall')
- {
+ if ($methName->scalarval() == 'system.multicall') {
return static::_xmlrpcs_multicall_error('recursion');
}
$params = @$call->structmem('params');
- if(!$params)
- {
+ if (!$params) {
return static::_xmlrpcs_multicall_error('noparams');
}
- if($params->kindOf() != 'array')
- {
+ if ($params->kindOf() != 'array') {
return static::_xmlrpcs_multicall_error('notarray');
}
$numParams = $params->arraysize();
$msg = new Request($methName->scalarval());
- for($i = 0; $i < $numParams; $i++)
- {
- if(!$msg->addParam($params->arraymem($i)))
- {
+ for ($i = 0; $i < $numParams; $i++) {
+ if (!$msg->addParam($params->arraymem($i))) {
$i++;
+
return static::_xmlrpcs_multicall_error(new Response(0,
PhpXmlRpc::$xmlrpcerr['incorrect_params'],
PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
$result = $server->execute($msg);
- if($result->faultCode() != 0)
- {
+ if ($result->faultCode() != 0) {
return static::_xmlrpcs_multicall_error($result); // Method returned fault.
}
public static function _xmlrpcs_multicall_do_call_phpvals($server, $call)
{
- if(!is_array($call))
- {
+ if (!is_array($call)) {
return static::_xmlrpcs_multicall_error('notstruct');
}
- if(!array_key_exists('methodName', $call))
- {
+ if (!array_key_exists('methodName', $call)) {
return static::_xmlrpcs_multicall_error('nomethod');
}
- if (!is_string($call['methodName']))
- {
+ if (!is_string($call['methodName'])) {
return static::_xmlrpcs_multicall_error('notstring');
}
- if($call['methodName'] == 'system.multicall')
- {
+ if ($call['methodName'] == 'system.multicall') {
return static::_xmlrpcs_multicall_error('recursion');
}
- if(!array_key_exists('params', $call))
- {
+ if (!array_key_exists('params', $call)) {
return static::_xmlrpcs_multicall_error('noparams');
}
- if(!is_array($call['params']))
- {
+ if (!is_array($call['params'])) {
return static::_xmlrpcs_multicall_error('notarray');
}
// base64 or datetime values, but they will be listed as strings here...
$numParams = count($call['params']);
$pt = array();
- foreach($call['params'] as $val)
+ foreach ($call['params'] as $val) {
$pt[] = php_2_xmlrpc_type(gettype($val));
+ }
$result = $server->execute($call['methodName'], $call['params'], $pt);
- if($result->faultCode() != 0)
- {
+ if ($result->faultCode() != 0) {
return static::_xmlrpcs_multicall_error($result); // Method returned fault.
}
{
$result = array();
// let accept a plain list of php parameters, beside a single xmlrpc msg object
- if (is_object($m))
- {
+ if (is_object($m)) {
$calls = $m->getParam(0);
$numCalls = $calls->arraysize();
- for($i = 0; $i < $numCalls; $i++)
- {
+ for ($i = 0; $i < $numCalls; $i++) {
$call = $calls->arraymem($i);
$result[$i] = static::_xmlrpcs_multicall_do_call($server, $call);
}
- }
- else
- {
- $numCalls=count($m);
- for($i = 0; $i < $numCalls; $i++)
- {
+ } else {
+ $numCalls = count($m);
+ for ($i = 0; $i < $numCalls; $i++) {
$result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $m[$i]);
}
}
* that a PHP execution error on the server generally entails.
*
* NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.
- *
*/
- public static function _xmlrpcs_errorHandler($errcode, $errstring, $filename=null, $lineno=null, $context=null)
+ public static function _xmlrpcs_errorHandler($errcode, $errstring, $filename = null, $lineno = null, $context = null)
{
// obey the @ protocol
- if (error_reporting() == 0)
+ if (error_reporting() == 0) {
return;
+ }
//if($errcode != E_NOTICE && $errcode != E_WARNING && $errcode != E_USER_NOTICE && $errcode != E_USER_WARNING)
- if($errcode != E_STRICT)
- {
+ if ($errcode != E_STRICT) {
\PhpXmlRpc\Server::error_occurred($errstring);
}
// Try to avoid as much as possible disruption to the previous error handling
// mechanism in place
- if($GLOBALS['_xmlrpcs_prev_ehandler'] == '')
- {
+ if ($GLOBALS['_xmlrpcs_prev_ehandler'] == '') {
// The previous error handler was the default: all we should do is log error
// to the default error log (if level high enough)
- if(ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errcode))
- {
+ if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errcode)) {
error_log($errstring);
}
- }
- else
- {
+ } else {
// Pass control on to previous error handler, trying to avoid loops...
- if($GLOBALS['_xmlrpcs_prev_ehandler'] != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'))
- {
- if(is_array($GLOBALS['_xmlrpcs_prev_ehandler']))
- {
+ if ($GLOBALS['_xmlrpcs_prev_ehandler'] != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
+ if (is_array($GLOBALS['_xmlrpcs_prev_ehandler'])) {
// the following works both with static class methods and plain object methods as error handler
call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errcode, $errstring, $filename, $lineno, $context));
- }
- else
- {
+ } else {
$GLOBALS['_xmlrpcs_prev_ehandler']($errcode, $errstring, $filename, $lineno, $context);
}
}
}
}
-
}
"base64" => 1,
"array" => 2,
"struct" => 3,
- "null" => 1
- );
+ "null" => 1,
+ );
/// @todo: does these need to be public?
- public $me=array();
- public $mytype=0;
- public $_php_class=null;
+ public $me = array();
+ public $mytype = 0;
+ public $_php_class = null;
/**
- * @param mixed $val
- * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed
- */
- function __construct($val=-1, $type='') {
+ * @param mixed $val
+ * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed
+ */
+ public function __construct($val = -1, $type = '')
+ {
/// @todo: optimization creep - do not call addXX, do it all inline.
/// downside: booleans will not be coerced anymore
- if($val!==-1 || $type!='')
- {
+ if ($val !== -1 || $type != '') {
// optimization creep: inlined all work done by constructor
- switch($type)
- {
+ switch ($type) {
case '':
- $this->mytype=1;
- $this->me['string']=$val;
+ $this->mytype = 1;
+ $this->me['string'] = $val;
break;
case 'i4':
case 'int':
case 'dateTime.iso8601':
case 'base64':
case 'null':
- $this->mytype=1;
- $this->me[$type]=$val;
+ $this->mytype = 1;
+ $this->me[$type] = $val;
break;
case 'array':
- $this->mytype=2;
- $this->me['array']=$val;
+ $this->mytype = 2;
+ $this->me['array'] = $val;
break;
case 'struct':
- $this->mytype=3;
- $this->me['struct']=$val;
+ $this->mytype = 3;
+ $this->me['struct'] = $val;
break;
default:
- error_log("XML-RPC: ".__METHOD__.": not a known type ($type)");
+ error_log("XML-RPC: " . __METHOD__ . ": not a known type ($type)");
}
/*if($type=='')
{
}
/**
- * Add a single php value to an (unitialized) xmlrpcval
- * @param mixed $val
- * @param string $type
- * @return int 1 or 0 on failure
- */
- function addScalar($val, $type='string')
+ * Add a single php value to an (unitialized) xmlrpcval.
+ *
+ * @param mixed $val
+ * @param string $type
+ *
+ * @return int 1 or 0 on failure
+ */
+ public function addScalar($val, $type = 'string')
{
$typeof = null;
- if(isset(static::$xmlrpcTypes[$type])) {
+ if (isset(static::$xmlrpcTypes[$type])) {
$typeof = static::$xmlrpcTypes[$type];
}
- if($typeof!=1)
- {
- error_log("XML-RPC: ".__METHOD__.": not a scalar type ($type)");
+ if ($typeof != 1) {
+ error_log("XML-RPC: " . __METHOD__ . ": not a scalar type ($type)");
+
return 0;
}
// coerce booleans into correct values
// NB: we should either do it for datetimes, integers and doubles, too,
// or just plain remove this check, implemented on booleans only...
- if($type==static::$xmlrpcBoolean)
- {
- if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false')))
- {
- $val=true;
- }
- else
- {
- $val=false;
+ if ($type == static::$xmlrpcBoolean) {
+ if (strcasecmp($val, 'true') == 0 || $val == 1 || ($val == true && strcasecmp($val, 'false'))) {
+ $val = true;
+ } else {
+ $val = false;
}
}
- switch($this->mytype)
- {
+ switch ($this->mytype) {
case 1:
- error_log('XML-RPC: '.__METHOD__.': scalar xmlrpc value can have only one value');
+ error_log('XML-RPC: ' . __METHOD__ . ': scalar xmlrpc value can have only one value');
+
return 0;
case 3:
- error_log('XML-RPC: '.__METHOD__.': cannot add anonymous scalar to struct xmlrpc value');
+ error_log('XML-RPC: ' . __METHOD__ . ': cannot add anonymous scalar to struct xmlrpc value');
+
return 0;
case 2:
// we're adding a scalar value to an array here
//$ar[]=new Value($val, $type);
//$this->me['array']=$ar;
// Faster (?) avoid all the costly array-copy-by-val done here...
- $this->me['array'][]=new Value($val, $type);
+ $this->me['array'][] = new Value($val, $type);
+
return 1;
default:
// a scalar, so set the value and remember we're scalar
- $this->me[$type]=$val;
- $this->mytype=$typeof;
+ $this->me[$type] = $val;
+ $this->mytype = $typeof;
+
return 1;
}
}
/**
- * Add an array of xmlrpcval objects to an xmlrpcval
- * @param array $vals
- * @return int 1 or 0 on failure
- *
- * @todo add some checking for $vals to be an array of xmlrpcvals?
- */
+ * Add an array of xmlrpcval objects to an xmlrpcval.
+ *
+ * @param array $vals
+ *
+ * @return int 1 or 0 on failure
+ *
+ * @todo add some checking for $vals to be an array of xmlrpcvals?
+ */
public function addArray($vals)
{
- if($this->mytype==0)
- {
- $this->mytype=static::$xmlrpcTypes['array'];
- $this->me['array']=$vals;
+ if ($this->mytype == 0) {
+ $this->mytype = static::$xmlrpcTypes['array'];
+ $this->me['array'] = $vals;
+
return 1;
- }
- elseif($this->mytype==2)
- {
+ } elseif ($this->mytype == 2) {
// we're adding to an array here
$this->me['array'] = array_merge($this->me['array'], $vals);
+
return 1;
- }
- else
- {
- error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');
+ } else {
+ error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
+
return 0;
}
}
/**
- * Add an array of named xmlrpcval objects to an xmlrpcval
+ * Add an array of named xmlrpcval objects to an xmlrpcval.
+ *
* @param array $vals
+ *
* @return int 1 or 0 on failure
*
* @todo add some checking for $vals to be an array?
*/
public function addStruct($vals)
{
- if($this->mytype==0)
- {
- $this->mytype=static::$xmlrpcTypes['struct'];
- $this->me['struct']=$vals;
+ if ($this->mytype == 0) {
+ $this->mytype = static::$xmlrpcTypes['struct'];
+ $this->me['struct'] = $vals;
+
return 1;
- }
- elseif($this->mytype==3)
- {
+ } elseif ($this->mytype == 3) {
// we're adding to a struct here
$this->me['struct'] = array_merge($this->me['struct'], $vals);
+
return 1;
- }
- else
- {
- error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']');
+ } else {
+ error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
+
return 0;
}
}
/**
- * Returns a string containing "struct", "array" or "scalar" describing the base type of the value
+ * Returns a string containing "struct", "array" or "scalar" describing the base type of the value.
+ *
* @return string
*/
public function kindOf()
{
- switch($this->mytype)
- {
+ switch ($this->mytype) {
case 3:
return 'struct';
break;
}
}
- private function serializedata($typ, $val, $charset_encoding='')
+ private function serializedata($typ, $val, $charset_encoding = '')
{
- $rs='';
+ $rs = '';
- if(!isset(static::$xmlrpcTypes[$typ])) {
+ if (!isset(static::$xmlrpcTypes[$typ])) {
return $rs;
}
- switch(static::$xmlrpcTypes[$typ])
- {
+ switch (static::$xmlrpcTypes[$typ]) {
case 1:
- switch($typ)
- {
+ switch ($typ) {
case static::$xmlrpcBase64:
- $rs.="<${typ}>" . base64_encode($val) . "</${typ}>";
+ $rs .= "<${typ}>" . base64_encode($val) . "</${typ}>";
break;
case static::$xmlrpcBoolean:
- $rs.="<${typ}>" . ($val ? '1' : '0') . "</${typ}>";
+ $rs .= "<${typ}>" . ($val ? '1' : '0') . "</${typ}>";
break;
case static::$xmlrpcString:
// G. Giunta 2005/2/13: do NOT use htmlentities, since
// it will produce named html entities, which are invalid xml
- $rs.="<${typ}>" . Charset::instance()->encode_entities($val, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding). "</${typ}>";
+ $rs .= "<${typ}>" . Charset::instance()->encode_entities($val, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "</${typ}>";
break;
case static::$xmlrpcInt:
case static::$xmlrpcI4:
- $rs.="<${typ}>".(int)$val."</${typ}>";
+ $rs .= "<${typ}>" . (int)$val . "</${typ}>";
break;
case static::$xmlrpcDouble:
// avoid using standard conversion of float to string because it is locale-dependent,
// sprintf('%F') could be most likely ok but it fails eg. on 2e-14.
// The code below tries its best at keeping max precision while avoiding exp notation,
// but there is of course no limit in the number of decimal places to be used...
- $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', ''))."</${typ}>";
+ $rs .= "<${typ}>" . preg_replace('/\\.?0+$/', '', number_format((double)$val, 128, '.', '')) . "</${typ}>";
break;
case static::$xmlrpcDateTime:
- if (is_string($val))
- {
- $rs.="<${typ}>${val}</${typ}>";
- }
- else if(is_a($val, 'DateTime'))
- {
- $rs.="<${typ}>".$val->format('Ymd\TH:i:s')."</${typ}>";
- }
- else if(is_int($val))
- {
- $rs.="<${typ}>".strftime("%Y%m%dT%H:%M:%S", $val)."</${typ}>";
- }
- else
- {
+ if (is_string($val)) {
+ $rs .= "<${typ}>${val}</${typ}>";
+ } elseif (is_a($val, 'DateTime')) {
+ $rs .= "<${typ}>" . $val->format('Ymd\TH:i:s') . "</${typ}>";
+ } elseif (is_int($val)) {
+ $rs .= "<${typ}>" . strftime("%Y%m%dT%H:%M:%S", $val) . "</${typ}>";
+ } else {
// not really a good idea here: but what shall we output anyway? left for backward compat...
- $rs.="<${typ}>${val}</${typ}>";
+ $rs .= "<${typ}>${val}</${typ}>";
}
break;
case static::$xmlrpcNull:
- if (PhpXmlRpc::$xmlrpc_null_apache_encoding)
- {
- $rs.="<ex:nil/>";
- }
- else
- {
- $rs.="<nil/>";
+ if (PhpXmlRpc::$xmlrpc_null_apache_encoding) {
+ $rs .= "<ex:nil/>";
+ } else {
+ $rs .= "<nil/>";
}
break;
default:
// no standard type value should arrive here, but provide a possibility
// for xmlrpcvals of unknown type...
- $rs.="<${typ}>${val}</${typ}>";
+ $rs .= "<${typ}>${val}</${typ}>";
}
break;
case 3:
// struct
- if ($this->_php_class)
- {
- $rs.='<struct php_class="' . $this->_php_class . "\">\n";
- }
- else
- {
- $rs.="<struct>\n";
+ if ($this->_php_class) {
+ $rs .= '<struct php_class="' . $this->_php_class . "\">\n";
+ } else {
+ $rs .= "<struct>\n";
}
$charsetEncoder = Charset::instance();
- foreach($val as $key2 => $val2)
- {
- $rs.='<member><name>'.$charsetEncoder->encode_entities($key2, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding)."</name>\n";
+ foreach ($val as $key2 => $val2) {
+ $rs .= '<member><name>' . $charsetEncoder->encode_entities($key2, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "</name>\n";
//$rs.=$this->serializeval($val2);
- $rs.=$val2->serialize($charset_encoding);
- $rs.="</member>\n";
+ $rs .= $val2->serialize($charset_encoding);
+ $rs .= "</member>\n";
}
- $rs.='</struct>';
+ $rs .= '</struct>';
break;
case 2:
// array
- $rs.="<array>\n<data>\n";
- foreach($val as $element)
- {
+ $rs .= "<array>\n<data>\n";
+ foreach ($val as $element) {
//$rs.=$this->serializeval($val[$i]);
- $rs.=$element->serialize($charset_encoding);
+ $rs .= $element->serialize($charset_encoding);
}
- $rs.="</data>\n</array>";
+ $rs .= "</data>\n</array>";
break;
default:
break;
}
+
return $rs;
}
/**
- * Returns xml representation of the value. XML prologue not included
+ * Returns xml representation of the value. XML prologue not included.
+ *
* @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
+ *
* @return string
*/
- public function serialize($charset_encoding='')
+ public function serialize($charset_encoding = '')
{
// add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
//if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
//{
- reset($this->me);
- list($typ, $val) = each($this->me);
- return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";
+ reset($this->me);
+ list($typ, $val) = each($this->me);
+
+ return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";
//}
}
// DEPRECATED
- function serializeval($o)
+ public function serializeval($o)
{
// add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
//if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
//{
- $ar=$o->me;
- reset($ar);
- list($typ, $val) = each($ar);
- return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
+ $ar = $o->me;
+ reset($ar);
+ list($typ, $val) = each($ar);
+
+ return '<value>' . $this->serializedata($typ, $val) . "</value>\n";
//}
}
/**
* Checks whether a struct member with a given name is present.
* Works only on xmlrpcvals of type struct.
+ *
* @param string $m the name of the struct member to be looked up
+ *
* @return boolean
*/
public function structmemexists($m)
/**
* Returns the value of a given struct member (an xmlrpcval object in itself).
- * Will raise a php warning if struct member of given name does not exist
+ * Will raise a php warning if struct member of given name does not exist.
+ *
* @param string $m the name of the struct member to be looked up
+ *
* @return xmlrpcval
*/
public function structmem($m)
/**
* Return next member element for xmlrpcvals of type struct.
+ *
* @return xmlrpcval
*/
public function structeach()
// DEPRECATED! this code looks like it is very fragile and has not been fixed
// for a long long time. Shall we remove it for 2.0?
- function getval()
+ public function getval()
{
// UNSTABLE
reset($this->me);
- list($a,$b)=each($this->me);
+ list($a, $b) = each($this->me);
// contributed by I Sofer, 2001-03-24
// add support for nested arrays to scalarval
// i've created a new method here, so as to
// preserve back compatibility
- if(is_array($b))
- {
+ if (is_array($b)) {
@reset($b);
- while(list($id,$cont) = @each($b))
- {
+ while (list($id, $cont) = @each($b)) {
$b[$id] = $cont->scalarval();
}
}
// add support for structures directly encoding php objects
- if(is_object($b))
- {
+ if (is_object($b)) {
$t = get_object_vars($b);
@reset($t);
- while(list($id,$cont) = @each($t))
- {
+ while (list($id, $cont) = @each($t)) {
$t[$id] = $cont->scalarval();
}
@reset($t);
- while(list($id,$cont) = @each($t))
- {
+ while (list($id, $cont) = @each($t)) {
@$b->$id = $cont;
}
}
}
/**
- * Returns the value of a scalar xmlrpcval
+ * Returns the value of a scalar xmlrpcval.
+ *
* @return mixed
*/
public function scalarval()
{
reset($this->me);
- list(,$b)=each($this->me);
+ list(, $b) = each($this->me);
+
return $b;
}
/**
* Returns the type of the xmlrpcval.
- * For integers, 'int' is always returned in place of 'i4'
+ * For integers, 'int' is always returned in place of 'i4'.
+ *
* @return string
*/
public function scalartyp()
{
reset($this->me);
- list($a,)=each($this->me);
- if($a==static::$xmlrpcI4)
- {
- $a=static::$xmlrpcInt;
+ list($a,) = each($this->me);
+ if ($a == static::$xmlrpcI4) {
+ $a = static::$xmlrpcInt;
}
+
return $a;
}
/**
- * Returns the m-th member of an xmlrpcval of struct type
+ * Returns the m-th member of an xmlrpcval of struct type.
+ *
* @param integer $m the index of the value to be retrieved (zero based)
+ *
* @return xmlrpcval
*/
public function arraymem($m)
}
/**
- * Returns the number of members in an xmlrpcval of array type
+ * Returns the number of members in an xmlrpcval of array type.
+ *
* @return integer
*/
public function arraysize()
}
/**
- * Returns the number of members in an xmlrpcval of struct type
+ * Returns the number of members in an xmlrpcval of struct type.
+ *
* @return integer
*/
public function structsize()
*/
class Wrapper
{
-
/**
- * Given a string defining a php type or phpxmlrpc type (loosely defined: strings
- * accepted come from javadoc blocks), return corresponding phpxmlrpc type.
- * NB: for php 'resource' types returns empty string, since resources cannot be serialized;
- * for php class names returns 'struct', since php objects can be serialized as xmlrpc structs
- * for php arrays always return array, even though arrays sometimes serialize as json structs
- * @param string $phptype
- * @return string
- */
+ * Given a string defining a php type or phpxmlrpc type (loosely defined: strings
+ * accepted come from javadoc blocks), return corresponding phpxmlrpc type.
+ * NB: for php 'resource' types returns empty string, since resources cannot be serialized;
+ * for php class names returns 'struct', since php objects can be serialized as xmlrpc structs
+ * for php arrays always return array, even though arrays sometimes serialize as json structs.
+ *
+ * @param string $phptype
+ *
+ * @return string
+ */
public function php_2_xmlrpc_type($phptype)
{
- switch(strtolower($phptype))
- {
+ switch (strtolower($phptype)) {
case 'string':
return Value::$xmlrpcString;
case 'integer':
case 'resource':
return '';
default:
- if(class_exists($phptype))
- {
+ if (class_exists($phptype)) {
return Value::$xmlrpcStruct;
- }
- else
- {
+ } else {
// unknown: might be any 'extended' xmlrpc type
return Value::$xmlrpcValue;
}
}
/**
- * Given a string defining a phpxmlrpc type return corresponding php type.
- * @param string $xmlrpctype
- * @return string
- */
+ * Given a string defining a phpxmlrpc type return corresponding php type.
+ *
+ * @param string $xmlrpctype
+ *
+ * @return string
+ */
public function xmlrpc_2_php_type($xmlrpctype)
{
- switch(strtolower($xmlrpctype))
- {
+ switch (strtolower($xmlrpctype)) {
case 'base64':
case 'datetime.iso8601':
case 'string':
}
/**
- * Given a user-defined PHP function, create a PHP 'wrapper' function that can
- * be exposed as xmlrpc method from an xmlrpc_server object and called from remote
- * clients (as well as its corresponding signature info).
- *
- * Since php is a typeless language, to infer types of input and output parameters,
- * it relies on parsing the javadoc-style comment block associated with the given
- * function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)
- * in the @param tag is also allowed, if you need the php function to receive/send
- * data in that particular format (note that base64 encoding/decoding is transparently
- * carried out by the lib, while datetime vals are passed around as strings)
- *
- * Known limitations:
- * - only works for user-defined functions, not for PHP internal functions
- * (reflection does not support retrieving number/type of params for those)
- * - functions returning php objects will generate special xmlrpc responses:
- * when the xmlrpc decoding of those responses is carried out by this same lib, using
- * the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.
- * In short: php objects can be serialized, too (except for their resource members),
- * using this function.
- * Other libs might choke on the very same xml that will be generated in this case
- * (i.e. it has a nonstandard attribute on struct element tags)
- * - usage of javadoc @param tags using param names in a different order from the
- * function prototype is not considered valid (to be fixed?)
- *
- * Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'
- * php functions (ie. functions not expecting a single Request obj as parameter)
- * is by making use of the functions_parameters_type class member.
- *
- * @param string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') and array('class', 'methodname') are ok too
- * @param string $newfuncname (optional) name for function to be created
- * @param array $extra_options (optional) array of options for conversion. valid values include:
- * bool return_source when true, php code w. function definition will be returned, not evaluated
- * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
- * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
- * bool suppress_warnings remove from produced xml any runtime warnings due to the php function being invoked
- * @return false on error, or an array containing the name of the new php function,
- * its signature and docs, to be used in the server dispatch map
- *
- * @todo decide how to deal with params passed by ref: bomb out or allow?
- * @todo finish using javadoc info to build method sig if all params are named but out of order
- * @todo add a check for params of 'resource' type
- * @todo add some trigger_errors / error_log when returning false?
- * @todo what to do when the PHP function returns NULL? we are currently returning an empty string value...
- * @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3?
- * @todo if $newfuncname is empty, we could use create_user_func instead of eval, as it is possibly faster
- * @todo add a verbatim_object_copy parameter to allow avoiding the same obj instance?
- */
- public function wrap_php_function($funcname, $newfuncname='', $extra_options=array())
+ * Given a user-defined PHP function, create a PHP 'wrapper' function that can
+ * be exposed as xmlrpc method from an xmlrpc_server object and called from remote
+ * clients (as well as its corresponding signature info).
+ *
+ * Since php is a typeless language, to infer types of input and output parameters,
+ * it relies on parsing the javadoc-style comment block associated with the given
+ * function. Usage of xmlrpc native types (such as datetime.dateTime.iso8601 and base64)
+ * in the @param tag is also allowed, if you need the php function to receive/send
+ * data in that particular format (note that base64 encoding/decoding is transparently
+ * carried out by the lib, while datetime vals are passed around as strings)
+ *
+ * Known limitations:
+ * - only works for user-defined functions, not for PHP internal functions
+ * (reflection does not support retrieving number/type of params for those)
+ * - functions returning php objects will generate special xmlrpc responses:
+ * when the xmlrpc decoding of those responses is carried out by this same lib, using
+ * the appropriate param in php_xmlrpc_decode, the php objects will be rebuilt.
+ * In short: php objects can be serialized, too (except for their resource members),
+ * using this function.
+ * Other libs might choke on the very same xml that will be generated in this case
+ * (i.e. it has a nonstandard attribute on struct element tags)
+ * - usage of javadoc @param tags using param names in a different order from the
+ * function prototype is not considered valid (to be fixed?)
+ *
+ * Note that since rel. 2.0RC3 the preferred method to have the server call 'standard'
+ * php functions (ie. functions not expecting a single Request obj as parameter)
+ * is by making use of the functions_parameters_type class member.
+ *
+ * @param string $funcname the name of the PHP user function to be exposed as xmlrpc method; array($obj, 'methodname') and array('class', 'methodname') are ok too
+ * @param string $newfuncname (optional) name for function to be created
+ * @param array $extra_options (optional) array of options for conversion. valid values include:
+ * bool return_source when true, php code w. function definition will be returned, not evaluated
+ * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
+ * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
+ * bool suppress_warnings remove from produced xml any runtime warnings due to the php function being invoked
+ *
+ * @return false on error, or an array containing the name of the new php function,
+ * its signature and docs, to be used in the server dispatch map
+ *
+ * @todo decide how to deal with params passed by ref: bomb out or allow?
+ * @todo finish using javadoc info to build method sig if all params are named but out of order
+ * @todo add a check for params of 'resource' type
+ * @todo add some trigger_errors / error_log when returning false?
+ * @todo what to do when the PHP function returns NULL? we are currently returning an empty string value...
+ * @todo add an option to suppress php warnings in invocation of user function, similar to server debug level 3?
+ * @todo if $newfuncname is empty, we could use create_user_func instead of eval, as it is possibly faster
+ * @todo add a verbatim_object_copy parameter to allow avoiding the same obj instance?
+ */
+ public function wrap_php_function($funcname, $newfuncname = '', $extra_options = array())
{
$buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;
$prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';
$catch_warnings = isset($extra_options['suppress_warnings']) && $extra_options['suppress_warnings'] ? '@' : '';
$exists = false;
- if (is_string($funcname) && strpos($funcname, '::') !== false)
- {
+ if (is_string($funcname) && strpos($funcname, '::') !== false) {
$funcname = explode('::', $funcname);
}
- if(is_array($funcname))
- {
- if(count($funcname) < 2 || (!is_string($funcname[0]) && !is_object($funcname[0])))
- {
+ if (is_array($funcname)) {
+ if (count($funcname) < 2 || (!is_string($funcname[0]) && !is_object($funcname[0]))) {
error_log('XML-RPC: syntax for function to be wrapped is wrong');
+
return false;
}
- if(is_string($funcname[0]))
- {
+ if (is_string($funcname[0])) {
$plainfuncname = implode('::', $funcname);
- }
- elseif(is_object($funcname[0]))
- {
+ } elseif (is_object($funcname[0])) {
$plainfuncname = get_class($funcname[0]) . '->' . $funcname[1];
}
$exists = method_exists($funcname[0], $funcname[1]);
- }
- else
- {
+ } else {
$plainfuncname = $funcname;
$exists = function_exists($funcname);
}
- if(!$exists)
- {
- error_log('XML-RPC: function to be wrapped is not defined: '.$plainfuncname);
+ if (!$exists) {
+ error_log('XML-RPC: function to be wrapped is not defined: ' . $plainfuncname);
+
return false;
- }
- else
- {
+ } else {
// determine name of new php function
- if($newfuncname == '')
- {
- if(is_array($funcname))
- {
- if(is_string($funcname[0]))
- $xmlrpcfuncname = "{$prefix}_".implode('_', $funcname);
- else
- $xmlrpcfuncname = "{$prefix}_".get_class($funcname[0]) . '_' . $funcname[1];
- }
- else
- {
+ if ($newfuncname == '') {
+ if (is_array($funcname)) {
+ if (is_string($funcname[0])) {
+ $xmlrpcfuncname = "{$prefix}_" . implode('_', $funcname);
+ } else {
+ $xmlrpcfuncname = "{$prefix}_" . get_class($funcname[0]) . '_' . $funcname[1];
+ }
+ } else {
$xmlrpcfuncname = "{$prefix}_$funcname";
}
- }
- else
- {
+ } else {
$xmlrpcfuncname = $newfuncname;
}
- while($buildit && function_exists($xmlrpcfuncname))
- {
+ while ($buildit && function_exists($xmlrpcfuncname)) {
$xmlrpcfuncname .= 'x';
}
// start to introspect PHP code
- if(is_array($funcname))
- {
+ if (is_array($funcname)) {
$func = new \ReflectionMethod($funcname[0], $funcname[1]);
- if($func->isPrivate())
- {
- error_log('XML-RPC: method to be wrapped is private: '.$plainfuncname);
+ if ($func->isPrivate()) {
+ error_log('XML-RPC: method to be wrapped is private: ' . $plainfuncname);
+
return false;
}
- if($func->isProtected())
- {
- error_log('XML-RPC: method to be wrapped is protected: '.$plainfuncname);
+ if ($func->isProtected()) {
+ error_log('XML-RPC: method to be wrapped is protected: ' . $plainfuncname);
+
return false;
}
- if($func->isConstructor())
- {
- error_log('XML-RPC: method to be wrapped is the constructor: '.$plainfuncname);
+ if ($func->isConstructor()) {
+ error_log('XML-RPC: method to be wrapped is the constructor: ' . $plainfuncname);
+
return false;
}
- if($func->isDestructor())
- {
- error_log('XML-RPC: method to be wrapped is the destructor: '.$plainfuncname);
+ if ($func->isDestructor()) {
+ error_log('XML-RPC: method to be wrapped is the destructor: ' . $plainfuncname);
+
return false;
}
- if($func->isAbstract())
- {
- error_log('XML-RPC: method to be wrapped is abstract: '.$plainfuncname);
+ if ($func->isAbstract()) {
+ error_log('XML-RPC: method to be wrapped is abstract: ' . $plainfuncname);
+
return false;
}
/// @todo add more checks for static vs. nonstatic?
- }
- else
- {
+ } else {
$func = new \ReflectionFunction($funcname);
}
- if($func->isInternal())
- {
+ if ($func->isInternal()) {
// Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs
// instead of getparameters to fully reflect internal php functions ?
- error_log('XML-RPC: function to be wrapped is internal: '.$plainfuncname);
+ error_log('XML-RPC: function to be wrapped is internal: ' . $plainfuncname);
+
return false;
}
$paramDocs = array();
$docs = $func->getDocComment();
- if($docs != '')
- {
+ if ($docs != '') {
$docs = explode("\n", $docs);
$i = 0;
- foreach($docs as $doc)
- {
+ foreach ($docs as $doc) {
$doc = trim($doc, " \r\t/*");
- if(strlen($doc) && strpos($doc, '@') !== 0 && !$i)
- {
- if($desc)
- {
+ if (strlen($doc) && strpos($doc, '@') !== 0 && !$i) {
+ if ($desc) {
$desc .= "\n";
}
$desc .= $doc;
- }
- elseif(strpos($doc, '@param') === 0)
- {
+ } elseif (strpos($doc, '@param') === 0) {
// syntax: @param type [$name] desc
- if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches))
- {
- if(strpos($matches[1], '|'))
- {
+ if (preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches)) {
+ if (strpos($matches[1], '|')) {
//$paramDocs[$i]['type'] = explode('|', $matches[1]);
$paramDocs[$i]['type'] = 'mixed';
- }
- else
- {
+ } else {
$paramDocs[$i]['type'] = $matches[1];
}
$paramDocs[$i]['name'] = trim($matches[2]);
$paramDocs[$i]['doc'] = $matches[3];
}
$i++;
- }
- elseif(strpos($doc, '@return') === 0)
- {
+ } elseif (strpos($doc, '@return') === 0) {
// syntax: @return type desc
//$returns = preg_split('/\s+/', $doc);
- if(preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches))
- {
+ if (preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches)) {
$returns = php_2_xmlrpc_type($matches[1]);
- if(isset($matches[2]))
- {
+ if (isset($matches[2])) {
$returnsDocs = $matches[2];
}
}
// execute introspection of actual function prototype
$params = array();
$i = 0;
- foreach($func->getParameters() as $paramobj)
- {
+ foreach ($func->getParameters() as $paramobj) {
$params[$i] = array();
- $params[$i]['name'] = '$'.$paramobj->getName();
+ $params[$i]['name'] = '$' . $paramobj->getName();
$params[$i]['isoptional'] = $paramobj->isOptional();
$i++;
}
-
// start building of PHP code to be eval'd
$innercode = '';
$i = 0;
$parsvariations = array();
$pars = array();
$pnum = count($params);
- foreach($params as $param)
- {
- if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name']))
- {
+ foreach ($params as $param) {
+ if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name'])) {
// param name from phpdoc info does not match param definition!
$paramDocs[$i]['type'] = 'mixed';
}
- if($param['isoptional'])
- {
+ if ($param['isoptional']) {
// this particular parameter is optional. save as valid previous list of parameters
$innercode .= "if (\$paramcount > $i) {\n";
$parsvariations[] = $pars;
}
$innercode .= "\$p$i = \$msg->getParam($i);\n";
- if ($decode_php_objects)
- {
+ if ($decode_php_objects) {
$innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i, array('decode_php_objs'));\n";
- }
- else
- {
+ } else {
$innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i);\n";
}
$pars[] = "\$p$i";
$i++;
- if($param['isoptional'])
- {
+ if ($param['isoptional']) {
$innercode .= "}\n";
}
- if($i == $pnum)
- {
+ if ($i == $pnum) {
// last allowed parameters combination
$parsvariations[] = $pars;
}
$sigs = array();
$psigs = array();
- if(count($parsvariations) == 0)
- {
+ if (count($parsvariations) == 0) {
// only known good synopsis = no parameters
$parsvariations[] = array();
$minpars = 0;
- }
- else
- {
+ } else {
$minpars = count($parsvariations[0]);
}
- if($minpars)
- {
+ if ($minpars) {
// add to code the check for min params number
// NB: this check needs to be done BEFORE decoding param values
$innercode = "\$paramcount = \$msg->getNumParams();\n" .
- "if (\$paramcount < $minpars) return new {$prefix}resp(0, ".PhpXmlRpc::$xmlrpcerr['incorrect_params'].", '".PhpXmlRpc::$xmlrpcerr['incorrect_params']."');\n" . $innercode;
- }
- else
- {
+ "if (\$paramcount < $minpars) return new {$prefix}resp(0, " . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . ", '" . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . "');\n" . $innercode;
+ } else {
$innercode = "\$paramcount = \$msg->getNumParams();\n" . $innercode;
}
$innercode .= "\$np = false;\n";
// since there are no closures in php, if we are given an object instance,
// we store a pointer to it in a global var...
- if ( is_array($funcname) && is_object($funcname[0]) )
- {
- $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] =& $funcname[0];
+ if (is_array($funcname) && is_object($funcname[0])) {
+ $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] = &$funcname[0];
$innercode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcfuncname'];\n";
- $realfuncname = '$obj->'.$funcname[1];
- }
- else
- {
+ $realfuncname = '$obj->' . $funcname[1];
+ } else {
$realfuncname = $plainfuncname;
}
- foreach($parsvariations as $pars)
- {
+ foreach ($parsvariations as $pars) {
$innercode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catch_warnings}$realfuncname(" . implode(',', $pars) . "); else\n";
// build a 'generic' signature (only use an appropriate return type)
$sig = array($returns);
$psig = array($returnsDocs);
- for($i=0; $i < count($pars); $i++)
- {
- if (isset($paramDocs[$i]['type']))
- {
+ for ($i = 0; $i < count($pars); $i++) {
+ if (isset($paramDocs[$i]['type'])) {
$sig[] = $this->php_2_xmlrpc_type($paramDocs[$i]['type']);
- }
- else
- {
+ } else {
$sig[] = Value::$xmlrpcValue;
}
$psig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : '';
$psigs[] = $psig;
}
$innercode .= "\$np = true;\n";
- $innercode .= "if (\$np) return new {$prefix}resp(0, ".PhpXmlRpc::$xmlrpcerr['incorrect_params'].", '".PhpXmlRpc::$xmlrpcerr['incorrect_params']."'); else {\n";
+ $innercode .= "if (\$np) return new {$prefix}resp(0, " . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . ", '" . PhpXmlRpc::$xmlrpcerr['incorrect_params'] . "'); else {\n";
//$innercode .= "if (\$_xmlrpcs_error_occurred) return new Response(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n";
$innercode .= "if (is_a(\$retval, '{$prefix}resp')) return \$retval; else\n";
- if($returns == Value::$xmlrpcDateTime || $returns == Value::$xmlrpcBase64)
- {
+ if ($returns == Value::$xmlrpcDateTime || $returns == Value::$xmlrpcBase64) {
$innercode .= "return new {$prefix}resp(new {$prefix}val(\$retval, '$returns'));";
- }
- else
- {
- if ($encode_php_objects)
+ } else {
+ if ($encode_php_objects) {
$innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval, array('encode_php_objs')));\n";
- else
+ } else {
$innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval));\n";
+ }
}
// shall we exclude functions returning by ref?
// if($func->returnsReference())
// return false;
$code = "function $xmlrpcfuncname(\$msg) {\n" . $innercode . "}\n}";
//print_r($code);
- if ($buildit)
- {
+ if ($buildit) {
$allOK = 0;
- eval($code.'$allOK=1;');
+ eval($code . '$allOK=1;');
// alternative
//$xmlrpcfuncname = create_function('$m', $innercode);
- if(!$allOK)
- {
- error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap php function '.$plainfuncname);
+ if (!$allOK) {
+ error_log('XML-RPC: could not create function ' . $xmlrpcfuncname . ' to wrap php function ' . $plainfuncname);
+
return false;
}
}
/// usage as method signature, plus put together a nice string for docs
$ret = array('function' => $xmlrpcfuncname, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $psigs, 'source' => $code);
+
return $ret;
}
}
/**
- * Given a user-defined PHP class or php object, map its methods onto a list of
- * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server
- * object and called from remote clients (as well as their corresponding signature info).
- *
- * @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class
- * @param array $extra_options see the docs for wrap_php_method for more options
- * string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance
- * @return array or false on failure
- *
- * @todo get_class_methods will return both static and non-static methods.
- * we have to differentiate the action, depending on wheter we recived a class name or object
- */
- public function wrap_php_class($classname, $extra_options=array())
+ * Given a user-defined PHP class or php object, map its methods onto a list of
+ * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server
+ * object and called from remote clients (as well as their corresponding signature info).
+ *
+ * @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class
+ * @param array $extra_options see the docs for wrap_php_method for more options
+ * string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance
+ *
+ * @return array or false on failure
+ *
+ * @todo get_class_methods will return both static and non-static methods.
+ * we have to differentiate the action, depending on wheter we recived a class name or object
+ */
+ public function wrap_php_class($classname, $extra_options = array())
{
$methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';
$methodtype = isset($extra_options['method_type']) ? $extra_options['method_type'] : 'auto';
$result = array();
$mlist = get_class_methods($classname);
- foreach($mlist as $mname)
- {
- if ($methodfilter == '' || preg_match($methodfilter, $mname))
- {
+ foreach ($mlist as $mname) {
+ if ($methodfilter == '' || preg_match($methodfilter, $mname)) {
// echo $mlist."\n";
$func = new ReflectionMethod($classname, $mname);
- if(!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract())
- {
- if(($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) ||
- (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname)))))
- {
+ if (!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract()) {
+ if (($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) ||
+ (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname))))
+ ) {
$methodwrap = wrap_php_function(array($classname, $mname), '', $extra_options);
- if ( $methodwrap )
- {
+ if ($methodwrap) {
$result[$methodwrap['function']] = $methodwrap['function'];
}
}
}
}
}
+
return $result;
}
/**
- * Given an xmlrpc client and a method name, register a php wrapper function
- * that will call it and return results using native php types for both
- * params and results. The generated php function will return a Response
- * object for failed xmlrpc calls
- *
- * Known limitations:
- * - server must support system.methodsignature for the wanted xmlrpc method
- * - for methods that expose many signatures, only one can be picked (we
- * could in principle check if signatures differ only by number of params
- * and not by type, but it would be more complication than we can spare time)
- * - nested xmlrpc params: the caller of the generated php function has to
- * encode on its own the params passed to the php function if these are structs
- * or arrays whose (sub)members include values of type datetime or base64
- *
- * Notes: the connection properties of the given client will be copied
- * and reused for the connection used during the call to the generated
- * php function.
- * Calling the generated php function 'might' be slow: a new xmlrpc client
- * is created on every invocation and an xmlrpc-connection opened+closed.
- * An extra 'debug' param is appended to param list of xmlrpc method, useful
- * for debugging purposes.
- *
- * @param Client $client an xmlrpc client set up correctly to communicate with target server
- * @param string $methodname the xmlrpc method to be mapped to a php function
- * @param array $extra_options array of options that specify conversion details. valid options include
- * integer signum the index of the method signature to use in mapping (if method exposes many sigs)
- * integer timeout timeout (in secs) to be used when executing function/calling remote method
- * string protocol 'http' (default), 'http11' or 'https'
- * string new_function_name the name of php function to create. If unspecified, lib will pick an appropriate name
- * string return_source if true return php code w. function definition instead fo function name
- * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
- * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
- * mixed return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the Response object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values
- * bool debug set it to 1 or 2 to see debug results of querying server for method synopsis
- * @return string the name of the generated php function (or false) - OR AN ARRAY...
- */
- public function wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='')
+ * Given an xmlrpc client and a method name, register a php wrapper function
+ * that will call it and return results using native php types for both
+ * params and results. The generated php function will return a Response
+ * object for failed xmlrpc calls.
+ *
+ * Known limitations:
+ * - server must support system.methodsignature for the wanted xmlrpc method
+ * - for methods that expose many signatures, only one can be picked (we
+ * could in principle check if signatures differ only by number of params
+ * and not by type, but it would be more complication than we can spare time)
+ * - nested xmlrpc params: the caller of the generated php function has to
+ * encode on its own the params passed to the php function if these are structs
+ * or arrays whose (sub)members include values of type datetime or base64
+ *
+ * Notes: the connection properties of the given client will be copied
+ * and reused for the connection used during the call to the generated
+ * php function.
+ * Calling the generated php function 'might' be slow: a new xmlrpc client
+ * is created on every invocation and an xmlrpc-connection opened+closed.
+ * An extra 'debug' param is appended to param list of xmlrpc method, useful
+ * for debugging purposes.
+ *
+ * @param Client $client an xmlrpc client set up correctly to communicate with target server
+ * @param string $methodname the xmlrpc method to be mapped to a php function
+ * @param array $extra_options array of options that specify conversion details. valid options include
+ * integer signum the index of the method signature to use in mapping (if method exposes many sigs)
+ * integer timeout timeout (in secs) to be used when executing function/calling remote method
+ * string protocol 'http' (default), 'http11' or 'https'
+ * string new_function_name the name of php function to create. If unspecified, lib will pick an appropriate name
+ * string return_source if true return php code w. function definition instead fo function name
+ * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects
+ * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers ---
+ * mixed return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the Response object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values
+ * bool debug set it to 1 or 2 to see debug results of querying server for method synopsis
+ *
+ * @return string the name of the generated php function (or false) - OR AN ARRAY...
+ */
+ public function wrap_xmlrpc_method($client, $methodname, $extra_options = 0, $timeout = 0, $protocol = '', $newfuncname = '')
{
// mind numbing: let caller use sane calling convention (as per javadoc, 3 params),
// OR the 2.0 calling convention (no options) - we really love backward compat, don't we?
- if (!is_array($extra_options))
- {
+ if (!is_array($extra_options)) {
$signum = $extra_options;
$extra_options = array();
- }
- else
- {
+ } else {
$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;
$timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0;
$protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : '';
$simple_client_copy = isset($extra_options['simple_client_copy']) ? (int)($extra_options['simple_client_copy']) : 0;
$buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;
$prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';
- if (isset($extra_options['return_on_fault']))
- {
+ if (isset($extra_options['return_on_fault'])) {
$decode_fault = true;
$fault_response = $extra_options['return_on_fault'];
- }
- else
- {
+ } else {
$decode_fault = false;
$fault_response = '';
}
$debug = isset($extra_options['debug']) ? ($extra_options['debug']) : 0;
- $msgclass = $prefix.'msg';
- $valclass = $prefix.'val';
- $decodefunc = 'php_'.$prefix.'_decode';
+ $msgclass = $prefix . 'msg';
+ $valclass = $prefix . 'val';
+ $decodefunc = 'php_' . $prefix . '_decode';
$msg = new $msgclass('system.methodSignature');
$msg->addparam(new $valclass($methodname));
$client->setDebug($debug);
$response = $client->send($msg, $timeout, $protocol);
- if($response->faultCode())
- {
- error_log('XML-RPC: could not retrieve method signature from remote server for method '.$methodname);
+ if ($response->faultCode()) {
+ error_log('XML-RPC: could not retrieve method signature from remote server for method ' . $methodname);
+
return false;
- }
- else
- {
+ } else {
$msig = $response->value();
- if ($client->return_type != 'phpvals')
- {
+ if ($client->return_type != 'phpvals') {
$msig = $decodefunc($msig);
}
- if(!is_array($msig) || count($msig) <= $signum)
- {
- error_log('XML-RPC: could not retrieve method signature nr.'.$signum.' from remote server for method '.$methodname);
+ if (!is_array($msig) || count($msig) <= $signum) {
+ error_log('XML-RPC: could not retrieve method signature nr.' . $signum . ' from remote server for method ' . $methodname);
+
return false;
- }
- else
- {
+ } else {
// pick a suitable name for the new function, avoiding collisions
- if($newfuncname != '')
- {
+ if ($newfuncname != '') {
$xmlrpcfuncname = $newfuncname;
- }
- else
- {
+ } else {
// take care to insure that methodname is translated to valid
// php function name
- $xmlrpcfuncname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
- array('_', ''), $methodname);
+ $xmlrpcfuncname = $prefix . '_' . preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
+ array('_', ''), $methodname);
}
- while($buildit && function_exists($xmlrpcfuncname))
- {
+ while ($buildit && function_exists($xmlrpcfuncname)) {
$xmlrpcfuncname .= 'x';
}
$mdesc = '';
// if in 'offline' mode, get method description too.
// in online mode, favour speed of operation
- if(!$buildit)
- {
+ if (!$buildit) {
$msg = new $msgclass('system.methodHelp');
$msg->addparam(new $valclass($methodname));
$response = $client->send($msg, $timeout, $protocol);
- if (!$response->faultCode())
- {
+ if (!$response->faultCode()) {
$mdesc = $response->value();
- if ($client->return_type != 'phpvals')
- {
+ if ($client->return_type != 'phpvals') {
$mdesc = $mdesc->scalarval();
}
}
$fault_response);
//print_r($code);
- if ($buildit)
- {
+ if ($buildit) {
$allOK = 0;
- eval($results['source'].'$allOK=1;');
+ eval($results['source'] . '$allOK=1;');
// alternative
//$xmlrpcfuncname = create_function('$m', $innercode);
- if($allOK)
- {
+ if ($allOK) {
return $xmlrpcfuncname;
- }
- else
- {
- error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap remote method '.$methodname);
+ } else {
+ error_log('XML-RPC: could not create function ' . $xmlrpcfuncname . ' to wrap remote method ' . $methodname);
+
return false;
}
- }
- else
- {
+ } else {
$results['function'] = $xmlrpcfuncname;
+
return $results;
}
}
}
/**
- * Similar to wrap_xmlrpc_method, but will generate a php class that wraps
- * all xmlrpc methods exposed by the remote server as own methods.
- * For more details see wrap_xmlrpc_method.
- * @param Client $client the client obj all set to query the desired server
- * @param array $extra_options list of options for wrapped code
- * @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options)
- */
- public function wrap_xmlrpc_server($client, $extra_options=array())
+ * Similar to wrap_xmlrpc_method, but will generate a php class that wraps
+ * all xmlrpc methods exposed by the remote server as own methods.
+ * For more details see wrap_xmlrpc_method.
+ *
+ * @param Client $client the client obj all set to query the desired server
+ * @param array $extra_options list of options for wrapped code
+ *
+ * @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options)
+ */
+ public function wrap_xmlrpc_server($client, $extra_options = array())
{
$methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : '';
//$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0;
$buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true;
$prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc';
- $msgclass = $prefix.'msg';
+ $msgclass = $prefix . 'msg';
//$valclass = $prefix.'val';
- $decodefunc = 'php_'.$prefix.'_decode';
+ $decodefunc = 'php_' . $prefix . '_decode';
$msg = new $msgclass('system.listMethods');
$response = $client->send($msg, $timeout, $protocol);
- if($response->faultCode())
- {
+ if ($response->faultCode()) {
error_log('XML-RPC: could not retrieve method list from remote server');
+
return false;
- }
- else
- {
+ } else {
$mlist = $response->value();
- if ($client->return_type != 'phpvals')
- {
+ if ($client->return_type != 'phpvals') {
$mlist = $decodefunc($mlist);
}
- if(!is_array($mlist) || !count($mlist))
- {
+ if (!is_array($mlist) || !count($mlist)) {
error_log('XML-RPC: could not retrieve meaningful method list from remote server');
+
return false;
- }
- else
- {
+ } else {
// pick a suitable name for the new function, avoiding collisions
- if($newclassname != '')
- {
+ if ($newclassname != '') {
$xmlrpcclassname = $newclassname;
+ } else {
+ $xmlrpcclassname = $prefix . '_' . preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
+ array('_', ''), $client->server) . '_client';
}
- else
- {
- $xmlrpcclassname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
- array('_', ''), $client->server).'_client';
- }
- while($buildit && class_exists($xmlrpcclassname))
- {
+ while ($buildit && class_exists($xmlrpcclassname)) {
$xmlrpcclassname .= 'x';
}
$opts = array('simple_client_copy' => 2, 'return_source' => true,
'timeout' => $timeout, 'protocol' => $protocol,
'encode_php_objs' => $encode_php_objects, 'prefix' => $prefix,
- 'decode_php_objs' => $decode_php_objects
- );
+ 'decode_php_objs' => $decode_php_objects,
+ );
/// @todo build javadoc for class definition, too
- foreach($mlist as $mname)
- {
- if ($methodfilter == '' || preg_match($methodfilter, $mname))
- {
+ foreach ($mlist as $mname) {
+ if ($methodfilter == '' || preg_match($methodfilter, $mname)) {
$opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'),
array('_', ''), $mname);
$methodwrap = wrap_xmlrpc_method($client, $mname, $opts);
- if ($methodwrap)
- {
- if (!$buildit)
- {
+ if ($methodwrap) {
+ if (!$buildit) {
$source .= $methodwrap['docstring'];
}
- $source .= $methodwrap['source']."\n";
- }
- else
- {
- error_log('XML-RPC: will not create class method to wrap remote method '.$mname);
+ $source .= $methodwrap['source'] . "\n";
+ } else {
+ error_log('XML-RPC: will not create class method to wrap remote method ' . $mname);
}
}
}
$source .= "}\n";
- if ($buildit)
- {
+ if ($buildit) {
$allOK = 0;
- eval($source.'$allOK=1;');
+ eval($source . '$allOK=1;');
// alternative
//$xmlrpcfuncname = create_function('$m', $innercode);
- if($allOK)
- {
+ if ($allOK) {
return $xmlrpcclassname;
- }
- else
- {
- error_log('XML-RPC: could not create class '.$xmlrpcclassname.' to wrap remote server '.$client->server);
+ } else {
+ error_log('XML-RPC: could not create class ' . $xmlrpcclassname . ' to wrap remote server ' . $client->server);
+
return false;
}
- }
- else
- {
+ } else {
return array('class' => $xmlrpcclassname, 'code' => $source, 'docstring' => '');
}
}
}
/**
- * Given the necessary info, build php code that creates a new function to
- * invoke a remote xmlrpc method.
- * Take care that no full checking of input parameters is done to ensure that
- * valid php code is emitted.
- * Note: real spaghetti code follows...
- */
+ * Given the necessary info, build php code that creates a new function to
+ * invoke a remote xmlrpc method.
+ * Take care that no full checking of input parameters is done to ensure that
+ * valid php code is emitted.
+ * Note: real spaghetti code follows...
+ */
protected function build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname,
- $msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc',
- $decode_php_objects=false, $encode_php_objects=false, $decode_fault=false,
- $fault_response='')
+ $msig, $mdesc = '', $timeout = 0, $protocol = '', $client_copy_mode = 0, $prefix = 'xmlrpc',
+ $decode_php_objects = false, $encode_php_objects = false, $decode_fault = false,
+ $fault_response = '')
{
$code = "function $xmlrpcfuncname (";
- if ($client_copy_mode < 2)
- {
+ if ($client_copy_mode < 2) {
// client copy mode 0 or 1 == partial / full client copy in emitted code
$innercode = $this->build_client_wrapper_code($client, $client_copy_mode, $prefix);
$innercode .= "\$client->setDebug(\$debug);\n";
$this_ = '';
- }
- else
- {
+ } else {
// client copy mode 2 == no client copy in emitted code
$innercode = '';
$this_ = 'this->';
}
$innercode .= "\$msg = new {$prefix}msg('$methodname');\n";
- if ($mdesc != '')
- {
+ if ($mdesc != '') {
// take care that PHP comment is not terminated unwillingly by method description
- $mdesc = "/**\n* ".str_replace('*/', '* /', $mdesc)."\n";
- }
- else
- {
+ $mdesc = "/**\n* " . str_replace('*/', '* /', $mdesc) . "\n";
+ } else {
$mdesc = "/**\nFunction $xmlrpcfuncname\n";
}
// param parsing
$plist = array();
$pcount = count($msig);
- for($i = 1; $i < $pcount; $i++)
- {
+ for ($i = 1; $i < $pcount; $i++) {
$plist[] = "\$p$i";
$ptype = $msig[$i];
- if($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' ||
- $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null')
- {
+ if ($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' ||
+ $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null'
+ ) {
// only build directly xmlrpcvals when type is known and scalar
$innercode .= "\$p$i = new {$prefix}val(\$p$i, '$ptype');\n";
- }
- else
- {
- if ($encode_php_objects)
- {
+ } else {
+ if ($encode_php_objects) {
$innercode .= "\$p$i = php_{$prefix}_encode(\$p$i, array('encode_php_objs'));\n";
- }
- else
- {
+ } else {
$innercode .= "\$p$i = php_{$prefix}_encode(\$p$i);\n";
}
}
$innercode .= "\$msg->addparam(\$p$i);\n";
- $mdesc .= '* @param '.$this->xmlrpc_2_php_type($ptype)." \$p$i\n";
+ $mdesc .= '* @param ' . $this->xmlrpc_2_php_type($ptype) . " \$p$i\n";
}
- if ($client_copy_mode < 2)
- {
+ if ($client_copy_mode < 2) {
$plist[] = '$debug=0';
$mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n";
}
$plist = implode(', ', $plist);
- $mdesc .= '* @return '.$this->xmlrpc_2_php_type($msig[0])." (or an {$prefix}resp obj instance if call fails)\n*/\n";
+ $mdesc .= '* @return ' . $this->xmlrpc_2_php_type($msig[0]) . " (or an {$prefix}resp obj instance if call fails)\n*/\n";
$innercode .= "\$res = \${$this_}client->send(\$msg, $timeout, '$protocol');\n";
- if ($decode_fault)
- {
- if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false)))
- {
- $respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '".str_replace("'", "''", $fault_response)."')";
- }
- else
- {
+ if ($decode_fault) {
+ if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false))) {
+ $respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '" . str_replace("'", "''", $fault_response) . "')";
+ } else {
$respcode = var_export($fault_response, true);
}
- }
- else
- {
+ } else {
$respcode = '$res';
}
- if ($decode_php_objects)
- {
+ if ($decode_php_objects) {
$innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value(), array('decode_php_objs'));";
- }
- else
- {
+ } else {
$innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value());";
}
- $code = $code . $plist. ") {\n" . $innercode . "\n}\n";
+ $code = $code . $plist . ") {\n" . $innercode . "\n}\n";
return array('source' => $code, 'docstring' => $mdesc);
}
/**
- * Given necessary info, generate php code that will rebuild a client object
- * Take care that no full checking of input parameters is done to ensure that
- * valid php code is emitted.
- */
- protected function build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc')
+ * Given necessary info, generate php code that will rebuild a client object
+ * Take care that no full checking of input parameters is done to ensure that
+ * valid php code is emitted.
+ */
+ protected function build_client_wrapper_code($client, $verbatim_client_copy, $prefix = 'xmlrpc')
{
- $code = "\$client = new {$prefix}_client('".str_replace("'", "\'", $client->path).
+ $code = "\$client = new {$prefix}_client('" . str_replace("'", "\'", $client->path) .
"', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n";
// copy all client fields to the client that will be generated runtime
// (this provides for future expansion or subclassing of client obj)
- if ($verbatim_client_copy)
- {
- foreach($client as $fld => $val)
- {
- if($fld != 'debug' && $fld != 'return_type')
- {
+ if ($verbatim_client_copy) {
+ foreach ($client as $fld => $val) {
+ if ($fld != 'debug' && $fld != 'return_type') {
$val = var_export($val, true);
$code .= "\$client->$fld = $val;\n";
}
//$code .= "\$client->setDebug(\$debug);\n";
return $code;
}
-
-}
\ No newline at end of file
+}
git://git.onelab.eu / plcapi.git / commitdiff