modules/filefield_paths/filefield_paths.module

<?php
// $Id: filefield_paths.module,v 1.22 2009/11/03 21:41:39 deciphered Exp $

/**
 * @file
 * Adds extra functionality to FileFields Path settings.
 */

/**
 * Implements hook_filefield_paths_field_settings().
 */
function filefield_paths_filefield_paths_field_settings() {
  return array(
    'file_path' => array(
      'title' => 'File path',
      'sql' => 'filepath',

      'form' => array(
        'file_path' => array(
          '#maxlength' => 512,
          '#size' => 128,
        ),
      ),
    ),

    'file_name' => array(
      'title' => 'File name',
      'sql' => 'filename',

      'form' => array(
        'file_name' => array(
          '#type' => 'textfield',
          '#title' => t('File name'),
          '#default_value' => '[file:ffp:onlyname:original].[file:ffp:extension:original]',
        ),
      ),
    )
  );
}

/**
 * Implements hook_theme().
 */
function filefield_paths_theme() {
  return array(
    'filefield_paths_token_help' => array(
      'arguments' => array($types = array())
    ),
  );
}

function theme_filefield_paths_token_help($types) {
  $types = count($types) == 0 ? array('file', 'node', 'site', 'user') : $types;
  $full_list = token_info();
  $table = array(
    //'header' => array(t('Token'), t('Replacement value')),
    'rows' => array(),
    'attributes' => array('class' => 'description'),
  );

  foreach ($types as $type) {
    $table['rows'][] = array(array('data' => drupal_ucfirst($type) . ' ' . t('tokens'), 'class' => 'region', 'colspan' => 2));
    foreach ($full_list['tokens'][$type] as $token => $data) {
      $table['rows'][] = array(
        '[' . $type . ':' . $token . ']',
        $data['description'],
      );
    }
  }

  return theme('table', $table);
}

/**
 * Implements hook_init().
 */
function filefield_paths_init() {
  foreach (module_list() as $module) {
    if (file_exists($file = drupal_get_path('module', 'filefield_paths') . '/modules/' . $module . '.inc')) {
      require_once $file;
    }
  }
}

/**
 * Implements hook_form_alter().
 */
