click_filter.module in Advertisement 5.2

Filter duplicate and other unwanted clicks from ad statistics.

Copyright (c) 2008. Jeremy Andrews <[e-mail]>. All rights reserved.

File

statistics/click_filter/click_filter.module

<?php

/**
* @file
* Filter duplicate and other unwanted clicks from ad statistics.
*
* Copyright (c) 2008.
*   Jeremy Andrews <[e-mail]>.  All rights reserved.
*/

/**
 * TODO:
 *  - Filter out bots and spiders using user_agent field.
 *  - Add administrative ability to enter IP or range to filter.
 */
define('CLICK_NEW', 0);
define('CLICK_VALID', 1);
define('CLICK_DUPLICATE', 2);
define('CLICK_OWNER', 3);
define('CLICK_FILTER_ROLE', 4);
define('CLICK_BOT', 5);

/**
 * Provide text version for statistics output.
 */
function click_filter_status_text($status) {
  $output = '<div class="click-status">';
  switch ($status) {
    case 0:
      $output .= '<div class="click-new">' . t('New') . '</div>';
      break;
    case 1:
      $output .= '<div class="click-valid">' . t('Valid') . '</div>';
      break;
    case 2:
      $output .= '<div class="click-duplicate">' . t('Duplicate') . '</div>';
      break;
    case 3:
      $output .= '<div class="click-owner">' . t('Ad owner') . '</div>';
      break;
    case 4:
      $output .= '<div class="click-filtered-role">' . t('Filtered role') . '</div>';
      break;
    case 5:
      $output .= '<div class="click-bot">' . t('Bot') . '</div>';
      break;
    default:
      $output .= '<div class="click-unknown">' . t('Unknown') . '</div>';
      break;
  }
  $output .= '</div>';
  return $output;
}

/**
 * Perform on-the-fly click filtering.
 */
function click_filter_status($aid, $hostid) {
  global $user;
  if (user_access('filter clicks')) {
    return CLICK_FILTER_ROLE;
  }
  if (preg_match("/bot/i", $_SERVER['HTTP_USER_AGENT'])) {
    return CLICK_BOT;
  }

  // See if the click came from an owner of the ad.
  $result = db_query('SELECT oid FROM {ad_owners} WHERE aid = %d AND uid = %d', $aid, $user->uid);
  if (db_num_rows($result)) {
    return CLICK_OWNER;
  }

  // See if the click came from a duplicate uid or ip address.
  if ($user->uid) {
    $result = db_query("SELECT cid FROM {ad_clicks} WHERE aid = %d AND status = %d AND (uid = %d OR hostname = '%s')", $aid, CLICK_VALID, $user->uid, $_SERVER['REMOTE_ADDR']);
  }
  else {
    $result = db_query("SELECT cid FROM {ad_clicks} WHERE aid = %d AND status = %d AND hostname = '%s'", $aid, CLICK_VALID, $_SERVER['REMOTE_ADDR']);
  }
  if (db_num_rows($result)) {
    return CLICK_DUPLICATE;
  }
  return CLICK_VALID;
}

/** 
 * Drupal _perm hook.
 */
function click_filter_perm() {
  return array(
    'view filtered clicks',
    'filter clicks',
  );
}

Functions

Name	Description
click_filter_perm	Drupal _perm hook.
click_filter_status	Perform on-the-fly click filtering.
click_filter_status_text	Provide text version for statistics output.

Constants

Name	Description
CLICK_BOT
CLICK_DUPLICATE
CLICK_FILTER_ROLE
CLICK_NEW	TODO:
CLICK_OWNER
CLICK_VALID