BeSimpleSoap/src/BeSimple/SoapClient/SoapClient.php

319 lines
9.3 KiB
PHP
Raw Normal View History

<?php
2011-10-03 21:03:46 +02:00
/*
* This file is part of the BeSimpleSoapClient.
*
* (c) Christian Kerl <christian-kerl@web.de>
* (c) Francis Besset <francis.besset@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace BeSimple\SoapClient;
2011-12-11 21:20:35 +01:00
use BeSimple\SoapCommon\SoapKernel;
/**
2011-10-02 12:23:59 +02:00
* Extended SoapClient that uses a a cURL wrapper for all underlying HTTP
* requests in order to use proper authentication for all requests. This also
* adds NTLM support. A custom WSDL downloader resolves remote xsd:includes and
* allows caching of all remote referenced items.
*
2011-10-22 11:28:15 +02:00
* @author Andreas Schamberger <mail@andreass.net>
*/
class SoapClient extends \SoapClient
{
/**
* Soap version.
*
* @var int
*/
protected $soapVersion = SOAP_1_1;
/**
* Tracing enabled?
*
* @var boolean
*/
protected $tracingEnabled = false;
/**
* cURL instance.
*
* @var \BeSimple\SoapClient\Curl
*/
protected $curl = null;
2011-10-16 19:49:24 +02:00
/**
* Last request headers.
*
* @var string
*/
private $lastRequestHeaders = '';
2011-10-16 19:49:24 +02:00
/**
* Last request.
*
* @var string
*/
private $lastRequest = '';
2011-10-16 19:49:24 +02:00
/**
* Last response headers.
*
* @var string
*/
private $lastResponseHeaders = '';
2011-10-16 19:49:24 +02:00
/**
* Last response.
*
* @var string
*/
private $lastResponse = '';
2011-12-11 21:20:35 +01:00
/**
* Last response.
*
* @var \BeSimple\SoapCommon\SoapKernel
*/
protected $soapKernel = null;
/**
* Constructor.
*
* @param string $wsdl WSDL file
* @param array(string=>mixed) $options Options array
*/
public function __construct($wsdl, array $options = array())
{
// tracing enabled: store last request/response header and body
if (isset($options['trace']) && $options['trace'] === true) {
$this->tracingEnabled = true;
}
// store SOAP version
if (isset($options['soap_version'])) {
$this->soapVersion = $options['soap_version'];
}
$this->curl = new Curl($options);
$wsdlFile = $this->loadWsdl($wsdl, $options);
2011-12-11 21:20:35 +01:00
// TODO $wsdlHandler = new WsdlHandler($wsdlFile, $this->soapVersion);
$this->soapKernel = new SoapKernel();
// we want the exceptions option to be set
$options['exceptions'] = true;
// disable obsolete trace option for native SoapClient as we need to do our own tracing anyways
$options['trace'] = false;
2011-10-16 19:49:24 +02:00
// disable WSDL caching as we handle WSDL caching for remote URLs ourself
$options['cache_wsdl'] = WSDL_CACHE_NONE;
parent::__construct($wsdlFile, $options);
2011-10-16 19:49:24 +02:00
}
/**
* Perform HTTP request with cURL.
*
2011-12-17 16:05:25 +01:00
* @param SoapRequest $soapRequest SoapRequest object
*
2011-12-11 21:20:35 +01:00
* @return SoapResponse
*/
2011-12-11 21:20:35 +01:00
private function __doHttpRequest(SoapRequest $soapRequest)
{
2011-12-11 21:20:35 +01:00
// HTTP headers
$headers = array(
'Content-Type:' . $soapRequest->getContentType(),
'SOAPAction: "' . $soapRequest->getAction() . '"',
);
// execute HTTP request with cURL
$responseSuccessfull = $this->curl->exec($soapRequest->getLocation(),
$soapRequest->getContent(),
2011-12-17 16:05:25 +01:00
$headers);
// tracing enabled: store last request header and body
if ($this->tracingEnabled === true) {
2011-12-11 21:20:35 +01:00
$this->lastRequestHeaders = $this->curl->getRequestHeaders();
$this->lastRequest = $soapRequest->getContent();
}
// in case of an error while making the http request throw a soapFault
2011-10-02 12:23:59 +02:00
if ($responseSuccessfull === false) {
// get error message from curl
$faultstring = $this->curl->getErrorMessage();
2011-12-17 16:05:25 +01:00
throw new \SoapFault('HTTP', $faultstring);
}
// tracing enabled: store last response header and body
if ($this->tracingEnabled === true) {
$this->lastResponseHeaders = $this->curl->getResponseHeaders();
$this->lastResponse = $this->curl->getResponseBody();
}
2011-12-11 21:20:35 +01:00
// wrap response data in SoapResponse object
2011-12-17 16:05:25 +01:00
$soapResponse = SoapResponse::create(
$this->curl->getResponseBody(),
2011-12-11 21:20:35 +01:00
$soapRequest->getLocation(),
$soapRequest->getAction(),
$soapRequest->getVersion(),
2011-12-17 16:05:25 +01:00
$this->curl->getResponseContentType()
);
2011-12-11 21:20:35 +01:00
return $soapResponse;
2011-12-17 16:05:25 +01:00
}
2011-12-17 16:05:25 +01:00
/**
* Custom request method to be able to modify the SOAP messages.
2011-12-11 21:20:35 +01:00
* $oneWay parameter is not used at the moment.
*
2011-12-17 16:05:25 +01:00
* @param string $request Request string
* @param string $location Location
* @param string $action SOAP action
* @param int $version SOAP version
* @param int $oneWay 0|1
*
* @return string
*/
2011-12-11 21:20:35 +01:00
public function __doRequest($request, $location, $action, $version, $oneWay = 0)
{
2011-12-11 21:20:35 +01:00
// wrap request data in SoapRequest object
$soapRequest = SoapRequest::create($request, $location, $action, $version);
// do actual SOAP request
$soapResponse = $this->__doRequest2($soapRequest);
// return SOAP response to ext/soap
2011-12-11 21:20:35 +01:00
return $soapResponse->getContent();
}
/**
* Runs the currently registered request filters on the request, performs
* the HTTP request and runs the response filters.
*
2011-12-17 16:05:25 +01:00
* @param SoapRequest $soapRequest SOAP request object
*
2011-12-11 21:20:35 +01:00
* @return SoapResponse
*/
protected function __doRequest2(SoapRequest $soapRequest)
{
// run SoapKernel on SoapRequest
$soapRequest = $this->soapKernel->filterRequest($soapRequest);
// perform HTTP request with cURL
$soapResponse = $this->__doHttpRequest($soapRequest);
// run SoapKernel on SoapResponse
$soapResponse = $this->soapKernel->filterResponse($soapResponse);
return $soapResponse;
}
/**
* Get last request HTTP headers.
*
* @return string
*/
public function __getLastRequestHeaders()
{
return $this->lastRequestHeaders;
}
/**
* Get last request HTTP body.
*
* @return string
*/
public function __getLastRequest()
{
return $this->lastRequest;
}
/**
* Get last response HTTP headers.
*
* @return string
*/
public function __getLastResponseHeaders()
{
return $this->lastResponseHeaders;
}
/**
* Get last response HTTP body.
*
* @return string
*/
public function __getLastResponse()
{
return $this->lastResponse;
}
2011-12-11 21:20:35 +01:00
/**
* Get SoapKernel instance.
*
* @return \BeSimple\SoapCommon\SoapKernel
*/
public function getSoapKernel()
{
return $this->soapKernel;
}
// TODO finish
protected function isValidSoapResponse()
{
//check if we do have a proper soap status code (if not soapfault)
$responseStatusCode = $this->curl->getResponseStatusCode();
$response = $this->curl->getResponseBody();
if ($responseStatusCode >= 400) {
$isError = 0;
$response = trim($response);
if (strlen($response) == 0) {
$isError = 1;
} else {
$contentType = $this->curl->getResponseContentType();
if ($contentType != 'application/soap+xml'
&& $contentType != 'application/soap+xml') {
2011-12-17 16:05:25 +01:00
if (strncmp($response, "<?xml", 5)) {
2011-12-11 21:20:35 +01:00
$isError = 1;
}
}
}
if ($isError == 1) {
throw new \SoapFault('HTTP', $this->curl->getResponseStatusMessage());
}
} elseif ($responseStatusCode != 200 && $responseStatusCode != 202) {
$dom = new \DOMDocument('1.0');
$dom->loadXML($response);
if ($dom->getElementsByTagNameNS($dom->documentElement->namespaceURI, 'Fault')->length == 0) {
throw new \SoapFault('HTTP', 'HTTP response status must be 200 or 202');
}
}
}
/**
* Downloads WSDL files with cURL. Uses all SoapClient options for
* authentication. Uses the WSDL_CACHE_* constants and the 'soap.wsdl_*'
* ini settings. Does only file caching as SoapClient only supports a file
* name parameter.
*
* @param string $wsdl WSDL file
* @param array(string=>mixed) $options Options array
2011-12-17 16:05:25 +01:00
*
* @return string
*/
private function loadWsdl($wsdl, array $options)
{
// option to resolve wsdl/xsd includes
$resolveRemoteIncludes = true;
if (isset($options['resolve_wsdl_remote_includes'])) {
$resolveRemoteIncludes = $options['resolve_wsdl_remote_includes'];
}
// option to enable cache
$wsdlCache = WSDL_CACHE_DISK;
if (isset($options['cache_wsdl'])) {
$wsdlCache = $options['cache_wsdl'];
}
$wsdlDownloader = new WsdlDownloader($this->curl, $resolveRemoteIncludes, $wsdlCache);
2011-10-02 12:23:59 +02:00
try {
$cacheFileName = $wsdlDownloader->download($wsdl);
} catch (\RuntimeException $e) {
throw new \SoapFault('WSDL', "SOAP-ERROR: Parsing WSDL: Couldn't load from '" . $wsdl . "' : failed to load external entity \"" . $wsdl . "\"");
}
2011-12-11 21:20:35 +01:00
return $cacheFileName;
}
}