statistics.module

<?php

/**
 * @file
 * Logs access statistics for your site.
 */

/**
 * Implementation of hook_help().
 */
function statistics_help($path, $arg) {
  switch ($path) {
    case 'admin/help#statistics':
      $output = '<p>' . t('The statistics module keeps track of numerous site usage statistics, including the number of times, and from where, each of your posts is viewed. These statistics are useful in determining how users are interacting with each other and with your site, and are required for the display of some Drupal blocks.') . '</p>';
      $output .= '<p>' . t('The statistics module provides:') . '</p>';
      $output .= '<ul><li>' . t('a counter for each post on your site that increments each time the post is viewed. (Enable <em>Count content views</em> on the <a href="@accesslog">access log settings page</a>, and determine if the post access counters should be visible to any user roles on the <a href="@permissions">permissions page</a>.)', array(
        '@accesslog' => url('admin/reports/settings'),
        '@permissions' => url('admin/user/permissions'),
      )) . '</li>';
      $output .= '<li>' . t('a <a href="@recent-hits">recent hits</a> log that displays information about the latest activity on your site, including the URL and title of the page accessed, the user name (if available) and IP address of the accessing party.', array(
        '@recent-hits' => url('admin/reports/hits'),
      )) . '</li>';
      $output .= '<li>' . t('a <a href="@top-referrers">top referrers</a> log that displays the referring parties for your site visits (where your visitors came from).', array(
        '@top-referrers' => url('admin/reports/referrers'),
      )) . '</li>';
      $output .= '<li>' . t('a <a href="@top-pages">top pages</a> log that displays site content in descending order by number of views.', array(
        '@top-pages' => url('admin/reports/pages'),
      )) . '</li>';
      $output .= '<li>' . t('a <a href="@top-visitors">top visitors</a> log that displays the most active users on your site.', array(
        '@top-visitors' => url('admin/reports/visitors'),
      )) . '</li>';
      $output .= '<li>' . t('a <em>Popular content</em> block that displays the day\'s most viewed content, the all-time most viewed content, and the last content viewed. (Enable the <em>Popular content</em> block on the <a href="@blocks">blocks administration page</a>.)', array(
        '@blocks' => url('admin/build/block'),
      )) . '</li></ul>';
      $output .= '<p>' . t('Configuring the statistics module') . '</p>';
      $output .= '<ul><li>' . t('When the <em>Enable access log</em> setting on the <a href="@accesslog">access log settings page</a> is enabled, data about every page accessed (including the remote host\'s IP address, referrer, node accessed, and user name) is stored in the access log. The access log must be enabled for the <a href="@recent-hits">recent hits</a>, <a href="@top-referrers">top referrers</a>, <a href="@top-pages">top pages</a>, and <a href="@top-visitors">top visitors</a> log pages to function. Enabling the access log adds one additional database call per page displayed by Drupal.', array(
        '@accesslog' => url('admin/reports/settings'),
        '@recent-hits' => url('admin/reports/hits'),
        '@top-referrers' => url('admin/reports/referrers'),
        '@top-pages' => url('admin/reports/pages'),
        '@top-visitors' => url('admin/reports/visitors'),
      )) . '</li>';
      $output .= '<li>' . t('The <em>Discard access logs older than</em> setting on the <a href="@accesslog">access log settings page</a> specifies the length of time entries are retained in the access log before they are deleted. Automatic access log entry deletion requires a correctly configured <a href="@cron">cron maintenance task</a>.', array(
        '@accesslog' => url('admin/reports/settings'),
        '@cron' => url('admin/reports/status'),
      )) . '</li>';
      $output .= '<li>' . t('The <em>Count content views</em> setting on the <a href="@accesslog">access log settings page</a> enables a counter for each post on your site that increments each time the post is viewed. This option must be enabled to provide post-specific access counts. Enabling this option adds one additional database call per each post displayed by Drupal.', array(
        '@accesslog' => url('admin/reports/settings'),
      )) . '</li></ul>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@statistics">Statistics module</a>.', array(
        '@statistics' => 'http://drupal.org/handbook/modules/statistics/',
      )) . '</p>';
      return $output;
    case 'admin/reports/settings':
      return '<p>' . t('Settings for the statistical information that Drupal will keep about the site. See <a href="@statistics">site statistics</a> for the actual information.', array(
        '@statistics' => url('admin/reports/hits'),
      )) . '</p>';
    case 'admin/reports/hits':
      return '<p>' . t("This page displays the site's most recent hits.") . '</p>';
    case 'admin/reports/referrers':
      return '<p>' . t('This page displays all external referrers, or external references to your website.') . '</p>';
    case 'admin/reports/visitors':
      return '<p>' . t("When you ban a visitor, you prevent the visitor's IP address from accessing your site. Unlike blocking a user, banning a visitor works even for anonymous users. This is most commonly used to block resource-intensive bots or web crawlers.") . '</p>';
  }
}

