cid.h File Reference

Attachment Content-ID header functions. More...

#include "config.h"
#include "mutt/lib.h"

Include dependency graph for cid.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	CidMap
	List of Content-ID to filename mappings. More...

Functions
	STAILQ_HEAD (CidMapList, CidMap)
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.
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.h.

Function Documentation

STAILQ_HEAD()

STAILQ_HEAD	(	CidMapList	,
		CidMap
	)

cid_map_free()

void cid_map_free

(

struct CidMap **

ptr

)

Free a CidMap.

Parameters

[out]

ptr

CidMap to free

Definition at line 46 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 65 of file cid.c.

{
  if (!cid || !filename)
    return NULL;
 
  struct CidMap *cid_map = mutt_mem_calloc(1, sizeof(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 82 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_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 151 of file cid.c.

{
  if (!body || !cid_map_list)
    return;
 
  for (struct Body *b = body; b; b = b->next)
  {
    if (b->parts)
      cid_save_attachments(b->parts, cid_map_list);
    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_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 170 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 *tmpfile = 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 tmpfile 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(tmpfile, "neomutt", suffix);
  else
    buf_mktemp(tmpfile);
  fp_out = mutt_file_fopen(buf_string(tmpfile), "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(tmpfile));
 
  /* 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, tmpfile);
 
bail:
  FREE(&buf);
  mutt_file_fclose(&fp_in);
  mutt_file_fclose(&fp_out);
  buf_pool_release(&tmpfile);
  buf_pool_release(&tmpbuf);
}

Here is the call graph for this function:

Here is the caller graph for this function: