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

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

8
use Drupal\Core\Datetime\Entity\DateFormat;
9
use Drupal\Core\Field\FieldDefinitionInterface;
10
use Drupal\Core\Form\FormStateInterface;
11
use Drupal\Core\Render\BubbleableMetadata;
12
use Drupal\Core\Render\Element;
13
use Drupal\Core\Routing\RouteMatchInterface;
14
use Drupal\Core\Url;
15
use Drupal\file\Entity\File;
16
use Drupal\file\FileInterface;
17
use Drupal\Component\Utility\NestedArray;
18
use Drupal\Component\Utility\Unicode;
19
use Drupal\Core\Entity\EntityStorageInterface;
20
use Drupal\Core\Template\Attribute;
21

22 23 24 25 26
/**
 * The regex pattern used when checking for insecure file types.
 */
define('FILE_INSECURE_EXTENSION_REGEX', '/\.(php|pl|py|cgi|asp|js)(\.|$)/i');

27
// Load all Field module hooks for File.
28
require_once __DIR__ . '/file.field.inc';
29

30 31 32
/**
 * Implements hook_help().
 */
33
function file_help($route_name, RouteMatchInterface $route_match) {
34 35
  switch ($route_name) {
    case 'help.page.file':
36 37
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
38
      $output .= '<p>' . t('The File module allows you to create fields that contain files. See the <a href=":field">Field module help</a> and the <a href=":field_ui">Field UI help</a> pages for general information on fields and how to create and manage them. For more information, see the <a href=":file_documentation">online documentation for the File module</a>.', [':field' => \Drupal::url('help.page', ['name' => 'field']), ':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#', ':file_documentation' => 'https://www.drupal.org/documentation/modules/file']) . '</p>';
39 40
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
41
      $output .= '<dt>' . t('Managing and displaying file fields') . '</dt>';
42
      $output .= '<dd>' . t('The <em>settings</em> and the <em>display</em> of the file field can be configured separately. See the <a href=":field_ui">Field UI help</a> for more information on how to manage fields and their display.', [':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#']) . '</dd>';
43 44
      $output .= '<dt>' . t('Allowing file extensions') . '</dt>';
      $output .= '<dd>' . t('In the field settings, you can define the allowed file extensions (for example <em>pdf docx psd</em>) for the files that will be uploaded with the file field.') . '</dd>';
45
      $output .= '<dt>' . t('Storing files') . '</dt>';
46
      $output .= '<dd>' . t('Uploaded files can either be stored as <em>public</em> or <em>private</em>, depending on the <a href=":file-system">File system settings</a>. For more information, see the <a href=":system-help">System module help page</a>.', [':file-system' => \Drupal::url('system.file_system_settings'), ':system-help' => \Drupal::url('help.page', ['name' => 'system'])]) . '</dd>';
47 48 49 50
      $output .= '<dt>' . t('Restricting the maximum file size') . '</dt>';
      $output .= '<dd>' . t('The maximum file size that users can upload is limited by PHP settings of the server, but you can restrict by entering the desired value as the <em>Maximum upload size</em> setting. The maximum file size is automatically displayed to users in the help text of the file field.') . '</dd>';
      $output .= '<dt>' . t('Displaying files and descriptions') . '<dt>';
      $output .= '<dd>' . t('In the field settings, you can allow users to toggle whether individual files are displayed. In the display settings, you can then choose one of the following formats: <ul><li><em>Generic file</em> displays links to the files and adds icons that symbolize the file extensions. If <em>descriptions</em> are enabled and have been submitted, then the description is displayed instead of the file name.</li><li><em>URL to file</em> displays the full path to the file as plain text.</li><li><em>Table of files</em> lists links to the files and the file sizes in a table.</li><li><em>RSS enclosure</em> only displays the first file, and only in a RSS feed, formatted according to the RSS 2.0 syntax for enclosures.</li></ul> A file can still be linked to directly by its URI even if it is not displayed.') . '</dd>';
51 52 53 54 55
      $output .= '</dl>';
      return $output;
  }
}

