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

Dries's avatar
 
Dries committed
4
function watchdog_help() {
Dries's avatar
 
Dries committed
5 6 7 8

  $output .= "<p>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 ". l("check the Watchdog report", "admin/watchdog") ." on a regular basis as it is often the only way to tell what is going on.</p>";
  $output .= "<p>To ease administration, the watchdog will automatically discard old log entries, ". l("as configured", "admin/system/modules/watchdog") .". Needs \"cron.php\" to discard the entries.</p>";
  return t($output);
Dries's avatar
 
Dries committed
9 10
}

11 12
function watchdog_system($field){
  $system["description"] = t("Logs and records system events.");
Dries's avatar
 
Dries committed
13
  $system["admin_help"] = t("Watchdog logs your system events. Too see these logs go to <a href=\"%watchdog\">Site monitoring</a>. Since these logs can grow out of control if kept around forever, below set how long an item should be kept in the log.<br />Note:<ul><li>To discard entries as set below you must run \"cron.php\" regularly.</li></ul>", array("%watchdog" => url("admin/watchdog")));
14 15 16
  return $system[$field];
}

Dries's avatar
 
Dries committed
17
function watchdog_perm() {
Dries's avatar
 
Dries committed
18
  return array("administer watchdog");
Dries's avatar
 
Dries committed
19 20
}

Dries's avatar
 
Dries committed
21
function watchdog_link($type) {
Dries's avatar
 
Dries committed
22
  if ($type == "admin" && user_access("administer watchdog")) {
Dries's avatar
 
Dries committed
23 24 25 26 27 28 29
    $help["general"] = t("The watchdog module monitors your web site, captures system events in a log and records them to be reviewed by an authorized individual at a later time.  The watchdog log is simply a list of events recorded during operation and contains 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.");
    $help["user"] = t("Watchdog events that have to do with users. Most of these come from the user.module.");
    $help["regular"] = t("Watchdog events that are \"normal\" and have no other classification.");
    $help["httpd"] = t("Watchdog events that are from the web server.<br />Note: At this time this logging level is <b>not</b> used.");
    $help["special"] = t("Watchdog events about adding, changing, and moderating nodes and comments.");
    $help["error"] = t("Watchdog general error events, such as invalid login, permission denied, and database errors.");
    $help["warning"] = t("Watchdog warning events. These events don't stop Drupal from running, but are things you should no to correct.");
Dries's avatar
 
Dries committed
30

Dries's avatar
 
Dries committed
31 32 33 34 35 36 37 38
    menu("admin/watchdog", "site monitoring", "watchdog_admin", $help["general"], 6);
    menu("admin/watchdog/user", "user messages", "watchdog_admin", $help["user"]);
    menu("admin/watchdog/regular", "regular messages", "watchdog_admin", $help["regular"]);
    menu("admin/watchdog/special", "special messages", "watchdog_admin", $help["special"]);
    menu("admin/watchdog/warning", "warning messages", "watchdog_admin", $help["warning"]);
    menu("admin/watchdog/error", "error messages", "watchdog_admin", $help["error"]);
    menu("admin/watchdog/httpd", "httpd messages", "watchdog_admin", $help["http"]);
    menu("admin/watchdog/view", "view details", "watchdog_admin", $help["general"], 0, 1); // hidden menu
Dries's avatar
 
Dries committed
39 40 41
  }
}

42
function watchdog_settings() {
Dries's avatar
 
Dries committed
43 44
  $period = array(3600 => format_interval(3600), 10800 => format_interval(10800), 21600 => format_interval(21600), 32400 => format_interval(32400), 43200 => format_interval(43200), 86400 => format_interval(86400), 172800 => format_interval(172800), 259200 => format_interval(259200), 604800 => format_interval(604800), 1209600 => format_interval(1209600), 2419200 => format_interval(2419200), 1000000000 => t("Never"));
  $output .= form_select(t("Discard entries older than"), "watchdog_clear", variable_get("watchdog_clear", 604800), $period, t("The time watchdog entries should be kept.  Older entries will be automatically discarded.  Requires crontab."));
Dries's avatar
 
Dries committed
45 46 47
  return $output;
}

Dries's avatar
 
Dries committed
48
function watchdog_cron() {
Dries's avatar
 
Dries committed
49
  db_query("DELETE FROM {watchdog} WHERE ". time() ." - timestamp > ". variable_get("watchdog_clear", 604800));
Dries's avatar
 
Dries committed
50
}
Dries's avatar
 
