5 use PhpXmlRpc\Helper\XMLParser;
6 use PhpXmlRpc\Helper\Charset;
11 * Array defining php functions exposed as xmlrpc methods by this server.
13 protected $dmap = array();
15 * Defines how functions in dmap will be invoked: either using an xmlrpc msg object
16 * or plain php values.
17 * valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'
19 public $functions_parameters_type = 'xmlrpcvals';
21 * Option used for fine-tuning the encoding the php values returned from
22 * functions registered in the dispatch map when the functions_parameters_types
23 * member is set to 'phpvals'
24 * @see php_xmlrpc_encode for a list of values
26 public $phpvals_encoding_options = array('auto_dates');
27 /// 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
30 * Controls behaviour of server when invoked user function throws an exception:
31 * 0 = catch it and return an 'internal error' xmlrpc response (default)
32 * 1 = catch it and return an xmlrpc response with the error corresponding to the exception
33 * 2 = allow the exception to float to the upper layers
35 public $exception_handling = 0;
37 * When set to true, it will enable HTTP compression of the response, in case
38 * the client has declared its support for compression in the request.
40 public $compress_response = false;
42 * List of http compression methods accepted by the server for requests.
43 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
45 public $accepted_compression = array();
46 /// shall we serve calls to system.* methods?
47 public $allow_system_funcs = true;
48 /// list of charset encodings natively accepted for requests
49 public $accepted_charset_encodings = array();
51 * charset encoding to be used for response.
52 * NB: if we can, we will convert the generated response from internal_encoding to the intended one.
53 * can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),
54 * null (leave unspecified in response, convert output stream to US_ASCII),
55 * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed),
56 * 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).
57 * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
59 public $response_charset_encoding = '';
61 * Storage for internal debug info.
63 protected $debug_info = '';
65 * Extra data passed at runtime to method handling functions. Used only by EPI layer
67 public $user_data = null;
69 protected static $_xmlrpc_debuginfo = '';
70 protected static $_xmlrpcs_occurred_errors = '';
71 public static $_xmlrpcs_prev_ehandler = '';
74 * @param array $dispatchMap the dispatch map with definition of exposed services
75 * @param boolean $servicenow set to false to prevent the server from running upon construction
77 public function __construct($dispatchMap = null, $serviceNow = true)
79 // if ZLIB is enabled, let the server by default accept compressed requests,
80 // and compress responses sent to clients that support them
81 if (function_exists('gzinflate')) {
82 $this->accepted_compression = array('gzip', 'deflate');
83 $this->compress_response = true;
86 // by default the xml parser can support these 3 charset encodings
87 $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
89 // dispMap is a dispatch array of methods
90 // mapped to function names and signatures
92 // doesn't appear in the map then an unknown
93 // method error is generated
94 /* milosch - changed to make passing dispMap optional.
95 * instead, you can use the class add_to_map() function
96 * to add functions manually (borrowed from SOAPX4)
99 $this->dmap = $dispatchMap;
107 * Set debug level of server.
109 * @param integer $level debug lvl: determines info added to xmlrpc responses (as xml comments)
111 * 1 = msgs set from user with debugmsg(),
112 * 2 = add complete xmlrpc request (headers and body),
113 * 3 = add also all processing warnings happened during method processing
114 * (NB: this involves setting a custom error handler, and might interfere
115 * with the standard processing of the php function exposed as method. In
116 * particular, triggering an USER_ERROR level error will not halt script
117 * execution anymore, but just end up logged in the xmlrpc response)
118 * Note that info added at level 2 and 3 will be base64 encoded
120 public function setDebug($level)
122 $this->debug = $level;
126 * Add a string to the debug info that can be later serialized by the server
127 * as part of the response message.
128 * Note that for best compatibility, the debug string should be encoded using
129 * the PhpXmlRpc::$xmlrpc_internalencoding character set.
134 public static function xmlrpc_debugmsg($msg)
136 static::$_xmlrpc_debuginfo .= $msg . "\n";
139 public static function error_occurred($msg)
141 static::$_xmlrpcs_occurred_errors .= $msg . "\n";
145 * Return a string with the serialized representation of all debug info.
147 * @param string $charsetEncoding the target charset encoding for the serialization
149 * @return string an XML comment (or two)
151 public function serializeDebug($charsetEncoding = '')
153 // Tough encoding problem: which internal charset should we assume for debug info?
154 // It might contain a copy of raw data received from client, ie with unknown encoding,
155 // intermixed with php generated data and user generated data...
156 // so we split it: system debug is base 64 encoded,
157 // user debug info should be encoded by the end user using the INTERNAL_ENCODING
159 if ($this->debug_info != '') {
160 $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n" . base64_encode($this->debug_info) . "\n-->\n";
162 if (static::$_xmlrpc_debuginfo != '') {
163 $out .= "<!-- DEBUG INFO:\n" . Charset::instance()->encodeEntities(str_replace('--', '_-', static::$_xmlrpc_debuginfo), PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n-->\n";
164 // NB: a better solution MIGHT be to use CDATA, but we need to insert it
165 // into return payload AFTER the beginning tag
166 //$out .= "<![CDATA[ DEBUG INFO:\n\n" . str_replace(']]>', ']_]_>', static::$_xmlrpc_debuginfo) . "\n]]>\n";
173 * Execute the xmlrpc request, printing the response.
175 * @param string $data the request body. If null, the http POST request will be examined
176 * @param bool $returnPayload When true, return the response but do not echo it or any http header
178 * @return Response the response object (usually not used by caller...)
180 public function service($data = null, $returnPayload = false)
182 if ($data === null) {
183 $data = file_get_contents('php://input');
187 // reset internal debug info
188 $this->debug_info = '';
190 // Echo back what we received, before parsing it
191 if ($this->debug > 1) {
192 $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
195 $r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
197 $r = $this->parseRequest($data, $reqCharset);
200 // save full body of request into response, for more debugging usages
201 $r->raw_data = $rawData;
203 if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors) {
204 $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
205 static::$_xmlrpcs_occurred_errors . "+++END+++");
208 $payload = $this->xml_header($respCharset);
209 if ($this->debug > 0) {
210 $payload = $payload . $this->serializeDebug($respCharset);
213 // G. Giunta 2006-01-27: do not create response serialization if it has
214 // already happened. Helps building json magic
215 if (empty($r->payload)) {
216 $r->serialize($respCharset);
218 $payload = $payload . $r->payload;
220 if ($returnPayload) {
224 // if we get a warning/error that has output some text before here, then we cannot
225 // add a new header. We cannot say we are sending xml, either...
226 if (!headers_sent()) {
227 header('Content-Type: ' . $r->content_type);
228 // we do not know if client actually told us an accepted charset, but if he did
229 // we have to tell him what we did
230 header("Vary: Accept-Charset");
232 // http compression of output: only
233 // if we can do it, and we want to do it, and client asked us to,
234 // and php ini settings do not force it already
235 $phpNoSelfCompress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');
236 if ($this->compress_response && function_exists('gzencode') && $respEncoding != ''
237 && $phpNoSelfCompress
239 if (strpos($respEncoding, 'gzip') !== false) {
240 $payload = gzencode($payload);
241 header("Content-Encoding: gzip");
242 header("Vary: Accept-Encoding");
243 } elseif (strpos($respEncoding, 'deflate') !== false) {
244 $payload = gzcompress($payload);
245 header("Content-Encoding: deflate");
246 header("Vary: Accept-Encoding");
250 // do not output content-length header if php is compressing output for us:
251 // it will mess up measurements
252 if ($phpNoSelfCompress) {
253 header('Content-Length: ' . (int)strlen($payload));
256 error_log('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
261 // return request, in case subclasses want it
266 * Add a method to the dispatch map.
268 * @param string $methodName the name with which the method will be made available
269 * @param string $function the php function that will get invoked
270 * @param array $sig the array of valid method signatures
271 * @param string $doc method documentation
272 * @param array $sigDoc the array of valid method signatures docs (one string per param, one for return type)
274 public function add_to_map($methodName, $function, $sig = null, $doc = false, $sigDoc = false)
276 $this->dmap[$methodName] = array(
277 'function' => $function,
281 $this->dmap[$methodName]['signature'] = $sig;
284 $this->dmap[$methodName]['signature_docs'] = $sigDoc;
289 * Verify type and number of parameters received against a list of known signatures.
291 * @param array $in array of either xmlrpc value objects or xmlrpc type definitions
292 * @param array $sig array of known signatures to match against
296 protected function verifySignature($in, $sig)
298 // check each possible signature in turn
299 if (is_object($in)) {
300 $numParams = $in->getNumParams();
302 $numParams = count($in);
304 foreach ($sig as $cursig) {
305 if (count($cursig) == $numParams + 1) {
307 for ($n = 0; $n < $numParams; $n++) {
308 if (is_object($in)) {
309 $p = $in->getParam($n);
310 if ($p->kindOf() == 'scalar') {
311 $pt = $p->scalartyp();
316 $pt = $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
319 // param index is $n+1, as first member of sig is return type
320 if ($pt != $cursig[$n + 1] && $cursig[$n + 1] != Value::$xmlrpcValue) {
323 $wanted = $cursig[$n + 1];
333 if (isset($wanted)) {
334 return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
336 return array(0, "No method signature matches number of parameters");
341 * Parse http headers received along with xmlrpc request. If needed, inflate request.
343 * @return mixed null on success or a Response
345 protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
347 // check if $_SERVER is populated: it might have been disabled via ini file
348 // (this is true even when in CLI mode)
349 if (count($_SERVER) == 0) {
350 error_log('XML-RPC: ' . __METHOD__ . ': cannot parse request headers as $_SERVER is not populated');
353 if ($this->debug > 1) {
354 if (function_exists('getallheaders')) {
355 $this->debugmsg(''); // empty line
356 foreach (getallheaders() as $name => $val) {
357 $this->debugmsg("HEADER: $name: $val");
362 if (isset($_SERVER['HTTP_CONTENT_ENCODING'])) {
363 $contentEncoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);
365 $contentEncoding = '';
368 // check if request body has been compressed and decompress it
369 if ($contentEncoding != '' && strlen($data)) {
370 if ($contentEncoding == 'deflate' || $contentEncoding == 'gzip') {
371 // if decoding works, use it. else assume data wasn't gzencoded
372 if (function_exists('gzinflate') && in_array($contentEncoding, $this->accepted_compression)) {
373 if ($contentEncoding == 'deflate' && $degzdata = @gzuncompress($data)) {
375 if ($this->debug > 1) {
376 $this->debugmsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
378 } elseif ($contentEncoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
380 if ($this->debug > 1) {
381 $this->debugmsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
384 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'], PhpXmlRpc::$xmlrpcstr['server_decompress_fail']);
389 //error_log('The server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
390 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'], PhpXmlRpc::$xmlrpcstr['server_cannot_decompress']);
397 // check if client specified accepted charsets, and if we know how to fulfill
399 if ($this->response_charset_encoding == 'auto') {
401 if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
402 // here we should check if we can match the client-requested encoding
403 // with the encodings we know we can generate.
404 /// @todo we should parse q=0.x preferences instead of getting first charset specified...
405 $clientAcceptedCharsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));
406 // Give preference to internal encoding
407 $knownCharsets = array(PhpXmlRpc::$xmlrpc_internalencoding, 'UTF-8', 'ISO-8859-1', 'US-ASCII');
408 foreach ($knownCharsets as $charset) {
409 foreach ($clientAcceptedCharsets as $accepted) {
410 if (strpos($accepted, $charset) === 0) {
411 $respEncoding = $charset;
421 $respEncoding = $this->response_charset_encoding;
424 if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
425 $respCompression = $_SERVER['HTTP_ACCEPT_ENCODING'];
427 $respCompression = '';
430 // 'guestimate' request encoding
431 /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???
432 $reqEncoding = Encoder::guess_encoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',
439 * Parse an xml chunk containing an xmlrpc request and execute the corresponding
440 * php function registered with the server.
442 * @param string $data the xml request
443 * @param string $reqEncoding (optional) the charset encoding of the xml request
447 public function parseRequest($data, $reqEncoding = '')
449 // 2005/05/07 commented and moved into caller function code
452 // $data=$GLOBALS['HTTP_RAW_POST_DATA'];
455 // G. Giunta 2005/02/13: we do NOT expect to receive html entities
456 // so we do not try to convert them into xml character entities
457 //$data = xmlrpc_html_entity_xlate($data);
459 // decompose incoming XML into request structure
460 if ($reqEncoding != '') {
461 if (!in_array($reqEncoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
462 // the following code might be better for mb_string enabled installs, but
463 // makes the lib about 200% slower...
464 //if (!is_valid_charset($reqEncoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII')))
466 error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $reqEncoding);
467 $reqEncoding = PhpXmlRpc::$xmlrpc_defencoding;
469 /// @BUG this will fail on PHP 5 if charset is not specified in the xml prologue,
470 // the encoding is not UTF8 and there are non-ascii chars in the text...
471 /// @todo use an empty string for php 5 ???
472 $parser = xml_parser_create($reqEncoding);
474 $parser = xml_parser_create();
477 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
478 // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
479 // the xml parser to give us back data in the expected charset
480 // What if internal encoding is not in one of the 3 allowed?
481 // we use the broadest one, ie. utf8
482 // This allows to send data which is native in various charset,
483 // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
484 if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
485 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
487 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
490 $xmlRpcParser = new XMLParser();
491 xml_set_object($parser, $xmlRpcParser);
493 if ($this->functions_parameters_type != 'xmlrpcvals') {
494 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
496 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
498 xml_set_character_data_handler($parser, 'xmlrpc_cd');
499 xml_set_default_handler($parser, 'xmlrpc_dh');
500 if (!xml_parse($parser, $data, 1)) {
501 // return XML error as a faultCode
503 PhpXmlRpc::$xmlrpcerrxml + xml_get_error_code($parser),
504 sprintf('XML error: %s at line %d, column %d',
505 xml_error_string(xml_get_error_code($parser)),
506 xml_get_current_line_number($parser), xml_get_current_column_number($parser)));
507 xml_parser_free($parser);
508 } elseif ($xmlRpcParser->_xh['isf']) {
509 xml_parser_free($parser);
511 PhpXmlRpc::$xmlrpcerr['invalid_request'],
512 PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
514 xml_parser_free($parser);
515 // small layering violation in favor of speed and memory usage:
516 // we should allow the 'execute' method handle this, but in the
517 // most common scenario (xmlrpc values type server with some methods
518 // registered as phpvals) that would mean a useless encode+decode pass
519 if ($this->functions_parameters_type != 'xmlrpcvals' || (isset($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type']) && ($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type'] == 'phpvals'))) {
520 if ($this->debug > 1) {
521 $this->debugmsg("\n+++PARSED+++\n" . var_export($xmlRpcParser->_xh['params'], true) . "\n+++END+++");
523 $r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
525 // build a Request object with data parsed from xml
526 $m = new Request($xmlRpcParser->_xh['method']);
527 // now add parameters in
528 for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
529 $m->addParam($xmlRpcParser->_xh['params'][$i]);
532 if ($this->debug > 1) {
533 $this->debugmsg("\n+++PARSED+++\n" . var_export($m, true) . "\n+++END+++");
535 $r = $this->execute($m);
543 * Execute a method invoked by the client, checking parameters used.
545 * @param mixed $m either a Request obj or a method name
546 * @param array $params array with method parameters as php types (if m is method name only)
547 * @param array $paramTypes array with xmlrpc types of method parameters (if m is method name only)
551 protected function execute($m, $params = null, $paramTypes = null)
554 $methName = $m->method();
558 $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);
559 $dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
561 if (!isset($dmap[$methName]['function'])) {
563 return new Response(0,
564 PhpXmlRpc::$xmlrpcerr['unknown_method'],
565 PhpXmlRpc::$xmlrpcstr['unknown_method']);
569 if (isset($dmap[$methName]['signature'])) {
570 $sig = $dmap[$methName]['signature'];
572 list($ok, $errStr) = $this->verifySignature($m, $sig);
574 list($ok, $errStr) = $this->verifySignature($paramTypes, $sig);
580 PhpXmlRpc::$xmlrpcerr['incorrect_params'],
581 PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errstr}"
586 $func = $dmap[$methName]['function'];
587 // let the 'class::function' syntax be accepted in dispatch maps
588 if (is_string($func) && strpos($func, '::')) {
589 $func = explode('::', $func);
591 // verify that function to be invoked is in fact callable
592 if (!is_callable($func)) {
593 error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler is not callable");
597 PhpXmlRpc::$xmlrpcerr['server_error'],
598 PhpXmlRpc::$xmlrpcstr['server_error'] . ": no function matches method"
602 // If debug level is 3, we should catch all errors generated during
603 // processing of user function, and log them as part of response
604 if ($this->debug > 2) {
605 $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
608 // Allow mixed-convention servers
611 $r = call_user_func($func, $this, $m);
613 $r = call_user_func($func, $m);
615 if (!is_a($r, 'PhpXmlRpc\Response')) {
616 error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler does not return an xmlrpc response object");
617 if (is_a($r, 'PhpXmlRpc\Value')) {
618 $r = new Response($r);
622 PhpXmlRpc::$xmlrpcerr['server_error'],
623 PhpXmlRpc::$xmlrpcstr['server_error'] . ": function does not return xmlrpc response object"
628 // call a 'plain php' function
630 array_unshift($params, $this);
631 $r = call_user_func_array($func, $params);
633 // 3rd API convention for method-handling functions: EPI-style
634 if ($this->functions_parameters_type == 'epivals') {
635 $r = call_user_func_array($func, array($methName, $params, $this->user_data));
636 // mimic EPI behaviour: if we get an array that looks like an error, make it
638 if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) {
639 $r = new Response(0, (integer)$r['faultCode'], (string)$r['faultString']);
641 // functions using EPI api should NOT return resp objects,
642 // so make sure we encode the return type correctly
643 $r = new Response(php_xmlrpc_encode($r, array('extension_api')));
646 $r = call_user_func_array($func, $params);
649 // the return type can be either a Response object or a plain php value...
650 if (!is_a($r, '\PhpXmlRpc\Response')) {
651 // what should we assume here about automatic encoding of datetimes
652 // and php classes instances???
653 $r = new Response(php_xmlrpc_encode($r, $this->phpvals_encoding_options));
656 } catch (\Exception $e) {
657 // (barring errors in the lib) an uncatched exception happened
658 // in the called function, we wrap it in a proper error-response
659 switch ($this->exception_handling) {
664 $r = new Response(0, $e->getCode(), $e->getMessage());
667 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
670 if ($this->debug > 2) {
671 // note: restore the error handler we found before calling the
672 // user func, even if it has been changed inside the func itself
673 if ($GLOBALS['_xmlrpcs_prev_ehandler']) {
674 set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);
676 restore_error_handler();
684 * add a string to the 'internal debug message' (separate from 'user debug message').
686 * @param string $string
688 protected function debugmsg($string)
690 $this->debug_info .= $string . "\n";
693 protected function xml_header($charsetEncoding = '')
695 if ($charsetEncoding != '') {
696 return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\"?" . ">\n";
698 return "<?xml version=\"1.0\"?" . ">\n";
702 /* Functions that implement system.XXX methods of xmlrpc servers */
704 public function getSystemDispatchMap()
707 'system.listMethods' => array(
708 'function' => 'PhpXmlRpc\Server::_xmlrpcs_listMethods',
709 // listMethods: signature was either a string, or nothing.
710 // The useless string variant has been removed
711 'signature' => array(array(Value::$xmlrpcArray)),
712 'docstring' => 'This method lists all the methods that the XML-RPC server knows how to dispatch',
713 'signature_docs' => array(array('list of method names')),
715 'system.methodHelp' => array(
716 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodHelp',
717 'signature' => array(array(Value::$xmlrpcString, Value::$xmlrpcString)),
718 'docstring' => 'Returns help text if defined for the method passed, otherwise returns an empty string',
719 'signature_docs' => array(array('method description', 'name of the method to be described')),
721 'system.methodSignature' => array(
722 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodSignature',
723 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcString)),
724 'docstring' => 'Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)',
725 'signature_docs' => array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')),
727 'system.multicall' => array(
728 'function' => 'PhpXmlRpc\Server::_xmlrpcs_multicall',
729 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcArray)),
730 'docstring' => 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details',
731 'signature_docs' => array(array('list of response structs, where each struct has the usual members', 'list of calls, with each call being represented as a struct, with members "methodname" and "params"')),
733 'system.getCapabilities' => array(
734 'function' => 'PhpXmlRpc\Server::_xmlrpcs_getCapabilities',
735 'signature' => array(array(Value::$xmlrpcStruct)),
736 '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',
737 'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec')),
742 public static function _xmlrpcs_getCapabilities($server, $m = null)
745 // xmlrpc spec: always supported
746 'xmlrpc' => new Value(array(
747 'specUrl' => new Value('http://www.xmlrpc.com/spec', 'string'),
748 'specVersion' => new Value(1, 'int'),
750 // if we support system.xxx functions, we always support multicall, too...
751 // Note that, as of 2006/09/17, the following URL does not respond anymore
752 'system.multicall' => new Value(array(
753 'specUrl' => new Value('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),
754 'specVersion' => new Value(1, 'int'),
756 // introspection: version 2! we support 'mixed', too
757 'introspection' => new Value(array(
758 'specUrl' => new Value('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),
759 'specVersion' => new Value(2, 'int'),
764 if (PhpXmlRpc::$xmlrpc_null_extension) {
765 $outAr['nil'] = new Value(array(
766 'specUrl' => new Value('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),
767 'specVersion' => new Value(1, 'int'),
771 return new Response(new Value($outAr, 'struct'));
774 public static function _xmlrpcs_listMethods($server, $m = null) // if called in plain php values mode, second param is missing
777 foreach ($server->dmap as $key => $val) {
778 $outAr[] = new Value($key, 'string');
780 if ($server->allow_system_funcs) {
781 foreach ($server->getSystemDispatchMap() as $key => $val) {
782 $outAr[] = new Value($key, 'string');
786 return new Response(new Value($outAr, 'array'));
789 public static function _xmlrpcs_methodSignature($server, $m)
791 // let accept as parameter both an xmlrpc value or string
793 $methName = $m->getParam(0);
794 $methName = $methName->scalarval();
798 if (strpos($methName, "system.") === 0) {
799 $dmap = $server->getSystemDispatchMap();
801 $dmap = $server->dmap;
803 if (isset($dmap[$methName])) {
804 if (isset($dmap[$methName]['signature'])) {
806 foreach ($dmap[$methName]['signature'] as $inSig) {
808 foreach ($inSig as $sig) {
809 $cursig[] = new Value($sig, 'string');
811 $sigs[] = new Value($cursig, 'array');
813 $r = new Response(new Value($sigs, 'array'));
815 // NB: according to the official docs, we should be returning a
816 // "none-array" here, which means not-an-array
817 $r = new Response(new Value('undef', 'string'));
820 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
826 public static function _xmlrpcs_methodHelp($server, $m)
828 // let accept as parameter both an xmlrpc value or string
830 $methName = $m->getParam(0);
831 $methName = $methName->scalarval();
835 if (strpos($methName, "system.") === 0) {
836 $dmap = $server->getSystemDispatchMap();
838 $dmap = $server->dmap;
840 if (isset($dmap[$methName])) {
841 if (isset($dmap[$methName]['docstring'])) {
842 $r = new Response(new Value($dmap[$methName]['docstring']), 'string');
844 $r = new Response(new Value('', 'string'));
847 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
853 public static function _xmlrpcs_multicall_error($err)
855 if (is_string($err)) {
856 $str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
857 $code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
859 $code = $err->faultCode();
860 $str = $err->faultString();
863 $struct['faultCode'] = new Value($code, 'int');
864 $struct['faultString'] = new Value($str, 'string');
866 return new Value($struct, 'struct');
869 public static function _xmlrpcs_multicall_do_call($server, $call)
871 if ($call->kindOf() != 'struct') {
872 return static::_xmlrpcs_multicall_error('notstruct');
874 $methName = @$call->structmem('methodName');
876 return static::_xmlrpcs_multicall_error('nomethod');
878 if ($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') {
879 return static::_xmlrpcs_multicall_error('notstring');
881 if ($methName->scalarval() == 'system.multicall') {
882 return static::_xmlrpcs_multicall_error('recursion');
885 $params = @$call->structmem('params');
887 return static::_xmlrpcs_multicall_error('noparams');
889 if ($params->kindOf() != 'array') {
890 return static::_xmlrpcs_multicall_error('notarray');
892 $numParams = $params->arraysize();
894 $msg = new Request($methName->scalarval());
895 for ($i = 0; $i < $numParams; $i++) {
896 if (!$msg->addParam($params->arraymem($i))) {
899 return static::_xmlrpcs_multicall_error(new Response(0,
900 PhpXmlRpc::$xmlrpcerr['incorrect_params'],
901 PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
905 $result = $server->execute($msg);
907 if ($result->faultCode() != 0) {
908 return static::_xmlrpcs_multicall_error($result); // Method returned fault.
911 return new Value(array($result->value()), 'array');
914 public static function _xmlrpcs_multicall_do_call_phpvals($server, $call)
916 if (!is_array($call)) {
917 return static::_xmlrpcs_multicall_error('notstruct');
919 if (!array_key_exists('methodName', $call)) {
920 return static::_xmlrpcs_multicall_error('nomethod');
922 if (!is_string($call['methodName'])) {
923 return static::_xmlrpcs_multicall_error('notstring');
925 if ($call['methodName'] == 'system.multicall') {
926 return static::_xmlrpcs_multicall_error('recursion');
928 if (!array_key_exists('params', $call)) {
929 return static::_xmlrpcs_multicall_error('noparams');
931 if (!is_array($call['params'])) {
932 return static::_xmlrpcs_multicall_error('notarray');
935 // this is a real dirty and simplistic hack, since we might have received a
936 // base64 or datetime values, but they will be listed as strings here...
937 $numParams = count($call['params']);
939 foreach ($call['params'] as $val) {
940 $pt[] = php_2_xmlrpc_type(gettype($val));
943 $result = $server->execute($call['methodName'], $call['params'], $pt);
945 if ($result->faultCode() != 0) {
946 return static::_xmlrpcs_multicall_error($result); // Method returned fault.
949 return new Value(array($result->value()), 'array');
952 public static function _xmlrpcs_multicall($server, $m)
955 // let accept a plain list of php parameters, beside a single xmlrpc msg object
957 $calls = $m->getParam(0);
958 $numCalls = $calls->arraysize();
959 for ($i = 0; $i < $numCalls; $i++) {
960 $call = $calls->arraymem($i);
961 $result[$i] = static::_xmlrpcs_multicall_do_call($server, $call);
964 $numCalls = count($m);
965 for ($i = 0; $i < $numCalls; $i++) {
966 $result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $m[$i]);
970 return new Response(new Value($result, 'array'));
974 * Error handler used to track errors that occur during server-side execution of PHP code.
975 * This allows to report back to the client whether an internal error has occurred or not
976 * using an xmlrpc response object, instead of letting the client deal with the html junk
977 * that a PHP execution error on the server generally entails.
979 * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.
981 public static function _xmlrpcs_errorHandler($errCode, $errString, $filename = null, $lineNo = null, $context = null)
983 // obey the @ protocol
984 if (error_reporting() == 0) {
988 //if($errCode != E_NOTICE && $errCode != E_WARNING && $errCode != E_USER_NOTICE && $errCode != E_USER_WARNING)
989 if ($errCode != E_STRICT) {
990 \PhpXmlRpc\Server::error_occurred($errString);
992 // Try to avoid as much as possible disruption to the previous error handling
993 // mechanism in place
994 if ($GLOBALS['_xmlrpcs_prev_ehandler'] == '') {
995 // The previous error handler was the default: all we should do is log error
996 // to the default error log (if level high enough)
997 if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errCode)) {
998 error_log($errString);
1001 // Pass control on to previous error handler, trying to avoid loops...
1002 if ($GLOBALS['_xmlrpcs_prev_ehandler'] != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
1003 if (is_array($GLOBALS['_xmlrpcs_prev_ehandler'])) {
1004 // the following works both with static class methods and plain object methods as error handler
1005 call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errCode, $errString, $filename, $lineNo, $context));
1007 $GLOBALS['_xmlrpcs_prev_ehandler']($errCode, $errString, $filename, $lineno, $context);