body.c File Reference

Write a MIME Email Body to a file. More...

#include "config.h"
#include <stdbool.h>
#include "mutt/lib.h"
#include "email/lib.h"
#include "body.h"
#include "ncrypt/lib.h"
#include "header.h"
#include "muttlib.h"

Include dependency graph for body.c:

Go to the source code of this file.

Data Structures
struct	B64Context
	Cursor for the Base64 conversion. More...

Functions
static void	b64_flush (struct B64Context *bctx, FILE *fp_out)
	Save the bytes to the file.
static void	b64_putc (struct B64Context *bctx, char c, FILE *fp_out)
	Base64-encode one character.
static void	encode_base64 (struct FgetConv *fc, FILE *fp_out, int istext)
	Base64-encode some data.
static void	encode_8bit (struct FgetConv *fc, FILE *fp_out)
	Write the data as raw 8-bit data.
static void	encode_quoted (struct FgetConv *fc, FILE *fp_out, bool istext)
	Encode text as quoted printable.
static bool	write_as_text_part (struct Body *b)
	Should the Body be written as a text MIME part.
int	mutt_write_mime_body (struct Body *b, FILE *fp, struct ConfigSubset *sub)
	Write a MIME part.

Detailed Description

Write a MIME Email Body to a file.

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

Function Documentation

b64_flush()

static void b64_flush ( struct B64Context * bctx, FILE * fp_out )

static

Save the bytes to the file.

Parameters

bctx	Cursor for the base64 conversion
fp_out	File to save the output

Definition at line 53 of file body.c.

