file.module 68.9 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\Core\Datetime\Entity\DateFormat;
9
use Drupal\Core\Field\FieldDefinitionInterface;
10
use Drupal\Core\Form\FormStateInterface;
11
use Drupal\Core\Messenger\MessengerInterface;
12
use Drupal\Core\Render\BubbleableMetadata;
13
use Drupal\Core\Render\Element;
14
use Drupal\Core\Routing\RouteMatchInterface;
15
use Drupal\Core\Url;
16
use Drupal\file\Entity\File;
17
use Drupal\file\FileInterface;
18
use Drupal\Component\Utility\NestedArray;
19
use Drupal\Component\Utility\Unicode;
20
use Drupal\Core\Entity\EntityStorageInterface;
21
use Drupal\Core\Template\Attribute;
22

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

28
// Load all Field module hooks for File.
29
require_once __DIR__ . '/file.field.inc';
30

31 32 33
/**
 * Implements hook_help().
 */
34
function file_help($route_name, RouteMatchInterface $route_match) {
35 36
  switch ($route_name) {
    case 'help.page.file':
37 38
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
39
      $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' => \Drupal::url('help.page', ['name' => 'field']), ':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#', ':file_documentation' => 'https://www.drupal.org/documentation/modules/file']) . '</p>';
40 41
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
42
      $output .= '<dt>' . t('Managing and displaying file fields') . '</dt>';
43
      $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')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#']) . '</dd>';
44 45
      $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>';
46
      $output .= '<dt>' . t('Storing files') . '</dt>';
47
      $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' => \Drupal::url('system.file_system_settings'), ':system-help' => \Drupal::url('help.page', ['name' => 'system'])]) . '</dd>';
48 49 50 51
      $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>';
52 53 54 55 56
      $output .= '</dl>';
      return $output;
  }
}

57 58 59 60 61 62 63 64 65 66
/**
 * 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';
}

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

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

/**
 * 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.
127
 * - If the $source and $destination are equal, the behavior depends on the
128
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
129
 *   will rename the file until the $destination is unique.
130 131 132 133
 * - 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.
 *
134
 * @param \Drupal\file\FileInterface $source
135
 *   A file entity.
136
 * @param string $destination
137 138
 *   A string containing the destination that $source should be
 *   copied to. This must be a stream wrapper URI.
139
 * @param int $replace
140 141 142 143 144 145 146 147
 *   (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.
148
 *
149 150
 * @return \Drupal\file\FileInterface|false
 *   File entity if the copy is successful, or FALSE in the event of an error.
151 152 153 154
 *
 * @see file_unmanaged_copy()
 * @see hook_file_copy()
 */
155
function file_copy(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
156
  if (!file_valid_uri($destination)) {
157
    if (($realpath = \Drupal::service('file_system')->realpath($source->getFileUri())) !== FALSE) {
158
      \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]);
159 160
    }
    else {
161
      \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]);
162
    }
163
    \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()]));
164 165 166
    return FALSE;
  }

167
  if ($uri = file_unmanaged_copy($source->getFileUri(), $destination, $replace)) {
168 169 170
    $file = $source->createDuplicate();
    $file->setFileUri($uri);
    $file->setFilename(drupal_basename($uri));
171
    // If we are replacing an existing file re-use its database record.
172 173
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
174
    if ($replace == FILE_EXISTS_REPLACE) {
175
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
176 177
      if (count($existing_files)) {
        $existing = reset($existing_files);
178
        $file->fid = $existing->id();
179
        $file->setOriginalId($existing->id());
180
        $file->setFilename($existing->getFilename());
181 182 183 184 185
      }
    }
    // 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)) {
186
      $file->setFilename(drupal_basename($destination));
187 188 189 190 191
    }

    $file->save();

    // Inform modules that the file has been copied.
192
    \Drupal::moduleHandler()->invokeAll('file_copy', [$file, $source]);
193 194 195

    return $file;
  }
196
  return FALSE;
197 198 199 200 201 202 203 204 205 206 207
}

