{$this->method}
EOD;
foreach ($this->args as $arg) {
$this->xml .= '';
$v = new IXR_Value($arg);
$this->xml .= $v->getXml();
$this->xml .= "\n";
}
$this->xml .= '';
}
function getLength()
{
return strlen($this->xml);
}
function getXml()
{
return $this->xml;
}
}
/**
* IXR_Client
*
* @package IXR
* @since 1.5
*
*/
class IXR_Client
{
var $server;
var $port;
var $path;
var $useragent;
var $response;
var $message = false;
var $debug = false;
var $timeout;
// Storage place for an error message
var $error = false;
function IXR_Client($server, $path = false, $port = 80, $timeout = 15)
{
if (!$path) {
// Assume we have been given a URL instead
$bits = parse_url($server);
$this->server = $bits['host'];
$this->port = isset($bits['port']) ? $bits['port'] : 80;
$this->path = isset($bits['path']) ? $bits['path'] : '/';
// Make absolutely sure we have a path
if (!$this->path) {
$this->path = '/';
}
} else {
$this->server = $server;
$this->path = $path;
$this->port = $port;
}
$this->useragent = 'The Incutio XML-RPC PHP Library';
$this->timeout = $timeout;
}
function query()
{
$args = func_get_args();
$method = array_shift($args);
$request = new IXR_Request($method, $args);
$length = $request->getLength();
$xml = $request->getXml();
$r = "\r\n";
$request = "POST {$this->path} HTTP/1.0$r";
// Merged from WP #8145 - allow custom headers
$this->headers['Host'] = $this->server;
$this->headers['Content-Type'] = 'text/xml';
$this->headers['User-Agent'] = $this->useragent;
$this->headers['Content-Length']= $length;
foreach( $this->headers as $header => $value ) {
$request .= "{$header}: {$value}{$r}";
}
$request .= $r;
$request .= $xml;
// Now send the request
if ($this->debug) {
echo ''.htmlspecialchars($request)."\n
\n\n";
}
if ($this->timeout) {
$fp = @fsockopen($this->server, $this->port, $errno, $errstr, $this->timeout);
} else {
$fp = @fsockopen($this->server, $this->port, $errno, $errstr);
}
if (!$fp) {
$this->error = new IXR_Error(-32300, 'transport error - could not open socket');
return false;
}
fputs($fp, $request);
$contents = '';
$debugContents = '';
$gotFirstLine = false;
$gettingHeaders = true;
while (!feof($fp)) {
$line = fgets($fp, 4096);
if (!$gotFirstLine) {
// Check line for '200'
if (strstr($line, '200') === false) {
$this->error = new IXR_Error(-32300, 'transport error - HTTP status code was not 200');
return false;
}
$gotFirstLine = true;
}
if (trim($line) == '') {
$gettingHeaders = false;
}
if (!$gettingHeaders) {
// merged from WP #12559 - remove trim
$contents .= $line;
}
if ($this->debug) {
$debugContents .= $line;
}
}
if ($this->debug) {
echo ''.htmlspecialchars($debugContents)."\n
\n\n";
}
// Now parse what we've got back
$this->message = new IXR_Message($contents);
if (!$this->message->parse()) {
// XML error
$this->error = new IXR_Error(-32700, 'parse error. not well formed');
return false;
}
// Is the message a fault?
if ($this->message->messageType == 'fault') {
$this->error = new IXR_Error($this->message->faultCode, $this->message->faultString);
return false;
}
// Message must be OK
return true;
}
function getResponse()
{
// methodResponses can only have one param - return that
return $this->message->params[0];
}
function isError()
{
return (is_object($this->error));
}
function getErrorCode()
{
return $this->error->code;
}
function getErrorMessage()
{
return $this->error->message;
}
}
/**
* IXR_Error
*
* @package IXR
* @since 1.5
*/
class IXR_Error
{
var $code;
var $message;
function IXR_Error($code, $message)
{
$this->code = $code;
$this->message = htmlspecialchars($message);
}
function getXml()
{
$xml = <<
faultCode
{$this->code}
faultString
{$this->message}
EOD;
return $xml;
}
}
/**
* IXR_Date
*
* @package IXR
* @since 1.5
*/
class IXR_Date {
var $year;
var $month;
var $day;
var $hour;
var $minute;
var $second;
var $timezone;
function IXR_Date($time)
{
// $time can be a PHP timestamp or an ISO one
if (is_numeric($time)) {
$this->parseTimestamp($time);
} else {
$this->parseIso($time);
}
}
function parseTimestamp($timestamp)
{
$this->year = date('Y', $timestamp);
$this->month = date('m', $timestamp);
$this->day = date('d', $timestamp);
$this->hour = date('H', $timestamp);
$this->minute = date('i', $timestamp);
$this->second = date('s', $timestamp);
$this->timezone = '';
}
function parseIso($iso)
{
$this->year = substr($iso, 0, 4);
$this->month = substr($iso, 4, 2);
$this->day = substr($iso, 6, 2);
$this->hour = substr($iso, 9, 2);
$this->minute = substr($iso, 12, 2);
$this->second = substr($iso, 15, 2);
$this->timezone = substr($iso, 17);
}
function getIso()
{
return $this->year.$this->month.$this->day.'T'.$this->hour.':'.$this->minute.':'.$this->second.$this->timezone;
}
function getXml()
{
return ''.$this->getIso().'';
}
function getTimestamp()
{
return mktime($this->hour, $this->minute, $this->second, $this->month, $this->day, $this->year);
}
}
/**
* IXR_Base64
*
* @package IXR
* @since 1.5
*/
class IXR_Base64
{
var $data;
function IXR_Base64($data)
{
$this->data = $data;
}
function getXml()
{
return ''.base64_encode($this->data).'';
}
}
/**
* IXR_IntrospectionServer
*
* @package IXR
* @since 1.5
*/
class IXR_IntrospectionServer extends IXR_Server
{
var $signatures;
var $help;
function IXR_IntrospectionServer()
{
$this->setCallbacks();
$this->setCapabilities();
$this->capabilities['introspection'] = array(
'specUrl' => 'http://xmlrpc.usefulinc.com/doc/reserved.html',
'specVersion' => 1
);
$this->addCallback(
'system.methodSignature',
'this:methodSignature',
array('array', 'string'),
'Returns an array describing the return type and required parameters of a method'
);
$this->addCallback(
'system.getCapabilities',
'this:getCapabilities',
array('struct'),
'Returns a struct describing the XML-RPC specifications supported by this server'
);
$this->addCallback(
'system.listMethods',
'this:listMethods',
array('array'),
'Returns an array of available methods on this server'
);
$this->addCallback(
'system.methodHelp',
'this:methodHelp',
array('string', 'string'),
'Returns a documentation string for the specified method'
);
}
function addCallback($method, $callback, $args, $help)
{
$this->callbacks[$method] = $callback;
$this->signatures[$method] = $args;
$this->help[$method] = $help;
}
function call($methodname, $args)
{
// Make sure it's in an array
if ($args && !is_array($args)) {
$args = array($args);
}
// Over-rides default call method, adds signature check
if (!$this->hasMethod($methodname)) {
return new IXR_Error(-32601, 'server error. requested method "'.$this->message->methodName.'" not specified.');
}
$method = $this->callbacks[$methodname];
$signature = $this->signatures[$methodname];
$returnType = array_shift($signature);
// Check the number of arguments
if (count($args) != count($signature)) {
return new IXR_Error(-32602, 'server error. wrong number of method parameters');
}
// Check the argument types
$ok = true;
$argsbackup = $args;
for ($i = 0, $j = count($args); $i < $j; $i++) {
$arg = array_shift($args);
$type = array_shift($signature);
switch ($type) {
case 'int':
case 'i4':
if (is_array($arg) || !is_int($arg)) {
$ok = false;
}
break;
case 'base64':
case 'string':
if (!is_string($arg)) {
$ok = false;
}
break;
case 'boolean':
if ($arg !== false && $arg !== true) {
$ok = false;
}
break;
case 'float':
case 'double':
if (!is_float($arg)) {
$ok = false;
}
break;
case 'date':
case 'dateTime.iso8601':
if (!is_a($arg, 'IXR_Date')) {
$ok = false;
}
break;
}
if (!$ok) {
return new IXR_Error(-32602, 'server error. invalid method parameters');
}
}
// It passed the test - run the "real" method call
return parent::call($methodname, $argsbackup);
}
function methodSignature($method)
{
if (!$this->hasMethod($method)) {
return new IXR_Error(-32601, 'server error. requested method "'.$method.'" not specified.');
}
// We should be returning an array of types
$types = $this->signatures[$method];
$return = array();
foreach ($types as $type) {
switch ($type) {
case 'string':
$return[] = 'string';
break;
case 'int':
case 'i4':
$return[] = 42;
break;
case 'double':
$return[] = 3.1415;
break;
case 'dateTime.iso8601':
$return[] = new IXR_Date(time());
break;
case 'boolean':
$return[] = true;
break;
case 'base64':
$return[] = new IXR_Base64('base64');
break;
case 'array':
$return[] = array('array');
break;
case 'struct':
$return[] = array('struct' => 'struct');
break;
}
}
return $return;
}
function methodHelp($method)
{
return $this->help[$method];
}
}
/**
* IXR_ClientMulticall
*
* @package IXR
* @since 1.5
*/
class IXR_ClientMulticall extends IXR_Client
{
var $calls = array();
function IXR_ClientMulticall($server, $path = false, $port = 80)
{
parent::IXR_Client($server, $path, $port);
$this->useragent = 'The Incutio XML-RPC PHP Library (multicall client)';
}
function addCall()
{
$args = func_get_args();
$methodName = array_shift($args);
$struct = array(
'methodName' => $methodName,
'params' => $args
);
$this->calls[] = $struct;
}
function query()
{
// Prepare multicall, then call the parent::query() method
return parent::query('system.multicall', $this->calls);
}
}
/**
* Client for communicating with a XML-RPC Server over HTTPS.
*
* @author Jason Stirk (@link http://blog.griffin.homelinux.org/projects/xmlrpc/)
* @version 0.2.0 26May2005 08:34 +0800
* @copyright (c) 2004-2005 Jason Stirk
* @package IXR
*/
class IXR_ClientSSL extends IXR_Client
{
/**
* Filename of the SSL Client Certificate
* @access private
* @since 0.1.0
* @var string
*/
var $_certFile;
/**
* Filename of the SSL CA Certificate
* @access private
* @since 0.1.0
* @var string
*/
var $_caFile;
/**
* Filename of the SSL Client Private Key
* @access private
* @since 0.1.0
* @var string
*/
var $_keyFile;
/**
* Passphrase to unlock the private key
* @access private
* @since 0.1.0
* @var string
*/
var $_passphrase;
/**
* Constructor
* @param string $server URL of the Server to connect to
* @since 0.1.0
*/
function IXR_ClientSSL($server, $path = false, $port = 443, $timeout = false)
{
parent::IXR_Client($server, $path, $port, $timeout);
$this->useragent = 'The Incutio XML-RPC PHP Library for SSL';
// Set class fields
$this->_certFile=false;
$this->_caFile=false;
$this->_keyFile=false;
$this->_passphrase='';
}
/**
* Set the client side certificates to communicate with the server.
*
* @since 0.1.0
* @param string $certificateFile Filename of the client side certificate to use
* @param string $keyFile Filename of the client side certificate's private key
* @param string $keyPhrase Passphrase to unlock the private key
*/
function setCertificate($certificateFile, $keyFile, $keyPhrase='')
{
// Check the files all exist
if (is_file($certificateFile)) {
$this->_certFile = $certificateFile;
} else {
die('Could not open certificate: ' . $certificateFile);
}
if (is_file($keyFile)) {
$this->_keyFile = $keyFile;
} else {
die('Could not open private key: ' . $keyFile);
}
$this->_passphrase=(string)$keyPhrase;
}
function setCACertificate($caFile)
{
if (is_file($caFile)) {
$this->_caFile = $caFile;
} else {
die('Could not open CA certificate: ' . $caFile);
}
}
/**
* Sets the connection timeout (in seconds)
* @param int $newTimeOut Timeout in seconds
* @returns void
* @since 0.1.2
*/
function setTimeOut($newTimeOut)
{
$this->timeout = (int)$newTimeOut;
}
/**
* Returns the connection timeout (in seconds)
* @returns int
* @since 0.1.2
*/
function getTimeOut()
{
return $this->timeout;
}
/**
* Set the query to send to the XML-RPC Server
* @since 0.1.0
*/
function query()
{
$args = func_get_args();
$method = array_shift($args);
$request = new IXR_Request($method, $args);
$length = $request->getLength();
$xml = $request->getXml();
if ($this->debug) {
echo ''.htmlspecialchars($xml)."\n
\n\n";
}
//This is where we deviate from the normal query()
//Rather than open a normal sock, we will actually use the cURL
//extensions to make the calls, and handle the SSL stuff.
//Since 04Aug2004 (0.1.3) - Need to include the port (duh...)
//Since 06Oct2004 (0.1.4) - Need to include the colon!!!
// (I swear I've fixed this before... ESP in live... But anyhu...)
$curl=curl_init('https://' . $this->server . ':' . $this->port . $this->path);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
//Since 23Jun2004 (0.1.2) - Made timeout a class field
curl_setopt($curl, CURLOPT_TIMEOUT, $this->timeout);
if ($this->debug) {
curl_setopt($curl, CURLOPT_VERBOSE, 1);
}
curl_setopt($curl, CURLOPT_HEADER, 1);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $xml);
curl_setopt($curl, CURLOPT_PORT, $this->port);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
"Content-Type: text/xml",
"Content-length: {$length}"));
// Process the SSL certificates, etc. to use
if (!($this->_certFile === false)) {
// We have a certificate file set, so add these to the cURL handler
curl_setopt($curl, CURLOPT_SSLCERT, $this->_certFile);
curl_setopt($curl, CURLOPT_SSLKEY, $this->_keyFile);
if ($this->debug) {
echo "SSL Cert at : " . $this->_certFile . "\n";
echo "SSL Key at : " . $this->_keyFile . "\n";
}
// See if we need to give a passphrase
if (!($this->_passphrase === '')) {
curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $this->_passphrase);
}
if ($this->_caFile === false) {
// Don't verify their certificate, as we don't have a CA to verify against
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
} else {
// Verify against a CA
curl_setopt($curl, CURLOPT_CAINFO, $this->_caFile);
}
}
// Call cURL to do it's stuff and return us the content
$contents = curl_exec($curl);
curl_close($curl);
// Check for 200 Code in $contents
if (!strstr($contents, '200 OK')) {
//There was no "200 OK" returned - we failed
$this->error = new IXR_Error(-32300, 'transport error - HTTP status code was not 200');
return false;
}
if ($this->debug) {
echo ''.htmlspecialchars($contents)."\n
\n\n";
}
// Now parse what we've got back
// Since 20Jun2004 (0.1.1) - We need to remove the headers first
// Why I have only just found this, I will never know...
// So, remove everything before the first <
$contents = substr($contents,strpos($contents, '<'));
$this->message = new IXR_Message($contents);
if (!$this->message->parse()) {
// XML error
$this->error = new IXR_Error(-32700, 'parse error. not well formed');
return false;
}
// Is the message a fault?
if ($this->message->messageType == 'fault') {
$this->error = new IXR_Error($this->message->faultCode, $this->message->faultString);
return false;
}
// Message must be OK
return true;
}
}
/**
* Extension of the {@link IXR_Server} class to easily wrap objects.
*
* Class is designed to extend the existing XML-RPC server to allow the
* presentation of methods from a variety of different objects via an
* XML-RPC server.
* It is intended to assist in organization of your XML-RPC methods by allowing
* you to "write once" in your existing model classes and present them.
*
* @author Jason Stirk
* @version 1.0.1 19Apr2005 17:40 +0800
* @copyright Copyright (c) 2005 Jason Stirk
* @package IXR
*/
class IXR_ClassServer extends IXR_Server
{
var $_objects;
var $_delim;
function IXR_ClassServer($delim = '.', $wait = false)
{
$this->IXR_Server(array(), false, $wait);
$this->_delimiter = $delim;
$this->_objects = array();
}
function addMethod($rpcName, $functionName)
{
$this->callbacks[$rpcName] = $functionName;
}
function registerObject($object, $methods, $prefix=null)
{
if (is_null($prefix))
{
$prefix = get_class($object);
}
$this->_objects[$prefix] = $object;
// Add to our callbacks array
foreach($methods as $method)
{
if (is_array($method))
{
$targetMethod = $method[0];
$method = $method[1];
}
else
{
$targetMethod = $method;
}
$this->callbacks[$prefix . $this->_delimiter . $method]=array($prefix, $targetMethod);
}
}
function call($methodname, $args)
{
if (!$this->hasMethod($methodname)) {
return new IXR_Error(-32601, 'server error. requested method '.$methodname.' does not exist.');
}
$method = $this->callbacks[$methodname];
// Perform the callback and send the response
if (count($args) == 1) {
// If only one paramater just send that instead of the whole array
$args = $args[0];
}
// See if this method comes from one of our objects or maybe self
if (is_array($method) || (substr($method, 0, 5) == 'this:')) {
if (is_array($method)) {
$object=$this->_objects[$method[0]];
$method=$method[1];
} else {
$object=$this;
$method = substr($method, 5);
}
// It's a class method - check it exists
if (!method_exists($object, $method)) {
return new IXR_Error(-32601, 'server error. requested class method "'.$method.'" does not exist.');
}
// Call the method
$result = $object->$method($args);
} else {
// It's a function - does it exist?
if (!function_exists($method)) {
return new IXR_Error(-32601, 'server error. requested function "'.$method.'" does not exist.');
}
// Call the function
$result = $method($args);
}
return $result;
}
}