vendor/liip/imagine-bundle/Controller/ImagineController.php line 95

  1. <?php
  3. /*
  4.  * This file is part of the `liip/LiipImagineBundle` project.
  5.  *
  6.  * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE.md
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Liip\ImagineBundle\Controller;
  14. use Imagine\Exception\RuntimeException;
  15. use Liip\ImagineBundle\Config\Controller\ControllerConfig;
  16. use Liip\ImagineBundle\Exception\Binary\Loader\NotLoadableException;
  17. use Liip\ImagineBundle\Exception\Imagine\Filter\NonExistingFilterException;
  18. use Liip\ImagineBundle\Imagine\Cache\Helper\PathHelper;
  19. use Liip\ImagineBundle\Imagine\Cache\SignerInterface;
  20. use Liip\ImagineBundle\Imagine\Data\DataManager;
  21. use Liip\ImagineBundle\Service\FilterService;
  22. use Symfony\Component\HttpFoundation\Exception\BadRequestException;
  23. use Symfony\Component\HttpFoundation\RedirectResponse;
  24. use Symfony\Component\HttpFoundation\Request;
  25. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  26. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  27. use Symfony\Component\HttpKernel\Kernel;
  29. class ImagineController
  30. {
  31.     /**
  32.      * @var FilterService
  33.      */
  34.     private $filterService;
  36.     /**
  37.      * @var DataManager
  38.      */
  39.     private $dataManager;
  41.     /**
  42.      * @var SignerInterface
  43.      */
  44.     private $signer;
  46.     /**
  47.      * @var ControllerConfig
  48.      */
  49.     private $controllerConfig;
  51.     public function __construct(
  52.         FilterService $filterService,
  53.         DataManager $dataManager,
  54.         SignerInterface $signer,
  55.         ?ControllerConfig $controllerConfig = null
  56.     ) {
  57.         $this->filterService = $filterService;
  58.         $this->dataManager = $dataManager;
  59.         $this->signer = $signer;
  61.         if (null === $controllerConfig) {
  62.             @trigger_error(sprintf(
  63.                 'Instantiating "%s" without a forth argument of type "%s" is deprecated since 2.2.0 and will be required in 3.0.', self::class, ControllerConfig::class
  64.             ), E_USER_DEPRECATED);
  65.         }
  67.         $this->controllerConfig = $controllerConfig ?? new ControllerConfig(301);
  68.     }
  70.     /**
  71.      * This action applies a given filter to a given image, saves the image and redirects the browser to the stored
  72.      * image.
  73.      *
  74.      * The resulting image is cached so subsequent requests will redirect to the cached image instead applying the
  75.      * filter and storing the image again.
  76.      *
  77.      * @param string $path
  78.      * @param string $filter
  79.      *
  80.      * @throws RuntimeException
  81.      * @throws NotFoundHttpException
  82.      *
  83.      * @return RedirectResponse
  84.      */
  85.     public function filterAction(Request $request, $path, $filter)
  86.     {
  87.         $path = PathHelper::urlPathToFilePath($path);
  88.         $resolver = $request->get('resolver');
  90.         return $this->createRedirectResponse(function () use ($path, $filter, $resolver, $request) {
  91.             return $this->filterService->getUrlOfFilteredImage(
  92.                 $path,
  93.                 $filter,
  94.                 $resolver,
  95.                 $this->isWebpSupported($request)
  96.             );
  97.         }, $path, $filter);
  98.     }
  100.     /**
  101.      * This action applies a given filter -merged with additional runtime filters- to a given image, saves the image and
  102.      * redirects the browser to the stored image.
  103.      *
  104.      * The resulting image is cached so subsequent requests will redirect to the cached image instead applying the
  105.      * filter and storing the image again.
  106.      *
  107.      * @param string $hash
  108.      * @param string $path
  109.      * @param string $filter
  110.      *
  111.      * @throws RuntimeException
  112.      * @throws BadRequestHttpException
  113.      * @throws NotFoundHttpException
  114.      *
  115.      * @return RedirectResponse
  116.      */
  117.     public function filterRuntimeAction(Request $request, $hash, $path, $filter)
  118.     {
  119.         $resolver = $request->get('resolver');
  120.         $path = PathHelper::urlPathToFilePath($path);
  121.         $runtimeConfig = $this->getFiltersBc($request);
  123.         if (true !== $this->signer->check($hash, $path, $runtimeConfig)) {
  124.             throw new BadRequestHttpException(sprintf('Signed url does not pass the sign check for path "%s" and filter "%s" and runtime config %s', $path, $filter, json_encode($runtimeConfig)));
  125.         }
  127.         return $this->createRedirectResponse(function () use ($path, $filter, $runtimeConfig, $resolver, $request) {
  128.             return $this->filterService->getUrlOfFilteredImageWithRuntimeFilters(
  129.                 $path,
  130.                 $filter,
  131.                 $runtimeConfig,
  132.                 $resolver,
  133.                 $this->isWebpSupported($request)
  134.             );
  135.         }, $path, $filter, $hash);
  136.     }
  138.     private function getFiltersBc(Request $request): array
  139.     {
  140.         if (version_compare(Kernel::VERSION, '5.1', '>=')) {
  141.             try {
  142.                 return $request->query->all('filters');
  143.             } catch (BadRequestException $e) {
  144.                 // for strict BC - BadRequestException seems more suited to this situation.
  145.                 // remove the try-catch in version 3
  146.                 throw new NotFoundHttpException(sprintf('Filters must be an array. Value was "%s"', $request->query->get('filters')));
  147.             }
  148.         }
  150.         $runtimeConfig = $request->query->get('filters', []);
  152.         if (!\is_array($runtimeConfig)) {
  153.             throw new NotFoundHttpException(sprintf('Filters must be an array. Value was "%s"', $runtimeConfig));
  154.         }
  156.         return $runtimeConfig;
  157.     }
  159.     private function createRedirectResponse(\Closure $url, string $path, string $filter, ?string $hash = null): RedirectResponse
  160.     {
  161.         try {
  162.             return new RedirectResponse($url(), $this->controllerConfig->getRedirectResponseCode());
  163.         } catch (NotLoadableException $exception) {
  164.             if (null !== $this->dataManager->getDefaultImageUrl($filter)) {
  165.                 return new RedirectResponse($this->dataManager->getDefaultImageUrl($filter));
  166.             }
  168.             throw new NotFoundHttpException(sprintf('Source image for path "%s" could not be found', $path), $exception);
  169.         } catch (NonExistingFilterException $exception) {
  170.             throw new NotFoundHttpException(sprintf('Requested non-existing filter "%s"', $filter), $exception);
  171.         } catch (RuntimeException $exception) {
  172.             throw new \RuntimeException(vsprintf('Unable to create image for path "%s" and filter "%s". Message was "%s"', [$hash ? sprintf('%s/%s', $hash, $path) : $path, $filter, $exception->getMessage()]), 0, $exception);
  173.         }
  174.     }
  176.     private function isWebpSupported(Request $request): bool
  177.     {
  178.         return false !== mb_stripos($request->headers->get('accept', ''), 'image/webp');
  179.     }
  180. }