Newer
Older
Dries Buytaert
committed
<?php
/**
* @file
* Defines a "managed_file" Form API field and a "file" field for Field module.
*/
Angie Byron
committed
use Drupal\file\Plugin\Core\Entity\File;
Dries Buytaert
committed
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Template\Attribute;
use Symfony\Component\HttpFoundation\JsonResponse;
use Drupal\file\FileUsage\DatabaseFileUsageBackend;
use Drupal\file\FileUsage\FileUsageInterface;
use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\ReplaceCommand;
Angie Byron
committed
// Load all Field module hooks for File.
require_once __DIR__ . '/file.field.inc';
Angie Byron
committed
/**
* Implements hook_help().
*/
function file_help($path, $arg) {
switch ($path) {
case 'admin/help#file':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The File module defines a <em>File</em> field type for the Field module, which lets you manage and validate uploaded files attached to content on your site (see the <a href="@field-help">Field module help page</a> for more information about fields). For more information, see the online handbook entry for <a href="@file">File module</a>.', array('@field-help' => url('admin/help/field'), '@file' => 'http://drupal.org/documentation/modules/file')) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Attaching files to content') . '</dt>';
$output .= '<dd>' . t('The File module allows users to attach files to content (e.g., PDF files, spreadsheets, etc.), when a <em>File</em> field is added to a given content type using the <a href="@fieldui-help">Field UI module</a>. You can add validation options to your File field, such as specifying a maximum file size and allowed file extensions.', array('@fieldui-help' => url('admin/help/field_ui'))) . '</dd>';
$output .= '<dt>' . t('Managing attachment display') . '</dt>';
$output .= '<dd>' . t('When you attach a file to content, you can specify whether it is <em>listed</em> or not. Listed files are displayed automatically in a section at the bottom of your content; non-listed files are available for embedding in your content, but are not included in the list at the bottom.') . '</dd>';
$output .= '<dt>' . t('Managing file locations') . '</dt>';
$output .= '<dd>' . t("When you create a File field, you can specify a directory where the files will be stored, which can be within either the <em>public</em> or <em>private</em> files directory. Files in the public directory can be accessed directly through the web server; when public files are listed, direct links to the files are used, and anyone who knows a file's URL can download the file. Files in the private directory are not accessible directly through the web server; when private files are listed, the links are Drupal path requests. This adds to server load and download time, since Drupal must start up and resolve the path for each file download request, but allows for access restrictions.") . '</dd>';
$output .= '</dl>';
return $output;
}
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_menu().
Dries Buytaert
committed
*/
function file_menu() {
$items = array();
$items['file/ajax'] = array(
'page callback' => 'file_ajax_upload',
'access arguments' => array('access content'),
Dries Buytaert
committed
'theme callback' => 'ajax_base_page_theme',
Dries Buytaert
committed
'type' => MENU_CALLBACK,
);
$items['file/progress'] = array(
'page callback' => 'file_ajax_progress',
'access arguments' => array('access content'),
Dries Buytaert
committed
'theme callback' => 'ajax_base_page_theme',
Dries Buytaert
committed
'type' => MENU_CALLBACK,
);
return $items;
}
/**
Dries Buytaert
committed
* Implements hook_element_info().
Dries Buytaert
committed
*
* The managed file element may be used anywhere in Drupal.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function file_element_info() {
Dries Buytaert
committed
$file_path = drupal_get_path('module', 'file');
Dries Buytaert
committed
$types['managed_file'] = array(
Dries Buytaert
committed
'#input' => TRUE,
'#process' => array('file_managed_file_process'),
'#value_callback' => 'file_managed_file_value',
'#element_validate' => array('file_managed_file_validate'),
'#pre_render' => array('file_managed_file_pre_render'),
Dries Buytaert
committed
'#theme' => 'file_managed_file',
'#theme_wrappers' => array('form_element'),
'#progress_indicator' => 'throbber',
'#progress_message' => NULL,
'#upload_validators' => array(),
'#upload_location' => NULL,
Angie Byron
committed
'#size' => 22,
Angie Byron
committed
'#multiple' => FALSE,
Dries Buytaert
committed
'#extended' => FALSE,
Dries Buytaert
committed
'#attached' => array(
'library' => array(array('file','drupal.file')),
Dries Buytaert
committed
),
Dries Buytaert
committed
);
Dries Buytaert
committed
return $types;
Dries Buytaert
committed
}
Angie Byron
committed
/**
* Loads file entities from the database.
*
* @param array $fids
* (optional) An array of entity IDs. If omitted, all entities are loaded.
* @param $reset
* Whether to reset the internal file_load_multiple() cache.
Angie Byron
committed
*
* @return array
* An array of file entities, indexed by fid.
*
* @see hook_file_load()
* @see file_load()
* @see entity_load()
* @see Drupal\Core\Entity\Query\EntityQueryInterface
Angie Byron
committed
*/
function file_load_multiple(array $fids = NULL, $reset = FALSE) {
return entity_load_multiple('file', $fids, $reset);
Angie Byron
committed
}
/**
* Loads a single file entity from the database.
*
* @param $fid
* A file ID.
* @param $reset
* Whether to reset the internal file_load_multiple() cache.
Angie Byron
committed
*
* @return \Drupal\file\FileInterface
Dries Buytaert
committed
* A file entity or NULL if the file was not found.
Angie Byron
committed
*
* @see hook_file_load()
* @see file_load_multiple()
*/
function file_load($fid, $reset = FALSE) {
Dries Buytaert
committed
return entity_load('file', $fid, $reset);
Angie Byron
committed
}
/**
* Returns the file usage service.
Angie Byron
committed
*
* @return Drupal\file\FileUsage\FileUsageInterface.
Angie Byron
committed
*/
function file_usage() {
return Drupal::service('file.usage');
Angie Byron
committed
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
}
/**
* Copies a file to a new location and adds a file record to the database.
*
* This function should be used when manipulating files that have records
* stored in the database. This is a powerful function that in many ways
* performs like an advanced version of copy().
* - Checks if $source and $destination are valid and readable/writable.
* - Checks that $source is not equal to $destination; if they are an error
* is reported.
* - If file already exists in $destination either the call will error out,
* replace the file or rename the file based on the $replace parameter.
* - Adds the new file to the files database. If the source file is a
* temporary file, the resulting file will also be a temporary file. See
* file_save_upload() for details on temporary files.
*
* @param Drupal\file\File $source
* A file entity.
* @param $destination
* A string containing the destination that $source should be copied to.
* This must be a stream wrapper URI.
* @param $replace
* Replace behavior when the destination file already exists:
* - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with
* the destination name exists then its database entry will be updated. If
* no database entry is found then a new one will be created.
* - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
* unique.
* - FILE_EXISTS_ERROR - Do nothing and return FALSE.
*
* @return
* File object if the copy is successful, or FALSE in the event of an error.
*
* @see file_unmanaged_copy()
* @see hook_file_copy()
*/
function file_copy(File $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
if (!file_valid_uri($destination)) {
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));
Angie Byron
committed
}
else {
watchdog('file', 'File %file could not be copied because the destination %destination is invalid. This is often caused by improper use of file_copy() or a missing stream wrapper.', array('%file' => $source->getFileUri(), '%destination' => $destination));
Angie Byron
committed
}
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');
Angie Byron
committed
return FALSE;
}
if ($uri = file_unmanaged_copy($source->getFileUri(), $destination, $replace)) {
$file = $source->createDuplicate();
$file->setFileUri($uri);
$file->setFilename(drupal_basename($uri));
Angie Byron
committed
// If we are replacing an existing file re-use its database record.
if ($replace == FILE_EXISTS_REPLACE) {
$existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
if (count($existing_files)) {
$existing = reset($existing_files);
$file->fid = $existing->id();
$file->setFilename($existing->getFilename());
Angie Byron
committed
}
}
// If we are renaming around an existing file (rather than a directory),
// use its basename for the filename.
elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
$file->setFilename(drupal_basename($destination));
Angie Byron
committed
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
}
$file->save();
// Inform modules that the file has been copied.
module_invoke_all('file_copy', $file, $source);
return $file;
}
return FALSE;
}
/**
* Moves a file to a new location and update the file's database entry.
*
* Moving a file is performed by copying the file to the new location and then
* deleting the original.
* - Checks if $source and $destination are valid and readable/writable.
* - Performs a file move if $source is not equal to $destination.
* - If file already exists in $destination either the call will error out,
* replace the file or rename the file based on the $replace parameter.
* - Adds the new file to the files database.
*
* @param Drupal\file\File $source
* A file entity.
* @param $destination
* A string containing the destination that $source should be moved to.
* This must be a stream wrapper URI.
* @param $replace
* Replace behavior when the destination file already exists:
* - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with
* the destination name exists then its database entry will be updated and
* $source->delete() called after invoking hook_file_move().
* If no database entry is found then the source files record will be
* updated.
* - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
* unique.
* - FILE_EXISTS_ERROR - Do nothing and return FALSE.
*
* @return Drupal\file\File
* Resulting file entity for success, or FALSE in the event of an error.
*
* @see file_unmanaged_move()
* @see hook_file_move()
*/
function file_move(File $source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
if (!file_valid_uri($destination)) {
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));
Angie Byron
committed
}
else {
watchdog('file', 'File %file could not be moved because the destination %destination is invalid. This may be caused by improper use of file_move() or a missing stream wrapper.', array('%file' => $source->getFileUri(), '%destination' => $destination));
Angie Byron
committed
}
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');
Angie Byron
committed
return FALSE;
}
if ($uri = file_unmanaged_move($source->getFileUri(), $destination, $replace)) {
Angie Byron
committed
$delete_source = FALSE;
$file = clone $source;
$file->setFileUri($uri);
Angie Byron
committed
// If we are replacing an existing file re-use its database record.
if ($replace == FILE_EXISTS_REPLACE) {
$existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
if (count($existing_files)) {
$existing = reset($existing_files);
$delete_source = TRUE;
$file->fid = $existing->id();
Angie Byron
committed
}
}
// If we are renaming around an existing file (rather than a directory),
// use its basename for the filename.
elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
$file->setFilename(drupal_basename($destination));
Angie Byron
committed
}
$file->save();
// Inform modules that the file has been moved.
module_invoke_all('file_move', $file, $source);
// Delete the original if it's not in use elsewhere.
if ($delete_source && !file_usage()->listUsage($source)) {
Angie Byron
committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
$source->delete();
}
return $file;
}
return FALSE;
}
/**
* Checks that a file meets the criteria specified by the validators.
*
* After executing the validator callbacks specified hook_file_validate() will
* also be called to allow other modules to report errors about the file.
*
* @param Drupal\file\File $file
* A file entity.
* @param $validators
* An optional, associative array of callback functions used to validate the
* file. The keys are function names and the values arrays of callback
* parameters which will be passed in after the file entity. The
* functions should return an array of error messages; an empty array
* indicates that the file passed validation. The functions will be called in
* the order specified.
*
* @return
* An array containing validation error messages.
*
* @see hook_file_validate()
*/
function file_validate(File $file, $validators = array()) {
// Call the validation functions specified by this function's caller.
$errors = array();
foreach ($validators as $function => $args) {
if (function_exists($function)) {
array_unshift($args, $file);
$errors = array_merge($errors, call_user_func_array($function, $args));
}
}
// Let other modules perform validation on the new file.
return array_merge($errors, module_invoke_all('file_validate', $file));
}
/**
* Checks for files with names longer than can be stored in the database.
*
* @param Drupal\file\File $file
* A file entity.
*
* @return
* An array. If the file name is too long, it will contain an error message.
*/
function file_validate_name_length(File $file) {
$errors = array();
if (!$file->getFilename()) {
Angie Byron
committed
$errors[] = t("The file's name is empty. Please give a name to the file.");
}
if (strlen($file->getFilename()) > 240) {
Angie Byron
committed
$errors[] = t("The file's name exceeds the 240 characters limit. Please rename the file and try again.");
}
return $errors;
}
/**
* Checks that the filename ends with an allowed extension.
*
* @param Drupal\file\File $file
* A file entity.
* @param $extensions
* A string with a space separated list of allowed extensions.
*
* @return
* An array. If the file extension is not allowed, it will contain an error
* message.
*
* @see hook_file_validate()
*/
function file_validate_extensions(File $file, $extensions) {
$errors = array();
$regex = '/\.(' . preg_replace('/ +/', '|', preg_quote($extensions)) . ')$/i';
if (!preg_match($regex, $file->getFilename())) {
Angie Byron
committed
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
$errors[] = t('Only files with the following extensions are allowed: %files-allowed.', array('%files-allowed' => $extensions));
}
return $errors;
}
/**
* Checks that the file's size is below certain limits.
*
* @param Drupal\file\File $file
* A file entity.
* @param $file_limit
* An integer specifying the maximum file size in bytes. Zero indicates that
* no limit should be enforced.
* @param $user_limit
* An integer specifying the maximum number of bytes the user is allowed.
* Zero indicates that no limit should be enforced.
*
* @return
* An array. If the file size exceeds limits, it will contain an error
* message.
*
* @see hook_file_validate()
*/
function file_validate_size(File $file, $file_limit = 0, $user_limit = 0) {
global $user;
$errors = array();
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)));
Dries Buytaert
committed
}
Angie Byron
committed
Dries Buytaert
committed
// Save a query by only calling spaceUsed() when a limit is provided.
Dries Buytaert
committed
if ($user_limit && (Drupal::entityManager()->getStorageController('file')->spaceUsed($user->id()) + $file->getSize()) > $user_limit) {
$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)));
Angie Byron
committed
}
Dries Buytaert
committed
Angie Byron
committed
return $errors;
}
/**
* Checks that the file is recognized by image_get_info() as an image.
*
* @param Drupal\file\File $file
* A file entity.
*
* @return
* An array. If the file is not an image, it will contain an error message.
*
* @see hook_file_validate()
*/
function file_validate_is_image(File $file) {
$errors = array();
$info = image_get_info($file->getFileUri());
Angie Byron
committed
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
if (!$info || empty($info['extension'])) {
$errors[] = t('Only JPEG, PNG and GIF images are allowed.');
}
return $errors;
}
/**
* Verifies that image dimensions are within the specified maximum and minimum.
*
* Non-image files will be ignored. If a image toolkit is available the image
* will be scaled to fit within the desired maximum dimensions.
*
* @param Drupal\file\File $file
* A file entity. This function may resize the file affecting its size.
* @param $maximum_dimensions
* An optional string in the form WIDTHxHEIGHT e.g. '640x480' or '85x85'. If
* an image toolkit is installed the image will be resized down to these
* dimensions. A value of 0 indicates no restriction on size, so resizing
* will be attempted.
* @param $minimum_dimensions
* An optional string in the form WIDTHxHEIGHT. This will check that the
* image meets a minimum size. A value of 0 indicates no restriction.
*
* @return
* An array. If the file is an image and did not meet the requirements, it
* will contain an error message.
*
* @see hook_file_validate()
*/
function file_validate_image_resolution(File $file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
$errors = array();
// Check first that the file is an image.
if ($info = image_get_info($file->getFileUri())) {
Angie Byron
committed
if ($maximum_dimensions) {
// Check that it is smaller than the given dimensions.
list($width, $height) = explode('x', $maximum_dimensions);
if ($info['width'] > $width || $info['height'] > $height) {
// Try to resize the image to fit the dimensions.
if ($image = image_load($file->getFileUri())) {
Angie Byron
committed
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
image_scale($image, $width, $height);
image_save($image);
$file->filesize = $image->info['file_size'];
drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
}
else {
$errors[] = t('The image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => $maximum_dimensions));
}
}
}
if ($minimum_dimensions) {
// Check that it is larger than the given dimensions.
list($width, $height) = explode('x', $minimum_dimensions);
if ($info['width'] < $width || $info['height'] < $height) {
$errors[] = t('The image is too small; the minimum dimensions are %dimensions pixels.', array('%dimensions' => $minimum_dimensions));
}
}
}
return $errors;
}
/**
* Saves a file to the specified destination and creates a database entry.
*
* @param $data
* A string containing the contents of the file.
* @param $destination
* A string containing the destination URI. This must be a stream wrapper URI.
* If no value is provided, a randomized name will be generated and the file
* will be saved using Drupal's default files scheme, usually "public://".
* @param $replace
* Replace behavior when the destination file already exists:
* - FILE_EXISTS_REPLACE - Replace the existing file. If a managed file with
* the destination name exists then its database entry will be updated. If
* no database entry is found then a new one will be created.
* - FILE_EXISTS_RENAME - Append _{incrementing number} until the filename is
* unique.
* - FILE_EXISTS_ERROR - Do nothing and return FALSE.
*
* @return \Drupal\file\FileInterface
Angie Byron
committed
* A file entity, or FALSE on error.
*
* @see file_unmanaged_save_data()
*/
function file_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
global $user;
if (empty($destination)) {
$destination = file_default_scheme() . '://';
}
if (!file_valid_uri($destination)) {
watchdog('file', 'The data could not be saved because the destination %destination is invalid. This may be caused by improper use of file_save_data() or a missing stream wrapper.', array('%destination' => $destination));
drupal_set_message(t('The data could not be saved because the destination is invalid. More information is available in the system log.'), 'error');
return FALSE;
}
if ($uri = file_unmanaged_save_data($data, $destination, $replace)) {
// Create a file entity.
$file = entity_create('file', array(
'uri' => $uri,
Dries Buytaert
committed
'uid' => $user->id(),
Angie Byron
committed
'status' => FILE_STATUS_PERMANENT,
));
// If we are replacing an existing file re-use its database record.
if ($replace == FILE_EXISTS_REPLACE) {
$existing_files = entity_load_multiple_by_properties('file', array('uri' => $uri));
if (count($existing_files)) {
$existing = reset($existing_files);
$file->fid = $existing->id();
$file->setFilename($existing->getFilename());
Angie Byron
committed
}
}
// If we are renaming around an existing file (rather than a directory),
// use its basename for the filename.
elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
$file->setFilename(drupal_basename($destination));
Angie Byron
committed
}
$file->save();
return $file;
}
return FALSE;
}
/**
* Examines a file entity and returns appropriate content headers for download.
*
* @param Drupal\file\File $file
* A file entity.
*
* @return
* An associative array of headers, as expected by
* \Symfony\Component\HttpFoundation\StreamedResponse.
*/
function file_get_content_headers(File $file) {
$name = mime_header_encode($file->getFilename());
$type = mime_header_encode($file->getMimeType());
Angie Byron
committed
return array(
Angie Byron
committed
'Content-Type' => $type,
'Content-Length' => $file->getSize(),
Angie Byron
committed
'Cache-Control' => 'private',
);
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_theme().
Dries Buytaert
committed
*/
function file_theme() {
return array(
// file.module.
'file_link' => array(
catch
committed
'variables' => array('file' => NULL, 'icon_directory' => NULL, 'description' => NULL),
Dries Buytaert
committed
),
'file_icon' => array(
'variables' => array('file' => NULL, 'icon_directory' => NULL),
Dries Buytaert
committed
),
'file_managed_file' => array(
'render element' => 'element',
Dries Buytaert
committed
),
// file.field.inc.
'file_widget' => array(
'render element' => 'element',
Dries Buytaert
committed
),
'file_widget_multiple' => array(
'render element' => 'element',
Dries Buytaert
committed
),
Dries Buytaert
committed
'file_formatter_table' => array(
'variables' => array('items' => NULL),
),
Dries Buytaert
committed
'file_upload_help' => array(
Angie Byron
committed
'variables' => array('description' => NULL, 'upload_validators' => NULL, 'cardinality' => NULL),
Dries Buytaert
committed
),
);
}
/**
Dries Buytaert
committed
* Implements hook_file_download().
Angie Byron
committed
*
* This function takes an extra parameter $field_type so that it may
* be re-used by other File-like modules, such as Image.
Dries Buytaert
committed
*/
Angie Byron
committed
function file_file_download($uri, $field_type = 'file') {
Dries Buytaert
committed
global $user;
// Get the file record based on the URI. If not in the database just return.
$files = entity_load_multiple_by_properties('file', array('uri' => $uri));
Dries Buytaert
committed
if (count($files)) {
foreach ($files as $item) {
// Since some database servers sometimes use a case-insensitive comparison
// by default, double check that the filename is an exact match.
if ($item->getFileUri() === $uri) {
$file = $item;
break;
}
}
Dries Buytaert
committed
}
if (!isset($file)) {
Dries Buytaert
committed
return;
}
// Find out which (if any) fields of this type contain the file.
Dries Buytaert
committed
$references = file_get_file_references($file, NULL, FIELD_LOAD_CURRENT, $field_type);
Dries Buytaert
committed
Angie Byron
committed
// 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.
Dries Buytaert
committed
if (empty($references) && ($file->isPermanent() || $file->getOwner()->id() != $user->id())) {
Angie Byron
committed
// 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.
Dries Buytaert
committed
foreach ($references as $field_name => $field_references) {
foreach ($field_references as $entity_type => $entities) {
foreach ($entities as $entity) {
$field = field_info_field($field_name);
// Check if access to this field is not disallowed.
if (!field_access('view', $field, $entity_type, $entity)) {
Angie Byron
committed
$denied = TRUE;
Angie Byron
committed
}
// Invoke hook and collect grants/denies for download access.
// Default to FALSE and let entities overrule this ruling.
$grants = array('system' => FALSE);
foreach (module_implements('file_download_access') as $module) {
$grants = array_merge($grants, array($module => module_invoke($module, 'file_download_access', $field, $entity, $file)));
Angie Byron
committed
}
// Allow other modules to alter the returned grants/denies.
$context = array(
'entity' => $entity,
'field' => $field,
'file' => $file,
);
drupal_alter('file_download_access', $grants, $context);
Angie Byron
committed
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;
Dries Buytaert
committed
}
}
}
}
Angie Byron
committed
// Access specifically denied.
if ($denied) {
Dries Buytaert
committed
return -1;
}
// Access is granted.
Dries Buytaert
committed
$headers = file_get_content_headers($file);
return $headers;
Dries Buytaert
committed
}
Angie Byron
committed
/**
* Implements file_cron()
*/
function file_cron() {
$result = Drupal::entityManager()->getStorageController('file')->retrieveTemporaryFiles();
Angie Byron
committed
foreach ($result as $row) {
if ($file = file_load($row->fid)) {
$references = file_usage()->listUsage($file);
Angie Byron
committed
if (empty($references)) {
if (file_exists($file->getFileUri())) {
Angie Byron
committed
$file->delete();
}
else {
watchdog('file system', 'Could not delete temporary file "%path" during garbage collection', array('%path' => $file->getFileUri()), WATCHDOG_ERROR);
Angie Byron
committed
}
}
else {
watchdog('file system', 'Did not delete temporary file "%path" during garbage collection because it is in use by the following modules: %modules.', array('%path' => $file->getFileUri(), '%modules' => implode(', ', array_keys($references))), WATCHDOG_INFO);
Angie Byron
committed
}
}
}
}
Dries Buytaert
committed
/**
* Ajax callback: Processes file uploads and deletions.
*
Dries Buytaert
committed
* This rebuilds the form element for a particular field item. As long as the
* form processing is properly encapsulated in the widget element the form
* should rebuild correctly using FAPI without the need for additional callbacks
* or processing.
*
* @see file_menu()
Dries Buytaert
committed
*/
function file_ajax_upload() {
$form_parents = func_get_args();
$form_build_id = (string) array_pop($form_parents);
Dries Buytaert
committed
$request = \Drupal::request();
if (!$request->request->has('form_build_id') || $form_build_id != $request->request->get('form_build_id')) {
Dries Buytaert
committed
// Invalid request.
drupal_set_message(t('An unrecoverable error occurred. The uploaded file likely exceeded the maximum file size (@size) that this server supports.', array('@size' => format_size(file_upload_max_size()))), 'error');
$response = new AjaxResponse();
return $response->addCommand(new ReplaceCommand(NULL, theme('status_messages')));
Dries Buytaert
committed
}
Dries Buytaert
committed
list($form, $form_state) = ajax_get_form();
Dries Buytaert
committed
if (!$form) {
// Invalid form_build_id.
drupal_set_message(t('An unrecoverable error occurred. Use of this form has expired. Try reloading the page and submitting again.'), 'error');
$response = new AjaxResponse();
return $response->addCommand(new ReplaceCommand(NULL, theme('status_messages')));
Dries Buytaert
committed
}
// Get the current element and count the number of files.
$current_element = $form;
foreach ($form_parents as $parent) {
$current_element = $current_element[$parent];
}
$current_file_count = isset($current_element['#file_upload_delta']) ? $current_element['#file_upload_delta'] : 0;
Dries Buytaert
committed
// Process user input. $form and $form_state are modified in the process.
drupal_process_form($form['#form_id'], $form, $form_state);
Dries Buytaert
committed
// Retrieve the element to be rendered.
foreach ($form_parents as $parent) {
$form = $form[$parent];
}
// Add the special Ajax class if a new file was added.
Dries Buytaert
committed
if (isset($form['#file_upload_delta']) && $current_file_count < $form['#file_upload_delta']) {
$form[$current_file_count]['#attributes']['class'][] = 'ajax-new-content';
}
// Otherwise just add the new content class on a placeholder.
else {
$form['#suffix'] .= '<span class="ajax-new-content"></span>';
}
$form['#prefix'] .= theme('status_messages');
$output = drupal_render($form);
Dries Buytaert
committed
$js = drupal_add_js();
$settings = drupal_merge_js_settings($js['settings']['data']);
Dries Buytaert
committed
$response = new AjaxResponse();
return $response->addCommand(new ReplaceCommand(NULL, $output, $settings));
Dries Buytaert
committed
}
/**
* Ajax callback: Retrieves upload progress.
*
Dries Buytaert
committed
* @param $key
* The unique key for this upload process.
*/
function file_ajax_progress($key) {
$progress = array(
'message' => t('Starting upload...'),
'percentage' => -1,
);
$implementation = file_progress_implementation();
if ($implementation == 'uploadprogress') {
$status = uploadprogress_get_info($key);
if (isset($status['bytes_uploaded']) && !empty($status['bytes_total'])) {
$progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['bytes_uploaded']), '@total' => format_size($status['bytes_total'])));
$progress['percentage'] = round(100 * $status['bytes_uploaded'] / $status['bytes_total']);
}
}
elseif ($implementation == 'apc') {
$status = apc_fetch('upload_' . $key);
if (isset($status['current']) && !empty($status['total'])) {
$progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['current']), '@total' => format_size($status['total'])));
$progress['percentage'] = round(100 * $status['current'] / $status['total']);
}
}
return new JsonResponse($progress);
Dries Buytaert
committed
}
/**
* Determines the preferred upload progress implementation.
Dries Buytaert
committed
*
* @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;
}
/**
catch
committed
* Implements hook_file_predelete().
Dries Buytaert
committed
*/
Dries Buytaert
committed
function file_file_predelete(File $file) {
Dries Buytaert
committed
// TODO: Remove references to a file that is in-use.
}
/**
* Render API callback: Expands the managed_file element type.
Dries Buytaert
committed
*
* Expands the file type to include Upload and Remove buttons, as well as
* support for a default value.
*
* This function is assigned as a #process callback in file_element_info().
Dries Buytaert
committed
*/
function file_managed_file_process($element, &$form_state, $form) {
catch
committed
// Append the '-upload' to the #id so the field label's 'for' attribute
// corresponds with the file element.
$element['#id'] .= '-upload';
Angie Byron
committed
// 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();
Dries Buytaert
committed
// Set some default element properties.
$element['#progress_indicator'] = empty($element['#progress_indicator']) ? 'none' : $element['#progress_indicator'];
Angie Byron
committed
$element['#files'] = !empty($fids) ? file_load_multiple($fids) : FALSE;
Dries Buytaert
committed
$element['#tree'] = TRUE;
$ajax_settings = array(
'path' => 'file/ajax/' . implode('/', $element['#array_parents']) . '/' . $form['form_build_id']['#value'],
Dries Buytaert
committed
'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(
Angie Byron
committed
'#name' => $parents_prefix . '_upload_button',
Dries Buytaert
committed
'#type' => 'submit',
'#value' => t('Upload'),
'#validate' => array(),
'#submit' => array('file_managed_file_submit'),
Dries Buytaert
committed
'#limit_validation_errors' => array($element['#parents']),
Dries Buytaert
committed
'#ajax' => $ajax_settings,
'#weight' => -5,
);
catch
committed
// 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';
Dries Buytaert
committed
$ajax_settings['progress']['message'] = NULL;
$ajax_settings['effect'] = 'none';
$element['remove_button'] = array(
Angie Byron
committed
'#name' => $parents_prefix . '_remove_button',
Dries Buytaert
committed
'#type' => 'submit',
Angie Byron
committed
'#value' => $element['#multiple'] ? t('Remove selected') : t('Remove'),
Dries Buytaert
committed
'#validate' => array(),
'#submit' => array('file_managed_file_submit'),
Dries Buytaert
committed
'#limit_validation_errors' => array($element['#parents']),
Dries Buytaert
committed
'#ajax' => $ajax_settings,
Angie Byron
committed
'#weight' => 1,
Dries Buytaert
committed
);
Angie Byron
committed
$element['fids'] = array(
Dries Buytaert
committed
'#type' => 'hidden',
Angie Byron
committed
'#value' => $fids,
Dries Buytaert
committed
);
// Add progress bar support to the upload if possible.
if ($element['#progress_indicator'] == 'bar' && $implementation = file_progress_implementation()) {
Dries Buytaert
committed
$upload_progress_key = mt_rand();
Dries Buytaert
committed
if ($implementation == 'uploadprogress') {
$element['UPLOAD_IDENTIFIER'] = array(
'#type' => 'hidden',
'#value' => $upload_progress_key,
'#attributes' => array('class' => array('file-progress')),
catch
committed
// Uploadprogress extension requires this field to be at the top of the
// form.
'#weight' => -20,
Dries Buytaert
committed
);
}
elseif ($implementation == 'apc') {
$element['APC_UPLOAD_PROGRESS'] = array(
'#type' => 'hidden',
'#value' => $upload_progress_key,
'#attributes' => array('class' => array('file-progress')),
catch
committed
// Uploadprogress extension requires this field to be at the top of the
// form.
'#weight' => -20,
Dries Buytaert
committed
);
}
// Add the upload progress callback.
$element['upload_button']['#ajax']['progress']['path'] = 'file/progress/' . $upload_progress_key;
}
// The file upload field itself.
$element['upload'] = array(
Angie Byron
committed
'#name' => 'files[' . $parents_prefix . ']',
Dries Buytaert
committed
'#type' => 'file',
Dries Buytaert
committed
'#title' => t('Choose a file'),
'#title_display' => 'invisible',
Angie Byron
committed
'#size' => $element['#size'],
Angie Byron
committed
'#multiple' => $element['#multiple'],
Dries Buytaert
committed
'#theme_wrappers' => array(),
'#weight' => -10,
);
Angie Byron
committed
if (!empty($fids) && $element['#files']) {
foreach ($element['#files'] as $delta => $file) {
if ($element['#multiple']) {
$element['file_' . $delta]['selected'] = array(
'#type' => 'checkbox',
'#title' => theme('file_link', array('file' => $file)) . ' ',
);
}
else {
$element['file_' . $delta]['filename'] = array(
'#markup' => theme('file_link', array('file' => $file)) . ' ',
'#weight' => -10,
);
}
}
Dries Buytaert
committed
}
Angie Byron
committed
// Add the extension list to the page as JavaScript settings.
Dries Buytaert
committed
if (isset($element['#upload_validators']['file_validate_extensions'][0])) {
Angie Byron
committed
$extension_list = implode(',', array_filter(explode(' ', $element['#upload_validators']['file_validate_extensions'][0])));
$element['upload']['#attached']['js'] = array(
array(
'type' => 'setting',
'data' => array('file' => array('elements' => array('#' . $element['#id'] . '-upload' => $extension_list)))
)
);
Dries Buytaert
committed
}
// Prefix and suffix used for Ajax replacement.
Dries Buytaert
committed
$element['#prefix'] = '<div id="' . $element['#id'] . '-ajax-wrapper">';
$element['#suffix'] = '</div>';
return $element;
}
/**
* Render API callback: Determines the value for a managed_file type element.
*
* This function is assigned as a #value_callback in file_element_info().
Dries Buytaert
committed
*/
function file_managed_file_value(&$element, $input = FALSE, $form_state = NULL) {
Angie Byron
committed
// Find the current value of this field.
$fids = !empty($input['fids']) ? explode(' ', $input['fids']) : array();
foreach ($fids as $key => $fid) {