file.module 72.8 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Defines a "managed_file" Form API field and a "file" field for Field module.
 */

8
use Drupal\Component\Utility\Environment;
9
use Drupal\Core\Datetime\Entity\DateFormat;
10
use Drupal\Core\Field\FieldDefinitionInterface;
11 12
use Drupal\Core\File\Exception\FileException;
use Drupal\Core\File\FileSystemInterface;
13
use Drupal\Core\Form\FormStateInterface;
14
use Drupal\Core\Messenger\MessengerInterface;
15
use Drupal\Core\Render\BubbleableMetadata;
16
use Drupal\Core\Render\Element;
17
use Drupal\Core\Routing\RouteMatchInterface;
18
use Drupal\Core\Link;
19
use Drupal\Core\Url;
20
use Drupal\file\Entity\File;
21
use Drupal\file\FileInterface;
22
use Drupal\Component\Utility\NestedArray;
23
use Drupal\Component\Utility\Unicode;
24
use Drupal\Core\Entity\EntityStorageInterface;
25
use Drupal\Core\Template\Attribute;
26

27 28 29
/**
 * The regex pattern used when checking for insecure file types.
 */
30
define('FILE_INSECURE_EXTENSION_REGEX', '/\.(phar|php|pl|py|cgi|asp|js)(\.|$)/i');
31

32
// Load all Field module hooks for File.
33
require_once __DIR__ . '/file.field.inc';
34

35 36 37
/**
 * Implements hook_help().
 */
38
function file_help($route_name, RouteMatchInterface $route_match) {
39 40
  switch ($route_name) {
    case 'help.page.file':
41 42
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
43
      $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>';
44 45
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
46
      $output .= '<dt>' . t('Managing and displaying file fields') . '</dt>';
47
      $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>';
48 49
      $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>';
50
      $output .= '<dt>' . t('Storing files') . '</dt>';
51
      $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>';
52 53 54 55
      $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>';
56 57 58 59 60
      $output .= '</dl>';
      return $output;
  }
}

61 62 63 64 65 66 67 68 69 70
/**
 * 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';
}

71 72 73
/**
 * Loads file entities from the database.
 *
74 75 76
 * @param array|null $fids
 *   (optional) An array of entity IDs. If omitted or NULL, all entities are
 *   loaded.
77
 * @param bool $reset
78 79
 *   (optional) Whether to reset the internal file_load_multiple() cache.
 *   Defaults to FALSE.
80 81 82 83
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
84
 * @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Use
85
 *   \Drupal\file\Entity\File::loadMultiple().
86
 *
87
 * @see https://www.drupal.org/node/2266845
88
 */
89
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
90
  @trigger_error('file_load_multiple() is deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal\file\Entity\File::loadMultiple(). See https://www.drupal.org/node/2266845', E_USER_DEPRECATED);
91
  if ($reset) {
92
    \Drupal::entityTypeManager()->getStorage('file')->resetCache($fids);
93 94
  }
  return File::loadMultiple($fids);
95 96 97 98 99
}

/**
 * Loads a single file entity from the database.
 *
100
 * @param int $fid
101
 *   A file ID.
102
 * @param bool $reset
103 104
 *   (optional) Whether to reset the internal file_load_multiple() cache.
 *   Defaults to FALSE.
105
 *
106
 * @return \Drupal\file\FileInterface|null
107
 *   A file entity or NULL if the file was not found.
108
 *
109
 * @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Use
110
 *   \Drupal\file\Entity\File::load().
111
 *
112
 * @see https://www.drupal.org/node/2266845
113
 */
114
function file_load($fid, $reset = FALSE) {
115
  @trigger_error('file_load() is deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use \Drupal\file\Entity\File::load(). See https://www.drupal.org/node/2266845', E_USER_DEPRECATED);
116
  if ($reset) {
117
    \Drupal::entityTypeManager()->getStorage('file')->resetCache([$fid]);
118 119
  }
  return File::load($fid);
120 121 122 123 124 125 126 127 128 129 130
}

