Newer
Older
Dries Buytaert
committed
* Implements hook_help().
Gábor Hojtsy
committed
function statistics_help($path, $arg) {
switch ($path) {
Angie Byron
committed
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The Statistics module shows you how often a given page is viewed, who viewed it, the previous page the user visited (referrer URL), and when it was viewed. These statistics are useful in determining how users are visiting and navigating your site. For more information, see the online handbook entry for the <a href="@statistics">Statistics module</a>.', array('@statistics' => url('http://drupal.org/handbook/modules/statistics/'))) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Managing logs') . '</dt>';
$output .= '<dd>' . t('To enable collection of statistics, the <em>Enable access log</em> checkbox on the <a href="@statistics-settings">Statistics settings page</a> must be checked. The <em>Discard access logs older than</em> setting on the settings page specifies the length of time entries are kept in the log before they are deleted. This setting requires a correctly configured <a href="@cron">cron maintenance task</a> to run.', array('@statistics-settings' => url('admin/config/system/statistics'), '@cron' => 'http://drupal.org/cron')) . '</dd>';
Angie Byron
committed
$output .= '<dt>' . t('Viewing site usage') . '</dt>';
$output .= '<dd>' . t('The Statistics module can help you break down details about your users and how they are using the site. The module offers four reports:');
$output .= '<ul><li>' . t('<a href="@recent-hits">Recent hits</a> displays information about the latest activity on your site, including the URL and title of the page that was accessed, the user name (if available) and the IP address of the viewer.', array('@recent-hits' => url('admin/reports/hits'))) . '</li>';
$output .= '<li>' . t('<a href="@top-referrers">Top referrers</a> displays where visitors came from (referrer URL).', array('@top-referrers' => url('admin/reports/referrers'))) . '</li>';
$output .= '<li>' . t('<a href="@top-pages">Top pages</a> displays a list of pages ordered by how often they were viewed.', array('@top-pages' => url('admin/reports/pages'))) . '</li>';
$output .= '<li>' . t('<a href="@top-visitors">Top visitors</a> shows you the most active visitors for your site and allows you to ban abusive visitors.', array('@top-visitors' => url('admin/reports/visitors'))) . '</li></ul>';
$output .= '<dt>' . t('Displaying popular content') . '</dt>';
$output .= '<dd>' . t('The module includes a <em>Popular content</em> block that displays the most viewed pages today and for all time, and the last content viewed. To use the block, enable <em>Count content views</em> on the <a href="@statistics-settings">statistics settings page</a>, and then you can enable and configure the block on the <a href="@blocks">blocks administration page</a>.', array('@statistics-settings' => url('admin/config/system/statistics'), '@blocks' => url('admin/structure/block'))) . '</dd>';
Angie Byron
committed
$output .= '<dt>' . t('Page view counter') . '</dt>';
Angie Byron
committed
$output .= '<dd>' . t('The Statistics module includes a counter for each page that increases whenever the page is viewed. To use the counter, enable <em>Count content views</em> on the <a href="@statistics-settings">statistics settings page</a>, and set the necessary <a href="@permissions">permissions</a> (<em>View content hits</em>) so that the counter is visible to the users.', array('@statistics-settings' => url('admin/config/system/statistics'), '@permissions' => url('admin/people/permissions', array('fragment' => 'module-statistics')))) . '</dd>';
Angie Byron
committed
$output .= '</dl>';
Dries Buytaert
committed
return $output;
case 'admin/config/system/statistics':
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>';
Angie Byron
committed
Dries Buytaert
committed
* Implements hook_exit().
function statistics_exit() {
Dries Buytaert
committed
// When serving cached pages with the 'page_cache_without_database'
// configuration, system variables need to be loaded. This is a major
// performance decrease for non-database page caches, but with Statistics
// module, it is likely to also have 'statistics_enable_access_log' enabled,
// in which case we need to bootstrap to the session phase anyway.
drupal_bootstrap(DRUPAL_BOOTSTRAP_VARIABLES);
Dries Buytaert
committed
if (variable_get('statistics_count_content_views', 0)) {
// We are counting content views.
if (arg(0) == 'node' && is_numeric(arg(1)) && arg(2) == NULL) {
Dries Buytaert
committed
db_merge('node_counter')
Dries Buytaert
committed
->key(array('nid' => arg(1)))
->fields(array(
'daycount' => 1,
'totalcount' => 1,
'timestamp' => REQUEST_TIME,
))
Dries Buytaert
committed
->expression('daycount', 'daycount + 1')
->expression('totalcount', 'totalcount + 1')
->execute();
Dries Buytaert
committed
if (variable_get('statistics_enable_access_log', 0)) {
Dries Buytaert
committed
drupal_bootstrap(DRUPAL_BOOTSTRAP_SESSION);
Dries Buytaert
committed
db_insert('accesslog')
->fields(array(
'title' => strip_tags(drupal_get_title()),
'path' => $_GET['q'],
'url' => $_SERVER['HTTP_REFERER'],
'hostname' => ip_address(),
'uid' => $user->uid,
'sid' => session_id(),
'timer' => (int) timer_read('page'),
'timestamp' => REQUEST_TIME,
))
->execute();
Dries Buytaert
committed
* Implements hook_permission().
function statistics_permission() {
return array(
'administer statistics' => array(
'title' => t('Administer statistics'),
),
'access statistics' => array(
'title' => t('View content access statistics'),
),
Angie Byron
committed
'view post access counter' => array(
'title' => t('View content hits'),
Angie Byron
committed
),
);
Dries Buytaert
committed
* Implements hook_node_view().
function statistics_node_view($node, $view_mode) {
if ($view_mode != 'rss') {
Dries Buytaert
committed
if (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');
$node->content['links']['statistics'] = array(
'#theme' => 'links__node__statistics',
'#links' => $links,
'#attributes' => array('class' => array('links', 'inline')),
);
Dries Buytaert
committed
}
Dries Buytaert
committed
}
Dries Buytaert
committed
* Implements hook_menu().
Dries Buytaert
committed
function statistics_menu() {
$items['admin/reports/hits'] = array(
'title' => 'Recent hits',
'description' => 'View pages that have recently been visited.',
Dries Buytaert
committed
'page callback' => 'statistics_recent_hits',
'access arguments' => array('access statistics'),
'file' => 'statistics.admin.inc',
Dries Buytaert
committed
);
$items['admin/reports/pages'] = array(
'title' => 'Top pages',
'description' => 'View pages that have been hit frequently.',
Dries Buytaert
committed
'page callback' => 'statistics_top_pages',
'access arguments' => array('access statistics'),
'weight' => 1,
'file' => 'statistics.admin.inc',
Dries Buytaert
committed
);
$items['admin/reports/visitors'] = array(
'title' => 'Top visitors',
'description' => 'View visitors that hit many pages.',
Dries Buytaert
committed
'page callback' => 'statistics_top_visitors',
'access arguments' => array('access statistics'),
'weight' => 2,
'file' => 'statistics.admin.inc',
Dries Buytaert
committed
);
$items['admin/reports/referrers'] = array(
'title' => 'Top referrers',
'description' => 'View top referrers.',
Dries Buytaert
committed
'page callback' => 'statistics_top_referrers',
'access arguments' => array('access statistics'),
'file' => 'statistics.admin.inc',
Dries Buytaert
committed
);
$items['admin/reports/access/%'] = array(
'title' => 'Details',
'description' => 'View access log.',
Dries Buytaert
committed
'page callback' => 'statistics_access_log',
'page arguments' => array(3),
'access arguments' => array('access statistics'),
'file' => 'statistics.admin.inc',
Dries Buytaert
committed
);
$items['admin/config/system/statistics'] = array(
'title' => 'Statistics',
'description' => 'Control details about what and how your site logs access statistics.',
Dries Buytaert
committed
'page callback' => 'drupal_get_form',
'page arguments' => array('statistics_settings_form'),
'access arguments' => array('administer statistics'),
'file' => 'statistics.admin.inc',
Angie Byron
committed
'weight' => -15,
Dries Buytaert
committed
);
$items['user/%user/track/navigation'] = array(
'title' => 'Track page visits',
Dries Buytaert
committed
'page callback' => 'statistics_user_tracker',
'access callback' => 'user_access',
Dries Buytaert
committed
'access arguments' => array('access statistics'),
'type' => MENU_LOCAL_TASK,
'weight' => 2,
'file' => 'statistics.pages.inc',
Dries Buytaert
committed
);
$items['node/%node/track'] = array(
'title' => 'Track',
Dries Buytaert
committed
'page callback' => 'statistics_node_tracker',
'access callback' => 'user_access',
'access arguments' => array('access statistics'),
'type' => MENU_LOCAL_TASK,
'weight' => 2,
'file' => 'statistics.pages.inc',
Dries Buytaert
committed
);
Gerhard Killesreiter
committed
/**
Dries Buytaert
committed
* Implements hook_user_cancel().
Gerhard Killesreiter
committed
*/
function statistics_user_cancel($edit, $account, $method) {
Angie Byron
committed
switch ($method) {
case 'user_cancel_reassign':
Dries Buytaert
committed
db_update('accesslog')
->fields(array('uid' => 0))
->condition('uid', $account->uid)
->execute();
Angie Byron
committed
break;
}
Gerhard Killesreiter
committed
}
Dries Buytaert
committed
/**
* Implements hook_user_delete().
*/
function statistics_user_delete($account) {
db_delete('accesslog')
->condition('uid', $account->uid)
->execute();
}
Dries Buytaert
committed
* Implements hook_cron().
function statistics_cron() {
Dries Buytaert
committed
if ((REQUEST_TIME - $statistics_timestamp) >= 86400) {
Dries Buytaert
committed
// Reset day counts.
Dries Buytaert
committed
db_update('node_counter')
->fields(array('daycount' => 0))
->execute();
Dries Buytaert
committed
variable_set('statistics_day_timestamp', REQUEST_TIME);
Angie Byron
committed
// Clean up expired access logs (if applicable).
if (variable_get('statistics_flush_accesslog_timer', 259200) > 0) {
db_delete('accesslog')
->condition('timestamp', REQUEST_TIME - variable_get('statistics_flush_accesslog_timer', 259200), '<')
->execute();
}
/**
* 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) {
Gábor Hojtsy
committed
if (in_array($dbfield, array('totalcount', 'daycount', 'timestamp'))) {
Dries Buytaert
committed
$query = db_select('node', 'n');
$query->addTag('node_access');
$query->join('node_counter', 's', 'n.nid = s.nid');
$query->join('users', 'u', 'n.uid = u.uid');
return $query
->fields('n', array('nid', 'title'))
->fields('u', array('uid', 'name'))
->condition($dbfield, 0, '<>')
->condition('n.status', 1)
->orderBy($dbfield, 'DESC')
->range(0, $dbrows)
->execute();
Gábor Hojtsy
committed
}
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) {
Dries Buytaert
committed
// Retrieve an array with both totalcount and daycount.
return db_query('SELECT totalcount, daycount, timestamp FROM {node_counter} WHERE nid = :nid', array(':nid' => $nid), array('target' => 'slave'))->fetchAssoc();
}
}
Dries Buytaert
committed
* Implements hook_block_info().
Dries Buytaert
committed
function statistics_block_info() {
Dries Buytaert
committed
$blocks = array();
Dries Buytaert
committed
if (variable_get('statistics_count_content_views', 0)) {
$blocks['popular']['info'] = t('Popular content');
// Too dynamic to cache.
$blocks['popular']['cache'] = DRUPAL_NO_CACHE;
Dries Buytaert
committed
}
Dries Buytaert
committed
return $blocks;
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_block_configure().
Dries Buytaert
committed
*/
function statistics_block_configure($delta = '') {
// 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;
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_block_save().
Dries Buytaert
committed
*/
function statistics_block_save($delta = '', $edit = array()) {
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']);
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_block_view().
Dries Buytaert
committed
*/
function statistics_block_view($delta = '') {
if (user_access('access content')) {
$content = array();
Dries Buytaert
committed
$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:")))) {
Dries Buytaert
committed
$content['top_day'] = $node_title_list;
$content['top_day']['#suffix'] = '<br />';
Dries Buytaert
committed
}
Dries Buytaert
committed
$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:')))) {
Dries Buytaert
committed
$content['top_all'] = $node_title_list;
$content['top_all']['#suffix'] = '<br />';
Dries Buytaert
committed
}
Dries Buytaert
committed
$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:')))) {
Dries Buytaert
committed
$content['top_last'] = $node_title_list;
$content['top_last']['#suffix'] = '<br />';
Dries Buytaert
committed
}
Dries Buytaert
committed
if (count($content)) {
Dries Buytaert
committed
$block['content'] = $content;
Dries Buytaert
committed
$block['subject'] = t('Popular content');
return $block;
}
}
}
/**
* It is possible to adjust the width of columns generated by the
Dries Buytaert
committed
function _statistics_link($path, $width = 35) {
$title = drupal_get_path_alias($path);
$title = truncate_utf8($title, $width, FALSE, TRUE);
return l($title, $path);
Dries Buytaert
committed
function _statistics_format_item($title, $path) {
$path = ($path ? $path : '/');
Dries Buytaert
committed
$output .= _statistics_link($path);
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_node_delete().
Dries Buytaert
committed
*/
function statistics_node_delete($node) {
Dries Buytaert
committed
// clean up statistics table when node is deleted
Dries Buytaert
committed
db_delete('node_counter')
->condition('nid', $node->nid)
->execute();
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_ranking().
Dries Buytaert
committed
*/
function statistics_ranking() {
if (variable_get('statistics_count_content_views', 0)) {
return array(
'views' => array(
'title' => t('Number of views'),
Dries Buytaert
committed
'join' => array(
'type' => 'LEFT',
'table' => 'node_counter',
'alias' => 'node_counter',
'on' => 'node_counter.nid = i.sid',
),
Dries Buytaert
committed
// Inverse law that maps the highest view count on the site to 1 and 0 to 0.
Dries Buytaert
committed
'score' => '2.0 - 2.0 / (1.0 + node_counter.totalcount * CAST(:scale AS DECIMAL))',
'arguments' => array(':scale' => variable_get('node_cron_views_scale', 0)),
Dries Buytaert
committed
),
);
}
}
Dries Buytaert
committed
/**
Dries Buytaert
committed
* Implements hook_update_index().
Dries Buytaert
committed
*/
function statistics_update_index() {
Dries Buytaert
committed
variable_set('node_cron_views_scale', 1.0 / max(1, db_query('SELECT MAX(totalcount) FROM {node_counter}')->fetchField()));