Added SwA to Client
This commit is contained in:
parent
7cc928a111
commit
c5ccd89949
|
@ -28,11 +28,29 @@ use BeSimple\SoapCommon\SoapResponseFilter;
|
||||||
*/
|
*/
|
||||||
class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* Attachment type.
|
||||||
|
*
|
||||||
|
* @var int Helper::ATTACHMENTS_TYPE_SWA | Helper::ATTACHMENTS_TYPE_MTOM
|
||||||
|
*/
|
||||||
|
protected $attachmentType = Helper::ATTACHMENTS_TYPE_SWA;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructor.
|
||||||
|
*
|
||||||
|
* @param int $attachmentType Helper::ATTACHMENTS_TYPE_SWA | Helper::ATTACHMENTS_TYPE_MTOM
|
||||||
|
*/
|
||||||
|
public function __construct($attachmentType)
|
||||||
|
{
|
||||||
|
$this->attachmentType = $attachmentType;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Reset all properties to default values.
|
* Reset all properties to default values.
|
||||||
*/
|
*/
|
||||||
public function resetFilter()
|
public function resetFilter()
|
||||||
{
|
{
|
||||||
|
$this->attachmentType = Helper::ATTACHMENTS_TYPE_SWA;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -44,8 +62,8 @@ class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
||||||
*/
|
*/
|
||||||
public function filterRequest(CommonSoapRequest $request)
|
public function filterRequest(CommonSoapRequest $request)
|
||||||
{
|
{
|
||||||
// TODO get from request object
|
// get attachments from request object
|
||||||
$attachmentsToSend = array();
|
$attachmentsToSend = $request->getAttachments();
|
||||||
|
|
||||||
// build mime message if we have attachments
|
// build mime message if we have attachments
|
||||||
if (count($attachmentsToSend) > 0) {
|
if (count($attachmentsToSend) > 0) {
|
||||||
|
@ -53,8 +71,7 @@ class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
||||||
$soapPart = new MimePart($request->getContent(), 'text/xml', 'utf-8', MimePart::ENCODING_EIGHT_BIT);
|
$soapPart = new MimePart($request->getContent(), 'text/xml', 'utf-8', MimePart::ENCODING_EIGHT_BIT);
|
||||||
$soapVersion = $request->getVersion();
|
$soapVersion = $request->getVersion();
|
||||||
// change content type headers for MTOM with SOAP 1.1
|
// change content type headers for MTOM with SOAP 1.1
|
||||||
// TODO attachment type option!!!!!!!!!1
|
if ($soapVersion == SOAP_1_1 && $this->attachmentType & Helper::ATTACHMENTS_TYPE_MTOM) {
|
||||||
if ($soapVersion == SOAP_1_1 && $this->options['features_mime'] & Helper::ATTACHMENTS_TYPE_MTOM) {
|
|
||||||
$multipart->setHeader('Content-Type', 'type', 'application/xop+xml');
|
$multipart->setHeader('Content-Type', 'type', 'application/xop+xml');
|
||||||
$multipart->setHeader('Content-Type', 'start-info', 'text/xml');
|
$multipart->setHeader('Content-Type', 'start-info', 'text/xml');
|
||||||
$soapPart->setHeader('Content-Type', 'application/xop+xml');
|
$soapPart->setHeader('Content-Type', 'application/xop+xml');
|
||||||
|
@ -69,8 +86,13 @@ class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
||||||
foreach ($attachmentsToSend as $cid => $attachment) {
|
foreach ($attachmentsToSend as $cid => $attachment) {
|
||||||
$multipart->addPart($attachment, false);
|
$multipart->addPart($attachment, false);
|
||||||
}
|
}
|
||||||
$request = $multipart->getMimeMessage();
|
$request->setContent($multipart->getMimeMessage());
|
||||||
|
|
||||||
|
// TODO
|
||||||
$headers = $multipart->getHeadersForHttp();
|
$headers = $multipart->getHeadersForHttp();
|
||||||
|
list($name, $contentType) = explode(': ', $headers[0]);
|
||||||
|
|
||||||
|
$request->setContentType($contentType);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -83,6 +105,7 @@ class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
||||||
*/
|
*/
|
||||||
public function filterResponse(CommonSoapResponse $response)
|
public function filterResponse(CommonSoapResponse $response)
|
||||||
{
|
{
|
||||||
|
// array to store attachments
|
||||||
$attachmentsRecieved = array();
|
$attachmentsRecieved = array();
|
||||||
|
|
||||||
// check content type if it is a multipart mime message
|
// check content type if it is a multipart mime message
|
||||||
|
@ -90,12 +113,15 @@ class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
||||||
if (false !== stripos($responseContentType, 'multipart/related')) {
|
if (false !== stripos($responseContentType, 'multipart/related')) {
|
||||||
// parse mime message
|
// parse mime message
|
||||||
$headers = array(
|
$headers = array(
|
||||||
'Content-Type' => $responseContentType,
|
'Content-Type' => trim($responseContentType),
|
||||||
);
|
);
|
||||||
$multipart = MimeParser::parseMimeMessage($response->getContent(), $headers);
|
$multipart = MimeParser::parseMimeMessage($response->getContent(), $headers);
|
||||||
// get soap payload and update SoapResponse object
|
// get soap payload and update SoapResponse object
|
||||||
$soapPart = $multipart->getPart();
|
$soapPart = $multipart->getPart();
|
||||||
$response->setContent($soapPart->getContent());
|
// convert href -> myhref for external references as PHP throws exception in this case
|
||||||
|
// http://svn.php.net/viewvc/php/php-src/branches/PHP_5_4/ext/soap/php_encoding.c?view=markup#l3436
|
||||||
|
$content = preg_replace('/href=(?!#)/', 'myhref=', $soapPart->getContent());
|
||||||
|
$response->setContent($content);
|
||||||
$response->setContentType($soapPart->getHeader('Content-Type'));
|
$response->setContentType($soapPart->getHeader('Content-Type'));
|
||||||
// store attachments
|
// store attachments
|
||||||
$attachments = $multipart->getParts(false);
|
$attachments = $multipart->getParts(false);
|
||||||
|
@ -104,9 +130,9 @@ class MimeFilter implements SoapRequestFilter, SoapResponseFilter
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// add attachment to request object
|
// add attachments to response object
|
||||||
if (count($attachmentsRecieved) > 0) {
|
if (count($attachmentsRecieved) > 0) {
|
||||||
// TODO add to response object
|
$response->setAttachments($attachmentsRecieved);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
|
@ -0,0 +1,93 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 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;
|
||||||
|
|
||||||
|
use BeSimple\SoapCommon\Helper;
|
||||||
|
use BeSimple\SoapCommon\Mime\Part as MimePart;
|
||||||
|
use BeSimple\SoapCommon\SoapKernel;
|
||||||
|
use BeSimple\SoapCommon\SoapRequest as CommonSoapRequest;
|
||||||
|
use BeSimple\SoapCommon\SoapResponse as CommonSoapResponse;
|
||||||
|
use BeSimple\SoapCommon\Converter\TypeConverterInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* MTOM type converter.
|
||||||
|
*
|
||||||
|
* @author Andreas Schamberger <mail@andreass.net>
|
||||||
|
*/
|
||||||
|
class MtomTypeConverter
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function getTypeNamespace()
|
||||||
|
{
|
||||||
|
return 'http://www.w3.org/2001/XMLSchema';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function getTypeName()
|
||||||
|
{
|
||||||
|
return 'base64Binary';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function convertXmlToPhp($data, $soapKernel)
|
||||||
|
{
|
||||||
|
$doc = new \DOMDocument();
|
||||||
|
$doc->loadXML($data);
|
||||||
|
|
||||||
|
$includes = $doc->getElementsByTagNameNS(Helper::NS_XOP, 'Include');
|
||||||
|
$include = $includes->item(0);
|
||||||
|
|
||||||
|
$ref = $include->getAttribute('myhref');
|
||||||
|
|
||||||
|
if ('cid:' === substr($ref, 0, 4)) {
|
||||||
|
$contentId = urldecode(substr($ref, 4));
|
||||||
|
|
||||||
|
if (null !== ($part = $soapKernel->getAttachment($contentId))) {
|
||||||
|
|
||||||
|
return $part->getContent();
|
||||||
|
} else {
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function convertPhpToXml($data, $soapKernel)
|
||||||
|
{
|
||||||
|
$part = new MimePart($data);
|
||||||
|
$contentId = trim($part->getHeader('Content-ID'), '<>');
|
||||||
|
|
||||||
|
$soapKernel->addAttachment($part);
|
||||||
|
|
||||||
|
$doc = new \DOMDocument();
|
||||||
|
$node = $doc->createElement($this->getTypeName());
|
||||||
|
|
||||||
|
// add xop:Include element
|
||||||
|
$xinclude = $doc->createElementNS(Helper::NS_XOP, Helper::PFX_XOP . ':Include');
|
||||||
|
$xinclude->setAttribute('href', 'cid:' . $contentId);
|
||||||
|
$node->appendChild($xinclude);
|
||||||
|
|
||||||
|
return $doc->saveXML();
|
||||||
|
}
|
||||||
|
}
|
|
@ -12,6 +12,7 @@
|
||||||
|
|
||||||
namespace BeSimple\SoapClient;
|
namespace BeSimple\SoapClient;
|
||||||
|
|
||||||
|
use BeSimple\SoapCommon\Helper;
|
||||||
use BeSimple\SoapCommon\SoapKernel;
|
use BeSimple\SoapCommon\SoapKernel;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -24,6 +25,13 @@ use BeSimple\SoapCommon\SoapKernel;
|
||||||
*/
|
*/
|
||||||
class SoapClient extends \SoapClient
|
class SoapClient extends \SoapClient
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* SOAP attachment type.
|
||||||
|
*
|
||||||
|
* @var int
|
||||||
|
*/
|
||||||
|
protected $attachmentType = Helper::ATTACHMENTS_TYPE_BASE64;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Soap version.
|
* Soap version.
|
||||||
*
|
*
|
||||||
|
@ -96,10 +104,16 @@ class SoapClient extends \SoapClient
|
||||||
if (isset($options['soap_version'])) {
|
if (isset($options['soap_version'])) {
|
||||||
$this->soapVersion = $options['soap_version'];
|
$this->soapVersion = $options['soap_version'];
|
||||||
}
|
}
|
||||||
|
// attachment handling
|
||||||
|
if (isset($options['attachment_type'])) {
|
||||||
|
$this->attachmentType = $options['attachment_type'];
|
||||||
|
}
|
||||||
$this->curl = new Curl($options);
|
$this->curl = new Curl($options);
|
||||||
$wsdlFile = $this->loadWsdl($wsdl, $options);
|
$wsdlFile = $this->loadWsdl($wsdl, $options);
|
||||||
// TODO $wsdlHandler = new WsdlHandler($wsdlFile, $this->soapVersion);
|
// TODO $wsdlHandler = new WsdlHandler($wsdlFile, $this->soapVersion);
|
||||||
$this->soapKernel = new SoapKernel();
|
$this->soapKernel = new SoapKernel();
|
||||||
|
// set up type converter and mime filter
|
||||||
|
$this->configureMime($options);
|
||||||
// we want the exceptions option to be set
|
// we want the exceptions option to be set
|
||||||
$options['exceptions'] = true;
|
$options['exceptions'] = true;
|
||||||
// disable obsolete trace option for native SoapClient as we need to do our own tracing anyways
|
// disable obsolete trace option for native SoapClient as we need to do our own tracing anyways
|
||||||
|
@ -244,6 +258,43 @@ class SoapClient extends \SoapClient
|
||||||
return $this->lastResponse;
|
return $this->lastResponse;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Configure filter and type converter for SwA/MTOM.
|
||||||
|
*
|
||||||
|
* @param array &$options SOAP constructor options array.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
private function configureMime(array &$options)
|
||||||
|
{
|
||||||
|
if (Helper::ATTACHMENTS_TYPE_BASE64 !== $this->attachmentType) {
|
||||||
|
// register mime filter in SoapKernel
|
||||||
|
$mimeFilter = new MimeFilter($this->attachmentType);
|
||||||
|
$this->soapKernel->registerFilter($mimeFilter);
|
||||||
|
// configure type converter
|
||||||
|
if (Helper::ATTACHMENTS_TYPE_SWA === $this->attachmentType) {
|
||||||
|
$converter = new SwaTypeConverter();
|
||||||
|
} elseif (Helper::ATTACHMENTS_TYPE_MTOM === $this->attachmentType) {
|
||||||
|
$converter = new MtomTypeConverter();
|
||||||
|
}
|
||||||
|
// configure typemap
|
||||||
|
if (!isset($options['typemap'])) {
|
||||||
|
$options['typemap'] = array();
|
||||||
|
}
|
||||||
|
$soapKernel = $this->soapKernel;
|
||||||
|
$options['typemap'][] = array(
|
||||||
|
'type_name' => $converter->getTypeName(),
|
||||||
|
'type_ns' => $converter->getTypeNamespace(),
|
||||||
|
'from_xml' => function($input) use ($converter, $soapKernel) {
|
||||||
|
return $converter->convertXmlToPhp($input, $soapKernel);
|
||||||
|
},
|
||||||
|
'to_xml' => function($input) use ($converter, $soapKernel) {
|
||||||
|
return $converter->convertPhpToXml($input, $soapKernel);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get SoapKernel instance.
|
* Get SoapKernel instance.
|
||||||
*
|
*
|
||||||
|
|
|
@ -0,0 +1,82 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 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;
|
||||||
|
|
||||||
|
use BeSimple\SoapCommon\Helper;
|
||||||
|
use BeSimple\SoapCommon\Mime\Part as MimePart;
|
||||||
|
use BeSimple\SoapCommon\SoapKernel;
|
||||||
|
use BeSimple\SoapCommon\SoapRequest as CommonSoapRequest;
|
||||||
|
use BeSimple\SoapCommon\SoapResponse as CommonSoapResponse;
|
||||||
|
use BeSimple\SoapCommon\Converter\TypeConverterInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SwA type converter.
|
||||||
|
*
|
||||||
|
* @author Andreas Schamberger <mail@andreass.net>
|
||||||
|
*/
|
||||||
|
class SwaTypeConverter
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function getTypeNamespace()
|
||||||
|
{
|
||||||
|
return 'http://www.w3.org/2001/XMLSchema';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function getTypeName()
|
||||||
|
{
|
||||||
|
return 'base64Binary';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function convertXmlToPhp($data, $soapKernel)
|
||||||
|
{
|
||||||
|
$doc = new \DOMDocument();
|
||||||
|
$doc->loadXML($data);
|
||||||
|
|
||||||
|
$ref = $doc->documentElement->getAttribute('myhref');
|
||||||
|
|
||||||
|
if ('cid:' === substr($ref, 0, 4)) {
|
||||||
|
$contentId = urldecode(substr($ref, 4));
|
||||||
|
|
||||||
|
if (null !== ($part = $soapKernel->getAttachment($contentId))) {
|
||||||
|
|
||||||
|
return $part->getContent();
|
||||||
|
} else {
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritDoc}
|
||||||
|
*/
|
||||||
|
public function convertPhpToXml($data, $soapKernel)
|
||||||
|
{
|
||||||
|
$part = new MimePart($data);
|
||||||
|
$contentId = trim($part->getHeader('Content-ID'), '<>');
|
||||||
|
|
||||||
|
$soapKernel->addAttachment($part);
|
||||||
|
|
||||||
|
return sprintf('<%s href="%s"/>', $this->getTypeName(), $contentId);
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue