NeoMutt  2021-10-22-8-g9cb437
Teaching an old dog new tricks
DOXYGEN
logging.h File Reference

Logging Dispatcher. More...

#include <stdbool.h>
#include <stdio.h>
#include <time.h>
#include "queue.h"
+ Include dependency graph for logging.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  LogLine
 A Log line. More...
 

Macros

#define mutt_debug(LEVEL, ...)   MuttLogger(0, __FILE__, __LINE__, __func__, LEVEL, __VA_ARGS__)
 
#define mutt_warning(...)   MuttLogger(0, __FILE__, __LINE__, __func__, LL_WARNING, __VA_ARGS__)
 
#define mutt_message(...)   MuttLogger(0, __FILE__, __LINE__, __func__, LL_MESSAGE, __VA_ARGS__)
 
#define mutt_error(...)   MuttLogger(0, __FILE__, __LINE__, __func__, LL_ERROR, __VA_ARGS__)
 
#define mutt_perror(...)   MuttLogger(0, __FILE__, __LINE__, __func__, LL_PERROR, __VA_ARGS__)
 

Typedefs

typedef int(* log_dispatcher_t) (time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
 

Enumerations

enum  LogLevel {
  LL_PERROR = -3 , LL_ERROR = -2 , LL_WARNING = -1 , LL_MESSAGE = 0 ,
  LL_DEBUG1 = 1 , LL_DEBUG2 = 2 , LL_DEBUG3 = 3 , LL_DEBUG4 = 4 ,
  LL_DEBUG5 = 5 , LL_NOTIFY = 6 , LL_MAX
}
 Names for the Logging Levels. More...
 

Functions

 STAILQ_HEAD (LogLineList, LogLine)
 
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 -. More...
 
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 -. More...
 
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 -. More...
 
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 -. More...
 
int log_queue_add (struct LogLine *ll)
 Add a LogLine to the queue. More...
 
void log_queue_empty (void)
 Free the contents of the queue. More...
 
void log_queue_flush (log_dispatcher_t disp)
 Replay the log queue. More...
 
int log_queue_save (FILE *fp)
 Save the contents of the queue to a temporary file. More...
 
void log_queue_set_max_size (int size)
 Set a upper limit for the queue length. More...
 
void log_file_close (bool verbose)
 Close the log file. More...
 
int log_file_open (bool verbose)
 Start logging to a file. More...
 
bool log_file_running (void)
 Is the log file running? More...
 
int log_file_set_filename (const char *file, bool verbose)
 Set the filename for the log. More...
 
int log_file_set_level (enum LogLevel level, bool verbose)
 Set the logging level. More...
 
void log_file_set_version (const char *version)
 Set the program's version number. More...
 

Variables

log_dispatcher_t MuttLogger
 The log dispatcher -. More...
 

Detailed Description

Logging Dispatcher.

Authors
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file logging.h.

Typedef Documentation

◆ log_dispatcher_t

typedef int(* log_dispatcher_t) (time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)

Definition at line 65 of file logging.h.

Enumeration Type Documentation

◆ LogLevel

enum LogLevel

Names for the Logging Levels.

Enumerator
LL_PERROR 

Log perror (using errno)

LL_ERROR 

Log error.

LL_WARNING 

Log warning.

LL_MESSAGE 

Log informational message.

LL_DEBUG1 

Log at debug level 1.

LL_DEBUG2 

Log at debug level 2.

LL_DEBUG3 

Log at debug level 3.

LL_DEBUG4 

Log at debug level 4.

LL_DEBUG5 

Log at debug level 5.

LL_NOTIFY 

Log of notifications.

LL_MAX 

Definition at line 34 of file logging.h.

35 {
36  LL_PERROR = -3,
37  LL_ERROR = -2,
38  LL_WARNING = -1,
39  LL_MESSAGE = 0,
40  LL_DEBUG1 = 1,
41  LL_DEBUG2 = 2,
42  LL_DEBUG3 = 3,
43  LL_DEBUG4 = 4,
44  LL_DEBUG5 = 5,
45  LL_NOTIFY = 6,
46 
47  LL_MAX,
48 };
@ LL_DEBUG4
Log at debug level 4.
Definition: logging.h:43
@ LL_ERROR
Log error.
Definition: logging.h:37
@ LL_DEBUG3
Log at debug level 3.
Definition: logging.h:42
@ LL_PERROR
Log perror (using errno)
Definition: logging.h:36
@ LL_DEBUG5
Log at debug level 5.
Definition: logging.h:44
@ LL_WARNING
Log warning.
Definition: logging.h:38
@ LL_MESSAGE
Log informational message.
Definition: logging.h:39
@ LL_DEBUG2
Log at debug level 2.
Definition: logging.h:41
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
@ LL_NOTIFY
Log of notifications.
Definition: logging.h:45
@ LL_MAX
Definition: logging.h:47

Function Documentation

◆ STAILQ_HEAD()

STAILQ_HEAD ( LogLineList  ,
LogLine   
)

◆ log_queue_add()

int log_queue_add ( struct LogLine ll)

Add a LogLine to the queue.

Parameters
llLogLine to add
Return values
numEntries in the queue

If LogQueueMax is non-zero, the queue will be limited to this many items.

Definition at line 287 of file logging.c.

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 }
static struct LogLineList LogQueue
In-memory list of log lines.
Definition: logging.c:62
int LogQueueMax
Maximum number of entries in the log queue.
Definition: logging.c:65
int LogQueueCount
Number of entries currently in the log queue.
Definition: logging.c:64
#define FREE(x)
Definition: memory.h:40
#define STAILQ_REMOVE_HEAD(head, field)
Definition: queue.h:422
#define STAILQ_FIRST(head)
Definition: queue.h:350
#define STAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:389
char * message
Message to be logged.
Definition: logging.h:79
+ Here is the caller graph for this function:

