symfony-storage/StorageBundle/Adaptors/S3Storage.php

168 lines
4.8 KiB
PHP

<?php
namespace Bluesquare\StorageBundle\Adaptors;
use Aws\S3\S3Client;
use Bluesquare\StorageBundle\Exceptions\InvalidStorageConfiguration;
use Symfony\Component\Config\Definition\Exception\Exception;
/**
* Interface de manipulation du stockage S3
* Usage: $storage = new S3Storage('my_storage_name', $config);
* @author Maxime Renou
*/
class S3Storage implements StorageAdaptor
{
const MODE_PRIVATE = 'private';
const MODE_PUBLIC = 'public-read';
protected $client;
protected $bucket;
protected $region;
public function __construct ($storage_name, $config)
{
if (!($this->configIsNormed($config)))
throw new InvalidStorageConfiguration("Invalid $storage_name storage configuration");
$this->config = $config;
$this->bucket = $config['bucket'];
$this->bucket_url = $config['bucket_url'];
$this->client = new S3Client([
'version' => isset($config['version']) ? $config['version'] : 'latest',
'region' => $config['region'],
'endpoint' => $config['endpoint'],
'credentials' => [
'key' => $config['credentials']['key'],
'secret' => $config['credentials']['secret']
]
]);
}
public function mode($name)
{
if ($name == 'public') return self::MODE_PUBLIC;
return self::MODE_PRIVATE;
}
private function configIsNormed($config)
{
return (
isset($config['type']) &&
isset($config['bucket']) &&
isset($config['bucket_url']) &&
isset($config['region']) &&
isset($config['endpoint']) &&
isset($config['credentials']) &&
isset($config['credentials']['key']) &&
isset($config['credentials']['secret'])
);
}
protected function getPrefix($prefix = null)
{
$ret = '';
if (isset($this->config['path'])) {
$ret = trim($this->config['path'], '/').'/';
}
if (!is_null($prefix)) {
$ret = ltrim($prefix, '/');
}
return $ret;
}
public function index($prefix = null)
{
return ($this->client->listObjectsV2([
'Bucket' => $this->bucket,
'Prefix' => $this->getPrefix($prefix)
]));
}
/**
* Permet d'obtenir l'URL vers une ressource S3
* Cette ressource n'est accessible que si le fichier a été stocké en mode public
* @param $target_path
* @return string
*/
public function url ($target_path)
{
return rtrim($this->bucket_url, '/').'/'.$this->getPrefix().ltrim($target_path, '/');
}
/**
* Permet de stocker un fichier dans S3
* @param $source_path
* @param $target_path
* @param string $permissions
* @return \Aws\Result
*/
public function store ($source_path, $target_path, $permissions = self::MODE_PRIVATE)
{
return $this->client->putObject([
'Bucket' => $this->bucket,
'Path' => $this->getPrefix().$target_path,
'Key' => $this->getPrefix().$target_path,
'Body' => file_get_contents($source_path),
'ACL' => $permissions
]);
}
/**
* Permet de récupérer un fichier dans S3 pour le stocker en local
* @param $distant_path
* @param $local_path
*/
public function retrieve ($distant_path, $local_path)
{
$file_stream = fopen($local_path, 'w');
$aws_stream = $this->client->getObject([
'Bucket' => $this->bucket,
'Key' => $this->getPrefix().$distant_path,
'Path' => $this->getPrefix().$distant_path,
])->get('Body')->detach();
stream_copy_to_stream($aws_stream, $file_stream);
fclose($file_stream);
}
/**
* Ouvre le stream d'un fichier stocké dans S3
* @param $distant_path
* @param $target_stream
*/
public function getStream ($distant_path)
{
return $this->client->getObject([
'Bucket' => $this->bucket,
'Key' => $this->getPrefix().$distant_path,
'Path' => $this->getPrefix().$distant_path,
])->get('Body')->detach();
}
/**
* Permet de stream un fichier stocké dans S3
* @param $distant_path
* @param $target_stream
*/
public function stream ($distant_path, $target_stream)
{
stream_copy_to_stream($this->getStream($distant_path), $target_stream);
}
/**
* Permet de supprimer un fichier stocké dans S3
* @param $distant_path
*/
public function delete ($distant_path)
{
$this->client->deleteObject([
'Bucket' => $this->bucket,
'Path' => $this->getPrefix().$distant_path,
'Key' => $this->getPrefix().$distant_path,
]);
}
}