cid.c File Reference

Attachment Content-ID header functions. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include "email/lib.h"
#include "core/lib.h"
#include "cid.h"
#include "attach.h"
#include "mutt_attach.h"

Include dependency graph for cid.c:

Go to the source code of this file.

Macros
#define	CID_DEPTH_MAX   50
	Maximum MIME nesting depth for saving CID attachments.

Functions
void	cid_map_free (struct CidMap **ptr)
	Free a CidMap.
struct CidMap *	cid_map_new (const char *cid, const char *filename)
	Initialise a new CidMap.
void	cid_map_list_clear (struct CidMapList *cid_map_list)
	Empty a CidMapList.
static void	cid_save_attachment (struct Body *b, struct CidMapList *cid_map_list)
	Save attachment if it has a Content-ID.
static void	cid_save_attachments_r (struct Body *body, struct CidMapList *cid_map_list, int depth)
	Recursively save attachments with Content-IDs.
void	cid_save_attachments (struct Body *body, struct CidMapList *cid_map_list)
	Save all attachments in a "multipart/related" group with a Content-ID.
void	cid_to_filename (struct Buffer *filename, const struct CidMapList *cid_map_list)
	Replace Content-IDs with filenames.

Detailed Description

Attachment Content-ID header functions.

Authors

• David Purton
• 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 cid.c.

Macro Definition Documentation

CID_DEPTH_MAX

#define CID_DEPTH_MAX   50

Maximum MIME nesting depth for saving CID attachments.

Definition at line 145 of file cid.c.

Function Documentation

cid_map_free()

void cid_map_free

(

struct CidMap **

ptr

)

Free a CidMap.

Parameters

[out]

ptr

CidMap to free

Definition at line 44 of file cid.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct CidMap *cid_map = *ptr;
 
  FREE(&cid_map->cid);
  FREE(&cid_map->fname);
 
  FREE(ptr);
}

Here is the caller graph for this function:

cid_map_new()

struct CidMap * cid_map_new	(	const char *	cid,
		const char *	filename )

Initialise a new CidMap.

Parameters

cid	Content-ID to replace including "cid:" prefix
filename	Path to file to replace Content-ID with

Return values

ptr	Newly allocated CidMap

Definition at line 63 of file cid.c.

{
  if (!cid || !filename)
    return NULL;
 
  struct CidMap *cid_map = MUTT_MEM_CALLOC(1, struct CidMap);
 
  cid_map->cid = mutt_str_dup(cid);
  cid_map->fname = mutt_str_dup(filename);
 
  return cid_map;
}

Here is the call graph for this function:

Here is the caller graph for this function:

cid_map_list_clear()

void cid_map_list_clear

(

struct CidMapList *

cid_map_list

)

Empty a CidMapList.

Parameters

cid_map_list

List of Content-ID to filename mappings

Definition at line 80 of file cid.c.

