View source
<?php
namespace Drupal\KernelTests\Core\Image;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Image\ImageInterface;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Site\Settings;
use Drupal\KernelTests\KernelTestBase;
class ToolkitGdTest extends KernelTestBase {
protected $imageFactory;
protected $black = [
0,
0,
0,
0,
];
protected $red = [
255,
0,
0,
0,
];
protected $green = [
0,
255,
0,
0,
];
protected $blue = [
0,
0,
255,
0,
];
protected $yellow = [
255,
255,
0,
0,
];
protected $white = [
255,
255,
255,
0,
];
protected $transparent = [
0,
0,
0,
127,
];
protected $fuchsia = [
255,
0,
255,
0,
];
protected $rotateTransparent = [
255,
255,
255,
127,
];
protected $width = 40;
protected $height = 20;
public static $modules = [
'system',
];
protected function setUp() {
parent::setUp();
$this->imageFactory = $this->container
->get('image.factory');
}
protected function checkRequirements() {
if (!function_exists('imagegd2')) {
return [
'Image manipulations for the GD toolkit cannot run because the GD toolkit is not available.',
];
}
return parent::checkRequirements();
}
public function colorsAreEqual($color_a, $color_b) {
if ($color_a[3] == 127 && $color_b[3] == 127) {
return TRUE;
}
foreach ($color_a as $key => $value) {
if ($color_b[$key] != $value) {
return FALSE;
}
}
return TRUE;
}
public function getPixelColor(ImageInterface $image, $x, $y) {
$toolkit = $image
->getToolkit();
$color_index = imagecolorat($toolkit
->getResource(), $x, $y);
$transparent_index = imagecolortransparent($toolkit
->getResource());
if ($color_index == $transparent_index) {
return [
0,
0,
0,
127,
];
}
return array_values(imagecolorsforindex($toolkit
->getResource(), $color_index));
}
public function testManipulations() {
$this
->assertEqual($this->imageFactory
->getToolkitId(), 'gd', 'The image factory is set to use the \'gd\' image toolkit.');
$expected_extensions = [
'png',
'gif',
'jpeg',
'jpg',
'jpe',
];
$supported_extensions = $this->imageFactory
->getSupportedExtensions();
$this
->assertEqual($expected_extensions, array_intersect($expected_extensions, $supported_extensions));
$expected_image_types = [
'png' => IMAGETYPE_PNG,
'gif' => IMAGETYPE_GIF,
'jpeg' => IMAGETYPE_JPEG,
'jpg' => IMAGETYPE_JPEG,
'jpe' => IMAGETYPE_JPEG,
];
$image = $this->imageFactory
->get();
foreach ($expected_image_types as $extension => $expected_image_type) {
$image_type = $image
->getToolkit()
->extensionToImageType($extension);
$this
->assertSame($expected_image_type, $image_type);
}
$default_corners = [
$this->red,
$this->green,
$this->blue,
$this->transparent,
];
$files = [
'image-test.png',
'image-test.gif',
'image-test-no-transparency.gif',
'image-test.jpg',
];
$operations = [
'resize' => [
'function' => 'resize',
'arguments' => [
'width' => 20,
'height' => 10,
],
'width' => 20,
'height' => 10,
'corners' => $default_corners,
],
'scale_x' => [
'function' => 'scale',
'arguments' => [
'width' => 20,
],
'width' => 20,
'height' => 10,
'corners' => $default_corners,
],
'scale_y' => [
'function' => 'scale',
'arguments' => [
'height' => 10,
],
'width' => 20,
'height' => 10,
'corners' => $default_corners,
],
'upscale_x' => [
'function' => 'scale',
'arguments' => [
'width' => 80,
'upscale' => TRUE,
],
'width' => 80,
'height' => 40,
'corners' => $default_corners,
],
'upscale_y' => [
'function' => 'scale',
'arguments' => [
'height' => 40,
'upscale' => TRUE,
],
'width' => 80,
'height' => 40,
'corners' => $default_corners,
],
'crop' => [
'function' => 'crop',
'arguments' => [
'x' => 12,
'y' => 4,
'width' => 16,
'height' => 12,
],
'width' => 16,
'height' => 12,
'corners' => array_fill(0, 4, $this->white),
],
'scale_and_crop' => [
'function' => 'scale_and_crop',
'arguments' => [
'width' => 10,
'height' => 8,
],
'width' => 10,
'height' => 8,
'corners' => array_fill(0, 4, $this->black),
],
'convert_jpg' => [
'function' => 'convert',
'width' => 40,
'height' => 20,
'arguments' => [
'extension' => 'jpeg',
],
'corners' => $default_corners,
],
'convert_gif' => [
'function' => 'convert',
'width' => 40,
'height' => 20,
'arguments' => [
'extension' => 'gif',
],
'corners' => $default_corners,
],
'convert_png' => [
'function' => 'convert',
'width' => 40,
'height' => 20,
'arguments' => [
'extension' => 'png',
],
'corners' => $default_corners,
],
];
if (function_exists('imagerotate') && version_compare(phpversion(), '7.0.26') < 0) {
$operations += [
'rotate_5' => [
'function' => 'rotate',
'arguments' => [
'degrees' => 5,
'background' => '#FF00FF',
],
'width' => 41,
'height' => 23,
'corners' => array_fill(0, 4, $this->fuchsia),
],
'rotate_90' => [
'function' => 'rotate',
'arguments' => [
'degrees' => 90,
'background' => '#FF00FF',
],
'width' => 20,
'height' => 40,
'corners' => [
$this->transparent,
$this->red,
$this->green,
$this->blue,
],
],
'rotate_transparent_5' => [
'function' => 'rotate',
'arguments' => [
'degrees' => 5,
],
'width' => 41,
'height' => 23,
'corners' => array_fill(0, 4, $this->rotateTransparent),
],
'rotate_transparent_90' => [
'function' => 'rotate',
'arguments' => [
'degrees' => 90,
],
'width' => 20,
'height' => 40,
'corners' => [
$this->transparent,
$this->red,
$this->green,
$this->blue,
],
],
];
}
if (function_exists('imagefilter')) {
$operations += [
'desaturate' => [
'function' => 'desaturate',
'arguments' => [],
'height' => 20,
'width' => 40,
'corners' => [
array_fill(0, 3, 76) + [
3 => 0,
],
array_fill(0, 3, 149) + [
3 => 0,
],
array_fill(0, 3, 29) + [
3 => 0,
],
array_fill(0, 3, 225) + [
3 => 127,
],
],
],
];
}
$directory = Settings::get('file_public_path') . '/imagetest';
\Drupal::service('file_system')
->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY);
foreach ($files as $file) {
foreach ($operations as $op => $values) {
$image = $this->imageFactory
->get('core/tests/fixtures/files/' . $file);
$toolkit = $image
->getToolkit();
if (!$image
->isValid()) {
$this
->fail(new FormattableMarkup('Could not load image %file.', [
'%file' => $file,
]));
continue 2;
}
$image_original_type = $image
->getToolkit()
->getType();
$image_truecolor = imageistruecolor($toolkit
->getResource());
$this
->assertTrue($image_truecolor, new FormattableMarkup('Image %file after load is a truecolor image.', [
'%file' => $file,
]));
$old_res = $toolkit
->getResource();
$image
->apply($values['function'], $values['arguments']);
$new_res = $toolkit
->getResource();
if ($new_res !== $old_res) {
$this
->assertFalse(is_resource($old_res), new FormattableMarkup("'%operation' destroyed the original resource.", [
'%operation' => $values['function'],
]));
}
$correct_dimensions_real = TRUE;
$correct_dimensions_object = TRUE;
if (imagesy($toolkit
->getResource()) != $values['height'] || imagesx($toolkit
->getResource()) != $values['width']) {
$correct_dimensions_real = FALSE;
}
if ($image
->getWidth() != $values['width'] || $image
->getHeight() != $values['height']) {
$correct_dimensions_object = FALSE;
}
$file_path = $directory . '/' . $op . image_type_to_extension($image
->getToolkit()
->getType());
$image
->save($file_path);
$this
->assertTrue($correct_dimensions_real, new FormattableMarkup('Image %file after %action action has proper dimensions.', [
'%file' => $file,
'%action' => $op,
]));
$this
->assertTrue($correct_dimensions_object, new FormattableMarkup('Image %file object after %action action is reporting the proper height and width values.', [
'%file' => $file,
'%action' => $op,
]));
if ($image
->getToolkit()
->getType() != IMAGETYPE_JPEG && $image_original_type != IMAGETYPE_JPEG) {
foreach ($values['corners'] as $key => $corner) {
if ($file === 'image-test-no-transparency.gif') {
if ($op == 'desaturate') {
$corner[3] = 0;
}
elseif ($corner === $this->transparent) {
$corner = $this->yellow;
}
}
switch ($key) {
case 0:
$x = 0;
$y = 0;
break;
case 1:
$x = $image
->getWidth() - 1;
$y = 0;
break;
case 2:
$x = $image
->getWidth() - 1;
$y = $image
->getHeight() - 1;
break;
case 3:
$x = 0;
$y = $image
->getHeight() - 1;
break;
}
$color = $this
->getPixelColor($image, $x, $y);
if ($image
->getToolkit()
->getType() == $image_original_type || $corner != $this->transparent) {
$correct_colors = $this
->colorsAreEqual($color, $corner);
$this
->assertTrue($correct_colors, new FormattableMarkup('Image %file object after %action action has the correct color placement at corner %corner.', [
'%file' => $file,
'%action' => $op,
'%corner' => $key,
]));
}
}
}
$image_reloaded = $this->imageFactory
->get($file_path);
$resource = $image_reloaded
->getToolkit()
->getResource();
}
}
foreach ([
IMAGETYPE_PNG,
IMAGETYPE_GIF,
IMAGETYPE_JPEG,
] as $type) {
$image = $this->imageFactory
->get();
$image
->createNew(50, 20, image_type_to_extension($type, FALSE), '#ffff00');
$file = 'from_null' . image_type_to_extension($type);
$file_path = $directory . '/' . $file;
$this
->assertEqual(50, $image
->getWidth(), new FormattableMarkup('Image file %file has the correct width.', [
'%file' => $file,
]));
$this
->assertEqual(20, $image
->getHeight(), new FormattableMarkup('Image file %file has the correct height.', [
'%file' => $file,
]));
$this
->assertEqual(image_type_to_mime_type($type), $image
->getMimeType(), new FormattableMarkup('Image file %file has the correct MIME type.', [
'%file' => $file,
]));
$this
->assertTrue($image
->save($file_path), new FormattableMarkup('Image %file created anew from a null image was saved.', [
'%file' => $file,
]));
$image_reloaded = $this->imageFactory
->get($file_path);
if (!$image_reloaded
->isValid()) {
$this
->fail(new FormattableMarkup('Could not load image %file.', [
'%file' => $file,
]));
continue;
}
$this
->assertEqual(50, $image_reloaded
->getWidth(), new FormattableMarkup('Image file %file has the correct width.', [
'%file' => $file,
]));
$this
->assertEqual(20, $image_reloaded
->getHeight(), new FormattableMarkup('Image file %file has the correct height.', [
'%file' => $file,
]));
$this
->assertEqual(image_type_to_mime_type($type), $image_reloaded
->getMimeType(), new FormattableMarkup('Image file %file has the correct MIME type.', [
'%file' => $file,
]));
if ($image_reloaded
->getToolkit()
->getType() == IMAGETYPE_GIF) {
$this
->assertEqual('#ffff00', $image_reloaded
->getToolkit()
->getTransparentColor(), new FormattableMarkup('Image file %file has the correct transparent color channel set.', [
'%file' => $file,
]));
}
else {
$this
->assertEqual(NULL, $image_reloaded
->getToolkit()
->getTransparentColor(), new FormattableMarkup('Image file %file has no color channel set.', [
'%file' => $file,
]));
}
}
$image = $this->imageFactory
->get();
$image
->createNew(-50, 20);
$this
->assertFalse($image
->isValid(), 'CreateNew with negative width fails.');
$image
->createNew(50, 20, 'foo');
$this
->assertFalse($image
->isValid(), 'CreateNew with invalid extension fails.');
$image
->createNew(50, 20, 'gif', '#foo');
$this
->assertFalse($image
->isValid(), 'CreateNew with invalid color hex string fails.');
$image
->createNew(50, 20, 'gif', '#ff0000');
$this
->assertTrue($image
->isValid(), 'CreateNew with valid arguments validates the Image.');
}
public function testResourceDestruction() {
$image = $this->imageFactory
->get('core/tests/fixtures/files/image-test.png');
$res = $image
->getToolkit()
->getResource();
$this
->assertIsResource($res);
$image = NULL;
$this
->assertFalse(is_resource($res), 'Image resource was destroyed after losing scope.');
$image = $this->imageFactory
->get('core/tests/fixtures/files/image-test.png');
$old_res = $image
->getToolkit()
->getResource();
$this
->assertIsResource($old_res);
$image
->createNew(20, 20);
$new_res = $image
->getToolkit()
->getResource();
$this
->assertFalse(is_resource($old_res));
$this
->assertIsResource($new_res);
}
public function testGifTransparentImages() {
$directory = Settings::get('file_public_path') . '/imagetest';
\Drupal::service('file_system')
->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY);
$file = 'image-test-transparent-indexed.gif';
$image = $this->imageFactory
->get('core/tests/fixtures/files/' . $file);
$resource = $image
->getToolkit()
->getResource();
$color_index = imagecolorat($resource, $image
->getWidth() - 1, 0);
$color = array_values(imagecolorsforindex($resource, $color_index));
$this
->assertEqual($this->rotateTransparent, $color, "Image {$file} after load has full transparent color at corner 1.");
$file = 'image-test-no-transparent-color-set.gif';
$file_path = $directory . '/' . $file;
$image = $this->imageFactory
->get();
$image
->createNew(50, 20, 'gif', NULL);
$resource = $image
->getToolkit()
->getResource();
$color_index = imagecolorat($resource, $image
->getWidth() - 1, 0);
$color = array_values(imagecolorsforindex($resource, $color_index));
$this
->assertEqual($this->rotateTransparent, $color, "New GIF image with no transparent color set after creation has full transparent color at corner 1.");
$this
->assertTrue($image
->save($file_path), "New GIF image {$file} was saved.");
$image_reloaded = $this->imageFactory
->get($file_path);
$resource = $image_reloaded
->getToolkit()
->getResource();
$color_index = imagecolorat($resource, $image_reloaded
->getWidth() - 1, 0);
$color = array_values(imagecolorsforindex($resource, $color_index));
$this
->assertEqual(0, $color[3], "New GIF image {$file} after reload has no transparent color at corner 1.");
$file = 'image-test-transparent-out-of-range.gif';
$image = $this->imageFactory
->get('core/tests/fixtures/files/' . $file);
$toolkit = $image
->getToolkit();
if (!$image
->isValid()) {
$this
->fail(new FormattableMarkup('Could not load image %file.', [
'%file' => $file,
]));
}
else {
$image_truecolor = imageistruecolor($toolkit
->getResource());
$this
->assertTrue($image_truecolor, new FormattableMarkup('Image %file after load is a truecolor image.', [
'%file' => $file,
]));
}
}
public function testMissingOperation() {
$this
->assertEqual($this->imageFactory
->getToolkitId(), 'gd', 'The image factory is set to use the \'gd\' image toolkit.');
$file = 'image-test.png';
$image = $this->imageFactory
->get('core/tests/fixtures/files/' . $file);
if (!$image
->isValid()) {
$this
->fail(new FormattableMarkup('Could not load image %file.', [
'%file' => $file,
]));
}
$this
->assertFalse($image
->apply('missing_op', []), 'Calling a missing image toolkit operation plugin fails.');
}
}