mutt_logging.c

Go to the documentation of this file.

 
#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"
 
static uint64_t LastError = 0; 
 
static char *CurrentFile = NULL; 
static const int NumOfLogs = 5;  
 
#define S_TO_MS 1000L

static void error_pause(void)
{
  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);
}

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

int log_disp_curses(time_t stamp, const char *file, int line, const char *function,
                    enum LogLevel level, const char *format, ...)
{
  const short c_debug_level = cs_subset_number(NeoMutt->sub, "debug_level");
  if (level > c_debug_level)
    return 0;
 
  char buf[LOG_LINE_MAX_LEN] = { 0 };
 
  va_list ap;
  va_start(ap, format);
  int rc = vsnprintf(buf, sizeof(buf), format, ap);
  va_end(ap);
 
  if ((level == LL_PERROR) && (rc >= 0) && (rc < sizeof(buf)))
  {
    char *buf2 = buf + rc;
    int len = sizeof(buf) - rc;
    const char *p = strerror(errno);
    if (!p)
      p = _("unknown error");
 
    rc += snprintf(buf2, len, ": %s (errno = %d)", p, errno);
  }
 
  const bool dupe = (mutt_str_equal(buf, ErrorBuf));
  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_str_copy(ErrorBuf, buf, sizeof(ErrorBuf));
  ErrorBufMessage = true;
 
  if (!OptKeepQuiet)
  {
    enum ColorId cid = MT_COLOR_NORMAL;
    switch (level)
    {
      case LL_ERROR:
        mutt_beep(false);
        cid = MT_COLOR_ERROR;
        break;
      case LL_WARNING:
        cid = MT_COLOR_WARNING;
        break;
      default:
        cid = MT_COLOR_MESSAGE;
        break;
    }
 
    msgwin_set_text(NULL, ErrorBuf, cid);
  }
 
  if ((level <= LL_ERROR) && !dupe)
  {
    OptMsgErr = true;
    LastError = mutt_date_now_ms();
  }
  else
  {
    OptMsgErr = false;
    LastError = 0;
  }
 
  window_redraw(msgwin_get_window());
  return rc;
}

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

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

int mutt_log_set_file(const char *file)
{
  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;
}

int mutt_log_set_level(enum LogLevel level, bool verbose)
{
  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;
}

int mutt_log_start(void)
{
  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;
}

int level_validator(const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
{
  if ((value < 0) || (value >= LL_MAX))
  {
    buf_printf(err, _("Invalid value for option %s: %ld"), cdef->name, (long) value);
    return CSR_ERR_INVALID;
  }
 
  return CSR_SUCCESS;
}

int main_log_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_CONFIG)
    return 0;
  if (!nc->event_data)
    return -1;
 
  struct EventConfig *ev_c = nc->event_data;
 
  if (mutt_str_equal(ev_c->name, "debug_file"))
  {
    const char *const c_debug_file = cs_subset_path(NeoMutt->sub, "debug_file");
    mutt_log_set_file(c_debug_file);
  }
  else if (mutt_str_equal(ev_c->name, "debug_level"))
  {
    const short c_debug_level = cs_subset_number(NeoMutt->sub, "debug_level");
    mutt_log_set_level(c_debug_level, true);
  }
  else
  {
    return 0;
  }
 
  mutt_debug(LL_DEBUG5, "log done\n");
  return 0;
}