file.module 69.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 11
use Drupal\Core\File\Exception\FileException;
use Drupal\Core\File\FileSystemInterface;
12
use Drupal\Core\Form\FormStateInterface;
13
use Drupal\Core\Messenger\MessengerInterface;
14
use Drupal\Core\Render\BubbleableMetadata;
15
use Drupal\Core\Render\Element;
16
use Drupal\Core\Routing\RouteMatchInterface;
17
use Drupal\Core\Url;
18
use Drupal\file\Entity\File;
19
use Drupal\file\FileInterface;
20
use Drupal\Component\Utility\NestedArray;
21
use Drupal\Component\Utility\Unicode;
22
use Drupal\Core\Entity\EntityStorageInterface;
23
use Drupal\Core\Template\Attribute;
24

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

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

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

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

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

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

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

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

    $file->save();

    // Inform modules that the file has been copied.
197
    \Drupal::moduleHandler()->invokeAll('file_copy', [$file, $source]);
198 199 200

    return $file;
  }
201 202 203
  catch (FileException $e) {
    return FALSE;
  }
204 205 206 207 208 209 210 211 212 213 214
}

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

251 252
  try {
    $uri = $file_system->move($source->getFileUri(), $destination, $replace);
253 254 255
    $delete_source = FALSE;

    $file = clone $source;
256
    $file->setFileUri($uri);
257 258
    // If we are replacing an existing file re-use its database record.
    if ($replace == FILE_EXISTS_REPLACE) {
259
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
260 261 262
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $delete_source = TRUE;
263
        $file->fid = $existing->id();
264
        $file->uuid = $existing->uuid();
265 266 267 268 269
      }
    }
    // 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)) {
270
      $file->setFilename(\Drupal::service('file_system')->basename($destination));
271 272 273 274 275
    }

    $file->save();

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

    // Delete the original if it's not in use elsewhere.
279
    if ($delete_source && !\Drupal::service('file.usage')->listUsage($source)) {
280 281 282 283 284
      $source->delete();
    }

    return $file;
  }
285 286 287
  catch (FileException $e) {
    return FALSE;
  }
288 289 290 291 292 293 294 295
}

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

/**
 * Checks for files with names longer than can be stored in the database.
 *
329
 * @param \Drupal\file\FileInterface $file
330 331
 *   A file entity.
 *
332
 * @return array
333 334
 *   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.
335
 */
336
function file_validate_name_length(FileInterface $file) {
337
  $errors = [];
338

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

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
366
  if (!preg_match($regex, $file->getFilename())) {
367
    $errors[] = t('Only files with the following extensions are allowed: %files-allowed.', ['%files-allowed' => $extensions]);
368 369 370 371 372 373 374
  }
  return $errors;
}

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

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

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

403 404 405 406
  return $errors;
}

/**
407
 * Checks that the file is recognized as a valid image.
408
 *
409
 * @param \Drupal\file\FileInterface $file
410 411
 *   A file entity.
 *
412
 * @return array
413 414
 *   An empty array if the file is a valid image or an array containing an error
 *   message if it's not.
415 416 417
 *
 * @see hook_file_validate()
 */
418
function file_validate_is_image(FileInterface $file) {
419
  $errors = [];
420

421 422 423 424
  $image_factory = \Drupal::service('image.factory');
  $image = $image_factory->get($file->getFileUri());
  if (!$image->isValid()) {
    $supported_extensions = $image_factory->getSupportedExtensions();
425
    $errors[] = t('The image file is invalid or the image type is not allowed. Allowed types: %types', ['%types' => implode(', ', $supported_extensions)]);
426 427 428 429 430 431 432 433
  }

  return $errors;
}

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

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

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

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
509
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
        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(),
            ]);
        }
526 527 528 529 530 531 532 533 534 535
      }
    }
  }

  return $errors;
}

