Admin page callbacks for the Statistics module.
<?php
/**
* @file
* Admin page callbacks for the Statistics module.
*/
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
/**
* Page callback: Displays the "recent hits" page.
*
* This displays the pages with recent hits in a given time interval that
* haven't been flushed yet. The flush interval is set on the statistics
* settings form, but is dependent on cron running.
*
* @return array
* A render array containing information about the most recent hits.
*/
function statistics_recent_hits() {
$header = array(
array(
'data' => t('Timestamp'),
'field' => 'a.timestamp',
'sort' => 'desc',
),
array(
'data' => t('Page'),
'field' => 'a.path',
),
array(
'data' => t('User'),
'field' => 'u.name',
),
t('Operations'),
);
$query = db_select('accesslog', 'a', array(
'target' => 'slave',
))
->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
$query
->join('users', 'u', 'a.uid = u.uid');
$query
->fields('a', array(
'aid',
'timestamp',
'path',
'title',
'uid',
))
->fields('u', array(
'name',
))
->limit(30)
->orderByHeader($header);
$result = $query
->execute();
$rows = array();
foreach ($result as $log) {
$row = array();
$row[] = array(
'data' => format_date($log->timestamp, 'short'),
'class' => array(
'nowrap',
),
);
$row[] = _statistics_format_item($log->title, $log->path);
$row[] = theme('username', array(
'account' => $log,
));
$links = array();
$links['details'] = array(
'title' => t('details'),
'href' => "admin/reports/access/{$log->aid}",
);
$row[] = array(
'data' => array(
'#type' => 'operations',
'#links' => $links,
),
);
$rows[] = $row;
}
$build['statistics_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => t('No statistics available.'),
);
$build['statistics_pager'] = array(
'#theme' => 'pager',
);
return $build;
}
/**
* Page callback: Displays statistics for the "top pages" (most accesses).
*
* This displays the pages with the most hits (the "top pages") within a given
* time period that haven't been flushed yet. The flush interval is set on the
* statistics settings form, but is dependent on cron running.
*
* @return array
* A render array containing information about the the top pages.
*/
function statistics_top_pages() {
$header = array(
array(
'data' => t('Hits'),
'field' => 'hits',
'sort' => 'desc',
),
array(
'data' => t('Page'),
'field' => 'path',
),
array(
'data' => t('Average page generation time'),
'field' => 'average_time',
),
array(
'data' => t('Total page generation time'),
'field' => 'total_time',
),
);
$query = db_select('accesslog', 'a', array(
'target' => 'slave',
))
->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
$query
->addExpression('COUNT(path)', 'hits');
// MAX(title) avoids having empty node titles which otherwise causes
// duplicates in the top pages list.
$query
->addExpression('MAX(title)', 'title');
$query
->addExpression('AVG(timer)', 'average_time');
$query
->addExpression('SUM(timer)', 'total_time');
$query
->fields('a', array(
'path',
))
->groupBy('path')
->limit(30)
->orderByHeader($header);
$count_query = db_select('accesslog', 'a', array(
'target' => 'slave',
));
$count_query
->addExpression('COUNT(DISTINCT path)');
$query
->setCountQuery($count_query);
$result = $query
->execute();
$rows = array();
foreach ($result as $page) {
$rows[] = array(
$page->hits,
_statistics_format_item($page->title, $page->path),
t('%time ms', array(
'%time' => round($page->average_time),
)),
format_interval(round($page->total_time / 1000)),
);
}
drupal_set_title(t('Top pages in the past %interval', array(
'%interval' => format_interval(config('statistics.settings')
->get('access_log.max_lifetime')),
)), PASS_THROUGH);
$build['statistics_top_pages_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => t('No statistics available.'),
);
$build['statistics_top_pages_pager'] = array(
'#theme' => 'pager',
);
return $build;
}
/**
* Page callback: Displays the "top visitors" page.
*
* This displays the pages with the top number of visitors in a given time
* interval that haven't been flushed yet. The flush interval is set on the
* statistics settings form, but is dependent on cron running.
*
* @return array
* A render array containing the top visitors information.
*/
function statistics_top_visitors() {
$ban_exists = module_exists('ban');
$header = array(
array(
'data' => t('Hits'),
'field' => 'hits',
'sort' => 'desc',
),
array(
'data' => t('Visitor'),
'field' => 'u.name',
),
array(
'data' => t('Total page generation time'),
'field' => 'total',
),
$ban_exists && user_access('Ban IP addresses') ? t('Operations') : '',
);
$query = db_select('accesslog', 'a', array(
'target' => 'slave',
))
->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
if ($ban_exists) {
$query
->leftJoin('ban_ip', 'b', 'a.hostname = b.ip');
}
$query
->leftJoin('users', 'u', 'a.uid = u.uid');
$query
->addExpression('COUNT(a.uid)', 'hits');
$query
->addExpression('SUM(a.timer)', 'total');
$query
->fields('a', array(
'uid',
'hostname',
))
->fields('u', array(
'name',
))
->groupBy('a.hostname')
->groupBy('a.uid')
->groupBy('u.name')
->limit(30);
if ($ban_exists) {
$query
->fields('b', array(
'iid',
))
->groupBy('b.iid');
}
$query
->orderByHeader($header);
$uniques_query = db_select('accesslog')
->distinct();
$uniques_query
->fields('accesslog', array(
'uid',
'hostname',
));
$count_query = db_select($uniques_query);
$count_query
->addExpression('COUNT(*)');
$query
->setCountQuery($count_query);
$result = $query
->execute();
$rows = array();
$destination = drupal_get_destination();
foreach ($result as $account) {
$links = array();
if ($ban_exists && user_access('ban IP addresses') && !$account->uid) {
if ($account->iid) {
$links['unban'] = array(
'title' => t('unban IP address'),
'href' => "admin/config/people/ban/delete/{$account->iid}",
'query' => $destination,
);
}
else {
$links['ban'] = array(
'title' => t('ban IP address'),
'href' => "admin/config/people/ban/{$account->hostname}",
'query' => $destination,
);
}
}
$row = array();
$row[] = $account->hits;
$row[] = $account->uid ? theme('username', array(
'account' => $account,
)) : $account->hostname;
$row[] = format_interval(round($account->total / 1000));
$row[] = array(
'data' => array(
'#type' => 'operations',
'#links' => $links,
),
);
$rows[] = $row;
}
drupal_set_title(t('Top visitors in the past %interval', array(
'%interval' => format_interval(config('statistics.settings')
->get('access_log.max_lifetime')),
)), PASS_THROUGH);
$build['statistics_top_visitors_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => t('No statistics available.'),
);
$build['statistics_top_visitors_pager'] = array(
'#theme' => 'pager',
);
return $build;
}
/**
* Page callback: Displays the "top referrers" in the access logs.
*
* This displays the pages with the top referrers in a given time interval that
* haven't been flushed yet. The flush interval is set on the statistics
* settings form, but is dependent on cron running.
*
* @return array
* A render array containing the top referrers information.
*/
function statistics_top_referrers() {
drupal_set_title(t('Top referrers in the past %interval', array(
'%interval' => format_interval(config('statistics.settings')
->get('access_log.max_lifetime')),
)), PASS_THROUGH);
$header = array(
array(
'data' => t('Hits'),
'field' => 'hits',
'sort' => 'desc',
),
array(
'data' => t('Url'),
'field' => 'url',
),
array(
'data' => t('Last visit'),
'field' => 'last',
),
);
$query = db_select('accesslog', 'a')
->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
->extend('Drupal\\Core\\Database\\Query\\TableSortExtender');
$query
->addExpression('COUNT(url)', 'hits');
$query
->addExpression('MAX(timestamp)', 'last');
$query
->fields('a', array(
'url',
))
->condition('url', '%' . $_SERVER['HTTP_HOST'] . '%', 'NOT LIKE')
->condition('url', '', '<>')
->groupBy('url')
->limit(30)
->orderByHeader($header);
$count_query = db_select('accesslog', 'a', array(
'target' => 'slave',
));
$count_query
->addExpression('COUNT(DISTINCT url)');
$count_query
->condition('url', '%' . $_SERVER['HTTP_HOST'] . '%', 'NOT LIKE')
->condition('url', '', '<>');
$query
->setCountQuery($count_query);
$result = $query
->execute();
$rows = array();
foreach ($result as $referrer) {
$rows[] = array(
$referrer->hits,
_statistics_link($referrer->url),
t('@time ago', array(
'@time' => format_interval(REQUEST_TIME - $referrer->last),
)),
);
}
$build['statistics_top_referrers_table'] = array(
'#theme' => 'table',
'#header' => $header,
'#rows' => $rows,
'#empty' => t('No statistics available.'),
);
$build['statistics_top_referrers_pager'] = array(
'#theme' => 'pager',
);
return $build;
}
/**
* Page callback: Gathers page access statistics suitable for rendering.
*
* @param int $aid
* The unique accesslog ID.
*
* @return array
* A render array containing page access statistics. If information for the
* page was not found, a NotFoundHttpException is thrown.
*/
function statistics_access_log($aid) {
$access = db_query('SELECT a.*, u.name FROM {accesslog} a LEFT JOIN {users} u ON a.uid = u.uid WHERE aid = :aid', array(
':aid' => $aid,
))
->fetch();
if ($access) {
$rows[] = array(
array(
'data' => t('URL'),
'header' => TRUE,
),
l(url($access->path, array(
'absolute' => TRUE,
)), $access->path),
);
// It is safe to avoid filtering $access->title through check_plain because
// it comes from drupal_get_title().
$rows[] = array(
array(
'data' => t('Title'),
'header' => TRUE,
),
$access->title,
);
$rows[] = array(
array(
'data' => t('Referrer'),
'header' => TRUE,
),
$access->url ? l($access->url, $access->url) : '',
);
$rows[] = array(
array(
'data' => t('Date'),
'header' => TRUE,
),
format_date($access->timestamp, 'long'),
);
$rows[] = array(
array(
'data' => t('User'),
'header' => TRUE,
),
theme('username', array(
'account' => $access,
)),
);
$rows[] = array(
array(
'data' => t('Hostname'),
'header' => TRUE,
),
check_plain($access->hostname),
);
$build['statistics_table'] = array(
'#theme' => 'table',
'#rows' => $rows,
);
return $build;
}
else {
throw new NotFoundHttpException();
}
}
/**
* Form constructor for the statistics administration form.
*
* @ingroup forms
* @see statistics_settings_form_submit().
*/
function statistics_settings_form($form, &$form_state) {
$config = config('statistics.settings');
// Access log settings.
$form['access'] = array(
'#type' => 'details',
'#title' => t('Access log settings'),
);
$form['access']['statistics_enable_access_log'] = array(
'#type' => 'checkbox',
'#title' => t('Enable access log'),
'#default_value' => $config
->get('access_log.enabled'),
'#description' => t('Log each page access. Required for referrer statistics.'),
);
$form['access']['statistics_flush_accesslog_timer'] = array(
'#type' => 'select',
'#title' => t('Discard access logs older than'),
'#default_value' => $config
->get('access_log.max_lifetime'),
'#options' => array(
0 => t('Never'),
) + drupal_map_assoc(array(
3600,
10800,
21600,
32400,
43200,
86400,
172800,
259200,
604800,
1209600,
2419200,
4838400,
9676800,
), 'format_interval'),
'#description' => t('Older access log entries (including referrer statistics) will be automatically discarded. (Requires a correctly configured <a href="@cron">cron maintenance task</a>.)', array(
'@cron' => url('admin/reports/status'),
)),
);
// Content counter settings.
$form['content'] = array(
'#type' => 'details',
'#title' => t('Content viewing counter settings'),
);
$form['content']['statistics_count_content_views'] = array(
'#type' => 'checkbox',
'#title' => t('Count content views'),
'#default_value' => $config
->get('count_content_views'),
'#description' => t('Increment a counter each time content is viewed.'),
);
return system_config_form($form, $form_state);
}
/**
* Form submission handler for statistics_settings_form().
*/
function statistics_settings_form_submit($form, &$form_state) {
config('statistics.settings')
->set('access_log.enabled', $form_state['values']['statistics_enable_access_log'])
->set('access_log.max_lifetime', $form_state['values']['statistics_flush_accesslog_timer'])
->set('count_content_views', $form_state['values']['statistics_count_content_views'])
->save();
}
Name | Description |
---|---|
statistics_access_log | Page callback: Gathers page access statistics suitable for rendering. |
statistics_recent_hits | Page callback: Displays the "recent hits" page. |
statistics_settings_form | Form constructor for the statistics administration form. |
statistics_settings_form_submit | Form submission handler for statistics_settings_form(). |
statistics_top_pages | Page callback: Displays statistics for the "top pages" (most accesses). |
statistics_top_referrers | Page callback: Displays the "top referrers" in the access logs. |
statistics_top_visitors | Page callback: Displays the "top visitors" page. |