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

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

8
use Drupal\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
use Drupal\file\FileUsage\FileUsageInterface;
22

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

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

52 53 54 55 56
/**
 * Loads file entities from the database.
 *
 * @param array $fids
 *   (optional) An array of entity IDs. If omitted, all entities are loaded.
57
 * @param bool $reset
58
 *   Whether to reset the internal file_load_multiple() cache.
59 60 61 62
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
63 64 65
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::loadMultiple().
 *
66
 * @see hook_ENTITY_TYPE_load()
67 68
 * @see file_load()
 * @see entity_load()
69
 * @see \Drupal\Core\Entity\Query\EntityQueryInterface
70
 */
71
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
72 73 74 75
  if ($reset) {
    \Drupal::entityManager()->getStorage('file')->resetCache($fids);
  }
  return File::loadMultiple($fids);
76 77 78 79 80
}

/**
 * Loads a single file entity from the database.
 *
81
 * @param int $fid
82
 *   A file ID.
83
 * @param bool $reset
84
 *   Whether to reset the internal file_load_multiple() cache.
85
 *
86
 * @return \Drupal\file\FileInterface
87
 *   A file entity or NULL if the file was not found.
88
 *
89 90 91
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::load().
 *
92
 * @see hook_ENTITY_TYPE_load()
93 94
 * @see file_load_multiple()
 */
95
function file_load($fid, $reset = FALSE) {
96 97 98 99
  if ($reset) {
    \Drupal::entityManager()->getStorage('file')->resetCache(array($fid));
  }
  return File::load($fid);
100 101 102 103 104 105 106 107 108 109 110
}

/**
 * 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.
111
 * - If the $source and $destination are equal, the behavior depends on the
112
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
113
 *   will rename the file until the $destination is unique.
114 115 116 117
 * - 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.
 *
118
 * @param \Drupal\file\FileInterface $source
119
 *   A file entity.
120
 * @param string $destination
121 122
 *   A string containing the destination that $source should be copied to.
 *   This must be a stream wrapper URI.
123
 * @param int $replace
124 125 126 127 128 129 130 131
 *   Replace behavior when the destination file already exists:
 *   - 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 - Append _{incrementing number} until the filename is
 *       unique.
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
 *
132
 * @return \Drupal\file\FileInterface|FALSE
133 134 135 136 137
 *   File object if the copy is successful, or FALSE in the event of an error.
 *
 * @see file_unmanaged_copy()
 * @see hook_file_copy()
 */
138
function file_copy(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
139
  if (!file_valid_uri($destination)) {
140
    if (($realpath = drupal_realpath($source->getFileUri())) !== FALSE) {
141
      \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.', array('%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination));
142 143
    }
    else {
144
      \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.', array('%file' => $source->getFileUri(), '%destination' => $destination));
145
    }
146
    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.', array('%file' => $source->getFileUri())), 'error');
147 148 149
    return FALSE;
  }

150 151 152 153
  if ($uri = file_unmanaged_copy($source->getFileUri(), $destination, $replace)) {
    $file = $source->createDuplicate();
    $file->setFileUri($uri);
    $file->setFilename(drupal_basename($uri));
154
    // If we are replacing an existing file re-use its database record.
155 156
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
157 158 159 160
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
      if (count($existing_files)) {
        $existing = reset($existing_files);
161
        $file->fid = $existing->id();
162
        $file->setOriginalId($existing->id());
163
        $file->setFilename($existing->getFilename());
164 165 166 167 168
      }
    }
    // 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)) {
169
      $file->setFilename(drupal_basename($destination));
170 171 172 173 174
    }

    $file->save();

    // Inform modules that the file has been copied.
175
    \Drupal::moduleHandler()->invokeAll('file_copy', array($file, $source));
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192

    return $file;
  }
  return FALSE;
}

/**
 * Moves a file to a new location and update the file's database entry.
 *
 * Moving a file is performed by copying the file to the new location and then
 * deleting the original.
 * - 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.
 *
193
 * @param \Drupal\file\FileInterface $source
194
 *   A file entity.
195
 * @param string $destination
196 197
 *   A string containing the destination that $source should be moved to.
 *   This must be a stream wrapper URI.
198
 * @param int $replace
199 200 201 202 203 204 205 206 207 208
 *   Replace behavior when the destination file already exists:
 *   - 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 - Append _{incrementing number} until the filename is
 *       unique.
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
 *
209
 * @return \Drupal\file\FileInterface
210 211 212 213 214
 *   Resulting file entity for success, or FALSE in the event of an error.
 *
 * @see file_unmanaged_move()
 * @see hook_file_move()
 */
