dblog.module 13.4 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5 6 7
/**
 * @file
 * System monitoring and logging for administrators.
 *
8
 * The dblog module monitors your site and keeps a list of
Dries's avatar
 
Dries committed
9 10 11 12 13 14
 * recorded events containing usage and performance data, errors,
 * warnings, and similar operational information.
 *
 * @see watchdog().
 */

Dries's avatar
Dries committed
15 16 17
/**
 * Implementation of hook_help().
 */
18
function dblog_help($section) {
Dries's avatar
 
Dries committed
19
  switch ($section) {
20 21 22 23
    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 please read the configuration and customization handbook <a href="@dblog">Dblog page</a>.', array('@dblog' => 'http://drupal.org/handbook/modules/dblog/')) .'</p>';
24 25
      return $output;
    case 'admin/logs':
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>';
Dries's avatar
 
Dries committed
27
  }
28 29
}

30 31 32
/**
 * Implementation of hook_theme()
 */
33
function dblog_theme() {
34
  return array(
35
    'dblog_filters' => array(
36 37 38 39 40
      'arguments' => array('form' => NULL),
    ),
  );
}

Dries's avatar
 
Dries committed
41
/**
Dries's avatar
 
Dries committed
42
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
43
 */
44 45
function dblog_menu() {
  $items['admin/settings/logging/dblog'] = array(
46 47
    'title' => 'Database logging',
    '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.',
48 49 50 51 52
    'page callback' => 'drupal_get_form',
    'page arguments' => array('dblog_admin_settings'),
  );

  $items['admin/logs/dblog'] = array(
53 54
    'title' => 'Recent log entries',
    'description' => 'View events that have recently been logged.',
55
    'page callback' => 'dblog_overview',
56 57 58
    'weight' => -1,
  );
  $items['admin/logs/page-not-found'] = array(
59 60
    'title' => "Top 'page not found' errors",
    'description' => "View 'page not found' errors (404s).",
61
    'page callback' => 'dblog_top',
62 63 64
    'page arguments' => array('page not found'),
  );
  $items['admin/logs/access-denied'] = array(
65 66
      'title' => "Top 'access denied' errors",
    'description' => "View 'access denied' errors (403s).",
67
    'page callback' => 'dblog_top',
68 69 70
    'page arguments' => array('access denied'),
  );
  $items['admin/logs/event/%'] = array(
71
    'title' => 'Details',
72
    'page callback' => 'dblog_event',
73 74 75 76 77
    'page arguments' => array(3),
    'type' => MENU_CALLBACK,
  );
  return $items;
}
Dries's avatar
 
Dries committed
78

79
function dblog_init() {
80 81
  if (arg(0) == 'admin' && arg(1) == 'logs') {
    // Add the CSS for this module
82
    drupal_add_css(drupal_get_path('module', 'dblog') .'/dblog.css', 'module', 'all', FALSE);
83
  }
Dries's avatar
 
Dries committed
84 85
}

86 87 88 89 90 91 92 93 94 95 96 97
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);
}

Dries's avatar
Dries committed
98 99 100
/**
 * Implementation of hook_cron().
 *
Dries's avatar
 
Dries committed
101
 * Remove expired log messages and flood control events.
Dries's avatar
Dries committed
102
 */
103 104 105 106 107 108 109 110 111 112 113
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);
      }
    }
  }
Dries's avatar
 
Dries committed
114
}
Dries's avatar
 
Dries committed
115

116 117 118
/**
 * Implementation of hook_user().
 */
119
function dblog_user($op, &$edit, &$user) {
120
  if ($op == 'delete') {
Steven Wittens's avatar
Steven Wittens committed
121
    db_query('UPDATE {watchdog} SET uid = 0 WHERE uid = %d', $user->uid);
122 123 124
  }
}

125 126 127
/**
 * Menu callback; displays a listing of log messages.
 */
128
function dblog_overview() {
129
  $filter = dblog_build_filter_query();
130
  $rows = array();
131 132 133 134 135 136 137 138 139 140
  $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',
  );
141

142
  $output = drupal_get_form('dblog_filter_form');
143

Dries's avatar
 
Dries committed
144
  $header = array(
145
    ' ',
146
    array('data' => t('Type'), 'field' => 'w.type'),
147
    array('data' => t('Date'), 'field' => 'w.wid', 'sort' => 'desc'),
148
    t('Message'),
Dries's avatar
 
Dries committed
149
    array('data' => t('User'), 'field' => 'u.name'),
150
    array('data' => t('Operations')),
Dries's avatar
 
Dries committed
151
  );
152

153
  $sql = "SELECT w.wid, w.uid, w.severity, w.type, w.timestamp, w.message, w.variables, w.link, u.name FROM {watchdog} w INNER JOIN {users} u ON w.uid = u.uid";
