/web/core/modules/file/tests/src/Kernel/ValidatorTest.php
PHP | 242 lines | 152 code | 27 blank | 63 comment | 2 complexity | 95c71ec9a883a7d913809b6c1bcc1da2 MD5 | raw file
- <?php
- namespace Drupal\Tests\file\Kernel;
- use Drupal\file\Entity\File;
- /**
- * Tests the functions used to validate uploaded files.
- *
- * @group file
- */
- class ValidatorTest extends FileManagedUnitTestBase {
- /**
- * An image file.
- *
- * @var \Drupal\file\FileInterface
- */
- protected $image;
- /**
- * A file which is not an image.
- *
- * @var \Drupal\file\Entity\File
- */
- protected $nonImage;
- protected function setUp(): void {
- parent::setUp();
- $this->image = File::create();
- $this->image->setFileUri('core/misc/druplicon.png');
- /** @var \Drupal\Core\File\FileSystemInterface $file_system */
- $file_system = \Drupal::service('file_system');
- $this->image->setFilename($file_system->basename($this->image->getFileUri()));
- $this->nonImage = File::create();
- $this->nonImage->setFileUri('core/assets/vendor/jquery/jquery.min.js');
- $this->nonImage->setFilename($file_system->basename($this->nonImage->getFileUri()));
- }
- /**
- * Tests the file_validate_extensions() function.
- */
- public function testFileValidateExtensions() {
- $file = File::create(['filename' => 'asdf.txt']);
- $errors = file_validate_extensions($file, 'asdf txt pork');
- $this->assertCount(0, $errors, 'Valid extension accepted.');
- $file->setFilename('asdf.txt');
- $errors = file_validate_extensions($file, 'exe png');
- $this->assertCount(1, $errors, 'Invalid extension blocked.');
- }
- /**
- * Tests the file_validate_extensions() function.
- *
- * @param array $file_properties
- * The properties of the file being validated.
- * @param string[] $extensions
- * An array of the allowed file extensions.
- * @param string[] $expected_errors
- * The expected error messages as string.
- *
- * @dataProvider providerTestFileValidateExtensionsOnUri
- */
- public function testFileValidateExtensionsOnUri(array $file_properties, array $extensions, array $expected_errors) {
- $file = File::create($file_properties);
- $actual_errors = file_validate_extensions($file, implode(' ', $extensions));
- $actual_errors_as_string = array_map(function ($error_message) {
- return (string) $error_message;
- }, $actual_errors);
- $this->assertEquals($expected_errors, $actual_errors_as_string);
- }
- /**
- * Data provider for ::testFileValidateExtensionsOnUri.
- *
- * @return array[][]
- * The test cases.
- */
- public function providerTestFileValidateExtensionsOnUri(): array {
- $temporary_txt_file_properties = [
- 'filename' => 'asdf.txt',
- 'uri' => 'temporary://asdf',
- 'status' => 0,
- ];
- $permanent_txt_file_properties = [
- 'filename' => 'asdf.txt',
- 'uri' => 'public://asdf_0.txt',
- 'status' => 1,
- ];
- $permanent_png_file_properties = [
- 'filename' => 'The Druplicon',
- 'uri' => 'public://druplicon.png',
- 'status' => 1,
- ];
- return [
- 'Temporary txt validated with "asdf", "txt", "pork"' => [
- 'File properties' => $temporary_txt_file_properties,
- 'Allowed_extensions' => ['asdf', 'txt', 'pork'],
- 'Expected errors' => [],
- ],
- 'Temporary txt validated with "exe" and "png"' => [
- 'File properties' => $temporary_txt_file_properties,
- 'Allowed_extensions' => ['exe', 'png'],
- 'Expected errors' => [
- 'Only files with the following extensions are allowed: <em class="placeholder">exe png</em>.',
- ],
- ],
- 'Permanent txt validated with "asdf", "txt", "pork"' => [
- 'File properties' => $permanent_txt_file_properties,
- 'Allowed_extensions' => ['asdf', 'txt', 'pork'],
- 'Expected errors' => [],
- ],
- 'Permanent txt validated with "exe" and "png"' => [
- 'File properties' => $permanent_txt_file_properties,
- 'Allowed_extensions' => ['exe', 'png'],
- 'Expected errors' => [
- 'Only files with the following extensions are allowed: <em class="placeholder">exe png</em>.',
- ],
- ],
- 'Permanent png validated with "png", "gif", "jpg", "jpeg"' => [
- 'File properties' => $permanent_png_file_properties,
- 'Allowed_extensions' => ['png', 'gif', 'jpg', 'jpeg'],
- 'Expected errors' => [],
- ],
- 'Permanent png validated with "exe" and "txt"' => [
- 'File properties' => $permanent_png_file_properties,
- 'Allowed_extensions' => ['exe', 'txt'],
- 'Expected errors' => [
- 'Only files with the following extensions are allowed: <em class="placeholder">exe txt</em>.',
- ],
- ],
- ];
- }
- /**
- * This ensures a specific file is actually an image.
- */
- public function testFileValidateIsImage() {
- $this->assertFileExists($this->image->getFileUri());
- $errors = file_validate_is_image($this->image);
- $this->assertCount(0, $errors, 'No error reported for our image file.');
- $this->assertFileExists($this->nonImage->getFileUri());
- $errors = file_validate_is_image($this->nonImage);
- $this->assertCount(1, $errors, 'An error reported for our non-image file.');
- }
- /**
- * This ensures the resolution of a specific file is within bounds.
- *
- * The image will be resized if it's too large.
- */
- public function testFileValidateImageResolution() {
- // Non-images.
- $errors = file_validate_image_resolution($this->nonImage);
- $this->assertCount(0, $errors, 'Should not get any errors for a non-image file.');
- $errors = file_validate_image_resolution($this->nonImage, '50x50', '100x100');
- $this->assertCount(0, $errors, 'Do not check the resolution on non files.');
- // Minimum size.
- $errors = file_validate_image_resolution($this->image);
- $this->assertCount(0, $errors, 'No errors for an image when there is no minimum or maximum resolution.');
- $errors = file_validate_image_resolution($this->image, 0, '200x1');
- $this->assertCount(1, $errors, 'Got an error for an image that was not wide enough.');
- $errors = file_validate_image_resolution($this->image, 0, '1x200');
- $this->assertCount(1, $errors, 'Got an error for an image that was not tall enough.');
- $errors = file_validate_image_resolution($this->image, 0, '200x200');
- $this->assertCount(1, $errors, 'Small images report an error.');
- // Maximum size.
- if ($this->container->get('image.factory')->getToolkitId()) {
- // Copy the image so that the original doesn't get resized.
- copy('core/misc/druplicon.png', 'temporary://druplicon.png');
- $this->image->setFileUri('temporary://druplicon.png');
- $errors = file_validate_image_resolution($this->image, '10x5');
- $this->assertCount(0, $errors, 'No errors should be reported when an oversized image can be scaled down.');
- $image = $this->container->get('image.factory')->get($this->image->getFileUri());
- // Verify that the image was scaled to the correct width and height.
- $this->assertLessThanOrEqual(10, $image->getWidth());
- $this->assertLessThanOrEqual(5, $image->getHeight());
- // Once again, now with negative width and height to force an error.
- copy('core/misc/druplicon.png', 'temporary://druplicon.png');
- $this->image->setFileUri('temporary://druplicon.png');
- $errors = file_validate_image_resolution($this->image, '-10x-5');
- $this->assertCount(1, $errors, 'An error reported for an oversized image that can not be scaled down.');
- \Drupal::service('file_system')->unlink('temporary://druplicon.png');
- }
- else {
- // TODO: should check that the error is returned if no toolkit is available.
- $errors = file_validate_image_resolution($this->image, '5x10');
- $this->assertCount(1, $errors, 'Oversize images that cannot be scaled get an error.');
- }
- }
- /**
- * This will ensure the filename length is valid.
- */
- public function testFileValidateNameLength() {
- // Create a new file entity.
- $file = File::create();
- // Add a filename with an allowed length and test it.
- $file->setFilename(str_repeat('x', 240));
- $this->assertEquals(240, strlen($file->getFilename()));
- $errors = file_validate_name_length($file);
- $this->assertCount(0, $errors, 'No errors reported for 240 length filename.');
- // Add a filename with a length too long and test it.
- $file->setFilename(str_repeat('x', 241));
- $errors = file_validate_name_length($file);
- $this->assertCount(1, $errors, 'An error reported for 241 length filename.');
- // Add a filename with an empty string and test it.
- $file->setFilename('');
- $errors = file_validate_name_length($file);
- $this->assertCount(1, $errors, 'An error reported for 0 length filename.');
- }
- /**
- * Tests file_validate_size().
- */
- public function testFileValidateSize() {
- // Create a file with a size of 1000 bytes, and quotas of only 1 byte.
- $file = File::create(['filesize' => 1000]);
- $errors = file_validate_size($file, 0, 0);
- $this->assertCount(0, $errors, 'No limits means no errors.');
- $errors = file_validate_size($file, 1, 0);
- $this->assertCount(1, $errors, 'Error for the file being over the limit.');
- $errors = file_validate_size($file, 0, 1);
- $this->assertCount(1, $errors, 'Error for the user being over their limit.');
- $errors = file_validate_size($file, 1, 1);
- $this->assertCount(2, $errors, 'Errors for both the file and their limit.');
- }
- }