class AvatarKitDownloadUtility in Avatar Kit 8.2

Utility for creating Drupal files from responses.

Hierarchy

• class \Drupal\avatars\AvatarKitDownloadUtility implements AvatarKitDownloadUtilityInterface

1 string reference to 'AvatarKitDownloadUtility'

avatars.services.yml in ./avatars.services.yml

avatars.services.yml

1 service uses AvatarKitDownloadUtility

avatars.utility.download in ./avatars.services.yml

Drupal\avatars\AvatarKitDownloadUtility

File

src/AvatarKitDownloadUtility.php, line 17

Namespace

Drupal\avatars

class AvatarKitDownloadUtility implements AvatarKitDownloadUtilityInterface {

  /**
   * Storage for 'file' entity.
   *
   * @var \Drupal\Core\Entity\ContentEntityStorageInterface
   */
  protected $fileStorage;

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The file usage service.
   *
   * @var \Drupal\file\FileUsage\FileUsageInterface
   */
  protected $fileUsage;

  /**
   * The Guzzle HTTP middleware.
   *
   * @var \GuzzleHttp\Client
   */
  protected $httpClient;

  /**
   * The logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Creates a new AvatarKitDownloadUtility instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   * @param \Drupal\Core\File\FileSystemInterface $fileSystem
   *   The file system service.
   * @param \Drupal\file\FileUsage\FileUsageInterface $fileUsage
   *   The file usage service.
   * @param \GuzzleHttp\Client $httpClient
   *   The Guzzle HTTP middleware.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger service.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, FileSystemInterface $fileSystem, FileUsageInterface $fileUsage, Client $httpClient, LoggerInterface $logger) {
    $this->fileStorage = $entityTypeManager
      ->getStorage('file');
    $this->fileSystem = $fileSystem;
    $this->fileUsage = $fileUsage;
    $this->httpClient = $httpClient;
    $this->logger = $logger;
  }

  /**
   * {@inheritdoc}
   */
  public function get(string $uri) : ResponseInterface {
    $valid_url = !empty($uri) && parse_url($uri) !== FALSE;
    if (!$valid_url) {
      throw new \InvalidArgumentException('Malformed Url');
    }
    $response = $this->httpClient
      ->get($uri);
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function createFile(ResponseInterface $response, string $default_filename) : ?FileInterface {
    $stream = $response
      ->getBody();

    // Save stream to temporary file.
    // Following block is file_unmanaged_save_data() but without the Drupal
    // message.
    $temp_filepath = $this->fileSystem
      ->tempnam('temporary://', 'temp');
    if (\file_put_contents($temp_filepath, $stream) === FALSE) {
      $this->logger
        ->notice('Unable to create temporary file: %filename.', [
        '%filename' => $temp_filepath,
      ]);
      return NULL;
    }
    [
      'dirname' => $directory,
      'filename' => $filename,
    ] = pathinfo($default_filename);
    $final_filename = $directory . DIRECTORY_SEPARATOR . $filename . '.' . $this
      ->getExtension($response);

    // Create destination directory if it doesn't exist.
    if (file_prepare_directory($directory, FILE_CREATE_DIRECTORY) !== TRUE) {
      $this->logger
        ->notice('Unable to create directory: %directory.', [
        '%directory' => $directory,
      ]);
      return NULL;
    }

    // Move the temporary file to the final destination.
    try {
      $final_filepath = $this
        ->moveFile($temp_filepath, $final_filename, FILE_EXISTS_REPLACE);
    } catch (\Exception $e) {

      // file_unmanaged_move() logs its own errors.
      return NULL;
    }

    // Create file entity.
    // file_save_data() used as inspiration.

    /** @var \Drupal\file\FileInterface $file */
    $file = $this->fileStorage
      ->create();
    $file
      ->setFileUri($final_filepath);
    $file
      ->setPermanent();

    // `$violation_count = $this->logViolations($file);`.
    // Normally you would return NULL here. But if file_entity module is
    // installed, it will cause voilations since there is no bundle set.
    try {
      $file
        ->save();
    } catch (\Exception $e) {
      $this->logger
        ->notice('Error saving file: %message.', [
        '%message' => $e
          ->getMessage(),
      ]);
    }
    return $file;
  }

  /**
   * Abstraction of file_unmanaged_move.
   *
   * @param array ...
   *   Arguments to pass to file_unmanaged_move().
   *
   * @see \file_unmanaged_move();
   *
   * @return string
   *   The path to the new file.
   *
   * @throws \Exception
   *   Throws exception in the event of an error.
   */
  protected function moveFile(...$args) : string {
    $result = \file_unmanaged_move(...$args);
    if ($result === FALSE) {
      throw new \Exception('Failed to move file.');
    }
    return $result;
  }

  /**
   * Guess file extension for a response.
   *
   * @param \Psr\Http\Message\ResponseInterface $response
   *   A response object.
   *
   * @return string
   *   A file extension. 'file' is returned if no guess could be made.
   */
  protected function getExtension(ResponseInterface $response) : string {
    $guesser = ExtensionGuesser::getInstance();
    $mime = $response
      ->getHeaderLine('Content-Type');
    return $guesser
      ->guess($mime) ?? 'file';
  }

  /**
   * Validates a file entity and logs any violations.
   *
   * @param \Drupal\file\FileInterface $entity
   *   A file entity to validate.
   *
   * @return int
   *   Number of violations logged.
   */
  protected function logViolations(FileInterface $entity) : int {
    $violations = $entity
      ->validate();
    if ($violations) {
      foreach ($violations as $violation) {
        $message = $violation
          ->getMessage();
        $this->logger
          ->notice('Unable to save file %file: %message.', [
          '%file' => $entity
            ->getFileUri(),
          '%message' => $message,
        ]);
      }
    }
    return $violations
      ->count();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AvatarKitDownloadUtility::$fileStorage	protected	property	Storage for 'file' entity.
AvatarKitDownloadUtility::$fileSystem	protected	property	The file system service.
AvatarKitDownloadUtility::$fileUsage	protected	property	The file usage service.
AvatarKitDownloadUtility::$httpClient	protected	property	The Guzzle HTTP middleware.
AvatarKitDownloadUtility::$logger	protected	property	The logger instance.
AvatarKitDownloadUtility::createFile	public	function	Creates a file entity from a PSR response. Overrides AvatarKitDownloadUtilityInterface::createFile
AvatarKitDownloadUtility::get	public	function	Get stream for a file. Overrides AvatarKitDownloadUtilityInterface::get
AvatarKitDownloadUtility::getExtension	protected	function	Guess file extension for a response.
AvatarKitDownloadUtility::logViolations	protected	function	Validates a file entity and logs any violations.
AvatarKitDownloadUtility::moveFile	protected	function	Abstraction of file_unmanaged_move.
AvatarKitDownloadUtility::__construct	public	function	Creates a new AvatarKitDownloadUtility instance.