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

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.      * @param bool $deferredAllowed
  53.      * @param bool $cacheBuster
  54.      *
  55.      * @return string
  56.      */
  57.     public function getPath($deferredAllowed = true, $cacheBuster = false)
  58.     {
  59.         $pathReference = null;
  60.         if ($this->getConfig()) {
  61.             if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  62.                 // we still generate the raster image, to get the final size of the thumbnail
  63.                 // we use getRealFullPath() here, to avoid double encoding (getFullPath() returns already encoded path)
  64.                 $pathReference = [
  65.                     'src' => $this->asset->getRealFullPath(),
  66.                     'type' => 'asset',
  67.                 ];
  68.             }
  69.         }
  71.         if (!$pathReference) {
  72.             $pathReference = $this->getPathReference($deferredAllowed);
  73.         }
  75.         $path = $this->convertToWebPath($pathReference);
  77.         if ($cacheBuster) {
  78.             $path = $this->addCacheBuster($path, ['cacheBuster' => true], $this->getAsset());
  79.         }
  81.         if ($this->hasListeners(FrontendEvents::ASSET_IMAGE_THUMBNAIL)) {
  82.             $event = new GenericEvent($this, [
  83.                 'pathReference' => $pathReference,
  84.                 'frontendPath' => $path,
  85.             ]);
  86.             \Pimcore::getEventDispatcher()->dispatch($event, FrontendEvents::ASSET_IMAGE_THUMBNAIL);
  87.             $path = $event->getArgument('frontendPath');
  88.         }
  90.         return $path;
  91.     }
  93.     /**
  94.      * @param string $eventName
  95.      *
  96.      * @return bool
  97.      */
  98.     protected function hasListeners(string $eventName): bool
  99.     {
  100.         if (!isset(self::$hasListenersCache[$eventName])) {
  101.             self::$hasListenersCache[$eventName] = \Pimcore::getEventDispatcher()->hasListeners($eventName);
  102.         }
  104.         return self::$hasListenersCache[$eventName];
  105.     }
  107.     /**
  108.      * @param string $filename
  109.      *
  110.      * @return bool
  111.      */
  112.     protected function useOriginalFile($filename)
  113.     {
  114.         if ($this->getConfig()) {
  115.             if (!$this->getConfig()->isRasterizeSVG() && preg_match("@\.svgz?$@", $filename)) {
  116.                 return true;
  117.             }
  118.         }
  120.         return false;
  121.     }
  123.     /**
  124.      * @internal
  125.      *
  126.      * @param bool $deferredAllowed
  127.      */
  128.     public function generate($deferredAllowed = true)
  129.     {
  130.         $deferred = false;
  131.         $generated = false;
  133.         if ($this->asset && empty($this->pathReference)) {
  134.             // if no correct thumbnail config is given use the original image as thumbnail
  135.             if (!$this->config) {
  136.                 $this->pathReference = [
  137.                     'type' => 'asset',
  138.                     'src' => $this->asset->getRealFullPath(),
  139.                 ];
  140.             } else {
  141.                 try {
  142.                     $deferred = $deferredAllowed && $this->deferred;
  143.                     $this->pathReference = Thumbnail\Processor::process($this->asset, $this->config, null, $deferred, $generated);
  144.                 } catch (\Exception $e) {
  145.                     Logger::error("Couldn't create thumbnail of image " . $this->asset->getRealFullPath());
  146.                     Logger::error($e->getMessage());
  147.                 }
  148.             }
  149.         }
  151.         if (empty($this->pathReference)) {
  152.             $this->pathReference = [
  153.                 'type' => 'error',
  154.                 'src' => '/bundles/pimcoreadmin/img/filetype-not-supported.svg',
  155.             ];
  156.         }
  158.         if ($this->hasListeners(AssetEvents::IMAGE_THUMBNAIL)) {
  159.             $event = new GenericEvent($this, [
  160.                 'deferred' => $deferred,
  161.                 'generated' => $generated,
  162.             ]);
  163.             \Pimcore::getEventDispatcher()->dispatch($event, AssetEvents::IMAGE_THUMBNAIL);
  164.         }
  165.     }
  167.     /**
  168.      * @return string Public path to thumbnail image.
  169.      */
  170.     public function __toString()
  171.     {
  172.         return $this->getPath(true);
  173.     }
  175.     /**
  176.      * @param string $path
  177.      * @param array $options
  178.      * @param Asset $asset
  179.      *
  180.      * @return string
  181.      */
  182.     private function addCacheBuster(string $path, array $options, Asset $asset): string
  183.     {
  184.         if (isset($options['cacheBuster']) && $options['cacheBuster']) {
  185.             if (!str_starts_with($path, 'http')) {
  186.                 $path = '/cache-buster-' . $asset->getVersionCount() . $path;
  187.             }
  188.         }
  190.         return $path;
  191.     }
  193.     private function getSourceTagHtml(Image\Thumbnail\Config $thumbConfig, string $mediaQuery, Image $image, array $options): string
  194.     {
  195.         $sourceTagAttributes = [];
  196.         $sourceTagAttributes['srcset'] = $this->getSrcset($thumbConfig, $image, $options, $mediaQuery);
  197.         $thumb = $image->getThumbnail($thumbConfig, true);
  199.         if ($mediaQuery) {
  200.             $sourceTagAttributes['media'] = $mediaQuery;
  201.             $thumb->reset();
  202.         }
  204.         if (isset($options['previewDataUri'])) {
  205.             $sourceTagAttributes['data-srcset'] = $sourceTagAttributes['srcset'];
  206.             unset($sourceTagAttributes['srcset']);
  207.         }
  209.         $sourceTagAttributes['type'] = $thumb->getMimeType();
  211.         $sourceCallback = $options['sourceCallback'] ?? null;
  212.         if ($sourceCallback) {
  213.             $sourceTagAttributes = $sourceCallback($sourceTagAttributes);
  214.         }
  216.         return '<source ' . array_to_html_attribute_string($sourceTagAttributes) . ' />';
  217.     }
  219.     /**
  220.      * Get generated HTML for displaying the thumbnail image in a HTML document.
  221.      *
  222.      * @param array $options Custom configuration
  223.      *
  224.      * @return string
  225.      */
  226.     public function getHtml($options = [])
  227.     {
  228.         /** @var Image $image */
  229.         $image = $this->getAsset();
  230.         $thumbConfig = $this->getConfig();
  232.         $pictureTagAttributes = $options['pictureAttributes'] ?? []; // this is used for the html5 <picture> element
  234.         if ((isset($options['lowQualityPlaceholder']) && $options['lowQualityPlaceholder']) && !Tool::isFrontendRequestByAdmin()) {
  235.             $previewDataUri = $image->getLowQualityPreviewDataUri();
  236.             if (!$previewDataUri) {
  237.                 // use a 1x1 transparent GIF as a fallback if no LQIP exists
  238.                 $previewDataUri = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';
  239.             }
  241.             // this gets used in getImagTag() later
  242.             $options['previewDataUri'] = $previewDataUri;
  243.         }
  245.         $isAutoFormat = $thumbConfig instanceof Image\Thumbnail\Config ? strtolower($thumbConfig->getFormat()) === 'source' : false;
  247.         if ($isAutoFormat) {
  248.             // ensure the default image is not WebP
  249.             $this->pathReference = [];
  250.         }
  252.         $pictureCallback = $options['pictureCallback'] ?? null;
  253.         if ($pictureCallback) {
  254.             $pictureTagAttributes = $pictureCallback($pictureTagAttributes);
  255.         }
  257.         $html = '<picture ' . array_to_html_attribute_string($pictureTagAttributes) . '>' . "\n";
  259.         if ($thumbConfig instanceof Image\Thumbnail\Config) {
  260.             $mediaConfigs = $thumbConfig->getMedias();
  262.             // currently only max-width is supported, the key of the media is WIDTHw (eg. 400w) according to the srcset specification
  263.             ksort($mediaConfigs, SORT_NUMERIC);
  264.             array_push($mediaConfigs, $thumbConfig->getItems()); //add the default config at the end - picturePolyfill v4
  266.             foreach ($mediaConfigs as $mediaQuery => $config) {
  267.                 $sourceHtml = $this->getSourceTagHtml($thumbConfig, $mediaQuery, $image, $options);
  268.                 if (!empty($sourceHtml)) {
  269.                     if ($isAutoFormat) {
  270.                         foreach ($thumbConfig->getAutoFormatThumbnailConfigs() as $autoFormatConfig) {
  271.                             $autoFormatThumbnailHtml = $this->getSourceTagHtml($autoFormatConfig, $mediaQuery, $image, $options);
  272.                             if (!empty($autoFormatThumbnailHtml)) {
  273.                                 $html .= "\t" . $autoFormatThumbnailHtml . "\n";
  274.                             }
  275.                         }
  276.                     }
  278.                     $html .= "\t" . $sourceHtml . "\n";
  279.                 }
  280.             }
  281.         }
  283.         if (!($options['disableImgTag'] ?? null)) {
  284.             $html .= "\t" . $this->getImageTag($options) . "\n";
  285.         }
  287.         $html .= '</picture>' . "\n";
  289.         if (isset($options['useDataSrc']) && $options['useDataSrc']) {
  290.             $html = preg_replace('/ src(set)?=/i', ' data-src$1=', $html);
  291.         }
  293.         return $html;
  294.     }
  296.     /**
  297.      * @param array $options
  298.      * @param array $removeAttributes
  299.      *
  300.      * @return string
  301.      */
  302.     public function getImageTag(array $options = [], array $removeAttributes = []): string
  303.     {
  304.         /** @var Image $image */
  305.         $image = $this->getAsset();
  306.         $attributes = $options['imgAttributes'] ?? [];
  307.         $callback = $options['imgCallback'] ?? null;
  309.         if (isset($options['previewDataUri'])) {
  310.             $attributes['src'] = $options['previewDataUri'];
  311.         } else {
  312.             $path = $this->getPath(true);
  313.             $attributes['src'] = $this->addCacheBuster($path, $options, $image);
  314.         }
  316.         if (!isset($options['disableWidthHeightAttributes'])) {
  317.             if ($this->getWidth()) {
  318.                 $attributes['width'] = $this->getWidth();
  319.             }
  321.             if ($this->getHeight()) {
  322.                 $attributes['height'] = $this->getHeight();
  323.             }
  324.         }
  326.         $altText = !empty($options['alt']) ? $options['alt'] : (!empty($attributes['alt']) ? $attributes['alt'] : '');
  327.         $titleText = !empty($options['title']) ? $options['title'] : (!empty($attributes['title']) ? $attributes['title'] : '');
  329.         if (empty($titleText) && (!isset($options['disableAutoTitle']) || !$options['disableAutoTitle'])) {
  330.             if ($image->getMetadata('title')) {
  331.                 $titleText = $image->getMetadata('title');
  332.             }
  333.         }
  335.         if (empty($altText) && (!isset($options['disableAutoAlt']) || !$options['disableAutoAlt'])) {
  336.             if ($image->getMetadata('alt')) {
  337.                 $altText = $image->getMetadata('alt');
  338.             } elseif (isset($options['defaultalt'])) {
  339.                 $altText = $options['defaultalt'];
  340.             } else {
  341.                 $altText = $titleText;
  342.             }
  343.         }
  345.         // get copyright from asset
  346.         if ($image->getMetadata('copyright') && (!isset($options['disableAutoCopyright']) || !$options['disableAutoCopyright'])) {
  347.             if (!empty($altText)) {
  348.                 $altText .= ' | ';
  349.             }
  350.             if (!empty($titleText)) {
  351.                 $titleText .= ' | ';
  352.             }
  353.             $altText .= ('© ' . $image->getMetadata('copyright'));
  354.             $titleText .= ('© ' . $image->getMetadata('copyright'));
  355.         }
  357.         $attributes['alt'] = $altText;
  358.         if (!empty($titleText)) {
  359.             $attributes['title'] = $titleText;
  360.         }
  362.         if (!isset($attributes['loading'])) {
  363.             $attributes['loading'] = 'lazy';
  364.         }
  366.         foreach ($removeAttributes as $attribute) {
  367.             unset($attributes[$attribute]);
  368.         }
  370.         if ($callback) {
  371.             $attributes = $callback($attributes);
  372.         }
  374.         $thumbConfig = $this->getConfig();
  375.         if ($thumbConfig) {
  376.             $srcsetAttribute = isset($options['previewDataUri']) ? 'data-srcset' : 'srcset';
  378.             $attributes[$srcsetAttribute] = $this->getSrcset($thumbConfig, $image, $options);
  379.         }
  381.         $htmlImgTag = '';
  382.         if (!empty($attributes)) {
  383.             $htmlImgTag = '<img ' . array_to_html_attribute_string($attributes) . ' />';
  384.         }
  386.         return $htmlImgTag;
  387.     }
  389.     /**
  390.      * @param string $name
  391.      * @param int $highRes
  392.      *
  393.      * @return Thumbnail
  394.      *
  395.      * @throws \Exception
  396.      */
  397.     public function getMedia($name, $highRes = 1)
  398.     {
  399.         $thumbConfig = $this->getConfig();
  400.         $mediaConfigs = $thumbConfig->getMedias();
  402.         if (isset($mediaConfigs[$name])) {
  403.             $thumbConfigRes = clone $thumbConfig;
  404.             $thumbConfigRes->selectMedia($name);
  405.             $thumbConfigRes->setHighResolution($highRes);
  406.             $thumbConfigRes->setMedias([]);
  407.             /** @var Image $asset */
  408.             $asset = $this->getAsset();
  409.             $thumb = $asset->getThumbnail($thumbConfigRes);
  411.             return $thumb;
  412.         } else {
  413.             throw new \Exception("Media query '" . $name . "' doesn't exist in thumbnail configuration: " . $thumbConfig->getName());
  414.         }
  415.     }
  417.     /**
  418.      * Get a thumbnail image configuration.
  419.      *
  420.      * @param string|array|Thumbnail\Config $selector Name, array or object describing a thumbnail configuration.
  421.      *
  422.      * @return Thumbnail\Config
  423.      *
  424.      * @throws NotFoundException
  425.      */
  426.     private function createConfig($selector)
  427.     {
  428.         $thumbnailConfig = Thumbnail\Config::getByAutoDetect($selector);
  430.         if (!empty($selector) && $thumbnailConfig === null) {
  431.             throw new NotFoundException('Thumbnail definition "' . (is_string($selector) ? $selector : '') . '" does not exist');
  432.         }
  434.         return $thumbnailConfig;
  435.     }
  437.     /**
  438.      * Get value that can be directly used ina srcset HTML attribute for images.
  439.      *
  440.      * @param Image\Thumbnail\Config $thumbConfig
  441.      * @param Image $image
  442.      * @param array $options
  443.      * @param string|null $mediaQuery Can be empty string if no media queries are defined.
  444.      *
  445.      * @return string Relative paths to different thunbnail images with 1x and 2x resolution
  446.      */
  447.     private function getSrcset(Image\Thumbnail\Config $thumbConfig, Image $image, array $options, ?string $mediaQuery = null): string
  448.     {
  449.         $srcSetValues = [];
  450.         foreach ([1, 2] as $highRes) {
  451.             $thumbConfigRes = clone $thumbConfig;
  452.             if ($mediaQuery) {
  453.                 $thumbConfigRes->selectMedia($mediaQuery);
  454.             }
  455.             $thumbConfigRes->setHighResolution($highRes);
  456.             $thumb = $image->getThumbnail($thumbConfigRes, true);
  458.             $descriptor = $highRes . 'x';
  459.             $srcSetValues[] = $this->addCacheBuster($thumb . ' ' . $descriptor, $options, $image);
  461.             if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  462.                 break;
  463.             }
  464.         }
  466.         return implode(', ', $srcSetValues);
  467.     }
  468. }