/**
 * 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.
 *
208
 * @param \Drupal\file\FileInterface $source
209
 *   A file entity.
210
 * @param string $destination
211 212
 *   A string containing the destination that $source should be moved
 *   to. This must be a stream wrapper URI.
213
 * @param int $replace
214 215 216 217 218 219 220 221 222
 *   (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.
223
 *
224
 * @return \Drupal\file\FileInterface|false
225 226
 *   Resulting file entity for success, or FALSE in the event of an error.
 *
227
 * @see file_unmanaged_move()
228 229
 * @see hook_file_move()
 */
230
function file_move(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
231
  if (!file_valid_uri($destination)) {
232
    if (($realpath = \Drupal::service('file_system')->realpath($source->getFileUri())) !== FALSE) {
233
      \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]);
234 235
    }
    else {
236
      \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]);
237
    }
238
    \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()]));
239 240 241
    return FALSE;
  }

242
  if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
243 244 245
    $delete_source = FALSE;

    $file = clone $source;
246
    $file->setFileUri($uri);
247 248
    // If we are replacing an existing file re-use its database record.
    if ($replace == FILE_EXISTS_REPLACE) {
249
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
250 251 252
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $delete_source = TRUE;
253
        $file->fid = $existing->id();
254
        $file->uuid = $existing->uuid();
255 256 257 258 259
      }
    }
    // 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)) {
260
      $file->setFilename(drupal_basename($destination));
261 262 263 264 265
    }

    $file->save();

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

    // Delete the original if it's not in use elsewhere.
269
    if ($delete_source && !\Drupal::service('file.usage')->listUsage($source)) {
270 271 272 273 274
      $source->delete();
    }

    return $file;
  }
275
  return FALSE;
276 277 278 279 280 281 282 283
}

/**
 * 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.
 *
284
 * @param \Drupal\file\FileInterface $file
285
 *   A file entity.
286
 * @param array $validators
287 288 289 290 291 292 293
 *   (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.
294
 *
295
 * @return array
296 297 298 299
 *   An array containing validation error messages.
 *
 * @see hook_file_validate()
 */
300
function file_validate(FileInterface $file, $validators = []) {
301
  // Call the validation functions specified by this function's caller.
302
  $errors = [];
303 304 305 306 307 308 309 310
  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.
311
  return array_merge($errors, \Drupal::moduleHandler()->invokeAll('file_validate', [$file]));
312 313 314 315 316
}

/**
 * Checks for files with names longer than can be stored in the database.
 *
317
 * @param \Drupal\file\FileInterface $file
318 319
 *   A file entity.
 *
320
 * @return array
321 322
 *   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.
323
 */
