15452802478

Committed 04 Jun 2025 09:09PM UTC coverage: 82.793% (-0.02%) from 82.811%

Build # 15452802478

Build Type

push

github

Committed by

ArnaudLigny

Commit Message

fix: cover filter with GIF image

Run Details

1 of 2 new or added lines in 1 file covered. (50.0%)

3118 of 3766 relevant lines covered (82.79%)

0.83 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.01

/src/Assets/Image.php

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <arnaud@ligny.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Assets;

use Cecil\Exception\RuntimeException;
use Intervention\Image\Drivers\Gd\Driver as GdDriver;
use Intervention\Image\Drivers\Imagick\Driver as ImagickDriver;
use Intervention\Image\Encoders\AutoEncoder;
use Intervention\Image\ImageManager;

class Image
{
    /**
     * Create new manager instance with available driver.
     */
    private static function manager(): ImageManager
    {
        $driver = null;

        // ImageMagick is available? (for a future quality option)
        if (\extension_loaded('imagick') && class_exists('Imagick')) {
            $driver = ImagickDriver::class;
        }
        // Use GD, because it's the faster driver
        if (\extension_loaded('gd') && \function_exists('gd_info')) {
            $driver = GdDriver::class;
        }

        if ($driver) {
            return ImageManager::withDriver(
                $driver,
                [
                    'autoOrientation' => true,
                    'decodeAnimation' => true,
                    'blendingColor' => 'ffffff',
                    'strip' => true, // remove metadata
                ]
            );
        }

        throw new RuntimeException('PHP GD (or Imagick) extension is required.');
    }

