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

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

8
use Drupal\file\Plugin\Core\Entity\File;
9
use Drupal\Component\Utility\NestedArray;
10
use Drupal\Core\Template\Attribute;
11
use Symfony\Component\HttpFoundation\JsonResponse;
12 13
use Drupal\file\FileUsage\DatabaseFileUsageBackend;
use Drupal\file\FileUsage\FileUsageInterface;
14 15
use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\ReplaceCommand;
16

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

20 21 22 23 24 25 26 27
/**
 * Implements hook_help().
 */
function file_help($path, $arg) {
  switch ($path) {
    case 'admin/help#file':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
28
      $output .= '<p>' . t('The File module defines a <em>File</em> field type for the Field module, which lets you manage and validate uploaded files attached to content on your site (see the <a href="@field-help">Field module help page</a> for more information about fields). For more information, see the online handbook entry for <a href="@file">File module</a>.', array('@field-help' => url('admin/help/field'), '@file' => 'http://drupal.org/documentation/modules/file')) . '</p>';
29 30 31 32 33 34 35 36 37 38 39 40 41
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Attaching files to content') . '</dt>';
      $output .= '<dd>' . t('The File module allows users to attach files to content (e.g., PDF files, spreadsheets, etc.), when a <em>File</em> field is added to a given content type using the <a href="@fieldui-help">Field UI module</a>. You can add validation options to your File field, such as specifying a maximum file size and allowed file extensions.', array('@fieldui-help' => url('admin/help/field_ui'))) . '</dd>';
      $output .= '<dt>' . t('Managing attachment display') . '</dt>';
      $output .= '<dd>' . t('When you attach a file to content, you can specify whether it is <em>listed</em> or not. Listed files are displayed automatically in a section at the bottom of your content; non-listed files are available for embedding in your content, but are not included in the list at the bottom.') . '</dd>';
      $output .= '<dt>' . t('Managing file locations') . '</dt>';
      $output .= '<dd>' . t("When you create a File field, you can specify a directory where the files will be stored, which can be within either the <em>public</em> or <em>private</em> files directory. Files in the public directory can be accessed directly through the web server; when public files are listed, direct links to the files are used, and anyone who knows a file's URL can download the file. Files in the private directory are not accessible directly through the web server; when private files are listed, the links are Drupal path requests. This adds to server load and download time, since Drupal must start up and resolve the path for each file download request, but allows for access restrictions.") . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}

42
/**
43
 * Implements hook_menu().
44 45 46 47 48 49 50
 */
function file_menu() {
  $items = array();

  $items['file/ajax'] = array(
    'page callback' => 'file_ajax_upload',
    'access arguments' => array('access content'),
51
    'theme callback' => 'ajax_base_page_theme',
52 53 54 55 56
    'type' => MENU_CALLBACK,
  );
  $items['file/progress'] = array(
    'page callback' => 'file_ajax_progress',
    'access arguments' => array('access content'),
57
    'theme callback' => 'ajax_base_page_theme',
58 59 60 61 62 63 64
    'type' => MENU_CALLBACK,
  );

  return $items;
}

/**
65
 * Implements hook_element_info().
66
 *
67
 * The managed file element may be used anywhere in Drupal.
68
 */
69
function file_element_info() {
70
  $file_path = drupal_get_path('module', 'file');
71
  $types['managed_file'] = array(
72 73 74 75
    '#input' => TRUE,
    '#process' => array('file_managed_file_process'),
    '#value_callback' => 'file_managed_file_value',
    '#element_validate' => array('file_managed_file_validate'),
76
    '#pre_render' => array('file_managed_file_pre_render'),
77 78 79 80 81 82
    '#theme' => 'file_managed_file',
    '#theme_wrappers' => array('form_element'),
    '#progress_indicator' => 'throbber',
    '#progress_message' => NULL,
    '#upload_validators' => array(),
    '#upload_location' => NULL,
83
    '#size' => 22,
84
    '#multiple' => FALSE,
85
    '#extended' => FALSE,
86
    '#attached' => array(
87
      'library' => array(array('file','drupal.file')),
88
    ),
89
  );
90
  return $types;
91 92
}

93 94 95 96 97
/**
 * Loads file entities from the database.
 *
 * @param array $fids
 *   (optional) An array of entity IDs. If omitted, all entities are loaded.
98 99
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
100 101 102 103 104 105 106
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
 * @see hook_file_load()
 * @see file_load()
 * @see entity_load()
107
 * @see Drupal\Core\Entity\Query\EntityQueryInterface
108
 */
109 110
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
  return entity_load_multiple('file', $fids, $reset);
111 112 113 114 115 116 117
}