215
function file_move(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
216
  if (!file_valid_uri($destination)) {
217
    if (($realpath = drupal_realpath($source->getFileUri())) !== FALSE) {
218
      \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.', array('%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination));
219 220
    }
    else {
221
      \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.', array('%file' => $source->getFileUri(), '%destination' => $destination));
222
    }
223
    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.', array('%file' => $source->getFileUri())), 'error');
224 225 226
    return FALSE;
  }

227
  if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
228 229 230
    $delete_source = FALSE;

    $file = clone $source;
231
    $file->setFileUri($uri);
232 233 234 235 236 237
    // If we are replacing an existing file re-use its database record.
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $delete_source = TRUE;
238
        $file->fid = $existing->id();
239
        $file->uuid = $existing->uuid();
240 241 242 243 244
      }
    }
    // 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)) {
245
      $file->setFilename(drupal_basename($destination));
246 247 248 249 250
    }

    $file->save();

    // Inform modules that the file has been moved.
251
    \Drupal::moduleHandler()->invokeAll('file_move', array($file, $source));
252 253

    // Delete the original if it's not in use elsewhere.
254
    if ($delete_source && !\Drupal::service('file.usage')->listUsage($source)) {
255 256 257 258 259 260 261 262 263 264 265 266 267 268
      $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.
 *
269
 * @param \Drupal\file\FileInterface $file
270
 *   A file entity.
271
 * @param array $validators
272 273 274 275 276 277 278
 *   An optional, 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 functions will be called in
 *   the order specified.
 *
279
 * @return array
280 281 282 283
 *   An array containing validation error messages.
 *
 * @see hook_file_validate()
 */
284
function file_validate(FileInterface $file, $validators = array()) {
285 286 287 288 289 290 291 292 293 294
  // Call the validation functions specified by this function's caller.
  $errors = array();
  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.
295
  return array_merge($errors, \Drupal::moduleHandler()->invokeAll('file_validate', array($file)));
296 297 298 299 300
}

/**
 * Checks for files with names longer than can be stored in the database.
 *
301
 * @param \Drupal\file\FileInterface $file
302 303
 *   A file entity.
 *
304
 * @return array
305 306
 *   An array. If the file name is too long, it will contain an error message.
 */
307
function file_validate_name_length(FileInterface $file) {
308 309
  $errors = array();

310
  if (!$file->getFilename()) {
311 312
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
313
  if (strlen($file->getFilename()) > 240) {
314 315 316 317 318 319 320 321
    $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.
 *
322
 * @param \Drupal\file\FileInterface $file
323
 *   A file entity.
324
 * @param string $extensions
325 326
 *   A string with a space separated list of allowed extensions.
 *
327
 * @return array
328 329 330 331 332
 *   An array. If the file extension is not allowed, it will contain an error
 *   message.
 *
 * @see hook_file_validate()
 */
333
function file_validate_extensions(FileInterface $file, $extensions) {
334 335 336
  $errors = array();

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
337
  if (!preg_match($regex, $file->getFilename())) {
338 339 340 341 342 343 344 345
    $errors[] = t('Only files with the following extensions are allowed: %files-allowed.', array('%files-allowed' => $extensions));
  }
  return $errors;
}

/**
 * Checks that the file's size is below certain limits.
 *
346
 * @param \Drupal\file\FileInterface $file
347
 *   A file entity.
348
 * @param int $file_limit
349 350
 *   An integer specifying the maximum file size in bytes. Zero indicates that
 *   no limit should be enforced.
351
 * @param int $user_limit
352 353 354
 *   An integer specifying the maximum number of bytes the user is allowed.
 *   Zero indicates that no limit should be enforced.
 *
355
 * @return array
356 357 358 359 360
 *   An array. If the file size exceeds limits, it will contain an error
 *   message.
 *
 * @see hook_file_validate()
 */
361
function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = 0) {
362
  $user = \Drupal::currentUser();
363 364
  $errors = array();

365 366
  if ($file_limit && $file->getSize() > $file_limit) {
    $errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', array('%filesize' => format_size($file->getSize()), '%maxsize' => format_size($file_limit)));
367
  }
368

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

374 375 376 377
  return $errors;
}

/**
378
 * Checks that the file is recognized as a valid image.
379
 *
380
 * @param \Drupal\file\FileInterface $file
381 382
 *   A file entity.
 *
383
 * @return array
384 385 386 387
 *   An array. If the file is not an image, it will contain an error message.
 *
 * @see hook_file_validate()
 */
388
function file_validate_is_image(FileInterface $file) {
389 390
  $errors = array();

391 392 393 394 395
  $image_factory = \Drupal::service('image.factory');
  $image = $image_factory->get($file->getFileUri());
  if (!$image->isValid()) {
    $supported_extensions = $image_factory->getSupportedExtensions();
    $errors[] = t('Image type not supported. Allowed types: %types', array('%types' => implode(' ', $supported_extensions)));
396 397 398 399 400 401 402 403 404 405 406
  }

  return $errors;
}

/**
 * Verifies that image dimensions are within the specified maximum and minimum.
 *
 * Non-image files will be ignored. If a image toolkit is available the image
 * will be scaled to fit within the desired maximum dimensions.
 *
407
 * @param \Drupal\file\FileInterface $file
408
 *   A file entity. This function may resize the file affecting its size.
409
 * @param string $maximum_dimensions
410 411 412 413
 *   An optional string in the form WIDTHxHEIGHT e.g. '640x480' or '85x85'. If
 *   an image toolkit is installed the image will be resized down to these
 *   dimensions. A value of 0 indicates no restriction on size, so resizing
 *   will be attempted.
414
 * @param string $minimum_dimensions
415 416 417 418 419 420 421 422 423
 *   An optional string in the form WIDTHxHEIGHT. This will check that the
 *   image meets a minimum size. A value of 0 indicates no restriction.
 *
 * @return
 *   An array. If the file is an image and did not meet the requirements, it
 *   will contain an error message.
 *
 * @see hook_file_validate()
 */
424
function file_validate_image_resolution(FileInterface $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
425 426 427
  $errors = array();

  // Check first that the file is an image.
428
  $image_factory = \Drupal::service('image.factory');
429
  $image = $image_factory->get($file->getFileUri());
430
  if ($image->isValid()) {
431 432 433
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
434
      if ($image->getWidth() > $width || $image->getHeight() > $height) {
435
        // Try to resize the image to fit the dimensions.
436
        if ($image->scale($width, $height)) {
437 438
          $image->save();
          $file->filesize = $image->getFileSize();
439 440 441
          drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
        }
        else {
442
          $errors[] = t('The image exceeds the maximum allowed dimensions and an attempt to resize it failed.');
443 444 445 446 447 448 449
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
450
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
451 452 453 454 455 456 457 458 459 460 461
        $errors[] = t('The image is too small; the minimum dimensions are %dimensions pixels.', array('%dimensions' => $minimum_dimensions));
      }
    }
  }

  return $errors;
}

/**
 * Saves a file to the specified destination and creates a database entry.
 *
462
 * @param string $data
463
 *   A string containing the contents of the file.
464
 * @param string $destination
465 466 467
 *   A string containing the destination URI. This must be a stream wrapper URI.
 *   If no value is provided, a randomized name will be generated and the file
 *   will be saved using Drupal's default files scheme, usually "public://".
468
 * @param int $replace
469 470 471 472 473 474 475 476
 *   Replace behavior when the destination file already exists:
 *   - 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 - Append _{incrementing number} until the filename is
 *       unique.
 *   - FILE_EXISTS_ERROR - Do nothing and return FALSE.
 *
477
 * @return \Drupal\file\FileInterface
478 479 480 481 482
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
483
  $user = \Drupal::currentUser();
484 485 486 487 488

  if (empty($destination)) {
    $destination = file_default_scheme() . '://';
  }
  if (!file_valid_uri($destination)) {
489
    \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.', array('%destination' => $destination));
490 491 492 493 494 495 496 497
    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.
    $file = entity_create('file', array(
      'uri' => $uri,
498
      'uid' => $user->id(),
499 500 501
      'status' => FILE_STATUS_PERMANENT,
    ));
    // If we are replacing an existing file re-use its database record.
502 503
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
504 505 506 507
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
      if (count($existing_files)) {
        $existing = reset($existing_files);
508
        $file->fid = $existing->id();
509
        $file->setOriginalId($existing->id());
510
        $file->setFilename($existing->getFilename());
511 512 513 514 515
      }
    }
    // 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)) {
516
      $file->setFilename(drupal_basename($destination));
517 518 519 520 521 522 523 524 525 526 527
    }

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

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
528
 * @param \Drupal\file\FileInterface $file
529 530
 *   A file entity.
 *
531
 * @return array
532 533 534
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
535
function file_get_content_headers(FileInterface $file) {
536
  $type = Unicode::mimeHeaderEncode($file->getMimeType());
537 538

  return array(
539
    'Content-Type' => $type,
540
    'Content-Length' => $file->getSize(),
541 542 543 544
    'Cache-Control' => 'private',
  );
}

545
/**
546
 * Implements hook_theme().
547 548 549
 */
function file_theme() {
  return array(
550
    // From file.module.
551
    'file_link' => array(
552
      'variables' => array('file' => NULL, 'description' => NULL, 'attributes' => array()),
553 554
    ),
    'file_managed_file' => array(
555
      'render element' => 'element',
556 557
    ),

558
    // From file.field.inc.
559
    'file_widget' => array(
560
      'render element' => 'element',
561
      'file' => 'file.field.inc',
562 563
    ),
    'file_widget_multiple' => array(
564
      'render element' => 'element',
565
      'file' => 'file.field.inc',
566
    ),
567
    'file_upload_help' => array(
568
      'variables' => array('description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL),
569
      'file' => 'file.field.inc',
570 571 572 573 574
    ),
  );
}

/**
575
 * Implements hook_file_download().
576
 */
577
function file_file_download($uri) {
578
  // Get the file record based on the URI. If not in the database just return.
579
  /** @var \Drupal\file\FileInterface[] $files */
580
  $files = entity_load_multiple_by_properties('file', array('uri' => $uri));
581
  if (count($files)) {
582 583 584
    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.
585
      if ($item->getFileUri() === $uri) {
586 587 588 589
        $file = $item;
        break;
      }
    }
590
  }
591
  if (!isset($file)) {
592 593 594
    return;
  }

595 596 597 598 599 600 601 602 603 604 605 606 607 608
  // 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;
    }
  }

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

612 613 614 615 616
  // 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.
617
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
618
    return;
619 620
  }

621
  if (!$file->access('download')) {
622 623 624 625
    return -1;
  }

  // Access is granted.
626 627
  $headers = file_get_content_headers($file);
  return $headers;
628 629
}

