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

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

8
use Drupal\Component\Utility\String;
9
use Drupal\Core\Field\FieldDefinitionInterface;
10
use Drupal\Core\Render\Element;
11
use Drupal\file\Entity\File;
12
use Drupal\Component\Utility\NestedArray;
13
use Drupal\Component\Utility\Unicode;
14
use Drupal\Core\Entity\EntityStorageInterface;
15
use Drupal\Core\Template\Attribute;
16
use Drupal\file\FileUsage\FileUsageInterface;
17
use Symfony\Component\HttpFoundation\Request;
18

19
// Load all Field module hooks for File.
20
require_once __DIR__ . '/file.field.inc';
21

22 23 24
/**
 * Implements hook_help().
 */
25 26 27
function file_help($route_name, Request $request) {
  switch ($route_name) {
    case 'help.page.file':
28 29
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
30
      $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>';
31 32
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
33 34 35 36 37 38 39 40 41 42
      $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>';
43 44 45 46 47
      $output .= '</dl>';
      return $output;
  }
}

48
/**
49
 * Implements hook_element_info().
50
 *
51
 * The managed file element may be used anywhere in Drupal.
52
 */
53 54
function file_element_info() {
  $types['managed_file'] = array(
55 56 57 58
    '#input' => TRUE,
    '#process' => array('file_managed_file_process'),
    '#value_callback' => 'file_managed_file_value',
    '#element_validate' => array('file_managed_file_validate'),
59
    '#pre_render' => array('file_managed_file_pre_render'),
60 61 62 63 64 65
    '#theme' => 'file_managed_file',
    '#theme_wrappers' => array('form_element'),
    '#progress_indicator' => 'throbber',
    '#progress_message' => NULL,
    '#upload_validators' => array(),
    '#upload_location' => NULL,
66
    '#size' => 22,
67
    '#multiple' => FALSE,
68
    '#extended' => FALSE,
69
    '#attached' => array(
70
      'library' => array('file/drupal.file'),
71
    ),
72
  );
73
  return $types;
74 75
}

76 77 78 79 80
/**
 * Loads file entities from the database.
 *
 * @param array $fids
 *   (optional) An array of entity IDs. If omitted, all entities are loaded.
81 82
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
83 84 85 86
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
87 88 89
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::loadMultiple().
 *
90 91 92
 * @see hook_file_load()
 * @see file_load()
 * @see entity_load()
93
 * @see \Drupal\Core\Entity\Query\EntityQueryInterface
94
 */
95
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
96 97 98 99
  if ($reset) {
    \Drupal::entityManager()->getStorage('file')->resetCache($fids);
  }
  return File::loadMultiple($fids);
100 101 102 103 104 105 106
}

/**
 * Loads a single file entity from the database.
 *
 * @param $fid
 *   A file ID.
107 108
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
109
 *
110
 * @return \Drupal\file\FileInterface
111
 *   A file entity or NULL if the file was not found.
112
 *
113 114 115
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::load().
 *
116 117 118
 * @see hook_file_load()
 * @see file_load_multiple()
 */
119
function file_load($fid, $reset = FALSE) {
120 121 122 123
  if ($reset) {
    \Drupal::entityManager()->getStorage('file')->resetCache(array($fid));
  }
  return File::load($fid);
124 125 126
}

/**
127
 * Returns the file usage service.
128
 *
129 130
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('file.usage').
131
 *
132
 * @return \Drupal\file\FileUsage\FileUsageInterface.
133
 */
134
function file_usage() {
135
  return \Drupal::service('file.usage');
136 137 138 139 140 141 142 143 144 145 146
}

/**
 * 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.
147
 * - If the $source and $destination are equal, the behavior depends on the
148
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
149
 *   will rename the file until the $destination is unique.
150 151 152 153
 * - 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.
 *
154
 * @param \Drupal\file\File $source
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
 *   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()
 */