56 57 58 59 60 61 62 63 64 65
/**
 * Implements hook_field_widget_info_alter().
 */
function file_field_widget_info_alter(array &$info) {
  // Allows using the 'uri' widget for the 'file_uri' field type, which uses it
  // as the default widget.
  // @see \Drupal\file\Plugin\Field\FieldType\FileUriItem
  $info['uri']['field_types'][] = 'file_uri';
}

66 67 68
/**
 * Loads file entities from the database.
 *
69 70 71
 * @param array|null $fids
 *   (optional) An array of entity IDs. If omitted or NULL, all entities are
 *   loaded.
72
 * @param bool $reset
73 74
 *   (optional) Whether to reset the internal file_load_multiple() cache.
 *   Defaults to FALSE.
75 76 77 78
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
79 80 81
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::loadMultiple().
 *
82
 * @see hook_ENTITY_TYPE_load()
83 84
 * @see file_load()
 * @see entity_load()
85
 * @see \Drupal\Core\Entity\Query\EntityQueryInterface
86
 */
87
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
88 89 90 91
  if ($reset) {
    \Drupal::entityManager()->getStorage('file')->resetCache($fids);
  }
  return File::loadMultiple($fids);
92 93 94 95 96
}

/**
 * Loads a single file entity from the database.
 *
97
 * @param int $fid
98
 *   A file ID.
99
 * @param bool $reset
100 101
 *   (optional) Whether to reset the internal file_load_multiple() cache.
 *   Defaults to FALSE.
102
 *
103
 * @return \Drupal\file\FileInterface|null
104
 *   A file entity or NULL if the file was not found.
105
 *
106 107 108
 * @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
 *   Use \Drupal\file\Entity\File::load().
 *
109
 * @see hook_ENTITY_TYPE_load()
110 111
 * @see file_load_multiple()
 */
112
function file_load($fid, $reset = FALSE) {
113
  if ($reset) {
114
    \Drupal::entityManager()->getStorage('file')->resetCache([$fid]);
115 116
  }
  return File::load($fid);
117 118 119 120 121 122 123 124 125 126 127
}

/**
 * Copies a file to a new location and adds a file record to the database.
 *
 * This function should be used when manipulating files that have records
 * stored in the database. This is a powerful function that in many ways
 * performs like an advanced version of copy().
 * - Checks if $source and $destination are valid and readable/writable.
 * - If file already exists in $destination either the call will error out,
 *   replace the file or rename the file based on the $replace parameter.
128
 * - If the $source and $destination are equal, the behavior depends on the
129
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
130
 *   will rename the file until the $destination is unique.
131 132 133 134
 * - 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.
 *
135
 * @param \Drupal\file\FileInterface $source
136
 *   A file entity.
137
 * @param string $destination
138 139
 *   A string containing the destination that $source should be
 *   copied to. This must be a stream wrapper URI.
140
 * @param int $replace
141 142 143 144 145 146 147 148
 *   (optional) Replace behavior when the destination file already exists.
 *   Possible values include:
 *   - FILE_EXISTS_REPLACE: Replace the existing file. If a managed file with
 *     the destination name exists, then its database entry will be updated. If
 *     no database entry is found, then a new one will be created.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
149
 *
150 151
 * @return \Drupal\file\FileInterface|false
 *   File entity if the copy is successful, or FALSE in the event of an error.
152 153 154 155
 *
 * @see file_unmanaged_copy()
 * @see hook_file_copy()
 */
