Post-release destabilisation! Completely remove the struct type
[u/mdw/putty] / logging.c
index 1a98213..b2401c3 100644 (file)
--- a/logging.c
+++ b/logging.c
@@ -18,7 +18,8 @@ struct LogContext {
     bufchain queue;
     Filename currlogfilename;
     void *frontend;
-    Config cfg;
+    Conf *conf;
+    int logtype;                      /* cached out of conf */
 };
 
 static void xlatlognam(Filename *d, Filename s, char *hostname, struct tm *tm);
@@ -43,7 +44,13 @@ static void logwrite(struct LogContext *ctx, void *data, int len)
        bufchain_add(&ctx->queue, data, len);
     } else if (ctx->state == L_OPEN) {
        assert(ctx->lgfp);
-       fwrite(data, 1, len, ctx->lgfp);
+       if (fwrite(data, 1, len, ctx->lgfp) < (size_t)len) {
+           logfclose(ctx);
+           ctx->state = L_ERROR;
+           /* Log state is L_ERROR so this won't cause a loop */
+           logevent(ctx->frontend,
+                    "Disabled writing session log due to error while writing");
+       }
     }                                 /* else L_ERROR, so ignore the write */
 }
 
@@ -69,7 +76,7 @@ static void logprintf(struct LogContext *ctx, const char *fmt, ...)
  */
 void logflush(void *handle) {
     struct LogContext *ctx = (struct LogContext *)handle;
-    if (ctx->cfg.logtype > 0)
+    if (ctx->logtype > 0)
        if (ctx->state == L_OPEN)
            fflush(ctx->lgfp);
 }
@@ -85,7 +92,7 @@ static void logfopen_callback(void *handle, int mode)
        ctx->state = L_ERROR;          /* disable logging */
     } else {
        fmode = (mode == 1 ? "ab" : "wb");
-       ctx->lgfp = f_open(ctx->currlogfilename, fmode);
+       ctx->lgfp = f_open(ctx->currlogfilename, fmode, FALSE);
        if (ctx->lgfp)
            ctx->state = L_OPEN;
        else
@@ -101,12 +108,13 @@ static void logfopen_callback(void *handle, int mode)
     }
 
     event = dupprintf("%s session log (%s mode) to file: %s",
-                     (mode == 0 ? "Disabled writing" :
-                       mode == 1 ? "Appending" : "Writing new"),
-                     (ctx->cfg.logtype == LGTYP_ASCII ? "ASCII" :
-                      ctx->cfg.logtype == LGTYP_DEBUG ? "raw" :
-                      ctx->cfg.logtype == LGTYP_PACKETS ? "SSH packets" :
-                      ctx->cfg.logtype == LGTYP_SSHRAW ? "SSH raw data" :
+                     ctx->state == L_ERROR ?
+                     (mode == 0 ? "Disabled writing" : "Error writing") :
+                     (mode == 1 ? "Appending" : "Writing new"),
+                     (ctx->logtype == LGTYP_ASCII ? "ASCII" :
+                      ctx->logtype == LGTYP_DEBUG ? "raw" :
+                      ctx->logtype == LGTYP_PACKETS ? "SSH packets" :
+                      ctx->logtype == LGTYP_SSHRAW ? "SSH raw data" :
                       "unknown"),
                      filename_to_str(&ctx->currlogfilename));
     logevent(ctx->frontend, event);
@@ -141,19 +149,22 @@ void logfopen(void *handle)
     if (ctx->state != L_CLOSED)
        return;
 
-    if (!ctx->cfg.logtype)
+    if (!ctx->logtype)
        return;
 
     tm = ltime();
 
     /* substitute special codes in file name */
-    xlatlognam(&ctx->currlogfilename, ctx->cfg.logfilename,ctx->cfg.host, &tm);
+    xlatlognam(&ctx->currlogfilename,
+              *conf_get_filename(ctx->conf, CONF_logfilename),
+              conf_get_str(ctx->conf, CONF_host), &tm);
 
-    ctx->lgfp = f_open(ctx->currlogfilename, "r");  /* file already present? */
+    ctx->lgfp = f_open(ctx->currlogfilename, "r", FALSE);  /* file already present? */
     if (ctx->lgfp) {
+       int logxfovr = conf_get_int(ctx->conf, CONF_logxfovr);
        fclose(ctx->lgfp);
-       if (ctx->cfg.logxfovr != LGXF_ASK) {
-           mode = ((ctx->cfg.logxfovr == LGXF_OVR) ? 2 : 1);
+       if (logxfovr != LGXF_ASK) {
+           mode = ((logxfovr == LGXF_OVR) ? 2 : 1);
        } else
            mode = askappend(ctx->frontend, ctx->currlogfilename,
                             logfopen_callback, ctx);
@@ -182,8 +193,8 @@ void logfclose(void *handle)
 void logtraffic(void *handle, unsigned char c, int logmode)
 {
     struct LogContext *ctx = (struct LogContext *)handle;
-    if (ctx->cfg.logtype > 0) {
-       if (ctx->cfg.logtype == logmode)
+    if (ctx->logtype > 0) {
+       if (ctx->logtype == logmode)
            logwrite(ctx, &c, 1);
     }
 }
@@ -204,8 +215,11 @@ void log_eventlog(void *handle, const char *event)
        fprintf(stderr, "%s\n", event);
        fflush(stderr);
     }
-    if (ctx->cfg.logtype != LGTYP_PACKETS &&
-       ctx->cfg.logtype != LGTYP_SSHRAW)
+    /* If we don't have a context yet (eg winnet.c init) then skip entirely */
+    if (!ctx)
+       return;
+    if (ctx->logtype != LGTYP_PACKETS &&
+       ctx->logtype != LGTYP_SSHRAW)
        return;
     logprintf(ctx, "Event Log: %s\r\n", event);
     logflush(ctx);
@@ -217,26 +231,34 @@ void log_eventlog(void *handle, const char *event)
  * Set of blanking areas must be in increasing order.
  */
 void log_packet(void *handle, int direction, int type,
-               char *texttype, void *data, int len,
-               int n_blanks, const struct logblank_t *blanks)
+               char *texttype, const void *data, int len,
+               int n_blanks, const struct logblank_t *blanks,
+               const unsigned long *seq)
 {
     struct LogContext *ctx = (struct LogContext *)handle;
     char dumpdata[80], smalldata[5];
     int p = 0, b = 0, omitted = 0;
     int output_pos = 0; /* NZ if pending output in dumpdata */
 
-    if (!(ctx->cfg.logtype == LGTYP_SSHRAW ||
-          (ctx->cfg.logtype == LGTYP_PACKETS && texttype)))
+    if (!(ctx->logtype == LGTYP_SSHRAW ||
+          (ctx->logtype == LGTYP_PACKETS && texttype)))
        return;
 
     /* Packet header. */
-    if (texttype)
-        logprintf(ctx, "%s packet type %d / 0x%02x (%s)\r\n",
-                  direction == PKT_INCOMING ? "Incoming" : "Outgoing",
-                  type, type, texttype);
-    else
+    if (texttype) {
+       if (seq) {
+           logprintf(ctx, "%s packet #0x%lx, type %d / 0x%02x (%s)\r\n",
+                     direction == PKT_INCOMING ? "Incoming" : "Outgoing",
+                     *seq, type, type, texttype);
+       } else {
+           logprintf(ctx, "%s packet type %d / 0x%02x (%s)\r\n",
+                     direction == PKT_INCOMING ? "Incoming" : "Outgoing",
+                     type, type, texttype);
+       }
+    } else {
         logprintf(ctx, "%s raw data\r\n",
                   direction == PKT_INCOMING ? "Incoming" : "Outgoing");
+    }
 
     /*
      * Output a hex/ASCII dump of the packet body, blanking/omitting
@@ -308,13 +330,14 @@ void log_packet(void *handle, int direction, int type,
     logflush(ctx);
 }
 
-void *log_init(void *frontend, Config *cfg)
+void *log_init(void *frontend, Conf *conf)
 {
     struct LogContext *ctx = snew(struct LogContext);
     ctx->lgfp = NULL;
     ctx->state = L_CLOSED;
     ctx->frontend = frontend;
-    ctx->cfg = *cfg;                  /* STRUCTURE COPY */
+    ctx->conf = conf_copy(conf);
+    ctx->logtype = conf_get_int(ctx->conf, CONF_logtype);
     bufchain_init(&ctx->queue);
     return ctx;
 }
@@ -328,13 +351,15 @@ void log_free(void *handle)
     sfree(ctx);
 }
 
-void log_reconfig(void *handle, Config *cfg)
+void log_reconfig(void *handle, Conf *conf)
 {
     struct LogContext *ctx = (struct LogContext *)handle;
     int reset_logging;
 
-    if (!filename_equal(ctx->cfg.logfilename, cfg->logfilename) ||
-       ctx->cfg.logtype != cfg->logtype)
+    if (!filename_equal(*conf_get_filename(ctx->conf, CONF_logfilename),
+                       *conf_get_filename(conf, CONF_logfilename)) ||
+       conf_get_int(ctx->conf, CONF_logtype) !=
+       conf_get_int(conf, CONF_logtype))
        reset_logging = TRUE;
     else
        reset_logging = FALSE;
@@ -342,7 +367,10 @@ void log_reconfig(void *handle, Config *cfg)
     if (reset_logging)
        logfclose(ctx);
 
-    ctx->cfg = *cfg;                  /* STRUCTURE COPY */
+    conf_free(ctx->conf);
+    ctx->conf = conf_copy(conf);
+
+    ctx->logtype = conf_get_int(ctx->conf, CONF_logtype);
 
     if (reset_logging)
        logfopen(ctx);
@@ -352,7 +380,7 @@ void log_reconfig(void *handle, Config *cfg)
  * translate format codes into time/date strings
  * and insert them into log file name
  *
- * "&Y":YYYY   "&m":MM   "&d":DD   "&T":hhmm   "&h":<hostname>   "&&":&
+ * "&Y":YYYY   "&m":MM   "&d":DD   "&T":hhmmss   "&h":<hostname>   "&&":&
  */
 static void xlatlognam(Filename *dest, Filename src,
                       char *hostname, struct tm *tm) {
@@ -373,7 +401,7 @@ static void xlatlognam(Filename *dest, Filename src,
            char c;
            s++;
            size = 0;
-           if (*s) switch (c = *s++, tolower(c)) {
+           if (*s) switch (c = *s++, tolower((unsigned char)c)) {
              case 'y':
                size = strftime(buf, sizeof(buf), "%Y", tm);
                break;