/**
 * Copies a file to a new location and adds a file record to the database.
 *
 * This function should be used when manipulating files that have records
 * stored in the database. This is a powerful function that in many ways
 * performs like an advanced version of copy().
 * - Checks if $source and $destination are valid and readable/writable.
 * - If file already exists in $destination either the call will error out,
 *   replace the file or rename the file based on the $replace parameter.
131
 * - If the $source and $destination are equal, the behavior depends on the
132 133 134
 *   $replace parameter. FileSystemInterface::EXISTS_REPLACE will error out.
 *   FileSystemInterface::EXISTS_RENAME will rename the file until the
 *   $destination is unique.
135 136 137 138
 * - Adds the new file to the files database. If the source file is a
 *   temporary file, the resulting file will also be a temporary file. See
 *   file_save_upload() for details on temporary files.
 *
139
 * @param \Drupal\file\FileInterface $source
140
 *   A file entity.
141
 * @param string $destination
142 143
 *   A string containing the destination that $source should be
 *   copied to. This must be a stream wrapper URI.
144
 * @param int $replace
145 146
 *   (optional) Replace behavior when the destination file already exists.
 *   Possible values include:
147 148 149 150 151 152 153
 *   - FileSystemInterface::EXISTS_REPLACE: Replace the existing file. If a
 *     managed file with the destination name exists, then its database entry
 *     will be updated. If no database entry is found, then a new one will be
 *     created.
 *   - FileSystemInterface::EXISTS_RENAME: (default) Append
 *     _{incrementing number} until the filename is unique.
 *   - FileSystemInterface::EXISTS_ERROR: Do nothing and return FALSE.
154
 *
155 156
 * @return \Drupal\file\FileInterface|false
 *   File entity if the copy is successful, or FALSE in the event of an error.
157 158 159 160
 *
 * @see file_unmanaged_copy()
 * @see hook_file_copy()
 */
161
function file_copy(FileInterface $source, $destination = NULL, $replace = FileSystemInterface::EXISTS_RENAME) {
162 163
  /** @var \Drupal\Core\File\FileSystemInterface $file_system */
  $file_system = \Drupal::service('file_system');
164 165 166 167
  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');

  if (!$stream_wrapper_manager->isValidUri($destination)) {
168
    if (($realpath = $file_system->realpath($source->getFileUri())) !== FALSE) {
169
      \Drupal::logger('file')->notice('File %file (%realpath) could not be copied because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination]);
170 171
    }
    else {
172
      \Drupal::logger('file')->notice('File %file could not be copied because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%destination' => $destination]);
173
    }
174
    \Drupal::messenger()->addError(t('The specified file %file could not be copied because the destination is invalid. More information is available in the system log.', ['%file' => $source->getFileUri()]));
175 176 177
    return FALSE;
  }

178 179
  try {
    $uri = $file_system->copy($source->getFileUri(), $destination, $replace);
180 181
    $file = $source->createDuplicate();
    $file->setFileUri($uri);
182
    $file->setFilename($file_system->basename($uri));
183
    // If we are replacing an existing file re-use its database record.
184 185
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
186
    if ($replace == FileSystemInterface::EXISTS_REPLACE) {
187
      $existing_files = \Drupal::entityTypeManager()->getStorage('file')->loadByProperties(['uri' => $uri]);
188 189
      if (count($existing_files)) {
        $existing = reset($existing_files);
190
        $file->fid = $existing->id();
191
        $file->setOriginalId($existing->id());
192
        $file->setFilename($existing->getFilename());
193 194 195 196
      }
    }
    // If we are renaming around an existing file (rather than a directory),
    // use its basename for the filename.
197
    elseif ($replace == FileSystemInterface::EXISTS_RENAME && is_file($destination)) {
198
      $file->setFilename($file_system->basename($destination));
199 200 201 202 203
    }

    $file->save();

    // Inform modules that the file has been copied.
204
    \Drupal::moduleHandler()->invokeAll('file_copy', [$file, $source]);
205 206 207

    return $file;
  }
208 209 210
  catch (FileException $e) {
    return FALSE;
  }
211 212 213 214 215 216 217 218 219 220 221
}