function filefield_paths_form_alter(&$form, $form_state, $form_id) {
  $ffp = array();

  // Invoke hook_filefield_paths_form_alter().
  foreach (module_implements('filefield_paths_form_alter') as $module) {
    $function = $module . '_filefield_paths_form_alter';
    $function($form, $ffp);
  }

  // If supporting module enabled, show FileField Paths settings form.
  if (count($ffp) > 0) {
    $fields = module_invoke_all('filefield_paths_field_settings');
    foreach ($ffp as $field_name => $field_data) {

      $results = db_query("SELECT * FROM {filefield_paths} WHERE type = :type AND field = :field", array(
        ':type' => $field_data['type'],
        ':field' => $field_name
      ));
      foreach ($results as $result) { break; }
      if (!empty($result)) {
        foreach ($fields as &$field) {
          $field['settings'] = unserialize($result->$field['sql']);
        }
        unset($field);
      }

      $count = 0;
      foreach ($fields as $name => $field) {
        $count++;

        if (isset($field['form']) && is_array($field['form'])) {
          $keys = array_keys($field['form']);
          for ($i = 1; $i < count($field['form']); $i++) {
            $field['form'][$keys[$i]]['#weight'] = ($count - 1) * 3 + 2 + $i;
          }
          unset($keys);

          $field_data['form_path'] = array_merge_recursive($field_data['form_path'], $field['form']);
        }

        $field_data['form_path']['#tree'] = TRUE;
        $field_data['form_path'][$name]['#weight'] = ($count - 1) * 3;

        // Set defualt value for patterns.
        if (isset($field['settings']['value'])) {
          $field_data['form_path'][$name]['#default_value'] = $field['settings']['value'];

          if (isset($field['data'])) {
            foreach ($field['data'] as $key => $value) {
              $field_data['form_path'][$value]['#default_value'] = $field['settings'][$key];
            }
          }
        }

        $field_data['form_path'][$name . '_cleanup'] = array(
          '#type' => 'fieldset',
          '#title' => t('!title cleanup settings', array('!title' => $field['title'])),
          '#collapsible' => TRUE,
          '#collapsed' => TRUE,
          '#weight' => ($count - 1) * 3 + 1,
          '#attributes' => array(
            'class' => array($name . ' cleanup')
          )
        );

        // Cleanup field with Pathauto module.
        $field_data['form_path'][$name . '_cleanup'][$name . '_pathauto'] = array(
          '#type' => 'checkbox',
          '#title' => t('Cleanup using Pathauto') . '.',
          '#default_value' => isset($field['settings']['pathauto'])
            ? $field['settings']['pathauto']
            : 0
          ,
          '#description' => t('Cleanup !title using !url', array('!title' => $field['title'], '!url' => l(t('Pathauto settings'), 'admin/build/path/pathauto'))),
        );
        if (!module_exists('pathauto')) {
          $field_data['form_path'][$name . '_cleanup'][$name . '_pathauto']['#disabled'] = TRUE;
          $field_data['form_path'][$name . '_cleanup'][$name . '_pathauto']['#default_value'] = 0;
        }

        // Convert field to lower case.
        $field_data['form_path'][$name . '_cleanup'][$name . '_tolower'] = array(
          '#type' => 'checkbox',
          '#title' => t('Convert to lower case') . '.',
          '#default_value' => isset($field['settings']['tolower'])
            ? $field['settings']['tolower']
            : 0
          ,
          '#description' => t('Convert !title to lower case', array('!title' => $field['title'])) . '.'
        );

        // Transliterate field with Transliteration module.
        $field_data['form_path'][$name . '_cleanup'][$name . '_transliterate'] = array(
          '#type' => 'checkbox',
          '#title' => t('Transliterate') . '.',
          '#default_value' => isset($field['settings']['transliterate'])
            ? $field['settings']['transliterate']
            : 0
          ,
          '#description' => t('Transliterate !title', array('!title' => $field['title'])) . '.'
        );
        if (!module_exists('transliteration')) {
          $field_data['form_path'][$name . '_cleanup'][$name . '_transliterate']['#disabled'] = TRUE;
          $field_data['form_path'][$name . '_cleanup'][$name . '_transliterate']['#default_value'] = 0;
        }

        // Replacement patterns for field.
        $field_data['form_path'][$name . '_tokens'] = array(
          '#type' => 'fieldset',
          '#title' => t('!title replacement patterns', array('!title' => $field['title'])),
          '#collapsible' => TRUE,
          '#collapsed' => TRUE,
          '#description' => theme('filefield_paths_token_help'),
          '#weight' => ($count - 1) * 3 + 2,
          '#attributes' => array(
            'class' => array($name . ' tokens')
          )
        );
      }

      // Retroactive updates.
      $field_data['form_path']['retroactive_update'] = array(
        '#type' => 'checkbox',
        '#title' => t('Retroactive update'),
        '#description' => t('Move and rename previously uploaded files') . '.' .
          '<br /> <strong style="color: #FF0000;">' . t('Warning') . ':</strong> ' .
          t('This feature should only be used on developmental servers or with extreme caution') . '.',
        '#weight' => 10
      );

      // Active updating.
      $field_data['form_path']['active_updating'] = array(
        '#type' => 'checkbox',
        '#title' => t('Active updating'),
        '#default_value' => variable_get("ffp_{$field_data['type']}_{$field_name}", 0),
        '#description' => t('Actively move and rename previously uploaded files as required') . '.' .
          '<br /> <strong style="color: #FF0000;">' . t('Warning') . ':</strong> ' .
          t('This feature should only be used on developmental servers or with extreme caution') . '.',
        '#weight' => 11
      );

      if (!in_array('filefield_paths_form_submit', $form['#submit'])) {
        $form['#submit'][] = 'filefield_paths_form_submit';
      }
    }
  }
}

/**
 * Implements hook_form_submit().
 */