324
function file_validate_name_length(FileInterface $file) {
325
  $errors = [];
326

327
  if (!$file->getFilename()) {
328 329
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
330
  if (strlen($file->getFilename()) > 240) {
331 332 333 334 335 336 337 338
    $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.
 *
339
 * @param \Drupal\file\FileInterface $file
340
 *   A file entity.
341
 * @param string $extensions
342 343
 *   A string with a space separated list of allowed extensions.
 *
344
 * @return array
345 346
 *   An empty array if the file extension is allowed or an array containing an
 *   error message if it's not.
347 348 349
 *
 * @see hook_file_validate()
 */
350
function file_validate_extensions(FileInterface $file, $extensions) {
351
  $errors = [];
352 353

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
354
  if (!preg_match($regex, $file->getFilename())) {
355
    $errors[] = t('Only files with the following extensions are allowed: %files-allowed.', ['%files-allowed' => $extensions]);
356 357 358 359 360 361 362
  }
  return $errors;
}

/**
 * Checks that the file's size is below certain limits.
 *
363
 * @param \Drupal\file\FileInterface $file
364
 *   A file entity.
365
 * @param int $file_limit
366 367
 *   (optional) The maximum file size in bytes. Zero (the default) indicates
 *   that no limit should be enforced.
368
 * @param int $user_limit
369 370
 *   (optional) The maximum number of bytes the user is allowed. Zero (the
 *   default) indicates that no limit should be enforced.
371
 *
372
 * @return array
373 374
 *   An empty array if the file size is below limits or an array containing an
 *   error message if it's not.
375 376 377
 *
 * @see hook_file_validate()
 */
378
function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = 0) {
379
  $user = \Drupal::currentUser();
380
  $errors = [];
381

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

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

391 392 393 394
  return $errors;
}

/**
395
 * Checks that the file is recognized as a valid image.
396
 *
397
 * @param \Drupal\file\FileInterface $file
398 399
 *   A file entity.
 *
400
 * @return array
401 402
 *   An empty array if the file is a valid image or an array containing an error
 *   message if it's not.
403 404 405
 *
 * @see hook_file_validate()
 */
406
function file_validate_is_image(FileInterface $file) {
407
  $errors = [];
408

409 410 411 412
  $image_factory = \Drupal::service('image.factory');
  $image = $image_factory->get($file->getFileUri());
  if (!$image->isValid()) {
    $supported_extensions = $image_factory->getSupportedExtensions();
413
    $errors[] = t('The image file is invalid or the image type is not allowed. Allowed types: %types', ['%types' => implode(', ', $supported_extensions)]);
414 415 416 417 418 419 420 421
  }

  return $errors;
}

/**
 * Verifies that image dimensions are within the specified maximum and minimum.
 *
422
 * Non-image files will be ignored. If an image toolkit is available the image
423 424
 * will be scaled to fit within the desired maximum dimensions.
 *
425
 * @param \Drupal\file\FileInterface $file
426
 *   A file entity. This function may resize the file affecting its size.
427 428 429 430 431 432 433 434 435
 * @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.
436
 *
437 438 439 440 441
 * @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.
442 443 444
 *
 * @see hook_file_validate()
 */
445
function file_validate_image_resolution(FileInterface $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
446
  $errors = [];
447 448

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

452
  if ($image->isValid()) {
453
    $scaling = FALSE;
454 455 456
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
457
      if ($image->getWidth() > $width || $image->getHeight() > $height) {
458
        // Try to resize the image to fit the dimensions.
459
        if ($image->scale($width, $height)) {
460
          $scaling = TRUE;
461
          $image->save();
462
          if (!empty($width) && !empty($height)) {
463 464 465 466 467 468
            $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(),
              ]);
469 470
          }
          elseif (empty($width)) {
471 472 473 474 475 476
            $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(),
              ]);
477 478
          }
          elseif (empty($height)) {
479 480 481 482 483 484
            $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(),
              ]);
485
          }
486
          \Drupal::messenger()->addStatus($message);
487 488
        }
        else {
489
          $errors[] = t('The image exceeds the maximum allowed dimensions and an attempt to resize it failed.');
490 491 492 493 494 495 496
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
497
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
        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(),
            ]);
        }
514 515 516 517 518 519 520 521 522 523
      }
    }
  }

  return $errors;
}

/**
 * Saves a file to the specified destination and creates a database entry.
 *
524
 * @param string $data
525
 *   A string containing the contents of the file.
526 527 528 529 530
 * @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://".
531
 * @param int $replace
532 533 534 535 536 537 538 539
 *   (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.
540
 *
541
 * @return \Drupal\file\FileInterface|false
542 543 544 545 546
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
547
  $user = \Drupal::currentUser();
548 549 550 551 552

  if (empty($destination)) {
    $destination = file_default_scheme() . '://';
  }
  if (!file_valid_uri($destination)) {
553
    \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]);
554
    \Drupal::messenger()->addError(t('The data could not be saved because the destination is invalid. More information is available in the system log.'));
555 556 557
    return FALSE;
  }

558
  if ($uri = file_unmanaged_save_data($data, $destination, $replace)) {
559
    // Create a file entity.
560
    $file = File::create([
561
      'uri' => $uri,
562
      'uid' => $user->id(),
563
      'status' => FILE_STATUS_PERMANENT,
564
    ]);
565
    // If we are replacing an existing file re-use its database record.
566 567
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
568
    if ($replace == FILE_EXISTS_REPLACE) {
569
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
570 571
      if (count($existing_files)) {
        $existing = reset($existing_files);
572
        $file->fid = $existing->id();
573
        $file->setOriginalId($existing->id());
574
        $file->setFilename($existing->getFilename());
575 576 577 578 579
      }
    }
    // 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)) {
580
      $file->setFilename(drupal_basename($destination));
581 582 583 584 585
    }

    $file->save();
    return $file;
  }
586
  return FALSE;
587 588 589 590 591
}

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
592
 * @param \Drupal\file\FileInterface $file
593 594
 *   A file entity.
 *
595
 * @return array
596 597 598
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
599
function file_get_content_headers(FileInterface $file) {
600
  $type = Unicode::mimeHeaderEncode($file->getMimeType());
601

602
  return [
603
    'Content-Type' => $type,
604
    'Content-Length' => $file->getSize(),
605
    'Cache-Control' => 'private',
606
  ];
607 608
}

609
/**
610
 * Implements hook_theme().
611 612
 */
