Issue #1027184 by Aron Novak: Expose file download URL as a token.
[project/filefield.git] / filefield.module
index 39c886e..d697d53 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-// $Id$
 
 /**
  * @file
@@ -9,14 +8,15 @@
  * and Drupal's {files} table to store the actual file data.
  */
 
-include_once('field_file.inc');
+// FileField API hooks should always be available.
+require_once dirname(__FILE__) . '/field_file.inc';
+require_once dirname(__FILE__) . '/filefield_widget.inc';
 
 /**
  * Implementation of hook_init().
  */
 function filefield_init() {
   // File hooks and callbacks may be used by any module.
-  module_load_include('inc', 'filefield', 'filefield_widget');
   drupal_add_css(drupal_get_path('module', 'filefield') .'/filefield.css');
 
   // Conditional module support.
@@ -35,25 +35,29 @@ function filefield_menu() {
     'page callback' => 'filefield_js',
     'page arguments' => array(2, 3, 4),
     'access callback' => 'filefield_edit_access',
-    'access arguments' => array(3),
+    'access arguments' => array(2, 3),
     'type' => MENU_CALLBACK,
   );
+  $items['filefield/progress'] = array(
+    'page callback' => 'filefield_progress',
+    'access arguments' => array('access content'),
+    'type' => MENU_CALLBACK,
+  );
+
   return $items;
 }
 
 /**
  * Implementation of hook_elements().
- * @todo: autogenerate element registry entries for widgets.
  */
 function filefield_elements() {
   $elements = array();
-  $elements['filefield_widget'] =  array(
+  $elements['filefield_widget'] = array(
     '#input' => TRUE,
     '#columns' => array('fid', 'list', 'data'),
     '#process' => array('filefield_widget_process'),
     '#value_callback' => 'filefield_widget_value',
     '#element_validate' => array('filefield_widget_validate'),
-    '#description' => t('Changes made to the attachments are not permanent until you save this post.'),
   );
   return $elements;
 }
@@ -106,110 +110,134 @@ function filefield_theme() {
       'arguments' => array('file' => NULL, 'field' => NULL),
       'file' => 'filefield_formatter.inc',
     ),
-    'filefield_file' => array(
-      'arguments' => array('file' => NULL),
-      'file' => 'filefield_formatter.inc',
-    ),
-
  );
 }
 
 /**
- * Implementation of hook_file_download(). Yes, *that* hook that causes
- * any attempt for file upload module interoperability to fail spectacularly.
+ * Implementation of hook_file_download().
  */
