Symfony Profiler

<?php
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PCL
*/
namespace Pimcore\Model\Asset;
use Pimcore\Event\FrontendEvents;
use Pimcore\File;
use Pimcore\Model;
use Pimcore\Tool;
use Pimcore\Tool\Console;
use Pimcore\Tool\Storage;
use Symfony\Component\EventDispatcher\GenericEvent;
use Symfony\Component\Process\Process;
/**
* @method \Pimcore\Model\Asset\Dao getDao()
*/
class Image extends Model\Asset
{
use Model\Asset\MetaData\EmbeddedMetaDataTrait;
/**
* {@inheritdoc}
*/
protected $type = 'image';
private bool $clearThumbnailsOnSave = false;
/**
* {@inheritdoc}
*/
protected function update($params = [])
{
if ($this->getDataChanged()) {
foreach (['imageWidth', 'imageHeight', 'imageDimensionsCalculated'] as $key) {
$this->removeCustomSetting($key);
}
}
if ($params['isUpdate']) {
$this->clearThumbnails($this->clearThumbnailsOnSave);
$this->clearThumbnailsOnSave = false; // reset to default
}
parent::update($params);
}
/**
* @internal
*/
public function detectFocalPoint(): bool
{
if ($this->getCustomSetting('focalPointX') && $this->getCustomSetting('focalPointY')) {
return false;
}
if ($faceCordintates = $this->getCustomSetting('faceCoordinates')) {
$xPoints = [];
$yPoints = [];
foreach ($faceCordintates as $fc) {
// focal point calculation
$xPoints[] = ($fc['x'] + $fc['x'] + $fc['width']) / 2;
$yPoints[] = ($fc['y'] + $fc['y'] + $fc['height']) / 2;
}
$focalPointX = array_sum($xPoints) / count($xPoints);
$focalPointY = array_sum($yPoints) / count($yPoints);
$this->setCustomSetting('focalPointX', $focalPointX);
$this->setCustomSetting('focalPointY', $focalPointY);
return true;
}
return false;
}
/**
* @internal
*/
public function detectFaces(): bool
{
if ($this->getCustomSetting('faceCoordinates')) {
return false;
}
$config = \Pimcore::getContainer()->getParameter('pimcore.config')['assets']['image']['focal_point_detection'];
if (!$config['enabled']) {
return false;
}
$facedetectBin = \Pimcore\Tool\Console::getExecutable('facedetect');
if ($facedetectBin) {
$faceCoordinates = [];
$thumbnail = $this->getThumbnail(Image\Thumbnail\Config::getPreviewConfig());
$reference = $thumbnail->getPathReference();
if (in_array($reference['type'], ['asset', 'thumbnail'])) {
$image = $thumbnail->getLocalFile();
if (null === $image) {
return false;
}
$imageWidth = $thumbnail->getWidth();
$imageHeight = $thumbnail->getHeight();
$command = [$facedetectBin, $image];
Console::addLowProcessPriority($command);
$process = new Process($command);
$process->run();
$result = $process->getOutput();
if (strpos($result, "\n")) {
$faces = explode("\n", trim($result));
foreach ($faces as $coordinates) {
list($x, $y, $width, $height) = explode(' ', $coordinates);
// percentages
$Px = (int) $x / $imageWidth * 100;
$Py = (int) $y / $imageHeight * 100;
$Pw = (int) $width / $imageWidth * 100;
$Ph = (int) $height / $imageHeight * 100;
$faceCoordinates[] = [
'x' => $Px,
'y' => $Py,
'width' => $Pw,
'height' => $Ph,
];
}
$this->setCustomSetting('faceCoordinates', $faceCoordinates);
return true;
}
}
}
return false;
}
private function isLowQualityPreviewEnabled(): bool
{
return \Pimcore::getContainer()->getParameter('pimcore.config')['assets']['image']['low_quality_image_preview']['enabled'];
}
/**
* @internal
*
* @param null|string $generator
*
* @return bool|string
*
* @throws \Exception
*/
public function generateLowQualityPreview($generator = null)
{
if (!$this->isLowQualityPreviewEnabled()) {
return false;
}
// fallback
if (class_exists('Imagick')) {
// Imagick fallback
$path = $this->getThumbnail(Image\Thumbnail\Config::getPreviewConfig())->getLocalFile();
if (null === $path) {
return false;
}
$imagick = new \Imagick($path);
$imagick->setImageFormat('jpg');
$imagick->setOption('jpeg:extent', '1kb');
$width = $imagick->getImageWidth();
$height = $imagick->getImageHeight();
// we can't use getImageBlob() here, because of a bug in combination with jpeg:extent
// http://www.imagemagick.org/discourse-server/viewtopic.php?f=3&t=24366
$tmpFile = File::getLocalTempFilePath('jpg');
$imagick->writeImage($tmpFile);
$imageBase64 = base64_encode(file_get_contents($tmpFile));
$imagick->destroy();
$svg = <<<EOT
<?xml version="1.0" encoding="utf-8"?>
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="$width" height="$height" viewBox="0 0 $width $height" preserveAspectRatio="xMidYMid slice">
<filter id="blur" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
<feGaussianBlur stdDeviation="20 20" edgeMode="duplicate" />
<feComponentTransfer>
<feFuncA type="discrete" tableValues="1 1" />
</feComponentTransfer>
</filter>
<image filter="url(#blur)" x="0" y="0" height="100%" width="100%" xlink:href="data:image/jpg;base64,$imageBase64" />
</svg>
EOT;
$storagePath = $this->getLowQualityPreviewStoragePath();
Storage::get('thumbnail')->write($storagePath, $svg);
return $storagePath;
}
return false;
}
/**
* @return string
*/
public function getLowQualityPreviewPath()
{
$storagePath = $this->getLowQualityPreviewStoragePath();
$path = $storagePath;
if (Tool::isFrontend()) {
$path = urlencode_ignore_slash($storagePath);
$prefix = \Pimcore::getContainer()->getParameter('pimcore.config')['assets']['frontend_prefixes']['thumbnail'];
$path = $prefix . $path;
}
$event = new GenericEvent($this, [
'storagePath' => $storagePath,
'frontendPath' => $path,
]);
\Pimcore::getEventDispatcher()->dispatch($event, FrontendEvents::ASSET_IMAGE_THUMBNAIL);
$path = $event->getArgument('frontendPath');
return $path;
}
/**
* @return string
*/
private function getLowQualityPreviewStoragePath()
{
return sprintf(
'%s/%s/image-thumb__%s__-low-quality-preview.svg',
rtrim($this->getRealPath(), '/'),
$this->getId(),
$this->getId()
);
}
/**
* @return string|null
*/
public function getLowQualityPreviewDataUri(): ?string
{
if (!$this->isLowQualityPreviewEnabled()) {
return null;
}
try {
$dataUri = 'data:image/svg+xml;base64,' . base64_encode(Storage::get('thumbnail')->read($this->getLowQualityPreviewStoragePath()));
} catch (\Exception $e) {
$dataUri = null;
}
return $dataUri;
}
/**
* Legacy method for backwards compatibility. Use getThumbnail($config)->getConfig() instead.
*
* @internal
*
* @param string|array|Image\Thumbnail\Config|null $config
*
* @return Image\Thumbnail\Config|null
*/
public function getThumbnailConfig($config)
{
$thumbnail = $this->getThumbnail($config);
return $thumbnail->getConfig();
}
/**
* Returns a path to a given thumbnail or an thumbnail configuration.
*
* @param null|string|array|Image\Thumbnail\Config $config
* @param bool $deferred
*
* @return Image\Thumbnail
*/
public function getThumbnail($config = null, $deferred = true)
{
return new Image\Thumbnail($this, $config, $deferred);
}
/**
* @internal
*
* @throws \Exception
*
* @return null|\Pimcore\Image\Adapter
*/
public static function getImageTransformInstance()
{
try {
$image = \Pimcore\Image::getInstance();
} catch (\Exception $e) {
$image = null;
}
if (!$image instanceof \Pimcore\Image\Adapter) {
throw new \Exception("Couldn't get instance of image tranform processor.");
}
return $image;
}
/**
* @return string
*/
public function getFormat()
{
if ($this->getWidth() > $this->getHeight()) {
return 'landscape';
} elseif ($this->getWidth() == $this->getHeight()) {
return 'square';
} elseif ($this->getHeight() > $this->getWidth()) {
return 'portrait';
}
return 'unknown';
}
/**
* @param string|null $path
* @param bool $force
*
* @return array|null
*
* @throws \Exception
*/
public function getDimensions($path = null, $force = false)
{
if (!$force) {
$width = $this->getCustomSetting('imageWidth');
$height = $this->getCustomSetting('imageHeight');
if ($width && $height) {
return [
'width' => $width,
'height' => $height,
];
}
}
if (!$path) {
$path = $this->getLocalFile();
}
if (!$path) {
return null;
}
$dimensions = null;
//try to get the dimensions with getimagesize because it is much faster than e.g. the Imagick-Adapter
if (is_readable($path)) {
$imageSize = getimagesize($path);
if ($imageSize && $imageSize[0] && $imageSize[1]) {
$dimensions = [
'width' => $imageSize[0],
'height' => $imageSize[1],
];
}
}
if (!$dimensions) {
$image = self::getImageTransformInstance();
$status = $image->load($path, ['preserveColor' => true, 'asset' => $this]);
if ($status === false) {
return null;
}
$dimensions = [
'width' => $image->getWidth(),
'height' => $image->getHeight(),
];
}
// EXIF orientation
if (function_exists('exif_read_data')) {
$exif = @exif_read_data($path);
if (is_array($exif)) {
if (array_key_exists('Orientation', $exif)) {
$orientation = (int)$exif['Orientation'];
if (in_array($orientation, [5, 6, 7, 8])) {
// flip height & width
$dimensions = [
'width' => $dimensions['height'],
'height' => $dimensions['width'],
];
}
}
}
}
if (($width = $dimensions['width']) && ($height = $dimensions['height'])) {
// persist dimensions to database
$this->setCustomSetting('imageDimensionsCalculated', true);
$this->setCustomSetting('imageWidth', $width);
$this->setCustomSetting('imageHeight', $height);
$this->getDao()->updateCustomSettings();
$this->clearDependentCache();
}
return $dimensions;
}
/**
* @return int
*/
public function getWidth()
{
$dimensions = $this->getDimensions();
if ($dimensions) {
return $dimensions['width'];
}
return 0;
}
/**
* @return int
*/
public function getHeight()
{
$dimensions = $this->getDimensions();
if ($dimensions) {
return $dimensions['height'];
}
return 0;
}
/**
* {@inheritdoc}
*/
public function setCustomSetting($key, $value)
{
if (in_array($key, ['focalPointX', 'focalPointY'])) {
// if the focal point changes we need to clean all thumbnails on save
if ($this->getCustomSetting($key) != $value) {
$this->clearThumbnailsOnSave = true;
}
}
return parent::setCustomSetting($key, $value);
}
/**
* @return bool
*/
public function isVectorGraphic()
{
// we use a simple file-extension check, for performance reasons
if (preg_match("@\.(svgz?|eps|pdf|ps|ai|indd)$@", $this->getFilename())) {
return true;
}
return false;
}
/**
* Checks if this file represents an animated image (png or gif)
*
* @return bool
*/
public function isAnimated()
{
$isAnimated = false;
switch ($this->getMimeType()) {
case 'image/gif':
$isAnimated = $this->isAnimatedGif();
break;
case 'image/png':
$isAnimated = $this->isAnimatedPng();
break;
default:
break;
}
return $isAnimated;
}
/**
* Checks if this object represents an animated gif file
*
* @return bool
*/
private function isAnimatedGif()
{
$isAnimated = false;
if ($this->getMimeType() == 'image/gif') {
$fileContent = $this->getData();
/**
* An animated gif contains multiple "frames", with each frame having a header made up of:
* - a static 4-byte sequence (\x00\x21\xF9\x04)
* - 4 variable bytes
* - a static 2-byte sequence (\x00\x2C) (some variants may use \x00\x21 ?)
*
* @see http://it.php.net/manual/en/function.imagecreatefromgif.php#104473
*/
$numberOfFrames = preg_match_all('#\x00\x21\xF9\x04.{4}\x00(\x2C|\x21)#s', $fileContent, $matches);
$isAnimated = $numberOfFrames > 1;
}
return $isAnimated;
}
/**
* Checks if this object represents an animated png file
*
* @return bool
*/
private function isAnimatedPng()
{
$isAnimated = false;
if ($this->getMimeType() == 'image/png') {
$fileContent = $this->getData();
/**
* Valid APNGs have an "acTL" chunk somewhere before their first "IDAT" chunk.
*
* @see http://foone.org/apng/
*/
$posIDAT = strpos($fileContent, 'IDAT');
if ($posIDAT !== false) {
$isAnimated = str_contains(substr($fileContent, 0, $posIDAT), 'acTL');
}
}
return $isAnimated;
}
}

vendor/pimcore/pimcore/models/Asset/Image.php line 30