file.module 61 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 DRUPAL_ROOT . '/core/modules/file/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 98 99 100 101 102
/**
 * Implements hook_entity_view_mode_info().
 */
function file_entity_view_mode_info() {
  $view_modes['file']['full'] = array(
    'label' => t('File default'),
  );
  return $view_modes;
}

103 104 105 106 107
/**
 * Loads file entities from the database.
 *
 * @param array $fids
 *   (optional) An array of entity IDs. If omitted, all entities are loaded.
108 109
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
110 111 112 113 114 115 116
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
 * @see hook_file_load()
 * @see file_load()
 * @see entity_load()
117
 * @see Drupal\Core\Entity\Query\EntityQueryInterface
118
 */
119 120
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
  return entity_load_multiple('file', $fids, $reset);
121 122 123 124 125 126 127
}

/**
 * Loads a single file entity from the database.
 *
 * @param $fid
 *   A file ID.
128 129
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
130 131 132 133 134 135 136
 *
 * @return Drupal\file\File
 *   A file entity or FALSE if the file was not found.
 *
 * @see hook_file_load()
 * @see file_load_multiple()
 */
137 138
function file_load($fid, $reset = FALSE) {
  $files = file_load_multiple(array($fid), $reset);
139 140 141 142
  return reset($files);
}

/**
143
 * Returns the file usage service.
144
 *
145
 * @return Drupal\file\FileUsage\FileUsageInterface.
146
 */
147 148
function file_usage() {
  return drupal_container()->get('file.usage');
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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
}

/**
 * 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)) {
    if (($realpath = drupal_realpath($source->uri)) !== 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->uri, '%realpath' => $realpath, '%destination' => $destination));
    }
    else {
      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->uri, '%destination' => $destination));
    }
    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->uri)), 'error');
    return FALSE;
  }

  if ($uri = file_unmanaged_copy($source->uri, $destination, $replace)) {
    $file = clone $source;
    $file->fid = NULL;
    $file->uri = $uri;
    $file->filename = drupal_basename($uri);
    // 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);
        $file->fid = $existing->fid;
        $file->filename = $existing->filename;
      }
    }
    // 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)) {
      $file->filename = drupal_basename($destination);
    }

    $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)) {
    if (($realpath = drupal_realpath($source->uri)) !== 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->uri, '%realpath' => $realpath, '%destination' => $destination));
    }
    else {
      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->uri, '%destination' => $destination));
    }
    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->uri)), 'error');
    return FALSE;
  }

  if ($uri = file_unmanaged_move($source->uri, $destination, $replace)) {
    $delete_source = FALSE;

    $file = clone $source;
    $file->uri = $uri;
    // 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;
        $file->fid = $existing->fid;
      }
    }
    // 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)) {
      $file->filename = drupal_basename($destination);
    }

    $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.
299
    if ($delete_source && !file_usage()->listUsage($source)) {
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 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 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 398 399 400 401 402 403 404 405 406 407 408 409 410 411
      $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();

  if (empty($file->filename)) {
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
  if (strlen($file->filename) > 240) {
    $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';
  if (!preg_match($regex, $file->filename)) {
    $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.
 *
 * This check is not enforced for the user #1.
 *
 * @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();

412
  if ($file_limit && $file->filesize > $file_limit) {
413
    $errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', array('%filesize' => format_size($file->filesize), '%maxsize' => format_size($file_limit)));
414
  }
415

416
  // Save a query by only calling spaceUsed() when a limit is provided.
417
  if ($user_limit && (drupal_container()->get('plugin.manager.entity')->getStorageController('file')->spaceUsed($user->uid) + $file->filesize) > $user_limit) {
418
    $errors[] = t('The file is %filesize which would exceed your disk quota of %quota.', array('%filesize' => format_size($file->filesize), '%quota' => format_size($user_limit)));
419
  }
420

421 422 423 424 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 459 460 461 462 463 464 465 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 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
  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();

  $info = image_get_info($file->uri);
  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.
  if ($info = image_get_info($file->uri)) {
    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.
        if ($image = image_load($file->uri)) {
          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.
 *
 * @return Drupal\file\File
 *   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,
      'uid' => $user->uid,
      '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);
        $file->fid = $existing->fid;
        $file->filename = $existing->filename;
      }
    }
    // 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)) {
      $file->filename = drupal_basename($destination);
    }

    $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) {
  $name = mime_header_encode($file->filename);
  $type = mime_header_encode($file->filemime);

  return array(
581
    'Content-Type' => $type,
582 583 584 585 586
    'Content-Length' => $file->filesize,
    'Cache-Control' => 'private',
  );
}

587
/**
588
 * Implements hook_theme().
589 590 591 592 593
 */
