From 07e6bdcdfe3273e6a17940c2ba12d2c8e0e878d1 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Tue, 10 Apr 2007 10:10:27 +0000 Subject: - Patch #63881 by kbahey and jakeg: improved Drupal's logging functionality. Added support for external loggers, and included a small syslog module into core. --- modules/dblog/dblog.css | 26 ++++ modules/dblog/dblog.info | 5 + modules/dblog/dblog.install | 53 ++++++++ modules/dblog/dblog.module | 321 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 405 insertions(+) create mode 100644 modules/dblog/dblog.css create mode 100644 modules/dblog/dblog.info create mode 100644 modules/dblog/dblog.install create mode 100644 modules/dblog/dblog.module (limited to 'modules/dblog') diff --git a/modules/dblog/dblog.css b/modules/dblog/dblog.css new file mode 100644 index 000000000..d5ef7f260 --- /dev/null +++ b/modules/dblog/dblog.css @@ -0,0 +1,26 @@ +/* $Id$ */ + +tr.dblog-user { + background: #ffd; +} +tr.dblog-user .active { + background: #eed; +} +tr.dblog-content { + background: #ddf; +} +tr.dblog-content .active { + background: #cce; +} +tr.dblog-page-not-found, tr.dblog-access-denied { + background: #dfd; +} +tr.dblog-page-not-found .active, tr.dblog-access-denied .active { + background: #cec; +} +tr.dblog-error { + background: #ffc9c9; +} +tr.dblog-error .active { + background: #eeb9b9; +} diff --git a/modules/dblog/dblog.info b/modules/dblog/dblog.info new file mode 100644 index 000000000..124280577 --- /dev/null +++ b/modules/dblog/dblog.info @@ -0,0 +1,5 @@ +; $Id$ +name = Database logging +description = Logs and records system events to the database. +package = Core - optional +version = VERSION diff --git a/modules/dblog/dblog.install b/modules/dblog/dblog.install new file mode 100644 index 000000000..f94bab651 --- /dev/null +++ b/modules/dblog/dblog.install @@ -0,0 +1,53 @@ +'. 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.') .'

'; + $output .= '

'. 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.') .'

'; + $output .= '

'. t('For more information please read the configuration and customization handbook Dblog page.', array('@dblog' => 'http://drupal.org/handbook/modules/dblog/')) .'

'; + return $output; + case 'admin/logs': + return '

'. 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.') .'