/**
 * Implementation of hook_exit().
 *
 * This is where statistics are gathered on page accesses.
 */
function statistics_exit() {
  global $user, $recent_activity;
  drupal_bootstrap(DRUPAL_BOOTSTRAP_PATH);
  if (variable_get('statistics_count_content_views', 0)) {

    // We are counting content views.
    if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == '') {

      // A node has been viewed, so update the node's counters.
      db_query('UPDATE {node_counter} SET daycount = daycount + 1, totalcount = totalcount + 1, timestamp = %d WHERE nid = %d', time(), arg(1));

      // If we affected 0 rows, this is the first time viewing the node.
      if (!db_affected_rows()) {

        // We must create a new row to store counters for the new node.
        db_query('INSERT INTO {node_counter} (nid, daycount, totalcount, timestamp) VALUES (%d, 1, 1, %d)', arg(1), time());
      }
    }
  }
  if (variable_get('statistics_enable_access_log', 0) && module_invoke('throttle', 'status') == 0) {

    // Log this page access.
    db_query("INSERT INTO {accesslog} (title, path, url, hostname, uid, sid, timer, timestamp) values('%s', '%s', '%s', '%s', %d, '%s', %d, %d)", strip_tags(drupal_get_title()), $_GET['q'], referer_uri(), ip_address(), $user->uid, session_id(), timer_read('page'), time());
  }
}

/**
 * Implementation of hook_perm().
 */
function statistics_perm() {
  return array(
    'access statistics',
    'view post access counter',
  );
}

/**
 * Implementation of hook_link().
 */
function statistics_link($type, $node = NULL, $teaser = FALSE) {
  global $id;
  $links = array();
  if ($type == 'node' && user_access('view post access counter')) {
    $statistics = statistics_get($node->nid);
    if ($statistics) {
      $links['statistics_counter']['title'] = format_plural($statistics['totalcount'], '1 read', '@count reads');
    }
  }
  return $links;
}

/**
 * Implementation of hook_menu().
 */