function file_theme() {
  return array(
    // file.module.
    'file_link' => array(
594
      'variables' => array('file' => NULL, 'icon_directory' => NULL, 'description' => NULL),
595 596
    ),
    'file_icon' => array(
597
      'variables' => array('file' => NULL, 'icon_directory' => NULL),
598 599
    ),
    'file_managed_file' => array(
600
      'render element' => 'element',
601 602 603 604
    ),

    // file.field.inc.
    'file_widget' => array(
605
      'render element' => 'element',
606 607
    ),
    'file_widget_multiple' => array(
608
      'render element' => 'element',
609
    ),
610 611 612
    'file_formatter_table' => array(
      'variables' => array('items' => NULL),
    ),
613
    'file_upload_help' => array(
614
      'variables' => array('description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL),
615 616 617 618 619
    ),
  );
}

/**
620
 * Implements hook_file_download().
621 622 623
 *
 * This function takes an extra parameter $field_type so that it may
 * be re-used by other File-like modules, such as Image.
624
 */
625
function file_file_download($uri, $field_type = 'file') {
626 627 628
  global $user;

  // Get the file record based on the URI. If not in the database just return.
629
  $files = entity_load_multiple_by_properties('file', array('uri' => $uri));
630
  if (count($files)) {
631 632 633 634 635 636 637 638
    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.
      if ($item->uri === $uri) {
        $file = $item;
        break;
      }
    }
639
  }
640
  if (!isset($file)) {
641 642 643
    return;
  }

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

647 648 649 650 651
  // 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.
652
  if (empty($references) && ($file->status == FILE_STATUS_PERMANENT || $file->uid != $user->uid)) {
653
    return;
654 655
  }

656 657 658 659 660 661 662 663
  // 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.
664
  foreach ($references as $field_name => $field_references) {
665 666
    foreach ($field_references as $entity_type => $entities) {
      foreach ($entities as $entity) {
667
        $field = field_info_field($field_name);
668 669
        // Check if access to this field is not disallowed.
        if (!field_access('view', $field, $entity_type, $entity)) {
670
          $denied = TRUE;
671
          continue;
672 673 674 675 676 677
        }

        // 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) {
678
          $grants = array_merge($grants, array($module => module_invoke($module, 'file_download_access', $field, $entity, $file)));
679 680
        }
        // Allow other modules to alter the returned grants/denies.
681 682 683 684 685 686
        $context = array(
          'entity' => $entity,
          'field' => $field,
          'file' => $file,
        );
        drupal_alter('file_download_access', $grants, $context);
687 688 689 690 691 692 693 694 695 696 697 698 699

        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;
700 701 702 703 704
        }
      }
    }
  }

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

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

715 716 717 718
/**
 * Implements file_cron()
 */