/**
 * Loads a single file entity from the database.
 *
 * @param $fid
 *   A file ID.
118 119
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
120
 *
121
 * @return \Drupal\file\FileInterface
122
 *   A file entity or NULL if the file was not found.
123 124 125 126
 *
 * @see hook_file_load()
 * @see file_load_multiple()
 */
127
function file_load($fid, $reset = FALSE) {
128
  return entity_load('file', $fid, $reset);
129 130 131
}

/**
132
 * Returns the file usage service.
133
 *
134
 * @return Drupal\file\FileUsage\FileUsageInterface.
135
 */
136
function file_usage() {
137
  return Drupal::service('file.usage');
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
}

/**
 * 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.
 * - Checks that $source is not equal to $destination; if they are an error
 *   is reported.
 * - 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. 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.
 *
 * @param Drupal\file\File $source
 *   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)) {
177 178
    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));
179 180
    }
    else {
181
      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));
182
    }
183
    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');
184 185 186
    return FALSE;
  }

187 188 189 190
  if ($uri = file_unmanaged_copy($source->getFileUri(), $destination, $replace)) {
    $file = $source->createDuplicate();
    $file->setFileUri($uri);
    $file->setFilename(drupal_basename($uri));
191 192 193 194 195
    // 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);
196 197
        $file->fid = $existing->id();
        $file->setFilename($existing->getFilename());
198 199 200 201 202
      }
    }
    // 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)) {
203
      $file->setFilename(drupal_basename($destination));
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
    }

    $file->save();

    // Inform modules that the file has been copied.
    module_invoke_all('file_copy', $file, $source);

    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.
 *
 * @param Drupal\file\File $source
 *   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.
 *
 * @return Drupal\file\File
 *   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)) {
251 252
    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));
253 254
    }
    else {
255
      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));
256
    }
257
    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');
258 259 260
    return FALSE;
  }

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

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

    $file->save();

    // Inform modules that the file has been moved.
    module_invoke_all('file_move', $file, $source);

    // Delete the original if it's not in use elsewhere.
287
    if ($delete_source && !file_usage()->listUsage($source)) {
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 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 331 332 333 334 335 336 337 338 339 340 341 342
      $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.
 *
 * @param Drupal\file\File $file
 *   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.
  return array_merge($errors, module_invoke_all('file_validate', $file));
}

/**
 * Checks for files with names longer than can be stored in the database.
 *
 * @param Drupal\file\File $file
 *   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();

343
  if (!$file->getFilename()) {
344 345
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
346
  if (strlen($file->getFilename()) > 240) {
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
    $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.
 *
 * @param Drupal\file\File $file
 *   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';
370
  if (!preg_match($regex, $file->getFilename())) {
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    $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.
 *
 * @param Drupal\file\File $file
 *   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) {
  global $user;
  $errors = array();

398 399
  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)));
400
  }
401

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

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
  return $errors;
}

/**
 * Checks that the file is recognized by image_get_info() as an image.
 *
 * @param Drupal\file\File $file
 *   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();

424
  $info = image_get_info($file->getFileUri());
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
  if (!$info || empty($info['extension'])) {
    $errors[] = t('Only JPEG, PNG and GIF images are allowed.');
  }

  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.
 *
 * @param Drupal\file\File $file
 *   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.
459
  if ($info = image_get_info($file->getFileUri())) {
460 461 462 463 464
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
      if ($info['width'] > $width || $info['height'] > $height) {
        // Try to resize the image to fit the dimensions.
465
        if ($image = image_load($file->getFileUri())) {
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
          image_scale($image, $width, $height);
          image_save($image);
          $file->filesize = $image->info['file_size'];
          drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
        }
        else {
          $errors[] = t('The image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => $maximum_dimensions));
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
      if ($info['width'] < $width || $info['height'] < $height) {
        $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.
 *
507
 * @return \Drupal\file\FileInterface
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
  global $user;

  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,
528
      'uid' => $user->id(),
529 530 531 532 533 534 535
      'status' => FILE_STATUS_PERMANENT,
    ));
    // 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);
536 537
        $file->fid = $existing->id();
        $file->setFilename($existing->getFilename());
538 539 540 541 542
      }
    }
    // 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)) {
543
      $file->setFilename(drupal_basename($destination));
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
    }

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

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

  return array(
567
    'Content-Type' => $type,
568
    'Content-Length' => $file->getSize(),
569 570 571 572
    'Cache-Control' => 'private',
  );
}

573
/**
574
 * Implements hook_theme().
575 576 577 578 579
 */
