git.pond.sub.org Git - empserver/blob - src/lib/common/journal.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2000, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
  23  *  related information and legal notices. It is expected that any future
  24  *  projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  journal.c: Log a journal of events to a file
  29  *
  30  *  Known contributors to this file:
  31  *     Markus Armbruster, 2004-2006
  32  */
  33
  34 /*
  35  * Journal file format: each line logs an event, and looks like this:
  36  *
  37  *     TIME THREAD EVENT DATA
  38  *
  39  * Events and their data are:
  40  *
  41  *     startup
  42  *     shutdown
  43  *     login CNUM HOSTADDR USER
  44  *     logout CNUM
  45  *     input INPUT
  46  *     update ETU
  47  */
  48
  49 #include <config.h>
  50
  51 #include <ctype.h>
  52 #include <errno.h>
  53 #include <stdarg.h>
  54 #include <stdio.h>
  55 #include <time.h>
  56 #include "misc.h"
  57 #include "empthread.h"
  58 #include "journal.h"
  59 #include "optlist.h"
  60 #include "player.h"
  61 #include "prototypes.h"
  62
  63 static char journal_fname[] = "journal.log";
  64 static FILE *journal;
  65
  66 int
  67 journal_open(void)
  68 {
  69     journal = fopen(journal_fname, "a+");
  70     return journal ? 0 : -1;
  71 }
  72
  73 int
  74 journal_close(void)
  75 {
  76     FILE *j = journal;
  77     journal = NULL;
  78     return j ? fclose(j) : 0;
  79 }
  80
  81 void
  82 journal_entry(char *fmt, ...)
  83 {
  84     static char buf[1024];
  85     va_list ap;
  86     time_t now;
  87     int n, i;
  88
  89     if (journal) {
  90         time(&now);
  91         n = sprintf(buf, "%.24s %p ", ctime(&now), empth_self());
  92         va_start(ap, fmt);
  93         vsnprintf(buf + n, sizeof(buf) - n - 1, fmt, ap);
  94         va_end(ap);
  95
  96         for (i = n; buf[i]; ++i) {
  97             if (!isprint(buf[i]))
  98                 buf[i] = '?';   /* FIXME replace by escape */
  99         }
 100         buf[i++] = '\n';
 101         buf[i] = 0;
 102         if (fputs(buf, journal) == EOF)
 103             logerror("Error writing journal (%s)", strerror(errno));
 104     }
 105 }
 106
 107 int
 108 journal_startup(void)
 109 {
 110     if (!keep_journal)
 111         return 0;
 112     if (journal_open() < 0) {
 113         logerror("Can't open %s (%s)", journal_fname, strerror(errno));
 114         return -1;
 115     }
 116     journal_entry("startup");
 117     return 0;
 118 }
 119
 120 void
 121 journal_shutdown(void)
 122 {
 123     journal_entry("shutdown");
 124     journal_close();
 125 }
 126
 127 void
 128 journal_login(void)
 129 {
 130     journal_entry("login %d %s %s",
 131                   player->cnum, player->hostaddr, player->userid);
 132 }
 133
 134 void
 135 journal_logout(void)
 136 {
 137     journal_entry("logout %d", player->cnum);
 138 }
 139
 140 void
 141 journal_input(char *input)
 142 {
 143     journal_entry("input %s", input);
 144 }
 145
 146 void
 147 journal_update(int etu)
 148 {
 149     journal_entry("update %d", etu);
 150 }