Skip to content
Snippets Groups Projects
Select Git revision
  • 4e7959f88665719b11d03c8c15d9b1f595d1e650
  • 11.x default protected
  • 11.2.x protected
  • 10.5.x protected
  • 10.6.x protected
  • 11.1.x protected
  • 10.4.x protected
  • 11.0.x protected
  • 10.3.x protected
  • 7.x protected
  • 10.2.x protected
  • 10.1.x protected
  • 9.5.x protected
  • 10.0.x protected
  • 9.4.x protected
  • 9.3.x protected
  • 9.2.x protected
  • 9.1.x protected
  • 8.9.x protected
  • 9.0.x protected
  • 8.8.x protected
  • 10.5.1 protected
  • 11.2.2 protected
  • 11.2.1 protected
  • 11.2.0 protected
  • 10.5.0 protected
  • 11.2.0-rc2 protected
  • 10.5.0-rc1 protected
  • 11.2.0-rc1 protected
  • 10.4.8 protected
  • 11.1.8 protected
  • 10.5.0-beta1 protected
  • 11.2.0-beta1 protected
  • 11.2.0-alpha1 protected
  • 10.4.7 protected
  • 11.1.7 protected
  • 10.4.6 protected
  • 11.1.6 protected
  • 10.3.14 protected
  • 10.4.5 protected
  • 11.0.13 protected
41 results

SaveUploadTest.php

