file.module 74.7 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\Render\Element;
9
use Drupal\file\Entity\File;
10
use Drupal\Component\Utility\NestedArray;
11
use Drupal\Component\Utility\Unicode;
12
use Drupal\Core\Entity\EntityStorageInterface;
13
use Drupal\Core\Template\Attribute;
14
use Drupal\file\FileUsage\FileUsageInterface;
15
use Symfony\Component\HttpFoundation\Request;
16

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

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

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

74
75
76
77
78
/**
 * Loads file entities from the database.
 *
 * @param array $fids
 *   (optional) An array of entity IDs. If omitted, all entities are loaded.
79
80
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
81
82
83
84
85
86
87
 *
 * @return array
 *   An array of file entities, indexed by fid.
 *
 * @see hook_file_load()
 * @see file_load()
 * @see entity_load()
88
 * @see \Drupal\Core\Entity\Query\EntityQueryInterface
89
 */
90
91
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
  return entity_load_multiple('file', $fids, $reset);
92
93
94
95
96
97
98
}

/**
 * Loads a single file entity from the database.
 *
 * @param $fid
 *   A file ID.
99
100
 * @param $reset
 *   Whether to reset the internal file_load_multiple() cache.
101
 *
102
 * @return \Drupal\file\FileInterface
103
 *   A file entity or NULL if the file was not found.
104
105
106
107
 *
 * @see hook_file_load()
 * @see file_load_multiple()
 */
108
function file_load($fid, $reset = FALSE) {
109
  return entity_load('file', $fid, $reset);
110
111
112
}

/**
113
 * Returns the file usage service.
114
 *
115
116
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('file.usage').
117
 *
118
 * @return \Drupal\file\FileUsage\FileUsageInterface.
119
 */
120
function file_usage() {
121
  return \Drupal::service('file.usage');
122
123
124
125
126
127
128
129
130
131
132
}

