3 * IXR - The Incutio XML-RPC Library
5 * Copyright (c) 2010, Incutio Ltd.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * - Neither the name of Incutio Ltd. nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
28 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
30 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * @copyright Incutio Ltd 2010 (http://www.incutio.com)
36 * @version 1.7.4 7th September 2010
37 * @author Simon Willison
38 * @link http://scripts.incutio.com/xmlrpc/ Site/manual
39 * @license http://www.opensource.org/licenses/bsd-license.php BSD
52 function IXR_Value($data, $type = false)
56 $type = $this->calculateType();
59 if ($type == 'struct') {
60 // Turn all the values in the array in to new IXR_Value objects
61 foreach ($this->data as $key => $value) {
62 $this->data[$key] = new IXR_Value($value);
65 if ($type == 'array') {
66 for ($i = 0, $j = count($this->data); $i < $j; $i++) {
67 $this->data[$i] = new IXR_Value($this->data[$i]);
72 function calculateType()
74 if ($this->data === true || $this->data === false) {
77 if (is_integer($this->data)) {
80 if (is_double($this->data)) {
84 // Deal with IXR object types base64 and date
85 if (is_object($this->data) && is_a($this->data, 'IXR_Date')) {
88 if (is_object($this->data) && is_a($this->data, 'IXR_Base64')) {
92 // If it is a normal PHP object convert it in to a struct
93 if (is_object($this->data)) {
94 $this->data = get_object_vars($this->data);
97 if (!is_array($this->data)) {
101 // We have an array - is it an array or a struct?
102 if ($this->isStruct($this->data)) {
111 // Return XML for this value
112 switch ($this->type) {
114 return '<boolean>'.(($this->data) ? '1' : '0').'</boolean>';
117 return '<int>'.$this->data.'</int>';
120 return '<double>'.$this->data.'</double>';
123 return '<string>'.htmlspecialchars($this->data).'</string>';
126 $return = '<array><data>'."\n";
127 foreach ($this->data as $item) {
128 $return .= ' <value>'.$item->getXml()."</value>\n";
130 $return .= '</data></array>';
134 $return = '<struct>'."\n";
135 foreach ($this->data as $name => $value) {
136 $name = htmlspecialchars($name);
137 $return .= " <member><name>$name</name><value>";
138 $return .= $value->getXml()."</value></member>\n";
140 $return .= '</struct>';
145 return $this->data->getXml();
152 * Checks whether or not the supplied array is a struct or not
154 * @param array $array
157 function isStruct($array)
160 foreach ($array as $key => $value) {
161 if ((string)$key != (string)$expected) {
180 var $messageType; // methodCall / methodResponse / fault
186 // Current variable stacks
187 var $_arraystructs = array(); // The stack used to keep track of the current array/struct
188 var $_arraystructstypes = array(); // Stack keeping track of if things are structs or array
189 var $_currentStructName = array(); // A stack as well
193 var $_currentTagContents;
197 function IXR_Message($message)
199 $this->message =& $message;
204 // first remove the XML declaration
205 // merged from WP #10698 - this method avoids the RAM usage of preg_replace on very large messages
206 $header = preg_replace( '/<\?xml.*?\?'.'>/s', '', substr( $this->message, 0, 100 ), 1 );
207 $this->message = trim( substr_replace( $this->message, $header, 0, 100 ) );
208 if ( '' == $this->message ) {
212 // Then remove the DOCTYPE
213 $header = preg_replace( '/^<!DOCTYPE[^>]*+>/i', '', substr( $this->message, 0, 200 ), 1 );
214 $this->message = trim( substr_replace( $this->message, $header, 0, 200 ) );
215 if ( '' == $this->message ) {
219 // Check that the root tag is valid
220 $root_tag = substr( $this->message, 0, strcspn( substr( $this->message, 0, 20 ), "> \t\r\n" ) );
221 if ( '<!DOCTYPE' === strtoupper( $root_tag ) ) {
224 if ( ! in_array( $root_tag, array( '<methodCall', '<methodResponse', '<fault' ) ) ) {
228 // Bail if there are too many elements to parse
229 $element_limit = 30000;
230 if ( function_exists( 'apply_filters' ) ) {
232 * Filter the number of elements to parse in an XML-RPC response.
236 * @param int $element_limit Default elements limit.
238 $element_limit = apply_filters( 'xmlrpc_element_limit', $element_limit );
240 if ( $element_limit && 2 * $element_limit < substr_count( $this->message, '<' ) ) {
244 $this->_parser = xml_parser_create();
245 // Set XML parser to take the case of tags in to account
246 xml_parser_set_option($this->_parser, XML_OPTION_CASE_FOLDING, false);
247 // Set XML parser callback functions
248 xml_set_object($this->_parser, $this);
249 xml_set_element_handler($this->_parser, 'tag_open', 'tag_close');
250 xml_set_character_data_handler($this->_parser, 'cdata');
251 $chunk_size = 262144; // 256Kb, parse in chunks to avoid the RAM usage on very large messages
254 if (strlen($this->message) <= $chunk_size) {
257 $part = substr($this->message, 0, $chunk_size);
258 $this->message = substr($this->message, $chunk_size);
259 if (!xml_parse($this->_parser, $part, $final)) {
266 xml_parser_free($this->_parser);
268 // Grab the error messages, if any
269 if ($this->messageType == 'fault') {
270 $this->faultCode = $this->params[0]['faultCode'];
271 $this->faultString = $this->params[0]['faultString'];
276 function tag_open($parser, $tag, $attr)
278 $this->_currentTagContents = '';
279 $this->currentTag = $tag;
282 case 'methodResponse':
284 $this->messageType = $tag;
286 /* Deal with stacks of arrays and structs */
287 case 'data': // data is to all intents and puposes more interesting than array
288 $this->_arraystructstypes[] = 'array';
289 $this->_arraystructs[] = array();
292 $this->_arraystructstypes[] = 'struct';
293 $this->_arraystructs[] = array();
298 function cdata($parser, $cdata)
300 $this->_currentTagContents .= $cdata;
303 function tag_close($parser, $tag)
309 $value = (int)trim($this->_currentTagContents);
313 $value = (double)trim($this->_currentTagContents);
317 $value = (string)trim($this->_currentTagContents);
320 case 'dateTime.iso8601':
321 $value = new IXR_Date(trim($this->_currentTagContents));
325 // "If no type is indicated, the type is string."
326 if (trim($this->_currentTagContents) != '') {
327 $value = (string)$this->_currentTagContents;
332 $value = (boolean)trim($this->_currentTagContents);
336 $value = base64_decode($this->_currentTagContents);
339 /* Deal with stacks of arrays and structs */
342 $value = array_pop($this->_arraystructs);
343 array_pop($this->_arraystructstypes);
347 array_pop($this->_currentStructName);
350 $this->_currentStructName[] = trim($this->_currentTagContents);
353 $this->methodName = trim($this->_currentTagContents);
358 if (count($this->_arraystructs) > 0) {
359 // Add value to struct or array
360 if ($this->_arraystructstypes[count($this->_arraystructstypes)-1] == 'struct') {
362 $this->_arraystructs[count($this->_arraystructs)-1][$this->_currentStructName[count($this->_currentStructName)-1]] = $value;
365 $this->_arraystructs[count($this->_arraystructs)-1][] = $value;
368 // Just add as a parameter
369 $this->params[] = $value;
372 $this->_currentTagContents = '';
385 var $callbacks = array();
389 function IXR_Server($callbacks = false, $data = false, $wait = false)
391 $this->setCapabilities();
393 $this->callbacks = $callbacks;
395 $this->setCallbacks();
401 function serve($data = false)
404 if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] !== 'POST') {
405 header('Content-Type: text/plain'); // merged from WP #9093
406 die('XML-RPC server accepts POST requests only.');
409 global $HTTP_RAW_POST_DATA;
410 if (empty($HTTP_RAW_POST_DATA)) {
411 // workaround for a bug in PHP 5.2.2 - http://bugs.php.net/bug.php?id=41293
412 $data = file_get_contents('php://input');
414 $data =& $HTTP_RAW_POST_DATA;
417 $this->message = new IXR_Message($data);
418 if (!$this->message->parse()) {
419 $this->error(-32700, 'parse error. not well formed');
421 if ($this->message->messageType != 'methodCall') {
422 $this->error(-32600, 'server error. invalid xml-rpc. not conforming to spec. Request must be a methodCall');
424 $result = $this->call($this->message->methodName, $this->message->params);
426 // Is the result an error?
427 if (is_a($result, 'IXR_Error')) {
428 $this->error($result);
432 $r = new IXR_Value($result);
433 $resultxml = $r->getXml();
452 function call($methodname, $args)
454 if (!$this->hasMethod($methodname)) {
455 return new IXR_Error(-32601, 'server error. requested method '.$methodname.' does not exist.');
457 $method = $this->callbacks[$methodname];
459 // Perform the callback and send the response
460 if (count($args) == 1) {
461 // If only one parameter just send that instead of the whole array
465 // Are we dealing with a function or a method?
466 if (is_string($method) && substr($method, 0, 5) == 'this:') {
467 // It's a class method - check it exists
468 $method = substr($method, 5);
469 if (!method_exists($this, $method)) {
470 return new IXR_Error(-32601, 'server error. requested class method "'.$method.'" does not exist.');
474 $result = $this->$method($args);
476 // It's a function - does it exist?
477 if (is_array($method)) {
478 if (!is_callable(array($method[0], $method[1]))) {
479 return new IXR_Error(-32601, 'server error. requested object method "'.$method[1].'" does not exist.');
481 } else if (!function_exists($method)) {
482 return new IXR_Error(-32601, 'server error. requested function "'.$method.'" does not exist.');
486 $result = call_user_func($method, $args);
491 function error($error, $message = false)
493 // Accepts either an error object or an error code and message
494 if ($message && !is_object($error)) {
495 $error = new IXR_Error($error, $message);
497 $this->output($error->getXml());
500 function output($xml)
502 $charset = function_exists('get_option') ? get_option('blog_charset') : '';
504 $xml = '<?xml version="1.0" encoding="'.$charset.'"?>'."\n".$xml;
506 $xml = '<?xml version="1.0"?>'."\n".$xml;
507 $length = strlen($xml);
508 header('Connection: close');
509 header('Content-Length: '.$length);
511 header('Content-Type: text/xml; charset='.$charset);
513 header('Content-Type: text/xml');
514 header('Date: '.date('r'));
519 function hasMethod($method)
521 return in_array($method, array_keys($this->callbacks));
524 function setCapabilities()
526 // Initialises capabilities array
527 $this->capabilities = array(
529 'specUrl' => 'http://www.xmlrpc.com/spec',
532 'faults_interop' => array(
533 'specUrl' => 'http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php',
534 'specVersion' => 20010516
536 'system.multicall' => array(
537 'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
543 function getCapabilities($args)
545 return $this->capabilities;
548 function setCallbacks()
550 $this->callbacks['system.getCapabilities'] = 'this:getCapabilities';
551 $this->callbacks['system.listMethods'] = 'this:listMethods';
552 $this->callbacks['system.multicall'] = 'this:multiCall';
555 function listMethods($args)
557 // Returns a list of methods - uses array_reverse to ensure user defined
558 // methods are listed before server defined methods
559 return array_reverse(array_keys($this->callbacks));
562 function multiCall($methodcalls)
564 // See http://www.xmlrpc.com/discuss/msgReader$1208
566 foreach ($methodcalls as $call) {
567 $method = $call['methodName'];
568 $params = $call['params'];
569 if ($method == 'system.multicall') {
570 $result = new IXR_Error(-32600, 'Recursive calls to system.multicall are forbidden');
572 $result = $this->call($method, $params);
574 if (is_a($result, 'IXR_Error')) {
576 'faultCode' => $result->code,
577 'faultString' => $result->message
580 $return[] = array($result);
599 function IXR_Request($method, $args)
601 $this->method = $method;
604 <?xml version="1.0"?>
606 <methodName>{$this->method}</methodName>
610 foreach ($this->args as $arg) {
611 $this->xml .= '<param><value>';
612 $v = new IXR_Value($arg);
613 $this->xml .= $v->getXml();
614 $this->xml .= "</value></param>\n";
616 $this->xml .= '</params></methodCall>';
621 return strlen($this->xml);
644 var $message = false;
647 var $headers = array();
649 // Storage place for an error message
652 function IXR_Client($server, $path = false, $port = 80, $timeout = 15)
655 // Assume we have been given a URL instead
656 $bits = parse_url($server);
657 $this->server = $bits['host'];
658 $this->port = isset($bits['port']) ? $bits['port'] : 80;
659 $this->path = isset($bits['path']) ? $bits['path'] : '/';
661 // Make absolutely sure we have a path
666 if ( ! empty( $bits['query'] ) ) {
667 $this->path .= '?' . $bits['query'];
670 $this->server = $server;
674 $this->useragent = 'The Incutio XML-RPC PHP Library';
675 $this->timeout = $timeout;
680 $args = func_get_args();
681 $method = array_shift($args);
682 $request = new IXR_Request($method, $args);
683 $length = $request->getLength();
684 $xml = $request->getXml();
686 $request = "POST {$this->path} HTTP/1.0$r";
688 // Merged from WP #8145 - allow custom headers
689 $this->headers['Host'] = $this->server;
690 $this->headers['Content-Type'] = 'text/xml';
691 $this->headers['User-Agent'] = $this->useragent;
692 $this->headers['Content-Length']= $length;
694 foreach( $this->headers as $header => $value ) {
695 $request .= "{$header}: {$value}{$r}";
701 // Now send the request
703 echo '<pre class="ixr_request">'.htmlspecialchars($request)."\n</pre>\n\n";
706 if ($this->timeout) {
707 $fp = @fsockopen($this->server, $this->port, $errno, $errstr, $this->timeout);
709 $fp = @fsockopen($this->server, $this->port, $errno, $errstr);
712 $this->error = new IXR_Error(-32300, 'transport error - could not open socket');
715 fputs($fp, $request);
718 $gotFirstLine = false;
719 $gettingHeaders = true;
721 $line = fgets($fp, 4096);
722 if (!$gotFirstLine) {
723 // Check line for '200'
724 if (strstr($line, '200') === false) {
725 $this->error = new IXR_Error(-32300, 'transport error - HTTP status code was not 200');
728 $gotFirstLine = true;
730 if (trim($line) == '') {
731 $gettingHeaders = false;
733 if (!$gettingHeaders) {
734 // merged from WP #12559 - remove trim
738 $debugContents .= $line;
742 echo '<pre class="ixr_response">'.htmlspecialchars($debugContents)."\n</pre>\n\n";
745 // Now parse what we've got back
746 $this->message = new IXR_Message($contents);
747 if (!$this->message->parse()) {
749 $this->error = new IXR_Error(-32700, 'parse error. not well formed');
753 // Is the message a fault?
754 if ($this->message->messageType == 'fault') {
755 $this->error = new IXR_Error($this->message->faultCode, $this->message->faultString);
759 // Message must be OK
763 function getResponse()
765 // methodResponses can only have one param - return that
766 return $this->message->params[0];
771 return (is_object($this->error));
774 function getErrorCode()
776 return $this->error->code;
779 function getErrorMessage()
781 return $this->error->message;
797 function IXR_Error($code, $message)
800 $this->message = htmlspecialchars($message);
811 <name>faultCode</name>
812 <value><int>{$this->code}</int></value>
815 <name>faultString</name>
816 <value><string>{$this->message}</string></value>
843 function IXR_Date($time)
845 // $time can be a PHP timestamp or an ISO one
846 if (is_numeric($time)) {
847 $this->parseTimestamp($time);
849 $this->parseIso($time);
853 function parseTimestamp($timestamp)
855 $this->year = date('Y', $timestamp);
856 $this->month = date('m', $timestamp);
857 $this->day = date('d', $timestamp);
858 $this->hour = date('H', $timestamp);
859 $this->minute = date('i', $timestamp);
860 $this->second = date('s', $timestamp);
861 $this->timezone = '';
864 function parseIso($iso)
866 $this->year = substr($iso, 0, 4);
867 $this->month = substr($iso, 4, 2);
868 $this->day = substr($iso, 6, 2);
869 $this->hour = substr($iso, 9, 2);
870 $this->minute = substr($iso, 12, 2);
871 $this->second = substr($iso, 15, 2);
872 $this->timezone = substr($iso, 17);
877 return $this->year.$this->month.$this->day.'T'.$this->hour.':'.$this->minute.':'.$this->second.$this->timezone;
882 return '<dateTime.iso8601>'.$this->getIso().'</dateTime.iso8601>';
885 function getTimestamp()
887 return mktime($this->hour, $this->minute, $this->second, $this->month, $this->day, $this->year);
901 function IXR_Base64($data)
908 return '<base64>'.base64_encode($this->data).'</base64>';
913 * IXR_IntrospectionServer
918 class IXR_IntrospectionServer extends IXR_Server
923 function IXR_IntrospectionServer()
925 $this->setCallbacks();
926 $this->setCapabilities();
927 $this->capabilities['introspection'] = array(
928 'specUrl' => 'http://xmlrpc.usefulinc.com/doc/reserved.html',
932 'system.methodSignature',
933 'this:methodSignature',
934 array('array', 'string'),
935 'Returns an array describing the return type and required parameters of a method'
938 'system.getCapabilities',
939 'this:getCapabilities',
941 'Returns a struct describing the XML-RPC specifications supported by this server'
944 'system.listMethods',
947 'Returns an array of available methods on this server'
952 array('string', 'string'),
953 'Returns a documentation string for the specified method'
957 function addCallback($method, $callback, $args, $help)
959 $this->callbacks[$method] = $callback;
960 $this->signatures[$method] = $args;
961 $this->help[$method] = $help;
964 function call($methodname, $args)
966 // Make sure it's in an array
967 if ($args && !is_array($args)) {
968 $args = array($args);
971 // Over-rides default call method, adds signature check
972 if (!$this->hasMethod($methodname)) {
973 return new IXR_Error(-32601, 'server error. requested method "'.$this->message->methodName.'" not specified.');
975 $method = $this->callbacks[$methodname];
976 $signature = $this->signatures[$methodname];
977 $returnType = array_shift($signature);
979 // Check the number of arguments
980 if (count($args) != count($signature)) {
981 return new IXR_Error(-32602, 'server error. wrong number of method parameters');
984 // Check the argument types
987 for ($i = 0, $j = count($args); $i < $j; $i++) {
988 $arg = array_shift($args);
989 $type = array_shift($signature);
993 if (is_array($arg) || !is_int($arg)) {
999 if (!is_string($arg)) {
1004 if ($arg !== false && $arg !== true) {
1010 if (!is_float($arg)) {
1015 case 'dateTime.iso8601':
1016 if (!is_a($arg, 'IXR_Date')) {
1022 return new IXR_Error(-32602, 'server error. invalid method parameters');
1025 // It passed the test - run the "real" method call
1026 return parent::call($methodname, $argsbackup);
1029 function methodSignature($method)
1031 if (!$this->hasMethod($method)) {
1032 return new IXR_Error(-32601, 'server error. requested method "'.$method.'" not specified.');
1034 // We should be returning an array of types
1035 $types = $this->signatures[$method];
1037 foreach ($types as $type) {
1040 $return[] = 'string';
1049 case 'dateTime.iso8601':
1050 $return[] = new IXR_Date(time());
1056 $return[] = new IXR_Base64('base64');
1059 $return[] = array('array');
1062 $return[] = array('struct' => 'struct');
1069 function methodHelp($method)
1071 return $this->help[$method];
1076 * IXR_ClientMulticall
1081 class IXR_ClientMulticall extends IXR_Client
1083 var $calls = array();
1085 function IXR_ClientMulticall($server, $path = false, $port = 80)
1087 parent::IXR_Client($server, $path, $port);
1088 $this->useragent = 'The Incutio XML-RPC PHP Library (multicall client)';
1093 $args = func_get_args();
1094 $methodName = array_shift($args);
1096 'methodName' => $methodName,
1099 $this->calls[] = $struct;
1104 // Prepare multicall, then call the parent::query() method
1105 return parent::query('system.multicall', $this->calls);