2001-03-10 11:07:52 +00:00
<?php
2001-10-20 18:57:09 +00:00
// $Id$
2000-12-14 14:13:37 +00:00
2004-07-02 07:11:35 +00:00
/**
* @file
* System monitoring and logging for administrators.
*
* The watchdog module monitors your site and keeps a list of
* recorded events containing usage and performance data, errors,
* warnings, and similar operational information.
*
* @see watchdog().
*/
2004-05-24 18:37:50 +00:00
/**
* Implementation of hook_help().
*/
function watchdog_help($section = 'admin/help#watchdog') {
2003-08-19 19:59:33 +00:00
switch ($section) {
2003-10-09 18:53:22 +00:00
case 'admin/help#watchdog':
2004-07-02 07:11:35 +00:00
return t('<p>The watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to <a href="%watchdog">check the watchdog report</a> on a regular basis as it is often the only way to tell what is going on.</p>', array('%watchdog' => url('admin/logs')));
2004-04-18 12:51:55 +00:00
case 'admin/logs':
2004-07-02 07:11:35 +00:00
return t('The watchdog module monitors your web site, capturing system events in a log to be reviewed by an authorized individual at a later time. The watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. It is vital to check the watchdog report on a regular basis as it is often the only way to tell what is going on.');
2004-07-03 14:10:09 +00:00
case 'admin/logs/error':
return t('Watchdog events about PHP and database errors.');
2004-04-18 12:51:55 +00:00
case 'admin/logs/httpd':
2004-07-02 07:11:35 +00:00
return t('Watchdog events that are from the web server, like 404s, etc.');
2004-07-03 14:10:09 +00:00
case 'admin/logs/regular':
return t('Watchdog events that are "normal" and have no other classification.');
2004-04-18 12:51:55 +00:00
case 'admin/logs/search':
2004-07-02 07:11:35 +00:00
return t('Watchdog events showing what users have searched for.');
2004-07-03 14:10:09 +00:00
case 'admin/logs/special':
return t('Watchdog events about adding, changing, and moderating nodes and comments.');
case 'admin/logs/user':
return t('Watchdog events that have to do with users and their accounts.');
2004-04-18 12:51:55 +00:00
case 'admin/logs/warning':
2004-07-03 14:10:09 +00:00
return t('Watchdog events that don\'t stop normal operation, but are things you should know.');
2004-06-18 15:04:37 +00:00
case 'admin/modules#description':
2004-05-24 18:37:50 +00:00
return t('Logs and records system events.');
2003-08-19 19:59:33 +00:00
}
2002-06-01 21:57:29 +00:00
}
2004-04-21 13:56:38 +00:00
/**
2004-06-18 15:04:37 +00:00
* Implementation of hook_menu().
2004-04-21 13:56:38 +00:00
*/
2004-09-16 07:17:56 +00:00
function watchdog_menu($may_cache) {
2004-06-18 15:04:37 +00:00
$items = array();
2004-07-03 14:10:09 +00:00
2004-09-16 07:17:56 +00:00
if ($may_cache) {
$items[] = array('path' => 'admin/logs', 'title' => t('logs'),
'callback' => 'watchdog_overview', 'access' => user_access('administer watchdog'));
2004-07-03 14:10:09 +00:00
2004-09-16 07:17:56 +00:00
$items[] = array('path' => 'admin/logs/view', 'title' => t('view details'),
'callback' => 'watchdog_view', 'access' => user_access('administer watchdog'),
'type' => MENU_CALLBACK);
2004-07-03 14:10:09 +00:00
2004-06-18 15:04:37 +00:00
foreach (_watchdog_get_message_types() as $type) {
2004-07-03 14:10:09 +00:00
$items[] = array('path' => 'admin/logs/'. $type, 'title' => t($type), 'type' => MENU_DYNAMIC_ITEM);
2003-09-26 10:04:09 +00:00
}
2001-06-29 22:08:57 +00:00
}
2004-06-18 15:04:37 +00:00
return $items;
2001-05-19 13:41:52 +00:00
}
2004-07-03 14:10:09 +00:00
/**
* Implementation of hook_perm().
*/
function watchdog_perm() {
return array('administer watchdog');
}
2004-05-24 18:37:50 +00:00
/**
* Implementation of hook_cron().
*
* Remove expired log messages.
*/
2000-12-16 08:39:01 +00:00
function watchdog_cron() {
2004-05-24 18:37:50 +00:00
db_query('DELETE FROM {watchdog} WHERE '. time() .' - timestamp > '. variable_get('watchdog_clear', 604800));
2000-12-16 08:39:01 +00:00
}
2000-12-14 14:13:37 +00:00
2004-05-24 18:37:50 +00:00
/**
* Menu callback; displays a listing of log messages.
*/
function watchdog_overview($type = '') {
2004-01-02 16:28:45 +00:00
foreach (_watchdog_get_message_types() as $key) {
$query[$key] = "WHERE type = '". check_query($key) ."'";
}
2000-12-14 14:13:37 +00:00
2003-08-21 15:47:50 +00:00
$header = array(
2004-08-19 15:41:57 +00:00
array('data' => t('Date'), 'field' => 'w.timestamp', 'sort' => 'desc'),
array('data' => t('Message'), 'field' => 'w.message'),
array('data' => t('User'), 'field' => 'u.name'),
array('data' => t('Operations'), 'colspan' => '2')
2003-08-21 15:47:50 +00:00
);
2004-07-02 18:32:12 +00:00
$sql = 'SELECT w.*, u.name, u.uid FROM {watchdog} w INNER JOIN {users} u ON w.uid = u.uid '. ($type ? $query[$type] : '') . tablesort_sql($header);
2003-08-21 15:47:50 +00:00
$result = pager_query($sql, 50);
2001-01-26 13:38:46 +00:00
2000-12-14 14:13:37 +00:00
while ($watchdog = db_fetch_object($result)) {
2004-09-14 20:01:00 +00:00
$rows[] = array('data' =>
array(
// Cells
format_date($watchdog->timestamp, 'small'),
truncate_utf8(strip_tags($watchdog->message), 64),
format_name($watchdog),
$watchdog->link,
l(t('details'), "admin/logs/view/$watchdog->wid")
),
// Attributes for tr
2004-09-16 07:17:56 +00:00
'class' => "watchdog-$watchdog->type"
2003-12-03 15:00:02 +00:00
);
2000-12-14 14:13:37 +00:00
}
2002-12-29 18:31:46 +00:00
2003-08-21 15:47:50 +00:00
if (!$rows) {
2004-05-24 18:37:50 +00:00
$rows[] = array(array('data' => t('No log messages available.'), 'colspan' => '5'));
2003-08-21 15:47:50 +00:00
}
2003-10-02 08:35:33 +00:00
2004-05-24 18:37:50 +00:00
$pager = theme('pager', NULL, 50, 0, tablesort_pager());
2003-08-21 15:47:50 +00:00
if (!empty($pager)) {
2004-05-24 18:37:50 +00:00
$rows[] = array(array('data' => $pager, 'colspan' => '5'));
2003-08-21 15:47:50 +00:00
}
2004-05-24 18:37:50 +00:00
print theme('page', theme('table', $header, $rows));
2000-12-14 14:13:37 +00:00
}
2004-05-24 18:37:50 +00:00
/**
* Menu callback; displays details about a log message.
*/
2000-12-14 14:13:37 +00:00
function watchdog_view($id) {
2004-05-24 18:37:50 +00:00
$output = '';
$result = db_query('SELECT w.*, u.name, u.uid FROM {watchdog} w INNER JOIN {users} u ON w.uid = u.uid WHERE w.wid = %d', $id);
2000-12-14 14:13:37 +00:00
if ($watchdog = db_fetch_object($result)) {
2004-05-24 18:37:50 +00:00
$output .= '<table border="1" cellpadding="2" cellspacing="2">';
$output .= ' <tr><th>'. t('Type') ."</th><td>$watchdog->type</td></tr>";
$output .= ' <tr><th>'. t('Date') .'</th><td>'. format_date($watchdog->timestamp, 'large') .'</td></tr>';
$output .= ' <tr><th>'. t('User') .'</th><td>'. format_name($watchdog) .'</td></tr>';
$output .= ' <tr><th>'. t('Location') ."</th><td>$watchdog->location</td></tr>";
$output .= ' <tr><th>'. t('Message') ."</th><td>$watchdog->message</td></tr>";
$output .= ' <tr><th>'. t('Hostname') ."</th><td>$watchdog->hostname</td></tr>";
$output .= '</table>';
2000-12-14 14:13:37 +00:00
}
2004-05-24 18:37:50 +00:00
print theme('page', $output);
2000-12-14 14:13:37 +00:00
}
2001-11-01 11:00:51 +00:00
2004-01-02 16:28:45 +00:00
function _watchdog_get_message_types() {
$types = array();
2004-05-24 18:37:50 +00:00
$result = db_query('SELECT DISTINCT(type) FROM {watchdog}');
2004-01-02 16:28:45 +00:00
while ($object = db_fetch_object($result)) {
$types[] = $object->type;
}
return $types;
}
2001-10-09 21:01:47 +00:00
?>