src/Server.php

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