function file_cron() {
719
  $result = drupal_container()->get('plugin.manager.entity')->getStorageController('file')->retrieveTemporaryFiles();
720 721
  foreach ($result as $row) {
    if ($file = file_load($row->fid)) {
722
      $references = file_usage()->listUsage($file);
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
      if (empty($references)) {
        if (file_exists($file->uri)) {
          $file->delete();
        }
        else {
          watchdog('file system', 'Could not delete temporary file "%path" during garbage collection', array('%path' => $file->uri), WATCHDOG_ERROR);
        }
      }
      else {
        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->uri, '%modules' => implode(', ', array_keys($references))), WATCHDOG_INFO);
      }
    }
  }
}

738
/**
739 740
 * Ajax callback: Processes file uploads and deletions.
 *
741 742 743 744
 * 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.
745 746
 *
 * @see file_menu()
747 748 749 750 751 752 753 754
 */
function file_ajax_upload() {
  $form_parents = func_get_args();
  $form_build_id = (string) array_pop($form_parents);

  if (empty($_POST['form_build_id']) || $form_build_id != $_POST['form_build_id']) {
    // 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');
755 756
    $response = new AjaxResponse();
    return $response->addCommand(new ReplaceCommand(NULL, theme('status_messages')));
757 758
  }

759
  list($form, $form_state) = ajax_get_form();
760 761 762 763

  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');
764 765
    $response = new AjaxResponse();
    return $response->addCommand(new ReplaceCommand(NULL, theme('status_messages')));
766 767 768 769 770 771 772 773 774
  }

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

775 776
  // Process user input. $form and $form_state are modified in the process.
  drupal_process_form($form['#form_id'], $form, $form_state);
777 778 779 780 781 782

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

783
  // Add the special Ajax class if a new file was added.
784 785 786 787 788 789 790 791 792 793
  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>';
  }

  $output = theme('status_messages') . drupal_render($form);
  $js = drupal_add_js();
794
  $settings = drupal_merge_js_settings($js['settings']['data']);
795

796 797
  $response = new AjaxResponse();
  return $response->addCommand(new ReplaceCommand(NULL, $output, $settings));
798 799 800
}

/**
801 802
 * Ajax callback: Retrieves upload progress.
 *
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
 * @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']);
    }
  }

828
  return new JsonResponse($progress);
829 830 831
}

/**
832
 * Determines the preferred upload progress implementation.
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
 *
 * @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;
}

/**
856
 * Implements hook_file_predelete().
857
 */
858
function file_file_predelete(File $file) {
859 860 861 862
  // TODO: Remove references to a file that is in-use.
}

/**
863
 * Render API callback: Expands the managed_file element type.
864 865 866
 *
 * Expands the file type to include Upload and Remove buttons, as well as
 * support for a default value.
867 868
 *
 * This function is assigned as a #process callback in file_element_info().
869 870
 */
