nystudio107\imageoptimize\services\OptimizedImages

Complexity

Total Complexity

84

Size/Duplication

Total Lines	554
Duplicated Lines	0 %

Importance

Changes	16
Bugs	8	Features	2

11 Methods

Rating	Name	Duplication	Size	Complexity
A	createOptimizedImages()	0	16	3
C	shouldCreateVariants()	0	43	16
F	populateOptimizedImageModel()	0	116	23
B	generatePlaceholders()	0	34	7
A	resaveAsset()	0	21	1
B	resaveVolumeAssets()	0	45	6
B	getTransformFromVariant()	0	42	11
A	resaveAllVolumesAssets()	0	5	2
B	updateOptimizedImageFieldData()	0	41	9
A	encodeOptimizedSVGDataUri()	0	21	2
A	addVariantImageToModel()	0	47	4

<?php
/**
 * ImageOptimize plugin for Craft CMS
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\imageoptimize\services;

use Craft;
use craft\base\Component;
use craft\base\ElementInterface;

The type craft\base\ElementInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\base\Field;
use craft\console\Application as ConsoleApplication;
use craft\elements\Asset;
use craft\errors\FsObjectNotFoundException;
use craft\errors\InvalidFieldException;
use craft\errors\SiteNotFoundException;
use craft\helpers\Image;
use craft\helpers\ImageTransforms as TransformHelper;
use craft\helpers\Json;
use craft\imagetransforms\ImageTransformer;
use craft\models\FieldLayout;
use craft\models\ImageTransform as AssetTransform;
use craft\models\Volume;
use craft\records\Element_SiteSettings as Element_SiteSettingsRecord;
use nystudio107\imageoptimize\fields\OptimizedImages as OptimizedImagesField;
use nystudio107\imageoptimize\helpers\Image as ImageHelper;
use nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\imagetransforms\CraftImageTransform;
use nystudio107\imageoptimize\jobs\ResaveOptimizedImages;
use nystudio107\imageoptimize\models\OptimizedImage;
use nystudio107\imageoptimize\models\Settings;
use Throwable;
use yii\base\InvalidConfigException;
use yii\db\Exception;
use function in_array;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   ImageOptimize

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.4.0

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

The tag in position 3 should be the @author tag

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class OptimizedImages extends Component
{
    // Constants
    // =========================================================================

    // Public Properties
    // =========================================================================

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @param Asset $asset

Missing parameter comment

     * @param array $variants

Missing parameter comment

     *
     * @return OptimizedImage
     * @throws InvalidConfigException
     */
    public function createOptimizedImages(Asset $asset, array $variants = []): OptimizedImage
    {
        Craft::beginProfile('createOptimizedImages', __METHOD__);
        if (empty($variants)) {
            /** @var ?Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $settings = ImageOptimize::$plugin->getSettings();

The method getSettings() does not exist on null.

            if ($settings) {

$settings is of type nystudio107\imageoptimize\models\Settings, thus it always evaluated to true.

                $variants = $settings->defaultVariants;
            }
        }

        $model = new OptimizedImage();
        $this->populateOptimizedImageModel($asset, $variants, $model);
        Craft::endProfile('createOptimizedImages', __METHOD__);

        return $model;
    }

    /**

Missing short description in doc comment

     * @param Asset $asset

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Expected 10 spaces after parameter type; 1 found

     * @param array $variants

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Expected 10 spaces after parameter type; 1 found

     * @param OptimizedImage $model

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param bool $force

Missing parameter comment

Expected 11 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @throws InvalidConfigException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    public function populateOptimizedImageModel(Asset $asset, array $variants, OptimizedImage $model, bool $force = false): void
    {
        Craft::beginProfile('populateOptimizedImageModel', __METHOD__);
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = ImageOptimize::$plugin->getSettings();
        // Empty our the optimized image URLs
        $model->optimizedImageUrls = [];
        $model->optimizedWebPImageUrls = [];
        $model->variantSourceWidths = [];
        $model->placeholderWidth = 0;
        $model->placeholderHeight = 0;
        $model->stickyErrors = [];

        foreach ($variants as $variant) {
            $retinaSizes = ['1'];
            if (!empty($variant['retinaSizes'])) {
                $retinaSizes = $variant['retinaSizes'];
            }
            foreach ($retinaSizes as $retinaSize) {
                $finalFormat = empty($variant['format']) ? $asset->getExtension() : $variant['format'];
                $variantFormat = $finalFormat;
                if (!ImageOptimize::$plugin->transformMethod instanceof CraftImageTransform) {
                    $variantFormat = empty($variant['format']) ? null : $variant['format'];
                }
                $variant['format'] = $variantFormat;
                // Only try the transform if it's possible
                if ((int)$asset->height > 0
                    && Image::canManipulateAsImage($finalFormat)
                    && Image::canManipulateAsImage($asset->getExtension())
                ) {
                    // Create the transform based on the variant
                    /** @var AssetTransform $transform */

Missing short description in doc comment

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

                    [$transform, $aspectRatio] = $this->getTransformFromVariant($asset, $variant, $retinaSize);
                    // If they want to $force it, set `fileExists` = 0 in the transform index, then delete the transformed image
                    if ($force) {
                        $transformer = Craft::createObject(ImageTransformer::class);

                        try {
                            $index = $transformer->getTransformIndex($asset, $transform);
                            $index->fileExists = false;
                            $transformer->storeTransformIndexData($index);
                            try {
                                $transformer->deleteImageTransformFile($asset, $index);
                            } catch (Throwable $exception) {

Consider adding a comment why this CATCH block is empty.

                            }
                        } catch (Throwable $e) {
                            $msg = 'Failed to update transform: ' . $e->getMessage();
                            Craft::error($msg, __METHOD__);
                            if (Craft::$app instanceof ConsoleApplication) {
                                echo $msg . PHP_EOL;
                            }
                            // Add the error message to the stickyErrors for the model
                            $model->stickyErrors[] = $msg;
                        }
                    }
                    // Only create the image variant if it is not upscaled, or they are okay with it being up-scaled
                    if (($asset->width >= $transform->width && $asset->height >= $transform->height)
                        || $settings->allowUpScaledImageVariants
                    ) {
                        $this->addVariantImageToModel($asset, $model, $transform, $variant, $aspectRatio);
                    }
                } else {
                    $canManipulate = Image::canManipulateAsImage($asset->getExtension());
                    $msg = 'Could not create transform for: ' . $asset->title
                        . ' - Final format: ' . $finalFormat
                        . ' - Element extension: ' . $asset->getExtension()
                        . ' - canManipulateAsImage: ' . $canManipulate;
                    Craft::error(
                        $msg,
                        __METHOD__
                    );
                    if (Craft::$app instanceof ConsoleApplication) {
                        echo $msg . PHP_EOL;
                    }
                    if ($canManipulate) {
                        // Add the error message to the stickyErrors for the model
                        $model->stickyErrors[] = $msg;
                    }
                }
            }
        }

        // If no image variants were created, populate it with the image itself
        if (empty($model->optimizedImageUrls)) {
            $finalFormat = $asset->getExtension();
            if ((int)$asset->height > 0
                && Image::canManipulateAsImage($finalFormat)
            ) {
                $variant = [
                    'width' => $asset->width,
                    'useAspectRatio' => false,
                    'aspectRatioX' => $asset->width,
                    'aspectRatioY' => $asset->height,
                    'retinaSizes' => ['1'],
                    'quality' => 0,
                    'format' => $finalFormat,
                ];
                [$transform, $aspectRatio] = $this->getTransformFromVariant($asset, $variant, 1);
                $this->addVariantImageToModel($asset, $model, $transform, $variant, $aspectRatio);
            } else {
                $canManipulate = Image::canManipulateAsImage($asset->getExtension());
                $msg = 'Could not create transform for: ' . $asset->title
                    . ' - Final format: ' . $finalFormat
                    . ' - Element extension: ' . $asset->getExtension()
                    . ' - canManipulateAsImage: ' . $canManipulate;
                Craft::error(
                    $msg,
                    __METHOD__
                );
                if ($canManipulate) {
                    // Add the error message to the stickyErrors for the model
                    $model->stickyErrors[] = $msg;
                }
            }
        }
        Craft::endProfile('populateOptimizedImageModel', __METHOD__);
    }

    /**
     * Should variants be created for the given OptimizedImages field and the Asset?
     *
     * @param $field

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param $asset

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return bool

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function shouldCreateVariants($field, $asset): bool
    {
        $createVariants = true;
        Craft::info(print_r($field->fieldVolumeSettings, true), __METHOD__);

It seems like print_r($field->fieldVolumeSettings, true) can also be of type true; however, parameter $message of yii\BaseYii::info() does only seem to accept array|string, maybe add an additional type check?

        // See if we're ignoring files in this dir
        if (!empty($field->fieldVolumeSettings)) {
            foreach ($field->fieldVolumeSettings as $volumeHandle => $subfolders) {
                if ($asset->getVolume()->handle === $volumeHandle) {
                    if (is_string($subfolders) && $subfolders === '*') {
                        $createVariants = true;
                        Craft::info("Matched '*' wildcard ", __METHOD__);
                    } else {
                        $createVariants = false;
                        if (is_array($subfolders)) {
                            foreach ($subfolders as $subfolder) {
                                $folder = $asset->getFolder();
                                while ($folder !== null && !$createVariants) {
                                    if ($folder->uid === $subfolder || $folder->name === $subfolder) {
                                        Craft::info('Matched subfolder uid: ' . print_r($subfolder, true), __METHOD__);

Are you sure print_r($subfolder, true) of type string|true can be used in concatenation?

                                        $createVariants = true;
                                    } else {
                                        $folder = $folder->getParent();
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        // See if we should ignore this type of file
        $sourceType = $asset->getMimeType();
        if (!empty($field->ignoreFilesOfType) && $sourceType !== null) {
            $ignoreTypes = array_values($field->ignoreFilesOfType);
            // If `image/svg` is being ignored, add `image/svg+xml` to the mime types to ignore as well
            if (in_array('image/svg', $ignoreTypes, false)) {
                $ignoreTypes[] = 'image/svg+xml';
            }
            if (in_array($sourceType, $ignoreTypes, false)) {
                $createVariants = false;
            }
        }
        return $createVariants;
    }

    /**

Missing short description in doc comment

     * @param Field $field

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

     * @param ElementInterface $asset

Missing parameter comment

     * @param bool $force

Missing parameter comment

Expected 13 spaces after parameter type; 1 found

     *
     * @throws Exception
     * @throws InvalidConfigException
     * @throws InvalidFieldException
     */

