file_entity.admin.inc in File Entity (fieldable files) 7

Administrative interface for file type configuration.

File

file_entity.admin.inc

<?php

require_once dirname(__FILE__) . '/file_entity.pages.inc';

/**
 * @file
 * Administrative interface for file type configuration.
 */

/**
 * Administrative form for browsing files and performing operations on them.
 */
function file_entity_admin_files($form, &$form_state) {
  if (!empty($form_state['values']['operation'])) {

    // The form is being rebuilt because an operation requiring confirmation
    // was selected.  Hand off to the callback of the operation at this point
    // which should return a confirm form.
    $operation = $form_state['values']['operation'];
    $files = array_keys(array_filter($form_state['values']['files']));
    return call_user_func_array($operation['callback'], array(
      $files,
    ));
  }
  $limit = variable_get('file_entity_admin_files_limit', 50);

  // Build the 'Update options' form.
  $form['options'] = array(
    '#type' => 'fieldset',
    '#title' => t('Update options'),
    '#attributes' => array(
      'class' => array(
        'container-inline',
      ),
    ),
  );
  $options = array();
  $form['#operations'] = module_invoke_all('file_operations_info');
  drupal_alter('file_entity_file_operations', $form['#operations']);
  foreach ($form['#operations'] as $operation => $array) {
    $options[$operation] = $array['label'];
  }
  $form['options']['operation'] = array(
    '#type' => 'select',
    '#title' => t('Operation'),
    '#title_display' => 'invisible',
    '#options' => $options,
  );
  $form['options']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Update'),
  );

  // Build the sortable table header.
  $header = array(
    'title' => array(
      'data' => t('Title'),
      'field' => 'f.filename',
    ),
    'type' => array(
      'data' => t('Type'),
      'field' => 'f.filemime',
    ),
    'size' => array(
      'data' => t('Size'),
      'field' => 'f.filesize',
    ),
    'author' => array(
      'data' => t('Author'),
      'field' => 'u.name',
    ),
    'timestamp' => array(
      'data' => t('Updated'),
      'field' => 'f.timestamp',
      'sort' => 'desc',
    ),
    'operations' => array(
      'data' => t('Operations'),
    ),
  );
  $query = db_select('file_managed', 'f');
  $query
    ->join('users', 'u', 'f.uid = u.uid');
  $query
    ->extend('PagerDefault')
    ->extend('TableSort')
    ->fields('f', array(
    'fid',
  ))
    ->fields('u', array(
    'uid',
  ))
    ->condition('f.status', FILE_STATUS_PERMANENT)
    ->limit($limit)
    ->orderByHeader($header);
  foreach (array_keys(file_entity_get_hidden_stream_wrappers()) as $name) {
    $query
      ->condition('f.uri', $name . '%', 'NOT LIKE');
  }
  $result = $query
    ->execute()
    ->fetchAllKeyed();
  $files = file_load_multiple(array_keys($result));
  $form['#files'] = $files;

  // This is used to add usernames to the table below.
  $accounts = user_load_multiple(array_values($result));
  $destination = drupal_get_destination();
  $options = array();
  foreach ($files as $file) {
    $options[$file->fid] = array(
      'title' => theme('file_entity_file_link', array(
        'file' => $file,
      )),
      'type' => check_plain($file->filemime),
      'size' => format_size($file->filesize),
      'author' => theme('username', array(
        'account' => $accounts[$file->uid],
      )),
      'timestamp' => format_date($file->timestamp, 'short'),
    );
    $options[$file->fid]['operations'] = array(
      'data' => array(
        '#theme' => 'links__file_operations',
        '#links' => array(),
        '#attributes' => array(
          'class' => array(
            'links',
            'inline',
          ),
        ),
      ),
    );
    $options[$file->fid]['operations']['data']['#links']['edit'] = array(
      'title' => t('edit'),
      'href' => 'file/' . $file->fid . '/edit',
      'query' => $destination,
    );
    $options[$file->fid]['operations']['data']['#links']['delete'] = array(
      'title' => t('delete'),
      'href' => 'file/' . $file->fid . '/delete',
      'query' => $destination,
    );
  }
  $form['files'] = array(
    '#type' => 'tableselect',
    '#header' => $header,
    '#options' => $options,
    '#empty' => t('No files available.'),
    '#attributes' => array(
      'class' => array(
        'file-display-table',
        'clear',
      ),
    ),
  );
  $form['pager'] = array(
    '#markup' => theme('pager', array(
      'tags' => NULL,
    )),
  );
  return $form;
}

