- <?php
- * @file
- * API for handling file uploads and server file management.
- */
-
- * Manually include stream wrapper code.
- *
- * Stream wrapper code is included here because there are cases where
- * File API is needed before a bootstrap, or in an alternate order (e.g.
- * maintenance theme).
- */
- require_once BACKDROP_ROOT . '/core/includes/stream_wrappers.inc';
-
- * @defgroup file File interface
- * @{
- * Common file handling functions.
- *
- * Fields on the file entity:
- * - fid: File ID
- * - uid: The {users}.uid of the user who is associated with the file.
- * - filename: Name of the file with no path components. This may differ from
- * the basename of the filepath if the file is renamed to avoid overwriting
- * an existing file.
- * - uri: URI of the file.
- * - filemime: The file's MIME type.
- * - filesize: The size of the file in bytes.
- * - status: A bitmapped field indicating the status of the file. The first 8
- * bits are reserved for Backdrop core. The least significant bit indicates
- * temporary (0) or permanent (1). Temporary files older than
- * BACKDROP_MAXIMUM_TEMP_FILE_AGE will be removed during cron runs.
- * - timestamp: UNIX timestamp for the date the file was added to the database.
- */
-
- * Flag used by file_prepare_directory() -- create directory if not present.
- */
- define('FILE_CREATE_DIRECTORY', 1);
-
- * Flag used by file_prepare_directory() -- file permissions may be changed.
- */
- define('FILE_MODIFY_PERMISSIONS', 2);
-
- * Flag for dealing with existing files: Appends number until name is unique.
- */
- define('FILE_EXISTS_RENAME', 0);
-
- * Flag for dealing with existing files: Replace the existing file.
- */
- define('FILE_EXISTS_REPLACE', 1);
-
- * Flag for dealing with existing files: Do nothing and return FALSE.
- */
- define('FILE_EXISTS_ERROR', 2);
-
- * Indicates that the file is permanent and should not be deleted.
- *
- * Temporary files older than BACKDROP_MAXIMUM_TEMP_FILE_AGE will be removed
- * during cron runs, but permanent files will not be removed during the file
- * garbage collection process.
- */
- define('FILE_STATUS_PERMANENT', 1);
-
- * Provides Backdrop stream wrapper registry.
- *
- * A stream wrapper is an abstraction of a file system that allows Backdrop to
- * use the same set of methods to access both local files and remote resources.
- *
- * Provide a facility for managing and querying user-defined stream wrappers
- * in PHP. PHP's internal stream_get_wrappers() doesn't return the class
- * registered to handle a stream, which we need to be able to find the handler
- * for class instantiation.
- *
- * If a module registers a scheme that is already registered with PHP, the
- * existing scheme will be unregistered and replaced with the specified class.
- *
- * A stream is referenced as "scheme://target".
- *
- * The optional $filter parameter can be used to retrieve only the stream
- * wrappers that are appropriate for particular usage. For example, this returns
- * only stream wrappers that use local file storage:
- * @code
- * $local_stream_wrappers = file_get_stream_wrappers(STREAM_WRAPPERS_LOCAL);
- * @endcode
- *
- * The $filter parameter can only filter to types containing a particular flag.
- * In some cases, you may want to filter to types that do not contain a
- * particular flag. For example, you may want to retrieve all stream wrappers
- * that are not writable, or all stream wrappers that are not local. PHP's
- * array_diff_key() function can be used to help with this. For example, this
- * returns only stream wrappers that do not use local file storage:
- * @code
- * $remote_stream_wrappers = array_diff_key(file_get_stream_wrappers(STREAM_WRAPPERS_ALL), file_get_stream_wrappers(STREAM_WRAPPERS_LOCAL));
- * @endcode
- *
- * @param $filter
- * (Optional) Filters out all types except those with an on bit for each on
- * bit in $filter. For example, if $filter is STREAM_WRAPPERS_WRITE_VISIBLE,
- * which is equal to (STREAM_WRAPPERS_READ | STREAM_WRAPPERS_WRITE |
- * STREAM_WRAPPERS_VISIBLE), then only stream wrappers with all three of these
- * bits set are returned. Defaults to STREAM_WRAPPERS_ALL, which returns all
- * registered stream wrappers.
- *
- * @return
- * An array keyed by scheme, with values containing an array of information
- * about the stream wrapper, as returned by hook_stream_wrappers(). If $filter
- * is omitted or set to STREAM_WRAPPERS_ALL, the entire Backdrop stream wrapper
- * registry is returned. Otherwise only the stream wrappers whose 'type'
- * bitmask has an on bit for each bit specified in $filter are returned.
- *
- * @see hook_stream_wrappers()
- * @see hook_stream_wrappers_alter()
- */
- function file_get_stream_wrappers($filter = STREAM_WRAPPERS_ALL) {
- $wrappers_storage = &backdrop_static(__FUNCTION__);
-
- if (!isset($wrappers_storage)) {
- $wrappers = module_invoke_all('stream_wrappers');
- foreach ($wrappers as $scheme => $info) {
-
- $wrappers[$scheme] += array('type' => STREAM_WRAPPERS_NORMAL);
- }
- backdrop_alter('stream_wrappers', $wrappers);
- $existing = stream_get_wrappers();
- foreach ($wrappers as $scheme => $info) {
-
- if (in_array('BackdropStreamWrapperInterface', class_implements($info['class']), TRUE)) {
-
- if (in_array($scheme, $existing, TRUE)) {
- $wrappers[$scheme]['override'] = TRUE;
- stream_wrapper_unregister($scheme);
- }
- else {
- $wrappers[$scheme]['override'] = FALSE;
- }
- if (($info['type'] & STREAM_WRAPPERS_LOCAL) == STREAM_WRAPPERS_LOCAL) {
- stream_wrapper_register($scheme, $info['class']);
- }
- else {
- stream_wrapper_register($scheme, $info['class'], STREAM_IS_URL);
- }
- }
-
- $wrappers_storage[STREAM_WRAPPERS_ALL][$scheme] = $wrappers[$scheme];
- if (($info['type'] & STREAM_WRAPPERS_WRITE_VISIBLE) == STREAM_WRAPPERS_WRITE_VISIBLE) {
- $wrappers_storage[STREAM_WRAPPERS_WRITE_VISIBLE][$scheme] = $wrappers[$scheme];
- }
- }
- }
-
- if (!isset($wrappers_storage[$filter])) {
- $wrappers_storage[$filter] = array();
- foreach ($wrappers_storage[STREAM_WRAPPERS_ALL] as $scheme => $info) {
-
- if (($info['type'] & $filter) == $filter) {
- $wrappers_storage[$filter][$scheme] = $info;
- }
- }
- }
-
- return $wrappers_storage[$filter];
- }
-
- * Returns the stream wrapper class name for a given scheme.
- *
- * @param $scheme
- * Stream scheme.
- *
- * @return
- * Return string if a scheme has a registered handler, or FALSE.
- */
- function file_stream_wrapper_get_class($scheme) {
- $wrappers = file_get_stream_wrappers();
- return empty($wrappers[$scheme]) ? FALSE : $wrappers[$scheme]['class'];
- }
-
- * Returns the scheme of a URI (e.g. a stream).
- *
- * @param $uri
- * A stream, referenced as "scheme://target".
- *
- * @return
- * A string containing the name of the scheme, or FALSE if none. For example,
- * the URI "public://example.txt" would return "public".
- *
- * @see file_uri_target()
- */
- function file_uri_scheme($uri) {
- $position = strpos($uri, '://');
- return $position ? substr($uri, 0, $position) : FALSE;
- }
-
- * Checks that the scheme of a stream URI is valid.
- *
- * Confirms that there is a registered stream handler for the provided scheme
- * and that it is callable. This is useful if you want to confirm a valid
- * scheme without creating a new instance of the registered handler.
- *
- * @param $scheme
- * A URI scheme, a stream is referenced as "scheme://target".
- *
- * @return
- * Returns TRUE if the string is the name of a validated stream,
- * or FALSE if the scheme does not have a registered handler.
- */
- function file_stream_wrapper_valid_scheme($scheme) {
-
- $class = file_stream_wrapper_get_class($scheme);
- if (class_exists($class)) {
- return TRUE;
- }
- else {
- return FALSE;
- }
- }
-
-
- * Returns the part of a URI after the schema.
- *
- * @param $uri
- * A stream, referenced as "scheme://target".
- *
- * @return
- * A string containing the target (path), or FALSE if none.
- * For example, the URI "public://sample/test.txt" would return
- * "sample/test.txt".
- *
- * @see file_uri_scheme()
- */
- function file_uri_target($uri) {
- $data = explode('://', $uri, 2);
-
-
- return count($data) == 2 ? trim($data[1], '\/') : FALSE;
- }
-
- * Gets the default file stream implementation.
- *
- * @return
- * 'public', 'private' or any other file scheme defined as the default.
- */
- function file_default_scheme() {
- try {
- $scheme = config_get('system.core', 'file_default_scheme');
- }
- catch (ConfigException $e) {}
- if (empty($scheme)) {
- $scheme = 'public';
- }
- return $scheme;
- }
-
- * Normalizes a URI by making it syntactically correct.
- *
- * A stream is referenced as "scheme://target".
- *
- * The following actions are taken:
- * - Remove trailing slashes from target
- * - Trim erroneous leading slashes from target. e.g. ":///" becomes "://".
- *
- * @param $uri
- * String reference containing the URI to normalize.
- *
- * @return
- * The normalized URI.
- */
- function file_stream_wrapper_uri_normalize($uri) {
-
- $position = strpos($uri, '://');
- $scheme = $position ? substr($uri, 0, $position) : FALSE;
-
- if ($scheme && file_stream_wrapper_valid_scheme($scheme)) {
- $target = file_uri_target($uri);
-
- if ($target !== FALSE) {
- $uri = $scheme . '://' . $target;
- }
- }
-
- return $uri;
- }
-
- * Returns a reference to the stream wrapper class responsible for a given URI.
- *
- * The scheme determines the stream wrapper class that should be
- * used by consulting the stream wrapper registry.
- *
- * @param $uri
- * A stream, referenced as "scheme://target".
- *
- * @return BackdropStreamWrapperInterface
- * Returns a new stream wrapper object appropriate for the given URI or FALSE
- * if no registered handler could be found. For example, a URI of
- * "private://example.txt" would return a new private stream wrapper object
- * (BackdropPrivateStreamWrapper).
- */
- function file_stream_wrapper_get_instance_by_uri($uri) {
- $scheme = file_uri_scheme($uri);
- if (!$scheme || !file_stream_wrapper_valid_scheme($scheme)) {
- return FALSE;
- }
-
- $class = file_stream_wrapper_get_class($scheme);
- if (class_exists($class)) {
-
- $instance = new $class();
- $instance->setUri($uri);
- return $instance;
- }
- else {
- return FALSE;
- }
- }
-
- * Returns a reference to the stream wrapper class responsible for a scheme.
- *
- * This helper method returns a stream instance using a scheme. That is, the
- * passed string does not contain a "://". For example, "public" is a scheme
- * but "public://" is a URI (stream). This is because the later contains both
- * a scheme and target despite target being empty.
- *
- * Note: the instance URI will be initialized to "scheme://" so that you can
- * make the customary method calls as if you had retrieved an instance by URI.
- *
- * @param $scheme
- * If the stream was "public://target", "public" would be the scheme.
- *
- * @return BackdropLocalStreamWrapper|BackdropStreamWrapperInterface|FALSE
- * Returns a new stream wrapper object appropriate for the given $scheme.
- * For example, for the public scheme a stream wrapper object
- * (BackdropPublicStreamWrapper).
- * FALSE is returned if no registered handler could be found.
- */
- function file_stream_wrapper_get_instance_by_scheme($scheme) {
- $class = file_stream_wrapper_get_class($scheme);
- if (class_exists($class)) {
-
- $instance = new $class();
- $instance->setUri($scheme . '://');
- return $instance;
- }
- else {
- return FALSE;
- }
- }
-
- * Creates a web-accessible URL for a stream to an external or local file.
- *
- * Compatibility: normal paths and stream wrappers.
- *
- * There are two kinds of local files:
- * - "managed files", i.e. those stored by a Backdrop-compatible stream wrapper.
- * These are files that have either been uploaded by users or were generated
- * automatically (for example through CSS aggregation).
- * - "shipped files", i.e. those outside of the files directory, which ship as
- * part of Backdrop core or contributed modules or themes.
- *
- * @param $uri
- * The URI to a file for which we need an external URL, or the path to a
- * shipped file.
- *
- * @return
- * A string containing a URL that may be used to access the file.
- * If the provided string already contains a preceding 'http', 'https', or
- * '/', nothing is done and the same string is returned. If a stream wrapper
- * could not be found to generate an external URL, then FALSE is returned.
- *
- * @see http://drupal.org/node/515192
- */
- function file_create_url($uri) {
-
-
- backdrop_alter('file_url', $uri);
-
- $scheme = file_uri_scheme($uri);
-
- if (!$scheme) {
-
-
-
-
-
-
-
- if (backdrop_substr($uri, 0, 1) == '/') {
- return $uri;
- }
- else {
-
-
- return $GLOBALS['base_url'] . '/' . backdrop_encode_path($uri);
- }
- }
- elseif ($scheme == 'http' || $scheme == 'https') {
-
-
- return $uri;
- }
- else {
-
- if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
- return $wrapper->getExternalUrl();
- }
- else {
- return FALSE;
- }
- }
- }
-
- * Checks that the directory exists and is writable.
- *
- * Directories need to have execute permissions to be considered a directory by
- * FTP servers, etc.
- *
- * @param $directory
- * A string reference containing the name of a directory path or URI. A
- * trailing slash will be trimmed from a path.
- * @param $options
- * A bitmask to indicate if the directory should be created if it does
- * not exist (FILE_CREATE_DIRECTORY) or made writable if it is read-only
- * (FILE_MODIFY_PERMISSIONS).
- *
- * @return
- * TRUE if the directory exists (or was created) and is writable. FALSE
- * otherwise.
- */
- function file_prepare_directory(&$directory, $options = FILE_MODIFY_PERMISSIONS) {
- $scheme = file_uri_scheme($directory);
- if (!$scheme || !file_stream_wrapper_valid_scheme($scheme)) {
-
- $directory = rtrim($directory, '/\\');
- }
-
-
- if (!is_dir($directory)) {
-
-
- if (($options & FILE_CREATE_DIRECTORY) && @backdrop_mkdir($directory, NULL, TRUE)) {
- return backdrop_chmod($directory);
- }
- return FALSE;
- }
-
- $writable = is_writable($directory);
- if (!$writable && ($options & FILE_MODIFY_PERMISSIONS)) {
- return backdrop_chmod($directory);
- }
-
- return $writable;
- }
-
- * Creates a .htaccess file in each files directory if it is missing.
- */
- function file_ensure_htaccess() {
-
- if (!backdrop_is_apache()) {
- return;
- }
-
- file_save_htaccess('public://', FALSE);
- if (config_get('system.core', 'file_private_path')) {
- file_save_htaccess('private://', TRUE);
- }
- file_save_htaccess('temporary://', TRUE);
- }
-
- * Creates a .htaccess file in the given directory.
- *
- * @param $directory
- * The directory.
- * @param $private
- * FALSE indicates that $directory should be an open and public directory.
- * The default is TRUE which indicates a private and protected directory.
- * @param $force_overwrite
- * Set to TRUE to attempt to overwrite the existing .htaccess file if one is
- * already present. Defaults to FALSE.
- */
- function file_save_htaccess($directory, $private = TRUE, $force_overwrite = FALSE) {
- if (file_uri_scheme($directory)) {
- $directory = file_stream_wrapper_uri_normalize($directory);
- }
- else {
- $directory = rtrim($directory, '/\\');
- }
- $htaccess_path = $directory . '/.htaccess';
-
- if (file_exists($htaccess_path) && !$force_overwrite) {
-
- return;
- }
-
- $htaccess_lines = file_htaccess_lines($private);
-
-
- if (file_put_contents($htaccess_path, $htaccess_lines)) {
- backdrop_chmod($htaccess_path, 0444);
- }
- else {
- $variables = array('%directory' => $directory, '!htaccess' => '<br />' . nl2br(check_plain($htaccess_lines)));
- 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);
- }
- }
-
- * Returns the standard .htaccess lines that Backdrop adds to file directories.
- *
- * @param $private
- * (Optional) Set to FALSE to return the .htaccess lines for an open and
- * public directory. The default is TRUE, which returns the .htaccess lines
- * for a private and protected directory.
- *
- * @return
- * A string representing the desired contents of the .htaccess file.
- *
- * @see file_save_htaccess()
- */
- function file_htaccess_lines($private = TRUE) {
- $lines = <<<EOF
- # Turn off all options we don't need.
- Options -Indexes -ExecCGI -Includes
-
- # 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>
- <IfModule mod_php7.c>
- php_flag engine off
- </IfModule>
- EOF;
-
- if ($private) {
- $lines .= <<<EOF
-
- # Deny all requests from Apache 2.4+.
- <IfModule mod_authz_core.c>
- Require all denied
- </IfModule>
-
- # Deny all requests from Apache 2.0-2.2.
- <IfModule !mod_authz_core.c>
- Deny from all
- </IfModule>
-
- EOF;
- }
-
- return $lines;
- }
-
- * Loads file entities from the database.
- *
- * @param $fids
- * An array of file IDs.
- * @param $conditions
- * (deprecated) An associative array of conditions on the {file_managed}
- * table, where the keys are the database fields and the values are the
- * values those fields must have. Instead, it is preferable to use
- * EntityFieldQuery to retrieve a list of entity IDs loadable by
- * this function.
- *
- * @return File[]
- * An array of file entities, indexed by fid.
- *
- * @see hook_file_load()
- * @see file_load()
- * @see entity_load()
- * @see EntityFieldQuery
- */
- function file_load_multiple($fids = array(), $conditions = array()) {
- return entity_load('file', $fids, $conditions);
- }
-
- * Loads a single file entity from the database.
- *
- * @param $fid
- * A file ID.
- *
- * @return File
- * A file entity or FALSE if the file was not found.
- *
- * @see hook_file_load()
- * @see file_load_multiple()
- */
- function file_load($fid) {
- $files = file_load_multiple(array($fid), array());
- return reset($files);
- }
-
- * Saves a new or updated file.
- *
- * @param File $file
- * A file object returned by file_load(). If the $file->fid is not set a new
- * record will be added.
- *
- * @return int
- * Either SAVED_NEW or SAVED_UPDATED depending on the operation performed.
- *
- * @see hook_file_insert()
- * @see hook_file_update()
- */
- function file_save(File $file) {
- return $file->save();
- }
-
- * Determines where a file is used.
- *
- * @param $file
- * A file entity.
- *
- * @return
- * A nested array with usage data. The first level is keyed by module name,
- * the second by object type and the third by the object id. The value
- * of the third level contains the usage count.
- *
- * @see file_usage_add()
- * @see file_usage_delete()
- */
- function file_usage_list(File $file) {
- $result = db_select('file_usage', 'f')
- ->fields('f', array('module', 'type', 'id', 'count'))
- ->condition('fid', $file->fid)
- ->condition('count', 0, '>')
- ->execute();
- $references = array();
- foreach ($result as $usage) {
- $references[$usage->module][$usage->type][$usage->id] = $usage->count;
- }
- return $references;
- }
-
- * Records that a module is using a file.
- *
- * Examples:
- * - A module that associates files with nodes, so $type would be
- * 'node' and $id would be the node's nid. Files for all revisions are stored
- * within a single nid.
- * - The User module associates an image with a user, so $type would be 'user'
- * and the $id would be the user's uid.
- *
- * @param File $file
- * A file entity.
- * @param $module
- * The name of the module using the file.
- * @param $type
- * The type of the object that contains the referenced file.
- * @param $id
- * The unique, numeric ID of the object containing the referenced file.
- * @param $count
- * (optional) The number of references to add to the object. Defaults to 1.
- *
- * @see file_usage_list()
- * @see file_usage_delete()
- */
- function file_usage_add(File $file, $module, $type, $id, $count = 1) {
- db_merge('file_usage')
- ->key(array(
- 'fid' => $file->fid,
- 'module' => $module,
- 'type' => $type,
- 'id' => $id,
- ))
- ->fields(array('count' => $count))
- ->expression('count', 'count + :count', array(':count' => $count))
- ->execute();
-
-
- if ($file->status != FILE_STATUS_PERMANENT) {
- $file->status = FILE_STATUS_PERMANENT;
- $file->save();
- }
- }
-
- * Removes a record to indicate that a module is no longer using a file.
- *
- * @param File $file
- * A file entity.
- * @param $module
- * The name of the module using the file.
- * @param $type
- * (optional) The type of the object that contains the referenced file. May
- * be omitted if all module references to a file are being deleted.
- * @param $id
- * (optional) The unique, numeric ID of the object containing the referenced
- * file. May be omitted if all module references to a file are being deleted.
- * @param $count
- * (optional) The number of references to delete from the object. Defaults to
- * 1. 0 may be specified to delete all references to the file within a
- * specific object.
- *
- * @see file_usage_add()
- * @see file_usage_list()
- */
- function file_usage_delete(File $file, $module, $type = NULL, $id = NULL, $count = 1) {
-
- $query = db_delete('file_usage')
- ->condition('module', $module)
- ->condition('fid', $file->fid);
- if ($type && $id) {
- $query
- ->condition('type', $type)
- ->condition('id', $id);
- }
- if ($count) {
- $query->condition('count', $count, '<=');
- }
- $result = $query->execute();
-
-
- if (!$result && $count > 0) {
- $query = db_update('file_usage')
- ->condition('module', $module)
- ->condition('fid', $file->fid);
- if ($type && $id) {
- $query
- ->condition('type', $type)
- ->condition('id', $id);
- }
- $query->expression('count', 'count - :count', array(':count' => $count));
- $query->execute();
- }
-
-
-
- $usage = file_usage_list($file);
- if (empty($usage)) {
- $file->status = 0;
- $file->save();
- }
- }
-
- * 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.
- * - If the $source and $destination are equal, the behavior depends on the
- * $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
- * will rename the file until the $destination is unique.
- * - 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 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 = backdrop_realpath($source->uri)) !== 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->uri, '%realpath' => $realpath, '%destination' => $destination));
- }
- 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->uri, '%destination' => $destination));
- }
- backdrop_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->uri)), 'error');
- return FALSE;
- }
-
- if ($uri = file_unmanaged_copy($source->uri, $destination, $replace)) {
- $file = clone $source;
- $file->fid = NULL;
- $file->uri = $uri;
- $file->filename = backdrop_basename($uri);
-
- if ($replace == FILE_EXISTS_REPLACE) {
- $existing_files = file_load_multiple(array(), array('uri' => $uri));
- if (count($existing_files)) {
- $existing = reset($existing_files);
- $file->fid = $existing->fid;
- $file->filename = $existing->filename;
- }
- }
-
-
- elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
- $file->filename = backdrop_basename($destination);
- }
-
- $file->save();
-
-
- module_invoke_all('file_copy', $file, $source);
-
- return $file;
- }
- return FALSE;
- }
-
- * Determines whether the URI has a valid scheme for file API operations.
- *
- * There must be a scheme and it must be a Backdrop-provided scheme like
- * 'public', 'private', 'temporary', or an extension provided with
- * hook_stream_wrappers().
- *
- * @param $uri
- * The URI to be tested.
- *
- * @return
- * TRUE if the URI is allowed.
- */
- function file_valid_uri($uri) {
-
- $uri_scheme = file_uri_scheme($uri);
- if (empty($uri_scheme) || !file_stream_wrapper_valid_scheme($uri_scheme)) {
- return FALSE;
- }
- return TRUE;
- }
-
- * Copies a file to a new location without database changes or hook invocation.
- *
- * 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.
- * - If the $source and $destination are equal, the behavior depends on the
- * $replace parameter. FILE_EXISTS_REPLACE will error out. FILE_EXISTS_RENAME
- * will rename the file until the $destination is unique.
- * - Works around a PHP 5.3 bug where copy() does not properly support streams
- * if safe_mode or open_basedir are enabled.
- * @see https://bugs.php.net/bug.php?id=60456
- *
- * @param $source
- * A string specifying the filepath or URI of the source file.
- * @param $destination
- * A URI containing the destination that $source should be copied to. The
- * URI may be a bare filepath (without a scheme). If this value is omitted,
- * Backdrop's default files scheme will be used, usually "public://".
- * @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 path to the new file, or FALSE in the event of an error.
- *
- * @see file_copy()
- */
- function file_unmanaged_copy($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
- if (!file_unmanaged_prepare($source, $destination, $replace)) {
- return FALSE;
- }
-
-
- $real_source = ($real_source = backdrop_realpath($source)) ? $real_source : $source;
- $real_destination = ($real_destination = backdrop_realpath($destination)) ? $real_destination : $destination;
-
- if (!@copy($real_source, $real_destination)) {
- watchdog('file', 'The specified file %file could not be copied to %destination.', array('%file' => $source, '%destination' => $destination), WATCHDOG_ERROR);
- return FALSE;
- }
-
- backdrop_chmod($destination);
- return $destination;
- }
-
- * Internal function that prepares the destination for a file_unmanaged_copy or
- * file_unmanaged_move operation.
- *
- * - 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.
- *
- * @param $source
- * A string specifying the filepath or URI of the source file.
- * @param $destination
- * A URI containing the destination that $source should be moved/copied to.
- * The URI may be a bare filepath (without a scheme) and in that case the
- * default scheme (file://) will be used. If this value is omitted, Backdrop's
- * default files scheme will be used, usually "public://".
- * @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, or FALSE in the event of an error.
- *
- * @see file_unmanaged_copy()
- * @see file_unmanaged_move()
- */
- function file_unmanaged_prepare($source, &$destination = NULL, $replace = FILE_EXISTS_RENAME) {
- $original_source = $source;
-
-
- if (!file_exists($source)) {
-
- backdrop_set_message(t('The specified file %file could not be moved/copied because no file by that name exists. Please check that you supplied the correct filename.', array('%file' => $original_source)), 'error');
- if (($realpath = backdrop_realpath($original_source)) !== FALSE) {
- watchdog('file', 'File %file (%realpath) could not be copied because it does not exist.', array('%file' => $original_source, '%realpath' => $realpath));
- }
- else {
- watchdog('file', 'File %file could not be moved/copied because it does not exist.', array('%file' => $original_source));
- }
- return FALSE;
- }
-
-
- if (!isset($destination)) {
- $destination = file_build_uri(backdrop_basename($source));
- }
-
-
- if (file_prepare_directory($destination)) {
-
- $destination = file_stream_wrapper_uri_normalize($destination . '/' . backdrop_basename($source));
- }
- else {
-
- $dirname = backdrop_dirname($destination);
- if (!file_prepare_directory($dirname)) {
-
- watchdog('file', 'File %file could not be moved/copied because the destination directory %destination is not configured correctly.', array('%file' => $original_source, '%destination' => $dirname));
- backdrop_set_message(t('The specified file %file could not be moved/copied because the destination directory is not properly configured. This may be caused by a problem with file or directory permissions. More information is available in the system log.', array('%file' => $original_source)), 'error');
- return FALSE;
- }
- }
-
-
- $destination = file_destination($destination, $replace);
- if ($destination === FALSE) {
- backdrop_set_message(t('The file %file could not be moved/copied because a file by that name already exists in the destination directory.', array('%file' => $original_source)), 'error');
- watchdog('file', 'File %file could not be moved/copied because a file by that name already exists in the destination directory (%directory)', array('%file' => $original_source, '%directory' => $destination));
- return FALSE;
- }
-
-
- $real_source = backdrop_realpath($source);
- $real_destination = backdrop_realpath($destination);
- if ($source == $destination || ($real_source !== FALSE) && ($real_source == $real_destination)) {
- backdrop_set_message(t('The specified file %file was not moved/copied because it would overwrite itself.', array('%file' => $source)), 'error');
- watchdog('file', 'File %file could not be moved/copied because it would overwrite itself.', array('%file' => $source));
- return FALSE;
- }
-
- file_ensure_htaccess();
-
- return TRUE;
- }
-
- * Constructs a URI to Backdrop's default files location given a relative path.
- */
- function file_build_uri($path) {
- $uri = file_default_scheme() . '://' . $path;
- return file_stream_wrapper_uri_normalize($uri);
- }
-
- * Determines the destination path for a file.
- *
- * @param $destination
- * A string specifying the desired final URI or filepath.
- * @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 filepath, or FALSE if the file already exists
- * and FILE_EXISTS_ERROR is specified.
- *
- * @throws RuntimeException
- * Thrown if the filename contains invalid UTF-8.
- */
- function file_destination($destination, $replace) {
- $basename = backdrop_basename($destination);
- if (!backdrop_validate_utf8($basename)) {
- throw new RuntimeException(sprintf("Invalid filename '%s'", $basename));
- }
- if (file_exists($destination)) {
- switch ($replace) {
- case FILE_EXISTS_REPLACE:
-
- break;
-
- case FILE_EXISTS_RENAME:
- $directory = backdrop_dirname($destination);
- $destination = file_create_filename($basename, $directory);
- break;
-
- case FILE_EXISTS_ERROR:
-
- return FALSE;
- }
- }
- return $destination;
- }
-
- * Moves a file to a new location and update the file's database entry.
- *
- * - 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 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 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 = backdrop_realpath($source->uri)) !== 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->uri, '%realpath' => $realpath, '%destination' => $destination));
- }
- 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->uri, '%destination' => $destination));
- }
- backdrop_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->uri)), 'error');
- return FALSE;
- }
-
- if ($uri = file_unmanaged_move($source->uri, $destination, $replace)) {
- $delete_source = FALSE;
-
- $file = clone $source;
- $file->uri = $uri;
-
- if ($replace == FILE_EXISTS_REPLACE) {
- $existing_files = file_load_multiple(array(), array('uri' => $uri));
- if (count($existing_files)) {
- $existing = reset($existing_files);
- $delete_source = TRUE;
- $file->fid = $existing->fid;
- }
- }
-
-
- elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
- $file->filename = backdrop_basename($destination);
- }
-
- $file->save();
-
-
- module_invoke_all('file_move', $file, $source);
-
-
- if ($delete_source && !file_usage_list($source)) {
- $source->delete();
- }
-
- return $file;
- }
- return FALSE;
- }
-
- * Moves a file to a new location without database changes or hook invocation.
- * This is a powerful function that in many ways performs like an advanced
- * version of rename().
- * - 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.
- * - Works around a PHP 5.3 bug where rename() does not properly support streams
- * if safe_mode or open_basedir are enabled.
- * @see https://bugs.php.net/bug.php?id=60456
- *
- * @param $source
- * A string specifying the filepath or URI of the source file.
- * @param $destination
- * A URI containing the destination that $source should be moved to. The
- * URI may be a bare filepath (without a scheme) and in that case the default
- * scheme (file://) will be used. If this value is omitted, Backdrop's default
- * files scheme will be used, usually "public://".
- * @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 path to the new file, or FALSE in the event of an error.
- *
- * @see file_move()
- */
- function file_unmanaged_move($source, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
- if (!file_unmanaged_prepare($source, $destination, $replace)) {
- return FALSE;
- }
-
- backdrop_chmod($source);
-
-
- $real_source = ($real_source = backdrop_realpath($source)) ? $real_source : $source;
- $real_destination = ($real_destination = backdrop_realpath($destination)) ? $real_destination : $destination;
-
- if (!@rename($real_source, $real_destination)) {
-
-
-
- if (!@copy($real_source, $real_destination) || !@unlink($real_source)) {
- watchdog('file', 'The specified file %file could not be moved to %destination.', array('%file' => $source, '%destination' => $destination), WATCHDOG_ERROR);
- return FALSE;
- }
- }
-
- backdrop_chmod($destination);
- return $destination;
- }
-
- * Modifies a filename as needed for security purposes.
- *
- * 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 either
- * included in the list of unsafe extensions, or not included in $extensions.
- *
- * Function behavior is also controlled by the Backdrop 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. Note that
- * extensions that are unsafe will be altered regardless of this parameter.
- * @param $alerts
- * If TRUE, backdrop_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;
-
-
- if (!settings_get('allow_insecure_uploads', 0)) {
-
- $filename = str_replace(chr(0), '', $filename);
-
- $whitelist = array_unique(explode(' ', strtolower(trim($extensions))));
-
-
-
- $whitelist = array_diff($whitelist, explode('|', 'php|phar|pl|py|cgi|asp|js'));
-
-
-
- $filename_parts = explode('.', $filename);
- $new_filename = array_shift($filename_parts);
- $final_extension = array_pop($filename_parts);
-
-
-
-
- foreach ($filename_parts as $filename_part) {
- $new_filename .= '.' . $filename_part;
- if (!in_array(strtolower($filename_part), $whitelist) && preg_match("/^[a-zA-Z]{2,5}\d?$/", $filename_part)) {
- $new_filename .= '_';
- }
- }
- $filename = $new_filename . '.' . $final_extension;
-
- if ($alerts && $original != $filename) {
- backdrop_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $filename)));
- }
- }
-
- return $filename;
- }
-
- * Undoes the effect of file_munge_filename().
- *
- * @param $filename
- * String with the filename to be unmunged.
- *
- * @return
- * An unmunged filename string.
- */
- function file_unmunge_filename($filename) {
- return str_replace('_.', '.', $filename);
- }
-
- * Creates 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 containing the directory or parent URI.
- *
- * @return
- * File path consisting of $directory and a unique filename based off
- * of $basename.
- *
- * @throws RuntimeException
- * Thrown if the $basename is not valid UTF-8 or another error occurs
- * stripping control characters.
- */
- function file_create_filename($basename, $directory) {
- $original = $basename;
-
-
- $basename = preg_replace('/[\x00-\x1F]/u', '_', $basename);
- if (preg_last_error() !== PREG_NO_ERROR) {
- throw new RuntimeException(sprintf("Invalid filename '%s'", $original));
- }
-
- if (substr(PHP_OS, 0, 3) == 'WIN') {
-
- $basename = str_replace(array(':', '*', '?', '"', '<', '>', '|'), '_', $basename);
- }
-
-
- if (substr($directory, -1) == '/') {
- $separator = '';
- }
- else {
- $separator = '/';
- }
-
- $destination = $directory . $separator . $basename;
-
- if (file_exists($destination)) {
-
- $pos = strrpos($basename, '.');
- if ($pos !== FALSE) {
- $name = substr($basename, 0, $pos);
- $ext = substr($basename, $pos);
- }
- else {
- $name = $basename;
- $ext = '';
- }
-
- $counter = 0;
- do {
- $destination = $directory . $separator . $name . '_' . $counter++ . $ext;
- } while (file_exists($destination));
- }
-
- return $destination;
- }
-
- * Deletes a file and its database record.
- *
- * Instead of directly deleting a file, it is strongly recommended to delete
- * file usages instead. That will automatically mark the file as temporary and
- * remove it during cleanup.
- *
- * @param $fid
- * The file id.
- *
- * @see file_unmanaged_delete()
- * @see file_usage_list()
- */
- function file_delete($fid) {
- file_delete_multiple(array($fid));
- }
-
- * Deletes files.
- *
- * Instead of directly deleting a file, it is strongly recommended to delete
- * file usages instead. That will automatically mark the file as temporary and
- * remove it during cleanup.
- *
- * @param $fid
- * The file ID.
- *
- * @see file_unmanaged_delete()
- * @see file_usage_list()
- */
- function file_delete_multiple(array $fids) {
- entity_delete_multiple('file', $fids);
- }
-
- * Deletes a file without database changes or hook invocations.
- *
- * This function should be used when the file to be deleted does not have an
- * entry recorded in the files table.
- *
- * @param $path
- * A string containing a file path or (streamwrapper) URI.
- *
- * @return
- * TRUE for success or path does not exist, or FALSE in the event of an
- * error.
- *
- * @see file_delete()
- * @see file_unmanaged_delete_recursive()
- */
- function file_unmanaged_delete($path) {
- if (is_dir($path)) {
- watchdog('file', '%path is a directory and cannot be removed using file_unmanaged_delete().', array('%path' => $path), WATCHDOG_ERROR);
- return FALSE;
- }
- if (is_file($path)) {
- return backdrop_unlink($path);
- }
-
-
- if (!file_exists($path)) {
- watchdog('file', 'The file %path was not deleted because it does not exist.', array('%path' => $path), WATCHDOG_NOTICE);
- return TRUE;
- }
-
-
- watchdog('file', 'The file %path is not of a recognized type so it was not deleted.', array('%path' => $path), WATCHDOG_ERROR);
- return FALSE;
- }
-
- * Deletes all files and directories in the specified filepath recursively.
- *
- * If the specified path is a directory then the function will call itself
- * recursively to process the contents. Once the contents have been removed the
- * directory will also be removed.
- *
- * If the specified path is a file then it will be passed to
- * file_unmanaged_delete().
- *
- * Note that this only deletes visible files with write permission.
- *
- * @param $path
- * A string containing either an URI or a file or directory path.
- *
- * @return
- * TRUE for success or if path does not exist, FALSE in the event of an
- * error.
- *
- * @see file_unmanaged_delete()
- */
- function file_unmanaged_delete_recursive($path) {
- if (is_dir($path)) {
- $dir = dir($path);
- while (($entry = $dir->read()) !== FALSE) {
- if ($entry == '.' || $entry == '..') {
- continue;
- }
- $entry_path = $path . '/' . $entry;
- file_unmanaged_delete_recursive($entry_path);
- }
- $dir->close();
-
- return backdrop_rmdir($path);
- }
- return file_unmanaged_delete($path);
- }
-
- * Determines total disk space used by a single user or the whole filesystem.
- *
- * @param $uid
- * Optional. A user id, specifying NULL returns the total space used by all
- * non-temporary files.
- * @param $status
- * Optional. The file status to consider. The default is to only
- * consider files in status FILE_STATUS_PERMANENT.
- *
- * @return
- * An integer containing the number of bytes used.
- */
- function file_space_used($uid = NULL, $status = FILE_STATUS_PERMANENT) {
- $query = db_select('file_managed', 'f');
- $query->condition('f.status', $status);
- $query->addExpression('SUM(f.filesize)', 'filesize');
- if (isset($uid)) {
- $query->condition('f.uid', $uid);
- }
- return $query->execute()->fetchField();
- }
-
- * Saves a file upload to a new location.
- *
- * The file will be added to the {file_managed} table as a temporary file.
- * Temporary files are periodically cleaned. Use file_usage_add() to register
- * the usage of the file which will automatically mark it as permanent.
- *
- * @param $form_field_name
- * A string that is the associative array key of the upload form element in
- * the form array.
- * @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, Backdrop's temporary
- * files scheme will be used ("temporary://").
- * @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 File|FALSE|NULL
- * An object containing the file information if the upload succeeded, FALSE
- * in the event of an error, or 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').
- */
- function file_save_upload($form_field_name, $validators = array(), $destination = FALSE, $replace = FILE_EXISTS_RENAME) {
- global $user;
- static $upload_cache;
-
-
-
- if (isset($upload_cache[$form_field_name])) {
- return $upload_cache[$form_field_name];
- }
-
-
- if (empty($_FILES['files']['name'][$form_field_name])) {
- return NULL;
- }
-
-
-
-
- switch ($_FILES['files']['error'][$form_field_name]) {
- case UPLOAD_ERR_INI_SIZE:
- case UPLOAD_ERR_FORM_SIZE:
- backdrop_set_message(t('The file %file could not be saved because it exceeds %maxsize, the maximum allowed size for uploads.', array('%file' => $_FILES['files']['name'][$form_field_name], '%maxsize' => format_size(file_upload_max_size()))), 'error');
- return FALSE;
-
- case UPLOAD_ERR_PARTIAL:
- case UPLOAD_ERR_NO_FILE:
- backdrop_set_message(t('The file %file could not be saved because the upload did not complete.', array('%file' => $_FILES['files']['name'][$form_field_name])), 'error');
- return FALSE;
-
- case UPLOAD_ERR_OK:
-
-
- if (is_uploaded_file($_FILES['files']['tmp_name'][$form_field_name])) {
- break;
- }
-
-
- default:
- backdrop_set_message(t('The file %file could not be saved. An unknown error has occurred.', array('%file' => $_FILES['files']['name'][$form_field_name])), 'error');
- return FALSE;
- }
-
- $values = array(
- 'uid' => $user->uid,
- 'status' => 0,
- 'filename' => trim(backdrop_basename($_FILES['files']['name'][$form_field_name]), '.'),
- 'uri' => $_FILES['files']['tmp_name'][$form_field_name],
- 'filesize' => $_FILES['files']['size'][$form_field_name],
- );
- $values['filemime'] = file_get_mimetype($values['filename']);
- $file = new File($values);
-
- $extensions = '';
- if (isset($validators['file_validate_extensions'])) {
- if (isset($validators['file_validate_extensions'][0])) {
-
- $extensions = $validators['file_validate_extensions'][0];
- }
- else {
-
-
-
- unset($validators['file_validate_extensions']);
- }
- }
- else {
-
-
- $extensions = 'jpg jpeg gif png txt doc xls pdf ppt pps odt ods odp docx docm pptx pptm xlsx xlsm';
- $validators['file_validate_extensions'] = array();
- $validators['file_validate_extensions'][0] = $extensions;
- }
-
-
- if (!settings_get('allow_insecure_uploads', 0)) {
- if (!empty($extensions)) {
-
-
- $file->filename = file_munge_filename($file->filename, $extensions);
- }
-
-
-
-
-
- if (preg_match('/\.(php|phar|pl|py|cgi|asp|js)(\.|$)/i', $file->filename)) {
-
-
-
- if (!isset($validators['file_validate_extensions']) || !file_validate_extensions($file, $extensions)) {
- $file->filemime = 'text/plain';
- if (substr($file->filename, -4) != '.txt') {
-
- $file->filename .= '.txt';
- }
- $file->filename = file_munge_filename($file->filename, $extensions, FALSE);
- backdrop_set_message(t('For security reasons, your upload has been renamed to %filename.', array('%filename' => $file->filename)));
-
-
- if (!empty($validators['file_validate_extensions'][0])) {
- $validators['file_validate_extensions'][0] .= ' txt';
- }
- }
- }
- }
-
-
- if (empty($destination)) {
- $destination = 'temporary://';
- }
-
-
- $destination_scheme = file_uri_scheme($destination);
- if (!$destination_scheme || !file_stream_wrapper_valid_scheme($destination_scheme)) {
- backdrop_set_message(t('The file could not be uploaded because the destination %destination is invalid.', array('%destination' => $destination)), 'error');
- return FALSE;
- }
-
- $file->source = $form_field_name;
-
- if (substr($destination, -1) != '/') {
- $destination .= '/';
- }
- try {
- $file->destination = file_destination($destination . $file->filename, $replace);
- }
- catch (RuntimeException $e) {
- backdrop_set_message(t('The file %source could not be uploaded because the name is invalid.', array('%source' => $form_field_name)), 'error');
- return FALSE;
- }
-
-
- if ($file->destination === FALSE) {
- backdrop_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');
- return FALSE;
- }
-
-
- $validators['file_validate_name_length'] = array();
-
-
- $errors = file_validate($file, $validators);
-
-
- if (!empty($errors)) {
- $message = t('The specified file %name could not be uploaded.', array('%name' => $file->filename));
- if (count($errors) > 1) {
- $message .= theme('item_list', array('items' => $errors));
- }
- else {
- $message .= ' ' . array_pop($errors);
- }
- form_set_error($form_field_name, $message);
- return FALSE;
- }
-
-
-
-
- $file->uri = $file->destination;
- if (!backdrop_move_uploaded_file($_FILES['files']['tmp_name'][$form_field_name], $file->uri)) {
- form_set_error($form_field_name, t('File upload error. Could not move uploaded file.'));
- watchdog('file', 'Upload error. Could not move uploaded file %file to destination %destination.', array('%file' => $file->filename, '%destination' => $file->uri));
- return FALSE;
- }
-
-
- backdrop_chmod($file->uri);
-
-
- if ($replace == FILE_EXISTS_REPLACE) {
- $existing_files = file_load_multiple(array(), array('uri' => $file->uri));
- if (count($existing_files)) {
- $existing = reset($existing_files);
- $file->fid = $existing->fid;
- }
- }
-
-
- if (file_save($file)) {
-
-
-
-
- if (!$user->uid && $destination_scheme === 'private') {
- $_SESSION['anonymous_allowed_file_ids'][$file->fid] = $file->fid;
- }
-
- $upload_cache[$form_field_name] = $file;
- return $file;
- }
- }
-
- * Moves an uploaded file to a new location.
- *
- * PHP's move_uploaded_file() does not properly support streams if safe_mode
- * or open_basedir are enabled, so this function fills that gap.
- *
- * Compatibility: normal paths and stream wrappers.
- *
- * @param $filename
- * The filename of the uploaded file.
- * @param $uri
- * A string containing the destination URI of the file.
- *
- * @return
- * TRUE on success, or FALSE on failure.
- *
- * @see move_uploaded_file()
- * @see http://drupal.org/node/515192
- * @ingroup php_wrappers
- */
- function backdrop_move_uploaded_file($filename, $uri) {
- $result = @move_uploaded_file($filename, $uri);
-
-
-
- if (!$result) {
- if ($realpath = backdrop_realpath($uri)) {
- $result = move_uploaded_file($filename, $realpath);
- }
- else {
- $result = move_uploaded_file($filename, $uri);
- }
- }
-
- return $result;
- }
-
- * 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 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()) {
-
- $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));
- }
- }
-
-
- $errors = array_merge($errors, module_invoke_all('file_validate', $file));
-
-
-
-
-
-
- if (empty($errors) && !settings_get('allow_insecure_uploads', 0) && preg_match('/\.(php|phar|pl|py|cgi|asp|js)(\.|$)/i', $file->filename)) {
- $errors[] = t('For security reasons, your upload has been rejected.');
- }
-
- return $errors;
- }
-
- * Checks for files with names longer than can be stored in the database.
- *
- * @param 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 (empty($file->filename)) {
- $errors[] = t("The file's name is empty. Please give a name to the file.");
- }
- if (strlen($file->filename) > 240) {
- $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 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->filename)) {
- $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 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->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)));
- }
-
-
- if ($user_limit && (file_space_used($user->uid) + $file->filesize) > $user_limit) {
- $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;
- }
-
- * Checks that the file is recognized by image_get_info() as an image.
- *
- * @param 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->uri);
- 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 an image toolkit is available the image
- * will be scaled to fit within the desired maximum dimensions.
- *
- * @param 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();
-
- if ($info = image_get_info($file->uri)) {
- if ($maximum_dimensions) {
-
- list($width, $height) = explode('x', $maximum_dimensions);
- if ($info['width'] > $width || $info['height'] > $height) {
- $width = empty($width) ? NULL : $width;
- $height = empty($height) ? NULL : $height;
-
- if ($image = image_load($file->uri)) {
- image_scale($image, $width, $height);
- image_save($image);
- $file->filesize = $image->info['file_size'];
- if (!$height) {
- backdrop_set_message(t('The image was resized to fit within the maximum allowed width of %width pixels.', array('%width' => $width)));
- }
- elseif (!$width) {
- backdrop_set_message(t('The image was resized to fit within the maximum allowed height of %height pixels.', array('%height' => $height)));
- }
- else {
- backdrop_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) {
-
- list($width, $height) = explode('x', $minimum_dimensions);
- if ($width > 0 && $height > 0) {
- if ($info['width'] < $width || $info['height'] < $height) {
- $errors[] = t('The image is too small; the minimum dimensions are %dimensions pixels.', array('%dimensions' => $minimum_dimensions));
- }
- }
- elseif ($width > 0 && $info['width'] < $width) {
- $errors[] = t('The image is too small; the minimum width is %width pixels.', array('%width' => $width));
- }
- elseif ($info['height'] < $height) {
- $errors[] = t('The image is too small; the minimum height is %height pixels.', array('%height' => $height));
- }
- }
- }
- return $errors;
- }
-
- * Check for EXIF orientation data and rotate file if needed.
- *
- * @param File $file
- * A file entity.
- * @param $orientation
- * A flag indicating that EXIF data should be checked and image rotated if necessary.
- *
- * @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_orientation(File $file, $orientation = 0) {
- $errors = array();
-
-
- if ($info = image_get_info($file->uri)) {
-
- if ($orientation && function_exists('exif_read_data')) {
- $file_exif = @exif_read_data(backdrop_realpath($file->uri));
-
- if (is_array($file_exif) && isset($file_exif['Orientation'])) {
-
-
- switch ($file_exif['Orientation']) {
- case 3:
- $degrees = 180;
- break;
- case 6:
- $degrees = 90;
- break;
- case 8:
- $degrees = 270;
- break;
- default:
- $degrees = 0;
- }
- if ($degrees > 0) {
-
- $file_image = image_load($file->uri);
- if (image_rotate($file_image, $degrees, 0xffffff)) {
- image_save($file_image);
- }
- backdrop_set_message(t('The image was rotated by @degrees degrees.', array('@degrees' => $degrees)));
- }
- }
- }
- }
-
- 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 Backdrop'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 File
- * 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));
- backdrop_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)) {
-
- $file = new File(array(
- 'uri' => $uri,
- 'uid' => $user->uid,
- 'status' => FILE_STATUS_PERMANENT,
- ));
-
- if ($replace == FILE_EXISTS_REPLACE) {
- $existing_files = file_load_multiple(array(), array('uri' => $uri));
- if (count($existing_files)) {
- $existing = reset($existing_files);
- $file->fid = $existing->fid;
- $file->filename = $existing->filename;
- }
- }
-
-
- elseif ($replace == FILE_EXISTS_RENAME && is_file($destination)) {
- $file->filename = backdrop_basename($destination);
- }
-
- $file->save();
- return $file;
- }
- return FALSE;
- }
-
- * Saves a file to the specified destination without invoking file API.
- *
- * This function is identical to file_save_data() except the file will not be
- * saved to the {file_managed} table and none of the file_* hooks will be
- * called.
- *
- * @param $data
- * A string containing the contents of the file.
- * @param $destination
- * A string containing the destination location. 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 Backdrop's default files scheme, usually
- * "public://".
- * @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 with the path of the resulting file, or FALSE on error.
- *
- * @see file_save_data()
- */
- function file_unmanaged_save_data($data, $destination = NULL, $replace = FILE_EXISTS_RENAME) {
-
- $temp_name = backdrop_tempnam('temporary://', 'file');
- if (file_put_contents($temp_name, $data) === FALSE) {
- backdrop_set_message(t('The file could not be created.'), 'error');
- return FALSE;
- }
-
-
- return file_unmanaged_move($temp_name, $destination, $replace);
- }
-
- * Transfers a file to the client using HTTP.
- *
- * Pipes a file through Backdrop to the client.
- *
- * @param $uri
- * String specifying the file URI to transfer.
- * @param $headers
- * An array of HTTP headers to send along with file.
- */
- function file_transfer($uri, $headers) {
- if (ob_get_level()) {
- ob_end_clean();
- }
-
- foreach ($headers as $name => $value) {
- backdrop_add_http_header($name, $value);
- }
- backdrop_send_headers();
- $scheme = file_uri_scheme($uri);
-
- if ($scheme && file_stream_wrapper_valid_scheme($scheme) && $fd = fopen($uri, 'rb')) {
- while (!feof($fd)) {
- print fread($fd, 1024);
- }
- fclose($fd);
- }
- else {
- backdrop_not_found();
- }
- backdrop_exit();
- }
-
- * Page callback: Handles private file transfers.
- *
- * Call modules that implement hook_file_download() to find out if a file is
- * accessible and what headers it should be transferred with. If one or more
- * modules returned headers the download will start with the returned headers.
- * If a module returns -1 backdrop_access_denied() will be returned. If the file
- * exists but no modules responded backdrop_access_denied() will be returned.
- * If the file does not exist backdrop_not_found() will be returned.
- *
- * @see hook_file_download()
- * @see system_menu()
- */
- function file_download() {
-
- $args = func_get_args();
- $scheme = array_shift($args);
- $target = implode('/', $args);
- $uri = $scheme . '://' . $target;
- if (file_stream_wrapper_valid_scheme($scheme) && file_exists($uri)) {
- $headers = file_download_headers($uri);
- if (count($headers)) {
- file_transfer($uri, $headers);
- }
- backdrop_access_denied();
- }
- else {
- backdrop_not_found();
- }
- backdrop_exit();
- }
-
- * 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 $uri
- * The URI 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.
- *
- * @see file_transfer()
- * @see file_download_access()
- * @see hook_file_download()
- */
- function file_download_headers($uri) {
-
-
-
-
- $headers = array();
- foreach (module_implements('file_download') as $module) {
- $function = $module . '_file_download';
- $result = $function($uri);
- if ($result == -1) {
-
- $headers = array();
- break;
- }
- if (isset($result) && is_array($result)) {
- $headers = array_merge($headers, $result);
- }
- }
- return $headers;
- }
-
- * Checks that the current user has access to a particular file.
- *
- * The return value of this function hinges on the return value from
- * file_download_headers(), which is the function responsible for collecting
- * access information through hook_file_download().
- *
- * If immediately transferring the file to the browser and the headers will
- * need to be retrieved, the return value of file_download_headers() should be
- * used to determine access directly, so that access checks will not be run
- * twice.
- *
- * @param $uri
- * The URI for the file whose access should be retrieved.
- *
- * @return
- * Boolean TRUE if access is allowed. FALSE if access is not allowed.
- *
- * @see file_download_headers()
- * @see hook_file_download()
- */
- function file_download_access($uri) {
- return count(file_download_headers($uri)) > 0;
- }
-
- * 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.
- *
- * @param $dir
- * The base directory or URI to scan, without trailing slash.
- * @param $mask
- * The preg_match() regular expression of the files to find.
- * @param $options
- * An associative array of additional options, with the following elements:
- * - 'nomask': The preg_match() regular expression of the files to ignore.
- * Defaults to '/^(\..*)|(CVS)$/'. This default ignores all hidden files
- * (those that start with a period) and items named "CVS".
- * - 'callback': The callback function to call for each match. There is no
- * default callback.
- * - 'recurse': When TRUE, the directory scan will recurse the entire tree
- * starting at the provided directory. Defaults to TRUE.
- * - 'key': The key to be used for the returned associative array of files.
- * Possible values are 'uri', for the file's URI; 'filename', for the
- * basename of the file; and 'name' for the name of the file without the
- * extension. Defaults to 'uri'.
- * - 'min_depth': Minimum depth of directories to return files from. Defaults
- * to 0.
- * @param $depth
- * Current depth of recursion. This parameter is only used internally and
- * should not be passed in.
- *
- * @return
- * An associative array (keyed on the chosen key) of objects with 'uri',
- * 'filename', and 'name' members corresponding to the matching files.
- */
- function file_scan_directory($dir, $mask, $options = array(), $depth = 0) {
-
- $ignore_directories = array(
- 'node_modules',
- 'bower_components',
- );
- $no_mask = '/^((\..*)|' . implode('|', $ignore_directories) . ')$/';
-
-
- $options += array(
- 'nomask' => $no_mask,
- 'callback' => 0,
- 'recurse' => TRUE,
- 'key' => 'uri',
- 'min_depth' => 0,
- );
-
- $options['key'] = in_array($options['key'], array('uri', 'filename', 'name')) ? $options['key'] : 'uri';
- $files = array();
- if (is_dir($dir) && $handle = opendir($dir)) {
- while (FALSE !== ($filename = readdir($handle))) {
- if (!preg_match($options['nomask'], $filename) && $filename !== '.' && $filename !== '..') {
- $uri = "$dir/$filename";
- $uri = file_stream_wrapper_uri_normalize($uri);
- if (is_dir($uri) && $options['recurse']) {
-
- $files = array_merge(file_scan_directory($uri, $mask, $options, $depth + 1), $files);
- }
- elseif ($depth >= $options['min_depth'] && preg_match($mask, $filename)) {
-
-
- $file = new stdClass();
- $file->uri = $uri;
- $file->filename = $filename;
- $file->name = pathinfo($filename, PATHINFO_FILENAME);
- $key = $options['key'];
- $files[$file->$key] = $file;
- if ($options['callback']) {
- $options['callback']($uri);
- }
- }
- }
- }
-
- closedir($handle);
- }
-
- return $files;
- }
-
- * Determines the maximum file upload size by querying the PHP settings.
- *
- * @return
- * A file size limit in bytes based on the PHP upload_max_filesize and
- * post_max_size
- */
- function file_upload_max_size() {
- static $max_size = -1;
-
- if ($max_size < 0) {
-
- $max_size = parse_size(ini_get('post_max_size'));
-
-
-
- $upload_max = parse_size(ini_get('upload_max_filesize'));
- if ($upload_max > 0 && $upload_max < $max_size) {
- $max_size = $upload_max;
- }
- }
- return $max_size;
- }
-
- * Determines an Internet Media Type or MIME type from a filename.
- *
- * @param $uri
- * A string containing the URI, path, or filename.
- * @param $mapping
- * An optional map of extensions to their mimetypes, in the form:
- * - 'mimetypes': a list of mimetypes, keyed by an identifier,
- * - 'extensions': the mapping itself, an associative array in which
- * the key is the extension (lowercase) and the value is the mimetype
- * identifier. If $mapping is NULL file_mimetype_mapping() is called.
- *
- * @return
- * The internet media type registered for the extension or
- * application/octet-stream for unknown extensions.
- *
- * @see file_default_mimetype_mapping()
- */
- function file_get_mimetype($uri, $mapping = NULL) {
- if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
- return $wrapper->getMimeType($uri, $mapping);
- }
- else {
-
-
- return BackdropLocalStreamWrapper::getMimeType($uri, $mapping);
- }
- }
-
- * Sets the permissions on a file or directory.
- *
- * This function will use the 'file_chmod_directory' and 'file_chmod_file'
- * variables for the default modes for directories and uploaded/generated
- * files. By default these will give everyone read access so that users
- * accessing the files with a user account without the webserver group (e.g.
- * via FTP) can read these files, and give group write permissions so webserver
- * group members (e.g. a vhost account) can alter files uploaded and owned by
- * the webserver.
- *
- * PHP's chmod does not support stream wrappers so we use our wrapper
- * implementation which interfaces with chmod() by default. Contrib wrappers
- * may override this behavior in their implementations as needed.
- *
- * @param $uri
- * A string containing a URI file, or directory path.
- * @param $mode
- * Integer value for the permissions. Consult PHP chmod() documentation for
- * more information.
- *
- * @return
- * TRUE for success, FALSE in the event of an error.
- *
- * @ingroup php_wrappers
- */
- function backdrop_chmod($uri, $mode = NULL) {
- if (!isset($mode)) {
- if (is_dir($uri)) {
- $mode = settings_get('file_chmod_directory', 0775);
- }
- else {
- $mode = settings_get('file_chmod_file', 0664);
- }
- }
-
-
-
-
- if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
- if ($wrapper->chmod($mode)) {
- return TRUE;
- }
- }
- else {
- if (@chmod($uri, $mode)) {
- return TRUE;
- }
- }
-
- watchdog('file', 'The file permissions could not be set on %uri.', array('%uri' => $uri), WATCHDOG_ERROR);
- return FALSE;
- }
-
- * Deletes a file.
- *
- * PHP's unlink() is broken on Windows, as it can fail to remove a file
- * when it has a read-only flag set.
- *
- * @param $uri
- * A URI or pathname.
- * @param $context
- * Refer to http://php.net/manual/ref.stream.php
- *
- * @return
- * Boolean TRUE on success, or FALSE on failure.
- *
- * @see unlink()
- * @ingroup php_wrappers
- */
- function backdrop_unlink($uri, $context = NULL) {
- $scheme = file_uri_scheme($uri);
- if ((!$scheme || !file_stream_wrapper_valid_scheme($scheme)) && (substr(PHP_OS, 0, 3) == 'WIN')) {
- chmod($uri, 0600);
- }
- if ($context) {
- return unlink($uri, $context);
- }
- else {
- return unlink($uri);
- }
- }
-
- * Resolves the absolute filepath of a local URI or filepath.
- *
- * The use of backdrop_realpath() is discouraged, because it does not work for
- * remote URIs. Except in rare cases, URIs should not be manually resolved.
- *
- * Only use this function if you know that the stream wrapper in the URI uses
- * the local file system, and you need to pass an absolute path to a function
- * that is incompatible with stream URIs.
- *
- * @param string $uri
- * A stream wrapper URI or a filepath, possibly including one or more symbolic
- * links.
- *
- * @return string|false
- * The absolute local filepath (with no symbolic links), or FALSE on failure.
- *
- * @see BackdropStreamWrapperInterface::realpath()
- * @see http://php.net/manual/function.realpath.php
- * @ingroup php_wrappers
- */
- function backdrop_realpath($uri) {
-
-
-
- if ($wrapper = file_stream_wrapper_get_instance_by_uri($uri)) {
- return $wrapper->realpath();
- }
-
- return realpath($uri);
- }
-
- * Gets the name of the directory from a given path.
- *
- * PHP's dirname() does not properly pass streams, so this function fills
- * that gap. It is backwards compatible with normal paths and will use
- * PHP's dirname() as a fallback.
- *
- * Compatibility: normal paths and stream wrappers.
- *
- * @param $uri
- * A URI or path.
- *
- * @return
- * A string containing the directory name.
- *
- * @see dirname()
- * @see http://drupal.org/node/515192
- * @ingroup php_wrappers
- */
- function backdrop_dirname($uri) {
- $scheme = file_uri_scheme($uri);
-
- if ($scheme && file_stream_wrapper_valid_scheme($scheme)) {
- return file_stream_wrapper_get_instance_by_scheme($scheme)->dirname($uri);
- }
- else {
- return dirname($uri);
- }
- }
-
- * Gets the filename from a given path.
- *
- * PHP's basename() does not properly support streams or filenames beginning
- * with a non-US-ASCII character.
- *
- * @see http://bugs.php.net/bug.php?id=37738
- * @see basename()
- *
- * @ingroup php_wrappers
- */
- function backdrop_basename($uri, $suffix = NULL) {
- $separators = '/';
- if (DIRECTORY_SEPARATOR != '/') {
-
- $separators .= DIRECTORY_SEPARATOR;
- }
-
- $uri = rtrim($uri, $separators);
-
-
- $filename = preg_match('@[^' . preg_quote($separators, '@') . ']+$@', $uri, $matches) ? $matches[0] : '';
-
- if ($suffix) {
- $filename = preg_replace('@' . preg_quote($suffix, '@') . '$@', '', $filename);
- }
- return $filename;
- }
-
- * Creates a directory using Backdrop's default mode.
- *
- * PHP's mkdir() does not respect Backdrop's default permissions mode. If a mode
- * is not provided, this function will make sure that Backdrop's is used.
- *
- * Compatibility: normal paths and stream wrappers.
- *
- * @param $uri
- * A URI or pathname.
- * @param $mode
- * By default the Backdrop mode is used.
- * @param $recursive
- * Default to FALSE.
- * @param $context
- * Refer to http://php.net/manual/ref.stream.php
- *
- * @return
- * Boolean TRUE on success, or FALSE on failure.
- *
- * @see mkdir()
- * @see http://drupal.org/node/515192
- * @ingroup php_wrappers
- */
- function backdrop_mkdir($uri, $mode = NULL, $recursive = FALSE, $context = NULL) {
- if (!isset($mode)) {
- $mode = settings_get('file_chmod_directory', 0775);
- }
-
- if (!isset($context)) {
- return mkdir($uri, $mode, $recursive);
- }
- else {
- return mkdir($uri, $mode, $recursive, $context);
- }
- }
-
- * Removes a directory.
- *
- * PHP's rmdir() is broken on Windows, as it can fail to remove a directory
- * when it has a read-only flag set.
- *
- * @param $uri
- * A URI or pathname.
- * @param $context
- * Refer to http://php.net/manual/ref.stream.php
- *
- * @return
- * Boolean TRUE on success, or FALSE on failure.
- *
- * @see rmdir()
- * @ingroup php_wrappers
- */
- function backdrop_rmdir($uri, $context = NULL) {
- $scheme = file_uri_scheme($uri);
- if ((!$scheme || !file_stream_wrapper_valid_scheme($scheme)) && (substr(PHP_OS, 0, 3) == 'WIN')) {
- chmod($uri, 0700);
- }
- if ($context) {
- return rmdir($uri, $context);
- }
- else {
- return rmdir($uri);
- }
- }
-
- * Creates a file with a unique filename in the specified directory.
- *
- * PHP's tempnam() does not return a URI like we want. This function
- * will return a URI if given a URI, or it will return a filepath if
- * given a filepath.
- *
- * Compatibility: normal paths and stream wrappers.
- *
- * @param $directory
- * The directory where the temporary filename will be created.
- * @param $prefix
- * The prefix of the generated temporary filename.
- * Note: Windows uses only the first three characters of prefix.
- *
- * @return
- * The new temporary filename, or FALSE on failure.
- *
- * @see tempnam()
- * @see http://drupal.org/node/515192
- * @ingroup php_wrappers
- */
- function backdrop_tempnam($directory, $prefix) {
- $scheme = file_uri_scheme($directory);
-
- if ($scheme && file_stream_wrapper_valid_scheme($scheme)) {
- $wrapper = file_stream_wrapper_get_instance_by_scheme($scheme);
-
- if ($filename = tempnam($wrapper->getDirectoryPath(), $prefix)) {
- return $scheme . '://' . backdrop_basename($filename);
- }
- else {
- return FALSE;
- }
- }
- else {
-
- return tempnam($directory, $prefix);
- }
- }
-
- * Gets the path of system-appropriate temporary directory.
- */
- function file_directory_temp() {
- $site_config = config('system.core');
- $temporary_directory = $site_config->get('file_temporary_path');
-
- if (empty($temporary_directory)) {
- $directories = array();
-
-
- if (ini_get('upload_tmp_dir')) {
- $directories[] = ini_get('upload_tmp_dir');
- }
-
-
- if (substr(PHP_OS, 0, 3) == 'WIN') {
- $directories[] = 'c:\\windows\\temp';
- $directories[] = 'c:\\winnt\\temp';
- }
- else {
- $directories[] = '/tmp';
- }
-
- $directories[] = sys_get_temp_dir();
-
- foreach ($directories as $directory) {
- if (is_dir($directory) && is_writable($directory)) {
- $temporary_directory = $directory;
- break;
- }
- }
-
- if (empty($temporary_directory)) {
-
- $temporary_directory = $site_config->get('file_public_path') . '/tmp';
-
-
-
-
-
- $temporary_directory = str_replace('\\', '/', $temporary_directory);
- }
- }
-
- return $temporary_directory;
- }
-
- * Examines a file entity and returns appropriate content headers for download.
- *
- * @param File $file
- * A file entity.
- *
- * @return
- * An associative array of headers, as expected by file_transfer().
- */
- function file_get_content_headers(File $file) {
- $type = mime_header_encode($file->filemime);
-
- return array(
- 'Content-Type' => $type,
- 'Content-Length' => $file->filesize,
- 'Cache-Control' => 'private',
- );
- }
-
- * @} End of "defgroup file".
- */