/**
 * 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.
133
 * - If the $source and $destination are equal, the behavior depends on the
134
 *   $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
135
 *   will rename the file until the $destination is unique.
136
137
138
139
 * - 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.
 *
140
 * @param \Drupal\file\File $source
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 *   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)) {
162
163
    if (($realpath = drupal_realpath($source->getFileUri())) !== FALSE) {
      watchdog('file', 'File %file (%realpath) could not be copied because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', array('%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination));
164
165
    }
    else {
166
      watchdog('file', 'File %file could not be copied because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', array('%file' => $source->getFileUri(), '%destination' => $destination));
167
    }
168
    drupal_set_message(t('The specified file %file could not be copied because the destination is invalid. More information is available in the system log.', array('%file' => $source->getFileUri())), 'error');
169
170
171
    return FALSE;
  }

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

    $file->save();

    // Inform modules that the file has been copied.
197
    \Drupal::moduleHandler()->invokeAll('file_copy', array($file, $source));
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214

    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.
 *
215
 * @param \Drupal\file\File $source
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 *   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.
 *
231
 * @return \Drupal\file\File
232
233
234
235
236
237
238
 *   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)) {
239
240
    if (($realpath = drupal_realpath($source->getFileUri())) !== FALSE) {
      watchdog('file', 'File %file (%realpath) could not be moved because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', array('%file' => $source->getFileUri(), '%realpath' => $realpath, '%destination' => $destination));
241
242
    }
    else {
243
      watchdog('file', 'File %file could not be moved because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', array('%file' => $source->getFileUri(), '%destination' => $destination));
244
    }
245
    drupal_set_message(t('The specified file %file could not be moved because the destination is invalid. More information is available in the system log.', array('%file' => $source->getFileUri())), 'error');
246
247
248
    return FALSE;
  }

249
  if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
250
251
252
    $delete_source = FALSE;

    $file = clone $source;
253
    $file->setFileUri($uri);
254
255
256
257
258
259
    // 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;
260
        $file->fid = $existing->id();
261
        $file->uuid = $existing->uuid();
262
263
264
265
266
      }
    }
    // 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)) {
267
      $file->setFilename(drupal_basename($destination));
268
269
270
271
272
    }

    $file->save();

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

    // Delete the original if it's not in use elsewhere.
276
    if ($delete_source && !\Drupal::service('file.usage')->listUsage($source)) {
277
278
279
280
281
282
283
284
285
286
287
288
289
290
      $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.
 *
291
 * @param \Drupal\file\File $file
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 *   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.
317
  return array_merge($errors, \Drupal::moduleHandler()->invokeAll('file_validate', array($file)));
318
319
320
321
322
}

/**
 * Checks for files with names longer than can be stored in the database.
 *
323
 * @param \Drupal\file\File $file
324
325
326
327
328
329
330
331
 *   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();

332
  if (!$file->getFilename()) {
333
334
    $errors[] = t("The file's name is empty. Please give a name to the file.");
  }
335
  if (strlen($file->getFilename()) > 240) {
336
337
338
339
340
341
342
343
    $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.
 *
344
 * @param \Drupal\file\File $file
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 *   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';
359
  if (!preg_match($regex, $file->getFilename())) {
360
361
362
363
364
365
366
367
    $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.
 *
368
 * @param \Drupal\file\File $file
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 *   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) {
384
  $user = \Drupal::currentUser();
385
386
  $errors = array();

387
388
  if ($file_limit && $file->getSize() > $file_limit) {
    $errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', array('%filesize' => format_size($file->getSize()), '%maxsize' => format_size($file_limit)));
389
  }
390

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

396
397
398
399
  return $errors;
}

/**
400
 * Checks that the file is recognized by Image::getInfo() as an image.
401
 *
402
 * @param \Drupal\file\File $file
403
404
405
406
407
408
409
410
411
412
 *   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();

413
  $image = \Drupal::service('image.factory')->get($file->getFileUri());
414
415
  if (!$image->isSupported()) {
    $extensions = array();
416
    foreach ($image->getToolkit()->supportedTypes() as $image_type) {
417
418
419
      $extensions[] = Unicode::strtoupper(image_type_to_extension($image_type));
    }
    $errors[] = t('Image type not supported. Allowed types: @types.', array('@types' => implode(', ', $extensions)));
420
421
422
423
424
425
426
427
428
429
430
  }

  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.
 *
431
 * @param \Drupal\file\File $file
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 *   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.
452
  $image_factory = \Drupal::service('image.factory');
453
  $image = $image_factory->get($file->getFileUri());
454
  if ($image->isSupported()) {
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
        $image = $image_factory->get($file->getFileUri());
461
        if ($image->isExisting()) {
462
463
464
          $image->scale($width, $height);
          $image->save();
          $file->filesize = $image->getFileSize();
465
466
467
468
469
470
471
472
473
474
475
          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);
476
      if ($image->getWidth() < $width || $image->getHeight() < $height) {
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
        $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.
 *
503
 * @return \Drupal\file\FileInterface
504
505
506
507
508
 *   A file entity, or FALSE on error.
 *
 * @see file_unmanaged_save_data()
 */
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
509
  $user = \Drupal::currentUser();
510
511
512
513
514
515
516
517
518
519
520
521
522
523

  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,
524
      'uid' => $user->id(),
525
526
527
      'status' => FILE_STATUS_PERMANENT,
    ));
    // If we are replacing an existing file re-use its database record.
528
529
    // @todo Do not create a new entity in order to update it, see
    //   https://drupal.org/node/2241865
530
531
532
533
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
      if (count($existing_files)) {
        $existing = reset($existing_files);
534
        $file->fid = $existing->id();
535
        $file->setOriginalId($existing->id());
536
        $file->setFilename($existing->getFilename());
537
538
539
540
541
      }
    }
    // 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)) {
542
      $file->setFilename(drupal_basename($destination));
543
544
545
546
547
548
549
550
551
552
553
    }

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

