ImgixImageTransform.php

<?php
/**
 * ImageOptimize plugin for Craft CMS 3.x
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com
 * @copyright Copyright (c) 2017 nystudio107
 */

namespace nystudio107\imageoptimizeimgix\imagetransforms;

use Craft;
use craft\elements\Asset;
use craft\errors\DeprecationException;
use craft\fs\Local;
use craft\helpers\App;
use craft\helpers\ArrayHelper;
use craft\helpers\Assets as AssetsHelper;
use craft\helpers\UrlHelper;
use craft\models\ImageTransform as CraftImageTransformModel;
use Exception;
use GuzzleHttp\Exception\GuzzleException;
use Imgix\UrlBuilder;
use nystudio107\imageoptimize\ImageOptimize;
use nystudio107\imageoptimize\imagetransforms\ImageTransform;

/**
 * @author    nystudio107
 * @package   ImageOptimize
 * @since     1.1.0
 */
class ImgixImageTransform extends ImageTransform
{
    // Constants
    // =========================================================================

    protected const TRANSFORM_ATTRIBUTES_MAP = [
        'width' => 'w',
        'height' => 'h',
        'quality' => 'q',
        'format' => 'fm',
    ];

    protected const IMGIX_PURGE_ENDPOINT = 'https://api.imgix.com/api/v1/purge';

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

    /**
     * @var string
     */
    public string $domain = '';

    /**
     * @var string
     */
    public string $apiKey = '';

    /**
     * @var string
     */
    public string $securityToken = '';

    /**
     * @var int The amount that should be sent to the USM parameter
     */
    public int $unsharpMask = 20;

    /**
     * @inheritdoc
     */
    public static function displayName(): string
    {
        return Craft::t('image-optimize', 'Imgix');
    }

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

    public function init(): void
    {
        parent::init();
    }

    /**
     * @inheritdoc
     */
    public function getTransformUrl(Asset $asset, CraftImageTransformModel|string|array|null $transform): ?string
    {
        $params = [];
        $settings = ImageOptimize::$plugin->getSettings();

        $domain = $this->domain ?? 'demos.imgix.net';
        $securityToken = $this->securityToken;
        $domain = App::parseEnv($domain);
        $securityToken = App::parseEnv($securityToken);
        $params['domain'] = $domain;
        $builder = new UrlBuilder($domain);
        $builder->setUseHttps(true);
        if ($transform) {
            // Map the transform properties
            foreach (self::TRANSFORM_ATTRIBUTES_MAP as $key => $value) {
                if (!empty($transform[$key])) {
                    $params[$value] = $transform[$key];
                }
            }
            // Remove any 'AUTO' settings
            ArrayHelper::removeValue($params, 'AUTO');
            // Handle the Imgix auto setting for compression/format
            $autoParams = [];
            if (empty($params['q'])) {
                $autoParams[] = 'compress';
            }
            if (empty($params['fm'])) {
                $autoParams[] = 'format';
            }
            if (!empty($autoParams)) {
                $params['auto'] = implode(',', $autoParams);
            }
            // Handle interlaced images
            if (property_exists($transform, 'interlace') && ($transform->interlace !== 'none')
                && (!empty($params['fm']))
                && ($params['fm'] === 'jpg')) {
                $params['fm'] = 'pjpg';
            }
            if ($settings->autoSharpenScaledImages && $asset->getWidth() && $asset->getHeight()) {
                // See if the image has been scaled >= 50%
                $widthScale = (int)((($transform->width ?? $asset->getWidth()) / $asset->getWidth()) * 100);
                $heightScale = (int)((($transform->height ?? $asset->getHeight()) / $asset->getHeight()) * 100);
                if (($widthScale >= $settings->sharpenScaledImagePercentage) || ($heightScale >= $settings->sharpenScaledImagePercentage)) {
                    $params['usm'] = ($this->unsharpMask ?? 25);
                }
            }
            // Handle the mode
            switch ($transform->mode) {
                case 'fit':
                    $params['fit'] = 'clip';
                    break;

                case 'stretch':
                    $params['fit'] = 'scale';
                    break;

                default:
                    // Set a sane default
                    if (empty($transform->position)) {
                        $transform->position = 'center-center';
                    }
                    // Fit mode
                    $params['fit'] = 'crop';
                    $cropParams = [];
                    // Handle the focal point
                    $focalPoint = $asset->getFocalPoint();
                    if (!empty($focalPoint)) {
                        $params['fp-x'] = $focalPoint['x'];
                        $params['fp-y'] = $focalPoint['y'];
                        $cropParams[] = 'focalpoint';
                        $params['crop'] = implode(',', $cropParams);
                    } elseif (preg_match('/(top|center|bottom)-(left|center|right)/', $transform->position)) {
                        // Imgix defaults to 'center' if no param is present
                        $filteredCropParams = explode('-', $transform->position);
                        $filteredCropParams = array_diff($filteredCropParams, ['center']);
                        $cropParams[] = $filteredCropParams;
                        // Imgix
                        if (!empty($cropParams) && $transform->position !== 'center-center') {
                            $params['crop'] = implode(',', $cropParams);
                        }
                    }
                    break;
            }
        } else {
            // No transform was passed in; so just auto all the things
            $params['auto'] = 'format,compress';
        }
        // Apply the Security Token, if set
        if (!empty($securityToken)) {
            $builder->setSignKey($securityToken);
        }
        // Finally, create the Imgix URL for this transformed image
        $assetUri = $this->getAssetUri($asset);
        $url = $builder->createURL($assetUri, $params);
        Craft::debug(
            'Imgix transform created for: ' . $assetUri . ' - Params: ' . print_r($params, true) . ' - URL: ' . $url,
            __METHOD__
        );

        return $url;
    }

