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 unknown_type $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.*?\?'.'>/', '', substr($this->message, 0, 100), 1);
207 $this->message = substr_replace($this->message, $header, 0, 100);
208 if (trim($this->message) == '') {
211 $this->_parser = xml_parser_create();
212 // Set XML parser to take the case of tags in to account
213 xml_parser_set_option($this->_parser, XML_OPTION_CASE_FOLDING, false);
214 // Set XML parser callback functions
215 xml_set_object($this->_parser, $this);
216 xml_set_element_handler($this->_parser, 'tag_open', 'tag_close');
217 xml_set_character_data_handler($this->_parser, 'cdata');
218 $chunk_size = 262144; // 256Kb, parse in chunks to avoid the RAM usage on very large messages
221 if (strlen($this->message) <= $chunk_size) {
224 $part = substr($this->message, 0, $chunk_size);
225 $this->message = substr($this->message, $chunk_size);
226 if (!xml_parse($this->_parser, $part, $final)) {
233 xml_parser_free($this->_parser);
235 // Grab the error messages, if any
236 if ($this->messageType == 'fault') {
237 $this->faultCode = $this->params[0]['faultCode'];
238 $this->faultString = $this->params[0]['faultString'];
243 function tag_open($parser, $tag, $attr)
245 $this->_currentTagContents = '';
246 $this->currentTag = $tag;
249 case 'methodResponse':
251 $this->messageType = $tag;
253 /* Deal with stacks of arrays and structs */
254 case 'data': // data is to all intents and puposes more interesting than array
255 $this->_arraystructstypes[] = 'array';
256 $this->_arraystructs[] = array();
259 $this->_arraystructstypes[] = 'struct';
260 $this->_arraystructs[] = array();
265 function cdata($parser, $cdata)
267 $this->_currentTagContents .= $cdata;
270 function tag_close($parser, $tag)
276 $value = (int)trim($this->_currentTagContents);
280 $value = (double)trim($this->_currentTagContents);
284 $value = (string)trim($this->_currentTagContents);
287 case 'dateTime.iso8601':
288 $value = new IXR_Date(trim($this->_currentTagContents));
292 // "If no type is indicated, the type is string."
293 if (trim($this->_currentTagContents) != '') {
294 $value = (string)$this->_currentTagContents;
299 $value = (boolean)trim($this->_currentTagContents);
303 $value = base64_decode($this->_currentTagContents);
306 /* Deal with stacks of arrays and structs */
309 $value = array_pop($this->_arraystructs);
310 array_pop($this->_arraystructstypes);
314 array_pop($this->_currentStructName);
317 $this->_currentStructName[] = trim($this->_currentTagContents);
320 $this->methodName = trim($this->_currentTagContents);
325 if (count($this->_arraystructs) > 0) {
326 // Add value to struct or array
327 if ($this->_arraystructstypes[count($this->_arraystructstypes)-1] == 'struct') {
329 $this->_arraystructs[count($this->_arraystructs)-1][$this->_currentStructName[count($this->_currentStructName)-1]] = $value;
332 $this->_arraystructs[count($this->_arraystructs)-1][] = $value;
335 // Just add as a paramater
336 $this->params[] = $value;
339 $this->_currentTagContents = '';
352 var $callbacks = array();
356 function IXR_Server($callbacks = false, $data = false, $wait = false)
358 $this->setCapabilities();
360 $this->callbacks = $callbacks;
362 $this->setCallbacks();
368 function serve($data = false)
371 if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] !== 'POST') {
372 header('Content-Type: text/plain'); // merged from WP #9093
373 die('XML-RPC server accepts POST requests only.');
376 global $HTTP_RAW_POST_DATA;
377 if (empty($HTTP_RAW_POST_DATA)) {
378 // workaround for a bug in PHP 5.2.2 - http://bugs.php.net/bug.php?id=41293
379 $data = file_get_contents('php://input');
381 $data =& $HTTP_RAW_POST_DATA;
384 $this->message = new IXR_Message($data);
385 if (!$this->message->parse()) {
386 $this->error(-32700, 'parse error. not well formed');
388 if ($this->message->messageType != 'methodCall') {
389 $this->error(-32600, 'server error. invalid xml-rpc. not conforming to spec. Request must be a methodCall');
391 $result = $this->call($this->message->methodName, $this->message->params);
393 // Is the result an error?
394 if (is_a($result, 'IXR_Error')) {
395 $this->error($result);
399 $r = new IXR_Value($result);
400 $resultxml = $r->getXml();
419 function call($methodname, $args)
421 if (!$this->hasMethod($methodname)) {
422 return new IXR_Error(-32601, 'server error. requested method '.$methodname.' does not exist.');
424 $method = $this->callbacks[$methodname];
426 // Perform the callback and send the response
427 if (count($args) == 1) {
428 // If only one paramater just send that instead of the whole array
432 // Are we dealing with a function or a method?
433 if (is_string($method) && substr($method, 0, 5) == 'this:') {
434 // It's a class method - check it exists
435 $method = substr($method, 5);
436 if (!method_exists($this, $method)) {
437 return new IXR_Error(-32601, 'server error. requested class method "'.$method.'" does not exist.');
441 $result = $this->$method($args);
443 // It's a function - does it exist?
444 if (is_array($method)) {
445 if (!is_callable(array($method[0], $method[1]))) {
446 return new IXR_Error(-32601, 'server error. requested object method "'.$method[1].'" does not exist.');
448 } else if (!function_exists($method)) {
449 return new IXR_Error(-32601, 'server error. requested function "'.$method.'" does not exist.');
453 $result = call_user_func($method, $args);
458 function error($error, $message = false)
460 // Accepts either an error object or an error code and message
461 if ($message && !is_object($error)) {
462 $error = new IXR_Error($error, $message);
464 $this->output($error->getXml());
467 function output($xml)
469 $charset = function_exists('get_option') ? get_option('blog_charset') : '';
471 $xml = '<?xml version="1.0" encoding="'.$charset.'"?>'."\n".$xml;
473 $xml = '<?xml version="1.0"?>'."\n".$xml;
474 $length = strlen($xml);
475 header('Connection: close');
476 header('Content-Length: '.$length);
478 header('Content-Type: text/xml; charset='.$charset);
480 header('Content-Type: text/xml');
481 header('Date: '.date('r'));
486 function hasMethod($method)
488 return in_array($method, array_keys($this->callbacks));
491 function setCapabilities()
493 // Initialises capabilities array
494 $this->capabilities = array(
496 'specUrl' => 'http://www.xmlrpc.com/spec',
499 'faults_interop' => array(
500 'specUrl' => 'http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php',
501 'specVersion' => 20010516
503 'system.multicall' => array(
504 'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
510 function getCapabilities($args)
512 return $this->capabilities;
515 function setCallbacks()
517 $this->callbacks['system.getCapabilities'] = 'this:getCapabilities';
518 $this->callbacks['system.listMethods'] = 'this:listMethods';
519 $this->callbacks['system.multicall'] = 'this:multiCall';
522 function listMethods($args)
524 // Returns a list of methods - uses array_reverse to ensure user defined
525 // methods are listed before server defined methods
526 return array_reverse(array_keys($this->callbacks));
529 function multiCall($methodcalls)
531 // See http://www.xmlrpc.com/discuss/msgReader$1208
533 foreach ($methodcalls as $call) {
534 $method = $call['methodName'];
535 $params = $call['params'];
536 if ($method == 'system.multicall') {
537 $result = new IXR_Error(-32600, 'Recursive calls to system.multicall are forbidden');
539 $result = $this->call($method, $params);
541 if (is_a($result, 'IXR_Error')) {
543 'faultCode' => $result->code,
544 'faultString' => $result->message
547 $return[] = array($result);
566 function IXR_Request($method, $args)
568 $this->method = $method;
571 <?xml version="1.0"?>
573 <methodName>{$this->method}</methodName>
577 foreach ($this->args as $arg) {
578 $this->xml .= '<param><value>';
579 $v = new IXR_Value($arg);
580 $this->xml .= $v->getXml();
581 $this->xml .= "</value></param>\n";
583 $this->xml .= '</params></methodCall>';
588 return strlen($this->xml);
611 var $message = false;
614 var $headers = array();
616 // Storage place for an error message
619 function IXR_Client($server, $path = false, $port = 80, $timeout = 15)
622 // Assume we have been given a URL instead
623 $bits = parse_url($server);
624 $this->server = $bits['host'];
625 $this->port = isset($bits['port']) ? $bits['port'] : 80;
626 $this->path = isset($bits['path']) ? $bits['path'] : '/';
628 // Make absolutely sure we have a path
633 if ( ! empty( $bits['query'] ) ) {
634 $this->path .= '?' . $bits['query'];
637 $this->server = $server;
641 $this->useragent = 'The Incutio XML-RPC PHP Library';
642 $this->timeout = $timeout;
647 $args = func_get_args();
648 $method = array_shift($args);
649 $request = new IXR_Request($method, $args);
650 $length = $request->getLength();
651 $xml = $request->getXml();
653 $request = "POST {$this->path} HTTP/1.0$r";
655 // Merged from WP #8145 - allow custom headers
656 $this->headers['Host'] = $this->server;
657 $this->headers['Content-Type'] = 'text/xml';
658 $this->headers['User-Agent'] = $this->useragent;
659 $this->headers['Content-Length']= $length;
661 foreach( $this->headers as $header => $value ) {
662 $request .= "{$header}: {$value}{$r}";
668 // Now send the request
670 echo '<pre class="ixr_request">'.htmlspecialchars($request)."\n</pre>\n\n";
673 if ($this->timeout) {
674 $fp = @fsockopen($this->server, $this->port, $errno, $errstr, $this->timeout);
676 $fp = @fsockopen($this->server, $this->port, $errno, $errstr);
679 $this->error = new IXR_Error(-32300, 'transport error - could not open socket');
682 fputs($fp, $request);
685 $gotFirstLine = false;
686 $gettingHeaders = true;
688 $line = fgets($fp, 4096);
689 if (!$gotFirstLine) {
690 // Check line for '200'
691 if (strstr($line, '200') === false) {
692 $this->error = new IXR_Error(-32300, 'transport error - HTTP status code was not 200');
695 $gotFirstLine = true;
697 if (trim($line) == '') {
698 $gettingHeaders = false;
700 if (!$gettingHeaders) {
701 // merged from WP #12559 - remove trim
705 $debugContents .= $line;
709 echo '<pre class="ixr_response">'.htmlspecialchars($debugContents)."\n</pre>\n\n";
712 // Now parse what we've got back
713 $this->message = new IXR_Message($contents);
714 if (!$this->message->parse()) {
716 $this->error = new IXR_Error(-32700, 'parse error. not well formed');
720 // Is the message a fault?
721 if ($this->message->messageType == 'fault') {
722 $this->error = new IXR_Error($this->message->faultCode, $this->message->faultString);
726 // Message must be OK
730 function getResponse()
732 // methodResponses can only have one param - return that
733 return $this->message->params[0];
738 return (is_object($this->error));
741 function getErrorCode()
743 return $this->error->code;
746 function getErrorMessage()
748 return $this->error->message;
764 function IXR_Error($code, $message)
767 $this->message = htmlspecialchars($message);
778 <name>faultCode</name>
779 <value><int>{$this->code}</int></value>
782 <name>faultString</name>
783 <value><string>{$this->message}</string></value>
810 function IXR_Date($time)
812 // $time can be a PHP timestamp or an ISO one
813 if (is_numeric($time)) {
814 $this->parseTimestamp($time);
816 $this->parseIso($time);
820 function parseTimestamp($timestamp)
822 $this->year = date('Y', $timestamp);
823 $this->month = date('m', $timestamp);
824 $this->day = date('d', $timestamp);
825 $this->hour = date('H', $timestamp);
826 $this->minute = date('i', $timestamp);
827 $this->second = date('s', $timestamp);
828 $this->timezone = '';
831 function parseIso($iso)
833 $this->year = substr($iso, 0, 4);
834 $this->month = substr($iso, 4, 2);
835 $this->day = substr($iso, 6, 2);
836 $this->hour = substr($iso, 9, 2);
837 $this->minute = substr($iso, 12, 2);
838 $this->second = substr($iso, 15, 2);
839 $this->timezone = substr($iso, 17);
844 return $this->year.$this->month.$this->day.'T'.$this->hour.':'.$this->minute.':'.$this->second.$this->timezone;
849 return '<dateTime.iso8601>'.$this->getIso().'</dateTime.iso8601>';
852 function getTimestamp()
854 return mktime($this->hour, $this->minute, $this->second, $this->month, $this->day, $this->year);
868 function IXR_Base64($data)
875 return '<base64>'.base64_encode($this->data).'</base64>';
880 * IXR_IntrospectionServer
885 class IXR_IntrospectionServer extends IXR_Server
890 function IXR_IntrospectionServer()
892 $this->setCallbacks();
893 $this->setCapabilities();
894 $this->capabilities['introspection'] = array(
895 'specUrl' => 'http://xmlrpc.usefulinc.com/doc/reserved.html',
899 'system.methodSignature',
900 'this:methodSignature',
901 array('array', 'string'),
902 'Returns an array describing the return type and required parameters of a method'
905 'system.getCapabilities',
906 'this:getCapabilities',
908 'Returns a struct describing the XML-RPC specifications supported by this server'
911 'system.listMethods',
914 'Returns an array of available methods on this server'
919 array('string', 'string'),
920 'Returns a documentation string for the specified method'
924 function addCallback($method, $callback, $args, $help)
926 $this->callbacks[$method] = $callback;
927 $this->signatures[$method] = $args;
928 $this->help[$method] = $help;
931 function call($methodname, $args)
933 // Make sure it's in an array
934 if ($args && !is_array($args)) {
935 $args = array($args);
938 // Over-rides default call method, adds signature check
939 if (!$this->hasMethod($methodname)) {
940 return new IXR_Error(-32601, 'server error. requested method "'.$this->message->methodName.'" not specified.');
942 $method = $this->callbacks[$methodname];
943 $signature = $this->signatures[$methodname];
944 $returnType = array_shift($signature);
946 // Check the number of arguments
947 if (count($args) != count($signature)) {
948 return new IXR_Error(-32602, 'server error. wrong number of method parameters');
951 // Check the argument types
954 for ($i = 0, $j = count($args); $i < $j; $i++) {
955 $arg = array_shift($args);
956 $type = array_shift($signature);
960 if (is_array($arg) || !is_int($arg)) {
966 if (!is_string($arg)) {
971 if ($arg !== false && $arg !== true) {
977 if (!is_float($arg)) {
982 case 'dateTime.iso8601':
983 if (!is_a($arg, 'IXR_Date')) {
989 return new IXR_Error(-32602, 'server error. invalid method parameters');
992 // It passed the test - run the "real" method call
993 return parent::call($methodname, $argsbackup);
996 function methodSignature($method)
998 if (!$this->hasMethod($method)) {
999 return new IXR_Error(-32601, 'server error. requested method "'.$method.'" not specified.');
1001 // We should be returning an array of types
1002 $types = $this->signatures[$method];
1004 foreach ($types as $type) {
1007 $return[] = 'string';
1016 case 'dateTime.iso8601':
1017 $return[] = new IXR_Date(time());
1023 $return[] = new IXR_Base64('base64');
1026 $return[] = array('array');
1029 $return[] = array('struct' => 'struct');
1036 function methodHelp($method)
1038 return $this->help[$method];
1043 * IXR_ClientMulticall
1048 class IXR_ClientMulticall extends IXR_Client
1050 var $calls = array();
1052 function IXR_ClientMulticall($server, $path = false, $port = 80)
1054 parent::IXR_Client($server, $path, $port);
1055 $this->useragent = 'The Incutio XML-RPC PHP Library (multicall client)';
1060 $args = func_get_args();
1061 $methodName = array_shift($args);
1063 'methodName' => $methodName,
1066 $this->calls[] = $struct;
1071 // Prepare multicall, then call the parent::query() method
1072 return parent::query('system.multicall', $this->calls);