function file_managed_file_process($element, &$form_state, $form) {
871 872 873
  // Append the '-upload' to the #id so the field label's 'for' attribute
  // corresponds with the file element.
  $element['#id'] .= '-upload';
874 875 876 877 878

  // 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();
879 880 881

  // Set some default element properties.
  $element['#progress_indicator'] = empty($element['#progress_indicator']) ? 'none' : $element['#progress_indicator'];
882
  $element['#files'] = !empty($fids) ? file_load_multiple($fids) : FALSE;
883 884 885
  $element['#tree'] = TRUE;

  $ajax_settings = array(
886
    'path' => 'file/ajax/' . implode('/', $element['#array_parents']) . '/' . $form['form_build_id']['#value'],
887 888 889 890 891 892 893 894 895 896
    '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(
897
    '#name' => $parents_prefix . '_upload_button',
898 899 900 901
    '#type' => 'submit',
    '#value' => t('Upload'),
    '#validate' => array(),
    '#submit' => array('file_managed_file_submit'),
902
    '#limit_validation_errors' => array($element['#parents']),
903 904 905 906
    '#ajax' => $ajax_settings,
    '#weight' => -5,
  );

907 908 909
  // 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';
910 911 912
  $ajax_settings['progress']['message'] = NULL;
  $ajax_settings['effect'] = 'none';
  $element['remove_button'] = array(
913
    '#name' => $parents_prefix . '_remove_button',
914
    '#type' => 'submit',
915
    '#value' => $element['#multiple'] ? t('Remove selected') : t('Remove'),
916 917
    '#validate' => array(),
    '#submit' => array('file_managed_file_submit'),
918
    '#limit_validation_errors' => array($element['#parents']),
919
    '#ajax' => $ajax_settings,
920
    '#weight' => 1,
921 922
  );

923
  $element['fids'] = array(
924
    '#type' => 'hidden',
925
    '#value' => $fids,
926 927 928 929
  );

  // Add progress bar support to the upload if possible.
  if ($element['#progress_indicator'] == 'bar' && $implementation = file_progress_implementation()) {
930
    $upload_progress_key = mt_rand();
931 932 933 934 935 936

    if ($implementation == 'uploadprogress') {
      $element['UPLOAD_IDENTIFIER'] = array(
        '#type' => 'hidden',
        '#value' => $upload_progress_key,
        '#attributes' => array('class' => array('file-progress')),
937 938 939
        // Uploadprogress extension requires this field to be at the top of the
        // form.
        '#weight' => -20,
940 941 942 943 944 945 946
      );
    }
    elseif ($implementation == 'apc') {
      $element['APC_UPLOAD_PROGRESS'] = array(
        '#type' => 'hidden',
        '#value' => $upload_progress_key,
        '#attributes' => array('class' => array('file-progress')),
947 948 949
        // Uploadprogress extension requires this field to be at the top of the
        // form.
        '#weight' => -20,
950 951 952 953 954 955 956 957 958
      );
    }

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

  // The file upload field itself.
  $element['upload'] = array(
959
    '#name' => 'files[' . $parents_prefix . ']',
960
    '#type' => 'file',
961 962
    '#title' => t('Choose a file'),
    '#title_display' => 'invisible',
963
    '#size' => $element['#size'],
964
    '#multiple' => $element['#multiple'],
965 966 967 968
    '#theme_wrappers' => array(),
    '#weight' => -10,
  );

969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
  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(
          '#type' => 'markup',
          '#markup' => theme('file_link', array('file' => $file)) . ' ',
          '#weight' => -10,
        );
      }
    }
985 986
  }

987
  // Add the extension list to the page as JavaScript settings.
988
  if (isset($element['#upload_validators']['file_validate_extensions'][0])) {
989 990 991 992 993 994 995
    $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)))
      )
    );
996 997
  }

998
  // Prefix and suffix used for Ajax replacement.
999 1000 1001 1002 1003 1004 1005
  $element['#prefix'] = '<div id="' . $element['#id'] . '-ajax-wrapper">';
  $element['#suffix'] = '</div>';

  return $element;
}

/**
1006 1007 1008
 * Render API callback: Determines the value for a managed_file type element.
 *
 * This function is assigned as a #value_callback in file_element_info().
1009 1010
 */
function file_managed_file_value(&$element, $input = FALSE, $form_state = NULL) {
1011 1012 1013 1014
  // Find the current value of this field.
  $fids = !empty($input['fids']) ? explode(' ', $input['fids']) : array();
  foreach ($fids as $key => $fid) {
    $fids[$key] = (int) $fid;
1015 1016 1017 1018
  }

  // Process any input and save new uploads.
  if ($input !== FALSE) {
1019
    $input['fids'] = $fids;
1020 1021 1022
    $return = $input;

    // Uploads take priority over all other values.
1023 1024 1025 1026 1027 1028 1029
    if ($files = file_managed_file_save_upload($element)) {
      if ($element['#multiple']) {
        $fids = array_merge($fids, array_keys($files));
      }
      else {
        $fids = array_keys($files);
      }
1030 1031 1032 1033 1034 1035 1036 1037
    }
    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) {
1038
          $callback($element, $input, $form_state);
1039 1040
        }
      }