    /**
     * @inheritdoc
     */
    public function getWebPUrl(string $url, Asset $asset, CraftImageTransformModel|string|array|null $transform): ?string
    {
        if ($transform) {
            $transform->format = 'webp';
        }
        try {
            $webPUrl = $this->getTransformUrl($asset, $transform);
        } catch (Exception $e) {
            Craft::error($e->getMessage(), __METHOD__);
        }

        return $webPUrl ?? '';
    }

    /**
     * @inheritdoc
     */
    public function getPurgeUrl(Asset $asset): ?string
    {
        $domain = $this->domain ?? 'demos.imgix.net';
        $apiKey = $this->apiKey;
        $securityToken = $this->securityToken;
        $domain = App::parseEnv($domain);
        $apiKey = App::parseEnv($apiKey);
        $securityToken = App::parseEnv($securityToken);
        $builder = new UrlBuilder($domain);
        $builder->setUseHttps(true);
        // Create the Imgix URL for purging this image
        $assetUri = $this->getAssetUri($asset);
        $url = $builder->createURL($assetUri, [
            'domain' => $domain,
            'api-key' => $apiKey,
            'security-token' => $securityToken,
        ]);

        // Strip the query string, so we just pass in the raw URL
        return UrlHelper::stripQueryString($url);
    }

    /**
     * @inheritdoc
     */
    public function purgeUrl(string $url): bool
    {
        $result = false;

        $apiKey = $this->apiKey;
        if ($apiKey === '') {
            Craft::error(
                'Imgix API key is not set',
                __METHOD__
            );
            return false;
        }
        
        $apiKey = App::parseEnv($apiKey);
        
        // Check the API key to see if it is deprecated or not
        if (strlen($this->apiKey) < 50) {
            try {
                Craft::$app->deprecator->log(__METHOD__, 'You are using a deprecated API key. Obtain a new API key to use the purging API. More info: https://blog.imgix.com/2020/10/16/api-deprecation');
            } catch (DeprecationException $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        // create new guzzle client
        $guzzleClient = Craft::createGuzzleClient(['timeout' => 120, 'connect_timeout' => 120]);
        // Submit the sitemap index to each search engine
        try {
            $response = $guzzleClient->post(self::IMGIX_PURGE_ENDPOINT, [
                'headers' => [
                    'Authorization' => 'Bearer ' . $apiKey,
                ],
                'form_params' => [
                    'data' => [
                        'attributes' => [
                            'url' => $url
                        ],
                        'type' => 'purges'
                    ]
                ],
            ]);
            // See if it succeeded
            if (($response->getStatusCode() >= 200)
                && ($response->getStatusCode() < 400)
            ) {
                $result = true;
            }
            Craft::info(
                'URL purged: ' . $url . ' - Response code: ' . $response->getStatusCode(),
                __METHOD__
            );
        } catch (GuzzleException $e) {
            Craft::error(
                'Error purging URL: ' . $url . ' - ' . $e->getMessage(),
                __METHOD__
            );
        }

        return $result;
    }

    /**
     * @inheritdoc
     */
    public function getAssetUri(Asset $asset): ?string
    {
        $volume = $asset->getVolume();

        // If this is a local volume, it implies your are using a "Web Folder"
        // source in Imgix. We can then also infer that:
        // - This volume has URLs
        // - The "Base URL" in Imgix is set to your domain root, per the ImageOptimize docs.
        //
        // Therefore, we need to parse the path from the full URL, so that it
        // includes the path of the volume.
        $fs = $volume->getFs();
        if ($fs instanceof Local) {
            $assetUrl = AssetsHelper::generateUrl($fs, $asset);

            return parse_url(rawurldecode($assetUrl), PHP_URL_PATH);
        }

        return parent::getAssetUri($asset);
    }

    /**
     * @inheritdoc
     */
    public function getSettingsHtml(): ?string
    {
        return Craft::$app->getView()->renderTemplate('imgix-image-transform/settings/image-transforms/imgix.twig', [
            'imageTransform' => $this,
        ]);
    }

    /**
     * @inheritdoc
     */
    public function rules(): array
    {
        $rules = parent::rules();
        return array_merge($rules, [
            [['domain', 'apiKey', 'securityToken'], 'default', 'value' => ''],
            [['domain', 'apiKey', 'securityToken'], 'string'],
        ]);
    }
}