file.module 67.6 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\Render\BubbleableMetadata;
12
use Drupal\Core\Render\Element;
13
use Drupal\Core\Routing\RouteMatchInterface;
14
use Drupal\Core\Url;
15
use Drupal\file\Entity\File;
16
use Drupal\file\FileInterface;
17
use Drupal\Component\Utility\NestedArray;
18
use Drupal\Component\Utility\Unicode;
19
use Drupal\Core\Entity\EntityStorageInterface;
20
use Drupal\Core\Template\Attribute;
21

22
// Load all Field module hooks for File.
23
require_once __DIR__ . '/file.field.inc';
24

25 26 27
/**
 * Implements hook_help().
 */
28
function file_help($route_name, RouteMatchInterface $route_match) {
29 30
  switch ($route_name) {
    case 'help.page.file':
31 32
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
33
      $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>';
34 35
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
36
      $output .= '<dt>' . t('Managing and displaying file fields') . '</dt>';
37
      $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>';
38 39
      $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>';
40
      $output .= '<dt>' . t('Storing files') . '</dt>';
41
      $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>';
42 43 44 45
      $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>';
46 47 48 49 50
      $output .= '</dl>';
      return $output;
  }
}

51 52 53 54 55 56 57 58 59 60
/**
 * 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';
}

61 62 63
/**
 * Loads file entities from the database.
 *
64 65 66
 * @param array|null $fids
 *   (optional) An array of entity IDs. If omitted or NULL, all entities are
 *   loaded.
67
 * @param bool $reset
68 69
 *   (optional) Whether to reset the internal file_load_multiple() cache.
 *   Defaults to FALSE.
70 71 72 73
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
74 75 76
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::loadMultiple().
 *
77
 * @see hook_ENTITY_TYPE_load()
78 79
 * @see file_load()
 * @see entity_load()
80
 * @see \Drupal\Core\Entity\Query\EntityQueryInterface
81
 */
82
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
83 84 85 86
  if ($reset) {
    \Drupal::entityManager()->getStorage('file')->resetCache($fids);
  }
  return File::loadMultiple($fids);
87 88 89 90 91
}

/**
 * Loads a single file entity from the database.
 *
92
 * @param int $fid
93
 *   A file ID.
94
 * @param bool $reset
95 96
 *   (optional) Whether to reset the internal file_load_multiple() cache.
 *   Defaults to FALSE.
97
 *
98
 * @return \Drupal\file\FileInterface|null
99
 *   A file entity or NULL if the file was not found.
100
 *
101 102 103
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::load().
 *
104
 * @see hook_ENTITY_TYPE_load()
105 106
 * @see file_load_multiple()
 */
107
function file_load($fid, $reset = FALSE) {
108
  if ($reset) {
109
    \Drupal::entityManager()->getStorage('file')->resetCache([$fid]);
110 111
  }
  return File::load($fid);
112 113 114 115 116 117 118 119 120 121 122
}

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

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

    $file->save();

    // Inform modules that the file has been copied.
188
    \Drupal::moduleHandler()->invokeAll('file_copy', [$file, $source]);
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

    return $file;
  }
  return FALSE;
}

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

238
  if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
239 240 241
    $delete_source = FALSE;

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

    $file->save();

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

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

    return $file;
  }
  return FALSE;
}

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

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

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

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

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

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

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

387 388 389 390
  return $errors;
}

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

405 406 407 408
  $image_factory = \Drupal::service('image.factory');
  $image = $image_factory->get($file->getFileUri());
  if (!$image->isValid()) {
    $supported_extensions = $image_factory->getSupportedExtensions();
409
    $errors[] = t('Image type not supported. Allowed types: %types', ['%types' => implode(' ', $supported_extensions)]);
410 411 412 413 414 415 416 417
  }

  return $errors;
}

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

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

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

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

  return $errors;
}

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

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

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

    $file->save();
    return $file;
  }
  return FALSE;
}

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

598
  return [
599
    'Content-Type' => $type,
600
    'Content-Length' => $file->getSize(),
601
    'Cache-Control' => 'private',
602
  ];
603 604
}

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

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

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

657 658 659 660 661 662 663 664 665 666 667 668 669 670
  // 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;
    }
  }

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

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

683
  if (!$file->access('download')) {
684 685 686 687
    return -1;
  }

  // Access is granted.
688 689
  $headers = file_get_content_headers($file);
  return $headers;
690 691
}

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

  // 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();
707
    $files = $file_storage->loadMultiple($fids);
708
    foreach ($files as $file) {
709
      $references = \Drupal::service('file.usage')->listUsage($file);
710
      if (empty($references)) {
711
        if (file_exists($file->getFileUri())) {
712 713 714
          $file->delete();
        }
        else {
715
          \Drupal::logger('file system')->error('Could not delete temporary file "%path" during garbage collection', ['%path' => $file->getFileUri()]);
716 717 718
        }
      }
      else {
719
        \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))]);
720 721 722 723 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 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
/**
 * 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.
  $errors_before = drupal_get_messages('error');

  $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.
  $errors_new = drupal_get_messages('error');
  if (!empty($errors_new['error'])) {
    $errors_new = $errors_new['error'];

    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.
  if (!empty($errors_before['error'])) {
    foreach ($errors_before['error'] as $error) {
      drupal_set_message($error, 'error');
    }
  }

  return $result;
}

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

860
  $all_files = \Drupal::request()->files->get('files', []);
861
  // Make sure there's an upload to process.
862
  if (empty($all_files[$form_field_name])) {
863 864
    return NULL;
  }
865
  $file_upload = $all_files[$form_field_name];
866 867 868 869 870 871 872 873 874 875 876 877

  // Return cached objects without processing since the file will have
  // already been processed and the paths in $_FILES will be invalid.
  if (isset($upload_cache[$form_field_name])) {
    if (isset($delta)) {
      return $upload_cache[$form_field_name][$delta];
    }
    return $upload_cache[$form_field_name];
  }

  // Prepare uploaded files info. Representation is slightly different
  // for multiple uploads and we fix that here.
878 879
  $uploaded_files = $file_upload;
  if (!is_array($file_upload)) {
880
    $uploaded_files = [$file_upload];
881 882
  }

883
  $files = [];
884
  foreach ($uploaded_files as $i => $file_info) {
885 886 887
    // Check for file upload errors and return FALSE for this file if a lower
    // level system error occurred. For a complete list of errors:
    // See http://php.net/manual/features.file-upload.errors.php.
888
    switch ($file_info->getError()) {
889