630
/**
631
 * Implements hook_cron().
632 633
 */
function file_cron() {
634
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');
635
  $file_storage = \Drupal::entityManager()->getStorage('file');
636 637 638 639 640 641 642 643 644

  // 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();
645
    $files = $file_storage->loadMultiple($fids);
646
    foreach ($files as $file) {
647
      $references = \Drupal::service('file.usage')->listUsage($file);
648
      if (empty($references)) {
649
        if (file_exists($file->getFileUri())) {
650 651 652
          $file->delete();
        }
        else {
653
          \Drupal::logger('file system')->error('Could not delete temporary file "%path" during garbage collection', array('%path' => $file->getFileUri()));
654 655 656
        }
      }
      else {
657
        \Drupal::logger('file system')->info('Did not delete temporary file "%path" during garbage collection because it is in use by the following modules: %modules.', array('%path' => $file->getFileUri(), '%modules' => implode(', ', array_keys($references))));
658 659 660 661 662
      }
    }
  }
}

663 664 665 666
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
667 668
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
669
 *
670
 * @param string $form_field_name
671 672
 *   A string that is the associative array key of the upload form element in
 *   the form array.
673
 * @param array $validators
674 675 676 677 678 679 680 681
 *   An optional, associative array of callback functions used to validate the
 *   file. See file_validate() for a full discussion of the array format.
 *   If no extension validator is provided it will default to a limited safe
 *   list of extensions which is as follows: "jpg jpeg gif png txt
 *   doc xls pdf ppt pps odt ods odp". To allow all extensions you must
 *   explicitly set the 'file_validate_extensions' validator to an empty array
 *   (Beware: this is not safe and should only be allowed for trusted users, if
 *   at all).