function filefield_paths_form_submit($form, &$form_state) {
  $ffp = array();

  // Invoke hook_filefield_paths_form_submit().
  foreach (module_implements('filefield_paths_form_submit') as $module) {
    $function = $module . '_filefield_paths_form_submit';
    $function($form_state, $ffp);
  }

  if (count($ffp) > 0) {
    $retroactive_update = FALSE;
    $fields = module_invoke_all('filefield_paths_field_settings');
    foreach ($ffp as $field_name => $field_data) {
      $cols = array();

      foreach ($fields as $name => &$field) {
        $field['settings'] = array(
          'value' => $form_state['values']['ffp_' . $field_name][$name],
          'tolower' => $form_state['values']['ffp_' . $field_name][$name . '_cleanup'][$name . '_tolower'],
          'pathauto' => $form_state['values']['ffp_' . $field_name][$name . '_cleanup'][$name . '_pathauto'],
          'transliterate' => $form_state['values']['ffp_' . $field_name][$name . '_cleanup'][$name . '_transliterate']
        );

        // Store additional settings from addon modules.
        if (isset($field['data'])) {
          foreach ($field['data'] as $key => $value) {
            $field['settings'][$key] = $form_state['values']['ffp_' . $field_name][$value];
          }
        }

        $cols[$field['sql']] = serialize($field['settings']);
      }

      $results = db_query(
        "SELECT * FROM {filefield_paths} WHERE type = :type AND field = :field", array(
        ':type' => $field_data['type'],
        ':field' => $field_name
      ));
      foreach ($results as $result) { break; }

      // Update existing entry.
      if (!empty($result)) {
        db_update('filefield_paths')
          ->fields($cols)
          ->condition('type', $field_data['type'])
          ->condition('field', $field_name)
          ->execute();
      }

      // Create new entry.
      else {
        db_insert('filefield_paths')
          ->fields(array_merge(array(
            'type' => $field_data['type'],
            'field' => $field_name,
          ), $cols))
          ->execute();
      }

      if ($form_state['values']['ffp_' . $field_name]['retroactive_update']) {
        $retroactive_update = TRUE;
        $module = isset($form['#field']) ? $form['#field']['module'] : $field_name;
        filefield_paths_batch_update($module, $field_name, arg(4));
      }

      variable_set("ffp_{$field_data['type']}_{$field_name}", $form_state['values']['ffp_' . $field_name]['active_updating']);
    }

    if ($retroactive_update) {
      // Run batch.
      batch_process($form_state['redirect']);
    }
  }
}

function filefield_paths_batch_update($module, $field, $type) {
  $objects = array();

  // Invoke hook_filefield_paths_batch_update().
  if (function_exists($function = $module . '_filefield_paths_batch_update')) {
    $function($field, str_replace('-', '_', $type), $objects);
  }

  // Create batch.
  $batch = array(
    'title' => t('Updating FileField Paths'),
    'operations' => array(
      array('_filefield_paths_batch_update_process', array($objects, $module, $field))
    ),
  );
  batch_set($batch);
}

function _filefield_paths_batch_update_process($objects, $module, $field, &$context) {
  if (!isset($context['sandbox']['progress'])) {
    $context['sandbox']['progress'] = 0;
    $context['sandbox']['max'] = count($objects);
    $context['sandbox']['objects'] = $objects;
  }

  // Process nodes by groups of 5.
  $count = min(5, count($context['sandbox']['objects']));
  for ($i = 1; $i <= $count; $i++) {
    // For each oid, load the object, update the files and save it.
    $oid = array_shift($context['sandbox']['objects']);

    // Invoke hook_filefield_paths_update().
    if (function_exists($function = $module . '_filefield_paths_update')) {
      $function($oid, $field);
    }

    // Update our progress information.
    $context['sandbox']['progress']++;
  }

  // Inform the batch engine that we are not finished,
  // and provide an estimation of the completion level we reached.
  if ($context['sandbox']['progress'] != $context['sandbox']['max']) {
    $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
  }
}

/**
 * Implements hook_node_insert().
 */
function filefield_paths_node_insert($node) {
  filefield_paths_node_update($node);
}

/**
 * Implements hook_node_update().
 */
function filefield_paths_node_update($node) {
  if (($ffp = filefield_paths_get_fields($node)) !== FALSE) {
    $update = new stdClass;
    $update->node = FALSE;

    // Process files.
    foreach ($ffp['#files'] as &$file) {
      // Invoke hook_filefield_paths_process_file().
      foreach (module_implements('filefield_paths_process_file') as $module) {
        $function = $module . '_filefield_paths_process_file';
        $function(($file['new'] || variable_get("ffp_{$node->type}_{$file['name']}", 0)), $file, $ffp['#settings'][$file['name']], $node, $update);
      }
    }

    field_attach_update('node', $node);

//  // Cleanup temporary paths.
//  if ($ffp['#settings']) {
//    foreach ($ffp['#settings'] as $name => $field) {
//      $paths = explode('/', $field['filepath']['value']);
//      filefield_paths_cleanup_temp($paths);
//
//      // Invoke hook_filefield_paths_cleanup().
//      foreach (module_implements('filefield_paths_cleanup') as $module) {
//        $function = $module . '_filefield_paths_cleanup';
//        $function($ffp, $paths, $name);
//      }
//    }
//  }
  }
}

