You are here

Home » API reference » S3 File System 8.2 » ValidateService.php

class ValidateService in S3 File System 8.2

Defines a ValidateService service.

Hierarchy

Expanded class hierarchy of ValidateService

1 string reference to 'ValidateService'
s3fs.services.yml in ./s3fs.services.yml
s3fs.services.yml
1 service uses ValidateService
s3fs.validate in ./s3fs.services.yml
Drupal\s3fs\ValidateService

File

src/ValidateService.php, line 16

Namespace

Drupal\s3fs
View source 
class ValidateService {
  use StringTranslationTrait;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The config factory object.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * Constructs an ValidateService object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The new database connection object.
   *
   * @param \Drupal\Core\Config\ConfigFactory $config_factory
   *   The config factory object.
   */
  public function __construct(Connection $connection, ConfigFactory $config_factory) {
    $this->connection = $connection;
    $this->configFactory = $config_factory;
  }

  /**
   * Validate the S3fs config.
   *
   * @param $config
   *   Array of configuration settings from which to configure the client.
   * @param $returnError
   *   Boolean, False by default.
   *
   * @return Boolean/array
   */
  public function validate(array $config, $returnError = FALSE) {
    if (!empty($config['use_customhost']) && empty($config['hostname'])) {
      if ($returnError) {
        $name = 'hostname';
        $msg = $this
          ->t('You must specify a Hostname to use the Custom Host feature.');
        return [
          $name,
          $msg,
        ];
      }
      return FALSE;
    }
    if (!empty($config['use_cname']) && empty($config['domain'])) {
      if ($returnError) {
        $name = 'domain';
        $msg = $this
          ->t('You must specify a CDN Domain Name to use the CNAME feature.');
        return [
          $name,
          $msg,
        ];
      }
      return FALSE;
    }
    try {
      $s3 = $this
        ->getAmazonS3Client($config);
    } catch (S3Exception $e) {
      if ($returnError) {
        $name = 'form';
        $msg = $e
          ->getMessage();
        return [
          $name,
          $msg,
        ];
      }
      return FALSE;
    }

    // Test the connection to S3, and the bucket name.
    try {

      // listObjects() will trigger descriptive exceptions if the credentials,
      // bucket name, or region are invalid/mismatched.
      $s3
        ->listObjects([
        'Bucket' => $config['bucket'],
        'MaxKeys' => 1,
      ]);
    } catch (S3Exception $e) {
      if ($returnError) {
        $name = 'form';
        $msg = $this
          ->t('An unexpected error occurred. @message', [
          '@message' => $e
            ->getMessage(),
        ]);
        return [
          $name,
          $msg,
        ];
      }
      return FALSE;
    }
    return TRUE;
  }

  /**
   * Sets up the S3Client object.
   * For performance reasons, only one S3Client object will ever be created
   * within a single request.
   *
   * @param $config
   *   Array of configuration settings from which to configure the client.
   *
   * @return \Aws\S3\S3Client
   *   The fully-configured S3Client object.
   *
   * @throws \Drupal\s3fs\S3fsException
   */
  public function getAmazonS3Client($config) {
    $s3 =& drupal_static(__METHOD__ . '_S3Client');
    $static_config =& drupal_static(__METHOD__ . '_static_config');

    // If the client hasn't been set up yet, or the config given to this call is
    // different from the previous call, (re)build the client.
    if (!isset($s3) || $static_config != $config) {
      if (!class_exists('Aws\\S3\\S3Client')) {
        throw new S3fsException($this
          ->t('Cannot load Aws\\S3\\S3Client class. Please ensure that the aws sdk php library is installed correctly.'));
      }
      elseif (!$config['use_instance_profile'] && (!$config['secret_key'] || !$config['access_key'])) {
        throw new S3fsException($this
          ->t("Your AWS credentials have not been properly configured.\n          Please set them on the S3 File System admin/config/media/s3fs page or\n          set \$config['s3fs.settings']['access_key'] and \$config['s3fs.settings']['secret_key'] in settings.php."));
      }
      elseif ($config['use_instance_profile'] && empty($config['default_cache_config'])) {
        throw new S3fsException($this
          ->t("Your AWS credentials have not been properly configured.\n          You are attempting to use instance profile credentials but you have not set a default cache location.\n          Please set it on the admin/config/media/s3fs page or set \$config['s3fs.settings']['cache_config'] in settings.php."));
      }

      // Create the Aws\S3\S3Client object.
      if ($config['use_instance_profile']) {
        $client_config = [
          'default_cache_config' => $config['default_cache_config'],
        ];
      }
      else {
        $client_config['credentials'] = [
          'key' => $config['access_key'],
          'secret' => $config['secret_key'],
        ];
      }
      if (!empty($config['region'])) {
        $client_config['region'] = $config['region'];

        // Signature v4 is only required in the Beijing and Frankfurt regions.
        // Also, setting it will throw an exception if a region hasn't been set.
        $client_config['signature'] = 'v4';
      }
      if (!empty($config['use_customhost']) && !empty($config['hostname'])) {
        $client_config['base_url'] = $config['hostname'];
      }
      $client_config['version'] = 'latest';
      $s3 = S3Client::factory($client_config);
      $static_config = $config;
    }
    return $s3;
  }

