Newer
Older
/**
* @file
* API for handling file uploads and server file management.
*/
*/
define('FILE_DOWNLOADS_PUBLIC', 1);
define('FILE_DOWNLOADS_PRIVATE', 2);
define('FILE_CREATE_DIRECTORY', 1);
define('FILE_MODIFY_PERMISSIONS', 2);
define('FILE_EXISTS_RENAME', 0);
define('FILE_EXISTS_REPLACE', 1);
define('FILE_EXISTS_ERROR', 2);
/**
* A files status can be one of two values: temporary or permanent. The status
* for each file Drupal manages is stored in the {files} tables. If the status
* is temporary Drupal's file garbage collection will delete the file and
* remove it from the files table after a set period of time.
*
* If you wish to add custom statuses for use by contrib modules please expand as
* binary flags and consider the first 8 bits reserved. (0,1,2,4,8,16,32,64,128)
*/
define('FILE_STATUS_TEMPORARY', 0);
define('FILE_STATUS_PERMANENT', 1);
* @param $path A string containing the path of the file to generate URL for.
* @return A string containing a URL that can be used to download the file.
Jennifer Hodgdon
committed
// Strip file_directory_path from $path. We only include relative paths in URLs.
Dries Buytaert
committed
if (strpos($path, file_directory_path() .'/') === 0) {
$path = trim(substr($path, strlen(file_directory_path())), '\\/');
switch (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC)) {
return $GLOBALS['base_url'] .'/'. file_directory_path() .'/'. str_replace('\\', '/', $path);
return url('system/files/'. $path, array('absolute' => TRUE));
* Make sure the destination is a complete path and resides in the file system
* directory, if it is not prepend the file system directory.
* @param $dest A string containing the path to verify. If this value is
* omitted, Drupal's 'files' directory will be used.
* @return A string containing the path to file, with file system directory
* appended if necessary, or FALSE if the path is invalid (i.e. outside the
* configured 'files' or temp directories).
$file_path = file_directory_path();
return $file_path;
// file_check_location() checks whether the destination is inside the Drupal files directory.
if (file_check_location($dest, $file_path)) {
// check if the destination is instead inside the Drupal temporary files directory.
else if (file_check_location($dest, file_directory_temp())) {
return $dest;
}
// Not found, try again with prefixed directory path.
Dries Buytaert
committed
else if (file_check_location($file_path .'/'. $dest, $file_path)) {
return $file_path .'/'. $dest;
}
// File not found.
return FALSE;
Gábor Hojtsy
committed
* Checks whether a directory exists and is writable.
Gábor Hojtsy
committed
* Furthermore, the directory can optionally be created if it does not exist,
* and/or be set to writable if it is currently not. Directories need to have
* execute permission to be considered a directory by FTP servers.
*
* @param $directory
* A string representing the directory path.
* @param $mode
* An optional bitmask containing the actions, if any, to be carried out on
* the directory. Any combination of the actions FILE_CREATE_DIRECTORY and
* FILE_MODIFY_PERMISSIONS is allowed.
* @param $form_item
* An optional string containing the name of a form item that any errors
* will be attached to. Useful when the function validates a directory path
* entered as a form value. An error will consequently prevent form submit
* handlers from running, and instead display the form along with the
* error messages.
*
* @return
* FALSE if the directory does not exist or is not writable, even after
* any optional actions have been carried out. Otherwise, TRUE is returned.
function file_check_directory(&$directory, $mode = 0, $form_item = NULL) {
if (($mode & FILE_CREATE_DIRECTORY) && @mkdir($directory)) {
drupal_set_message(t('The directory %directory has been created.', array('%directory' => $directory)));
@chmod($directory, 0775); // Necessary for non-webserver users.
form_set_error($form_item, t('The directory %directory does not exist.', array('%directory' => $directory)));
return FALSE;
}
}
// Check to see if the directory is writable.
if (!is_writable($directory)) {
if (($mode & FILE_MODIFY_PERMISSIONS) && @chmod($directory, 0775)) {
drupal_set_message(t('The permissions of directory %directory have been changed to make it writable.', array('%directory' => $directory)));
form_set_error($form_item, t('The directory %directory is not writable', array('%directory' => $directory)));
watchdog('file system', 'The directory %directory is not writable, because it does not have the correct permissions set.', array('%directory' => $directory), WATCHDOG_ERROR);
return FALSE;
if (file_directory_path() == $directory || file_directory_temp() == $directory) {
file_create_htaccess($directory, $form_item);
}
return TRUE;
}
/**
* Creates a .htaccess file in the given directory.
*
* @param $directory
* The directory.
* @param $form_item
* An optional string containing the name of a form item that any errors
* will be attached to. Useful when called from file_check_directory() to
* validate a directory path entered as a form value. An error will
* consequently prevent form submit handlers from running, and instead
* display the form along with the error messages.
* @param $force_overwrite
* Set to TRUE to attempt to overwrite the existing .htaccess file if one is
* already present. Defaults to FALSE.
*/
function file_create_htaccess($directory, $form_item = NULL, $force_overwrite = FALSE) {
if (!is_file("$directory/.htaccess") || $force_overwrite) {
$htaccess_lines = file_htaccess_lines();
if (($fp = fopen("$directory/.htaccess", 'w')) && fputs($fp, $htaccess_lines)) {
Steven Wittens
committed
chmod($directory .'/.htaccess', 0664);
$variables = array('%directory' => $directory, '!htaccess' => '<br />'. nl2br(check_plain($htaccess_lines)));
if ($form_item) {
form_set_error($form_item, t("Security warning: Couldn't write .htaccess file. Please create a .htaccess file in your %directory directory which contains the following lines: <code>!htaccess</code>", $variables));
}
watchdog('security', "Security warning: Couldn't write .htaccess file. Please create a .htaccess file in your %directory directory which contains the following lines: <code>!htaccess</code>", $variables, WATCHDOG_ERROR);
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/**
* Returns the standard .htaccess lines that Drupal writes to file directories.
*
* @return
* A string representing the desired contents of the .htaccess file.
*
* @see file_create_htaccess()
*/
function file_htaccess_lines() {
$lines = <<<EOF
# Turn off all options we don't need.
Options None
Options +FollowSymLinks
# Set the catch-all handler to prevent scripts from being executed.
SetHandler Drupal_Security_Do_Not_Remove_See_SA_2006_006
<Files *>
# Override the handler again if we're run later in the evaluation list.
SetHandler Drupal_Security_Do_Not_Remove_See_SA_2013_003
</Files>
# If we know how to do it safely, disable the PHP engine entirely.
<IfModule mod_php5.c>
php_flag engine off
</IfModule>
# PHP 4, Apache 1.
<IfModule mod_php4.c>
php_flag engine off
</IfModule>
# PHP 4, Apache 2.
<IfModule sapi_apache2.c>
php_flag engine off
</IfModule>
EOF;
return $lines;
}
/**
* Checks path to see if it is a directory, or a dir/file.
*
* @param $path A string containing a file path. This will be set to the
* directory's path.
* @return If the directory is not in a Drupal writable directory, FALSE is
* returned. Otherwise, the base name of the path is returned.
*/
function file_check_path(&$path) {
// Check if path is a directory.
if (file_check_directory($path)) {
return '';
}
// Check if path is a possible dir/file.
$filename = basename($path);
$path = dirname($path);
if (file_check_directory($path)) {
return $filename;
}
return FALSE;
}
/**
* Check if a file is really located inside $directory. Should be used to make
* sure a file specified is really located within the directory to prevent
* exploits.
*
* @code
* // Returns FALSE:
* file_check_location('/www/example.com/files/../../../etc/passwd', '/www/example.com/files');
* @endcode
*
* @param $source A string set to the file to check.
* @param $directory A string where the file should be located.
* @return 0 for invalid path or the real path of the source.
*/
Gerhard Killesreiter
committed
function file_check_location($source, $directory = '') {
$check = realpath($source);
if ($check) {
$source = $check;
}
else {
// This file does not yet exist
$source = realpath(dirname($source)) .'/'. basename($source);
}
Kjartan Mannes
committed
$directory = realpath($directory);
if ($directory && strpos($source, $directory) !== 0) {
return 0;
}
return $source;
}
/**
Gábor Hojtsy
committed
* Copies a file to a new location.
*
* This is a powerful function that in many ways performs like an advanced
* version of copy().
* - Checks if $source and $dest are valid and readable/writable.
* - Performs a file copy if $source is not equal to $dest.
* - If file already exists in $dest either the call will error out, replace the
* file or rename the file based on the $replace parameter.
Gábor Hojtsy
committed
* @param $source
* Either a string specifying the file location of the original file or an
* object containing a 'filepath' property. This parameter is passed by
* reference and will contain the resulting destination filename in case of
Gábor Hojtsy
committed
* @param $dest
* A string containing the directory $source should be copied to. If this
* value is omitted, Drupal's 'files' directory will be used.
* @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
* TRUE for success, FALSE for failure.
function file_copy(&$source, $dest = 0, $replace = FILE_EXISTS_RENAME) {
$dest = file_create_path($dest);
$directory = $dest;
$basename = file_check_path($directory);
// Make sure we at least have a valid directory.
if ($basename === FALSE) {
$source = is_object($source) ? $source->filepath : $source;
drupal_set_message(t('The selected file %file could not be uploaded, because the destination %directory is not properly configured.', array('%file' => $source, '%directory' => $dest)), 'error');
watchdog('file system', 'The selected file %file could not be uploaded, because the destination %directory could not be found, or because its permissions do not allow the file to be written.', array('%file' => $source, '%directory' => $dest), WATCHDOG_ERROR);
return 0;
}
// Process a file upload object.
if (is_object($source)) {
$file = $source;
}
}
$source = realpath($source);
if (!file_exists($source)) {
drupal_set_message(t('The selected file %file could not be copied, because no file by that name exists. Please check that you supplied the correct filename.', array('%file' => $source)), 'error');
// If the destination file is not specified then use the filename of the source file.
// Make sure source and destination filenames are not the same, makes no sense
// to copy it if they are. In fact copying the file will most likely result in
// a 0 byte file. Which is bad. Real bad.
if ($source != realpath($dest)) {
if (!$dest = file_destination($dest, $replace)) {
drupal_set_message(t('The selected file %file could not be copied, because a file by that name already exists in the destination.', array('%file' => $source)), 'error');
return FALSE;
drupal_set_message(t('The selected file %file could not be copied.', array('%file' => $source)), 'error');
// Give everyone read access so that FTP'd users or
// non-webserver users can see/read these files,
// and give group write permissions so group members
// can alter files uploaded by the webserver.
@chmod($dest, 0664);
Steven Wittens
committed
if (isset($file) && is_object($file)) {
/**
* Determines the destination path for a file depending on how replacement of
* existing files should be handled.
*
* @param $destination A string specifying the desired path.
* @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 The destination file path or FALSE if the file already exists and
* FILE_EXISTS_ERROR was specified.
*/
function file_destination($destination, $replace) {
if (file_exists($destination)) {
switch ($replace) {
case FILE_EXISTS_RENAME:
$basename = basename($destination);
$directory = dirname($destination);
$destination = file_create_filename($basename, $directory);
break;
case FILE_EXISTS_ERROR:
Gábor Hojtsy
committed
drupal_set_message(t('The selected file %file could not be copied, because a file by that name already exists in the destination.', array('%file' => $destination)), 'error');
return FALSE;
}
}
return $destination;
}
Gábor Hojtsy
committed
*
* - Checks if $source and $dest are valid and readable/writable.
* - Performs a file move if $source is not equal to $dest.
* - If file already exists in $dest either the call will error out, replace the
* file or rename the file based on the $replace parameter.
*
Gábor Hojtsy
committed
* @param $source
* Either a string specifying the file location of the original file or an
* object containing a 'filepath' property. This parameter is passed by
* reference and will contain the resulting destination filename in case of
Gábor Hojtsy
committed
* @param $dest
* A string containing the directory $source should be copied to. If this
* value is omitted, Drupal's 'files' directory will be used.
* @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
* TRUE for success, FALSE for failure.
*/
function file_move(&$source, $dest = 0, $replace = FILE_EXISTS_RENAME) {
$path_current = is_object($source) ? $source->filepath : $source;
if ($path_original == $path_current || file_delete($path_original)) {
drupal_set_message(t('The removal of the original file %file has failed.', array('%file' => $path_original)), 'error');
/**
* Modify a filename as needed for security purposes.
*
Gábor Hojtsy
committed
* Munging a file name prevents unknown file extensions from masking exploit
* files. When web servers such as Apache decide how to process a URL request,
* they use the file extension. If the extension is not recognized, Apache
* skips that extension and uses the previous file extension. For example, if
* the file being requested is exploit.php.pps, and Apache does not recognize
* the '.pps' extension, it treats the file as PHP and executes it. To make
* this file name safe for Apache and prevent it from executing as PHP, the
* .php extension is "munged" into .php_, making the safe file name
* exploit.php_.pps.
*
* Specifically, this function adds an underscore to all extensions that are
* between 2 and 5 characters in length, internal to the file name, and not
Gábor Hojtsy
committed
* included in $extensions.
*
* Function behavior is also controlled by the Drupal variable
* 'allow_insecure_uploads'. If 'allow_insecure_uploads' evaluates to TRUE, no
* alterations will be made, if it evaluates to FALSE, the filename is 'munged'.
*
* @param $filename
* File name to modify.
* @param $extensions
* A space-separated list of extensions that should not be altered.
* @param $alerts
* If TRUE, drupal_set_message() will be called to display a message if the
* file name was changed.
*
* @return
* The potentially modified $filename.
*/
function file_munge_filename($filename, $extensions, $alerts = TRUE) {
$original = $filename;
// Allow potentially insecure uploads for very savvy users and admin
if (!variable_get('allow_insecure_uploads', 0)) {
// Remove any null bytes. See http://php.net/manual/en/security.filesystem.nullbytes.php
$filename = str_replace(chr(0), '', $filename);
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
$whitelist = array_unique(explode(' ', trim($extensions)));
// Split the filename up by periods. The first part becomes the basename
// the last part the final extension.
$filename_parts = explode('.', $filename);
$new_filename = array_shift($filename_parts); // Remove file basename.
$final_extension = array_pop($filename_parts); // Remove final extension.
// Loop through the middle parts of the name and add an underscore to the
// end of each section that could be a file extension but isn't in the list
// of allowed extensions.
foreach ($filename_parts as $filename_part) {
$new_filename .= '.'. $filename_part;
if (!in_array($filename_part, $whitelist) && preg_match("/^[a-zA-Z]{2,5}\d?$/", $filename_part)) {
$new_filename .= '_';
}
}
$filename = $new_filename .'.'. $final_extension;
if ($alerts && $original != $filename) {
drupal_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $filename)));
}
}
return $filename;
}
/**
* Undo the effect of upload_munge_filename().
*
* @param $filename string filename
* @return string
*/
function file_unmunge_filename($filename) {
return str_replace('_.', '.', $filename);
}
/**
* Create a full file path from a directory and filename. If a file with the
* specified name already exists, an alternative will be used.
*
* @param $basename string filename
* @param $directory string directory
* @return
*/
if (file_exists($dest)) {
// Destination file already exists, generate an alternative.
if ($pos = strrpos($basename, '.')) {
$name = substr($basename, 0, $pos);
$ext = substr($basename, $pos);
}
else {
$name = $basename;
Gábor Hojtsy
committed
$ext = '';
$dest = $directory .'/'. $name .'_'. $counter++ . $ext;
/**
* Delete a file.
*
* @param $path A string containing a file path.
* @return TRUE for success, FALSE for failure.
*/
function file_delete($path) {
if (is_file($path)) {
/**
Gábor Hojtsy
committed
* Determine total disk space used by a single user or the whole filesystem.
*
Gábor Hojtsy
committed
* @param $uid
* An optional user id. A NULL value returns the total space used
* by all files.
*/
function file_space_used($uid = NULL) {
Gábor Hojtsy
committed
if (isset($uid)) {
return (int) db_result(db_query('SELECT SUM(filesize) FROM {files} WHERE uid = %d', $uid));
}
Gábor Hojtsy
committed
return (int) db_result(db_query('SELECT SUM(filesize) FROM {files}'));
}
Gábor Hojtsy
committed
* Saves a file upload to a new location.
Gábor Hojtsy
committed
* The source file is validated as a proper upload and handled as such.
* The file will be added to the files table as a temporary file. Temporary
* files are periodically cleaned. To make the file permanent file call
Dries Buytaert
committed
* file_set_status() to change its status.
*
* @param $source
* A string specifying the name of the upload field to save.
* @param $validators
Gábor Hojtsy
committed
* (optional) An associative array of callback functions used to validate the
* file. The keys are function names and the values arrays of callback
Dries Buytaert
committed
* parameters which will be passed in after the file object. 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.
* @param $dest
* A string containing the directory $source should be copied to. If this is
* not provided or is not writable, the temporary directory will be used.
* @param $replace
Gábor Hojtsy
committed
* 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
* An object containing the file information, or 0 in the event of an error.
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
function file_save_upload($source, $validators = array(), $dest = FALSE, $replace = FILE_EXISTS_RENAME) {
global $user;
static $upload_cache;
// Add in our check of the the file name length.
$validators['file_validate_name_length'] = array();
// 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[$source])) {
return $upload_cache[$source];
}
// If a file was uploaded, process it.
if (isset($_FILES['files']) && $_FILES['files']['name'][$source] && is_uploaded_file($_FILES['files']['tmp_name'][$source])) {
// Check for file upload errors and return FALSE if a
// lower level system error occurred.
switch ($_FILES['files']['error'][$source]) {
// @see http://php.net/manual/en/features.file-upload.errors.php
case UPLOAD_ERR_OK:
break;
case UPLOAD_ERR_INI_SIZE:
case UPLOAD_ERR_FORM_SIZE:
drupal_set_message(t('The file %file could not be saved, because it exceeds %maxsize, the maximum allowed size for uploads.', array('%file' => $source, '%maxsize' => format_size(file_upload_max_size()))), 'error');
return 0;
case UPLOAD_ERR_PARTIAL:
case UPLOAD_ERR_NO_FILE:
drupal_set_message(t('The file %file could not be saved, because the upload did not complete.', array('%file' => $source)), 'error');
return 0;
// Unknown error
default:
drupal_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $source)), 'error');
return 0;
}
// Build the list of non-munged extensions.
// @todo: this should not be here. we need to figure out the right place.
$extensions = '';
foreach ($user->roles as $rid => $name) {
$extensions .= ' '. variable_get("upload_extensions_$rid",
variable_get('upload_extensions_default', 'jpg jpeg gif png txt html doc xls pdf ppt pps odt ods odp'));
}
Dries Buytaert
committed
// Begin building file object.
$file = new stdClass();
$file->filename = file_munge_filename(trim(basename($_FILES['files']['name'][$source]), '.'), $extensions);
$file->filepath = $_FILES['files']['tmp_name'][$source];
// If the destination is not provided, or is not writable, then use the
// temporary directory.
if (empty($dest) || file_check_path($dest) === FALSE) {
$dest = file_directory_temp();
}
$file->source = $source;
Gábor Hojtsy
committed
$file->destination = file_destination(file_create_path($dest .'/'. $file->filename), $replace);
$file->filesize = $_FILES['files']['size'][$source];
// Call the validation functions.
$errors = array();
foreach ($validators as $function => $args) {
array_unshift($args, $file);
Gábor Hojtsy
committed
// Make sure $file is passed around by reference.
$args[0] = &$file;
$errors = array_merge($errors, call_user_func_array($function, $args));
// Rename potentially executable files, to help prevent exploits.
Gábor Hojtsy
committed
if (preg_match('/\.(php|pl|py|cgi|asp|js)$/i', $file->filename) && (substr($file->filename, -4) != '.txt')) {
$file->filemime = 'text/plain';
$file->filepath .= '.txt';
$file->filename .= '.txt';
// As the file may be named example.php.txt, we need to munge again to
// convert to example.php_.txt, then create the correct destination.
$file->filename = file_munge_filename($file->filename, $extensions);
$file->destination = file_destination(file_create_path($dest .'/'. $file->filename), $replace);
}
// Check for validation errors.
if (!empty($errors)) {
$message = t('The selected file %name could not be uploaded.', array('%name' => $file->filename));
if (count($errors) > 1) {
$message .= '<ul><li>'. implode('</li><li>', $errors) .'</li></ul>';
}
else {
Gábor Hojtsy
committed
$message .= ' '. array_pop($errors);
form_set_error($source, $message);
return 0;
// Move uploaded files from PHP's upload_tmp_dir to Drupal's temporary directory.
// This overcomes open_basedir restrictions for future file operations.
$file->filepath = $file->destination;
if (!move_uploaded_file($_FILES['files']['tmp_name'][$source], $file->filepath)) {
form_set_error($source, t('File upload error. Could not move uploaded file.'));
Gábor Hojtsy
committed
watchdog('file', 'Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->filename, '%destination' => $file->filepath));
return 0;
}
// If we made it this far it's safe to record this file in the database.
Dries Buytaert
committed
$file->uid = $user->uid;
$file->status = FILE_STATUS_TEMPORARY;
$file->timestamp = time();
drupal_write_record('files', $file);
// Add file to the cache.
$upload_cache[$source] = $file;
return $file;
/**
* Check for files with names longer than we can store in the database.
*
* @param $file
* A Drupal file object.
* @return
* An array. If the file name is too long, it will contain an error message.
*/
function file_validate_name_length($file) {
$errors = array();
if (strlen($file->filename) > 255) {
$errors[] = t('Its name exceeds the 255 characters limit. Please rename the file and try again.');
}
return $errors;
}
/**
* Check that the filename ends with an allowed extension. This check is not
* enforced for the user #1.
*
* @param $file
* A Drupal file object.
* @param $extensions
Gábor Hojtsy
committed
* A string with a space separated list of allowed file extensions, not
* including the period. For example, 'bmp jpg gif png'.
*
* @return
Gábor Hojtsy
committed
* An array. If the file extension is not allowed, it will contain an error
* message.
*/
function file_validate_extensions($file, $extensions) {
global $user;
$errors = array();
// Bypass validation for uid = 1.
if ($user->uid != 1) {
$regex = '/\.('. @ereg_replace(' +', '|', preg_quote($extensions)) .')$/i';
if (!preg_match($regex, $file->filename)) {
$errors[] = t('Only files with the following extensions are allowed: %files-allowed.', array('%files-allowed' => $extensions));
}
}
return $errors;
}
/**
* Check that the file's size is below certain limits. This check is not
* enforced for the user #1.
*
* @param $file
* A Drupal file object.
* @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
Gábor Hojtsy
committed
* An array. If the file size exceeds limits, it will contain an error message.
*/
function file_validate_size($file, $file_limit = 0, $user_limit = 0) {
global $user;
$errors = array();
// Bypass validation for uid = 1.
if ($user->uid != 1) {
if ($file_limit && $file->filesize > $file_limit) {
$errors[] = t('The file is %filesize exceeding the maximum file size of %maxsize.', array('%filesize' => format_size($file->filesize), '%maxsize' => format_size($file_limit)));
}
// Save a query by only calling file_space_used() when a limit is provided.
if ($user_limit && (file_space_used($user->uid) + $file->filesize) > $user_limit) {
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
$errors[] = t('The file is %filesize which would exceed your disk quota of %quota.', array('%filesize' => format_size($file->filesize), '%quota' => format_size($user_limit)));
}
}
return $errors;
}
/**
* Check that the file is recognized by image_get_info() as an image.
*
* @param $file
* A Drupal file object.
* @return
* An array. If the file is not an image, it will contain an error message.
*/
function file_validate_is_image(&$file) {
$errors = array();
$info = image_get_info($file->filepath);
if (!$info || empty($info['extension'])) {
$errors[] = t('Only JPEG, PNG and GIF images are allowed.');
}
return $errors;
}
/**
* If the file is an image verify that its dimensions are within the specified
* maximum and minimum dimensions. Non-image files will be ignored.
*
* @param $file
* A Drupal file object. 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.
*/
function file_validate_image_resolution(&$file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
$errors = array();
// Check first that the file is an image.
if ($info = image_get_info($file->filepath)) {
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_get_toolkit() && image_scale($file->filepath, $file->filepath, $width, $height)) {
drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
// Clear the cached filesize and refresh the image information.
clearstatcache();
$info = image_get_info($file->filepath);
$file->filesize = $info['file_size'];
}
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;
}
* Save a string to the specified destination.
* @param $data A string containing the contents of the file.
* @param $dest A string containing the destination location.
* @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 A string containing the resulting filename or 0 on error
*/
function file_save_data($data, $dest, $replace = FILE_EXISTS_RENAME) {
$temp = file_directory_temp();
Gábor Hojtsy
committed
// On Windows, tempnam() requires an absolute path, so we use realpath().
$file = tempnam(realpath($temp), 'file');
drupal_set_message(t('The file could not be created.'), 'error');
return 0;
}
fwrite($fp, $data);
fclose($fp);
if (!file_move($file, $dest, $replace)) {
return 0;
}
return $file;
}
/**
* Set the status of a file.
*
* @param $file
* A Drupal file object.
* @param $status
* A status value to set the file to. One of:
* - FILE_STATUS_PERMANENT
* - FILE_STATUS_TEMPORARY
*
* @return FALSE on failure, TRUE on success and $file->status will contain the
* status.
*/
function file_set_status(&$file, $status) {
if (db_query('UPDATE {files} SET status = %d WHERE fid = %d', $status, $file->fid)) {
$file->status = $status;
return TRUE;
}
return FALSE;
}
/**
* Transfer file using http to client. Pipes a file through Drupal to the
* client.
*
* @param $source File to transfer.
* @param $headers An array of http headers to send along with file.
*/
function file_transfer($source, $headers) {
Gábor Hojtsy
committed
if (ob_get_level()) {
ob_end_clean();
}
Gábor Hojtsy
committed
// IE cannot download private files because it cannot store files downloaded
Jennifer Hodgdon
committed
// over HTTPS in the browser cache. The problem can be solved by sending
Gábor Hojtsy
committed
// custom headers to IE. See http://support.microsoft.com/kb/323308/en-us
if (isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] == 'on')) {
drupal_set_header('Cache-Control: private');
drupal_set_header('Pragma: private');
}
// To prevent HTTP header injection, we delete new lines that are
// not followed by a space or a tab.
// See http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
$header = preg_replace('/\r?\n(?!\t| )/', '', $header);
Dries Buytaert
committed
drupal_set_header($header);
}
$source = file_create_path($source);
// Transfer file in 1024 byte chunks to save memory usage.
if ($fd = fopen($source, 'rb')) {
while (!feof($fd)) {
print fread($fd, 1024);
}
fclose($fd);
}
else {
drupal_not_found();
* Call modules that implement hook_file_download() to find out if a file is
Dries Buytaert
committed
* accessible and what headers it should be transferred with. If a module
* returns -1 drupal_access_denied() will be returned. If one or more modules
* returned headers the download will start with the returned headers. If no
* modules respond drupal_not_found() will be returned.
// Merge remainder of arguments from GET['q'], into relative file path.
Gerhard Killesreiter
committed
$args = func_get_args();
$filepath = implode('/', $args);
// Maintain compatibility with old ?file=paths saved in node bodies.
Gerhard Killesreiter
committed
if (isset($_GET['file'])) {
$filepath = $_GET['file'];
}
Dries Buytaert
committed
if (file_exists(file_create_path($filepath))) {
Dries Buytaert
committed
if (count($headers)) {
file_transfer($filepath, $headers);
Dries Buytaert
committed
return drupal_not_found();
/**
* Retrieves headers for a private file download.
*
* Calls all module implementations of hook_file_download() to retrieve headers
* for files by the module that originally provided the file. The presence of
* returned headers indicates the current user has access to the file.
*
* @param $filepath
* The path for the file whose headers should be retrieved.
*
* @return
* If access is allowed, headers for the file, suitable for passing to
* file_transfer(). If access is not allowed, an empty array will be returned.