Blame
  • xjm's avatar
    SA-CORE-2019-004 by alexpott, larowlan, greggles, drumm, mlhess, David_Rothstein, pwolanin
    Jess authored
    (cherry picked from commit eae8a6c1)
    4e7959f8
    History
    Code owners
    Assign users and groups as approvers for specific file changes. Learn more.
    SaveUploadTest.php 17.10 KiB
    <?php
    
    namespace Drupal\Tests\file\Functional;
    
    use Drupal\Component\Render\FormattableMarkup;
    use Drupal\Core\File\FileSystemInterface;
    use Drupal\Core\Url;
    use Drupal\file\Entity\File;
    use Drupal\Tests\TestFileCreationTrait;
    
    /**
     * Tests the file_save_upload() function.
     *
     * @group file
     */
    class SaveUploadTest extends FileManagedTestBase {
    
      use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
      }
    
      /**
       * Modules to enable.
       *
       * @var array
       */
      public static $modules = ['dblog'];
    
      /**
       * An image file path for uploading.
       *
       * @var \Drupal\file\FileInterface
       */
      protected $image;
    
      /**
       * A PHP file path for upload security testing.
       */
      protected $phpfile;
    
      /**
       * The largest file id when the test starts.
       */
      protected $maxFidBefore;
    
      /**
       * Extension of the image filename.
       *
       * @var string
       */
      protected $imageExtension;
    
      protected function setUp() {
        parent::setUp();
        $account = $this->drupalCreateUser(['access site reports']);
        $this->drupalLogin($account);
    
        $image_files = $this->drupalGetTestFiles('image');
        $this->image = File::create((array) current($image_files));
    
        list(, $this->imageExtension) = explode('.', $this->image->getFilename());
        $this->assertTrue(is_file($this->image->getFileUri()), "The image file we're going to upload exists.");
    
        $this->phpfile = current($this->drupalGetTestFiles('php'));
        $this->assertTrue(is_file($this->phpfile->uri), 'The PHP file we are going to upload exists.');
    
        $this->maxFidBefore = (int) \Drupal::entityQueryAggregate('file')->aggregate('fid', 'max')->execute()[0]['fid_max'];
    
        // Upload with replace to guarantee there's something there.
        $edit = [
          'file_test_replace' => FILE_EXISTS_REPLACE,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
        ];
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
    
        // Check that the correct hooks were called then clean out the hook
        // counters.
        $this->assertFileHooksCalled(['validate', 'insert']);
        file_test_reset();
      }
    
      /**
       * Test the file_save_upload() function.
       */
      public function testNormal() {
        $max_fid_after = (int) \Drupal::entityQueryAggregate('file')->aggregate('fid', 'max')->execute()[0]['fid_max'];
        $this->assertTrue($max_fid_after > $this->maxFidBefore, 'A new file was created.');
        $file1 = File::load($max_fid_after);
        $this->assertTrue($file1, 'Loaded the file.');
        // MIME type of the uploaded image may be either image/jpeg or image/png.
        $this->assertEqual(substr($file1->getMimeType(), 0, 5), 'image', 'A MIME type was set.');
    
        // Reset the hook counters to get rid of the 'load' we just called.
        file_test_reset();
    
        // Upload a second file.
        $image2 = current($this->drupalGetTestFiles('image'));
        $edit = ['files[file_test_upload]' => \Drupal::service('file_system')->realpath($image2->uri)];
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('You WIN!'));
        $max_fid_after = (int) \Drupal::entityQueryAggregate('file')->aggregate('fid', 'max')->execute()[0]['fid_max'];
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'insert']);
    
        $file2 = File::load($max_fid_after);
        $this->assertTrue($file2, 'Loaded the file');
        // MIME type of the uploaded image may be either image/jpeg or image/png.
        $this->assertEqual(substr($file2->getMimeType(), 0, 5), 'image', 'A MIME type was set.');
    
        // Load both files using File::loadMultiple().
        $files = File::loadMultiple([$file1->id(), $file2->id()]);
        $this->assertTrue(isset($files[$file1->id()]), 'File was loaded successfully');
        $this->assertTrue(isset($files[$file2->id()]), 'File was loaded successfully');
    
        // Upload a third file to a subdirectory.
        $image3 = current($this->drupalGetTestFiles('image'));
        $image3_realpath = \Drupal::service('file_system')->realpath($image3->uri);
        $dir = $this->randomMachineName();
        $edit = [
          'files[file_test_upload]' => $image3_realpath,
          'file_subdir' => $dir,
        ];
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('You WIN!'));
        $this->assertTrue(is_file('temporary://' . $dir . '/' . trim(\Drupal::service('file_system')->basename($image3_realpath))));
      }
    
      /**
       * Test extension handling.
       */
      public function testHandleExtension() {
        // The file being tested is a .gif which is in the default safe list
        // of extensions to allow when the extension validator isn't used. This is
        // implicitly tested at the testNormal() test. Here we tell
        // file_save_upload() to only allow ".foo".
        $extensions = 'foo';
        $edit = [
          'file_test_replace' => FILE_EXISTS_REPLACE,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
          'extensions' => $extensions,
        ];
    
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $message = t('Only files with the following extensions are allowed:') . ' <em class="placeholder">' . $extensions . '</em>';
        $this->assertRaw($message, 'Cannot upload a disallowed extension');
        $this->assertRaw(t('Epic upload FAIL!'), 'Found the failure message.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate']);
    
        // Reset the hook counters.
        file_test_reset();
    
        $extensions = 'foo ' . $this->imageExtension;
        // Now tell file_save_upload() to allow the extension of our test image.
        $edit = [
          'file_test_replace' => FILE_EXISTS_REPLACE,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
          'extensions' => $extensions,
        ];
    
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertNoRaw(t('Only files with the following extensions are allowed:'), 'Can upload an allowed extension.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'load', 'update']);
    
        // Reset the hook counters.
        file_test_reset();
    
        // Now tell file_save_upload() to allow any extension.
        $edit = [
          'file_test_replace' => FILE_EXISTS_REPLACE,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
          'allow_all_extensions' => TRUE,
        ];
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertNoRaw(t('Only files with the following extensions are allowed:'), 'Can upload any extension.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'load', 'update']);
      }
    
      /**
       * Test dangerous file handling.
       */
      public function testHandleDangerousFile() {
        $config = $this->config('system.file');
        // Allow the .php extension and make sure it gets renamed to .txt for
        // safety. Also check to make sure its MIME type was changed.
        $edit = [
          'file_test_replace' => FILE_EXISTS_REPLACE,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->phpfile->uri),
          'is_image_file' => FALSE,
          'extensions' => 'php',
        ];
    
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $message = t('For security reasons, your upload has been renamed to') . ' <em class="placeholder">' . $this->phpfile->filename . '.txt' . '</em>';
        $this->assertRaw($message, 'Dangerous file was renamed.');
        $this->assertSession()->pageTextContains('File name is php-2.php.txt.');
        $this->assertRaw(t('File MIME type is text/plain.'), "Dangerous file's MIME type was changed.");
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'insert']);
    
        // Ensure dangerous files are not renamed when insecure uploads is TRUE.
        // Turn on insecure uploads.
        $config->set('allow_insecure_uploads', 1)->save();
        // Reset the hook counters.
        file_test_reset();
    
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertNoRaw(t('For security reasons, your upload has been renamed'), 'Found no security message.');
        $this->assertSession()->pageTextContains('File name is php-2.php.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'insert']);
    
        // Turn off insecure uploads.
        $config->set('allow_insecure_uploads', 0)->save();
      }
    
      /**
       * Test file munge handling.
       */
      public function testHandleFileMunge() {
        // Ensure insecure uploads are disabled for this test.
        $this->config('system.file')->set('allow_insecure_uploads', 0)->save();
        $this->image = file_move($this->image, $this->image->getFileUri() . '.foo.' . $this->imageExtension);
    
        // Reset the hook counters to get rid of the 'move' we just called.
        file_test_reset();
    
        $extensions = $this->imageExtension;
        $edit = [
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
          'extensions' => $extensions,
        ];
    
        $munged_filename = $this->image->getFilename();
        $munged_filename = substr($munged_filename, 0, strrpos($munged_filename, '.'));
        $munged_filename .= '_.' . $this->imageExtension;
    
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('For security reasons, your upload has been renamed'), 'Found security message.');
        $this->assertRaw(t('File name is @filename', ['@filename' => $munged_filename]), 'File was successfully munged.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'insert']);
    
        // Ensure we don't munge files if we're allowing any extension.
        // Reset the hook counters.
        file_test_reset();
    
        $edit = [
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
          'allow_all_extensions' => TRUE,
        ];
    
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertNoRaw(t('For security reasons, your upload has been renamed'), 'Found no security message.');
        $this->assertRaw(t('File name is @filename', ['@filename' => $this->image->getFilename()]), 'File was not munged when allowing any extension.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'insert']);
      }
    
      /**
       * Test renaming when uploading over a file that already exists.
       */
      public function testExistingRename() {
        $edit = [
          'file_test_replace' => FileSystemInterface::EXISTS_RENAME,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
        ];
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
        $this->assertSession()->pageTextContains('File name is image-test_0.png.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'insert']);
      }
    
      /**
       * Test replacement when uploading over a file that already exists.
       */
      public function testExistingReplace() {
        $edit = [
          'file_test_replace' => FILE_EXISTS_REPLACE,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
        ];
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('You WIN!'), 'Found the success message.');
        $this->assertSession()->pageTextContains('File name is image-test.png.');
    
        // Check that the correct hooks were called.
        $this->assertFileHooksCalled(['validate', 'load', 'update']);
      }
    
      /**
       * Test for failure when uploading over a file that already exists.
       */
      public function testExistingError() {
        $edit = [
          'file_test_replace' => FILE_EXISTS_ERROR,
          'files[file_test_upload]' => \Drupal::service('file_system')->realpath($this->image->getFileUri()),
        ];
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('Epic upload FAIL!'), 'Found the failure message.');
    
        // Check that the no hooks were called while failing.
        $this->assertFileHooksCalled([]);
      }
    
      /**
       * Test for no failures when not uploading a file.
       */
      public function testNoUpload() {
        $this->drupalPostForm('file-test/upload', [], t('Submit'));
        $this->assertNoRaw(t('Epic upload FAIL!'), 'Failure message not found.');
      }
    
      /**
       * Tests for log entry on failing destination.
       */
      public function testDrupalMovingUploadedFileError() {
        // Create a directory and make it not writable.
        $test_directory = 'test_drupal_move_uploaded_file_fail';
        /** @var \Drupal\Core\File\FileSystemInterface $file_system */
        $file_system = \Drupal::service('file_system');
        $file_system->mkdir('temporary://' . $test_directory, 0000);
        $this->assertTrue(is_dir('temporary://' . $test_directory));
    
        $edit = [
          'file_subdir' => $test_directory,
          'files[file_test_upload]' => $file_system->realpath($this->image->getFileUri()),
        ];
    
        \Drupal::state()->set('file_test.disable_error_collection', TRUE);
        $this->drupalPostForm('file-test/upload', $edit, t('Submit'));
        $this->assertResponse(200, 'Received a 200 response for posted test file.');
        $this->assertRaw(t('File upload error. Could not move uploaded file.'), 'Found the failure message.');
        $this->assertRaw(t('Epic upload FAIL!'), 'Found the failure message.');
    
        // Uploading failed. Now check the log.
        $this->drupalGet('admin/reports/dblog');
        $this->assertResponse(200);
        $this->assertRaw(t('Upload error. Could not move uploaded file @file to destination @destination.', [
          '@file' => $this->image->getFilename(),
          '@destination' => 'temporary://' . $test_directory . '/' . $this->image->getFilename(),
        ]), 'Found upload error log entry.');
      }
    
      /**
       * Tests that filenames containing invalid UTF-8 are rejected.
       */
      public function testInvalidUtf8FilenameUpload() {
        $this->drupalGet('file-test/upload');
    
        // Filename containing invalid UTF-8.
        $filename = "x\xc0xx.gif";
    
        $page = $this->getSession()->getPage();
        $data = [
          'multipart' => [
            [
              'name'     => 'file_test_replace',
              'contents' => FileSystemInterface::EXISTS_RENAME,
            ],
            [
              'name' => 'form_id',
              'contents' => '_file_test_form',
            ],
            [
              'name' => 'form_build_id',
              'contents' => $page->find('hidden_field_selector', ['hidden_field', 'form_build_id'])->getAttribute('value'),
            ],
            [
              'name' => 'form_token',
              'contents' => $page->find('hidden_field_selector', ['hidden_field', 'form_token'])->getAttribute('value'),
            ],
            [
              'name' => 'op',
              'contents' => 'Submit',
            ],
            [
              'name'     => 'files[file_test_upload]',
              'contents' => 'Test content',
              'filename' => $filename,
            ],
          ],
          'cookies' => $this->getSessionCookies(),
          'http_errors' => FALSE,
        ];
    
        $this->assertFileNotExists('temporary://' . $filename);
        // Use Guzzle's HTTP client directly so we can POST files without having to
        // write them to disk. Not all filesystem support writing files with invalid
        // UTF-8 filenames.
        $response = $this->getHttpClient()->request('POST', Url::fromUri('base:file-test/upload')->setAbsolute()->toString(), $data);
    
        $content = (string) $response->getBody();
        $this->htmlOutput($content);
        $error_text = new FormattableMarkup('The file %filename could not be uploaded because the name is invalid.', ['%filename' => $filename]);
        $this->assertContains((string) $error_text, $content);
        $this->assertContains('Epic upload FAIL!', $content);
        $this->assertFileNotExists('temporary://' . $filename);
      }
    
    }