682
 * @param string $destination
683 684 685
 *   A string containing the URI that the file should be copied to. This must
 *   be a stream wrapper URI. If this value is omitted, Drupal's temporary
 *   files scheme will be used ("temporary://").
686
 * @param int $delta
687
 *   Delta of the file to save or NULL to save all files. Defaults to NULL.
688
 * @param int $replace
689 690 691 692 693 694
 *   Replace behavior when the destination file already exists:
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
 *   - FILE_EXISTS_RENAME: Append _{incrementing number} until the filename is
 *     unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
 *
695
 * @return array
696 697 698 699 700 701 702 703 704 705 706 707
 *   Function returns array of files or a single file object if $delta
 *   != NULL. Each file object contains the file information if the
 *   upload succeeded or FALSE in the event of an error. Function
 *   returns NULL if no file was uploaded.
 *
 *   The documentation for the "File interface" group, which you can find under
 *   Related topics, or the header at the top of this file, documents the
 *   components of a file entity. In addition to the standard components,
 *   this function adds:
 *   - source: Path to the file before it is moved.
 *   - destination: Path to the file after it is moved (same as 'uri').
 */
708
function file_save_upload($form_field_name, $validators = array(), $destination = FALSE, $delta = NULL, $replace = FILE_EXISTS_RENAME) {
709
  $user = \Drupal::currentUser();
710 711
  static $upload_cache;

712
  $file_upload = \Drupal::request()->files->get("files[$form_field_name]", NULL, TRUE);
713
  // Make sure there's an upload to process.
714
  if (empty($file_upload)) {
715 716 717 718 719 720 721 722 723 724 725 726 727 728
    return NULL;
  }

  // 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.
729 730 731
  $uploaded_files = $file_upload;
  if (!is_array($file_upload)) {
    $uploaded_files = array($file_upload);
732 733 734
  }

  $files = array();
735
  foreach ($uploaded_files as $i => $file_info) {
736 737 738
    // 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.
739
    switch ($file_info->getError()) {
740 741
      case UPLOAD_ERR_INI_SIZE:
      case UPLOAD_ERR_FORM_SIZE:
742
        drupal_set_message(t('The file %file could not be saved because it exceeds %maxsize, the maximum allowed size for uploads.', array('%file' => $file_info->getFilename(), '%maxsize' => format_size(file_upload_max_size()))), 'error');
743 744 745 746 747
        $files[$i] = FALSE;
        continue;

      case UPLOAD_ERR_PARTIAL:
      case UPLOAD_ERR_NO_FILE:
748
        drupal_set_message(t('The file %file could not be saved because the upload did not complete.', array('%file' => $file_info->getFilename())), 'error');
749 750 751 752 753 754
        $files[$i] = FALSE;
        continue;

      case UPLOAD_ERR_OK:
        // Final check that this is a valid upload, if it isn't, use the
        // default error handler.
755
        if (is_uploaded_file($file_info->getRealPath())) {
756 757 758 759 760
          break;
        }

        // Unknown error
      default:
761
        drupal_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $file_info->getFilename())), 'error');
