Logging tweaks

Add some function-like macros for log/warn/both

WARN_AND_LOG() is like fprintf_color() then log_event(), with same message.

WARN_ONCE() is like fprintf_color() but only once per session.
LOG_ONCE() is like log_event() but only once per session.
WARN_AND_LOG_ONCE() does both, with same message.

Also add error color to error(), pexit() and similar stuff in misc.c

Author: magnumripper

src/color.c

@@ -9,7 +9,7 @@
 #include "config.h"
 #include "options.h"
 
-char *color_error, *color_notice, *color_warning, *color_end;
+char *color_none, *color_error, *color_notice, *color_warning, *color_end;
 
 /*
  * Translate ^ to Esc, in place.
@@ -34,11 +34,13 @@ char *parse_esc(const char *string)
 
 void color_init()
 {
+	color_none = "";
+
 	if (cfg_get_bool(SECTION_OPTIONS, NULL, "UseColors", 0)) {
 		color_error = parse_esc(cfg_get_param(SECTION_OPTIONS, NULL, "ColorError"));
 		color_notice = parse_esc(cfg_get_param(SECTION_OPTIONS, NULL, "ColorNotice"));
 		color_warning = parse_esc(cfg_get_param(SECTION_OPTIONS, NULL, "ColorWarning"));
 		color_end = parse_esc(cfg_get_param(SECTION_OPTIONS, NULL, "ColorEnd"));
 	} else
-		color_error = color_notice = color_warning = color_end = "";
+		color_error = color_notice = color_warning = color_end = color_none;
 }

src/color.h

@@ -8,11 +8,14 @@
 #ifndef _JOHN_COLOR_H
 #define _JOHN_COLOR_H
 
+#include <stdio.h>
+#include <unistd.h> /* isatty */
+
 extern char *parse_esc(const char *string);
 extern void color_init();
 
 /* Color escape sequences as strings */
-extern char *color_error, *color_notice, *color_warning, *color_end;
+extern char *color_none, *color_error, *color_notice, *color_warning, *color_end;
 
 #define printf_color(color, ...)	fprintf_color(color, stdout, __VA_ARGS__);
 

src/logger.h

@@ -50,6 +50,41 @@ extern int log_lock(int fd, int cmd, int type, const char *name,
 #endif /* #if defined(F_SETLK) && defined(F_SETLKW) && defined(F_UNLCK)
 		&& defined(F_RDLCK) && defined(F_WRLCK) */
 
+/*
+ * Macro for warning/notice AND logging.  Arguments are like to fprintf_color
+ * but with no ending NL.
+ */
+#define WARN_AND_LOG(color, stream, ...)	  \
+	do { \
+		fprintf_color(color, stream, __VA_ARGS__); \
+		fputc('\n', stream); \
+		log_event(__VA_ARGS__); \
+	} while (0)
+
+/*
+ * Macro to only log something once per session.
+ */
+#define LOG_ONCE(...)	  \
+	do { \
+		static int warned; \
+		if (!warned) { \
+			log_event(__VA_ARGS__); \
+			warned = 1; \
+		} \
+	} while (0)
+
+/*
+ * Like WARN_AND_LOG,  but once per session.
+ */
+#define WARN_AND_LOG_ONCE(color, stream, ...)	  \
+	do { \
+		static int warned; \
+		if (!warned) { \
+			WARN_AND_LOG(color, stream, __VA_ARGS__); \
+			warned = 1; \
+		} \
+	} while (0)
+
 /*
  * Initializes the logger (opens john.pot and a log file).
  */

src/misc.c

@@ -32,6 +32,7 @@
 #include "logger.h"
 #include "params.h"
 #include "misc.h"
+#include "color.h"
 #include "options.h"
 
 #include "john_mpi.h"
@@ -49,17 +50,20 @@ void real_error(const char *file, int line)
 	exit(1);
 }
 
-void real_error_msg(const char *file, int line,  const char *format, ...)
+void real_error_msg(const char *file, int line, const char *format, ...)
 {
 	va_list args;
 
-#if defined(HAVE_MPI) && !defined(_JOHN_MISC_NO_LOG)
+#if !defined(_JOHN_MISC_NO_LOG)
+	fputs(color_error, stderr);
+#ifdef HAVE_MPI
 	if (mpi_p > 1)
 		fprintf(stderr, "%u@%s: ", mpi_id + 1, mpi_name);
 	else
-#elif OS_FORK && !defined(_JOHN_MISC_NO_LOG)
+#elif OS_FORK
 	if (options.fork)
 		fprintf(stderr, "%u: ", options.node_min);
+#endif
 #endif
 	va_start(args, format);
 	vfprintf(stderr, format, args);
@@ -73,6 +77,7 @@ void real_pexit(const char *file, int line, const char *format, ...)
 	va_list args;
 
 #if !defined(_JOHN_MISC_NO_LOG)
+	fputs(color_error, stderr);
 #if HAVE_MPI
 	if (mpi_p > 1)
 		fprintf(stderr, "%u@%s: ", mpi_id + 1, mpi_name);

src/misc.h

@@ -18,7 +18,9 @@
 #define _JOHN_MISC_H
 
 #include <stdio.h>
+
 #include "jumbo.h"
+#include "color.h"
 
 #if !AC_BUILT
  #include <string.h>
@@ -37,6 +39,18 @@
  #endif
 #endif
 
+/*
+ * Like fprintf_color but only once per session.
+ */
+#define WARN_ONCE(...)	  \
+	do { \
+		static int warned; \
+		if (!warned) { \
+			fprintf_color(__VA_ARGS__); \
+			warned = 1; \
+		} \
+	} while (0)
+
 /*
  * Exit on error. Logs the event, closes john.pot and the log file, and
  * terminates the process with non-zero exit status.