Newer
Older
<?php
namespace Drupal\system\Plugin\ImageToolkit;
use Drupal\Component\Utility\Color;
Alex Pott
committed
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Config\ConfigFactoryInterface;
Dries Buytaert
committed
use Drupal\Core\Form\FormStateInterface;
Alex Pott
committed
use Drupal\Core\ImageToolkit\ImageToolkitBase;
use Drupal\Core\ImageToolkit\ImageToolkitOperationManagerInterface;
use Drupal\Core\StreamWrapper\StreamWrapperInterface;
use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Defines the GD2 toolkit for image manipulation within Drupal.
*
Alex Pott
committed
* @ImageToolkit(
* id = "gd",
* title = @Translation("GD2 image manipulation toolkit")
* )
*/
Alex Pott
committed
class GDToolkit extends ImageToolkitBase {
Alex Pott
committed
/**
* A GD image resource.
*
* @var resource|null
Alex Pott
committed
*/
protected $resource = NULL;
Alex Pott
committed
Alex Pott
committed
/**
* 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;
/**
* 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.
*/
public function __construct(array $configuration, $plugin_id, array $plugin_definition, ImageToolkitOperationManagerInterface $operation_manager, LoggerInterface $logger, ConfigFactoryInterface $config_factory, StreamWrapperManagerInterface $stream_wrapper_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $operation_manager, $logger, $config_factory);
$this->streamWrapperManager = $stream_wrapper_manager;
}
/**
* 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')
);
}
Alex Pott
committed
/**
* Sets the GD image resource.
*
* @param resource $resource
* The GD image resource.
*
* @return \Drupal\system\Plugin\ImageToolkit\GDToolkit
* An instance of the current toolkit object.
Alex Pott
committed
*/
public function setResource($resource) {
if (!is_resource($resource) || get_resource_type($resource) != 'gd') {
throw new \InvalidArgumentException('Invalid resource argument');
}
$this->preLoadInfo = NULL;
Alex Pott
committed
$this->resource = $resource;
return $this;
}
/**
* Retrieves the GD image resource.
*
* @return resource|null
* The GD image resource, or NULL if not available.
Alex Pott
committed
*/
public function getResource() {
if (!is_resource($this->resource)) {
$this->load();
}
Alex Pott
committed
return $this->resource;
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form['image_jpeg_quality'] = array(
'#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')
Alex Pott
committed
->set('jpeg_quality', $form_state->getValue(array('gd', 'image_jpeg_quality')))
->save();
}
/**
Alex Pott
committed
* Loads a GD resource from a file.
Alex Pott
committed
*
* @return bool
* TRUE or FALSE, based on success.
*/
catch
committed
protected function load() {
// Return immediately if the image file is not valid.
if (!$this->isValid()) {
return FALSE;
}
Alex Pott
committed
$function = 'imagecreatefrom' . image_type_to_extension($this->getType(), FALSE);
if (function_exists($function) && $resource = $function($this->getSource())) {
Alex Pott
committed
$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 = array(
'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}
*/
catch
committed
public function save($destination) {
$scheme = file_uri_scheme($destination);
// Work around lack of stream wrapper support in imagejpeg() and imagepng().
if ($scheme && file_stream_wrapper_valid_scheme($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 = drupal_tempnam('temporary://', 'gd_');
}
// Convert stream wrapper URI to normal path.
$destination = drupal_realpath($destination);
}
Alex Pott
committed
$function = 'image' . image_type_to_extension($this->getType(), FALSE);
if (!function_exists($function)) {
return FALSE;
}
Alex Pott
committed
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.
Alex Pott
committed
if ($this->getType() == IMAGETYPE_PNG) {
Alex Pott
committed
imagealphablending($this->getResource(), FALSE);
imagesavealpha($this->getResource(), TRUE);
Alex Pott
committed
$success = $function($this->getResource(), $destination);
}
// Move temporary local file to remote destination.
if (isset($permanent_destination) && $success) {
return (bool) file_unmanaged_move($destination, $permanent_destination, FILE_EXISTS_REPLACE);
}
return $success;
}
/**
* {@inheritdoc}
*/
catch
committed
public function parseFile() {
$data = @getimagesize($this->getSource());
Alex Pott
committed
if ($data && in_array($data[2], static::supportedTypes())) {
$this->setType($data[2]);
$this->preLoadInfo = $data;
return TRUE;
Alex Pott
committed
}
Alex Pott
committed
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;
}
catch
committed
/**
* {@inheritdoc}
*/
catch
committed
public function getWidth() {
if ($this->preLoadInfo) {
return $this->preLoadInfo[0];
}
elseif ($res = $this->getResource()) {
return imagesx($res);
}
else {
return NULL;
}
catch
committed
}
/**
* {@inheritdoc}
*/
catch
committed
public function getHeight() {
if ($this->preLoadInfo) {
return $this->preLoadInfo[1];
}
elseif ($res = $this->getResource()) {
return imagesy($res);
}
else {
return NULL;
}
catch
committed
}
Alex Pott
committed
/**
* 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).
*
Alex Pott
committed
* @return $this
Alex Pott
committed
*/
public function setType($type) {
if (in_array($type, static::supportedTypes())) {
$this->type = $type;
}
return $this;
}
/**
* {@inheritdoc}
*/
catch
committed
public function getMimeType() {
Alex Pott
committed
return $this->getType() ? image_type_to_mime_type($this->getType()) : '';
}
Alex Pott
committed
/**
* {@inheritdoc}
*/
public function getRequirements() {
$requirements = array();
$info = gd_info();
$requirements['version'] = array(
'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>.');
Alex Pott
committed
}
return $requirements;
}
/**
* {@inheritdoc}
*/
public static function isAvailable() {
// GD2 support is available.
return function_exists('imagegd2');
Alex Pott
committed
/**
* {@inheritdoc}
*/
Alex Pott
committed
public static function getSupportedExtensions() {
$extensions = array();
foreach (static::supportedTypes() as $image_type) {
$extensions[] = Unicode::strtolower(image_type_to_extension($image_type, FALSE));
}
return $extensions;
}
Angie Byron
committed
/**
* 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) {
foreach ($this->supportedTypes() as $type) {
if (image_type_to_extension($type, FALSE) === $extension) {
return $type;
}
}
return IMAGETYPE_UNKNOWN;
}
Alex Pott
committed
/**
* 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() {
Alex Pott
committed
return array(IMAGETYPE_PNG, IMAGETYPE_JPEG, IMAGETYPE_GIF);
}