/**
 * Moves a file to a new location and update the file's database entry.
 *
 * - Checks if $source and $destination are valid and readable/writable.
 * - Performs a file move if $source is not equal to $destination.
 * - If file already exists in $destination either the call will error out,
 *   replace the file or rename the file based on the $replace parameter.
 * - Adds the new file to the files database.
 *
222
 * @param \Drupal\file\FileInterface $source
223
 *   A file entity.
224
 * @param string $destination
225 226
 *   A string containing the destination that $source should be moved
 *   to. This must be a stream wrapper URI.
227
 * @param int $replace
228 229
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
230 231 232 233 234 235 236 237
 *   - FileSystemInterface::EXISTS_REPLACE: Replace the existing file. If a
 *     managed file with the destination name exists then its database entry
 *     will be updated and $source->delete() called after invoking
 *     hook_file_move(). If no database entry is found, then the source files
 *     record will be updated.
 *   - FileSystemInterface::EXISTS_RENAME: (default) Append
 *     _{incrementing number} until the filename is unique.
 *   - FileSystemInterface::EXISTS_ERROR: Do nothing and return FALSE.
238
 *
239
 * @return \Drupal\file\FileInterface|false
240 241
 *   Resulting file entity for success, or FALSE in the event of an error.
 *
242
 * @see \Drupal\Core\File\FileSystemInterface::move()
243 244
 * @see hook_file_move()
 */
245
function file_move(FileInterface $source, $destination = NULL, $replace = FileSystemInterface::EXISTS_RENAME) {
246 247
  /** @var \Drupal\Core\File\FileSystemInterface $file_system */
  $file_system = \Drupal::service('file_system');
248 249 250 251
  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');

  if (!$stream_wrapper_manager->isValidUri($destination)) {
252
    if (($realpath = $file_system->realpath($source->getFileUri())) !== FALSE) {
253
      \Drupal::logger('file')->notice('File %file (%realpath) could not be moved because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination]);
254 255
    }
    else {
256
      \Drupal::logger('file')->notice('File %file could not be moved because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%destination' => $destination]);
257
    }
258
    \Drupal::messenger()->addError(t('The specified file %file could not be moved because the destination is invalid. More information is available in the system log.', ['%file' => $source->getFileUri()]));
259 260 261
    return FALSE;
  }

262 263
  try {
    $uri = $file_system->move($source->getFileUri(), $destination, $replace);
264 265 266
    $delete_source = FALSE;

    $file = clone $source;
267
    $file->setFileUri($uri);
268
    // If we are replacing an existing file re-use its database record.
269
    if ($replace == FileSystemInterface::EXISTS_REPLACE) {
270
      $existing_files = \Drupal::entityTypeManager()->getStorage('file')->loadByProperties(['uri' => $uri]);
271 272 273
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $delete_source = TRUE;
274
        $file->fid = $existing->id();
275
        $file->uuid = $existing->uuid();
276 277 278 279
      }
    }
    // If we are renaming around an existing file (rather than a directory),
    // use its basename for the filename.
280
    elseif ($replace == FileSystemInterface::EXISTS_RENAME && is_file($destination)) {
281
      $file->setFilename(\Drupal::service('file_system')->basename($destination));
282 283 284 285 286
    }

    $file->save();

    // Inform modules that the file has been moved.
287
    \Drupal::moduleHandler()->invokeAll('file_move', [$file, $source]);
288 289

    // Delete the original if it's not in use elsewhere.
290
    if ($delete_source && !\Drupal::service('file.usage')->listUsage($source)) {
291 292 293 294 295
      $source->delete();
    }

    return $file;
  }
296 297 298
  catch (FileException $e) {
    return FALSE;
  }
299 300 301 302 303 304 305 306
}

/**
 * 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.
 *
307
 * @param \Drupal\file\FileInterface $file
308
 *   A file entity.
309
 * @param array $validators
310 311 312 313 314 315 316
 *   (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.
317
 *
318
 * @return array
319 320 321 322
 *   An array containing validation error messages.
 *
 * @see hook_file_validate()
 */
323
function file_validate(FileInterface $file, $validators = []) {
324
  // Call the validation functions specified by this function's caller.
325
  $errors = [];
326 327 328 329 330 331 332 333
  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.
334
  return array_merge($errors, \Drupal::moduleHandler()->invokeAll('file_validate', [$file]));
335 336 337 338 339
}

