Common file handling functions.

Constants

Namesort iconLocationDescription
FILE_CREATE_DIRECTORYdrupal/includes/file.incFlag used by file_create_directory() -- create directory if not present.
FILE_DOWNLOADS_PRIVATEdrupal/includes/file.incFlag to indicate that the 'private' file download method is enabled.
FILE_DOWNLOADS_PUBLICdrupal/includes/file.incFlag to indicate that the 'public' file download method is enabled.
FILE_EXISTS_ERRORdrupal/includes/file.incFlag for dealing with existing files: Do nothing and return FALSE.
FILE_EXISTS_RENAMEdrupal/includes/file.incFlag for dealing with existing files: Append number until filename is unique.
FILE_EXISTS_REPLACEdrupal/includes/file.incFlag for dealing with existing files: Replace the existing file.
FILE_MODIFY_PERMISSIONSdrupal/includes/file.incFlag used by file_create_directory() -- file permissions may be changed.
FILE_STATUS_PERMANENTdrupal/includes/file.incFile status -- File has been permanently saved to the {files} tables.
FILE_STATUS_TEMPORARYdrupal/includes/file.incFile status -- File has been temporarily saved to the {files} tables.

Functions

Namesort iconLocationDescription
file_check_directorydrupal/includes/file.incCheck that the directory exists and is writable. Directories need to have execute permissions to be considered a directory by FTP servers, etc.
file_check_locationdrupal/includes/file.incCheck 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_pathdrupal/includes/file.incChecks path to see if it is a directory, or a dir/file.
file_copydrupal/includes/file.incCopies 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_filenamedrupal/includes/file.incCreate 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_pathdrupal/includes/file.incMake 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_urldrupal/includes/file.incCreate the download path to a file.
file_deletedrupal/includes/file.incDelete a file.
file_destinationdrupal/includes/file.incDetermines the destination path for a file depending on how replacement of existing files should be handled.
file_directory_pathdrupal/includes/file.incDetermine the default 'files' directory.
file_directory_tempdrupal/includes/file.incDetermine the default temporary directory.
file_downloaddrupal/includes/file.incCall 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_mimetypedrupal/includes/file.incDetermine an Internet Media Type, or MIME type from a filename.
file_movedrupal/includes/file.incMoves 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_filenamedrupal/includes/file.incMunge the filename as needed for security purposes. For instance the file name "exploit.php.pps" would become "exploit.php_.pps".
file_save_datadrupal/includes/file.incSave a string to the specified destination.
file_save_uploaddrupal/includes/file.incSaves a file upload to a new location. The source file is validated as a proper upload and handled as such.
file_scan_directorydrupal/includes/file.incFinds 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_statusdrupal/includes/file.incSet the status of a file.
file_space_useddrupal/includes/file.incDetermine total disk space used by a single user or the whole filesystem.
file_transferdrupal/includes/file.incTransfer file using http to client. Pipes a file through Drupal to the client.
file_unmunge_filenamedrupal/includes/file.incUndo the effect of upload_munge_filename().
file_upload_max_sizedrupal/includes/file.incDetermine the maximum file upload size by querying the PHP settings.
file_validate_extensionsdrupal/includes/file.incCheck that the filename ends with an allowed extension. This check is not enforced for the user #1.
file_validate_image_resolutiondrupal/includes/file.incIf 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_imagedrupal/includes/file.incCheck that the file is recognized by image_get_info() as an image.
file_validate_name_lengthdrupal/includes/file.incCheck for files with names longer than we can store in the database.
file_validate_sizedrupal/includes/file.incCheck that the file's size is below certain limits. This check is not enforced for the user #1.