file.inc

• Drupal 4.6
• Drupal 4.7
• Drupal 5
• Drupal 6
• Drupal 7

• View documentation
• View source

Version

1.128 (checked in on 2008/08/14 at 12:10:47 by dries)

Description

API for handling file uploads and server file management.

Constants

Name	Description
FILE_CREATE_DIRECTORY	Flag used by file_create_directory() -- create directory if not present.
FILE_DOWNLOADS_PRIVATE	Flag to indicate that the 'private' file download method is enabled.
FILE_DOWNLOADS_PUBLIC	Flag to indicate that the 'public' file download method is enabled.
FILE_EXISTS_ERROR	Flag for dealing with existing files: Do nothing and return FALSE.
FILE_EXISTS_RENAME	Flag for dealing with existing files: Append number until filename is unique.
FILE_EXISTS_REPLACE	Flag for dealing with existing files: Replace the existing file.
FILE_MODIFY_PERMISSIONS	Flag used by file_create_directory() -- file permissions may be changed.
FILE_STATUS_PERMANENT	File status -- File has been permanently saved to the {files} tables.
FILE_STATUS_TEMPORARY	File status -- File has been temporarily saved to the {files} tables.

Functions

Name	Description
file_check_directory	Check that the directory exists and is writable. Directories need to have execute permissions to be considered a directory by FTP servers, etc.
file_check_location	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.
file_check_path	Checks path to see if it is a directory, or a dir/file.
file_copy	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...
file_create_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.
file_create_path	Make sure the destination is a complete path and resides in the file system directory, if it is not prepend the file system directory.
file_create_url	Create the download path to a file.
file_delete	Delete a file.
file_destination	Determines the destination path for a file depending on how replacement of existing files should be handled.
file_directory_path	Determine the default 'files' directory.
file_directory_temp	Determine the default temporary directory.
file_download	Call modules that implement hook_file_download() to find out if a file is 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...
file_get_mimetype	Determine an Internet Media Type, or MIME type from a filename.
file_move	Moves a file to a new location. 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...
file_munge_filename	Munge the filename as needed for security purposes. For instance the file name "exploit.php.pps" would become "exploit.php_.pps".
file_save_data	Save a string to the specified destination.
file_save_upload	Saves a file upload to a new location. The source file is validated as a proper upload and handled as such.
file_scan_directory	Finds all files that match a given mask in a given directory. Directories and files beginning with a period are excluded; this prevents hidden files and directories (such as SVN working directories) from being scanned.
file_set_status	Set the status of a file.
file_space_used	Determine total disk space used by a single user or the whole filesystem.
file_transfer	Transfer file using http to client. Pipes a file through Drupal to the client.
file_unmunge_filename	Undo the effect of upload_munge_filename().
file_upload_max_size	Determine the maximum file upload size by querying the PHP settings.
file_validate_extensions	Check that the filename ends with an allowed extension. This check is not enforced for the user #1.
file_validate_image_resolution	If the file is an image verify that its dimensions are within the specified maximum and minimum dimensions. Non-image files will be ignored.
file_validate_is_image	Check that the file is recognized by image_get_info() as an image.
file_validate_name_length	Check for files with names longer than we can store in the database.
file_validate_size	Check that the file's size is below certain limits. This check is not enforced for the user #1.