src/Server.php

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