FileTestHooks.php

<?php

declare (strict_types=1);
namespace Drupal\file_test\Hook;

use Drupal\Core\Hook\Attribute\Hook;
use Drupal\file\Entity\File;
use Drupal\file_test\FileTestCdn;
use Drupal\file_test\FileTestHelper;
// cspell:ignore tarz
// cspell:ignore garply

/**
 * Hook implementations for file_test.
 */
class FileTestHooks {
  
  /**
   * Implements hook_ENTITY_TYPE_load() for file entities.
   */
  public function fileLoad($files) : void {
    foreach ($files as $file) {
      FileTestHelper::logCall('load', [
        $file->id(),
      ]);
      // Assign a value on the object so that we can test that the $file is
      // passed by reference.
      $file->file_test['loaded'] = TRUE;
    }
  }
  
  /**
   * Implements hook_file_download().
   */
  public function fileDownload($uri) : array|int|null {
    if (\Drupal::state()->get('file_test.allow_all', FALSE)) {
      $files = \Drupal::entityTypeManager()->getStorage('file')
        ->loadByProperties([
        'uri' => $uri,
      ]);
      $file = reset($files);
      return $file->getDownloadHeaders();
    }
    FileTestHelper::logCall('download', [
      $uri,
    ]);
    return $this->getReturn('download');
  }
  
  /**
   * Implements hook_ENTITY_TYPE_insert() for file entities.
   */
  public function fileInsert(File $file) : void {
    FileTestHelper::logCall('insert', [
      $file->id(),
    ]);
  }
  
  /**
   * Implements hook_ENTITY_TYPE_update() for file entities.
   */
  public function fileUpdate(File $file) : void {
    FileTestHelper::logCall('update', [
      $file->id(),
    ]);
  }
  
  /**
   * Implements hook_file_copy().
   */
  public function fileCopy(File $file, $source) : void {
    FileTestHelper::logCall('copy', [
      $file->id(),
      $source->id(),
    ]);
  }
  
  /**
   * Implements hook_file_move().
   */
  public function fileMove(File $file, File $source) : void {
    FileTestHelper::logCall('move', [
      $file->id(),
      $source->id(),
    ]);
  }
  
  /**
   * Implements hook_ENTITY_TYPE_predelete() for file entities.
   */
  public function filePredelete(File $file) : void {
    FileTestHelper::logCall('delete', [
      $file->id(),
    ]);
  }
  
  /**
   * Implements hook_file_url_alter().
   */
  public function fileUrlAlter(&$uri) : void {
    /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
    $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
    // Only run this hook when this variable is set. Otherwise, we'd have to add
    // another hidden test module just for this hook.
    $alter_mode = \Drupal::state()->get('file_test.hook_file_url_alter');
    if (!$alter_mode) {
      return;
    }
    elseif ($alter_mode == 'cdn') {
      $cdn_extensions = [
        'css',
        'js',
        'gif',
        'jpg',
        'jpeg',
        'png',
      ];
      // Most CDNs don't support private file transfers without a lot of hassle,
      // so don't support this in the common case.
      $schemes = [
        'public',
      ];
      $scheme = $stream_wrapper_manager::getScheme($uri);
      // Only serve shipped files and public created files from the CDN.
      if (!$scheme || in_array($scheme, $schemes)) {
        // Shipped files.
        if (!$scheme) {
          $path = $uri;
        }
        else {
          $wrapper = $stream_wrapper_manager->getViaScheme($scheme);
          $path = $wrapper->getDirectoryPath() . '/' . $stream_wrapper_manager::getTarget($uri);
        }
        // Clean up Windows paths.
        $path = str_replace('\\', '/', $path);
        // Serve files with one of the CDN extensions from CDN 1, all others
        // from CDN 2.
        $pathinfo = pathinfo($path);
        if (array_key_exists('extension', $pathinfo) && in_array($pathinfo['extension'], $cdn_extensions)) {
          $uri = FileTestCdn::First->value . '/' . $path;
        }
        else {
          $uri = FileTestCdn::Second->value . '/' . $path;
        }
      }
    }
    elseif ($alter_mode == 'root-relative') {
      // Only serve shipped files and public created files with root-relative
      // URLs.
      $scheme = $stream_wrapper_manager::getScheme($uri);
      if (!$scheme || $scheme == 'public') {
        // Shipped files.
        if (!$scheme) {
          $path = $uri;
        }
        else {
          $wrapper = $stream_wrapper_manager->getViaScheme($scheme);
          $path = $wrapper->getDirectoryPath() . '/' . $stream_wrapper_manager::getTarget($uri);
        }
        // Clean up Windows paths.
        $path = str_replace('\\', '/', $path);
        // Generate a root-relative URL.
        $uri = base_path() . '/' . $path;
      }
    }
    elseif ($alter_mode == 'protocol-relative') {
      // Only serve shipped files and public created files with
      // protocol-relative URLs.
      $scheme = $stream_wrapper_manager::getScheme($uri);
      if (!$scheme || $scheme == 'public') {
        // Shipped files.
        if (!$scheme) {
          $path = $uri;
        }
        else {
          $wrapper = $stream_wrapper_manager->getViaScheme($scheme);
          $path = $wrapper->getDirectoryPath() . '/' . $stream_wrapper_manager::getTarget($uri);
        }
        // Clean up Windows paths.
        $path = str_replace('\\', '/', $path);
        // Generate a protocol-relative URL.
        $uri = '/' . base_path() . '/' . $path;
      }
    }
  }
  
  /**
   * Implements hook_entity_type_alter().
   */
  public function entityTypeAlter(&$entity_types) : void {
    if (\Drupal::state()->get('file_test_alternate_access_handler', FALSE)) {
      /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
      $entity_types['file']->setAccessClass('Drupal\\file_test\\FileTestAccessControlHandler');
    }
  }
  
  /**
   * Load the appropriate return value.
   *
   * @param string $op
   *   One of the hook_file_[validate,download] operations.
   *
   * @return array|int|null
   *   Value set by Drupal\file_test\FileTestHelper::setReturn().
   *
   * @see \Drupal\file_test\FileTestHelper::setReturn()
   * @see Drupal\file_test\FileTestHelper::reset()
   */
  public function getReturn($op) : array|int|null {
    $return = \Drupal::keyValue('file_test')->get('return', [
      $op => NULL,
    ]);
    return $return[$op];
  }

}