156
function file_copy(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
157
  if (!file_valid_uri($destination)) {
158
    if (($realpath = \Drupal::service('file_system')->realpath($source->getFileUri())) !== FALSE) {
159
      \Drupal::logger('file')->notice('File %file (%realpath) could not be copied because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination]);
160 161
    }
    else {
162
      \Drupal::logger('file')->notice('File %file could not be copied because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%destination' => $destination]);
163
    }
164
    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.', ['%file' => $source->getFileUri()]), 'error');
165 166 167
    return FALSE;
  }

168 169 170 171
  if ($uri = file_unmanaged_copy($source->getFileUri(), $destination, $replace)) {
    $file = $source->createDuplicate();
    $file->setFileUri($uri);
    $file->setFilename(drupal_basename($uri));
172
    // If we are replacing an existing file re-use its database record.
173 174
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
175
    if ($replace == FILE_EXISTS_REPLACE) {
176
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
177 178
      if (count($existing_files)) {
        $existing = reset($existing_files);
179
        $file->fid = $existing->id();
180
        $file->setOriginalId($existing->id());
181
        $file->setFilename($existing->getFilename());
182 183 184 185 186
      }
    }
    // 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)) {
187
      $file->setFilename(drupal_basename($destination));
188 189 190 191 192
    }

    $file->save();

    // Inform modules that the file has been copied.
193
    \Drupal::moduleHandler()->invokeAll('file_copy', [$file, $source]);
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

    return $file;
  }
  return FALSE;
}

/**
 * Moves a file to a new location and update the file's database entry.
 *
 * - 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.
 *
209
 * @param \Drupal\file\FileInterface $source
210
 *   A file entity.
211
 * @param string $destination
212 213
 *   A string containing the destination that $source should be moved
 *   to. This must be a stream wrapper URI.
214
 * @param int $replace
215 216 217 218 219 220 221 222 223
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
 *   - FILE_EXISTS_REPLACE: Replace the existing file. If a managed file with
 *     the destination name exists then its database entry will be updated and
 *     $source->delete() called after invoking hook_file_move(). If no database
 *     entry is found, then the source files record will be updated.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
224
 *
225
 * @return \Drupal\file\FileInterface|false
226 227 228 229 230
 *   Resulting file entity for success, or FALSE in the event of an error.
 *
 * @see file_unmanaged_move()
 * @see hook_file_move()
 */
231
function file_move(FileInterface $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
232
  if (!file_valid_uri($destination)) {
233
    if (($realpath = \Drupal::service('file_system')->realpath($source->getFileUri())) !== FALSE) {
234
      \Drupal::logger('file')->notice('File %file (%realpath) could not be moved because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination]);
235 236
    }
    else {
237
      \Drupal::logger('file')->notice('File %file could not be moved because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', ['%file' => $source->getFileUri(), '%destination' => $destination]);
238
    }
239
    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.', ['%file' => $source->getFileUri()]), 'error');
240 241 242
    return FALSE;
  }

243
  if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
244 245 246
    $delete_source = FALSE;

    $file = clone $source;
247
    $file->setFileUri($uri);
248 249
    // If we are replacing an existing file re-use its database record.
    if ($replace == FILE_EXISTS_REPLACE) {
250
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
251 252 253
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $delete_source = TRUE;
254
        $file->fid = $existing->id();
255
        $file->uuid = $existing->uuid();
256 257 258 259 260
      }
    }
    // 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)) {
261
      $file->setFilename(drupal_basename($destination));
262 263 264 265 266
    }

    $file->save();

    // Inform modules that the file has been moved.
267
    \Drupal::moduleHandler()->invokeAll('file_move', [$file, $source]);
268 269

    // Delete the original if it's not in use elsewhere.
