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');
28 * Controls whether the server is going to echo debugging messages back to the client as comments in response body.
29 * Valid values: 0,1,2,3
33 * Controls behaviour of server when invoked user function throws an exception:
34 * 0 = catch it and return an 'internal error' xmlrpc response (default)
35 * 1 = catch it and return an xmlrpc response with the error corresponding to the exception
36 * 2 = allow the exception to float to the upper layers
38 public $exception_handling = 0;
40 * When set to true, it will enable HTTP compression of the response, in case
41 * the client has declared its support for compression in the request.
43 public $compress_response = false;
45 * List of http compression methods accepted by the server for requests.
46 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
48 public $accepted_compression = array();
49 /// shall we serve calls to system.* methods?
50 public $allow_system_funcs = true;
51 /// list of charset encodings natively accepted for requests
52 public $accepted_charset_encodings = array();
54 * charset encoding to be used for response.
55 * NB: if we can, we will convert the generated response from internal_encoding to the intended one.
56 * Can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),
57 * null (leave unspecified in response, convert output stream to US_ASCII),
58 * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed),
59 * 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).
60 * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
62 public $response_charset_encoding = '';
64 * Storage for internal debug info.
66 protected $debug_info = '';
68 * Extra data passed at runtime to method handling functions. Used only by EPI layer
70 public $user_data = null;
72 protected static $_xmlrpc_debuginfo = '';
73 protected static $_xmlrpcs_occurred_errors = '';
74 public static $_xmlrpcs_prev_ehandler = '';
77 * @param array $dispatchMap the dispatch map with definition of exposed services
78 * @param boolean $servicenow set to false to prevent the server from running upon construction
80 public function __construct($dispatchMap = null, $serviceNow = true)
82 // if ZLIB is enabled, let the server by default accept compressed requests,
83 // and compress responses sent to clients that support them
84 if (function_exists('gzinflate')) {
85 $this->accepted_compression = array('gzip', 'deflate');
86 $this->compress_response = true;
89 // by default the xml parser can support these 3 charset encodings
90 $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
92 // dispMap is a dispatch array of methods
93 // mapped to function names and signatures
95 // doesn't appear in the map then an unknown
96 // method error is generated
97 /* milosch - changed to make passing dispMap optional.
98 * instead, you can use the class add_to_map() function
99 * to add functions manually (borrowed from SOAPX4)
102 $this->dmap = $dispatchMap;
110 * Set debug level of server.
112 * @param integer $level debug lvl: determines info added to xmlrpc responses (as xml comments)
114 * 1 = msgs set from user with debugmsg(),
115 * 2 = add complete xmlrpc request (headers and body),
116 * 3 = add also all processing warnings happened during method processing
117 * (NB: this involves setting a custom error handler, and might interfere
118 * with the standard processing of the php function exposed as method. In
119 * particular, triggering an USER_ERROR level error will not halt script
120 * execution anymore, but just end up logged in the xmlrpc response)
121 * Note that info added at level 2 and 3 will be base64 encoded
123 public function setDebug($level)
125 $this->debug = $level;
129 * Add a string to the debug info that can be later serialized by the server
130 * as part of the response message.
131 * Note that for best compatibility, the debug string should be encoded using
132 * the PhpXmlRpc::$xmlrpc_internalencoding character set.
137 public static function xmlrpc_debugmsg($msg)
139 static::$_xmlrpc_debuginfo .= $msg . "\n";
142 public static function error_occurred($msg)
144 static::$_xmlrpcs_occurred_errors .= $msg . "\n";
148 * Return a string with the serialized representation of all debug info.
150 * @param string $charsetEncoding the target charset encoding for the serialization
152 * @return string an XML comment (or two)
154 public function serializeDebug($charsetEncoding = '')
156 // Tough encoding problem: which internal charset should we assume for debug info?
157 // It might contain a copy of raw data received from client, ie with unknown encoding,
158 // intermixed with php generated data and user generated data...
159 // so we split it: system debug is base 64 encoded,
160 // user debug info should be encoded by the end user using the INTERNAL_ENCODING
162 if ($this->debug_info != '') {
163 $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n" . base64_encode($this->debug_info) . "\n-->\n";
165 if (static::$_xmlrpc_debuginfo != '') {
166 $out .= "<!-- DEBUG INFO:\n" . Charset::instance()->encodeEntities(str_replace('--', '_-', static::$_xmlrpc_debuginfo), PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n-->\n";
167 // NB: a better solution MIGHT be to use CDATA, but we need to insert it
168 // into return payload AFTER the beginning tag
169 //$out .= "<![CDATA[ DEBUG INFO:\n\n" . str_replace(']]>', ']_]_>', static::$_xmlrpc_debuginfo) . "\n]]>\n";
176 * Execute the xmlrpc request, printing the response.
178 * @param string $data the request body. If null, the http POST request will be examined
179 * @param bool $returnPayload When true, return the response but do not echo it or any http header
181 * @return Response the response object (usually not used by caller...)
183 public function service($data = null, $returnPayload = false)
185 if ($data === null) {
186 $data = file_get_contents('php://input');
190 // reset internal debug info
191 $this->debug_info = '';
193 // Echo back what we received, before parsing it
194 if ($this->debug > 1) {
195 $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
198 $r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
200 $r = $this->parseRequest($data, $reqCharset);
203 // save full body of request into response, for more debugging usages
204 $r->raw_data = $rawData;
206 if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors) {
207 $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
208 static::$_xmlrpcs_occurred_errors . "+++END+++");
211 $payload = $this->xml_header($respCharset);
212 if ($this->debug > 0) {
213 $payload = $payload . $this->serializeDebug($respCharset);
216 // G. Giunta 2006-01-27: do not create response serialization if it has
217 // already happened. Helps building json magic
218 if (empty($r->payload)) {
219 $r->serialize($respCharset);
221 $payload = $payload . $r->payload;
223 if ($returnPayload) {
227 // if we get a warning/error that has output some text before here, then we cannot
228 // add a new header. We cannot say we are sending xml, either...
229 if (!headers_sent()) {
230 header('Content-Type: ' . $r->content_type);
231 // we do not know if client actually told us an accepted charset, but if he did
232 // we have to tell him what we did
233 header("Vary: Accept-Charset");
235 // http compression of output: only
236 // if we can do it, and we want to do it, and client asked us to,
237 // and php ini settings do not force it already
238 $phpNoSelfCompress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');
239 if ($this->compress_response && function_exists('gzencode') && $respEncoding != ''
240 && $phpNoSelfCompress
242 if (strpos($respEncoding, 'gzip') !== false) {
243 $payload = gzencode($payload);
244 header("Content-Encoding: gzip");
245 header("Vary: Accept-Encoding");
246 } elseif (strpos($respEncoding, 'deflate') !== false) {
247 $payload = gzcompress($payload);
248 header("Content-Encoding: deflate");
249 header("Vary: Accept-Encoding");
253 // do not output content-length header if php is compressing output for us:
254 // it will mess up measurements
255 if ($phpNoSelfCompress) {
256 header('Content-Length: ' . (int)strlen($payload));
259 error_log('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
264 // return request, in case subclasses want it
269 * Add a method to the dispatch map.
271 * @param string $methodName the name with which the method will be made available
272 * @param string $function the php function that will get invoked
273 * @param array $sig the array of valid method signatures
274 * @param string $doc method documentation
275 * @param array $sigDoc the array of valid method signatures docs (one string per param, one for return type)
277 public function add_to_map($methodName, $function, $sig = null, $doc = false, $sigDoc = false)
279 $this->dmap[$methodName] = array(
280 'function' => $function,
284 $this->dmap[$methodName]['signature'] = $sig;
287 $this->dmap[$methodName]['signature_docs'] = $sigDoc;
292 * Verify type and number of parameters received against a list of known signatures.
294 * @param array $in array of either xmlrpc value objects or xmlrpc type definitions
295 * @param array $sig array of known signatures to match against
299 protected function verifySignature($in, $sig)
301 // check each possible signature in turn
302 if (is_object($in)) {
303 $numParams = $in->getNumParams();
305 $numParams = count($in);
307 foreach ($sig as $cursig) {
308 if (count($cursig) == $numParams + 1) {
310 for ($n = 0; $n < $numParams; $n++) {
311 if (is_object($in)) {
312 $p = $in->getParam($n);
313 if ($p->kindOf() == 'scalar') {
314 $pt = $p->scalartyp();
319 $pt = $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
322 // param index is $n+1, as first member of sig is return type
323 if ($pt != $cursig[$n + 1] && $cursig[$n + 1] != Value::$xmlrpcValue) {
326 $wanted = $cursig[$n + 1];
336 if (isset($wanted)) {
337 return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
339 return array(0, "No method signature matches number of parameters");
344 * Parse http headers received along with xmlrpc request. If needed, inflate request.
346 * @return mixed null on success or a Response
348 protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
350 // check if $_SERVER is populated: it might have been disabled via ini file
351 // (this is true even when in CLI mode)
352 if (count($_SERVER) == 0) {
353 error_log('XML-RPC: ' . __METHOD__ . ': cannot parse request headers as $_SERVER is not populated');
356 if ($this->debug > 1) {
357 if (function_exists('getallheaders')) {
358 $this->debugmsg(''); // empty line
359 foreach (getallheaders() as $name => $val) {
360 $this->debugmsg("HEADER: $name: $val");
365 if (isset($_SERVER['HTTP_CONTENT_ENCODING'])) {
366 $contentEncoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);
368 $contentEncoding = '';
371 // check if request body has been compressed and decompress it
372 if ($contentEncoding != '' && strlen($data)) {
373 if ($contentEncoding == 'deflate' || $contentEncoding == 'gzip') {
374 // if decoding works, use it. else assume data wasn't gzencoded
375 if (function_exists('gzinflate') && in_array($contentEncoding, $this->accepted_compression)) {
376 if ($contentEncoding == 'deflate' && $degzdata = @gzuncompress($data)) {
378 if ($this->debug > 1) {
379 $this->debugmsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
381 } elseif ($contentEncoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
383 if ($this->debug > 1) {
384 $this->debugmsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
387 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'], PhpXmlRpc::$xmlrpcstr['server_decompress_fail']);
392 //error_log('The server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
393 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'], PhpXmlRpc::$xmlrpcstr['server_cannot_decompress']);
400 // check if client specified accepted charsets, and if we know how to fulfill
402 if ($this->response_charset_encoding == 'auto') {
404 if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
405 // here we should check if we can match the client-requested encoding
406 // with the encodings we know we can generate.
407 /// @todo we should parse q=0.x preferences instead of getting first charset specified...
408 $clientAcceptedCharsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));
409 // Give preference to internal encoding
410 $knownCharsets = array(PhpXmlRpc::$xmlrpc_internalencoding, 'UTF-8', 'ISO-8859-1', 'US-ASCII');
411 foreach ($knownCharsets as $charset) {
412 foreach ($clientAcceptedCharsets as $accepted) {
413 if (strpos($accepted, $charset) === 0) {
414 $respEncoding = $charset;
424 $respEncoding = $this->response_charset_encoding;
427 if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
428 $respCompression = $_SERVER['HTTP_ACCEPT_ENCODING'];
430 $respCompression = '';
433 // 'guestimate' request encoding
434 /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???
435 $reqEncoding = XMLParser::guessEncoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',
442 * Parse an xml chunk containing an xmlrpc request and execute the corresponding
443 * php function registered with the server.
445 * @param string $data the xml request
446 * @param string $reqEncoding (optional) the charset encoding of the xml request
450 public function parseRequest($data, $reqEncoding = '')
452 // decompose incoming XML into request structure
454 if ($reqEncoding != '') {
455 // Since parsing will fail if charset is not specified in the xml prologue,
456 // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...
457 // The following code might be better for mb_string enabled installs, but
458 // makes the lib about 200% slower...
459 //if (!is_valid_charset($reqEncoding, array('UTF-8')))
460 if (!in_array($reqEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($data)) {
461 if ($reqEncoding == 'ISO-8859-1') {
462 $data = utf8_encode($data);
464 if (extension_loaded('mbstring')) {
465 $data = mb_convert_encoding($data, 'UTF-8', $reqEncoding);
467 error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $reqEncoding);
473 $parser = xml_parser_create();
474 xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true);
475 // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell
476 // the xml parser to give us back data in the expected charset
477 // What if internal encoding is not in one of the 3 allowed?
478 // we use the broadest one, ie. utf8
479 // This allows to send data which is native in various charset,
480 // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
481 if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
482 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8');
484 xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
487 $xmlRpcParser = new XMLParser();
488 xml_set_object($parser, $xmlRpcParser);
490 if ($this->functions_parameters_type != 'xmlrpcvals') {
491 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
493 xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
495 xml_set_character_data_handler($parser, 'xmlrpc_cd');
496 xml_set_default_handler($parser, 'xmlrpc_dh');
497 if (!xml_parse($parser, $data, 1)) {
498 // return XML error as a faultCode
500 PhpXmlRpc::$xmlrpcerrxml + xml_get_error_code($parser),
501 sprintf('XML error: %s at line %d, column %d',
502 xml_error_string(xml_get_error_code($parser)),
503 xml_get_current_line_number($parser), xml_get_current_column_number($parser)));
504 xml_parser_free($parser);
505 } elseif ($xmlRpcParser->_xh['isf']) {
506 xml_parser_free($parser);
508 PhpXmlRpc::$xmlrpcerr['invalid_request'],
509 PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
511 xml_parser_free($parser);
512 // small layering violation in favor of speed and memory usage:
513 // we should allow the 'execute' method handle this, but in the
514 // most common scenario (xmlrpc values type server with some methods
515 // registered as phpvals) that would mean a useless encode+decode pass
516 if ($this->functions_parameters_type != 'xmlrpcvals' || (isset($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type']) && ($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type'] == 'phpvals'))) {
517 if ($this->debug > 1) {
518 $this->debugmsg("\n+++PARSED+++\n" . var_export($xmlRpcParser->_xh['params'], true) . "\n+++END+++");
520 $r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
522 // build a Request object with data parsed from xml
523 $req = new Request($xmlRpcParser->_xh['method']);
524 // now add parameters in
525 for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
526 $req->addParam($xmlRpcParser->_xh['params'][$i]);
529 if ($this->debug > 1) {
530 $this->debugmsg("\n+++PARSED+++\n" . var_export($req, true) . "\n+++END+++");
532 $r = $this->execute($req);
540 * Execute a method invoked by the client, checking parameters used.
542 * @param mixed $req either a Request obj or a method name
543 * @param array $params array with method parameters as php types (if m is method name only)
544 * @param array $paramTypes array with xmlrpc types of method parameters (if m is method name only)
548 * @throws \Exception in case the executed method does throw an exception (and depending on )
550 protected function execute($req, $params = null, $paramTypes = null)
552 if (is_object($req)) {
553 $methName = $req->method();
557 $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);
558 $dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
560 if (!isset($dmap[$methName]['function'])) {
562 return new Response(0,
563 PhpXmlRpc::$xmlrpcerr['unknown_method'],
564 PhpXmlRpc::$xmlrpcstr['unknown_method']);
568 if (isset($dmap[$methName]['signature'])) {
569 $sig = $dmap[$methName]['signature'];
570 if (is_object($req)) {
571 list($ok, $errStr) = $this->verifySignature($req, $sig);
573 list($ok, $errStr) = $this->verifySignature($paramTypes, $sig);
579 PhpXmlRpc::$xmlrpcerr['incorrect_params'],
580 PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errStr}"
585 $func = $dmap[$methName]['function'];
586 // let the 'class::function' syntax be accepted in dispatch maps
587 if (is_string($func) && strpos($func, '::')) {
588 $func = explode('::', $func);
591 if (is_array($func)) {
592 if (is_object($func[0])) {
593 $funcName = get_class($func[0]) . '->' . $func[1];
595 $funcName = implode('::', $func);
597 } else if ($func instanceof \Closure) {
598 $funcName = 'Closure';
603 // verify that function to be invoked is in fact callable
604 if (!is_callable($func)) {
605 error_log("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable");
609 PhpXmlRpc::$xmlrpcerr['server_error'],
610 PhpXmlRpc::$xmlrpcstr['server_error'] . ": no function matches method"
614 // If debug level is 3, we should catch all errors generated during
615 // processing of user function, and log them as part of response
616 if ($this->debug > 2) {
617 $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
620 // Allow mixed-convention servers
621 if (is_object($req)) {
623 $r = call_user_func($func, $this, $req);
625 $r = call_user_func($func, $req);
627 if (!is_a($r, 'PhpXmlRpc\Response')) {
628 error_log("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler does not return an xmlrpc response object but a " . gettype($r));
629 if (is_a($r, 'PhpXmlRpc\Value')) {
630 $r = new Response($r);
634 PhpXmlRpc::$xmlrpcerr['server_error'],
635 PhpXmlRpc::$xmlrpcstr['server_error'] . ": function does not return xmlrpc response object"
640 // call a 'plain php' function
642 array_unshift($params, $this);
643 $r = call_user_func_array($func, $params);
645 // 3rd API convention for method-handling functions: EPI-style
646 if ($this->functions_parameters_type == 'epivals') {
647 $r = call_user_func_array($func, array($methName, $params, $this->user_data));
648 // mimic EPI behaviour: if we get an array that looks like an error, make it
650 if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) {
651 $r = new Response(0, (integer)$r['faultCode'], (string)$r['faultString']);
653 // functions using EPI api should NOT return resp objects,
654 // so make sure we encode the return type correctly
655 $r = new Response(php_xmlrpc_encode($r, array('extension_api')));
658 $r = call_user_func_array($func, $params);
661 // the return type can be either a Response object or a plain php value...
662 if (!is_a($r, '\PhpXmlRpc\Response')) {
663 // what should we assume here about automatic encoding of datetimes
664 // and php classes instances???
665 $r = new Response(php_xmlrpc_encode($r, $this->phpvals_encoding_options));
668 } catch (\Exception $e) {
669 // (barring errors in the lib) an uncatched exception happened
670 // in the called function, we wrap it in a proper error-response
671 switch ($this->exception_handling) {
676 $r = new Response(0, $e->getCode(), $e->getMessage());
679 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
682 if ($this->debug > 2) {
683 // note: restore the error handler we found before calling the
684 // user func, even if it has been changed inside the func itself
685 if ($GLOBALS['_xmlrpcs_prev_ehandler']) {
686 set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);
688 restore_error_handler();
696 * add a string to the 'internal debug message' (separate from 'user debug message').
698 * @param string $string
700 protected function debugmsg($string)
702 $this->debug_info .= $string . "\n";
705 protected function xml_header($charsetEncoding = '')
707 if ($charsetEncoding != '') {
708 return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\"?" . ">\n";
710 return "<?xml version=\"1.0\"?" . ">\n";
714 /* Functions that implement system.XXX methods of xmlrpc servers */
716 public function getSystemDispatchMap()
719 'system.listMethods' => array(
720 'function' => 'PhpXmlRpc\Server::_xmlrpcs_listMethods',
721 // listMethods: signature was either a string, or nothing.
722 // The useless string variant has been removed
723 'signature' => array(array(Value::$xmlrpcArray)),
724 'docstring' => 'This method lists all the methods that the XML-RPC server knows how to dispatch',
725 'signature_docs' => array(array('list of method names')),
727 'system.methodHelp' => array(
728 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodHelp',
729 'signature' => array(array(Value::$xmlrpcString, Value::$xmlrpcString)),
730 'docstring' => 'Returns help text if defined for the method passed, otherwise returns an empty string',
731 'signature_docs' => array(array('method description', 'name of the method to be described')),
733 'system.methodSignature' => array(
734 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodSignature',
735 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcString)),
736 '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)',
737 'signature_docs' => array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')),
739 'system.multicall' => array(
740 'function' => 'PhpXmlRpc\Server::_xmlrpcs_multicall',
741 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcArray)),
742 'docstring' => 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details',
743 '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"')),
745 'system.getCapabilities' => array(
746 'function' => 'PhpXmlRpc\Server::_xmlrpcs_getCapabilities',
747 'signature' => array(array(Value::$xmlrpcStruct)),
748 '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',
749 'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec')),
754 public static function _xmlrpcs_getCapabilities($server, $req = null)
757 // xmlrpc spec: always supported
758 'xmlrpc' => new Value(array(
759 'specUrl' => new Value('http://www.xmlrpc.com/spec', 'string'),
760 'specVersion' => new Value(1, 'int'),
762 // if we support system.xxx functions, we always support multicall, too...
763 // Note that, as of 2006/09/17, the following URL does not respond anymore
764 'system.multicall' => new Value(array(
765 'specUrl' => new Value('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),
766 'specVersion' => new Value(1, 'int'),
768 // introspection: version 2! we support 'mixed', too
769 'introspection' => new Value(array(
770 'specUrl' => new Value('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),
771 'specVersion' => new Value(2, 'int'),
776 if (PhpXmlRpc::$xmlrpc_null_extension) {
777 $outAr['nil'] = new Value(array(
778 'specUrl' => new Value('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),
779 'specVersion' => new Value(1, 'int'),
783 return new Response(new Value($outAr, 'struct'));
786 public static function _xmlrpcs_listMethods($server, $req = null) // if called in plain php values mode, second param is missing
789 foreach ($server->dmap as $key => $val) {
790 $outAr[] = new Value($key, 'string');
792 if ($server->allow_system_funcs) {
793 foreach ($server->getSystemDispatchMap() as $key => $val) {
794 $outAr[] = new Value($key, 'string');
798 return new Response(new Value($outAr, 'array'));
801 public static function _xmlrpcs_methodSignature($server, $req)
803 // let accept as parameter both an xmlrpc value or string
804 if (is_object($req)) {
805 $methName = $req->getParam(0);
806 $methName = $methName->scalarval();
810 if (strpos($methName, "system.") === 0) {
811 $dmap = $server->getSystemDispatchMap();
813 $dmap = $server->dmap;
815 if (isset($dmap[$methName])) {
816 if (isset($dmap[$methName]['signature'])) {
818 foreach ($dmap[$methName]['signature'] as $inSig) {
820 foreach ($inSig as $sig) {
821 $cursig[] = new Value($sig, 'string');
823 $sigs[] = new Value($cursig, 'array');
825 $r = new Response(new Value($sigs, 'array'));
827 // NB: according to the official docs, we should be returning a
828 // "none-array" here, which means not-an-array
829 $r = new Response(new Value('undef', 'string'));
832 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
838 public static function _xmlrpcs_methodHelp($server, $req)
840 // let accept as parameter both an xmlrpc value or string
841 if (is_object($req)) {
842 $methName = $req->getParam(0);
843 $methName = $methName->scalarval();
847 if (strpos($methName, "system.") === 0) {
848 $dmap = $server->getSystemDispatchMap();
850 $dmap = $server->dmap;
852 if (isset($dmap[$methName])) {
853 if (isset($dmap[$methName]['docstring'])) {
854 $r = new Response(new Value($dmap[$methName]['docstring']), 'string');
856 $r = new Response(new Value('', 'string'));
859 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
865 public static function _xmlrpcs_multicall_error($err)
867 if (is_string($err)) {
868 $str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
869 $code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
871 $code = $err->faultCode();
872 $str = $err->faultString();
875 $struct['faultCode'] = new Value($code, 'int');
876 $struct['faultString'] = new Value($str, 'string');
878 return new Value($struct, 'struct');
881 public static function _xmlrpcs_multicall_do_call($server, $call)
883 if ($call->kindOf() != 'struct') {
884 return static::_xmlrpcs_multicall_error('notstruct');
886 $methName = @$call->structmem('methodName');
888 return static::_xmlrpcs_multicall_error('nomethod');
890 if ($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') {
891 return static::_xmlrpcs_multicall_error('notstring');
893 if ($methName->scalarval() == 'system.multicall') {
894 return static::_xmlrpcs_multicall_error('recursion');
897 $params = @$call->structmem('params');
899 return static::_xmlrpcs_multicall_error('noparams');
901 if ($params->kindOf() != 'array') {
902 return static::_xmlrpcs_multicall_error('notarray');
904 $numParams = $params->arraysize();
906 $msg = new Request($methName->scalarval());
907 for ($i = 0; $i < $numParams; $i++) {
908 if (!$msg->addParam($params->arraymem($i))) {
911 return static::_xmlrpcs_multicall_error(new Response(0,
912 PhpXmlRpc::$xmlrpcerr['incorrect_params'],
913 PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
917 $result = $server->execute($msg);
919 if ($result->faultCode() != 0) {
920 return static::_xmlrpcs_multicall_error($result); // Method returned fault.
923 return new Value(array($result->value()), 'array');
926 public static function _xmlrpcs_multicall_do_call_phpvals($server, $call)
928 if (!is_array($call)) {
929 return static::_xmlrpcs_multicall_error('notstruct');
931 if (!array_key_exists('methodName', $call)) {
932 return static::_xmlrpcs_multicall_error('nomethod');
934 if (!is_string($call['methodName'])) {
935 return static::_xmlrpcs_multicall_error('notstring');
937 if ($call['methodName'] == 'system.multicall') {
938 return static::_xmlrpcs_multicall_error('recursion');
940 if (!array_key_exists('params', $call)) {
941 return static::_xmlrpcs_multicall_error('noparams');
943 if (!is_array($call['params'])) {
944 return static::_xmlrpcs_multicall_error('notarray');
947 // this is a real dirty and simplistic hack, since we might have received a
948 // base64 or datetime values, but they will be listed as strings here...
949 $numParams = count($call['params']);
951 $wrapper = new Wrapper();
952 foreach ($call['params'] as $val) {
953 $pt[] = $wrapper->php_2_xmlrpc_type(gettype($val));
956 $result = $server->execute($call['methodName'], $call['params'], $pt);
958 if ($result->faultCode() != 0) {
959 return static::_xmlrpcs_multicall_error($result); // Method returned fault.
962 return new Value(array($result->value()), 'array');
965 public static function _xmlrpcs_multicall($server, $req)
968 // let accept a plain list of php parameters, beside a single xmlrpc msg object
969 if (is_object($req)) {
970 $calls = $req->getParam(0);
971 $numCalls = $calls->arraysize();
972 for ($i = 0; $i < $numCalls; $i++) {
973 $call = $calls->arraymem($i);
974 $result[$i] = static::_xmlrpcs_multicall_do_call($server, $call);
977 $numCalls = count($req);
978 for ($i = 0; $i < $numCalls; $i++) {
979 $result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $req[$i]);
983 return new Response(new Value($result, 'array'));
987 * Error handler used to track errors that occur during server-side execution of PHP code.
988 * This allows to report back to the client whether an internal error has occurred or not
989 * using an xmlrpc response object, instead of letting the client deal with the html junk
990 * that a PHP execution error on the server generally entails.
992 * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.
994 public static function _xmlrpcs_errorHandler($errCode, $errString, $filename = null, $lineNo = null, $context = null)
996 // obey the @ protocol
997 if (error_reporting() == 0) {
1001 //if($errCode != E_NOTICE && $errCode != E_WARNING && $errCode != E_USER_NOTICE && $errCode != E_USER_WARNING)
1002 if ($errCode != E_STRICT) {
1003 \PhpXmlRpc\Server::error_occurred($errString);
1005 // Try to avoid as much as possible disruption to the previous error handling
1006 // mechanism in place
1007 if ($GLOBALS['_xmlrpcs_prev_ehandler'] == '') {
1008 // The previous error handler was the default: all we should do is log error
1009 // to the default error log (if level high enough)
1010 if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errCode)) {
1011 error_log($errString);
1014 // Pass control on to previous error handler, trying to avoid loops...
1015 if ($GLOBALS['_xmlrpcs_prev_ehandler'] != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
1016 if (is_array($GLOBALS['_xmlrpcs_prev_ehandler'])) {
1017 // the following works both with static class methods and plain object methods as error handler
1018 call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errCode, $errString, $filename, $lineNo, $context));
1020 $GLOBALS['_xmlrpcs_prev_ehandler']($errCode, $errString, $filename, $lineNo, $context);