class S3 in Flysystem - S3 2.0.x

Drupal plugin for the "S3" Flysystem adapter.

Plugin annotation

@Adapter(id = "s3")

Hierarchy

• class \Drupal\flysystem_s3\Flysystem\S3 implements \Drupal\flysystem\Plugin\FlysystemPluginInterface, ContainerFactoryPluginInterface uses \Drupal\flysystem\Plugin\ImageStyleGenerationTrait, \Drupal\flysystem\Plugin\FlysystemUrlTrait

1 file declares its use of S3

S3Test.php in tests/src/Unit/Flysystem/S3Test.php

File

src/Flysystem/S3.php, line 24

Namespace

Drupal\flysystem_s3\Flysystem

class S3 implements FlysystemPluginInterface, ContainerFactoryPluginInterface {
  use ImageStyleGenerationTrait;
  use FlysystemUrlTrait {
    getExternalUrl as getDownloadlUrl;
  }

  /**
   * The S3 bucket.
   *
   * @var string
   */
  protected $bucket;

  /**
   * The S3 client.
   *
   * @var \Aws\S3\S3Client
   */
  protected $client;

  /**
   * Options to pass into \League\Flysystem\AwsS3v3\AwsS3Adapter.
   *
   * @var array
   */
  protected $options;

  /**
   * The path prefix inside the bucket.
   *
   * @var string
   */
  protected $prefix;

  /**
   * The URL prefix.
   *
   * @var string
   */
  protected $urlPrefix;

  /**
   * Whether the stream is set to public.
   *
   * @var bool
   */
  protected $isPublic;

  /**
   * Constructs an S3 object.
   *
   * @param \Aws\S3\S3Client $client
   *   The S3 client.
   * @param \League\Flysystem\Config $config
   *   The configuration.
   */
  public function __construct(S3Client $client, Config $config) {
    $this->client = $client;
    $this->bucket = $config
      ->get('bucket', '');
    $this->prefix = $config
      ->get('prefix', '');
    $this->isPublic = $config
      ->get('public', FALSE);
    $this->options = $config
      ->get('options', []);
    $this->urlPrefix = $this
      ->calculateUrlPrefix($config);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $configuration = static::mergeConfiguration($container, $configuration);
    $client_config = static::mergeClientConfiguration($container, $configuration);
    $client = new S3Client($client_config);
    unset($configuration['key'], $configuration['secret']);
    return new static($client, new Config($configuration));
  }

  /**
   * Returns an S3 client configuration based on a Flysystem configuration.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The container to pull out services used in the plugin.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   *
   * @return array
   *   The client configuration.
   */
  public static function mergeClientConfiguration(ContainerInterface $container, array $configuration) {
    $client_config = [
      'version' => 'latest',
      'region' => $configuration['region'],
      'endpoint' => $configuration['endpoint'],
    ];

    // Add config for S3Client if the exists.
    if (isset($configuration['bucket_endpoint'])) {
      $client_config['bucket_endpoint'] = $configuration['bucket_endpoint'];
    }
    if (isset($configuration['use_accelerate_endpoint'])) {
      $client_config['use_accelerate_endpoint'] = $configuration['use_accelerate_endpoint'];
    }
    if (isset($configuration['use_dual_stack_endpoint'])) {
      $client_config['use_dual_stack_endpoint'] = $configuration['use_dual_stack_endpoint'];
    }
    if (isset($configuration['use_path_style_endpoint'])) {
      $client_config['use_path_style_endpoint'] = $configuration['use_path_style_endpoint'];
    }

    // Allow authentication with standard secret/key or IAM roles.
    if (isset($configuration['key']) && isset($configuration['secret'])) {
      $client_config['credentials'] = new Credentials($configuration['key'], $configuration['secret']);
      return $client_config;
    }
    $client_config['credentials.cache'] = new AwsCacheAdapter($container
      ->get('cache.default'), 'flysystem_s3:');
    return $client_config;
  }