762 763 764 765 766 767 768 769
        $files[$i] = FALSE;
        continue;

    }
    // Begin building file entity.
    $values = array(
      'uid' => $user->id(),
      'status' => 0,
770 771 772
      'filename' => $file_info->getClientOriginalName(),
      'uri' => $file_info->getRealPath(),
      'filesize' => $file_info->getSize(),
773
    );
774
    $values['filemime'] = \Drupal::service('file.mime_type.guesser')->guess($values['filename']);
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
    $file = entity_create('file', $values);

    $extensions = '';
    if (isset($validators['file_validate_extensions'])) {
      if (isset($validators['file_validate_extensions'][0])) {
        // Build the list of non-munged extensions if the caller provided them.
        $extensions = $validators['file_validate_extensions'][0];
      }
      else {
        // If 'file_validate_extensions' is set and the list is empty then the
        // caller wants to allow any extension. In this case we have to remove the
        // validator or else it will reject all extensions.
        unset($validators['file_validate_extensions']);
      }
    }
    else {
      // No validator was provided, so add one using the default list.
      // Build a default non-munged safe list for file_munge_filename().
      $extensions = 'jpg jpeg gif png txt doc xls pdf ppt pps odt ods odp';
      $validators['file_validate_extensions'] = array();
      $validators['file_validate_extensions'][0] = $extensions;
    }

    if (!empty($extensions)) {
      // Munge the filename to protect against possible malicious extension
      // hiding within an unknown file type (ie: filename.html.foo).
      $file->setFilename(file_munge_filename($file->getFilename(), $extensions));
    }

    // Rename potentially executable files, to help prevent exploits (i.e. will
    // rename filename.php.foo and filename.php to filename.php.foo.txt and
    // filename.php.txt, respectively). Don't rename if 'allow_insecure_uploads'
    // evaluates to TRUE.