1041 1042 1043 1044 1045 1046 1047 1048 1049

      // 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)) {
            $fids[] = $file->fid;
          }
        }
1050 1051 1052 1053 1054 1055 1056
      }
    }
  }

  // If there is no input, set the default value.
  else {
    if ($element['#extended']) {
1057 1058
      $default_fids = isset($element['#default_value']['fids']) ? $element['#default_value']['fids'] : array();
      $return = isset($element['#default_value']) ? $element['#default_value'] : array('fids' => array());
1059 1060
    }
    else {
1061 1062
      $default_fids = isset($element['#default_value']) ? $element['#default_value'] : array();
      $return = array('fids' => array());
1063 1064 1065
    }

    // Confirm that the file exists when used as a default value.
1066 1067 1068 1069 1070 1071 1072
    if (!empty($default_fids)) {
      $fids = array();
      foreach ($default_fids as $key => $fid) {
        if ($file = file_load($fid)) {
          $fids[] = $file->fid;
        }
      }
1073 1074 1075
    }
  }

1076
  $return['fids'] = $fids;
1077 1078 1079 1080
  return $return;
}

/**
1081 1082 1083 1084
 * Render API callback: Validates the managed_file element.
 *
 * This function is assigned as a #element_validate callback in
 * file_element_info().
1085 1086 1087 1088 1089
 */
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.
1090
  $clicked_button = end($form_state['triggering_element']['#parents']);
1091 1092 1093 1094 1095 1096 1097 1098 1099
  if ($clicked_button != 'remove_button' && !empty($element['fids']['#value'])) {
    $fids = $element['fids']['#value'];
    foreach ($fids as $fid) {
      if ($file = file_load($fid)) {
        if ($file->status == FILE_STATUS_PERMANENT) {
          $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'])));
          }
1100 1101
        }
      }
1102 1103 1104
      else {
        form_error($element, t('The file referenced by the !name field does not exist.', array('!name' => $element['#title'])));
      }
1105 1106 1107 1108
    }
  }

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

1113
  // Consolidate the array value of this field to array of FIDs.
1114
  if (!$element['#extended']) {
1115
    form_set_value($element, $element['fids']['#value'], $form_state);
1116 1117 1118 1119
  }
}

/**
1120 1121 1122
 * Form submission handler for upload / remove buttons of managed_file elements.
 *
 * @see file_managed_file_process()
1123 1124
 */
function file_managed_file_submit($form, &$form_state) {
1125 1126 1127 1128
  // Determine whether it was the upload or the remove button that was clicked,
  // and set $element to the managed_file element that contains that button.
  $parents = $form_state['triggering_element']['#array_parents'];
  $button_key = array_pop($parents);
1129
  $element = NestedArray::getValue($form, $parents);
1130 1131 1132 1133 1134 1135

  // No action is needed here for the upload button, because all file uploads on
  // the form are processed by file_managed_file_value() regardless of which
  // button was clicked. Action is needed here for the remove button, because we
  // only remove a file in response to its remove button being clicked.
  if ($button_key == 'remove_button') {
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
    $fids = array_keys($element['#files']);
    // Get files that will be removed.
    if ($element['#multiple']) {
      $remove_fids = array();
      foreach (element_children($element) as $name) {
        if (strpos($name, 'file_') === 0 && $element[$name]['selected']['#value']) {
          $remove_fids[] = (int) substr($name, 5);
        }
      }
      $fids = array_diff($fids, $remove_fids);
    }
    else {
      $remove_fids = $fids;
    }

    foreach ($remove_fids as $fid) {
      // If it's a temporary file we can safely remove it immediately, otherwise
      // it's up to the implementing module to remove usages of files to have them
      // removed.
      if ($element['#files'][$fid] && $element['#files'][$fid]->status == 0) {
        file_delete($element['#files'][$fid]->fid);
      }
1158 1159 1160 1161 1162 1163 1164
    }
    // Update both $form_state['values'] and $form_state['input'] to reflect
    // that the file has been removed, so that the form is rebuilt correctly.
    // $form_state['values'] must be updated in case additional submit handlers
    // run, and for form building functions that run during the rebuild, such as
    // when the managed_file element is part of a field widget.
    // $form_state['input'] must be updated so that file_managed_file_value()
1165
    // has correct information during the rebuild.
1166 1167
    form_set_value($element['fids'], implode(' ', $fids), $form_state);
    NestedArray::setValue($form_state['input'], $element['fids']['#parents'], implode(' ', $fids));
1168 1169 1170 1171 1172 1173 1174 1175 1176
  }

  // Set the form to rebuild so that $form is correctly updated in response to
  // processing the file removal. Since this function did not change $form_state
  // if the upload button was clicked, a rebuild isn't necessary in that
  // situation and setting $form_state['redirect'] to FALSE would suffice.
  // However, we choose to always rebuild, to keep the form processing workflow
  // consistent between the two buttons.
  $form_state['rebuild'] = TRUE;
1177 1178 1179
}

