SoapServer::handle

dub357 at gmail dot com (2012-02-08 22:54:53)

After much headache and looking through PHP source code, I finally found out why the handle() function would immediately send back a fault with the string "Bad Request".
Turns out that my client was sending valid XML, but the first line of the XML was the actual XML declaration:

<?xml version="1.0" encoding="UTF-8"?>

When the "handle" function in the SoapServer class is called, it first tries to parse the XML.  When the XML document can't be parsed, a "Bad Request" fault is returned and execution of the script immediately stops.  I assume that the XML parser built into PHP (libxml2) already assumes the document to be XML and when it finds the declaration, it thinks it isn't valid.

I added some XML parsing calls to my service before the handle() function is called to check for valid XML and avoid the "Bad Request" fault.  This also allows me to send back a more suitable error message:

<?php
$parser = xml_parser_create("UTF-8");
if (!xml_parse($parser,$HTTP_RAW_POST_DATA,true)){
   $webService->fault("500", "Cannot parse XML: ".
      xml_error_string(xml_get_error_code($parser)).
       " at line: ".xml_get_current_line_number($parser).
       ", column: ".xml_get_current_column_number($parser));
}
?>

prenaud at profideo dot com (2012-01-09 02:23:49)

Please note that when defining several services in one wsdl file, and calling one of those services, you may always get the response for your first service.
This is a known bug. You will find its description and some workarounds here : https://bugs.php.net/bug.php?id=49169

Artur Graniszewski (2009-11-15 10:19:26)

Be aware that SoapServer::handle(); method sends additional HTTP headers to the browser. One of them is "Content-Type: application/soap+xml". If you want to execute SOAP methods locally as a part of SoapClient::__doRequest() (see example at http://pl2.php.net/manual/en/soapclient.dorequest.php ) you may need to reset (override) this header back to "Content-Type: text/html" like so:

<?php
function Add($x,$y) {
  return $x+$y;
}

class LocalSoapClient extends SoapClient {

  function __construct($wsdl, $options) {
    parent::__construct($wsdl, $options);
    $this->server = new SoapServer($wsdl, $options);
    $this->server->addFunction('Add');
  }

  function __doRequest($request, $location, $action, $version) {
    ob_start();
    $this->server->handle($request);
    $response = ob_get_contents();
    ob_end_clean();
    return $response;
  }

}

$x = new LocalSoapClient(NULL,array('location'=>'test://', 
                                   'uri'=>'http://testuri.org')); 

header("Content-Type: text/html");

var_dump($x->Add(3,4));

?>

tom at backslashinteractive dot com (2008-10-03 10:54:58)

In response to Blizzke:
Sometimes this problem can be hidden by an Apache segmentation fault along with an HTTP headers error SoapFault thrown to the client.
If you get either of those 2, try checking to make sure that style="rpc" in your WSDL file's soap:operation's.
-T

Blizzke at gmail dot com (2008-03-12 04:39:13)

Seems pretty logical once you find the solution, but it took me quite a while to figure this one out:
If you are using WSDL based SOAP requests and you have more than one operation in your binding (with the same parameters), make sure the <soap:operation> style is set to rpc, NOT body!

When you specify 'body' here, all that will be transmitted in the request is the parameters for the function call, and SoapServer->handle() will use the first function it finds with the same parameter-makeup to handle the call.

ie If you have 2 functions:
<?php
function One ( string $blah );
function Two ( string $blah );
?>
Making a client call with SoapClient -> Two ( 'test' ); will result in One ( ) being called when your 'type' is set to 'body'

The actual method to call will only be included in the request when your type is set to 'rpc', resulting in the expected behavior

king dot maxemilian at noos dot fr (2007-08-21 09:23:37)

Sometime, it happens that PHP does not detect anything in $HTTP_RAW_POST_DATA.
To solve this problem and make it work in any case:
function soaputils_autoFindSoapRequest() {
global $HTTP_RAW_POST_DATA;

if($HTTP_RAW_POST_DATA)
return $HTTP_RAW_POST_DATA;

$f = file("php://input");
return implode(" ", $f);
}
$server = new SoapServer($wsdl);
$server->setClass($MyClass);
$server->handle(soaputils_autoFindSoapRequest());