webform = Webform::load('test_element_managed_file');
$this->adminSubmissionUser = $this->drupalCreateUser([
'administer webform submission',
]);
}
/**
* Test single and multiple file upload.
*/
public function testFileUpload(): void {
$assert_session = $this->assertSession();
/* Element rendering */
$this->drupalGet('/webform/test_element_managed_file');
// Check single file upload button.
$assert_session->responseContains('Choose file ');
// Check multiple file upload button.
$assert_session->responseContains('Choose files ');
// Check single custom file upload button.
$assert_session->responseContains('{Custom label} ');
// Check comma delimited file extensions.
$assert_session->responseContains('Allowed types: txt text.');
/* Element processing */
$this->checkFileUpload('single', $this->files[0], $this->files[1]);
$this->checkFileUpload('multiple', $this->files[2], $this->files[3]);
/* Multiple processing */
// Check file input is visible.
$this->drupalGet('/webform/test_element_managed_file');
$assert_session->fieldExists('files[managed_file_multiple_two][]');
$assert_session->buttonExists('managed_file_multiple_two_upload_button');
// phpcs:disable
// Check that only two files can be uploaded.
// @todo Determine how to submit multiple files.
/*
$edit = [
'files[managed_file_multiple_two][]' => [
\Drupal::service('file_system')->realpath($this->files[0]->uri),
\Drupal::service('file_system')->realpath($this->files[1]->uri),
\Drupal::service('file_system')->realpath($this->files[2]->uri),
],
];
$this->drupalGet('/webform/test_element_managed_file');
$this->submitForm($edit, 'Upload');
$assert_session->responseContains('managed_file_multiple_two can only hold 2 values but there were 3 uploaded. The following files have been omitted as a result: text-2.txt .');
// Check file input is removed.
$assert_session->fieldNotExists('files[managed_file_multiple_two][]');
$assert_session->fieldNotExists('managed_file_multiple_two_upload_button');
*/
// phpcs:enable
/* File placeholder */
// Check placeholder is displayed.
$this->drupalGet('/webform/test_element_managed_file');
$assert_session->responseContains('This is the single file upload placeholder
');
$assert_session->responseContains('This is the multiple file upload placeholder
');
$this->drupalLogin($this->rootUser);
// Check placeholder is not displayed when files are uploaded.
$this->drupalGet('/webform/test_element_managed_file/test');
$assert_session->responseNotContains('This is the single file upload placeholder
');
$assert_session->responseNotContains('This is the multiple file upload placeholder
');
$this->drupalLogout();
/* Required error */
// Set required error.
/** @var \Drupal\webform\WebformInterface $webform */
$webform = Webform::load('test_element_managed_file');
$webform->setElementProperties('managed_file_single', $webform->getElementDecoded('managed_file_single') + [
'#required' => TRUE,
'#required_error' => '{Custom required error}',
]);
$webform->save();
// Check that required error is displayed.
$this->postSubmission($webform);
$assert_session->responseContains('Error message ');
$assert_session->responseContains('{Custom required error}');
}
/**
* Test managed file tamper protection.
*/
public function testFileUploadTampering(): void {
$webform = Webform::load('test_element_managed_file');
// Check that a tampered hidden fid is not saved to the submission.
$this->drupalGet('/webform/test_element_managed_file');
$this->submitForm([
'files[managed_file_single]' => \Drupal::service('file_system')->realpath($this->files[0]->uri),
], 'Upload');
$tampered_file = $this->createPermanentManagedFile($this->files[1]->uri);
$tampered_fid = (int) $tampered_file->id();
$this->getSession()
->getPage()
->find('css', 'input[name="managed_file_single[fids]"]')
->setValue((string) $tampered_fid);
$this->submitForm([], 'Submit');
$this->assertSession()->responseContains('The uploaded file is invalid.');
$this->assertEmpty($this->getLastSubmissionId($webform));
// Check that a tampered temporary fid is not displayed after an upload.
$tampered_file = File::create([
'uri' => $this->files[1]->uri,
'filename' => basename($this->files[1]->uri),
'uid' => 0,
'status' => 0,
]);
$tampered_file->setTemporary();
$tampered_file->save();
$tampered_fid = (int) $tampered_file->id();
$this->drupalGet('/webform/test_element_managed_file');
$this->getSession()
->getPage()
->find('css', 'input[name="managed_file_multiple[fids]"]')
->setValue((string) $tampered_fid);
$this->submitForm([
'files[managed_file_multiple][]' => \Drupal::service('file_system')->realpath($this->files[0]->uri),
], 'Upload');
// Check that the tampered temporary file is not displayed.
$this->assertSession()->responseNotContains($tampered_file->getFilename());
}
/**
* Test the file renaming feature.
*
* The property #file_name_pattern is tested.
*/
public function testFileRename(): void {
$webform = Webform::load('test_element_managed_file_name');
$source_for_filename = $this->randomMachineName();
$sid = $this->postSubmission($webform, [
'source_for_filename' => $source_for_filename,
'files[file_single]' => \Drupal::service('file_system')->realpath($this->files[0]->uri),
'files[file_multiple][]' => \Drupal::service('file_system')->realpath($this->files[0]->uri),
'files[file_truncate]' => \Drupal::service('file_system')->realpath($this->files[0]->uri),
]);
$this->drupalLogin($this->adminSubmissionUser);
// Edit the submission and insert 1 extra file into the multiple element.
$this->drupalGet('/webform/' . $webform->id() . '/submissions/' . $sid . '/edit');
$edit = ['files[file_multiple][]' => \Drupal::service('file_system')->realpath($this->files[1]->uri)];
$this->submitForm($edit, 'Save');
$this->drupalLogout();
/** @var \Drupal\webform\WebformSubmissionInterface $submission */
$submission = WebformSubmission::load($sid);
/** @var \Drupal\file\FileInterface $single_file */
$single_file = File::load($submission->getElementData('file_single'));
$this->assertEquals('file_single_' . $source_for_filename . '.txt', $single_file->getFilename());
/** @var \Drupal\file\FileInterface[] $multiple_file */
$multiple_file = File::loadMultiple($submission->getElementData('file_multiple'));
$this->assertCount(2, $multiple_file, 'Two files found in the multiple element.');
$i = -1;
foreach ($multiple_file as $file) {
$suffix = $i === -1 ? '' : '_' . $i;
$this->assertEquals('file_multiple_' . $source_for_filename . $suffix . '.txt', $file->getFilename());
$i++;
}
/** @var \Drupal\file\FileInterface $truncate_file */
$truncate_file = File::load($submission->getElementData('file_truncate'));
$this->assertEquals(strlen($truncate_file->getFileUri()), 250);
$this->assertEquals('file_truncate_1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901.txt', $truncate_file->getFilename());
}
/**
* Test file management.
*/
public function testFileManagement(): void {
$this->drupalLogin($this->rootUser);
$webform = Webform::load('test_element_managed_file');
/* ********************************************************************** */
// Test immediately delete file.
/* ********************************************************************** */
// Upload files.
$sid = $this->postSubmissionTest($webform);
/** @var \Drupal\webform\WebformSubmissionInterface $submission */
$submission = WebformSubmission::load($sid);
$managed_file_single = $this->fileLoad($submission->getElementData('managed_file_single'));
// Check single file is not temporary.
$this->debug($submission->getData());
$this->assertNotNull($managed_file_single);
$this->assertFalse($managed_file_single->isTemporary());
// Check deleting file completely deletes the file record.
$submission->delete();
$managed_file_single = $this->fileLoad($submission->getElementData('managed_file_single'));
$this->assertNull($managed_file_single);
/* ********************************************************************** */
// Test disabling immediately deleted temporary managed files.
/* ********************************************************************** */
// Disable deleting of temporary files.
$config = \Drupal::configFactory()->getEditable('webform.settings');
$config->set('file.delete_temporary_managed_files', FALSE);
$config->save();
// Upload files.
$sid = $this->postSubmissionTest($webform);
$submission = WebformSubmission::load($sid);
// Check deleting file completely deletes the file record.
$submission->delete();
$managed_file_single = $this->fileLoad($submission->getElementData('managed_file_single'));
$this->assertNotNull($managed_file_single);
$this->assertTrue($managed_file_single->isTemporary());
/* ********************************************************************** */
// Test disabling unused files marked temporary.
/* ********************************************************************** */
// Disable deleting of temporary files.
$config = \Drupal::configFactory()->getEditable('webform.settings');
$config->set('file.make_unused_managed_files_temporary', FALSE);
$config->save();
// Upload files.
$sid = $this->postSubmissionTest($webform);
$submission = WebformSubmission::load($sid);
// Check deleting file completely deletes the file record.
$submission->delete();
$managed_file_single = $this->fileLoad($submission->getElementData('managed_file_single'));
$this->assertNotNull($managed_file_single);
$this->assertFalse($managed_file_single->isTemporary());
}
/**
* Test file upload with disabled results.
*/
public function testFileUploadWithDisabledResults(): void {
$this->drupalLogin($this->rootUser);
$webform = Webform::load('test_element_managed_file_dis');
// Upload new file.
$sid = $this->postSubmissionTest($webform);
$file = File::load($this->getLastFileId());
// Check that no submission was saved to the database.
$this->assertNull($sid);
// Check file URI.
$this->assertEquals($file->getFileUri(), 'private://webform/test_element_managed_file_dis/_sid_/managed_file.txt');
// Check file is temporary.
$this->assertTrue($file->isTemporary());
// Check file_managed table has 1 record.
$this->assertEquals(1, \Drupal::database()->query('SELECT COUNT(fid) AS total FROM {file_managed}')->fetchField());
// Check file_usage table has no records.
$this->assertEquals(0, \Drupal::database()->query('SELECT COUNT(fid) AS total FROM {file_usage}')->fetchField());
}
/**
* Test that browser-renderable file types are downloaded.
*/
public function testFileDownloadMimeTypes() {
$this->drupalLogin($this->rootUser);
$webform = Webform::load('test_element_managed_file');
$sid = $this->postSubmissionTest($webform);
$submission = WebformSubmission::load($sid);
$download_files = [
'application/xhtml+xml' => $this->createSubmissionFile('test.xhtml', 'Test XHTML', $submission),
'application/rdf+xml' => $this->createSubmissionFile('test.rdf', 'managed_file_multiple ');
$assert_session->responseContains('');
}
$assert_session->responseContains('' . $file->getFilename() . '