270
    if ($delete_source && !\Drupal::service('file.usage')->listUsage($source)) {
271 272 273 274 275 276 277 278 279 280 281 282 283 284
      $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.
 *
285
 * @param \Drupal\file\FileInterface $file
286
 *   A file entity.
287
 * @param array $validators
288 289 290 291 292 293 294
 *   (optional) An associative array of callback functions used to validate
 *   the file. The keys are function names and the values arrays of callback
 *   parameters which will be passed in after the file entity. The functions
 *   should return an array of error messages; an empty array indicates that
 *   the file passed validation. The callback functions will be called in the
 *   order specified in the array, then the hook hook_file_validate()
 *   will be invoked so other modules can validate the new file.
295
 *
296
 * @return array
297 298 299 300
 *   An array containing validation error messages.
 *
 * @see hook_file_validate()
 */
301
function file_validate(FileInterface $file, $validators = []) {
302
  // Call the validation functions specified by this function's caller.
303
  $errors = [];
304 305 306 307 308 309 310 311
  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.
312
  return array_merge($errors, \Drupal::moduleHandler()->invokeAll('file_validate', [$file]));
313 314 315 316 317
}

/**
 * Checks for files with names longer than can be stored in the database.
 *
318
 * @param \Drupal\file\FileInterface $file
319 320
 *   A file entity.
 *
321
 * @return array
322 323
 *   An empty array if the file name length is smaller than the limit or an
 *   array containing an error message if it's not or is empty.
324
 */
325
function file_validate_name_length(FileInterface $file) {
326
  $errors = [];
327

328
  if (!$file->getFilename()) {
329 330
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
331
  if (strlen($file->getFilename()) > 240) {
332 333 334 335 336 337 338 339
    $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.
 *
340
 * @param \Drupal\file\FileInterface $file
341
 *   A file entity.
342
 * @param string $extensions
343 344
 *   A string with a space separated list of allowed extensions.
 *
345
 * @return array
346 347
 *   An empty array if the file extension is allowed or an array containing an
 *   error message if it's not.
348 349 350
 *
 * @see hook_file_validate()
 */
351
function file_validate_extensions(FileInterface $file, $extensions) {
352
  $errors = [];
353 354

  $regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
355
  if (!preg_match($regex, $file->getFilename())) {
356
    $errors[] = t('Only files with the following extensions are allowed: %files-allowed.', ['%files-allowed' => $extensions]);
357 358 359 360 361 362 363
  }
  return $errors;
}

/**
 * Checks that the file's size is below certain limits.
 *
364
 * @param \Drupal\file\FileInterface $file
365
 *   A file entity.
366
 * @param int $file_limit
367 368
 *   (optional) The maximum file size in bytes. Zero (the default) indicates
 *   that no limit should be enforced.
369
 * @param int $user_limit
370 371
 *   (optional) The maximum number of bytes the user is allowed. Zero (the
 *   default) indicates that no limit should be enforced.
372
 *
373
 * @return array
374 375
 *   An empty array if the file size is below limits or an array containing an
 *   error message if it's not.
376 377 378
 *
 * @see hook_file_validate()
 */
379
function file_validate_size(FileInterface $file, $file_limit = 0, $user_limit = 0) {
380
  $user = \Drupal::currentUser();
381
  $errors = [];
382

383
  if ($file_limit && $file->getSize() > $file_limit) {
384
    $errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', ['%filesize' => format_size($file->getSize()), '%maxsize' => format_size($file_limit)]);
385
  }
386

387
  // Save a query by only calling spaceUsed() when a limit is provided.
388
  if ($user_limit && (\Drupal::entityManager()->getStorage('file')->spaceUsed($user->id()) + $file->getSize()) > $user_limit) {
389
    $errors[] = t('The file is %filesize which would exceed your disk quota of %quota.', ['%filesize' => format_size($file->getSize()), '%quota' => format_size($user_limit)]);
390
  }
391

392 393 394 395
  return $errors;
}

/**
396
 * Checks that the file is recognized as a valid image.
397
 *
398
 * @param \Drupal\file\FileInterface $file
399 400
 *   A file entity.
 *
401
 * @return array
402 403
 *   An empty array if the file is a valid image or an array containing an error
 *   message if it's not.
404 405 406
 *
 * @see hook_file_validate()
 */
407
function file_validate_is_image(FileInterface $file) {
408
  $errors = [];
409

410 411 412 413
  $image_factory = \Drupal::service('image.factory');
  $image = $image_factory->get($file->getFileUri());
  if (!$image->isValid()) {
    $supported_extensions = $image_factory->getSupportedExtensions();
414
    $errors[] = t('The image file is invalid or the image type is not allowed. Allowed types: %types', ['%types' => implode(', ', $supported_extensions)]);
415 416 417 418 419 420 421 422
  }

  return $errors;
}

/**
 * Verifies that image dimensions are within the specified maximum and minimum.
 *
423
 * Non-image files will be ignored. If an image toolkit is available the image
424 425
 * will be scaled to fit within the desired maximum dimensions.
 *
426
 * @param \Drupal\file\FileInterface $file
427
 *   A file entity. This function may resize the file affecting its size.
428 429 430 431 432 433 434 435 436
 * @param string|int $maximum_dimensions
 *   (optional) A string in the form WIDTHxHEIGHT; for example, '640x480' or
 *   '85x85'. If an image toolkit is installed, the image will be resized down
 *   to these dimensions. A value of zero (the default) indicates no restriction
 *   on size, so no resizing will be attempted.
 * @param string|int $minimum_dimensions
 *   (optional) A string in the form WIDTHxHEIGHT. This will check that the
 *   image meets a minimum size. A value of zero (the default) indicates that
 *   there is no restriction on size.
437
 *
438 439 440 441 442
 * @return array
 *   An empty array if the file meets the specified dimensions, was resized
 *   successfully to meet those requirements or is not an image. If the image
 *   does not meet the requirements or an attempt to resize it fails, an array
 *   containing the error message will be returned.
443 444 445
 *
 * @see hook_file_validate()
 */
446
function file_validate_image_resolution(FileInterface $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
447
  $errors = [];
448 449

  // Check first that the file is an image.
450
  $image_factory = \Drupal::service('image.factory');
451
  $image = $image_factory->get($file->getFileUri());
452

453
  if ($image->isValid()) {
454
    $scaling = FALSE;
455 456 457
    if ($maximum_dimensions) {
      // Check that it is smaller than the given dimensions.
      list($width, $height) = explode('x', $maximum_dimensions);
458
      if ($image->getWidth() > $width || $image->getHeight() > $height) {
459
        // Try to resize the image to fit the dimensions.
460
        if ($image->scale($width, $height)) {
461
          $scaling = TRUE;
462
          $image->save();
463
          if (!empty($width) && !empty($height)) {
464 465 466 467 468 469
            $message = t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels. The new dimensions of the resized image are %new_widthx%new_height pixels.',
              [
                '%dimensions' => $maximum_dimensions,
                '%new_width' => $image->getWidth(),
                '%new_height' => $image->getHeight(),
              ]);
470 471
          }
          elseif (empty($width)) {
472 473 474 475 476 477
            $message = t('The image was resized to fit within the maximum allowed height of %height pixels. The new dimensions of the resized image are %new_widthx%new_height pixels.',
              [
                '%height' => $height,
                '%new_width' => $image->getWidth(),
                '%new_height' => $image->getHeight(),
              ]);
478 479
          }
          elseif (empty($height)) {
480 481 482 483 484 485
            $message = t('The image was resized to fit within the maximum allowed width of %width pixels. The new dimensions of the resized image are %new_widthx%new_height pixels.',
              [
                '%width' => $width,
                '%new_width' => $image->getWidth(),
                '%new_height' => $image->getHeight(),
              ]);
486 487
          }
          drupal_set_message($message);
488 489
        }
        else {
490
          $errors[] = t('The image exceeds the maximum allowed dimensions and an attempt to resize it failed.');
491 492 493 494 495 496 497
        }
      }
    }

    if ($minimum_dimensions) {
      // Check that it is larger than the given dimensions.
      list($width, $height) = explode('x', $minimum_dimensions);
498
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
        if ($scaling) {
          $errors[] = t('The resized image is too small. The minimum dimensions are %dimensions pixels and after resizing, the image size will be %widthx%height pixels.',
            [
              '%dimensions' => $minimum_dimensions,
              '%width' => $image->getWidth(),
              '%height' => $image->getHeight(),
            ]);
        }
        else {
          $errors[] = t('The image is too small. The minimum dimensions are %dimensions pixels and the image size is %widthx%height pixels.',
            [
              '%dimensions' => $minimum_dimensions,
              '%width' => $image->getWidth(),
              '%height' => $image->getHeight(),
            ]);
        }
515 516 517 518 519 520 521 522 523 524
      }
    }
  }

  return $errors;
}

/**
 * Saves a file to the specified destination and creates a database entry.
 *
525
 * @param string $data
526
 *   A string containing the contents of the file.
527 528 529 530 531
 * @param string|null $destination
 *   (optional) A string containing the destination URI. This must be a stream
 *   wrapper URI. If no value or NULL is provided, a randomized name will be
 *   generated and the file will be saved using Drupal's default files scheme,
 *   usually "public://".
532
 * @param int $replace
533 534 535 536 537 538 539 540
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
 *   - FILE_EXISTS_REPLACE: Replace the existing file. If a managed file with
 *     the destination name exists, then its database entry will be updated. If
 *     no database entry is found, then a new one will be created.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
541
 *
542
 * @return \Drupal\file\FileInterface|false
543 544 545 546 547
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
548
  $user = \Drupal::currentUser();
549 550 551 552 553

  if (empty($destination)) {
    $destination = file_default_scheme() . '://';
  }
  if (!file_valid_uri($destination)) {
554
    \Drupal::logger('file')->notice('The data could not be saved because the destination %destination is invalid. This may be caused by improper use of file_save_data() or a missing stream wrapper.', ['%destination' => $destination]);
555 556 557 558 559 560
    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.
561
    $file = File::create([
562
      'uri' => $uri,
563
      'uid' => $user->id(),
564
      'status' => FILE_STATUS_PERMANENT,
565
    ]);
566
    // If we are replacing an existing file re-use its database record.
567 568
    // @todo Do not create a new entity in order to update it. See
    //   https://www.drupal.org/node/2241865.
569
    if ($replace == FILE_EXISTS_REPLACE) {
570
      $existing_files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
571 572
      if (count($existing_files)) {
        $existing = reset($existing_files);
573
        $file->fid = $existing->id();
574
        $file->setOriginalId($existing->id());
575
        $file->setFilename($existing->getFilename());
576 577 578 579 580
      }
    }
    // 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)) {
581
      $file->setFilename(drupal_basename($destination));
582 583 584 585 586 587 588 589 590 591 592
    }

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

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
593
 * @param \Drupal\file\FileInterface $file
594 595
 *   A file entity.
 *
596
 * @return array
597 598 599
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
600
function file_get_content_headers(FileInterface $file) {
601
  $type = Unicode::mimeHeaderEncode($file->getMimeType());
602

603
  return [
604
    'Content-Type' => $type,
605
    'Content-Length' => $file->getSize(),
606
    'Cache-Control' => 'private',
607
  ];
608 609
}

610
/**
611
 * Implements hook_theme().
612 613
 */
function file_theme() {
614
  return [
615
    // From file.module.
616 617 618 619
    'file_link' => [
      'variables' => ['file' => NULL, 'description' => NULL, 'attributes' => []],
    ],
    'file_managed_file' => [
620
      'render element' => 'element',
621
    ],
622 623 624 625 626 627
    'file_audio' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
    'file_video' => [
      'variables' => ['files' => [], 'attributes' => NULL],
    ],
628

629
    // From file.field.inc.
630
    'file_widget_multiple' => [
631
      'render element' => 'element',
632
      'file' => 'file.field.inc',
633 634 635
    ],
    'file_upload_help' => [
      'variables' => ['description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL],
636
      'file' => 'file.field.inc',
637 638
    ],
  ];
639 640 641
}

/**
642
 * Implements hook_file_download().
643
 */
644
function file_file_download($uri) {
645
  // Get the file record based on the URI. If not in the database just return.
646
  /** @var \Drupal\file\FileInterface[] $files */
647
  $files = entity_load_multiple_by_properties('file', ['uri' => $uri]);
648
  if (count($files)) {
649 650 651
    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.
652
      if ($item->getFileUri() === $uri) {
653 654 655 656
        $file = $item;
        break;
      }
    }
657
  }
658
  if (!isset($file)) {
659 660 661
    return;
  }

662 663 664 665 666 667 668 669 670 671 672 673 674 675
  // Find out if a temporary file is still used in the system.
  if ($file->isTemporary()) {
    $usage = \Drupal::service('file.usage')->listUsage($file);
    if (empty($usage) && $file->getOwnerId() != \Drupal::currentUser()->id()) {
      // Deny access to temporary files without usage that are not owned by the
      // same user. This prevents the security issue that a private file that
      // was protected by field permissions becomes available after its usage
      // was removed and before it is actually deleted from the file system.
      // Modules that depend on this behavior should make the file permanent
      // instead.
      return -1;
    }
  }

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

679 680 681 682 683
  // 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.
684
  if (empty($references) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
685
    return;
686 687
  }

688
  if (!$file->access('download')) {
689 690 691 692
    return -1;
  }

  // Access is granted.
693 694
  $headers = file_get_content_headers($file);
  return $headers;
695 696
}

697
/**
698
 * Implements hook_cron().
699 700
 */
function file_cron() {
701
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');
702
  $file_storage = \Drupal::entityManager()->getStorage('file');
703 704 705 706 707 708 709 710 711

  // Only delete temporary files if older than $age. Note that automatic cleanup
  // is disabled if $age set to 0.
  if ($age) {
    $fids = Drupal::entityQuery('file')
      ->condition('status', FILE_STATUS_PERMANENT, '<>')
      ->condition('changed', REQUEST_TIME - $age, '<')
      ->range(0, 100)
      ->execute();
712
    $files = $file_storage->loadMultiple($fids);
713
    foreach ($files as $file) {
714
      $references = \Drupal::service('file.usage')->listUsage($file);
715
      if (empty($references)) {
716
        if (file_exists($file->getFileUri())) {
717 718 719
          $file->delete();
        }
        else {
720
          \Drupal::logger('file system')->error('Could not delete temporary file "%path" during garbage collection', ['%path' => $file->getFileUri()]);
721 722 723
        }
      }
      else {
724
        \Drupal::logger('file system')->info('Did not delete temporary file "%path" during garbage collection because it is in use by the following modules: %modules.', ['%path' => $file->getFileUri(), '%modules' => implode(', ', array_keys($references))]);
725 726 727 728 729
      }
    }
  }
}

730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
/**
 * Saves form file uploads.
 *
 * The files will be added to the {file_managed} table as temporary files.
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
 *
 * @param array $element
 *   The FAPI element whose values are being saved.
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The current state of the form.
 * @param null|int $delta
 *   (optional) The delta of the file to return the file entity.
 *   Defaults to NULL.
 * @param int $replace
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
 *
 * @return array|\Drupal\file\FileInterface|null|false
 *   An array of file entities or a single file entity if $delta != NULL. Each
 *   array element contains the file entity if the upload succeeded or FALSE if
 *   there was an error. Function returns NULL if no file was uploaded.
 *
 * @deprecated in Drupal 8.4.x, will be removed before Drupal 9.0.0.
 *   For backwards compatibility use core file upload widgets in forms.
 *
 * @internal
 *   This function wraps file_save_upload() to allow correct error handling in
 *   forms.
 *
 * @todo Revisit after https://www.drupal.org/node/2244513.
 */
function _file_save_upload_from_form(array $element, FormStateInterface $form_state, $delta = NULL, $replace = FILE_EXISTS_RENAME) {
  // Get all errors set before calling this method. This will also clear them
  // from $_SESSION.
  $errors_before = drupal_get_messages('error');

  $upload_location = isset($element['#upload_location']) ? $element['#upload_location'] : FALSE;
  $upload_name = implode('_', $element['#parents']);
  $upload_validators = isset($element['#upload_validators']) ? $element['#upload_validators'] : [];

  $result = file_save_upload($upload_name, $upload_validators, $upload_location, $delta, $replace);

  // Get new errors that are generated while trying to save the upload. This
  // will also clear them from $_SESSION.
  $errors_new = drupal_get_messages('error');
  if (!empty($errors_new['error'])) {
    $errors_new = $errors_new['error'];

    if (count($errors_new) > 1) {
      // Render multiple errors into a single message.
      // This is needed because only one error per element is supported.
      $render_array = [
        'error' => [
          '#markup' => t('One or more files could not be uploaded.'),
        ],
        'item_list' => [
          '#theme' => 'item_list',
          '#items' => $errors_new,
        ],
      ];
      $error_message = \Drupal::service('renderer')->renderPlain($render_array);
    }
    else {
      $error_message = reset($errors_new);
    }

    $form_state->setError($element, $error_message);
  }

  // Ensure that errors set prior to calling this method are still shown to the
  // user.
  if (!empty($errors_before['error'])) {
    foreach ($errors_before['error'] as $error) {
      drupal_set_message($error, 'error');
    }
  }

  return $result;
}

815 816 817 818
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
819 820
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
821
 *
822 823 824 825
 * Note that this function does not support correct form error handling. The
 * file upload widgets in core do support this. It is advised to use these in
 * any custom form, instead of calling this function.
 *
826
 * @param string $form_field_name
827 828
 *   A string that is the associative array key of the upload form element in
 *   the form array.
829
 * @param array $validators
830
 *   (optional) An associative array of callback functions used to validate the
831
 *   file. See file_validate() for a full discussion of the array format.
832 833 834 835 836 837 838 839 840 841 842 843
 *   If the array is empty, it will be set up to call file_validate_extensions()
 *   with a safe list of extensions, as follows: "jpg jpeg gif png txt doc
 *   xls pdf ppt pps odt ods odp". To allow all extensions, you must explicitly
 *   set this array to ['file_validate_extensions' => '']. (Beware: this is not
 *   safe and should only be allowed for trusted users, if at all.)
 * @param string|false $destination
 *   (optional) A string containing the URI that the file should be copied to.
 *   This must be a stream wrapper URI. If this value is omitted or set to
 *   FALSE, Drupal's temporary files scheme will be used ("temporary://").
 * @param null|int $delta
 *   (optional) The delta of the file to return the file entity.
 *   Defaults to NULL.
844
 * @param int $replace
845 846
 *   (optional) The replace behavior when the destination file already exists.
 *   Possible values include:
847
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
848 849
 *   - FILE_EXISTS_RENAME: (default) Append _{incrementing number} until the
 *     filename is unique.
850 851
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
 *
852 853 854 855
 * @return array|\Drupal\file\FileInterface|null|false
 *   An array of file entities or a single file entity if $delta != NULL. Each
 *   array element contains the file entity if the upload succeeded or FALSE if
 *   there was an error. Function returns NULL if no file was uploaded.
856 857 858 859
 *
 * @see _file_save_upload_from_form()
 *
 * @todo: move this logic to a service in https://www.drupal.org/node/2244513.
860
 */
861
function file_save_upload($form_field_name, $validators = [], $destination = FALSE, $delta = NULL, $replace = FILE_EXISTS_RENAME) {
862
  $user = \Drupal::currentUser();
863 864
  static $upload_cache;

865
  $all_files = \Drupal::request()->files->get('files', []);
866
  // Make sure there's an upload to process.
867
  if (empty($all_files[$form_field_name])) {
868 869
    return NULL;
  }
870
  $file_upload = $all_files[$form_field_name];
871 872 873 874 875 876 877 878 879 880 881 882

  // Return cached objects without processing since the file will have
  // already been processed and the paths in $_FILES will be invalid.
  if (isset($upload_cache[$form_field_name])) {
    if (isset($delta)) {
      return $upload_cache[$form_field_name][$delta];
    }
    return $upload_cache[$form_field_name];
  }

  // Prepare uploaded files info. Representation is slightly different
  // for multiple uploads and we fix that here.
883 884
  $uploaded_files = $file_upload;
  if (!is_array($file_upload)) {
885
    $uploaded_files = [$file_upload];
886 887
  }

888
  $files = [];
889
  foreach ($uploaded_files as $i => $file_info) {
890 891 892
    // Check for file upload errors and return FALSE for this file if a lower
    // level system error occurred. For a complete list of errors:
    // See http://php.net/manual/features.file-upload.errors.php.
webchick's avatar