/**
 * Implementation of hook_content_fieldapi().
 */
function filefield_paths_field_delete_field($field) {
  db_delete('filefield_paths')
    ->condition('type', $field['bundles']['node'][0])
    ->condition('field', $field['field_name'])
    ->execute();
}

//function filefield_paths_cleanup_temp($paths) {
//  while ($paths) {
//    if (@rmdir(file_directory_path() . '/' . implode('/', $paths)) === TRUE) {
//      array_pop($paths);
//      continue;
//    }
//    break;
//  }
//}

function filefield_paths_get_fields(&$node, $op = NULL) {
  $ffp = array();

  // Invoke hook_filefield_paths_get_fields().
  foreach (module_implements('filefield_paths_get_fields') as $module) {
    $function = $module . '_filefield_paths_get_fields';
    $function($node, $ffp);
  }

  if (count($ffp) == 0 || (isset($ffp['#types']) && !is_array($ffp['#types']))) {
    return FALSE;
  }

  $fields = module_invoke_all('filefield_paths_field_settings');

  // Load fields settings
  foreach ($ffp['#types'] as $name => $temp) {
    $results = db_query("SELECT * FROM {filefield_paths} WHERE type = :type AND field = :field", array(
      ":type" => $node->type,
      ":field" => $name
    ));
    foreach ($results as $result) { break; }

    if (!empty($result)) {
      foreach ($fields as $field) {
        $ffp['#settings'][$name][$field['sql']] = unserialize($result->$field['sql']);
      }
    }
  }

  return $ffp;
}

/**
 * Implements hook_filefield_paths_process_file().
 */
function filefield_paths_filefield_paths_process_file($new, &$file, $settings, &$node, &$update) {
  if ($new) {
    global $user;
    $token_data = array('file' => file_load($file['field']['fid']), 'node' => $node, 'user' => $user);

    // Process filename.
    $file['filename']['old'] = $file['field']['filename'];
    $file['filename']['new'] = (($settings['filename']['value']) != '')
      ? filefield_paths_process_string($settings['filename']['value'], $token_data, $settings['filename'])
      : $file['field']['filename'];

    // Process filepath.
    $file['filepath']['old'] = $file['field']['uri'];
    $file['filepath']['new'] = file_uri_scheme($file['field']['uri']) . '://' . filefield_paths_process_string($settings['filepath']['value'] . '/' . $file['filename']['new'], $token_data, $settings['filepath']);

    // Finalize files if necessary.
    if (dirname($file['filepath']['new']) != dirname($file['field']['uri']) || $file['filename']['new'] != $file['field']['uri']) {
      if (file_prepare_directory(dirname($file['filepath']['new']), FILE_CREATE_DIRECTORY) && file_move((object) $file['field'], $file['filepath']['new'])) {

        // Fix reference to old paths.
        $file_directory_path = file_uri_scheme($file['field']['uri']) !== 'private' ? file_directory_path(file_uri_scheme($file['field']['uri'])) : 'system/files';

        $pattern = array(
          'regex' => str_replace('/', '\/', $file_directory_path) . '([^"]*?)' . str_replace('/', '\/', str_replace(file_directory_path(), '', file_uri_target($file['filepath']['old']))),
          'regex_enc' => str_replace('/', '\/', drupal_encode_path($file_directory_path)) . '([^"]*?)' . str_replace('/', '\/', str_replace(drupal_encode_path(file_directory_path()), '', drupal_encode_path(file_uri_target($file['filepath']['old'])))),
          'replace' => $file_directory_path . '$1' . str_replace(file_directory_path(), '', file_uri_target($file['filepath']['new'])),
        );

        // TODO: Replace with field_info_fields() when http://drupal.org/node/613754 is fixed.
        $instances = field_info_instances('node', $node->type);
        $fields = array();
        foreach ($instances as $field_name => $instance) {
          $fields[$field_name] = field_info_field($field_name);
        }

        foreach ($fields as $name => $field) {
          if ($field['module'] == 'text' && isset($node->{$field['field_name']}) && is_array($node->{$field['field_name']})) {
            foreach ($node->{$field['field_name']}['zxx'] as &$item) {
              $original = $item['value'];
              $item['value'] = (preg_match('/' . $pattern['regex'] . '/s', $item['value']))
                ? preg_replace('/' . $pattern['regex'] . '/s', $pattern['replace'], $item['value'])
                : preg_replace('/' . $pattern['regex_enc'] . '/s', $pattern['replace'], $item['value']);

              if ($item['value'] !== $original) {
                $update->node = TRUE;
              }
            }
          }
        }

        // Store new filename in file Array
        $file['field']['filename'] = $file['filename']['new'];
        $file['field']['uri'] = $file['filepath']['new'];
      }
    }

    // Replace description.
    //if ($file['field']['description'] == $file['filename']['old']) {
    //  $file['field']['description'] = $file['filename']['new'];
    //}
  }
}