/**
 * Checks for files with names longer than can be stored in the database.
 *
340
 * @param \Drupal\file\FileInterface $file
341 342
 *   A file entity.
 *
343
 * @return array
344 345
 *   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.
346
 */
347
function file_validate_name_length(FileInterface $file) {
348
  $errors = [];
349

350
  if (!$file->getFilename()) {
351 352
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
353
  if (strlen($file->getFilename()) > 240) {
354 355 356 357 358 359 360 361
    $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.
 *
362
 * @param \Drupal\file\FileInterface $file
363
 *   A file entity.
364
 * @param string $extensions
365 366
 *   A string with a space separated list of allowed extensions.
 *
367
 * @return array
368 369
 *   An empty array if the file extension is allowed or an array containing an
 *   error message if it's not.
370 371 372
 *
 * @see hook_file_validate()
 */
373
function file_validate_extensions(FileInterface $file, $extensions) {
374
  $errors = [];
375 376

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
377
  if (!preg_match($regex, $file->getFilename())) {
378
    $errors[] = t('Only files with the following extensions are allowed: %files-allowed.', ['%files-allowed' => $extensions]);
379 380 381 382 383 384 385
  }
  return $errors;
}

/**
 * Checks that the file's size is below certain limits.
 *
386
 * @param \Drupal\file\FileInterface $file
387
 *   A file entity.
388
 * @param int $file_limit
389 390
 *   (optional) The maximum file size in bytes. Zero (the default) indicates
 *   that no limit should be enforced.
391
 * @param int $user_limit
392 393
 *   (optional) The maximum number of bytes the user is allowed. Zero (the
 *   default) indicates that no limit should be enforced.
394
 *
395
 * @return array
396 397
 *   An empty array if the file size is below limits or an array containing an
 *   error message if it's not.
398 399 400
 *
 * @see hook_file_validate()
 */
401
function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = 0) {
402
  $user = \Drupal::currentUser();
403
  $errors = [];
404

405
  if ($file_limit && $file->getSize() > $file_limit) {
406
    $errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', ['%filesize' => format_size($file->getSize()), '%maxsize' => format_size($file_limit)]);
407
  }
408

409
  // Save a query by only calling spaceUsed() when a limit is provided.
410
  if ($user_limit && (\Drupal::entityTypeManager()->getStorage('file')->spaceUsed($user->id()) + $file->getSize()) > $user_limit) {
411
    $errors[] = t('The file is %filesize which would exceed your disk quota of %quota.', ['%filesize' => format_size($file->getSize()), '%quota' => format_size($user_limit)]);
412
  }
413

414 415 416 417
  return $errors;
}

/**
418
 * Checks that the file is recognized as a valid image.
419
 *
420
 * @param \Drupal\file\FileInterface $file
421 422
 *   A file entity.
 *
423
 * @return array
424 425
 *   An empty array if the file is a valid image or an array containing an error
 *   message if it's not.
426 427 428
 *
 * @see hook_file_validate()
 */
429
function file_validate_is_image(FileInterface $file) {
430
  $errors = [];
431

432 433 434 435
  $image_factory = \Drupal::service('image.factory');
  $image = $image_factory->get($file->getFileUri());
  if (!$image->isValid()) {
    $supported_extensions = $image_factory->getSupportedExtensions();
436
    $errors[] = t('The image file is invalid or the image type is not allowed. Allowed types: %types', ['%types' => implode(', ', $supported_extensions)]);
437 438 439 440 441 442 443 444
  }

  return $errors;
}

/**
 * Verifies that image dimensions are within the specified maximum and minimum.
 *
445
 * Non-image files will be ignored. If an image toolkit is available the image
446 447
 * will be scaled to fit within the desired maximum dimensions.
 *
448
 * @param \Drupal\file\FileInterface $file
449
 *   A file entity. This function may resize the file affecting its size.
450 451 452 453 454 455 456 457 458
 * @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.
459
 *
460 461 462 463 464
 * @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.
465 466 467
 *
 * @see hook_file_validate()
 */
468
function file_validate_image_resolution(FileInterface $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
469
  $errors = [];
470 471

  // Check first that the file is an image.
472
  $image_factory = \Drupal::service('image.factory');
473
  $image = $image_factory->get($file->getFileUri());
474

475
  if ($image->isValid()) {
476
    $scaling = FALSE;
477 478 479
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
480
      if ($image->getWidth() > $width || $image->getHeight() > $height) {
481
        // Try to resize the image to fit the dimensions.
482
        if ($image->scale($width, $height)) {
483
          $scaling = TRUE;
484
          $image->save();
485
          if (!empty($width) && !empty($height)) {
486 487 488 489 490 491
            $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(),
              ]);
492 493
          }
          elseif (empty($width)) {
494 495 496 497 498 499
            $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(),
              ]);
500 501
          }
          elseif (empty($height)) {
502 503 504 505 506 507
            $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(),
              ]);
508
          }
