<?php
namespace PhpXmlRpc;
< use PhpXmlRpc\Helper\Charset;
> use PhpXmlRpc\Exception\NoSuchMethodException;
> use PhpXmlRpc\Exception\ValueErrorException;
> use PhpXmlRpc\Helper\Http;
> use PhpXmlRpc\Helper\Interop;
use PhpXmlRpc\Helper\Logger;
use PhpXmlRpc\Helper\XMLParser;
> use PhpXmlRpc\Traits\CharsetEncoderAware;
> use PhpXmlRpc\Traits\DeprecationLogger;
/**
> use PhpXmlRpc\Traits\ParserAware;
* Allows effortless implementation of XML-RPC servers
> *
*/
> * @property string[] $accepted_compression deprecated - public access left in purely for BC. Access via getOption()/setOption()
class Server
> * @property bool $allow_system_funcs deprecated - public access left in purely for BC. Access via getOption()/setOption()
{
> * @property bool $compress_response deprecated - public access left in purely for BC. Access via getOption()/setOption()
protected static $logger;
> * @property int $debug deprecated - public access left in purely for BC. Access via getOption()/setOption()
protected static $parser;
> * @property int $exception_handling deprecated - public access left in purely for BC. Access via getOption()/setOption()
protected static $charsetEncoder;
> * @property string $functions_parameters_type deprecated - public access left in purely for BC. Access via getOption()/setOption()
> * @property array $phpvals_encoding_options deprecated - public access left in purely for BC. Access via getOption()/setOption()
/**
> * @property string $response_charset_encoding deprecated - public access left in purely for BC. Access via getOption()/setOption()
< protected static $logger;
< protected static $parser;
< protected static $charsetEncoder;
<
< /**
< * Defines how functions in dmap will be invoked: either using an xmlrpc request object
< * or plain php values.
< * Valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'
> use CharsetEncoderAware;
> use DeprecationLogger;
> use ParserAware;
>
> const OPT_ACCEPTED_COMPRESSION = 'accepted_compression';
> const OPT_ALLOW_SYSTEM_FUNCS = 'allow_system_funcs';
> const OPT_COMPRESS_RESPONSE = 'compress_response';
> const OPT_DEBUG = 'debug';
> const OPT_EXCEPTION_HANDLING = 'exception_handling';
> const OPT_FUNCTIONS_PARAMETERS_TYPE = 'functions_parameters_type';
> const OPT_PHPVALS_ENCODING_OPTIONS = 'phpvals_encoding_options';
> const OPT_RESPONSE_CHARSET_ENCODING = 'response_charset_encoding';
>
> /** @var string */
> protected static $responseClass = '\\PhpXmlRpc\\Response';
>
> /**
> * @var string
> * Defines how functions in $dmap will be invoked: either using an xml-rpc Request object or plain php values.
> * Valid strings are 'xmlrpcvals', 'phpvals' or 'epivals' (only for use by polyfill-xmlrpc).
> *
< public $functions_parameters_type = 'xmlrpcvals';
> protected $functions_parameters_type = 'xmlrpcvals';
< * Option used for fine-tuning the encoding the php values returned from
< * functions registered in the dispatch map when the functions_parameters_types
< * member is set to 'phpvals'
> * @var array
> * Option used for fine-tuning the encoding the php values returned from functions registered in the dispatch map
> * when the functions_parameters_type member is set to 'phpvals'.
*/
< public $phpvals_encoding_options = array('auto_dates');
> protected $phpvals_encoding_options = array('auto_dates');
/**
> * @var int
* 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
< */
< public $debug = 1;
> * SECURITY SENSITIVE!
> * Valid values:
> * 0 =
> * 1 =
> * 2 =
> * 3 =
> */
> protected $debug = 1;
/**
< * Controls behaviour of server when the invoked user function throws an exception:
< * 0 = catch it and return an 'internal error' xmlrpc response (default)
< * 1 = catch it and return an xmlrpc response with the error corresponding to the exception
> * @var int
> * Controls behaviour of server when the invoked method-handler function throws an exception (within the `execute` method):
> * 0 = catch it and return an 'internal error' xml-rpc response (default)
> * 1 = SECURITY SENSITIVE DO NOT ENABLE ON PUBLIC SERVERS!!! catch it and return an xml-rpc response with the error
> * corresponding to the exception, both its code and message.
* 2 = allow the exception to float to the upper layers
> * Can be overridden per-method-handler in the dispatch map
*/
< public $exception_handling = 0;
> protected $exception_handling = 0;
/**
< * When set to true, it will enable HTTP compression of the response, in case
< * the client has declared its support for compression in the request.
< * Set at constructor time.
> * @var bool
> * When set to true, it will enable HTTP compression of the response, in case the client has declared its support
> * for compression in the request.
> * Automatically set at constructor time.
*/
< public $compress_response = false;
> protected $compress_response = false;
/**
< * List of http compression methods accepted by the server for requests. Set at constructor time.
> * @var string[]
> * List of http compression methods accepted by the server for requests. Automatically set at constructor time.
* NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
*/
< public $accepted_compression = array();
> protected $accepted_compression = array();
< /// Shall we serve calls to system.* methods?
< public $allow_system_funcs = true;
> /**
> * @var bool
> * Shall we serve calls to system.* methods?
> */
> protected $allow_system_funcs = true;
/**
* List of charset encodings natively accepted for requests.
* Set at constructor time.
< * UNUSED so far...
> * @deprecated UNUSED so far by this library. It is still accessible by subclasses but will be dropped in the future.
*/
< public $accepted_charset_encodings = array();
> private $accepted_charset_encodings = array();
/**
> * @var string
* Charset encoding to be used for response.
* NB: if we can, we will convert the generated response from internal_encoding to the intended one.
< * Can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled),
< * null (leave unspecified in response, convert output stream to US_ASCII),
< * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed),
< * 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).
> * Can be:
> * - a supported xml encoding (only UTF-8 and ISO-8859-1, unless mbstring is enabled),
> * - null (leave unspecified in response, convert output stream to US_ASCII),
> * - '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).
* NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
*/
< public $response_charset_encoding = '';
> protected $response_charset_encoding = '';
>
> protected static $options = array(
> self::OPT_ACCEPTED_COMPRESSION,
> self::OPT_ALLOW_SYSTEM_FUNCS,
> self::OPT_COMPRESS_RESPONSE,
> self::OPT_DEBUG,
> self::OPT_EXCEPTION_HANDLING,
> self::OPT_FUNCTIONS_PARAMETERS_TYPE,
> self::OPT_PHPVALS_ENCODING_OPTIONS,
> self::OPT_RESPONSE_CHARSET_ENCODING,
> );
/**
> * @var mixed
* Extra data passed at runtime to method handling functions. Used only by EPI layer
> * @internal
*/
public $user_data = null;
/**
< * Array defining php functions exposed as xmlrpc methods by this server.
> * Array defining php functions exposed as xml-rpc methods by this server.
* @var array[] $dmap
*/
protected $dmap = array();
/**
* Storage for internal debug info.
*/
protected $debug_info = '';
protected static $_xmlrpc_debuginfo = '';
protected static $_xmlrpcs_occurred_errors = '';
protected static $_xmlrpcs_prev_ehandler = '';
< public function getLogger()
< {
< if (self::$logger === null) {
< self::$logger = Logger::instance();
< }
< return self::$logger;
< }
<
< public static function setLogger($logger)
< {
< self::$logger = $logger;
< }
<
< public function getParser()
< {
< if (self::$parser === null) {
< self::$parser = new XMLParser();
< }
< return self::$parser;
< }
<
< public static function setParser($parser)
< {
< self::$parser = $parser;
< }
<
< public function getCharsetEncoder()
< {
< if (self::$charsetEncoder === null) {
< self::$charsetEncoder = Charset::instance();
< }
< return self::$charsetEncoder;
< }
<
< public function setCharsetEncoder($charsetEncoder)
< {
< self::$charsetEncoder = $charsetEncoder;
< }
<
/**
* @param array[] $dispatchMap the dispatch map with definition of exposed services
* Array keys are the names of the method names.
* Each array value is an array with the following members:
* - function (callable)
* - docstring (optional)
* - signature (array, optional)
* - signature_docs (array, optional)
* - parameters_type (string, optional)
< * @param boolean $serviceNow set to false to prevent the server from running upon construction
> * - exception_handling (int, optional)
> * @param boolean $serviceNow set to false in order to prevent the server from running upon construction
*/
public function __construct($dispatchMap = null, $serviceNow = true)
{
// if ZLIB is enabled, let the server by default accept compressed requests,
// and compress responses sent to clients that support them
if (function_exists('gzinflate')) {
< $this->accepted_compression = array('gzip', 'deflate');
> $this->accepted_compression[] = 'gzip';
> }
> if (function_exists('gzuncompress')) {
> $this->accepted_compression[] = 'deflate';
> }
> if (function_exists('gzencode') || function_exists('gzcompress')) {
$this->compress_response = true;
}
// by default the xml parser can support these 3 charset encodings
$this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII');
// dispMap is a dispatch array of methods mapped to function names and signatures.
< // If a method doesn't appear in the map then an unknown method error is generated
< /* milosch - changed to make passing dispMap optional.
< * instead, you can use the class add_to_map() function
< * to add functions manually (borrowed from SOAPX4)
< */
> // If a method doesn't appear in the map then an unknown method error is generated.
> // milosch - changed to make passing dispMap optional. Instead, you can use the addToMap() function
> // to add functions manually (borrowed from SOAPX4)
if ($dispatchMap) {
< $this->dmap = $dispatchMap;
> $this->setDispatchMap($dispatchMap);
if ($serviceNow) {
$this->service();
}
}
}
/**
> * @param string $name see all the OPT_ constants
* Set debug level of server.
> * @param mixed $value
*
> * @return $this
* @param integer $level debug lvl: determines info added to xmlrpc responses (as xml comments)
> * @throws ValueErrorException on unsupported option
* 0 = no debug info,
> */
* 1 = msgs set from user with debugmsg(),
> public function setOption($name, $value)
* 2 = add complete xmlrpc request (headers and body),
> {
* 3 = add also all processing warnings happened during method processing
> switch ($name) {
* (NB: this involves setting a custom error handler, and might interfere
> case self::OPT_ACCEPTED_COMPRESSION :
* with the standard processing of the php function exposed as method. In
> case self::OPT_ALLOW_SYSTEM_FUNCS:
* particular, triggering an USER_ERROR level error will not halt script
> case self::OPT_COMPRESS_RESPONSE:
* execution anymore, but just end up logged in the xmlrpc response)
> case self::OPT_DEBUG:
* Note that info added at level 2 and 3 will be base64 encoded
> case self::OPT_EXCEPTION_HANDLING:
*/
> case self::OPT_FUNCTIONS_PARAMETERS_TYPE:
public function setDebug($level)
> case self::OPT_PHPVALS_ENCODING_OPTIONS:
{
> case self::OPT_RESPONSE_CHARSET_ENCODING:
$this->debug = $level;
> $this->$name = $value;
}
> break;
> default:
/**
> throw new ValueErrorException("Unsupported option '$name'");
* Add a string to the debug info that can be later serialized by the server as part of the response message.
> }
* Note that for best compatibility, the debug string should be encoded using the PhpXmlRpc::$xmlrpc_internalencoding
>
* character set.
> return $this;
*
> }
* @param string $msg
>
*/
> /**
public static function xmlrpc_debugmsg($msg)
> * @param string $name see all the OPT_ constants
{
> * @return mixed
static::$_xmlrpc_debuginfo .= $msg . "\n";
> * @throws ValueErrorException on unsupported option
}
> */
> public function getOption($name)
/**
> {
* Add a string to the debug info that will be later serialized by the server as part of the response message
> switch ($name) {
* (base64 encoded, only when debug level >= 2)
> case self::OPT_ACCEPTED_COMPRESSION:
*
> case self::OPT_ALLOW_SYSTEM_FUNCS:
* character set.
> case self::OPT_COMPRESS_RESPONSE:
* @param string $msg
> case self::OPT_DEBUG:
*/
> case self::OPT_EXCEPTION_HANDLING:
public static function error_occurred($msg)
> case self::OPT_FUNCTIONS_PARAMETERS_TYPE:
{
> case self::OPT_PHPVALS_ENCODING_OPTIONS:
static::$_xmlrpcs_occurred_errors .= $msg . "\n";
> case self::OPT_RESPONSE_CHARSET_ENCODING:
}
> return $this->$name;
> default:
/**
> throw new ValueErrorException("Unsupported option '$name'");
* Return a string with the serialized representation of all debug info.
> }
*
> }
* @param string $charsetEncoding the target charset encoding for the serialization
>
*
> /**
* @return string an XML comment (or two)
> * Returns the complete list of Server options.
*/
> * @return array
public function serializeDebug($charsetEncoding = '')
> */
{
> public function getOptions()
// Tough encoding problem: which internal charset should we assume for debug info?
> {
// It might contain a copy of raw data received from client, ie with unknown encoding,
> $values = array();
// intermixed with php generated data and user generated data...
> foreach(static::$options as $opt) {
// so we split it: system debug is base 64 encoded,
> $values[$opt] = $this->getOption($opt);
// user debug info should be encoded by the end user using the INTERNAL_ENCODING
> }
$out = '';
> return $values;
if ($this->debug_info != '') {
> }
$out .= "<!-- SERVER DEBUG INFO (BASE64 ENCODED):\n" . base64_encode($this->debug_info) . "\n-->\n";
>
}
> /**
if (static::$_xmlrpc_debuginfo != '') {
> * @param array $options key: see all the OPT_ constants
$out .= "<!-- DEBUG INFO:\n" . $this->getCharsetEncoder()->encodeEntities(str_replace('--', '_-', static::$_xmlrpc_debuginfo), PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n-->\n";
> * @return $this
// NB: a better solution MIGHT be to use CDATA, but we need to insert it
> * @throws ValueErrorException on unsupported option
// into return payload AFTER the beginning tag
> */
//$out .= "<![CDATA[ DEBUG INFO:\n\n" . str_replace(']]>', ']_]_>', static::$_xmlrpc_debuginfo) . "\n]]>\n";
> public function setOptions($options)
}
> {
> foreach($options as $name => $value) {
return $out;
> $this->setOption($name, $value);
}
> }
>
/**
> return $this;
* Execute the xmlrpc request, printing the response.
> }
*
>
* @param string $data the request body. If null, the http POST request will be examined
> /**
< * @param integer $level debug lvl: determines info added to xmlrpc responses (as xml comments)
> * @param integer $level debug lvl: determines info added to xml-rpc responses (as xml comments)
< * 2 = add complete xmlrpc request (headers and body),
> * 2 = add complete xml-rpc request (headers and body),
< * particular, triggering an USER_ERROR level error will not halt script
< * execution anymore, but just end up logged in the xmlrpc response)
> * particular, triggering a USER_ERROR level error will not halt script
> * execution anymore, but just end up logged in the xml-rpc response)
* @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
> * @return $this
*/
> return $this;
public function service($data = null, $returnPayload = false)
> * @return void
< * (base64 encoded, only when debug level >= 2)
> * (base64 encoded) when debug level >= 2
< * character set.
$data = file_get_contents('php://input');
> * @return void
}
> * @internal this function will become protected in the future
$rawData = $data;
> *
< * Execute the xmlrpc request, printing the response.
> * Execute the xml-rpc request, printing the response.
< *
$this->debug_info = '';
// Save what we received, before parsing it
if ($this->debug > 1) {
< $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
> $this->debugMsg("+++GOT+++\n" . $data . "\n+++END+++");
}
< $r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
< if (!$r) {
> $resp = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
> if (!$resp) {
// this actually executes the request
< $r = $this->parseRequest($data, $reqCharset);
> $resp = $this->parseRequest($data, $reqCharset);
< // save full body of request into response, for more debugging usages.
< // Note that this is the _request_ data, not the response's own data, unlike what happens client-side
< /// @todo try to move this injection to the resp. constructor or use a non-deprecated access method
< $r->raw_data = $rawData;
> // save full body of request into response, for debugging purposes.
> // NB: this is the _request_ data, not the response's own data, unlike what happens client-side
> /// @todo try to move this injection to the resp. constructor or use a non-deprecated access method. Or, even
> /// better: just avoid setting this, and set debug info of the received http request in the request
> /// object instead? It's not like the developer misses access to _SERVER, _COOKIES though...
> /// Last but not least: the raw data might be of use to handler functions - but in decompressed form...
> $resp->raw_data = $rawData;
}
< if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors) {
< $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
> if ($this->debug > 2 && static::$_xmlrpcs_occurred_errors != '') {
> $this->debugMsg("+++PROCESSING ERRORS AND WARNINGS+++\n" .
static::$_xmlrpcs_occurred_errors . "+++END+++");
}
< $payload = $this->xml_header($respCharset);
> $header = $resp->xml_header($respCharset);
if ($this->debug > 0) {
< $payload = $payload . $this->serializeDebug($respCharset);
> $header .= $this->serializeDebug($respCharset);
}
< // Do not create response serialization if it has already happened. Helps building json magic
< if (empty($r->payload)) {
< $r->serialize($respCharset);
> // Do not create response serialization if it has already happened. Helps to build json magic
> /// @todo what if the payload was created targeting a different charset than $respCharset?
> /// Also, if we do not call serialize(), the request will not set its content-type to have the charset declared
> $payload = $resp->getPayload();
> if (empty($payload)) {
> $payload = $resp->serialize($respCharset);
}
< $payload = $payload . $r->payload;
> $payload = $header . $payload;
if ($returnPayload) {
return $payload;
}
// if we get a warning/error that has output some text before here, then we cannot
// add a new header. We cannot say we are sending xml, either...
if (!headers_sent()) {
< header('Content-Type: ' . $r->content_type);
< // we do not know if client actually told us an accepted charset, but if he did
< // we have to tell him what we did
> header('Content-Type: ' . $resp->getContentType());
> // we do not know if client actually told us an accepted charset, but if it did we have to tell it what we did
header("Vary: Accept-Charset");
< // http compression of output: only
< // if we can do it, and we want to do it, and client asked us to,
> // http compression of output: only if we can do it, and we want to do it, and client asked us to,
// and php ini settings do not force it already
< /// @todo check separately for gzencode and gzcompress functions, in case of polyfills
$phpNoSelfCompress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler');
< if ($this->compress_response && function_exists('gzencode') && $respEncoding != ''
< && $phpNoSelfCompress
< ) {
< if (strpos($respEncoding, 'gzip') !== false) {
> if ($this->compress_response && $respEncoding != '' && $phpNoSelfCompress) {
> if (strpos($respEncoding, 'gzip') !== false && function_exists('gzencode')) {
$payload = gzencode($payload);
header("Content-Encoding: gzip");
header("Vary: Accept-Encoding");
< } elseif (strpos($respEncoding, 'deflate') !== false) {
> } elseif (strpos($respEncoding, 'deflate') !== false && function_exists('gzcompress')) {
$payload = gzcompress($payload);
header("Content-Encoding: deflate");
header("Vary: Accept-Encoding");
}
}
< // Do not output content-length header if php is compressing output for us:
< // it will mess up measurements.
> // Do not output content-length header if php is compressing output for us: it will mess up measurements.
// Note that Apache/mod_php will add (and even alter!) the Content-Length header on its own, but only for
// responses up to 8000 bytes
if ($phpNoSelfCompress) {
header('Content-Length: ' . (int)strlen($payload));
}
} else {
< $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
> $this->getLogger()->error('XML-RPC: ' . __METHOD__ . ': http headers already sent before response is fully generated. Check for php warning or error messages');
}
print $payload;
< // return request, in case subclasses want it
< return $r;
> // return response, in case subclasses want it
> return $resp;
}
/**
* Add a method to the dispatch map.
*
* @param string $methodName the name with which the method will be made available
* @param callable $function the php function that will get invoked
* @param array[] $sig the array of valid method signatures.
* Each element is one signature: an array of strings with at least one element
* First element = type of returned value. Elements 2..N = types of parameters 1..N
* @param string $doc method documentation
* @param array[] $sigDoc the array of valid method signatures docs, following the format of $sig but with
* descriptions instead of types (one string for return type, one per param)
> * @param string $parametersType to allow single method handlers to receive php values instead of a Request, or vice-versa
*
> * @param int $exceptionHandling @see $this->exception_handling
* @todo raise a warning if the user tries to register a 'system.' method
> * @return void
< * @todo allow setting parameters_type
*/
< public function add_to_map($methodName, $function, $sig = null, $doc = false, $sigDoc = false)
> public function addToMap($methodName, $function, $sig = null, $doc = false, $sigDoc = false, $parametersType = false,
> $exceptionHandling = false)
{
> $this->add_to_map($methodName, $function, $sig, $doc, $sigDoc, $parametersType, $exceptionHandling);
$this->dmap[$methodName] = array(
> }
'function' => $function,
>
'docstring' => $doc,
> /**
);
> * Add a method to the dispatch map.
if ($sig) {
> *
$this->dmap[$methodName]['signature'] = $sig;
> * @param string $methodName the name with which the method will be made available
}
> * @param callable $function the php function that will get invoked
if ($sigDoc) {
> * @param array[] $sig the array of valid method signatures.
$this->dmap[$methodName]['signature_docs'] = $sigDoc;
> * Each element is one signature: an array of strings with at least one element
}
> * First element = type of returned value. Elements 2..N = types of parameters 1..N
}
> * @param string $doc method documentation
> * @param array[] $sigDoc the array of valid method signatures docs, following the format of $sig but with
/**
> * descriptions instead of types (one string for return type, one per param)
* Verify type and number of parameters received against a list of known signatures.
> * @param string $parametersType to allow single method handlers to receive php values instead of a Request, or vice-versa
*
> * @param int $exceptionHandling @see $this->exception_handling
* @param array|Request $in array of either xmlrpc value objects or xmlrpc type definitions
> * @return void
* @param array $sigs array of known signatures to match against
> *
*
> * @todo raise a warning if the user tries to register a 'system.' method
* @return array int, string
> * @deprecated use addToMap instead
*/
> */
protected function verifySignature($in, $sigs)
> public function add_to_map($methodName, $function, $sig = null, $doc = false, $sigDoc = false, $parametersType = false,
{
> $exceptionHandling = false)
// check each possible signature in turn
> {
if (is_object($in)) {
> $this->logDeprecationUnlessCalledBy('addToMap');
$numParams = $in->getNumParams();
>
} else {
> if ($parametersType) {
$numParams = count($in);
> $this->dmap[$methodName]['parameters_type'] = $parametersType;
}
> }
foreach ($sigs as $curSig) {
> if ($exceptionHandling !== false) {
if (count($curSig) == $numParams + 1) {
> $this->dmap[$methodName]['exception_handling'] = $exceptionHandling;
$itsOK = 1;
> }
< * @param array|Request $in array of either xmlrpc value objects or xmlrpc type definitions
> * @param array|Request $in array of either xml-rpc value objects or xml-rpc type definitions
< *
$p = $in->getParam($n);
if ($p->kindOf() == 'scalar') {
< $pt = $p->scalartyp();
> $pt = $p->scalarTyp();
} else {
$pt = $p->kindOf();
}
} else {
$pt = ($in[$n] == 'i4') ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
}
// param index is $n+1, as first member of sig is return type
if ($pt != $curSig[$n + 1] && $curSig[$n + 1] != Value::$xmlrpcValue) {
$itsOK = 0;
$pno = $n + 1;
$wanted = $curSig[$n + 1];
$got = $pt;
break;
}
}
if ($itsOK) {
return array(1, '');
}
}
}
if (isset($wanted)) {
< return array(0, "Wanted ${wanted}, got ${got} at param ${pno}");
> return array(0, "Wanted {$wanted}, got {$got} at param {$pno}");
} else {
return array(0, "No method signature matches number of parameters");
}
}
/**
< * Parse http headers received along with xmlrpc request. If needed, inflate request.
> * Parse http headers received along with xml-rpc request. If needed, inflate request.
*
* @return Response|null null on success or an error Response
*/
protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
{
// check if $_SERVER is populated: it might have been disabled via ini file
// (this is true even when in CLI mode)
if (count($_SERVER) == 0) {
< $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': cannot parse request headers as $_SERVER is not populated');
> $this->getLogger()->error('XML-RPC: ' . __METHOD__ . ': cannot parse request headers as $_SERVER is not populated');
}
if ($this->debug > 1) {
if (function_exists('getallheaders')) {
< $this->debugmsg(''); // empty line
> $this->debugMsg(''); // empty line
foreach (getallheaders() as $name => $val) {
< $this->debugmsg("HEADER: $name: $val");
> $this->debugMsg("HEADER: $name: $val");
}
}
}
if (isset($_SERVER['HTTP_CONTENT_ENCODING'])) {
$contentEncoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']);
} else {
$contentEncoding = '';
}
$rawData = $data;
// check if request body has been compressed and decompress it
if ($contentEncoding != '' && strlen($data)) {
if ($contentEncoding == 'deflate' || $contentEncoding == 'gzip') {
// if decoding works, use it. else assume data wasn't gzencoded
> /// @todo test separately for gzinflate and gzuncompress
if (function_exists('gzinflate') && in_array($contentEncoding, $this->accepted_compression)) {
if ($contentEncoding == 'deflate' && $degzdata = @gzuncompress($data)) {
$data = $degzdata;
if ($this->debug > 1) {
< $this->debugmsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
> $this->debugMsg("\n+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
}
} elseif ($contentEncoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) {
$data = $degzdata;
if ($this->debug > 1) {
< $this->debugmsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
> $this->debugMsg("+++INFLATED REQUEST+++[" . strlen($data) . " chars]+++\n" . $data . "\n+++END+++");
}
} else {
< $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'],
> $r = new static::$responseClass(0, PhpXmlRpc::$xmlrpcerr['server_decompress_fail'],
PhpXmlRpc::$xmlrpcstr['server_decompress_fail'], '', array('raw_data' => $rawData)
);
return $r;
}
} else {
< $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'],
> $r = new static::$responseClass(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'],
PhpXmlRpc::$xmlrpcstr['server_cannot_decompress'], '', array('raw_data' => $rawData)
);
return $r;
}
}
}
< // check if client specified accepted charsets, and if we know how to fulfill
< // the request
> // check if client specified accepted charsets, and if we know how to fulfill the request
if ($this->response_charset_encoding == 'auto') {
$respEncoding = '';
if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) {
< // here we should check if we can match the client-requested encoding
< // with the encodings we know we can generate.
< /// @todo we should parse q=0.x preferences instead of getting first charset specified...
< $clientAcceptedCharsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET']));
< // Give preference to internal encoding
< $knownCharsets = array(PhpXmlRpc::$xmlrpc_internalencoding, 'UTF-8', 'ISO-8859-1', 'US-ASCII');
< foreach ($knownCharsets as $charset) {
> // here we check if we can match the client-requested encoding with the encodings we know we can generate.
> // we parse q=0.x preferences instead of preferring the first charset specified
> $http = new Http();
> $clientAcceptedCharsets = $http->parseAcceptHeader($_SERVER['HTTP_ACCEPT_CHARSET']);
> $knownCharsets = $this->getCharsetEncoder()->knownCharsets();
foreach ($clientAcceptedCharsets as $accepted) {
< if (strpos($accepted, $charset) === 0) {
> foreach ($knownCharsets as $charset) {
> if (strtoupper($accepted) == strtoupper($charset)) {
$respEncoding = $charset;
< break;
< }
> break 2;
}
< if ($respEncoding) {
< break;
}
}
}
} else {
$respEncoding = $this->response_charset_encoding;
}
if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
$respCompression = $_SERVER['HTTP_ACCEPT_ENCODING'];
} else {
$respCompression = '';
}
// 'guestimate' request encoding
/// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check???
$reqEncoding = XMLParser::guessEncoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '',
$data);
return null;
}
/**
< * Parse an xml chunk containing an xmlrpc request and execute the corresponding
< * php function registered with the server.
> * Parse an xml chunk containing an xml-rpc request and execute the corresponding php function registered with the
> * server.
> * @internal this function will become protected in the future
*
* @param string $data the xml request
* @param string $reqEncoding (optional) the charset encoding of the xml request
< *
* @return Response
< *
* @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
*
< * @internal this function will become protected in the future
* @todo either rename this function or move the 'execute' part out of it...
*/
public function parseRequest($data, $reqEncoding = '')
{
// decompose incoming XML into request structure
> /// @todo move this block of code into the XMLParser
if ($reqEncoding != '') {
// Since parsing will fail if
< // - charset is not specified in the xml prologue,
> // - charset is not specified in the xml declaration,
// - the encoding is not UTF8 and
// - there are non-ascii chars in the text,
// we try to work round that...
< // The following code might be better for mb_string enabled installs, but
< // makes the lib about 200% slower...
> // The following code might be better for mb_string enabled installs, but it makes the lib about 200% slower...
//if (!is_valid_charset($reqEncoding, array('UTF-8')))
if (!in_array($reqEncoding, array('UTF-8', 'US-ASCII')) && !XMLParser::hasEncoding($data)) {
> if (function_exists('mb_convert_encoding')) {
if ($reqEncoding == 'ISO-8859-1') {
> $data = mb_convert_encoding($data, 'UTF-8', $reqEncoding);
$data = utf8_encode($data);
> } else {
} else {
< if (extension_loaded('mbstring')) {
< $data = mb_convert_encoding($data, 'UTF-8', $reqEncoding);
< } else {
< $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': invalid charset encoding of received request: ' . $reqEncoding);
> $this->getLogger()->error('XML-RPC: ' . __METHOD__ . ': unsupported charset encoding of received request: ' . $reqEncoding);
}
}
}
}
<
// PHP internally might use ISO-8859-1, so we have to tell the xml parser to give us back data in the expected charset.
< // What if internal encoding is not in one of the 3 allowed? We use the broadest one, ie. utf8
< // This allows to send data which is native in various charset,
< // by extending xmlrpc_encode_entities() and setting xmlrpc_internalencoding
< if (!in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
< /// @todo emit a warning
< $options = array(XML_OPTION_TARGET_ENCODING => 'UTF-8');
< } else {
> // What if internal encoding is not in one of the 3 allowed? We use the broadest one, i.e. utf8
> if (in_array(PhpXmlRpc::$xmlrpc_internalencoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) {
$options = array(XML_OPTION_TARGET_ENCODING => PhpXmlRpc::$xmlrpc_internalencoding);
> } else {
}
> $options = array(XML_OPTION_TARGET_ENCODING => 'UTF-8', 'target_charset' => PhpXmlRpc::$xmlrpc_internalencoding);
> // register a callback with the xml parser for when it finds the method name
$xmlRpcParser = $this->getParser();
> $options['methodname_callback'] = array($this, 'methodNameCallback');
< $xmlRpcParser->parse($data, $this->functions_parameters_type, XMLParser::ACCEPT_REQUEST, $options);
< if ($xmlRpcParser->_xh['isf'] > 2) {
> try {
> $_xh = $xmlRpcParser->parse($data, $this->functions_parameters_type, XMLParser::ACCEPT_REQUEST, $options);
> // BC
> if (!is_array($_xh)) {
> $_xh = $xmlRpcParser->_xh;
> }
> } catch (NoSuchMethodException $e) {
> return new static::$responseClass(0, $e->getCode(), $e->getMessage());
> }
>
> if ($_xh['isf'] == 3) {
// (BC) we return XML error as a faultCode
< preg_match('/^XML error ([0-9]+)/', $xmlRpcParser->_xh['isf_reason'], $matches);
< $r = new Response(0,
< PhpXmlRpc::$xmlrpcerrxml + $matches[1],
< $xmlRpcParser->_xh['isf_reason']);
< } elseif ($xmlRpcParser->_xh['isf']) {
< $r = new Response(0,
> preg_match('/^XML error ([0-9]+)/', $_xh['isf_reason'], $matches);
> return new static::$responseClass(
> 0,
> PhpXmlRpc::$xmlrpcerrxml + (int)$matches[1],
> $_xh['isf_reason']);
> } elseif ($_xh['isf']) {
> /// @todo separate better the various cases, as we have done in Request::parseResponse: invalid xml-rpc vs.
> /// parsing error
> return new static::$responseClass(
> 0,
PhpXmlRpc::$xmlrpcerr['invalid_request'],
< PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $xmlRpcParser->_xh['isf_reason']);
> PhpXmlRpc::$xmlrpcstr['invalid_request'] . ' ' . $_xh['isf_reason']);
} else {
< // small layering violation in favor of speed and memory usage:
< // we should allow the 'execute' method handle this, but in the
< // most common scenario (xmlrpc values type server with some methods
< // registered as phpvals) that would mean a useless encode+decode pass
> // small layering violation in favor of speed and memory usage: we should allow the 'execute' method handle
> // this, but in the most common scenario (xml-rpc values type server with some methods registered as phpvals)
> // that would mean a useless encode+decode pass
if ($this->functions_parameters_type != 'xmlrpcvals' ||
< (isset($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type']) &&
< ($this->dmap[$xmlRpcParser->_xh['method']]['parameters_type'] != 'xmlrpcvals')
> (isset($this->dmap[$_xh['method']]['parameters_type']) &&
> ($this->dmap[$_xh['method']]['parameters_type'] != 'xmlrpcvals')
)
) {
if ($this->debug > 1) {
< $this->debugmsg("\n+++PARSED+++\n" . var_export($xmlRpcParser->_xh['params'], true) . "\n+++END+++");
> $this->debugMsg("\n+++PARSED+++\n" . var_export($_xh['params'], true) . "\n+++END+++");
}
< $r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
>
> return $this->execute($_xh['method'], $_xh['params'], $_xh['pt']);
} else {
< // build a Request object with data parsed from xml
< $req = new Request($xmlRpcParser->_xh['method']);
< // now add parameters in
< for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
< $req->addParam($xmlRpcParser->_xh['params'][$i]);
> // build a Request object with data parsed from xml and add parameters in
> $req = new Request($_xh['method']);
> /// @todo for more speed, we could just pass in the array to the constructor (and loose the type validation)...
> for ($i = 0; $i < count($_xh['params']); $i++) {
> $req->addParam($_xh['params'][$i]);
}
if ($this->debug > 1) {
< $this->debugmsg("\n+++PARSED+++\n" . var_export($req, true) . "\n+++END+++");
> $this->debugMsg("\n+++PARSED+++\n" . var_export($req, true) . "\n+++END+++");
}
< $r = $this->execute($req);
>
> return $this->execute($req);
}
}
<
< return $r;
}
/**
* Execute a method invoked by the client, checking parameters used.
*
* @param Request|string $req either a Request obj or a method name
< * @param mixed[] $params array with method parameters as php types (only if m is method name)
< * @param string[] $paramTypes array with xmlrpc types of method parameters (only if m is method name)
< *
> * @param mixed[] $params array with method parameters as php types (only if $req is method name)
> * @param string[] $paramTypes array with xml-rpc types of method parameters (only if $req is method name)
* @return Response
*
* @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
*/
protected function execute($req, $params = null, $paramTypes = null)
{
static::$_xmlrpcs_occurred_errors = '';
static::$_xmlrpc_debuginfo = '';
if (is_object($req)) {
< $methName = $req->method();
> $methodName = $req->method();
} else {
< $methName = $req;
> $methodName = $req;
}
< $sysCall = $this->isSyscall($methName);
>
> $sysCall = $this->isSyscall($methodName);
$dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
< if (!isset($dmap[$methName]['function'])) {
> if (!isset($dmap[$methodName]['function'])) {
// No such method
< return new Response(0,
< PhpXmlRpc::$xmlrpcerr['unknown_method'],
< PhpXmlRpc::$xmlrpcstr['unknown_method']);
> return new static::$responseClass(0, PhpXmlRpc::$xmlrpcerr['unknown_method'], PhpXmlRpc::$xmlrpcstr['unknown_method']);
}
// Check signature
< if (isset($dmap[$methName]['signature'])) {
< $sig = $dmap[$methName]['signature'];
> if (isset($dmap[$methodName]['signature'])) {
> $sig = $dmap[$methodName]['signature'];
if (is_object($req)) {
list($ok, $errStr) = $this->verifySignature($req, $sig);
} else {
list($ok, $errStr) = $this->verifySignature($paramTypes, $sig);
}
if (!$ok) {
// Didn't match.
< return new Response(
> return new static::$responseClass(
0,
PhpXmlRpc::$xmlrpcerr['incorrect_params'],
< PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errStr}"
> PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": {$errStr}"
);
}
}
< $func = $dmap[$methName]['function'];
> $func = $dmap[$methodName]['function'];
>
// let the 'class::function' syntax be accepted in dispatch maps
if (is_string($func) && strpos($func, '::')) {
$func = explode('::', $func);
}
> // build string representation of function 'name'
if (is_array($func)) {
if (is_object($func[0])) {
$funcName = get_class($func[0]) . '->' . $func[1];
} else {
$funcName = implode('::', $func);
}
} else if ($func instanceof \Closure) {
$funcName = 'Closure';
} else {
$funcName = $func;
}
// verify that function to be invoked is in fact callable
if (!is_callable($func)) {
< $this->getLogger()->errorLog("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable");
< return new Response(
> $this->getLogger()->error("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable");
> return new static::$responseClass(
0,
PhpXmlRpc::$xmlrpcerr['server_error'],
PhpXmlRpc::$xmlrpcstr['server_error'] . ": no function matches method"
);
}
< // If debug level is 3, we should catch all errors generated during
< // processing of user function, and log them as part of response
> if (isset($dmap[$methodName]['exception_handling'])) {
> $exception_handling = (int)$dmap[$methodName]['exception_handling'];
> } else {
> $exception_handling = $this->exception_handling;
> }
>
> // If debug level is 3, we should catch all errors generated during processing of user function, and log them
> // as part of response
if ($this->debug > 2) {
self::$_xmlrpcs_prev_ehandler = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
}
try {
// Allow mixed-convention servers
if (is_object($req)) {
> // call an 'xml-rpc aware' function
if ($sysCall) {
$r = call_user_func($func, $this, $req);
} else {
$r = call_user_func($func, $req);
}
if (!is_a($r, 'PhpXmlRpc\Response')) {
< $this->getLogger()->errorLog("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler does not return an xmlrpc response object but a " . gettype($r));
> $this->getLogger()->error("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler does not return an xmlrpc response object but a " . gettype($r));
if (is_a($r, 'PhpXmlRpc\Value')) {
< $r = new Response($r);
> $r = new static::$responseClass($r);
} else {
< $r = new Response(
> $r = new static::$responseClass(
0,
PhpXmlRpc::$xmlrpcerr['server_error'],
PhpXmlRpc::$xmlrpcstr['server_error'] . ": function does not return xmlrpc response object"
);
}
}
} else {
// call a 'plain php' function
if ($sysCall) {
array_unshift($params, $this);
$r = call_user_func_array($func, $params);
} else {
// 3rd API convention for method-handling functions: EPI-style
if ($this->functions_parameters_type == 'epivals') {
< $r = call_user_func_array($func, array($methName, $params, $this->user_data));
< // mimic EPI behaviour: if we get an array that looks like an error, make it
< // an error response
> $r = call_user_func_array($func, array($methodName, $params, $this->user_data));
> // mimic EPI behaviour: if we get an array that looks like an error, make it an error response
if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) {
< $r = new Response(0, (integer)$r['faultCode'], (string)$r['faultString']);
> $r = new static::$responseClass(0, (integer)$r['faultCode'], (string)$r['faultString']);
} else {
< // functions using EPI api should NOT return resp objects,
< // so make sure we encode the return type correctly
> // functions using EPI api should NOT return resp objects, so make sure we encode the
> // return type correctly
$encoder = new Encoder();
< $r = new Response($encoder->encode($r, array('extension_api')));
> $r = new static::$responseClass($encoder->encode($r, array('extension_api')));
}
} else {
$r = call_user_func_array($func, $params);
}
}
// the return type can be either a Response object or a plain php value...
if (!is_a($r, '\PhpXmlRpc\Response')) {
< // what should we assume here about automatic encoding of datetimes
< // and php classes instances???
> // q: what should we assume here about automatic encoding of datetimes and php classes instances?
> // a: let the user decide
$encoder = new Encoder();
< $r = new Response($encoder->encode($r, $this->phpvals_encoding_options));
> $r = new static::$responseClass($encoder->encode($r, $this->phpvals_encoding_options));
}
}
> /// @todo bump minimum php version to 7.1 and use a single catch clause instead of the duplicate blocks
} catch (\Exception $e) {
< // (barring errors in the lib) an uncatched exception happened
< // in the called function, we wrap it in a proper error-response
< switch ($this->exception_handling) {
> // (barring errors in the lib) an uncaught exception happened in the called function, we wrap it in a
> // proper error-response
> switch ($exception_handling) {
case 2:
if ($this->debug > 2) {
if (self::$_xmlrpcs_prev_ehandler) {
set_error_handler(self::$_xmlrpcs_prev_ehandler);
} else {
restore_error_handler();
}
}
throw $e;
case 1:
< $r = new Response(0, $e->getCode(), $e->getMessage());
> $errCode = $e->getCode();
> if ($errCode == 0) {
> $errCode = PhpXmlRpc::$xmlrpcerr['server_error'];
> }
> $r = new static::$responseClass(0, $errCode, $e->getMessage());
break;
default:
< $r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
> $r = new static::$responseClass(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
> }
> } catch (\Error $e) {
> // (barring errors in the lib) an uncaught exception happened in the called function, we wrap it in a
> // proper error-response
> switch ($exception_handling) {
> case 2:
> if ($this->debug > 2) {
> if (self::$_xmlrpcs_prev_ehandler) {
> set_error_handler(self::$_xmlrpcs_prev_ehandler);
> } else {
> restore_error_handler();
> }
> }
> throw $e;
> case 1:
> $errCode = $e->getCode();
> if ($errCode == 0) {
> $errCode = PhpXmlRpc::$xmlrpcerr['server_error'];
}
> $r = new static::$responseClass(0, $errCode, $e->getMessage());
}
> break;
if ($this->debug > 2) {
> default:
// note: restore the error handler we found before calling the
> $r = new static::$responseClass(0, PhpXmlRpc::$xmlrpcerr['server_error'], PhpXmlRpc::$xmlrpcstr['server_error']);
// user func, even if it has been changed inside the func itself
> }
if (self::$_xmlrpcs_prev_ehandler) {
>
< // note: restore the error handler we found before calling the
< // user func, even if it has been changed inside the func itself
> // note: restore the error handler we found before calling the user func, even if it has been changed
> // inside the func itself
restore_error_handler();
}
}
return $r;
}
/**
< * Add a string to the 'internal debug message' (separate from 'user debug message').
< *
< * @param string $string
> * Registered as callback for when the XMLParser has found the name of the method to execute.
> * Handling that early allows to 1. stop parsing the rest of the xml if there is no such method registered, and
> * 2. tweak the type of data that the parser will return, in case the server uses mixed-calling-convention
> *
> * @internal
> * @param $methodName
> * @param XMLParser $xmlParser
> * @param resource $parser
> * @return void
> * @throws NoSuchMethodException
> *
> * @todo feature creep - we could validate here that the method in the dispatch map is valid, but that would mean
> * dirtying a lot the logic, as we would have back to both parseRequest() and execute() methods the info
> * about the matched method handler, in order to avoid doing the work twice...
*/
< protected function debugmsg($string)
> public function methodNameCallback($methodName, $xmlParser, $parser)
{
< $this->debug_info .= $string . "\n";
> $sysCall = $this->isSyscall($methodName);
> $dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
>
> if (!isset($dmap[$methodName]['function'])) {
> // No such method
> throw new NoSuchMethodException(PhpXmlRpc::$xmlrpcstr['unknown_method'], PhpXmlRpc::$xmlrpcerr['unknown_method']);
> }
>
> // alter on-the-fly the config of the xml parser if needed
> if (isset($dmap[$methodName]['parameters_type']) &&
> $dmap[$methodName]['parameters_type'] != $this->functions_parameters_type) {
> /// @todo this should be done by a method of the XMLParser
> switch ($dmap[$methodName]['parameters_type']) {
> case XMLParser::RETURN_PHP:
> xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast');
> break;
> case XMLParser::RETURN_EPIVALS:
> xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_epi');
> break;
> /// @todo log a warning on unsupported return type
> case XMLParser::RETURN_XMLRPCVALS:
> default:
> xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee');
> }
> }
}
/**
< * @param string $charsetEncoding
< * @return string
> * Add a string to the 'internal debug message' (separate from 'user debug message').
> *
> * @param string $string
> * @return void
*/
< protected function xml_header($charsetEncoding = '')
> protected function debugMsg($string)
{
< if ($charsetEncoding != '') {
< return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\"?" . ">\n";
< } else {
< return "<?xml version=\"1.0\"?" . ">\n";
< }
> $this->debug_info .= $string . "\n";
}
/**
* @param string $methName
* @return bool
*/
protected function isSyscall($methName)
{
return (strpos($methName, "system.") === 0);
}
/**
> * @param array $dmap
* @return array[]
> * @return $this
*/
> */
public function getDispatchMap()
> public function setDispatchMap($dmap)
{
> {
return $this->dmap;
> $this->dmap = $dmap;
}
> return $this;
> }
/**
>
* @return array[]
> /**
*/
public function getSystemDispatchMap()
{
if (!$this->allow_system_funcs) {
return array();
}
return array(
'system.listMethods' => array(
'function' => 'PhpXmlRpc\Server::_xmlrpcs_listMethods',
// listMethods: signature was either a string, or nothing.
// The useless string variant has been removed
'signature' => array(array(Value::$xmlrpcArray)),
'docstring' => 'This method lists all the methods that the XML-RPC server knows how to dispatch',
'signature_docs' => array(array('list of method names')),
),
'system.methodHelp' => array(
'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodHelp',
'signature' => array(array(Value::$xmlrpcString, Value::$xmlrpcString)),
'docstring' => 'Returns help text if defined for the method passed, otherwise returns an empty string',
'signature_docs' => array(array('method description', 'name of the method to be described')),
),
'system.methodSignature' => array(
'function' => 'PhpXmlRpc\Server::_xmlrpcs_methodSignature',
'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcString)),
'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)',
'signature_docs' => array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')),
),
'system.multicall' => array(
'function' => 'PhpXmlRpc\Server::_xmlrpcs_multicall',
'signature' => array(array(Value::$xmlrpcArray, Value::$xmlrpcArray)),
'docstring' => 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details',
'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"')),
),
'system.getCapabilities' => array(
'function' => 'PhpXmlRpc\Server::_xmlrpcs_getCapabilities',
'signature' => array(array(Value::$xmlrpcStruct)),
'docstring' => 'This method lists all the capabilities that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to',
'signature_docs' => array(array('list of capabilities, described as structs with a version number and url for the spec')),
),
);
}
< /* Functions that implement system.XXX methods of xmlrpc servers */
<
/**
* @return array[]
*/
public function getCapabilities()
{
$outAr = array(
< // xmlrpc spec: always supported
> // xml-rpc spec: always supported
'xmlrpc' => array(
< 'specUrl' => 'http://www.xmlrpc.com/spec',
> 'specUrl' => 'http://www.xmlrpc.com/spec', // NB: the spec sits now at http://xmlrpc.com/spec.md
'specVersion' => 1
),
// if we support system.xxx functions, we always support multicall, too...
< // Note that, as of 2006/09/17, the following URL does not respond anymore
'system.multicall' => array(
> // Note that, as of 2006/09/17, the following URL does not respond anymore
'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
'specVersion' => 1
),
< // introspection: version 2! we support 'mixed', too
> // introspection: version 2! we support 'mixed', too.
> // note: the php xml-rpc extension says this instead:
> // url http://xmlrpc-epi.sourceforge.net/specs/rfc.introspection.php, version 20010516
'introspection' => array(
'specUrl' => 'http://phpxmlrpc.sourceforge.net/doc-2/ch10.html',
'specVersion' => 2,
),
);
// NIL extension
if (PhpXmlRpc::$xmlrpc_null_extension) {
$outAr['nil'] = array(
> // Note that, as of 2023/01, the following URL does not respond anymore
'specUrl' => 'http://www.ontosys.com/xml-rpc/extensions.php',
'specVersion' => 1
);
}
> // support for "standard" error codes
return $outAr;
> if (PhpXmlRpc::$xmlrpcerr['unknown_method'] === Interop::$xmlrpcerr['unknown_method']) {
}
> $outAr['faults_interop'] = array(
> 'specUrl' => 'http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php',
/**
> 'specVersion' => 20010516
* @param Server $server
> );
* @param Request $req
> }
* @return Response
>
*/
> * @internal handler of a system. method
public static function _xmlrpcs_getCapabilities($server, $req = null)
> *
{
$encoder = new Encoder();
< return new Response($encoder->encode($server->getCapabilities()));
> return new static::$responseClass($encoder->encode($server->getCapabilities()));
}
/**
> * @internal handler of a system. method
* @param Server $server
> *
* @param Request $req if called in plain php values mode, second param is missing
* @return Response
*/
public static function _xmlrpcs_listMethods($server, $req = null)
{
$outAr = array();
foreach ($server->dmap as $key => $val) {
$outAr[] = new Value($key, 'string');
}
foreach ($server->getSystemDispatchMap() as $key => $val) {
$outAr[] = new Value($key, 'string');
}
< return new Response(new Value($outAr, 'array'));
> return new static::$responseClass(new Value($outAr, 'array'));
}
/**
> * @internal handler of a system. method
* @param Server $server
> *
* @param Request $req
* @return Response
*/
public static function _xmlrpcs_methodSignature($server, $req)
{
< // let accept as parameter both an xmlrpc value or string
> // let's accept as parameter either an xml-rpc value or string
if (is_object($req)) {
$methName = $req->getParam(0);
< $methName = $methName->scalarval();
> $methName = $methName->scalarVal();
} else {
$methName = $req;
}
if ($server->isSyscall($methName)) {
$dmap = $server->getSystemDispatchMap();
} else {
$dmap = $server->dmap;
}
if (isset($dmap[$methName])) {
if (isset($dmap[$methName]['signature'])) {
$sigs = array();
foreach ($dmap[$methName]['signature'] as $inSig) {
$curSig = array();
foreach ($inSig as $sig) {
$curSig[] = new Value($sig, 'string');
}
$sigs[] = new Value($curSig, 'array');
}
< $r = new Response(new Value($sigs, 'array'));
> $r = new static::$responseClass(new Value($sigs, 'array'));
} else {
// NB: according to the official docs, we should be returning a
// "none-array" here, which means not-an-array
< $r = new Response(new Value('undef', 'string'));
> $r = new static::$responseClass(new Value('undef', 'string'));
}
} else {
< $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
> $r = new static::$responseClass(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
}
return $r;
}
/**
> * @internal handler of a system. method
* @param Server $server
> *
* @param Request $req
* @return Response
*/
public static function _xmlrpcs_methodHelp($server, $req)
{
< // let accept as parameter both an xmlrpc value or string
> // let's accept as parameter either an xml-rpc value or string
if (is_object($req)) {
$methName = $req->getParam(0);
< $methName = $methName->scalarval();
> $methName = $methName->scalarVal();
} else {
$methName = $req;
}
if ($server->isSyscall($methName)) {
$dmap = $server->getSystemDispatchMap();
} else {
$dmap = $server->dmap;
}
if (isset($dmap[$methName])) {
if (isset($dmap[$methName]['docstring'])) {
< $r = new Response(new Value($dmap[$methName]['docstring'], 'string'));
> $r = new static::$responseClass(new Value($dmap[$methName]['docstring'], 'string'));
} else {
< $r = new Response(new Value('', 'string'));
> $r = new static::$responseClass(new Value('', 'string'));
}
} else {
< $r = new Response(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
> $r = new static::$responseClass(0, PhpXmlRpc::$xmlrpcerr['introspect_unknown'], PhpXmlRpc::$xmlrpcstr['introspect_unknown']);
}
return $r;
}
> /**
public static function _xmlrpcs_multicall_error($err)
> * @internal this function will become protected in the future
{
> *
if (is_string($err)) {
> * @param $err
$str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
> * @return Value
$code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
> */
< $str = PhpXmlRpc::$xmlrpcstr["multicall_${err}"];
< $code = PhpXmlRpc::$xmlrpcerr["multicall_${err}"];
> $str = PhpXmlRpc::$xmlrpcstr["multicall_{$err}"];
> $code = PhpXmlRpc::$xmlrpcerr["multicall_{$err}"];
$str = $err->faultString();
}
$struct = array();
$struct['faultCode'] = new Value($code, 'int');
$struct['faultString'] = new Value($str, 'string');
return new Value($struct, 'struct');
}
/**
> * @internal this function will become protected in the future
* @param Server $server
> *
* @param Value $call
* @return Value
*/
public static function _xmlrpcs_multicall_do_call($server, $call)
{
if ($call->kindOf() != 'struct') {
return static::_xmlrpcs_multicall_error('notstruct');
}
$methName = @$call['methodName'];
if (!$methName) {
return static::_xmlrpcs_multicall_error('nomethod');
}
< if ($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') {
> if ($methName->kindOf() != 'scalar' || $methName->scalarTyp() != 'string') {
return static::_xmlrpcs_multicall_error('notstring');
}
< if ($methName->scalarval() == 'system.multicall') {
> if ($methName->scalarVal() == 'system.multicall') {
return static::_xmlrpcs_multicall_error('recursion');
}
$params = @$call['params'];
if (!$params) {
return static::_xmlrpcs_multicall_error('noparams');
}
if ($params->kindOf() != 'array') {
return static::_xmlrpcs_multicall_error('notarray');
}
< $req = new Request($methName->scalarval());
> $req = new Request($methName->scalarVal());
foreach($params as $i => $param) {
if (!$req->addParam($param)) {
$i++; // for error message, we count params from 1
< return static::_xmlrpcs_multicall_error(new Response(0,
> return static::_xmlrpcs_multicall_error(new static::$responseClass(0,
PhpXmlRpc::$xmlrpcerr['incorrect_params'],
PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
}
}
$result = $server->execute($req);
if ($result->faultCode() != 0) {
return static::_xmlrpcs_multicall_error($result); // Method returned fault.
}
return new Value(array($result->value()), 'array');
}
/**
> * @internal this function will become protected in the future
* @param Server $server
> *
* @param Value $call
* @return Value
*/
public static function _xmlrpcs_multicall_do_call_phpvals($server, $call)
{
if (!is_array($call)) {
return static::_xmlrpcs_multicall_error('notstruct');
}
if (!array_key_exists('methodName', $call)) {
return static::_xmlrpcs_multicall_error('nomethod');
}
if (!is_string($call['methodName'])) {
return static::_xmlrpcs_multicall_error('notstring');
}
if ($call['methodName'] == 'system.multicall') {
return static::_xmlrpcs_multicall_error('recursion');
}
if (!array_key_exists('params', $call)) {
return static::_xmlrpcs_multicall_error('noparams');
}
if (!is_array($call['params'])) {
return static::_xmlrpcs_multicall_error('notarray');
}
// this is a simplistic hack, since we might have received
// base64 or datetime values, but they will be listed as strings here...
$pt = array();
$wrapper = new Wrapper();
foreach ($call['params'] as $val) {
// support EPI-encoded base64 and datetime values
if ($val instanceof \stdClass && isset($val->xmlrpc_type)) {
$pt[] = $val->xmlrpc_type == 'datetime' ? Value::$xmlrpcDateTime : $val->xmlrpc_type;
} else {
$pt[] = $wrapper->php2XmlrpcType(gettype($val));
}
}
$result = $server->execute($call['methodName'], $call['params'], $pt);
if ($result->faultCode() != 0) {
return static::_xmlrpcs_multicall_error($result); // Method returned fault.
}
return new Value(array($result->value()), 'array');
}
/**
> * @internal handler of a system. method
* @param Server $server
> *
* @param Request|array $req
* @return Response
*/
public static function _xmlrpcs_multicall($server, $req)
{
$result = array();
< // let accept a plain list of php parameters, beside a single xmlrpc msg object
> // let's accept a plain list of php parameters, beside a single xml-rpc msg object
if (is_object($req)) {
$calls = $req->getParam(0);
foreach($calls as $call) {
$result[] = static::_xmlrpcs_multicall_do_call($server, $call);
}
} else {
$numCalls = count($req);
for ($i = 0; $i < $numCalls; $i++) {
$result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $req[$i]);
}
}
< return new Response(new Value($result, 'array'));
> return new static::$responseClass(new Value($result, 'array'));
}
/**
* Error handler used to track errors that occur during server-side execution of PHP code.
* This allows to report back to the client whether an internal error has occurred or not
< * using an xmlrpc response object, instead of letting the client deal with the html junk
> * using an xml-rpc response object, instead of letting the client deal with the html junk
* that a PHP execution error on the server generally entails.
*
* NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors.
> *
*/
> * @internal
public static function _xmlrpcs_errorHandler($errCode, $errString, $filename = null, $lineNo = null, $context = null)
{
// obey the @ protocol
if (error_reporting() == 0) {
return;
}
//if($errCode != E_NOTICE && $errCode != E_WARNING && $errCode != E_USER_NOTICE && $errCode != E_USER_WARNING)
if ($errCode != E_STRICT) {
< \PhpXmlRpc\Server::error_occurred($errString);
> static::error_occurred($errString);
}
< // Try to avoid as much as possible disruption to the previous error handling
< // mechanism in place
>
> // Try to avoid as much as possible disruption to the previous error handling mechanism in place
if (self::$_xmlrpcs_prev_ehandler == '') {
< // The previous error handler was the default: all we should do is log error
< // to the default error log (if level high enough)
> // The previous error handler was the default: all we should do is log error to the default error log
> // (if level high enough)
if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errCode)) {
> // we can't use the functionality of LoggerAware, because this is a static method
if (self::$logger === null) {
self::$logger = Logger::instance();
}
< self::$logger->errorLog($errString);
> self::$logger->error($errString);
}
} else {
// Pass control on to previous error handler, trying to avoid loops...
if (self::$_xmlrpcs_prev_ehandler != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
if (is_array(self::$_xmlrpcs_prev_ehandler)) {
// the following works both with static class methods and plain object methods as error handler
call_user_func_array(self::$_xmlrpcs_prev_ehandler, array($errCode, $errString, $filename, $lineNo, $context));
} else {
$method = self::$_xmlrpcs_prev_ehandler;
$method($errCode, $errString, $filename, $lineNo, $context);
}
}
> }
}
> }
}
>
}
> // *** BC layer ***
>
> /**
> * @param string $charsetEncoding
> * @return string
> *
> * @deprecated this method was moved to the Response class
> */
> protected function xml_header($charsetEncoding = '')
> {
> $this->logDeprecation('Method ' . __METHOD__ . ' is deprecated');
>
> if ($charsetEncoding != '') {
> return "<?xml version=\"1.0\" encoding=\"$charsetEncoding\"?" . ">\n";
> } else {
> return "<?xml version=\"1.0\"?" . ">\n";
> }
> }
>
> // we have to make this return by ref in order to allow calls such as `$resp->_cookies['name'] = ['value' => 'something'];`
> public function &__get($name)
> {
> switch ($name) {
> case self::OPT_ACCEPTED_COMPRESSION :
> case self::OPT_ALLOW_SYSTEM_FUNCS:
> case self::OPT_COMPRESS_RESPONSE:
> case self::OPT_DEBUG:
> case self::OPT_EXCEPTION_HANDLING:
> case self::OPT_FUNCTIONS_PARAMETERS_TYPE:
> case self::OPT_PHPVALS_ENCODING_OPTIONS:
> case self::OPT_RESPONSE_CHARSET_ENCODING:
> $this->logDeprecation('Getting property Request::' . $name . ' is deprecated');
> return $this->$name;
> case 'accepted_charset_encodings':
> // manually implement the 'protected property' behaviour
> $canAccess = false;
> $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
> if (isset($trace[1]) && isset($trace[1]['class'])) {
> if (is_subclass_of($trace[1]['class'], 'PhpXmlRpc\Server')) {
> $canAccess = true;
> }
> }
> if ($canAccess) {
> $this->logDeprecation('Getting property Request::' . $name . ' is deprecated');
> return $this->accepted_compression;
> } else {
> trigger_error("Cannot access protected property Server::accepted_charset_encodings in " . __FILE__, E_USER_ERROR);
> }
> break;
> default:
> /// @todo throw instead? There are very few other places where the lib trigger errors which can potentially reach stdout...
> $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
> trigger_error('Undefined property via __get(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_WARNING);
> $result = null;
> return $result;
> }
> }
>
> public function __set($name, $value)
> {
> switch ($name) {
> case self::OPT_ACCEPTED_COMPRESSION :
> case self::OPT_ALLOW_SYSTEM_FUNCS:
> case self::OPT_COMPRESS_RESPONSE:
> case self::OPT_DEBUG:
> case self::OPT_EXCEPTION_HANDLING:
> case self::OPT_FUNCTIONS_PARAMETERS_TYPE:
> case self::OPT_PHPVALS_ENCODING_OPTIONS:
> case self::OPT_RESPONSE_CHARSET_ENCODING:
> $this->logDeprecation('Setting property Request::' . $name . ' is deprecated');
> $this->$name = $value;
> break;
> case 'accepted_charset_encodings':
> // manually implement the 'protected property' behaviour
> $canAccess = false;
> $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
> if (isset($trace[1]) && isset($trace[1]['class'])) {
> if (is_subclass_of($trace[1]['class'], 'PhpXmlRpc\Server')) {
> $canAccess = true;
> }
> }
> if ($canAccess) {
> $this->logDeprecation('Setting property Request::' . $name . ' is deprecated');
> $this->accepted_compression = $value;
> } else {
> trigger_error("Cannot access protected property Server::accepted_charset_encodings in " . __FILE__, E_USER_ERROR);
> }
> break;
> default:
> /// @todo throw instead? There are very few other places where the lib trigger errors which can potentially reach stdout...
> $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
> trigger_error('Undefined property via __set(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_WARNING);
> }
> }
>
> public function __isset($name)
> {
> switch ($name) {
> case self::OPT_ACCEPTED_COMPRESSION :
> case self::OPT_ALLOW_SYSTEM_FUNCS:
> case self::OPT_COMPRESS_RESPONSE:
> case self::OPT_DEBUG:
> case self::OPT_EXCEPTION_HANDLING:
> case self::OPT_FUNCTIONS_PARAMETERS_TYPE:
> case self::OPT_PHPVALS_ENCODING_OPTIONS:
> case self::OPT_RESPONSE_CHARSET_ENCODING:
> $this->logDeprecation('Checking property Request::' . $name . ' is deprecated');
> return isset($this->$name);
> case 'accepted_charset_encodings':
> // manually implement the 'protected property' behaviour
> $canAccess = false;
> $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
> if (isset($trace[1]) && isset($trace[1]['class'])) {
> if (is_subclass_of($trace[1]['class'], 'PhpXmlRpc\Server')) {
> $canAccess = true;
> }
> }
> if ($canAccess) {
> $this->logDeprecation('Checking property Request::' . $name . ' is deprecated');
> return isset($this->accepted_compression);
> }
> // break through voluntarily
> default:
> return false;
> }
> }
>
> public function __unset($name)
> {
> switch ($name) {
> case self::OPT_ACCEPTED_COMPRESSION :
> case self::OPT_ALLOW_SYSTEM_FUNCS:
> case self::OPT_COMPRESS_RESPONSE:
> case self::OPT_DEBUG:
> case self::OPT_EXCEPTION_HANDLING:
> case self::OPT_FUNCTIONS_PARAMETERS_TYPE:
> case self::OPT_PHPVALS_ENCODING_OPTIONS:
> case self::OPT_RESPONSE_CHARSET_ENCODING:
> $this->logDeprecation('Unsetting property Request::' . $name . ' is deprecated');
> unset($this->$name);
> break;
> case 'accepted_charset_encodings':
> // manually implement the 'protected property' behaviour
> $canAccess = false;
> $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
> if (isset($trace[1]) && isset($trace[1]['class'])) {
> if (is_subclass_of($trace[1]['class'], 'PhpXmlRpc\Server')) {
> $canAccess = true;
> }
> }
> if ($canAccess) {
> $this->logDeprecation('Unsetting property Request::' . $name . ' is deprecated');
> unset($this->accepted_compression);
> } else {
> trigger_error("Cannot access protected property Server::accepted_charset_encodings in " . __FILE__, E_USER_ERROR);
> }
> break;
> default:
> /// @todo throw instead? There are very few other places where the lib trigger errors which can potentially reach stdout...
> $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 1);
> trigger_error('Undefined property via __unset(): ' . $name . ' in ' . $trace[0]['file'] . ' on line ' . $trace[0]['line'], E_USER_WARNING);