Dries committed
51

Dries's avatar
 
Dries committed
52
function watchdog_overview($type) {
Dries's avatar
 
Dries committed
53 54
  $color = array("user" => "#FFEEAA", "message" => "#FFFFFF", "special" => "#A49FFF", "warning" => "#FFAA22", "httpd" => "#99DD99", "error" => "#EE4C4C");
  $query = array("user" => "WHERE type = 'user'", "regular" => "WHERE type = 'message'", "special" => "WHERE type = 'special'", "warning" => "WHERE type = 'warning'", "error" => "WHERE type = 'error'", "httpd" => "WHERE type = 'httpd'", "actions" => "WHERE link != ''");
Dries's avatar
 
Dries committed
55

Dries's avatar
 
Dries committed
56
  $result = pager_query("SELECT w.*, u.name, u.uid FROM {watchdog} w LEFT JOIN {users} u ON w.uid = u.uid ". ($type ? $query[$type] : "") ." ORDER BY w.timestamp DESC", 50);
Dries's avatar
 
Dries committed
57

Dries's avatar
 
Dries committed
58
  while ($watchdog = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
59
    if ($background = $color[$watchdog->type]) {
Dries's avatar
 
Dries committed
60
      $data .= " <tr style=\"background-color: $background\"><td>". format_date($watchdog->timestamp, "small") ."</td><td>". substr(strip_tags($watchdog->message), 0, 64) ."</td><td style=\"text-align: center;\">". format_name($watchdog) ."</td><td style=\"text-align: center;\">$watchdog->link</td><td style=\"text-align: center;\">". l(t("view details"), "admin/watchdog/view/$watchdog->wid") ."</td></tr>";
Dries's avatar
 
Dries committed
61
    }
Dries's avatar
 
Dries committed
62
  }
Dries's avatar
 
Dries committed
63

Dries's avatar
 
Dries committed
64 65
  $output .= "<table>";
  $output .= " <tr><th>" . t("date") . "</th><th>" . t("event") . "</th><th>" . t("user") . "</th><th colspan=\"2\">" . t("operations") . "</th></tr>";
Dries's avatar
 
Dries committed
66 67
  $output .= ($data ? $data : "<tr><td style=\"text-align: center;\" colspan=\"4\">". t("No system messages currently available.") ."</td></tr>");
  $output .= (($pager = pager_display(NULL, 50, 0, "admin")) ? "<tr><td style=\"text-align: center;\" colspan=\"4\">$pager</td></tr>" : "");
Dries's avatar
 
Dries committed
68
  $output .= "</table>";
Dries's avatar
 
Dries committed
69

Dries's avatar
 
Dries committed
70
  return $output;
Dries's avatar
 
Dries committed
71 72 73
}

function watchdog_view($id) {
Dries's avatar
 
Dries committed
74

Dries's avatar
 
Dries committed
75
  $result = db_query("SELECT w.*, u.name, u.uid FROM {watchdog} w LEFT JOIN {users} u ON w.uid = u.uid WHERE w.wid = %d", $id);
Dries's avatar
 
Dries committed
76 77

  if ($watchdog = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
78
    $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">";
Dries's avatar
 
Dries committed
79 80 81 82 83 84
    $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>";
Dries's avatar
 
Dries committed
85
    $output .= "</table>";
Dries's avatar
 
Dries committed
86

Dries's avatar
 
Dries committed
87 88
    return $output;
  }
Dries's avatar
 
Dries committed
89 90
}

Dries's avatar
 
Dries committed
91
function watchdog_admin() {
Dries's avatar
 
Dries committed
92

Dries's avatar
 
Dries committed
93
  if (user_access("administer watchdog")) {
Dries's avatar
 
Dries committed
94
    switch (arg(2)) {
Dries's avatar
 
Dries committed
95 96 97 98
      case "help":
        watchdog_help();
        break;
      case "view":
Dries's avatar
 
Dries committed
99
        print watchdog_view(arg(3));
Dries's avatar
 
Dries committed
100 101
        break;
      default:
Dries's avatar
 
Dries committed
102
        print watchdog_overview(arg(2));
Dries's avatar
 
Dries committed
103 104 105 106
    }
  }
  else {
    print message_access();
Dries's avatar
 
Dries committed
107 108
  }
}
Dries's avatar
 
Dries committed
109

Dries's avatar
 
Dries committed
110
?>