509
          \Drupal::messenger()->addStatus($message);
510 511
        }
        else {
512
          $errors[] = t('The image exceeds the maximum allowed dimensions and an attempt to resize it failed.');
513 514 515 516 517 518 519
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
520
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
        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(),
            ]);
        }
537 538 539 540 541 542 543 544 545 546
      }
    }
  }

  return $errors;
}

/**
 * Saves a file to the specified destination and creates a database entry.
 *
547
 * @param string $data
548
 *   A string containing the contents of the file.
549 550 551 552 553
 * @param string|null $destination
 *   (optional) A string containing the destination URI. This must be a stream
 *   wrapper URI. If no value or NULL is provided, a randomized name will be
 *   generated and the file will be saved using Drupal's default files scheme,
 *   usually "public://".
554
 * @param int $replace
555 556
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
557 558 559 560 561 562 563
 *   - FileSystemInterface::EXISTS_REPLACE: Replace the existing file. If a
 *     managed file with the destination name exists, then its database entry
 *     will be updated. If no database entry is found, then a new one will be
 *     created.
 *   - FileSystemInterface::EXISTS_RENAME: (default) Append
 *     _{incrementing number} until the filename is unique.
 *   - FileSystemInterface::EXISTS_ERROR: Do nothing and return FALSE.
564
 *
565
 * @return \Drupal\file\FileInterface|false
566 567 568 569
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
570
function file_save_data($data, $destination = NULL, $replace = FileSystemInterface::EXISTS_RENAME) {
571
  $user = \Drupal::currentUser();
572 573

  if (empty($destination)) {
574
    $destination = \Drupal::config('system.file')->get('default_scheme') . '://';
575
  }
576 577 578 579

  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
  if (!$stream_wrapper_manager->isValidUri($destination)) {
580
    \Drupal::logger('file')->notice('The data could not be saved because the destination %destination is invalid. This may be caused by improper use of file_save_data() or a missing stream wrapper.', ['%destination' => $destination]);
581
    \Drupal::messenger()->addError(t('The data could not be saved because the destination is invalid. More information is available in the system log.'));
582 583 584
    return FALSE;
  }

585 586
  try {
    $uri = \Drupal::service('file_system')->saveData($data, $destination, $replace);
587
    // Create a file entity.
588
    $file = File::create([
589
      'uri' => $uri,
590
      'uid' => $user->id(),
591
      'status' => FILE_STATUS_PERMANENT,
592
    ]);
593
    // If we are replacing an existing file re-use its database record.
594 595
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
596
    if ($replace == FileSystemInterface::EXISTS_REPLACE) {
597
      $existing_files = \Drupal::entityTypeManager()->getStorage('file')->loadByProperties(['uri' => $uri]);
598 599
      if (count($existing_files)) {
        $existing = reset($existing_files);
600
        $file->fid = $existing->id();
601
        $file->setOriginalId($existing->id());
602
        $file->setFilename($existing->getFilename());
603 604 605 606
      }
    }
    // If we are renaming around an existing file (rather than a directory),
    // use its basename for the filename.
607
    elseif ($replace == FileSystemInterface::EXISTS_RENAME && is_file($destination)) {
608
      $file->setFilename(\Drupal::service('file_system')->basename($destination));
609 610 611 612 613
    }

    $file->save();
    return $file;
  }
614 615 616 617
  catch (FileException $e) {
    return FALSE;
  }

618 619 620 621 622
}

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
623
 * @param \Drupal\file\FileInterface $file
624 625
 *   A file entity.
 *
626
 * @return array
627 628 629
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
630
function file_get_content_headers(FileInterface $file) {
631
  $type = Unicode::mimeHeaderEncode($file->getMimeType());
632

633
  return [
634
    'Content-Type' => $type,
635
    'Content-Length' => $file->getSize(),
636
    'Cache-Control' => 'private',
637
  ];
638 639
}

640
/**
641
 * Implements hook_theme().
642 643
 */
