file.module 59.3 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\Component\Utility\SafeMarkup;
9
use Drupal\Core\Field\FieldDefinitionInterface;
10
use Drupal\Core\Form\FormStateInterface;
11
use Drupal\Core\Render\Element;
12
use Drupal\Core\Routing\RouteMatchInterface;
13
use Drupal\Core\Url;
14
use Drupal\file\Entity\File;
15
use Drupal\file\FileInterface;
16
use Drupal\Component\Utility\NestedArray;
17
use Drupal\Component\Utility\Unicode;
18
use Drupal\Core\Entity\EntityStorageInterface;
19
use Drupal\Core\Template\Attribute;
20
use Drupal\file\FileUsage\FileUsageInterface;
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::url('help.page', array('name' => 'field_ui')), '!file_documentation' => 'https://drupal.org/documentation/modules/file')) . '</p>';
34 35
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
36 37 38 39 40 41 42 43 44 45
      $output .= '<dt>' . t('Managing and displaying file fields') . '</dt>';
      $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::url('help.page', array('name' => 'field_ui')))) . '</dd>';
      $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>';
      $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>';
      $output .= '<dt>' . t('Restricting the maximum file size') . '</dt>';
      $output .= '<dd>' . t('The maximum file size that users can upload is limited by PHP settings of the server, but you can restrict by entering the desired value as the <em>Maximum upload size</em> setting. The maximum file size is automatically displayed to users in the help text of the file field.') . '</dd>';
      $output .= '<dt>' . t('Displaying files and descriptions') . '<dt>';
      $output .= '<dd>' . t('In the field settings, you can allow users to toggle whether individual files are displayed. In the display settings, you can then choose one of the following formats: <ul><li><em>Generic file</em> displays links to the files and adds icons that symbolize the file extensions. If <em>descriptions</em> are enabled and have been submitted, then the description is displayed instead of the file name.</li><li><em>URL to file</em> displays the full path to the file as plain text.</li><li><em>Table of files</em> lists links to the files and the file sizes in a table.</li><li><em>RSS enclosure</em> only displays the first file, and only in a RSS feed, formatted according to the RSS 2.0 syntax for enclosures.</li></ul> A file can still be linked to directly by its URI even if it is not displayed.') . '</dd>';
46 47 48 49 50
      $output .= '</dl>';
      return $output;
  }
}

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

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

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

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

    $file->save();

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

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

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

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

    $file->save();

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

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

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

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

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
336
  if (!preg_match($regex, $file->getFilename())) {
337 338 339 340 341 342 343 344
    $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.
 *
345
 * @param \Drupal\file\FileInterface $file
346 347 348 349 350 351 352 353 354 355 356 357 358 359
 *   A file entity.
 * @param $file_limit
 *   An integer specifying the maximum file size in bytes. Zero indicates that
 *   no limit should be enforced.
 * @param $user_limit
 *   An integer specifying the maximum number of bytes the user is allowed.
 *   Zero indicates that no limit should be enforced.
 *
 * @return
 *   An array. If the file size exceeds limits, it will contain an error
 *   message.
 *
 * @see hook_file_validate()
 */
360
function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = 0) {
361
  $user = \Drupal::currentUser();
362 363
  $errors = array();

364 365
  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)));
366
  }
367

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

373 374 375 376
  return $errors;
}

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

390 391 392 393 394
  $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)));
395 396 397 398 399 400 401 402 403 404 405
  }

  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.
 *
406
 * @param \Drupal\file\FileInterface $file
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
 *   A file entity. This function may resize the file affecting its size.
 * @param $maximum_dimensions
 *   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.
 * @param $minimum_dimensions
 *   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()
 */
423
function file_validate_image_resolution(FileInterface $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
424 425 426
  $errors = array();

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

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

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

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

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

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

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

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

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

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

597 598 599 600 601
  // 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.
602
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
603
    return;
604 605
  }

606
  if (!$file->access('download')) {
607 608 609 610
    return -1;
  }

  // Access is granted.
611 612
  $headers = file_get_content_headers($file);
  return $headers;
613 614
}

615 616 617 618
/**
 * Implements file_cron()
 */
function file_cron() {
619 620 621 622 623 624 625 626 627 628 629 630
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');

  // 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();
    $files = file_load_multiple($fids);
    foreach ($files as $file) {
631
      $references = \Drupal::service('file.usage')->listUsage($file);
632
      if (empty($references)) {
633
        if (file_exists($file->getFileUri())) {
634 635 636
          $file->delete();
        }
        else {
637
          \Drupal::logger('file system')->error('Could not delete temporary file "%path" during garbage collection', array('%path' => $file->getFileUri()));
638 639 640
        }
      }
      else {
641
        \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))));