/**
 * Examines a file entity and returns appropriate content headers for download.
 *
554
 * @param \Drupal\file\File $file
555
556
557
558
559
560
561
 *   A file entity.
 *
 * @return
 *   An associative array of headers, as expected by
 *   \Symfony\Component\HttpFoundation\StreamedResponse.
 */
function file_get_content_headers(File $file) {
562
  $type = mime_header_encode($file->getMimeType());
563
564

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

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

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

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

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

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

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

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

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

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

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

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

700
701
702
703
/**
 * Implements file_cron()
 */
function file_cron() {
704
705
706
707
708
709
710
711
712
713
714
715
  $age = \Drupal::config('system.file')->get('temporary_maximum_age');

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

732
733
734
735
/**
 * Saves file uploads to a new location.
 *
 * The files will be added to the {file_managed} table as temporary files.
736
737
 * Temporary files are periodically cleaned. Use the 'file.usage' service to
 * register the usage of the file which will automatically mark it as permanent.
738
739
740
741
 *
 * @param $form_field_name
 *   A string that is the associative array key of the upload form element in
 *   the form array.
742
743
 * @param array $form_state
 *   An associative array containing the current state of the form.
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
 * @param $validators
 *   An optional, associative array of callback functions used to validate the
 *   file. See file_validate() for a full discussion of the array format.
 *   If no extension validator is provided it will default to a limited safe
 *   list of extensions which is as follows: "jpg jpeg gif png txt
 *   doc xls pdf ppt pps odt ods odp". To allow all extensions you must
 *   explicitly set the 'file_validate_extensions' validator to an empty array
 *   (Beware: this is not safe and should only be allowed for trusted users, if
 *   at all).
 * @param $destination
 *   A string containing the URI that the file should be copied to. This must
 *   be a stream wrapper URI. If this value is omitted, Drupal's temporary
 *   files scheme will be used ("temporary://").
 * @param $delta
 *   Delta of the file to save or NULL to save all files. Defaults to NULL.
 * @param $replace
 *   Replace behavior when the destination file already exists:
 *   - FILE_EXISTS_REPLACE: Replace the existing file.
 *   - FILE_EXISTS_RENAME: Append _{incrementing number} until the filename is
 *     unique.
 *   - FILE_EXISTS_ERROR: Do nothing and return FALSE.
 *
 * @return
 *   Function returns array of files or a single file object if $delta
 *   != NULL. Each file object contains the file information if the
 *   upload succeeded or FALSE in the event of an error. Function
 *   returns NULL if no file was uploaded.
 *
 *   The documentation for the "File interface" group, which you can find under
 *   Related topics, or the header at the top of this file, documents the
 *   components of a file entity. In addition to the standard components,
 *   this function adds:
 *   - source: Path to the file before it is moved.
 *   - destination: Path to the file after it is moved (same as 'uri').
 */
779
function file_save_upload($form_field_name, $validators = array(), $destination = FALSE, $delta = NULL, $replace = FILE_EXISTS_RENAME) {
780
  $user = \Drupal::currentUser();
781
782
  static $upload_cache;

783
  $file_upload = \Drupal::request()->files->get("files[$form_field_name]", NULL, TRUE);
784
  // Make sure there's an upload to process.
785
  if (empty($file_upload)) {
786
787
788
789
790
791
792
793
794
795
796
797
798
799
    return NULL;
  }

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

  // Prepare uploaded files info. Representation is slightly different
  // for multiple uploads and we fix that here.
800
801
802
  $uploaded_files = $file_upload;
  if (!is_array($file_upload)) {
    $uploaded_files = array($file_upload);
803
804
805
  }

  $files = array();
806
  foreach ($uploaded_files as $i => $file_info) {
807
808
809
    // 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.
810
    switch ($file_info->getError()) {
811
812
      case UPLOAD_ERR_INI_SIZE:
      case UPLOAD_ERR_FORM_SIZE:
813
        drupal_set_message(t('The file %file could not be saved because it exceeds %maxsize, the maximum allowed size for uploads.', array('%file' => $file_info->getFilename(), '%maxsize' => format_size(file_upload_max_size()))), 'error');
814
815
816
817
818
        $files[$i] = FALSE;
        continue;

      case UPLOAD_ERR_PARTIAL:
      case UPLOAD_ERR_NO_FILE:
819
        drupal_set_message(t('The file %file could not be saved because the upload did not complete.', array('%file' => $file_info->getFilename())), 'error');
820
821
822
823
824
825
        $files[$i] = FALSE;
        continue;

      case UPLOAD_ERR_OK:
        // Final check that this is a valid upload, if it isn't, use the
        // default error handler.
826
        if (is_uploaded_file($file_info->getRealPath())) {
827
828
829
830
831
          break;
        }

        // Unknown error
      default:
832
        drupal_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $file_info->getFilename())), 'error');
833
834
835
836
837
838
839
840
        $files[$i] = FALSE;
        continue;

    }
    // Begin building file entity.
    $values = array(
      'uid' => $user->id(),
      'status' => 0,
841
842
843
      'filename' => $file_info->getClientOriginalName(),
      'uri' => $file_info->getRealPath(),
      'filesize' => $file_info->getSize(),
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
    );
    $values['filemime'] = file_get_mimetype($values['filename']);
    $file = entity_create('file', $values);

    $extensions = '';
    if (isset($validators['file_validate_extensions'])) {
      if (isset($validators['file_validate_extensions'][0])) {
        // Build the list of non-munged extensions if the caller provided them.
        $extensions = $validators['file_validate_extensions'][0];
      }
      else {
        // If 'file_validate_extensions' is set and the list is empty then the
        // caller wants to allow any extension. In this case we have to remove the
        // validator or else it will reject all extensions.
        unset($validators['file_validate_extensions']);
      }
    }
    else {
      // No validator was provided, so add one using the default list.
      // Build a default non-munged safe list for file_munge_filename().
      $extensions = 'jpg jpeg gif png txt doc xls pdf ppt pps odt ods odp';
      $validators['file_validate_extensions'] = array();
      $validators['file_validate_extensions'][0] = $extensions;
    }

    if (!empty($extensions)) {
      // Munge the filename to protect against possible malicious extension
      // hiding within an unknown file type (ie: filename.html.foo).
      $file->setFilename(file_munge_filename($file->getFilename(), $extensions));
    }

    // Rename potentially executable files, to help prevent exploits (i.e. will
    // rename filename.php.foo and filename.php to filename.php.foo.txt and
    // filename.php.txt, respectively). Don't rename if 'allow_insecure_uploads'
    // evaluates to TRUE.
879
    if (!\Drupal::config('system.file')->get('allow_insecure_uploads') && preg_match('/\.(php|pl|py|cgi|asp|js)(\.|$)/i', $file->getFilename()) && (substr($file->getFilename(), -4) != '.txt')) {
880
      $file->setMimeType('text/plain');
881
      // The destination filename will also later be used to create the URI.
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
      $file->setFilename($file->getFilename() . '.txt');
      // The .txt extension may not be in the allowed list of extensions. We have
      // to add it here or else the file upload will fail.
      if (!empty($extensions)) {
        $validators['file_validate_extensions'][0] .= ' txt';
        drupal_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $file->getFilename())));
      }
    }

    // If the destination is not provided, use the temporary directory.
    if (empty($destination)) {
      $destination = 'temporary://';
    }

    // Assert that the destination contains a valid stream.
    $destination_scheme = file_uri_scheme($destination);
    if (!file_stream_wrapper_valid_scheme($destination_scheme)) {
      drupal_set_message(t('The file could not be uploaded because the destination %destination is invalid.', array('%destination' => $destination)), 'error');
      $files[$i] = FALSE;
      continue;
    }

    $file->source = $form_field_name;
    // A file URI may already have a trailing slash or look like "public://".
    if (substr($destination, -1) != '/') {
      $destination .= '/';
    }
    $file->destination = file_destination($destination . $file->getFilename(), $replace);
    // If file_destination() returns FALSE then $replace === FILE_EXISTS_ERROR and
    // there's an existing file so we need to bail.
    if ($file->destination === FALSE) {
      drupal_set_message(t('The file %source could not be uploaded because a file by that name already exists in the destination %directory.', array('%source' => $form_field_name, '%directory' => $destination)), 'error');
      $files[$i] = FALSE;
      continue;
    }

    // Add in our check of the the file name length.
    $validators['file_validate_name_length'] = array();

    // Call the validation functions specified by this function's caller.
    $errors = file_validate($file, $validators);

    // Check for errors.
    if (!empty($errors)) {
      $message = t('The specified file %name could not be uploaded.', array('%name' => $file->getFilename()));
      if (count($errors) > 1) {
928
929
930
931
932
        $item_list = array(
          '#theme' => 'item_list',
          '#items' => $errors,
        );
        $message .= drupal_render($item_list);
933
934
935
936
      }
      else {
        $message .= ' ' . array_pop($errors);
      }
937
      drupal_set_message($message, 'error');
938
939
940
941
942
943
944
945
      $files[$i] = FALSE;
      continue;
    }

    // Move uploaded files from PHP's upload_tmp_dir to Drupal's temporary
    // directory. This overcomes open_basedir restrictions for future file
    // operations.
    $file->uri = $file->destination;