  /**
   * Copies all the local files from the specified file system into S3.
   *
   * @param array $config
   *   An s3fs configuration array.
   * @param $scheme
   *   A variable defining which scheme (Public or Private) to copy.
   */
  function copyFileSystemToS3($config, $scheme) {
    if ($scheme == 'public') {
      $source_folder = realpath(PublicStream::basePath());
      $target_folder = !empty($config['public_folder']) ? $config['public_folder'] . '/' : 's3fs-public/';
    }
    else {
      if ($scheme == 'private') {
        $source_folder = PrivateStream::basePath() ? PrivateStream::basePath() : '';
        $source_folder_real = realpath($source_folder);
        if (empty($source_folder) || empty($source_folder_real)) {
          drupal_set_message('Private file system base path is unknown. Unable to perform S3 copy.', 'error');
          return;
        }
        $target_folder = !empty($config['private_folder']) ? $config['private_folder'] . '/' : 's3fs-private/';
      }
    }
    if (!empty($config['root_folder'])) {
      $target_folder = "{$config['root_folder']}/{$target_folder}";
    }

    // Create S3 object to move files.
    $s3 = $this
      ->getAmazonS3Client($config);
    $file_paths = $this
      ->dirScan($source_folder);
    foreach ($file_paths as $path) {
      $relative_path = str_replace($source_folder . '/', '', $path);
      print "Copying {$scheme}://{$relative_path} into S3...\n";

      // Finally get to make use of S3fsStreamWrapper's "S3 is actually a local
      // file system. No really!" functionality.
      copy($path, "s3fs://{$relative_path}");
    }
    drupal_set_message($this
      ->t('Copied all local %scheme files to S3.', [
      '%scheme' => $scheme,
    ]), 'status');
  }

  /**
   * Scans a given directory.
   *
   * @param $dir
   *   The directory to be scanned.
   *
   * @return array
   *   Array of file paths.
   */
  function dirScan($dir) {
    $output = [];
    $files = scandir($dir);
    foreach ($files as $file) {
      $path = "{$dir}/{$file}";
      if ($file != '.' && $file != '..') {

        // In case they put their private root folder inside their public one,
        // skip it. When listing the private file system contents, $path will
        // never trigger this.
        if ($path == realpath(PrivateStream::basePath() ? PrivateStream::basePath() : '')) {
          continue;
        }
        if (is_dir($path)) {
          $output = array_merge($output, $this
            ->dirScan($path));
        }
        else {
          $output[] = $path;
        }
      }
    }
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
ValidateService::$configFactory protected property The config factory object.
ValidateService::$connection protected property The database connection.
ValidateService::copyFileSystemToS3 function Copies all the local files from the specified file system into S3.
ValidateService::dirScan function Scans a given directory.
ValidateService::getAmazonS3Client public function Sets up the S3Client object. For performance reasons, only one S3Client object will ever be created within a single request.
ValidateService::validate public function Validate the S3fs config.
ValidateService::__construct public function Constructs an ValidateService object.