    /**
     * Scales down an image Asset to the given width, keeping the aspect ratio.
     *
     * @throws RuntimeException
     */
    public static function resize(Asset $asset, int $width, int $quality): string
    {
        try {
            // creates image object from source
            $image = self::manager()->read($asset['content']);
            // resizes to $width with constraint the aspect-ratio and unwanted upsizing
            $image->scaleDown(width: $width);
            // return image data
            return (string) $image->encodeByMediaType($asset['subtype'], /** @scrutinizer ignore-type */ progressive: true, /** @scrutinizer ignore-type */ interlaced: false, quality: $quality);
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Asset "%s" can\'t be resized: %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Crops an image Asset to the given width and height, keeping the aspect ratio.
     *
     * @throws RuntimeException
     */
    public static function cover(Asset $asset, int $width, int $height, string $position, int $quality): string
    {
        try {
            // creates image object from source
            $image = self::manager()->read($asset['content']);
            // turns an animated image (i.e GIF) into a static image
            if ($image->isAnimated()) {
                $image = $image->removeAnimation();
            }
            // crops the image
            $image->cover(width: $width, height: $height, position: $position);
            // return image data
            return (string) $image->encodeByMediaType($asset['subtype'], /** @scrutinizer ignore-type */ progressive: true, /** @scrutinizer ignore-type */ interlaced: false, quality: $quality);
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Asset "%s" can\'t be cropped: %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Converts an image Asset to the target format.
     *
     * @throws RuntimeException
     */
    public static function convert(Asset $asset, string $format, int $quality): string
    {
        try {
            $image = self::manager()->read($asset['content']);

            if (!\function_exists("image$format")) {
                throw new RuntimeException(\sprintf('Function "image%s" is not available.', $format));
            }

            return (string) $image->encodeByExtension($format, /** @scrutinizer ignore-type */ progressive: true, /** @scrutinizer ignore-type */ interlaced: false, quality: $quality);
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Not able to convert "%s" to %s: %s', $asset['path'], $format, $e->getMessage()));
        }
    }

    /**
     * Returns the Data URL (encoded in Base64).
     *
     * @throws RuntimeException
     */
    public static function getDataUrl(Asset $asset, int $quality): string
    {
        try {
            $image = self::manager()->read($asset['content']);

            return (string) $image->encode(new AutoEncoder(quality: $quality))->toDataUri();
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Can\'t get Data URL of "%s": %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Returns the dominant RGB color of an image asset.
     *
     * @throws RuntimeException
     */
    public static function getDominantColor(Asset $asset): string
    {
        try {
            $image = self::manager()->read(self::resize($asset, 100, 50));

            return $image->reduceColors(1)->pickColor(0, 0)->toString();
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('Can\'t get dominant color of "%s": %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Returns a Low Quality Image Placeholder (LQIP) as data URL.
     *
     * @throws RuntimeException
     */
    public static function getLqip(Asset $asset): string
    {
        try {
            $image = self::manager()->read(self::resize($asset, 100, 50));

            return (string) $image->blur(50)->encode()->toDataUri();
        } catch (\Exception $e) {
            throw new RuntimeException(\sprintf('can\'t create LQIP of "%s": %s', $asset['path'], $e->getMessage()));
        }
    }

    /**
     * Build the `srcset` attribute for responsive images.
     * e.g.: `srcset="/img-480.jpg 480w, /img-800.jpg 800w"`.
     *
     * @throws RuntimeException
     */
    public static function buildSrcset(Asset $asset, array $widths): string
    {
        if (!self::isImage($asset)) {
            throw new RuntimeException(\sprintf('can\'t build "srcset" of "%s": it\'s not an image file.', $asset['path']));
        }

        $srcset = '';
        $widthMax = 0;
        sort($widths, SORT_NUMERIC);
        $widths = array_reverse($widths);
        foreach ($widths as $width) {
            if ($asset['width'] < $width) {
                continue;
            }
            $img = $asset->resize($width);
            $srcset .= \sprintf('%s %sw, ', (string) $img, $width);
            $widthMax = $width;
        }
        // adds source image
        if (!empty($srcset) && ($asset['width'] < max($widths) && $asset['width'] != $widthMax)) {
            $srcset .= \sprintf('%s %sw', (string) $asset, $asset['width']);
        }

        return rtrim($srcset, ', ');
    }

    /**
     * Returns the value of the "sizes" attribute corresponding to the configured class.
     */
    public static function getSizes(string $class, array $sizes = []): string
    {
        $result = '';
        $classArray = explode(' ', $class);
        foreach ($classArray as $class) {
            if (\array_key_exists($class, $sizes)) {
                $result = $sizes[$class] . ', ';
            }
        }
        if (!empty($result)) {
            return trim($result, ', ');
        }

        return $sizes['default'] ?? '100vw';
    }

    /**
     * Checks if an asset is an animated GIF.
     */
    public static function isAnimatedGif(Asset $asset): bool
    {
        // an animated GIF contains multiple "frames", with each frame having a header made up of:
        // 1. a static 4-byte sequence (\x00\x21\xF9\x04)
        // 2. 4 variable bytes
        // 3. a static 2-byte sequence (\x00\x2C)
        $count = preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', (string) $asset['content']);

        return $count > 1;
    }

    /**
     * Returns true if asset is a SVG.
     */
    public static function isSVG(Asset $asset): bool
    {
        return \in_array($asset['subtype'], ['image/svg', 'image/svg+xml']) || $asset['ext'] == 'svg';
    }

    /**
     * Returns true if asset is an ICO.
     */
    public static function isIco(Asset $asset): bool
    {
        return \in_array($asset['subtype'], ['image/x-icon', 'image/vnd.microsoft.icon']) || $asset['ext'] == 'ico';
    }

    /**
     * Asset is a valid image?
     */
    public static function isImage(Asset $asset): bool
    {
        if ($asset['type'] !== 'image' || self::isSVG($asset) || self::isIco($asset)) {
            return false;
        }

        return true;
    }

    /**
     * Returns SVG attributes.
     *
     * @return \SimpleXMLElement|false
     */
    public static function getSvgAttributes(Asset $asset)
    {
        if (!self::isSVG($asset)) {
            return false;
        }

        if (false === $xml = simplexml_load_string($asset['content'] ?? '')) {
            return false;
        }

        return $xml->attributes();
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of Cecil.
7	*
8	* Copyright (c) Arnaud Ligny <arnaud@ligny.fr>
9	*
10	* For the full copyright and license information, please view the LICENSE
11	* file that was distributed with this source code.
12	*/
13
14	namespace Cecil\Assets;
15
16	use Cecil\Exception\RuntimeException;
17	use Intervention\Image\Drivers\Gd\Driver as GdDriver;
18	use Intervention\Image\Drivers\Imagick\Driver as ImagickDriver;
19	use Intervention\Image\Encoders\AutoEncoder;
20	use Intervention\Image\ImageManager;
21
22	class Image
23	{
24	/**
25	* Create new manager instance with available driver.
26	*/
27	private static function manager(): ImageManager
28	{
29	$driver = null;	1✔
30
31	// ImageMagick is available? (for a future quality option)
32	if (\extension_loaded('imagick') && class_exists('Imagick')) {	1✔
33	$driver = ImagickDriver::class;	1✔
34	}
35	// Use GD, because it's the faster driver
36	if (\extension_loaded('gd') && \function_exists('gd_info')) {	1✔
37	$driver = GdDriver::class;	1✔
38	}
39
40	if ($driver) {	1✔
41	return ImageManager::withDriver(	1✔
42	$driver,	1✔
43	[	1✔
44	'autoOrientation' => true,	1✔
45	'decodeAnimation' => true,	1✔
46	'blendingColor' => 'ffffff',	1✔
47	'strip' => true, // remove metadata	1✔
48	]	1✔
49	);	1✔
50	}
51
52	throw new RuntimeException('PHP GD (or Imagick) extension is required.');	×
53	}
54
55	/**
56	* Scales down an image Asset to the given width, keeping the aspect ratio.
57	*
58	* @throws RuntimeException
59	*/
60	public static function resize(Asset $asset, int $width, int $quality): string
61	{
62	try {
63	// creates image object from source
64	$image = self::manager()->read($asset['content']);	1✔
65	// resizes to $width with constraint the aspect-ratio and unwanted upsizing
66	$image->scaleDown(width: $width);	1✔
67	// return image data
68	return (string) $image->encodeByMediaType($asset['subtype'], /** @scrutinizer ignore-type / progressive: true, /* @scrutinizer ignore-type */ interlaced: false, quality: $quality);	1✔
69	} catch (\Exception $e) {	×
70	throw new RuntimeException(\sprintf('Asset "%s" can\'t be resized: %s', $asset['path'], $e->getMessage()));	×
71	}
72	}
73
74	/**
75	* Crops an image Asset to the given width and height, keeping the aspect ratio.
76	*
77	* @throws RuntimeException
78	*/
79	public static function cover(Asset $asset, int $width, int $height, string $position, int $quality): string
80	{
81	try {
82	// creates image object from source
83	$image = self::manager()->read($asset['content']);	1✔
84	// turns an animated image (i.e GIF) into a static image
85	if ($image->isAnimated()) {	1✔
NEW 86	$image = $image->removeAnimation();	×
87	}
88	// crops the image
89	$image->cover(width: $width, height: $height, position: $position);	1✔
90	// return image data
91	return (string) $image->encodeByMediaType($asset['subtype'], /** @scrutinizer ignore-type / progressive: true, /* @scrutinizer ignore-type */ interlaced: false, quality: $quality);	1✔
92	} catch (\Exception $e) {	×
93	throw new RuntimeException(\sprintf('Asset "%s" can\'t be cropped: %s', $asset['path'], $e->getMessage()));	×
94	}
95	}
96
97	/**
98	* Converts an image Asset to the target format.
99	*
100	* @throws RuntimeException
101	*/
102	public static function convert(Asset $asset, string $format, int $quality): string
103	{
104	try {
105	$image = self::manager()->read($asset['content']);	1✔
106
107	if (!\function_exists("image$format")) {	1✔
108	throw new RuntimeException(\sprintf('Function "image%s" is not available.', $format));	×
109	}
110
111	return (string) $image->encodeByExtension($format, /** @scrutinizer ignore-type / progressive: true, /* @scrutinizer ignore-type */ interlaced: false, quality: $quality);	1✔
112	} catch (\Exception $e) {	×
113	throw new RuntimeException(\sprintf('Not able to convert "%s" to %s: %s', $asset['path'], $format, $e->getMessage()));	×
114	}
115	}
116
117	/**
118	* Returns the Data URL (encoded in Base64).
119	*
120	* @throws RuntimeException
121	*/
122	public static function getDataUrl(Asset $asset, int $quality): string
123	{
124	try {
125	$image = self::manager()->read($asset['content']);	1✔
126
127	return (string) $image->encode(new AutoEncoder(quality: $quality))->toDataUri();	1✔
128	} catch (\Exception $e) {	×
129	throw new RuntimeException(\sprintf('Can\'t get Data URL of "%s": %s', $asset['path'], $e->getMessage()));	×
130	}
131	}
132
133	/**
134	* Returns the dominant RGB color of an image asset.
135	*
136	* @throws RuntimeException
137	*/
138	public static function getDominantColor(Asset $asset): string
139	{
140	try {
141	$image = self::manager()->read(self::resize($asset, 100, 50));	1✔
142
143	return $image->reduceColors(1)->pickColor(0, 0)->toString();	1✔
144	} catch (\Exception $e) {	×
145	throw new RuntimeException(\sprintf('Can\'t get dominant color of "%s": %s', $asset['path'], $e->getMessage()));	×
146	}
147	}
148
149	/**
150	* Returns a Low Quality Image Placeholder (LQIP) as data URL.
151	*
152	* @throws RuntimeException
153	*/
154	public static function getLqip(Asset $asset): string
155	{
156	try {
157	$image = self::manager()->read(self::resize($asset, 100, 50));	1✔
158
159	return (string) $image->blur(50)->encode()->toDataUri();	1✔
160	} catch (\Exception $e) {	×
161	throw new RuntimeException(\sprintf('can\'t create LQIP of "%s": %s', $asset['path'], $e->getMessage()));	×
162	}
163	}
164
165	/**
166	* Build the `srcset` attribute for responsive images.
167	* e.g.: `srcset="/img-480.jpg 480w, /img-800.jpg 800w"`.
168	*
169	* @throws RuntimeException
170	*/
171	public static function buildSrcset(Asset $asset, array $widths): string
172	{
173	if (!self::isImage($asset)) {	1✔
174	throw new RuntimeException(\sprintf('can\'t build "srcset" of "%s": it\'s not an image file.', $asset['path']));	1✔
175	}
176
177	$srcset = '';	1✔
178	$widthMax = 0;	1✔
179	sort($widths, SORT_NUMERIC);	1✔
180	$widths = array_reverse($widths);	1✔
181	foreach ($widths as $width) {	1✔
182	if ($asset['width'] < $width) {	1✔
183	continue;	1✔
184	}
185	$img = $asset->resize($width);	1✔
186	$srcset .= \sprintf('%s %sw, ', (string) $img, $width);	1✔
187	$widthMax = $width;	1✔
188	}
189	// adds source image
190	if (!empty($srcset) && ($asset['width'] < max($widths) && $asset['width'] != $widthMax)) {	1✔
191	$srcset .= \sprintf('%s %sw', (string) $asset, $asset['width']);	1✔
192	}
193
194	return rtrim($srcset, ', ');	1✔
195	}
196
197	/**
198	* Returns the value of the "sizes" attribute corresponding to the configured class.
199	*/
200	public static function getSizes(string $class, array $sizes = []): string
201	{
202	$result = '';	1✔
203	$classArray = explode(' ', $class);	1✔
204	foreach ($classArray as $class) {	1✔
205	if (\array_key_exists($class, $sizes)) {	1✔
206	$result = $sizes[$class] . ', ';	1✔
207	}
208	}
209	if (!empty($result)) {	1✔
210	return trim($result, ', ');	1✔
211	}
212
213	return $sizes['default'] ?? '100vw';	1✔
214	}
215
216	/**
217	* Checks if an asset is an animated GIF.
218	*/
219	public static function isAnimatedGif(Asset $asset): bool
220	{
221	// an animated GIF contains multiple "frames", with each frame having a header made up of:
222	// 1. a static 4-byte sequence (\x00\x21\xF9\x04)
223	// 2. 4 variable bytes
224	// 3. a static 2-byte sequence (\x00\x2C)
225	$count = preg_match_all('#\x00\x21\xF9\x04.{4}\x00[\x2C\x21]#s', (string) $asset['content']);	1✔
226
227	return $count > 1;	1✔
228	}
229
230	/**
231	* Returns true if asset is a SVG.
232	*/
233	public static function isSVG(Asset $asset): bool
234	{
235	return \in_array($asset['subtype'], ['image/svg', 'image/svg+xml']) \|\| $asset['ext'] == 'svg';	1✔
236	}
237
238	/**
239	* Returns true if asset is an ICO.
240	*/
241	public static function isIco(Asset $asset): bool
242	{
243	return \in_array($asset['subtype'], ['image/x-icon', 'image/vnd.microsoft.icon']) \|\| $asset['ext'] == 'ico';	1✔
244	}
245
246	/**
247	* Asset is a valid image?
248	*/
249	public static function isImage(Asset $asset): bool
250	{
251	if ($asset['type'] !== 'image' \|\| self::isSVG($asset) \|\| self::isIco($asset)) {	1✔
252	return false;	1✔
253	}
254
255	return true;	1✔
256	}
257
258	/**
259	* Returns SVG attributes.
260	*
261	* @return \SimpleXMLElement\|false
262	*/
263	public static function getSvgAttributes(Asset $asset)
264	{
265	if (!self::isSVG($asset)) {	1✔
266	return false;	×
267	}
268
269	if (false === $xml = simplexml_load_string($asset['content'] ?? '')) {	1✔
270	return false;	×
271	}
272
273	return $xml->attributes();	1✔
274	}
275	}

Cecilapp / Cecil / 15452802478

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous