history.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "lib.h"
#include "module_data.h"
 
#define HC_FIRST HC_EXT_COMMAND

static struct History *get_history(enum HistoryClass hclass)
{
  struct HistoryModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_HISTORY);
  const short c_history = cs_subset_number(NeoMutt->sub, "history");
  if ((hclass >= HC_MAX) || (c_history == 0))
    return NULL;
 
  struct History *hist = &mod_data->histories[hclass];
  return hist->hist ? hist : NULL;
}

static void init_history(struct History *h, int old_size)
{
  if (old_size != 0)
  {
    if (h->hist)
    {
      for (int i = 0; i <= old_size; i++)
        FREE(&h->hist[i]);
      FREE(&h->hist);
    }
  }
 
  const short c_history = cs_subset_number(NeoMutt->sub, "history");
  if (c_history != 0)
    h->hist = MUTT_MEM_CALLOC(c_history + 1, char *);
 
  h->cur = 0;
  h->last = 0;
}

static int dup_hash_dec(struct HashTable *dup_hash, char *str)
{
  struct HashElem *he = mutt_hash_find_elem(dup_hash, str);
  if (!he)
    return -1;
 
  uintptr_t count = (uintptr_t) he->data;
  if (count <= 1)
  {
    mutt_hash_delete(dup_hash, str, NULL);
    return 0;
  }
 
  count--;
  he->data = (void *) count;
  return count;
}

static int dup_hash_inc(struct HashTable *dup_hash, char *str)
{
  uintptr_t count;
 
  struct HashElem *he = mutt_hash_find_elem(dup_hash, str);
  if (!he)
  {
    count = 1;
    mutt_hash_insert(dup_hash, str, (void *) count);
    return count;
  }
 
  count = (uintptr_t) he->data;
  count++;
  he->data = (void *) count;
  return count;
}

static void shrink_histfile(void)
{
  FILE *fp_tmp = NULL;
  int n[HC_MAX] = { 0 };
  int line, hclass = 0, read = 0;
  char *linebuf = NULL, *p = NULL;
  size_t buflen;
  bool regen_file = false;
  struct HashTable *dup_hashes[HC_MAX] = { 0 };
 
  const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
  FILE *fp = mutt_file_fopen(c_history_file, "r");
  if (!fp)
    return;
 
  /* If duplicate removal is enabled, build per-class hash tables to track
   * how many times each history entry appears in the file */
  const bool c_history_remove_dups = cs_subset_bool(NeoMutt->sub, "history_remove_dups");
  const short c_save_history = cs_subset_number(NeoMutt->sub, "save_history");
  if (c_history_remove_dups)
  {
    for (hclass = 0; hclass < HC_MAX; hclass++)
      dup_hashes[hclass] = mutt_hash_new(MAX(10, c_save_history * 2), MUTT_HASH_STRDUP_KEYS);
  }
 
  /* First pass: count entries per class, detect duplicates, and validate
   * the file format (each line is "class:entry|") */
  line = 0;
  while ((linebuf = mutt_file_read_line(linebuf, &buflen, fp, &line, MUTT_RL_NO_FLAGS)))
  {
    if ((sscanf(linebuf, "%d:%n", &hclass, &read) < 1) || (read == 0) ||
        (*(p = linebuf + strlen(linebuf) - 1) != '|') || (hclass < 0))
    {
      mutt_error(_("%s:%d: Bad history file format"), c_history_file, line);
      regen_file = true;
      continue;
    }
    /* silently ignore too high class (probably newer neomutt) */
    if (hclass >= HC_MAX)
      continue;
    *p = '\0';
    if (c_history_remove_dups && (dup_hash_inc(dup_hashes[hclass], linebuf + read) > 1))
    {
      regen_file = true;
      continue;
    }
    n[hclass]++;
  }
 
  if (!regen_file)
  {
    for (hclass = HC_FIRST; hclass < HC_MAX; hclass++)
    {
      if (n[hclass] > c_save_history)
      {
        regen_file = true;
        break;
      }
    }
  }
 
  if (regen_file)
  {
    /* Second pass: rewrite the file keeping only the most recent
     * c_save_history entries per class, omitting duplicates */
    fp_tmp = mutt_file_mkstemp();
    if (!fp_tmp)
    {
      mutt_perror(_("Can't create temporary file"));
      goto cleanup;
    }
    rewind(fp);
    line = 0;
    while ((linebuf = mutt_file_read_line(linebuf, &buflen, fp, &line, MUTT_RL_NO_FLAGS)))
    {
      if ((sscanf(linebuf, "%d:%n", &hclass, &read) < 1) || (read == 0) ||
          (*(p = linebuf + strlen(linebuf) - 1) != '|') || (hclass < 0))
      {
        continue;
      }
      if (hclass >= HC_MAX)
        continue;
      *p = '\0';
      if (c_history_remove_dups && (dup_hash_dec(dup_hashes[hclass], linebuf + read) > 0))
      {
        continue;
      }
      *p = '|';
      if (n[hclass]-- <= c_save_history)
        fprintf(fp_tmp, "%s\n", linebuf);
    }
  }
 
cleanup:
  mutt_file_fclose(&fp);
  FREE(&linebuf);
  if (fp_tmp)
  {
    if (fflush(fp_tmp) == 0)
    {
      fp = mutt_file_fopen(c_history_file, "w");
      if (fp)
      {
        rewind(fp_tmp);
        mutt_file_copy_stream(fp_tmp, fp);
        mutt_file_fclose(&fp);
      }
    }
    mutt_file_fclose(&fp_tmp);
  }
  if (c_history_remove_dups)
    for (hclass = 0; hclass < HC_MAX; hclass++)
      mutt_hash_free(&dup_hashes[hclass]);
}

