Source for file Server.php
Documentation is available at Server.php
// +----------------------------------------------------------------------+
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2003 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 2.02 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available at through the world-wide-web at |
// | http://www.php.net/license/2_02.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | license@php.net so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Authors: Shane Caraveo <Shane@Caraveo.com> Port to PEAR and more |
// | Authors: Dietrich Ayala <dietrich@ganx4.com> Original Author |
// +----------------------------------------------------------------------+
// $Id: Server.php,v 1.54 2005/05/27 22:42:42 yunosh Exp $
require_once 'SOAP/Base.php';
require_once 'SOAP/Fault.php';
require_once 'SOAP/Parser.php';
require_once 'SOAP/Value.php';
require_once 'SOAP/WSDL.php';
* Originaly based on SOAPx4 by Dietrich Ayala
* http://dietrich.ganx4.com/soapx4
* @author Shane Caraveo <shane@php.net> Conversion to PEAR and updates
* @author Dietrich Ayala <dietrich@ganx4.com> Original Author
* A list of headers that are going to be sent back to the client.
* @var string XML-Encoding
var $result = 'successful'; // for logging interop results to db
var $__options = array ('use' => 'encoded',
if (isset ($options['use'])) {
$this->__options['use'] = $options['use'];
if (isset ($options['style'])) {
$this->__options['style'] = $options['style'];
if (isset ($options['parameters'])) {
$this->__options['parameters'] = $options['parameters'];
// assume we encode with section 5
if ($this->__options['use']== 'literal') {
$this->_section5 = false;
* Error handler for errors that happen in proxied methods.
* To always return a valid SOAP response even on errors that don't happen
* in this code, the errors are catched, transformed to a SOAP fault and
* immediately sent to the client.
* @see http://www.php.net/set_error_handler
function _errorHandler ($errno, $errmsg, $filename, $linenum, $vars)
/* The error handler should ignore '0' errors, eg. hidden by @ - see
* the set_error_handler manual page. (thanks to Alan Knowles). */
if (!$errno || $errno == E_NOTICE ) {
$this->fault = & new SOAP_Fault($errmsg, 'Server', 'PHP', " Errno: $errno\nFilename: $filename\nLineno: $linenum\n" );
function _getContentEncoding ($content_type)
/* Get the character encoding of the incoming request treat incoming
* data as UTF-8 if no encoding set. */
if (strpos($content_type, '=')) {
if (!in_array($enc, $this->_encodings)) {
* Parses request and posts response.
function service($data, $endpoint = '', $test = false )
/* Figure out our endpoint. */
/* We'll try to build our endpoint. */
$this->endpoint = 'http://' . $_SERVER['SERVER_NAME'];
if ($_SERVER['SERVER_PORT']) {
$this->endpoint .= ':' . $_SERVER['SERVER_PORT'];
$this->endpoint .= $_SERVER['SCRIPT_NAME'];
/* Get the character encoding of the incoming request treat incoming
* data as UTF-8 if no encoding set. */
if (isset ($_SERVER['CONTENT_TYPE'])) {
if (strcasecmp($_SERVER['CONTENT_TYPE'], 'application/dime') == 0 ) {
$this->_decodeDIMEMessage ($data, $headers, $attachments);
} elseif (stristr($_SERVER['CONTENT_TYPE'], 'multipart/related')) {
/* This is a mime message, let's decode it. */
$data = 'Content-Type: ' .
$this->_decodeMimeMessage ($data, $headers, $attachments);
if (!isset ($headers['content-type'])) {
$headers['content-type'] = stripslashes($_SERVER['CONTENT_TYPE']);
!$this->_getContentEncoding ($headers['content-type'])) {
/* Found encoding we don't understand; return a fault. */
$this->_raiseSoapFault ('Unsupported encoding, use one of ISO-8859-1, US-ASCII, UTF-8', '', '', 'Server');
/* If this is not a POST with Content-Type text/xml, try to return a
if (!$this->fault && !$test &&
($_SERVER['REQUEST_METHOD'] != 'POST' ||
strncmp($headers['content-type'], 'text/xml', 8 ) != 0 )) {
/* This is not possibly a valid SOAP request, try to return a WSDL
$this->_raiseSoapFault ('Invalid SOAP request, must be POST with content-type: text/xml, got: ' . (isset ($headers['content-type']) ? $headers['content-type'] : 'Nothing!'), '', '', 'Server');
/* $response is a SOAP_Msg object. */
/* Handle Mime or DIME encoding. */
/* TODO: DIME decoding should move to the transport, do it here
* for now and for ease of getting it done. */
if (count($this->__attachments)) {
if ($useEncoding == 'Mime') {
$soap_msg = $this->_makeMimeMessage ($soap_msg);
$soap_msg = $this->_makeDIMEMessage ($soap_msg);
$this->headers['Content-Type'] = 'application/dime';
if (PEAR ::isError ($soap_msg)) {
return $this->raiseSoapFault ($soap_msg);
$response = $soap_msg['body'];
if (count($soap_msg['headers'])) {
$this->headers = $soap_msg['headers'];
$this->_sendResponse ($response);
* Sends the final HTTP response to the client, including the HTTP header
* If an error happened, it returns a SOAP fault instead of the response
* @param string $response The response body.
function _sendResponse ($response = '')
/* Make distinction between the different SAPIs, running PHP as CGI or
$hdrs = " $hdrs_type 500 Soap Fault\r\n";
$response = $this->fault->message ();
$hdrs = " $hdrs_type 200 OK\r\n";
if (!isset ($this->headers['Content-Type'])) {
$this->headers['Content-Type'] = 'text/xml; charset=' .
foreach ($this->headers as $k => $v) {
$this->response = $hdrs . "\r\n" . $response;
/* Call method with parameters. */
/* Call method withour parameters. */
* Creates SOAP_Value object with return values from method.
* Uses method signature to determine type.
$return_name = 'return', $namespace = '')
if (is_a($method_response, 'SOAP_Value')) {
$return_val = array ($method_response);
foreach ($return_type as $key => $type) {
if (is_a($method_response[$i],'soap_value')) {
$return_val[] = $method_response[$i++ ];
$qn = & new QName($key, $namespace);
$return_val[] = & new SOAP_Value($qn->fqn (), $type, $method_response[$i++ ]);
$return_type = $values[0 ];
$qn = & new QName($return_name, $namespace);
$return_val[] = & new SOAP_Value($qn->fqn (), $return_type, $method_response);
/* Parse response, get SOAP_Parser object. */
/* If fault occurred during message parsing. */
$this->fault = $parser->fault;
/* Handle message headers. */
$request_headers = $parser->getHeaders ();
$header_results = array ();
if (!is_a($request_headers, 'SOAP_Value')) {
$this->_raiseSoapFault ('Parser did not return SOAP_Value object: ' . $request_headers, '', '', 'Server');
if ($request_headers->value ) {
/* Handle headers now. */
foreach ($request_headers->value as $header_val) {
$f_exists = $this->validateMethod($header_val->name , $header_val->namespace );
/* TODO: this does not take into account message routing
$myactor = !$header_val->actor ||
$header_val->actor == 'http://schemas.xmlsoap.org/soap/actor/next' ||
if (!$f_exists && $header_val->mustunderstand && $myactor) {
$this->_raiseSoapFault ('I don\'t understand header ' . $header_val->name , '', '', 'MustUnderstand');
/* We only handle the header if it's for us. */
$isok = $f_exists && $myactor;
/* Call our header now! */
$header_method = $header_val->name;
$header_data = array ($this->_decode ($header_val));
/* If there are parameters to pass. */
$hr = & $this->callMethod($header_method, $header_data);
$header_results[] = array_shift($this->buildResult($hr, $this->return_type, $header_method, $header_val->namespace ));
/* Handle the method call. */
/* Evaluate message, getting back a SOAP_Value object. */
/* Figure out the method namespace. */
$this->method_namespace = $parser->message [$parser->root_struct [0 ]]['namespace'];
$this->_setSchemaVersion ($this->_wsdl->xsd );
$dataHandler = $this->_wsdl->getDataHandler ($this->methodname, $this->method_namespace);
$this->_portName = $this->_wsdl->getPortName ($this->methodname);
if (PEAR ::isError ($this->_portName)) {
return $this->_raiseSoapFault ($this->_portName);
$opData = $this->_wsdl->getOperationData ($this->_portName, $this->methodname);
if (PEAR ::isError ($opData)) {
return $this->_raiseSoapFault ($opData);
$this->__options['style'] = $opData['style'];
$this->__options['use'] = $opData['output']['use'];
$this->__options['parameters'] = $opData['parameters'];
if (!$this->methodname ||
$this->_raiseSoapFault ('method "' . $this->method_namespace . $this->methodname . '" not defined in service', '', '', 'Server');
if (!$request_val = $parser->getResponse ()) {
if (!is_a($request_val, 'SOAP_Value')) {
$this->_raiseSoapFault ('Parser did not return SOAP_Value object: ' . $request_val, '', '', 'Server');
/* Verify that SOAP_Value objects in request match the methods
/* verifyMethod() creates the fault. */
/* Need to set special error detection inside the value class to
* differentiate between no params passed, and an error decoding. */
if (PEAR ::isError ($request_data)) {
return $this->_raiseSoapFault ($request_data);
if ($this->__options['parameters'] ||
$this->__options['style']== 'rpc') {
/* Get the method result. */
$return_val = $this->buildResult($method_response, $this->return_type);
$methodValue = & new SOAP_Value($qn->fqn (), 'Struct', $return_val);
$methodValue = & $method_response;
return $this->_makeEnvelope ($methodValue, $header_results, $this->response_encoding);
/* Check for valid response. */
if (PEAR ::isError ($request)) {
return $this->_raiseSoapFault ($request);
} else if (!is_a($request, 'SOAP_Value')) {
return $this->_raiseSoapFault ('Invalid data in server::__decodeRequest');
/* Decode to native php datatype. */
$requestArray = $this->_decode ($request);
if (PEAR ::isError ($requestArray)) {
return $this->_raiseSoapFault ($requestArray);
} elseif ($this->__options['style'] == 'document') {
$requestArray = array ($requestArray);
if (isset ($requestArray['faultcode']) ||
isset ($requestArray['SOAP-ENV:faultcode'])) {
$faultcode = $faultstring = $faultdetail = $faultactor = '';
foreach ($requestArray as $k => $v) {
return $this->_raiseSoapFault ($faultstring, $faultdetail, $faultactor, $faultcode);
/* Return array of return values. */
if ($shift && count($requestArray) == 1 ) {
$params = $request->value;
/* Get the dispatch map if one exists. */
$map = $this->soapobject->__dispatch ($this->methodname);
/* No map, all public functions are SOAP functions. */
$this->_raiseSoapFault ('SOAP request specified an unhandled method "' . $this->methodname . '"', '', '', 'Client');
/* If we aliased the SOAP method name to a PHP function, change
* call_methodname so we do the right thing. */
/* If there are input parameters required. */
$this->input_value = count($sig);
$this->return_type = is_array($map['out']) ? $map['out'] : false;
/* Validate the number of parameters. */
/* Make array of param types. */
foreach ($params as $param) {
/* Validate each param's type. */
for ($i = 0; $i < count($p); $i++ ) {
/* If SOAP types do not match, it's still fine if the
* mapped php types match this allows using plain PHP
* variables to work (i.e. stuff like Decimal would
* fail otherwise). We consider this only error if the
* types exist in our type maps, and they differ. */
$this->_raiseSoapFault (" SOAP request contained mismatching parameters of name $param->name had type [{$p[$i]}], which did not match signature's type: [{$sig_t[$i]}], matched? " . (strcasecmp($sig_t[$i], $p[$i])), '', '', 'Client');
/* Wrong number of params. */
$this->_raiseSoapFault ('SOAP request contained incorrect number of parameters. method "' . $this->methodname . '" required ' . count($sig) . ' and request provided ' . count($params), '', '', 'Client');
$this->_raiseSoapFault ('SOAP request contained incorrect number of parameters. method "' . $this->methodname . '" requires ' . count($sig) . ' parameters, and request provided none.', '', '', 'Client');
/* We'll try it anyway. */
/* No SOAP access to private functions. */
if ($methodname[0 ] == '_') {
/* if it's in our function list, ok */
$namespace == $this->dispatch_map[$methodname]['namespace'])) {
/* if it's in an object, it's ok */
for ($i = 0; $i < $c; $i++ ) {
/* If we have a dispatch map, and the function is not in the
* dispatch map, then it is not callable! */
if ($obj->__dispatch ($methodname)) {
function addObjectMap(&$obj, $namespace = null , $service_name = 'Default',
if (isset ($obj->namespace )) {
// XXX a bit of backwards compatibility
$namespace = $obj->namespace;
$this->_raiseSoapFault ('No namespace provided for class!', '', '', 'Server');
// Create internal WSDL structures for object
// XXX Because some internal workings of PEAR::SOAP decide whether to
// do certain things by the presence or absence of _wsdl, we should
// only create a _wsdl structure if we know we can fill it; if
// __dispatch_map or __typedef for the object is missing, we should
// avoid creating it. Later, when we are using PHP 5 introspection, we
// will be able to make the data for all objects without any extra
// information from the developers, and this condition should be
// XXX Known issue: if imported WSDL (bindWSDL) or another WSDL source
// is used to add _wsdl structure information, then addObjectWSDL is
// used, there is a high possibility of _wsdl data corruption;
// therefore you should avoid using __dispatch_map/__typedef
// definitions AND other WSDL data sources in the same service. We
// exclude classes that don't have __typedefs to allow external WSDL
// files to be used with classes with no internal type definitions
// (the types are defined in the WSDL file). When addObjectWSDL is
// refactored to not cause corruption, this restriction can be
// In summary, if you add an object with both a dispatch map and type
// definitions, then previous WSDL file operation and type definitions
if (isset ($obj->__dispatch_map ) && isset ($obj->__typedef )) {
$this->addObjectWSDL($obj, $namespace, $service_name, $service_desc);
* Adds a method to the dispatch map.
function addToMap($methodname, $in, $out, $namespace = null , $alias = null )
$this->_raiseSoapFault ('Error mapping function', '', '', 'Server');
* @deprecated use bindWSDL from now on
* @param string a url to a WSDL resource
/* Instantiate WSDL class. */
if ($this->_wsdl->fault ) {
$this->_raiseSoapFault ($this->_wsdl->fault );
function addObjectWSDL(&$wsdl_obj, $targetNamespace, $service_name,
if (!isset ($this->_wsdl)) {
$this->_wsdl->parseObject ($wsdl_obj, $targetNamespace, $service_name, $service_desc);
if ($this->_wsdl->fault ) {
$this->_raiseSoapFault ($this->_wsdl->fault );
Documentation generated on Mon, 11 Mar 2019 14:20:04 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|