function file_theme() {
644
  return [
645
    // From file.module.
646 647 648 649
    'file_link' => [
      'variables' => ['file' => NULL, 'description' => NULL, 'attributes' => []],
    ],
    'file_managed_file' => [
650
      'render element' => 'element',
651
    ],
652 653 654 655 656 657
    'file_audio' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
    'file_video' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
658

659
    // From file.field.inc.
660
    'file_widget_multiple' => [
661
      'render element' => 'element',
662
      'file' => 'file.field.inc',
663 664 665
    ],
    'file_upload_help' => [
      'variables' => ['description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL],
666
      'file' => 'file.field.inc',
667 668
    ],
  ];
669 670 671
}

/**
672
 * Implements hook_file_download().
673
 */
674
function file_file_download($uri) {
675
  // Get the file record based on the URI. If not in the database just return.
676
  /** @var \Drupal\file\FileInterface[] $files */
677
  $files = \Drupal::entityTypeManager()->getStorage('file')->loadByProperties(['uri' => $uri]);
678
  if (count($files)) {
679 680 681
    foreach ($files as $item) {
      // Since some database servers sometimes use a case-insensitive comparison
      // by default, double check that the filename is an exact match.
682
      if ($item->getFileUri() === $uri) {
683 684 685 686
        $file = $item;
        break;
      }
    }
687
  }
688
  if (!isset($file)) {
689 690 691
    return;
  }

692 693 694 695 696 697 698 699 700 701 702 703 704 705
  // 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;
    }
  }

706
  // Find out which (if any) fields of this type contain the file.
707
  $references = file_get_file_references($file, NULL, EntityStorageInterface::FIELD_LOAD_CURRENT, NULL);
708

709 710 711 712 713
  // 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.
714
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
715
    return;
716 717
  }

718
  if (!$file->access('download')) {
719 720 721 722
    return -1;
  }

  // Access is granted.
723 724
  $headers = file_get_content_headers($file);
  return $headers;
725 726
}

727
/**
728
 * Implements hook_cron().
729 730
 */
function file_cron() {
731
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');
732
  $file_storage = \Drupal::entityTypeManager()->getStorage('file');
733

734 735 736
  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');

737 738 739 740 741 742 743 744
  // 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')
      ->condition('status', FILE_STATUS_PERMANENT, '<>')
      ->condition('changed', REQUEST_TIME - $age, '<')
      ->range(0, 100)
      ->execute();
745
    $files = $file_storage->loadMultiple($fids);
746
    foreach ($files as $file) {
747
      $references = \Drupal::service('file.usage')->listUsage($file);
748
      if (empty($references)) {
749
        if (!file_exists($file->getFileUri())) {
750
          if (!$stream_wrapper_manager->isValidUri($file->getFileUri())) {
751 752 753 754 755
            \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()]);
          }
756
        }
757 758 759
        // Delete the file entity. If the file does not exist, this will
        // generate a second notice in the watchdog.
        $file->delete();
760 761
      }
      else {
762
        \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))]);
763 764 765 766 767
      }
    }
  }
}

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
/**
 * 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:
785 786 787 788
 *   - 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.
789 790 791 792 793 794 795
 *
 * @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
796 797 798 799
 *   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.
800
 *
801 802
 * @see https://www.drupal.org/project/drupal/issues/3069020
 * @see https://www.drupal.org/project/drupal/issues/2482783
803
 */
804
function _file_save_upload_from_form(array $element, FormStateInterface $form_state, $delta = NULL, $replace = FileSystemInterface::EXISTS_RENAME) {
805 806
  // Get all errors set before calling this method. This will also clear them
  // from $_SESSION.
807
  $errors_before = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
808 809 810 811 812 813 814 815 816

  $upload_location = isset($element