NeoMutt  2020-09-25
Teaching an old dog new tricks
DOXYGEN
logging.c
Go to the documentation of this file.
1 
29 #include "config.h"
30 #include <errno.h>
31 #include <stdarg.h>
32 #include <stdbool.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <time.h>
36 #include <unistd.h>
37 #include "logging.h"
38 #include "date.h"
39 #include "file.h"
40 #include "memory.h"
41 #include "message.h"
42 #include "queue.h"
43 #include "string2.h"
44 
45 const char *LevelAbbr = "PEWM12345N";
46 
53 
54 FILE *LogFileFP = NULL;
55 char *LogFileName = NULL;
56 int LogFileLevel = 0;
57 char *LogFileVersion = NULL;
58 
62 static struct LogLineList LogQueue = STAILQ_HEAD_INITIALIZER(LogQueue);
63 
64 int LogQueueCount = 0;
65 int LogQueueMax = 0;
66 
77 static const char *timestamp(time_t stamp)
78 {
79  static char buf[23] = { 0 };
80  static time_t last = 0;
81 
82  if (stamp == 0)
83  stamp = mutt_date_epoch();
84 
85  if (stamp != last)
86  {
87  mutt_date_localtime_format(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S", stamp);
88  last = stamp;
89  }
90 
91  return buf;
92 }
93 
98 void log_file_close(bool verbose)
99 {
100  if (!LogFileFP)
101  return;
102 
103  fprintf(LogFileFP, "[%s] Closing log.\n", timestamp(0));
104  fprintf(LogFileFP, "# vim: syntax=neomuttlog\n");
106  if (verbose)
107  mutt_message(_("Closed log file: %s"), LogFileName);
108 }
109 
119 int log_file_open(bool verbose)
120 {
121  if (!LogFileName)
122  return -1;
123 
124  if (LogFileFP)
125  log_file_close(false);
126 
127  if (LogFileLevel < LL_DEBUG1)
128  return -1;
129 
131  if (!LogFileFP)
132  return -1;
133  setvbuf(LogFileFP, NULL, _IOLBF, 0);
134 
135  fprintf(LogFileFP, "[%s] NeoMutt%s debugging at level %d\n", timestamp(0),
137  if (verbose)
138  mutt_message(_("Debugging at level %d to file '%s'"), LogFileLevel, LogFileName);
139  return 0;
140 }
141 
149 int log_file_set_filename(const char *file, bool verbose)
150 {
151  if (!file)
152  return -1;
153 
154  /* also handles both being NULL */
155  if (mutt_str_equal(LogFileName, file))
156  return 0;
157 
159 
160  if (!LogFileName)
161  log_file_close(verbose);
162 
163  return log_file_open(verbose);
164 }
165 
175 int log_file_set_level(enum LogLevel level, bool verbose)
176 {
177  if ((level < LL_MESSAGE) || (level >= LL_MAX))
178  return -1;
179 
180  if (level == LogFileLevel)
181  return 0;
182 
183  LogFileLevel = level;
184 
185  if (level == LL_MESSAGE)
186  {
187  log_file_close(verbose);
188  }
189  else if (LogFileFP)
190  {
191  if (verbose)
192  mutt_message(_("Logging at level %d to file '%s'"), LogFileLevel, LogFileName);
193  fprintf(LogFileFP, "[%s] NeoMutt%s debugging at level %d\n", timestamp(0),
195  }
196  else
197  {
198  log_file_open(verbose);
199  }
200 
201  if (LogFileLevel >= LL_DEBUG5)
202  {
203  fprintf(LogFileFP,
204  "\n"
205  "WARNING:\n"
206  " Logging at this level can reveal personal information.\n"
207  " Review the log carefully before posting in bug reports.\n"
208  "\n");
209  }
210 
211  return 0;
212 }
213 
221 void log_file_set_version(const char *version)
222 {
223  mutt_str_replace(&LogFileVersion, version);
224 }
225 
231 {
232  return LogFileFP;
233 }
234 
246 int log_disp_file(time_t stamp, const char *file, int line,
247  const char *function, enum LogLevel level, ...)
248 {
249  if (!LogFileFP || (level < LL_PERROR) || (level > LogFileLevel))
250  return 0;
251 
252  int ret = 0;
253  int err = errno;
254 
255  if (!function)
256  function = "UNKNOWN";
257 
258  ret += fprintf(LogFileFP, "[%s]<%c> %s() ", timestamp(stamp),
259  LevelAbbr[level + 3], function);
260 
261  va_list ap;
262  va_start(ap, level);
263  const char *fmt = va_arg(ap, const char *);
264  ret += vfprintf(LogFileFP, fmt, ap);
265  va_end(ap);
266 
267  if (level == LL_PERROR)
268  {
269  fprintf(LogFileFP, ": %s\n", strerror(err));
270  }
271  else if (level <= LL_MESSAGE)
272  {
273  fputs("\n", LogFileFP);
274  ret++;
275  }
276 
277  return ret;
278 }
279 
287 int log_queue_add(struct LogLine *ll)
288 {
289  if (!ll)
290  return -1;
291 
292  STAILQ_INSERT_TAIL(&LogQueue, ll, entries);
293 
294  if ((LogQueueMax > 0) && (LogQueueCount >= LogQueueMax))
295  {
296  ll = STAILQ_FIRST(&LogQueue);
297  STAILQ_REMOVE_HEAD(&LogQueue, entries);
298  FREE(&ll->message);
299  FREE(&ll);
300  }
301  else
302  {
303  LogQueueCount++;
304  }
305  return LogQueueCount;
306 }
307 
315 {
316  if (size < 0)
317  size = 0;
318  LogQueueMax = size;
319 }
320 
326 void log_queue_empty(void)
327 {
328  struct LogLine *ll = NULL;
329  struct LogLine *tmp = NULL;
330 
331  STAILQ_FOREACH_SAFE(ll, &LogQueue, entries, tmp)
332  {
333  STAILQ_REMOVE(&LogQueue, ll, LogLine, entries);
334  FREE(&ll->message);
335  FREE(&ll);
336  }
337 
338  LogQueueCount = 0;
339 }
340 
349 {
350  struct LogLine *ll = NULL;
351  STAILQ_FOREACH(ll, &LogQueue, entries)
352  {
353  disp(ll->time, ll->file, ll->line, ll->function, ll->level, "%s", ll->message);
354  }
355 
356  log_queue_empty();
357 }
358 
369 int log_queue_save(FILE *fp)
370 {
371  if (!fp)
372  return 0;
373 
374  char buf[32];
375  int count = 0;
376  struct LogLine *ll = NULL;
377  STAILQ_FOREACH(ll, &LogQueue, entries)
378  {
379  mutt_date_localtime_format(buf, sizeof(buf), "%H:%M:%S", ll->time);
380  fprintf(fp, "[%s]<%c> %s", buf, LevelAbbr[ll->level + 3], ll->message);
381  if (ll->level <= LL_MESSAGE)
382  fputs("\n", fp);
383  count++;
384  }
385 
386  return count;
387 }
388 
400 int log_disp_queue(time_t stamp, const char *file, int line,
401  const char *function, enum LogLevel level, ...)
402 {
403  char buf[1024] = { 0 };
404  int err = errno;
405 
406  va_list ap;
407  va_start(ap, level);
408  const char *fmt = va_arg(ap, const char *);
409  int ret = vsnprintf(buf, sizeof(buf), fmt, ap);
410  va_end(ap);
411 
412  if (level == LL_PERROR)
413  {
414  ret += snprintf(buf + ret, sizeof(buf) - ret, ": %s", strerror(err));
415  level = LL_ERROR;
416  }
417 
418  struct LogLine *ll = mutt_mem_calloc(1, sizeof(*ll));
419  ll->time = (stamp != 0) ? stamp : mutt_date_epoch();
420  ll->file = file;
421  ll->line = line;
422  ll->function = function;
423  ll->level = level;
424  ll->message = mutt_str_dup(buf);
425 
426  log_queue_add(ll);
427 
428  return ret;
429 }
430 
441 int log_disp_terminal(time_t stamp, const char *file, int line,
442  const char *function, enum LogLevel level, ...)
443 {
444  if ((level < LL_PERROR) || (level > LL_MESSAGE))
445  return 0;
446 
447  char buf[1024];
448 
449  va_list ap;
450  va_start(ap, level);
451  const char *fmt = va_arg(ap, const char *);
452  int ret = vsnprintf(buf, sizeof(buf), fmt, ap);
453  va_end(ap);
454 
455  log_disp_file(stamp, file, line, function, level, "%s", buf);
456 
457  FILE *fp = (level < LL_MESSAGE) ? stderr : stdout;
458  int err = errno;
459  int colour = 0;
460  bool tty = (isatty(fileno(fp)) == 1);
461 
462  if (tty)
463  {
464  switch (level)
465  {
466  case LL_PERROR:
467  case LL_ERROR:
468  colour = 31;
469  break;
470  case LL_WARNING:
471  colour = 33;
472  break;
473  case LL_MESSAGE:
474  // colour = 36;
475  break;
476  case LL_DEBUG1:
477  case LL_DEBUG2:
478  case LL_DEBUG3:
479  case LL_DEBUG4:
480  case LL_DEBUG5:
481  case LL_NOTIFY:
482  default:
483  break;
484  }
485  }
486 
487  if (colour > 0)
488  ret += fprintf(fp, "\033[1;%dm", colour); // Escape
489 
490  fputs(buf, fp);
491 
492  if (level == LL_PERROR)
493  ret += fprintf(fp, ": %s", strerror(err));
494 
495  if (colour > 0)
496  ret += fprintf(fp, "\033[0m"); // Escape
497 
498  ret += fprintf(fp, "\n");
499 
500  return ret;
501 }
502 
506 int log_disp_null(time_t stamp, const char *file, int line,
507  const char *function, enum LogLevel level, ...)
508 {
509  return 0;
510 }
int log_disp_null(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Discard log lines - Implements log_dispatcher_t.
Definition: logging.c:506
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:871
time_t mutt_date_epoch(void)
Return the number of seconds since the Unix epoch.
Definition: date.c:416
Log at debug level 4.
Definition: logging.h:43
Log error.
Definition: logging.h:37
void log_file_close(bool verbose)
Close the log file.
Definition: logging.c:98
#define NONULL(x)
Definition: string2.h:37
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:399
size_t mutt_date_localtime_format(char *buf, size_t buflen, const char *format, time_t t)
Format localtime.
Definition: date.c:680
enum LogLevel level
Log level, e.g. LL_DEBUG1.
Definition: logging.h:75
Memory management wrappers.
Log of notifications.
Definition: logging.h:45
const char * LevelAbbr
Abbreviations of logging level names.
Definition: logging.c:45
#define mutt_message(...)
Definition: logging.h:83
char * message
Message to be logged.
Definition: logging.h:76
FILE * LogFileFP
Log file handle.
Definition: logging.c:54
static struct LogLineList LogQueue
In-memory list of log lines.
Definition: logging.c:62
int log_disp_terminal(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Save a log line to the terminal - Implements log_dispatcher_t.
Definition: logging.c:441
Log perror (using errno)
Definition: logging.h:36
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:370
#define _(a)
Definition: message.h:28
static const char * timestamp(time_t stamp)
Create a YYYY-MM-DD HH:MM:SS timestamp.
Definition: logging.c:77
Definition: logging.h:47
#define STAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:386
Log informational message.
Definition: logging.h:39
#define STAILQ_REMOVE_HEAD(head, field)
Definition: queue.h:419
int LogQueueMax
Maximum number of entries in the log queue.
Definition: logging.c:65
void log_queue_flush(log_dispatcher_t disp)
Replay the log queue.
Definition: logging.c:348
log_dispatcher_t MuttLogger
The log dispatcher.
Definition: logging.c:52
void log_file_set_version(const char *version)
Set the program&#39;s version number.
Definition: logging.c:221
File management functions.
int log_file_set_filename(const char *file, bool verbose)
Set the filename for the log.
Definition: logging.c:149
Logging Dispatcher.
String manipulation functions.
int line
Line number in source file.
Definition: logging.h:73
LogLevel
Names for the Logging Levels.
Definition: logging.h:34
Log at debug level 2.
Definition: logging.h:41
A Log line.
Definition: logging.h:69
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:153
int log_disp_file(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Save a log line to a file - Implements log_dispatcher_t.
Definition: logging.c:246
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:359
int log_file_set_level(enum LogLevel level, bool verbose)
Set the logging level.
Definition: logging.c:175
Message logging.
void log_queue_set_max_size(int size)
Set a upper limit for the queue length.
Definition: logging.c:314
bool log_file_running(void)
Is the log file running?
Definition: logging.c:230
int log_file_open(bool verbose)
Start logging to a file.
Definition: logging.c:119
int log_queue_save(FILE *fp)
Save the contents of the queue to a temporary file.
Definition: logging.c:369
void log_queue_empty(void)
Free the contents of the queue.
Definition: logging.c:326
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:349
Log at debug level 1.
Definition: logging.h:40
int(* log_dispatcher_t)(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Prototype for a logging function.
Definition: logging.h:62
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:446
#define FREE(x)
Definition: memory.h:40
#define STAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:321
time_t time
Timestamp of the message.
Definition: logging.h:71
int LogFileLevel
Log file level.
Definition: logging.c:56
char * LogFileVersion
Program version.
Definition: logging.c:57
Log at debug level 5.
Definition: logging.h:44
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:588
int LogQueueCount
Number of entries currently in the log queue.
Definition: logging.c:64
int log_disp_queue(time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
Save a log line to an internal queue - Implements log_dispatcher_t.
Definition: logging.c:400
Time and date handling routines.
const char * file
Source file.
Definition: logging.h:72
int log_queue_add(struct LogLine *ll)
Add a LogLine to the queue.
Definition: logging.c:287
#define STAILQ_FIRST(head)
Definition: queue.h:347
Log at debug level 3.
Definition: logging.h:42
Log warning.
Definition: logging.h:38
const char * function
C function.
Definition: logging.h:74
char * LogFileName
Log file name.
Definition: logging.c:55