-function filefield_file_download($file) {
-  $file = file_create_path($file);
+function filefield_file_download($filepath) {
+  $filepath = file_create_path($filepath);
+  $result = db_query("SELECT * FROM {files} WHERE filepath = '%s'", $filepath);
+
+  // Ensure case-sensitivity of uploaded file names.
+  while ($file = db_fetch_object($result)) {
+    if (strcmp($file->filepath, $filepath) == 0) {
+      break;
+    }
+  }
 
-  $result = db_query("SELECT * FROM {files} WHERE filepath = '%s'", $file);
-  if (!$file = db_fetch_object($result)) {
-    // We don't really care about this file.
+  // If the file is not found in the database, we're not responsible for it.
+  if (empty($file)) {
     return;
   }
 
-  // Find out if any filefield contains this file, and if so, which field
-  // and node it belongs to. Required for later access checking.
-  $cck_files = array();
-  foreach (content_fields() as $field) {
-    if ($field['type'] == 'filefield' || $field['type'] == 'image') {
-      $db_info = content_database_info($field);
-      $table = $db_info['table'];
-      $fid_column = $db_info['columns']['fid']['column'];
-
-      $columns = array('vid', 'nid');
-      foreach ($db_info['columns'] as $property_name => $column_info) {
-        $columns[] = $column_info['column'] .' AS '. $property_name;
-      }
-      $result = db_query("SELECT ". implode(', ', $columns) ."
-                          FROM {". $table ."}
-                          WHERE ". $fid_column ." = %d", $file->fid);
+  // See if this is a file on a newly created node, on which the user who
+  // uploaded it will immediately have access.
+  $new_node_file = $file->status == 0 && isset($_SESSION['filefield_access']) && in_array($file->fid, $_SESSION['filefield_access']);
+  if ($new_node_file) {
+    $denied = FALSE;
+  }
+  // Loop through all fields and find if this file is used by FileField.
+  else {
+    // Find out if any file field contains this file, and if so, which field
+    // and node it belongs to. Required for later access checking.
+    $cck_files = array();
+    foreach (content_fields() as $field) {
+      if ($field['type'] == 'filefield' || $field['type'] == 'image') {
+        $db_info = content_database_info($field);
+        $table = $db_info['table'];
+        $fid_column = $db_info['columns']['fid']['column'];
+
+        $columns = array('vid', 'nid');
+        foreach ($db_info['columns'] as $property_name => $column_info) {
+          $columns[] = $column_info['column'] .' AS '. $property_name;
+        }
+        $result = db_query("SELECT ". implode(', ', $columns) ."
+                            FROM {". $table ."}
+                            WHERE ". $fid_column ." = %d", $file->fid);
 
-      while ($content = db_fetch_array($result)) {
-        $content['field'] = $field;
-        $cck_files[$field['field_name']][$content['vid']] = $content;
+        while ($content = db_fetch_array($result)) {
+          $content['field'] = $field;
+          $cck_files[$field['field_name']][$content['vid']] = $content;
+        }
       }
     }
-  }
-  // If no filefield item is involved with this file, we don't care about it.
-  if (empty($cck_files)) {
-    return;
-  }
 
-  // If any node includes this file but the user may not view this field,
-  // then deny the download.
-  foreach ($cck_files as $field_name => $field_files) {
-    if (!filefield_view_access($field_name)) {
-      return -1;
+    // If no file field item is involved with this file, we don't care about it.
+    if (empty($cck_files)) {
+      return;
     }
-  }
 
-  // So the overall field view permissions are not denied, but if access is
-  // denied for a specific node containing the file, deny the download as well.
-  // It's probably a little too restrictive, but I can't think of a
-  // better way at the moment. Input appreciated.
-  // (And yeah, node access checks also include checking for 'access content'.)
-  $nodes = array();
-  foreach ($cck_files as $field_name => $field_files) {
-    foreach ($field_files as $revision_id => $content) {
-      // Checking separately for each revision is probably not the best idea -
-      // what if 'view revisions' is disabled? So, let's just check for the
-      // current revision of that node.
-      if (isset($nodes[$content['nid']])) {
-        continue; // don't check the same node twice
-      }
-      $node = node_load($content['nid']);
-      if (!node_access('view', $node)) {
-        // You don't have permission to view the node this file is attached to.
-        return -1;
+    // So the overall field view permissions are not denied, but if access is
+    // denied for ALL nodes containing the file, deny the download as well.
+    // Node access checks also include checking for 'access content'.
+    $nodes = array();
+    $denied = TRUE;
+    foreach ($cck_files as $field_name => $field_files) {
+      foreach ($field_files as $revision_id => $content) {
+        // Checking separately for each revision is probably not the best idea -
+        // what if 'view revisions' is disabled? So, let's just check for the
+        // current revision of that node.
+        if (isset($nodes[$content['nid']])) {
+          continue; // Don't check the same node twice.
+        }
+        if (($node = node_load($content['nid'])) && (node_access('view', $node) && filefield_view_access($field_name, $node))) {
+          $denied = FALSE;
+          break 2;
+        }
+        $nodes[$content['nid']] = $node;
       }
-      $nodes[$content['nid']] = $node;
     }
   }
 
-  // Well I guess you can see this file.
+  if ($denied) {
+    return -1;
+  }
+
+  // Access is granted.
   $name = mime_header_encode($file->filename);
   $type = mime_header_encode($file->filemime);
-  // Serve images and text inline for the browser to display rather than download.
-  $disposition = ereg('^(text/|image/)', $file->filemime) ? 'inline' : 'attachment';
+  // By default, serve images, text, and flash content for display rather than
+  // download. Or if variable 'filefield_inline_types' is set, use its patterns.
+  $inline_types = variable_get('filefield_inline_types', array('^text/', '^image/', 'flash$'));
+  $disposition = 'attachment';
+  foreach ($inline_types as $inline_type) {
+    // Exclamation marks are used as delimiters to avoid escaping slashes.
+    if (preg_match('!' . $inline_type . '!', $file->filemime)) {
+      $disposition = 'inline';
+    }
+  }
   return array(
-    'Content-Type: '. $type .'; name='. $name,
-    'Content-Length: '. $file->filesize,
-    'Content-Disposition: '. $disposition .'; filename='. $name,
+    'Content-Type: ' . $type . '; name="' . $name . '"',
+    'Content-Length: ' . $file->filesize,
+    'Content-Disposition: ' . $disposition . '; filename="' . $name . '"',
     'Cache-Control: private',
   );
 }
 
 /**
+ * Implementation of hook_views_api().
+ */
+function filefield_views_api() {
+  return array(
+    'api' => 2.0,
+    'path' => drupal_get_path('module', 'filefield') . '/views',
+  );
+}
+
+/**
  * Implementation of hook_form_alter().
  *
- * Set the appropriate attibutes to allow file uploads on the field settings
- * form.
+ * Set the enctype on forms that need to accept file uploads.
  */
 function filefield_form_alter(&$form, $form_state, $form_id) {
+  // Field configuration (for default images).
   if ($form_id == 'content_field_edit_form' && isset($form['#field']) && $form['#field']['type'] == 'filefield') {
     $form['#attributes']['enctype'] = 'multipart/form-data';
   }
 
+  // Node forms.
   if (preg_match('/_node_form$/', $form_id)) {
     $form['#attributes']['enctype'] = 'multipart/form-data';
   }
@@ -221,7 +249,7 @@ function filefield_form_alter(&$form, $form_state, $form_id) {
 function filefield_field_info() {
   return array(
     'filefield' => array(
-      'label' => 'File',
+      'label' => t('File'),
       'description' => t('Store an arbitrary file.'),
     ),
   );
@@ -235,7 +263,6 @@ function filefield_field_settings($op, $field) {
 
   module_load_include('inc', 'filefield', 'filefield_field');
   $op = str_replace(' ', '_', $op);
-  // add filefield specific handlers...
   $function = 'filefield_field_settings_'. $op;
   if (function_exists($function)) {
     $result = $function($field);
@@ -244,23 +271,12 @@ function filefield_field_settings($op, $field) {
     }
   }
 
-  // dynamically load widgets file and callbacks for other fields utilizing
-  // filefield's hook_field_settings implementation.
-  module_load_include('inc', $field['module'], $field['type'] .'_field');
-  $function = $field['module'] .'_'. $field['type'] .'_field_settings_'. $op;
-  if (function_exists($function)) {
-    $result = $function($field);
-    if (isset($result) && is_array($result)) {
-      $return = array_merge($return, $result);
-    }
-  }
-
   return $return;
 
 }
 
 /**
- * Implementtation of CCK's hook_field().
+ * Implementation of CCK's hook_field().
  */
 function filefield_field($op, $node, $field, &$items, $teaser, $page) {
   module_load_include('inc', 'filefield', 'filefield_field');
@@ -289,17 +305,13 @@ function filefield_widget_settings($op, $widget) {
  */
 function filefield_widget(&$form, &$form_state, $field, $items, $delta = 0) {
   // CCK doesn't give a validate callback at the field level...
-  // and FAPI's #require is naieve to complex structures...
+  // and FAPI's #require is naive to complex structures...
   // we validate at the field level ourselves.
   if (empty($form['#validate']) || !in_array('filefield_node_form_validate', $form['#validate'])) {
     $form['#validate'][] = 'filefield_node_form_validate';
   }
-  if (empty($form['#submit']) || !in_array('filefield_node_form_submit', $form['#submit'])) {
-    $form['#submit'][] = 'filefield_node_form_submit';
-  }
-  $form['#attributes'] = array('enctype' => 'multipart/form-data');
+  $form['#attributes']['enctype'] = 'multipart/form-data';
 
-  module_load_include('inc', 'filefield', 'field_widget');
   module_load_include('inc', $field['widget']['module'], $field['widget']['module'] .'_widget');
 
   $item = array('fid' => 0, 'list' => $field['list_default'], 'data' => array('description' => ''));
@@ -319,8 +331,10 @@ function filefield_widget(&$form, &$form_state, $field, $items, $delta = 0) {
 /**
  * Get the upload validators for a file field.
  *
- * @param $field CCK Field
- * @return array suitable for passing to file_save_upload() or the filefield
+ * @param $field
+ *   A CCK field array.
+ * @return
+ *   An array suitable for passing to file_save_upload() or the file field
  *   element's '#upload_validators' property.
  */
 function filefield_widget_upload_validators($field) {
@@ -329,29 +343,71 @@ function filefield_widget_upload_validators($field) {
     $max_filesize = parse_size($field['widget']['max_filesize_per_file']);
   }
 
+  // Match the default value if no file extensions have been saved at all.
+  if (!isset($field['widget']['file_extensions'])) {
+    $field['widget']['file_extensions'] = 'txt';
+  }
+
   $validators = array(
     // associate the field to the file on validation.
     'filefield_validate_associate_field' => array($field),
     'filefield_validate_size' => array($max_filesize),
-    // Override core since it excludes uid 1 on the extension check. 
+    // Override core since it excludes uid 1 on the extension check.
     // Filefield only excuses uid 1 of quota requirements.
     'filefield_validate_extensions' => array($field['widget']['file_extensions']),
   );
   return $validators;
 }
 
-
 /**
  * Implementation of CCK's hook_content_is_empty().
  *
- * The result of this determines whether content.module will save
- * the value of the field.
+ * The result of this determines whether content.module will save the value of
+ * the field. Note that content module has some interesting behaviors for empty
+ * values. It will always save at least one record for every node revision,
+ * even if the values are all NULL. If it is a multi-value field with an
+ * explicit limit, CCK will save that number of empty entries.
  */
 function filefield_content_is_empty($item, $field) {
   return empty($item['fid']) || (int)$item['fid'] == 0;
 }
 
 /**
+ * Implementation of CCK's hook_content_diff_values().
+ */
+function filefield_content_diff_values($node, $field, $items) {
+  $return = array();
+  foreach ($items as $item) {
+    if (is_array($item) && !empty($item['filepath'])) {
+      $return[] = $item['filepath'];
+    }
+  }
+  return $return;
+}
+
+/**
+ * Implementation of CCK's hook_default_value().
+ *
+ * Note this is a widget-level hook, so it does not affect ImageField or other
+ * modules that extend FileField.
+ *
+ * @see content_default_value()
+ */
+function filefield_default_value(&$form, &$form_state, $field, $delta) {
+  // Reduce the default number of upload fields to one. CCK 2 (but not 3) will
+  // automatically add one more field than necessary. We use the
+  // content_multiple_value_after_build function to determine the version.
+  if (!function_exists('content_multiple_value_after_build') && !isset($form_state['item_count'][$field['field_name']])) {
+    $form_state['item_count'][$field['field_name']] = 0;
+  }
+
+  // The default value is actually handled in hook_widget().
+  // hook_default_value() is only helpful for new nodes, and we need to affect
+  // all widgets, such as when a new field is added via "Add another item".
+  return array();
+}
+
+/**
  * Implementation of CCK's hook_widget_info().
  */
 function filefield_widget_info() {
@@ -362,6 +418,7 @@ function filefield_widget_info() {
       'multiple values' => CONTENT_HANDLE_CORE,
       'callbacks' => array('default value' => CONTENT_CALLBACK_CUSTOM),
       'description' => t('A plain file upload widget.'),
+      'file_extensions' => 'txt',
     ),
   );
 }
@@ -391,6 +448,73 @@ function filefield_field_formatter_info() {
 }
 
 /**
+ * Implementation of CCK's hook_content_generate(). Used by generate.module.
+ */
+function filefield_content_generate($node, $field) {
+  module_load_include('inc', 'filefield', 'filefield.devel');
+
+  if (content_handle('widget', 'multiple values', $field) == CONTENT_HANDLE_MODULE) {
+    return content_devel_multiple('_filefield_content_generate', $node, $field);
+  }
+  else {
+    return _filefield_content_generate($node, $field);
+  }
+}
+
+/**
+ * Get a list of possible information stored in a file field "data" column.
+ */
+function filefield_data_info() {
+  static $columns;
+
+  if (!isset($columns)) {
+    $columns = array();
+    foreach (module_implements('filefield_data_info') as $module) {
+      $function = $module . '_filefield_data_info';
+      $data = (array) $function();
+      foreach ($data as $key => $value) {
+        $data[$key] = $value;
+        $data[$key]['module'] = $module;
+      }
+      $columns = array_merge($columns, $data);
+    }
+  }
+
+  return $columns;
+}
+
+/**
+ * Given an array of data options, dispatch the necessary callback function.
+ */
+function filefield_data_value($key, $value) {
+  $info = filefield_data_info();
+  if (isset($info[$key]['callback'])) {
+    $callback = $info[$key]['callback'];
+    $value = $callback($value);
+  }
+  else {
+    $value = check_plain((string) $value);
+  }
+  return $value;
+}
+
+/**
+ * Implementation of hook_filefield_data_info().
+ *
+ * Define a list of values that this module stores in the "data" column of a
+ * file field. The callback function receives the portion of the data column
+ * defined by key and should return a value suitable for printing to the page.
+ */
+function filefield_filefield_data_info() {
+  return array(
+    'description' => array(
+      'title' => t('Description'),
+      'callback' => 'check_plain',
+    ),
+  );
+}
+
+/**
  * Determine the most appropriate icon for the given file's mimetype.
  *
  * @param $file
@@ -399,46 +523,65 @@ function filefield_field_formatter_info() {
  *   The URL of the icon image file, or FALSE if no icon could be found.
  */
 function filefield_icon_url($file) {
-  include_once(drupal_get_path('module', 'filefield') .'/filefield.theme.inc');
+  module_load_include('inc', 'filefield', 'filefield.theme');
   return _filefield_icon_url($file);
 }
 
 /**
+ * Implementation of hook_filefield_icon_sets().
+ *
+ * Define a list of icon sets and directories that contain the icons.
+ */
+function filefield_filefield_icon_sets() {
+  return array(
+    'default' => drupal_get_path('module', 'filefield') . '/icons',
+  );
+}
+
+/**
  * Access callback for the JavaScript upload and deletion AHAH callbacks.
+ *
  * The content_permissions module provides nice fine-grained permissions for
  * us to check, so we can make sure that the user may actually edit the file.
  */
-function filefield_edit_access($field_name) {
-  if (module_exists('content_permissions')) {
-    return user_access('edit '. $field_name);
+function filefield_edit_access($type_name, $field_name) {
+  if (!content_access('edit', content_fields($field_name, $type_name))) {
+    return FALSE;
   }
   // No content permissions to check, so let's fall back to a more general permission.
-  return user_access('access content');
+  return user_access('access content') || user_access('administer nodes');
 }
 
 /**
  * Access callback that checks if the current user may view the filefield.
  */
-function filefield_view_access($field_name) {
-  if (module_exists('content_permissions')) {
-    return user_access('view '. $field_name);
+function filefield_view_access($field_name, $node = NULL) {
+  if (!content_access('view', content_fields($field_name), NULL, $node)) {
+    return FALSE;
   }
   // No content permissions to check, so let's fall back to a more general permission.
-  return user_access('access content');
+  return user_access('access content') || user_access('administer nodes');
 }
 
 /**
- * Shared AHAH callback for uploads and deletions... It rebuilds the form element
- * for a particular field item. As long as the form processing is properly
- * encapsulated in the widget element the form should rebuild correctly using
- * FAPI without the need for additional callbacks or processing.
+ * Menu callback; Shared AHAH callback for uploads and deletions.
+ *
+ * This rebuilds the form element for a particular field item. As long as the
+ * form processing is properly encapsulated in the widget element the form
+ * should rebuild correctly using FAPI without the need for additional callbacks
+ * or processing.
  */
 function filefield_js($type_name, $field_name, $delta) {
   $field = content_fields($field_name, $type_name);
 
+  // Immediately disable devel shutdown functions so that it doesn't botch our
+  // JSON output.
+  $GLOBALS['devel_shutdown'] = FALSE;
+
   if (empty($field) || empty($_POST['form_build_id'])) {
     // Invalid request.
-    print drupal_to_js(array('data' => ''));
+    drupal_set_message(t('An unrecoverable error occurred. The uploaded file likely exceeded the maximum file size (@size) that this server supports.', array('@size' => format_size(file_upload_max_size()))), 'error');
+    print drupal_to_js(array('data' => theme('status_messages')));
     exit;
   }
 
@@ -449,7 +592,8 @@ function filefield_js($type_name, $field_name, $delta) {
 
   if (!$form) {
     // Invalid form_build_id.
-    print drupal_to_js(array('data' => ''));
+    drupal_set_message(t('An unrecoverable error occurred. This form was missing from the server cache. Try reloading the page and submitting again.'), 'error');
+    print drupal_to_js(array('data' => theme('status_messages')));
     exit;
   }
 
@@ -471,7 +615,8 @@ function filefield_js($type_name, $field_name, $delta) {
       $form_element = $form[$group_name][$field_name][$delta];
     }
   }
-  else {
+
+  if (!isset($form_element)) {
     $form_element = $form[$field_name][$delta];
   }
 
@@ -509,44 +654,85 @@ function filefield_js($type_name, $field_name, $delta) {
 
   // For some reason, file uploads don't like drupal_json() with its manual
   // setting of the text/javascript HTTP header. So use this one instead.
-  $GLOBALS['devel_shutdown'] = FALSE;
   print drupal_to_js(array('status' => TRUE, 'data' => $output));
   exit;
 }
 
 /**
- * Implementation of hook_file_references().
+ * Menu callback for upload progress.
  */
-function filefield_file_references($file) {
-  $references = 0;
-  foreach (content_fields() as $field) {
-    if ($field['type'] != 'filefield') {
-      continue;
+function filefield_progress($key) {
+  $progress = array(
+    'message' => t('Starting upload...'),
+    'percentage' => -1,
+  );
+
+  $implementation = filefield_progress_implementation();
+  if ($implementation == 'uploadprogress') {
+    $status = uploadprogress_get_info($key);
+    if (isset($status['bytes_uploaded']) && !empty($status['bytes_total'])) {
+      $progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['bytes_uploaded']), '@total' => format_size($status['bytes_total'])));
+      $progress['percentage'] = round(100 * $status['bytes_uploaded'] / $status['bytes_total']);
+    }
+  }
+  elseif ($implementation == 'apc') {
+    $status = apc_fetch('upload_' . $key);
+    if (isset($status['current']) && !empty($status['total'])) {
+      $progress['message'] = t('Uploading... (@current of @total)', array('@current' => format_size($status['current']), '@total' => format_size($status['total'])));
+      $progress['percentage'] = round(100 * $status['current'] / $status['total']);
     }
-    $references += field_file_references($file, $field);
   }
-  return array('filefield' => $references);
+
+  drupal_json($progress);
 }
 
 /**
- * Implementation of hook_file_delete().
+ * Determine which upload progress implementation to use, if any available.
  */
-function filefield_file_delete($file) {
-  // foreach  field... remove items referencing $file.
+function filefield_progress_implementation() {
+  static $implementation;
+  if (!isset($implementation)) {
+    $implementation = FALSE;
+
+    // We prefer the PECL extension uploadprogress because it supports multiple
+    // simultaneous uploads. APC only supports one at a time.
+    if (extension_loaded('uploadprogress')) {
+      $implementation = 'uploadprogress';
+    }
+    elseif (extension_loaded('apc') && ini_get('apc.rfc1867')) {
+      $implementation = 'apc';
+    }
+  }
+  return $implementation;
 }
 
+/**
+ * Implementation of hook_file_references().
+ */
+function filefield_file_references($file) {
+  $count = filefield_get_file_reference_count($file);
+  return $count ? array('filefield' => $count) : NULL;
+}
 
+/**
+ * Implementation of hook_file_delete().
+ */
+function filefield_file_delete($file) {
+  filefield_delete_file_references($file);
+}
 
 /**
- * Check that the filename ends with an allowed extension. This check is
- * enforced for the user #1.
+ * An #upload_validators callback. Check the file matches an allowed extension.
+ *
+ * If the mimedetect module is available, this will also validate that the
+ * content of the file matches the extension. User #1 is included in this check.
  *
  * @param $file
  *   A Drupal file object.
  * @param $extensions
- *   A string with a space separated
+ *   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.
+ *   An array of any errors cause by this file if it failed validation.
  */
 function filefield_validate_extensions($file, $extensions) {
   global $user;
@@ -561,7 +747,7 @@ function filefield_validate_extensions($file, $extensions) {
       if (module_exists('mimedetect')) {
         $type = mimedetect_mime($file);
         if ($type != $file->filemime) {
-          $errors[] = t('The file contents (@type) do not match it\'s extension (@extension).', array('@type' => $type, '@extension' => $extension));
+          $errors[] = t('The file contents (@type) do not match its extension (@extension).', array('@type' => $type, '@extension' => $extension));
         }
       }
     }
@@ -573,18 +759,31 @@ function filefield_validate_extensions($file, $extensions) {
   return $errors;
 }
 
-// These three functions return messages for file_validate_size, and file_validate_extensions.
-// They're a neat hack that gets the job done. Even though it's evil to put a
-// function into a namespace not owned by your module...
+/**
+ * Help text automatically appended to fields that have extension validation.
+ */
 function filefield_validate_extensions_help($extensions) {
   if (!empty($extensions)) {
-    return t('Allowed Extensions: %ext', array('%ext' => $extensions));
+    return t('Allowed extensions: %ext', array('%ext' => $extensions));
   }
   else {
     return '';
   }
 }
 
+/**
+ * An #upload_validators callback. Check the file size does not exceed a limit.
+ *
+ * @param $file
+ *   A Drupal file object.
+ * @param $file_limit
+ *   An integer value limiting the maximum file size in bytes.
+ * @param $file_limit
+ *   An integer value limiting the maximum size in bytes a user can upload on
+ *   the entire site.
+ * @return
+ *   An array of any errors cause by this file if it failed validation.
+ */
 function filefield_validate_size($file, $file_limit = 0, $user_limit = 0) {
   global $user;
 
@@ -604,38 +803,76 @@ function filefield_validate_size($file, $file_limit = 0, $user_limit = 0) {
   return $errors;
 }
 
+/**
+ * Automatic help text appended to fields that have file size validation.
+ */
 function filefield_validate_size_help($size) {
-  return t('Maximum Filesize: %size', array('%size' => format_size(parse_size($size))));
+  return t('Maximum file size: %size', array('%size' => format_size(parse_size($size))));
 }
 
+/**
+ * An #upload_validators callback. Check an image resolution.
+ *
+ * @param $file
+ *   A Drupal file object.
+ * @param $max_size
+ *   A string in the format WIDTHxHEIGHT. If the image is larger than this size
+ *   the image will be scaled to fit within these dimensions.
+ * @param $min_size
+ *   A string in the format WIDTHxHEIGHT. If the image is smaller than this size
+ *   a validation error will be returned.
+ * @return
+ *   An array of any errors cause by this file if it failed validation.
+ */
 function filefield_validate_image_resolution(&$file, $maximum_dimensions = 0, $minimum_dimensions = 0) {
   $errors = array();
 
+  @list($max_width, $max_height) = explode('x', $maximum_dimensions);
+  @list($min_width, $min_height) = explode('x', $minimum_dimensions);
+
   // Check first that the file is an image.
   if ($info = image_get_info($file->filepath)) {
     if ($maximum_dimensions) {
+      $resized = FALSE;
+
       // Check that it is smaller than the given dimensions.
-      list($width, $height) = explode('x', $maximum_dimensions);
-      if ($info['width'] > $width || $info['height'] > $height) {
+      if ($info['width'] > $max_width || $info['height'] > $max_height) {
+        $ratio = min($max_width/$info['width'], $max_height/$info['height']);
+        // Check for exact dimension requirements (scaling allowed).
+        if (strcmp($minimum_dimensions, $maximum_dimensions) == 0 && $info['width']/$max_width != $info['height']/$max_height) {
+          $errors[] = t('The image must be exactly %dimensions pixels.', array('%dimensions' => $maximum_dimensions));
+        }
+        // Check that scaling won't drop the image below the minimum dimensions.
+        elseif ((image_get_toolkit() || module_exists('imageapi')) && (($info['width'] * $ratio < $min_width) || ($info['height'] * $ratio < $min_height))) {
+          $errors[] = t('The image will not fit between the dimensions of %min_dimensions and %max_dimensions pixels.', array('%min_dimensions' => $minimum_dimensions, '%max_dimensions' => $maximum_dimensions));
+        }
+        // Try resizing the image with ImageAPI if available.
+        elseif (module_exists('imageapi') && imageapi_default_toolkit()) {
+          $res = imageapi_image_open($file->filepath);
+          imageapi_image_scale($res, $max_width, $max_height);
+          imageapi_image_close($res, $file->filepath);
+          $resized = TRUE;
+        }
         // Try to resize the image to fit the dimensions.
-        if (image_get_toolkit() && image_scale($file->filepath, $file->filepath, $width, $height)) {
-          drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
-
-          // Clear the cached filesize and refresh the image information.
-          clearstatcache();
-          $info = image_get_info($file->filepath);
-          $file->filesize = $info['file_size'];
+        elseif (image_get_toolkit() && @image_scale($file->filepath, $file->filepath, $max_width, $max_height)) {
+          $resized = TRUE;
         }
         else {
           $errors[] = t('The image is too large; the maximum dimensions are %dimensions pixels.', array('%dimensions' => $maximum_dimensions));
         }
       }
+
+      // Clear the cached filesize and refresh the image information.
+      if ($resized) {
+        drupal_set_message(t('The image was resized to fit within the maximum allowed dimensions of %dimensions pixels.', array('%dimensions' => $maximum_dimensions)));
+        clearstatcache();
+        $file->filesize = filesize($file->filepath);
+      }
     }
 
-    if ($minimum_dimensions) {
+    if ($minimum_dimensions && empty($errors)) {
       // Check that it is larger than the given dimensions.
-      list($width, $height) = explode('x', $minimum_dimensions);
-      if ($info['width'] < $width || $info['height'] < $height) {
+      if ($info['width'] < $min_width || $info['height'] < $min_height) {
         $errors[] = t('The image is too small; the minimum dimensions are %dimensions pixels.', array('%dimensions' => $minimum_dimensions));
       }
     }
@@ -644,6 +881,9 @@ function filefield_validate_image_resolution(&$file, $maximum_dimensions = 0, $m
   return $errors;
 }
 
+/**
+ * Automatic help text appended to fields that have image resolution validation.
+ */
 function filefield_validate_image_resolution_help($max_size = '0', $min_size = '0') {
   if (!empty($max_size)) {
     if (!empty($min_size)) {
@@ -668,6 +908,22 @@ function filefield_validate_image_resolution_help($max_size = '0', $min_size = '
   }
 }
 
+
+/**
+ * An #upload_validators callback. Check that a file is an image.
+ *
+ * This check should allow any image that PHP can identify, including png, jpg,
+ * gif, tif, bmp, psd, swc, iff, jpc, jp2, jpx, jb2, xbm, and wbmp.
+ *
+ * This check should be combined with filefield_validate_extensions() to ensure
+ * only web-based images are allowed, however it provides a better check than
+ * extension checking alone if the mimedetect module is not available.
+ *
+ * @param $file
+ *   A Drupal file object.
+ * @return
+ *   An array of any errors cause by this file if it failed validation.
+ */
 function filefield_validate_is_image(&$file) {
   $errors = array();
   $info = image_get_info($file->filepath);
@@ -677,11 +933,201 @@ function filefield_validate_is_image(&$file) {
   return $errors;
 }
 
-/** 
- * This validation function adds the field to the file object, for later 
- * use in field aware modules implementing hook_file.
+/**
+ * An #upload_validators callback. Add the field to the file object.
+ *
+ * This validation function adds the field to the file object for later
+ * use in field aware modules implementing hook_file. It's not truly a
+ * validation at all, rather a convient way to add properties to the uploaded
+ * file.
  */
 function filefield_validate_associate_field(&$file, $field) {
   $file->field = $field;
   return array();
 }
+
+/*******************************************************************************
+ * Public API functions for FileField.
+ ******************************************************************************/
+
+/**
+ * Return an array of file fields within a node type or by field name.
+ *
+ * @param $field
+ *   Optional. May be either a field array or a field name.
+ * @param $node_type
+ *   Optional. The node type to filter the list of fields.
+ */
+function filefield_get_field_list($node_type = NULL, $field = NULL) {
+  // Build the list of fields to be used for retrieval.
+  if (isset($field)) {
+    if (is_string($field)) {
+      $field = content_fields($field, $node_type);
+    }
+    $fields = array($field['field_name'] => $field);
+  }
+  elseif (isset($node_type)) {
+    $type = content_types($node_type);
+    $fields = $type['fields'];
+  }
+  else {
+    $fields = content_fields();
+  }
+
+  // Filter down the list just to file fields.
+  foreach ($fields as $key => $field) {
+    if ($field['type'] != 'filefield') {
+      unset($fields[$key]);
+    }
+  }
+
+  return $fields;
+}
+
+/**
+ * Count the number of times the file is referenced within a field.
+ *
+ * @param $file
+ *   A file object.
+ * @param $field
+ *   Optional. The CCK field array or field name as a string.
+ * @return
+ *   An integer value.
+ */
+function filefield_get_file_reference_count($file, $field = NULL) {
+  $fields = filefield_get_field_list(NULL, $field);
+  $file = (object) $file;
+
+  $references = 0;
+  foreach ($fields as $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.
+    if (isset($file->field_name) && $field['field_name'] == $file->field_name) {
+      // If deleting the entire node, count how many references to decrement.
+      if (isset($file->delete_nid)) {
+        $node_references = db_result(db_query(
+          'SELECT count('. $db_info['columns']['fid']['column'] .')
+            FROM {'. $db_info['table'] .'}
+            WHERE '. $db_info['columns']['fid']['column'] .' = %d AND nid = %d', $file->fid, $file->delete_nid
+        ));
+        $references = $references - $node_references;
+      }
+      else {
+        $references = $references - 1;
+      }
+    }
+  }
+
+  return $references;
+}
+
+/**
+ * Get a list of node IDs that reference a file.
+ *
+ * @param $file
+ *   The file object for which to find references.
+ * @param $field
+ *   Optional. The CCK field array or field name as a string.
+ * @return
+ *   An array of IDs grouped by NID: array([nid] => array([vid1], [vid2])).
+ */
+function filefield_get_file_references($file, $field = NULL) {
+  $fields = filefield_get_field_list(NULL, $field);
+  $file = (object) $file;
+
+  $references = array();
+  foreach ($fields as $field) {
+    $db_info = content_database_info($field);
+    $sql = 'SELECT nid, vid FROM {'. $db_info['table'] .'} WHERE '. $db_info['columns']['fid']['column'] .' = %d';
+    $result = db_query($sql, $file->fid);
+    while ($row = db_fetch_object($result)) {
+      $references[$row->nid][$row->vid] = $row->vid;
+    }
+  }
+
+  return $references;
+}
+
+/**
+ * Get all FileField files connected to a node ID.
+ *
+ * @param $nid
+ *   The node object.
+ * @param $field_name
+ *   Optional. The CCK field array or field name as a string.
+ * @return
+ *   An array of all files attached to that field (or all fields).
+ */
+function filefield_get_node_files($node, $field = NULL) {
+  $fields = filefield_get_field_list($node->type, $field);
+  $files = array();
+
+  // Get the file rows.
+  foreach ($fields as $field) {
+    $db_info = content_database_info($field);
+    $fields = 'f.*';
+    $fields .= ', c.'. $db_info['columns']['list']['column'] .' AS list';
+    $fields .= ', c.'. $db_info['columns']['data']['column'] .' AS data';
+    $sql =  'SELECT '. $fields .' FROM {files} f INNER JOIN {' . $db_info['table'] . '} c ON f.fid = c.' . $db_info['columns']['fid']['column'] . ' AND c.vid = %d';
+    $result = db_query($sql, $node->vid);
+    while ($file = db_fetch_array($result)) {
+      $file['data'] = unserialize($file['data']);
+      $files[$file['fid']] = $file;
+    }
+  }
+
+  return $files;
+}
+
+/**
+ * Delete all node references of a file.
+ *
+ * @param $file
+ *   The file object for which to find references.
+ * @param $field
+ *   Optional. The CCK field array or field name as a string.
+ */
+function filefield_delete_file_references($file, $field = NULL) {
+  $fields = filefield_get_field_list(NULL, $field);
+  $file = (object) $file;
+
+  $references = filefield_get_file_references($file, $field);
+  foreach ($references as $nid => $node_references) {
+    // Do not update a node if it is already being deleted directly by the user.
+    if (isset($file->delete_nid) && $file->delete_nid == $nid) {
+      continue;
+    }
+
+    foreach ($node_references as $vid) {
+      // Do not update the node revision if that revision is already being
+      // saved or deleted directly by the user.
+      if (isset($file->delete_vid) && $file->delete_vid == $vid) {
+        continue;
+      }
+
+      $node = node_load(array('vid' => $vid));
+      foreach ($fields as $field_name => $field) {
+        if (isset($node->$field_name)) {
+          foreach ($node->$field_name as $delta => $item) {
+            if ($item['fid'] == $file->fid) {
+              unset($node->{$field_name}[$delta]);
+            }
+          }
+          $node->$field_name = array_values(array_filter($node->$field_name));
+        }
+      }
+
+      // Save the node after removing the file references. This flag prevents
+      // FileField from attempting to delete the file again.
+      $node->skip_filefield_delete = TRUE;
+      node_save($node);
+    }
+  }
+}