file.module 72.5 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 85
 * @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use
 *   \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 110
 * @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0. Use
 *   \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
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
133
 *   will rename the file until the $destination is unique.
134 135 136 137
 * - 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.
 *
138
 * @param \Drupal\file\FileInterface $source
139
 *   A file entity.
140
 * @param string $destination
141 142
 *   A string containing the destination that $source should be
 *   copied to. This must be a stream wrapper URI.
143
 * @param int $replace
144 145 146 147 148 149 150 151
 *   (optional) Replace behavior when the destination file already exists.
 *   Possible values include:
 *   - FILE_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.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
152
 *
153 154
 * @return \Drupal\file\FileInterface|false
 *   File entity if the copy is successful, or FALSE in the event of an error.
155 156 157 158
 *
 * @see file_unmanaged_copy()
 * @see hook_file_copy()
 */
159
function file_copy(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
160 161
  /** @var \Drupal\Core\File\FileSystemInterface $file_system */
  $file_system = \Drupal::service('file_system');
162 163 164 165
  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');

  if (!$stream_wrapper_manager->isValidUri($destination)) {
166
    if (($realpath = $file_system->realpath($source->getFileUri())) !== FALSE) {
167
      \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]);
168 169
    }
    else {
170
      \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]);
171
    }
172
    \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()]));
173 174 175
    return FALSE;
  }

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

    $file->save();

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

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

/**
 * 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.
 *
220
 * @param \Drupal\file\FileInterface $source
221
 *   A file entity.
222
 * @param string $destination
223 224
 *   A string containing the destination that $source should be moved
 *   to. This must be a stream wrapper URI.
225
 * @param int $replace
226 227 228 229 230 231 232 233 234
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
 *   - FILE_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.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
235
 *
236
 * @return \Drupal\file\FileInterface|false
237 238
 *   Resulting file entity for success, or FALSE in the event of an error.
 *
239
 * @see \Drupal\Core\File\FileSystemInterface::move()
240 241
 * @see hook_file_move()
 */
242
function file_move(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
243 244
  /** @var \Drupal\Core\File\FileSystemInterface $file_system */
  $file_system = \Drupal::service('file_system');
245 246 247 248
  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');

  if (!$stream_wrapper_manager->isValidUri($destination)) {
249
    if (($realpath = $file_system->realpath($source->getFileUri())) !== FALSE) {
250
      \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]);
251 252
    }
    else {
253
      \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]);
254
    }
255
    \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()]));
256 257 258
    return FALSE;
  }

259 260
  try {
    $uri = $file_system->move($source->getFileUri(), $destination, $replace);
261 262 263
    $delete_source = FALSE;

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

    $file->save();

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

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

    return $file;
  }
293 294 295
  catch (FileException $e) {
    return FALSE;
  }
296 297 298 299 300 301 302 303
}

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

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

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

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

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

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

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

411 412 413 414
  return $errors;
}

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

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

  return $errors;
}

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

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

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

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

  return $errors;
}

/**
 * Saves a file to the specified destination and creates a database entry.
 *
544
 * @param string $data
545
 *   A string containing the contents of the file.
546 547 548 549 550
 * @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://".
551
 * @param int $replace
552 553 554 555 556 557 558 559
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
 *   - FILE_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.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
560
 *
561
 * @return \Drupal\file\FileInterface|false
562 563 564 565 566
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
567
  $user = \Drupal::currentUser();
568 569

  if (empty($destination)) {
570
    $destination = \Drupal::config('system.file')->get('default_scheme') . '://';
571
  }
572 573 574 575

  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');
  if (!$stream_wrapper_manager->isValidUri($destination)) {
576
    \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]);
577
    \Drupal::messenger()->addError(t('The data could not be saved because the destination is invalid. More information is available in the system log.'));
578 579 580
    return FALSE;
  }

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

    $file->save();
    return $file;
  }
610 611 612 613
  catch (FileException $e) {
    return FALSE;
  }

614 615 616 617 618
}

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

629
  return [
630
    'Content-Type' => $type,
631
    'Content-Length' => $file->getSize(),
632
    'Cache-Control' => 'private',
633
  ];
634 635
}

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

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

/**
668
 * Implements hook_file_download().
669
 */
670
function file_file_download($uri) {
671
  // Get the file record based on the URI. If not in the database just return.
672
  /** @var \Drupal\file\FileInterface[] $files */
673
  $files = \Drupal::entityTypeManager()->getStorage('file')->loadByProperties(['uri' => $uri]);
674
  if (count($files)) {
675 676 677
    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.
678
      if ($item->getFileUri() === $uri) {
679 680 681 682
        $file = $item;
        break;
      }
    }
683
  }
684
  if (!isset($file)) {
685 686 687
    return;
  }

688 689 690 691 692 693 694 695 696 697 698 699 700 701
  // 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;
    }
  }

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

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

714
  if (!$file->access('download')) {
715 716 717 718
    return -1;
  }

  // Access is granted.
719 720
  $headers = file_get_content_headers($file);
  return $headers;
721 722
}

723
/**
724
 * Implements hook_cron().
725 726
 */
function file_cron() {
727
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');
728
  $file_storage = \Drupal::entityTypeManager()->getStorage('file');
729

730 731 732
  /** @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager */
  $stream_wrapper_manager = \Drupal::service('stream_wrapper_manager');

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

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
/**
 * 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:
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
 *
 * @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
792 793 794 795
 *   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.
796
 *
797 798
 * @see https://www.drupal.org/project/drupal/issues/3069020
 * @see https://www.drupal.org/project/drupal/issues/2482783
799 800 801 802
 */
function _file_save_upload_from_form(array $element, FormStateInterface $form_state, $delta = NULL, $replace = FILE_EXISTS_RENAME) {
  // Get all errors set before calling this method. This will also clear them
  // from $_SESSION.
803
  $errors_before = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
804 805 806 807 808 809 810 811 812

  $upload_location = isset($element['#upload_location']) ? $element['#upload_location'] : FALSE;
  $upload_name = implode('_', $element['#parents']);
  $upload_validators = isset($element['#upload_validators']) ? $element['#upload_validators'] : [];

  $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
  // will also clear them from $_SESSION.
813 814
  $errors_new = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
  if (!empty($errors_new)) {
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

    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.
839 840 841
  if (!empty($errors_before)) {
    foreach ($errors_before as $error) {
      \Drupal::messenger()->addError($error);
842 843 844