file.module 62 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>.', 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>';
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.', array(':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', array('name' => 'field_ui')) : '#')) . '</dd>';
38 39 40
      $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>';
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>.', array(':file-system' => \Drupal::url('system.file_system_settings'), ':system-help' => \Drupal::url('help.page', array('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
/**
 * Loads file entities from the database.
 *
54 55 56
 * @param array|null $fids
 *   (optional) An array of entity IDs. If omitted or NULL, all entities are
 *   loaded.
57
 * @param bool $reset
58 59
 *   (optional) Whether to reset the internal file_load_multiple() cache.
 *   Defaults to FALSE.
60 61 62 63
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
64 65 66
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::loadMultiple().
 *
67
 * @see hook_ENTITY_TYPE_load()
68 69
 * @see file_load()
 * @see entity_load()
70
 * @see \Drupal\Core\Entity\Query\EntityQueryInterface
71
 */
72
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
73 74 75 76
  if ($reset) {
    \Drupal::entityManager()->getStorage('file')->resetCache($fids);
  }
  return File::loadMultiple($fids);
77 78 79 80 81
}

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

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

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

    $file->save();

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

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

230
  if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
231 232 233
    $delete_source = FALSE;

    $file = clone $source;
234
    $file->setFileUri($uri);
235 236 237 238 239 240
    // 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;
241
        $file->fid = $existing->id();
242
        $file->uuid = $existing->uuid();
243 244 245 246 247
      }
    }
    // 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)) {
248
      $file->setFilename(drupal_basename($destination));
249 250 251 252 253
    }

    $file->save();

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

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

/**
 * Checks for files with names longer than can be stored in the database.
 *
305
 * @param \Drupal\file\FileInterface $file
306 307
 *   A file entity.
 *
308
 * @return array
309 310
 *   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.
311
 */
312
function file_validate_name_length(FileInterface $file) {
313 314
  $errors = array();

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

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
342
  if (!preg_match($regex, $file->getFilename())) {
343 344 345 346 347 348 349 350
    $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.
 *
351
 * @param \Drupal\file\FileInterface $file
352
 *   A file entity.
353
 * @param int $file_limit
354 355
 *   (optional) The maximum file size in bytes. Zero (the default) indicates
 *   that no limit should be enforced.
356
 * @param int $user_limit
357 358
 *   (optional) The maximum number of bytes the user is allowed. Zero (the
 *   default) indicates that no limit should be enforced.
359
 *
360
 * @return array
361 362
 *   An empty array if the file size is below limits or an array containing an
 *   error message if it's not.
363 364 365
 *
 * @see hook_file_validate()
 */
366
function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = 0) {
367
  $user = \Drupal::currentUser();
368 369
  $errors = array();

370 371
  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)));
372
  }
373

374
  // Save a query by only calling spaceUsed() when a limit is provided.
375
  if ($user_limit && (\Drupal::entityManager()->getStorage('file')->spaceUsed($user->id()) + $file->getSize()) > $user_limit) {
376
    $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)));
377
  }
378

379 380 381 382
  return $errors;
}

/**
383
 * Checks that the file is recognized as a valid image.
384
 *
385
 * @param \Drupal\file\FileInterface $file
386 387
 *   A file entity.
 *
388
 * @return array
389 390
 *   An empty array if the file is a valid image or an array containing an error
 *   message if it's not.
391 392 393
 *
 * @see hook_file_validate()
 */
394
function file_validate_is_image(FileInterface $file) {
395 396
  $errors = array();

397 398 399 400 401
  $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)));
402 403 404 405 406 407 408 409
  }

  return $errors;
}

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

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

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
459
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
460 461 462 463 464 465 466 467 468 469 470
        $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.
 *
471
 * @param string $data
472
 *   A string containing the contents of the file.
473 474 475 476 477
 * @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://".
478
 * @param int $replace
