drupal/modules/dblog/dblog.module

164 lines
5.3 KiB
Plaintext

<?php
// $Id$
/**
* @file
* System monitoring and logging for administrators.
*
* The dblog module monitors your site and keeps a list of
* recorded events containing usage and performance data, errors,
* warnings, and similar operational information.
*
* @see watchdog()
*/
/**
* Implement hook_help().
*/
function dblog_help($path, $arg) {
switch ($path) {
case 'admin/help#dblog':
$output = '<p>' . t('The dblog module monitors your system, capturing system events in a log to be reviewed by an authorized individual at a later time. This is useful for site administrators who want a quick overview of activities on their site. The logs also record the sequence of events, so it can be useful for debugging site errors.') . '</p>';
$output .= '<p>' . t('The dblog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. Administrators should check the dblog report on a regular basis to ensure their site is working properly.') . '</p>';
$output .= '<p>' . t('For more information, see the online handbook entry for <a href="@dblog">Dblog module</a>.', array('@dblog' => 'http://drupal.org/handbook/modules/dblog/')) . '</p>';
return $output;
case 'admin/reports/dblog':
return '<p>' . t('The dblog module monitors your website, capturing system events in a log to be reviewed by an authorized individual at a later time. The dblog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to check the dblog report on a regular basis as it is often the only way to tell what is going on.') . '</p>';
}
}
/**
* Implement hook_theme().
*/
function dblog_theme() {
return array(
'dblog_filters' => array(
'arguments' => array('form' => NULL),
),
);
}
/**
* Implement hook_menu().
*/
function dblog_menu() {
$items['admin/reports/dblog'] = array(
'title' => 'Recent log entries',
'description' => 'View events that have recently been logged.',
'page callback' => 'dblog_overview',
'access arguments' => array('access site reports'),
'weight' => -1,
);
$items['admin/reports/page-not-found'] = array(
'title' => "Top 'page not found' errors",
'description' => "View 'page not found' errors (404s).",
'page callback' => 'dblog_top',
'page arguments' => array('page not found'),
'access arguments' => array('access site reports'),
);
$items['admin/reports/access-denied'] = array(
'title' => "Top 'access denied' errors",
'description' => "View 'access denied' errors (403s).",
'page callback' => 'dblog_top',
'page arguments' => array('access denied'),
'access arguments' => array('access site reports'),
);
$items['admin/reports/event/%'] = array(
'title' => 'Details',
'page callback' => 'dblog_event',
'page arguments' => array(3),
'access arguments' => array('access site reports'),
'type' => MENU_CALLBACK,
);
return $items;
}
function dblog_init() {
if (arg(0) == 'admin' && arg(1) == 'reports') {
// Add the CSS for this module
drupal_add_css(drupal_get_path('module', 'dblog') . '/dblog.css', array('preprocess' => FALSE));
}
}
/**
* Implement hook_cron().
*
* Remove expired log messages and flood control events.
*/
function dblog_cron() {
// Cleanup the watchdog table
$max = db_query('SELECT MAX(wid) FROM {watchdog}')->fetchField();
db_delete('watchdog')
->condition('wid', $max - variable_get('dblog_row_limit', 1000), '<=')
->execute();
}
/**
* Implement hook_user_cancel().
*/
function dblog_user_cancel($edit, $account, $method) {
switch ($method) {
case 'user_cancel_reassign':
db_update('watchdog')
->fields(array('uid' => 0))
->condition('uid', $account->uid)
->execute();
break;
case 'user_cancel_delete':
db_delete('watchdog')
->condition('uid', $account->uid)
->execute();
break;
}
}
function _dblog_get_message_types() {
$types = array();
$result = db_query('SELECT DISTINCT(type) FROM {watchdog} ORDER BY type');
foreach ($result as $object) {
$types[] = $object->type;
}
return $types;
}
/**
* Implement hook_watchdog().
*
* Note some values may be truncated for database column size restrictions.
*/
function dblog_watchdog(array $log_entry) {
Database::getConnection('default', 'default')->insert('watchdog')
->fields(array(
'uid' => $log_entry['user']->uid,
'type' => substr($log_entry['type'], 0, 64),
'message' => $log_entry['message'],
'variables' => serialize($log_entry['variables']),
'severity' => $log_entry['severity'],
'link' => substr($log_entry['link'], 0, 255),
'location' => $log_entry['request_uri'],
'referer' => $log_entry['referer'],
'hostname' => substr($log_entry['ip'], 0, 128),
'timestamp' => $log_entry['timestamp'],
))
->execute();
}
/**
* Theme dblog administration filter selector.
*
* @ingroup themeable
*/
function theme_dblog_filters($form) {
$output = '';
foreach (element_children($form['status']) as $key) {
$output .= drupal_render($form['status'][$key]);
}
$output .= '<div id="dblog-admin-buttons">' . drupal_render($form['buttons']) . '</div>';
return $output;
}