808
    if (!\Drupal::config('system.file')->get('allow_insecure_uploads') && preg_match('/\.(php|pl|py|cgi|asp|js)(\.|$)/i', $file->getFilename()) && (substr($file->getFilename(), -4) != '.txt')) {
809
      $file->setMimeType('text/plain');
810
      // The destination filename will also later be used to create the URI.
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
      $file->setFilename($file->getFilename() . '.txt');
      // The .txt extension may not be in the allowed list of extensions. We have
      // to add it here or else the file upload will fail.
      if (!empty($extensions)) {
        $validators['file_validate_extensions'][0] .= ' txt';
        drupal_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $file->getFilename())));
      }
    }

    // If the destination is not provided, use the temporary directory.
    if (empty($destination)) {
      $destination = 'temporary://';
    }

    // Assert that the destination contains a valid stream.
    $destination_scheme = file_uri_scheme($destination);
    if (!file_stream_wrapper_valid_scheme($destination_scheme)) {
      drupal_set_message(t('The file could not be uploaded because the destination %destination is invalid.', array('%destination' => $destination)), 'error');
      $files[$i] = FALSE;
      continue;
    }

    $file->source = $form_field_name;
    // A file URI may already have a trailing slash or look like "public://".
    if (substr($destination, -1) != '/') {
      $destination .= '/';
    }
    $file->destination = file_destination($destination . $file->getFilename(), $replace);
    // If file_destination() returns FALSE then $replace === FILE_EXISTS_ERROR and
    // there's an existing file so we need to bail.
    if ($file->destination === FALSE) {
      drupal_set_message(t('The file %source could not be uploaded because a file by that name already exists in the destination %directory.', array('%source' => $form_field_name, '%directory' => $destination)), 'error');
      $files[$i] = FALSE;
      continue;
    }

847
    // Add in our check of the file name length.
848 849 850 851 852 853 854
    $validators['file_validate_name_length'] = array();

    // Call the validation functions specified by this function's caller.
    $errors = file_validate($file, $validators);

    // Check for errors.
    if (!empty($errors)) {
855 856 857 858 859
      $message = array(
        'error' => array(
          '#markup' => t('The specified file %name could not be uploaded.', array('%name' => $file->getFilename())),
        ),
        'item_list' => array(
860 861
          '#theme' => 'item_list',
          '#items' => $errors,
862 863 864 865
        ),
      );
      // @todo Add support for render arrays in drupal_set_message()? See
      //  https://www.drupal.org/node/2505497.
866
      drupal_set_message(\Drupal::service('renderer')->renderPlain($message), 'error');
867 868 869 870 871 872 873
      $files[$i] = FALSE;
      continue;
    }

    // Move uploaded files from PHP's upload_tmp_dir to Drupal's temporary
    // directory. This overcomes open_basedir restrictions for future file
    // operations.
874
    $file->setFileUri($file->destination);
875
    if (!drupal_move_uploaded_file($file_info->getRealPath(), $file->getFileUri())) {
876
      drupal_set_message(t('File upload error. Could not move uploaded file.'), 'error');
877
      \Drupal::logger('file')->notice('Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->getFilename(), '%destination' => $file->getFileUri()));
878 879 880 881 882 883 884 885
      $files[$i] = FALSE;
      continue;
    }

    // Set the permissions on the new file.
    drupal_chmod($file->getFileUri());

    // If we are replacing an existing file re-use its database record.
886 887
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
888 889 890 891 892
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $file->getFileUri()));
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $file->fid = $existing->id();
893
        $file->setOriginalId($existing->id());
894 895 896 897 898 899 900 901 902 903 904 905 906 907
      }
    }

    // If we made it this far it's safe to record this file in the database.
    $file->save();
    $files[$i] = $file;
  }

  // Add files to the cache.
  $upload_cache[$form_field_name] = $files;

  return isset($delta) ? $files[$delta] : $files;
}

908
/**
909
 * Determines the preferred upload progress implementation.
910
 *
911
 * @return string|FALSE
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
 *   A string indicating which upload progress system is available. Either "apc"
 *   or "uploadprogress". If neither are available, returns FALSE.
 */