users_export.admin.inc in Users Export 7.2

Administration page callbacks for the users_export module.

File

includes/users_export.admin.inc

<?php

/**
 * @file
 * Administration page callbacks for the users_export module.
 *
 * @ingroup users_export
 */

/**
 * Form builder. Configure users_export.
 *
 * @ingroup forms
 * @see system_settings_form()
 */
function users_export_form($form, &$form_state) {
  $info = loft_data_grids_export_info();

  // See if we get our visibiltiy using the new method.
  $options = loft_data_grids_exporter_options(TRUE, FALSE, FALSE);
  $needs_migrate = FALSE;
  if (empty($options)) {

    // So if there are no options because no perms have been set
    // we'll go ahead and rely on the older permissions and alert user
    // in a later update we'll remove these the hook_perms altogether.
    $options = loft_data_grids_exporter_options(FALSE, FALSE, FALSE);
    $needs_migrate = TRUE;
    foreach (array_keys($options) as $key) {
      if (!user_access('users_export:export as ' . $key)) {
        unset($options[$key]);
      }
    }
  }
  if ($needs_migrate && $options) {
    drupal_set_message(t('Please <a href="!url">go here</a> and transfer your <em>Users Export: Export As...</em> permissions to <em>Loft Data Grids: Visible in UI...</em> permissions as soon as possible.', array(
      '!url' => url('admin/people/permissions', array(
        'query' => drupal_get_destination(),
      )),
    )), 'warning', FALSE);
  }
  $form['#attached']['js'][] = array(
    'type' => 'file',
    'data' => drupal_get_path('module', 'users_export') . '/users_export.js',
    'scope' => 'footer',
  );
  $form['#attached']['js'][] = array(
    'type' => 'setting',
    'data' => array(
      'usersExport' => loft_data_grids_export_info(),
    ),
    'scope' => 'footer',
  );
  $class = variable_get('users_export_type', 'CSVExporter');
  $type = $info[$class]['extension'];
  $form['users_export_type'] = array(
    '#type' => 'select',
    '#title' => t('Export file format'),
    '#default_value' => $class,
    '#options' => $options,
  );
  $default = variable_get('users_export_filename', strtolower(preg_replace('/\\W+/', '_', variable_get('site_name', 'users_export')) . '_users'));
  $form['users_export_filename'] = array(
    '#type' => 'textfield',
    '#title' => t('Filename to save as'),
    '#default_value' => $default,
    '#required' => TRUE,
    '#field_suffix' => $type,
  );
  $test_mode = variable_get('users_export_test_mode', FALSE);
  $form['users_export_test_mode'] = array(
    '#type' => 'checkbox',
    '#title' => t('Preview mode (Enable to limit the export to only the first 10 users to check formatting.)'),
    '#default_value' => $test_mode,
  );
  $form['basic_filters'] = array(
    '#type' => 'fieldset',
    '#title' => t('Basic Filters'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['advanced'] = array(
    '#type' => 'fieldset',
    '#title' => t('Advanced Settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['basic_filters']['users_export_login_frequency'] = array(
    '#type' => 'select',
    '#title' => t('Login Frequency'),
    '#default_value' => variable_get('users_export_login_frequency', 2),
    '#options' => array(
      2 => t('All Users'),
      1 => t('Get users who have logged in at least one time'),
      0 => t('Get users who have never logged in'),
    ),
  );

  // Add field to add 'blocked' users to the export as well.
  $form['basic_filters']['users_export_user_status'] = array(
    '#type' => 'select',
    '#title' => t('Export users with status'),
    '#default_value' => variable_get('users_export_user_status', 1),
    '#options' => array(
      1 => t('Active'),
      0 => t('Blocked'),
      2 => t('Both active and blocked'),
    ),
  );
  $form['basic_filters']['users_export_filter_by_role'] = [
    '#type' => 'radios',
    '#title' => t('Filter by role?'),
    '#options' => [
      0 => t('No'),
      1 => t('Yes'),
    ],
    '#default_value' => 0,
  ];
  $roles = user_roles(TRUE);
  $form['basic_filters']['users_export_user_role'] = [
    '#type' => 'checkboxes',
    '#title' => t('Export users with role'),
    '#options' => $roles,
    '#default_value' => array_keys($roles),
    '#states' => array(
      'invisible' => array(
        ':input[name="users_export_filter_by_role"]' => array(
          'value' => 0,
        ),
      ),
    ),
  ];
  $form['basic_filters']['users_export_order'] = array(
    '#type' => 'select',
    '#title' => t('Order of results'),
    '#default_value' => 0,
    '#options' => array(
      0 => t('Default (uid)'),
      1 => t('Username A-Z'),
      2 => t('E-mail A-Z'),
    ),
  );
  if (module_exists('date')) {
    $options = array();
    foreach (date_format_type_options() as $type => $title) {
      $type = date_format_type_format($type);
      $options[$type] = $title;
    }

    // Now add in those we think most users will want to use.
    $options += array(
      DATE_FORMAT_DATETIME => 'Datetime (' . date(DATE_FORMAT_DATETIME) . ')',
      DATE_FORMAT_UNIX => 'Unix Timestamp (' . date(DATE_FORMAT_UNIX) . ')',
      DATE_FORMAT_ISO => 'ISO 8601 (' . date(DATE_FORMAT_ISO) . ')',
      DATE_FORMAT_ICAL => 'iCal (' . date(DATE_FORMAT_ICAL) . ')',
    );
    $form['advanced']['users_export_date_format'] = array(
      '#type' => 'select',
      '#title' => t('Date format'),
      '#default_value' => variable_get('users_export_date_format', DATE_FORMAT_DATETIME),
      '#options' => $options,
    );
  }
  else {
    $form['advanced']['users_export_date_format'] = array(
      '#type' => 'hidden',
      '#value' => USERS_EXPORT_DEFAULT_DATE_FORMAT,
      '#prefix' => t('Enable the <a href="!url" target="blank">date module</a> to be able to control date formatting.', array(
        '!url' => url('https://drupal.org/project/date'),
      )),
    );
  }
  $options = array(
    -1 => t('- Default -'),
  );
  foreach (range(128, 2048, 32) as $value) {
    $options[$value . 'M'] = format_size($value * 1024 * 1024);
  }
  $form['advanced']['users_export_memory_limit'] = array(
    '#type' => 'select',
    '#title' => t('Memory Limit', array(
      '@size' => format_size(variable_get('users_export_last_export_memory', 0)),
    )),
    '#description' => t('If you have many users you may need to set this value higher so you the web server does not run out of memory processing the export. <strong>Depending upon your server configuration, this may or may not have any effect!</strong> For more information refer to <a href="http://php.net/manual/en/function.ini-set.php" target="blank">http://php.net/manual/en/function.ini-set.php</a>.'),
    '#default_value' => variable_get('users_export_memory_limit', 160),
    '#options' => $options,
  );
  $options = array(
    -1 => t('- Default -'),
  );
  foreach (range(30, 1800, 30) as $value) {
    $options[$value] = format_interval($value);
  }
  $form['advanced']['users_export_max_execution'] = array(
    '#type' => 'select',
    '#title' => t('Maximum Execution Time', array(
      '@time' => format_interval(variable_get('users_export_last_export_time', 0)),
    )),
    '#description' => t('If you have many users you may need to set this value higher so you the web server does not timeout. <strong>Depending upon your server configuration, this may or may not have any effect!</strong> For more information refer to <a href="http://php.net/manual/en/function.set-time-limit.php" target="blank">http://php.net/manual/en/function.set-time-limit.php</a>.'),
    '#default_value' => variable_get('users_export_max_execution', 60),
    '#options' => $options,
  );
  $form = system_settings_form($form);
  $form['actions']['submit']['#value'] = t('Download File');
  $form['#submit'][] = 'users_export_form_submit';
  return $form;
}

/**
 * Form submission handler.
 */
function users_export_form_submit($form, &$form_state) {
  $values = $form_state['values'];
  if ($values['users_export_memory_limit'] != -1) {
    ini_set('memory_limit', $values['users_export_memory_limit']);
  }
  if ($values['users_export_max_execution'] != -1) {
    set_time_limit($values['users_export_max_execution']);
  }

  // Load the users.
  $query = db_select('users', 'u');
  $query
    ->fields('u', array(
    'uid',
    'name',
    'status',
  ));
  $query
    ->addField('u', 'mail', 'email');
  $query
    ->addField('u', 'created');
  $query
    ->addField('u', 'access', 'last_access');
  $query
    ->addField('u', 'login', 'last_login');

  // Exclude anonymous.
  $query
    ->condition('u.uid', 0, '<>');

  // Add status condition based on setting.
  $status = $values['users_export_user_status'] * 1;
  switch ($status) {
    case 0:
      $query
        ->condition('status', 0);
      break;
    case 1:
      $query
        ->condition('status', 1);
      break;
    case 2:

      // Do not add a status condition because admin wants both.
      break;
  }
  if (isset($values['users_export_login_frequency']) && $values['users_export_login_frequency'] != 2) {
    switch ($values['users_export_login_frequency']) {
      case 0:
        $operator = '=';
        break;
      case 1:
        $operator = '<>';
        break;
      default:
        $operator = '<>';
    }
    $query
      ->condition('u.access', 0, $operator);
  }
  if ($values['users_export_filter_by_role'] == 1 && !empty($values['users_export_user_role'])) {
    $roles = array_filter($values['users_export_user_role']);

    // If selected "authenticated user" option return all users.
    if (!array_search(DRUPAL_AUTHENTICATED_RID, $roles)) {
      $query
        ->leftJoin('users_roles', 'ur', 'u.uid = ur.uid');
      $query
        ->condition('ur.rid', $roles, 'in');
    }
  }
  if ($values['users_export_test_mode']) {
    $query
      ->range(0, 10);
  }
  if ($values['users_export_order']) {
    $order = $values['users_export_order'];
    switch ($order) {
      case 1:
        $query
          ->orderBy('u.name', 'asc');
        break;
      case 2:
        $query
          ->orderBy('u.mail', 'asc');
        break;
      default:
        $query
          ->orderBy('u.uid');
    }
  }
  else {
    $query
      ->orderBy('u.uid');
  }
  $result = $query
    ->execute();
  $data = loft_data_grids_export_data();
  $date_format = $values['users_export_date_format'];
  $context = array(
    'settings' => $values,
    'data' => $data,
  );

  // Go through and create a row for each user.
  foreach ($result as $row) {
    $row = $context['original_row'] = (array) $row;
    $row['last_login'] = empty($row['last_login']) ? '' : date($date_format, $row['last_login']);
    $row['last_access'] = empty($row['last_access']) ? '' : date($date_format, $row['last_access']);
    $row['created'] = empty($row['created']) ? '' : date($date_format, $row['created']);
    drupal_alter('users_export_row', $row, $row['uid'], $context);
    foreach ($row as $key => $value) {
      $data
        ->add($key, $value);
    }
    $data
      ->next();
  }
  $data
    ->normalize('');
  $exporter = loft_data_grids_exporter($data, $values['users_export_type'], $values['users_export_filename']);
  drupal_alter('users_export_exporter', $exporter);
  $exporter
    ->save();
  drupal_exit();
}

Related topics

Users Export

@file Base module file for users_export.

Functions

Name	Description
users_export_form	Form builder. Configure users_export.
users_export_form_submit	Form submission handler.