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