642 643 644 645 646
      }
    }
  }
}

647 648 649 650
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
651 652
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
 *
 * @param $form_field_name
 *   A string that is the associative array key of the upload form element in
 *   the form array.
 * @param $validators
 *   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).
 * @param $destination
 *   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://").
 * @param $delta
 *   Delta of the file to save or NULL to save all files. Defaults to NULL.
 * @param $replace
 *   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.
 *
 * @return
 *   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').
 */
692
function file_save_upload($form_field_name, $validators = array(), $destination = FALSE, $delta = NULL, $replace = FILE_EXISTS_RENAME) {
693
  $user = \Drupal::currentUser();
694 695
  static $upload_cache;

696
  $file_upload = \Drupal::request()->files->get("files[$form_field_name]", NULL, TRUE);
697
  // Make sure there's an upload to process.
698
  if (empty($file_upload)) {
699 700 701 702 703 704 705 706 707 708 709 710 711 712
    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.
713 714 715
  $uploaded_files = $file_upload;
  if (!is_array($file_upload)) {
    $uploaded_files = array($file_upload);
716 717 718
  }

  $files = array();
719
  foreach ($uploaded_files as $i => $file_info) {
720 721 722
    // 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.
723
    switch ($file_info->getError()) {
724 725
      case UPLOAD_ERR_INI_SIZE:
      case UPLOAD_ERR_FORM_SIZE:
726
        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');
727 728 729 730 731
        $files[$i] = FALSE;
        continue;

      case UPLOAD_ERR_PARTIAL:
      case UPLOAD_ERR_NO_FILE:
732
        drupal_set_message(t('The file %file could not be saved because the upload did not complete.', array('%file' => $file_info->getFilename())), 'error');
733 734 735 736 737 738
        $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.
739
        if (is_uploaded_file($file_info->getRealPath())) {
740 741 742 743 744
          break;
        }

        // Unknown error
      default:
745
        drupal_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $file_info->getFilename())), 'error');
746 747 748 749 750 751 752 753
        $files[$i] = FALSE;
        continue;

    }
    // Begin building file entity.
    $values = array(
      'uid' => $user->id(),
      'status' => 0,
754 755 756
      'filename' => $file_info->getClientOriginalName(),
      'uri' => $file_info->getRealPath(),
      'filesize' => $file_info->getSize(),
757
    );
758
    $values['filemime'] = \Drupal::service('file.mime_type.guesser')->guess($values['filename']);
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
    $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.
792
    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')) {
793
      $file->setMimeType('text/plain');
794
      // The destination filename will also later be used to create the URI.
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
      $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;
    }

831
    // Add in our check of the file name length.
832 833 834 835 836 837 838 839 840
    $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)) {
      $message = t('The specified file %name could not be uploaded.', array('%name' => $file->getFilename()));
      if (count($errors) > 1) {
841 842 843 844
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $errors,
        );
845
        $message = SafeMarkup::set($message . drupal_render($item_list));
846 847
      }
      else {
848
        $message = SafeMarkup::set($message . ' ' . SafeMarkup::escape(array_pop($errors)));
849
      }
850
      drupal_set_message($message, 'error');
851 852 853 854 855 856 857
      $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.
858
    $file->setFileUri($file->destination);
859
    if (!drupal_move_uploaded_file($file_info->getRealPath(), $file->getFileUri())) {
860
      drupal_set_message(t('File upload error. Could not move uploaded file.'), 'error');
861
      \Drupal::logger('file')->notice('Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->getFilename(), '%destination' => $file->getFileUri()));
862 863 864 865 866 867 868 869
      $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.
870 871
    // @todo Do not create a new entity in order to update it, see
    //   https://drupal.org/node/2241865
872 873 874 875 876
    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();
877
        $file->setOriginalId($existing->id());
878 879 880 881 882 883 884 885 886 887 888 889 890 891
      }
    }

    // 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;
}

892
/**
893
 * Determines the preferred upload progress implementation.
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
 *
 * @return
 *   A string indicating which upload progress system is available. Either "apc"
 *   or "uploadprogress". If neither are available, returns FALSE.
 */
function file_progress_implementation() {
  static $implementation;
  if (!isset($implementation)) {
    $implementation = FALSE;

    // We prefer the PECL extension uploadprogress because it supports multiple
    // simultaneous uploads. APC only supports one at a time.
    if (extension_loaded('uploadprogress')) {
      $implementation = 'uploadprogress';
    }
    elseif (extension_loaded('apc') && ini_get('apc.rfc1867')) {
      $implementation = 'apc';
    }
  }
  return $implementation;
}

/**
917
 * Implements hook_ENTITY_TYPE_predelete() for file entities.
918
 */