946
    if (!drupal_move_uploaded_file($file_info->getRealPath(), $file->getFileUri())) {
947
      drupal_set_message(t('File upload error. Could not move uploaded file.'), 'error');
948
949
950
951
952
953
954
955
956
      watchdog('file', 'Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->filename, '%destination' => $file->uri));
      $files[$i] = FALSE;
      continue;
    }

    // Set the permissions on the new file.
    drupal_chmod($file->getFileUri());

    // If we are replacing an existing file re-use its database record.
957
958
    // @todo Do not create a new entity in order to update it, see
    //   https://drupal.org/node/2241865
959
960
961
962
963
    if ($replace == FILE_EXISTS_REPLACE) {
      $existing_files = entity_load_multiple_by_properties('file', array('uri' => $file->getFileUri()));
      if (count($existing_files)) {
        $existing = reset($existing_files);
        $file->fid = $existing->id();
964
        $file->setOriginalId($existing->id());
965
966
967
968
969
970
971
972
973
974
975
976
977
978
      }
    }

    // If we made it this far it's safe to record this file in the database.
    $file->save();
    $files[$i] = $file;
  }

  // Add files to the cache.
  $upload_cache[$form_field_name] = $files;

  return isset($delta) ? $files[$delta] : $files;
}

979
/**
980
 * Determines the preferred upload progress implementation.
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 *
 * @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;
}

/**
1004
 * Implements hook_file_predelete().
1005
 */
