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