/**
 * Validate file_entity_admin_files form submissions.
 *
 * Check if any files have been selected to perform the chosen
 * 'Update option' on.
 */
function file_entity_admin_files_validate($form, &$form_state) {
  $files = array_filter($form_state['values']['files']);
  if (count($files) == 0) {
    form_set_error('', t('Update operation failed: no files were selected.'));
  }
}

/**
 * Submit handler for file_entity_admin_files.
 */
function file_entity_admin_files_submit($form, &$form_state) {
  $operations = $form['#operations'];
  $operation = $operations[$form_state['values']['operation']];

  // In the case of an operation which needs confirmation, rebuild the form.
  if (!empty($operation['confirm'])) {
    $form_state['rebuild'] = TRUE;
    $form_state['values']['operation'] = $operation;
    return;
  }

  // Filter out unchecked nodes
  $files = array_filter($form_state['values']['files']);
  if ($function = $operation['callback']) {

    // Add in callback arguments if present.
    if (isset($operation['callback arguments'])) {
      $args = array_merge(array(
        $files,
      ), $operation['callback arguments']);
    }
    else {
      $args = array(
        $files,
      );
    }
    call_user_func_array($function, $args);
    cache_clear_all();
  }
}

/**
 * Displays the file type admin overview page.
 */
function file_entity_list_types_page() {
  $types = file_info_file_types();
  $entity_info = entity_get_info('file');
  $field_ui = module_exists('field_ui');
  $header = array(
    array(
      'data' => t('Name'),
    ),
    array(
      'data' => t('Operations'),
      'colspan' => $field_ui ? '3' : '1',
    ),
  );
  $rows = array();
  foreach ($types as $type => $info) {
    $row = array(
      array(
        'data' => theme('file_entity_file_type_overview', $info),
      ),
    );
    $path = isset($entity_info['bundles'][$type]['admin']['real path']) ? $entity_info['bundles'][$type]['admin']['real path'] : NULL;
    if ($field_ui) {
      $row[] = array(
        'data' => isset($path) ? l(t('manage fields'), $path . '/fields') : '',
      );
      $row[] = array(
        'data' => isset($path) ? l(t('manage display'), $path . '/display') : '',
      );
    }
    $row[] = array(
      'data' => isset($path) ? l(t('manage file display'), $path . '/file-display') : '',
    );
    $rows[] = $row;
  }
  $build['file_type_table'] = array(
    '#theme' => 'table',
    '#header' => $header,
    '#rows' => $rows,
    '#empty' => t('No file types available.'),
  );
  return $build;
}

/**
 * Form callback; presents file display settings for a given view mode.
 */
