src/Server.php

   1 <?php
   2
   3 namespace PhpXmlRpc;
   4
   5 use PhpXmlRpc\Helper\Logger;
   6 use PhpXmlRpc\Helper\Charset;
   7 use PhpXmlRpc\Helper\XMLParser;
   8
   9 /**
  10  * Allows effortless implementation of XML-RPC servers
  11  */
  12 class Server
  13 {
  14     /**
  15      * Array defining php functions exposed as xmlrpc methods by this server.
  16      */
  17     protected $dmap = array();
  18
  19     /**
  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'
  23      */
  24     public $functions_parameters_type = 'xmlrpcvals';
  25
  26     /**
  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
  31      */
  32     public $phpvals_encoding_options = array('auto_dates');
  33
  34     /**
  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
  37      */
  38     public $debug = 1;
  39
  40     /**
  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
  45      */
  46     public $exception_handling = 0;
  47
  48     /**
  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.
  52      */
  53     public $compress_response = false;
  54
  55     /**
  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
  58      */
  59     public $accepted_compression = array();
  60
  61     /// Shall we serve calls to system.* methods?
  62     public $allow_system_funcs = true;
  63
  64     /**
  65      * List of charset encodings natively accepted for requests.
  66      * Set at constructor time.
  67      * UNUSED so far...
  68      */
  69     public $accepted_charset_encodings = array();
  70
  71     /**
  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)
  79      */
  80     public $response_charset_encoding = '';
  81
  82     /**
  83      * Storage for internal debug info.
  84      */
  85     protected $debug_info = '';
  86
  87     /**
  88      * Extra data passed at runtime to method handling functions. Used only by EPI layer
  89      */
  90     public $user_data = null;
  91
  92     protected static $_xmlrpc_debuginfo = '';
  93     protected static $_xmlrpcs_occurred_errors = '';
  94     protected static $_xmlrpcs_prev_ehandler = '';
  95
  96     /**
  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
  99      */
 100     public function __construct($dispatchMap = null, $serviceNow = true)
 101     {
 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;
 107         }
 108
 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');
 111
 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)
 117         */
 118         if ($dispatchMap) {
 119             $this->dmap = $dispatchMap;
 120             if ($serviceNow) {
 121                 $this->service();
 122             }
 123         }
 124     }
 125
 126     /**
 127      * Set debug level of server.
 128      *
 129      * @param integer $level debug lvl: determines info added to xmlrpc responses (as xml comments)
 130      *                    0 = no debug info,
 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
 139      */
 140     public function setDebug($level)
 141     {
 142         $this->debug = $level;
 143     }
 144
 145     /**
 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
 148      * character set.
 149      *
 150      * @param string $msg
 151      * @access public
 152      */
 153     public static function xmlrpc_debugmsg($msg)
 154     {
 155         static::$_xmlrpc_debuginfo .= $msg . "\n";
 156     }
 157
 158     /**
 159      * @param string $msg
 160      */
 161     public static function error_occurred($msg)
 162     {
 163         static::$_xmlrpcs_occurred_errors .= $msg . "\n";
 164     }
 165
 166     /**
 167      * Return a string with the serialized representation of all debug info.
 168      *
 169      * @param string $charsetEncoding the target charset encoding for the serialization
 170      *
 171      * @return string an XML comment (or two)
 172      */
 173     public function serializeDebug($charsetEncoding = '')
 174     {
 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
 180         $out = '';
 181         if ($this->debug_info != '') {
 182             $out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n" . base64_encode($this->debug_info) . "\n-->\n";
 183         }
 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";
 189         }
 190
 191         return $out;
 192     }
 193
 194     /**
 195      * Execute the xmlrpc request, printing the response.
 196      *
 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
 199      *
 200      * @return Response|string the response object (usually not used by caller...) or its xml serialization
 201      *
 202      * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
 203      */
 204     public function service($data = null, $returnPayload = false)
 205     {
 206         if ($data === null) {
 207             $data = file_get_contents('php://input');
 208         }
 209         $rawData = $data;
 210
 211         // reset internal debug info
 212         $this->debug_info = '';
 213
 214         // Save what we received, before parsing it
 215         if ($this->debug > 1) {
 216             $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
 217         }
 218
 219         $r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
 220         if (!$r) {
 221             // this actually executes the request
 222             $r = $this->parseRequest($data, $reqCharset);
 223         }
 224
 225         // save full body of request into response, for more debugging usages
 226         $r->raw_data = $rawData;
 227
 228         if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors) {
 229             $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
 230                 static::$_xmlrpcs_occurred_errors . "+++END+++");
 231         }
 232
 233         $payload = $this->xml_header($respCharset);
 234         if ($this->debug > 0) {
 235             $payload = $payload . $this->serializeDebug($respCharset);
 236         }
 237
 238         // Do not create response serialization if it has already happened. Helps building json magic
 239         if (empty($r->payload)) {
 240             $r->serialize($respCharset);
 241         }
 242         $payload = $payload . $r->payload;
 243
 244         if ($returnPayload) {
 245             return $payload;
 246         }
 247
 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");
 255
 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
 262             ) {
 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");
 271                 }
 272             }
 273
 274             // do not output content-length header if php is compressing output for us:
 275             // it will mess up measurements
 276             if ($phpNoSelfCompress) {
 277                 header('Content-Length: ' . (int)strlen($payload));
 278             }
 279         } else {
 280             Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
 281         }
 282
 283         print $payload;
 284
 285         // return request, in case subclasses want it
 286         return $r;
 287     }
 288
 289     /**
 290      * Add a method to the dispatch map.
 291      *
 292      * @param string $methodName the name with which the method will be made available
 293      * @param string $function the php function that will get invoked
 294      * @param array $sig the array of valid method signatures
 295      * @param string $doc method documentation
 296      * @param array $sigDoc the array of valid method signatures docs (one string per param, one for return type)
 297      */
 298     public function add_to_map($methodName, $function, $sig = null, $doc = false, $sigDoc = false)
 299     {
 300         $this->dmap[$methodName] = array(
 301             'function' => $function,
 302             'docstring' => $doc,
 303         );
 304         if ($sig) {
 305             $this->dmap[$methodName]['signature'] = $sig;
 306         }
 307         if ($sigDoc) {
 308             $this->dmap[$methodName]['signature_docs'] = $sigDoc;
 309         }
 310     }
 311
 312     /**
 313      * Verify type and number of parameters received against a list of known signatures.
 314      *
 315      * @param array|Request $in array of either xmlrpc value objects or xmlrpc type definitions
 316      * @param array $sigs array of known signatures to match against
 317      *
 318      * @return array
 319      */
 320     protected function verifySignature($in, $sigs)
 321     {
 322         // check each possible signature in turn
 323         if (is_object($in)) {
 324             $numParams = $in->getNumParams();
 325         } else {
 326             $numParams = count($in);
 327         }
 328         foreach ($sigs as $curSig) {
 329             if (count($curSig) == $numParams + 1) {
 330                 $itsOK = 1;
 331                 for ($n = 0; $n < $numParams; $n++) {
 332                     if (is_object($in)) {
 333                         $p = $in->getParam($n);
 334                         if ($p->kindOf() == 'scalar') {
 335                             $pt = $p->scalartyp();
 336                         } else {
 337                             $pt = $p->kindOf();
 338                         }
 339                     } else {
 340                         $pt = ($in[$n] == 'i4') ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
 341                     }
 342
 343                     // param index is $n+1, as first member of sig is return type
 344                     if ($pt != $curSig[$n + 1] && $curSig[$n + 1] != Value::$xmlrpcValue) {
 345                         $itsOK = 0;
 346                         $pno = $n + 1;
 347                         $wanted = $curSig[$n + 1];
 348                         $got = $pt;
 349                         break;
 350                     }
 351                 }
 352                 if ($itsOK) {
 353                     return array(1, '');
 354                 }
 355             }
 356         }
 357         if (isset($wanted)) {
 358             return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
 359         } else {
 360             return array(0, "No method signature matches number of parameters");
 361         }
 362     }
 363
 364     /**
 365      * Parse http headers received along with xmlrpc request. If needed, inflate request.
 366      *
 367      * @return mixed Response|null on success or an error Response
 368      */
 369     protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
 370     {
 371         // check if $_SERVER is populated: it might have been disabled via ini file
 372         // (this is true even when in CLI mode)
 373         if (count($_SERVER) == 0) {
 374             Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': cannot parse request headers as $_SERVER is not populated');
 375         }
 376
 377         if ($this->debug > 1) {
 378             if (function_exists('getallheaders')) {
 379                 $this->debugmsg(''); // empty line
 380                 foreach (getallheaders() as $name => $val) {
 381                     $this->debugmsg("HEADER: $name: $val");
 382                 }
 383             }
 384         }
 385
 386         if (isset($_SERVER['HTTP_CONTENT_ENCODING'])) {
 387             $contentEncoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);
 388         } else {
 389             $contentEncoding = '';
 390         }
 391
 392         // check if request body has been compressed and decompress it
 393         if ($contentEncoding != '' && strlen($data)) {
 394             if ($contentEncoding == 'deflate' || $contentEncoding == 'gzip') {
 395                 // if decoding works, use it. else assume data wasn't gzencoded
 396                 if (function_exists('gzinflate') && in_array($contentEncoding, $this->accepted_compression)) {
 397                     if ($contentEncoding == 'deflate' && $degzdata = @gzuncompress($data)) {
 398                         $data = $degzdata;
 399                         if ($this->debug > 1) {
 400                             $this->debugmsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
 401                         }
 402                     } elseif ($contentEncoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
 403                         $data = $degzdata;
 404                         if ($this->debug > 1) {
 405                             $this->debugmsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
 406                         }
 407                     } else {
 408                         $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'], PhpXmlRpc::$xmlrpcstr['server_decompress_fail']);
 409
 410                         return $r;
 411                     }
 412                 } else {
 413                     $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'], PhpXmlRpc::$xmlrpcstr['server_cannot_decompress']);
 414
 415                     return $r;
 416                 }
 417             }
 418         }
 419
 420         // check if client specified accepted charsets, and if we know how to fulfill
 421         // the request
 422         if ($this->response_charset_encoding == 'auto') {
 423             $respEncoding = '';
 424             if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
 425                 // here we should check if we can match the client-requested encoding
 426                 // with the encodings we know we can generate.
 427                 /// @todo we should parse q=0.x preferences instead of getting first charset specified...
 428                 $clientAcceptedCharsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));
 429                 // Give preference to internal encoding
 430                 $knownCharsets = array(PhpXmlRpc::$xmlrpc_internalencoding, 'UTF-8', 'ISO-8859-1', 'US-ASCII');
 431                 foreach ($knownCharsets as $charset) {
 432                     foreach ($clientAcceptedCharsets as $accepted) {
 433                         if (strpos($accepted, $charset) === 0) {
 434                             $respEncoding = $charset;
 435                             break;
 436                         }
 437                     }
 438                     if ($respEncoding) {
 439                         break;
 440                     }
 441                 }
 442             }
 443         } else {
 444             $respEncoding = $this->response_charset_encoding;
 445         }
 446
 447         if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
 448             $respCompression = $_SERVER['HTTP_ACCEPT_ENCODING'];
 449         } else {
 450             $respCompression = '';
 451         }
 452
 453         // 'guestimate' request encoding
 454         /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???
 455         $reqEncoding = XMLParser::guessEncoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',
 456             $data);
 457
 458         return null;
 459     }
 460
 461     /**
 462      * Parse an xml chunk containing an xmlrpc request and execute the corresponding
 463      * php function registered with the server.
 464      *
 465      * @param string $data the xml request
 466      * @param string $reqEncoding (optional) the charset encoding of the xml request
 467      *
 468      * @return Response
 469      *
 470      * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
 471      */
 472     public function parseRequest($data, $reqEncoding = '')
 473     {
 474         // decompose incoming XML into request structure
 475
 476         if ($reqEncoding != '') {
 477             // Since parsing will fail if charset is not specified in the xml prologue,
 478             // the encoding is not UTF8 and there are non-ascii chars in the text, we try to work round that...
 479             // The following code might be better for mb_string enabled installs, but
 480             // makes the lib about 200% slower...
 481             //if (!is_valid_charset($reqEncoding, array('UTF-8')))
 482             if (!in_array($reqEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($data)) {
 483                 if ($reqEncoding == 'ISO-8859-1') {
 484                     $data = utf8_encode($data);
 485                 } else {
 486                     if (extension_loaded('mbstring')) {
 487                         $data = mb_convert_encoding($data, 'UTF-8', $reqEncoding);
 488                     } else {
 489                         Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $reqEncoding);
 490                     }
 491                 }
 492             }
 493         }
 494
 495         // PHP internally might use ISO-8859-1, so we have to tell the xml parser to give us back data in the expected charset.
 496         // What if internal encoding is not in one of the 3 allowed? We use the broadest one, ie. utf8
 497         // This allows to send data which is native in various charset,
 498         // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
 499         if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
 500             $options = array(XML_OPTION_TARGET_ENCODING => 'UTF-8');
 501         } else {
 502             $options = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding);
 503         }
 504
 505         $xmlRpcParser = new XMLParser($options);
 506         $xmlRpcParser->parse($data, $this->functions_parameters_type, XMLParser::ACCEPT_REQUEST);
 507         if ($xmlRpcParser->_xh['isf'] > 2) {
 508             // (BC) we return XML error as a faultCode
 509             preg_match('/^XML error ([0-9]+)/', $xmlRpcParser->_xh['isf_reason'], $matches);
 510             $r = new Response(0,
 511                 PhpXmlRpc::$xmlrpcerrxml + $matches[1],
 512                 $xmlRpcParser->_xh['isf_reason']);
 513         } elseif ($xmlRpcParser->_xh['isf']) {
 514             $r = new Response(0,
 515                 PhpXmlRpc::$xmlrpcerr['invalid_request'],
 516                 PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
 517         } else {
 518             // small layering violation in favor of speed and memory usage:
 519             // we should allow the 'execute' method handle this, but in the
 520             // most common scenario (xmlrpc values type server with some methods
 521             // registered as phpvals) that would mean a useless encode+decode pass
 522             if ($this->functions_parameters_type != 'xmlrpcvals' ||
 523                 (isset($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type']) &&
 524                     ($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type'] == 'phpvals')
 525                 )
 526             ) {
 527                 if ($this->debug > 1) {
 528                     $this->debugmsg("\n+++PARSED+++\n" . var_export($xmlRpcParser->_xh['params'], true) . "\n+++END+++");
 529                 }
 530                 $r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
 531             } else {
 532                 // build a Request object with data parsed from xml
 533                 $req = new Request($xmlRpcParser->_xh['method']);
 534                 // now add parameters in
 535                 for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
 536                     $req->addParam($xmlRpcParser->_xh['params'][$i]);
 537                 }
 538
 539                 if ($this->debug > 1) {
 540                     $this->debugmsg("\n+++PARSED+++\n" . var_export($req, true) . "\n+++END+++");
 541                 }
 542                 $r = $this->execute($req);
 543             }
 544         }
 545
 546         return $r;
 547     }
 548
 549     /**
 550      * Execute a method invoked by the client, checking parameters used.
 551      *
 552      * @param mixed $req either a Request obj or a method name
 553      * @param array $params array with method parameters as php types (if m is method name only)
 554      * @param array $paramTypes array with xmlrpc types of method parameters (if m is method name only)
 555      *
 556      * @return Response
 557      *
 558      * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
 559      */
 560     protected function execute($req, $params = null, $paramTypes = null)
 561     {
 562         static::$_xmlrpcs_occurred_errors = '';
 563         static::$_xmlrpc_debuginfo = '';
 564
 565         if (is_object($req)) {
 566             $methName = $req->method();
 567         } else {
 568             $methName = $req;
 569         }
 570         $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);
 571         $dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
 572
 573         if (!isset($dmap[$methName]['function'])) {
 574             // No such method
 575             return new Response(0,
 576                 PhpXmlRpc::$xmlrpcerr['unknown_method'],
 577                 PhpXmlRpc::$xmlrpcstr['unknown_method']);
 578         }
 579
 580         // Check signature
 581         if (isset($dmap[$methName]['signature'])) {
 582             $sig = $dmap[$methName]['signature'];
 583             if (is_object($req)) {
 584                 list($ok, $errStr) = $this->verifySignature($req, $sig);
 585             } else {
 586                 list($ok, $errStr) = $this->verifySignature($paramTypes, $sig);
 587             }
 588             if (!$ok) {
 589                 // Didn't match.
 590                 return new Response(
 591                     0,
 592                     PhpXmlRpc::$xmlrpcerr['incorrect_params'],
 593                     PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errStr}"
 594                 );
 595             }
 596         }
 597
 598         $func = $dmap[$methName]['function'];
 599         // let the 'class::function' syntax be accepted in dispatch maps
 600         if (is_string($func) && strpos($func, '::')) {
 601             $func = explode('::', $func);
 602         }
 603
 604         if (is_array($func)) {
 605             if (is_object($func[0])) {
 606                 $funcName = get_class($func[0]) . '->' . $func[1];
 607             } else {
 608                 $funcName = implode('::', $func);
 609             }
 610         } else if ($func instanceof \Closure) {
 611             $funcName = 'Closure';
 612         } else {
 613             $funcName = $func;
 614         }
 615
 616         // verify that function to be invoked is in fact callable
 617         if (!is_callable($func)) {
 618             Logger::instance()->errorLog("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable");
 619             return new Response(
 620                 0,
 621                 PhpXmlRpc::$xmlrpcerr['server_error'],
 622                 PhpXmlRpc::$xmlrpcstr['server_error'] . ": no function matches method"
 623             );
 624         }
 625
 626         // If debug level is 3, we should catch all errors generated during
 627         // processing of user function, and log them as part of response
 628         if ($this->debug > 2) {
 629             self::$_xmlrpcs_prev_ehandler = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
 630         }
 631
 632         try {
 633             // Allow mixed-convention servers
 634             if (is_object($req)) {
 635                 if ($sysCall) {
 636                     $r = call_user_func($func, $this, $req);
 637                 } else {
 638                     $r = call_user_func($func, $req);
 639                 }
 640                 if (!is_a($r, 'PhpXmlRpc\Response')) {
 641                     Logger::instance()->errorLog("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler does not return an xmlrpc response object but a " . gettype($r));
 642                     if (is_a($r, 'PhpXmlRpc\Value')) {
 643                         $r = new Response($r);
 644                     } else {
 645                         $r = new Response(
 646                             0,
 647                             PhpXmlRpc::$xmlrpcerr['server_error'],
 648                             PhpXmlRpc::$xmlrpcstr['server_error'] . ": function does not return xmlrpc response object"
 649                         );
 650                     }
 651                 }
 652             } else {
 653                 // call a 'plain php' function
 654                 if ($sysCall) {
 655                     array_unshift($params, $this);
 656                     $r = call_user_func_array($func, $params);
 657                 } else {
 658                     // 3rd API convention for method-handling functions: EPI-style
 659                     if ($this->functions_parameters_type == 'epivals') {
 660                         $r = call_user_func_array($func, array($methName, $params, $this->user_data));
 661                         // mimic EPI behaviour: if we get an array that looks like an error, make it
 662                         // an eror response
 663                         if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) {
 664                             $r = new Response(0, (integer)$r['faultCode'], (string)$r['faultString']);
 665                         } else {
 666                             // functions using EPI api should NOT return resp objects,
 667                             // so make sure we encode the return type correctly
 668                             $encoder = new Encoder();
 669                             $r = new Response($encoder->encode($r, array('extension_api')));
 670                         }
 671                     } else {
 672                         $r = call_user_func_array($func, $params);
 673                     }
 674                 }
 675                 // the return type can be either a Response object or a plain php value...
 676                 if (!is_a($r, '\PhpXmlRpc\Response')) {
 677                     // what should we assume here about automatic encoding of datetimes
 678                     // and php classes instances???
 679                     $encoder = new Encoder();
 680                     $r = new Response($encoder->encode($r, $this->phpvals_encoding_options));
 681                 }
 682             }
 683         } catch (\Exception $e) {
 684             // (barring errors in the lib) an uncatched exception happened
 685             // in the called function, we wrap it in a proper error-response
 686             switch ($this->exception_handling) {
 687                 case 2:
 688                     if ($this->debug > 2) {
 689                         if (self::$_xmlrpcs_prev_ehandler) {
 690                             set_error_handler(self::$_xmlrpcs_prev_ehandler);
 691                         } else {
 692                             restore_error_handler();
 693                         }
 694                     }
 695                     throw $e;
 696                     break;
 697                 case 1:
 698                     $r = new Response(0, $e->getCode(), $e->getMessage());
 699                     break;
 700                 default:
 701                     $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
 702             }
 703         }
 704         if ($this->debug > 2) {
 705             // note: restore the error handler we found before calling the
 706             // user func, even if it has been changed inside the func itself
 707             if (self::$_xmlrpcs_prev_ehandler) {
 708                 set_error_handler(self::$_xmlrpcs_prev_ehandler);
 709             } else {
 710                 restore_error_handler();
 711             }
 712         }
 713
 714         return $r;
 715     }
 716
 717     /**
 718      * Add a string to the 'internal debug message' (separate from 'user debug message').
 719      *
 720      * @param string $string
 721      */
 722     protected function debugmsg($string)
 723     {
 724         $this->debug_info .= $string . "\n";
 725     }
 726
 727     /**
 728      * @param string $charsetEncoding
 729      * @return string
 730      */
 731     protected function xml_header($charsetEncoding = '')
 732     {
 733         if ($charsetEncoding != '') {
 734             return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\"?" . ">\n";
 735         } else {
 736             return "<?xml version=\"1.0\"?" . ">\n";
 737         }
 738     }
 739
 740     /* Functions that implement system.XXX methods of xmlrpc servers */
 741
 742     /**
 743      * @return array
 744      */
 745     public function getSystemDispatchMap()
 746     {
 747         return array(
 748             'system.listMethods' => array(
 749                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_listMethods',
 750                 // listMethods: signature was either a string, or nothing.
 751                 // The useless string variant has been removed
 752                 'signature' => array(array(Value::$xmlrpcArray)),
 753                 'docstring' => 'This method lists all the methods that the XML-RPC server knows how to dispatch',
 754                 'signature_docs' => array(array('list of method names')),
 755             ),
 756             'system.methodHelp' => array(
 757                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodHelp',
 758                 'signature' => array(array(Value::$xmlrpcString, Value::$xmlrpcString)),
 759                 'docstring' => 'Returns help text if defined for the method passed, otherwise returns an empty string',
 760                 'signature_docs' => array(array('method description', 'name of the method to be described')),
 761             ),
 762             'system.methodSignature' => array(
 763                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodSignature',
 764                 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcString)),
 765                 '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)',
 766                 'signature_docs' => array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')),
 767             ),
 768             'system.multicall' => array(
 769                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_multicall',
 770                 'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcArray)),
 771                 'docstring' => 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details',
 772                 '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"')),
 773             ),
 774             'system.getCapabilities' => array(
 775                 'function' => 'PhpXmlRpc\Server::_xmlrpcs_getCapabilities',
 776                 'signature' => array(array(Value::$xmlrpcStruct)),
 777                 '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',
 778                 'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec')),
 779             ),
 780         );
 781     }
 782
 783     /**
 784      * @return array
 785      */
 786     public function getCapabilities()
 787     {
 788         $outAr = array(
 789             // xmlrpc spec: always supported
 790             'xmlrpc' => array(
 791                 'specUrl' => 'http://www.xmlrpc.com/spec',
 792                 'specVersion' => 1
 793             ),
 794             // if we support system.xxx functions, we always support multicall, too...
 795             // Note that, as of 2006/09/17, the following URL does not respond anymore
 796             'system.multicall' => array(
 797                 'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
 798                 'specVersion' => 1
 799             ),
 800             // introspection: version 2! we support 'mixed', too
 801             'introspection' => array(
 802                 'specUrl' => 'http://phpxmlrpc.sourceforge.net/doc-2/ch10.html',
 803                 'specVersion' => 2,
 804             ),
 805         );
 806
 807         // NIL extension
 808         if (PhpXmlRpc::$xmlrpc_null_extension) {
 809             $outAr['nil'] = array(
 810                 'specUrl' => 'http://www.ontosys.com/xml-rpc/extensions.php',
 811                 'specVersion' => 1
 812             );
 813         }
 814
 815         return $outAr;
 816     }
 817
 818     /**
 819      * @param Server $server
 820      * @param Request $req
 821      * @return Response
 822      */
 823     public static function _xmlrpcs_getCapabilities($server, $req = null)
 824     {
 825         $encoder = new Encoder();
 826         return new Response($encoder->encode($server->getCapabilities()));
 827     }
 828
 829     /**
 830      * @param Server $server
 831      * @param Request $req if called in plain php values mode, second param is missing
 832      * @return Response
 833      */
 834     public static function _xmlrpcs_listMethods($server, $req = null)
 835     {
 836         $outAr = array();
 837         foreach ($server->dmap as $key => $val) {
 838             $outAr[] = new Value($key, 'string');
 839         }
 840         if ($server->allow_system_funcs) {
 841             foreach ($server->getSystemDispatchMap() as $key => $val) {
 842                 $outAr[] = new Value($key, 'string');
 843             }
 844         }
 845
 846         return new Response(new Value($outAr, 'array'));
 847     }
 848
 849     /**
 850      * @param Server $server
 851      * @param Request $req
 852      * @return Response
 853      */
 854     public static function _xmlrpcs_methodSignature($server, $req)
 855     {
 856         // let accept as parameter both an xmlrpc value or string
 857         if (is_object($req)) {
 858             $methName = $req->getParam(0);
 859             $methName = $methName->scalarval();
 860         } else {
 861             $methName = $req;
 862         }
 863         if (strpos($methName, "system.") === 0) {
 864             $dmap = $server->getSystemDispatchMap();
 865         } else {
 866             $dmap = $server->dmap;
 867         }
 868         if (isset($dmap[$methName])) {
 869             if (isset($dmap[$methName]['signature'])) {
 870                 $sigs = array();
 871                 foreach ($dmap[$methName]['signature'] as $inSig) {
 872                     $curSig = array();
 873                     foreach ($inSig as $sig) {
 874                         $curSig[] = new Value($sig, 'string');
 875                     }
 876                     $sigs[] = new Value($curSig, 'array');
 877                 }
 878                 $r = new Response(new Value($sigs, 'array'));
 879             } else {
 880                 // NB: according to the official docs, we should be returning a
 881                 // "none-array" here, which means not-an-array
 882                 $r = new Response(new Value('undef', 'string'));
 883             }
 884         } else {
 885             $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
 886         }
 887
 888         return $r;
 889     }
 890
 891     /**
 892      * @param Server $server
 893      * @param Request $req
 894      * @return Response
 895      */
 896     public static function _xmlrpcs_methodHelp($server, $req)
 897     {
 898         // let accept as parameter both an xmlrpc value or string
 899         if (is_object($req)) {
 900             $methName = $req->getParam(0);
 901             $methName = $methName->scalarval();
 902         } else {
 903             $methName = $req;
 904         }
 905         if (strpos($methName, "system.") === 0) {
 906             $dmap = $server->getSystemDispatchMap();
 907         } else {
 908             $dmap = $server->dmap;
 909         }
 910         if (isset($dmap[$methName])) {
 911             if (isset($dmap[$methName]['docstring'])) {
 912                 $r = new Response(new Value($dmap[$methName]['docstring']), 'string');
 913             } else {
 914                 $r = new Response(new Value('', 'string'));
 915             }
 916         } else {
 917             $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
 918         }
 919
 920         return $r;
 921     }
 922
 923     public static function _xmlrpcs_multicall_error($err)
 924     {
 925         if (is_string($err)) {
 926             $str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
 927             $code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
 928         } else {
 929             $code = $err->faultCode();
 930             $str = $err->faultString();
 931         }
 932         $struct = array();
 933         $struct['faultCode'] = new Value($code, 'int');
 934         $struct['faultString'] = new Value($str, 'string');
 935
 936         return new Value($struct, 'struct');
 937     }
 938
 939     /**
 940      * @param Server $server
 941      * @param Value $call
 942      * @return Value
 943      */
 944     public static function _xmlrpcs_multicall_do_call($server, $call)
 945     {
 946         if ($call->kindOf() != 'struct') {
 947             return static::_xmlrpcs_multicall_error('notstruct');
 948         }
 949         $methName = @$call['methodName'];
 950         if (!$methName) {
 951             return static::_xmlrpcs_multicall_error('nomethod');
 952         }
 953         if ($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') {
 954             return static::_xmlrpcs_multicall_error('notstring');
 955         }
 956         if ($methName->scalarval() == 'system.multicall') {
 957             return static::_xmlrpcs_multicall_error('recursion');
 958         }
 959
 960         $params = @$call['params'];
 961         if (!$params) {
 962             return static::_xmlrpcs_multicall_error('noparams');
 963         }
 964         if ($params->kindOf() != 'array') {
 965             return static::_xmlrpcs_multicall_error('notarray');
 966         }
 967
 968         $req = new Request($methName->scalarval());
 969         foreach($params as $i => $param) {
 970             if (!$req->addParam($param)) {
 971                 $i++; // for error message, we count params from 1
 972                 return static::_xmlrpcs_multicall_error(new Response(0,
 973                     PhpXmlRpc::$xmlrpcerr['incorrect_params'],
 974                     PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
 975             }
 976         }
 977
 978         $result = $server->execute($req);
 979
 980         if ($result->faultCode() != 0) {
 981             return static::_xmlrpcs_multicall_error($result); // Method returned fault.
 982         }
 983
 984         return new Value(array($result->value()), 'array');
 985     }
 986
 987     /**
 988      * @param Server $server
 989      * @param Value $call
 990      * @return Value
 991      */
 992     public static function _xmlrpcs_multicall_do_call_phpvals($server, $call)
 993     {
 994         if (!is_array($call)) {
 995             return static::_xmlrpcs_multicall_error('notstruct');
 996         }
 997         if (!array_key_exists('methodName', $call)) {
 998             return static::_xmlrpcs_multicall_error('nomethod');
 999         }
1000         if (!is_string($call['methodName'])) {
1001             return static::_xmlrpcs_multicall_error('notstring');
1002         }
1003         if ($call['methodName'] == 'system.multicall') {
1004             return static::_xmlrpcs_multicall_error('recursion');
1005         }
1006         if (!array_key_exists('params', $call)) {
1007             return static::_xmlrpcs_multicall_error('noparams');
1008         }
1009         if (!is_array($call['params'])) {
1010             return static::_xmlrpcs_multicall_error('notarray');
1011         }
1012
1013         // this is a real dirty and simplistic hack, since we might have received a
1014         // base64 or datetime values, but they will be listed as strings here...
1015         $pt = array();
1016         $wrapper = new Wrapper();
1017         foreach ($call['params'] as $val) {
1018             $pt[] = $wrapper->php2XmlrpcType(gettype($val));
1019         }
1020
1021         $result = $server->execute($call['methodName'], $call['params'], $pt);
1022
1023         if ($result->faultCode() != 0) {
1024             return static::_xmlrpcs_multicall_error($result); // Method returned fault.
1025         }
1026
1027         return new Value(array($result->value()), 'array');
1028     }
1029
1030     /**
1031      * @param Server $server
1032      * @param Request|array $req
1033      * @return Response
1034      */
1035     public static function _xmlrpcs_multicall($server, $req)
1036     {
1037         $result = array();
1038         // let accept a plain list of php parameters, beside a single xmlrpc msg object
1039         if (is_object($req)) {
1040             $calls = $req->getParam(0);
1041             foreach($calls as $call) {
1042                 $result[] = static::_xmlrpcs_multicall_do_call($server, $call);
1043             }
1044         } else {
1045             $numCalls = count($req);
1046             for ($i = 0; $i < $numCalls; $i++) {
1047                 $result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $req[$i]);
1048             }
1049         }
1050
1051         return new Response(new Value($result, 'array'));
1052     }
1053
1054     /**
1055      * Error handler used to track errors that occur during server-side execution of PHP code.
1056      * This allows to report back to the client whether an internal error has occurred or not
1057      * using an xmlrpc response object, instead of letting the client deal with the html junk
1058      * that a PHP execution error on the server generally entails.
1059      *
1060      * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.
1061      */
1062     public static function _xmlrpcs_errorHandler($errCode, $errString, $filename = null, $lineNo = null, $context = null)
1063     {
1064         // obey the @ protocol
1065         if (error_reporting() == 0) {
1066             return;
1067         }
1068
1069         //if($errCode != E_NOTICE && $errCode != E_WARNING && $errCode != E_USER_NOTICE && $errCode != E_USER_WARNING)
1070         if ($errCode != E_STRICT) {
1071             \PhpXmlRpc\Server::error_occurred($errString);
1072         }
1073         // Try to avoid as much as possible disruption to the previous error handling
1074         // mechanism in place
1075         if (self::$_xmlrpcs_prev_ehandler == '') {
1076             // The previous error handler was the default: all we should do is log error
1077             // to the default error log (if level high enough)
1078             if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errCode)) {
1079                 Logger::instance()->errorLog($errString);
1080             }
1081         } else {
1082             // Pass control on to previous error handler, trying to avoid loops...
1083             if (self::$_xmlrpcs_prev_ehandler != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
1084                 if (is_array(self::$_xmlrpcs_prev_ehandler)) {
1085                     // the following works both with static class methods and plain object methods as error handler
1086                     call_user_func_array(self::$_xmlrpcs_prev_ehandler, array($errCode, $errString, $filename, $lineNo, $context));
1087                 } else {
1088                     $method = self::$_xmlrpcs_prev_ehandler;
1089                     $method($errCode, $errString, $filename, $lineNo, $context);
1090                 }
1091             }
1092         }
1093     }
1094 }