Maintenance update for automake and PHP.
[gnucomo.git] / src / gcm_daemon / gcm_daemon.php
index bd65a72..61062a8 100755 (executable)
    Gnucomo-0.0.8: September 4th 2003
 
  $Log: gcm_daemon.php,v $
- Revision 1.17  2003-10-29 09:58:29  arjen
+ Revision 1.26  2011-03-24 09:46:36  arjen
+ Resolve a hostname before adding to the abuses.
+
+ Revision 1.25  2007/12/12 09:06:21  arjen
+ Added a new script gcm_maintenance.php to cleanup the database
+ and check referential integrity. Purging old log entries is
+ removed from the gcm_daemon script.
+
+ Revision 1.24  2007/11/17 09:34:07  arjen
+ Cleaned up some leftovers
+
+ Revision 1.23  2007/11/03 10:31:12  arjen
+ Added the class definition for a filesystem parameter.
+ New issue type: 'property out of range'.
+
+ Revision 1.22  2007/10/23 11:23:52  arjen
+ Record the date when adding the number of abuses for an IP address
+ in the abuse list.
+
+ Revision 1.21  2007/01/11 13:47:41  arjen
+ Log_adv and derived tables removed.
+ Create notifications from log entries with pattern matching.
+
+ Revision 1.20  2005/06/04 07:15:16  arjen
+ Added pattern check on log entries with the service_pattern table.
+
+ Revision 1.19  2004/01/10 20:04:12  arjen
+ Send email about open notifications to an object's users.
+
+ Revision 1.18  2003/12/03 08:07:21  arjen
+ Changed the type of log_adv_daemon_email.delay and log_adv_daemon_email.xdelay
+ from time to interval. These delays can be more than 24 hours.
+
+ Revision 1.17  2003/10/29 09:58:29  arjen
  Create separate notifications for different objects in service_check().
 
  Revision 1.16  2003/09/03 12:48:48  arjen
 
 */
 
-// $Id: gcm_daemon.php,v 1.17 2003-10-29 09:58:29 arjen Exp $
+// $Id: gcm_daemon.php,v 1.26 2011-03-24 09:46:36 arjen Exp $
 
 ini_set('include_path', '.:./classes:../phpclasses');
 ini_set('html_errors', 'false');
 
-//Tell the log that we're up.
-define_syslog_variables();
+define("BATCHSIZE", 50000);
 
 require_once "gnucomo_config.php";
 require_once "db.class.php";
-require_once "gnucomo.process_log.php";
 
 // Set the standard variables //
 
 $project_name   = "gnucomo";    // name of the entire project
 $app_name       = "gcm_daemon"; // name of the application running
 $developrelease = "FALSE";      // Indicates if special debug settings are needed
-$db_version     = 43;           // The db_version indicates what the level of
+$db_version     = 54;           // The db_version indicates what the level of
                                 // the database should be. If the database is
                                 // old an update will be generated.
 $gcmd_version   = 5;            // This value indicates the active version of
@@ -164,9 +195,8 @@ else
   die ("Couldn't initialize database version.\n");
 }
 
-// If there is a new gcm_daemon_version the logrecords that couldn't be
-// understood can be reprocessed. For this reason processed is now changed
-// to false again for not recognized records.
+// The gcm_daemon version is maintained in the database to enable
+// automatic update actions.
 
 $local_sql = "SELECT setting_value FROM db_value
               WHERE setting = 'gcm_daemon_version'";