1006
function file_file_predelete(File $file) {
1007
1008
1009
  // TODO: Remove references to a file that is in-use.
}

1010
1011
1012
1013
/**
 * Implements hook_tokens().
 */
function file_tokens($type, $tokens, array $data = array(), array $options = array()) {
1014
  $token_service = \Drupal::token();
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028

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

  $replacements = array();

  if ($type == 'file' && !empty($data['file'])) {
1029
    /** @var \Drupal\file\FileInterface $file */
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
    $file = $data['file'];

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

        // Essential file data
        case 'name':
          $replacements[$original] = $sanitize ? check_plain($file->getFilename()) : $file->getFilename();
          break;

        case 'path':
          $replacements[$original] = $sanitize ? check_plain($file->getFileUri()) : $file->getFileUri();
          break;

        case 'mime':
          $replacements[$original] = $sanitize ? check_plain($file->getMimeType()) : $file->getMimeType();
          break;

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

        case 'url':
          $replacements[$original] = $sanitize ? check_plain(file_create_url($file->getFileUri())) : file_create_url($file->getFileUri());
          break;

        // These tokens are default variations on the chained tokens handled below.
1061
1062
1063
1064
1065
        case 'created':
          $replacements[$original] = format_date($file->getCreatedTime(), 'medium', '', NULL, $langcode);
          break;

        case 'changed':
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
          $replacements[$original] = format_date($file->getChangedTime(), 'medium', '', NULL, $langcode);
          break;

        case 'owner':
          $name = $file->getOwner()->label();
          $replacements[$original] = $sanitize ? check_plain($name) : $name;
          break;
      }
    }