154
  $tablesort = tablesort_sql($header);
155 156
  if (!empty($filter['where'])) {
    $result = pager_query($sql ." WHERE ". $filter['where'] . $tablesort, 50, 0, NULL, $filter['args']);
157 158 159 160
  }
  else {
    $result = pager_query($sql . $tablesort, 50);
  }
Dries's avatar
 
Dries committed
161

162
  while ($dblog = db_fetch_object($result)) {
163 164 165
    $rows[] = array('data' =>
      array(
        // Cells
166 167 168
        $icons[$dblog->severity],
        t($dblog->type),
        format_date($dblog->timestamp, 'small'),
169
        l(truncate_utf8(_dblog_format_message($dblog), 56, TRUE, TRUE), 'admin/logs/event/'. $dblog->wid, array('html' => TRUE)),
170 171
        theme('username', $dblog),
        $dblog->link,
172 173
      ),
      // Attributes for tr
174
      'class' => "dblog-". preg_replace('/[^a-z]/i', '-', $dblog->type) .' '. $classes[$dblog->severity]
Dries's avatar
 
Dries committed
175
    );
Dries's avatar
 
Dries committed
176
  }
Dries's avatar
 
Dries committed
177

Dries's avatar
 
Dries committed
178
  if (!$rows) {
179
    $rows[] = array(array('data' => t('No log messages available.'), 'colspan' => 6));
Dries's avatar
 
Dries committed
180
  }
Dries's avatar
 
Dries committed
181

182
  $output .= theme('table', $header, $rows);
183
  $output .= theme('pager', NULL, 50, 0);
184

185 186 187 188 189
  return $output;
}

/**
 * Menu callback; generic function to display a page of the most frequent
190
 * dblog events of a specified type.
191
 */
192
function dblog_top($type) {
193 194 195 196 197 198

  $header = array(
    array('data' => t('Count'), 'field' => 'count', 'sort' => 'desc'),
    array('data' => t('Message'), 'field' => 'message')
  );

199
  $result = pager_query("SELECT COUNT(wid) AS count, message, variables FROM {watchdog} WHERE type = '%s' GROUP BY message, variables ". tablesort_sql($header), 30, 0, "SELECT COUNT(DISTINCT(message)) FROM {watchdog} WHERE type = '%s'", $type);
200

201
  $rows = array();
202
  while ($dblog = db_fetch_object($result)) {
203
    $rows[] = array($dblog->count, truncate_utf8(_dblog_format_message($dblog), 56, TRUE, TRUE));
204 205
  }

206
  if (empty($rows)) {
207 208 209 210 211 212
    $rows[] = array(array('data' => t('No log messages available.'), 'colspan' => 2));
  }

  $output  = theme('table', $header, $rows);
  $output .= theme('pager', NULL, 30, 0);

Dries's avatar
 
Dries committed
213
  return $output;
Dries's avatar
 
Dries committed
214 215
}

Dries's avatar
Dries committed
216 217 218
/**
 * Menu callback; displays details about a log message.
 */
219
function dblog_event($id) {
220
  $severity = watchdog_severity_levels();
Dries's avatar
Dries committed
221 222
  $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);
223
  if ($dblog = db_fetch_object($result)) {
224 225 226
    $rows = array(
      array(
        array('data' => t('Type'), 'header' => TRUE),
227
        t($dblog->type),
228 229 230
      ),
      array(
        array('data' => t('Date'), 'header' => TRUE),
231
        format_date($dblog->timestamp, 'large'),
232 233 234
      ),
      array(
        array('data' => t('User'), 'header' => TRUE),
235
        theme('username', $dblog),
236 237 238
      ),
      array(
        array('data' => t('Location'), 'header' => TRUE),
239
        l($dblog->location, $dblog->location),
240 241 242
      ),
      array(
        array('data' => t('Referrer'), 'header' => TRUE),
243
        l($dblog->referer, $dblog->referer),
244 245 246
      ),
      array(
        array('data' => t('Message'), 'header' => TRUE),
247
        _dblog_format_message($dblog),
248 249 250
      ),
      array(
        array('data' => t('Severity'), 'header' => TRUE),
251
        $severity[$dblog->severity],
252 253 254
      ),
      array(
        array('data' => t('Hostname'), 'header' => TRUE),
255
        $dblog->hostname,
256
      ),
257 258
      array(
        array('data' => t('Operations'), 'header' => TRUE),
259
        $dblog->link,
260
      ),
261
    );
262
    $attributes = array('class' => 'dblog-event');
263
    $output = theme('table', array(), $rows, $attributes);
264 265 266 267
  }
  return $output;
}