static void save_history(enum HistoryClass hclass, const char *str)
{
  if (!str || (*str == '\0')) // This shouldn't happen, but it's safer
    return;
 
  const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
  FILE *fp = mutt_file_fopen(c_history_file, "a");
  if (!fp)
    return;
 
  char *tmp = mutt_str_dup(str);
  mutt_ch_convert_string(&tmp, cc_charset(), "utf-8", MUTT_ICONV_NO_FLAGS);
 
  // If tmp contains '\n' terminate it there.
  char *nl = strchr(tmp, '\n');
  if (nl)
    *nl = '\0';
 
  /* Format of a history item (1 line): "<histclass>:<string>|".
   * We add a '|' in order to avoid lines ending with '\'. */
  fprintf(fp, "%d:%s|\n", (int) hclass, tmp);
 
  mutt_file_fclose(&fp);
  FREE(&tmp);
 
  shrink_histfile();
}

static void remove_history_dups(enum HistoryClass hclass, const char *str)
{
  struct History *h = get_history(hclass);
  if (!h)
    return; /* disabled */
 
  /* Remove dups from 0..last-1 compacting up. */
  int source = 0;
  int dest = 0;
  while (source < h->last)
  {
    if (mutt_str_equal(h->hist[source], str))
      FREE(&h->hist[source++]);
    else
      h->hist[dest++] = h->hist[source++];
  }
 
  /* Move 'last' entry up. */
  h->hist[dest] = h->hist[source];
  int old_last = h->last;
  h->last = dest;
 
  /* Fill in moved entries with NULL */
  while (source > h->last)
    h->hist[source--] = NULL;
 
  /* Remove dups from last+1 .. `$history` compacting down. */
  const short c_history = cs_subset_number(NeoMutt->sub, "history");
  source = c_history;
  dest = c_history;
  while (source > old_last)
  {
    if (mutt_str_equal(h->hist[source], str))
      FREE(&h->hist[source--]);
    else
      h->hist[dest--] = h->hist[source--];
  }
 
  /* Fill in moved entries with NULL */
  while (dest > old_last)
    h->hist[dest--] = NULL;
}

int mutt_hist_search(const char *find, enum HistoryClass hclass, struct StringArray *matches)
{
  if (!find || !matches)
    return 0;
 
  struct History *h = get_history(hclass);
  if (!h)
    return 0;
 
  int cur = h->last;
  const short c_history = cs_subset_number(NeoMutt->sub, "history");
 
  do
  {
    cur--;
    if (cur < 0)
      cur = c_history;
 
    if (cur == h->last)
      break;
 
    if (mutt_istr_find(h->hist[cur], find))
      ARRAY_ADD(matches, h->hist[cur]);
 
  } while (ARRAY_SIZE(matches) < c_history);
 
  return ARRAY_SIZE(matches);
}

void mutt_hist_cleanup(void)
{
  struct HistoryModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_HISTORY);
  for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
  {
    struct History *h = &mod_data->histories[hclass];
    if (!h->hist)
      continue;
 
    /* The array has (mod_data->old_size+1) elements */
    for (int i = 0; i <= mod_data->old_size; i++)
    {
      FREE(&h->hist[i]);
    }
    FREE(&h->hist);
  }
}

void mutt_hist_init(void)
{
  struct HistoryModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_HISTORY);
  const short c_history = cs_subset_number(NeoMutt->sub, "history");
  if (c_history == mod_data->old_size)
    return;
 
  for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
    init_history(&mod_data->histories[hclass], mod_data->old_size);
 
  mod_data->old_size = c_history;
}

