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-2008, 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-2007
  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 static FILE *
  67 journal_open(void)
  68 {
  69     return fopen(journal_fname, "a+");
  70 }
  71
  72 static void
  73 journal_entry(char *fmt, ...)
  74 {
  75     static char buf[1024];
  76     va_list ap;
  77     time_t now;
  78     unsigned char *p;
  79
  80     if (journal) {
  81         time(&now);
  82         fprintf(journal, "%.24s %p ", ctime(&now), empth_self());
  83
  84         va_start(ap, fmt);
  85         vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
  86         va_end(ap);
  87
  88         for (p = (unsigned char *)buf; *p; p++) {
  89             if (isprint(*p))
  90                 putc(*p, journal);
  91             else
  92                 fprintf(journal, "\\%03o", *p);
  93         }
  94         fputs("\n", journal);
  95         if (debug)
  96             fflush(journal);
  97         if (ferror(journal)) {
  98             logerror("Error writing journal (%s)", strerror(errno));
  99             clearerr(journal);
 100         }
 101     }
 102 }
 103
 104 int
 105 journal_startup(void)
 106 {
 107     if (!keep_journal)
 108         return 0;
 109     journal = journal_open();
 110     if (!journal) {
 111         logerror("Can't open %s (%s)", journal_fname, strerror(errno));
 112         return -1;
 113     }
 114     journal_entry("startup");
 115     return 0;
 116 }
 117
 118 void
 119 journal_shutdown(void)
 120 {
 121     journal_entry("shutdown");
 122     if (journal) {
 123         fclose(journal);
 124         journal = NULL;
 125     }
 126 }
 127
 128 int
 129 journal_reopen(void)
 130 {
 131     FILE *j;
 132
 133     if (!keep_journal)
 134         return 0;
 135     j = journal_open();
 136     if (!j) {
 137         logerror("Can't open %s (%s)", journal_fname, strerror(errno));
 138         return -1;
 139     }
 140     if (journal)
 141         fclose(journal);
 142     journal = j;
 143     return 0;
 144 }
 145
 146 void
 147 journal_login(void)
 148 {
 149     journal_entry("login %d %s %s",
 150                   player->cnum, player->hostaddr, player->userid);
 151 }
 152
 153 void
 154 journal_logout(void)
 155 {
 156     journal_entry("logout %d", player->cnum);
 157 }
 158
 159 void
 160 journal_input(char *input)
 161 {
 162     journal_entry("input %s", input);
 163 }
 164
 165 void
 166 journal_update(int etu)
 167 {
 168     journal_entry("update %d", etu);
 169 }