BeSimpleSoap/src/BeSimple/SoapClient/WsdlDownloader.php

265 lines
8.5 KiB
PHP
Raw Normal View History

<?php
2011-10-16 19:49:24 +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;
2013-07-24 23:18:41 +02:00
use BeSimple\SoapCommon\Cache;
2011-12-11 21:20:35 +01:00
use BeSimple\SoapCommon\Helper;
2011-10-16 19:49:24 +02:00
/**
* Downloads WSDL files with cURL. Uses the WSDL_CACHE_* constants and the
* 'soap.wsdl_*' ini settings. Does only file caching as SoapClient only
* supports a file name parameter. The class also resolves remote XML schema
* includes.
2011-10-16 19:49:24 +02:00
*
2011-10-22 11:28:15 +02:00
* @author Andreas Schamberger <mail@andreass.net>
2011-10-16 19:49:24 +02:00
*/
class WsdlDownloader
{
/**
* Cache enabled.
*
* @var bool
*/
2011-12-11 21:20:35 +01:00
protected $cacheEnabled;
2011-10-16 19:49:24 +02:00
/**
* Cache dir.
*
* @var string
*/
2011-12-11 21:20:35 +01:00
protected $cacheDir;
2011-10-16 19:49:24 +02:00
/**
* Cache TTL.
*
* @var int
*/
2011-12-11 21:20:35 +01:00
protected $cacheTtl;
2011-10-16 19:49:24 +02:00
/**
* cURL instance for downloads.
*
* @var unknown_type
*/
2011-12-11 21:20:35 +01:00
protected $curl;
/**
* Resolve WSDl/XSD includes.
2011-10-16 19:49:24 +02:00
*
* @var boolean
2011-10-16 19:49:24 +02:00
*/
protected $resolveRemoteIncludes = true;
2011-10-16 19:49:24 +02:00
/**
* Constructor.
*
* @param \BeSimple\SoapClient\Curl $curl Curl instance
* @param boolean $resolveRemoteIncludes WSDL/XSD include enabled?
* @param boolean $cacheWsdl Cache constant
2011-10-16 19:49:24 +02:00
*/
2013-07-24 23:18:41 +02:00
public function __construct(Curl $curl, $resolveRemoteIncludes = true, $cacheWsdl = Cache::TYPE_DISK)
2011-10-16 19:49:24 +02:00
{
2013-07-24 23:18:41 +02:00
$this->curl = $curl;
$this->resolveRemoteIncludes = (Boolean) $resolveRemoteIncludes;
2011-10-16 19:49:24 +02:00
// get current WSDL caching config
2013-07-24 23:18:41 +02:00
$this->cacheEnabled = $cacheWsdl === Cache::TYPE_NONE ? Cache::DISABLED : Cache::ENABLED == Cache::isEnabled();
2013-08-24 09:39:56 +02:00
$this->cacheDir = Cache::getDirectory();
$this->cacheTtl = Cache::getLifetime();
2011-10-16 19:49:24 +02:00
}
/**
* Download given WSDL file and return name of cache file.
*
2011-12-17 16:05:25 +01:00
* @param string $wsdl WSDL file URL/path
*
2011-10-16 19:49:24 +02:00
* @return string
*/
public function download($wsdl)
{
// download and cache remote WSDL files or local ones where we want to
// resolve remote XSD includes
$isRemoteFile = $this->isRemoteFile($wsdl);
2013-07-24 23:18:41 +02:00
if ($isRemoteFile || $this->resolveRemoteIncludes) {
$cacheFilePath = $this->cacheDir.DIRECTORY_SEPARATOR.'wsdl_'.md5($wsdl).'.cache';
if (!$this->cacheEnabled || !file_exists($cacheFilePath) || (filemtime($cacheFilePath) + $this->cacheTtl) < time()) {
if ($isRemoteFile) {
2011-10-16 19:49:24 +02:00
// execute request
$responseSuccessfull = $this->curl->exec($wsdl);
2011-10-16 19:49:24 +02:00
// get content
2013-07-24 23:18:41 +02:00
if ($responseSuccessfull) {
$response = $this->curl->getResponseBody();
2013-07-24 23:18:41 +02:00
if ($this->resolveRemoteIncludes) {
$this->resolveRemoteIncludes($response, $cacheFilePath, $wsdl);
2011-10-16 19:49:24 +02:00
} else {
2013-07-24 23:18:41 +02:00
file_put_contents($cacheFilePath, $response);
2011-10-16 19:49:24 +02:00
}
} else {
throw new \ErrorException("SOAP-ERROR: Parsing WSDL: Couldn't load from '" . $wsdl ."'");
}
} elseif (file_exists($wsdl)) {
$response = file_get_contents($wsdl);
2013-07-24 23:18:41 +02:00
$this->resolveRemoteIncludes($response, $cacheFilePath);
2011-10-16 19:49:24 +02:00
} else {
throw new \ErrorException("SOAP-ERROR: Parsing WSDL: Couldn't load from '" . $wsdl ."'");
}
}
2011-12-11 21:20:35 +01:00
2013-07-24 23:18:41 +02:00
return $cacheFilePath;
2011-10-16 19:49:24 +02:00
} elseif (file_exists($wsdl)) {
return realpath($wsdl);
}
2013-07-24 23:18:41 +02:00
throw new \ErrorException("SOAP-ERROR: Parsing WSDL: Couldn't load from '" . $wsdl ."'");
2011-10-16 19:49:24 +02:00
}
/**
* Do we have a remote file?
*
2011-12-17 16:05:25 +01:00
* @param string $file File URL/path
*
2011-10-16 19:49:24 +02:00
* @return boolean
*/
private function isRemoteFile($file)
{
// @parse_url to suppress E_WARNING for invalid urls
2013-07-24 23:18:41 +02:00
if (false !== $url = @parse_url($file)) {
if (isset($url['scheme']) && 'http' === substr($url['scheme'], 0, 4)) {
return true;
2011-10-16 19:49:24 +02:00
}
}
2011-12-11 21:20:35 +01:00
2013-07-24 23:18:41 +02:00
return false;
2011-10-16 19:49:24 +02:00
}
/**
* Resolves remote WSDL/XSD includes within the WSDL files.
2011-10-16 19:49:24 +02:00
*
2013-07-24 23:18:41 +02:00
* @param string $xml XML file
* @param string $cacheFilePath Cache file name
* @param boolean $parentFilePath Parent file name
2011-12-17 16:05:25 +01:00
*
2011-12-11 21:20:35 +01:00
* @return void
2011-10-16 19:49:24 +02:00
*/
2013-07-24 23:18:41 +02:00
private function resolveRemoteIncludes($xml, $cacheFilePath, $parentFilePath = null)
2011-10-16 19:49:24 +02:00
{
$doc = new \DOMDocument();
$doc->loadXML($xml);
2013-07-24 23:18:41 +02:00
2011-10-16 19:49:24 +02:00
$xpath = new \DOMXPath($doc);
$xpath->registerNamespace(Helper::PFX_XML_SCHEMA, Helper::NS_XML_SCHEMA);
2011-12-17 11:10:08 +01:00
$xpath->registerNamespace(Helper::PFX_WSDL, Helper::NS_WSDL);
2013-07-24 23:18:41 +02:00
// WSDL include/import
2013-07-24 23:18:41 +02:00
$query = './/'.Helper::PFX_WSDL.':include | .//'.Helper::PFX_WSDL.':import';
$nodes = $xpath->query($query);
if ($nodes->length > 0) {
foreach ($nodes as $node) {
$location = $node->getAttribute('location');
if ($this->isRemoteFile($location)) {
$location = $this->download($location);
$node->setAttribute('location', $location);
2013-07-24 23:18:41 +02:00
} elseif (null !== $parentFilePath) {
$location = $this->resolveRelativePathInUrl($parentFilePath, $location);
$location = $this->download($location);
$node->setAttribute('location', $location);
}
}
}
2013-07-24 23:18:41 +02:00
// XML schema include/import
2013-07-24 23:18:41 +02:00
$query = './/'.Helper::PFX_XML_SCHEMA.':include | .//'.Helper::PFX_XML_SCHEMA.':import';
2011-10-16 19:49:24 +02:00
$nodes = $xpath->query($query);
if ($nodes->length > 0) {
foreach ($nodes as $node) {
2012-08-02 10:13:49 +02:00
if ($node->hasAttribute('schemaLocation')) {
2013-07-24 23:18:41 +02:00
$schemaLocation = $node->getAttribute('schemaLocation');
if ($this->isRemoteFile($schemaLocation)) {
$schemaLocation = $this->download($schemaLocation);
$node->setAttribute('schemaLocation', $schemaLocation);
} elseif (null !== $parentFilePath) {
$schemaLocation = $this->resolveRelativePathInUrl($parentFilePath, $schemaLocation);
$schemaLocation = $this->download($schemaLocation);
$node->setAttribute('schemaLocation', $schemaLocation);
}
2011-10-16 19:49:24 +02:00
}
}
}
2013-07-24 23:18:41 +02:00
$doc->save($cacheFilePath);
2011-10-16 19:49:24 +02:00
}
/**
* Resolves the relative path to base into an absolute.
*
2011-12-17 16:05:25 +01:00
* @param string $base Base path
* @param string $relative Relative path
*
2011-10-16 19:49:24 +02:00
* @return string
*/
private function resolveRelativePathInUrl($base, $relative)
{
$urlParts = parse_url($base);
2013-07-24 23:18:41 +02:00
2011-10-16 19:49:24 +02:00
// combine base path with relative path
2013-07-24 23:18:41 +02:00
if (isset($urlParts['path']) && '/' === $relative{0}) {
2011-10-16 19:49:24 +02:00
// $relative is absolute path from domain (starts with /)
$path = $relative;
} elseif (isset($urlParts['path']) && strrpos($urlParts['path'], '/') === (strlen($urlParts['path']) )) {
// base path is directory
2013-07-24 23:18:41 +02:00
$path = $urlParts['path'].$relative;
2011-10-16 19:49:24 +02:00
} elseif (isset($urlParts['path'])) {
// strip filename from base path
2013-07-24 23:18:41 +02:00
$path = substr($urlParts['path'], 0, strrpos($urlParts['path'], '/')).'/'.$relative;
2011-10-16 19:49:24 +02:00
} else {
// no base path
2013-07-24 23:18:41 +02:00
$path = '/'.$relative;
2011-10-16 19:49:24 +02:00
}
2013-07-24 23:18:41 +02:00
2011-10-16 19:49:24 +02:00
// foo/./bar ==> foo/bar
// remove double slashes
2013-07-24 23:18:41 +02:00
$path = preg_replace(array('#/\./#', '#/+#'), '/', $path);
2011-10-16 19:49:24 +02:00
// split path by '/'
$parts = explode('/', $path);
2013-07-24 23:18:41 +02:00
2011-10-16 19:49:24 +02:00
// resolve /../
foreach ($parts as $key => $part) {
2013-07-24 23:18:41 +02:00
if ('..' === $part) {
$keyToDelete = $key - 1;
2011-10-16 19:49:24 +02:00
while ($keyToDelete > 0) {
if (isset($parts[$keyToDelete])) {
unset($parts[$keyToDelete]);
2013-07-24 23:18:41 +02:00
2011-10-16 19:49:24 +02:00
break;
}
2013-07-24 23:18:41 +02:00
$keyToDelete--;
2011-10-16 19:49:24 +02:00
}
2013-07-24 23:18:41 +02:00
2011-10-16 19:49:24 +02:00
unset($parts[$key]);
}
}
2013-07-24 23:18:41 +02:00
$hostname = $urlParts['scheme'].'://'.$urlParts['host'];
2011-10-16 19:49:24 +02:00
if (isset($urlParts['port'])) {
2013-07-24 23:18:41 +02:00
$hostname .= ':'.$urlParts['port'];
2011-10-16 19:49:24 +02:00
}
2011-12-11 21:20:35 +01:00
2013-07-24 23:18:41 +02:00
return $hostname.implode('/', $parts);
2011-10-16 19:49:24 +02:00
}
2013-07-24 23:18:41 +02:00
}