src/gcm_input/gcm_input.cpp

   1 /**************************************************************************
   2 **  (c) Copyright 2002, Andromeda Technology & Automation
   3 ** This is free software; you can redistribute it and/or modify it under the
   4 ** terms of the GNU General Public License, see the file COPYING.
   5 ***************************************************************************
   6 ** MODULE INFORMATION *
   7 ***********************
   8 **      FILE NAME      : gcm_input.cpp
   9 **      SYSTEM NAME    : Gnucomo - Gnu Computer Monitoring
  10 **      VERSION NUMBER : $Revision: 1.10 $
  11 **
  12 **  DESCRIPTION      :  Application to store client messages into the database
  13 **                      The client message contains a log file from one of the
  14 **                      system logs. Gcm_input parses the log file and enters
  15 **                      the raw data into the 'log' table of the gnucomo database.
  16 **
  17 **                      The system log may arrive in one of several forms:
  18 **                      1. Log file (archived or not) from a client machine.
  19 **                      2. Log file from a client system, arriving in a clear Email.
  20 **                      3. Log file from a client machine, arriving in an
  21 **                         encrypted Email.
  22 **
  23 **                      additional information we need that may not be availble in
  24 **                      the content of the log is:
  25 **                      - FQDN of the client.
  26 **                      - Time of arrival of the log
  27 **                      - Service that created the log.
  28 **
  29 **                      If the log arrives in an Email, these items probably are
  30 **                      available in the mail header. Otherwise, they have to be
  31 **                      provided as command line arguments.
  32 **
  33 **                      Command line arguments:
  34 **                      -c <name>        Configuration name (default = gnucomo).
  35 **                      -d <date>        Date and time of log arrival.
  36 **                      -h <hostname>    FQDN of the client.
  37 **                      -i               Incremental - partial list of parameters.
  38 **                      -s <service>     Service that created the log.
  39 **                      -T               Test mode. Do not alter the database.
  40 **                      -v               Verbose (debug) output.
  41 **                      -V               Print version and exit.
  42 **
  43 **  EXPORTED OBJECTS :
  44 **  LOCAL    OBJECTS :
  45 **  MODULES  USED    :
  46 ***************************************************************************
  47 **  ADMINISTRATIVE INFORMATION *
  48 ********************************
  49 **      ORIGINAL AUTHOR : Arjen Baart - arjen@andromeda.nl
  50 **      CREATION DATE   : Aug 29, 2002
  51 **      LAST UPDATE     : Aug 11, 2003
  52 **      MODIFICATIONS   :
  53 **************************************************************************/
  54
  55 /*****************************
  56    $Log: gcm_input.cpp,v $
  57    Revision 1.10  2003-09-03 06:58:31  arjen
  58    Changed version string to 0.0.8
  59
  60    Revision 1.9  2003/09/01 06:59:26  arjen
  61    A date without the time for the '-d <date> option will
  62    assume midnight on that date.
  63
  64    Revision 1.8  2003/08/16 15:30:19  arjen
  65    Fixed a gcc 2 vs. gcc 3 problem
  66
  67    Revision 1.7  2003/08/14 10:28:37  arjen
  68    Use parameters from a new section 'logging' with three configuration parameters:
  69       method       - Output method to use for logging.
  70       destination  - Name of the log output destination.
  71       level        - Log level: Verbose output if greater than 0.
  72
  73    Revision 1.6  2003/08/11 16:56:16  arjen
  74    Different kinds of log files are parsed by a collection of objects
  75    of different classes, derived from the base class line_cooker
  76    Depending on the message content or the message_type element in
  77    XML, one of these objects is selected.
  78
  79    Logrunner is integrated with gcm_input. Although its functionality
  80    is still limited, a connection between logrunner and gcm_input
  81    is beginning to form.
  82
  83    Revision 1.5  2003/08/05 08:11:06  arjen
  84    Added two configuration parameters:
  85       logfile   - Log to this file instead of stderr.
  86       verbosity - Verbose output if greater than 0.
  87    Added '-i' option for incremental parameter updates
  88
  89    Revision 1.4  2003/03/29 08:42:00  arjen
  90    Exit without reading any input if the database connection fails.
  91
  92    Revision 1.3  2002/11/09 08:04:27  arjen
  93    Added a reference to the GPL
  94
  95    Revision 1.2  2002/11/04 10:13:36  arjen
  96    Use proper namespace for iostream classes
  97
  98    Revision 1.1  2002/10/05 10:25:49  arjen
  99    Creation of gcm_input and a first approach to a web interface
 100
 101 *****************************/
 102
 103 static const char *RCSID = "$Id: gcm_input.cpp,v 1.10 2003-09-03 06:58:31 arjen Exp $";
 104
 105 #include <fstream>
 106
 107 #include <getopt.h>
 108
 109 #include "message.h"
 110 #include "syslog_cooker.h"
 111 #include "irix_syslog_cooker.h"
 112 #include "access_cooker.h"
 113 #include "error_cooker.h"
 114
 115 bool verbose = false;
 116 bool testmode = false;
 117 bool incremental = false;
 118 std::ostream *log = &std::cerr;
 119
 120 static char *Version = "gcm_input version 0.0.8 - Sep 04, 2003";
 121
 122
 123 /*=========================================================================
 124 **  NAME           : main
 125 **  SYNOPSIS       : int main(int argc, char *argv[])
 126 **  PARAMETERS     :
 127 **  RETURN VALUE   :
 128 **
 129 **  DESCRIPTION    : Parse command line arguments and establish a connection
 130 **                   to the database.
 131 **                   When we have a database connection, parse the log file
 132 **                   from stdin.
 133 **
 134 **  VARS USED      :
 135 **  VARS CHANGED   :
 136 **  FUNCTIONS USED :
 137 **  SEE ALSO       :
 138 **  LAST MODIFIED  : Aug 11, 2003
 139 **=========================================================================
 140 */
 141
 142 int main(int argc, char *argv[])
 143 {
 144    const char *usage = "Usage: gcm_input [-c configname] [-h hostname] [-i] [-d date]"
 145                        " [-s service] [-T] [-v] [-V]\n";
 146
 147    gnucomo_config    cfg;
 148    char             *config_name = "gnucomo";
 149    std::ofstream    logfile;
 150
 151
 152    /*   Parse command line arguments */
 153
 154    UTC    arrival = Now();
 155    String  hostname(""), service("");
 156    int     option;
 157
 158
 159    while ((option = getopt(argc, argv, "c:h:d:s:iTvV")) != -1)
 160    {
 161       switch (option)
 162       {
 163       case 'c':
 164          config_name = optarg;
 165          break;
 166
 167       case 'h':
 168          hostname = optarg;
 169          break;
 170
 171       case 'd':
 172          arrival = String(optarg);
 173          if (!date(arrival).proper())
 174          {
 175             std::cerr << "gcm_input: Invalid date string: " << optarg
 176                       << "(" << arrival << ").\n";
 177             exit(1);
 178          }
 179          else if (!hour(arrival).proper())
 180          {
 181             arrival = UTC(date(arrival), hour(0,0,0));
 182          }
 183          break;
 184
 185       case 's':
 186          service = optarg;
 187          break;
 188
 189       case 'i':
 190          incremental = true;
 191          break;
 192
 193       case 'T':
 194          testmode = true;
 195          break;
 196
 197       case 'v':
 198          verbose = true;
 199          break;
 200
 201       case 'V':
 202          std::cout << Version << "\n";
 203          exit(0);
 204
 205       case '?':
 206       case ':':
 207          std::cerr << usage;
 208          exit(1);
 209       }
 210    }
 211    /*  Get the configuration file */
 212
 213    if (!cfg.read(config_name))
 214    {
 215       std::cerr << "Can not read Gnucomo configuration file for " << config_name << ".\n";
 216       exit(1);
 217    }
 218
 219    String log_method      = cfg.find_parameter("logging", "method");
 220    String log_destination = cfg.find_parameter("logging", "destination");
 221    int    level           = cfg.find_parameter("gcm_input", "level");
 222
 223    if (log_method == "file" && log_destination != "")
 224    {
 225       std::cerr << "Logging to " << log_destination << ".\n";
 226 #if __GNUC__ == 2
 227       logfile.open(log_destination, _IO_APPEND); // for gcc 2
 228 #else
 229       logfile.open(log_destination, std::ios_base::app); // for gcc 3
 230 #endif
 231       if (!logfile)
 232       {
 233          std::cerr << "Can't open logfile " << log_destination << " for writing.\n";
 234       }
 235       else
 236       {
 237          log = &logfile;
 238          verbose = verbose || level > 0;
 239       }
 240    }
 241
 242    if (verbose)
 243    {
 244       *log << "Hostname = " << hostname;
 245       *log << " Arrival = " << arrival;
 246       *log << " Service = " << service << "\n";
 247       *log << "Config OK.\n";
 248    }
 249
 250    /*  Try to connect to the database */
 251
 252    gnucomo_database db(&cfg);
 253
 254    if (db.is_connected())
 255    {
 256
 257       client_message      msg(&std::cin, db);
 258       syslog_cooker       slc;
 259       irix_syslog_cooker  islc;
 260       access_cooker       alc;
 261       error_cooker        elc;
 262
 263       msg.add_cooker(&slc);
 264       msg.add_cooker(&islc);
 265       msg.add_cooker(&alc);
 266       msg.add_cooker(&elc);
 267
 268       if (msg.classify(hostname, arrival, service) > 0.9)
 269       {
 270          msg.enter();
 271       }
 272       return 0;
 273    }
 274    else
 275    {
 276       *log << "gcm_input: Can not connect to database.\n";
 277       *log << "Gcm_input finished at " << Now() << ".\n";
 278       return 1;
 279    }
 280 }
 281