function file_theme() {
  return array(
    // file.module.
    'file_link' => array(
580
      'variables' => array('file' => NULL, 'icon_directory' => NULL, 'description' => NULL),
581 582
    ),
    'file_icon' => array(
583
      'variables' => array('file' => NULL, 'icon_directory' => NULL),
584 585
    ),
    'file_managed_file' => array(
586
      'render element' => 'element',
587 588 589 590
    ),

    // file.field.inc.
    'file_widget' => array(
591
      'render element' => 'element',
592 593
    ),
    'file_widget_multiple' => array(
594
      'render element' => 'element',
595
    ),
596 597 598
    'file_formatter_table' => array(
      'variables' => array('items' => NULL),
    ),
599
    'file_upload_help' => array(
600
      'variables' => array('description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL),
601 602 603 604 605
    ),
  );
}

/**
606
 * Implements hook_file_download().
607 608 609
 *
 * This function takes an extra parameter $field_type so that it may
 * be re-used by other File-like modules, such as Image.
610
 */
611
function file_file_download($uri, $field_type = 'file') {
612 613 614
  global $user;

  // Get the file record based on the URI. If not in the database just return.
615
  $files = entity_load_multiple_by_properties('file', array('uri' => $uri));
616
  if (count($files)) {
617 618 619
    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.
620
      if ($item->getFileUri() === $uri) {
621 622 623 624
        $file = $item;
        break;
      }
    }
625
  }
626
  if (!isset($file)) {
627 628 629
    return;
  }

630
  // Find out which (if any) fields of this type contain the file.
631
  $references = file_get_file_references($file, NULL, FIELD_LOAD_CURRENT, $field_type);
632

633 634 635 636 637
  // 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.
638
  if (empty($references) && ($file->isPermanent() || $file->getOwner()->id() != $user->id())) {
639
    return;
640 641
  }

642 643 644 645 646 647 648 649
  // 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.
650
  foreach ($references as $field_name => $field_references) {
651 652
    foreach ($field_references as $entity_type => $entities) {
      foreach ($entities as $entity) {
653
        $field = field_info_field($field_name);
654 655
        // Check if access to this field is not disallowed.
        if (!field_access('view', $field, $entity_type, $entity)) {
656
          $denied = TRUE;
657
          continue;
658 659 660 661 662 663
        }

        // Invoke hook and collect grants/denies for download access.
        // Default to FALSE and let entities overrule this ruling.
        $grants = array('system' => FALSE);
        foreach (module_implements('file_download_access') as $module) {
664
          $grants = array_merge($grants, array($module => module_invoke($module, 'file_download_access', $field, $entity, $file)));
665 666
        }
        // Allow other modules to alter the returned grants/denies.
667 668 669 670 671 672
        $context = array(
          'entity' => $entity,
          'field' => $field,
          'file' => $file,
        );
        drupal_alter('file_download_access', $grants, $context);
673 674 675 676 677 678 679 680 681 682 683 684 685

        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;
686 687 688 689 690
        }
      }
    }
  }