function statistics_menu() {
  $items['admin/reports/hits'] = array(
    'title' => 'Recent hits',
    'description' => 'View pages that have recently been visited.',
    'page callback' => 'statistics_recent_hits',
    'access arguments' => array(
      'access statistics',
    ),
    'file' => 'statistics.admin.inc',
  );
  $items['admin/reports/pages'] = array(
    'title' => 'Top pages',
    'description' => 'View pages that have been hit frequently.',
    'page callback' => 'statistics_top_pages',
    'access arguments' => array(
      'access statistics',
    ),
    'weight' => 1,
    'file' => 'statistics.admin.inc',
  );
  $items['admin/reports/visitors'] = array(
    'title' => 'Top visitors',
    'description' => 'View visitors that hit many pages.',
    'page callback' => 'statistics_top_visitors',
    'access arguments' => array(
      'access statistics',
    ),
    'weight' => 2,
    'file' => 'statistics.admin.inc',
  );
  $items['admin/reports/referrers'] = array(
    'title' => 'Top referrers',
    'description' => 'View top referrers.',
    'page callback' => 'statistics_top_referrers',
    'access arguments' => array(
      'access statistics',
    ),
    'file' => 'statistics.admin.inc',
  );
  $items['admin/reports/access/%'] = array(
    'title' => 'Details',
    'description' => 'View access log.',
    'page callback' => 'statistics_access_log',
    'page arguments' => array(
      3,
    ),
    'access arguments' => array(
      'access statistics',
    ),
    'type' => MENU_CALLBACK,
    'file' => 'statistics.admin.inc',
  );
  $items['admin/reports/settings'] = array(
    'title' => 'Access log settings',
    'description' => 'Control details about what and how your site logs.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'statistics_access_logging_settings',
    ),
    'access arguments' => array(
      'administer site configuration',
    ),
    'type' => MENU_NORMAL_ITEM,
    'weight' => 3,
    'file' => 'statistics.admin.inc',
  );
  $items['user/%user/track/navigation'] = array(
    'title' => 'Track page visits',
    'page callback' => 'statistics_user_tracker',
    'access callback' => 'user_access',
    'access arguments' => array(
      'access statistics',
    ),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
    'file' => 'statistics.pages.inc',
  );
  $items['node/%node/track'] = array(
    'title' => 'Track',
    'page callback' => 'statistics_node_tracker',
    'access callback' => 'user_access',
    'access arguments' => array(
      'access statistics',
    ),
    'type' => MENU_LOCAL_TASK,
    'weight' => 2,
    'file' => 'statistics.pages.inc',
  );
  return $items;
}

/**
 * Implementation of hook_user().
 */
function statistics_user($op, &$edit, &$user) {
  if ($op == 'delete') {
    db_query('UPDATE {accesslog} SET uid = 0 WHERE uid = %d', $user->uid);
  }
}

/**
 * Implementation of hook_cron().
 */
function statistics_cron() {
  $statistics_timestamp = variable_get('statistics_day_timestamp', '');
  if (time() - $statistics_timestamp >= 86400) {

    // Reset day counts.
    db_query('UPDATE {node_counter} SET daycount = 0');
    variable_set('statistics_day_timestamp', time());
  }

  // Clean up expired access logs.
  if (variable_get('statistics_flush_accesslog_timer', 259200) > 0) {
    db_query('DELETE FROM {accesslog} WHERE timestamp < %d', time() - variable_get('statistics_flush_accesslog_timer', 259200));
  }
}

/**
 * Returns all time or today top or last viewed node(s).
 *
 * @param $dbfield
 *   one of
 *   - 'totalcount': top viewed content of all time.
 *   - 'daycount': top viewed content for today.
 *   - 'timestamp': last viewed node.
 *
 * @param $dbrows
 *   number of rows to be returned.
 *
 * @return
 *   A query result containing n.nid, n.title, u.uid, u.name of the selected node(s)
 *   or FALSE if the query could not be executed correctly.
 */
function statistics_title_list($dbfield, $dbrows) {
  if (in_array($dbfield, array(
    'totalcount',
    'daycount',
    'timestamp',
  ))) {
    return db_query_range(db_rewrite_sql("SELECT n.nid, n.title, u.uid, u.name FROM {node} n INNER JOIN {node_counter} s ON n.nid = s.nid INNER JOIN {users} u ON n.uid = u.uid WHERE s." . $dbfield . " != 0 AND n.status = 1 ORDER BY s." . $dbfield . " DESC"), 0, $dbrows);
  }
  return FALSE;
}

/**
 * Retrieves a node's "view statistics".
 *
 * @param $nid
 *   node ID
 *
 * @return
 *   An array with three entries: [0]=totalcount, [1]=daycount, [2]=timestamp
 *   - totalcount: count of the total number of times that node has been viewed.
 *   - daycount: count of the total number of times that node has been viewed "today".
 *     For the daycount to be reset, cron must be enabled.
 *   - timestamp: timestamp of when that node was last viewed.
 */
