message.c File Reference

Maildir Message. More...

#include "config.h"
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include <inttypes.h>
#include <limits.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <utime.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "message.h"
#include "edata.h"
#include "globals.h"
#include "hcache.h"
#include "mx.h"
#include "shared.h"

Include dependency graph for message.c:

Go to the source code of this file.

Functions
int	nm_update_filename (struct Mailbox *m, const char *old_file, const char *new_file, struct Email *e)
	Change the filename.
static int	maildir_sort_flags (const void *a, const void *b, void *sdata)
	Compare two flag characters - Implements sort_t -.
void	maildir_gen_flags (char *dest, size_t destlen, struct Email *e)
	Generate the Maildir flags for an email.
static FILE *	maildir_open_find_message_dir (const char *folder, const char *unique, const char *subfolder, char **newname)
	Find a message in a maildir folder.
FILE *	maildir_open_find_message (const char *folder, const char *msg, char **newname)
	Find a message by name.
static int	maildir_sync_message (struct Mailbox *m, struct Email *e)
	Sync an email to a Maildir folder.
bool	maildir_sync_mailbox_message (struct Mailbox *m, struct Email *e, struct HeaderCache *hc)
	Save changes to the mailbox.
static int	maildir_commit_message (struct Mailbox *m, struct Message *msg, struct Email *e)
	Commit a message to a maildir folder.
int	maildir_rewrite_message (struct Mailbox *m, struct Email *e)
	Sync a message in an Maildir folder.
bool	maildir_msg_open (struct Mailbox *m, struct Message *msg, struct Email *e)
	Open an email message in a Mailbox - Implements MxOps::msg_open() -.
bool	maildir_msg_open_new (struct Mailbox *m, struct Message *msg, const struct Email *e)
	Open a new message in a Mailbox - Implements MxOps::msg_open_new() -.
int	maildir_msg_commit (struct Mailbox *m, struct Message *msg)
	Save changes to an email - Implements MxOps::msg_commit() -.
int	maildir_msg_close (struct Mailbox *m, struct Message *msg)
	Close an email - Implements MxOps::msg_close() -.
int	maildir_msg_save_hcache (struct Mailbox *m, struct Email *e)
	Save message to the header cache - Implements MxOps::msg_save_hcache() -.

Detailed Description

Maildir Message.

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 message.c.

Function Documentation

nm_update_filename()

int nm_update_filename	(	struct Mailbox *	m,
		const char *	old_file,
		const char *	new_file,
		struct Email *	e )

Change the filename.

Parameters

m	Mailbox
old_file	Old filename
new_file	New filename
e	Email

Return values

0	Success
-1	Failure

Definition at line 1811 of file notmuch.c.

