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