/**
 * Implements hook_token_info().
 */
function filefield_paths_token_info() {
  $file['ffp:onlyname'] = array(
    'name' => t("File name"),
    'description' => t("File name without extension."),
  );
  $file['ffp:onlyname:original'] = array(
    'onlyname' => t("File name - original"),
    'description' => t("File name without extension - original."),
  );
  $file['ffp:extension'] = array(
    'name' => t("File extension"),
    'description' => t("File extension."),
  );
  $file['ffp:extension:original'] = array(
    'name' => t("File extension - original"),
    'description' => t("File extension - original."),
  );

  return array(
    'tokens' => array('file' => $file),
  );
}

/**
 * Implements hook_tokens().
 */
function filefield_paths_tokens($type, $tokens, array $data = array(), array $options = array()) {
  $url_options = array('absolute' => TRUE);
  if (isset($language)) {
    $url_options['language'] = $language;
  }
  $sanitize = !empty($options['sanitize']);

  $replacements = array();

  if ($type == 'file' && !empty($data['file'])) {
    $file = $data['file'];

    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'ffp:onlyname':
          $info = pathinfo($file->filename);
          // PHP < 5.2: pathinfo() doesn't return 'filename' variable.
          $replacements[$original] = isset($orig['filename']) ? $info['filename'] : basename($file->filename, '.' . $info['extension']);
          break;

        case 'ffp:onlyname:original':
          $info = pathinfo($file->origname);
          // PHP < 5.2: pathinfo() doesn't return 'filename' variable.
          $replacements[$original] = isset($orig['filename']) ? $info['filename'] : basename($file->origname, '.' . $info['extension']);
          break;

        case 'ffp:extension':
          $info = pathinfo($file->filename);
          $replacements[$original] = $info['extension'];
          break;

        case 'ffp:extension:original':
          $info = pathinfo($file->origname);
          $replacements[$original] = $info['extension'];
          break;
      }
    }
  }

  return $replacements;
}

/**
 * Process and cleanup strings.
 */
function filefield_paths_process_string($value, $data, $settings = array()) {
  // Process string tokens.
  $value = token_replace($value, $data);

  // Transliterate string.
  if (module_exists('transliteration') && isset($settings['transliterate']) && $settings['transliterate']) {
    $value = transliteration_get($value);
    if ($type == 'field') {
      $paths = explode('/', $value);
      foreach ($paths as &$path) {
        $path = transliteration_clean_filename($path);
      }

      $value = implode('/', $paths);
    }
  }

  // Convert string to lower case.
  if ((isset($settings['tolower']) && $settings['tolower']) || (isset($settings['pathauto']) && $settings['pathauto'] && variable_get('pathauto_case', 0))) {
    // Convert string to lower case
    $value = drupal_strtolower($value);
  }

  // Ensure that there are no double-slash sequences due to empty token values.
  $value = preg_replace('/\/+/', '/', $value);

  return $value;
}

/**
 * Implements hook_file_insert().
 */
function filefield_paths_file_insert(&$file) {
  // Store original filename in the database.
  if (empty($file->origname)) {
    $file->origname = $file->filename;
    db_update('file')
      ->fields(array('origname' => $file->filename))
      ->condition('fid', $file->fid)
      ->execute();
  }
}