691 692
  // Access specifically denied.
  if ($denied) {
693 694 695 696
    return -1;
  }

  // Access is granted.
697 698
  $headers = file_get_content_headers($file);
  return $headers;
699 700
}

701 702 703 704
/**
 * Implements file_cron()
 */
function file_cron() {
705
  $result = Drupal::entityManager()->getStorageController('file')->retrieveTemporaryFiles();
706 707
  foreach ($result as $row) {
    if ($file = file_load($row->fid)) {
708
      $references = file_usage()->listUsage($file);
709
      if (empty($references)) {
710
        if (file_exists($file->getFileUri())) {
711 712 713
          $file->delete();
        }
        else {
714
          watchdog('file system', 'Could not delete temporary file "%path" during garbage collection', array('%path' => $file->getFileUri()), WATCHDOG_ERROR);
715 716 717
        }
      }
      else {
718
        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);
719 720 721 722 723
      }
    }
  }
}

724
/**
725 726
 * Ajax callback: Processes file uploads and deletions.
 *
727 728 729 730
 * This rebuilds the form element for a particular field item. As long as the
 * form processing is properly encapsulated in the widget element the form
 * should rebuild correctly using FAPI without the need for additional callbacks
 * or processing.
731 732
 *
 * @see file_menu()
733 734 735 736 737
 */
function file_ajax_upload() {
  $form_parents = func_get_args();
  $form_build_id = (string) array_pop($form_parents);

738 739
  $request = \Drupal::request();
  if (!$request->request->has('form_build_id') || $form_build_id != $request->request->get('form_build_id')) {
740 741
    // Invalid request.
    drupal_set_message(t('An unrecoverable error occurred. The uploaded file likely exceeded the maximum file size (@size) that this server supports.', array('@size' => format_size(file_upload_max_size()))), 'error');
742 743
    $response = new AjaxResponse();
    return $response->addCommand(new ReplaceCommand(NULL, theme('status_messages')));
744 745
  }

746
  list($form, $form_state) = ajax_get_form();
747 748 749 750

  if (!$form) {
    // Invalid form_build_id.
    drupal_set_message(t('An unrecoverable error occurred. Use of this form has expired. Try reloading the page and submitting again.'), 'error');
751 752
    $response = new AjaxResponse();
    return $response->addCommand(new ReplaceCommand(NULL, theme('status_messages')));
753 754 755 756 757 758 759 760 761
  }

  // Get the current element and count the number of files.
  $current_element = $form;
  foreach ($form_parents as $parent) {
    $current_element = $current_element[$parent];
  }
  $current_file_count = isset($current_element['#file_upload_delta']) ? $current_element['#file_upload_delta'] : 0;

762 763
  // Process user input. $form and $form_state are modified in the process.
  drupal_process_form($form['#form_id'], $form, $form_state);
764 765 766 767 768 769

  // Retrieve the element to be rendered.
  foreach ($form_parents as $parent) {
    $form = $form[$parent];
  }

770
  // Add the special Ajax class if a new file was added.
771 772 773 774 775 776 777 778
  if (isset($form['#file_upload_delta']) && $current_file_count < $form['#file_upload_delta']) {
    $form[$current_file_count]['#attributes']['class'][] = 'ajax-new-content';
  }
  // Otherwise just add the new content class on a placeholder.
  else {
    $form['#suffix'] .= '<span class="ajax-new-content"></span>';
  }

779 780
  $form['#prefix'] .= theme('status_messages');
  $output = drupal_render($form);
781
  $js = drupal_add_js();
782
  $settings = drupal_merge_js_settings($js['settings']['data']);
783

784 785
  $response = new AjaxResponse();
  return $response->addCommand(new ReplaceCommand(NULL, $output, $settings));
786 787 788
}