919
function file_file_predelete(File $file) {
920 921 922
  // TODO: Remove references to a file that is in-use.
}

923 924 925 926
/**
 * Implements hook_tokens().
 */
function file_tokens($type, $tokens, array $data = array(), array $options = array()) {
927
  $token_service = \Drupal::token();
928 929 930

  $url_options = array('absolute' => TRUE);
  if (isset($options['langcode'])) {
931
    $url_options['language'] = \Drupal::languageManager()->getLanguage($options['langcode']);
932 933 934 935 936 937 938 939 940 941
    $langcode = $options['langcode'];
  }
  else {
    $langcode = NULL;
  }
  $sanitize = !empty($options['sanitize']);

  $replacements = array();

  if ($type == 'file' && !empty($data['file'])) {
942
    /** @var \Drupal\file\FileInterface $file */
943 944 945 946 947 948 949 950 951 952 953
    $file = $data['file'];

    foreach ($tokens as $name => $original) {
      switch ($name) {
        // Basic keys and values.
        case 'fid':
          $replacements[$original] = $file->id();
          break;

        // Essential file data
        case 'name':
954
          $replacements[$original] = $sanitize ? SafeMarkup::checkPlain($file->getFilename()) : $file->getFilename();
955 956 957
          break;

        case 'path':
958
          $replacements[$original] = $sanitize ? SafeMarkup::checkPlain($file->getFileUri()) : $file->getFileUri();
959 960 961
          break;

        case 'mime':
962
          $replacements[$original] = $sanitize ? SafeMarkup::checkPlain($file->getMimeType()) : $file->getMimeType();
963 964 965 966 967 968 969
          break;

        case 'size':
          $replacements[$original] = format_size($file->getSize());
          break;

        case 'url':
970
          $replacements[$original] = $sanitize ? SafeMarkup::checkPlain(file_create_url($file->getFileUri())) : file_create_url($file->getFileUri());
971 972 973
          break;

        // These tokens are default variations on the chained tokens handled below.
974 975 976 977 978
        case 'created':
          $replacements[$original] = format_date($file->getCreatedTime(), 'medium', '', NULL, $langcode);
          break;

        case 'changed':
979 980 981 982 983
          $replacements[$original] = format_date($file->getChangedTime(), 'medium', '', NULL, $langcode);
          break;

        case 'owner':
          $name = $file->getOwner()->label();
984
          $replacements[$original] = $sanitize ? SafeMarkup::checkPlain($name) : $name;
985 986 987 988
          break;
      }
    }

989 990 991 992 993
    if ($date_tokens = $token_service->findWithPrefix($tokens, 'created')) {
      $replacements += $token_service->generate('date', $date_tokens, array('date' => $file->getCreatedTime()), $options);
    }

    if ($date_tokens = $token_service->findWithPrefix($tokens, 'changed')) {
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
      $replacements += $token_service->generate('date', $date_tokens, array('date' => $file->getChangedTime()), $options);
    }

    if (($owner_tokens = $token_service->findWithPrefix($tokens, 'owner')) && $file->getOwner()) {
      $replacements += $token_service->generate('user', $owner_tokens, array('user' => $file->getOwner()), $options);
    }
  }

  return $replacements;
}

/**
 * Implements hook_token_info().
 */
function file_token_info() {
  $types['file'] = array(
    'name' => t("Files"),
    'description' => t("Tokens related to uploaded files."),
    'needs-data' => 'file',
  );

  // File related tokens.
  $file['fid'] = array(
    'name' => t("File ID"),
    'description' => t("The unique ID of the uploaded file."),
  );
  $file['name'] = array(
    'name' => t("File name"),
    'description' => t("The name of the file on disk."),
  );
  $file['path'] = array(
    'name' => t("Path"),
    'description' => t("The location of the file relative to Drupal root."),
  );
  $file['mime'] = array(
    'name' => t("MIME type"),
    'description' => t("The MIME type of the file."),
  );
  $file['size'] = array(
    'name' => t("File size"),
    'description' => t("The size of the file."),
  );
  $file['url'] = array(
    'name' => t("URL"),
    'description' => t("The web-accessible URL for the file."),
  );
1040 1041 1042 1043 1044 1045 1046
  $file['created'] = array(
    'name' => t("Created"),
    'description' => t("The date the file created."),
    'type' => 'date',
  );
  $file['changed'] = array(
    'name' => t("Changed"),
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
    'description' => t("The date the file was most recently changed."),
    'type' => 'date',
  );
  $file['owner'] = array(
    'name' => t("Owner"),
    'description' => t("The user who originally uploaded the file."),
    'type' => 'user',
  );

  return array(
    'types' => $types,
    'tokens' => array(
      'file' => $file,
    ),
  );
}