2009-08-29 12:52:32 +00:00
<?php
/**
* @file
* Defines a "managed_file" Form API field and a "file" field for Field module.
*/
2019-07-31 07:44:23 +00:00
use Drupal\Component\Utility\Environment;
2021-10-15 08:01:34 +00:00
use Drupal\Component\Utility\NestedArray;
Issue #2525910 by dawehner, effulgentsia, Berdir, lauriii, larowlan, timmillwood, Wim Leers, chx, arlinsandbulte, Fabianx, Gábor Hojtsy, Dave Reid, alexpott, catch: Ensure token replacements have cacheability + attachments metadata and that it is bubbled in any case
2015-07-22 14:16:01 +00:00
use Drupal\Core\Datetime\Entity\DateFormat;
2021-10-15 08:01:34 +00:00
use Drupal\Core\Entity\EntityStorageInterface;
2014-05-15 17:26:18 +00:00
use Drupal\Core\Field\FieldDefinitionInterface;
Issue #2244513 by kim.pepper, phenaproxima, 20th, andrei.dincu, beejeebus, Berdir, alexpott, jibran, andypost, larowlan, Chadwick Wood, acbramley, Wim Leers, sun, xjm, YesCT, chx, tim.plunkett: Move the unmanaged file APIs to the file_system service (file.inc)
2019-02-23 22:35:15 +00:00
use Drupal\Core\File\Exception\FileException;
2021-10-15 08:01:34 +00:00
use Drupal\Core\File\Exception\FileExistsException;
use Drupal\Core\File\Exception\FileWriteException;
use Drupal\Core\File\Exception\InvalidStreamWrapperException;
Issue #2244513 by kim.pepper, phenaproxima, 20th, andrei.dincu, beejeebus, Berdir, alexpott, jibran, andypost, larowlan, Chadwick Wood, acbramley, Wim Leers, sun, xjm, YesCT, chx, tim.plunkett: Move the unmanaged file APIs to the file_system service (file.inc)
2019-02-23 22:35:15 +00:00
use Drupal\Core\File\FileSystemInterface;
2014-07-31 00:50:42 +00:00
use Drupal\Core\Form\FormStateInterface;
2021-10-15 08:01:34 +00:00
use Drupal\Core\Link;
2018-05-01 09:15:07 +00:00
use Drupal\Core\Messenger\MessengerInterface;
Issue #2525910 by dawehner, effulgentsia, Berdir, lauriii, larowlan, timmillwood, Wim Leers, chx, arlinsandbulte, Fabianx, Gábor Hojtsy, Dave Reid, alexpott, catch: Ensure token replacements have cacheability + attachments metadata and that it is bubbled in any case
2015-07-22 14:16:01 +00:00
use Drupal\Core\Render\BubbleableMetadata;
2014-03-31 17:37:55 +00:00
use Drupal\Core\Render\Element;
2014-06-30 03:33:08 +00:00
use Drupal\Core\Routing\RouteMatchInterface;
2021-10-15 08:01:34 +00:00
use Drupal\Core\Template\Attribute;
2014-11-04 08:30:21 +00:00
use Drupal\Core\Url;
2013-08-18 21:16:19 +00:00
use Drupal\file\Entity\File;
2014-07-12 05:42:35 +00:00
use Drupal\file\FileInterface;
2021-10-15 08:01:34 +00:00
use Drupal\file\Upload\FileValidationException;
2021-10-24 20:19:20 +00:00
use Drupal\file\Upload\FormUploadedFile;
2021-10-15 08:01:34 +00:00
use Symfony\Component\HttpFoundation\File\Exception\FileException as SymfonyFileException;
use Symfony\Component\HttpFoundation\File\Exception\FormSizeFileException;
use Symfony\Component\HttpFoundation\File\Exception\IniSizeFileException;
use Symfony\Component\HttpFoundation\File\Exception\NoFileException;
use Symfony\Component\HttpFoundation\File\Exception\PartialFileException;
2012-05-16 03:38:40 +00:00
2022-01-01 13:52:01 +00:00
// cspell:ignore abiword
2010-01-28 13:56:25 +00:00
// Load all Field module hooks for File.
2013-05-09 09:25:10 +00:00
require_once __DIR__ . '/file.field.inc';
2010-01-28 13:56:25 +00:00
2009-12-12 23:04:57 +00:00
/**
* Implements hook_help().
*/
2014-06-30 03:33:08 +00:00
function file_help($route_name, RouteMatchInterface $route_match) {
2014-05-07 02:04:53 +00:00
switch ($route_name) {
case 'help.page.file':
2009-12-12 23:04:57 +00:00
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
2019-04-16 05:38:27 +00:00
$output .= '<p>' . t('The File module allows you to create fields that contain files. See the <a href=":field">Field module help</a> and the <a href=":field_ui">Field UI help</a> pages for general information on fields and how to create and manage them. For more information, see the <a href=":file_documentation">online documentation for the File module</a>.', [':field' => Url::fromRoute('help.page', ['name' => 'field'])->toString(), ':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? Url::fromRoute('help.page', ['name' => 'field_ui'])->toString() : '#', ':file_documentation' => 'https://www.drupal.org/documentation/modules/file']) . '</p>';
2009-12-12 23:04:57 +00:00
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
2013-12-04 00:56:31 +00:00
$output .= '<dt>' . t('Managing and displaying file fields') . '</dt>';
2019-04-16 05:38:27 +00:00
$output .= '<dd>' . t('The <em>settings</em> and the <em>display</em> of the file field can be configured separately. See the <a href=":field_ui">Field UI help</a> for more information on how to manage fields and their display.', [':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? Url::fromRoute('help.page', ['name' => 'field_ui'])->toString() : '#']) . '</dd>';
2013-12-04 00:56:31 +00:00
$output .= '<dt>' . t('Allowing file extensions') . '</dt>';
$output .= '<dd>' . t('In the field settings, you can define the allowed file extensions (for example <em>pdf docx psd</em>) for the files that will be uploaded with the file field.') . '</dd>';
2016-04-29 09:05:19 +00:00
$output .= '<dt>' . t('Storing files') . '</dt>';
2019-04-16 05:38:27 +00:00
$output .= '<dd>' . t('Uploaded files can either be stored as <em>public</em> or <em>private</em>, depending on the <a href=":file-system">File system settings</a>. For more information, see the <a href=":system-help">System module help page</a>.', [':file-system' => Url::fromRoute('system.file_system_settings')->toString(), ':system-help' => Url::fromRoute('help.page', ['name' => 'system'])->toString()]) . '</dd>';
2013-12-04 00:56:31 +00:00
$output .= '<dt>' . t('Restricting the maximum file size') . '</dt>';
$output .= '<dd>' . t('The maximum file size that users can upload is limited by PHP settings of the server, but you can restrict by entering the desired value as the <em>Maximum upload size</em> setting. The maximum file size is automatically displayed to users in the help text of the file field.') . '</dd>';
$output .= '<dt>' . t('Displaying files and descriptions') . '<dt>';
$output .= '<dd>' . t('In the field settings, you can allow users to toggle whether individual files are displayed. In the display settings, you can then choose one of the following formats: <ul><li><em>Generic file</em> displays links to the files and adds icons that symbolize the file extensions. If <em>descriptions</em> are enabled and have been submitted, then the description is displayed instead of the file name.</li><li><em>URL to file</em> displays the full path to the file as plain text.</li><li><em>Table of files</em> lists links to the files and the file sizes in a table.</li><li><em>RSS enclosure</em> only displays the first file, and only in a RSS feed, formatted according to the RSS 2.0 syntax for enclosures.</li></ul> A file can still be linked to directly by its URI even if it is not displayed.') . '</dd>';
2009-12-12 23:04:57 +00:00
$output .= '</dl>';
return $output;
}
}
Issue #2825487 by damiankloip, Wim Leers, garphy, cburschka, tedbow, dpovshed, tstoeckler, Munavijayalakshmi, Berdir, dawehner, e0ipso: Fix normalization of File entities: file entities should expose the file URL as a computed property on the 'uri' base field
2017-12-20 22:14:36 +00:00
/**
* Implements hook_field_widget_info_alter().
*/
function file_field_widget_info_alter(array &$info) {
// Allows using the 'uri' widget for the 'file_uri' field type, which uses it
// as the default widget.
// @see \Drupal\file\Plugin\Field\FieldType\FileUriItem
$info['uri']['field_types'][] = 'file_uri';
}
2012-08-31 01:27:21 +00:00
/**
* Checks that a file meets the criteria specified by the validators.
*
* After executing the validator callbacks specified hook_file_validate() will
* also be called to allow other modules to report errors about the file.
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-08-31 01:27:21 +00:00
* A file entity.
2015-06-12 14:46:25 +00:00
* @param array $validators
2016-02-17 01:46:07 +00:00
* (optional) An associative array of callback functions used to validate
* the file. The keys are function names and the values arrays of callback
* parameters which will be passed in after the file entity. The functions
* should return an array of error messages; an empty array indicates that
* the file passed validation. The callback functions will be called in the
* order specified in the array, then the hook hook_file_validate()
* will be invoked so other modules can validate the new file.
2012-08-31 01:27:21 +00:00
*
2015-06-12 14:46:25 +00:00
* @return array
2012-08-31 01:27:21 +00:00
* An array containing validation error messages.
*
* @see hook_file_validate()
*/
2017-03-04 01:20:24 +00:00
function file_validate(FileInterface $file, $validators = []) {
2012-08-31 01:27:21 +00:00
// Call the validation functions specified by this function's caller.
2017-03-04 01:20:24 +00:00
$errors = [];
2012-08-31 01:27:21 +00:00
foreach ($validators as $function => $args) {
if (function_exists($function)) {
array_unshift($args, $file);
$errors = array_merge($errors, call_user_func_array($function, $args));
}
}
// Let other modules perform validation on the new file.
SA-CORE-2020-012 by ufku, mrf, fgm, samuel.mortenson, dww, Heine, mlhess, David_Rothstein, pwolanin, xjm, fgm, stefan.r, dsnopek, rickmanelius, David Strauss, tedbow, alexpott, dww, larowlan, kim.pepper, Wim Leers, quicksketch, mcdruid, Fabianx, effulgentsia, drumm, pandaski, Mixologic
2020-11-17 22:16:53 +00:00
$errors = array_merge($errors, \Drupal::moduleHandler()->invokeAll('file_validate', [$file]));
// Ensure the file does not contain a malicious extension. At this point
2022-02-14 17:04:27 +00:00
// \Drupal\file\Upload\FileUploadHandler::handleFileUpload() will have munged
// the file so it does not contain a malicious extension. Contributed and
// custom code that calls this method needs to take similar steps if they need
// to permit files with malicious extensions to be uploaded.
Issue #3032390 by alexpott, dww, Pancho, 3CWebDev, kim.pepper, larowlan, Berdir, catch, andypost, chr.fritsch, Wim Leers: Add an event to sanitize filenames during upload
2021-02-24 16:02:18 +00:00
if (empty($errors) && !\Drupal::config('system.file')->get('allow_insecure_uploads') && preg_match(FileSystemInterface::INSECURE_EXTENSION_REGEX, $file->getFilename())) {
SA-CORE-2020-012 by ufku, mrf, fgm, samuel.mortenson, dww, Heine, mlhess, David_Rothstein, pwolanin, xjm, fgm, stefan.r, dsnopek, rickmanelius, David Strauss, tedbow, alexpott, dww, larowlan, kim.pepper, Wim Leers, quicksketch, mcdruid, Fabianx, effulgentsia, drumm, pandaski, Mixologic
2020-11-17 22:16:53 +00:00
$errors[] = t('For security reasons, your upload has been rejected.');
}
return $errors;
2012-08-31 01:27:21 +00:00
}
/**
* Checks for files with names longer than can be stored in the database.
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-08-31 01:27:21 +00:00
* A file entity.
*
2015-06-12 14:46:25 +00:00
* @return array
2016-02-17 01:46:07 +00:00
* An empty array if the file name length is smaller than the limit or an
* array containing an error message if it's not or is empty.
2012-08-31 01:27:21 +00:00
*/
2014-07-12 05:42:35 +00:00
function file_validate_name_length(FileInterface $file) {
2017-03-04 01:20:24 +00:00
$errors = [];
2012-08-31 01:27:21 +00:00
2013-06-15 08:46:11 +00:00
if (!$file->getFilename()) {
2012-08-31 01:27:21 +00:00
$errors[] = t("The file's name is empty. Please give a name to the file.");
}
2013-06-15 08:46:11 +00:00
if (strlen($file->getFilename()) > 240) {
2012-08-31 01:27:21 +00:00
$errors[] = t("The file's name exceeds the 240 characters limit. Please rename the file and try again.");
}
return $errors;
}
/**
* Checks that the filename ends with an allowed extension.
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-08-31 01:27:21 +00:00
* A file entity.
2015-06-12 14:46:25 +00:00
* @param string $extensions
2012-08-31 01:27:21 +00:00
* A string with a space separated list of allowed extensions.
*
2015-06-12 14:46:25 +00:00
* @return array
2016-02-17 01:46:07 +00:00
* An empty array if the file extension is allowed or an array containing an
* error message if it's not.
2012-08-31 01:27:21 +00:00
*
* @see hook_file_validate()
*/
2014-07-12 05:42:35 +00:00
function file_validate_extensions(FileInterface $file, $extensions) {
2017-03-04 01:20:24 +00:00
$errors = [];
2012-08-31 01:27:21 +00:00
$regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
2021-07-09 05:20:56 +00:00
// Filename may differ from the basename, for instance in case files migrated
// from D7 file entities. Because of that new files are saved temporarily with
// a generated file name, without the original extension, we will use the
// generated filename property for extension validation only in case of
// temporary files; and use the file system file name in case of permanent
// files.
$subject = $file->isTemporary() ? $file->getFilename() : $file->getFileUri();
if (!preg_match($regex, $subject)) {
2017-03-04 01:20:24 +00:00
$errors[] = t('Only files with the following extensions are allowed: %files-allowed.', ['%files-allowed' => $extensions]);
2012-08-31 01:27:21 +00:00
}
return $errors;
}
/**
* Checks that the file's size is below certain limits.
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-08-31 01:27:21 +00:00
* A file entity.
2015-06-12 14:46:25 +00:00
* @param int $file_limit
2016-02-17 01:46:07 +00:00
* (optional) The maximum file size in bytes. Zero (the default) indicates
* that no limit should be enforced.
2015-06-12 14:46:25 +00:00
* @param int $user_limit
2016-02-17 01:46:07 +00:00
* (optional) The maximum number of bytes the user is allowed. Zero (the
* default) indicates that no limit should be enforced.
2012-08-31 01:27:21 +00:00
*
2015-06-12 14:46:25 +00:00
* @return array
2016-02-17 01:46:07 +00:00
* An empty array if the file size is below limits or an array containing an
* error message if it's not.
2012-08-31 01:27:21 +00:00
*
* @see hook_file_validate()
*/
2014-07-12 05:42:35 +00:00
function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = 0) {
2013-09-16 03:58:06 +00:00
$user = \Drupal::currentUser();
2017-03-04 01:20:24 +00:00
$errors = [];
2012-08-31 01:27:21 +00:00
2013-06-15 08:46:11 +00:00
if ($file_limit && $file->getSize() > $file_limit) {
2017-03-04 01:20:24 +00:00
$errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', ['%filesize' => format_size($file->getSize()), '%maxsize' => format_size($file_limit)]);
2012-09-18 14:06:55 +00:00
}
2012-08-31 01:27:21 +00:00
2012-11-17 02:09:54 +00:00
// Save a query by only calling spaceUsed() when a limit is provided.
2019-05-24 06:44:36 +00:00
if ($user_limit && (\Drupal::entityTypeManager()->getStorage('file')->spaceUsed($user->id()) + $file->getSize()) > $user_limit) {
2017-03-04 01:20:24 +00:00
$errors[] = t('The file is %filesize which would exceed your disk quota of %quota.', ['%filesize' => format_size($file->getSize()), '%quota' => format_size($user_limit)]);
2012-08-31 01:27:21 +00:00
}
2012-09-22 01:04:45 +00:00
2012-08-31 01:27:21 +00:00
return $errors;
}
/**
2014-06-09 14:48:54 +00:00
* Checks that the file is recognized as a valid image.
2012-08-31 01:27:21 +00:00
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-08-31 01:27:21 +00:00
* A file entity.
*
2015-06-12 14:46:25 +00:00
* @return array
2016-02-17 01:46:07 +00:00
* An empty array if the file is a valid image or an array containing an error
* message if it's not.
2012-08-31 01:27:21 +00:00
*
* @see hook_file_validate()
*/
2014-07-12 05:42:35 +00:00
function file_validate_is_image(FileInterface $file) {
2017-03-04 01:20:24 +00:00
$errors = [];
2012-08-31 01:27:21 +00:00
2014-06-09 14:48:54 +00:00
$image_factory = \Drupal::service('image.factory');
$image = $image_factory->get($file->getFileUri());
if (!$image->isValid()) {
$supported_extensions = $image_factory->getSupportedExtensions();
Issue #2377747 by mondrake, eiriksm, rpayanm, adci_contributor, mgifford, oakulm, Truptti, chetan2111, joyceg, alexpott, xjm, yoroy, catch: Incorrect node create validation error when an invalid image is attached to a field
2018-01-04 11:42:56 +00:00
$errors[] = t('The image file is invalid or the image type is not allowed. Allowed types: %types', ['%types' => implode(', ', $supported_extensions)]);
2012-08-31 01:27:21 +00:00
}
return $errors;
}
/**
* Verifies that image dimensions are within the specified maximum and minimum.
*
2015-10-05 01:07:03 +00:00
* Non-image files will be ignored. If an image toolkit is available the image
2012-08-31 01:27:21 +00:00
* will be scaled to fit within the desired maximum dimensions.
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-08-31 01:27:21 +00:00
* A file entity. This function may resize the file affecting its size.
2016-02-17 01:46:07 +00:00
* @param string|int $maximum_dimensions
* (optional) A string in the form WIDTHxHEIGHT; for example, '640x480' or
* '85x85'. If an image toolkit is installed, the image will be resized down
* to these dimensions. A value of zero (the default) indicates no restriction
* on size, so no resizing will be attempted.
* @param string|int $minimum_dimensions
* (optional) A string in the form WIDTHxHEIGHT. This will check that the
* image meets a minimum size. A value of zero (the default) indicates that
* there is no restriction on size.
2012-08-31 01:27:21 +00:00
*
2016-02-17 01:46:07 +00:00
* @return array
* An empty array if the file meets the specified dimensions, was resized
* successfully to meet those requirements or is not an image. If the image
* does not meet the requirements or an attempt to resize it fails, an array
* containing the error message will be returned.
2012-08-31 01:27:21 +00:00
*
* @see hook_file_validate()
*/
2014-07-12 05:42:35 +00:00
function file_validate_image_resolution(FileInterface $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
2017-03-04 01:20:24 +00:00
$errors = [];
2012-08-31 01:27:21 +00:00
// Check first that the file is an image.
2013-09-16 03:58:06 +00:00
$image_factory = \Drupal::service('image.factory');
2013-08-10 23:57:37 +00:00
$image = $image_factory->get($file->getFileUri());
2017-12-02 12:47:22 +00:00
2014-06-09 14:48:54 +00:00
if ($image->isValid()) {
2017-12-02 12:47:22 +00:00
$scaling = FALSE;
2012-08-31 01:27:21 +00:00
if ($maximum_dimensions) {
// Check that it is smaller than the given dimensions.
2021-11-15 02:35:55 +00:00
[$width, $height] = explode('x', $maximum_dimensions);
2013-08-10 23:57:37 +00:00
if ($image->getWidth() > $width || $image->getHeight() > $height) {
2012-08-31 01:27:21 +00:00
// Try to resize the image to fit the dimensions.
2014-06-09 14:48:54 +00:00
if ($image->scale($width, $height)) {
2017-12-02 12:47:22 +00:00
$scaling = TRUE;
2013-08-10 23:57:37 +00:00
$image->save();
2016-07-19 14:59:05 +00:00
if (!empty($width) && !empty($height)) {
2017-12-02 12:47:22 +00:00
$message = t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels. The new dimensions of the resized image are %new_widthx%new_height pixels.',
[
'%dimensions' => $maximum_dimensions,
'%new_width' => $image->getWidth(),
'%new_height' => $image->getHeight(),
]);
2016-07-19 14:59:05 +00:00
}
elseif (empty($width)) {
2017-12-02 12:47:22 +00:00
$message = t('The image was resized to fit within the maximum allowed height of %height pixels. The new dimensions of the resized image are %new_widthx%new_height pixels.',
[
'%height' => $height,
'%new_width' => $image->getWidth(),
'%new_height' => $image->getHeight(),
]);
2016-07-19 14:59:05 +00:00
}
elseif (empty($height)) {
2017-12-02 12:47:22 +00:00
$message = t('The image was resized to fit within the maximum allowed width of %width pixels. The new dimensions of the resized image are %new_widthx%new_height pixels.',
[
'%width' => $width,
'%new_width' => $image->getWidth(),
'%new_height' => $image->getHeight(),
]);
2016-07-19 14:59:05 +00:00
}
2018-05-01 09:15:07 +00:00
\Drupal::messenger()->addStatus($message);
2012-08-31 01:27:21 +00:00
}
else {
2014-06-09 14:48:54 +00:00
$errors[] = t('The image exceeds the maximum allowed dimensions and an attempt to resize it failed.');
2012-08-31 01:27:21 +00:00
}
}
}
if ($minimum_dimensions) {
// Check that it is larger than the given dimensions.
2021-11-15 02:35:55 +00:00
[$width, $height] = explode('x', $minimum_dimensions);
2013-08-10 23:57:37 +00:00
if ($image->getWidth() < $width || $image->getHeight() < $height) {
2017-12-02 12:47:22 +00:00
if ($scaling) {
$errors[] = t('The resized image is too small. The minimum dimensions are %dimensions pixels and after resizing, the image size will be %widthx%height pixels.',
[
'%dimensions' => $minimum_dimensions,
'%width' => $image->getWidth(),
'%height' => $image->getHeight(),
]);
}
else {
$errors[] = t('The image is too small. The minimum dimensions are %dimensions pixels and the image size is %widthx%height pixels.',
[
'%dimensions' => $minimum_dimensions,
'%width' => $image->getWidth(),
'%height' => $image->getHeight(),
]);
}
2012-08-31 01:27:21 +00:00
}
}
}
return $errors;
}
/**
* Examines a file entity and returns appropriate content headers for download.
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-08-31 01:27:21 +00:00
* A file entity.
*
2015-06-12 14:46:25 +00:00
* @return array
2012-08-31 01:27:21 +00:00
* An associative array of headers, as expected by
* \Symfony\Component\HttpFoundation\StreamedResponse.
*/
2014-07-12 05:42:35 +00:00
function file_get_content_headers(FileInterface $file) {
2017-03-04 01:20:24 +00:00
return [
2021-04-16 09:02:35 +00:00
'Content-Type' => $file->getMimeType(),
2013-06-15 08:46:11 +00:00
'Content-Length' => $file->getSize(),
2012-08-31 01:27:21 +00:00
'Cache-Control' => 'private',
2017-03-04 01:20:24 +00:00
];
2012-08-31 01:27:21 +00:00
}
2009-08-29 12:52:32 +00:00
/**
2009-12-04 16:49:48 +00:00
* Implements hook_theme().
2009-08-29 12:52:32 +00:00
*/
function file_theme() {
2017-03-04 01:20:24 +00:00
return [
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
// From file.module.
2017-03-04 01:20:24 +00:00
'file_link' => [
'variables' => ['file' => NULL, 'description' => NULL, 'attributes' => []],
],
'file_managed_file' => [
2009-10-23 22:24:19 +00:00
'render element' => 'element',
2017-03-04 01:20:24 +00:00
],
Issue #1174892 by chr.fritsch, travist, Dave Reid, keithm, webchick, phenaproxima, Everett Zufelt, slashrsm, Wim Leers, RobW, seanB, xjm, Gábor Hojtsy, larowlan, ericduran, webflo, Berdir, pschuelke: File field formatters for rich media display with <video> and <audio> HTML5 elements
2017-11-17 20:07:32 +00:00
'file_audio' => [
'variables' => ['files' => [], 'attributes' => NULL],
],
'file_video' => [
'variables' => ['files' => [], 'attributes' => NULL],
],
2009-08-29 12:52:32 +00:00
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
// From file.field.inc.
2017-03-04 01:20:24 +00:00
'file_widget_multiple' => [
2009-10-23 22:24:19 +00:00
'render element' => 'element',
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
'file' => 'file.field.inc',
2017-03-04 01:20:24 +00:00
],
'file_upload_help' => [
'variables' => ['description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL],
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
'file' => 'file.field.inc',
2017-03-04 01:20:24 +00:00
],
];
2009-08-29 12:52:32 +00:00
}
/**
2009-12-04 16:49:48 +00:00
* Implements hook_file_download().
2009-08-29 12:52:32 +00:00
*/
2014-07-24 15:35:27 +00:00
function file_file_download($uri) {
2009-08-29 12:52:32 +00:00
// Get the file record based on the URI. If not in the database just return.
Issue #3223209 by kim.pepper, dww, yogeshmpawar, daffie, larowlan, Berdir, andypost, phenaproxima, brianV, alexpott, AjitS, ravi.shankar, catch, quietone, trobey, Dave Reid, JacobSingh, imclean, tim.plunkett, Kars-T, amateescu, JeremyFrench, aaron: deprecate file_save_data, file_copy and file_move and replace with a service
2021-10-25 01:01:32 +00:00
/** @var \Drupal\file\FileRepositoryInterface $file_repository */
$file_repository = \Drupal::service('file.repository');
$file = $file_repository->loadByUri($uri);
if (!$file) {
2009-08-29 12:52:32 +00:00
return;
}
2015-05-16 19:56:34 +00:00
// Find out if a temporary file is still used in the system.
if ($file->isTemporary()) {
$usage = \Drupal::service('file.usage')->listUsage($file);
if (empty($usage) && $file->getOwnerId() != \Drupal::currentUser()->id()) {
// Deny access to temporary files without usage that are not owned by the
// same user. This prevents the security issue that a private file that
// was protected by field permissions becomes available after its usage
// was removed and before it is actually deleted from the file system.
// Modules that depend on this behavior should make the file permanent
// instead.
return -1;
}
}
2010-09-11 05:07:22 +00:00
// Find out which (if any) fields of this type contain the file.
2014-07-24 15:35:27 +00:00
$references = file_get_file_references($file, NULL, EntityStorageInterface::FIELD_LOAD_CURRENT, NULL);
2009-08-29 12:52:32 +00:00
2011-10-17 16:07:31 +00:00
// Stop processing if there are no references in order to avoid returning
// headers for files controlled by other modules. Make an exception for
// temporary files where the host entity has not yet been saved (for example,
// an image preview on a node/add form) in which case, allow download by the
// file's owner.
2014-07-24 15:35:27 +00:00
if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
2012-10-30 10:41:42 +00:00
return;
2010-09-11 05:07:22 +00:00
}
2014-07-24 15:35:27 +00:00
if (!$file->access('download')) {
2009-08-29 12:52:32 +00:00
return -1;
}
// Access is granted.
2010-10-18 01:00:39 +00:00
$headers = file_get_content_headers($file);
return $headers;
2009-08-29 12:52:32 +00:00
}
2012-08-31 01:27:21 +00:00
/**
2015-08-31 16:28:05 +00:00
* Implements hook_cron().
2012-08-31 01:27:21 +00:00
*/
function file_cron() {
2014-04-13 17:52:04 +00:00
$age = \Drupal::config('system.file')->get('temporary_maximum_age');
2019-05-24 06:44:36 +00:00
$file_storage = \Drupal::entityTypeManager()->getStorage('file');
2014-04-13 17:52:04 +00:00
2019-06-02 07:53:50 +00:00
/** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
$stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
2014-04-13 17:52:04 +00:00
// Only delete temporary files if older than $age. Note that automatic cleanup
// is disabled if $age set to 0.
if ($age) {
$fids = Drupal::entityQuery('file')
2021-03-06 09:13:25 +00:00
->accessCheck(FALSE)
2021-08-06 07:54:08 +00:00
->condition('status', FileInterface::STATUS_PERMANENT, '<>')
2014-04-13 17:52:04 +00:00
->condition('changed', REQUEST_TIME - $age, '<')
->range(0, 100)
->execute();
Issue #2321969 by rpayanm, subhojit777, prics, LinL, JeroenT, Temoor, prashantgoel, Mile23, pcambra, Sumi: Replace all instances of file_load(), file_load_multiple(), entity_load('file') and entity_load_multiple('file') with static method calls
2015-07-13 11:56:25 +00:00
$files = $file_storage->loadMultiple($fids);
2014-04-13 17:52:04 +00:00
foreach ($files as $file) {
2013-11-28 08:52:13 +00:00
$references = \Drupal::service('file.usage')->listUsage($file);
2012-08-31 01:27:21 +00:00
if (empty($references)) {
Issue #2802803 by Berdir, AdamPS, Darren Oh, alexpott, Munavijayalakshmi, jackbravo, slashrsm, mmbk, Dane Powell, larowlan, LittleCoding, gapple, catch, wiifm, quantumized, acbramley: Temporary files whose files are missing on the disk result in never-ending error log messages
2019-04-19 11:47:53 +00:00
if (!file_exists($file->getFileUri())) {
2019-06-02 07:53:50 +00:00
if (!$stream_wrapper_manager->isValidUri($file->getFileUri())) {
Issue #2802803 by Berdir, AdamPS, Darren Oh, alexpott, Munavijayalakshmi, jackbravo, slashrsm, mmbk, Dane Powell, larowlan, LittleCoding, gapple, catch, wiifm, quantumized, acbramley: Temporary files whose files are missing on the disk result in never-ending error log messages
2019-04-19 11:47:53 +00:00
\Drupal::logger('file system')->warning('Temporary file "%path" that was deleted during garbage collection did not exist on the filesystem. This could be caused by a missing stream wrapper.', ['%path' => $file->getFileUri()]);
}
else {
\Drupal::logger('file system')->warning('Temporary file "%path" that was deleted during garbage collection did not exist on the filesystem.', ['%path' => $file->getFileUri()]);
}
2012-08-31 01:27:21 +00:00
}
Issue #2802803 by Berdir, AdamPS, Darren Oh, alexpott, Munavijayalakshmi, jackbravo, slashrsm, mmbk, Dane Powell, larowlan, LittleCoding, gapple, catch, wiifm, quantumized, acbramley: Temporary files whose files are missing on the disk result in never-ending error log messages
2019-04-19 11:47:53 +00:00
// Delete the file entity. If the file does not exist, this will
// generate a second notice in the watchdog.
$file->delete();
2012-08-31 01:27:21 +00:00
}
else {
2017-03-04 01:20:24 +00:00
\Drupal::logger('file system')->info('Did not delete temporary file "%path" during garbage collection because it is in use by the following modules: %modules.', ['%path' => $file->getFileUri(), '%modules' => implode(', ', array_keys($references))]);
2012-08-31 01:27:21 +00:00
}
}
}
}
2017-10-12 14:56:30 +00:00
/**
* Saves form file uploads.
*
* The files will be added to the {file_managed} table as temporary files.
* Temporary files are periodically cleaned. Use the 'file.usage' service to
* register the usage of the file which will automatically mark it as permanent.
*
* @param array $element
* The FAPI element whose values are being saved.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param null|int $delta
* (optional) The delta of the file to return the file entity.
* Defaults to NULL.
* @param int $replace
* (optional) The replace behavior when the destination file already exists.
* Possible values include:
2019-10-08 20:49:15 +00:00
* - FileSystemInterface::EXISTS_REPLACE: Replace the existing file.
* - FileSystemInterface::EXISTS_RENAME: (default) Append
* _{incrementing number} until the filename is unique.
* - FileSystemInterface::EXISTS_ERROR: Do nothing and return FALSE.
2017-10-12 14:56:30 +00:00
*
* @return array|\Drupal\file\FileInterface|null|false
* An array of file entities or a single file entity if $delta != NULL. Each
* array element contains the file entity if the upload succeeded or FALSE if
* there was an error. Function returns NULL if no file was uploaded.
*
* @internal
2019-09-22 22:18:30 +00:00
* This function is internal, and may be removed in a minor version release.
* It wraps file_save_upload() to allow correct error handling in forms.
* Contrib and custom code should not call this function, they should use the
* managed file upload widgets in core.
2017-10-12 14:56:30 +00:00
*
2019-09-22 22:18:30 +00:00
* @see https://www.drupal.org/project/drupal/issues/3069020
* @see https://www.drupal.org/project/drupal/issues/2482783
2017-10-12 14:56:30 +00:00
*/
2019-10-08 20:49:15 +00:00
function _file_save_upload_from_form(array $element, FormStateInterface $form_state, $delta = NULL, $replace = FileSystemInterface::EXISTS_RENAME) {
2017-10-12 14:56:30 +00:00
// Get all errors set before calling this method. This will also clear them
2021-08-18 08:53:24 +00:00
// from the messenger service.
2018-05-01 09:15:07 +00:00
$errors_before = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
2017-10-12 14:56:30 +00:00
2021-11-15 02:19:43 +00:00
$upload_location = $element['#upload_location'] ?? FALSE;
2017-10-12 14:56:30 +00:00
$upload_name = implode('_', $element['#parents']);
2021-11-15 02:19:43 +00:00
$upload_validators = $element['#upload_validators'] ?? [];
2017-10-12 14:56:30 +00:00
$result = file_save_upload($upload_name, $upload_validators, $upload_location, $delta, $replace);
// Get new errors that are generated while trying to save the upload. This
2021-08-18 08:53:24 +00:00
// will also clear them from the messenger service.
2018-05-01 09:15:07 +00:00
$errors_new = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
if (!empty($errors_new)) {
2017-10-12 14:56:30 +00:00
if (count($errors_new) > 1) {
// Render multiple errors into a single message.
// This is needed because only one error per element is supported.
$render_array = [
'error' => [
'#markup' => t('One or more files could not be uploaded.'),
],
'item_list' => [
'#theme' => 'item_list',
'#items' => $errors_new,
],
];
$error_message = \Drupal::service('renderer')->renderPlain($render_array);
}
else {
$error_message = reset($errors_new);
}
$form_state->setError($element, $error_message);
}
// Ensure that errors set prior to calling this method are still shown to the
// user.
2018-05-01 09:15:07 +00:00
if (!empty($errors_before)) {
foreach ($errors_before as $error) {
\Drupal::messenger()->addError($error);
2017-10-12 14:56:30 +00:00
}
}
return $result;
}
2013-07-24 12:00:06 +00:00
/**
* Saves file uploads to a new location.
*
* The files will be added to the {file_managed} table as temporary files.
2013-11-28 08:52:13 +00:00
* Temporary files are periodically cleaned. Use the 'file.usage' service to
* register the usage of the file which will automatically mark it as permanent.
2013-07-24 12:00:06 +00:00
*
2017-10-12 14:56:30 +00:00
* Note that this function does not support correct form error handling. The
* file upload widgets in core do support this. It is advised to use these in
* any custom form, instead of calling this function.
*
2015-06-12 14:46:25 +00:00
* @param string $form_field_name
2013-07-24 12:00:06 +00:00
* A string that is the associative array key of the upload form element in
* the form array.
2015-06-12 14:46:25 +00:00
* @param array $validators
2016-02-17 01:46:07 +00:00
* (optional) An associative array of callback functions used to validate the
2013-07-24 12:00:06 +00:00
* file. See file_validate() for a full discussion of the array format.
2016-02-17 01:46:07 +00:00
* If the array is empty, it will be set up to call file_validate_extensions()
* with a safe list of extensions, as follows: "jpg jpeg gif png txt doc
* xls pdf ppt pps odt ods odp". To allow all extensions, you must explicitly
* set this array to ['file_validate_extensions' => '']. (Beware: this is not
* safe and should only be allowed for trusted users, if at all.)
* @param string|false $destination
* (optional) A string containing the URI that the file should be copied to.
* This must be a stream wrapper URI. If this value is omitted or set to
* FALSE, Drupal's temporary files scheme will be used ("temporary://").
* @param null|int $delta
* (optional) The delta of the file to return the file entity.
* Defaults to NULL.
2015-06-12 14:46:25 +00:00
* @param int $replace
2016-02-17 01:46:07 +00:00
* (optional) The replace behavior when the destination file already exists.
* Possible values include:
2019-10-08 20:49:15 +00:00
* - FileSystemInterface::EXISTS_REPLACE: Replace the existing file.
* - FileSystemInterface::EXISTS_RENAME: (default) Append
* _{incrementing number} until the filename is unique.
* - FileSystemInterface::EXISTS_ERROR: Do nothing and return FALSE.
2013-07-24 12:00:06 +00:00
*
2016-02-17 01:46:07 +00:00
* @return array|\Drupal\file\FileInterface|null|false
* An array of file entities or a single file entity if $delta != NULL. Each
* array element contains the file entity if the upload succeeded or FALSE if
* there was an error. Function returns NULL if no file was uploaded.
2017-10-12 14:56:30 +00:00
*
* @see _file_save_upload_from_form()
*
* @todo: move this logic to a service in https://www.drupal.org/node/2244513.
2013-07-24 12:00:06 +00:00
*/
2019-10-08 20:49:15 +00:00
function file_save_upload($form_field_name, $validators = [], $destination = FALSE, $delta = NULL, $replace = FileSystemInterface::EXISTS_RENAME) {
2013-07-24 12:00:06 +00:00
static $upload_cache;
2017-03-04 01:20:24 +00:00
$all_files = \Drupal::request()->files->get('files', []);
2013-07-24 12:00:06 +00:00
// Make sure there's an upload to process.
2016-05-09 11:16:30 +00:00
if (empty($all_files[$form_field_name])) {
2013-07-24 12:00:06 +00:00
return NULL;
}
2016-05-09 11:16:30 +00:00
$file_upload = $all_files[$form_field_name];
2013-07-24 12:00:06 +00:00
// Return cached objects without processing since the file will have
// already been processed and the paths in $_FILES will be invalid.
if (isset($upload_cache[$form_field_name])) {
if (isset($delta)) {
return $upload_cache[$form_field_name][$delta];
}
return $upload_cache[$form_field_name];
}
// Prepare uploaded files info. Representation is slightly different
// for multiple uploads and we fix that here.
2013-12-05 18:02:36 +00:00
$uploaded_files = $file_upload;
if (!is_array($file_upload)) {
2017-03-04 01:20:24 +00:00
$uploaded_files = [$file_upload];
2013-07-24 12:00:06 +00:00
}
2021-10-15 08:01:34 +00:00
if ($destination === FALSE || $destination === NULL) {
$destination = 'temporary://';
}
/** @var \Drupal\file\Upload\FileUploadHandler $file_upload_handler */
$file_upload_handler = \Drupal::service('file.upload_handler');
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
2017-03-04 01:20:24 +00:00
$files = [];
2021-10-15 08:01:34 +00:00
/** @var \Symfony\Component\HttpFoundation\File\UploadedFile $uploaded_file */
foreach ($uploaded_files as $i => $uploaded_file) {
try {
2021-10-24 20:19:20 +00:00
$form_uploaded_file = new FormUploadedFile($uploaded_file);
$result = $file_upload_handler->handleFileUpload($form_uploaded_file, $validators, $destination, $replace);
2021-10-15 08:01:34 +00:00
$file = $result->getFile();
// If the filename has been modified, let the user know.
if ($result->isRenamed()) {
if ($result->isSecurityRename()) {
$message = t('For security reasons, your upload has been renamed to %filename.', ['%filename' => $file->getFilename()]);
}
else {
$message = t('Your upload has been renamed to %filename.', ['%filename' => $file->getFilename()]);
}
\Drupal::messenger()->addStatus($message);
}
$files[$i] = $file;
}
catch (FileExistsException $e) {
\Drupal::messenger()->addError(t('Destination file "%file" exists', ['%file' => $destination . $uploaded_file->getFilename()]));
$files[$i] = FALSE;
}
catch (InvalidStreamWrapperException $e) {
\Drupal::messenger()->addError(t('The file could not be uploaded because the destination "%destination" is invalid.', ['%destination' => $destination]));
$files[$i] = FALSE;
}
catch (IniSizeFileException | FormSizeFileException $e) {
\Drupal::messenger()->addError(t('The file %file could not be saved because it exceeds %maxsize, the maximum allowed size for uploads.', [
'%file' => $uploaded_file->getFilename(),
'%maxsize' => format_size(Environment::getUploadMaxSize()),
]));
$files[$i] = FALSE;
}
catch (PartialFileException | NoFileException $e) {
\Drupal::messenger()->addError(t('The file %file could not be saved because the upload did not complete.', [
'%file' => $uploaded_file->getFilename(),
]));
$files[$i] = FALSE;
}
catch (SymfonyFileException $e) {
\Drupal::messenger()->addError(t('The file %file could not be saved. An unknown error has occurred.', ['%file' => $uploaded_file->getFilename()]));
$files[$i] = FALSE;
}
catch (FileValidationException $e) {
$message = [
'error' => [
'#markup' => t('The specified file %name could not be uploaded.', ['%name' => $e->getFilename()]),
],
'item_list' => [
'#theme' => 'item_list',
'#items' => $e->getErrors(),
],
];
// @todo Add support for render arrays in
// \Drupal\Core\Messenger\MessengerInterface::addMessage()?
// @see https://www.drupal.org/node/2505497.
\Drupal::messenger()->addError($renderer->renderPlain($message));
$files[$i] = FALSE;
}
catch (FileWriteException $e) {
\Drupal::messenger()->addError(t('File upload error. Could not move uploaded file.'));
\Drupal::logger('file')->notice('Upload error. Could not move uploaded file %file to destination %destination.', ['%file' => $uploaded_file->getClientOriginalName(), '%destination' => $destination . '/' . $uploaded_file->getClientOriginalName()]);
$files[$i] = FALSE;
}
catch (FileException $e) {
\Drupal::messenger()->addError(t('The file %filename could not be uploaded because the name is invalid.', ['%filename' => $uploaded_file->getClientOriginalName()]));
$files[$i] = FALSE;
}
2018-11-20 12:34:52 +00:00
}
2013-07-24 12:00:06 +00:00
2018-11-20 12:34:52 +00:00
// Add files to the cache.
$upload_cache[$form_field_name] = $files;
2013-07-24 12:00:06 +00:00
2018-11-20 12:34:52 +00:00
return isset($delta) ? $files[$delta] : $files;
}
2009-08-29 12:52:32 +00:00
/**
2011-12-05 12:59:26 +00:00
* Determines the preferred upload progress implementation.
2009-08-29 12:52:32 +00:00
*
2016-02-17 01:46:07 +00:00
* @return string|false
2009-08-29 12:52:32 +00:00
* A string indicating which upload progress system is available. Either "apc"
* or "uploadprogress". If neither are available, returns FALSE.
*/
function file_progress_implementation() {
static $implementation;
if (!isset($implementation)) {
$implementation = FALSE;
// We prefer the PECL extension uploadprogress because it supports multiple
2015-12-09 12:40:26 +00:00
// simultaneous uploads. APCu only supports one at a time.
2009-08-29 12:52:32 +00:00
if (extension_loaded('uploadprogress')) {
$implementation = 'uploadprogress';
}
}
return $implementation;
}
/**
2014-07-11 12:04:53 +00:00
* Implements hook_ENTITY_TYPE_predelete() for file entities.
2009-08-29 12:52:32 +00:00
*/
2012-06-03 11:25:35 +00:00
function file_file_predelete(File $file) {
2016-02-17 01:46:07 +00:00
// @todo Remove references to a file that is in-use.
2009-08-29 12:52:32 +00:00
}
2013-07-24 12:00:06 +00:00
/**
* Implements hook_tokens().
*/
Issue #2525910 by dawehner, effulgentsia, Berdir, lauriii, larowlan, timmillwood, Wim Leers, chx, arlinsandbulte, Fabianx, Gábor Hojtsy, Dave Reid, alexpott, catch: Ensure token replacements have cacheability + attachments metadata and that it is bubbled in any case
2015-07-22 14:16:01 +00:00
function file_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
2013-09-16 03:58:06 +00:00
$token_service = \Drupal::token();
2013-07-24 12:00:06 +00:00
2017-03-04 01:20:24 +00:00
$url_options = ['absolute' => TRUE];
2013-07-24 12:00:06 +00:00
if (isset($options['langcode'])) {
2015-01-18 09:47:33 +00:00
$url_options['language'] = \Drupal::languageManager()->getLanguage($options['langcode']);
2013-07-24 12:00:06 +00:00
$langcode = $options['langcode'];
}
else {
$langcode = NULL;
}
2017-03-04 01:20:24 +00:00
$replacements = [];
2013-07-24 12:00:06 +00:00
if ($type == 'file' && !empty($data['file'])) {
2014-02-03 16:02:31 +00:00
/** @var \Drupal\file\FileInterface $file */
2013-07-24 12:00:06 +00:00
$file = $data['file'];
foreach ($tokens as $name => $original) {
switch ($name) {
// Basic keys and values.
case 'fid':
$replacements[$original] = $file->id();
break;
// Essential file data
case 'name':
Issue #2567257 by dawehner, stefan.r, effulgentsia, pwolanin, catch, Xano, mr.baileys, Wim Leers, k4v, Dave Reid, chx, googletorp, plach, lauriii, Berdir, webchick, alexpott, stefan.r: hook_tokens() $sanitize option incompatible with Html sanitisation requirements
2015-10-01 13:01:21 +00:00
$replacements[$original] = $file->getFilename();
2013-07-24 12:00:06 +00:00
break;
case 'path':
Issue #2567257 by dawehner, stefan.r, effulgentsia, pwolanin, catch, Xano, mr.baileys, Wim Leers, k4v, Dave Reid, chx, googletorp, plach, lauriii, Berdir, webchick, alexpott, stefan.r: hook_tokens() $sanitize option incompatible with Html sanitisation requirements
2015-10-01 13:01:21 +00:00
$replacements[$original] = $file->getFileUri();
2013-07-24 12:00:06 +00:00
break;
case 'mime':
Issue #2567257 by dawehner, stefan.r, effulgentsia, pwolanin, catch, Xano, mr.baileys, Wim Leers, k4v, Dave Reid, chx, googletorp, plach, lauriii, Berdir, webchick, alexpott, stefan.r: hook_tokens() $sanitize option incompatible with Html sanitisation requirements
2015-10-01 13:01:21 +00:00
$replacements[$original] = $file->getMimeType();
2013-07-24 12:00:06 +00:00
break;
case 'size':
$replacements[$original] = format_size($file->getSize());
break;
case 'url':
Issue #2669074 by kim.pepper, Berdir, gaydabura, andypost, ravi.shankar, KapilV, Wim Leers, bradjones1, nickolaj, alexpott, mondrake, 20th, yogeshmpawar, gaurav.kapoor, voleger, Pavan B S, Neslee Canil Pinto, aerozeppelin, Cameron Tod, daffie, dhruveshdtripathi, abramm, Nono95230, s.messaris, Mile23, claudiu.cristea, larowlan, catch, jibran, SpadXIII: Convert file_create_url() & file_url_transform_relative() to service, deprecate it
2021-07-09 13:18:01 +00:00
// Ideally, this would use return a relative URL, but because tokens
// are also often used in e-mails, it's better to keep absolute file
// URLs. The 'url.site' cache context is associated to ensure the
2016-01-15 04:20:55 +00:00
// correct absolute URL is used in case of a multisite setup.
Issue #2402533 by YesCT, Berdir, tamasd, tjwelde, Wim Leers, vijaycs85, alexpott, slashrsm, Leon Kessler, chr.fritsch, borisson_: Provide File::createFileUrl() as a replacement for the deprecated File:url() implementation
2018-12-14 10:05:18 +00:00
$replacements[$original] = $file->createFileUrl(FALSE);
2016-01-15 04:20:55 +00:00
$bubbleable_metadata->addCacheContexts(['url.site']);
2013-07-24 12:00:06 +00:00
break;
// These tokens are default variations on the chained tokens handled below.
2014-01-07 10:09:22 +00:00
case 'created':
Issue #2525910 by dawehner, effulgentsia, Berdir, lauriii, larowlan, timmillwood, Wim Leers, chx, arlinsandbulte, Fabianx, Gábor Hojtsy, Dave Reid, alexpott, catch: Ensure token replacements have cacheability + attachments metadata and that it is bubbled in any case
2015-07-22 14:16:01 +00:00
$date_format = DateFormat::load('medium');
$bubbleable_metadata->addCacheableDependency($date_format);
2019-01-01 19:15:24 +00:00
$replacements[$original] = \Drupal::service('date.formatter')->format($file->getCreatedTime(), 'medium', '', NULL, $langcode);
2014-01-07 10:09:22 +00:00
break;
case 'changed':
Issue #2525910 by dawehner, effulgentsia, Berdir, lauriii, larowlan, timmillwood, Wim Leers, chx, arlinsandbulte, Fabianx, Gábor Hojtsy, Dave Reid, alexpott, catch: Ensure token replacements have cacheability + attachments metadata and that it is bubbled in any case
2015-07-22 14:16:01 +00:00
$date_format = DateFormat::load('medium');
$bubbleable_metadata = $bubbleable_metadata->addCacheableDependency($date_format);
2019-01-01 19:15:24 +00:00
$replacements[$original] = \Drupal::service('date.formatter')->format($file->getChangedTime(), 'medium', '', NULL, $langcode);
2013-07-24 12:00:06 +00:00
break;
case 'owner':
Issue #2525910 by dawehner, effulgentsia, Berdir, lauriii, larowlan, timmillwood, Wim Leers, chx, arlinsandbulte, Fabianx, Gábor Hojtsy, Dave Reid, alexpott, catch: Ensure token replacements have cacheability + attachments metadata and that it is bubbled in any case
2015-07-22 14:16:01 +00:00
$owner = $file->getOwner();
$bubbleable_metadata->addCacheableDependency($owner);
$name = $owner->label();
Issue #2567257 by dawehner, stefan.r, effulgentsia, pwolanin, catch, Xano, mr.baileys, Wim Leers, k4v, Dave Reid, chx, googletorp, plach, lauriii, Berdir, webchick, alexpott, stefan.r: hook_tokens() $sanitize option incompatible with Html sanitisation requirements
2015-10-01 13:01:21 +00:00
$replacements[$original] = $name;
2013-07-24 12:00:06 +00:00
break;
}
}
2014-01-07 10:09:22 +00:00
if ($date_tokens = $token_service->findWithPrefix($tokens, 'created')) {
2017-03-04 01:20:24 +00:00
$replacements += $token_service->generate('date', $date_tokens, ['date' => $file->getCreatedTime()], $options, $bubbleable_metadata);
2014-01-07 10:09:22 +00:00
}
if ($date_tokens = $token_service->findWithPrefix($tokens, 'changed')) {
2017-03-04 01:20:24 +00:00
$replacements += $token_service->generate('date', $date_tokens, ['date' => $file->getChangedTime()], $options, $bubbleable_metadata);
2013-07-24 12:00:06 +00:00
}
if (($owner_tokens = $token_service->findWithPrefix($tokens, 'owner')) && $file->getOwner()) {
2017-03-04 01:20:24 +00:00
$replacements += $token_service->generate('user', $owner_tokens, ['user' => $file->getOwner()], $options, $bubbleable_metadata);
2013-07-24 12:00:06 +00:00
}
}
return $replacements;
}
/**
* Implements hook_token_info().
*/
function file_token_info() {
2017-03-04 01:20:24 +00:00
$types['file'] = [
2013-07-24 12:00:06 +00:00
'name' => t("Files"),
'description' => t("Tokens related to uploaded files."),
'needs-data' => 'file',
2017-03-04 01:20:24 +00:00
];
2013-07-24 12:00:06 +00:00
// File related tokens.
2017-03-04 01:20:24 +00:00
$file['fid'] = [
2013-07-24 12:00:06 +00:00
'name' => t("File ID"),
'description' => t("The unique ID of the uploaded file."),
2017-03-04 01:20:24 +00:00
];
$file['name'] = [
2013-07-24 12:00:06 +00:00
'name' => t("File name"),
'description' => t("The name of the file on disk."),
2017-03-04 01:20:24 +00:00
];
$file['path'] = [
2013-07-24 12:00:06 +00:00
'name' => t("Path"),
'description' => t("The location of the file relative to Drupal root."),
2017-03-04 01:20:24 +00:00
];
$file['mime'] = [
2013-07-24 12:00:06 +00:00
'name' => t("MIME type"),
'description' => t("The MIME type of the file."),
2017-03-04 01:20:24 +00:00
];
$file['size'] = [
2013-07-24 12:00:06 +00:00
'name' => t("File size"),
'description' => t("The size of the file."),
2017-03-04 01:20:24 +00:00
];
$file['url'] = [
2013-07-24 12:00:06 +00:00
'name' => t("URL"),
'description' => t("The web-accessible URL for the file."),
2017-03-04 01:20:24 +00:00
];
$file['created'] = [
2014-01-07 10:09:22 +00:00
'name' => t("Created"),
'description' => t("The date the file created."),
'type' => 'date',
2017-03-04 01:20:24 +00:00
];
$file['changed'] = [
2014-01-07 10:09:22 +00:00
'name' => t("Changed"),
2013-07-24 12:00:06 +00:00
'description' => t("The date the file was most recently changed."),
'type' => 'date',
2017-03-04 01:20:24 +00:00
];
$file['owner'] = [
2013-07-24 12:00:06 +00:00
'name' => t("Owner"),
'description' => t("The user who originally uploaded the file."),
'type' => 'user',
2017-03-04 01:20:24 +00:00
];
2013-07-24 12:00:06 +00:00
2017-03-04 01:20:24 +00:00
return [
2013-07-24 12:00:06 +00:00
'types' => $types,
2017-03-04 01:20:24 +00:00
'tokens' => [
2013-07-24 12:00:06 +00:00
'file' => $file,
2017-03-04 01:20:24 +00:00
],
];
2013-07-24 12:00:06 +00:00
}
2009-08-29 12:52:32 +00:00
/**
2011-12-05 12:59:26 +00:00
* Form submission handler for upload / remove buttons of managed_file elements.
*
2014-10-22 08:57:33 +00:00
* @see \Drupal\file\Element\ManagedFile::processManagedFile()
2009-08-29 12:52:32 +00:00
*/
2014-07-31 00:50:42 +00:00
function file_managed_file_submit($form, FormStateInterface $form_state) {
2010-07-02 12:37:57 +00:00
// Determine whether it was the upload or the remove button that was clicked,
// and set $element to the managed_file element that contains that button.
2014-09-12 06:41:27 +00:00
$parents = $form_state->getTriggeringElement()['#array_parents'];
2010-07-02 12:37:57 +00:00
$button_key = array_pop($parents);
2012-12-17 21:54:13 +00:00
$element = NestedArray::getValue($form, $parents);
2010-07-02 12:37:57 +00:00
// No action is needed here for the upload button, because all file uploads on
2014-10-22 08:57:33 +00:00
// the form are processed by \Drupal\file\Element\ManagedFile::valueCallback()
// regardless of which button was clicked. Action is needed here for the
// remove button, because we only remove a file in response to its remove
// button being clicked.
2010-07-02 12:37:57 +00:00
if ($button_key == 'remove_button') {
2013-04-20 03:34:14 +00:00
$fids = array_keys($element['#files']);
// Get files that will be removed.
if ($element['#multiple']) {
2017-03-04 01:20:24 +00:00
$remove_fids = [];
2014-03-31 17:37:55 +00:00
foreach (Element::children($element) as $name) {
2013-04-20 03:34:14 +00:00
if (strpos($name, 'file_') === 0 && $element[$name]['selected']['#value']) {
$remove_fids[] = (int) substr($name, 5);
}
}
$fids = array_diff($fids, $remove_fids);
}
else {
2013-06-03 19:37:59 +00:00
// If we deal with single upload element remove the file and set
// element's value to empty array (file could not be removed from
// element if we don't do that).
2013-04-20 03:34:14 +00:00
$remove_fids = $fids;
2017-03-04 01:20:24 +00:00
$fids = [];
2013-04-20 03:34:14 +00:00
}
foreach ($remove_fids as $fid) {
// If it's a temporary file we can safely remove it immediately, otherwise
// it's up to the implementing module to remove usages of files to have them
// removed.
2013-06-15 08:46:11 +00:00
if ($element['#files'][$fid] && $element['#files'][$fid]->isTemporary()) {
$element['#files'][$fid]->delete();
2013-04-20 03:34:14 +00:00
}
2010-07-02 12:37:57 +00:00
}
2014-08-23 19:18:55 +00:00
// Update both $form_state->getValues() and FormState::$input to reflect
2010-07-02 12:37:57 +00:00
// that the file has been removed, so that the form is rebuilt correctly.
2014-08-08 16:25:54 +00:00
// $form_state->getValues() must be updated in case additional submit
// handlers run, and for form building functions that run during the
// rebuild, such as when the managed_file element is part of a field widget.
2014-10-22 08:57:33 +00:00
// FormState::$input must be updated so that
// \Drupal\file\Element\ManagedFile::valueCallback() has correct information
// during the rebuild.
2014-11-07 20:05:32 +00:00
$form_state->setValueForElement($element['fids'], implode(' ', $fids));
2014-08-23 19:18:55 +00:00
NestedArray::setValue($form_state->getUserInput(), $element['fids']['#parents'], implode(' ', $fids));
2010-07-02 12:37:57 +00:00
}
// Set the form to rebuild so that $form is correctly updated in response to
// processing the file removal. Since this function did not change $form_state
// if the upload button was clicked, a rebuild isn't necessary in that
2014-09-12 06:41:27 +00:00
// situation and calling $form_state->disableRedirect() would suffice.
2010-07-02 12:37:57 +00:00
// However, we choose to always rebuild, to keep the form processing workflow
// consistent between the two buttons.
2014-09-12 06:41:27 +00:00
$form_state->setRebuild();
2009-08-29 12:52:32 +00:00
}
/**
2011-12-05 12:59:26 +00:00
* Saves any files that have been uploaded into a managed_file element.
2009-08-29 12:52:32 +00:00
*
2015-06-12 14:46:25 +00:00
* @param array $element
2009-08-29 12:52:32 +00:00
* The FAPI element whose values are being saved.
2014-07-31 00:50:42 +00:00
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
2011-12-05 12:59:26 +00:00
*
2016-02-17 01:46:07 +00:00
* @return array|false
2013-04-20 03:34:14 +00:00
* An array of file entities for each file that was saved, keyed by its file
2016-02-17 01:46:07 +00:00
* ID. Each array element contains a file entity. Function returns FALSE if
* upload directory could not be created or no files were uploaded.
2009-08-29 12:52:32 +00:00
*/
2014-07-31 00:50:42 +00:00
function file_managed_file_save_upload($element, FormStateInterface $form_state) {
2009-08-29 12:52:32 +00:00
$upload_name = implode('_', $element['#parents']);
2017-03-04 01:20:24 +00:00
$all_files = \Drupal::request()->files->get('files', []);
2016-05-09 11:16:30 +00:00
if (empty($all_files[$upload_name])) {
2009-08-29 12:52:32 +00:00
return FALSE;
}
2016-05-09 11:16:30 +00:00
$file_upload = $all_files[$upload_name];
2009-08-29 12:52:32 +00:00
2021-11-15 02:19:43 +00:00
$destination = $element['#upload_location'] ?? NULL;
Issue #2244513 by kim.pepper, phenaproxima, 20th, andrei.dincu, beejeebus, Berdir, alexpott, jibran, andypost, larowlan, Chadwick Wood, acbramley, Wim Leers, sun, xjm, YesCT, chx, tim.plunkett: Move the unmanaged file APIs to the file_system service (file.inc)
2019-02-23 22:35:15 +00:00
if (isset($destination) && !\Drupal::service('file_system')->prepareDirectory($destination, FileSystemInterface::CREATE_DIRECTORY)) {
2017-03-04 01:20:24 +00:00
\Drupal::logger('file')->notice('The upload directory %directory for the file field %name could not be created or is not accessible. A newly uploaded file could not be saved in this directory as a consequence, and the upload was canceled.', ['%directory' => $destination, '%name' => $element['#field_name']]);
Issue #1493324 by tim.plunkett, dmsmidt, mgifford, bleen18, davidhernandez, crasx, mparker17, stefan.r, YesCT, joelpittet, tstoeckler, larowlan, vijaycs85, swentel, rpayanm, Bojhan, LewisNyman, emma.maria, BarisW, njbarrett, rteijeiro, nod_, sun, joshtaylor, mrjmd, webchick, marcvangend, kattekrab, SKAUGHT, bowersox, andrewmacpherson, Manjit.Singh, RavindraSingh, Wim Leers, BLadwin, aspilicious, mortendk, mausolos, jessebeach, Gábor Hojtsy, anandps, falcon03, franz, andypost, rooby, rootwork, Cottser, Xano: Inline form errors for accessibility and UX
2015-06-12 13:54:11 +00:00
$form_state->setError($element, t('The file could not be uploaded.'));
2009-08-29 12:52:32 +00:00
return FALSE;
}
2013-04-20 03:34:14 +00:00
// Save attached files to the database.
2013-12-05 18:02:36 +00:00
$files_uploaded = $element['#multiple'] && count(array_filter($file_upload)) > 0;
$files_uploaded |= !$element['#multiple'] && !empty($file_upload);
2013-04-20 03:34:14 +00:00
if ($files_uploaded) {
2017-10-12 14:56:30 +00:00
if (!$files = _file_save_upload_from_form($element, $form_state)) {
2017-03-04 01:20:24 +00:00
\Drupal::logger('file')->notice('The file upload failed. %upload', ['%upload' => $upload_name]);
return [];
2013-04-20 03:34:14 +00:00
}
// Value callback expects FIDs to be keys.
$files = array_filter($files);
2017-10-10 14:43:06 +00:00
$fids = array_map(function ($file) {
2017-09-22 11:16:23 +00:00
return $file->id();
}, $files);
2013-04-20 03:34:14 +00:00
2017-03-04 01:20:24 +00:00
return empty($files) ? [] : array_combine($fids, $files);
2009-08-29 12:52:32 +00:00
}
2017-03-04 01:20:24 +00:00
return [];
2009-08-29 12:52:32 +00:00
}
/**
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
* Prepares variables for file form widget templates.
*
* Default template: file-managed-file.html.twig.
2010-04-13 15:23:03 +00:00
*
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
* @param array $variables
2010-04-13 15:23:03 +00:00
* An associative array containing:
* - element: A render element representing the file.
2009-08-29 12:52:32 +00:00
*/
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
function template_preprocess_file_managed_file(&$variables) {
2009-10-09 01:00:08 +00:00
$element = $variables['element'];
2017-03-04 01:20:24 +00:00
$variables['attributes'] = [];
2011-09-05 19:08:11 +00:00
if (isset($element['#id'])) {
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
$variables['attributes']['id'] = $element['#id'];
2011-09-05 19:08:11 +00:00
}
if (!empty($element['#attributes']['class'])) {
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
$variables['attributes']['class'] = (array) $element['#attributes']['class'];
2011-09-05 19:08:11 +00:00
}
2009-08-29 12:52:32 +00:00
}
/**
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
* Prepares variables for file link templates.
*
* Default template: file-link.html.twig.
2009-08-29 12:52:32 +00:00
*
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
* @param array $variables
2009-10-09 01:00:08 +00:00
* An associative array containing:
2019-05-29 09:34:23 +00:00
* - file: A File entity to which the link will be created.
2010-08-02 13:26:40 +00:00
* - icon_directory: (optional) A path to a directory of icons to be used for
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
* files. Defaults to the value of the "icon.directory" variable.
2013-02-21 10:04:20 +00:00
* - description: A description to be displayed instead of the filename.
2013-09-20 09:59:23 +00:00
* - attributes: An associative array of attributes to be placed in the a tag.
2009-08-29 12:52:32 +00:00
*/
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
function template_preprocess_file_link(&$variables) {
2009-10-09 01:00:08 +00:00
$file = $variables['file'];
2017-03-04 01:20:24 +00:00
$options = [];
Issue #1898070 by benjifisher, jjcarrion, LinL, idflood, joelpittet, oshelach, tlattimore, Les Lim, sergey.semashko, jesse.d, bdgreen, jenlampton, Cottser, duellj, artofeclipse, vlad.dancer, steveoliver, EVIIILJ, c4rl, elv, OpenChimp: File.module - Convert theme_ functions to Twig.
2014-06-13 03:13:30 +00:00
Issue #2669074 by kim.pepper, Berdir, gaydabura, andypost, ravi.shankar, KapilV, Wim Leers, bradjones1, nickolaj, alexpott, mondrake, 20th, yogeshmpawar, gaurav.kapoor, voleger, Pavan B S, Neslee Canil Pinto, aerozeppelin, Cameron Tod, daffie, dhruveshdtripathi, abramm, Nono95230, s.messaris, Mile23, claudiu.cristea, larowlan, catch, jibran, SpadXIII: Convert file_create_url() & file_url_transform_relative() to service, deprecate it
2021-07-09 13:18:01 +00:00
/** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
$file_url_generator = \Drupal::service('file_url_generator');
$url = $file_url_generator->generate($file->getFileUri());
2014-07-13 20:21:15 +00:00
2014-11-10 14:30:41 +00:00
$mime_type = $file->getMimeType();
2020-08-08 01:23:14 +00:00
$options['attributes']['type'] = $mime_type;
2009-08-29 12:52:32 +00:00
// Use the description as the link text if available.
2013-02-21 10:04:20 +00:00
if (empty($variables['description'])) {
2019-05-29 09:34:23 +00:00
$link_text = $file->getFilename();
2009-08-29 12:52:32 +00:00
}
else {
2013-02-21 10:04:20 +00:00
$link_text = $variables['description'];
2019-05-29 09:34:23 +00:00
$options['attributes']['title'] = $file->getFilename();
2009-08-29 12:52:32 +00:00
}
2014-11-10 14:30:41 +00:00
// Classes to add to the file field for icons.
2017-03-04 01:20:24 +00:00
$classes = [
2014-11-10 14:30:41 +00:00
'file',
// Add a specific class for each and every mime type.
2017-03-04 01:20:24 +00:00
'file--mime-' . strtr($mime_type, ['/' => '-', '.' => '-']),
2016-02-22 12:30:26 +00:00
// Add a more general class for groups of well known MIME types.
2014-11-10 14:30:41 +00:00
'file--' . file_icon_class($mime_type),
2017-03-04 01:20:24 +00:00
];
2014-11-10 13:36:23 +00:00
2014-11-10 14:30:41 +00:00
// Set file classes to the options array.
$variables['attributes'] = new Attribute($variables['attributes']);
$variables['attributes']->addClass($classes);
2021-10-02 03:26:18 +00:00
$variables['file_size'] = format_size($file->getSize() ?? 0);
2014-11-10 14:30:41 +00:00
2022-02-07 16:12:37 +00:00
$variables['link'] = Link::fromTextAndUrl($link_text, $url->mergeOptions($options))->toRenderable();
2009-08-29 12:52:32 +00:00
}
/**
2014-11-10 14:30:41 +00:00
* Gets a class for the icon for a MIME type.
2009-08-29 12:52:32 +00:00
*
2014-11-10 14:30:41 +00:00
* @param string $mime_type
* A MIME type.
2011-12-05 12:59:26 +00:00
*
2014-11-10 14:30:41 +00:00
* @return string
2015-08-18 12:10:00 +00:00
* A class associated with the file.
2009-08-29 12:52:32 +00:00
*/
2014-11-10 14:30:41 +00:00
function file_icon_class($mime_type) {
// Search for a group with the files MIME type.
$generic_mime = (string) file_icon_map($mime_type);
if (!empty($generic_mime)) {
return $generic_mime;
2009-08-29 12:52:32 +00:00
}
// Use generic icons for each category that provides such icons.
2017-03-04 01:20:24 +00:00
foreach (['audio', 'image', 'text', 'video'] as $category) {
2014-11-10 14:30:41 +00:00
if (strpos($mime_type, $category) === 0) {
return $category;
2009-08-29 12:52:32 +00:00
}
}
2014-11-10 14:30:41 +00:00
// If there's no generic icon for the type the general class.
return 'general';
2009-08-29 12:52:32 +00:00
}
/**
2011-12-05 12:59:26 +00:00
* Determines the generic icon MIME package based on a file's MIME type.
2009-08-29 12:52:32 +00:00
*
2014-11-10 14:30:41 +00:00
* @param string $mime_type
* A MIME type.
2011-12-05 12:59:26 +00:00
*
2016-08-28 11:25:45 +00:00
* @return string|false
2009-08-29 12:52:32 +00:00
* The generic icon MIME package expected for this file.
*/
2014-11-10 14:30:41 +00:00
function file_icon_map($mime_type) {
switch ($mime_type) {
2009-08-29 12:52:32 +00:00
// Word document types.
case 'application/msword':
case 'application/vnd.ms-word.document.macroEnabled.12':
case 'application/vnd.oasis.opendocument.text':
case 'application/vnd.oasis.opendocument.text-template':
case 'application/vnd.oasis.opendocument.text-master':
case 'application/vnd.oasis.opendocument.text-web':
case 'application/vnd.openxmlformats-officedocument.wordprocessingml.document':
case 'application/vnd.stardivision.writer':
case 'application/vnd.sun.xml.writer':
case 'application/vnd.sun.xml.writer.template':
case 'application/vnd.sun.xml.writer.global':
case 'application/vnd.wordperfect':
case 'application/x-abiword':
case 'application/x-applix-word':
case 'application/x-kword':
case 'application/x-kword-crypt':
return 'x-office-document';
// Spreadsheet document types.
case 'application/vnd.ms-excel':
case 'application/vnd.ms-excel.sheet.macroEnabled.12':
case 'application/vnd.oasis.opendocument.spreadsheet':
case 'application/vnd.oasis.opendocument.spreadsheet-template':
case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
case 'application/vnd.stardivision.calc':
case 'application/vnd.sun.xml.calc':
case 'application/vnd.sun.xml.calc.template':
case 'application/vnd.lotus-1-2-3':
case 'application/x-applix-spreadsheet':
case 'application/x-gnumeric':
case 'application/x-kspread':
case 'application/x-kspread-crypt':
return 'x-office-spreadsheet';
// Presentation document types.
case 'application/vnd.ms-powerpoint':
case 'application/vnd.ms-powerpoint.presentation.macroEnabled.12':
case 'application/vnd.oasis.opendocument.presentation':
case 'application/vnd.oasis.opendocument.presentation-template':
case 'application/vnd.openxmlformats-officedocument.presentationml.presentation':
case 'application/vnd.stardivision.impress':
case 'application/vnd.sun.xml.impress':
case 'application/vnd.sun.xml.impress.template':
case 'application/x-kpresenter':
return 'x-office-presentation';
// Compressed archive types.
case 'application/zip':
case 'application/x-zip':
case 'application/stuffit':
case 'application/x-stuffit':
case 'application/x-7z-compressed':
case 'application/x-ace':
case 'application/x-arj':
case 'application/x-bzip':
case 'application/x-bzip-compressed-tar':
case 'application/x-compress':
case 'application/x-compressed-tar':
case 'application/x-cpio-compressed':
case 'application/x-deb':
case 'application/x-gzip':
case 'application/x-java-archive':
case 'application/x-lha':
case 'application/x-lhz':
case 'application/x-lzop':
case 'application/x-rar':
case 'application/x-rpm':
case 'application/x-tzo':
case 'application/x-tar':
case 'application/x-tarz':
case 'application/x-tgz':
return 'package-x-generic';
// Script file types.
case 'application/ecmascript':
case 'application/javascript':
case 'application/mathematica':
case 'application/vnd.mozilla.xul+xml':
case 'application/x-asp':
case 'application/x-awk':
case 'application/x-cgi':
case 'application/x-csh':
case 'application/x-m4':
case 'application/x-perl':
case 'application/x-php':
case 'application/x-ruby':
case 'application/x-shellscript':
case 'text/vnd.wap.wmlscript':
case 'text/x-emacs-lisp':
case 'text/x-haskell':
case 'text/x-literate-haskell':
case 'text/x-lua':
case 'text/x-makefile':
case 'text/x-matlab':
case 'text/x-python':
case 'text/x-sql':
case 'text/x-tcl':
return 'text-x-script';
// HTML aliases.
case 'application/xhtml+xml':
return 'text-html';
// Executable types.
case 'application/x-macbinary':
case 'application/x-ms-dos-executable':
case 'application/x-pef-executable':
return 'application-x-executable';
2014-11-10 14:30:41 +00:00
// Acrobat types
case 'application/pdf':
case 'application/x-pdf':
case 'applications/vnd.pdf':
case 'text/pdf':
case 'text/x-pdf':
return 'application-pdf';
2009-08-29 12:52:32 +00:00
default:
return FALSE;
}
}
/**
2011-12-05 12:59:26 +00:00
* Retrieves a list of references to a file.
2009-08-29 12:52:32 +00:00
*
2014-07-12 05:42:35 +00:00
* @param \Drupal\file\FileInterface $file
2012-06-03 11:25:35 +00:00
* A file entity.
2016-02-17 01:46:07 +00:00
* @param \Drupal\Core\Field\FieldDefinitionInterface|null $field
* (optional) A field definition to be used for this check. If given,
* limits the reference check to the given field. Defaults to NULL.
2015-06-12 14:46:25 +00:00
* @param int $age
2009-08-29 12:52:32 +00:00
* (optional) A constant that specifies which references to count. Use
2016-02-17 01:46:07 +00:00
* EntityStorageInterface::FIELD_LOAD_REVISION (the default) to retrieve all
2013-09-05 09:41:02 +00:00
* references within all revisions or
2016-02-17 01:46:07 +00:00
* EntityStorageInterface::FIELD_LOAD_CURRENT to retrieve references only in
* the current revisions of all entities that have references to this file.
2015-06-12 14:46:25 +00:00
* @param string $field_type
2010-08-22 13:52:59 +00:00
* (optional) The name of a field type. If given, limits the reference check
2016-02-17 01:46:07 +00:00
* to fields of the given type. If both $field and $field_type are given but
2012-10-30 10:41:42 +00:00
* $field is not the same type as $field_type, an empty array will be
2016-02-17 01:46:07 +00:00
* returned. Defaults to 'file'.
2010-08-22 13:52:59 +00:00
*
2015-06-12 14:46:25 +00:00
* @return array
2012-10-30 10:41:42 +00:00
* A multidimensional array. The keys are field_name, entity_type,
* entity_id and the value is an entity referencing this file.
2014-07-24 16:31:01 +00:00
*
* @ingroup file
2009-08-29 12:52:32 +00:00
*/
2014-07-12 05:42:35 +00:00
function file_get_file_references(FileInterface $file, FieldDefinitionInterface $field = NULL, $age = EntityStorageInterface::FIELD_LOAD_REVISION, $field_type = 'file') {
2017-03-04 01:20:24 +00:00
$references = &drupal_static(__FUNCTION__, []);
$field_columns = &drupal_static(__FUNCTION__ . ':field_columns', []);
2012-10-30 10:41:42 +00:00
// Fill the static cache, disregard $field and $field_type for now.
2013-06-15 08:46:11 +00:00
if (!isset($references[$file->id()][$age])) {
2017-03-04 01:20:24 +00:00
$references[$file->id()][$age] = [];
2013-11-28 08:52:13 +00:00
$usage_list = \Drupal::service('file.usage')->listUsage($file);
2021-11-15 02:19:43 +00:00
$file_usage_list = $usage_list['file'] ?? [];
2014-02-10 09:24:05 +00:00
foreach ($file_usage_list as $entity_type_id => $entity_ids) {
2016-08-05 08:29:20 +00:00
$entities = \Drupal::entityTypeManager()
->getStorage($entity_type_id)->loadMultiple(array_keys($entity_ids));
2012-10-30 10:41:42 +00:00
foreach ($entities as $entity) {
$bundle = $entity->bundle();
// We need to find file fields for this entity type and bundle.
2014-02-10 09:24:05 +00:00
if (!isset($file_fields[$entity_type_id][$bundle])) {
2017-03-04 01:20:24 +00:00
$file_fields[$entity_type_id][$bundle] = [];
2012-10-30 10:41:42 +00:00
// This contains the possible field names.
2014-04-11 16:01:24 +00:00
foreach ($entity->getFieldDefinitions() as $field_name => $field_definition) {
2012-10-30 10:41:42 +00:00
// If this is the first time this field type is seen, check
// whether it references files.
Issue #597236 by Berdir, catch, msonnabaum, Xano, Wim Leers, jhedstrom, amateescu, corvus_ch, swentel, moshe weitzman, Gábor Hojtsy, riccardoR, killes@www.drop.org, et al: Add entity caching to core.
2014-07-18 10:53:52 +00:00
if (!isset($field_columns[$field_definition->getType()])) {
$field_columns[$field_definition->getType()] = file_field_find_file_reference_column($field_definition);
2012-10-30 10:41:42 +00:00
}
// If the field type does reference files then record it.
Issue #597236 by Berdir, catch, msonnabaum, Xano, Wim Leers, jhedstrom, amateescu, corvus_ch, swentel, moshe weitzman, Gábor Hojtsy, riccardoR, killes@www.drop.org, et al: Add entity caching to core.
2014-07-18 10:53:52 +00:00
if ($field_columns[$field_definition->getType()]) {
$file_fields[$entity_type_id][$bundle][$field_name] = $field_columns[$field_definition->getType()];
2012-10-30 10:41:42 +00:00
}
}
}
2014-02-10 09:24:05 +00:00
foreach ($file_fields[$entity_type_id][$bundle] as $field_name => $field_column) {
2014-10-15 09:10:03 +00:00
// Iterate over the field items to find the referenced file and field
// name. This will fail if the usage checked is in a non-current
// revision because field items are from the current
2012-10-30 10:41:42 +00:00
// revision.
2014-11-07 00:34:53 +00:00
// We also iterate over all translations because a file can be linked
// to a language other than the default.
foreach ($entity->getTranslationLanguages() as $langcode => $language) {
foreach ($entity->getTranslation($langcode)->get($field_name) as $item) {
2013-08-01 12:46:59 +00:00
if ($file->id() == $item->{$field_column}) {
2014-10-15 09:10:03 +00:00
$references[$file->id()][$age][$field_name][$entity_type_id][$entity->id()] = $entity;
2012-10-30 10:41:42 +00:00
break;
}
}
}
}
}
2009-08-29 12:52:32 +00:00
}
}
2013-06-15 08:46:11 +00:00
$return = $references[$file->id()][$age];
2012-10-30 10:41:42 +00:00
// Filter the static cache down to the requested entries. The usual static
// cache is very small so this will be very fast.
2019-04-26 07:09:28 +00:00
$entity_field_manager = \Drupal::service('entity_field.manager');
2012-10-30 10:41:42 +00:00
if ($field || $field_type) {
foreach ($return as $field_name => $data) {
2014-02-10 09:24:05 +00:00
foreach (array_keys($data) as $entity_type_id) {
2019-04-26 07:09:28 +00:00
$field_storage_definitions = $entity_field_manager->getFieldStorageDefinitions($entity_type_id);
2014-05-15 17:26:18 +00:00
$current_field = $field_storage_definitions[$field_name];
2013-12-09 23:19:58 +00:00
if (($field_type && $current_field->getType() != $field_type) || ($field && $field->uuid() != $current_field->uuid())) {
2014-02-10 09:24:05 +00:00
unset($return[$field_name][$entity_type_id]);
2013-09-01 06:20:08 +00:00
}
2012-10-30 10:41:42 +00:00
}
}
}
return $return;
2009-08-29 12:52:32 +00:00
}