flood_unblock.admin.inc in Flood Unblock 7

Admin page callbacks for the flood_unblock module.

File

flood_unblock.admin.inc

<?php

/**
 * @file
 * Admin page callbacks for the flood_unblock module.
 */

/**
 * The settings form function.
 *
 * TODO: Clean up this code. It's a bit messy. See list below.
 * - String have to be translatable, and it has to be better then it is now!
 * - Split this function up. It is to complex right now.
 */
function flood_unblock_settings() {
  $entries = _flood_unblock_get_entries();
  $ip_limit = variable_get('user_failed_login_ip_limit', 50);
  $user_limit = variable_get('user_failed_login_user_limit', 5);
  $blocks = array();
  foreach ($entries as $identifier => $entry) {
    $blocks[$identifier] = array(
      'identifier' => $identifier,
      'type' => $entry['type'],
      'count' => $entry['count'],
    );
    if ($entry['type'] == 'ip') {
      $blocks[$identifier]['ip'] = $entry['ip'] . $entry['location'];
      $blocks[$identifier]['uid'] = '';
      $blocks[$identifier]['blocked'] = $entry['count'] >= $ip_limit ? "Yes" : "";
    }
    if ($entry['type'] == 'user') {
      $blocks[$identifier]['ip'] = $entry['ip'] . $entry['location'];
      $blocks[$identifier]['uid'] = $entry['username'];
      $blocks[$identifier]['blocked'] = $entry['count'] >= $user_limit ? "Yes" : "";
    }
  }
  $header = array(
    'blocked' => t('Blocked'),
    'type' => t('Type of block'),
    'count' => t('Count'),
    'uid' => t('Account name'),
    'ip' => t('IP Address'),
  );
  $options = array();
  foreach ($blocks as $block) {
    $options[$block['identifier']] = array(
      'blocked' => $block['blocked'],
      'type' => $block['type'],
      'count' => $block['count'],
      'uid' => $block['uid'],
      'ip' => $block['ip'],
    );
  }
  $prefix = 'Drupal has two types of blocks available:<br />' . '<ul><li>One where the incorrect password of an existing user account is being used. The user account being used and the IP address is logged.' . '<li>One where an incorrect user name is being used. The IP address is logged.</ul>' . '<br/>' . 'Both types of blocks has different settings. ';
  if (module_exists('flood_control')) {
    $prefix .= l('Click here to look at these settings.', 'admin/config/system/flood-control') . '<br />';
  }
  else {
    $prefix .= 'These settings can be looked at by installing and enabling the ' . l('Flood Control module.', 'http://drupal.org/project/flood_control') . '<br />';
  }
  $prefix .= '<br />';
  if (!function_exists('smart_ip_get_location')) {
    $prefix .= 'If the ' . l('Smart IP', 'http://drupal.org/project/smart_ip') . ' module is loaded, the physical location of the IP address will be shown.<br />';
    $prefix .= '<br />';
  }
  $form['table'] = array(
    '#type' => 'tableselect',
    '#header' => $header,
    '#options' => $options,
    '#empty' => t('There are no failed logins at this time.'),
    '#prefix' => t($prefix),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Clear flood'),
  );
  if (count($entries) == 0) {
    $form['submit']['#disabled'] = TRUE;
  }
  return $form;
}

/**
 * The validation function.
 */
function flood_unblock_settings_validate($form, &$form_state) {
  $count = 0;
  foreach ($form_state['values']['table'] as $value) {
    if ($value != "0") {
      $count++;
    }
  }
  if ($count == 0) {
    form_set_error('', t('Please make a selection.'));
  }
}

/**
 * The submit function.
 */
function flood_unblock_settings_submit($form, &$form_state) {
  foreach ($form_state['values']['table'] as $value) {
    if ($value != "0") {
      $type = $form['table']['#options'][$value]['type'];
      switch ($type) {
        case 'ip':
          $type = 'failed_login_attempt_ip';
          break;
        case 'user':
          $type = 'failed_login_attempt_user';
          break;
      }
      $identifier = $value;
      flood_unblock_clear_event($type, $identifier);
    }
  }
}

/**
 * Generate rows from the entries in the flood table.
 *
 * @return array
 *   Entries in the flood table.
 */
function _flood_unblock_get_entries() {
  $entries = array();
  $query = db_select('flood', 'f');
  $query
    ->addField('f', 'identifier');
  $query
    ->addField('f', 'identifier', 'ip');
  $query
    ->addExpression('count(*)', 'count');
  $query
    ->condition('f.event', 'failed_login_attempt_ip');
  $query
    ->groupBy('identifier');
  $results = $query
    ->execute();
  foreach ($results as $result) {
    if (function_exists('smart_ip_get_location')) {
      $location = smart_ip_get_location($result->ip);
      $location_string = sprintf(" (%s %s %s)", $location['city'], $location['region'], $location['country_code']);
    }
    else {
      $location_string = '';
    }
    $entries[$result->identifier] = array(
      'type' => 'ip',
      'ip' => $result->ip,
      'count' => $result->count,
      'location' => $location_string,
    );
  }

  // TODO: Rebuild this query to a dynamic query.
  $sql = "SELECT identifier, count(*) count FROM {flood} WHERE event='failed_login_attempt_user' group by identifier";
  $results = db_query($sql);
  foreach ($results as $result) {
    $parts = explode('-', $result->identifier);
    $result->uid = $parts[0];
    $result->ip = $parts[1];
    if (function_exists('smart_ip_get_location')) {
      $location = smart_ip_get_location($result->ip);
      $location_string = sprintf(" (%s %s %s)", $location['city'], $location['region'], $location['country_code']);
    }
    else {
      $location_string = '';
    }
    $user = user_load($result->uid);
    $entries[$result->identifier] = array(
      'type' => 'user',
      'uid' => $result->uid,
      'ip' => $result->ip,
      'username' => l($user->name, 'user/' . $user->uid),
      'count' => $result->count,
      'location' => $location_string,
    );
  }
  return $entries;
}

Functions

Name	Description
flood_unblock_settings	The settings form function.
flood_unblock_settings_submit	The submit function.
flood_unblock_settings_validate	The validation function.
_flood_unblock_get_entries	Generate rows from the entries in the flood table.