◆ log_queue_empty()

void log_queue_empty ( void  )

Free the contents of the queue.

Free any log lines in the queue.

Definition at line 326 of file logging.c.

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 }
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:402
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:362
A Log line.
Definition: logging.h:73
+ Here is the caller graph for this function:

◆ log_queue_flush()

void log_queue_flush ( log_dispatcher_t  disp)

Replay the log queue.

Parameters
dispLog dispatcher - Implements log_dispatcher_t

Pass all of the log entries in the queue to the log dispatcher provided. The queue will be emptied afterwards.

Definition at line 348 of file logging.c.

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 }
void log_queue_empty(void)
Free the contents of the queue.
Definition: logging.c:326
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
const char * file
Source file.
Definition: logging.h:75
const char * function
C function.
Definition: logging.h:77
int line
Line number in source file.
Definition: logging.h:76
enum LogLevel level
Log level, e.g. LL_DEBUG1.
Definition: logging.h:78
time_t time
Timestamp of the message.
Definition: logging.h:74
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ log_queue_save()

int log_queue_save ( FILE *  fp)

Save the contents of the queue to a temporary file.

Parameters
fpOpen file handle
Return values
numLines written to the file

The queue is written to a temporary file. The format is:

  • [HH:MM:SS]<LEVEL> FORMATTED-MESSAGE
Note
The caller should delete the file

Definition at line 369 of file logging.c.

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 }
size_t mutt_date_localtime_format(char *buf, size_t buflen, const char *format, time_t t)
Format localtime.
Definition: date.c:691
const char * LevelAbbr
Abbreviations of logging level names.
Definition: logging.c:45
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ log_queue_set_max_size()

void log_queue_set_max_size ( int  size)

Set a upper limit for the queue length.

Parameters
sizeNew maximum queue length
Note
size of 0 means unlimited

Definition at line 314 of file logging.c.

315 {
316  if (size < 0)
317  size = 0;
318  LogQueueMax = size;
319 }
+ Here is the caller graph for this function:

◆ log_file_close()

void log_file_close ( bool  verbose)

Close the log file.

Parameters
verboseIf true, then log the event

Definition at line 98 of file logging.c.

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 }
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:153
#define mutt_message(...)
Definition: logging.h:86
FILE * LogFileFP
Log file handle.
Definition: logging.c:54
char * LogFileName
Log file name.
Definition: logging.c:55
static const char * timestamp(time_t stamp)
Create a YYYY-MM-DD HH:MM:SS timestamp.
Definition: logging.c:77
#define _(a)
Definition: message.h:28
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ log_file_open()

int log_file_open ( bool  verbose)

Start logging to a file.

Parameters
verboseIf true, then log the event
Return values
0Success
-1Error, see errno

Before opening a log file, call log_file_set_version(), log_file_set_level() and log_file_set_filename().

Definition at line 119 of file logging.c.

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 }
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:593
char * LogFileVersion
Program version.
Definition: logging.c:57
int LogFileLevel
Log file level.
Definition: logging.c:56
void log_file_close(bool verbose)
Close the log file.
Definition: logging.c:98
#define NONULL(x)
Definition: string2.h:37
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ log_file_running()

bool log_file_running ( void  )

Is the log file running?

Return values
trueThe log file is running

Definition at line 230 of file logging.c.

231 {
232  return LogFileFP;
233 }
+ Here is the caller graph for this function:

◆ log_file_set_filename()

int log_file_set_filename ( const char *  file,
bool  verbose 
)

Set the filename for the log.

Parameters
fileName to use
verboseIf true, then log the event
Return values
0Success, file opened
-1Error, see errno

Definition at line 149 of file logging.c.

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 }
int log_file_open(bool verbose)
Start logging to a file.
Definition: logging.c:119
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:904
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:446
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ log_file_set_level()

int log_file_set_level ( enum LogLevel  level,
bool  verbose 
)

Set the logging level.

Parameters
levelLogging level
verboseIf true, then log the event
Return values
0Success
-1Error, level is out of range

The level should be: LL_MESSAGE <= level < LL_MAX.

Definition at line 175 of file logging.c.

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 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ log_file_set_version()

void log_file_set_version ( const char *  version)

Set the program's version number.

Parameters
versionVersion number

The string will be appended directly to 'NeoMutt', so it should begin with a hyphen.

Definition at line 221 of file logging.c.

222 {
223  mutt_str_replace(&LogFileVersion, version);
224 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function: