xref: /dports/mail/neomutt/neomutt-20211029/email/email.c

/**
 * @file
 * Representation of an email
 *
 * @authors
 * Copyright (C) 1996-2009,2012 Michael R. Elkins <me@mutt.org>
 *
 * @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/>.
 */

/**
 * @page email_email Email object
 *
 * Representation of an email
 */

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include "mutt/lib.h"
#include "email.h"
#include "body.h"
#include "envelope.h"
#include "tags.h"

void nm_edata_free(void **ptr);

/**
 * email_free - Free an Email
 * @param[out] ptr Email to free
 */
void email_free(struct Email **ptr)
{
  if (!ptr || !*ptr)
    return;

  struct Email *e = *ptr;

  mutt_debug(LL_NOTIFY, "NT_EMAIL_DELETE: %p\n", e);
  struct EventEmail ev_e = { 1, &e };
  notify_send(e->notify, NT_EMAIL, NT_EMAIL_DELETE, &ev_e);

  if (e->edata_free && e->edata)
    e->edata_free(&e->edata);

  mutt_env_free(&e->env);
  mutt_body_free(&e->body);
  FREE(&e->tree);
  FREE(&e->path);
#ifdef MIXMASTER
  mutt_list_free(&e->chain);
#endif
#ifdef USE_NOTMUCH
  nm_edata_free(&e->nm_edata);
#endif
  driver_tags_free(&e->tags);
  notify_free(&e->notify);

  FREE(ptr);
}

/**
 * email_new - Create a new Email
 * @retval ptr Newly created Email
 */
struct Email *email_new(void)
{
  static size_t sequence = 0;

  struct Email *e = mutt_mem_calloc(1, sizeof(struct Email));
#ifdef MIXMASTER
  STAILQ_INIT(&e->chain);
#endif
  STAILQ_INIT(&e->tags);
  e->visible = true;
  e->sequence = sequence++;
  e->notify = notify_new();

  return e;
}

/**
 * email_cmp_strict - Strictly compare message emails
 * @param e1 First Email
 * @param e2 Second Email
 * @retval true Emails are strictly identical
 */
bool email_cmp_strict(const struct Email *e1, const struct Email *e2)
{
  if (e1 && e2)
  {
    if ((e1->received != e2->received) || (e1->date_sent != e2->date_sent) ||
        (e1->body->length != e2->body->length) || (e1->lines != e2->lines) ||
        (e1->zhours != e2->zhours) || (e1->zminutes != e2->zminutes) ||
        (e1->zoccident != e2->zoccident) || (e1->mime != e2->mime) ||
        !mutt_env_cmp_strict(e1->env, e2->env) || !mutt_body_cmp_strict(e1->body, e2->body))
    {
      return false;
    }
    return true;
  }
  else
  {
    return (!e1 && !e2);
  }
}

/**
 * email_size - Compute the size of an email
 * @param e Email
 * @retval num Size of the email, in bytes
 */
size_t email_size(const struct Email *e)
{
  if (!e || !e->body)
    return 0;
  return e->body->length + e->body->offset - e->body->hdr_offset;
}

/**
 * emaillist_clear - Drop a private list of Emails
 * @param el EmailList to empty
 *
 * The Emails are not freed.
 */
void emaillist_clear(struct EmailList *el)
{
  if (!el)
    return;

  struct EmailNode *en = NULL, *tmp = NULL;
  STAILQ_FOREACH_SAFE(en, el, entries, tmp)
  {
    STAILQ_REMOVE(el, en, EmailNode, entries);
    FREE(&en);
  }
  STAILQ_INIT(el);
}

/**
 * emaillist_add_email - Add an Email to a list
 * @param e  Email to add
 * @param el EmailList to add to
 * @retval  0 Success
 * @retval -1 Error
 */
int emaillist_add_email(struct EmailList *el, struct Email *e)
{
  if (!el || !e)
    return -1;

  struct EmailNode *en = mutt_mem_calloc(1, sizeof(*en));
  en->email = e;
  STAILQ_INSERT_TAIL(el, en, entries);

  return 0;
}

/**
 * header_find - Find a header, matching on its field, in a list of headers
 * @param hdrlist List of headers to search
 * @param header  The header to search for
 * @retval node   The node in the list matching the header
 * @retval NULL   No matching header is found
 *
 * The header should either of the form "X-Header:" or "X-Header: value"
 */
struct ListNode *header_find(const struct ListHead *hdrlist, const char *header)
{
  const char *key_end = strchr(header, ':');
  if (!key_end)
    return NULL;

  const int keylen = key_end - header + 1;

  struct ListNode *n = NULL;
  STAILQ_FOREACH(n, hdrlist, entries)
  {
    if (mutt_istrn_equal(n->data, header, keylen))
      return n;
  }
  return n;
}

/**
 * header_add - Add a header to a list
 * @param hdrlist List of headers to search
 * @param header  String to set as the header
 * @retval node   The created header
 */
struct ListNode *header_add(struct ListHead *hdrlist, const char *header)
{
  struct ListNode *n = mutt_list_insert_tail(hdrlist, NULL);
  n->data = mutt_str_dup(header);

  return n;
}

/**
 * header_update - Update an existing header
 * @param hdr     The header to update
 * @param header  String to update the header with
 * @retval node   The updated header
 */
struct ListNode *header_update(struct ListNode *hdr, const char *header)
{
  FREE(&hdr->data);
  hdr->data = mutt_str_dup(header);

  return hdr;
}

/**
 * header_set - Set a header value in a list
 * @param hdrlist List of headers to search
 * @param header  String to set the value of the header to
 * @retval node   The updated or created header
 *
 * If a header exists with the same field, update it, otherwise add a new header.
 */
struct ListNode *header_set(struct ListHead *hdrlist, const char *header)
{
  struct ListNode *n = header_find(hdrlist, header);

  return n ? header_update(n, header) : header_add(hdrlist, header);
}

/**
 * header_free - Free and remove a header from a header list
 * @param hdrlist List to free the header from
 * @param target  The header to free
 */
void header_free(struct ListHead *hdrlist, struct ListNode *target)
{
  STAILQ_REMOVE(hdrlist, target, ListNode, entries);
  FREE(&target->data);
  FREE(&target);
}