WsdlDownloader fix: remote includes now work correctly with relative URLs & tests added
This commit is contained in:
parent
b650254d54
commit
6970b7bbef
|
@ -13,6 +13,8 @@
|
||||||
namespace BeSimple\SoapClient;
|
namespace BeSimple\SoapClient;
|
||||||
|
|
||||||
use BeSimple\SoapClient\Curl\Curl;
|
use BeSimple\SoapClient\Curl\Curl;
|
||||||
|
use BeSimple\SoapClient\Xml\RemoteFileResolver;
|
||||||
|
use BeSimple\SoapClient\Xml\XmlFileDomDocumentProcessor;
|
||||||
use BeSimple\SoapCommon\Cache;
|
use BeSimple\SoapCommon\Cache;
|
||||||
use BeSimple\SoapCommon\Helper;
|
use BeSimple\SoapCommon\Helper;
|
||||||
use DOMDocument;
|
use DOMDocument;
|
||||||
|
@ -30,6 +32,11 @@ use Exception;
|
||||||
*/
|
*/
|
||||||
class WsdlDownloader
|
class WsdlDownloader
|
||||||
{
|
{
|
||||||
|
public static function instantiateDownloader()
|
||||||
|
{
|
||||||
|
return new self();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param Curl $curl
|
* @param Curl $curl
|
||||||
* @param string $wsdlPath WSDL file URL/path
|
* @param string $wsdlPath WSDL file URL/path
|
||||||
|
@ -39,10 +46,10 @@ class WsdlDownloader
|
||||||
*/
|
*/
|
||||||
public function getWsdlPath(Curl $curl, $wsdlPath, $wsdCacheType, $resolveRemoteIncludes = true)
|
public function getWsdlPath(Curl $curl, $wsdlPath, $wsdCacheType, $resolveRemoteIncludes = true)
|
||||||
{
|
{
|
||||||
$isRemoteFile = $this->isRemoteFile($wsdlPath);
|
$isRemoteFile = RemoteFileResolver::instantiateResolver()->isRemoteFile($wsdlPath);
|
||||||
$isCacheEnabled = $wsdCacheType === Cache::TYPE_NONE ? false : Cache::isEnabled();
|
$isCacheEnabled = $wsdCacheType === Cache::TYPE_NONE ? false : Cache::isEnabled();
|
||||||
if ($isCacheEnabled === true) {
|
if ($isCacheEnabled === true) {
|
||||||
$cacheFilePath = Cache::getDirectory().DIRECTORY_SEPARATOR.'wsdl_'.md5($wsdlPath).'.cache';
|
$cacheFilePath = Cache::getDirectory() . DIRECTORY_SEPARATOR . 'wsdl_' . md5($wsdlPath) . '.cache';
|
||||||
$isCacheExisting = file_exists($cacheFilePath);
|
$isCacheExisting = file_exists($cacheFilePath);
|
||||||
if ($isCacheExisting) {
|
if ($isCacheExisting) {
|
||||||
$fileModificationTime = filemtime($cacheFilePath);
|
$fileModificationTime = filemtime($cacheFilePath);
|
||||||
|
@ -54,46 +61,17 @@ class WsdlDownloader
|
||||||
$isCacheExisting = $isCacheValid = false;
|
$isCacheExisting = $isCacheValid = false;
|
||||||
}
|
}
|
||||||
if ($isCacheExisting === false || $isCacheValid === false) {
|
if ($isCacheExisting === false || $isCacheValid === false) {
|
||||||
$this->writeCacheFile($curl, $wsdCacheType, $wsdlPath, $cacheFilePath, $resolveRemoteIncludes, $isRemoteFile);
|
XmlFileDomDocumentProcessor::writeCacheFile($curl, $wsdCacheType, $wsdlPath, $cacheFilePath, $resolveRemoteIncludes, $isRemoteFile);
|
||||||
}
|
}
|
||||||
|
|
||||||
return $this->getLocalWsdlPath($cacheFilePath);
|
return $this->getLocalWsdlPath($cacheFilePath);
|
||||||
|
|
||||||
} else {
|
|
||||||
|
|
||||||
if ($isRemoteFile === true) {
|
|
||||||
return $wsdlPath;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $this->getLocalWsdlPath($wsdlPath);
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
private function writeCacheFile(Curl $curl, $cacheType, $wsdlPath, $cacheFilePath, $resolveRemoteIncludes, $isRemoteFile)
|
|
||||||
{
|
|
||||||
if ($isRemoteFile === true) {
|
if ($isRemoteFile === true) {
|
||||||
$curlResponse = $curl->executeCurlWithCachedSession($wsdlPath);
|
return $wsdlPath;
|
||||||
if ($curlResponse->curlStatusSuccess()) {
|
|
||||||
if (mb_strlen($curlResponse->getResponseBody()) === 0) {
|
|
||||||
throw new Exception('Could not write WSDL cache file: empty curl response from: '.$wsdlPath);
|
|
||||||
}
|
|
||||||
if ($resolveRemoteIncludes === true) {
|
|
||||||
$document = $this->getXmlFileDomDocument($curl, $cacheType, $curlResponse->getResponseBody(), $wsdlPath);
|
|
||||||
$this->saveXmlDomDocument($document, $cacheFilePath);
|
|
||||||
} else {
|
|
||||||
file_put_contents($cacheFilePath, $curlResponse->getResponseBody());
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
throw new Exception('Could not write WSDL cache file: Download failed with message: '.$curlResponse->getCurlErrorMessage());
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if (file_exists($wsdlPath)) {
|
|
||||||
$document = $this->getXmlFileDomDocument($curl, $cacheType, file_get_contents($wsdlPath));
|
|
||||||
$this->saveXmlDomDocument($document, $cacheFilePath);
|
|
||||||
} else {
|
|
||||||
throw new Exception('Could write WSDL cache file: local file does not exist: '.$wsdlPath);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return $this->getLocalWsdlPath($wsdlPath);
|
||||||
}
|
}
|
||||||
|
|
||||||
private function getLocalWsdlPath($wsdlPath)
|
private function getLocalWsdlPath($wsdlPath)
|
||||||
|
@ -104,164 +82,6 @@ class WsdlDownloader
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
throw new Exception('Could not download WSDL: local file does not exist: '.$wsdlPath);
|
throw new Exception('Could not download WSDL: local file does not exist: ' . $wsdlPath);
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $wsdlPath File URL/path
|
|
||||||
* @return boolean
|
|
||||||
*/
|
|
||||||
private function isRemoteFile($wsdlPath)
|
|
||||||
{
|
|
||||||
$parsedUrlOrFalse = @parse_url($wsdlPath);
|
|
||||||
if ($parsedUrlOrFalse !== false) {
|
|
||||||
if (isset($parsedUrlOrFalse['scheme']) && substr($parsedUrlOrFalse['scheme'], 0, 4) === 'http') {
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Exception('Could not determine wsdlPath is remote: '.$wsdlPath);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Resolves remote WSDL/XSD includes within the WSDL files.
|
|
||||||
*
|
|
||||||
* @param Curl $curl
|
|
||||||
* @param int $cacheType
|
|
||||||
* @param string $xmlFileSource XML file contents
|
|
||||||
* @param boolean $parentFilePath Parent file name
|
|
||||||
* @return DOMDocument
|
|
||||||
*/
|
|
||||||
private function getXmlFileDomDocument(Curl $curl, $cacheType, $xmlFileSource, $parentFilePath = null)
|
|
||||||
{
|
|
||||||
$document = new DOMDocument('1.0', 'utf-8');
|
|
||||||
if ($document->loadXML($xmlFileSource) === false) {
|
|
||||||
throw new Exception('Could not save downloaded WSDL cache: '.$xmlFileSource);
|
|
||||||
}
|
|
||||||
|
|
||||||
$xpath = new DOMXPath($document);
|
|
||||||
$this->updateXmlDocument($curl, $cacheType, $xpath, Helper::PFX_WSDL, Helper::NS_WSDL, 'location', $parentFilePath);
|
|
||||||
$this->updateXmlDocument($curl, $cacheType, $xpath, Helper::PFX_XML_SCHEMA, Helper::NS_XML_SCHEMA, 'schemaLocation', $parentFilePath);
|
|
||||||
|
|
||||||
return $document;
|
|
||||||
}
|
|
||||||
|
|
||||||
private function saveXmlDomDocument(DOMDocument $document, $cacheFilePath)
|
|
||||||
{
|
|
||||||
try {
|
|
||||||
$xmlContents = $document->saveXML();
|
|
||||||
if ($xmlContents === '') {
|
|
||||||
throw new Exception('Could not write WSDL cache file: DOMDocument returned empty XML file');
|
|
||||||
}
|
|
||||||
file_put_contents($cacheFilePath, $xmlContents);
|
|
||||||
} catch (Exception $e) {
|
|
||||||
unlink($cacheFilePath);
|
|
||||||
throw new Exception('Could not write WSDL cache file: save method returned error: ' . $e->getMessage());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private function updateXmlDocument(
|
|
||||||
Curl $curl,
|
|
||||||
$cacheType,
|
|
||||||
DOMXPath $xpath,
|
|
||||||
$schemaPrefix,
|
|
||||||
$schemaUrl,
|
|
||||||
$locationAttributeName,
|
|
||||||
$parentFilePath = null
|
|
||||||
) {
|
|
||||||
$xpath->registerNamespace($schemaPrefix, $schemaUrl);
|
|
||||||
$nodes = $xpath->query('.//'.$schemaPrefix.':include | .//'.$schemaPrefix.':import');
|
|
||||||
if ($nodes->length > 0) {
|
|
||||||
foreach ($nodes as $node) {
|
|
||||||
/** @var DOMElement $node */
|
|
||||||
$locationPath = $node->getAttribute($locationAttributeName);
|
|
||||||
if ($locationPath !== '') {
|
|
||||||
if ($this->isRemoteFile($locationPath)) {
|
|
||||||
$node->setAttribute(
|
|
||||||
$locationAttributeName,
|
|
||||||
$this->getWsdlPath(
|
|
||||||
$curl,
|
|
||||||
$locationPath,
|
|
||||||
$cacheType,
|
|
||||||
true
|
|
||||||
)
|
|
||||||
);
|
|
||||||
} elseif ($parentFilePath !== null) {
|
|
||||||
$node->setAttribute(
|
|
||||||
$locationAttributeName,
|
|
||||||
$this->getWsdlPath(
|
|
||||||
$curl,
|
|
||||||
$this->resolveRelativePathInUrl($parentFilePath, $locationPath),
|
|
||||||
$cacheType,
|
|
||||||
true
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Resolves the relative path to base into an absolute.
|
|
||||||
*
|
|
||||||
* @param string $base Base path
|
|
||||||
* @param string $relative Relative path
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
private function resolveRelativePathInUrl($base, $relative)
|
|
||||||
{
|
|
||||||
$urlParts = parse_url($base);
|
|
||||||
|
|
||||||
// combine base path with relative path
|
|
||||||
if (isset($urlParts['path']) && mb_strlen($relative) > 0 && '/' === $relative{0}) {
|
|
||||||
// $relative is absolute path from domain (starts with /)
|
|
||||||
$path = $relative;
|
|
||||||
} elseif (isset($urlParts['path']) && strrpos($urlParts['path'], '/') === (strlen($urlParts['path']) )) {
|
|
||||||
// base path is directory
|
|
||||||
$path = $urlParts['path'].$relative;
|
|
||||||
} elseif (isset($urlParts['path'])) {
|
|
||||||
// strip filename from base path
|
|
||||||
$path = substr($urlParts['path'], 0, strrpos($urlParts['path'], '/')).'/'.$relative;
|
|
||||||
} else {
|
|
||||||
// no base path
|
|
||||||
$path = '/'.$relative;
|
|
||||||
}
|
|
||||||
|
|
||||||
// foo/./bar ==> foo/bar
|
|
||||||
// remove double slashes
|
|
||||||
$path = preg_replace(array('#/\./#', '#/+#'), '/', $path);
|
|
||||||
|
|
||||||
// split path by '/'
|
|
||||||
$parts = explode('/', $path);
|
|
||||||
|
|
||||||
// resolve /../
|
|
||||||
foreach ($parts as $key => $part) {
|
|
||||||
if ($part === '..') {
|
|
||||||
$keyToDelete = $key - 1;
|
|
||||||
while ($keyToDelete > 0) {
|
|
||||||
if (isset($parts[$keyToDelete])) {
|
|
||||||
unset($parts[$keyToDelete]);
|
|
||||||
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
$keyToDelete--;
|
|
||||||
}
|
|
||||||
|
|
||||||
unset($parts[$key]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$hostname = $urlParts['scheme'].'://'.$urlParts['host'];
|
|
||||||
if (isset($urlParts['port'])) {
|
|
||||||
$hostname .= ':'.$urlParts['port'];
|
|
||||||
}
|
|
||||||
|
|
||||||
return $hostname.implode('/', $parts);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,75 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BeSimple\SoapClient\Xml\Path;
|
||||||
|
|
||||||
|
class RelativePathResolver
|
||||||
|
{
|
||||||
|
public static function instantiateResolver()
|
||||||
|
{
|
||||||
|
return new self();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves the relative path to base into an absolute.
|
||||||
|
*
|
||||||
|
* @param string $base Base path
|
||||||
|
* @param string $relative Relative path
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function resolveRelativePathInUrl($base, $relative)
|
||||||
|
{
|
||||||
|
$urlParts = parse_url($base);
|
||||||
|
$isRelativePathAbsolute = 0 === strpos($relative, '/') || 0 === strpos($relative, '..');
|
||||||
|
|
||||||
|
// combine base path with relative path
|
||||||
|
if (isset($urlParts['path']) && mb_strlen($relative) > 0 && $isRelativePathAbsolute) {
|
||||||
|
// $relative is absolute path from domain (starts with /)
|
||||||
|
$path = $relative;
|
||||||
|
} elseif (isset($urlParts['path']) && strrpos($urlParts['path'], '/') === (strlen($urlParts['path']) )) {
|
||||||
|
// base path is directory
|
||||||
|
$path = $urlParts['path'].$relative;
|
||||||
|
} elseif (isset($urlParts['path'])) {
|
||||||
|
// strip filename from base path
|
||||||
|
$path = substr($urlParts['path'], 0, strrpos($urlParts['path'], '/')).'/'.$relative;
|
||||||
|
} else {
|
||||||
|
// no base path
|
||||||
|
$path = '/'.$relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
// foo/./bar ==> foo/bar
|
||||||
|
// remove double slashes
|
||||||
|
$path = preg_replace(array('#/\./#', '#/+#'), '/', $path);
|
||||||
|
|
||||||
|
// split path by '/'
|
||||||
|
$parts = explode('/', $path);
|
||||||
|
|
||||||
|
// resolve /../
|
||||||
|
foreach ($parts as $key => $part) {
|
||||||
|
if ($part === '..') {
|
||||||
|
$keyToDelete = $key - 1;
|
||||||
|
while ($keyToDelete > 0) {
|
||||||
|
if (isset($parts[$keyToDelete])) {
|
||||||
|
unset($parts[$keyToDelete]);
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
$keyToDelete--;
|
||||||
|
}
|
||||||
|
|
||||||
|
unset($parts[$key]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$hostname = $urlParts['scheme'].'://'.$urlParts['host'];
|
||||||
|
if (isset($urlParts['port'])) {
|
||||||
|
$hostname .= ':'.$urlParts['port'];
|
||||||
|
}
|
||||||
|
$implodedParts = implode('/', $parts);
|
||||||
|
if (substr($implodedParts, 0, 1) !== '/') {
|
||||||
|
$implodedParts = '/'.$implodedParts;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $hostname.$implodedParts;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,32 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BeSimple\SoapClient\Xml;
|
||||||
|
|
||||||
|
use Exception;
|
||||||
|
|
||||||
|
class RemoteFileResolver
|
||||||
|
{
|
||||||
|
public static function instantiateResolver()
|
||||||
|
{
|
||||||
|
return new self();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $wsdlPath File URL/path
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
|
public function isRemoteFile($wsdlPath)
|
||||||
|
{
|
||||||
|
$parsedUrlOrFalse = @parse_url($wsdlPath);
|
||||||
|
if ($parsedUrlOrFalse !== false) {
|
||||||
|
if (isset($parsedUrlOrFalse['scheme']) && strpos($parsedUrlOrFalse['scheme'], 'http') === 0) {
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new Exception('Could not determine wsdlPath is remote: '.$wsdlPath);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BeSimple\SoapClient\Xml;
|
||||||
|
|
||||||
|
use BeSimple\SoapClient\Curl\Curl;
|
||||||
|
use BeSimple\SoapClient\WsdlDownloader;
|
||||||
|
use DOMElement;
|
||||||
|
use DOMXPath;
|
||||||
|
|
||||||
|
class XmlDomDocumentImportReplacer
|
||||||
|
{
|
||||||
|
public static function instantiateReplacer()
|
||||||
|
{
|
||||||
|
return new self();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function updateXmlDocument(
|
||||||
|
Curl $curl,
|
||||||
|
$cacheType,
|
||||||
|
DOMXPath $xpath,
|
||||||
|
$schemaPrefix,
|
||||||
|
$schemaUrl,
|
||||||
|
$locationAttributeName,
|
||||||
|
$parentFilePath = null
|
||||||
|
) {
|
||||||
|
$xpath->registerNamespace($schemaPrefix, $schemaUrl);
|
||||||
|
$nodes = $xpath->query('.//'.$schemaPrefix.':include | .//'.$schemaPrefix.':import');
|
||||||
|
if ($nodes->length > 0) {
|
||||||
|
foreach ($nodes as $node) {
|
||||||
|
/** @var DOMElement $node */
|
||||||
|
$locationPath = $node->getAttribute($locationAttributeName);
|
||||||
|
if ($locationPath !== '') {
|
||||||
|
if (RemoteFileResolver::instantiateResolver()->isRemoteFile($locationPath)) {
|
||||||
|
$node->setAttribute(
|
||||||
|
$locationAttributeName,
|
||||||
|
WsdlDownloader::instantiateDownloader()->getWsdlPath(
|
||||||
|
$curl,
|
||||||
|
$locationPath,
|
||||||
|
$cacheType,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
);
|
||||||
|
} elseif ($parentFilePath !== null) {
|
||||||
|
$node->setAttribute(
|
||||||
|
$locationAttributeName,
|
||||||
|
WsdlDownloader::instantiateDownloader()->getWsdlPath(
|
||||||
|
$curl,
|
||||||
|
self::resolveRelativePathInUrl($parentFilePath, $locationPath),
|
||||||
|
$cacheType,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves the relative path to base into an absolute.
|
||||||
|
*
|
||||||
|
* @param string $base Base path
|
||||||
|
* @param string $relative Relative path
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private static function resolveRelativePathInUrl($base, $relative)
|
||||||
|
{
|
||||||
|
$urlParts = parse_url($base);
|
||||||
|
$isRelativePathAbsolute = 0 === strpos($relative, '/') || 0 === strpos($relative, '..');
|
||||||
|
|
||||||
|
// combine base path with relative path
|
||||||
|
if (isset($urlParts['path']) && mb_strlen($relative) > 0 && $isRelativePathAbsolute) {
|
||||||
|
// $relative is absolute path from domain (starts with /)
|
||||||
|
$path = $relative;
|
||||||
|
} elseif (isset($urlParts['path']) && strrpos($urlParts['path'], '/') === (strlen($urlParts['path']) )) {
|
||||||
|
// base path is directory
|
||||||
|
$path = $urlParts['path'].$relative;
|
||||||
|
} elseif (isset($urlParts['path'])) {
|
||||||
|
// strip filename from base path
|
||||||
|
$path = substr($urlParts['path'], 0, strrpos($urlParts['path'], '/')).'/'.$relative;
|
||||||
|
} else {
|
||||||
|
// no base path
|
||||||
|
$path = '/'.$relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
// foo/./bar ==> foo/bar
|
||||||
|
// remove double slashes
|
||||||
|
$path = preg_replace(array('#/\./#', '#/+#'), '/', $path);
|
||||||
|
|
||||||
|
// split path by '/'
|
||||||
|
$parts = explode('/', $path);
|
||||||
|
|
||||||
|
// resolve /../
|
||||||
|
foreach ($parts as $key => $part) {
|
||||||
|
if ($part === '..') {
|
||||||
|
$keyToDelete = $key - 1;
|
||||||
|
while ($keyToDelete > 0) {
|
||||||
|
if (isset($parts[$keyToDelete])) {
|
||||||
|
unset($parts[$keyToDelete]);
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
$keyToDelete--;
|
||||||
|
}
|
||||||
|
|
||||||
|
unset($parts[$key]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$hostname = $urlParts['scheme'].'://'.$urlParts['host'];
|
||||||
|
if (isset($urlParts['port'])) {
|
||||||
|
$hostname .= ':'.$urlParts['port'];
|
||||||
|
}
|
||||||
|
if (substr($hostname, -1) !== '/') {
|
||||||
|
$hostname .= '/';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $hostname.implode('/', $parts);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,77 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BeSimple\SoapClient\Xml;
|
||||||
|
|
||||||
|
use BeSimple\SoapClient\Curl\Curl;
|
||||||
|
use BeSimple\SoapCommon\Helper;
|
||||||
|
use DOMDocument;
|
||||||
|
use DOMXPath;
|
||||||
|
use Exception;
|
||||||
|
|
||||||
|
class XmlFileDomDocumentProcessor
|
||||||
|
{
|
||||||
|
public static function writeCacheFile(Curl $curl, $cacheType, $wsdlPath, $cacheFilePath, $resolveRemoteIncludes, $isRemoteFile)
|
||||||
|
{
|
||||||
|
if ($isRemoteFile === true) {
|
||||||
|
$curlResponse = $curl->executeCurlWithCachedSession($wsdlPath);
|
||||||
|
if ($curlResponse->curlStatusSuccess()) {
|
||||||
|
if (mb_strlen($curlResponse->getResponseBody()) === 0) {
|
||||||
|
throw new Exception('Could not write WSDL cache file: empty curl response from: '.$wsdlPath);
|
||||||
|
}
|
||||||
|
if ($resolveRemoteIncludes === true) {
|
||||||
|
$document = self::getXmlFileDomDocument($curl, $cacheType, $curlResponse->getResponseBody(), $wsdlPath);
|
||||||
|
self::saveXmlDomDocument($document, $cacheFilePath);
|
||||||
|
} else {
|
||||||
|
file_put_contents($cacheFilePath, $curlResponse->getResponseBody());
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
throw new Exception('Could not write WSDL cache file: Download failed with message: '.$curlResponse->getCurlErrorMessage());
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (file_exists($wsdlPath)) {
|
||||||
|
$document = self::getXmlFileDomDocument($curl, $cacheType, file_get_contents($wsdlPath));
|
||||||
|
self::saveXmlDomDocument($document, $cacheFilePath);
|
||||||
|
} else {
|
||||||
|
throw new Exception('Could write WSDL cache file: local file does not exist: '.$wsdlPath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves remote WSDL/XSD includes within the WSDL files.
|
||||||
|
*
|
||||||
|
* @param Curl $curl
|
||||||
|
* @param int $cacheType
|
||||||
|
* @param string $xmlFileSource XML file contents
|
||||||
|
* @param boolean $parentFilePath Parent file name
|
||||||
|
* @return DOMDocument
|
||||||
|
*/
|
||||||
|
private static function getXmlFileDomDocument(Curl $curl, $cacheType, $xmlFileSource, $parentFilePath = null)
|
||||||
|
{
|
||||||
|
$document = new DOMDocument('1.0', 'utf-8');
|
||||||
|
if ($document->loadXML($xmlFileSource) === false) {
|
||||||
|
throw new Exception('Could not save downloaded WSDL cache: '.$xmlFileSource);
|
||||||
|
}
|
||||||
|
|
||||||
|
$xpath = new DOMXPath($document);
|
||||||
|
$xmlDomDocumentImportReplacer = XmlDomDocumentImportReplacer::instantiateReplacer();
|
||||||
|
$xmlDomDocumentImportReplacer->updateXmlDocument($curl, $cacheType, $xpath, Helper::PFX_WSDL, Helper::NS_WSDL, 'location', $parentFilePath);
|
||||||
|
$xmlDomDocumentImportReplacer->updateXmlDocument($curl, $cacheType, $xpath, Helper::PFX_XML_SCHEMA, Helper::NS_XML_SCHEMA, 'schemaLocation', $parentFilePath);
|
||||||
|
|
||||||
|
return $document;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function saveXmlDomDocument(DOMDocument $document, $cacheFilePath)
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
$xmlContents = $document->saveXML();
|
||||||
|
if ($xmlContents === '') {
|
||||||
|
throw new Exception('Could not write WSDL cache file: DOMDocument returned empty XML file');
|
||||||
|
}
|
||||||
|
file_put_contents($cacheFilePath, $xmlContents);
|
||||||
|
} catch (Exception $e) {
|
||||||
|
unlink($cacheFilePath);
|
||||||
|
throw new Exception('Could not write WSDL cache file: save method returned error: ' . $e->getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,65 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BeSimple\SoapClient\Xml\Path;
|
||||||
|
|
||||||
|
use PHPUnit_Framework_TestCase;
|
||||||
|
|
||||||
|
class RelativePathResolverTest extends PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
/** @var RelativePathResolver */
|
||||||
|
private $relativePathResolver;
|
||||||
|
|
||||||
|
public function setUp()
|
||||||
|
{
|
||||||
|
$this->relativePathResolver = new RelativePathResolver();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $base
|
||||||
|
* @param string $relative
|
||||||
|
* @param string $assertPath
|
||||||
|
* @dataProvider providePathInfo
|
||||||
|
*/
|
||||||
|
public function testResolveRelativePathInUrl($base, $relative, $assertPath)
|
||||||
|
{
|
||||||
|
$path = $this->relativePathResolver->resolveRelativePathInUrl($base, $relative);
|
||||||
|
|
||||||
|
self::assertEquals($assertPath, $path);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function providePathInfo()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
[
|
||||||
|
'http://endpoint-location.ltd/',
|
||||||
|
'Document1.xsd',
|
||||||
|
'http://endpoint-location.ltd/Document1.xsd',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'http://endpoint-location.ltd:8080/endpoint/',
|
||||||
|
'../Schemas/Common/Document2.xsd',
|
||||||
|
'http://endpoint-location.ltd:8080/Schemas/Common/Document2.xsd',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'http://endpoint-location.ltd/',
|
||||||
|
'../Schemas/Common/Document3.xsd',
|
||||||
|
'http://endpoint-location.ltd/Schemas/Common/Document3.xsd',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'http://endpoint-location.ltd/',
|
||||||
|
'/Document4.xsd',
|
||||||
|
'http://endpoint-location.ltd/Document4.xsd',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'http://endpoint-location.ltd',
|
||||||
|
'/Document5.xsd',
|
||||||
|
'http://endpoint-location.ltd/Document5.xsd',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'http://endpoint-location.ltd',
|
||||||
|
'Document6.xsd',
|
||||||
|
'http://endpoint-location.ltd/Document6.xsd',
|
||||||
|
]
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,42 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BeSimple\SoapClient\Xml;
|
||||||
|
|
||||||
|
use PHPUnit_Framework_TestCase;
|
||||||
|
|
||||||
|
class RemoteFileResolverTest extends PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
const FILE_IS_REMOTE = true;
|
||||||
|
const FILE_IS_NOT_REMOTE = false;
|
||||||
|
|
||||||
|
/** @var RemoteFileResolver */
|
||||||
|
private $remoteFileResolver;
|
||||||
|
|
||||||
|
public function setUp()
|
||||||
|
{
|
||||||
|
$this->remoteFileResolver = new RemoteFileResolver();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $wsdlPath
|
||||||
|
* @param bool $assertIsRemoteFile
|
||||||
|
* @dataProvider provideWsdlPaths
|
||||||
|
*/
|
||||||
|
public function testIsRemoteFile($wsdlPath, $assertIsRemoteFile)
|
||||||
|
{
|
||||||
|
$isRemoteFile = $this->remoteFileResolver->isRemoteFile($wsdlPath);
|
||||||
|
|
||||||
|
self::assertEquals($assertIsRemoteFile, $isRemoteFile);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function provideWsdlPaths()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
['http://endpoint.tld/path/to/wsdl.wsdl', self::FILE_IS_REMOTE],
|
||||||
|
['http://endpoint.tld:1944/path/to/wsdl.wsdl', self::FILE_IS_REMOTE],
|
||||||
|
['path/to/wsdl.wsdl', self::FILE_IS_NOT_REMOTE],
|
||||||
|
['../../path/to/wsdl.wsdl', self::FILE_IS_NOT_REMOTE],
|
||||||
|
['/path/to/wsdl.wsdl', self::FILE_IS_NOT_REMOTE],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,105 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BeSimple\SoapClient\Xml;
|
||||||
|
|
||||||
|
use BeSimple\SoapClient\Curl\Curl;
|
||||||
|
use BeSimple\SoapClient\Curl\CurlOptionsBuilder;
|
||||||
|
use BeSimple\SoapCommon\Cache;
|
||||||
|
use BeSimple\SoapCommon\Helper;
|
||||||
|
use DOMDocument;
|
||||||
|
use DOMXPath;
|
||||||
|
use PHPUnit_Framework_TestCase;
|
||||||
|
|
||||||
|
class XmlDomDocumentImportReplacerTest extends PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
const NO_PARENT_FILE_PATH = null;
|
||||||
|
|
||||||
|
/** @var XmlDomDocumentImportReplacer */
|
||||||
|
private $xmlDomDocumentImportReplacer;
|
||||||
|
|
||||||
|
public function setUp()
|
||||||
|
{
|
||||||
|
$this->xmlDomDocumentImportReplacer = new XmlDomDocumentImportReplacer();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $xmlSource
|
||||||
|
* @param Curl $curl
|
||||||
|
* @param string $schemaPrefix
|
||||||
|
* @param string $schemaUrl
|
||||||
|
* @param string $locationAttributeName
|
||||||
|
* @param string|null $parentFilePath
|
||||||
|
* @param string|null $assertImportXmlSource
|
||||||
|
* @dataProvider provideXmlDocumentData
|
||||||
|
*/
|
||||||
|
public function testUpdateXmlDocument(
|
||||||
|
$xmlSource,
|
||||||
|
Curl $curl,
|
||||||
|
$schemaPrefix,
|
||||||
|
$schemaUrl,
|
||||||
|
$locationAttributeName,
|
||||||
|
$parentFilePath = null,
|
||||||
|
$assertImportXmlSource = null
|
||||||
|
) {
|
||||||
|
$wsdl = new DOMDocument();
|
||||||
|
$wsdl->loadXML($xmlSource);
|
||||||
|
|
||||||
|
$this->xmlDomDocumentImportReplacer->updateXmlDocument(
|
||||||
|
$curl,
|
||||||
|
Cache::TYPE_NONE,
|
||||||
|
new DOMXPath($wsdl),
|
||||||
|
$schemaPrefix,
|
||||||
|
$schemaUrl,
|
||||||
|
$locationAttributeName,
|
||||||
|
$parentFilePath
|
||||||
|
);
|
||||||
|
$wsdlSource = $wsdl->saveHTML();
|
||||||
|
|
||||||
|
self::assertContains(
|
||||||
|
$assertImportXmlSource,
|
||||||
|
$wsdlSource
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function provideXmlDocumentData()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'wsdlWithoutParentPath' => [
|
||||||
|
file_get_contents(__DIR__.'/testUpdateXmlDocument.wsdl'),
|
||||||
|
new Curl(CurlOptionsBuilder::buildDefault()),
|
||||||
|
Helper::PFX_WSDL,
|
||||||
|
Helper::NS_WSDL,
|
||||||
|
'location',
|
||||||
|
self::NO_PARENT_FILE_PATH,
|
||||||
|
'<xs:include schemaLocation="../Schemas/Common/Document1.xsd"></xs:include>'
|
||||||
|
],
|
||||||
|
'schemaWithoutParentPath' => [
|
||||||
|
file_get_contents(__DIR__.'/testUpdateXmlDocument.wsdl'),
|
||||||
|
new Curl(CurlOptionsBuilder::buildDefault()),
|
||||||
|
Helper::PFX_XML_SCHEMA,
|
||||||
|
Helper::NS_XML_SCHEMA,
|
||||||
|
'schemaLocation',
|
||||||
|
self::NO_PARENT_FILE_PATH,
|
||||||
|
'<xs:include schemaLocation="../Schemas/Common/Document1.xsd"></xs:include>'
|
||||||
|
],
|
||||||
|
'wsdlWithParentPath' => [
|
||||||
|
file_get_contents(__DIR__.'/testUpdateXmlDocument.wsdl'),
|
||||||
|
new Curl(CurlOptionsBuilder::buildDefault()),
|
||||||
|
Helper::PFX_WSDL,
|
||||||
|
Helper::NS_WSDL,
|
||||||
|
'location',
|
||||||
|
'http://endpoint-location.ltd:8080/endpoint/',
|
||||||
|
'<xs:include schemaLocation="../Schemas/Common/Document1.xsd"></xs:include>'
|
||||||
|
],
|
||||||
|
'schemaWithParentPath' => [
|
||||||
|
file_get_contents(__DIR__.'/testUpdateXmlDocument.wsdl'),
|
||||||
|
new Curl(CurlOptionsBuilder::buildDefault()),
|
||||||
|
Helper::PFX_XML_SCHEMA,
|
||||||
|
Helper::NS_XML_SCHEMA,
|
||||||
|
'schemaLocation',
|
||||||
|
'http://endpoint-location.ltd:8080/endpoint/',
|
||||||
|
'<xs:include schemaLocation="http://endpoint-location.ltd:8080/Schemas/Common/Document1.xsd"></xs:include>'
|
||||||
|
],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,51 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<wsdl:definitions
|
||||||
|
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
|
||||||
|
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
|
||||||
|
xmlns:ns="http://location.ltd/namespace1"
|
||||||
|
xmlns:ns2="http://location.ltd/namespace2"
|
||||||
|
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
|
||||||
|
xmlns:tns="http://endpoint-location.tld:7654/ws"
|
||||||
|
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PushServerWSDL"
|
||||||
|
targetNamespace="http://location.ltd/target-namespace">
|
||||||
|
<wsdl:types>
|
||||||
|
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://location.ltd/namespace1">
|
||||||
|
<xs:include schemaLocation="../Schemas/Common/Document1.xsd"/>
|
||||||
|
</xs:schema>
|
||||||
|
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://location.ltd/namespace2">
|
||||||
|
<xs:include schemaLocation="../Schemas/Common/Document2.xsd"/>
|
||||||
|
</xs:schema>
|
||||||
|
</wsdl:types>
|
||||||
|
<wsdl:message name="ServerHeader">
|
||||||
|
<wsdl:part element="ns:serverHeader" name="serverHeader"/>
|
||||||
|
</wsdl:message>
|
||||||
|
|
||||||
|
<wsdl:portType name="Server">
|
||||||
|
<wsdl:operation name="SendPushMessage">
|
||||||
|
<wsdl:documentation>TEST-OPERATION-1</wsdl:documentation>
|
||||||
|
<wsdl:input message="tns:SendPushMessageRequest" name="SendPushMessageRequest"/>
|
||||||
|
<wsdl:output message="tns:SendPushMessageResponse" name="SendPushMessageResponse"/>
|
||||||
|
<wsdl:fault message="tns:SystemFault" name="systemFault"/>
|
||||||
|
</wsdl:operation>
|
||||||
|
</wsdl:portType>
|
||||||
|
<wsdl:binding name="ServerBinding" type="tns:Server">
|
||||||
|
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
|
||||||
|
<wsdl:operation name="DummyMethod">
|
||||||
|
<soap:operation soapAction="http://endpoint-location.tld:7654/ep/v1" style="document"/>
|
||||||
|
<wsdl:input name="DummyMethodRequest">
|
||||||
|
<soap:body use="literal"/>
|
||||||
|
</wsdl:input>
|
||||||
|
<wsdl:output name="DummyMethodResponse">
|
||||||
|
<soap:body use="literal"/>
|
||||||
|
</wsdl:output>
|
||||||
|
<wsdl:fault name="soapServerFault">
|
||||||
|
<soap:fault name="soapServerFault" use="literal"/>
|
||||||
|
</wsdl:fault>
|
||||||
|
</wsdl:operation>
|
||||||
|
</wsdl:binding>
|
||||||
|
<wsdl:service name="ServerServices">
|
||||||
|
<wsdl:port binding="tns:ServerBinding" name="ServerServicesEndpoint">
|
||||||
|
<soap:address location="http://endpoint-location.tld:7654/ws/"/>
|
||||||
|
</wsdl:port>
|
||||||
|
</wsdl:service>
|
||||||
|
</wsdl:definitions>
|
Loading…
Reference in New Issue