/**
1180
 * Saves any files that have been uploaded into a managed_file element.
1181 1182 1183
 *
 * @param $element
 *   The FAPI element whose values are being saved.
1184
 *
1185
 * @return
1186 1187
 *   An array of file entities for each file that was saved, keyed by its file
 *   ID, or FALSE if no files were saved.
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
 */
function file_managed_file_save_upload($element) {
  $upload_name = implode('_', $element['#parents']);
  if (empty($_FILES['files']['name'][$upload_name])) {
    return FALSE;
  }

  $destination = isset($element['#upload_location']) ? $element['#upload_location'] : NULL;
  if (isset($destination) && !file_prepare_directory($destination, FILE_CREATE_DIRECTORY)) {
    watchdog('file', 'The upload directory %directory for the file field !name could not be created or is not accessible. A newly uploaded file could not be saved in this directory as a consequence, and the upload was canceled.', array('%directory' => $destination, '!name' => $element['#field_name']));
    form_set_error($upload_name, t('The file could not be uploaded.'));
    return FALSE;
  }

1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
  // Save attached files to the database.
  $files_uploaded = $element['#multiple'] && count(array_filter($_FILES['files']['name'][$upload_name])) > 0;
  $files_uploaded |= !$element['#multiple'] && !empty($_FILES['files']['name'][$upload_name]);
  if ($files_uploaded) {
    if (!$files = file_save_upload($upload_name, $element['#upload_validators'], $destination)) {
      watchdog('file', 'The file upload failed. %upload', array('%upload' => $upload_name));
      form_set_error($upload_name, t('Files in the !name field were unable to be uploaded.', array('!name' => $element['#title'])));
      return array();
    }

    // Value callback expects FIDs to be keys.
    $files = array_filter($files);
    $fids = array_map(function($file) { return $file->fid; }, $files);

    return empty($files) ? array() : array_combine($fids, $files);
1217 1218
  }

1219
  return array();
1220 1221 1222
}

/**
1223 1224 1225 1226 1227 1228 1229
 * Returns HTML for a managed file element.
 *
 * @param $variables
 *   An associative array containing:
 *   - element: A render element representing the file.
 *
 * @ingroup themeable
1230
 */
1231 1232 1233
function theme_file_managed_file($variables) {
  $element = $variables['element'];

1234 1235 1236 1237 1238 1239 1240 1241 1242
  $attributes = array();
  if (isset($element['#id'])) {
    $attributes['id'] = $element['#id'];
  }
  if (!empty($element['#attributes']['class'])) {
    $attributes['class'] = (array) $element['#attributes']['class'];
  }
  $attributes['class'][] = 'form-managed-file';

1243 1244
  // This wrapper is required to apply JS behaviors and CSS styling.
  $output = '';
1245
  $output .= '<div' . new Attribute($attributes) . '&