Issue #1027184 by Aron Novak: Expose file download URL as a token.
[project/filefield.git] / field_file.inc
index b035cfa..8d16ef6 100644 (file)
@@ -1,18 +1,19 @@
 <?php
-// $Id$
+
 /**
  * @file
  * Common functionality for file handling CCK field modules.
  */
 
 /**
- * Load a file object from the database.
+ * Load a file from the database.
  *
  * @param $fid
  *   A numeric file id or string containing the file path.
- *
  * @param $reset
  *   Whether to reset the internal file_load cache.
+ * @return
+ *   A file array.
  */
 function field_file_load($fid, $reset = NULL) {
   // Reset internal cache.
@@ -36,31 +37,33 @@ function field_file_load($fid, $reset = NULL) {
     }
 
     if (!$file) {
-      $file = array('fid' => 0, 'filepath' => '', 'filename' => '', 'filemime' => '', 'filesize' => 0);
+      $file = (object) array('fid' => 0, 'filepath' => '', 'filename' => '', 'filemime' => '', 'filesize' => 0);
     }
 
     foreach (module_implements('file_load') as $module) {
-      $function =  $module .'_file_load';
-      $function($file);
+      if ($module != 'field') {
+        $function = $module .'_file_load';
+        $function($file);
+      }
     }
 
-    // Cache the fully loaded file for later reusability.
+    // Cache the fully loaded file for later use.
     $files = _field_file_cache($file);
   }
 
-  // Cast to array for field. hook_file() expects objects as well as
-  // core file functions.
-  return (array)$files[$fid];
+  // Cast to an array for the field storage.
+  // Contrary to fields, hook_file() and core file functions expect objects.
+  return isset($files[$fid]) ? (array) $files[$fid] : FALSE;
 }
 
 /**
- * Save a file upload to a new location. The source file is validated as a
- * proper upload and handled as such. By implementing hook_file($op = 'insert'),
- * modules are able to act on the file upload and to add their own properties
- * to the file.
+ * Save a file upload to a new location.
+ * The source file is validated as a proper upload and handled as such. By
+ * implementing hook_file($op = 'insert'), modules are able to act on the file
+ * upload and to add their own properties to the file.
  *
- * The file will be added to the files table as a temporary file. Temporary files
- * are periodically cleaned. To make the file permanent file call
+ * The file will be added to the files table as a temporary file. Temporary
+ * files are periodically cleaned. To make the file permanent file call
  * file_set_status() to change its status.
  *
  * @param $source
@@ -83,7 +86,7 @@ function field_file_save_upload($source, $validators = array(), $dest = FALSE) {
     return 0;
   }
   if (!@chmod($file->filepath, 0664)) {
-    watchdog('filefield', 'Could not set permissons on destination file: %file', array('%file' => $file->filepath));
+    watchdog('filefield', 'Could not set permissions on destination file: %file', array('%file' => $file->filepath));
   }
 
   // Let modules add additional properties to the yet barebone file object.
@@ -98,6 +101,12 @@ function field_file_save_upload($source, $validators = array(), $dest = FALSE) {
 /**
  * Save a file into a file node after running all the associated validators.
  *
+ * This function is usually used to move a file from the temporary file
+ * directory to a permanent location. It may be used by import scripts or other
+ * modules that want to save an existing file into the database.
+ *
+ * @param $filepath
+ *   The local file path of the file to be saved.
  * @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
@@ -108,27 +117,22 @@ function field_file_save_upload($source, $validators = array(), $dest = FALSE) {
  * @param $dest
  *   A string containing the directory $source should be copied to. If this is
  *   not provided or is not writable, the temporary directory will be used.
+ * @param $account
+ *   The user account object that should associated with the uploaded file.
  * @return
  *   An array containing the file information, or 0 in the event of an error.
- *
  */
