diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 45c10ae96d1..46b86d06783 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -2,6 +2,11 @@ Drupal 6.0, xxxx-xx-xx (development version) ---------------------- +- New watchdog as a hook functionality. + * New hook_watchdog that can be implemented by any module to route log messages to various destinations. + * Expands the severity levels from 3 (Error, Warning, Notice) to the 8 levels defined in RFC 3164. + * The watchdog module is now called dblog, and is optional, but enabled by default in the default install profile. + * New optional syslog.module now in core. - Added theme registry: modules can directly provide .tpl.php files for their themes without having to create theme_ functions. - Added versioning support to node terms. - Made it easier to theme the forum overview page. diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc index 390768c6657..b68c95363a5 100644 --- a/includes/bootstrap.inc +++ b/includes/bootstrap.inc @@ -35,22 +35,17 @@ define('CACHE_NORMAL', 1); define('CACHE_AGGRESSIVE', 2); /** - * Indicates a notice-level watchdog event; these are normally notifications - * of normal system events that have occurred and can usually be safely ignored. + * + * Severity levels, as defined in RFC 3164 http://www.faqs.org/rfcs/rfc3164.html */ -define('WATCHDOG_NOTICE', 0); - -/** - * Indicates a warning-level watchdog event; this can be triggered by an error - * in a module that does not impact the overall functionality of the site. - */ -define('WATCHDOG_WARNING', 1); - -/** - * Indicates an error-level watchdog event; could be indicative of an attempt - * to compromise the security of the site, or a serious system error. - */ -define('WATCHDOG_ERROR', 2); +define('WATCHDOG_EMERG', 0); // Emergency: system is unusable +define('WATCHDOG_ALERT', 1); // Alert: action must be taken immediately +define('WATCHDOG_CRITICAL', 2); // Critical: critical conditions +define('WATCHDOG_ERROR', 3); // Error: error conditions +define('WATCHDOG_WARNING', 4); // Warning: warning conditions +define('WATCHDOG_NOTICE', 5); // Notice: normal but significant condition +define('WATCHDOG_INFO', 6); // Informational: informational messages +define('WATCHDOG_DEBUG', 7); // Debug: debug-level messages /** * First bootstrap phase: initialize configuration. @@ -649,25 +644,29 @@ function request_uri() { * @param $message * The message to store in the log. * @param $severity - * The severity of the message. One of the following values: - * - WATCHDOG_NOTICE - * - WATCHDOG_WARNING - * - WATCHDOG_ERROR + * The severity of the message, as per RFC 3164 * @param $link * A link to associate with the message. */ function watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL) { global $user, $base_root; - $current_db = db_set_active(); + // Prepare the fields to be logged + $log_message = array( + 'type' => $type, + 'message' => $message, + 'severity' => $severity, + 'link' => $link, + 'user' => $user, + 'request_uri' => $base_root . request_uri(), + 'referer' => referer_uri(), + 'ip' => $_SERVER['REMOTE_ADDR'], + 'timestamp' => time(), + ); - // Note: log the exact, entire absolute URL. - $request_uri = $base_root . request_uri(); - - db_query("INSERT INTO {watchdog} (uid, type, message, severity, link, location, referer, hostname, timestamp) VALUES (%d, '%s', '%s', %d, '%s', '%s', '%s', '%s', %d)", $user->uid, $type, $message, $severity, $link, $request_uri, referer_uri(), $_SERVER['REMOTE_ADDR'], time()); - - if ($current_db) { - db_set_active($current_db); + // Call the logging hooks to log/process the message + foreach (module_implements('watchdog', TRUE) as $module) { + module_invoke($module, 'watchdog', $log_message); } } diff --git a/includes/module.inc b/includes/module.inc index d2a6d7c0ab2..99b10043ace 100644 --- a/includes/module.inc +++ b/includes/module.inc @@ -423,5 +423,5 @@ function module_invoke_all() { * Array of modules required by core. */ function drupal_required_modules() { - return array('block', 'filter', 'node', 'system', 'user', 'watchdog'); + return array('block', 'filter', 'node', 'system', 'user'); } diff --git a/modules/dblog/dblog.css b/modules/dblog/dblog.css new file mode 100644 index 00000000000..d5ef7f26074 --- /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 00000000000..124280577d5 --- /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 00000000000..f94bab65110 --- /dev/null +++ b/modules/dblog/dblog.install @@ -0,0 +1,53 @@ +'. t('The watchdog 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 watchdog log is simply a list of recorded events containing usage data, performance data, errors, warnings and operational information. Administrators should check the watchdog report on a regular basis to ensure their site is working properly.') .'
'; - $output .= ''. t('For more information please read the configuration and customization handbook Watchdog page.', array('@watchdog' => 'http://drupal.org/handbook/modules/watchdog/')) .'
'; + case 'admin/help#dblog': + $output = ''. 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 watchdog module monitors your website, 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.') .'
'; + 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 watchdog_theme() { +function dblog_theme() { return array( - 'watchdog_form_overview' => array( + 'dblog_form_overview' => array( 'arguments' => array('form' => NULL), ), ); @@ -41,75 +41,102 @@ function watchdog_theme() { /** * Implementation of hook_menu(). */ -function watchdog_menu() { - $items['admin/logs/watchdog'] = array( +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' => 'watchdog_overview', + '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' => 'watchdog_top', + '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' => 'watchdog_top', + 'page callback' => 'dblog_top', 'page arguments' => array('access denied'), ); $items['admin/logs/event/%'] = array( 'title' => t('Details'), - 'page callback' => 'watchdog_event', + 'page callback' => 'dblog_event', 'page arguments' => array(3), 'type' => MENU_CALLBACK, ); return $items; } -function watchdog_init() { +function dblog_init() { if (arg(0) == 'admin' && arg(1) == 'logs') { // Add the CSS for this module - drupal_add_css(drupal_get_path('module', 'watchdog') .'/watchdog.css', 'module', 'all', FALSE); + 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 watchdog_cron() { - db_query('DELETE FROM {watchdog} WHERE timestamp < %d', time() - variable_get('watchdog_clear', 604800)); - db_query('DELETE FROM {flood} WHERE timestamp < %d', time() - 3600); +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 watchdog_user($op, &$edit, &$user) { +function dblog_user($op, &$edit, &$user) { if ($op == 'delete') { db_query('UPDATE {watchdog} SET uid = 0 WHERE uid = %d', $user->uid); } } -function watchdog_form_overview() { +function dblog_form_overview() { $names['all'] = t('all messages'); - foreach (_watchdog_get_message_types() as $type) { + foreach (_dblog_get_message_types() as $type) { $names[$type] = t('!type messages', array('!type' => t($type))); } - if (empty($_SESSION['watchdog_overview_filter'])) { - $_SESSION['watchdog_overview_filter'] = 'all'; + 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['watchdog_overview_filter'] + '#default_value' => $_SESSION['dblog_overview_filter'] ); $form['submit'] = array('#type' => 'submit', '#value' => t('Filter')); $form['#redirect'] = FALSE; @@ -119,13 +146,14 @@ function watchdog_form_overview() { /** * Menu callback; displays a listing of log messages. */ -function watchdog_overview() { +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 => 'watchdog-notice', WATCHDOG_WARNING => 'watchdog-warning', WATCHDOG_ERROR => 'watchdog-error'); + $classes = array(WATCHDOG_NOTICE => 'dblog-notice', WATCHDOG_WARNING => 'dblog-warning', WATCHDOG_ERROR => 'dblog-error'); - $output = drupal_get_form('watchdog_form_overview'); + $output = drupal_get_form('dblog_form_overview'); $header = array( ' ', @@ -138,7 +166,7 @@ function watchdog_overview() { $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['watchdog_overview_filter']; + $type = $_SESSION['dblog_overview_filter']; if ($type != 'all') { $result = pager_query($sql ." WHERE w.type = '%s'". $tablesort, 50, 0, NULL, $type); } @@ -146,19 +174,19 @@ function watchdog_overview() { $result = pager_query($sql . $tablesort, 50); } - while ($watchdog = db_fetch_object($result)) { + while ($dblog = db_fetch_object($result)) { $rows[] = array('data' => array( // Cells - $icons[$watchdog->severity], - t($watchdog->type), - format_date($watchdog->timestamp, 'small'), - l(truncate_utf8($watchdog->message, 56, TRUE, TRUE), 'admin/logs/event/'. $watchdog->wid, array('html' => TRUE)), - theme('username', $watchdog), - $watchdog->link, + $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' => "watchdog-". preg_replace('/[^a-z]/i', '-', $watchdog->type) .' '. $classes[$watchdog->severity] + 'class' => "dblog-". preg_replace('/[^a-z]/i', '-', $dblog->type) .' '. $classes[$dblog->severity] ); } @@ -174,9 +202,9 @@ function watchdog_overview() { /** * Menu callback; generic function to display a page of the most frequent - * watchdog events of a specified type. + * dblog events of a specified type. */ -function watchdog_top($type) { +function dblog_top($type) { $header = array( array('data' => t('Count'), 'field' => 'count', 'sort' => 'desc'), @@ -186,8 +214,8 @@ function watchdog_top($type) { $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 ($watchdog = db_fetch_object($result)) { - $rows[] = array($watchdog->count, truncate_utf8($watchdog->message, 56, TRUE, TRUE)); + while ($dblog = db_fetch_object($result)) { + $rows[] = array($dblog->count, truncate_utf8($dblog->message, 56, TRUE, TRUE)); } if (empty($rows)) { @@ -200,67 +228,67 @@ function watchdog_top($type) { return $output; } -function theme_watchdog_form_overview($form) { +function theme_dblog_form_overview($form) { return '