/**
789 790
 * Ajax callback: Retrieves upload progress.
 *
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
 * @param $key
 *   The unique key for this upload process.
 */
function file_ajax_progress($key) {
  $progress = array(
    'message' => t('Starting upload...'),
    'percentage' => -1,
  );

  $implementation = file_progress_implementation();
  if ($implementation == 'uploadprogress') {
    $status = uploadprogress_get_info($key);
    if (isset($status['bytes_uploaded']) && !empty($status['bytes_total'])) {
      $progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['bytes_uploaded']), '@total' => format_size($status['bytes_total'])));
      $progress['percentage'] = round(100 * $status['bytes_uploaded'] / $status['bytes_total']);
    }
  }
  elseif ($implementation == 'apc') {
    $status = apc_fetch('upload_' . $key);
    if (isset($status['current']) && !empty($status['total'])) {
      $progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['current']), '@total' => format_size($status['total'])));
      $progress['percentage'] = round(100 * $status['current'] / $status['total']);
    }
  }

816
  return new JsonResponse($progress);
817 818 819
}

/**
820
 * Determines the preferred upload progress implementation.
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
 *
 * @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;
}

/**
844
 * Implements hook_file_predelete().
845
 */
846
function file_file_predelete(File $file) {
847 848 849 850
  // TODO: Remove references to a file that is in-use.
}

/**
851
 * Render API callback: Expands the managed_file element type.
852 853 854
 *
 * Expands the file type to include Upload and Remove buttons, as well as
 * support for a default value.
855 856
 *
 * This function is assigned as a #process callback in file_element_info().
857 858
 */