function file_copy(File $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  if (!file_valid_uri($destination)) {
176 177
    if (($realpath = drupal_realpath($source->getFileUri())) !== FALSE) {
      watchdog('file', '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));
178 179
    }
    else {
180
      watchdog('file', '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));
181
    }
182
    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');
183 184 185
    return FALSE;
  }

186 187 188 189
  if ($uri = file_unmanaged_copy($source->getFileUri(), $destination, $replace)) {
    $file = $source->createDuplicate();
    $file->setFileUri($uri);
    $file->setFilename(drupal_basename($uri));
190
    // If we are replacing an existing file re-use its database record.
191 192
    // @todo Do not create a new entity in order to update it, see
    //   https://drupal.org/node/2241865
193 194 195 196
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
      if (count($existing_files)) {
        $existing = reset($existing_files);
197
        $file->fid = $existing->id();
198
        $file->setOriginalId($existing->id());
199
        $file->setFilename($existing->getFilename());
200 201 202 203 204
      }
    }
    // 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)) {
205
      $file->setFilename(drupal_basename($destination));
206 207 208 209 210
    }

    $file->save();

    // Inform modules that the file has been copied.
211
    \Drupal::moduleHandler()->invokeAll('file_copy', array($file, $source));
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

    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.
 *
229
 * @param \Drupal\file\File $source
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
 *   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.
 *
245
 * @return \Drupal\file\File
246 247 248 249 250 251 252
 *   Resulting file entity for success, or FALSE in the event of an error.
 *
 * @see file_unmanaged_move()
 * @see hook_file_move()
 */
function file_move(File $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  if (!file_valid_uri($destination)) {
253 254
    if (($realpath = drupal_realpath($source->getFileUri())) !== FALSE) {
      watchdog('file', '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));
255 256
    }
    else {
257
      watchdog('file', '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));
258
    }
259
    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');
260 261 262
    return FALSE;
  }

263
  if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
264 265 266
    $delete_source = FALSE;

    $file = clone $source;
267
    $file->setFileUri($uri);
268 269 270 271 272 273
    // 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;
274
        $file->fid = $existing->id();
275
        $file->uuid = $existing->uuid();
276 277 278 279 280
      }
    }
    // 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)) {
281
      $file->setFilename(drupal_basename($destination));
282 283 284 285 286
    }

    $file->save();

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

    // Delete the original if it's not in use elsewhere.
290
    if ($delete_source && !\Drupal::service('file.usage')->listUsage($source)) {
291 292 293 294 295 296 297 298 299 300 301 302 303 304
      $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.
 *
305
 * @param \Drupal\file\File $file
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
 *   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()
 */
function file_validate(File $file, $validators = array()) {
  // 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.
331
  return array_merge($errors, \Drupal::moduleHandler()->invokeAll('file_validate', array($file)));
332 333 334 335 336
}

/**
 * Checks for files with names longer than can be stored in the database.
 *
337
 * @param \Drupal\file\File $file
338 339 340 341 342 343 344 345
 *   A file entity.
 *
 * @return
 *   An array. If the file name is too long, it will contain an error message.
 */
function file_validate_name_length(File $file) {
  $errors = array();

346
  if (!$file->getFilename()) {
347 348
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
349
  if (strlen($file->getFilename()) > 240) {
350 351 352 353 354 355 356 357
    $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.
 *
358
 * @param \Drupal\file\File $file
359 360 361 362 363 364 365 366 367 368 369 370 371 372
 *   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()
 */
function file_validate_extensions(File $file, $extensions) {
  $errors = array();

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
373
  if (!preg_match($regex, $file->getFilename())) {
374 375 376 377 378 379 380 381
    $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.
 *
382
 * @param \Drupal\file\File $file
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
 *   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()
 */
function file_validate_size(File $file, $file_limit = 0, $user_limit = 0) {
398
  $user = \Drupal::currentUser();
399 400
  $errors = array();

401 402
  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)));
403
  }
404

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

410 411 412 413
  return $errors;
}

/**
414
 * Checks that the file is recognized as a valid image.
415
 *
416
 * @param \Drupal\file\File $file
417 418 419 420 421 422 423 424 425 426
 *   A file entity.
 *
 * @return
 *   An array. If the file is not an image, it will contain an error message.
 *
 * @see hook_file_validate()
 */
function file_validate_is_image(File $file) {
  $errors = array();

427 428 429 430 431
  $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)));
432 433 434 435 436 437 438 439 440 441 442
  }

  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.
 *
443
 * @param \Drupal\file\File $file
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
 *   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()
 */
function file_validate_image_resolution(File $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
  $errors = array();

  // Check first that the file is an image.
464
  $image_factory = \Drupal::service('image.factory');
465
  $image = $image_factory->get($file->getFileUri());
466
  if ($image->isValid()) {
467 468 469
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
470
      if ($image->getWidth() > $width || $image->getHeight() > $height) {
471
        // Try to resize the image to fit the dimensions.
472
        if ($image->scale($width, $height)) {
473 474
          $image->save();
          $file->filesize = $image->getFileSize();
475 476 477
          drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
        }
        else {
478
          $errors[] = t('The image exceeds the maximum allowed dimensions and an attempt to resize it failed.');
479 480 481 482 483 484 485
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
486
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
        $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.
 *
513
 * @return \Drupal\file\FileInterface
514 515 516 517 518
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
519
  $user = \Drupal::currentUser();
520 521 522 523 524 525 526 527 528 529 530 531 532 533

  if (empty($destination)) {
    $destination = file_default_scheme() . '://';
  }
  if (!file_valid_uri($destination)) {
    watchdog('file', '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));
    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,
534
      'uid' => $user->id(),
535 536 537
      'status' => FILE_STATUS_PERMANENT,
    ));
    // If we are replacing an existing file re-use its database record.
538 539
    // @todo Do not create a new entity in order to update it, see
    //   https://drupal.org/node/2241865
540 541 542 543
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
      if (count($existing_files)) {
        $existing = reset($existing_files);
544
        $file->fid = $existing->id();
545
        $file->setOriginalId($existing->id());
546
        $file->setFilename($existing->getFilename());
547 548 549 550 551
      }
    }
    // 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)) {
552
      $file->setFilename(drupal_basename($destination));
553 554 555 556 557 558 559 560 561 562 563
    }

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

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
564
 * @param \Drupal\file\File $file
565 566 567 568 569 570 571
 *   A file entity.
 *
 * @return
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
function file_get_content_headers(File $file) {
572
  $type = mime_header_encode($file->getMimeType());
573 574

  return array(
575
    'Content-Type' => $type,
576
    'Content-Length' => $file->getSize(),
577 578 579 580
    'Cache-Control' => 'private',
  );
}

581
/**
582
 * Implements hook_theme().
583 584 585
 */
function file_theme() {
  return array(
586
    // From file.module.
587
    'file_link' => array(
588
      'variables' => array('file' => NULL, 'icon_directory' => NULL, 'description' => NULL, 'attributes' => array()),
589
      'template' => 'file-link',
590 591
    ),
    'file_managed_file' => array(
592
      'render element' => 'element',
593
      'template' => 'file-managed-file',
594 595
    ),

596
    // From file.field.inc.
597
    'file_widget' => array(
598
      'render element' => 'element',
599 600
      'template' => 'file-widget',
      'file' => 'file.field.inc',
601 602
    ),
    'file_widget_multiple' => array(
603
      'render element' => 'element',
604 605
      'template' => 'file-widget-multiple',
      'file' => 'file.field.inc',
606
    ),
607
    'file_upload_help' => array(
608
      'variables' => array('description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL),
609 610
      'template' => 'file-upload-help',
      'file' => 'file.field.inc',
611 612 613 614 615
    ),
  );
}

/**
616
 * Implements hook_file_download().
617 618 619
 *
 * This function takes an extra parameter $field_type so that it may
 * be re-used by other File-like modules, such as Image.
620
 */
621
function file_file_download($uri, $field_type = 'file') {
622
  $user = \Drupal::currentUser();
623 624

  // Get the file record based on the URI. If not in the database just return.
625
  /** @var \Drupal\file\FileInterface[] $files */
626
  $files = entity_load_multiple_by_properties('file', array('uri' => $uri));
627
  if (count($files)) {
628 629 630
    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.
631
      if ($item->getFileUri() === $uri) {
632 633 634 635
        $file = $item;
        break;
      }
    }
636
  }
637
  if (!isset($file)) {
638 639 640
    return;
  }

641
  // Find out which (if any) fields of this type contain the file.
642
  $references = file_get_file_references($file, NULL, EntityStorageInterface::FIELD_LOAD_CURRENT, $field_type);
643

644 645 646 647 648
  // 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.
649
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != $user->id())) {
650
    return;
651 652
  }

653 654 655 656 657 658 659 660
  // Default to allow access.
  $denied = FALSE;
  // Loop through all references of this file. If a reference explicitly allows
  // access to the field to which this file belongs, no further checks are done
  // and download access is granted. If a reference denies access, eventually
  // existing additional references are checked. If all references were checked
  // and no reference denied access, access is granted as well. If at least one
  // reference denied access, access is denied.
661
  foreach ($references as $field_name => $field_references) {
662
    foreach ($field_references as $entity_type => $entities) {
663 664
      $field_storage_definitions = \Drupal::entityManager()->getFieldStorageDefinitions($entity_type);
      $field = $field_storage_definitions[$field_name];
665 666
      foreach ($entities as $entity) {
        // Check if access to this field is not disallowed.
667
        if (!$entity->get($field_name)->access('view')) {
668
          $denied = TRUE;
669
          continue;
670 671 672 673 674
        }

        // Invoke hook and collect grants/denies for download access.
        // Default to FALSE and let entities overrule this ruling.
        $grants = array('system' => FALSE);
675
        foreach (\Drupal::moduleHandler()->getImplementations('file_download_access') as $module) {
676
          $grants = array_merge($grants, array($module => \Drupal::moduleHandler()->invoke($module, 'file_download_access', array($field, $entity, $file))));
677 678
        }
        // Allow other modules to alter the returned grants/denies.
679 680 681 682 683
        $context = array(
          'entity' => $entity,
          'field' => $field,
          'file' => $file,
        );
684
        \Drupal::moduleHandler()->alter('file_download_access', $grants, $context);
685 686 687 688 689 690 691 692 693 694 695 696 697

        if (in_array(TRUE, $grants)) {
          // If TRUE is returned, access is granted and no further checks are
          // necessary.
          $denied = FALSE;
          break 3;
        }

        if (in_array(FALSE, $grants)) {
          // If an implementation returns FALSE, access to this entity is denied
          // but the file could belong to another entity to which the user might
          // have access. Continue with these.
          $denied = TRUE;
698 699 700 701 702
        }
      }
    }
  }

703 704
  // Access specifically denied.
  if ($denied) {
705 706 707 708
    return -1;
  }

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

713 714 715 716
/**
 * Implements file_cron()
 */
function file_cron() {
717 718 719 720 721 722 723 724 725 726 727 728
  $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) {
729
      $references = \Drupal::service('file.usage')->listUsage($file);
730
      if (empty($references)) {
731
        if (file_exists($file->getFileUri())) {
732 733 734
          $file->delete();
        }
        else {
735
          watchdog('file system', 'Could not delete temporary file "%path" during garbage collection', array('%path' => $file->getFileUri()), WATCHDOG_ERROR);
736 737 738
        }
      }
      else {
739
        watchdog('file system', '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))), WATCHDOG_INFO);
740 741 742 743 744
      }
    }
  }
}

745 746 747 748
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
749 750
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
751 752 753 754
 *
 * @param $form_field_name
 *   A string that is the associative array key of the upload form element in
 *   the form array.
755 756
 * @param array $form_state
 *   An associative array containing the current state of the form.
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
 * @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').
 */
792
function file_save_upload($form_field_name, $validators = array(), $destination = FALSE, $delta = NULL, $replace = FILE_EXISTS_RENAME) {
793
  $user = \Drupal::currentUser();
794 795
  static $upload_cache;

796
  $file_upload = \Drupal::request()->files->get("files[$form_field_name]", NULL, TRUE);
797
  // Make sure there's an upload to process.
798
  if (empty($file_upload)) {
799 800 801 802 803 804 805 806 807 808 809 810 811 812
    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.
813 814 815
  $uploaded_files = $file_upload;
  if (!is_array($file_upload)) {
    $uploaded_files = array($file_upload);
816 817 818
  }

  $files = array();
819
  foreach ($uploaded_files as $i => $file_info) {
820 821 822
    // 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.
823
    switch ($file_info->getError()) {
824 825
      case UPLOAD_ERR_INI_SIZE:
      case UPLOAD_ERR_FORM_SIZE:
826
        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');
827 828 829 830 831
        $files[$i] = FALSE;
        continue;

      case UPLOAD_ERR_PARTIAL:
      case UPLOAD_ERR_NO_FILE:
832
        drupal_set_message(t('The file %file could not be saved because the upload did not complete.', array('%file' => $file_info->getFilename())), 'error');
833 834 835 836 837 838
        $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.
839
        if (is_uploaded_file($file_info->getRealPath())) {
840 841 842 843 844
          break;
        }

        // Unknown error
      default:
845
        drupal_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $file_info->getFilename())), 'error');
846 847 848 849 850 851 852 853
        $files[$i] = FALSE;
        continue;

    }
    // Begin building file entity.
    $values = array(
      'uid' => $user->id(),
      'status' => 0,
854 855 856
      'filename' => $file_info->getClientOriginalName(),
      'uri' => $file_info->getRealPath(),
      'filesize' => $file_info->getSize(),
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
    );
    $values['filemime'] = file_get_mimetype($values['filename']);
    $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.
892
    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')) {
893
      $file->setMimeType('text/plain');
894
      // The destination filename will also later be used to create the URI.
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
      $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;
    }

    // Add in our check of the the file name length.
    $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) {
941 942 943 944 945
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $errors,
        );
        $message .= drupal_render($item_list);
