X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FServer.php;h=ab171685927b6e9171076d9d6ee35eed58ced37c;hb=238968291ce5627e94dbc3928d377d09f6e9eeda;hp=930edff4970f55497aab1a3eecc3d7755dfd845d;hpb=a518f173b88b757ad83e694d088331fe5496d977;p=plcapi.git diff --git a/src/Server.php b/src/Server.php index 930edff..ab17168 100644 --- a/src/Server.php +++ b/src/Server.php @@ -5,53 +5,70 @@ namespace PhpXmlRpc; 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 + * 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' + * 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 + * @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 */ public $debug = 1; + /** - * Controls behaviour of server when invoked user function throws an exception: + * 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. + * Set at constructor time. */ public $compress_response = false; + /** - * List of http compression methods accepted by the server for requests. + * 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. + * 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), @@ -60,10 +77,12 @@ class Server * 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 */ @@ -71,11 +90,11 @@ class Server 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) { @@ -89,15 +108,12 @@ class Server // 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) { @@ -178,7 +194,9 @@ class Server * @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) { @@ -190,13 +208,14 @@ class Server // 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); } @@ -291,12 +310,12 @@ class Server /** * 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)) { @@ -304,8 +323,8 @@ class Server } 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)) { @@ -316,14 +335,14 @@ class Server $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; } @@ -343,7 +362,7 @@ class Server /** * 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) { @@ -389,7 +408,6 @@ class Server 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; @@ -446,6 +464,8 @@ class Server * @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 = '') { @@ -545,10 +565,13 @@ class Server * * @return Response * - * @throws \Exception in case the executed method does throw an exception (and depending on ) + * @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(); } else { @@ -603,7 +626,6 @@ class Server // verify that function to be invoked is in fact callable if (!is_callable($func)) { error_log("XML-RPC: " . __METHOD__ . ": function '$funcName' registered as method handler is not callable"); - return new Response( 0, PhpXmlRpc::$xmlrpcerr['server_error'], @@ -614,8 +636,9 @@ class Server // 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($req)) { @@ -652,7 +675,8 @@ class Server } 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); @@ -662,7 +686,8 @@ class Server 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) { @@ -670,6 +695,13 @@ class Server // 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: @@ -682,8 +714,8 @@ class Server 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(); } @@ -693,7 +725,7 @@ class Server } /** - * 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 */ @@ -702,6 +734,10 @@ class Server $this->debug_info .= $string . "\n"; } + /** + * @param string $charsetEncoding + * @return string + */ protected function xml_header($charsetEncoding = '') { if ($charsetEncoding != '') { @@ -713,6 +749,9 @@ class Server /* Functions that implement system.XXX methods of xmlrpc servers */ + /** + * @return array + */ public function getSystemDispatchMap() { return array( @@ -751,36 +790,45 @@ class Server ); } - public static function _xmlrpcs_getCapabilities($server, $req = 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_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 @@ -816,11 +864,11 @@ class Server 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 { @@ -883,7 +931,7 @@ class Server 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'); } @@ -894,27 +942,25 @@ class Server 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. @@ -950,7 +996,7 @@ class Server $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); @@ -968,10 +1014,8 @@ class Server // let accept a plain list of php parameters, beside a single xmlrpc msg object if (is_object($req)) { $calls = $req->getParam(0); - $numCalls = $calls->arraysize(); - for ($i = 0; $i < $numCalls; $i++) { - $call = $calls->arraymem($i); - $result[$i] = static::_xmlrpcs_multicall_do_call($server, $call); + foreach($calls as $call) { + $result[] = static::_xmlrpcs_multicall_do_call($server, $call); } } else { $numCalls = count($req); @@ -1004,7 +1048,7 @@ class Server } // 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)) { @@ -1012,12 +1056,13 @@ class Server } } 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); } } }