479 480 481 482 483 484 485 486
 *   (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.
487
 *
488
 * @return \Drupal\file\FileInterface|false
489 490 491 492 493
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
494
  $user = \Drupal::currentUser();
495 496 497 498 499

  if (empty($destination)) {
    $destination = file_default_scheme() . '://';
  }
  if (!file_valid_uri($destination)) {
500
    \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));
501 502 503 504 505 506
    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.
507
    $file = File::create([
508
      'uri' => $uri,
509
      'uid' => $user->id(),
510
      'status' => FILE_STATUS_PERMANENT,
511
    ]);
512
    // If we are replacing an existing file re-use its database record.
513 514
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
515 516 517 518
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
      if (count($existing_files)) {
        $existing = reset($existing_files);
519
        $file->fid = $existing->id();
520
        $file->setOriginalId($existing->id());
521
        $file->setFilename($existing->getFilename());
522 523 524 525 526
      }
    }
    // 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)) {
527
      $file->setFilename(drupal_basename($destination));
528 529 530 531 532 533 534 535 536 537 538
    }

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

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
539
 * @param \Drupal\file\FileInterface $file
540 541
 *   A file entity.
 *
542
 * @return array
543 544 545
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
546
function file_get_content_headers(FileInterface $file) {
547
  $type = Unicode::mimeHeaderEncode($file->getMimeType());
548 549

  return array(
550
    'Content-Type' => $type,
551
    'Content-Length' => $file->getSize(),
552 553 554 555
    'Cache-Control' => 'private',
  );
}

556
/**
557
 * Implements hook_theme().
558 559 560
 */
function file_theme() {
  return array(
561
    // From file.module.
562
    'file_link' => array(
563
      'variables' => array('file' => NULL, 'description' => NULL, 'attributes' => array()),
564 565
    ),
    'file_managed_file' => array(
566
      'render element' => 'element',
567 568
    ),

569
    // From file.field.inc.
570
    'file_widget_multiple' => array(
571
      'render element' => 'element',
572
      'file' => 'file.field.inc',
573
    ),
574
    'file_upload_help' => array(
575
      'variables' => array('description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL),
576
      'file' => 'file.field.inc',
577 578 579 580 581
    ),
  );
}

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

602 603 604 605 606 607 608 609 610 611 612 613 614 615
  // 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;
    }
  }

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

619 620 621 622 623
  // 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.
624
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
625
    return;
626 627
  }

628
  if (!$file->access('download')) {
629 630 631 632
    return -1;
  }

  // Access is granted.
633 634
  $headers = file_get_content_headers($file);
  return $headers;
635 636
}

637
/**
638
 * Implements hook_cron().
639 640
 */
function file_cron() {
641
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');
642
  $file_storage = \Drupal::entityManager()->getStorage('file');
643 644 645 646 647 648 649 650 651

  // 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();
652
    $files = $file_storage->loadMultiple($fids);
653
    foreach ($files as $file) {
654
      $references = \Drupal::service('file.usage')->listUsage($file);
655
      if (empty($references)) {
656
        if (file_exists($file->getFileUri())) {
657 658 659
          $file->delete();
        }
        else {
660
          \Drupal::logger('file system')->error('Could not delete temporary file "%path" during garbage collection', array('%path' => $file->getFileUri()));
661 662 663
        }
      }
      else {
664
        \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))));
665 666 667 668 669
      }
    }
  }
}

670 671 672 673
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
674 675
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
676
 *
677
 * @param string $form_field_name
678 679
 *   A string that is the associative array key of the upload form element in
 *   the form array.
680
 * @param array $validators
681
 *   (optional) An associative array of callback functions used to validate the
682
 *   file. See file_validate() for a full discussion of the array format.
683 684 685 686 687 688 689 690 691 692 693 694
 *   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.
695
 * @param int $replace
696 697
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
698
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
699 700
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
701 702
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
 *
703 704 705 706
 * @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.
707
 */
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
    $file = File::create($values);
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

    $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