{
  char buf[PATH_MAX] = { 0 };
  struct NmMboxData *mdata = nm_mdata_get(m);
  if (!mdata || !new_file)
    return -1;
 
  if (!old_file && nm_edata_get(e))
  {
    email_get_fullpath(e, buf, sizeof(buf));
    old_file = buf;
  }
 
  int rc = rename_filename(m, old_file, new_file, e);
 
  nm_db_release(m);
  mdata->mtime.tv_sec = mutt_date_now();
  mdata->mtime.tv_nsec = 0;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_gen_flags()

void maildir_gen_flags	(	char *	dest,
		size_t	destlen,
		struct Email *	e )

Generate the Maildir flags for an email.

Parameters

dest	Buffer for the result
destlen	Length of buffer
e	Email

Definition at line 71 of file message.c.

{
  *dest = '\0';
 
  const char *flags = NULL;
 
  struct MaildirEmailData *edata = maildir_edata_get(e);
  if (edata)
    flags = edata->custom_flags;
 
  /* The maildir specification requires that all files in the cur
   * subdirectory have the :unique string appended, regardless of whether
   * or not there are any flags.  If .old is set, we know that this message
   * will end up in the cur directory, so we include it in the following
   * test even though there is no associated flag.  */
 
  if (e->flagged || e->replied || e->read || e->deleted || e->old || flags)
  {
    char tmp[1024] = { 0 };
    snprintf(tmp, sizeof(tmp), "%s%s%s%s%s", e->flagged ? "F" : "", e->replied ? "R" : "",
             e->read ? "S" : "", e->deleted ? "T" : "", NONULL(flags));
    if (flags)
      mutt_qsort_r(tmp, strlen(tmp), 1, maildir_sort_flags, NULL);
 
    const char c_maildir_field_delimiter = *cc_maildir_field_delimiter();
    snprintf(dest, destlen, "%c2,%s", c_maildir_field_delimiter, tmp);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_open_find_message_dir()

FILE * maildir_open_find_message_dir ( const char * folder, const char * unique, const char * subfolder, char ** newname )

static

Find a message in a maildir folder.

Parameters

[in]	folder	Base folder
[in]	unique	Unique part of filename
[in]	subfolder	Subfolder to search, e.g. 'cur'
[out]	newname	File's new name

Return values

ptr	File handle

These functions try to find a message in a maildir folder when it has moved under our feet. Note that this code is rather expensive, but then again, it's called rarely.

Definition at line 112 of file message.c.

{
  struct Buffer *dirname = buf_pool_get();
  struct Buffer *tunique = buf_pool_get();
  struct Buffer *fname = buf_pool_get();
 
  struct dirent *de = NULL;
 
  FILE *fp = NULL;
  int oe = ENOENT;
 
  buf_printf(dirname, "%s/%s", folder, subfolder);
 
  DIR *dir = mutt_file_opendir(buf_string(dirname), MUTT_OPENDIR_CREATE);
  if (!dir)
  {
    errno = ENOENT;
    goto cleanup;
  }
 
  while ((de = readdir(dir)))
  {
    maildir_canon_filename(tunique, de->d_name);
 
    if (mutt_str_equal(buf_string(tunique), unique))
    {
      buf_printf(fname, "%s/%s/%s", folder, subfolder, de->d_name);
      fp = mutt_file_fopen(buf_string(fname), "r");
      oe = errno;
      break;
    }
  }
 
  closedir(dir);
 
  if (newname && fp)
    *newname = buf_strdup(fname);
 
  errno = oe;
 
cleanup:
  buf_pool_release(&dirname);
  buf_pool_release(&tunique);
  buf_pool_release(&fname);
 
  return fp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_open_find_message()

FILE * maildir_open_find_message	(	const char *	folder,
		const char *	msg,
		char **	newname )

Find a message by name.

Parameters

[in]	folder	Maildir path
[in]	msg	Email path
[out]	newname	New name, if it has moved

Return values

ptr	File handle

Definition at line 168 of file message.c.

{
  static unsigned int new_hits = 0;
  static unsigned int cur_hits = 0; /* simple dynamic optimization */
 
  struct Buffer *unique = buf_pool_get();
  maildir_canon_filename(unique, msg);
 
  /* Prevent counter saturation by halving both when either gets large */
  if ((new_hits > (UINT_MAX / 2)) || (cur_hits > (UINT_MAX / 2)))
  {
    new_hits /= 2;
    cur_hits /= 2;
  }
 
  FILE *fp = maildir_open_find_message_dir(folder, buf_string(unique),
                                           (new_hits > cur_hits) ? "new" : "cur", newname);
  if (fp || (errno != ENOENT))
  {
    if (new_hits > cur_hits)
      new_hits++;
    else
      cur_hits++;
 
    goto cleanup;
  }
  fp = maildir_open_find_message_dir(folder, buf_string(unique),
                                     (new_hits > cur_hits) ? "cur" : "new", newname);
  if (fp || (errno != ENOENT))
  {
    if (new_hits > cur_hits)
      cur_hits++;
    else
      new_hits++;
 
    goto cleanup;
  }
 
  fp = NULL;
 
cleanup:
  buf_pool_release(&unique);
 
  return fp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_sync_message()

int maildir_sync_message ( struct Mailbox * m, struct Email * e )

static

Sync an email to a Maildir folder.

Parameters

m	Mailbox
e	Email

Return values

0	Success
-1	Error

Definition at line 221 of file message.c.

{
  if (!m || !e)
    return -1;
 
  struct Buffer *newpath = NULL;
  struct Buffer *partpath = NULL;
  struct Buffer *fullpath = NULL;
  struct Buffer *oldpath = NULL;
  char suffix[PATH_MAX] = { 0 };
  int rc = 0;
 
  if (e->attach_del || e->env->changed)
  {
    /* when doing attachment deletion/rethreading, fall back to the maildir case. */
    if (maildir_rewrite_message(m, e) != 0)
      return -1;
    e->env->changed = false;
  }
  else
  {
    /* we just have to rename the file. */
 
    char *p = strrchr(e->path, '/');
    if (!p)
    {
      mutt_debug(LL_DEBUG1, "%s: unable to find subdir!\n", e->path);
      return -1;
    }
    p++;
    newpath = buf_pool_get();
    partpath = buf_pool_get();
    fullpath = buf_pool_get();
    oldpath = buf_pool_get();
 
    buf_strcpy(newpath, p);
 
    /* kill the previous flags */
    const char c_maildir_field_delimiter = *cc_maildir_field_delimiter();
    p = strchr(newpath->data, c_maildir_field_delimiter);
    if (p)
    {
      *p = '\0';
      newpath->dptr = p; /* fix buffer up, just to be safe */
    }
 
    maildir_gen_flags(suffix, sizeof(suffix), e);
 
    buf_printf(partpath, "%s/%s%s", (e->read || e->old) ? "cur" : "new",
               buf_string(newpath), suffix);
    buf_printf(fullpath, "%s/%s", mailbox_path(m), buf_string(partpath));
    buf_printf(oldpath, "%s/%s", mailbox_path(m), e->path);
 
    if (mutt_str_equal(buf_string(fullpath), buf_string(oldpath)))
    {
      /* message hasn't really changed */
      goto cleanup;
    }
 
    /* record that the message is possibly marked as trashed on disk */
    e->trash = e->deleted;
 
    struct stat st = { 0 };
    if (stat(buf_string(oldpath), &st) == -1)
    {
      mutt_debug(LL_DEBUG1, "File already removed (just continuing)\n");
      goto cleanup;
    }
 
    if (rename(buf_string(oldpath), buf_string(fullpath)) != 0)
    {
      mutt_perror("rename");
      rc = -1;
      goto cleanup;
    }
    mutt_str_replace(&e->path, buf_string(partpath));
  }
 
cleanup:
  buf_pool_release(&newpath);
  buf_pool_release(&partpath);
  buf_pool_release(&fullpath);
  buf_pool_release(&oldpath);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_sync_mailbox_message()

bool maildir_sync_mailbox_message	(	struct Mailbox *	m,
		struct Email *	e,
		struct HeaderCache *	hc )

Save changes to the mailbox.

Parameters

m	Mailbox
e	Email
hc	Header cache handle

Return values

true	Success
false	Error

Definition at line 316 of file message.c.

{
  if (!e)
    return false;
 
  const bool c_maildir_trash = cs_subset_bool(NeoMutt->sub, "maildir_trash");
  if (e->deleted && !c_maildir_trash)
  {
    char path[PATH_MAX] = { 0 };
    snprintf(path, sizeof(path), "%s/%s", mailbox_path(m), e->path);
    maildir_hcache_delete(hc, e);
    unlink(path);
  }
  else if (e->changed || e->attach_del ||
           ((c_maildir_trash || e->trash) && (e->deleted != e->trash)))
  {
    if (maildir_sync_message(m, e) == -1)
      return false;
  }
 
  if (e->changed)
    maildir_hcache_store(hc, e);
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_commit_message()

int maildir_commit_message ( struct Mailbox * m, struct Message * msg, struct Email * e )

static

Commit a message to a maildir folder.

Parameters

m	Mailbox
msg	Message to commit
e	Email

Return values

0	Success
-1	Failure

msg->path contains the file name of a file in tmp/. We take the flags from this file's name.

m is the mail folder we commit to.

e is a header structure to which we write the message's new file name. This is used in the maildir folder sync routines. When this routine is invoked from mx_msg_commit(), e is NULL.

msg->path looks like this:

tmp/{cur,new}.neomutt-HOSTNAME-PID-COUNTER:flags

See also maildir_msg_open_new().

Definition at line 365 of file message.c.

{
  char subdir[4] = { 0 };
  char suffix[PATH_MAX] = { 0 };
  int rc = 0;
 
  if (mutt_file_fsync_close(&msg->fp))
  {
    mutt_perror(_("Could not flush message to disk"));
    return -1;
  }
 
  /* extract the subdir */
  char *s = strrchr(msg->path, '/');
  if (!s)
  {
    mutt_debug(LL_DEBUG1, "path '%s' lacks expected '/'\n", msg->path);
    return -1;
  }
  s++;
  mutt_str_copy(subdir, s, 4);
 
  /* extract the flags */
  const char c_maildir_field_delimiter = *cc_maildir_field_delimiter();
  s = strchr(s, c_maildir_field_delimiter);
  if (s)
    mutt_str_copy(suffix, s, sizeof(suffix));
  else
    suffix[0] = '\0';
 
  /* construct a new file name. */
  struct Buffer *path = buf_pool_get();
  struct Buffer *full = buf_pool_get();
  for (int retries = 0; retries < 16; retries++)
  {
    buf_printf(path, "%s/%lld.R%" PRIu64 ".%s%s", subdir, (long long) mutt_date_now(),
               mutt_rand64(), NONULL(ShortHostname), suffix);
    buf_printf(full, "%s/%s", mailbox_path(m), buf_string(path));
 
    mutt_debug(LL_DEBUG2, "renaming %s to %s\n", msg->path, buf_string(full));
 
    if (mutt_file_safe_rename(msg->path, buf_string(full)) == 0)
    {
      /* Adjust the mtime on the file to match the time at which this
       * message was received.  Currently this is only set when copying
       * messages between mailboxes, so we test to ensure that it is
       * actually set.  */
      if (msg->received != 0)
      {
        struct utimbuf ut = { 0 };
        int rc_utime;
 
        ut.actime = msg->received;
        ut.modtime = msg->received;
        do
        {
          rc_utime = utime(buf_string(full), &ut);
        } while ((rc_utime == -1) && (errno == EINTR));
        if (rc_utime == -1)
        {
          mutt_perror(_("maildir_commit_message(): unable to set time on file"));
          rc = -1;
          goto cleanup;
        }
      }
 
#ifdef USE_NOTMUCH
      if (m->type == MUTT_NOTMUCH)
        nm_update_filename(m, e->path, buf_string(full), e);
#endif
      if (e)
        mutt_str_replace(&e->path, buf_string(path));
      mutt_str_replace(&msg->committed_path, buf_string(full));
      FREE(&msg->path);
 
      goto cleanup;
    }
    else if (errno != EEXIST)
    {
      mutt_perror("%s", mailbox_path(m));
      rc = -1;
      goto cleanup;
    }
  }
 
  /* All retries exhausted */
  mutt_debug(LL_DEBUG1, "failed after 16 retries\n");
  rc = -1;
 
cleanup:
  buf_pool_release(&path);
  buf_pool_release(&full);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

maildir_rewrite_message()

int maildir_rewrite_message	(	struct Mailbox *	m,
		struct Email *	e )

Sync a message in an Maildir folder.

Parameters

m	Mailbox
e	Email

Return values

0	Success
-1	Error

Definition at line 468 of file message.c.

{
  if (!m || !e)
    return -1;
 
  bool restore = true;
 
  long old_body_offset = e->body->offset;
  long old_body_length = e->body->length;
  long old_hdr_lines = e->lines;
 
  struct Message *src = mx_msg_open(m, e);
  struct Message *dest = mx_msg_open_new(m, e, MUTT_MSG_NONE);
  if (!src || !dest)
  {
    mx_msg_close(m, &src);
    mx_msg_close(m, &dest);
    return -1;
  }
 
  int rc = mutt_copy_message(dest->fp, e, src, MUTT_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN, 0);
  if (rc == 0)
  {
    char oldpath[PATH_MAX] = { 0 };
    char partpath[PATH_MAX] = { 0 };
    snprintf(oldpath, sizeof(oldpath), "%s/%s", mailbox_path(m), e->path);
    mutt_str_copy(partpath, e->path, sizeof(partpath));
 
    rc = maildir_commit_message(m, dest, e);
 
    if (rc == 0)
    {
      unlink(oldpath);
      restore = false;
    }
  }
  mx_msg_close(m, &src);
  mx_msg_close(m, &dest);
 
  if ((rc == -1) && restore)
  {
    e->body->offset = old_body_offset;
    e->body->length = old_body_length;
    e->lines = old_hdr_lines;
  }
 
  mutt_body_free(&e->body->parts);
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function: