5 use PhpXmlRpc\Helper\Logger;
6 use PhpXmlRpc\Helper\Charset;
7 use PhpXmlRpc\Helper\XMLParser;
10 * Allows effortless implementation of XML-RPC servers
15 * Array defining php functions exposed as xmlrpc methods by this server.
17 protected $dmap = array();
20 * Defines how functions in dmap will be invoked: either using an xmlrpc request object
21 * or plain php values.
22 * Valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'
24 public $functions_parameters_type = 'xmlrpcvals';
27 * Option used for fine-tuning the encoding the php values returned from
28 * functions registered in the dispatch map when the functions_parameters_types
29 * member is set to 'phpvals'
30 * @see Encoder::encode for a list of values
32 public $phpvals_encoding_options = array('auto_dates');
35 * Controls whether the server is going to echo debugging messages back to the client as comments in response body.
36 * Valid values: 0,1,2,3
41 * Controls behaviour of server when the invoked user function throws an exception:
42 * 0 = catch it and return an 'internal error' xmlrpc response (default)
43 * 1 = catch it and return an xmlrpc response with the error corresponding to the exception
44 * 2 = allow the exception to float to the upper layers
46 public $exception_handling = 0;
49 * When set to true, it will enable HTTP compression of the response, in case
50 * the client has declared its support for compression in the request.
51 * Set at constructor time.
53 public $compress_response = false;
56 * List of http compression methods accepted by the server for requests. Set at constructor time.
57 * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
59 public $accepted_compression = array();
61 /// Shall we serve calls to system.* methods?
62 public $allow_system_funcs = true;
65 * List of charset encodings natively accepted for requests.
66 * Set at constructor time.
69 public $accepted_charset_encodings = array();
72 * Charset encoding to be used for response.
73 * NB: if we can, we will convert the generated response from internal_encoding to the intended one.
74 * Can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),
75 * null (leave unspecified in response, convert output stream to US_ASCII),
76 * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed),
77 * 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).
78 * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
80 public $response_charset_encoding = '';
83 * Storage for internal debug info.
85 protected $debug_info = '';
88 * Extra data passed at runtime to method handling functions. Used only by EPI layer
90 public $user_data = null;
92 protected static $_xmlrpc_debuginfo = '';
93 protected static $_xmlrpcs_occurred_errors = '';
94 protected static $_xmlrpcs_prev_ehandler = '';
97 * @param array $dispatchMap the dispatch map with definition of exposed services
98 * @param boolean $serviceNow set to false to prevent the server from running upon construction
100 public function __construct($dispatchMap = null, $serviceNow = true)
102 // if ZLIB is enabled, let the server by default accept compressed requests,
103 // and compress responses sent to clients that support them
104 if (function_exists('gzinflate')) {
105 $this->accepted_compression = array('gzip', 'deflate');
106 $this->compress_response = true;
109 // by default the xml parser can support these 3 charset encodings
110 $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
112 // dispMap is a dispatch array of methods mapped to function names and signatures.
113 // If a method doesn't appear in the map then an unknown method error is generated
114 /* milosch - changed to make passing dispMap optional.
115 * instead, you can use the class add_to_map() function
116 * to add functions manually (borrowed from SOAPX4)
119 $this->dmap = $dispatchMap;
127 * Set debug level of server.
129 * @param integer $level debug lvl: determines info added to xmlrpc responses (as xml comments)
131 * 1 = msgs set from user with debugmsg(),
132 * 2 = add complete xmlrpc request (headers and body),
133 * 3 = add also all processing warnings happened during method processing
134 * (NB: this involves setting a custom error handler, and might interfere
135 * with the standard processing of the php function exposed as method. In
136 * particular, triggering an USER_ERROR level error will not halt script
137 * execution anymore, but just end up logged in the xmlrpc response)
138 * Note that info added at level 2 and 3 will be base64 encoded
140 public function setDebug($level)
142 $this->debug = $level;
146 * Add a string to the debug info that can be later serialized by the server as part of the response message.
147 * Note that for best compatibility, the debug string should be encoded using the PhpXmlRpc::$xmlrpc_internalencoding
153 public static function xmlrpc_debugmsg($msg)
155 static::$_xmlrpc_debuginfo .= $msg . "\n";
161 public static function error_occurred($msg)
163 static::$_xmlrpcs_occurred_errors .= $msg . "\n";
167 * Return a string with the serialized representation of all debug info.
169 * @param string $charsetEncoding the target charset encoding for the serialization
171 * @return string an XML comment (or two)
173 public function serializeDebug($charsetEncoding = '')
175 // Tough encoding problem: which internal charset should we assume for debug info?
176 // It might contain a copy of raw data received from client, ie with unknown encoding,
177 // intermixed with php generated data and user generated data...
178 // so we split it: system debug is base 64 encoded,
179 // user debug info should be encoded by the end user using the INTERNAL_ENCODING
181 if ($this->debug_info != '') {
182 $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n" . base64_encode($this->debug_info) . "\n-->\n";
184 if (static::$_xmlrpc_debuginfo != '') {
185 $out .= "<!-- DEBUG INFO:\n" . Charset::instance()->encodeEntities(str_replace('--', '_-', static::$_xmlrpc_debuginfo), PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n-->\n";
186 // NB: a better solution MIGHT be to use CDATA, but we need to insert it
187 // into return payload AFTER the beginning tag
188 //$out .= "<![CDATA[ DEBUG INFO:\n\n" . str_replace(']]>', ']_]_>', static::$_xmlrpc_debuginfo) . "\n]]>\n";
195 * Execute the xmlrpc request, printing the response.
197 * @param string $data the request body. If null, the http POST request will be examined
198 * @param bool $returnPayload When true, return the response but do not echo it or any http header
200 * @return Response|string the response object (usually not used by caller...) or its xml serialization
202 * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
204 public function service($data = null, $returnPayload = false)
206 if ($data === null) {
207 $data = file_get_contents('php://input');
211 // reset internal debug info
212 $this->debug_info = '';
214 // Save what we received, before parsing it
215 if ($this->debug > 1) {
216 $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
219 $r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
221 // this actually executes the request
222 $r = $this->parseRequest($data, $reqCharset);
225 // save full body of request into response, for more debugging usages
226 $r->raw_data = $rawData;
228 if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors) {
229 $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
230 static::$_xmlrpcs_occurred_errors . "+++END+++");
233 $payload = $this->xml_header($respCharset);
234 if ($this->debug > 0) {
235 $payload = $payload . $this->serializeDebug($respCharset);
238 // Do not create response serialization if it has already happened. Helps building json magic
239 if (empty($r->payload)) {
240 $r->serialize($respCharset);
242 $payload = $payload . $r->payload;
244 if ($returnPayload) {
248 // if we get a warning/error that has output some text before here, then we cannot
249 // add a new header. We cannot say we are sending xml, either...
250 if (!headers_sent()) {
251 header('Content-Type: ' . $r->content_type);
252 // we do not know if client actually told us an accepted charset, but if he did
253 // we have to tell him what we did
254 header("Vary: Accept-Charset");
256 // http compression of output: only
257 // if we can do it, and we want to do it, and client asked us to,
258 // and php ini settings do not force it already
259 $phpNoSelfCompress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');
260 if ($this->compress_response && function_exists('gzencode') && $respEncoding != ''
261 && $phpNoSelfCompress
263 if (strpos($respEncoding, 'gzip') !== false) {
264 $payload = gzencode($payload);
265 header("Content-Encoding: gzip");
266 header("Vary: Accept-Encoding");
267 } elseif (strpos($respEncoding, 'deflate') !== false) {
268 $payload = gzcompress($payload);
269 header("Content-Encoding: deflate");
270 header("Vary: Accept-Encoding");
274 // Do not output content-length header if php is compressing output for us:
275 // it will mess up measurements.
276 // Note that Apache/mod_php will add (and even alter!) the Content-Length header on its own, but only for
277 // responses up to 8000 bytes
278 if ($phpNoSelfCompress) {
279 header('Content-Length: ' . (int)strlen($payload));
282 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
287 // return request, in case subclasses want it
292 * Add a method to the dispatch map.
294 * @param string $methodName the name with which the method will be made available
295 * @param string $function the php function that will get invoked
296 * @param array $sig the array of valid method signatures
297 * @param string $doc method documentation
298 * @param array $sigDoc the array of valid method signatures docs (one string per param, one for return type)
300 * @todo raise a warning if the user tries to register a 'system.' method
302 public function add_to_map($methodName, $function, $sig = null, $doc = false, $sigDoc = false)
304 $this->dmap[$methodName] = array(
305 'function' => $function,
309 $this->dmap[$methodName]['signature'] = $sig;
312 $this->dmap[$methodName]['signature_docs'] = $sigDoc;
317 * Verify type and number of parameters received against a list of known signatures.
319 * @param array|Request $in array of either xmlrpc value objects or xmlrpc type definitions
320 * @param array $sigs array of known signatures to match against
322 * @return array int, string
324 protected function verifySignature($in, $sigs)
326 // check each possible signature in turn
327 if (is_object($in)) {
328 $numParams = $in->getNumParams();
330 $numParams = count($in);
332 foreach ($sigs as $curSig) {
333 if (count($curSig) == $numParams + 1) {
335 for ($n = 0; $n < $numParams; $n++) {
336 if (is_object($in)) {
337 $p = $in->getParam($n);
338 if ($p->kindOf() == 'scalar') {
339 $pt = $p->scalartyp();
344 $pt = ($in[$n] == 'i4') ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
347 // param index is $n+1, as first member of sig is return type
348 if ($pt != $curSig[$n + 1] && $curSig[$n + 1] != Value::$xmlrpcValue) {
351 $wanted = $curSig[$n + 1];
361 if (isset($wanted)) {
362 return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
364 return array(0, "No method signature matches number of parameters");
369 * Parse http headers received along with xmlrpc request. If needed, inflate request.
371 * @return mixed Response|null on success or an error Response
373 protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
375 // check if $_SERVER is populated: it might have been disabled via ini file
376 // (this is true even when in CLI mode)
377 if (count($_SERVER) == 0) {
378 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': cannot parse request headers as $_SERVER is not populated');
381 if ($this->debug > 1) {
382 if (function_exists('getallheaders')) {
383 $this->debugmsg(''); // empty line
384 foreach (getallheaders() as $name => $val) {
385 $this->debugmsg("HEADER: $name: $val");
390 if (isset($_SERVER['HTTP_CONTENT_ENCODING'])) {
391 $contentEncoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);
393 $contentEncoding = '';
396 // check if request body has been compressed and decompress it
397 if ($contentEncoding != '' && strlen($data)) {
398 if ($contentEncoding == 'deflate' || $contentEncoding == 'gzip') {
399 // if decoding works, use it. else assume data wasn't gzencoded
400 if (function_exists('gzinflate') && in_array($contentEncoding, $this->accepted_compression)) {
401 if ($contentEncoding == 'deflate' && $degzdata = @gzuncompress($data)) {
403 if ($this->debug > 1) {
404 $this->debugmsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
406 } elseif ($contentEncoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
408 if ($this->debug > 1) {
409 $this->debugmsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
412 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'], PhpXmlRpc::$xmlrpcstr['server_decompress_fail']);
417 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'], PhpXmlRpc::$xmlrpcstr['server_cannot_decompress']);
424 // check if client specified accepted charsets, and if we know how to fulfill
426 if ($this->response_charset_encoding == 'auto') {
428 if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
429 // here we should check if we can match the client-requested encoding
430 // with the encodings we know we can generate.
431 /// @todo we should parse q=0.x preferences instead of getting first charset specified...
432 $clientAcceptedCharsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));
433 // Give preference to internal encoding
434 $knownCharsets = array(PhpXmlRpc::$xmlrpc_internalencoding, 'UTF-8', 'ISO-8859-1', 'US-ASCII');
435 foreach ($knownCharsets as $charset) {
436 foreach ($clientAcceptedCharsets as $accepted) {
437 if (strpos($accepted, $charset) === 0) {
438 $respEncoding = $charset;
448 $respEncoding = $this->response_charset_encoding;
451 if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
452 $respCompression = $_SERVER['HTTP_ACCEPT_ENCODING'];
454 $respCompression = '';
457 // 'guestimate' request encoding
458 /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???
459 $reqEncoding = XMLParser::guessEncoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',
466 * Parse an xml chunk containing an xmlrpc request and execute the corresponding
467 * php function registered with the server.
469 * @param string $data the xml request
470 * @param string $reqEncoding (optional) the charset encoding of the xml request
474 * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
476 public function parseRequest($data, $reqEncoding = '')
478 // decompose incoming XML into request structure
480 if ($reqEncoding != '') {
481 // Since parsing will fail if
482 // - charset is not specified in the xml prologue,
483 // - the encoding is not UTF8 and
484 // - there are non-ascii chars in the text,
485 // we try to work round that...
486 // The following code might be better for mb_string enabled installs, but
487 // makes the lib about 200% slower...
488 //if (!is_valid_charset($reqEncoding, array('UTF-8')))
489 if (!in_array($reqEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($data)) {
490 if ($reqEncoding == 'ISO-8859-1') {
491 $data = utf8_encode($data);
493 if (extension_loaded('mbstring')) {
494 $data = mb_convert_encoding($data, 'UTF-8', $reqEncoding);
496 Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $reqEncoding);
502 // PHP internally might use ISO-8859-1, so we have to tell the xml parser to give us back data in the expected charset.
503 // What if internal encoding is not in one of the 3 allowed? We use the broadest one, ie. utf8
504 // This allows to send data which is native in various charset,
505 // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
506 if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
507 $options = array(XML_OPTION_TARGET_ENCODING => 'UTF-8');
509 $options = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding);
512 $xmlRpcParser = new XMLParser($options);
513 $xmlRpcParser->parse($data, $this->functions_parameters_type, XMLParser::ACCEPT_REQUEST);
514 if ($xmlRpcParser->_xh['isf'] > 2) {
515 // (BC) we return XML error as a faultCode
516 preg_match('/^XML error ([0-9]+)/', $xmlRpcParser->_xh['isf_reason'], $matches);
518 PhpXmlRpc::$xmlrpcerrxml + $matches[1],
519 $xmlRpcParser->_xh['isf_reason']);
520 } elseif ($xmlRpcParser->_xh['isf']) {
522 PhpXmlRpc::$xmlrpcerr['invalid_request'],
523 PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
525 // small layering violation in favor of speed and memory usage:
526 // we should allow the 'execute' method handle this, but in the
527 // most common scenario (xmlrpc values type server with some methods
528 // registered as phpvals) that would mean a useless encode+decode pass
529 if ($this->functions_parameters_type != 'xmlrpcvals' ||
530 (isset($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type']) &&
531 ($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type'] == 'phpvals')
534 if ($this->debug > 1) {
535 $this->debugmsg("\n+++PARSED+++\n" . var_export($xmlRpcParser->_xh['params'], true) . "\n+++END+++");
537 $r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
539 // build a Request object with data parsed from xml
540 $req = new Request($xmlRpcParser->_xh['method']);
541 // now add parameters in
542 for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
543 $req->addParam($xmlRpcParser->_xh['params'][$i]);
546 if ($this->debug > 1) {
547 $this->debugmsg("\n+++PARSED+++\n" . var_export($req, true) . "\n+++END+++");
549 $r = $this->execute($req);
557 * Execute a method invoked by the client, checking parameters used.
559 * @param mixed $req either a Request obj or a method name
560 * @param array $params array with method parameters as php types (if m is method name only)
561 * @param array $paramTypes array with xmlrpc types of method parameters (if m is method name only)
565 * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
567 protected function execute($req, $params = null, $paramTypes = null)
569 static::$_xmlrpcs_occurred_errors = '';
570 static::$_xmlrpc_debuginfo = '';
572 if (is_object($req)) {
573 $methName = $req->method();
577 $sysCall = $this->isSyscall($methName);
578 $dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
580 if (!isset($dmap[$methName]['function'])) {
582 return new Response(0,
583 PhpXmlRpc::$xmlrpcerr['unknown_method'],
584 PhpXmlRpc::$xmlrpcstr['unknown_method']);
588 if (isset($dmap[$methName]['signature'])) {
589 $sig = $dmap[$methName]['signature'];
590 if (is_object($req)) {
591 list($ok, $errStr) = $this->verifySignature($req, $sig);
593 list($ok, $errStr) = $this->verifySignature($paramTypes, $sig);
599 PhpXmlRpc::$xmlrpcerr['incorrect_params'],
600 PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errStr}"
605 $func = $dmap[$methName]['function'];
606 // let the 'class::function' syntax be accepted in dispatch maps
607 if (is_string($func) && strpos($func, '::')) {
608 $func = explode('::', $func);
611 if (is_array($func)) {
612 if (is_object($func[0])) {
613 $funcName = get_class($func[0]) . '->' . $func[1];
615 $funcName = implode('::', $func);
617 } else if ($func instanceof \Closure) {
618 $funcName = 'Closure';
623 // verify that function to be invoked is in fact callable
624 if (!is_callable($func)) {
625 Logger::instance()->errorLog("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable");
628 PhpXmlRpc::$xmlrpcerr['server_error'],
629 PhpXmlRpc::$xmlrpcstr['server_error'] . ": no function matches method"
633 // If debug level is 3, we should catch all errors generated during
634 // processing of user function, and log them as part of response
635 if ($this->debug > 2) {
636 self::$_xmlrpcs_prev_ehandler = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
640 // Allow mixed-convention servers
641 if (is_object($req)) {
643 $r = call_user_func($func, $this, $req);
645 $r = call_user_func($func, $req);
647 if (!is_a($r, 'PhpXmlRpc\Response')) {
648 Logger::instance()->errorLog("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler does not return an xmlrpc response object but a " . gettype($r));
649 if (is_a($r, 'PhpXmlRpc\Value')) {
650 $r = new Response($r);
654 PhpXmlRpc::$xmlrpcerr['server_error'],
655 PhpXmlRpc::$xmlrpcstr['server_error'] . ": function does not return xmlrpc response object"
660 // call a 'plain php' function
662 array_unshift($params, $this);
663 $r = call_user_func_array($func, $params);
665 // 3rd API convention for method-handling functions: EPI-style
666 if ($this->functions_parameters_type == 'epivals') {
667 $r = call_user_func_array($func, array($methName, $params, $this->user_data));
668 // mimic EPI behaviour: if we get an array that looks like an error, make it
670 if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) {
671 $r = new Response(0, (integer)$r['faultCode'], (string)$r['faultString']);
673 // functions using EPI api should NOT return resp objects,
674 // so make sure we encode the return type correctly
675 $encoder = new Encoder();
676 $r = new Response($encoder->encode($r, array('extension_api')));
679 $r = call_user_func_array($func, $params);
682 // the return type can be either a Response object or a plain php value...
683 if (!is_a($r, '\PhpXmlRpc\Response')) {
684 // what should we assume here about automatic encoding of datetimes
685 // and php classes instances???
686 $encoder = new Encoder();
687 $r = new Response($encoder->encode($r, $this->phpvals_encoding_options));
690 } catch (\Exception $e) {
691 // (barring errors in the lib) an uncatched exception happened
692 // in the called function, we wrap it in a proper error-response
693 switch ($this->exception_handling) {
695 if ($this->debug > 2) {
696 if (self::$_xmlrpcs_prev_ehandler) {
697 set_error_handler(self::$_xmlrpcs_prev_ehandler);
699 restore_error_handler();
704 $r = new Response(0, $e->getCode(), $e->getMessage());
707 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
710 if ($this->debug > 2) {
711 // note: restore the error handler we found before calling the
712 // user func, even if it has been changed inside the func itself
713 if (self::$_xmlrpcs_prev_ehandler) {
714 set_error_handler(self::$_xmlrpcs_prev_ehandler);
716 restore_error_handler();
724 * Add a string to the 'internal debug message' (separate from 'user debug message').
726 * @param string $string
728 protected function debugmsg($string)
730 $this->debug_info .= $string . "\n";
734 * @param string $charsetEncoding
737 protected function xml_header($charsetEncoding = '')
739 if ($charsetEncoding != '') {
740 return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\"?" . ">\n";
742 return "<?xml version=\"1.0\"?" . ">\n";
747 * @param string $methName
750 protected function isSyscall($methName)
752 return (strpos($methName, "system.") === 0);
755 /* Functions that implement system.XXX methods of xmlrpc servers */
760 public function getSystemDispatchMap()
762 if (!$this->allow_system_funcs) {
767 'system.listMethods' => array(
768 'function' => 'PhpXmlRpc\Server::_xmlrpcs_listMethods',
769 // listMethods: signature was either a string, or nothing.
770 // The useless string variant has been removed
771 'signature' => array(array(Value::$xmlrpcArray)),
772 'docstring' => 'This method lists all the methods that the XML-RPC server knows how to dispatch',
773 'signature_docs' => array(array('list of method names')),
775 'system.methodHelp' => array(
776 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodHelp',
777 'signature' => array(array(Value::$xmlrpcString, Value::$xmlrpcString)),
778 'docstring' => 'Returns help text if defined for the method passed, otherwise returns an empty string',
779 'signature_docs' => array(array('method description', 'name of the method to be described')),
781 'system.methodSignature' => array(
782 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodSignature',
783 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcString)),
784 '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)',
785 'signature_docs' => array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')),
787 'system.multicall' => array(
788 'function' => 'PhpXmlRpc\Server::_xmlrpcs_multicall',
789 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcArray)),
790 'docstring' => 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details',
791 '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"')),
793 'system.getCapabilities' => array(
794 'function' => 'PhpXmlRpc\Server::_xmlrpcs_getCapabilities',
795 'signature' => array(array(Value::$xmlrpcStruct)),
796 'docstring' => 'This method lists all the capabilities that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to',
797 'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec')),
805 public function getCapabilities()
808 // xmlrpc spec: always supported
810 'specUrl' => 'http://www.xmlrpc.com/spec',
813 // if we support system.xxx functions, we always support multicall, too...
814 // Note that, as of 2006/09/17, the following URL does not respond anymore
815 'system.multicall' => array(
816 'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
819 // introspection: version 2! we support 'mixed', too
820 'introspection' => array(
821 'specUrl' => 'http://phpxmlrpc.sourceforge.net/doc-2/ch10.html',
827 if (PhpXmlRpc::$xmlrpc_null_extension) {
828 $outAr['nil'] = array(
829 'specUrl' => 'http://www.ontosys.com/xml-rpc/extensions.php',
838 * @param Server $server
839 * @param Request $req
842 public static function _xmlrpcs_getCapabilities($server, $req = null)
844 $encoder = new Encoder();
845 return new Response($encoder->encode($server->getCapabilities()));
849 * @param Server $server
850 * @param Request $req if called in plain php values mode, second param is missing
853 public static function _xmlrpcs_listMethods($server, $req = null)
856 foreach ($server->dmap as $key => $val) {
857 $outAr[] = new Value($key, 'string');
859 foreach ($server->getSystemDispatchMap() as $key => $val) {
860 $outAr[] = new Value($key, 'string');
863 return new Response(new Value($outAr, 'array'));
867 * @param Server $server
868 * @param Request $req
871 public static function _xmlrpcs_methodSignature($server, $req)
873 // let accept as parameter both an xmlrpc value or string
874 if (is_object($req)) {
875 $methName = $req->getParam(0);
876 $methName = $methName->scalarval();
880 if ($server->isSyscall($methName)) {
881 $dmap = $server->getSystemDispatchMap();
883 $dmap = $server->dmap;
885 if (isset($dmap[$methName])) {
886 if (isset($dmap[$methName]['signature'])) {
888 foreach ($dmap[$methName]['signature'] as $inSig) {
890 foreach ($inSig as $sig) {
891 $curSig[] = new Value($sig, 'string');
893 $sigs[] = new Value($curSig, 'array');
895 $r = new Response(new Value($sigs, 'array'));
897 // NB: according to the official docs, we should be returning a
898 // "none-array" here, which means not-an-array
899 $r = new Response(new Value('undef', 'string'));
902 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
909 * @param Server $server
910 * @param Request $req
913 public static function _xmlrpcs_methodHelp($server, $req)
915 // let accept as parameter both an xmlrpc value or string
916 if (is_object($req)) {
917 $methName = $req->getParam(0);
918 $methName = $methName->scalarval();
922 if ($server->isSyscall($methName)) {
923 $dmap = $server->getSystemDispatchMap();
925 $dmap = $server->dmap;
927 if (isset($dmap[$methName])) {
928 if (isset($dmap[$methName]['docstring'])) {
929 $r = new Response(new Value($dmap[$methName]['docstring'], 'string'));
931 $r = new Response(new Value('', 'string'));
934 $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
940 public static function _xmlrpcs_multicall_error($err)
942 if (is_string($err)) {
943 $str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
944 $code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
946 $code = $err->faultCode();
947 $str = $err->faultString();
950 $struct['faultCode'] = new Value($code, 'int');
951 $struct['faultString'] = new Value($str, 'string');
953 return new Value($struct, 'struct');
957 * @param Server $server
961 public static function _xmlrpcs_multicall_do_call($server, $call)
963 if ($call->kindOf() != 'struct') {
964 return static::_xmlrpcs_multicall_error('notstruct');
966 $methName = @$call['methodName'];
968 return static::_xmlrpcs_multicall_error('nomethod');
970 if ($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') {
971 return static::_xmlrpcs_multicall_error('notstring');
973 if ($methName->scalarval() == 'system.multicall') {
974 return static::_xmlrpcs_multicall_error('recursion');
977 $params = @$call['params'];
979 return static::_xmlrpcs_multicall_error('noparams');
981 if ($params->kindOf() != 'array') {
982 return static::_xmlrpcs_multicall_error('notarray');
985 $req = new Request($methName->scalarval());
986 foreach($params as $i => $param) {
987 if (!$req->addParam($param)) {
988 $i++; // for error message, we count params from 1
989 return static::_xmlrpcs_multicall_error(new Response(0,
990 PhpXmlRpc::$xmlrpcerr['incorrect_params'],
991 PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
995 $result = $server->execute($req);
997 if ($result->faultCode() != 0) {
998 return static::_xmlrpcs_multicall_error($result); // Method returned fault.
1001 return new Value(array($result->value()), 'array');
1005 * @param Server $server
1006 * @param Value $call
1009 public static function _xmlrpcs_multicall_do_call_phpvals($server, $call)
1011 if (!is_array($call)) {
1012 return static::_xmlrpcs_multicall_error('notstruct');
1014 if (!array_key_exists('methodName', $call)) {
1015 return static::_xmlrpcs_multicall_error('nomethod');
1017 if (!is_string($call['methodName'])) {
1018 return static::_xmlrpcs_multicall_error('notstring');
1020 if ($call['methodName'] == 'system.multicall') {
1021 return static::_xmlrpcs_multicall_error('recursion');
1023 if (!array_key_exists('params', $call)) {
1024 return static::_xmlrpcs_multicall_error('noparams');
1026 if (!is_array($call['params'])) {
1027 return static::_xmlrpcs_multicall_error('notarray');
1030 // this is a simplistic hack, since we might have received
1031 // base64 or datetime values, but they will be listed as strings here...
1033 $wrapper = new Wrapper();
1034 foreach ($call['params'] as $val) {
1035 // support EPI-encoded base64 and datetime values
1036 if ($val instanceof \stdClass && isset($val->xmlrpc_type)) {
1037 $pt[] = $val->xmlrpc_type == 'datetime' ? Value::$xmlrpcDateTime : $val->xmlrpc_type;
1039 $pt[] = $wrapper->php2XmlrpcType(gettype($val));
1043 $result = $server->execute($call['methodName'], $call['params'], $pt);
1045 if ($result->faultCode() != 0) {
1046 return static::_xmlrpcs_multicall_error($result); // Method returned fault.
1049 return new Value(array($result->value()), 'array');
1053 * @param Server $server
1054 * @param Request|array $req
1057 public static function _xmlrpcs_multicall($server, $req)
1060 // let accept a plain list of php parameters, beside a single xmlrpc msg object
1061 if (is_object($req)) {
1062 $calls = $req->getParam(0);
1063 foreach($calls as $call) {
1064 $result[] = static::_xmlrpcs_multicall_do_call($server, $call);
1067 $numCalls = count($req);
1068 for ($i = 0; $i < $numCalls; $i++) {
1069 $result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $req[$i]);
1073 return new Response(new Value($result, 'array'));
1077 * Error handler used to track errors that occur during server-side execution of PHP code.
1078 * This allows to report back to the client whether an internal error has occurred or not
1079 * using an xmlrpc response object, instead of letting the client deal with the html junk
1080 * that a PHP execution error on the server generally entails.
1082 * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.
1084 public static function _xmlrpcs_errorHandler($errCode, $errString, $filename = null, $lineNo = null, $context = null)
1086 // obey the @ protocol
1087 if (error_reporting() == 0) {
1091 //if($errCode != E_NOTICE && $errCode != E_WARNING && $errCode != E_USER_NOTICE && $errCode != E_USER_WARNING)
1092 if ($errCode != E_STRICT) {
1093 \PhpXmlRpc\Server::error_occurred($errString);
1095 // Try to avoid as much as possible disruption to the previous error handling
1096 // mechanism in place
1097 if (self::$_xmlrpcs_prev_ehandler == '') {
1098 // The previous error handler was the default: all we should do is log error
1099 // to the default error log (if level high enough)
1100 if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errCode)) {
1101 Logger::instance()->errorLog($errString);
1104 // Pass control on to previous error handler, trying to avoid loops...
1105 if (self::$_xmlrpcs_prev_ehandler != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
1106 if (is_array(self::$_xmlrpcs_prev_ehandler)) {
1107 // the following works both with static class methods and plain object methods as error handler
1108 call_user_func_array(self::$_xmlrpcs_prev_ehandler, array($errCode, $errString, $filename, $lineNo, $context));
1110 $method = self::$_xmlrpcs_prev_ehandler;
1111 $method($errCode, $errString, $filename, $lineNo, $context);