{
  /* for some reasons, mutt_b64_encode expects the
   * output buffer to be larger than 10B */
  char encoded[11] = { 0 };
  size_t rc;
 
  if (bctx->size == 0)
    return;
 
  if (bctx->linelen >= 72)
  {
    fputc('\n', fp_out);
    bctx->linelen = 0;
  }
 
  /* rc should always be equal to 4 here, because bctx->size
   * is a value between 1 and 3 (included), but let's not hardcode it
   * and prefer the return value of the function */
  rc = mutt_b64_encode(bctx->buffer, bctx->size, encoded, sizeof(encoded));
  for (size_t i = 0; i < rc; i++)
  {
    fputc(encoded[i], fp_out);
    bctx->linelen++;
  }
 
  bctx->size = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

b64_putc()

static void b64_putc ( struct B64Context * bctx, char c, FILE * fp_out )

static

Base64-encode one character.

Parameters

bctx	Cursor for the base64 conversion
c	Character to encode
fp_out	File to save the output

Definition at line 88 of file body.c.

{
  if (bctx->size == 3)
    b64_flush(bctx, fp_out);
 
  bctx->buffer[bctx->size++] = c;
}

Here is the call graph for this function:

Here is the caller graph for this function:

encode_base64()

static void encode_base64 ( struct FgetConv * fc, FILE * fp_out, int istext )

static

Base64-encode some data.

Parameters

fc	Cursor for converting a file's encoding
fp_out	File to store the result
istext	Is the input text?

Definition at line 102 of file body.c.

{
  struct B64Context bctx = { 0 };
  int ch;
  int ch1 = EOF;
 
  while ((ch = mutt_ch_fgetconv(fc)) != EOF)
  {
    if (SigInt)
    {
      SigInt = false;
      return;
    }
    if (istext && (ch == '\n') && (ch1 != '\r'))
      b64_putc(&bctx, '\r', fp_out);
    b64_putc(&bctx, ch, fp_out);
    ch1 = ch;
  }
  b64_flush(&bctx, fp_out);
  fputc('\n', fp_out);
}

Here is the call graph for this function:

Here is the caller graph for this function:

encode_8bit()

static void encode_8bit ( struct FgetConv * fc, FILE * fp_out )

static

Write the data as raw 8-bit data.

Parameters

fc	Cursor for converting a file's encoding
fp_out	File to store the result

Definition at line 129 of file body.c.

{
  int ch;
 
  while ((ch = mutt_ch_fgetconv(fc)) != EOF)
  {
    if (SigInt)
    {
      SigInt = false;
      return;
    }
    fputc(ch, fp_out);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

encode_quoted()

static void encode_quoted ( struct FgetConv * fc, FILE * fp_out, bool istext )

static

Encode text as quoted printable.

Parameters

fc	Cursor for converting a file's encoding
fp_out	File to store the result
istext	Is the input text?

Definition at line 150 of file body.c.

{
  int c;
  int linelen = 0;
  char line[77] = { 0 };
 
  while ((c = mutt_ch_fgetconv(fc)) != EOF)
  {
    /* Wrap the line if needed. */
    if ((linelen == 76) && ((istext && (c != '\n')) || !istext))
    {
      /* If the last character is "quoted", then be sure to move all three
       * characters to the next line.  Otherwise, just move the last
       * character...  */
      if (line[linelen - 3] == '=')
      {
        line[linelen - 3] = 0;
        fputs(line, fp_out);
        fputs("=\n", fp_out);
        line[linelen] = 0;
        line[0] = '=';
        line[1] = line[linelen - 2];
        line[2] = line[linelen - 1];
        linelen = 3;
      }
      else
      {
        char savechar = line[linelen - 1];
        line[linelen - 1] = '=';
        line[linelen] = 0;
        fputs(line, fp_out);
        fputc('\n', fp_out);
        line[0] = savechar;
        linelen = 1;
      }
    }
 
    /* Escape lines that begin with/only contain "the message separator". */
    if ((linelen == 4) && mutt_str_startswith(line, "From"))
    {
      mutt_str_copy(line, "=46rom", sizeof(line));
      linelen = 6;
    }
    else if ((linelen == 4) && mutt_str_startswith(line, "from"))
    {
      mutt_str_copy(line, "=66rom", sizeof(line));
      linelen = 6;
    }
    else if ((linelen == 1) && (line[0] == '.'))
    {
      mutt_str_copy(line, "=2E", sizeof(line));
      linelen = 3;
    }
 
    if ((c == '\n') && istext)
    {
      /* Check to make sure there is no trailing space on this line. */
      if ((linelen > 0) && ((line[linelen - 1] == ' ') || (line[linelen - 1] == '\t')))
      {
        if (linelen < 74)
        {
          snprintf(line + linelen - 1, sizeof(line) - (linelen - 1), "=%2.2X",
                   (unsigned char) line[linelen - 1]);
          fputs(line, fp_out);
        }
        else
        {
          int savechar2 = line[linelen - 1];
 
          line[linelen - 1] = '=';
          line[linelen] = 0;
          fputs(line, fp_out);
          fprintf(fp_out, "\n=%2.2X", (unsigned char) savechar2);
        }
      }
      else
      {
        line[linelen] = 0;
        fputs(line, fp_out);
      }
      fputc('\n', fp_out);
      linelen = 0;
    }
    else if ((c != 9) && ((c < 32) || (c > 126) || (c == '=')))
    {
      /* Check to make sure there is enough room for the quoted character.
       * If not, wrap to the next line.  */
      if (linelen > 73)
      {
        line[linelen++] = '=';
        line[linelen] = 0;
        fputs(line, fp_out);
        fputc('\n', fp_out);
        linelen = 0;
      }
      snprintf(line + linelen, sizeof(line) - linelen, "=%2.2X", (unsigned char) c);
      linelen += 3;
    }
    else
    {
      /* Don't worry about wrapping the line here.  That will happen during
       * the next iteration when I'll also know what the next character is.  */
      line[linelen++] = c;
    }
  }
 
  /* Take care of anything left in the buffer */
  if (linelen > 0)
  {
    if ((line[linelen - 1] == ' ') || (line[linelen - 1] == '\t'))
    {
      /* take care of trailing whitespace */
      if (linelen < 74)
      {
        snprintf(line + linelen - 1, sizeof(line) - (linelen - 1), "=%2.2X",
                 (unsigned char) line[linelen - 1]);
      }
      else
      {
        char savechar = line[linelen - 1];
        line[linelen - 1] = '=';
        line[linelen] = 0;
        fputs(line, fp_out);
        fputc('\n', fp_out);
        snprintf(line, sizeof(line), "=%2.2X", (unsigned char) savechar);
      }
    }
    else
    {
      line[linelen] = 0;
    }
    fputs(line, fp_out);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

write_as_text_part()

static bool write_as_text_part ( struct Body * b )

static

Should the Body be written as a text MIME part.

Parameters

b	Email to examine

Return values

true	The Body should be written as text

Definition at line 290 of file body.c.

{
  return mutt_is_text_part(b) ||
         (((WithCrypto & APPLICATION_PGP) != 0) && mutt_is_application_pgp(b));
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_write_mime_body()

int mutt_write_mime_body	(	struct Body *	b,
		FILE *	fp,
		struct ConfigSubset *	sub )

Write a MIME part.

Parameters

b	Body to use
fp	File to write to
sub	Config Subset

Return values

0	Success
-1	Failure

Definition at line 304 of file body.c.

{
  FILE *fp_in = NULL;
  struct FgetConv *fc = NULL;
 
  if (b->type == TYPE_MULTIPART)
  {
    /* First, find the boundary to use */
    const char *p = mutt_param_get(&b->parameter, "boundary");
    if (!p)
    {
      mutt_debug(LL_DEBUG1, "no boundary parameter found\n");
      mutt_error(_("No boundary parameter found [report this error]"));
      return -1;
    }
    char boundary[128] = { 0 };
    mutt_str_copy(boundary, p, sizeof(boundary));
 
    for (struct Body *t = b->parts; t; t = t->next)
    {
      fprintf(fp, "\n--%s\n", boundary);
      if (mutt_write_mime_header(t, fp, sub) == -1)
        return -1;
      fputc('\n', fp);
      if (mutt_write_mime_body(t, fp, sub) == -1)
        return -1;
    }
    fprintf(fp, "\n--%s--\n", boundary);
    return ferror(fp) ? -1 : 0;
  }
 
  /* This is pretty gross, but it's the best solution for now... */
  if (((WithCrypto & APPLICATION_PGP) != 0) && (b->type == TYPE_APPLICATION) &&
      mutt_str_equal(b->subtype, "pgp-encrypted") && !b->filename)
  {
    fputs("Version: 1\n", fp);
    return 0;
  }
 
  fp_in = mutt_file_fopen(b->filename, "r");
  if (!fp_in)
  {
    mutt_debug(LL_DEBUG1, "%s no longer exists\n", NONULL(b->filename));
    mutt_error(_("%s no longer exists"), NONULL(b->filename));
    return -1;
  }
 
  if ((b->type == TYPE_TEXT) && (!b->noconv))
  {
    char send_charset[128] = { 0 };
    fc = mutt_ch_fgetconv_open(fp_in, b->charset,
                               mutt_body_get_charset(b, send_charset, sizeof(send_charset)),
                               MUTT_ICONV_NONE);
  }
  else
  {
    fc = mutt_ch_fgetconv_open(fp_in, 0, 0, MUTT_ICONV_NONE);
  }
 
  mutt_sig_allow_interrupt(true);
  if (b->encoding == ENC_QUOTED_PRINTABLE)
    encode_quoted(fc, fp, write_as_text_part(b));
  else if (b->encoding == ENC_BASE64)
    encode_base64(fc, fp, write_as_text_part(b));
  else if ((b->type == TYPE_TEXT) && (!b->noconv))
    encode_8bit(fc, fp);
  else
    mutt_file_copy_stream(fp_in, fp);
  mutt_sig_allow_interrupt(false);
 
  mutt_ch_fgetconv_close(&fc);
  mutt_file_fclose(&fp_in);
 
  if (SigInt)
  {
    SigInt = false;
    return -1;
  }
  return ferror(fp) ? -1 : 0;
}

Here is the call graph for this function:

Here is the caller graph for this function: