GDToolkit.php

<?php

namespace Drupal\system\Plugin\ImageToolkit;

use Drupal\Component\Utility\Color;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\File\Exception\FileException;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\ImageToolkit\ImageToolkitBase;
use Drupal\Core\ImageToolkit\ImageToolkitOperationManagerInterface;
use Drupal\Core\StreamWrapper\StreamWrapperInterface;
use Drupal\Core\StreamWrapper\StreamWrapperManager;
use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Defines the GD2 toolkit for image manipulation within Drupal.
 *
 * @ImageToolkit(
 *   id = "gd",
 *   title = @Translation("GD2 image manipulation toolkit")
 * )
 */
class GDToolkit extends ImageToolkitBase {
    
    /**
     * A GD image resource.
     *
     * @var resource|null
     */
    protected $resource = NULL;
    
    /**
     * Image type represented by a PHP IMAGETYPE_* constant (e.g. IMAGETYPE_JPEG).
     *
     * @var int
     */
    protected $type;
    
    /**
     * Image information from a file, available prior to loading the GD resource.
     *
     * This contains a copy of the array returned by executing getimagesize()
     * on the image file when the image object is instantiated. It gets reset
     * to NULL as soon as the GD resource is loaded.
     *
     * @var array|null
     *
     * @see \Drupal\system\Plugin\ImageToolkit\GDToolkit::parseFile()
     * @see \Drupal\system\Plugin\ImageToolkit\GDToolkit::setResource()
     * @see http://php.net/manual/function.getimagesize.php
     */
    protected $preLoadInfo = NULL;
    
    /**
     * The StreamWrapper manager.
     *
     * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
     */
    protected $streamWrapperManager;
    
    /**
     * The file system.
     *
     * @var \Drupal\Core\File\FileSystemInterface
     */
    protected $fileSystem;
    