function file_managed_file_process($element, &$form_state, $form) {
859 860 861
  // Append the '-upload' to the #id so the field label's 'for' attribute
  // corresponds with the file element.
  $element['#id'] .= '-upload';
862 863 864 865 866

  // This is used sometimes so let's implode it just once.
  $parents_prefix = implode('_', $element['#parents']);

  $fids = isset($element['#value']['fids']) ? $element['#value']['fids'] : array();
867 868 869

  // Set some default element properties.
  $element['#progress_indicator'] = empty($element['#progress_indicator']) ? 'none' : $element['#progress_indicator'];
870
  $element['#files'] = !empty($fids) ? file_load_multiple($fids) : FALSE;
871 872 873
  $element['#tree'] = TRUE;

  $ajax_settings = array(
874
    'path' => 'file/ajax/' . implode('/', $element['#array_parents']) . '/' . $form['form_build_id']['#value'],
875 876 877 878 879 880 881 882 883 884
    'wrapper' => $element['#id'] . '-ajax-wrapper',
    'effect' => 'fade',
    'progress' => array(
      'type' => $element['#progress_indicator'],
      'message' => $element['#progress_message'],
    ),
  );

  // Set up the buttons first since we need to check if they were clicked.
  $element['upload_button'] = array(
885
    '#name' => $parents_prefix . '_upload_button',
886 887 888 889
    '#type' => 'submit',
    '#value' => t('Upload'),
    '#validate' => array(),
    '#submit' => array('file_managed_file_submit'),
890
    '#limit_validation_errors' => array($element['#parents']),
891 892 893 894
    '#ajax' => $ajax_settings,
    '#weight' => -5,
  );

895 896 897
  // Force the progress indicator for the remove button to be either 'none' or
  // 'throbber', even if the upload button is using something else.
  $ajax_settings['progress']['type'] = ($element['#progress_indicator'] == 'none') ? 'none' : 'throbber';
898 899 900
  $ajax_settings['progress']['message'] = NULL;
  $ajax_settings['effect'] = 'none';
  $element['remove_button'] = array(
901
    '#name' => $parents_prefix . '_remove_button',
902
    '#type' => 'submit',
903
    '#value' => $element['#multiple'] ? t('Remove selected') : t('Remove'),
904 905
    '#validate' => array(),
    '#submit' => array('file_managed_file_submit'),
906
    '#limit_validation_errors' => array($element['#parents']),
907
    '#ajax' => $ajax_settings,
908
    '#weight' => 1,
909 910
  );

911
  $element['fids'] = array(
912
    '#type' => 'hidden',
913
    '#value' => $fids,
914 915 916 917
  );

  // Add progress bar support to the upload if possible.
  if ($element['#progress_indicator'] == 'bar' && $implementation = file_progress_implementation()) {
918
    $upload_progress_key = mt_rand();
919 920 921 922 923 924

    if ($implementation == 'uploadprogress') {
      $element['UPLOAD_IDENTIFIER'] = array(
        '#type' => 'hidden',
        '#value' => $upload_progress_key,
        '#attributes' => array('class' => array('file-progress')),
925 926 927
        // Uploadprogress extension requires this field to be at the top of the
        // form.
        '#weight' => -20,
928 929 930 931 932 933 934
      );
    }
    elseif ($implementation == 'apc') {
      $element['APC_UPLOAD_PROGRESS'] = array(
        '#type' => 'hidden',
        '#value' => $upload_progress_key,
        '#attributes' => array('class' => array('file-progress')),
935 936 937
        // Uploadprogress extension requires this field to be at the top of the
        // form.
        '#weight' => -20,
938 939 940 941 942 943 944 945 946
      );
    }

    // Add the upload progress callback.
    $element['upload_button']['#ajax']['progress']['path'] = 'file/progress/' . $upload_progress_key;
  }

  // The file upload field itself.
  $element['upload'] = array(
947
    '#name' => 'files[' . $parents_prefix . ']',
948
    '#type' => 'file',
949 950
    '#title' => t('Choose a file'),
    '#title_display' => 'invisible',
951
    '#size' => $element['#size'],
952
    '#multiple' => $element['#multiple'],
953 954 955 956
    '#theme_wrappers' => array(),
    '#weight' => -10,
  );

957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
  if (!empty($fids) && $element['#files']) {
    foreach ($element['#files'] as $delta => $file) {
      if ($element['#multiple']) {
        $element['file_' . $delta]['selected'] = array(
          '#type' => 'checkbox',
          '#title' => theme('file_link', array('file' => $file)) . ' ',
        );
      }
      else {
        $element['file_' . $delta]['filename'] = array(
          '#markup' => theme('file_link', array('file' => $file)) . ' ',
          '#weight' => -10,
        );
      }
    }
972 973
  }

974
  // Add the extension list to the page as JavaScript settings.
975
  if (isset($element['#upload_validators']['file_validate_extensions'][0])) {
976 977 978 979 980 981 982
    $extension_list = implode(',', array_filter(explode(' ', $element['#upload_validators']['file_validate_extensions'][0])));
    $element['upload']['#attached']['js'] = array(
      array(
        'type' => 'setting',
        'data' => array('file' => array('elements' => array('#' . $element['#id'] . '-upload' => $extension_list)))
      )
    );
983 984
  }

985
  // Prefix and suffix used for Ajax replacement.
986 987 988 989 990 991 992
  $element['#prefix'] = '<div id="' . $element['#id'] . '-ajax-wrapper">';
  $element['#suffix'] = '</div>';

  return $element;
}

/**
993 994 995
 * Render API callback: Determines the value for a managed_file type element.
 *
 * This function is assigned as a #value_callback in file_element_info().
996 997
 */