946 947 948 949
      }
      else {
        $message .= ' ' . array_pop($errors);
      }
950
      drupal_set_message($message, 'error');
951 952 953 954 955 956 957 958
      $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.
    $file->uri = $file->destination;
959
    if (!drupal_move_uploaded_file($file_info->getRealPath(), $file->getFileUri())) {
960
      drupal_set_message(t('File upload error. Could not move uploaded file.'), 'error');
961 962 963 964 965 966 967 968 969
      watchdog('file', 'Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->filename, '%destination' => $file->uri));
      $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.
970 971
    // @todo Do not create a new entity in order to update it, see
    //   https://drupal.org/node/2241865
972 973 974 975 976
    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();
977
        $file->setOriginalId($existing->id());
978 979 980 981 982 983 984 985 986 987 988 989 990 991
      }
    }

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

992
/**
993
 * Determines the preferred upload progress implementation.
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
 *
 * @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;
}

/**
1017
 * Implements hook_file_predelete().
1018
 */
1019
function file_file_predelete(File $file) {
1020 1021 1022
  // TODO: Remove references to a file that is in-use.
}

1023 1024 1025 1026
/**
 * Implements hook_tokens().
 */
function file_tokens($type, $tokens, array $data = array(), array $options = array()) {
1027
  $token_service = \Drupal::token();
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041

  $url_options = array('absolute' => TRUE);
  if (isset($options['langcode'])) {
    $url_options['language'] = language_load($options['langcode']);
    $langcode = $options['langcode'];
  }
  else {
    $langcode = NULL;
  }
  $sanitize = !empty($options['sanitize']);

  $replacements = array();

  if ($type == 'file' && !empty($data['file'])) {
1042
    /** @var \Drupal\file\FileInterface $file */
1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
    $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':
1054
          $replacements[$original] = $sanitize ? String::checkPlain($file->getFilename()) : $file->getFilename();
1055 1056 1057
          break;

        case 'path':
1058
          $replacements[$original] = $sanitize ? String::checkPlain($file->getFileUri()) : $file->getFileUri();
1059 1060 1061
          break;

        case 'mime':
1062
          $replacements[$original] = $sanitize ? String::checkPlain($file->getMimeType()) : $file->getMimeType();
1063 1064 1065 1066 1067