Mercurial > defr > drupal > core

annotate modules/dblog/dblog.module @ 20:e3d20ebd63d1 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag 6.9 for changeset 3edae6ecd6c6
author Franck Deroche <franck@defr.org>
date Thu, 15 Jan 2009 10:16:10 +0100
parents 2427550111ae
children
rev   line source
webmaster@1 1 <?php
webmaster@5 2 // $Id: dblog.module,v 1.21.2.2 2008/04/09 21:11:46 goba Exp $
webmaster@1 3
webmaster@1 4 /**
webmaster@1 5 * @file
webmaster@1 6 * System monitoring and logging for administrators.
webmaster@1 7 *
webmaster@1 8 * The dblog module monitors your site and keeps a list of
webmaster@1 9 * recorded events containing usage and performance data, errors,
webmaster@1 10 * warnings, and similar operational information.
webmaster@1 11 *
webmaster@1 12 * @see watchdog()
webmaster@1 13 */
webmaster@1 14
webmaster@1 15 /**
webmaster@1 16 * Implementation of hook_help().
webmaster@1 17 */
webmaster@1 18 function dblog_help($path, $arg) {
webmaster@1 19 switch ($path) {
webmaster@1 20 case 'admin/help#dblog':
webmaster@1 21 $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>';
webmaster@1 22 $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>';
webmaster@1 23 $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>';
webmaster@1 24 return $output;
webmaster@1 25 case 'admin/reports/dblog':
webmaster@1 26 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>';
webmaster@1 27 }
webmaster@1 28 }
webmaster@1 29
webmaster@1 30 /**
webmaster@1 31 * Implementation of hook_theme()
webmaster@1 32 */
webmaster@1 33 function dblog_theme() {
webmaster@1 34 return array(
webmaster@1 35 'dblog_filters' => array(
webmaster@1 36 'arguments' => array('form' => NULL),
webmaster@1 37 ),
webmaster@1 38 );
webmaster@1 39 }
webmaster@1 40
webmaster@1 41 /**
webmaster@1 42 * Implementation of hook_menu().
webmaster@1 43 */
webmaster@1 44 function dblog_menu() {
webmaster@1 45 $items['admin/settings/logging/dblog'] = array(
webmaster@1 46 'title' => 'Database logging',
webmaster@1 47 'description' => 'Settings for logging to the Drupal database logs. This is the most common method for small to medium sites on shared hosting. The logs are viewable from the admin pages.',
webmaster@1 48 'page callback' => 'drupal_get_form',
webmaster@1 49 'page arguments' => array('dblog_admin_settings'),
webmaster@5 50 'access arguments' => array('administer site configuration'),
webmaster@1 51 'file' => 'dblog.admin.inc',
webmaster@1 52 );
webmaster@1 53
webmaster@1 54 $items['admin/reports/dblog'] = array(
webmaster@1 55 'title' => 'Recent log entries',
webmaster@1 56 'description' => 'View events that have recently been logged.',
webmaster@1 57 'page callback' => 'dblog_overview',
webmaster@5 58 'access arguments' => array('access site reports'),
webmaster@1 59 'weight' => -1,
webmaster@1 60 'file' => 'dblog.admin.inc',
webmaster@1 61 );
webmaster@1 62 $items['admin/reports/page-not-found'] = array(
webmaster@1 63 'title' => "Top 'page not found' errors",
webmaster@1 64 'description' => "View 'page not found' errors (404s).",
webmaster@1 65 'page callback' => 'dblog_top',
webmaster@1 66 'page arguments' => array('page not found'),
webmaster@5 67 'access arguments' => array('access site reports'),
webmaster@1 68 'file' => 'dblog.admin.inc',
webmaster@1 69 );
webmaster@1 70 $items['admin/reports/access-denied'] = array(
webmaster@1 71 'title' => "Top 'access denied' errors",
webmaster@1 72 'description' => "View 'access denied' errors (403s).",
webmaster@1 73 'page callback' => 'dblog_top',
webmaster@1 74 'page arguments' => array('access denied'),
webmaster@5 75 'access arguments' => array('access site reports'),
webmaster@1 76 'file' => 'dblog.admin.inc',
webmaster@1 77 );
webmaster@1 78 $items['admin/reports/event/%'] = array(
webmaster@1 79 'title' => 'Details',
webmaster@1 80 'page callback' => 'dblog_event',
webmaster@1 81 'page arguments' => array(3),
webmaster@5 82 'access arguments' => array('access site reports'),
webmaster@1 83 'type' => MENU_CALLBACK,
webmaster@1 84 'file' => 'dblog.admin.inc',
webmaster@1 85 );
webmaster@1 86 return $items;
webmaster@1 87 }
webmaster@1 88
webmaster@1 89 function dblog_init() {
webmaster@1 90 if (arg(0) == 'admin' && arg(1) == 'reports') {
webmaster@1 91 // Add the CSS for this module
webmaster@1 92 drupal_add_css(drupal_get_path('module', 'dblog') .'/dblog.css', 'module', 'all', FALSE);
webmaster@1 93 }
webmaster@1 94 }
webmaster@1 95
webmaster@1 96
webmaster@1 97
webmaster@1 98 /**
webmaster@1 99 * Implementation of hook_cron().
webmaster@1 100 *
webmaster@1 101 * Remove expired log messages and flood control events.
webmaster@1 102 */
webmaster@1 103 function dblog_cron() {
webmaster@1 104 // Cleanup the watchdog table
webmaster@1 105 $max = db_result(db_query('SELECT MAX(wid) FROM {watchdog}'));
webmaster@5 106 db_query('DELETE FROM {watchdog} WHERE wid <= %d', $max - variable_get('dblog_row_limit', 1000));
webmaster@1 107 }
webmaster@1 108
webmaster@1 109 /**
webmaster@1 110 * Implementation of hook_user().
webmaster@1 111 */
webmaster@1 112 function dblog_user($op, &$edit, &$user) {
webmaster@1 113 if ($op == 'delete') {
webmaster@1 114 db_query('UPDATE {watchdog} SET uid = 0 WHERE uid = %d', $user->uid);
webmaster@1 115 }
webmaster@1 116 }
webmaster@1 117
webmaster@1 118 function _dblog_get_message_types() {
webmaster@1 119 $types = array();
webmaster@1 120
webmaster@1 121 $result = db_query('SELECT DISTINCT(type) FROM {watchdog} ORDER BY type');
webmaster@1 122 while ($object = db_fetch_object($result)) {
webmaster@1 123 $types[] = $object->type;
webmaster@1 124 }
webmaster@1 125
webmaster@1 126 return $types;
webmaster@1 127 }
webmaster@1 128
webmaster@1 129 function dblog_watchdog($log = array()) {
webmaster@1 130 $current_db = db_set_active();
webmaster@1 131 db_query("INSERT INTO {watchdog}
webmaster@1 132 (uid, type, message, variables, severity, link, location, referer, hostname, timestamp)
webmaster@1 133 VALUES
webmaster@1 134 (%d, '%s', '%s', '%s', %d, '%s', '%s', '%s', '%s', %d)",
webmaster@1 135 $log['user']->uid,
webmaster@1 136 $log['type'],
webmaster@1 137 $log['message'],
webmaster@1 138 serialize($log['variables']),
webmaster@1 139 $log['severity'],
webmaster@1 140 $log['link'],
webmaster@1 141 $log['request_uri'],
webmaster@1 142 $log['referer'],
webmaster@1 143 $log['ip'],
webmaster@1 144 $log['timestamp']);
webmaster@1 145
webmaster@1 146 if ($current_db) {
webmaster@1 147 db_set_active($current_db);
webmaster@1 148 }
webmaster@1 149 }
webmaster@1 150
webmaster@1 151 /**
webmaster@1 152 * Theme dblog administration filter selector.
webmaster@1 153 *
webmaster@1 154 * @ingroup themeable
webmaster@1 155 */
webmaster@1 156 function theme_dblog_filters($form) {
webmaster@1 157 $output = '';
webmaster@1 158 foreach (element_children($form['status']) as $key) {
webmaster@1 159 $output .= drupal_render($form['status'][$key]);
webmaster@1 160 }
webmaster@1 161 $output .= '<div id="dblog-admin-buttons">'. drupal_render($form['buttons']) .'</div>';
webmaster@1 162 return $output;
webmaster@1 163 }
webmaster@1 164