function file_managed_file_value(&$element, $input = FALSE, $form_state = NULL) {
998 999 1000 1001
  // Find the current value of this field.
  $fids = !empty($input['fids']) ? explode(' ', $input['fids']) : array();
  foreach ($fids as $key => $fid) {
    $fids[$key] = (int) $fid;
1002 1003 1004 1005
  }

  // Process any input and save new uploads.
  if ($input !== FALSE) {
1006
    $input['fids'] = $fids;
1007 1008 1009
    $return = $input;

    // Uploads take priority over all other values.
1010 1011 1012 1013 1014 1015 1016
    if ($files = file_managed_file_save_upload($element)) {
      if ($element['#multiple']) {
        $fids = array_merge($fids, array_keys($files));
      }
      else {
        $fids = array_keys($files);
      }
1017 1018 1019 1020 1021 1022 1023 1024
    }
    else {
      // Check for #filefield_value_callback values.
      // Because FAPI does not allow multiple #value_callback values like it
      // does for #element_validate and #process, this fills the missing
      // functionality to allow File fields to be extended through FAPI.
      if (isset($element['#file_value_callbacks'])) {
        foreach ($element['#file_value_callbacks'] as $callback) {
1025
          $callback($element, $input, $form_state);
1026 1027
        }
      }
1028 1029 1030 1031 1032 1033

      // Load files if the FIDs have changed to confirm they exist.
      if (!empty($input['fids'])) {
        $fids = array();
        foreach ($input['fids'] as $key => $fid) {
          if ($file = file_load($fid)) {
1034
            $fids[] = $file->id();
1035 1036
          }
        }
1037 1038 1039 1040 1041 1042 1043
      }
    }
  }

  // If there is no input, set the default value.
  else {
    if ($element['#extended']) {
1044 1045
      $default_fids = isset($element['#default_value']['fids']) ? $element['#default_value']['fids'] : array();
      $return = isset($element['#default_value']) ? $element['#default_value'] : array('fids' => array());
1046 1047
    }
    else {
1048 1049
      $default_fids = isset($element['#default_value']) ? $element['#default_value'] : array();
      $return = array('fids' => array());
1050 1051 1052
    }

    // Confirm that the file exists when used as a default value.
1053 1054 1055 1056
    if (!empty($default_fids)) {
      $fids = array();
      foreach ($default_fids as $key => $fid) {
        if ($file = file_load($fid)) {
1057
          $fids[] = $file->id();
1058 1059
        }
      }
1060 1061 1062
    }
  }

1063
  $return['fids'] = $fids;
1064 1065 1066 1067
  return $return;
}

/**
1068 1069 1070 1071
 * Render API callback: Validates the managed_file element.
 *
 * This function is assigned as a #element_validate callback in
 * file_element_info().
1072 1073 1074 1075 1076
 */
function file_managed_file_validate(&$element, &$form_state) {
  // If referencing an existing file, only allow if there are existing
  // references. This prevents unmanaged files from being deleted if this
  // item were to be deleted.
1077
  $clicked_button = end($form_state['triggering_element']['#parents']);
1078 1079 1080 1081
  if ($clicked_button != 'remove_button' && !empty($element['fids']['#value'])) {
    $fids = $element['fids']['#value'];
    foreach ($fids as $fid) {
      if ($file = file_load($fid)) {
1082
        if ($file->isPermanent()) {
1083 1084 1085 1086
          $references = file_usage()->listUsage($file);
          if (empty($references)) {
            form_error($element, t('The file used in the !name field may not be referenced.', array('!name' => $element['#title'])));
          }
1087 1088
        }
      }
1089 1090 1091
      else {
        form_error($element, t('The file referenced by the !name field does not exist.', array('!name' => $element['#title'])));
      }
1092 1093 1094 1095
    }
  }

  // Check required property based on the FID.
1096
  if ($element['#required'] && empty($element['fids']['#value']) && !in_array($clicked_button, array('upload_button', 'remove_button'))) {
1097 1098 1099
    form_error($element['upload'], t('!name field is required.', array('!name' => $element['#title'])));
  }

1100
  // Consolidate the array value of this field to array of FIDs.
1101
  if (!$element['#extended']) {
1102
    form_set_value($element, $element['fids']['#value'], $form_state);
1103 1104 1105 1106