-function field_file_save_file($filepath, $validators = array(), $dest = FALSE) {
-  global $user;
+function field_file_save_file($filepath, $validators = array(), $dest = FALSE, $account = NULL) {
+  if (!isset($account)) {
+    $account = $GLOBALS['user'];
+  }
 
   // Add in our check of the the file name length.
   $validators['file_validate_name_length'] = array();
 
-  // Build the list of non-munged extensions.
-  // @todo: this should not be here. we need to figure out the right place.
-  $extensions = '';
-  foreach ($user->roles as $rid => $name) {
-    $extensions .= ' '. variable_get("upload_extensions_$rid",
-    variable_get('upload_extensions_default', 'jpg jpeg gif png txt html doc xls pdf ppt pps odt ods odp'));
-  }
-
   // Begin building file object.
   $file = new stdClass();
-  $file->uid = $user->uid;
+  $file->uid = $account->uid;
   $file->filename = basename($filepath);
   $file->filepath = $filepath;
   $file->filemime = module_exists('mimedetect') ? mimedetect_mime($file) : file_get_mimetype($file->filename);
@@ -153,7 +157,10 @@ function field_file_save_file($filepath, $validators = array(), $dest = FALSE) {
   // Call the validation functions.
   $errors = array();
   foreach ($validators as $function => $args) {
-    array_unshift($args, $file);
+      // Add the $file variable to the list of arguments and pass it by
+      // reference (required for PHP 5.3 and higher).
+    array_unshift($args, NULL);
+    $args[0] = &$file;
     $errors = array_merge($errors, call_user_func_array($function, $args));
   }
 
@@ -192,7 +199,7 @@ function field_file_save_file($filepath, $validators = array(), $dest = FALSE) {
 }
 
 /**
- * Update an field item file. Delete marked items if neccessary and set new items as permamant.
+ * Save a node file. Delete items if necessary and set new items as permanent.
  *
  * @param $node
  *    Node object this file is be associated with.
@@ -293,8 +300,11 @@ function _field_file_cache($file = NULL, $reset = FALSE) {
 }
 
 /**
- * A silent version of file.inc:file_check_directory it's only talkative
- * on errors.
+ * A silent version of file.inc's file_check_directory().
+ *
+ * This function differs from file_check_directory in that it checks for
+ * files when doing the directory check and it does not use drupal_set_message()
+ * when creating directories. This function may be removed in Drupal 7.
  *
  * Check that the directory exists and is writable. Directories need to
  * have execute permissions to be considered a directory by FTP servers, etc.
@@ -311,24 +321,30 @@ function _field_file_cache($file = NULL, $reset = FALSE) {
 function field_file_check_directory(&$directory, $mode = 0, $form_item = NULL) {
   $directory = rtrim($directory, '/\\');
 
-  // error if dir is a file.
+  // Error if the directory is a file.
   if (is_file($directory)) {
-    watchdog('file system',  'check_directory: The path  %directory is a file.',  array('%directory' => $directory), WATCHDOG_ERROR);
-    if ($form_item)  form_set_error($form_item, t('The directory %directory is a file!', array('%directory' => $directory)));
+    watchdog('file system', 'The path %directory was checked as a directory, but it is a file.',  array('%directory' => $directory), WATCHDOG_ERROR);
+    if ($form_item) {
+      form_set_error($form_item, t('The directory %directory is a file and cannot be overwritten.', array('%directory' => $directory)));
+    }
     return FALSE;
   }
 
-  // create the directory if it is missing.
-  if (!is_dir($directory) && $mode & FILE_CREATE_DIRECTORY && !@mkdir($directory, 0775, true)) {
+  // Create the directory if it is missing.
+  if (!is_dir($directory) && $mode & FILE_CREATE_DIRECTORY && !@mkdir($directory, 0775, TRUE)) {
     watchdog('file system', 'The directory %directory does not exist.', array('%directory' => $directory), WATCHDOG_ERROR);
-    if ($form_item) form_set_error($form_item, t('The directory %directory does not exist.', array('%directory' => $directory)));
+    if ($form_item) {
+      form_set_error($form_item, t('The directory %directory does not exist.', array('%directory' => $directory)));
+    }
     return FALSE;
   }
 
   // Check to see if the directory is writable.
   if (!is_writable($directory) && $mode & FILE_MODIFY_PERMISSIONS && !@chmod($directory, 0775)) {
     watchdog('file system', 'The directory %directory is not writable, because it does not have the correct permissions set.', array('%directory' => $directory), WATCHDOG_ERROR);
-    if ($form_item) form_set_error($form_item, t('The directory %directory is not writable', array('%directory' => $directory)));
+    if ($form_item) {
+      form_set_error($form_item, t('The directory %directory is not writable', array('%directory' => $directory)));
+    }
     return FALSE;
   }
 
@@ -360,23 +376,42 @@ function field_file_strip_path($path) {
   return $path;
 }
 
-
 /**
- * return references to a file by a single field.
+ * Encode a file path in a way that is compatible with file_create_url().
+ *
+ * This function should be used on the $file->filepath property before any call
+ * to file_create_url(). This ensures that the file directory path prefix is
+ * unmodified, but the actual path to the file will be properly URL encoded.
  */
+function field_file_urlencode_path($path) {
+  // Encode the parts of the path to ensure URLs operate within href attributes.
+  // Private file paths are urlencoded for us inside of file_create_url().
+  if (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC) == FILE_DOWNLOADS_PUBLIC) {
+    $file_directory_path = file_directory_path();
+    if (strpos($path, $file_directory_path . '/') === 0) {
+      $path = trim(substr($path, strlen($file_directory_path)), '\\/');
+    }
 
-function field_file_references($file, $field) {
-  $db_info = content_database_info($field);
-  $references = db_result(db_query(
-    'SELECT count('. $db_info['columns']['fid']['column'] .')
-      FROM {'. $db_info['table'] .'}
-      WHERE '. $db_info['columns']['fid']['column'] .' = %d', $file->fid
-  ));
-
-  // If a field_name is present in the file object, the file is being deleted
-  // from this field, decrement the number of total references by one.
-  if (isset($file->field_name) && $field['field_name'] == $file->field_name) {
-    --$references;
+    $parts = explode('/', $path);
+    foreach ($parts as $index => $part) {
+      $parts[$index] = rawurlencode($part);
+    }
+    $path = implode('/', $parts);
+
+    // Add the file directory path again (not encoded).
+    $path = $file_directory_path . '/' . $path;
+  }
+  return $path;
+}
+
+/**
+ * Return a count of the references to a file by all modules.
+ */
+function field_file_references($file) {
+  $references = (array) module_invoke_all('file_references', $file);
+  $reference_count = 0;
+  foreach ($references as $module => $count) {
+    $reference_count += $count;
   }
-  return $references;
+  return $reference_count;
 }