src/Server.php

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