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

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\Image\Thumbnail\Config;
  24. use Pimcore\Model\Asset\Thumbnail\ImageThumbnailTrait;
  25. use Pimcore\Model\Exception\NotFoundException;
  26. use Pimcore\Tool;
  27. use Symfony\Component\EventDispatcher\GenericEvent;
  29. final class Thumbnail
  30. {
  31.     use ImageThumbnailTrait;
  33.     /**
  34.      * @internal
  35.      *
  36.      * @var bool[]
  37.      */
  38.     protected static $hasListenersCache = [];
  40.     /**
  41.      * @param Image $asset
  42.      * @param string|array|Thumbnail\Config|null $config
  43.      * @param bool $deferred
  44.      */
  45.     public function __construct($asset, $config = null, $deferred = true)
  46.     {
  47.         $this->asset = $asset;
  48.         $this->deferred = $deferred;
  49.         $this->config = $this->createConfig($config);
  50.     }
  52.     /**
  53.      * TODO: Pimcore 11: Change method signature to getPath($args = [])
  54.      *
  55.      * @param mixed $args,...
  56.      *
  57.      * @return string
  58.      */
  59.     public function getPath(...$args)
  60.     {
  61.         // TODO: Pimcore 11: remove calling the covertArgsBcLayer() method
  62.         $args = $this->convertArgsBcLayer($args);
  64.         // set defaults
  65.         $deferredAllowed = $args['deferredAllowed'] ?? true;
  66.         $cacheBuster = $args['cacheBuster'] ?? false;
  67.         $frontend = $args['frontend'] ?? \Pimcore\Tool::isFrontend();
  69.         $pathReference = null;
  70.         if ($this->getConfig()) {
  71.             if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  72.                 // we still generate the raster image, to get the final size of the thumbnail
  73.                 // we use getRealFullPath() here, to avoid double encoding (getFullPath() returns already encoded path)
  74.                 $pathReference = [
  75.                     'src' => $this->asset->getRealFullPath(),
  76.                     'type' => 'asset',
  77.                 ];
  78.             }
  79.         }
  81.         if (!$pathReference) {
  82.             $pathReference = $this->getPathReference($deferredAllowed);
  83.         }
  85.         $path = $this->convertToWebPath($pathReference, $frontend);
  87.         if ($cacheBuster) {
  88.             $path = $this->addCacheBuster($path, ['cacheBuster' => true], $this->getAsset());
  89.         }
  91.         if ($this->hasListeners(FrontendEvents::ASSET_IMAGE_THUMBNAIL)) {
  92.             $event = new GenericEvent($this, [
  93.                 'pathReference' => $pathReference,
  94.                 'frontendPath' => $path,
  95.             ]);
  96.             \Pimcore::getEventDispatcher()->dispatch($event, FrontendEvents::ASSET_IMAGE_THUMBNAIL);
  97.             $path = $event->getArgument('frontendPath');
  98.         }
  100.         return $path;
  101.     }
  103.     /**
  104.      * @param string $eventName
  105.      *
  106.      * @return bool
  107.      */
  108.     protected function hasListeners(string $eventName): bool
  109.     {
  110.         if (!isset(self::$hasListenersCache[$eventName])) {
  111.             self::$hasListenersCache[$eventName] = \Pimcore::getEventDispatcher()->hasListeners($eventName);
  112.         }
  114.         return self::$hasListenersCache[$eventName];
  115.     }
  117.     /**
  118.      * @param string $filename
  119.      *
  120.      * @return bool
  121.      */
  122.     protected function useOriginalFile($filename)
  123.     {
  124.         if ($this->getConfig()) {
  125.             if (!$this->getConfig()->isRasterizeSVG() && preg_match("@\.svgz?$@", $filename)) {
  126.                 return true;
  127.             }
  128.         }
  130.         return false;
  131.     }
  133.     /**
  134.      * @internal
  135.      *
  136.      * @param bool $deferredAllowed
  137.      */
  138.     public function generate($deferredAllowed = true)
  139.     {
  140.         $deferred = false;
  141.         $generated = false;
  143.         if ($this->asset && empty($this->pathReference)) {
  144.             // if no correct thumbnail config is given use the original image as thumbnail
  145.             if (!$this->config) {
  146.                 $this->pathReference = [
  147.                     'type' => 'asset',
  148.                     'src' => $this->asset->getRealFullPath(),
  149.                 ];
  150.             } else {
  151.                 try {
  152.                     $deferred = $deferredAllowed && $this->deferred;
  153.                     $this->pathReference = Thumbnail\Processor::process($this->asset, $this->config, null, $deferred, $generated);
  154.                 } catch (\Exception $e) {
  155.                     Logger::error("Couldn't create thumbnail of image " . $this->asset->getRealFullPath() . ': ' . $e);
  156.                 }
  157.             }
  158.         }
  160.         if (empty($this->pathReference)) {
  161.             $this->pathReference = [
  162.                 'type' => 'error',
  163.                 'src' => '/bundles/pimcoreadmin/img/filetype-not-supported.svg',
  164.             ];
  165.         }
  167.         if ($this->hasListeners(AssetEvents::IMAGE_THUMBNAIL)) {
  168.             $event = new GenericEvent($this, [
  169.                 'deferred' => $deferred,
  170.                 'generated' => $generated,
  171.             ]);
  172.             \Pimcore::getEventDispatcher()->dispatch($event, AssetEvents::IMAGE_THUMBNAIL);
  173.         }
  174.     }
  176.     /**
  177.      * @return string Public path to thumbnail image.
  178.      */
  179.     public function __toString()
  180.     {
  181.         return $this->getPath();
  182.     }
  184.     /**
  185.      * @param string $path
  186.      * @param array $options
  187.      * @param Asset $asset
  188.      *
  189.      * @return string
  190.      */
  191.     private function addCacheBuster(string $path, array $options, Asset $asset): string
  192.     {
  193.         if (isset($options['cacheBuster']) && $options['cacheBuster']) {
  194.             if (!str_starts_with($path, 'http')) {
  195.                 $path = '/cache-buster-' . $asset->getVersionCount() . $path;
  196.             }
  197.         }
  199.         return $path;
  200.     }
  202.     private function getSourceTagHtml(Config $thumbConfig, string $mediaQuery, Image $image, array $options): string
  203.     {
  204.         $sourceTagAttributes = [];
  205.         $sourceTagAttributes['srcset'] = $this->getSrcset($thumbConfig, $image, $options, $mediaQuery);
  206.         $thumb = $image->getThumbnail($thumbConfig, true);
  208.         if ($mediaQuery) {
  209.             $sourceTagAttributes['media'] = $mediaQuery;
  210.             $thumb->reset();
  211.         }
  213.         if (isset($options['previewDataUri'])) {
  214.             $sourceTagAttributes['data-srcset'] = $sourceTagAttributes['srcset'];
  215.             unset($sourceTagAttributes['srcset']);
  216.         }
  218.         if (!isset($options['disableWidthHeightAttributes'])) {
  219.             if ($thumb->getWidth()) {
  220.                 $sourceTagAttributes['width'] = $thumb->getWidth();
  221.             }
  223.             if ($thumb->getHeight()) {
  224.                 $sourceTagAttributes['height'] = $thumb->getHeight();
  225.             }
  226.         }
  228.         $sourceTagAttributes['type'] = $thumb->getMimeType();
  230.         $sourceCallback = $options['sourceCallback'] ?? null;
  231.         if ($sourceCallback) {
  232.             $sourceTagAttributes = $sourceCallback($sourceTagAttributes);
  233.         }
  235.         return '<source ' . array_to_html_attribute_string($sourceTagAttributes) . ' />';
  236.     }
  238.     /**
  239.      * Get generated HTML for displaying the thumbnail image in a HTML document.
  240.      *
  241.      * @param array $options Custom configuration
  242.      *
  243.      * @return string
  244.      */
  245.     public function getHtml($options = [])
  246.     {
  247.         $emptyGif = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';
  248.         /** @var Image $image */
  249.         $image = $this->getAsset();
  250.         $thumbConfig = $this->getConfig();
  252.         $pictureTagAttributes = $options['pictureAttributes'] ?? []; // this is used for the html5 <picture> element
  254.         if (($options['lowQualityPlaceholder'] ?? false) && !Tool::isFrontendRequestByAdmin()) {
  255.             // this gets used in getImagTag() later, use a 1x1 transparent GIF as a fallback if no LQIP exists
  256.             $options['previewDataUri'] =  $image->getLowQualityPreviewDataUri() ?: $emptyGif;
  257.         }
  259.         $isAutoFormat = $thumbConfig instanceof Config ? strtolower($thumbConfig->getFormat()) === 'source' : false;
  261.         if ($isAutoFormat) {
  262.             // ensure the default image is not WebP
  263.             $this->pathReference = [];
  264.         }
  266.         $pictureCallback = $options['pictureCallback'] ?? null;
  267.         if ($pictureCallback) {
  268.             $pictureTagAttributes = $pictureCallback($pictureTagAttributes);
  269.         }
  271.         $html = '<picture ' . array_to_html_attribute_string($pictureTagAttributes) . '>' . "\n";
  273.         if ($thumbConfig instanceof Config) {
  274.             $thumbConfigRes = clone $thumbConfig;
  275.             $html.= $this->getMediaConfigHtml($thumbConfigRes, $image, $options, $isAutoFormat);
  276.         }
  278.         if (!($options['disableImgTag'] ?? null)) {
  279.             $html .= "\t" . $this->getImageTag($options) . "\n";
  280.         }
  282.         $html .= '</picture>' . "\n";
  284.         if ($options['useDataSrc'] ?? false) {
  285.             $html = preg_replace('/ src(set)?=/i', ' data-src$1=', $html);
  286.         }
  288.         return $html;
  289.     }
  291.     protected function getMediaConfigHtml(Config $thumbConfig, Image $image, array $options, bool $isAutoFormat): string
  292.     {
  293.         $html = '';
  294.         $mediaConfigs = $thumbConfig->getMedias();
  296.         // currently only max-width is supported, the key of the media is WIDTHw (eg. 400w) according to the srcset specification
  297.         ksort($mediaConfigs, SORT_NUMERIC);
  298.         array_push($mediaConfigs, $thumbConfig->getItems()); //add the default config at the end - picturePolyfill v4
  300.         foreach ($mediaConfigs as $mediaQuery => $config) {
  301.             $thumbConfig->setItems($config);
  302.             $sourceHtml = $this->getSourceTagHtml($thumbConfig, $mediaQuery, $image, $options);
  303.             if (!empty($sourceHtml)) {
  304.                 if ($isAutoFormat) {
  305.                     foreach ($thumbConfig->getAutoFormatThumbnailConfigs() as $autoFormatConfig) {
  306.                         $autoFormatThumbnailHtml = $this->getSourceTagHtml($autoFormatConfig, $mediaQuery, $image, $options);
  307.                         if (!empty($autoFormatThumbnailHtml)) {
  308.                             $html .= "\t" . $autoFormatThumbnailHtml . "\n";
  309.                         }
  310.                     }
  311.                 }
  313.                 $html .= "\t" . $sourceHtml . "\n";
  314.             }
  315.         }
  317.         return $html;
  318.     }
  320.     /**
  321.      * @param array $options
  322.      * @param array $removeAttributes
  323.      *
  324.      * @return string
  325.      */
  326.     public function getImageTag(array $options = [], array $removeAttributes = []): string
  327.     {
  328.         /** @var Image $image */
  329.         $image = $this->getAsset();
  330.         $attributes = $options['imgAttributes'] ?? [];
  331.         $callback = $options['imgCallback'] ?? null;
  333.         if (isset($options['previewDataUri'])) {
  334.             $attributes['src'] = $options['previewDataUri'];
  335.         } else {
  336.             $path = $this->getPath();
  337.             $attributes['src'] = $this->addCacheBuster($path, $options, $image);
  338.         }
  340.         if (!isset($options['disableWidthHeightAttributes'])) {
  341.             if ($this->getWidth()) {
  342.                 $attributes['width'] = $this->getWidth();
  343.             }
  345.             if ($this->getHeight()) {
  346.                 $attributes['height'] = $this->getHeight();
  347.             }
  348.         }
  350.         $altText = !empty($options['alt']) ? $options['alt'] : (!empty($attributes['alt']) ? $attributes['alt'] : '');
  351.         $titleText = !empty($options['title']) ? $options['title'] : (!empty($attributes['title']) ? $attributes['title'] : '');
  353.         if (empty($titleText) && (!isset($options['disableAutoTitle']) || !$options['disableAutoTitle'])) {
  354.             if ($image->getMetadata('title')) {
  355.                 $titleText = $image->getMetadata('title');
  356.             }
  357.         }
  359.         if (empty($altText) && (!isset($options['disableAutoAlt']) || !$options['disableAutoAlt'])) {
  360.             if ($image->getMetadata('alt')) {
  361.                 $altText = $image->getMetadata('alt');
  362.             } elseif (isset($options['defaultalt'])) {
  363.                 $altText = $options['defaultalt'];
  364.             } else {
  365.                 $altText = $titleText;
  366.             }
  367.         }
  369.         // get copyright from asset
  370.         if ($image->getMetadata('copyright') && (!isset($options['disableAutoCopyright']) || !$options['disableAutoCopyright'])) {
  371.             if (!empty($altText)) {
  372.                 $altText .= ' | ';
  373.             }
  374.             if (!empty($titleText)) {
  375.                 $titleText .= ' | ';
  376.             }
  377.             $altText .= ('© ' . $image->getMetadata('copyright'));
  378.             $titleText .= ('© ' . $image->getMetadata('copyright'));
  379.         }
  381.         $attributes['alt'] = $altText;
  382.         if (!empty($titleText)) {
  383.             $attributes['title'] = $titleText;
  384.         }
  386.         if (!isset($attributes['loading'])) {
  387.             $attributes['loading'] = 'lazy';
  388.         }
  390.         foreach ($removeAttributes as $attribute) {
  391.             unset($attributes[$attribute]);
  392.         }
  394.         if ($callback) {
  395.             $attributes = $callback($attributes);
  396.         }
  398.         $thumbConfig = $this->getConfig();
  399.         if ($thumbConfig) {
  400.             $srcsetAttribute = isset($options['previewDataUri']) ? 'data-srcset' : 'srcset';
  402.             $attributes[$srcsetAttribute] = $this->getSrcset($thumbConfig, $image, $options);
  403.         }
  405.         $htmlImgTag = '';
  406.         if (!empty($attributes)) {
  407.             $htmlImgTag = '<img ' . array_to_html_attribute_string($attributes) . ' />';
  408.         }
  410.         return $htmlImgTag;
  411.     }
  413.     /**
  414.      * @param string $name
  415.      * @param int $highRes
  416.      *
  417.      * @return Thumbnail
  418.      *
  419.      * @throws \Exception
  420.      */
  421.     public function getMedia($name, $highRes = 1)
  422.     {
  423.         $thumbConfig = $this->getConfig();
  424.         $mediaConfigs = $thumbConfig->getMedias();
  426.         if (isset($mediaConfigs[$name])) {
  427.             $thumbConfigRes = clone $thumbConfig;
  428.             $thumbConfigRes->selectMedia($name);
  429.             $thumbConfigRes->setHighResolution($highRes);
  430.             $thumbConfigRes->setMedias([]);
  431.             /** @var Image $asset */
  432.             $asset = $this->getAsset();
  433.             $thumb = $asset->getThumbnail($thumbConfigRes);
  435.             return $thumb;
  436.         } else {
  437.             throw new \Exception("Media query '" . $name . "' doesn't exist in thumbnail configuration: " . $thumbConfig->getName());
  438.         }
  439.     }
  441.     /**
  442.      * Get a thumbnail image configuration.
  443.      *
  444.      * @param string|array|Thumbnail\Config $selector Name, array or object describing a thumbnail configuration.
  445.      *
  446.      * @return Thumbnail\Config
  447.      *
  448.      * @throws NotFoundException
  449.      */
  450.     private function createConfig($selector)
  451.     {
  452.         $thumbnailConfig = Thumbnail\Config::getByAutoDetect($selector);
  454.         if (!empty($selector) && $thumbnailConfig === null) {
  455.             throw new NotFoundException('Thumbnail definition "' . (is_string($selector) ? $selector : '') . '" does not exist');
  456.         }
  458.         return $thumbnailConfig;
  459.     }
  461.     /**
  462.      * Get value that can be directly used ina srcset HTML attribute for images.
  463.      *
  464.      * @param Config $thumbConfig
  465.      * @param Image $image
  466.      * @param array $options
  467.      * @param string|null $mediaQuery Can be empty string if no media queries are defined.
  468.      *
  469.      * @return string Relative paths to different thunbnail images with 1x and 2x resolution
  470.      */
  471.     private function getSrcset(Config $thumbConfig, Image $image, array $options, ?string $mediaQuery = null): string
  472.     {
  473.         $srcSetValues = [];
  474.         foreach ([1, 2] as $highRes) {
  475.             $thumbConfigRes = clone $thumbConfig;
  476.             if ($mediaQuery) {
  477.                 $thumbConfigRes->selectMedia($mediaQuery);
  478.             }
  479.             $thumbConfigRes->setHighResolution($highRes);
  480.             $thumb = $image->getThumbnail($thumbConfigRes, true);
  482.             $descriptor = $highRes . 'x';
  483.             // encode comma in thumbnail path as srcset is a comma separated list
  484.             $srcSetValues[] = str_replace(',', '%2C', $this->addCacheBuster($thumb . ' ' . $descriptor, $options, $image));
  486.             if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  487.                 break;
  488.             }
  489.         }
  491.         return implode(', ', $srcSetValues);
  492.     }
  493. }