mutt_logging.h File Reference

NeoMutt Logging. More...

#include <stdbool.h>
#include <stdint.h>
#include <time.h>
#include "mutt/mutt.h"

Include dependency graph for mutt_logging.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	log_disp_curses (time_t stamp, const char *file, int line, const char *function, enum LogLevel level,...)
	Display a log line in the message line - Implements log_dispatcher_t. More...
void	mutt_log_prep (void)
	Prepare to log. More...
int	mutt_log_start (void)
	Enable file logging. More...
void	mutt_log_stop (void)
	Close the log file. More...
int	mutt_log_set_level (enum LogLevel level, bool verbose)
	Change the logging level. More...
int	mutt_log_set_file (const char *file, bool verbose)
	Change the logging file. More...
int	mutt_log_observer (struct NotifyCallback *nc)
	Listen for config changes affecting the log file - Implements observer_t() More...
int	level_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "debug_level" config variable. More...
void	mutt_clear_error (void)
	Clear the message line (bottom line of screen) More...

Variables
short	C_DebugLevel
	Config: Logging level for debug logs. More...
char *	C_DebugFile
	Config: File to save debug logs. More...

Detailed Description

NeoMutt Logging.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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 mutt_logging.h.

Function Documentation

log_disp_curses()

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

Display a log line in the message line - Implements log_dispatcher_t.

Definition at line 127 of file mutt_logging.c.

