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

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2018, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                Ken Stevens, Steve McClure, Markus Armbruster
   5  *
   6  *  Empire 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 3 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, see <http://www.gnu.org/licenses/>.
  18  *
  19  *  ---
  20  *
  21  *  See files README, COPYING and CREDITS in the root of the source
  22  *  tree for related information and legal notices.  It is expected
  23  *  that future projects/authors will amend these files as needed.
  24  *
  25  *  ---
  26  *
  27  *  journal.c: Log a journal of events to a file
  28  *
  29  *  Known contributors to this file:
  30  *     Markus Armbruster, 2004-2012
  31  *     Ron Koenderink, 2008
  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  *     prng NAME SEED
  44  *     login CNUM HOSTADDR USER
  45  *     logout CNUM
  46  *     command NAME
  47  *     input INPUT
  48  *     output THREAD ID OUTPUT
  49  *     update ETU
  50  */
  51
  52 #include <config.h>
  53
  54 #include <ctype.h>
  55 #include <errno.h>
  56 #include <stdarg.h>
  57 #include <stdio.h>
  58 #include <time.h>
  59 #include "misc.h"
  60 #include "empthread.h"
  61 #include "journal.h"
  62 #include "optlist.h"
  63 #include "player.h"
  64 #include "prototypes.h"
  65
  66 static char journal_fname[] = "journal.log";
  67 static FILE *journal;
  68
  69 static void journal_entry_start(char *fmt, ...)
  70     ATTRIBUTE((format (printf, 1, 2)));
  71 static void journal_entry(char *fmt, ...)
  72     ATTRIBUTE((format (printf, 1, 2)));
  73 static void journal_output_start(struct player *, int);
  74
  75 static FILE *
  76 journal_open(void)
  77 {
  78     return fopen(journal_fname, "a");
  79 }
  80
  81 static void
  82 journal_entry_vstart(char *fmt, va_list ap)
  83 {
  84     time_t now;
  85     empth_t *self;
  86
  87     if (!journal)
  88         return;
  89     time(&now);
  90     self = empth_self();
  91     fprintf(journal, "%.24s %10.10s ",
  92             ctime(&now), self ? empth_name(self) : "Main");
  93     vfprintf(journal, fmt, ap);
  94 }
  95
  96 static void
  97 journal_entry_start(char *fmt, ...)
  98 {
  99     va_list ap;
 100
 101     va_start(ap, fmt);
 102     journal_entry_vstart(fmt, ap);
 103     va_end(ap);
 104 }
 105
 106 static void
 107 journal_entry_write(char *s, size_t n)
 108 {
 109     char *p;
 110
 111     if (!journal)
 112         return;
 113     for (p = s; p < s + n; p++) {
 114         if (*p == '\\')
 115             fprintf(journal, "\\\\");
 116         else if (isprint(*(unsigned char *)p) || *p == '\t')
 117             putc(*p, journal);
 118         else
 119             fprintf(journal, "\\%03o", *p);
 120     }
 121 }
 122
 123 static void
 124 journal_entry_end(int newline, int flush)
 125 {
 126     if (!journal)
 127         return;
 128     if (!newline)
 129         fputc('\\', journal);
 130     fputc('\n', journal);
 131     fflush(journal);
 132     if (ferror(journal)) {
 133         logerror("Error writing journal (%s)", strerror(errno));
 134         clearerr(journal);
 135     }
 136 }
 137
 138 static void
 139 journal_entry(char *fmt, ...)
 140 {
 141     va_list ap;
 142
 143     va_start(ap, fmt);
 144     journal_entry_vstart(fmt, ap);
 145     va_end(ap);
 146     journal_entry_end(1, 1);
 147 }
 148
 149 int
 150 journal_startup(void)
 151 {
 152     if (!keep_journal)
 153         return 0;
 154     journal = journal_open();
 155     if (!journal) {
 156         logerror("Can't open %s (%s)", journal_fname, strerror(errno));
 157         return -1;
 158     }
 159     journal_entry("startup");
 160     return 0;
 161 }
 162
 163 void
 164 journal_shutdown(void)
 165 {
 166     journal_entry("shutdown");
 167     if (journal) {
 168         fclose(journal);
 169         journal = NULL;
 170     }
 171 }
 172
 173 int
 174 journal_reopen(void)
 175 {
 176     FILE *j;
 177
 178     if (!keep_journal)
 179         return 0;
 180     j = journal_open();
 181     if (!j) {
 182         logerror("Can't open %s (%s)", journal_fname, strerror(errno));
 183         return -1;
 184     }
 185     if (journal)
 186         fclose(journal);
 187     journal = j;
 188     return 0;
 189 }
 190
 191 void
 192 journal_prng(unsigned seed)
 193 {
 194     journal_entry("prng MT19937 %u", seed);
 195 }
 196
 197 void
 198 journal_login(void)
 199 {
 200     journal_entry("login %d %s %s",
 201                   player->cnum, player->hostaddr, player->userid);
 202 }
 203
 204 void
 205 journal_logout(void)
 206 {
 207     journal_entry("logout %d", player->cnum);
 208 }
 209
 210 void
 211 journal_output(struct player *pl, int id, char *output)
 212 {
 213     static char buf[1024];
 214     static char *bp = buf;
 215     static struct player *bpl;
 216     static int bid;
 217     char *s, *e;
 218
 219     if (keep_journal < 2)
 220         return;
 221
 222     if (bp != buf && (pl != bpl || id != bid)) {
 223         journal_output_start(bpl, bid);
 224         journal_entry_write(buf, bp - buf);
 225         journal_entry_end(0, 0);
 226         bp = buf;
 227     }
 228
 229     for (s = output; (e = strchr(s, '\n')); s = e + 1) {
 230         journal_output_start(pl, id);
 231         journal_entry_write(buf, bp - buf);
 232         journal_entry_write(s, e - s);
 233         journal_entry_end(1, 0);
 234         bp = buf;
 235     }
 236     e = strchr(s, 0);
 237     if (bp + (e - s) <= buf + sizeof(buf)) {
 238         memcpy(bp, s, e - s);
 239         bp += e - s;
 240         bpl = pl;
 241         bid = id;
 242     } else {
 243         journal_output_start(pl, id);
 244         journal_entry_write(buf, bp - buf);
 245         journal_entry_write(s, e - s);
 246         journal_entry_end(0, 0);
 247         bp = buf;
 248     }
 249 }
 250
 251 static void
 252 journal_output_start(struct player *pl, int id)
 253 {
 254     journal_entry_start("output %s %d ", empth_name(pl->proc), id);
 255 }
 256
 257 void
 258 journal_input(char *input)
 259 {
 260     journal_entry_start("input ");
 261     journal_entry_write(input, strlen(input));
 262     journal_entry_end(1, 1);
 263 }
 264
 265 void
 266 journal_command(char *cmd)
 267 {
 268     char *eptr = strchr(cmd, ' ');
 269     journal_entry("command %.*s", eptr ? (int)(eptr - cmd) : -1, cmd);
 270 }
 271
 272 void
 273 journal_update(int etu)
 274 {
 275     journal_entry("update %d", etu);
 276 }