mailbox.c

Go to the documentation of this file.

 
#include "config.h"
#include <sys/stat.h>
#include "config/lib.h"
#include "email/lib.h"
#include "mailbox.h"
#include "neomutt.h"

static const struct Mapping MailboxTypes[] = {
  // clang-format off
  { "compressed", MUTT_COMPRESSED },
  { "imap",       MUTT_IMAP },
  { "maildir",    MUTT_MAILDIR },
  { "mbox",       MUTT_MBOX },
  { "mh",         MUTT_MH },
  { "mmdf",       MUTT_MMDF },
  { "nntp",       MUTT_NNTP },
  { "notmuch",    MUTT_NOTMUCH },
  { "pop",        MUTT_POP },
  { NULL, 0 },
  // clang-format on
};

int mailbox_gen(void)
{
  static int gen = 0;
  return gen++;
}

struct Mailbox *mailbox_new(void)
{
  struct Mailbox *m = MUTT_MEM_CALLOC(1, struct Mailbox);
 
  buf_init(&m->pathbuf);
  m->notify = notify_new();
 
  m->email_max = 25;
  m->emails = MUTT_MEM_CALLOC(m->email_max, struct Email *);
  m->v2r = MUTT_MEM_CALLOC(m->email_max, int);
  m->gen = mailbox_gen();
  m->notify_user = true;
  m->poll_new_mail = true;
 
  return m;
}

void mailbox_free(struct Mailbox **ptr)
{
  if (!ptr || !*ptr)
    return;
 
  struct Mailbox *m = *ptr;
 
  const bool do_free = (m->opened == 0) && !m->visible;
 
  mutt_debug(LL_DEBUG3, "%sfreeing %s mailbox %s with refcount %d\n",
             do_free ? "" : "not ", m->visible ? "visible" : "invisible",
             buf_string(&m->pathbuf), m->opened);
 
  if (!do_free)
  {
    return;
  }
 
  mutt_debug(LL_NOTIFY, "NT_MAILBOX_DELETE: %s %p\n",
             mailbox_get_type_name(m->type), (void *) m);
  struct EventMailbox ev_m = { m };
  notify_send(m->notify, NT_MAILBOX, NT_MAILBOX_DELETE, &ev_m);
 
  mutt_debug(LL_NOTIFY, "NT_EMAIL_DELETE_ALL\n");
  struct EventEmail ev_e = { 0, NULL };
  notify_send(m->notify, NT_EMAIL, NT_EMAIL_DELETE_ALL, &ev_e);
 
  for (size_t i = 0; i < m->email_max; i++)
    email_free(&m->emails[i]);
 
  m->email_max = 0;
  m->msg_count = 0;
  m->msg_deleted = 0;
  m->msg_flagged = 0;
  m->msg_new = 0;
  m->msg_tagged = 0;
  m->msg_unread = 0;
 
  if (m->mdata_free && m->mdata)
    m->mdata_free(&m->mdata);
 
  buf_dealloc(&m->pathbuf);
  cs_subset_free(&m->sub);
  FREE(&m->name);
  FREE(&m->realpath);
  FREE(&m->emails);
  FREE(&m->v2r);
  notify_free(&m->notify);
  mailbox_gc_run();
 
  /* The NT_MAILBOX_DELETE notification might already have caused *ptr to be NULL,
   * so call free() on the m pointer */
  *ptr = NULL;
  FREE(&m);
}

struct Mailbox *mailbox_find(const char *path)
{
  if (!path)
    return NULL;
 
  struct stat st = { 0 };
  struct stat st_tmp = { 0 };
 
  if (stat(path, &st) != 0)
    return NULL;
 
  struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
  struct Mailbox **mp = NULL;
  struct Mailbox *m = NULL;
  ARRAY_FOREACH(mp, &ma)
  {
    if ((stat(mailbox_path(*mp), &st_tmp) == 0) &&
        (st.st_dev == st_tmp.st_dev) && (st.st_ino == st_tmp.st_ino))
    {
      m = *mp;
      break;
    }
  }
 
  ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
  return m;
}

struct Mailbox *mailbox_find_name(const char *name)
{
  if (!name)
    return NULL;
 
  struct MailboxArray ma = neomutt_mailboxes_get(NeoMutt, MUTT_MAILBOX_ANY);
  struct Mailbox **mp = NULL;
  struct Mailbox *m = NULL;
  ARRAY_FOREACH(mp, &ma)
  {
    if (mutt_str_equal((*mp)->name, name))
    {
      m = *mp;
      break;
    }
  }
 
  ARRAY_FREE(&ma); // Clean up the ARRAY, but not the Mailboxes
  return m;
}

void mailbox_update(struct Mailbox *m)
{
  struct stat st = { 0 };
 
  if (!m)
    return;
 
  if (stat(mailbox_path(m), &st) == 0)
    m->size = (off_t) st.st_size;
  else
    m->size = 0;
}

void mailbox_changed(struct Mailbox *m, enum NotifyMailbox action)
{
  if (!m)
    return;
 
  mutt_debug(LL_NOTIFY, "NT_MAILBOX_CHANGE: %s %p\n",
             mailbox_get_type_name(m->type), (void *) m);
  struct EventMailbox ev_m = { m };
  notify_send(m->notify, NT_MAILBOX, action, &ev_m);
}

void mailbox_size_add(struct Mailbox *m, const struct Email *e)
{
  m->size += email_get_size(e);
}

void mailbox_size_sub(struct Mailbox *m, const struct Email *e)
{
  m->size -= email_get_size(e);
}

bool mailbox_set_subset(struct Mailbox *m, struct ConfigSubset *sub)
{
  if (!m || m->sub || !sub)
    return false;
 
  m->sub = cs_subset_new(m->name, sub, m->notify);
  m->sub->scope = SET_SCOPE_MAILBOX;
  return true;
}

struct EmailGarbageCollector
{
  struct Email *arr[10]; 
  size_t idx;            
};

static struct EmailGarbageCollector GC = { 0 };

void mailbox_gc_add(struct Email *e)
{
  ASSERT(e);
  if (GC.idx == countof(GC.arr))
  {
    mailbox_gc_run();
  }
  GC.arr[GC.idx] = e;
  GC.idx++;
}

void mailbox_gc_run(void)
{
  for (size_t i = 0; i < GC.idx; i++)
  {
    email_free(&GC.arr[i]);
  }
  GC.idx = 0;
}

const char *mailbox_get_type_name(enum MailboxType type)
{
  const char *name = mutt_map_get_name(type, MailboxTypes);
  if (name)
    return name;
  return "UNKNOWN";
}