{
  if (!cid_map_list)
    return;
 
  while (!STAILQ_EMPTY(cid_map_list))
  {
    struct CidMap *cid_map = STAILQ_FIRST(cid_map_list);
    STAILQ_REMOVE_HEAD(cid_map_list, entries);
    cid_map_free(&cid_map);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

cid_save_attachment()

static void cid_save_attachment ( struct Body * b, struct CidMapList * cid_map_list )

static

Save attachment if it has a Content-ID.

Parameters

[in]	b	Body to check and save
[out]	cid_map_list	List of Content-ID to filename mappings

If body has a Content-ID, it is saved to disk and a new Content-ID to filename mapping is added to cid_map_list.

Definition at line 101 of file cid.c.

{
  if (!b || !cid_map_list)
    return;
 
  char *id = b->content_id;
  if (!id)
    return;
 
  struct Buffer *tempfile = buf_pool_get();
  struct Buffer *cid = buf_pool_get();
  bool has_tempfile = false;
  FILE *fp = NULL;
 
  mutt_debug(LL_DEBUG2, "attachment found with \"Content-ID: %s\"\n", id);
  /* get filename */
  char *fname = mutt_str_dup(b->filename);
  if (b->aptr)
    fp = b->aptr->fp;
  mutt_file_sanitize_filename(fname, fp ? true : false);
  mailcap_expand_filename("%s", fname, tempfile);
  FREE(&fname);
 
  /* save attachment */
  if (mutt_save_attachment(fp, b, buf_string(tempfile), 0, NULL) == -1)
    goto bail;
  has_tempfile = true;
  mutt_debug(LL_DEBUG2, "attachment with \"Content-ID: %s\" saved to file \"%s\"\n",
             id, buf_string(tempfile));
 
  /* add Content-ID to filename mapping to list */
  buf_printf(cid, "cid:%s", id);
  struct CidMap *cid_map = cid_map_new(buf_string(cid), buf_string(tempfile));
  STAILQ_INSERT_TAIL(cid_map_list, cid_map, entries);
 
bail:
 
  if ((fp && !buf_is_empty(tempfile)) || has_tempfile)
    mutt_add_temp_attachment(buf_string(tempfile));
  buf_pool_release(&tempfile);
  buf_pool_release(&cid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cid_save_attachments_r()

static void cid_save_attachments_r ( struct Body * body, struct CidMapList * cid_map_list, int depth )

static

Recursively save attachments with Content-IDs.

Parameters

[in]	body	First body in "multipart/related" group
[out]	cid_map_list	List of Content-ID to filename mappings
[in]	depth	Current recursion depth

Definition at line 153 of file cid.c.

{
  if (!body || !cid_map_list || (depth >= CID_DEPTH_MAX))
    return;
 
  for (struct Body *b = body; b; b = b->next)
  {
    if (b->parts)
      cid_save_attachments_r(b->parts, cid_map_list, depth + 1);
    else
      cid_save_attachment(b, cid_map_list);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

cid_save_attachments()

void cid_save_attachments	(	struct Body *	body,
		struct CidMapList *	cid_map_list )

Save all attachments in a "multipart/related" group with a Content-ID.

Parameters

[in]	body	First body in "multipart/related" group
[out]	cid_map_list	List of Content-ID to filename mappings

Definition at line 172 of file cid.c.

{
  cid_save_attachments_r(body, cid_map_list, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

cid_to_filename()

void cid_to_filename	(	struct Buffer *	filename,
		const struct CidMapList *	cid_map_list )

Replace Content-IDs with filenames.

Parameters

filename	Path to file to replace Content-IDs with filenames
cid_map_list	List of Content-ID to filename mappings

Definition at line 182 of file cid.c.

{
  if (!filename || !cid_map_list)
    return;
 
  FILE *fp_out = NULL;
  char *pbuf = NULL;
  char *searchbuf = NULL;
  char *buf = NULL;
  char *cid = NULL;
  size_t blen = 0;
  struct CidMap *cid_map = NULL;
 
  struct Buffer *tempfile = buf_pool_get();
  struct Buffer *tmpbuf = buf_pool_get();
 
  FILE *fp_in = mutt_file_fopen(buf_string(filename), "r");
  if (!fp_in)
    goto bail;
 
  /* ensure tempfile has the same file extension as filename otherwise an
   * HTML file may be opened as plain text by the viewer */
  const char *suffix = buf_rfind(filename, ".");
  if (suffix && *(suffix++))
    buf_mktemp_pfx_sfx(tempfile, "neomutt", suffix);
  else
    buf_mktemp(tempfile);
  fp_out = mutt_file_fopen(buf_string(tempfile), "w+");
  if (!fp_out)
    goto bail;
 
  /* Read in lines from filename into buf */
  while ((buf = mutt_file_read_line(buf, &blen, fp_in, NULL, MUTT_RL_NO_FLAGS)) != NULL)
  {
    if (mutt_str_len(buf) == 0)
    {
      fputs(buf, fp_out);
      continue;
    }
 
    /* copy buf to searchbuf because we need to edit multiple times */
    searchbuf = mutt_str_dup(buf);
    buf_reset(tmpbuf);
 
    /* loop through Content-ID to filename mappings and do search and replace */
    STAILQ_FOREACH(cid_map, cid_map_list, entries)
    {
      pbuf = searchbuf;
      while ((cid = strstr(pbuf, cid_map->cid)) != NULL)
      {
        buf_addstr_n(tmpbuf, pbuf, cid - pbuf);
        buf_addstr(tmpbuf, cid_map->fname);
        pbuf = cid + mutt_str_len(cid_map->cid);
        mutt_debug(LL_DEBUG2, "replaced \"%s\" with \"%s\" in file \"%s\"\n",
                   cid_map->cid, cid_map->fname, buf_string(filename));
      }
      buf_addstr(tmpbuf, pbuf);
      FREE(&searchbuf);
      searchbuf = buf_strdup(tmpbuf);
      buf_reset(tmpbuf);
    }
 
    /* write edited line to output file */
    fputs(searchbuf, fp_out);
    fputs("\n", fp_out);
    FREE(&searchbuf);
  }
 
  mutt_file_set_mtime(buf_string(filename), buf_string(tempfile));
 
  /* add filename to TempAtachmentsList so it doesn't get left lying around */
  mutt_add_temp_attachment(buf_string(filename));
  /* update filename to point to new file */
  buf_copy(filename, tempfile);
 
bail:
  FREE(&buf);
  mutt_file_fclose(&fp_in);
  mutt_file_fclose(&fp_out);
  buf_pool_release(&tempfile);
  buf_pool_release(&tmpbuf);
}

Here is the call graph for this function:

Here is the caller graph for this function: