ImageManipulations::web_p_enabled() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/sunnys..." - sunnysideup/silverstripe-perfect_cms_images - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 091b64...dd72cb )

by Nicolaas
created 2023-02-07 05:53 UTC
ImageManipulations::web_p_enabled() A

↳ Parent: ImageManipulations
Complexity

Conditions	5
Paths	5
Size

Total Lines	13
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	5
eloc	6
c	1
b	0
f	0
nc	5
nop	0
dl	0
loc	13
rs	9.6111
<?php

namespace Sunnysideup\PerfectCmsImages\Api;

use SilverStripe\Assets\Image;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\SiteConfig\SiteConfig;

class ImageManipulations
{
    use Configurable;
    use Injectable;

    private static $webp_enabled = true;

    private static $webp_quality = 77;

    private static $imageLinkCache = [];

    /**
     * work out the best image link.
     *
     * There are basically three options:
     * a. if the height and/or width matches or is smaller than it should be
     *    then just return natural image
     * b. if crop is set to true then Fill
     * c. otherwise resize Height/Width/Both
     *
     * @param Image     $image
     * @param null|bool $useRetina     optional
     * @param null|bool $forMobile     optional
     * @param null|int  $resizeToWidth optional
     */
    public static function get_image_link($image, string $name, ?bool $useRetina = null, ?bool $forMobile = null, ?int $resizeToWidth = 0): string
    {
        $cacheKey =
            implode(
                '_',
                array_filter(
                    [
                        $image->ID,
                        $name,
                        ($useRetina ? 'Y' : 'N'),
                        ($forMobile ? 'MY' : 'MN'),
                        $resizeToWidth
                    ]
                )
            );
        if (empty(self::$imageLinkCache[$cacheKey])) {
            $item = DataObject::get_one(PerfectCMSImageCache::class, ['Code' => $cacheKey]);
filter:
    dependency_paths: ["lib/*"]
            if ($item) {
                return $item->Link;
            }
            $link = '';

            //work out perfect width and height
            if (null === $useRetina) {
                $useRetina = PerfectCMSImages::use_retina($name);
filter:
    dependency_paths: ["lib/*"]
            }

            $crop = PerfectCMSImages::is_crop($name);

            $multiplier = PerfectCMSImages::get_multiplier($useRetina);
            $perfectWidth = (int) PerfectCMSImages::get_width($name, true);
            $perfectHeight = (int) PerfectCMSImages::get_height($name, true);

            if ($forMobile) {
                $perfectWidth = (int) PerfectCMSImages::get_mobile_width($name, true);
                $perfectHeight = (int) PerfectCMSImages::get_mobile_height($name, true);
            }

            $perfectWidth *= $multiplier;
            $perfectHeight *= $multiplier;

            //get current width and height
            $myWidth = $image->getWidth();
            $myHeight = $image->getHeight();
            //if we are trying to resize to a width that is small than the perfect width
            //and the resize width is small than the current width, then lets resize...
            if (0 !== (int) $resizeToWidth) {
                if ($resizeToWidth < $perfectWidth && $resizeToWidth < $myWidth) {
                    $perfectWidth = $resizeToWidth;
                }
            }

            $tmpImage = null;
            if ($perfectWidth && $perfectHeight) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                //if the height or the width are already perfect then we can not do anything about it.
                if ($myWidth === $perfectWidth && $myHeight === $perfectHeight) {
                    $tmpImage = $image;
                } elseif ($myWidth < $perfectWidth || $myHeight < $perfectHeight) {
                    $tmpImage = $image->Pad(
                        $perfectWidth,
                        $perfectHeight,
                        PerfectCMSImages::get_padding_bg_colour($name)
                    );
                } elseif ($crop) {
                    $tmpImage = $image->Fill($perfectWidth, $perfectHeight);
                } else {
                    $tmpImage = $image->FitMax($perfectWidth, $perfectHeight);
                }
            } elseif ($perfectWidth) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                if ($myWidth === $perfectWidth) {
                    $tmpImage = $image;
                } elseif ($crop) {
                    $tmpImage = $image->Fill($perfectWidth, $myHeight);
                } else {
                    $tmpImage = $image->ScaleWidth($perfectWidth);
                }
            } elseif ($perfectHeight) {
                if ($myHeight === $perfectHeight) {
                    $tmpImage = $image;
                } elseif ($crop) {
                    $tmpImage = $image->Fill($myWidth, $perfectHeight);
                } else {
                    $tmpImage = $image->ScaleHeight($perfectHeight);
                }
            } elseif ($forMobile) {
                // todo: expplain this!
                // basically, it is for mobile and there is not perfect height nor width
                $tmpImage = null;
            } else {
                $tmpImage = $image;
            }
            $link = '';
            if($tmpImage) {
                $link = (string) $tmpImage->getUrl();
            }
            self::$imageLinkCache[$cacheKey] = $link;
            PerfectCMSImageCache::add_one($cacheKey, $link);
        }

        return self::$imageLinkCache[$cacheKey];
    }

    /**
     * back-up image.
     *
     * @return null|Image
     */
    public static function get_backup_image(string $name)
    {
        $image = null;
        $backupObject = SiteConfig::current_site_config();
        if ($backupObject->hasMethod($name)) {
            $image = $backupObject->{$name}();
        }

        return $image;
    }

    /**
     * placeholder image.
     */
    public static function get_placeholder_image_tag(string $name): string
    {
        $multiplier = (int) PerfectCMSImages::get_multiplier(true);
        $perfectWidth = (int) PerfectCMSImages::get_width($name, true);
        $perfectHeight = (int) PerfectCMSImages::get_height($name, true);
        $perfectWidth *= $multiplier;
        $perfectHeight *= $multiplier;
        if ($perfectWidth || $perfectHeight) {
            if (0 === $perfectWidth && $perfectHeight === 0) {
                $perfectWidth = 200;
            } elseif (0 === $perfectWidth) {
                $perfectWidth = $perfectHeight;
            } elseif ($perfectHeight === 0) {
                $perfectHeight = $perfectWidth;
            }

            $text = "{$perfectWidth} x {$perfectHeight} /2 = " . round($perfectWidth / 2) . ' x ' . round($perfectHeight / 2) . '';

            return 'https://placehold.it/' . $perfectWidth . 'x' . $perfectHeight . '?text=' . urlencode($text);
        }

        return 'https://placehold.it/1500x1500?text=' . urlencode('no size set');
    }

    public static function web_p_link(string $link): string
    {
        if (self::web_p_enabled() && $link) {
            $fileNameWithBaseFolder = Director::baseFolder() . '/public' . $link;
            $arrayOfLink = explode('.', $link);
            $extension = array_pop($arrayOfLink);
            $pathWithoutExtension = rtrim($link, '.' . $extension);
            $webPFileName = $pathWithoutExtension . '_' . $extension . '.webp';
            $webPFileNameWithBaseFolder = Director::baseFolder() . '/public' . $webPFileName;
            if (file_exists($fileNameWithBaseFolder)) {
                if (isset($_GET['flush']) && file_exists($webPFileNameWithBaseFolder)) {
                    unlink($webPFileNameWithBaseFolder);
                }

                if (file_exists($webPFileNameWithBaseFolder)) {
                    //todo: check that image is the same ...
                } else {
                    list($width, $height, $type) = getimagesize($fileNameWithBaseFolder);
                    $img = null;
                    if ($width && $height) {
                        if (2 === $type) {
                            $img = imagecreatefromjpeg($fileNameWithBaseFolder);
                        } elseif (3 === $type) {
                            $img = imagecreatefrompng($fileNameWithBaseFolder);
                            imagesavealpha($img, true);
                        }

                        if (null !== $img) {
                            $quality = Config::inst()->get(ImageManipulations::class, 'webp_quality');
                            imagewebp($img, $webPFileNameWithBaseFolder, $quality);
                        }
                    }
                }

                return $webPFileName;
            }
        }

        return $link;
    }

    public static function add_fake_parts($image, string $link): string
    {
        // first get the timestamp
        $time1 = strtotime((string) $image->LastEdited);
        $time2 = 0;
        $path = Controller::join_links(Director::baseFolder(), PUBLIC_DIR, $link);
        if (file_exists($path)) {
            $time2 = filemtime($path);
        }

        // first convert to hash extension
        if (class_exists('HashPathExtension')) {
            /** @var null|Controller $curr */
            $curr = Controller::curr();
            if ($curr) {

                if ($curr->hasMethod('HashPath')) {
                    $link = $curr->HashPath($link, false);
                }
            }
        }

        // now you can add the time
        $link .= '?time=' . max($time1, $time2);

        // finally add the title
        if ($image->Title) {
            $imageClasses = Config::inst()->get(PerfectCMSImages::class, 'perfect_cms_images_append_title_to_image_links_classes');
            if (in_array($image->ClassName, $imageClasses, true)) {
                $link .= '&title=' . urlencode(Convert::raw2att($image->Title));
                $link .= '&title=' . urlencode(/** @scrutinizer ignore-type */ Convert::raw2att($image->Title));
            }
        }

        return $link;
    }

    public static function web_p_enabled(): bool
    {
        if (Config::inst()->get(ImageManipulations::class, 'webp_enabled')) {
            if (function_exists('imagewebp')) {
                if (function_exists('imagecreatefromjpeg')) {
                    if (function_exists('imagecreatefrompng')) {
                        return true;
                    }
                }
            }
        }

        return false;
    }
}

sunnysideup / silverstripe-perfect_cms_images

Push — master ( 091b64...dd72cb )

ImageManipulations::web_p_enabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
