1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
<?php
/**
* The Horde_RPC_soap class provides an SOAP implementation of the
* Horde RPC system.
*
* $Horde: framework/RPC/RPC/soap.php,v 1.13.10.7 2006/01/01 21:28:33 jan Exp $
*
* Copyright 2003-2006 Jan Schneider <jan@horde.org>
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
*
* @author Jan Schneider <jan@horde.org>
* @since Horde 3.0
* @package Horde_RPC
*/
class Horde_RPC_soap extends Horde_RPC {
/**
* Resource handler for the RPC server.
*
* @var object
*/
var $_server;
/**
* Hash holding all methods' signatures.
*
* @var array
*/
var $__dispatch_map = array();
/**
* SOAP server constructor
*
* @access private
*/
function Horde_RPC_soap($params = null)
{
if ($params == 'wsdl' || $params == 'disco') {
$this->_authorize = false;
}
parent::Horde_RPC();
global $registry;
require_once 'SOAP/Server.php';
$this->_server = &new SOAP_Server();
$this->_server->_auto_translation = true;
}
/**
* Fills a hash that is used by the SOAP server with the signatures of
* all available methods.
*/
function _setupDispatchMap()
{
global $registry;
$methods = $registry->listMethods();
foreach ($methods as $method) {
$signature = $registry->getSignature($method);
if (!is_array($signature)) {
continue;
}
$method = str_replace('/', '.', $method);
$this->__dispatch_map[$method] = array(
'in' => $signature[0],
'out' => array('output' => $signature[1])
);
}
$this->__typedef = $registry->listTypes();
}
/**
* Returns the signature of a method.
* Internally used by the SOAP server.
*
* @param string $method A method name.
*
* @return array An array describing the method's signature.
*/
function __dispatch($method)
{
global $registry;
$method = str_replace('.', '/', $method);
$signature = $registry->getSignature($method);
if (!is_array($signature)) {
return null;
}
return array('in' => $signature[0],
'out' => array('output' => $signature[1]));
}
/**
* Will be registered as the handler for all methods called in the
* SOAP server and will call the appropriate function through the registry.
*
* @access private
*
* @param string $method The name of the method called by the RPC request.
* @param array $params The passed parameters.
* @param mixed $data Unknown.
*
* @return mixed The result of the called registry method.
*/
function _dispatcher($method, $params)
{
global $registry;
$method = str_replace('.', '/', $method);
if (!$registry->hasMethod($method)) {
return sprintf(_("Method \"%s\" is not defined"), $method);
}
$this->_server->bindWSDL(Horde::url($registry->get('webroot', 'horde') . '/rpc.php?wsdl', true, false));
return $registry->call($method, $params);
}
/**
* Takes an RPC request and returns the result.
*
* @param string The raw request string.
* @param string String specifying what kind of data to return. Defaults
* to SOAP request. Possible other values: "wdsl" and
* "disco".
*
* @return string The XML encoded response from the server.
*/
function getResponse($request, $params = null)
{
$this->_server->addObjectMap($this, 'urn:horde');
if (!$params) {
$this->_server->setCallHandler(array($this, '_dispatcher'));
/* We can't use Util::bufferOutput() here for some reason. */
ob_start();
$this->_server->service($request);
$output = ob_get_contents();
ob_end_clean();
} else {
require_once 'SOAP/Disco.php';
$disco = new SOAP_DISCO_Server($this->_server, 'horde');
if ($params == 'wsdl') {
$this->_setupDispatchMap();
$output = $disco->getWSDL();
} else {
$output = $disco->getDISCO();
}
}
return $output;
}
/**
* Builds an SOAP request and sends it to the SOAP server.
*
* This statically called method is actually the SOAP client.
*
* @param string $url The path to the SOAP server on the called host.
* @param string $method The method to call.
* @param array $params A hash containing any necessary parameters for
* the method call.
* @param $options Optional associative array of parameters which can be:
* user - Basic Auth username
* pass - Basic Auth password
* proxy_host - Proxy server host
* proxy_port - Proxy server port
* proxy_user - Proxy auth username
* proxy_pass - Proxy auth password
* timeout - Connection timeout in seconds.
* allowRedirects - Whether to follow redirects or not
* maxRedirects - Max number of redirects to follow
* namespace
* soapaction
* from - SMTP, from address
* transfer-encoding - SMTP, sets the
* Content-Transfer-Encoding header
* subject - SMTP, subject header
* headers - SMTP, array-hash of extra smtp
* headers
*
* @return mixed The returned result from the method or a PEAR
* error object on failure.
*/
function request($url, $method, $params = null, $options = array())
{
if (!isset($options['timeout'])) {
$options['timeout'] = 5;
}
if (!isset($options['allowRedirects'])) {
$options['allowRedirects'] = true;
$options['maxRedirects'] = 3;
}
require_once 'SOAP/Client.php';
$soap = &new SOAP_Client($url, false, false, $options);
return $soap->call($method, $params, $options['namespace']);
}
}
|