Missing @return tag in function comment

    public function updateOptimizedImageFieldData(Field $field, ElementInterface $asset, bool $force = false): void
    {
        /** @var Asset $asset */

Missing short description in doc comment

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

        if ($asset instanceof Asset && $field instanceof OptimizedImagesField) {
            $createVariants = $this->shouldCreateVariants($field, $asset);
            // Create a new OptimizedImage model and populate it
            $model = new OptimizedImage();
            // Empty our the optimized image URLs
            $model->optimizedImageUrls = [];
            $model->optimizedWebPImageUrls = [];
            $model->variantSourceWidths = [];
            $model->placeholderWidth = 0;
            $model->placeholderHeight = 0;
            if ($createVariants) {
                $this->populateOptimizedImageModel(
                    $asset,
                    $field->variants,
                    $model,
                    $force
                );
            }
            // Save the changed data directly into the elements_sites.content table
            if ($field->handle !== null) {
                $asset->setFieldValue($field->handle, $field->serializeValue($model, $asset));
                $fieldLayout = $asset->getFieldLayout();
                $siteSettingsRecords = Element_SiteSettingsRecord::findAll([

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'elementId' => $asset->id,
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

                // Update it for all of the sites
                foreach ($siteSettingsRecords as $siteSettingsRecord) {
                    // Set the field values
                    if ($fieldLayout) {
                        $content = Json::decodeIfJson($siteSettingsRecord->content);
                        if (!is_array($content)) {
                            $content = [];
                        }
                        $content[$field->layoutElement->uid] = $field->serializeValue($asset->getFieldValue($field->handle), $asset);
                        $siteSettingsRecord->content = $content;
                        // Save the site settings record
                        if (!$siteSettingsRecord->save(false)) {
                            Craft::error('Couldn’t save elements’ site settings record.', __METHOD__);
                        }
                    }
                }
            }
        }
    }

    /**
     * Re-save all the assets in all the volumes
     *
     * @param ?int $fieldId only for this specific id
     * @param bool $force Should image variants be forced to be recreated?

Expected 3 spaces after parameter name; 1 found

     *
     * @throws InvalidConfigException
     */

Missing @return tag in function comment

    public function resaveAllVolumesAssets(?int $fieldId = null, bool $force = false): void
    {
        $volumes = Craft::$app->getVolumes()->getAllVolumes();
        foreach ($volumes as $volume) {
            $this->resaveVolumeAssets($volume, $fieldId, $force);
        }
    }

    /**
     * Re-save all the Asset elements in the Volume $volume that have an
     * OptimizedImages field in the FieldLayout
     *
     * @param Volume $volume for this volume

Expected 2 spaces after parameter name; 1 found

     * @param ?int $fieldId only for this specific id

Expected 3 spaces after parameter type; 1 found

     * @param bool $force Should image variants be forced to be recreated?

Expected 3 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 1 found

     */

Missing @return tag in function comment

    public function resaveVolumeAssets(Volume $volume, ?int $fieldId = null, bool $force = false): void
    {
        $needToReSave = false;
        /** @var ?FieldLayout $fieldLayout */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $fieldLayout = $volume->getFieldLayout();
        // Loop through the fields in the layout to see if there is an OptimizedImages field
        if ($fieldLayout) {
            $fields = $fieldLayout->getCustomFields();
            foreach ($fields as $field) {
                if ($field instanceof OptimizedImagesField) {
                    $needToReSave = true;
                }
            }
        }
        if ($needToReSave) {
            try {
                $siteId = Craft::$app->getSites()->getPrimarySite()->id;
            } catch (SiteNotFoundException $e) {
                $siteId = 0;
                Craft::error(
                    'Failed to get primary site: ' . $e->getMessage(),
                    __METHOD__
                );
            }

            $queue = Craft::$app->getQueue();
            $jobId = $queue->push(new ResaveOptimizedImages([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'description' => Craft::t('image-optimize', 'Optimizing images in {name}', ['name' => $volume->name]),
                'criteria' => [
                    'siteId' => $siteId,
                    'volumeId' => $volume->id,
                    'status' => null,
                ],
                'fieldId' => $fieldId,
                'force' => $force,
            ]));

For multi-line function calls, the closing parenthesis should be on a new line.

            Craft::debug(
                Craft::t(
                    'image-optimize',
                    'Started resaveVolumeAssets queue job id: {jobId}',
                    [
                        'jobId' => $jobId,
                    ]
                ),
                __METHOD__
            );
        }
    }

    /**
     * Re-save an individual asset
     *
     * @param int $id

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param bool $force Should image variants be forced to be recreated?
     */

Missing @return tag in function comment

    public function resaveAsset(int $id, bool $force = false): void
    {
        $queue = Craft::$app->getQueue();
        $jobId = $queue->push(new ResaveOptimizedImages([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'description' => Craft::t('image-optimize', 'Optimizing image id {id}', ['id' => $id]),
            'criteria' => [
                'id' => $id,
                'status' => null,
            ],
            'force' => $force,
        ]));

For multi-line function calls, the closing parenthesis should be on a new line.

        Craft::debug(
            Craft::t(
                'image-optimize',
                'Started resaveAsset queue job id: {jobId} Element id: {elementId}',
                [
                    'elementId' => $id,
                    'jobId' => $jobId,
                ]
            ),
            __METHOD__
        );
    }

    /**
     * Create an optimized SVG data uri
     * See: https://codepen.io/tigt/post/optimizing-svgs-in-data-uris
     *
     * @param string $uri

Missing parameter comment

     *
     * @return string
     */
    public function encodeOptimizedSVGDataUri(string $uri): string
    {
        // First, uri encode everything
        $uri = rawurlencode($uri);
        $replacements = [
            // remove newlines
            '/%0A/' => '',
            // put equals signs back in
            '/%3D/' => '=',
            // put colons back in
            '/%3A/' => ':',
            // put slashes back in
            '/%2F/' => '/',
            // replace quotes with apostrophes (may break certain SVGs)
            '/%22/' => "'",
        ];
        foreach ($replacements as $pattern => $replacement) {
            $uri = preg_replace($pattern, $replacement, $uri);
        }

        return $uri;
    }

    // Protected Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @param Asset $element

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     * @param OptimizedImage $model

Missing parameter comment

     * @param                $aspectRatio

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 1 spaces but found 16

     */

Missing @return tag in function comment

    protected function generatePlaceholders(Asset $element, OptimizedImage $model, $aspectRatio): void
    {
        Craft::beginProfile('generatePlaceholders', __METHOD__);
        Craft::info(
            'generatePlaceholders for: ' . print_r($model, true),

Are you sure print_r($model, true) of type string|true can be used in concatenation?

            __METHOD__
        );
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = ImageOptimize::$plugin->getSettings();
        if ($settings->generatePlaceholders && ImageOptimize::$generatePlaceholders) {
            $placeholder = ImageOptimize::$plugin->placeholder;
            if ($element->focalPoint) {
                $position = $element->getFocalPoint();
            } else {
                $position = 'center-center';
            }
            $tempPath = $placeholder->createTempPlaceholderImage($element, $aspectRatio, $position);
            if (!empty($tempPath)) {
                // Generate our placeholder image
                $model->placeholder = $placeholder->generatePlaceholderImage($tempPath, $aspectRatio, $position);
                // Generate the color palette for the image
                if ($settings->createColorPalette) {
                    $model->colorPalette = $placeholder->generateColorPalette($tempPath);
                    $model->lightness = $placeholder->calculateLightness($model->colorPalette);

It seems like $model->colorPalette can also be of type null; however, parameter $colors of nystudio107\imageoptimize\services\Placeholder::calculateLightness() does only seem to accept array, maybe add an additional type check?

                }
                // Generate the Potrace SVG
                if ($settings->createPlaceholderSilhouettes) {
                    $model->placeholderSvg = $placeholder->generatePlaceholderSvg($tempPath);
                }
                // Get rid of our placeholder image
                @unlink($tempPath);

It seems like you do not handle an error condition for unlink(). This can introduce security issues, and is generally not recommended.

            }
        }
        Craft::endProfile('generatePlaceholders', __METHOD__);
    }

    /**

Missing short description in doc comment

     * @param Asset $asset

Missing parameter comment

     * @param       $variant

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 1 spaces but found 7

     * @param       $retinaSize

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 1 spaces but found 7

     *
     * @return array
     * @throws FsObjectNotFoundException
     */
    protected function getTransformFromVariant(Asset $asset, $variant, $retinaSize): array
    {
        /** @var Settings $settings */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $settings = ImageOptimize::$plugin->getSettings();
        $transform = new AssetTransform();
        $transform->format = $variant['format'] ?? null;
        // Handle animate .gif images by never changing the format
        $images = Craft::$app->getImages();
        if ($asset->extension === 'gif' && !$images->getIsGd()) {
            $imageSource = TransformHelper::getLocalImageSource($asset);
            try {
                if (ImageHelper::getIsAnimatedGif($imageSource)) {
                    $transform->format = null;
                }
            } catch (\Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }
        $useAspectRatio = $variant['useAspectRatio'] ?? false;
        if ($useAspectRatio) {
            $aspectRatio = (float)$variant['aspectRatioX'] / (float)$variant['aspectRatioY'];
        } else {
            $aspectRatio = (float)$asset->width / (float)$asset->height;
        }
        $width = (int)$variant['width'] * (int)$retinaSize;
        $transform->width = $width;
        $transform->height = (int)($width / $aspectRatio);
        // Image quality
        $quality = (int)($variant['quality'] ?? null);
        if (empty($quality)) {
            $quality = null;
        }
        if ($quality !== null && $settings->lowerQualityRetinaImageVariants && $retinaSize != '1') {
            $quality = (int)($quality * (1.5 / (int)$retinaSize));
        }
        $transform->quality = $quality;
        // Interlaced (progressive JPEGs or interlaced PNGs)
        if (property_exists($transform, 'interlace')) {
            $transform->interlace = 'line';
        }

        return [$transform, $aspectRatio];
    }

    /**

Missing short description in doc comment

     * @param Asset $asset

Missing parameter comment