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

run/john.conf

@@ -113,7 +113,7 @@ TerminalReset = ^[0m
 # which define red for errors, green for notices and yellow for warnings).
 # Note that you don't strictly need to use ANSI sequences - other things are
 # fine too.
-# Set this to N or comment it out to disable all color stuff.
+# Set this to N to disable all color stuff.
 UseColors = Y
 ColorError = ^[0;31m
 ColorNotice = ^[0;32m

src/color.c

@@ -9,6 +9,7 @@
 #include "config.h"
 #include "options.h"
 
+const char* const color_none = "";
 char *color_error, *color_notice, *color_warning, *color_end;
 
 /*
@@ -34,11 +35,11 @@ char *parse_esc(const char *string)
 
 void color_init()
 {
-	if (cfg_get_bool(SECTION_OPTIONS, NULL, "UseColors", 0)) {
+	if (cfg_get_bool(SECTION_OPTIONS, NULL, "UseColors", 1)) {
 		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 = (char*)color_none;
 }

src/color.h

@@ -8,11 +8,8 @@
 #ifndef _JOHN_COLOR_H
 #define _JOHN_COLOR_H
 
-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;
+#include <stdio.h>
+#include <unistd.h> /* isatty */
 
 #define printf_color(color, ...)	fprintf_color(color, stdout, __VA_ARGS__);
 
@@ -40,4 +37,11 @@ extern char *color_error, *color_notice, *color_warning, *color_end;
 			fputs(color_end, handle); \
 	} while (0)
 
+extern char *parse_esc(const char *string);
+extern void color_init();
+
+/* Color escape sequences as strings */
+extern const char* const color_none;
+extern char *color_error, *color_notice, *color_warning, *color_end;
+
 #endif	/* _JOHN_COLOR_H */

src/john.c

@@ -2093,6 +2093,12 @@ int main(int argc, char **argv)
 		return base64conv(argc, argv);
 	}
 
+	/*
+	 * For having these as empty strings in case a color warning/error is
+	 * printed before we init colors.
+	 */
+	color_error = color_notice = color_warning = color_end = (char*)color_none;
+
 #if !(CPU_FALLBACK || OMP_FALLBACK || defined(CPU_FALLBACK_BINARY) || defined(OMP_FALLBACK_BINARY))
 	path_init(argv);
 #endif

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"
@@ -42,24 +43,28 @@ void real_error(const char *file, int line)
 #ifndef _JOHN_MISC_NO_LOG
 	log_event("Terminating on error, %s:%d", file, line);
 	log_done();
+	fputs(color_end, stderr);
 #else
 	fprintf(stderr, "Terminating on error, %s:%d\n", file, line);
 #endif
 
 	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 +78,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.
@@ -62,7 +76,7 @@ extern void real_error_msg(const char *file, int line, const char *format, ...)
 	;
 #endif
 
-#define error_msg(...) real_error_msg(__FILE__, __LINE__,  __VA_ARGS__)
+#define error_msg(...) real_error_msg(__FILE__, __LINE__, __VA_ARGS__)
 
 /*
  * Similar to perror(), but supports formatted output, and calls error().