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