'; + } +} + +/** + * Implementation of hook_theme() + */ +function dblog_theme() { + return array( + 'dblog_form_overview' => array( + 'arguments' => array('form' => NULL), + ), + ); +} + +/** + * Implementation of hook_menu(). + */ +function dblog_menu() { + $items['admin/settings/logging/dblog'] = array( + 'title' => t('Database logging'), + 'description' => t('Settings for logging to the Drupal database logs.'), + 'page callback' => 'drupal_get_form', + 'page arguments' => array('dblog_admin_settings'), + ); + + $items['admin/logs/dblog'] = array( + 'title' => t('Recent log entries'), + 'description' => t('View events that have recently been logged.'), + 'page callback' => 'dblog_overview', + 'weight' => -1, + ); + $items['admin/logs/page-not-found'] = array( + 'title' => t("Top 'page not found' errors"), + 'description' => t("View 'page not found' errors (404s)."), + 'page callback' => 'dblog_top', + 'page arguments' => array('page not found'), + ); + $items['admin/logs/access-denied'] = array( + 'title' => t("Top 'access denied' errors"), + 'description' => t("View 'access denied' errors (403s)."), + 'page callback' => 'dblog_top', + 'page arguments' => array('access denied'), + ); + $items['admin/logs/event/%'] = array( + 'title' => t('Details'), + 'page callback' => 'dblog_event', + 'page arguments' => array(3), + 'type' => MENU_CALLBACK, + ); + return $items; +} + +function dblog_init() { + if (arg(0) == 'admin' && arg(1) == 'logs') { + // Add the CSS for this module + drupal_add_css(drupal_get_path('module', 'dblog') .'/dblog.css', 'module', 'all', FALSE); + } +} + +function dblog_admin_settings() { + $form['dblog_row_limit'] = array( + '#type' => 'select', + '#title' => t('Discard log entries above the following row limit'), + '#default_value' => variable_get('dblog_row_limit', 1000), + '#options' => drupal_map_assoc(array(100, 1000, 10000, 100000, 1000000)), + '#description' => t('The maximum number of rows to keep in the database log. Older entries will be automatically discarded. Requires crontab.') + ); + + return system_settings_form($form); +} + +/** + * Implementation of hook_cron(). + * + * Remove expired log messages and flood control events. + */ +function dblog_cron() { + // Cleanup the watchdog table + $min = db_result(db_query('SELECT MIN(wid) FROM {watchdog}')); + if ($min) { + $max = db_result(db_query('SELECT MAX(wid) FROM {watchdog}')); + if ($max) { + if (($max - $min) > variable_get('dblog_row_limit', 1000)) { + db_query('DELETE FROM {watchdog} WHERE wid < %d', $max - $min); + } + } + } +} + +/** + * Implementation of hook_user(). + */ +function dblog_user($op, &$edit, &$user) { + if ($op == 'delete') { + db_query('UPDATE {watchdog} SET uid = 0 WHERE uid = %d', $user->uid); + } +} + +function dblog_form_overview() { + $names['all'] = t('all messages'); + foreach (_dblog_get_message_types() as $type) { + $names[$type] = t('!type messages', array('!type' => t($type))); + } + + if (empty($_SESSION['dblog_overview_filter'])) { + $_SESSION['dblog_overview_filter'] = 'all'; + } + + $form['filter'] = array( + '#type' => 'select', + '#title' => t('Filter by message type'), + '#options' => $names, + '#default_value' => $_SESSION['dblog_overview_filter'] + ); + $form['submit'] = array('#type' => 'submit', '#value' => t('Filter')); + $form['#redirect'] = FALSE; + + return $form; +} +/** + * Menu callback; displays a listing of log messages. + */ +function dblog_overview() { + $rows = array(); + $icons = array(WATCHDOG_NOTICE => '', + WATCHDOG_WARNING => theme('image', 'misc/watchdog-warning.png', t('warning'), t('warning')), + WATCHDOG_ERROR => theme('image', 'misc/watchdog-error.png', t('error'), t('error'))); + $classes = array(WATCHDOG_NOTICE => 'dblog-notice', WATCHDOG_WARNING => 'dblog-warning', WATCHDOG_ERROR => 'dblog-error'); + + $output = drupal_get_form('dblog_form_overview'); + + $header = array( + ' ', + array('data' => t('Type'), 'field' => 'w.type'), + array('data' => t('Date'), 'field' => 'w.wid', 'sort' => 'desc'), + array('data' => t('Message'), 'field' => 'w.message'), + array('data' => t('User'), 'field' => 'u.name'), + array('data' => t('Operations')) + ); + + $sql = "SELECT w.wid, w.uid, w.severity, w.type, w.timestamp, w.message, w.link, u.name FROM {watchdog} w INNER JOIN {users} u ON w.uid = u.uid"; + $tablesort = tablesort_sql($header); + $type = $_SESSION['dblog_overview_filter']; + if ($type != 'all') { + $result = pager_query($sql ." WHERE w.type = '%s'". $tablesort, 50, 0, NULL, $type); + } + else { + $result = pager_query($sql . $tablesort, 50); + } + + while ($dblog = db_fetch_object($result)) { + $rows[] = array('data' => + array( + // Cells + $icons[$dblog->severity], + t($dblog->type), + format_date($dblog->timestamp, 'small'), + l(truncate_utf8($dblog->message, 56, TRUE, TRUE), 'admin/logs/event/'. $dblog->wid, array('html' => TRUE)), + theme('username', $dblog), + $dblog->link, + ), + // Attributes for tr + 'class' => "dblog-". preg_replace('/[^a-z]/i', '-', $dblog->type) .' '. $classes[$dblog->severity] + ); + } + + if (!$rows) { + $rows[] = array(array('data' => t('No log messages available.'), 'colspan' => 6)); + } + + $output .= theme('table', $header, $rows); + $output .= theme('pager', NULL, 50, 0); + + return $output; +} + +/** + * Menu callback; generic function to display a page of the most frequent + * dblog events of a specified type. + */ +function dblog_top($type) { + + $header = array( + array('data' => t('Count'), 'field' => 'count', 'sort' => 'desc'), + array('data' => t('Message'), 'field' => 'message') + ); + + $result = pager_query("SELECT COUNT(wid) AS count, message FROM {watchdog} WHERE type = '%s' GROUP BY message ". tablesort_sql($header), 30, 0, "SELECT COUNT(DISTINCT(message)) FROM {watchdog} WHERE type = '%s'", $type); + + $rows = array(); + while ($dblog = db_fetch_object($result)) { + $rows[] = array($dblog->count, truncate_utf8($dblog->message, 56, TRUE, TRUE)); + } + + if (empty($rows)) { + $rows[] = array(array('data' => t('No log messages available.'), 'colspan' => 2)); + } + + $output = theme('table', $header, $rows); + $output .= theme('pager', NULL, 30, 0); + + return $output; +} + +function theme_dblog_form_overview($form) { + return '
'. drupal_render($form) .'
'; +} + +function dblog_form_overview_submit($form_id, $form_values) { + $_SESSION['dblog_overview_filter'] = $form_values['filter']; +} + +/** + * Menu callback; displays details about a log message. + */ +function dblog_event($id) { + $severity = array(WATCHDOG_NOTICE => t('notice'), WATCHDOG_WARNING => t('warning'), WATCHDOG_ERROR => t('error')); + $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); + if ($dblog = db_fetch_object($result)) { + $rows = array( + array( + array('data' => t('Type'), 'header' => TRUE), + t($dblog->type), + ), + array( + array('data' => t('Date'), 'header' => TRUE), + format_date($dblog->timestamp, 'large'), + ), + array( + array('data' => t('User'), 'header' => TRUE), + theme('username', $dblog), + ), + array( + array('data' => t('Location'), 'header' => TRUE), + l($dblog->location, $dblog->location), + ), + array( + array('data' => t('Referrer'), 'header' => TRUE), + l($dblog->referer, $dblog->referer), + ), + array( + array('data' => t('Message'), 'header' => TRUE), + $dblog->message, + ), + array( + array('data' => t('Severity'), 'header' => TRUE), + $severity[$dblog->severity], + ), + array( + array('data' => t('Hostname'), 'header' => TRUE), + $dblog->hostname, + ), + array( + array('data' => t('Operations'), 'header' => TRUE), + $dblog->link, + ), + ); + $attributes = array('class' => 'dblog-event'); + $output = theme('table', array(), $rows, $attributes); + } + return $output; +} + +function _dblog_get_message_types() { + $types = array(); + + $result = db_query('SELECT DISTINCT(type) FROM {watchdog} ORDER BY type'); + while ($object = db_fetch_object($result)) { + $types[] = $object->type; + } + + return $types; +} + +function dblog_watchdog($log = array()) { + $current_db = db_set_active(); + db_query("INSERT INTO {watchdog} + (uid, type, message, severity, link, location, referer, hostname, timestamp) + VALUES + (%d, '%s', '%s', %d, '%s', '%s', '%s', '%s', %d)", + $log['user']->uid, + $log['type'], + $log['message'], + $log['severity'], + $log['link'], + $log['request_uri'], + $log['referer'], + $log['ip'], + $log['timestamp']); + + if ($current_db) { + db_set_active($current_db); + } +} -- cgit v1.2.3