Merge pull request #2862 from craftcms/pull/transform-gifs-setting

Added `transformGifs` config setting, Fixes #2845

CHANGELOG-v3.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Added
+- Added the `transformGifs` settings that defaults to `true`. Changing it to `false` prevents GIF files from being transformed or cleansed on upload.
+- Added `craft\helpers\FileHelper::isGif()`.
+
 ### Changed
 - Craft no longer logs warnings about missing translation files when Dev Mode isn’t enabled. ([#1531](https://github.com/craftcms/cms/issues/1531))
 - Added `craft\services\Deprecator::$logTarget`. ([#2870](https://github.com/craftcms/cms/issues/2870))

src/config/GeneralConfig.php

@@ -568,6 +568,10 @@ class GeneralConfig extends BaseObject
      * This can be set to one of PHP’s supported timezones (http://php.net/manual/en/timezones.php).
      */
     public $timezone;
+    /**
+     * @var bool Tells Craft whether GIF files should be transformed or cleansed. Defaults to true.
+     */
+    public $transformGifs = true;
     /**
      * @var bool Tells Craft whether to surround all translatable strings with “@” symbols, to help find any strings that are not
      * being run through Craft::t() or the |translate filter.

src/elements/Asset.php

@@ -31,6 +31,7 @@
 use craft\helpers\FileHelper;
 use craft\helpers\Html;
 use craft\helpers\Image;
+use craft\helpers\StringHelper;
 use craft\helpers\Template;
 use craft\helpers\UrlHelper;
 use craft\models\AssetTransform;
@@ -704,6 +705,10 @@ public function getUrl($transform = null)
             return null;
         }
 
+        if (FileHelper::isGif($this->filename) && !Craft::$app->getConfig()->getGeneral()->transformGifs) {
+            return AssetsHelper::generateUrl($volume, $this);
+        }
+
         // Normalize empty transform values
         $transform = $transform ?: null;
 

src/helpers/FileHelper.php

@@ -256,10 +256,17 @@ public static function isWritable(string $path): bool
      */
     public static function getMimeType($file, $magicFile = null, $checkExtension = true)
     {
-        $mimeType = parent::getMimeType($file, $magicFile, $checkExtension);
+        try {
+            $mimeType = parent::getMimeType($file, $magicFile, $checkExtension);
+        } catch (\Throwable $e) {
+            if (!$checkExtension) {
+                throw $e;
+            }
+            $mimeType = null;
+        }
 
         // Be forgiving of SVG files, etc., that don't have an XML declaration
-        if ($checkExtension && in_array($mimeType, ['text/plain', 'text/html', 'application/xml'])) {
+        if ($checkExtension && in_array($mimeType, [null, 'text/plain', 'text/html', 'application/xml'], true)) {
             return static::getMimeTypeByExtension($file, $magicFile) ?? $mimeType;
         }
 
@@ -284,6 +291,23 @@ public static function isSvg(string $file, string $magicFile = null, bool $check
         return strpos($mimeType, 'image/svg') === 0;
     }
 
+    /**
+     * Returns whether the given file path is an GIF image.
+     *
+     * @param string $file the file name.
+     * @param string $magicFile name of the optional magic database file (or alias), usually something like `/path/to/magic.mime`.
+     * This will be passed as the second parameter to [finfo_open()](http://php.net/manual/en/function.finfo-open.php)
+     * when the `fileinfo` extension is installed. If the MIME type is being determined based via [[getMimeTypeByExtension()]]
+     * and this is null, it will use the file specified by [[mimeMagicFile]].
+     * @param bool $checkExtension whether to use the file extension to determine the MIME type in case
+     * `finfo_open()` cannot determine it.
+     * @return bool
+     */
+    public static function isGif(string $file, string $magicFile = null, bool $checkExtension = true): bool
+    {
+        return self::getMimeType($file, $magicFile, $checkExtension) === 'image/gif';
+    }
+
     /**
      * Writes contents to a file.
      *

src/services/Images.php

@@ -13,6 +13,7 @@
 use craft\helpers\ConfigHelper;
 use craft\helpers\FileHelper;
 use craft\helpers\Image as ImageHelper;
+use craft\helpers\StringHelper;
 use craft\image\Raster;
 use craft\image\Svg;
 use enshrined\svgSanitize\Sanitizer;
@@ -298,6 +299,10 @@ public function cleanImage(string $filePath)
             return;
         }
 
+        if (FileHelper::isGif($filePath) && !Craft::$app->getConfig()->getGeneral()->transformGifs) {
+            return;
+        }
+
         try {
             if (Craft::$app->getConfig()->getGeneral()->rotateImagesOnUploadByExifData) {
                 $cleanedByRotation = $this->rotateImageByExifData($filePath);