function statistics_get($nid) {
  if ($nid > 0) {

    // Retrieve an array with both totalcount and daycount.
    $statistics = db_fetch_array(db_query('SELECT totalcount, daycount, timestamp FROM {node_counter} WHERE nid = %d', $nid));
  }
  return $statistics;
}

/**
 * Implementation of hook_block().
 */
function statistics_block($op = 'list', $delta = 0, $edit = array()) {
  switch ($op) {
    case 'list':
      if (variable_get('statistics_count_content_views', 0)) {
        $blocks[0]['info'] = t('Popular content');

        // Too dynamic to cache.
        $blocks[0]['cache'] = BLOCK_NO_CACHE;
        return $blocks;
      }
      break;
    case 'configure':

      // Popular content block settings
      $numbers = array(
        '0' => t('Disabled'),
      ) + drupal_map_assoc(array(
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        15,
        20,
        25,
        30,
        40,
      ));
      $form['statistics_block_top_day_num'] = array(
        '#type' => 'select',
        '#title' => t("Number of day's top views to display"),
        '#default_value' => variable_get('statistics_block_top_day_num', 0),
        '#options' => $numbers,
        '#description' => t('How many content items to display in "day" list.'),
      );
      $form['statistics_block_top_all_num'] = array(
        '#type' => 'select',
        '#title' => t('Number of all time views to display'),
        '#default_value' => variable_get('statistics_block_top_all_num', 0),
        '#options' => $numbers,
        '#description' => t('How many content items to display in "all time" list.'),
      );
      $form['statistics_block_top_last_num'] = array(
        '#type' => 'select',
        '#title' => t('Number of most recent views to display'),
        '#default_value' => variable_get('statistics_block_top_last_num', 0),
        '#options' => $numbers,
        '#description' => t('How many content items to display in "recently viewed" list.'),
      );
      return $form;
    case 'save':
      variable_set('statistics_block_top_day_num', $edit['statistics_block_top_day_num']);
      variable_set('statistics_block_top_all_num', $edit['statistics_block_top_all_num']);
      variable_set('statistics_block_top_last_num', $edit['statistics_block_top_last_num']);
      break;
    case 'view':
      if (user_access('access content')) {
        $content = array();
        $daytop = variable_get('statistics_block_top_day_num', 0);
        if ($daytop && ($result = statistics_title_list('daycount', $daytop)) && ($node_title_list = node_title_list($result, t("Today's:")))) {
          $content[] = $node_title_list;
        }
        $alltimetop = variable_get('statistics_block_top_all_num', 0);
        if ($alltimetop && ($result = statistics_title_list('totalcount', $alltimetop)) && ($node_title_list = node_title_list($result, t('All time:')))) {
          $content[] = $node_title_list;
        }
        $lasttop = variable_get('statistics_block_top_last_num', 0);
        if ($lasttop && ($result = statistics_title_list('timestamp', $lasttop)) && ($node_title_list = node_title_list($result, t('Last viewed:')))) {
          $content[] = $node_title_list;
        }
        if (count($content)) {
          $block['content'] = implode('<br />', $content);
          $block['subject'] = t('Popular content');
          return $block;
        }
      }
  }
}

/**
 * It is possible to adjust the width of columns generated by the
 * statistics module.
 */
function _statistics_link($path, $width = 35) {
  $title = drupal_get_path_alias($path);
  $title = truncate_utf8($title, $width, FALSE, TRUE);
  return l($title, $path);
}
function _statistics_format_item($title, $path) {
  $path = $path ? $path : '/';
  $output = $title ? "{$title}<br />" : '';
  $output .= _statistics_link($path);
  return $output;
}

/**
 * Implementation of hook_nodeapi().
 */
function statistics_nodeapi(&$node, $op, $arg = 0) {
  switch ($op) {
    case 'delete':

      // clean up statistics table when node is deleted
      db_query('DELETE FROM {node_counter} WHERE nid = %d', $node->nid);
  }
}