  /**
   * Merges default Flysystem configuration.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The container to pull out services used in the plugin.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   *
   * @return array
   *   The Flysystem configuration.
   */
  public static function mergeConfiguration(ContainerInterface $container, array $configuration) {
    $protocol = $container
      ->get('request_stack')
      ->getCurrentRequest()
      ->getScheme();
    return $configuration += [
      'protocol' => $protocol,
      'region' => 'us-east-1',
      'endpoint' => NULL,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getAdapter() {
    try {
      $adapter = new S3Adapter($this->client, $this->bucket, $this->prefix, $this->options);
      return $adapter;
    } catch (S3Exception $e) {
      $message = $e
        ->getMessage();
      \Drupal::logger('flysystem_s3')
        ->error($message);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getExternalUrl($uri) {
    if ($this->isPublic === FALSE) {
      return $this
        ->getDownloadlUrl($uri);
    }
    $target = $this
      ->getTarget($uri);
    if (strpos($target, 'styles/') === 0 && !file_exists($uri)) {
      $this
        ->generateImageStyle($target);
    }
    return $this->urlPrefix . '/' . UrlHelper::encodePath($target);
  }

  /**
   * {@inheritdoc}
   */
  public function ensure($force = FALSE) {
    try {
      $this
        ->getAdapter()
        ->listContents();
    } catch (S3Exception $e) {
      $message = $e
        ->getMessage();
      \Drupal::logger('flysystem_s3')
        ->error($message);
    }

    // @TODO: If the bucket exists, can we write to it? Find a way to test that.
    if (!$this->client
      ->doesBucketExist($this->bucket)) {
      return [
        [
          'severity' => RfcLogLevel::ERROR,
          'message' => 'Bucket %bucket does not exist.',
          'context' => [
            '%bucket' => $this->bucket,
          ],
        ],
      ];
    }
    return [];
  }

  /**
   * Calculates the URL prefix.
   *
   * @param \League\Flysystem\Config $config
   *   The configuration.
   *
   * @return string
   *   The URL prefix in the form protocol://cname[/bucket][/prefix].
   */
  private function calculateUrlPrefix(Config $config) {
    $protocol = $config
      ->get('protocol', 'http');
    $cname = (string) $config
      ->get('cname');
    $prefix = (string) $config
      ->get('prefix', '');
    $prefix = $prefix === '' ? '' : '/' . UrlHelper::encodePath($prefix);
    if ($cname !== '' && $config
      ->get('cname_is_bucket', TRUE)) {
      return $protocol . '://' . $cname . $prefix;
    }
    $bucket = (string) $config
      ->get('bucket', '');
    $bucket = $bucket === '' ? '' : '/' . UrlHelper::encodePath($bucket);

    // No custom CNAME was provided. Generate the default S3 one.
    if ($cname === '') {
      $cname = 's3-' . $config
        ->get('region', 'us-east-1') . '.amazonaws.com';
    }

    // us-east-1 doesn't follow the consistent mapping.
    if ($cname === 's3-us-east-1.amazonaws.com') {
      $cname = 's3.amazonaws.com';
    }
    return $protocol . '://' . $cname . $bucket . $prefix;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
S3::$bucket	protected	property	The S3 bucket.
S3::$client	protected	property	The S3 client.
S3::$isPublic	protected	property	Whether the stream is set to public.
S3::$options	protected	property	Options to pass into \League\Flysystem\AwsS3v3\AwsS3Adapter.
S3::$prefix	protected	property	The path prefix inside the bucket.
S3::$urlPrefix	protected	property	The URL prefix.
S3::calculateUrlPrefix	private	function	Calculates the URL prefix.
S3::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
S3::ensure	public	function
S3::getAdapter	public	function
S3::getExternalUrl	public	function
S3::mergeClientConfiguration	public static	function	Returns an S3 client configuration based on a Flysystem configuration.
S3::mergeConfiguration	public static	function	Merges default Flysystem configuration.
S3::__construct	public	function	Constructs an S3 object.