Cadoles/BeSimpleSoap
21
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

WsdlDownloader fix: remote includes now work correctly with relative URLs & tests added

Browse Source
This commit is contained in:
Petr Bechyně
2017-07-18 18:52:52 +02:00
parent b650254d54
commit 6970b7bbef
9 changed files with 583 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files

208
src/BeSimple/SoapClient/WsdlDownloader.php
View File

@ -13,6 +13,8 @@
namespace BeSimple\SoapClient;
use BeSimple\SoapClient\Curl\Curl;
use BeSimple\SoapClient\Xml\RemoteFileResolver;
use BeSimple\SoapClient\Xml\XmlFileDomDocumentProcessor;
use BeSimple\SoapCommon\Cache;
use BeSimple\SoapCommon\Helper;
use DOMDocument;
@ -30,6 +32,11 @@ use Exception;
*/
class WsdlDownloader
{
public static function instantiateDownloader()
{
return new self();
}
/**
* @param Curl $curl
* @param string $wsdlPath WSDL file URL/path
@ -39,10 +46,10 @@ class WsdlDownloader
*/
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();
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);
if ($isCacheExisting) {
$fileModificationTime = filemtime($cacheFilePath);
@ -54,46 +61,17 @@ class WsdlDownloader
$isCacheExisting = $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);
} else {
if ($isRemoteFile === true) {
return $wsdlPath;
}
return $this->getLocalWsdlPath($wsdlPath);
}
}
private 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 = $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 $wsdlPath;
}
return $this->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);
}
/**
* @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);
throw new Exception('Could not download WSDL: local file does not exist: ' . $wsdlPath);
}
}