function file_entity_file_display_form($form, &$form_state, $file_type, $view_mode) {
  $form['#file_type'] = $file_type;
  $form['#view_mode'] = $view_mode;
  $form['#tree'] = TRUE;
  $form['#attached']['js'][] = drupal_get_path('module', 'file_entity') . '/file_entity.admin.js';

  // Retrieve available formatters for this file type and load all configured
  // filters for existing text formats.
  $formatters = file_info_formatter_types();
  foreach ($formatters as $name => $formatter) {
    if (isset($formatter['file types']) && !in_array($file_type, $formatter['file types'])) {
      unset($formatters[$name]);
    }
  }
  $current_displays = file_displays_load($file_type, $view_mode, TRUE);
  foreach ($current_displays as $name => $display) {
    $current_displays[$name] = (array) $display;
  }

  // Formatter status.
  $form['displays']['status'] = array(
    '#type' => 'item',
    '#title' => t('Enabled displays'),
    '#prefix' => '<div id="file-displays-status-wrapper">',
    '#suffix' => '</div>',
  );
  $i = 0;
  foreach ($formatters as $name => $formatter) {
    $form['displays']['status'][$name] = array(
      '#type' => 'checkbox',
      '#title' => check_plain($formatter['label']),
      '#default_value' => !empty($current_displays[$name]['status']),
      '#description' => isset($formatter['description']) ? filter_xss($formatter['description']) : NULL,
      '#parents' => array(
        'displays',
        $name,
        'status',
      ),
      '#weight' => (isset($formatter['weight']) ? $formatter['weight'] : 0) + $i / 1000,
    );
    $i++;
  }

  // Formatter order (tabledrag).
  $form['displays']['order'] = array(
    '#type' => 'item',
    '#title' => t('Display precedence order'),
    '#theme' => 'file_entity_file_display_order',
  );
  foreach ($formatters as $name => $formatter) {
    $form['displays']['order'][$name]['label'] = array(
      '#markup' => check_plain($formatter['label']),
    );
    $form['displays']['order'][$name]['weight'] = array(
      '#type' => 'weight',
      '#title' => t('Weight for @title', array(
        '@title' => $formatter['label'],
      )),
      '#title_display' => 'invisible',
      '#delta' => 50,
      '#default_value' => isset($current_displays[$name]['weight']) ? $current_displays[$name]['weight'] : 0,
      '#parents' => array(
        'displays',
        $name,
        'weight',
      ),
    );
    $form['displays']['order'][$name]['#weight'] = $form['displays']['order'][$name]['weight']['#default_value'];
  }

  // Formatter settings.
  $form['display_settings_title'] = array(
    '#type' => 'item',
    '#title' => t('Display settings'),
  );
  $form['display_settings'] = array(
    '#type' => 'vertical_tabs',
  );
  $i = 0;
  foreach ($formatters as $name => $formatter) {
    if (isset($formatter['settings callback']) && ($function = $formatter['settings callback']) && function_exists($function)) {
      $defaults = !empty($formatter['default settings']) ? $formatter['default settings'] : array();
      $settings = !empty($current_displays[$name]['settings']) ? $current_displays[$name]['settings'] : array();
      $settings += $defaults;
      $settings_form = $function($form, $form_state, $settings, $name, $file_type, $view_mode);
      if (!empty($settings_form)) {
        $form['displays']['settings'][$name] = array(
          '#type' => 'fieldset',
          '#title' => check_plain($formatter['label']),
          '#parents' => array(
            'displays',
            $name,
            'settings',
          ),
          '#group' => 'display_settings',
          '#weight' => (isset($formatter['weight']) ? $formatter['weight'] : 0) + $i / 1000,
        ) + $settings_form;
      }
    }
    $i++;
  }
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );
  return $form;
}

/**
 * Process file display settings form submissions.
 */
function file_entity_file_display_form_submit($form, &$form_state) {
  $file_type = $form['#file_type'];
  $view_mode = $form['#view_mode'];
  $displays = isset($form_state['values']['displays']) ? $form_state['values']['displays'] : array();
  $displays_original = file_displays_load($file_type, $view_mode, TRUE);
  foreach ($displays as $formatter_name => $display) {
    $display_original = isset($displays_original[$formatter_name]) ? $displays_original[$formatter_name] : file_display_new($file_type, $view_mode, $formatter_name);
    $display += (array) $display_original;
    file_display_save((object) $display);
  }
  drupal_set_message(t('Your settings have been saved.'));
}

/**
 * Returns HTML for a file type label and description for the file type admin overview page.
 */
function theme_file_entity_file_type_overview($variables) {
  return check_plain($variables['label']) . '<div class="description">' . $variables['description'] . '</div>';
}

/**
 * Returns HTML for a file display's display order table.
 */
function theme_file_entity_file_display_order($variables) {
  $element = $variables['element'];
  $rows = array();
  foreach (element_children($element, TRUE) as $name) {
    $element[$name]['weight']['#attributes']['class'][] = 'file-display-order-weight';
    $rows[] = array(
      'data' => array(
        drupal_render($element[$name]['label']),
        drupal_render($element[$name]['weight']),
      ),
      'class' => array(
        'draggable',
      ),
    );
  }
  $output = drupal_render_children($element);
  $output .= theme('table', array(
    'rows' => $rows,
    'attributes' => array(
      'id' => 'file-displays-order',
    ),
  ));
  drupal_add_tabledrag('file-displays-order', 'order', 'sibling', 'file-display-order-weight', NULL, NULL, TRUE);
  return $output;
}

Functions

Name	Description
file_entity_admin_files	Administrative form for browsing files and performing operations on them.
file_entity_admin_files_submit	Submit handler for file_entity_admin_files.
file_entity_admin_files_validate	Validate file_entity_admin_files form submissions.
file_entity_file_display_form	Form callback; presents file display settings for a given view mode.
file_entity_file_display_form_submit	Process file display settings form submissions.
file_entity_list_types_page	Displays the file type admin overview page.
theme_file_entity_file_display_order	Returns HTML for a file display's display order table.
theme_file_entity_file_type_overview	Returns HTML for a file type label and description for the file type admin overview page.