{
  if (level > C_DebugLevel)
    return 0;

  char buf[1024];

  va_list ap;
  va_start(ap, level);
  const char *fmt = va_arg(ap, const char *);
  int ret = vsnprintf(buf, sizeof(buf), fmt, ap);
  va_end(ap);

  if (level == LL_PERROR)
  {
    char *buf2 = buf + ret;
    int len = sizeof(buf) - ret;
    char *p = strerror(errno);
    if (!p)
      p = _("unknown error");

    ret += snprintf(buf2, len, ": %s (errno = %d)", p, errno);
  }

  const bool dupe = (strcmp(buf, ErrorBuf) == 0);
  if (!dupe)
  {
    /* Only log unique messages */
    log_disp_file(stamp, file, line, function, level, "%s", buf);
    if (stamp == 0)
      log_disp_queue(stamp, file, line, function, level, "%s", buf);
  }

  /* Don't display debugging message on screen */
  if (level > LL_MESSAGE)
    return 0;

  /* Only pause if this is a message following an error */
  if ((level > LL_ERROR) && OptMsgErr && !dupe)
    error_pause();

  mutt_simple_format(ErrorBuf, sizeof(ErrorBuf), 0,
                     MuttMessageWindow ? MuttMessageWindow->state.cols : sizeof(ErrorBuf),
                     JUSTIFY_LEFT, 0, buf, sizeof(buf), false);
  ErrorBufMessage = true;

  if (!OptKeepQuiet)
  {
    switch (level)
    {
      case LL_ERROR:
        mutt_beep(false);
        mutt_curses_set_color(MT_COLOR_ERROR);
        break;
      case LL_WARNING:
        mutt_curses_set_color(MT_COLOR_WARNING);
        break;
      default:
        mutt_curses_set_color(MT_COLOR_MESSAGE);
        break;
    }

    mutt_window_mvaddstr(MuttMessageWindow, 0, 0, ErrorBuf);
    mutt_curses_set_color(MT_COLOR_NORMAL);
    mutt_window_clrtoeol(MuttMessageWindow);
    mutt_refresh();
  }

  if ((level <= LL_ERROR) && !dupe)
  {
    OptMsgErr = true;
    LastError = mutt_date_epoch_ms();
  }
  else
  {
    OptMsgErr = false;
    LastError = 0;
  }

  return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_prep()

void mutt_log_prep

(

void

)

Prepare to log.

Definition at line 213 of file mutt_logging.c.

{
  char ver[64];
  snprintf(ver, sizeof(ver), "-%s%s", PACKAGE_VERSION, GitVer);
  log_file_set_version(ver);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_start()

int mutt_log_start

(

void

)

Enable file logging.

Return values

0	Success, or already running
-1	Failed to start

This also handles file rotation.

Definition at line 282 of file mutt_logging.c.

{
  if (C_DebugLevel < 1)
    return 0;

  if (log_file_running())
    return 0;

  mutt_log_set_file(C_DebugFile, false);

  /* This will trigger the file creation */
  if (log_file_set_level(C_DebugLevel, true) < 0)
    return -1;

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_stop()

void mutt_log_stop

(

void

)

Close the log file.

Definition at line 223 of file mutt_logging.c.

{
  log_file_close(false);
  FREE(&CurrentFile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_set_level()

int mutt_log_set_level	(	enum LogLevel	level,
		bool	verbose
	)

Change the logging level.

Parameters

level	Logging level
verbose	If true, then log the event

Return values

0	Success
-1	Error, level is out of range

Definition at line 263 of file mutt_logging.c.

{
  if (!CurrentFile)
    mutt_log_set_file(C_DebugFile, false);

  if (log_file_set_level(level, verbose) != 0)
    return -1;

  cs_subset_str_native_set(NeoMutt->sub, "debug_level", level, NULL);
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_set_file()

int mutt_log_set_file	(	const char *	file,
		bool	verbose
	)

Change the logging file.

Parameters

file	Name to use
verbose	If true, then log the event

Return values

0	Success, file opened
-1	Error, see errno

Close the old log, rotate the new logs and open the new log.

Definition at line 238 of file mutt_logging.c.

{
  if (mutt_str_strcmp(CurrentFile, C_DebugFile) != 0)
  {
    const char *name = rotate_logs(C_DebugFile, NumOfLogs);
    if (!name)
      return -1;

    log_file_set_filename(name, false);
    FREE(&name);
    mutt_str_replace(&CurrentFile, C_DebugFile);
  }

  cs_subset_str_string_set(NeoMutt->sub, "debug_file", file, NULL);

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_log_observer()

int mutt_log_observer

(

struct NotifyCallback *

nc

)

Listen for config changes affecting the log file - Implements observer_t()

Definition at line 323 of file mutt_logging.c.

{
  if (!nc->event_data)
    return -1;
  if (nc->event_type != NT_CONFIG)
    return 0;

  struct EventConfig *ec = nc->event_data;

  if (mutt_str_strcmp(ec->name, "debug_file") == 0)
    mutt_log_set_file(C_DebugFile, true);
  else if (mutt_str_strcmp(ec->name, "debug_level") == 0)
    mutt_log_set_level(C_DebugLevel, true);

  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

level_validator()

int level_validator	(	const struct ConfigSet *	cs,
		const struct ConfigDef *	cdef,
		intptr_t	value,
		struct Buffer *	err
	)

Validate the "debug_level" config variable.

Parameters

cs	Config items
cdef	Config definition
value	Native value
err	Message for the user

Return values

CSR_SUCCESS	Success
CSR_ERR_INVALID	Failure

Definition at line 308 of file mutt_logging.c.

{
  if ((value < 0) || (value >= LL_MAX))
  {
    mutt_buffer_printf(err, _("Invalid value for option %s: %ld"), cdef->name, value);
    return CSR_ERR_INVALID;
  }

  return CSR_SUCCESS;
}

Here is the call graph for this function:

mutt_clear_error()

void mutt_clear_error

(

void

)

Clear the message line (bottom line of screen)

Definition at line 113 of file mutt_logging.c.

{
  /* Make sure the error message has had time to be read */
  if (OptMsgErr)
    error_pause();

  ErrorBufMessage = false;
  if (!OptNoCurses)
    mutt_window_clearline(MuttMessageWindow, 0);
}

Here is the call graph for this function:

Variable Documentation

C_DebugLevel

short C_DebugLevel

Config: Logging level for debug logs.

Definition at line 48 of file mutt_logging.c.

C_DebugFile

char* C_DebugFile

Config: File to save debug logs.

Definition at line 49 of file mutt_logging.c.