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.11 $
  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.11  2003-10-27 13:00:15  arjen
  58    Catch exceptions from the database library
  59
  60    Revision 1.10  2003/09/03 06:58:31  arjen
  61    Changed version string to 0.0.8
  62
  63    Revision 1.9  2003/09/01 06:59:26  arjen
  64    A date without the time for the '-d <date> option will
  65    assume midnight on that date.
  66
  67    Revision 1.8  2003/08/16 15:30:19  arjen
  68    Fixed a gcc 2 vs. gcc 3 problem
  69
  70    Revision 1.7  2003/08/14 10:28:37  arjen
  71    Use parameters from a new section 'logging' with three configuration parameters:
  72       method       - Output method to use for logging.
  73       destination  - Name of the log output destination.
  74       level        - Log level: Verbose output if greater than 0.
  75
  76    Revision 1.6  2003/08/11 16:56:16  arjen
  77    Different kinds of log files are parsed by a collection of objects
  78    of different classes, derived from the base class line_cooker
  79    Depending on the message content or the message_type element in
  80    XML, one of these objects is selected.
  81
  82    Logrunner is integrated with gcm_input. Although its functionality
  83    is still limited, a connection between logrunner and gcm_input
  84    is beginning to form.
  85
  86    Revision 1.5  2003/08/05 08:11:06  arjen
  87    Added two configuration parameters:
  88       logfile   - Log to this file instead of stderr.
  89       verbosity - Verbose output if greater than 0.
  90    Added '-i' option for incremental parameter updates
  91
  92    Revision 1.4  2003/03/29 08:42:00  arjen
  93    Exit without reading any input if the database connection fails.
  94
  95    Revision 1.3  2002/11/09 08:04:27  arjen
  96    Added a reference to the GPL
  97
  98    Revision 1.2  2002/11/04 10:13:36  arjen
  99    Use proper namespace for iostream classes
 100
 101    Revision 1.1  2002/10/05 10:25:49  arjen
 102    Creation of gcm_input and a first approach to a web interface
 103
 104 *****************************/
 105
 106 static const char *RCSID = "$Id: gcm_input.cpp,v 1.11 2003-10-27 13:00:15 arjen Exp $";
 107
 108 #include <fstream>
 109
 110 #include <getopt.h>
 111
 112 #include "message.h"
 113 #include "syslog_cooker.h"
 114 #include "irix_syslog_cooker.h"
 115 #include "access_cooker.h"
 116 #include "error_cooker.h"
 117
 118 bool verbose = false;
 119 bool testmode = false;
 120 bool incremental = false;
 121 std::ostream *log = &std::cerr;
 122
 123 static char *Version = "gcm_input version 0.0.8 - Sep 04, 2003";
 124
 125
 126 /*=========================================================================
 127 **  NAME           : main
 128 **  SYNOPSIS       : int main(int argc, char *argv[])
 129 **  PARAMETERS     :
 130 **  RETURN VALUE   :
 131 **
 132 **  DESCRIPTION    : Parse command line arguments and establish a connection
 133 **                   to the database.
 134 **                   When we have a database connection, parse the log file
 135 **                   from stdin.
 136 **
 137 **  VARS USED      :
 138 **  VARS CHANGED   :
 139 **  FUNCTIONS USED :
 140 **  SEE ALSO       :
 141 **  LAST MODIFIED  : Aug 11, 2003
 142 **=========================================================================
 143 */
 144
 145 int main(int argc, char *argv[])
 146 {
 147    const char *usage = "Usage: gcm_input [-c configname] [-h hostname] [-i] [-d date]"
 148                        " [-s service] [-T] [-v] [-V]\n";
 149
 150    gnucomo_config    cfg;
 151    char             *config_name = "gnucomo";
 152    std::ofstream    logfile;
 153
 154
 155    /*   Parse command line arguments */
 156
 157    UTC    arrival = Now();
 158    String  hostname(""), service("");
 159    int     option;
 160
 161
 162    while ((option = getopt(argc, argv, "c:h:d:s:iTvV")) != -1)
 163    {
 164       switch (option)
 165       {
 166       case 'c':
 167          config_name = optarg;
 168          break;
 169
 170       case 'h':
 171          hostname = optarg;
 172          break;
 173
 174       case 'd':
 175          arrival = String(optarg);
 176          if (!date(arrival).proper())
 177          {
 178             std::cerr << "gcm_input: Invalid date string: " << optarg
 179                       << "(" << arrival << ").\n";
 180             exit(1);
 181          }
 182          else if (!hour(arrival).proper())
 183          {
 184             arrival = UTC(date(arrival), hour(0,0,0));
 185          }
 186          break;
 187
 188       case 's':
 189          service = optarg;
 190          break;
 191
 192       case 'i':
 193          incremental = true;
 194          break;
 195
 196       case 'T':
 197          testmode = true;
 198          break;
 199
 200       case 'v':
 201          verbose = true;
 202          break;
 203
 204       case 'V':
 205          std::cout << Version << "\n";
 206          exit(0);
 207
 208       case '?':
 209       case ':':
 210          std::cerr << usage;
 211          exit(1);
 212       }
 213    }
 214    /*  Get the configuration file */
 215
 216    if (!cfg.read(config_name))
 217    {
 218       std::cerr << "Can not read Gnucomo configuration file for " << config_name << ".\n";
 219       exit(1);
 220    }
 221
 222    String log_method      = cfg.find_parameter("logging", "method");
 223    String log_destination = cfg.find_parameter("logging", "destination");
 224    int    level           = cfg.find_parameter("logging", "level");
 225
 226    if (log_method == "file" && log_destination != "")
 227    {
 228 #if __GNUC__ == 2
 229       logfile.open(log_destination, _IO_APPEND); // for gcc 2
 230 #else
 231       logfile.open(log_destination, std::ios_base::app); // for gcc 3
 232 #endif
 233       if (!logfile)
 234       {
 235          std::cerr << "Can't open logfile " << log_destination << " for writing.\n";
 236       }
 237       else
 238       {
 239          log = &logfile;
 240       }
 241    }
 242    verbose = verbose || level > 0;
 243
 244    if (verbose)
 245    {
 246       *log << "Hostname = " << hostname;
 247       *log << " Arrival = " << arrival;
 248       *log << " Service = " << service << "\n";
 249       *log << "Config OK.\n";
 250    }
 251
 252    /*  Try to connect to the database */
 253
 254    gnucomo_database db(&cfg);
 255
 256    if (db.is_connected())
 257    {
 258
 259       client_message      msg(&std::cin, db);
 260       syslog_cooker       slc;
 261       irix_syslog_cooker  islc;
 262       access_cooker       alc;
 263       error_cooker        elc;
 264
 265       msg.add_cooker(&slc);
 266       msg.add_cooker(&islc);
 267       msg.add_cooker(&alc);
 268       msg.add_cooker(&elc);
 269
 270       if (msg.classify(hostname, arrival, service) > 0.9)
 271       {
 272          try
 273          {
 274             msg.enter();
 275          }
 276          catch (exception &e)
 277          {
 278             *log << "Caught an exception: " << e.what() << "\n";
 279          }
 280       }
 281       return 0;
 282    }
 283    else
 284    {
 285       *log << "gcm_input: Can not connect to database.\n";
 286       *log << "Gcm_input finished at " << Now() << ".\n";
 287       return 1;
 288    }
 289 }
 290