-
Notifications
You must be signed in to change notification settings - Fork 824
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d768e28
commit b346ba6
Showing
2 changed files
with
551 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,393 @@ | ||
<?php | ||
|
||
namespace League\Flysystem\Adapter; | ||
|
||
use GuzzleHttp\Client; | ||
use GuzzleHttp\ClientInterface; | ||
use GuzzleHttp\Exception\ClientException; | ||
use GuzzleHttp\Message\ResponseInterface; | ||
use GuzzleHttp\Stream\GuzzleStreamWrapper; | ||
use League\Flysystem\Config; | ||
use League\Flysystem\AdapterInterface; | ||
|
||
class Http extends AbstractAdapter | ||
{ | ||
/** @var string */ | ||
protected $host; | ||
|
||
/** @var ClientInterface */ | ||
protected $client; | ||
|
||
/** | ||
* Constructor | ||
* | ||
* @param string $url | ||
* @param ClientInterface $client | ||
*/ | ||
public function __construct($url, ClientInterface $client = null) | ||
{ | ||
$parsedUrl = parse_url($url); | ||
$this->host = $parsedUrl['scheme'] . '://'; | ||
if (isset($parsedUrl['user']) && isset($parsedUrl['pass'])) { | ||
$this->host .= $parsedUrl['user'] . ':' . $parsedUrl['pass'] . '@'; | ||
}; | ||
$this->host .= $parsedUrl['host']; | ||
|
||
if (null !== $client) { | ||
$this->setClient($client); | ||
} | ||
} | ||
|
||
/** | ||
* Check whether a file is present | ||
* | ||
* @param string $path | ||
* | ||
* @return boolean | ||
*/ | ||
public function has($path) | ||
{ | ||
$client = $this->getClient(); | ||
try { | ||
/** @var ResponseInterface $response */ | ||
$response = $client->head($this->buildUrl($path)); | ||
} catch (ClientException $e) { | ||
return false; | ||
} | ||
$code = $response->getStatusCode(); | ||
|
||
if ($code != 200) { | ||
return false; | ||
} | ||
|
||
return true; | ||
} | ||
|
||
/** | ||
* Write a file | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* @param string $contents | ||
* @param null $config | ||
* | ||
* @return array|bool | ||
*/ | ||
public function write($path, $contents, $config = null) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Write using a stream | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* @param string $resource | ||
* @param null $config | ||
* | ||
* @return array|bool | ||
*/ | ||
public function writeStream($path, $resource, $config = null) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Get a read-stream for a file | ||
* | ||
* @param string $path | ||
* | ||
* @return array|bool | ||
*/ | ||
public function readStream($path) | ||
{ | ||
$client = $this->getClient(); | ||
$response = $client->head($this->buildUrl($path)); | ||
$streamObj = $response->getBody(); | ||
$stream = GuzzleStreamWrapper::getResource($streamObj); | ||
|
||
return compact('stream', 'path'); | ||
} | ||
|
||
/** | ||
* Update a file using a stream | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* @param resource $resource | ||
* @param mixed $config Config object or visibility setting | ||
* | ||
* @return array|bool | ||
*/ | ||
public function updateStream($path, $resource, $config = null) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Update a file | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* @param string $contents | ||
* @param mixed $config Config object or visibility setting | ||
* | ||
* @return array|bool | ||
*/ | ||
public function update($path, $contents, $config = null) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Read a file | ||
* | ||
* @param string $path | ||
* | ||
* @return array|bool | ||
*/ | ||
public function read($path) | ||
{ | ||
$client = $this->getClient(); | ||
/** @var ResponseInterface $response */ | ||
$response = $client->get($this->buildUrl($path)); | ||
|
||
if (200 !== ((int) $response->getStatusCode())) { | ||
return false; | ||
} | ||
|
||
$contents = (string) $response->getBody(); | ||
|
||
return compact('contents', 'path'); | ||
} | ||
|
||
/** | ||
* Rename a file | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* @param string $newpath | ||
* | ||
* @return bool | ||
*/ | ||
public function rename($path, $newpath) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Copy a file | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* @param string $newpath | ||
* | ||
* @return bool | ||
*/ | ||
public function copy($path, $newpath) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Delete a file | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* | ||
* @return bool | ||
*/ | ||
public function delete($path) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* List contents of a directory | ||
* There are no directories in HTTP, so this always returns an empty array | ||
* | ||
* @param string $directory | ||
* @param bool $recursive | ||
* | ||
* @return false|array | ||
*/ | ||
public function listContents($directory = '', $recursive = false) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Get the metadata of a file | ||
* | ||
* @param string $path | ||
* | ||
* @return array | ||
*/ | ||
public function getMetadata($path) | ||
{ | ||
$metadata = $this->fetchRemoteFileMetadata($this->buildUrl($path)); | ||
|
||
return $this->normalizeFileInfo($path, $metadata); | ||
} | ||
|
||
/** | ||
* Get the size of a file | ||
* | ||
* @param string $path | ||
* | ||
* @return array | ||
*/ | ||
public function getSize($path) | ||
{ | ||
return $this->getMetadata($path); | ||
} | ||
|
||
/** | ||
* Get the mimetype of a file | ||
* | ||
* @param string $path | ||
* | ||
* @return array | ||
*/ | ||
public function getMimetype($path) | ||
{ | ||
return $this->getMetadata($path); | ||
} | ||
|
||
/** | ||
* Get the timestamp of a file | ||
* | ||
* @param string $path | ||
* | ||
* @return array | ||
*/ | ||
public function getTimestamp($path) | ||
{ | ||
return $this->getMetadata($path); | ||
} | ||
|
||
/** | ||
* Get the visibility of a file | ||
* | ||
* @param string $path | ||
* | ||
* @return array|void | ||
*/ | ||
public function getVisibility($path) | ||
{ | ||
return $this->getMetadata($path); | ||
} | ||
|
||
/** | ||
* Create a directory | ||
* | ||
* @param string $path | ||
* @param array|Config $options | ||
* | ||
* @return bool | ||
*/ | ||
public function createDir($path, $options = null) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Delete a directory | ||
* It's not possible to write to HTTP so it will always do nothing and return false | ||
* | ||
* @param string $path | ||
* | ||
* @return bool | ||
*/ | ||
public function deleteDir($path) | ||
{ | ||
return false; | ||
} | ||
|
||
/** | ||
* Normalize the file info | ||
* | ||
* @param string $path | ||
* @param array $fileMetadata | ||
* | ||
* @return array | ||
*/ | ||
protected function normalizeFileInfo($path, array $fileMetadata) | ||
{ | ||
$normalized = array( | ||
'type' => 'file', | ||
'path' => $path, | ||
'timestamp' => $fileMetadata['timestamp'], | ||
'size' => $fileMetadata['size'], | ||
'visibility' => $fileMetadata['visibility'] | ||
); | ||
|
||
return $normalized; | ||
} | ||
|
||
/** | ||
* Given a file URL it fetches the file metadata | ||
* | ||
* @param string $url | ||
* | ||
* @throws ClientException | ||
* | ||
* @return array | ||
*/ | ||
protected function fetchRemoteFileMetadata($url) | ||
{ | ||
$client = $this->getClient(); | ||
/** @var ResponseInterface $response */ | ||
$response = $client->head($url); | ||
$status = (int) $response->getStatusCode(); | ||
$visibility = AdapterInterface::VISIBILITY_PRIVATE; | ||
|
||
// http://en.wikipedia.org/wiki/List_of_HTTP_status_codes | ||
if ($status == 200 || ($status > 300 && $status <= 308)) { | ||
$size = (int) $response->getHeader('Content-Length'); | ||
$timestamp = strtotime($response->getHeader('Last-Modified')); | ||
$mimetype = $response->getHeader('Content-Type'); | ||
} | ||
|
||
if ($status != 401 && $status != 402 && $status != 403) { | ||
$visibility = AdapterInterface::VISIBILITY_PUBLIC; | ||
} | ||
|
||
return compact('visibility', 'size', 'timestamp', 'mimetype'); | ||
} | ||
|
||
/** | ||
* @param string $path | ||
* | ||
* @return string | ||
*/ | ||
protected function buildUrl($path) | ||
{ | ||
return $this->host . '/' . ltrim($path, '/'); | ||
} | ||
|
||
/** | ||
* @param ClientInterface $client | ||
* | ||
* @return self | ||
*/ | ||
protected function setClient(ClientInterface $client) | ||
{ | ||
$this->client = $client; | ||
|
||
return $this; | ||
} | ||
|
||
/** | ||
* @return ClientInterface | ||
*/ | ||
public function getClient() | ||
{ | ||
if ( ! $this->client) { | ||
$this->client = new Client(); | ||
} | ||
|
||
return $this->client; | ||
} | ||
} |
Oops, something went wrong.
b346ba6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any news on when this'll be ready to go?
b346ba6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As soon as I have some times to work on it. The unit test coverage was under 60% on this class so much work seems to be needed. I'm struck down for a throat infection atm, so might be a while before I'm back on the horse. At least 4 days or so.
b346ba6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How's the throat @frankdejonge? 😄 Joking aside, what's left on this? Would really like to use it. I can help out if needed!
b346ba6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nojacko Hi! Basically it needs to be finished up. I don't really have the time/need for this. So a separate package (which all adapters are) would be very welcome!
b346ba6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/twistor/flysystem-guzzle
b346ba6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, see https://github.com/twistor/flysystem-http
Similar as the previous one, but uses native PHP functions.
b346ba6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @frankdejonge and @twistor! I like the the look of the native PHP functions version over using another dependency Guzzle. I'll give it a go!