vendor/pimcore/pimcore/models/Asset/Image/Thumbnail.php line 180

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Model\Asset\Image;
  18. use Pimcore\Event\AssetEvents;
  19. use Pimcore\Event\FrontendEvents;
  20. use Pimcore\Logger;
  21. use Pimcore\Model\Asset;
  22. use Pimcore\Model\Asset\Image;
  23. use Pimcore\Model\Asset\Thumbnail\ImageThumbnailTrait;
  24. use Pimcore\Model\Exception\NotFoundException;
  25. use Pimcore\Tool;
  26. use Symfony\Component\EventDispatcher\GenericEvent;
  28. final class Thumbnail
  29. {
  30.     use ImageThumbnailTrait;
  32.     /**
  33.      * @internal
  34.      *
  35.      * @var bool[]
  36.      */
  37.     protected static $hasListenersCache = [];
  39.     /**
  40.      * @param Image $asset
  41.      * @param string|array|Thumbnail\Config|null $config
  42.      * @param bool $deferred
  43.      */
  44.     public function __construct($asset, $config = null, $deferred = true)
  45.     {
  46.         $this->asset = $asset;
  47.         $this->deferred = $deferred;
  48.         $this->config = $this->createConfig($config);
  49.     }
  51.     /**
  52.      * TODO: Pimcore 11: Change method signature to getPath($args = [])
  53.      *
  54.      * @param mixed $args,...
  55.      *
  56.      * @return string
  57.      */
  58.     public function getPath(...$args)
  59.     {
  60.         // TODO: Pimcore 11: remove calling the covertArgsBcLayer() method
  61.         $args = $this->convertArgsBcLayer($args);
  63.         // set defaults
  64.         $deferredAllowed = $args['deferredAllowed'] ?? true;
  65.         $cacheBuster = $args['cacheBuster'] ?? false;
  66.         $frontend = $args['frontend'] ?? \Pimcore\Tool::isFrontend();
  68.         $pathReference = null;
  69.         if ($this->getConfig()) {
  70.             if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  71.                 // we still generate the raster image, to get the final size of the thumbnail
  72.                 // we use getRealFullPath() here, to avoid double encoding (getFullPath() returns already encoded path)
  73.                 $pathReference = [
  74.                     'src' => $this->asset->getRealFullPath(),
  75.                     'type' => 'asset',
  76.                 ];
  77.             }
  78.         }
  80.         if (!$pathReference) {
  81.             $pathReference = $this->getPathReference($deferredAllowed);
  82.         }
  84.         $path = $this->convertToWebPath($pathReference, $frontend);
  86.         if ($cacheBuster) {
  87.             $path = $this->addCacheBuster($path, ['cacheBuster' => true], $this->getAsset());
  88.         }
  90.         if ($this->hasListeners(FrontendEvents::ASSET_IMAGE_THUMBNAIL)) {
  91.             $event = new GenericEvent($this, [
  92.                 'pathReference' => $pathReference,
  93.                 'frontendPath' => $path,
  94.             ]);
  95.             \Pimcore::getEventDispatcher()->dispatch($event, FrontendEvents::ASSET_IMAGE_THUMBNAIL);
  96.             $path = $event->getArgument('frontendPath');
  97.         }
  99.         return $path;
  100.     }
  102.     /**
  103.      * @param string $eventName
  104.      *
  105.      * @return bool
  106.      */
  107.     protected function hasListeners(string $eventName): bool
  108.     {
  109.         if (!isset(self::$hasListenersCache[$eventName])) {
  110.             self::$hasListenersCache[$eventName] = \Pimcore::getEventDispatcher()->hasListeners($eventName);
  111.         }
  113.         return self::$hasListenersCache[$eventName];
  114.     }
  116.     /**
  117.      * @param string $filename
  118.      *
  119.      * @return bool
  120.      */
  121.     protected function useOriginalFile($filename)
  122.     {
  123.         if ($this->getConfig()) {
  124.             if (!$this->getConfig()->isRasterizeSVG() && preg_match("@\.svgz?$@", $filename)) {
  125.                 return true;
  126.             }
  127.         }
  129.         return false;
  130.     }
  132.     /**
  133.      * @internal
  134.      *
  135.      * @param bool $deferredAllowed
  136.      */
  137.     public function generate($deferredAllowed = true)
  138.     {
  139.         $deferred = false;
  140.         $generated = false;
  142.         if ($this->asset && empty($this->pathReference)) {
  143.             // if no correct thumbnail config is given use the original image as thumbnail
  144.             if (!$this->config) {
  145.                 $this->pathReference = [
  146.                     'type' => 'asset',
  147.                     'src' => $this->asset->getRealFullPath(),
  148.                 ];
  149.             } else {
  150.                 try {
  151.                     $deferred = $deferredAllowed && $this->deferred;
  152.                     $this->pathReference = Thumbnail\Processor::process($this->asset, $this->config, null, $deferred, $generated);
  153.                 } catch (\Exception $e) {
  154.                     Logger::error("Couldn't create thumbnail of image " . $this->asset->getRealFullPath() . ': ' . $e);
  155.                 }
  156.             }
  157.         }
  159.         if (empty($this->pathReference)) {
  160.             $this->pathReference = [
  161.                 'type' => 'error',
  162.                 'src' => '/bundles/pimcoreadmin/img/filetype-not-supported.svg',
  163.             ];
  164.         }
  166.         if ($this->hasListeners(AssetEvents::IMAGE_THUMBNAIL)) {
  167.             $event = new GenericEvent($this, [
  168.                 'deferred' => $deferred,
  169.                 'generated' => $generated,
  170.             ]);
  171.             \Pimcore::getEventDispatcher()->dispatch($event, AssetEvents::IMAGE_THUMBNAIL);
  172.         }
  173.     }
  175.     /**
  176.      * @return string Public path to thumbnail image.
  177.      */
  178.     public function __toString()
  179.     {
  180.         return $this->getPath();
  181.     }
  183.     /**
  184.      * @param string $path
  185.      * @param array $options
  186.      * @param Asset $asset
  187.      *
  188.      * @return string
  189.      */
  190.     private function addCacheBuster(string $path, array $options, Asset $asset): string
  191.     {
  192.         if (isset($options['cacheBuster']) && $options['cacheBuster']) {
  193.             if (!str_starts_with($path, 'http')) {
  194.                 $path = '/cache-buster-' . $asset->getVersionCount() . $path;
  195.             }
  196.         }
  198.         return $path;
  199.     }
  201.     private function getSourceTagHtml(Image\Thumbnail\Config $thumbConfig, string $mediaQuery, Image $image, array $options): string
  202.     {
  203.         $sourceTagAttributes = [];
  204.         $sourceTagAttributes['srcset'] = $this->getSrcset($thumbConfig, $image, $options, $mediaQuery);
  205.         $thumb = $image->getThumbnail($thumbConfig, true);
  207.         if ($mediaQuery) {
  208.             $sourceTagAttributes['media'] = $mediaQuery;
  209.             $thumb->reset();
  210.         }
  212.         if (isset($options['previewDataUri'])) {
  213.             $sourceTagAttributes['data-srcset'] = $sourceTagAttributes['srcset'];
  214.             unset($sourceTagAttributes['srcset']);
  215.         }
  217.         if (!isset($options['disableWidthHeightAttributes'])) {
  218.             if ($thumb->getWidth()) {
  219.                 $sourceTagAttributes['width'] = $thumb->getWidth();
  220.             }
  222.             if ($thumb->getHeight()) {
  223.                 $sourceTagAttributes['height'] = $thumb->getHeight();
  224.             }
  225.         }
  227.         $sourceTagAttributes['type'] = $thumb->getMimeType();
  229.         $sourceCallback = $options['sourceCallback'] ?? null;
  230.         if ($sourceCallback) {
  231.             $sourceTagAttributes = $sourceCallback($sourceTagAttributes);
  232.         }
  234.         return '<source ' . array_to_html_attribute_string($sourceTagAttributes) . ' />';
  235.     }
  237.     /**
  238.      * Get generated HTML for displaying the thumbnail image in a HTML document.
  239.      *
  240.      * @param array $options Custom configuration
  241.      *
  242.      * @return string
  243.      */
  244.     public function getHtml($options = [])
  245.     {
  246.         /** @var Image $image */
  247.         $image = $this->getAsset();
  248.         $thumbConfig = $this->getConfig();
  250.         $pictureTagAttributes = $options['pictureAttributes'] ?? []; // this is used for the html5 <picture> element
  252.         if ((isset($options['lowQualityPlaceholder']) && $options['lowQualityPlaceholder']) && !Tool::isFrontendRequestByAdmin()) {
  253.             $previewDataUri = $image->getLowQualityPreviewDataUri();
  254.             if (!$previewDataUri) {
  255.                 // use a 1x1 transparent GIF as a fallback if no LQIP exists
  256.                 $previewDataUri = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';
  257.             }
  259.             // this gets used in getImagTag() later
  260.             $options['previewDataUri'] = $previewDataUri;
  261.         }
  263.         $isAutoFormat = $thumbConfig instanceof Image\Thumbnail\Config ? strtolower($thumbConfig->getFormat()) === 'source' : false;
  265.         if ($isAutoFormat) {
  266.             // ensure the default image is not WebP
  267.             $this->pathReference = [];
  268.         }
  270.         $pictureCallback = $options['pictureCallback'] ?? null;
  271.         if ($pictureCallback) {
  272.             $pictureTagAttributes = $pictureCallback($pictureTagAttributes);
  273.         }
  275.         $html = '<picture ' . array_to_html_attribute_string($pictureTagAttributes) . '>' . "\n";
  277.         if ($thumbConfig instanceof Image\Thumbnail\Config) {
  278.             $mediaConfigs = $thumbConfig->getMedias();
  280.             // currently only max-width is supported, the key of the media is WIDTHw (eg. 400w) according to the srcset specification
  281.             ksort($mediaConfigs, SORT_NUMERIC);
  282.             array_push($mediaConfigs, $thumbConfig->getItems()); //add the default config at the end - picturePolyfill v4
  284.             foreach ($mediaConfigs as $mediaQuery => $config) {
  285.                 $sourceHtml = $this->getSourceTagHtml($thumbConfig, $mediaQuery, $image, $options);
  286.                 if (!empty($sourceHtml)) {
  287.                     if ($isAutoFormat) {
  288.                         foreach ($thumbConfig->getAutoFormatThumbnailConfigs() as $autoFormatConfig) {
  289.                             $autoFormatThumbnailHtml = $this->getSourceTagHtml($autoFormatConfig, $mediaQuery, $image, $options);
  290.                             if (!empty($autoFormatThumbnailHtml)) {
  291.                                 $html .= "\t" . $autoFormatThumbnailHtml . "\n";
  292.                             }
  293.                         }
  294.                     }
  296.                     $html .= "\t" . $sourceHtml . "\n";
  297.                 }
  298.             }
  299.         }
  301.         if (!($options['disableImgTag'] ?? null)) {
  302.             $html .= "\t" . $this->getImageTag($options) . "\n";
  303.         }
  305.         $html .= '</picture>' . "\n";
  307.         if (isset($options['useDataSrc']) && $options['useDataSrc']) {
  308.             $html = preg_replace('/ src(set)?=/i', ' data-src$1=', $html);
  309.         }
  311.         return $html;
  312.     }
  314.     /**
  315.      * @param array $options
  316.      * @param array $removeAttributes
  317.      *
  318.      * @return string
  319.      */
  320.     public function getImageTag(array $options = [], array $removeAttributes = []): string
  321.     {
  322.         /** @var Image $image */
  323.         $image = $this->getAsset();
  324.         $attributes = $options['imgAttributes'] ?? [];
  325.         $callback = $options['imgCallback'] ?? null;
  327.         if (isset($options['previewDataUri'])) {
  328.             $attributes['src'] = $options['previewDataUri'];
  329.         } else {
  330.             $path = $this->getPath();
  331.             $attributes['src'] = $this->addCacheBuster($path, $options, $image);
  332.         }
  334.         if (!isset($options['disableWidthHeightAttributes'])) {
  335.             if ($this->getWidth()) {
  336.                 $attributes['width'] = $this->getWidth();
  337.             }
  339.             if ($this->getHeight()) {
  340.                 $attributes['height'] = $this->getHeight();
  341.             }
  342.         }
  344.         $altText = !empty($options['alt']) ? $options['alt'] : (!empty($attributes['alt']) ? $attributes['alt'] : '');
  345.         $titleText = !empty($options['title']) ? $options['title'] : (!empty($attributes['title']) ? $attributes['title'] : '');
  347.         if (empty($titleText) && (!isset($options['disableAutoTitle']) || !$options['disableAutoTitle'])) {
  348.             if ($image->getMetadata('title')) {
  349.                 $titleText = $image->getMetadata('title');
  350.             }
  351.         }
  353.         if (empty($altText) && (!isset($options['disableAutoAlt']) || !$options['disableAutoAlt'])) {
  354.             if ($image->getMetadata('alt')) {
  355.                 $altText = $image->getMetadata('alt');
  356.             } elseif (isset($options['defaultalt'])) {
  357.                 $altText = $options['defaultalt'];
  358.             } else {
  359.                 $altText = $titleText;
  360.             }
  361.         }
  363.         // get copyright from asset
  364.         if ($image->getMetadata('copyright') && (!isset($options['disableAutoCopyright']) || !$options['disableAutoCopyright'])) {
  365.             if (!empty($altText)) {
  366.                 $altText .= ' | ';
  367.             }
  368.             if (!empty($titleText)) {
  369.                 $titleText .= ' | ';
  370.             }
  371.             $altText .= ('© ' . $image->getMetadata('copyright'));
  372.             $titleText .= ('© ' . $image->getMetadata('copyright'));
  373.         }
  375.         $attributes['alt'] = $altText;
  376.         if (!empty($titleText)) {
  377.             $attributes['title'] = $titleText;
  378.         }
  380.         if (!isset($attributes['loading'])) {
  381.             $attributes['loading'] = 'lazy';
  382.         }
  384.         foreach ($removeAttributes as $attribute) {
  385.             unset($attributes[$attribute]);
  386.         }
  388.         if ($callback) {
  389.             $attributes = $callback($attributes);
  390.         }
  392.         $thumbConfig = $this->getConfig();
  393.         if ($thumbConfig) {
  394.             $srcsetAttribute = isset($options['previewDataUri']) ? 'data-srcset' : 'srcset';
  396.             $attributes[$srcsetAttribute] = $this->getSrcset($thumbConfig, $image, $options);
  397.         }
  399.         $htmlImgTag = '';
  400.         if (!empty($attributes)) {
  401.             $htmlImgTag = '<img ' . array_to_html_attribute_string($attributes) . ' />';
  402.         }
  404.         return $htmlImgTag;
  405.     }
  407.     /**
  408.      * @param string $name
  409.      * @param int $highRes
  410.      *
  411.      * @return Thumbnail
  412.      *
  413.      * @throws \Exception
  414.      */
  415.     public function getMedia($name, $highRes = 1)
  416.     {
  417.         $thumbConfig = $this->getConfig();
  418.         $mediaConfigs = $thumbConfig->getMedias();
  420.         if (isset($mediaConfigs[$name])) {
  421.             $thumbConfigRes = clone $thumbConfig;
  422.             $thumbConfigRes->selectMedia($name);
  423.             $thumbConfigRes->setHighResolution($highRes);
  424.             $thumbConfigRes->setMedias([]);
  425.             /** @var Image $asset */
  426.             $asset = $this->getAsset();
  427.             $thumb = $asset->getThumbnail($thumbConfigRes);
  429.             return $thumb;
  430.         } else {
  431.             throw new \Exception("Media query '" . $name . "' doesn't exist in thumbnail configuration: " . $thumbConfig->getName());
  432.         }
  433.     }
  435.     /**
  436.      * Get a thumbnail image configuration.
  437.      *
  438.      * @param string|array|Thumbnail\Config $selector Name, array or object describing a thumbnail configuration.
  439.      *
  440.      * @return Thumbnail\Config
  441.      *
  442.      * @throws NotFoundException
  443.      */
  444.     private function createConfig($selector)
  445.     {
  446.         $thumbnailConfig = Thumbnail\Config::getByAutoDetect($selector);
  448.         if (!empty($selector) && $thumbnailConfig === null) {
  449.             throw new NotFoundException('Thumbnail definition "' . (is_string($selector) ? $selector : '') . '" does not exist');
  450.         }
  452.         return $thumbnailConfig;
  453.     }
  455.     /**
  456.      * Get value that can be directly used ina srcset HTML attribute for images.
  457.      *
  458.      * @param Image\Thumbnail\Config $thumbConfig
  459.      * @param Image $image
  460.      * @param array $options
  461.      * @param string|null $mediaQuery Can be empty string if no media queries are defined.
  462.      *
  463.      * @return string Relative paths to different thunbnail images with 1x and 2x resolution
  464.      */
  465.     private function getSrcset(Image\Thumbnail\Config $thumbConfig, Image $image, array $options, ?string $mediaQuery = null): string
  466.     {
  467.         $srcSetValues = [];
  468.         foreach ([1, 2] as $highRes) {
  469.             $thumbConfigRes = clone $thumbConfig;
  470.             if ($mediaQuery) {
  471.                 $thumbConfigRes->selectMedia($mediaQuery);
  472.             }
  473.             $thumbConfigRes->setHighResolution($highRes);
  474.             $thumb = $image->getThumbnail($thumbConfigRes, true);
  476.             $descriptor = $highRes . 'x';
  477.             // encode comma in thumbnail path as srcset is a comma separated list
  478.             $srcSetValues[] = str_replace(',', '%2C', $this->addCacheBuster($thumb . ' ' . $descriptor, $options, $image));
  480.             if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  481.                 break;
  482.             }
  483.         }
  485.         return implode(', ', $srcSetValues);
  486.     }
  487. }