    /**
     * Constructs a GDToolkit object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin_id for the plugin instance.
     * @param array $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\ImageToolkit\ImageToolkitOperationManagerInterface $operation_manager
     *   The toolkit operation manager.
     * @param \Psr\Log\LoggerInterface $logger
     *   A logger instance.
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The config factory.
     * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager
     *   The StreamWrapper manager.
     * @param \Drupal\Core\File\FileSystemInterface $file_system
     *   The file system.
     */
    public function __construct(array $configuration, $plugin_id, array $plugin_definition, ImageToolkitOperationManagerInterface $operation_manager, LoggerInterface $logger, ConfigFactoryInterface $config_factory, StreamWrapperManagerInterface $stream_wrapper_manager, FileSystemInterface $file_system = NULL) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $operation_manager, $logger, $config_factory);
        $this->streamWrapperManager = $stream_wrapper_manager;
        if (!$file_system) {
            @trigger_error('The file_system service must be passed to GDToolkit::__construct(), it is required before Drupal 9.0.0. See https://www.drupal.org/node/3006851.', E_USER_DEPRECATED);
            $file_system = \Drupal::service('file_system');
        }
        $this->fileSystem = $file_system;
    }
    
    /**
     * Destructs a GDToolkit object.
     *
     * Frees memory associated with a GD image resource.
     */
    public function __destruct() {
        if (is_resource($this->resource)) {
            imagedestroy($this->resource);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('image.toolkit.operation.manager'), $container->get('logger.channel.image'), $container->get('config.factory'), $container->get('stream_wrapper_manager'), $container->get('file_system'));
    }
    
    /**
     * Sets the GD image resource.
     *
     * @param resource $resource
     *   The GD image resource.
     *
     * @return $this
     *   An instance of the current toolkit object.
     */
    public function setResource($resource) {
        if (!is_resource($resource) || get_resource_type($resource) != 'gd') {
            throw new \InvalidArgumentException('Invalid resource argument');
        }
        $this->preLoadInfo = NULL;
        $this->resource = $resource;
        return $this;
    }
    
    /**
     * Retrieves the GD image resource.
     *
     * @return resource|null
     *   The GD image resource, or NULL if not available.
     */
    public function getResource() {
        if (!is_resource($this->resource)) {
            $this->load();
        }
        return $this->resource;
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form['image_jpeg_quality'] = [
            '#type' => 'number',
            '#title' => t('JPEG quality'),
            '#description' => t('Define the image quality for JPEG manipulations. Ranges from 0 to 100. Higher values mean better image quality but bigger files.'),
            '#min' => 0,
            '#max' => 100,
            '#default_value' => $this->configFactory
                ->getEditable('system.image.gd')
                ->get('jpeg_quality', FALSE),
            '#field_suffix' => t('%'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configFactory
            ->getEditable('system.image.gd')
            ->set('jpeg_quality', $form_state->getValue([
            'gd',
            'image_jpeg_quality',
        ]))
            ->save();
    }
    
    /**
     * Loads a GD resource from a file.
     *
     * @return bool
     *   TRUE or FALSE, based on success.
     */
    protected function load() {
        // Return immediately if the image file is not valid.
        if (!$this->isValid()) {
            return FALSE;
        }
        $function = 'imagecreatefrom' . image_type_to_extension($this->getType(), FALSE);
        if (function_exists($function) && ($resource = $function($this->getSource()))) {
            $this->setResource($resource);
            if (imageistruecolor($resource)) {
                return TRUE;
            }
            else {
                // Convert indexed images to truecolor, copying the image to a new
                // truecolor resource, so that filters work correctly and don't result
                // in unnecessary dither.
                $data = [
                    'width' => imagesx($resource),
                    'height' => imagesy($resource),
                    'extension' => image_type_to_extension($this->getType(), FALSE),
                    'transparent_color' => $this->getTransparentColor(),
                    'is_temp' => TRUE,
                ];
                if ($this->apply('create_new', $data)) {
                    imagecopy($this->getResource(), $resource, 0, 0, 0, 0, imagesx($resource), imagesy($resource));
                    imagedestroy($resource);
                }
            }
            return (bool) $this->getResource();
        }
        return FALSE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function isValid() {
        return (bool) $this->preLoadInfo || (bool) $this->resource;
    }
    
    /**
     * {@inheritdoc}
     */
    public function save($destination) {
        $scheme = StreamWrapperManager::getScheme($destination);
        // Work around lack of stream wrapper support in imagejpeg() and imagepng().
        if ($scheme && $this->streamWrapperManager
            ->isValidScheme($scheme)) {
            // If destination is not local, save image to temporary local file.
            $local_wrappers = $this->streamWrapperManager
                ->getWrappers(StreamWrapperInterface::LOCAL);
            if (!isset($local_wrappers[$scheme])) {
                $permanent_destination = $destination;
                $destination = $this->fileSystem
                    ->tempnam('temporary://', 'gd_');
            }
            // Convert stream wrapper URI to normal path.
            $destination = $this->fileSystem
                ->realpath($destination);
        }
        $function = 'image' . image_type_to_extension($this->getType(), FALSE);
        if (!function_exists($function)) {
            return FALSE;
        }
        if ($this->getType() == IMAGETYPE_JPEG) {
            $success = $function($this->getResource(), $destination, $this->configFactory
                ->get('system.image.gd')
                ->get('jpeg_quality'));
        }
        else {
            // Always save PNG images with full transparency.
            if ($this->getType() == IMAGETYPE_PNG) {
                imagealphablending($this->getResource(), FALSE);
                imagesavealpha($this->getResource(), TRUE);
            }
            $success = $function($this->getResource(), $destination);
        }
        // Move temporary local file to remote destination.
        if (isset($permanent_destination) && $success) {
            try {
                $this->fileSystem
                    ->move($destination, $permanent_destination, FileSystemInterface::EXISTS_REPLACE);
                return TRUE;
            } catch (FileException $e) {
                return FALSE;
            }
        }
        return $success;
    }
    
    /**
     * {@inheritdoc}
     */
    public function parseFile() {
        $data = @getimagesize($this->getSource());
        if ($data && in_array($data[2], static::supportedTypes())) {
            $this->setType($data[2]);
            $this->preLoadInfo = $data;
            return TRUE;
        }
        return FALSE;
    }
    
    /**
     * Gets the color set for transparency in GIF images.
     *
     * @return string|null
     *   A color string like '#rrggbb', or NULL if not set or not relevant.
     */
    public function getTransparentColor() {
        if (!$this->getResource() || $this->getType() != IMAGETYPE_GIF) {
            return NULL;
        }
        // Find out if a transparent color is set, will return -1 if no
        // transparent color has been defined in the image.
        $transparent = imagecolortransparent($this->getResource());
        if ($transparent >= 0) {
            // Find out the number of colors in the image palette. It will be 0 for
            // truecolor images.
            $palette_size = imagecolorstotal($this->getResource());
            if ($palette_size == 0 || $transparent < $palette_size) {
                // Return the transparent color, either if it is a truecolor image
                // or if the transparent color is part of the palette.
                // Since the index of the transparent color is a property of the
                // image rather than of the palette, it is possible that an image
                // could be created with this index set outside the palette size.
                // (see http://stackoverflow.com/a/3898007).
                $rgb = imagecolorsforindex($this->getResource(), $transparent);
                unset($rgb['alpha']);
                return Color::rgbToHex($rgb);
            }
        }
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getWidth() {
        if ($this->preLoadInfo) {
            return $this->preLoadInfo[0];
        }
        elseif ($res = $this->getResource()) {
            return imagesx($res);
        }
        else {
            return NULL;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getHeight() {
        if ($this->preLoadInfo) {
            return $this->preLoadInfo[1];
        }
        elseif ($res = $this->getResource()) {
            return imagesy($res);
        }
        else {
            return NULL;
        }
    }
    
    /**
     * Gets the PHP type of the image.
     *
     * @return int
     *   The image type represented by a PHP IMAGETYPE_* constant (e.g.
     *   IMAGETYPE_JPEG).
     */
    public function getType() {
        return $this->type;
    }
    
    /**
     * Sets the PHP type of the image.
     *
     * @param int $type
     *   The image type represented by a PHP IMAGETYPE_* constant (e.g.
     *   IMAGETYPE_JPEG).
     *
     * @return $this
     */
    public function setType($type) {
        if (in_array($type, static::supportedTypes())) {
            $this->type = $type;
        }
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMimeType() {
        return $this->getType() ? image_type_to_mime_type($this->getType()) : '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRequirements() {
        $requirements = [];
        $info = gd_info();
        $requirements['version'] = [
            'title' => t('GD library'),
            'value' => $info['GD Version'],
        ];
        // Check for filter and rotate support.
        if (!function_exists('imagefilter') || !function_exists('imagerotate')) {
            $requirements['version']['severity'] = REQUIREMENT_WARNING;
            $requirements['version']['description'] = t('The GD Library for PHP is enabled, but was compiled without support for functions used by the rotate and desaturate effects. It was probably compiled using the official GD libraries from http://www.libgd.org instead of the GD library bundled with PHP. You should recompile PHP --with-gd using the bundled GD library. See <a href="http://php.net/manual/book.image.php">the PHP manual</a>.');
        }
        return $requirements;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function isAvailable() {
        // GD2 support is available.
        return function_exists('imagegd2');
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getSupportedExtensions() {
        $extensions = [];
        foreach (static::supportedTypes() as $image_type) {
            // @todo Automatically fetch possible extensions for each mime type.
            // @see https://www.drupal.org/node/2311679
            $extension = mb_strtolower(image_type_to_extension($image_type, FALSE));
            $extensions[] = $extension;
            // Add some known similar extensions.
            if ($extension === 'jpeg') {
                $extensions[] = 'jpg';
                $extensions[] = 'jpe';
            }
        }
        return $extensions;
    }
    
    /**
     * Returns the IMAGETYPE_xxx constant for the given extension.
     *
     * This is the reverse of the image_type_to_extension() function.
     *
     * @param string $extension
     *   The extension to get the IMAGETYPE_xxx constant for.
     *
     * @return int
     *   The IMAGETYPE_xxx constant for the given extension, or IMAGETYPE_UNKNOWN
     *   for unsupported extensions.
     *
     * @see image_type_to_extension()
     */
    public function extensionToImageType($extension) {
        if (in_array($extension, [
            'jpe',
            'jpg',
        ])) {
            $extension = 'jpeg';
        }
        foreach ($this->supportedTypes() as $type) {
            if (image_type_to_extension($type, FALSE) === $extension) {
                return $type;
            }
        }
        return IMAGETYPE_UNKNOWN;
    }
    
    /**
     * Returns a list of image types supported by the toolkit.
     *
     * @return array
     *   An array of available image types. An image type is represented by a PHP
     *   IMAGETYPE_* constant (e.g. IMAGETYPE_JPEG, IMAGETYPE_PNG, etc.).
     */
    protected static function supportedTypes() {
        return [
            IMAGETYPE_PNG,
            IMAGETYPE_JPEG,
            IMAGETYPE_GIF,
        ];
    }

}