src/Server.php

   1 <?php
   2
   3 namespace PhpXmlRpc;
   4
   5 use PhpXmlRpc\Helper\XMLParser;
   6 use PhpXmlRpc\Helper\Charset;
   7
   8 class Server
   9 {
  10     /**
  11      * Array defining php functions exposed as xmlrpc methods by this server.
  12      */
  13     protected $dmap = array();
  14     /**
  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'
  18      */
  19     public $functions_parameters_type = 'xmlrpcvals';
  20     /**
  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
  25      */
  26     public $phpvals_encoding_options = array('auto_dates');
  27     /**
  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
  30      */
  31     public $debug = 1;
  32     /**
  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
  37      */
  38     public $exception_handling = 0;
  39     /**
  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.
  42      */
  43     public $compress_response = false;
  44     /**
  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
  47      */
  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();
  53     /**
  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)
  61      */
  62     public $response_charset_encoding = '';
  63     /**
  64      * Storage for internal debug info.
  65      */
  66     protected $debug_info = '';
  67     /**
  68      * Extra data passed at runtime to method handling functions. Used only by EPI layer
  69      */
  70     public $user_data = null;
  71
  72     protected static $_xmlrpc_debuginfo = '';
  73     protected static $_xmlrpcs_occurred_errors = '';
  74     public static $_xmlrpcs_prev_ehandler = '';
  75
  76     /**
  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
  79      */
  80     public function __construct($dispatchMap = null, $serviceNow = true)
  81     {
  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;
  87         }
  88
  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');
  91
  92         // dispMap is a dispatch array of methods
  93         // mapped to function names and signatures
  94         // if a method
  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)
 100             */
 101         if ($dispatchMap) {
 102             $this->dmap = $dispatchMap;
 103             if ($serviceNow) {
 104                 $this->service();
 105             }
 106         }
 107     }
 108
 109     /**
 110      * Set debug level of server.
 111      *
 112      * @param integer $level debug lvl: determines info added to xmlrpc responses (as xml comments)
 113      *                    0 = no debug info,
 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
 122      */
 123     public function setDebug($level)
 124     {
 125         $this->debug = $level;
 126     }
 127
 128     /**
 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.
 133      *
 134      * @param string $msg
 135      * @access public
 136      */
 137     public static function xmlrpc_debugmsg($msg)
 138     {
 139         static::$_xmlrpc_debuginfo .= $msg . "\n";
 140     }
 141
 142     public static function error_occurred($msg)
 143     {
 144         static::$_xmlrpcs_occurred_errors .= $msg . "\n";
 145     }
 146
 147     /**
 148      * Return a string with the serialized representation of all debug info.
 149      *
 150      * @param string $charsetEncoding the target charset encoding for the serialization
 151      *
 152      * @return string an XML comment (or two)
 153      */
 154     public function serializeDebug($charsetEncoding = '')
 155     {
 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
 161         $out = '';
 162         if ($this->debug_info != '') {
 163             $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n" . base64_encode($this->debug_info) . "\n-->\n";
 164         }
 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";
 170         }
 171
 172         return $out;
 173     }
 174
 175     /**
 176      * Execute the xmlrpc request, printing the response.
 177      *
 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
 180      *
 181      * @return Response the response object (usually not used by caller...)
 182      */
 183     public function service($data = null, $returnPayload = false)
 184     {
 185         if ($data === null) {
 186             $data = file_get_contents('php://input');
 187         }
 188         $rawData = $data;
 189
 190         // reset internal debug info
 191         $this->debug_info = '';
 192
 193         // Echo back what we received, before parsing it
 194         if ($this->debug > 1) {
 195             $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
 196         }
 197
 198         $r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
 199         if (!$r) {
 200             $r = $this->parseRequest($data, $reqCharset);
 201         }
 202
 203         // save full body of request into response, for more debugging usages
 204         $r->raw_data = $rawData;
 205
 206         if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors) {
 207             $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
 208                 static::$_xmlrpcs_occurred_errors . "+++END+++");
 209         }
 210
 211         $payload = $this->xml_header($respCharset);
 212         if ($this->debug > 0) {
 213             $payload = $payload . $this->serializeDebug($respCharset);
 214         }
 215
 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);
 220         }
 221         $payload = $payload . $r->payload;
 222
 223         if ($returnPayload) {
 224             return $payload;
 225         }
 226
 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");
 234
 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
 241             ) {
 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");
 250                 }
 251             }
 252
 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));
 257             }
 258         } else {
 259             error_log('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
 260         }
 261
 262         print $payload;
 263
 264         // return request, in case subclasses want it
 265         return $r;
 266     }
 267
 268     /**
 269      * Add a method to the dispatch map.
 270      *
 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)
 276      */
 277     public function add_to_map($methodName, $function, $sig = null, $doc = false, $sigDoc = false)
 278     {
 279         $this->dmap[$methodName] = array(
 280             'function' => $function,
 281             'docstring' => $doc,
 282         );
 283         if ($sig) {
 284             $this->dmap[$methodName]['signature'] = $sig;
 285         }
 286         if ($sigDoc) {
 287             $this->dmap[$methodName]['signature_docs'] = $sigDoc;
 288         }
 289     }
 290
 291     /**
 292      * Verify type and number of parameters received against a list of known signatures.
 293      *
 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
 296      *
 297      * @return array
 298      */
 299     protected function verifySignature($in, $sig)
 300     {
 301         // check each possible signature in turn
 302         if (is_object($in)) {
 303             $numParams = $in->getNumParams();
 304         } else {
 305             $numParams = count($in);
 306         }
 307         foreach ($sig as $cursig) {
 308             if (count($cursig) == $numParams + 1) {
 309                 $itsOK = 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();
 315                         } else {
 316                             $pt = $p->kindOf();
 317                         }
 318                     } else {
 319                         $pt = $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
 320                     }
 321
 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) {
 324                         $itsOK = 0;
 325                         $pno = $n + 1;
 326                         $wanted = $cursig[$n + 1];
 327                         $got = $pt;
 328                         break;
 329                     }
 330                 }
 331                 if ($itsOK) {
 332                     return array(1, '');
 333                 }
 334             }
 335         }
 336         if (isset($wanted)) {
 337             return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
 338         } else {
 339             return array(0, "No method signature matches number of parameters");
 340         }
 341     }
 342
 343     /**
 344      * Parse http headers received along with xmlrpc request. If needed, inflate request.
 345      *
 346      * @return mixed null on success or a Response
 347      */
 348     protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
 349     {
 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');
 354         }
 355
 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");
 361                 }
 362             }
 363         }
 364
 365         if (isset($_SERVER['HTTP_CONTENT_ENCODING'])) {
 366             $contentEncoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);
 367         } else {
 368             $contentEncoding = '';
 369         }
 370
 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)) {
 377                         $data = $degzdata;
 378                         if ($this->debug > 1) {
 379                             $this->debugmsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
 380                         }
 381                     } elseif ($contentEncoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
 382                         $data = $degzdata;
 383                         if ($this->debug > 1) {
 384                             $this->debugmsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
 385                         }
 386                     } else {
 387                         $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'], PhpXmlRpc::$xmlrpcstr['server_decompress_fail']);
 388
 389                         return $r;
 390                     }
 391                 } else {
 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']);
 394
 395                     return $r;
 396                 }
 397             }
 398         }
 399
 400         // check if client specified accepted charsets, and if we know how to fulfill
 401         // the request
 402         if ($this->response_charset_encoding == 'auto') {
 403             $respEncoding = '';
 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;
 415                             break;
 416                         }
 417                     }
 418                     if ($respEncoding) {
 419                         break;
 420                     }
 421                 }
 422             }
 423         } else {
 424             $respEncoding = $this->response_charset_encoding;
 425         }
 426
 427         if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
 428             $respCompression = $_SERVER['HTTP_ACCEPT_ENCODING'];
 429         } else {
 430             $respCompression = '';
 431         }
 432
 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'] : '',
 436             $data);
 437
 438         return;
 439     }
 440
 441     /**
 442      * Parse an xml chunk containing an xmlrpc request and execute the corresponding
 443      * php function registered with the server.
 444      *
 445      * @param string $data the xml request
 446      * @param string $reqEncoding (optional) the charset encoding of the xml request
 447      *
 448      * @return Response
 449      */
 450     public function parseRequest($data, $reqEncoding = '')
 451     {
 452         // decompose incoming XML into request structure
 453
 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);
 463                 } else {
 464                     if (extension_loaded('mbstring')) {
 465                         $data = mb_convert_encoding($data, 'UTF-8', $reqEncoding);
 466                     } else {
 467                         error_log('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $reqEncoding);
 468                     }
 469                 }
 470             }
 471         }
 472
 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');
 483         } else {
 484             xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, PhpXmlRpc::$xmlrpc_internalencoding);
 485         }
 486
 487         $xmlRpcParser = new XMLParser();
 488         xml_set_object($parser, $xmlRpcParser);
 489
 490         if ($this->functions_parameters_type != 'xmlrpcvals') {
 491             xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
 492         } else {
 493             xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
 494         }
 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
 499             $r = new Response(0,
 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);
 507             $r = new Response(0,
 508                 PhpXmlRpc::$xmlrpcerr['invalid_request'],
 509                 PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
 510         } else {
 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+++");
 519                 }
 520                 $r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
 521             } else {
 522                 // build a Request object with data parsed from xml
 523                 $m = new Request($xmlRpcParser->_xh['method']);
 524                 // now add parameters in
 525                 for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
 526                     $m->addParam($xmlRpcParser->_xh['params'][$i]);
 527                 }
 528
 529                 if ($this->debug > 1) {
 530                     $this->debugmsg("\n+++PARSED+++\n" . var_export($m, true) . "\n+++END+++");
 531                 }
 532                 $r = $this->execute($m);
 533             }
 534         }
 535
 536         return $r;
 537     }
 538
 539     /**
 540      * Execute a method invoked by the client, checking parameters used.
 541      *
 542      * @param mixed $m 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)
 545      *
 546      * @return Response
 547      *
 548      * @throws \Exception in case the executed method does throw an exception (and depending on )
 549      */
 550     protected function execute($m, $params = null, $paramTypes = null)
 551     {
 552         if (is_object($m)) {
 553             $methName = $m->method();
 554         } else {
 555             $methName = $m;
 556         }
 557         $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);
 558         $dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
 559
 560         if (!isset($dmap[$methName]['function'])) {
 561             // No such method
 562             return new Response(0,
 563                 PhpXmlRpc::$xmlrpcerr['unknown_method'],
 564                 PhpXmlRpc::$xmlrpcstr['unknown_method']);
 565         }
 566
 567         // Check signature
 568         if (isset($dmap[$methName]['signature'])) {
 569             $sig = $dmap[$methName]['signature'];
 570             if (is_object($m)) {
 571                 list($ok, $errStr) = $this->verifySignature($m, $sig);
 572             } else {
 573                 list($ok, $errStr) = $this->verifySignature($paramTypes, $sig);
 574             }
 575             if (!$ok) {
 576                 // Didn't match.
 577                 return new Response(
 578                     0,
 579                     PhpXmlRpc::$xmlrpcerr['incorrect_params'],
 580                     PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errstr}"
 581                 );
 582             }
 583         }
 584
 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);
 589         }
 590         // verify that function to be invoked is in fact callable
 591         if (!is_callable($func)) {
 592             error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler is not callable");
 593
 594             return new Response(
 595                 0,
 596                 PhpXmlRpc::$xmlrpcerr['server_error'],
 597                 PhpXmlRpc::$xmlrpcstr['server_error'] . ": no function matches method"
 598             );
 599         }
 600
 601         // If debug level is 3, we should catch all errors generated during
 602         // processing of user function, and log them as part of response
 603         if ($this->debug > 2) {
 604             $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
 605         }
 606         try {
 607             // Allow mixed-convention servers
 608             if (is_object($m)) {
 609                 if ($sysCall) {
 610                     $r = call_user_func($func, $this, $m);
 611                 } else {
 612                     $r = call_user_func($func, $m);
 613                 }
 614                 if (!is_a($r, 'PhpXmlRpc\Response')) {
 615                     error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler does not return an xmlrpc response object");
 616                     if (is_a($r, 'PhpXmlRpc\Value')) {
 617                         $r = new Response($r);
 618                     } else {
 619                         $r = new Response(
 620                             0,
 621                             PhpXmlRpc::$xmlrpcerr['server_error'],
 622                             PhpXmlRpc::$xmlrpcstr['server_error'] . ": function does not return xmlrpc response object"
 623                         );
 624                     }
 625                 }
 626             } else {
 627                 // call a 'plain php' function
 628                 if ($sysCall) {
 629                     array_unshift($params, $this);
 630                     $r = call_user_func_array($func, $params);
 631                 } else {
 632                     // 3rd API convention for method-handling functions: EPI-style
 633                     if ($this->functions_parameters_type == 'epivals') {
 634                         $r = call_user_func_array($func, array($methName, $params, $this->user_data));
 635                         // mimic EPI behaviour: if we get an array that looks like an error, make it
 636                         // an eror response
 637                         if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) {
 638                             $r = new Response(0, (integer)$r['faultCode'], (string)$r['faultString']);
 639                         } else {
 640                             // functions using EPI api should NOT return resp objects,
 641                             // so make sure we encode the return type correctly
 642                             $r = new Response(php_xmlrpc_encode($r, array('extension_api')));
 643                         }
 644                     } else {
 645                         $r = call_user_func_array($func, $params);
 646                     }
 647                 }
 648                 // the return type can be either a Response object or a plain php value...
 649                 if (!is_a($r, '\PhpXmlRpc\Response')) {
 650                     // what should we assume here about automatic encoding of datetimes
 651                     // and php classes instances???
 652                     $r = new Response(php_xmlrpc_encode($r, $this->phpvals_encoding_options));
 653                 }
 654             }
 655         } catch (\Exception $e) {
 656             // (barring errors in the lib) an uncatched exception happened
 657             // in the called function, we wrap it in a proper error-response
 658             switch ($this->exception_handling) {
 659                 case 2:
 660                     throw $e;
 661                     break;
 662                 case 1:
 663                     $r = new Response(0, $e->getCode(), $e->getMessage());
 664                     break;
 665                 default:
 666                     $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
 667             }
 668         }
 669         if ($this->debug > 2) {
 670             // note: restore the error handler we found before calling the
 671             // user func, even if it has been changed inside the func itself
 672             if ($GLOBALS['_xmlrpcs_prev_ehandler']) {
 673                 set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);
 674             } else {
 675                 restore_error_handler();
 676             }
 677         }
 678
 679         return $r;
 680     }
 681
 682     /**
 683      * add a string to the 'internal debug message' (separate from 'user debug message').
 684      *
 685      * @param string $string
 686      */
 687     protected function debugmsg($string)
 688     {
 689         $this->debug_info .= $string . "\n";
 690     }
 691
 692     protected function xml_header($charsetEncoding = '')
 693     {
 694         if ($charsetEncoding != '') {
 695             return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\"?" . ">\n";
 696         } else {
 697             return "<?xml version=\"1.0\"?" . ">\n";
 698         }
 699     }
 700
 701     /* Functions that implement system.XXX methods of xmlrpc servers */
 702
 703     public function getSystemDispatchMap()
 704     {
 705         return array(
 706             'system.listMethods' => array(
 707                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_listMethods',
 708                 // listMethods: signature was either a string, or nothing.
 709                 // The useless string variant has been removed
 710                 'signature' => array(array(Value::$xmlrpcArray)),
 711                 'docstring' => 'This method lists all the methods that the XML-RPC server knows how to dispatch',
 712                 'signature_docs' => array(array('list of method names')),
 713             ),
 714             'system.methodHelp' => array(
 715                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodHelp',
 716                 'signature' => array(array(Value::$xmlrpcString, Value::$xmlrpcString)),
 717                 'docstring' => 'Returns help text if defined for the method passed, otherwise returns an empty string',
 718                 'signature_docs' => array(array('method description', 'name of the method to be described')),
 719             ),
 720             'system.methodSignature' => array(
 721                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodSignature',
 722                 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcString)),
 723                 '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)',
 724                 'signature_docs' => array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')),
 725             ),
 726             'system.multicall' => array(
 727                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_multicall',
 728                 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcArray)),
 729                 'docstring' => 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details',
 730                 '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"')),
 731             ),
 732             'system.getCapabilities' => array(
 733                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_getCapabilities',
 734                 'signature' => array(array(Value::$xmlrpcStruct)),
 735                 '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',
 736                 'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec')),
 737             ),
 738         );
 739     }
 740
 741     public static function _xmlrpcs_getCapabilities($server, $m = null)
 742     {
 743         $outAr = array(
 744             // xmlrpc spec: always supported
 745             'xmlrpc' => new Value(array(
 746                 'specUrl' => new Value('http://www.xmlrpc.com/spec', 'string'),
 747                 'specVersion' => new Value(1, 'int'),
 748             ), 'struct'),
 749             // if we support system.xxx functions, we always support multicall, too...
 750             // Note that, as of 2006/09/17, the following URL does not respond anymore
 751             'system.multicall' => new Value(array(
 752                 'specUrl' => new Value('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),
 753                 'specVersion' => new Value(1, 'int'),
 754             ), 'struct'),
 755             // introspection: version 2! we support 'mixed', too
 756             'introspection' => new Value(array(
 757                 'specUrl' => new Value('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),
 758                 'specVersion' => new Value(2, 'int'),
 759             ), 'struct'),
 760         );
 761
 762         // NIL extension
 763         if (PhpXmlRpc::$xmlrpc_null_extension) {
 764             $outAr['nil'] = new Value(array(
 765                 'specUrl' => new Value('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),
 766                 'specVersion' => new Value(1, 'int'),
 767             ), 'struct');
 768         }
 769
 770         return new Response(new Value($outAr, 'struct'));
 771     }
 772
 773     public static function _xmlrpcs_listMethods($server, $m = null) // if called in plain php values mode, second param is missing
 774     {
 775         $outAr = array();
 776         foreach ($server->dmap as $key => $val) {
 777             $outAr[] = new Value($key, 'string');
 778         }
 779         if ($server->allow_system_funcs) {
 780             foreach ($server->getSystemDispatchMap() as $key => $val) {
 781                 $outAr[] = new Value($key, 'string');
 782             }
 783         }
 784
 785         return new Response(new Value($outAr, 'array'));
 786     }
 787
 788     public static function _xmlrpcs_methodSignature($server, $m)
 789     {
 790         // let accept as parameter both an xmlrpc value or string
 791         if (is_object($m)) {
 792             $methName = $m->getParam(0);
 793             $methName = $methName->scalarval();
 794         } else {
 795             $methName = $m;
 796         }
 797         if (strpos($methName, "system.") === 0) {
 798             $dmap = $server->getSystemDispatchMap();
 799         } else {
 800             $dmap = $server->dmap;
 801         }
 802         if (isset($dmap[$methName])) {
 803             if (isset($dmap[$methName]['signature'])) {
 804                 $sigs = array();
 805                 foreach ($dmap[$methName]['signature'] as $inSig) {
 806                     $cursig = array();
 807                     foreach ($inSig as $sig) {
 808                         $cursig[] = new Value($sig, 'string');
 809                     }
 810                     $sigs[] = new Value($cursig, 'array');
 811                 }
 812                 $r = new Response(new Value($sigs, 'array'));
 813             } else {
 814                 // NB: according to the official docs, we should be returning a
 815                 // "none-array" here, which means not-an-array
 816                 $r = new Response(new Value('undef', 'string'));
 817             }
 818         } else {
 819             $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
 820         }
 821
 822         return $r;
 823     }
 824
 825     public static function _xmlrpcs_methodHelp($server, $m)
 826     {
 827         // let accept as parameter both an xmlrpc value or string
 828         if (is_object($m)) {
 829             $methName = $m->getParam(0);
 830             $methName = $methName->scalarval();
 831         } else {
 832             $methName = $m;
 833         }
 834         if (strpos($methName, "system.") === 0) {
 835             $dmap = $server->getSystemDispatchMap();
 836         } else {
 837             $dmap = $server->dmap;
 838         }
 839         if (isset($dmap[$methName])) {
 840             if (isset($dmap[$methName]['docstring'])) {
 841                 $r = new Response(new Value($dmap[$methName]['docstring']), 'string');
 842             } else {
 843                 $r = new Response(new Value('', 'string'));
 844             }
 845         } else {
 846             $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
 847         }
 848
 849         return $r;
 850     }
 851
 852     public static function _xmlrpcs_multicall_error($err)
 853     {
 854         if (is_string($err)) {
 855             $str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
 856             $code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
 857         } else {
 858             $code = $err->faultCode();
 859             $str = $err->faultString();
 860         }
 861         $struct = array();
 862         $struct['faultCode'] = new Value($code, 'int');
 863         $struct['faultString'] = new Value($str, 'string');
 864
 865         return new Value($struct, 'struct');
 866     }
 867
 868     public static function _xmlrpcs_multicall_do_call($server, $call)
 869     {
 870         if ($call->kindOf() != 'struct') {
 871             return static::_xmlrpcs_multicall_error('notstruct');
 872         }
 873         $methName = @$call->structmem('methodName');
 874         if (!$methName) {
 875             return static::_xmlrpcs_multicall_error('nomethod');
 876         }
 877         if ($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') {
 878             return static::_xmlrpcs_multicall_error('notstring');
 879         }
 880         if ($methName->scalarval() == 'system.multicall') {
 881             return static::_xmlrpcs_multicall_error('recursion');
 882         }
 883
 884         $params = @$call->structmem('params');
 885         if (!$params) {
 886             return static::_xmlrpcs_multicall_error('noparams');
 887         }
 888         if ($params->kindOf() != 'array') {
 889             return static::_xmlrpcs_multicall_error('notarray');
 890         }
 891         $numParams = $params->arraysize();
 892
 893         $msg = new Request($methName->scalarval());
 894         for ($i = 0; $i < $numParams; $i++) {
 895             if (!$msg->addParam($params->arraymem($i))) {
 896                 $i++;
 897
 898                 return static::_xmlrpcs_multicall_error(new Response(0,
 899                     PhpXmlRpc::$xmlrpcerr['incorrect_params'],
 900                     PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
 901             }
 902         }
 903
 904         $result = $server->execute($msg);
 905
 906         if ($result->faultCode() != 0) {
 907             return static::_xmlrpcs_multicall_error($result); // Method returned fault.
 908         }
 909
 910         return new Value(array($result->value()), 'array');
 911     }
 912
 913     public static function _xmlrpcs_multicall_do_call_phpvals($server, $call)
 914     {
 915         if (!is_array($call)) {
 916             return static::_xmlrpcs_multicall_error('notstruct');
 917         }
 918         if (!array_key_exists('methodName', $call)) {
 919             return static::_xmlrpcs_multicall_error('nomethod');
 920         }
 921         if (!is_string($call['methodName'])) {
 922             return static::_xmlrpcs_multicall_error('notstring');
 923         }
 924         if ($call['methodName'] == 'system.multicall') {
 925             return static::_xmlrpcs_multicall_error('recursion');
 926         }
 927         if (!array_key_exists('params', $call)) {
 928             return static::_xmlrpcs_multicall_error('noparams');
 929         }
 930         if (!is_array($call['params'])) {
 931             return static::_xmlrpcs_multicall_error('notarray');
 932         }
 933
 934         // this is a real dirty and simplistic hack, since we might have received a
 935         // base64 or datetime values, but they will be listed as strings here...
 936         $numParams = count($call['params']);
 937         $pt = array();
 938         $wrapper = new Wrapper();
 939         foreach ($call['params'] as $val) {
 940             $pt[] = $wrapper->php_2_xmlrpc_type(gettype($val));
 941         }
 942
 943         $result = $server->execute($call['methodName'], $call['params'], $pt);
 944
 945         if ($result->faultCode() != 0) {
 946             return static::_xmlrpcs_multicall_error($result); // Method returned fault.
 947         }
 948
 949         return new Value(array($result->value()), 'array');
 950     }
 951
 952     public static function _xmlrpcs_multicall($server, $m)
 953     {
 954         $result = array();
 955         // let accept a plain list of php parameters, beside a single xmlrpc msg object
 956         if (is_object($m)) {
 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);
 962             }
 963         } else {
 964             $numCalls = count($m);
 965             for ($i = 0; $i < $numCalls; $i++) {
 966                 $result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $m[$i]);
 967             }
 968         }
 969
 970         return new Response(new Value($result, 'array'));
 971     }
 972
 973     /**
 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.
 978      *
 979      * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.
 980      */
 981     public static function _xmlrpcs_errorHandler($errCode, $errString, $filename = null, $lineNo = null, $context = null)
 982     {
 983         // obey the @ protocol
 984         if (error_reporting() == 0) {
 985             return;
 986         }
 987
 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);
 991         }
 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);
 999             }
1000         } else {
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));
1006                 } else {
1007                     $GLOBALS['_xmlrpcs_prev_ehandler']($errCode, $errString, $filename, $lineno, $context);
1008                 }
1009             }
1010         }
1011     }
1012 }