Viewing file:  Server.php (7.42 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */
// LICENSE AGREEMENT. If folded, press za here to unfold and read license {{{
/**
* +-----------------------------------------------------------------------------+
* | Copyright (c) 2004-2006 Sergio Gonalves Carvalho |
* +-----------------------------------------------------------------------------+
* | This file is part of XML_RPC2. |
* | |
* | XML_RPC2 is free software; you can redistribute it and/or modify |
* | it under the terms of the GNU Lesser General Public License as published by |
* | the Free Software Foundation; either version 2.1 of the License, or |
* | (at your option) any later version. |
* | |
* | XML_RPC2 is distributed in the hope that it will be useful, |
* | but WITHOUT ANY WARRANTY; without even the implied warranty of |
* | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
* | GNU Lesser General Public License for more details. |
* | |
* | You should have received a copy of the GNU Lesser General Public License |
* | along with XML_RPC2; if not, write to the Free Software |
* | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
* | 02111-1307 USA |
* +-----------------------------------------------------------------------------+
* | Author: Sergio Carvalho <sergio.carvalho@portugalmail.com> |
* +-----------------------------------------------------------------------------+
*
* @category XML
* @package XML_RPC2
* @author Sergio Carvalho <sergio.carvalho@portugalmail.com>
* @copyright 2004-2006 Sergio Carvalho
* @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
* @version CVS: $Id: Server.php 308615 2011-02-23 21:44:05Z sergiosgc $
* @link http://pear.php.net/package/XML_RPC2
*/
// }}}
// dependencies {{{
require_once 'XML/RPC2/Backend/Php/Request.php';
require_once 'XML/RPC2/Backend/Php/Response.php';
require_once 'XML/RPC2/Exception.php';
// }}}
/**
* XML_RPC server class XMLRPCext extension-based backend
*
* The XML_RPC2_Server does the work of decoding and encoding xml-rpc request and response. The actual
* method execution is delegated to the call handler instance.
*
* The XML_RPC server is responsible for decoding the request and calling the appropriate method in the
* call handler class. It then encodes the result into an XML-RPC response and returns it to the client.
*
* @category XML
* @package XML_RPC2
* @author Sergio Carvalho <sergio.carvalho@portugalmail.com>
* @copyright 2004-2006 Sergio Carvalho
* @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
* @link http://pear.php.net/package/XML_RPC2
*/
class XML_RPC2_Backend_Xmlrpcext_Server extends XML_RPC2_Server
{
// {{{ properties
/**
* xmlrpcext server
*
* @var resource
*/
private $_xmlrpcextServer;
// }}}
// {{{ constructor
/**
* Create a new XML-RPC Server.
*
* The constructor receives a mandatory parameter: the Call Handler. The call handler executes the actual
* method call. XML_RPC2 server acts as a protocol decoder/encoder between the call handler and the client
*
* @param object $callHandler
* @param array $options associative array of options
*/
function __construct($callHandler, $options = array())
{
parent::__construct($callHandler, $options);
$this->_xmlrpcextServer = xmlrpc_server_create();
foreach ($callHandler->getMethods() as $method) {
if (xmlrpc_server_register_method($this->_xmlrpcextServer,
$method->getName(),
array($this, 'epiFunctionHandlerAdapter')) !== true) {
throw new XML_RPC2_Exception('Unable to setup XMLRPCext server. xmlrpc_server_register_method returned non-true.');
}
}
}
// }}}
// {{{ epiFunctionHandlerAdapter()
/**
* This is an adapter between XML_RPC2_CallHandler::__call and xmlrpc_server_register_method callback interface
*
* @param string Method name
* @param array Parameters
* @param array Application data (ignored)
*/
protected function epiFunctionHandlerAdapter($method_name, $params, $app_data) {
return @call_user_func_array(array($this->callHandler, $method_name), $params);
}
// }}}
// {{{ handleCall()
/**
* Respond to the XML-RPC request.
*
* handleCall reads the XML-RPC request from the raw HTTP body and decodes it. It then calls the
* corresponding method in the call handler class, returning the encoded result to the client.
*/
public function handleCall()
{
if ($this->autoDocument && $this->input->isEmpty()) {
$this->autoDocument();
} else {
$response = $this->getResponse();
header('Content-type: text/xml; charset=' . $this->encoding);
header('Content-length: ' . $this->getContentLength($response));
print $response;
}
}
// }}}
// {{{ getResponse()
/**
* get the XML response of the XMLRPC server
*
* @return string the XML response
*/
public function getResponse()
{
try {
if ($this->signatureChecking) {
$tmp = xmlrpc_parse_method_descriptions($this->input->readRequest());
$methodName = $tmp['methodName'];
$parameters = xmlrpc_decode($this->input->readRequest(), $this->encoding);
$method = $this->callHandler->getMethod($methodName);
if (!($method)) {
// see http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php for standard error codes
return (XML_RPC2_Backend_Php_Response::encodeFault(-32601, 'server error. requested method not found'));
}
if (!($method->matchesSignature($methodName, $parameters))) {
return (XML_RPC2_Backend_Php_Response::encodeFault(-32602, 'server error. invalid method parameters'));
}
}
set_error_handler(array('XML_RPC2_Backend_Xmlrpcext_Server', 'errorToException'));
$response = @xmlrpc_server_call_method($this->_xmlrpcextServer,
$this->input->readRequest(),
null,
array('output_type' => 'xml', 'encoding' => $this->encoding));
restore_error_handler();
return $response;
} catch (XML_RPC2_FaultException $e) {
return (XML_RPC2_Backend_Php_Response::encodeFault($e->getFaultCode(), $e->getMessage()));
} catch (Exception $e) {
return (XML_RPC2_Backend_Php_Response::encodeFault(1, 'Unhandled ' . get_class($e) . ' exception:' . $e->getMessage()));
}
}
// }}}
}
?>
|