ImageUtils::imageCreateFromString() - Code Metrics - Inspection of "Fix/error handling exception" - ArthurHoaro/web-thumbnailer - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#19)

by Arthur
created 2020-01-17 19:29 UTC
ImageUtils::imageCreateFromString() A

↳ Parent: ImageUtils
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	4
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	8
rs	10
<?php

namespace WebThumbnailer\Utils;

use WebThumbnailer\Exception\ImageConvertException;
use WebThumbnailer\Exception\NotAnImageException;

/**
 * Class ImageUtils
 *
 * Util class to manipulate GD images.
 *
 * @package WebThumbnailer\Utils
 */
class ImageUtils
{
    /**
     * Generate a clean PNG thumbnail from given image resource.
     *
     * It makes sure the downloaded image is really an image,
     * doesn't contain funny stuff, and it resize it to a standard size.
     * Resizing conserves proportions.
     *
     * @param string   $imageStr  Source image.
     * @param string   $target    Path where the generated thumb will be saved.
     * @param int      $maxWidth  Max width for the generated thumb.
     * @param int      $maxHeight Max height for the generated thumb.
     * @param bool     $crop      Will crop the image to a fixed size if true. Height AND width must be provided.
     *
     * @throws NotAnImageException   The given resource isn't an image.
     * @throws ImageConvertException Another error occured.
     */
    public static function generateThumbnail($imageStr, $target, $maxWidth, $maxHeight, $crop = false)
    {
        if (! touch($target)) {
            throw new ImageConvertException('Target file is not writable.');
        }

        if ($crop && ($maxWidth == 0  || $maxHeight == 0)) {
            throw new ImageConvertException('Both width and height must be provided for cropping');
        }

        $sourceImg = static::imageCreateFromString($imageStr);
        if ($sourceImg === false) {
            throw new NotAnImageException();
        }

        $originalWidth = imagesx($sourceImg);
        $originalHeight = imagesy($sourceImg);
        if ($maxWidth > $originalWidth) {
            $maxWidth = $originalWidth;
        }
        if ($maxHeight > $originalHeight) {
            $maxHeight = $originalHeight;
        }

        list($finalWidth, $finalHeight) = self::calcNewSize(
            $originalWidth,
            $originalHeight,
            $maxWidth,
            $maxHeight,
            $crop
        );

        $targetImg = imagecreatetruecolor($finalWidth, $finalHeight);
        if ($targetImg === false) {
            throw new ImageConvertException('Could not generate the thumbnail from source image.');
        }

        if (! imagecopyresized(
            $targetImg,
            $sourceImg,
            0,
            0,
            0,
            0,
            $finalWidth,
            $finalHeight,
            $originalWidth,
            $originalHeight
        )
        ) {
            static::imageDestroy($sourceImg);
            static::imageDestroy($targetImg);
            throw new ImageConvertException('Could not generate the thumbnail from source image.');
        }

        if ($crop) {
            $targetImg = imagecrop($targetImg, [
                'x' => $finalWidth >= $finalHeight ? ($finalWidth - $maxWidth) / 2 : 0,
                'y' => $finalHeight <= $finalWidth ? ($finalHeight - $maxHeight) / 2 : 0,
                'width' => $maxWidth,
                'height' => $maxHeight
            ]);
        }

        imagedestroy($sourceImg);
        imagejpeg($targetImg, $target);
        imagejpeg(/** @scrutinizer ignore-type */ $targetImg, $target);
        imagedestroy($targetImg);
        imagedestroy(/** @scrutinizer ignore-type */ $targetImg);
    }

    /**
     * Calculate image new size to keep proportions depending on actual image size
     * and max width/height settings.
     *
     * @param int  $originalWidth  Image original width
     * @param int  $originalHeight Image original height
     * @param int  $maxWidth       Target image maximum width
     * @param int  $maxHeight      Target image maximum height
     * @param bool $crop           Is cropping enabled
     *
     * @return array [final width, final height]
     *
     * @throws ImageConvertException At least maxwidth or maxheight needs to be defined
     */
    public static function calcNewSize($originalWidth, $originalHeight, $maxWidth, $maxHeight, $crop)
    {
        if (empty($maxHeight) && empty($maxWidth)) {
            throw new ImageConvertException('At least maxwidth or maxheight needs to be defined.');
        }
        $diffWidth = !empty($maxWidth) ? $originalWidth - $maxWidth : false;
        $diffHeight = !empty($maxHeight) ? $originalHeight - $maxHeight : false;

        if (($diffHeight === false && $diffWidth !== false)
            || ($diffWidth > $diffHeight && ! $crop)
            || ($diffWidth < $diffHeight && $crop)
        ) {
            $finalWidth = $maxWidth;
            $finalHeight = $originalHeight * ($finalWidth / $originalWidth);
        } else {
            $finalHeight = $maxHeight;
            $finalWidth = $originalWidth * ($finalHeight / $originalHeight);
        }

        return [$finalWidth, $finalHeight];
    }

    /**
     * Check if a file extension is an image.
     *
     * @param string $ext file extension.
     *
     * @return bool true if it's an image extension, false otherwise.
     */
    public static function isImageExtension($ext)
    {
        $supportedImageFormats = ['png', 'jpg', 'jpeg', 'svg'];
        return in_array($ext, $supportedImageFormats);
    }

    /**
     * Check if a string is an image.
     *
     * @param string $content String to check.
     *
     * @return bool True if the content is image, false otherwise.
     */
    public static function isImageString($content)
    {
        return static::imageCreateFromString($content) !== false;
    }

    /**
     * With custom error handlers, @ does not stop the warning to being thrown.
     *
     * @param string $content
     *
     * @return resource|false
     */
    protected static function imageCreateFromString($content)
    {
        try {
            return @imagecreatefromstring($content);
        } catch (\Exception $e) {

        }

        return false;
    }

    /**
     * With custom error handlers, @ does not stop the warning to being thrown.
     *
     * @param resource $image
     *
     * @return bool
     */
    protected static function imageDestroy($image)
    {
        try {
            return @imagedestroy($image);
        } catch (\Exception $e) {

        }

        return false;
    }
}

ArthurHoaro / web-thumbnailer

Pull Request — master (#19)

ImageUtils::imageCreateFromString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
