use PhpXmlRpc\Helper\XMLParser;
use PhpXmlRpc\Helper\Charset;
+/**
+ * Allows effortless implementation of XML-RPC servers
+ */
class Server
{
/**
* Array defining php functions exposed as xmlrpc methods by this server.
*/
protected $dmap = array();
- /*
- * Defines how functions in dmap will be invoked: either using an xmlrpc msg object
- * or plain php values.
- * valid strings are 'xmlrpcvals', 'phpvals' or 'epivals'
- */
+
+ /**
+ * 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'
+ */
public $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'
- * @see php_xmlrpc_encode for a list of values
- */
+
+ /**
+ * 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'
+ * @see Encoder::encode for a list of values
+ */
public $phpvals_encoding_options = array('auto_dates');
- /// 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
+
+ /**
+ * 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;
- /*
- * Controls behaviour of server when 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
- * 2 = allow the exception to float to the upper layers
- */
+
+ /**
+ * 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
+ * 2 = allow the exception to float to the upper layers
+ */
public $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.
- */
+
+ /**
+ * 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.
+ */
public $compress_response = false;
- /*
- * List of http compression methods accepted by the server for requests.
- * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
- */
+
+ /**
+ * List of http compression methods accepted by the server for requests. Set at constructor time.
+ * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib
+ */
public $accepted_compression = array();
- /// shall we serve calls to system.* methods?
+
+ /// Shall we serve calls to system.* methods?
public $allow_system_funcs = true;
- /// list of charset encodings natively accepted for requests
+
+ /**
+ * List of charset encodings natively accepted for requests.
+ * Set at constructor time.
+ * UNUSED so far...
+ */
public $accepted_charset_encodings = array();
- /*
- * 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).
- * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
- */
+
+ /**
+ * 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).
+ * NB: pretty dangerous if you accept every charset and do not have mbstring enabled)
+ */
public $response_charset_encoding = '';
+
/**
* Storage for internal debug info.
*/
protected $debug_info = '';
- /*
- * Extra data passed at runtime to method handling functions. Used only by EPI layer
- */
+
+ /**
+ * Extra data passed at runtime to method handling functions. Used only by EPI layer
+ */
public $user_data = null;
protected static $_xmlrpc_debuginfo = '';
protected static $_xmlrpcs_occurred_errors = '';
- public static $_xmlrpcs_prev_ehandler = '';
+ protected static $_xmlrpcs_prev_ehandler = '';
/**
* @param array $dispatchMap the dispatch map with definition of exposed services
- * @param boolean $servicenow set to false to prevent the server from running upon construction
+ * @param boolean $serviceNow set to false to prevent the server from running upon construction
*/
public function __construct($dispatchMap = null, $serviceNow = 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
+ // 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)
- */
+ * instead, you can use the class add_to_map() function
+ * to add functions manually (borrowed from SOAPX4)
+ */
if ($dispatchMap) {
$this->dmap = $dispatchMap;
if ($serviceNow) {
* @param string $data the request body. If null, the http POST request will be examined
* @param bool $returnPayload When true, return the response but do not echo it or any http header
*
- * @return Response the response object (usually not used by caller...)
+ * @return Response|string the response object (usually not used by caller...) or its xml serialization
+ *
+ * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
*/
public function service($data = null, $returnPayload = false)
{
// reset internal debug info
$this->debug_info = '';
- // Echo back what we received, before parsing it
+ // Save what we received, before parsing it
if ($this->debug > 1) {
$this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++");
}
$r = $this->parseRequestHeaders($data, $reqCharset, $respCharset, $respEncoding);
if (!$r) {
+ // this actually executes the request
$r = $this->parseRequest($data, $reqCharset);
}
/**
* Verify type and number of parameters received against a list of known signatures.
*
- * @param array $in array of either xmlrpc value objects or xmlrpc type definitions
- * @param array $sig array of known signatures to match against
+ * @param array|Request $in array of either xmlrpc value objects or xmlrpc type definitions
+ * @param array $sigs array of known signatures to match against
*
* @return array
*/
- protected function verifySignature($in, $sig)
+ protected function verifySignature($in, $sigs)
{
// check each possible signature in turn
if (is_object($in)) {
} else {
$numParams = count($in);
}
- foreach ($sig as $cursig) {
- if (count($cursig) == $numParams + 1) {
+ foreach ($sigs as $curSig) {
+ if (count($curSig) == $numParams + 1) {
$itsOK = 1;
for ($n = 0; $n < $numParams; $n++) {
if (is_object($in)) {
$pt = $p->kindOf();
}
} else {
- $pt = $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4...
+ $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) {
+ if ($pt != $curSig[$n + 1] && $curSig[$n + 1] != Value::$xmlrpcValue) {
$itsOK = 0;
$pno = $n + 1;
- $wanted = $cursig[$n + 1];
+ $wanted = $curSig[$n + 1];
$got = $pt;
break;
}
/**
* Parse http headers received along with xmlrpc request. If needed, inflate request.
*
- * @return mixed null on success or a Response
+ * @return mixed Response|null on success or an error Response
*/
protected function parseRequestHeaders(&$data, &$reqEncoding, &$respEncoding, &$respCompression)
{
return $r;
}
} else {
- //error_log('The server sent deflated data. Your php install must have the Zlib extension compiled in to support this.');
$r = new Response(0, PhpXmlRpc::$xmlrpcerr['server_cannot_decompress'], PhpXmlRpc::$xmlrpcstr['server_cannot_decompress']);
return $r;
* @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)
*/
public function parseRequest($data, $reqEncoding = '')
{
$r = $this->execute($xmlRpcParser->_xh['method'], $xmlRpcParser->_xh['params'], $xmlRpcParser->_xh['pt']);
} else {
// build a Request object with data parsed from xml
- $m = new Request($xmlRpcParser->_xh['method']);
+ $req = new Request($xmlRpcParser->_xh['method']);
// now add parameters in
for ($i = 0; $i < count($xmlRpcParser->_xh['params']); $i++) {
- $m->addParam($xmlRpcParser->_xh['params'][$i]);
+ $req->addParam($xmlRpcParser->_xh['params'][$i]);
}
if ($this->debug > 1) {
- $this->debugmsg("\n+++PARSED+++\n" . var_export($m, true) . "\n+++END+++");
+ $this->debugmsg("\n+++PARSED+++\n" . var_export($req, true) . "\n+++END+++");
}
- $r = $this->execute($m);
+ $r = $this->execute($req);
}
}
/**
* Execute a method invoked by the client, checking parameters used.
*
- * @param mixed $m either a Request obj or a method name
+ * @param mixed $req either a Request obj or a method name
* @param array $params array with method parameters as php types (if m is method name only)
* @param array $paramTypes array with xmlrpc types of method parameters (if m is method name only)
*
* @return Response
+ *
+ * @throws \Exception in case the executed method does throw an exception (and depending on server configuration)
*/
- protected function execute($m, $params = null, $paramTypes = null)
+ protected function execute($req, $params = null, $paramTypes = null)
{
- if (is_object($m)) {
- $methName = $m->method();
+ static::$_xmlrpcs_occurred_errors = '';
+ static::$_xmlrpc_debuginfo = '';
+
+ if (is_object($req)) {
+ $methName = $req->method();
} else {
- $methName = $m;
+ $methName = $req;
}
$sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0);
$dmap = $sysCall ? $this->getSystemDispatchMap() : $this->dmap;
// Check signature
if (isset($dmap[$methName]['signature'])) {
$sig = $dmap[$methName]['signature'];
- if (is_object($m)) {
- list($ok, $errStr) = $this->verifySignature($m, $sig);
+ if (is_object($req)) {
+ list($ok, $errStr) = $this->verifySignature($req, $sig);
} else {
list($ok, $errStr) = $this->verifySignature($paramTypes, $sig);
}
return new Response(
0,
PhpXmlRpc::$xmlrpcerr['incorrect_params'],
- PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errstr}"
+ PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": ${errStr}"
);
}
}
if (is_string($func) && strpos($func, '::')) {
$func = explode('::', $func);
}
+
+ 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)) {
- error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler is not callable");
-
+ error_log("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable");
return new Response(
0,
PhpXmlRpc::$xmlrpcerr['server_error'],
// 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) {
- $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
+ self::$_xmlrpcs_prev_ehandler = set_error_handler(array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler'));
}
+
try {
// Allow mixed-convention servers
- if (is_object($m)) {
+ if (is_object($req)) {
if ($sysCall) {
- $r = call_user_func($func, $this, $m);
+ $r = call_user_func($func, $this, $req);
} else {
- $r = call_user_func($func, $m);
+ $r = call_user_func($func, $req);
}
if (!is_a($r, 'PhpXmlRpc\Response')) {
- error_log("XML-RPC: " . __METHOD__ . ": function $func registered as method handler does not return an xmlrpc response object");
+ error_log("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);
} else {
} else {
// functions using EPI api should NOT return resp objects,
// so make sure we encode the return type correctly
- $r = new Response(php_xmlrpc_encode($r, array('extension_api')));
+ $encoder = new Encoder();
+ $r = new Response($encoder->encode($r, array('extension_api')));
}
} else {
$r = call_user_func_array($func, $params);
if (!is_a($r, '\PhpXmlRpc\Response')) {
// what should we assume here about automatic encoding of datetimes
// and php classes instances???
- $r = new Response(php_xmlrpc_encode($r, $this->phpvals_encoding_options));
+ $encoder = new Encoder();
+ $r = new Response($encoder->encode($r, $this->phpvals_encoding_options));
}
}
} catch (\Exception $e) {
// in the called function, we wrap it in a proper error-response
switch ($this->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;
break;
case 1:
if ($this->debug > 2) {
// note: restore the error handler we found before calling the
// user func, even if it has been changed inside the func itself
- if ($GLOBALS['_xmlrpcs_prev_ehandler']) {
- set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']);
+ if (self::$_xmlrpcs_prev_ehandler) {
+ set_error_handler(self::$_xmlrpcs_prev_ehandler);
} else {
restore_error_handler();
}
}
/**
- * add a string to the 'internal debug message' (separate from 'user debug message').
+ * Add a string to the 'internal debug message' (separate from 'user debug message').
*
* @param string $string
*/
$this->debug_info .= $string . "\n";
}
+ /**
+ * @param string $charsetEncoding
+ * @return string
+ */
protected function xml_header($charsetEncoding = '')
{
if ($charsetEncoding != '') {
/* Functions that implement system.XXX methods of xmlrpc servers */
+ /**
+ * @return array
+ */
public function getSystemDispatchMap()
{
return array(
);
}
- public static function _xmlrpcs_getCapabilities($server, $m = null)
+ /**
+ * @return array
+ */
+ public function getCapabilities()
{
$outAr = array(
// xmlrpc spec: always supported
- 'xmlrpc' => new Value(array(
- 'specUrl' => new Value('http://www.xmlrpc.com/spec', 'string'),
- 'specVersion' => new Value(1, 'int'),
- ), 'struct'),
+ 'xmlrpc' => array(
+ 'specUrl' => 'http://www.xmlrpc.com/spec',
+ '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' => new Value(array(
- 'specUrl' => new Value('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'),
- 'specVersion' => new Value(1, 'int'),
- ), 'struct'),
+ 'system.multicall' => array(
+ 'specUrl' => 'http://www.xmlrpc.com/discuss/msgReader$1208',
+ 'specVersion' => 1
+ ),
// introspection: version 2! we support 'mixed', too
- 'introspection' => new Value(array(
- 'specUrl' => new Value('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'),
- 'specVersion' => new Value(2, 'int'),
- ), 'struct'),
+ 'introspection' => array(
+ 'specUrl' => 'http://phpxmlrpc.sourceforge.net/doc-2/ch10.html',
+ 'specVersion' => 2,
+ ),
);
// NIL extension
if (PhpXmlRpc::$xmlrpc_null_extension) {
- $outAr['nil'] = new Value(array(
- 'specUrl' => new Value('http://www.ontosys.com/xml-rpc/extensions.php', 'string'),
- 'specVersion' => new Value(1, 'int'),
- ), 'struct');
+ $outAr['nil'] = array(
+ 'specUrl' => 'http://www.ontosys.com/xml-rpc/extensions.php',
+ 'specVersion' => 1
+ );
}
- return new Response(new Value($outAr, 'struct'));
+ return $outAr;
}
- public static function _xmlrpcs_listMethods($server, $m = null) // if called in plain php values mode, second param is missing
+ public static function _xmlrpcs_getCapabilities($server, $req = null)
+ {
+ $encoder = new Encoder();
+ return new Response($encoder->encode($server->getCapabilities()));
+ }
+
+ public static function _xmlrpcs_listMethods($server, $req = null) // if called in plain php values mode, second param is missing
{
$outAr = array();
foreach ($server->dmap as $key => $val) {
return new Response(new Value($outAr, 'array'));
}
- public static function _xmlrpcs_methodSignature($server, $m)
+ public static function _xmlrpcs_methodSignature($server, $req)
{
// let accept as parameter both an xmlrpc value or string
- if (is_object($m)) {
- $methName = $m->getParam(0);
+ if (is_object($req)) {
+ $methName = $req->getParam(0);
$methName = $methName->scalarval();
} else {
- $methName = $m;
+ $methName = $req;
}
if (strpos($methName, "system.") === 0) {
$dmap = $server->getSystemDispatchMap();
if (isset($dmap[$methName]['signature'])) {
$sigs = array();
foreach ($dmap[$methName]['signature'] as $inSig) {
- $cursig = array();
+ $curSig = array();
foreach ($inSig as $sig) {
- $cursig[] = new Value($sig, 'string');
+ $curSig[] = new Value($sig, 'string');
}
- $sigs[] = new Value($cursig, 'array');
+ $sigs[] = new Value($curSig, 'array');
}
$r = new Response(new Value($sigs, 'array'));
} else {
return $r;
}
- public static function _xmlrpcs_methodHelp($server, $m)
+ public static function _xmlrpcs_methodHelp($server, $req)
{
// let accept as parameter both an xmlrpc value or string
- if (is_object($m)) {
- $methName = $m->getParam(0);
+ if (is_object($req)) {
+ $methName = $req->getParam(0);
$methName = $methName->scalarval();
} else {
- $methName = $m;
+ $methName = $req;
}
if (strpos($methName, "system.") === 0) {
$dmap = $server->getSystemDispatchMap();
if ($call->kindOf() != 'struct') {
return static::_xmlrpcs_multicall_error('notstruct');
}
- $methName = @$call->structmem('methodName');
+ $methName = @$call['methodName'];
if (!$methName) {
return static::_xmlrpcs_multicall_error('nomethod');
}
return static::_xmlrpcs_multicall_error('recursion');
}
- $params = @$call->structmem('params');
+ $params = @$call['params'];
if (!$params) {
return static::_xmlrpcs_multicall_error('noparams');
}
if ($params->kindOf() != 'array') {
return static::_xmlrpcs_multicall_error('notarray');
}
- $numParams = $params->arraysize();
-
- $msg = new Request($methName->scalarval());
- for ($i = 0; $i < $numParams; $i++) {
- if (!$msg->addParam($params->arraymem($i))) {
- $i++;
+ $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,
PhpXmlRpc::$xmlrpcerr['incorrect_params'],
PhpXmlRpc::$xmlrpcstr['incorrect_params'] . ": probable xml error in param " . $i));
}
}
- $result = $server->execute($msg);
+ $result = $server->execute($req);
if ($result->faultCode() != 0) {
return static::_xmlrpcs_multicall_error($result); // Method returned fault.
$pt = array();
$wrapper = new Wrapper();
foreach ($call['params'] as $val) {
- $pt[] = $wrapper->php_2_xmlrpc_type(gettype($val));
+ $pt[] = $wrapper->php2XmlrpcType(gettype($val));
}
$result = $server->execute($call['methodName'], $call['params'], $pt);
return new Value(array($result->value()), 'array');
}
- public static function _xmlrpcs_multicall($server, $m)
+ public static function _xmlrpcs_multicall($server, $req)
{
$result = array();
// let accept a plain list of php parameters, beside a single xmlrpc msg object
- if (is_object($m)) {
- $calls = $m->getParam(0);
- $numCalls = $calls->arraysize();
- for ($i = 0; $i < $numCalls; $i++) {
- $call = $calls->arraymem($i);
- $result[$i] = static::_xmlrpcs_multicall_do_call($server, $call);
+ if (is_object($req)) {
+ $calls = $req->getParam(0);
+ foreach($calls as $call) {
+ $result[] = static::_xmlrpcs_multicall_do_call($server, $call);
}
} else {
- $numCalls = count($m);
+ $numCalls = count($req);
for ($i = 0; $i < $numCalls; $i++) {
- $result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $m[$i]);
+ $result[$i] = static::_xmlrpcs_multicall_do_call_phpvals($server, $req[$i]);
}
}
}
// Try to avoid as much as possible disruption to the previous error handling
// mechanism in place
- if ($GLOBALS['_xmlrpcs_prev_ehandler'] == '') {
+ 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)
if (ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errCode)) {
}
} else {
// Pass control on to previous error handler, trying to avoid loops...
- if ($GLOBALS['_xmlrpcs_prev_ehandler'] != array('\PhpXmlRpc\Server', '_xmlrpcs_errorHandler')) {
- if (is_array($GLOBALS['_xmlrpcs_prev_ehandler'])) {
+ 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($GLOBALS['_xmlrpcs_prev_ehandler'], array($errCode, $errString, $filename, $lineNo, $context));
+ call_user_func_array(self::$_xmlrpcs_prev_ehandler, array($errCode, $errString, $filename, $lineNo, $context));
} else {
- $GLOBALS['_xmlrpcs_prev_ehandler']($errCode, $errString, $filename, $lineno, $context);
+ $method = self::$_xmlrpcs_prev_ehandler;
+ $method($errCode, $errString, $filename, $lineNo, $context);
}
}
}