1076
1077
1078
1079
1080
    if ($date_tokens = $token_service->findWithPrefix($tokens, 'created')) {
      $replacements += $token_service->generate('date', $date_tokens, array('date' => $file->getCreatedTime()), $options);
    }

    if ($date_tokens = $token_service->findWithPrefix($tokens, 'changed')) {
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
      $replacements += $token_service->generate('date', $date_tokens, array('date' => $file->getChangedTime()), $options);
    }

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

  return $replacements;
}

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

  // File related tokens.
  $file['fid'] = array(
    'name' => t("File ID"),
    'description' => t("The unique ID of the uploaded file."),
  );
  $file['name'] = array(
    'name' => t("File name"),
    'description' => t("The name of the file on disk."),
  );
  $file['path'] = array(
    'name' => t("Path"),
    'description' => t("The location of the file relative to Drupal root."),
  );
  $file['mime'] = array(
    'name' => t("MIME type"),
    'description' => t("The MIME type of the file."),
  );
  $file['size'] = array(
    'name' => t("File size"),
    'description' => t("The size of the file."),
  );
  $file['url'] = array(
    'name' => t("URL"),
    'description' => t("The web-accessible URL for the file."),
  );
1127
1128
1129
1130
1131
1132
1133
  $file['created'] = array(
    'name' => t("Created"),
    'description' => t("The date the file created."),
    'type' => 'date',
  );
  $file['changed'] = array(
    'name' => t("Changed"),
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
    'description' => t("The date the file was most recently changed."),
    'type' => 'date',
  );
  $file['owner'] = array(
    'name' => t("Owner"),
    'description' => t("The user who originally uploaded the file."),
    'type' => 'user',
  );

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

1151
/**
1152
 * Render API callback: Expands the managed_file element type.
1153
1154
1155
 *
 * Expands the file type to include Upload and Remove buttons, as well as
 * support for a default value.
1156
1157
 *
 * This function is assigned as a #process callback in file_element_info().
1158
1159
 */