268
function _dblog_get_message_types() {
Dries's avatar
 
Dries committed
269 270
  $types = array();

271
  $result = db_query('SELECT DISTINCT(type) FROM {watchdog} ORDER BY type');
Dries's avatar
 
Dries committed
272 273 274 275 276 277
  while ($object = db_fetch_object($result)) {
    $types[] = $object->type;
  }

  return $types;
}
278 279 280 281

function dblog_watchdog($log = array()) {
  $current_db = db_set_active();
  db_query("INSERT INTO {watchdog}
282
    (uid, type, message, variables, severity, link, location, referer, hostname, timestamp)
283
    VALUES
284
    (%d, '%s', '%s', '%s', %d, '%s', '%s', '%s', '%s', %d)",
285 286 287
    $log['user']->uid,
    $log['type'],
    $log['message'],
288
    serialize($log['variables']),
289 290 291 292 293 294 295 296 297 298 299
    $log['severity'],
    $log['link'],
    $log['request_uri'],
    $log['referer'],
    $log['ip'],
    $log['timestamp']);

  if ($current_db) {
    db_set_active($current_db);
  }
}
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316

/**
 * Formats a log message for display.
 *
 * @param $dblog
 *   An object with at least the message and variables properties
 */
function _dblog_format_message($dblog) {
  // Legacy messages and user specified text
  if ($dblog->variables === 'N;') {
    return $dblog->message;
  }
  // Message to translate with injected variables
  else {
    return t($dblog->message, unserialize($dblog->variables));
  }
}
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371

/**
 * Return form for dblog administration filters.
 */
function dblog_filter_form() {
  $session = &$_SESSION['dblog_overview_filter'];
  $session = is_array($session) ? $session : array();
  $filters = dblog_filters();

  $form['filters'] = array(
    '#type' => 'fieldset',
    '#title' => t('Filter log messages'),
    '#theme' => 'dblog_filters',
    '#collapsible' => TRUE,
    '#collapsed' => empty($session),
  );
  foreach ($filters as $key => $filter) {
    $form['filters']['status'][$key] = array(
      '#title' => $filter['title'],
      '#type' => 'select',
      '#multiple' => TRUE,
      '#size' => 8,
      '#options' => $filter['options'],
    );
    if (!empty($session[$key])) {
      $form['filters']['status'][$key]['#default_value'] = $session[$key];
    }
  }

  $form['filters']['buttons']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Filter'),
  );
  if (!empty($session)) {
    $form['filters']['buttons']['reset'] = array(
      '#type' => 'submit',
      '#value' => t('Reset')
    );
  }

  return $form;
}

/**
 * Theme dblog administration filter selector.
 */
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;
}

372 373
function dblog_filter_form_validate($form, &$form_state) {
  if ($form_state['values']['op'] == t('Filter') && empty($form_state['values']['type']) && empty($form_state['values']['severity'])) {
374 375 376 377 378 379 380
    form_set_error('type', t('You must select something to filter by.'));
  }
}

/**
 * Process result from dblog administration filter form.
 */
381 382
function dblog_filter_form_submit($form, &$form_state) {
  $op = $form_state['values']['op'];
383 384 385 386
  $filters = dblog_filters();
  switch ($op) {
    case t('Filter'):
      foreach ($filters as $name => $filter) {
387 388
        if (isset($form_state['values'][$name])) {
          $_SESSION['dblog_overview_filter'][$name] = $form_state['values'][$name];
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
        }
      }
      break;
    case t('Reset'):
      $_SESSION['dblog_overview_filter'] = array();
      break;
  }
  return 'admin/logs/dblog';
}

/**
 * List dblog administration filters that can be applied.
 */
function dblog_filters() {
  $filters = array();

  foreach(_dblog_get_message_types() as $type) {
    $types[$type] = $type;
  }

  if (!empty($types)) {
    $filters['type'] = array(
      'title' => t('Type'),
      'where' => "w.type = '%s'",
      'options' => $types,
    );
  }

  $filters['severity'] = array(
    'title' => t('Severity'),
    'where' => 'w.severity = %d',
    'options' => watchdog_severity_levels(),
  );

  return $filters;
}

/**
 * Build query for dblog administration filters based on session.
 */
function dblog_build_filter_query() {
  if (empty($_SESSION['dblog_overview_filter'])) {
    return;
  }

  $filters = dblog_filters();

  // Build query
  $where = $args = array();
  foreach ($_SESSION['dblog_overview_filter'] as $key => $filter) {
    $filter_where = array();
    foreach ($filter as $value) {
      $filter_where[] = $filters[$key]['where'];
      $args[] = $value;
    }
    if (!empty($filter_where)) {
      $where[] = '('. implode(' OR ', $filter_where) .')';
    }
  }
  $where = !empty($where) ? implode(' AND ', $where) : '';

  return array(
    'where' => $where,
    'args' => $args,
  );
}