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

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @category   Pimcore
  12.  * @package    Asset
  13.  *
  14.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  16.  */
  18. namespace Pimcore\Model\Asset\Image;
  20. use Pimcore\Event\AssetEvents;
  21. use Pimcore\Event\FrontendEvents;
  22. use Pimcore\Logger;
  23. use Pimcore\Model\Asset\Image;
  24. use Pimcore\Model\Asset\Thumbnail\ImageThumbnailTrait;
  25. use Pimcore\Tool;
  26. use Symfony\Component\EventDispatcher\GenericEvent;
  28. class Thumbnail
  29. {
  30.     use ImageThumbnailTrait;
  32.     /**
  33.      * @var bool[]
  34.      */
  35.     protected static $hasListenersCache = [];
  37.     /**
  38.      * @param Image $asset
  39.      * @param string|array|Thumbnail\Config $config
  40.      * @param bool $deferred
  41.      */
  42.     public function __construct($asset, $config = null, $deferred = true)
  43.     {
  44.         $this->asset = $asset;
  45.         $this->deferred = $deferred;
  46.         $this->config = $this->createConfig($config);
  47.     }
  49.     /**
  50.      * @param bool $deferredAllowed
  51.      *
  52.      * @return string
  53.      */
  54.     public function getPath($deferredAllowed = true)
  55.     {
  56.         $fsPath = $this->getFileSystemPath($deferredAllowed);
  57.         if ($this->getConfig()) {
  58.             if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  59.                 // we still generate the raster image, to get the final size of the thumbnail
  60.                 // we use getRealFullPath() here, to avoid double encoding (getFullPath() returns already encoded path)
  61.                 $fsPath = $this->asset->getRealFullPath();
  62.             }
  63.         }
  65.         $path = $this->convertToWebPath($fsPath);
  67.         if ($this->hasListeners(FrontendEvents::ASSET_IMAGE_THUMBNAIL)) {
  68.             $event = new GenericEvent($this, [
  69.                 'filesystemPath' => $fsPath,
  70.                 'frontendPath' => $path,
  71.             ]);
  72.             \Pimcore::getEventDispatcher()->dispatch(FrontendEvents::ASSET_IMAGE_THUMBNAIL, $event);
  73.             $path = $event->getArgument('frontendPath');
  74.         }
  76.         return $path;
  77.     }
  79.     /**
  80.      * @param string $eventName
  81.      *
  82.      * @return bool
  83.      */
  84.     protected function hasListeners(string $eventName): bool
  85.     {
  86.         if (!isset(self::$hasListenersCache[$eventName])) {
  87.             self::$hasListenersCache[$eventName] = \Pimcore::getEventDispatcher()->hasListeners($eventName);
  88.         }
  90.         return self::$hasListenersCache[$eventName];
  91.     }
  93.     /**
  94.      * @param string $filename
  95.      *
  96.      * @return bool
  97.      */
  98.     protected function useOriginalFile($filename)
  99.     {
  100.         if ($this->getConfig()) {
  101.             if (!$this->getConfig()->isRasterizeSVG() && preg_match("@\.svgz?$@", $filename)) {
  102.                 return true;
  103.             }
  104.         }
  106.         return false;
  107.     }
  109.     /**
  110.      * @param bool $deferredAllowed
  111.      */
  112.     public function generate($deferredAllowed = true)
  113.     {
  114.         $errorImage = PIMCORE_WEB_ROOT . '/bundles/pimcoreadmin/img/filetype-not-supported.svg';
  115.         $deferred = false;
  116.         $generated = false;
  118.         if (!$this->asset) {
  119.             $this->filesystemPath = $errorImage;
  120.         } elseif (!$this->filesystemPath) {
  121.             // if no correct thumbnail config is given use the original image as thumbnail
  122.             if (!$this->config) {
  123.                 $this->filesystemPath = $this->asset->getRealFullPath();
  124.             } else {
  125.                 try {
  126.                     $deferred = $deferredAllowed && $this->deferred;
  127.                     $this->filesystemPath = Thumbnail\Processor::process($this->asset, $this->config, null, $deferred, true, $generated);
  128.                 } catch (\Exception $e) {
  129.                     $this->filesystemPath = $errorImage;
  130.                     Logger::error("Couldn't create thumbnail of image " . $this->asset->getRealFullPath());
  131.                     Logger::error($e);
  132.                 }
  133.             }
  134.         }
  136.         if ($this->hasListeners(AssetEvents::IMAGE_THUMBNAIL)) {
  137.             \Pimcore::getEventDispatcher()->dispatch(AssetEvents::IMAGE_THUMBNAIL, new GenericEvent($this, [
  138.                 'deferred' => $deferred,
  139.                 'generated' => $generated,
  140.             ]));
  141.         }
  142.     }
  144.     /**
  145.      * Get the public path to the thumbnail image.
  146.      * This method is here for backwards compatility.
  147.      * Up to Pimcore 1.4.8 a thumbnail was returned as a path to an image.
  148.      *
  149.      * @return string Public path to thumbnail image.
  150.      */
  151.     public function __toString()
  152.     {
  153.         return $this->getPath(true);
  154.     }
  156.     /**
  157.      * @param string $path
  158.      * @param array $options
  159.      * @param Image $asset
  160.      *
  161.      * @return string
  162.      */
  163.     protected function addCacheBuster(string $path, array $options, Image $asset): string
  164.     {
  165.         if (isset($options['cacheBuster']) && $options['cacheBuster']) {
  166.             $path = '/cache-buster-' . $asset->getModificationDate() . $path;
  167.         }
  169.         return $path;
  170.     }
  172.     /**
  173.      * Get generated HTML for displaying the thumbnail image in a HTML document. (XHTML compatible).
  174.      * Attributes can be added as a parameter. Attributes containing illegal characters are ignored.
  175.      * Width and Height attribute can be overridden. SRC-attribute not.
  176.      * Values of attributes are escaped.
  177.      *
  178.      * @param array $options Custom configurations and HTML attributes.
  179.      * @param array $removeAttributes Listof key-value pairs of HTML attributes that should be removed
  180.      *
  181.      * @return string IMG-element with at least the attributes src, width, height, alt.
  182.      */
  183.     public function getHtml($options = [], $removeAttributes = [])
  184.     {
  185.         /** @var Image $image */
  186.         $image = $this->getAsset();
  187.         $attributes = [];
  188.         $pictureAttribs = $options['pictureAttributes'] ?? []; // this is used for the html5 <picture> element
  190.         // re-add support for disableWidthHeightAttributes
  191.         if (isset($options['disableWidthHeightAttributes']) && $options['disableWidthHeightAttributes']) {
  192.             // make sure the attributes are removed
  193.             $removeAttributes = array_merge($removeAttributes, ['width', 'height']);
  194.         } else {
  195.             if ($this->getWidth()) {
  196.                 $attributes['width'] = $this->getWidth();
  197.             }
  199.             if ($this->getHeight()) {
  200.                 $attributes['height'] = $this->getHeight();
  201.             }
  202.         }
  204.         $w3cImgAttributes = ['alt', 'align', 'border', 'height', 'hspace', 'ismap', 'longdesc', 'usemap',
  205.             'vspace', 'width', 'class', 'dir', 'id', 'lang', 'style', 'title', 'xml:lang', 'onmouseover',
  206.             'onabort', 'onclick', 'ondblclick', 'onmousedown', 'onmousemove', 'onmouseout', 'onmouseup',
  207.             'onkeydown', 'onkeypress', 'onkeyup', 'itemprop', 'itemscope', 'itemtype', ];
  209.         $customAttributes = [];
  210.         if (isset($options['attributes']) && is_array($options['attributes'])) {
  211.             $customAttributes = $options['attributes'];
  212.         }
  214.         $altText = '';
  215.         $titleText = '';
  216.         if (isset($options['alt'])) {
  217.             $altText = $options['alt'];
  218.         }
  219.         if (isset($options['title'])) {
  220.             $titleText = $options['title'];
  221.         }
  223.         if (empty($titleText) && (!isset($options['disableAutoTitle']) || !$options['disableAutoTitle'])) {
  224.             if ($image->getMetadata('title')) {
  225.                 $titleText = $image->getMetadata('title');
  226.             }
  227.         }
  229.         if (empty($altText) && (!isset($options['disableAutoAlt']) || !$options['disableAutoAlt'])) {
  230.             if ($image->getMetadata('alt')) {
  231.                 $altText = $image->getMetadata('alt');
  232.             } elseif (isset($options['defaultalt'])) {
  233.                 $altText = $options['defaultalt'];
  234.             } else {
  235.                 $altText = $titleText;
  236.             }
  237.         }
  239.         // get copyright from asset
  240.         if ($image->getMetadata('copyright') && (!isset($options['disableAutoCopyright']) || !$options['disableAutoCopyright'])) {
  241.             if (!empty($altText)) {
  242.                 $altText .= ' | ';
  243.             }
  244.             if (!empty($titleText)) {
  245.                 $titleText .= ' | ';
  246.             }
  247.             $altText .= ('© ' . $image->getMetadata('copyright'));
  248.             $titleText .= ('© ' . $image->getMetadata('copyright'));
  249.         }
  251.         $options['alt'] = $altText;
  252.         if (!empty($titleText)) {
  253.             $options['title'] = $titleText;
  254.         }
  256.         $attributesRaw = array_merge($options, $customAttributes);
  258.         foreach ($attributesRaw as $key => $value) {
  259.             if (!(is_string($value) || is_numeric($value) || is_bool($value))) {
  260.                 continue;
  261.             }
  263.             if (!(in_array($key, $w3cImgAttributes) || isset($customAttributes[$key]) || strpos($key, 'data-') === 0)) {
  264.                 continue;
  265.             }
  267.             //only include attributes with characters a-z and dashes in their name.
  268.             if (preg_match('/^[a-z-]+$/i', $key)) {
  269.                 $attributes[$key] = $value;
  271.                 // some attributes need to be added also as data- attribute, this is specific to picturePolyfill
  272.                 if (in_array($key, ['alt'])) {
  273.                     $pictureAttribs['data-' . $key] = $value;
  274.                 }
  275.             }
  276.         }
  278.         $path = $this->getPath(true);
  279.         $attributes['src'] = $this->addCacheBuster($path, $options, $image);
  281.         $thumbConfig = $this->getConfig();
  283.         if ($this->getConfig() && !$this->getConfig()->hasMedias() && !$this->useOriginalFile($path)) {
  284.             // generate the srcset
  285.             $srcSetValues = [];
  286.             foreach ([1, 2] as $highRes) {
  287.                 $thumbConfigRes = clone $thumbConfig;
  288.                 $thumbConfigRes->setHighResolution($highRes);
  289.                 $srcsetEntry = $image->getThumbnail($thumbConfigRes, true) . ' ' . $highRes . 'x';
  290.                 $srcSetValues[] = $this->addCacheBuster($srcsetEntry, $options, $image);
  291.             }
  292.             $attributes['srcset'] = implode(', ', $srcSetValues);
  293.         }
  295.         foreach ($removeAttributes as $attribute) {
  296.             unset($attributes[$attribute]);
  297.             unset($pictureAttribs[$attribute]);
  298.         }
  300.         $isLowQualityPreview = false;
  301.         if ((isset($options['lowQualityPlaceholder']) && $options['lowQualityPlaceholder']) && !Tool::isFrontendRequestByAdmin()) {
  302.             $previewDataUri = $this->getAsset()->getLowQualityPreviewDataUri();
  303.             if (!$previewDataUri) {
  304.                 // use a 1x1 transparent GIF as a fallback if no LQIP exists
  305.                 $previewDataUri = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';
  306.             }
  308.             $isLowQualityPreview = true;
  309.             $attributes['data-src'] = $attributes['src'];
  310.             if (isset($attributes['srcset'])) {
  311.                 $attributes['data-srcset'] = $attributes['srcset'];
  312.             }
  313.             $attributes['src'] = $previewDataUri;
  314.             unset($attributes['srcset']);
  315.         }
  317.         // build html tag
  318.         $htmlImgTag = '<img ' . array_to_html_attribute_string($attributes) . ' />';
  320.         // $this->getConfig() can be empty, the original image is returned
  321.         if ($this->getConfig() && ($this->getConfig()->hasMedias() || $this->getConfig()->getForcePictureTag())) {
  322.             // output the <picture> - element
  323.             $config = \Pimcore\Config::getSystemConfiguration('assets');
  324.             $isWebPAutoSupport = $config['image']['thumbnails']['webp_auto_support'] ?? false;
  325.             $isAutoFormat = ($isWebPAutoSupport && strtolower($this->getConfig()->getFormat()) === 'source') ? true : false;
  326.             $webpSupportBackup = null;
  328.             if ($isAutoFormat) {
  329.                 $webpSupportBackup = Image\Thumbnail\Processor::setHasWebpSupport(false);
  330.                 // ensure the default image is not WebP
  331.                 $this->filesystemPath = null;
  332.                 $path = $this->getPath(true);
  333.             }
  335.             $html = '<picture ' . array_to_html_attribute_string($pictureAttribs) . ' data-default-src="' . $this->addCacheBuster($path, $options, $image) . '">' . "\n";
  336.             $mediaConfigs = $thumbConfig->getMedias();
  338.             // currently only max-width is supported, the key of the media is WIDTHw (eg. 400w) according to the srcset specification
  339.             ksort($mediaConfigs, SORT_NUMERIC);
  340.             array_push($mediaConfigs, $thumbConfig->getItems()); //add the default config at the end - picturePolyfill v4
  342.             foreach ($mediaConfigs as $mediaQuery => $config) {
  343.                 $srcSetValues = [];
  344.                 $sourceTagAttributes = [];
  345.                 $thumb = null;
  347.                 foreach ([1, 2] as $highRes) {
  348.                     $thumbConfigRes = clone $thumbConfig;
  349.                     $thumbConfigRes->selectMedia($mediaQuery);
  350.                     $thumbConfigRes->setHighResolution($highRes);
  351.                     $thumb = $image->getThumbnail($thumbConfigRes, true);
  352.                     $srcSetValues[] = $this->addCacheBuster($thumb . ' ' . $highRes . 'x', $options, $image);
  354.                     if ($this->useOriginalFile($this->asset->getFilename()) && $this->getConfig()->isSvgTargetFormatPossible()) {
  355.                         break;
  356.                     }
  358.                     if ($isAutoFormat) {
  359.                         $thumbConfigWebP = clone $thumbConfigRes;
  360.                         $thumbConfigWebP->setFormat('webp');
  361.                         $image->getThumbnail($thumbConfigWebP, true)->getPath();
  362.                     }
  363.                 }
  365.                 if ($thumb) {
  366.                     $sourceTagAttributes['srcset'] = implode(', ', $srcSetValues);
  367.                     if ($mediaQuery) {
  368.                         if (preg_match('/^[\d]+w$/', $mediaQuery)) {
  369.                             // we replace the width indicator (400w) out of the name and build a proper media query for max width
  370.                             $maxWidth = str_replace('w', '', $mediaQuery);
  371.                             $sourceTagAttributes['media'] = '(max-width: ' . $maxWidth . 'px)';
  372.                         } else {
  373.                             // new style custom media queries
  374.                             $sourceTagAttributes['media'] = $mediaQuery;
  375.                         }
  377.                         $thumb->reset();
  378.                     }
  380.                     if ($isLowQualityPreview) {
  381.                         $sourceTagAttributes['data-srcset'] = $sourceTagAttributes['srcset'];
  382.                         unset($sourceTagAttributes['srcset']);
  383.                     }
  385.                     $sourceTagAttributes['type'] = $thumb->getMimeType();
  387.                     $sourceHtml = '<source ' . array_to_html_attribute_string($sourceTagAttributes) . ' />';
  388.                     if ($isAutoFormat) {
  389.                         $sourceHtmlWebP = preg_replace(['@(\.)(jpg|png)( \dx)@', '@(/)(jpeg|png)(")@'], '$1webp$3', $sourceHtml);
  390.                         if ($sourceHtmlWebP != $sourceHtml) {
  391.                             $html .= "\t" . $sourceHtmlWebP . "\n";
  392.                         }
  393.                     }
  395.                     $html .= "\t" . $sourceHtml . "\n";
  396.                 }
  397.             }
  399.             $attrCleanedForPicture = $attributes;
  400.             $attrCleanedForPicture['src'] = $this->addCacheBuster($path, $options, $image);
  401.             unset($attrCleanedForPicture['width']);
  402.             unset($attrCleanedForPicture['height']);
  404.             if (isset($attrCleanedForPicture['srcset'])) {
  405.                 unset($attrCleanedForPicture['srcset']);
  406.             }
  408.             if ($isLowQualityPreview) {
  409.                 unset($attrCleanedForPicture['data-src']);
  410.                 unset($attrCleanedForPicture['data-srcset']);
  411.                 $attrCleanedForPicture['data-src'] = $attrCleanedForPicture['src'];
  412.                 $attrCleanedForPicture['src'] = $attributes['src'];
  413.             }
  415.             $htmlImgTagForpicture = "\t" . '<img ' . array_to_html_attribute_string($attrCleanedForPicture) .' />';
  417.             $html .= $htmlImgTagForpicture . "\n";
  419.             $html .= '</picture>' . "\n";
  421.             $htmlImgTag = $html;
  423.             if ($isAutoFormat) {
  424.                 Image\Thumbnail\Processor::setHasWebpSupport($webpSupportBackup);
  425.             }
  426.         }
  428.         if (isset($options['useDataSrc']) && $options['useDataSrc']) {
  429.             $htmlImgTag = preg_replace('/ src(set)?=/i', ' data-src$1=', $htmlImgTag);
  430.         }
  432.         return $htmlImgTag;
  433.     }
  435.     /**
  436.      * @param string $name
  437.      * @param int $highRes
  438.      *
  439.      * @return Thumbnail
  440.      *
  441.      * @throws \Exception
  442.      */
  443.     public function getMedia($name, $highRes = 1)
  444.     {
  445.         $thumbConfig = $this->getConfig();
  446.         $mediaConfigs = $thumbConfig->getMedias();
  448.         if (isset($mediaConfigs[$name])) {
  449.             $thumbConfigRes = clone $thumbConfig;
  450.             $thumbConfigRes->selectMedia($name);
  451.             $thumbConfigRes->setHighResolution($highRes);
  452.             $thumbConfigRes->setMedias([]);
  453.             $thumb = $this->getAsset()->getThumbnail($thumbConfigRes);
  455.             return $thumb;
  456.         } else {
  457.             throw new \Exception("Media query '" . $name . "' doesn't exist in thumbnail configuration: " . $thumbConfig->getName());
  458.         }
  459.     }
  461.     /**
  462.      * Get a thumbnail image configuration.
  463.      *
  464.      * @param string|array|Thumbnail\Config $selector Name, array or object describing a thumbnail configuration.
  465.      *
  466.      * @return Thumbnail\Config
  467.      */
  468.     protected function createConfig($selector)
  469.     {
  470.         return Thumbnail\Config::getByAutoDetect($selector);
  471.     }
  472. }