function file_managed_file_process($element, &$form_state, $form) {
1160
1161
1162
  // Append the '-upload' to the #id so the field label's 'for' attribute
  // corresponds with the file element.
  $element['#id'] .= '-upload';
1163
1164
1165
1166
1167

  // 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();
1168
1169
1170

  // Set some default element properties.
  $element['#progress_indicator'] = empty($element['#progress_indicator']) ? 'none' : $element['#progress_indicator'];
1171
  $element['#files'] = !empty($fids) ? file_load_multiple($fids) : FALSE;
1172
1173
1174
  $element['#tree'] = TRUE;

  $ajax_settings = array(
1175
1176
1177
1178
1179
1180
1181
    'path' => 'file/ajax',
    'options' => array(
      'query' => array(
        'element_parents' => implode('/', $element['#array_parents']),
        'form_build_id' => $form['form_build_id']['#value'],
      ),
    ),
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
    '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(
1192
    '#name' => $parents_prefix . '_upload_button',
1193
1194
    '#type' => 'submit',
    '#value' => t('Upload'),
1195
    '#attributes' => array('class' => array('js-hide')),
1196
1197
    '#validate' => array(),
    '#submit' => array('file_managed_file_submit'),
1198
    '#limit_validation_errors' => array($element['#parents']),
1199
1200
1201
1202
    '#ajax' => $ajax_settings,
    '#weight' => -5,
  );

1203
1204
1205
  // 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';
1206
1207
1208
  $ajax_settings['progress']['message'] = NULL;
  $ajax_settings['effect'] = 'none';
  $element['remove_button'] = array(
1209
    '#name' => $parents_prefix . '_remove_button',
1210
    '#type' => 'submit',
1211
    '#value' => $element['#multiple'] ? t('Remove selected') : t('Remove'),
1212
1213
    '#validate' => array(),
    '#submit' => array('file_managed_file_submit'),
1214
    '#limit_validation_errors' => array($element['#parents']),
1215
    '#ajax' => $ajax_settings,
1216
    '#weight' => 1,
1217
1218
  );

1219
  $element['fids'] = array(
1220
    '#type' => 'hidden',
1221
    '#value' => $fids,
1222
1223
1224
1225
  );

  // Add progress bar support to the upload if possible.
  if ($element['#progress_indicator'] == 'bar' && $implementation = file_progress_implementation()) {
1226
    $upload_progress_key = mt_rand();
1227
1228
1229
1230
1231
1232

    if ($implementation == 'uploadprogress') {
      $element['UPLOAD_IDENTIFIER'] = array(
        '#type' => 'hidden',
        '#value' => $upload_progress_key,
        '#attributes' => array('class' => array('file-progress')),
1233
1234
1235
        // Uploadprogress extension requires this field to be at the top of the
        // form.
        '#weight' => -20,
1236
1237
1238
1239
1240
1241
1242
      );
    }
    elseif ($implementation == 'apc') {
      $element['APC_UPLOAD_PROGRESS'] = array(
        '#type' => 'hidden',
        '#value' => $upload_progress_key,
        '#attributes' => array('class' => array('file-progress')),
1243
1244
1245
        // Uploadprogress extension requires this field to be at the top of the
        // form.
        '#weight' => -20,
1246
1247
1248
1249
1250
1251
1252
1253
1254
      );
    }

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

  // The file upload field itself.
  $element['upload'] = array(
1255
    '#name' => 'files[' . $parents_prefix . ']',
1256
    '#type' => 'file',
1257
1258
    '#title' => t('Choose a file'),
    '#title_display' => 'invisible',
1259
    '#size' => $element['#size'],
1260
    '#multiple' => $element['#multiple'],
1261
1262
1263
1264
    '#theme_wrappers' => array(),
    '#weight' => -10,
  );

1265
1266
  if (!empty($fids) && $element['#files']) {
    foreach ($element['#files'] as $delta => $file) {
1267
1268
1269
1270
      $file_link = array(
        '#theme' => 'file_link',
        '#file' => $file,
      );
1271
1272
1273
      if ($element['#multiple']) {
        $element['file_' . $delta]['selected'] = array(
          '#type' => 'checkbox',
1274
          '#title' => drupal_render($file_link),
1275
1276
1277
        );
      }
      else {
1278
        $element['file_' . $delta]['filename'] = $file_link += array('#weight' => -10);
1279
1280
      }
    }
1281
1282
  }

1283
  // Add the extension list to the page as JavaScript settings.
1284
  if (isset($element['#upload_validators']['file_validate_extensions'][0])) {
1285
1286
1287
1288
    $extension_list = implode(',', array_filter(explode(' ', $element['#upload_validators']['file_validate_extensions'][0])));
    $element['upload']['#attached']['js'] = array(
      array(
        'type' => 'setting',
1289
        'data' => array('file' => array('elements' => array('#' . $element['#id'] => $extension_list)))
1290
1291
      )
    );
1292
1293
  }

1294
  // Prefix and suffix used for Ajax replacement.
1295
1296
1297
1298
1299
1300
1301
  $element['#prefix'] = '<div id="' . $element['#id'] . '-ajax-wrapper">';
  $element['#suffix'] = '</div>';

  return $element;
}

/**