@@ -176,11 +206,6 @@ if ($dbms->fetch_row() == "TRUE")
 {
    if ($dbms->db_result_row[0] < $gcmd_version)
    {
-      //Reactive log-records that weren't understood earlier.
-
-      $local_sql = "UPDATE log SET processed = false
-                    WHERE logid NOT IN (SELECT DISTINCT logid FROM log_adv)";
-      $dbms->query($local_sql);
 
       //Update de gcm_daemon version in the database
       $local_sql = "UPDATE db_value SET setting_value = '".$gcmd_version;
@@ -197,11 +222,10 @@ if ($dbms->fetch_row() == "TRUE")
 do
 {
 
-   //At this place we start processing new log-lines
-
+   echo "Processing logs...\n";
    process_log ();
    service_check();
-   find_notifications();
+   //mail_notifications();
 
    //  Gather the statistics for each object
 
@@ -248,9 +272,12 @@ function process_log ()
      $last_log = $dbms->db_result_row[0];
   }
 
+  echo "Last processed logid = $last_log \n";
+
   //Query the log-table
+  $log_limit = $last_log + BATCHSIZE;
   $local_sql = "SELECT * FROM log WHERE logid > CAST(".$last_log." AS BIGINT)
-                ORDER BY logid";
+                AND logid <= $log_limit ORDER BY logid";
   $dbms->query($local_sql);
 
   //Update the log-statistics in the object-table
@@ -290,63 +317,12 @@ function process_log ()
        $local_object_os         = "";
        $local_object_os_version = "";
 
-       while ($local_counter < $dbms->num_rows())
-       {
-
-         $local_return_row = $dbms->fetch_row();
-         if ($local_return_row == 'TRUE')
-         {
-            // Work on active rows
-            $local_log_id = $dbms->db_result_row[0];
-
-            $local_sql_findobject = "SELECT os, os_version FROM object
-                                WHERE objectid = '".$dbms->db_result_row[1]."'";
-            $local_findobject_db->query($local_sql_findobject);
-            $local_findobject_result = $local_findobject_db->fetch_row();
-            if ($local_findobject_result == 'TRUE')
-            {
-
-                // Now work on the OS again
-                $local_object_os = $local_findobject_db->db_result_row[0];
-                if  ($local_object_os == "")
-                {
-                    $local_object_os = "Linux";
-                    $local_object_os_version = "Unknown assuming Linux";
-                }
-                else
-                {
-                  $local_object_os_version = $local_findobject_db->db_result_row[1];
-                }
-             }
-
-            switch (strtolower($local_object_os))
-            {
-            case "linux":
-                $local_process_return = linux_log ();
-                break;
-            default:
-                syslog (LOG_INFO, "Couldn't find suitable OS for processing the logline");
-                break;
-            }
-
-            if ($local_process_return != 'TRUE')
-            {
-              $local_process_return = 'FALSE';
-            }
-
-         }
-         else
-         {
-
-           break;
-
-         }
-         $local_counter++;
-       }
+       match_log_patterns($last_log);
 
        // Register that the logrecords have been processed.
+       $local_upper_row--;
        $local_sql = "UPDATE db_value SET setting_value = '"
-                   .$local_log_id."' where setting = 'log_processing'";
+                   . $local_upper_row ."' where setting = 'log_processing'";
        $dbms->query($local_sql);
 
 
@@ -447,6 +423,177 @@ function GatherStatistics($objectid)
    UpdateStatistic($objectid, 'logs', $cnt->count);
 }
 
+function match_log_patterns($logstart)
+{
+   global  $dbms;
+
+   $notifications = array();
+
+   $log_limit = $logstart + BATCHSIZE;
+   $noqueue_res = $dbms->query("select logid, objectid, servicecode, rawdata from log
+                              where logid > $logstart and logid <= $log_limit
+                              order by logid");
+   for ($row = 0; $row < $dbms->num_rows($noqueue_res); $row++)
+   {
+      $logentry = $dbms->fetch_object($noqueue_res, $row);
+      //echo "\n----------\n" . $logentry->rawdata . "\n----------\n";
+      $service = $logentry->servicecode;
+      $pattern_res = $dbms->query("select * from service_pattern where service='$service'
+                                              OR service='ANY' order by rank");
+
+      $match_found = false;
+      for ($patnr = 0; !$match_found && $patnr < $dbms->num_rows($pattern_res); $patnr++)
+      {
+         $srv_pat = $dbms->fetch_object($pattern_res, $patnr);
+         //echo "  Checking with pattern " . $srv_pat->pattern . "\n";
+         if (ereg($srv_pat->pattern, $logentry->rawdata, $matches))
+         {
+            //  Scan the argument for '$n' expressions and expand
+
+            $srv_pat->argument = expand_arguments($srv_pat->argument, $matches);
+            //echo "   " . $srv_pat->pattern . " matches.\n";
+            //echo "   Matched string: " . $matches[0] . "\n";
+            //echo "   Action = " . $srv_pat->action . "(" . $srv_pat->argument . ")\n\n";
+            $match_found = true;
+
+            switch ($srv_pat->action)
+            {
+            case "ignore":
+               break;
+
+            case "notify":
+               $notif = $srv_pat->argument;
+               if (!isset($notifications[$logentry->objectid][$notif]))
+               {
+                  //echo "Creating notification $notif for object " . $logentry->objectid . ".\n";
+                  $remark = "Notification generated from Gnucomo pattern match.";
+                  $notifications[$logentry->objectid][$notif] =
+                         $dbms->new_notification($logentry->objectid, $notif, $remark);
+               }
+               if (isset($notifications[$logentry->objectid][$notif]))
+               {
+                  //echo "Notification $notif for object " . $logentry->objectid . " already created.\n";
+                  $insertion = "INSERT INTO log_notification (notificationid, logid) VALUES ('";
+                  $insertion .= $notifications[$logentry->objectid][$notif] . "', '";
+                  $insertion .= $logentry->logid . "')";
+                  $dbms->query($insertion);
+               }
+               break;
+
+            case "abuse":
+               //echo "Recording abuse for address ", $srv_pat->argument, "\n  Log entry:\n  ";
+               //echo $logentry->rawdata, "\n  Pattern:\n  ", $srv_pat->pattern, "\n\n";
+
+               if (record_abuse($logentry->logid, $logentry->objectid, $srv_pat->argument, 1) >= 32)
+               {
+                  $source_ip = gethostbyname($srv_pat->argument);
+                  $notif = 'abuses exceeded';
+                  if (!isset($notifications[$logentry->objectid][$notif][$source_ip]))
+                  {
+                     echo "Creating notification $notif for object " . $logentry->objectid . ".\n";
+                     $remark = "Abuses from IP address $source_ip exceeded the limit.";
+                     $notifid = $dbms->new_notification($logentry->objectid, $notif, $remark);
+                     $notifications[$logentry->objectid][$notif][$source_ip] = $notifid;
+
+                     //  Add log entries from previously detected abuses
+
+                     echo " Add log entries from previously detected abuses\n";
+                     $abuses = $dbms->query("SELECT logid FROM log_abuse WHERE objectid = '" .
+                                    $logentry->objectid . "' AND source = '$source_ip'");
+                     for ($abusenr = 0; $abusenr < $dbms->num_rows($abuses); $abusenr++)
+                     {
+                        $log_abuse = $dbms->fetch_object($abuses, $abusenr);
+                        if ($log_abuse->logid != $logentry->logid)
+                        {
+                           $insertion = "INSERT INTO log_notification (notificationid, logid) VALUES ('";
+                           $insertion .= $notifid . "', '";
+                           $insertion .= $log_abuse->logid . "')";
+                           $dbms->query($insertion);
+                        }
+                     }
+                  }
+                  if (isset($notifications[$logentry->objectid][$notif][$source_ip]))
+                  {
+                     //echo "Notification $notif for object " . $logentry->objectid . " already created.\n";
+                     $insertion = "INSERT INTO log_notification (notificationid, logid) VALUES ('";
+                     $insertion .= $notifications[$logentry->objectid][$notif][$source_ip] . "', '";
+                     $insertion .= $logentry->logid . "')";
+                     $dbms->query($insertion);
+                  }
+               }
+               break;
+            case "forgive":
+               record_abuse($logentry->logid, $logentry->objectid, $srv_pat->argument, -4);
+               break;
+            default:
+               echo "Error: unrecognized action in service pattern: " . $srv_pat->action . "\n";
+               break;
+            }
+         }
+         else
+         {
+            // echo "   " . $srv_pat->pattern . " does not match.\n";
+         }
+      }
+
+   }
+}
+
+/*
+ *  Some IP address abused us. Record the event.
+ *  Return the number of abuse points recorded so far for the address
+ */
+
+function record_abuse($logid, $objectid, $sourceip, $points)
+{
+   global  $dbms;
+
+   $abuse_points = $points;
+
+   $ipaddress = gethostbyname($sourceip);
+   //echo " IP address for $sourceip is $ipaddress.\n";
+   $sourceip = $ipaddress;
+
+   $abres = $dbms->query("SELECT * FROM object_abuse WHERE objectid='$objectid' AND source='$sourceip'");
+
+   if (pg_numrows($abres) == 0 && $points > 0)
+   {
+      //echo "$sourceip is new.\n";
+      $dbms->query("INSERT INTO object_abuse VALUES ('$objectid', '$sourceip', '$points', '', NOW())");
+      $dbms->query("INSERT INTO log_abuse VALUES ('$logid', '$objectid', '$sourceip')");
+   }
+   else if (pg_numrows($abres) != 0)
+   {
+      $abuse = $dbms->fetch_object($abres, 0);
+      if ($abuse->status == '' || $abuse->status == 'dropped')
+      {
+         $abuse_points = $abuse->nr_abuses + $points;
+         if ($abuse_points < 0)
+         {
+            $abuse_points = 0;
+         }
+         //echo $sourceip . " will get " . $abuse_points . " abuse points, ";
+         //echo "Status was " . $abuse->status . "\n";
+         $dbms->query("UPDATE object_abuse SET nr_abuses='$abuse_points'" .
+                     ", last_change=NOW() WHERE objectid='$objectid' AND source='$sourceip'");
+
+         if ($points > 0)
+         {
+            $dbms->query("INSERT INTO log_abuse VALUES ('$logid', '$objectid', '$sourceip')");
+         }
+         if ($abuse_points >= 32)
+         {
+            //echo "      BLOCK IP adrress $sourceip on the firewall.\n";
+            $dbms->query("UPDATE object_abuse SET status='dropped'" .
+                     " WHERE objectid='$objectid' AND source='$sourceip'");
+         }
+      }
+   }
+
+   return $abuse_points;
+}
+
+
 /*
  *   Service_check - Check the log entries if there are any unknown
  *   services.
@@ -475,10 +622,13 @@ function service_check()
                             VALUES ('log_servicecheck', '0')");
    }
 
+   echo "Running service check from log id $last_log.\n";
    // Query the log-table
 
+   $log_limit = $last_log + BATCHSIZE;
    $qry = "SELECT logid, objectid, servicecode FROM log
-           WHERE logid > CAST(".$last_log." AS BIGINT) ORDER BY logid";
+           WHERE logid > CAST(".$last_log." AS BIGINT) AND logid <= $log_limit
+           ORDER BY logid";
    $log_res = $dbms->query($qry);
    //$log_res = $dbms->query("SELECT logid, objectid, servicecode,rawdata FROM log");
 
@@ -542,28 +692,65 @@ function service_check()
    $dbms->query($qry);
 }
 
-function find_notifications ()
-{
-
 /*
- *  Do something with notification checks.
- *
- * INPUT  : NONE
- * OUTPUT : NONE
+ *  find open notifications and send an email to the object's users.
  */
 
+function mail_notifications ()
+{
    global $dbms;
 
-   // Find checks that have to be executed.
-   $local_sql = "select * from notification_check where
-                    age(last_execution) > time_between_executions";
-   $dbms->query($local_sql);
+   $notifres = $dbms->query("SELECT notificationid, objectid, type_of_issueid FROM notification
+                               WHERE statuscode != 'cls'");
 
-   for ($i=0; $i<$dbms->num_rows(); $i++)
+   for ($notifrow = 0; $notifrow < pg_numrows($notifres); $notifrow++)
    {
-      // A check has been found that has to be executed
-      $dbms->fetch_row();
+      $notification = pg_fetch_object($notifres, $notifrow);
+
+      $issue = pg_fetch_object($dbms->query("SELECT description FROM type_of_issue
+                                             WHERE type_of_issueid='" . $notification->type_of_issueid . "'"), 0);
+      echo "Mailing Notification for object id " . $notification->objectid . "\n";
+      $object = pg_fetch_object($dbms->query("SELECT objectname FROM object
+                                              WHERE objectid='" . $notification->objectid ."'"), 0);
+
+      $users = $dbms->query("SELECT username FROM object_user WHERE objectid='" . $notification->objectid . "'");
+
+      for ($userrow = 0; $userrow < pg_numrows($users); $userrow++)
+      {
+         $objusr = pg_fetch_object($users, $userrow);
+         $usr = pg_fetch_object($dbms->query("SELECT email FROM usr
+                                              WHERE username='" . $objusr->username . "'"), 0);
+
+         $message = "Notification " . $notification->notificationid . ": " . $issue->description;
+         $message .= "  for object " . $object->objectname . "\n";
+
+         mail($usr->email, "GnuCoMo Notification", $message);
+      }
+   }
+}
+
+/*
+ *   The 'command' may contain positional parameters such as '$1' and '$3',
+ *   just like the shell. These parameters are replaced by content from
+ *   the 'args' array.
+ */
+
+function expand_arguments($command, $args)
+{
+   while (ereg('\$([0-9]+)', $command, $match))
+   {
+      $index = $match[1];
+      if ($index >= count($args))
+      {
+         echo "Error: Argument $index not found for $command.\n";
+         $command = ereg_replace('\$' . $index, "", $command);
+      }
+      else
+      {
+         $command = ereg_replace('\$' . $index, $args[$index], $command);
+      }
    }
+   return $command;
 }
 
 ?>