/**
 * Saves a file to the specified destination and creates a database entry.
 *
536
 * @param string $data
537
 *   A string containing the contents of the file.
538 539 540 541 542
 * @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://".
543
 * @param int $replace
544 545 546 547 548 549 550 551
 *   (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.
552
 *
553
 * @return \Drupal\file\FileInterface|false
554 555 556 557 558
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
559
  $user = \Drupal::currentUser();
560 561 562 563 564

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

570 571
  try {
    $uri = \Drupal::service('file_system')->saveData($data, $destination, $replace);
572
    // Create a file entity.
573
    $file = File::create([
574
      'uri' => $uri,
575
      'uid' => $user->id(),
576
      'status' => FILE_STATUS_PERMANENT,
577
    ]);
578
    // If we are replacing an existing file re-use its database record.
579 580
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
581
    if ($replace == FILE_EXISTS_REPLACE) {
582
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
583 584
      if (count($existing_files)) {
        $existing = reset($existing_files);
585
        $file->fid = $existing->id();
586
        $file->setOriginalId($existing->id());
587
        $file->setFilename($existing->getFilename());
588 589 590 591 592
      }
    }
    // 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)) {
593
      $file->setFilename(\Drupal::service('file_system')->basename($destination));
594 595 596 597 598
    }

    $file->save();
    return $file;
  }
599 600 601 602
  catch (FileException $e) {
    return FALSE;
  }

603 604 605 606 607
}

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
608
 * @param \Drupal\file\FileInterface $file
609 610
 *   A file entity.
 *
611
 * @return array
612 613 614
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
615
function file_get_content_headers(FileInterface $file) {
616
  $type = Unicode::mimeHeaderEncode($file->getMimeType());
617

618
  return [
619
    'Content-Type' => $type,
620
    'Content-Length' => $file->getSize(),
621
    'Cache-Control' => 'private',
622
  ];
623 624
}

625
/**
626
 * Implements hook_theme().
627 628
 */
function file_theme() {
629
  return [
630
    // From file.module.
631 632 633 634
    'file_link' => [
      'variables' => ['file' => NULL, 'description' => NULL, 'attributes' => []],
    ],
    'file_managed_file' => [
635
      'render element' => 'element',
636
    ],
637 638 639 640 641 642
    'file_audio' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
    'file_video' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
643

644
    // From file.field.inc.
645
    'file_widget_multiple' => [
646
      'render element' => 'element',
647
      'file' => 'file.field.inc',
648 649 650
    ],
    'file_upload_help' => [
      'variables' => ['description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL],
651
      'file' => 'file.field.inc',
652 653
    ],
  ];
654 655 656
}

/**
657
 * Implements hook_file_download().
658
 */
659
function file_file_download($uri) {
660
  // Get the file record based on the URI. If not in the database just return.
661
  /** @var \Drupal\file\FileInterface[] $files */
662
  $files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
663
  if (count($files)) {
664 665 666
    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.
667
      if ($item->getFileUri() === $uri) {
668 669 670 671
        $file = $item;
        break;
      }
    }
672
  }
673
  if (!isset($file)) {
674 675 676
    return;
  }

677 678 679 680 681 682 683 684 685 686 687 688 689 690
  // 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;
    }
  }

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

694 695 696 697 698
  // 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.
699
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
700
    return;
701 702
  }

703
  if (!$file->access('download')) {
704 705 706 707
    return -1;
  }

  // Access is granted.
708 709
  $headers = file_get_content_headers($file);
  return $headers;
710 711
}

712
/**
713
 * Implements hook_cron().
714 715
 */
function file_cron() {
716
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');
717
  $file_storage = \Drupal::entityManager()->getStorage('file');
718 719 720 721 722 723 724 725 726

  // 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();
727
    $files = $file_storage->loadMultiple($fids);
728
    foreach ($files as $file) {
729
      $references = \Drupal::service('file.usage')->listUsage($file);
730
      if (empty($references)) {
731 732 733 734 735
        if (file_exists($file->getFileUri())) {
          $file->delete();
        }
        else {
          \Drupal::logger('file system')->error('Could not delete temporary file "%path" during garbage collection', ['%path' => $file->getFileUri()]);
736 737 738
        }
      }
      else {
739
        \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))]);
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
/**
 * 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.
784
  $errors_before = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
785 786 787 788 789 790 791 792 793

  $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.
794 795
  $errors_new = \Drupal::messenger()->deleteByType(MessengerInterface::TYPE_ERROR);
  if (!empty($errors_new)) {
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819

    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.
820 821 822
  if (!empty($errors_before)) {
    foreach ($errors_before as $error) {
      \Drupal::messenger()->addError($error);
823 824 825 826 827 828
    }
  }

  return $result;
}

829 830 831 832
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
833 834
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
835
 *
836 837 838 839
 * 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.
 *
840
 * @param string $form_field_name
841 842
 *   A string that is the associative array key of the upload form element in
 *   the form array.
843
 * @param array $validators
844
 *   (optional) An associative array of callback functions used to validate the
845
 *   file. See file_validate() for a full discussion of the array format.
846 847 848 849 850 851 852 853 854 855 856 857
 *   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.
858
 * @param int $replace
859 860
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
861
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
862 863
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
catch's avatar