void mutt_hist_add(enum HistoryClass hclass, const char *str, bool save)
{
  struct History *h = get_history(hclass);
  if (!h)
    return; /* disabled */
 
  if (str && *str)
  {
    int prev = h->last - 1;
    const short c_history = cs_subset_number(NeoMutt->sub, "history");
    if (prev < 0)
      prev = c_history;
 
    /* don't add to prompt history:
     *  - lines beginning by a space
     *  - repeated lines */
    if ((*str != ' ') && (!h->hist[prev] || !mutt_str_equal(h->hist[prev], str)))
    {
      const bool c_history_remove_dups = cs_subset_bool(NeoMutt->sub, "history_remove_dups");
      if (c_history_remove_dups)
        remove_history_dups(hclass, str);
      const short c_save_history = cs_subset_number(NeoMutt->sub, "save_history");
      const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
      if (save && (c_save_history != 0) && c_history_file)
        save_history(hclass, str);
      mutt_str_replace(&h->hist[h->last++], str);
      if (h->last > c_history)
        h->last = 0;
    }
  }
  h->cur = h->last; /* reset to the last entry */
}

char *mutt_hist_next(enum HistoryClass hclass)
{
  struct History *h = get_history(hclass);
  if (!h)
    return ""; /* disabled */
 
  int next = h->cur;
  const short c_history = cs_subset_number(NeoMutt->sub, "history");
  do
  {
    next++;
    if (next > c_history)
      next = 0;
    if (next == h->last)
      break;
  } while (!h->hist[next]);
 
  h->cur = next;
  return NONULL(h->hist[h->cur]);
}

char *mutt_hist_prev(enum HistoryClass hclass)
{
  struct History *h = get_history(hclass);
  if (!h)
    return ""; /* disabled */
 
  int prev = h->cur;
  const short c_history = cs_subset_number(NeoMutt->sub, "history");
  do
  {
    prev--;
    if (prev < 0)
      prev = c_history;
    if (prev == h->last)
      break;
  } while (!h->hist[prev]);
 
  h->cur = prev;
  return NONULL(h->hist[h->cur]);
}

void mutt_hist_reset_state(enum HistoryClass hclass)
{
  struct History *h = get_history(hclass);
  if (!h)
    return; /* disabled */
 
  h->cur = h->last;
}

void mutt_hist_read_file(void)
{
  const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
  if (!c_history_file)
    return;
 
  FILE *fp = mutt_file_fopen(c_history_file, "r");
  if (!fp)
    return;
 
  int line = 0, hclass = 0, read = 0;
  char *linebuf = NULL, *p = NULL;
  size_t buflen;
 
  const char *const c_charset = cc_charset();
  while ((linebuf = mutt_file_read_line(linebuf, &buflen, fp, &line, MUTT_RL_NO_FLAGS)))
  {
    read = 0;
    if ((sscanf(linebuf, "%d:%n", &hclass, &read) < 1) || (read == 0) ||
        (*(p = linebuf + strlen(linebuf) - 1) != '|') || (hclass < 0))
    {
      mutt_error(_("%s:%d: Bad history file format"), c_history_file, line);
      continue;
    }
    /* silently ignore too high class (probably newer neomutt) */
    if (hclass >= HC_MAX)
      continue;
    *p = '\0';
    p = mutt_str_dup(linebuf + read);
    if (p)
    {
      mutt_ch_convert_string(&p, "utf-8", c_charset, MUTT_ICONV_NO_FLAGS);
      mutt_hist_add(hclass, p, false);
      FREE(&p);
    }
  }
 
  mutt_file_fclose(&fp);
  FREE(&linebuf);
}

bool mutt_hist_at_scratch(enum HistoryClass hclass)
{
  struct History *h = get_history(hclass);
  if (!h)
    return false; /* disabled */
 
  return h->cur == h->last;
}

void mutt_hist_save_scratch(enum HistoryClass hclass, const char *str)
{
  struct History *h = get_history(hclass);
  if (!h)
    return; /* disabled */
 
  /* Don't check if str has a value because the scratch buffer may contain
   * an old garbage value that should be overwritten */
  mutt_str_replace(&h->hist[h->last], str);
}

void mutt_hist_complete(struct Buffer *buf, enum HistoryClass hclass)
{
  struct StringArray matches = ARRAY_HEAD_INITIALIZER;
 
  int match_count = mutt_hist_search(buf_string(buf), hclass, &matches);
  if (match_count != 0)
  {
    if (match_count == 1)
    {
      const char **pstr = ARRAY_GET(&matches, 0);
      buf_strcpy(buf, *pstr);
    }
    else
    {
      dlg_history(buf, &matches);
    }
  }
 
  ARRAY_FREE(&matches);
}

int main_hist_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, "history"))
    return 0;
 
  mutt_hist_init();
  mutt_debug(LL_DEBUG5, "history done\n");
  return 0;
}