mutt_logging.c File Reference

NeoMutt Logging. More...

#include "config.h"
#include <errno.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "mutt_logging.h"
#include "color/lib.h"
#include "globals.h"
#include "muttlib.h"

Include dependency graph for mutt_logging.c:

Go to the source code of this file.

Macros
#define	S_TO_MS   1000L

Functions
static void	error_pause (void)
	Wait for an error message to be read. More...
void	mutt_clear_error (void)
	Clear the message line (bottom line of screen) More...
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...
void	mutt_log_stop (void)
	Close the log file. More...
int	mutt_log_set_file (const char *file)
	Change the logging file. More...
int	mutt_log_set_level (enum LogLevel level, bool verbose)
	Change the logging level. More...
int	mutt_log_start (void)
	Enable file logging. More...
int	level_validator (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
	Validate the "debug_level" config variable - Implements ConfigDef::validator() -. More...
int	main_log_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -. More...

Variables
static uint64_t	LastError = 0
	Time of the last error message (in milliseconds since the Unix epoch) More...
static char *	CurrentFile = NULL
	The previous log file name. More...
static const int	NumOfLogs = 5
	How many log files to rotate. 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.c.

Macro Definition Documentation

S_TO_MS

#define S_TO_MS   1000L

Definition at line 51 of file mutt_logging.c.

Function Documentation

error_pause()

static void error_pause ( void  )

static

Wait for an error message to be read.

If '$sleep_time' seconds hasn't elapsed since LastError, then wait

Definition at line 58 of file mutt_logging.c.

{
  const short c_sleep_time = cs_subset_number(NeoMutt->sub, "sleep_time");
  const uint64_t elapsed = mutt_date_now_ms() - LastError;
  const uint64_t sleep = c_sleep_time * S_TO_MS;
  if ((LastError == 0) || (elapsed >= sleep))
    return;
 
  mutt_refresh();
  mutt_date_sleep_ms(sleep - elapsed);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_clear_error()

void mutt_clear_error

(

void

)

Clear the message line (bottom line of screen)

Definition at line 73 of file mutt_logging.c.

{
  /* Make sure the error message has had time to be read */
  if (OptMsgErr)
    error_pause();
 
  ErrorBufMessage = false;
  if (!OptNoCurses)
    msgwin_clear_text();
}

Here is the call graph for this function:

mutt_log_prep()

void mutt_log_prep

(

void

)

Prepare to log.

Definition at line 173 of file mutt_logging.c.

{
  char ver[64] = { 0 };
  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_stop()

void mutt_log_stop

(

void

)

Close the log file.

Definition at line 183 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_file()

int mutt_log_set_file

(

const char *

file

)

Change the logging file.

Parameters

file	Name to use

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 197 of file mutt_logging.c.

{
  const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
  if (!mutt_str_equal(CurrentFile, c_debug_file))
  {
    struct Buffer *expanded = buf_pool_get();
    buf_addstr(expanded, c_debug_file);
    buf_expand_path(expanded);
 
    const char *name = mutt_file_rotate(buf_string(expanded), NumOfLogs);
    buf_pool_release(&expanded);
    if (!name)
      return -1;
 
    log_file_set_filename(name, false);
    FREE(&name);
    mutt_str_replace(&CurrentFile, c_debug_file);
  }
 
  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_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 228 of file mutt_logging.c.

{
  if (!CurrentFile)
  {
    const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
    mutt_log_set_file(c_debug_file);
  }
 
  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_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 250 of file mutt_logging.c.

{
  const short c_debug_level = cs_subset_number(NeoMutt->sub, "debug_level");
  if (c_debug_level < 1)
    return 0;
 
  if (log_file_running())
    return 0;
 
  const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
  mutt_log_set_file(c_debug_file);
 
  /* This will trigger the file creation */
  if (log_file_set_level(c_debug_level, true) < 0)
    return -1;
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

LastError

uint64_t LastError = 0

static

Time of the last error message (in milliseconds since the Unix epoch)

Definition at line 46 of file mutt_logging.c.

CurrentFile

char* CurrentFile = NULL

static

The previous log file name.

Definition at line 48 of file mutt_logging.c.

NumOfLogs

const int NumOfLogs = 5

static

How many log files to rotate.

Definition at line 49 of file mutt_logging.c.