function file_theme() {
613
  return [
614
    // From file.module.
615 616 617 618
    'file_link' => [
      'variables' => ['file' => NULL, 'description' => NULL, 'attributes' => []],
    ],
    'file_managed_file' => [
619
      'render element' => 'element',
620
    ],
621 622 623 624 625 626
    'file_audio' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
    'file_video' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
627

628
    // From file.field.inc.
629
    'file_widget_multiple' => [
630
      'render element' => 'element',
631
      'file' => 'file.field.inc',
632 633 634
    ],
    'file_upload_help' => [
      'variables' => ['description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL],
635
      'file' => 'file.field.inc',
636 637
    ],
  ];
638 639 640
}

/**
641
 * Implements hook_file_download().
642
 */
643
function file_file_download($uri) {
644
  // Get the file record based on the URI. If not in the database just return.
645
  /** @var \Drupal\file\FileInterface[] $files */
646
  $files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
647
  if (count($files)) {
648 649 650
    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.
651
      if ($item->getFileUri() === $uri) {
652 653 654 655
        $file = $item;
        break;
      }
    }
656
  }
657
  if (!isset($file)) {
658 659 660
    return;
  }

661 662 663 664 665 666 667 668 669 670 671 672 673 674
  // 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;
    }
  }

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

678 679 680 681 682
  // 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.
683
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
684
    return;
685 686
  }

687
  if (!$file->access('download')) {
688 689 690 691
    return -1;
  }

  // Access is granted.
692 693
  $headers = file_get_content_headers($file);
  return $headers;
694 695
}

696
/**
697
 * Implements hook_cron().
698 699
 */
function file_cron() {
700
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');
701
  $file_storage = \Drupal::entityManager()->getStorage('file');
702 703 704 705 706 707 708 709 710

  // 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();
711
    $files = $file_storage->loadMultiple($fids);
712
    foreach ($files as $file) {
713
      $references = \Drupal::service('file.usage')->listUsage($file);
714
      if (empty($references)) {
715
        if (file_exists($file->getFileUri())) {
716 717 718
          $file->delete();
        }
        else {
719
          \Drupal::logger('file system')->error('Could not delete temporary file "%path" during garbage collection', ['%path' => $file->getFileUri()]);
720 721 722
        }
      }
      else {
723
        \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))]);
724 725 726 727 728
      }
    }
  }
}

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
/**
 * 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.
 *
 * @deprecated in Drupal 8.4.x, will be removed before Drupal 9.0.0.
 *   For backwards compatibility use core file upload widgets in forms.
 *
 * @internal
 *   This function wraps file_save_upload() to allow correct error handling in
 *   forms.
 *
 * @todo Revisit after https://www.drupal.org/node/2244513.
 */
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.
768
  $errors_before = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
769 770 771 772 773 774 775 776 777

  $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.
778 779
  $errors_new = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
  if (!empty($errors_new)) {
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803

    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.
804 805 806
  if (!empty($errors_before)) {
    foreach ($errors_before as $error) {
      \Drupal::messenger()->addError($error);
807 808 809 810 811 812
    }
  }

  return $result;
}

813 814 815 816
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
817 818
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
819
 *
820 821 822 823
 * 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.
 *
824
 * @param string $form_field_name
825 826
 *   A string that is the associative array key of the upload form element in
 *   the form array.
827
 * @param array $validators
828
 *   (optional) An associative array of callback functions used to validate the
829
 *   file. See file_validate() for a full discussion of the array format.
830 831 832 833 834 835 836 837 838 839 840 841
 *   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.
842
 * @param int $replace
843 844
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
845
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
846 847
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
848 849
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
 *
850 851 852 853
 * @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.
854 855 856 857
 *
 * @see _file_save_upload_from_form()
 *
 * @todo: move this logic to a service in https://www.drupal.org/node/2244513.
858
 */