rfc2047.c File Reference

RFC2047 MIME extensions encoding / decoding routines. More...

#include "config.h"
#include <errno.h>
#include <iconv.h>
#include <stdbool.h>
#include <string.h>
#include "mutt/lib.h"
#include "address/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "rfc2047.h"
#include "envelope.h"
#include "mime.h"

Include dependency graph for rfc2047.c:

Go to the source code of this file.

Macros
#define	ENCWORD_LEN_MAX   75
	Maximum length of an RFC2047 encoded word (75 chars per RFC2047).
#define	ENCWORD_LEN_MIN   9 /* strlen ("=?.?.?.?=") */
	Minimum length of an RFC2047 encoded word ("=?.?.?.?=" = 9 chars).
#define	HSPACE(ch)
	Check if character is horizontal whitespace (space, tab, or null).
#define	CONTINUATION_BYTE(ch)
	Check if a byte is a UTF-8 continuation byte (10xxxxxx pattern).

Typedefs
typedef size_t(*	encoder_t) (char *res, const char *buf, size_t buflen, const char *tocode)

Functions
static size_t	b_encoder (char *res, const char *src, size_t srclen, const char *tocode)
	Base64 Encode a string - Implements encoder_t -.
static size_t	q_encoder (char *res, const char *src, size_t srclen, const char *tocode)
	Quoted-printable Encode a string - Implements encoder_t -.
static char *	parse_encoded_word (char *str, enum ContentEncoding *enc, char **charset, size_t *charsetlen, char **text, size_t *textlen)
	Parse a string and report RFC2047 elements.
static size_t	try_block (const char *d, size_t dlen, const char *fromcode, const char *tocode, encoder_t *encoder, size_t *wlen)
	Attempt to convert a block of text.
static size_t	encode_block (char *str, char *buf, size_t buflen, const char *fromcode, const char *tocode, encoder_t encoder)
	Encode a block of text using an encoder.
static size_t	choose_block (char *d, size_t dlen, int col, const char *fromcode, const char *tocode, encoder_t *encoder, size_t *wlen)
	Calculate how much data can be converted.
static void	finalize_chunk (struct Buffer *res, struct Buffer *buf, char *charset, size_t charsetlen)
	Perform charset conversion and filtering.
static char *	decode_word (const char *s, size_t len, enum ContentEncoding enc)
	Decode an RFC2047-encoded string.
static int	encode (const char *d, size_t dlen, int col, const char *fromcode, const struct Slist *charsets, char **e, size_t *elen, const char *specials)
	RFC2047-encode a string.
void	rfc2047_encode (char **pd, const char *specials, int col, const struct Slist *charsets)
	RFC-2047-encode a string.
void	rfc2047_decode (char **pd)
	Decode any RFC2047-encoded header fields.
void	rfc2047_encode_addrlist (struct AddressList *al, const char *tag)
	Encode any RFC2047 headers, where required, in an Address list.
void	rfc2047_decode_addrlist (struct AddressList *al)
	Decode any RFC2047 headers in an Address list.
void	rfc2047_decode_envelope (struct Envelope *env)
	Decode the fields of an Envelope.
void	rfc2047_encode_envelope (struct Envelope *env)
	Encode the fields of an Envelope.

Variables
static const char	RFC2047Specials [] = "@.,;:<>[]\\\"()?/= \t"

Detailed Description

RFC2047 MIME extensions encoding / decoding routines.

Authors

• Federico Kircheis
• Pietro Cerutti
• Richard Russon
• Anna Figueiredo Gomes
• наб

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

Macro Definition Documentation

ENCWORD_LEN_MAX

#define ENCWORD_LEN_MAX   75

Maximum length of an RFC2047 encoded word (75 chars per RFC2047).

Definition at line 47 of file rfc2047.c.

ENCWORD_LEN_MIN

#define ENCWORD_LEN_MIN   9 /* strlen ("=?.?.?.?=") */

Minimum length of an RFC2047 encoded word ("=?.?.?.?=" = 9 chars).

Definition at line 49 of file rfc2047.c.

HSPACE

#define HSPACE

(

ch

)

Value:

(((ch) == '\0') || ((ch) == ' ') || ((ch) == '\t'))

Check if character is horizontal whitespace (space, tab, or null).

Definition at line 52 of file rfc2047.c.

CONTINUATION_BYTE

#define CONTINUATION_BYTE

(

ch

)

Value:

(((ch) & 0xc0) == 0x80)

Check if a byte is a UTF-8 continuation byte (10xxxxxx pattern).

Definition at line 55 of file rfc2047.c.

Typedef Documentation

encoder_t

typedef size_t(* encoder_t) (char *res, const char *buf, size_t buflen, const char *tocode)

Definition at line 68 of file rfc2047.c.

Function Documentation

parse_encoded_word()

char * parse_encoded_word ( char * str, enum ContentEncoding * enc, char ** charset, size_t * charsetlen, char ** text, size_t * textlen )

static

Parse a string and report RFC2047 elements.

Parameters

[in]	str	String to parse
[out]	enc	Content encoding found in the first RFC2047 word
[out]	charset	Charset found in the first RFC2047 word
[out]	charsetlen	Length of the charset string found
[out]	text	Start of the first RFC2047 encoded text
[out]	textlen	Length of the encoded text found

Return values

ptr	Start of the RFC2047 encoded word
NULL	None was found

Definition at line 155 of file rfc2047.c.

{
  regmatch_t *match = mutt_prex_capture(PREX_RFC2047_ENCODED_WORD, str);
  if (!match)
    return NULL;
 
  const regmatch_t *mfull = &match[PREX_RFC2047_ENCODED_WORD_MATCH_FULL];
  const regmatch_t *mcharset = &match[PREX_RFC2047_ENCODED_WORD_MATCH_CHARSET];
  const regmatch_t *mencoding = &match[PREX_RFC2047_ENCODED_WORD_MATCH_ENCODING];
  const regmatch_t *mtext = &match[PREX_RFC2047_ENCODED_WORD_MATCH_TEXT];
 
  /* Charset */
  *charset = str + mutt_regmatch_start(mcharset);
  *charsetlen = mutt_regmatch_len(mcharset);
 
  /* Encoding: either Q or B */
  *enc = (mutt_tolower(str[mutt_regmatch_start(mencoding)]) == 'q') ? ENC_QUOTED_PRINTABLE :
                                                                      ENC_BASE64;
 
  *text = str + mutt_regmatch_start(mtext);
  *textlen = mutt_regmatch_len(mtext);
  return str + mutt_regmatch_start(mfull);
}

Here is the call graph for this function:

Here is the caller graph for this function:

try_block()

size_t try_block ( const char * d, size_t dlen, const char * fromcode, const char * tocode, encoder_t * encoder, size_t * wlen )

static

Attempt to convert a block of text.

Parameters

d	String to convert
dlen	Length of string
fromcode	Original encoding
tocode	New encoding
encoder	Encoding function
wlen	Number of characters converted

Return values

0	Success, string converted
>0	Error, number of bytes that could be converted

If the data could be converted using encoder, then set *encoder and *wlen. Otherwise return an upper bound on the maximum length of the data which could be converted.

The data is converted from fromcode (which must be stateless) to tocode, unless fromcode is NULL, in which case the data is assumed to be already in tocode, which should be 8-bit and stateless.

Definition at line 199 of file rfc2047.c.

{
  char buf[ENCWORD_LEN_MAX - ENCWORD_LEN_MIN + 1] = { 0 };
  const char *ib = NULL;
  char *ob = NULL;
  size_t ibl = 0;
  size_t obl = 0;
  int count;
  int len;
  int len_b;
  int len_q;
 
  if (fromcode)
  {
    iconv_t cd = mutt_ch_iconv_open(tocode, fromcode, MUTT_ICONV_NONE);
    ASSERT(iconv_t_valid(cd));
    ib = d;
    ibl = dlen;
    ob = buf;
    obl = sizeof(buf) - strlen(tocode);
    if ((iconv(cd, (ICONV_CONST char **) &ib, &ibl, &ob, &obl) == ICONV_ILLEGAL_SEQ) ||
        (iconv(cd, NULL, NULL, &ob, &obl) == ICONV_ILLEGAL_SEQ))
    {
      ASSERT(errno == E2BIG);
      ASSERT(ib > d);
      return ((ib - d) == dlen) ? dlen : ib - d + 1;
    }
  }
  else
  {
    if (dlen > (sizeof(buf) - strlen(tocode)))
      return sizeof(buf) - strlen(tocode) + 1;
    memcpy(buf, d, dlen);
    ob = buf + dlen;
  }
 
  count = 0;
  for (char *p = buf; p < ob; p++)
  {
    unsigned char c = *p;
    ASSERT(strchr(RFC2047Specials, '?'));
    if ((c >= 0x7f) || (c < 0x20) || (*p == '_') ||
        ((c != ' ') && strchr(RFC2047Specials, *p)))
    {
      count++;
    }
  }
 
  len = ENCWORD_LEN_MIN - 2 + strlen(tocode);
  len_b = len + (((ob - buf) + 2) / 3) * 4;
  len_q = len + (ob - buf) + 2 * count;
 
  /* Apparently RFC1468 says to use B encoding for iso-2022-jp. */
  if (mutt_istr_equal(tocode, "ISO-2022-JP"))
    len_q = ENCWORD_LEN_MAX + 1;
 
  if ((len_b < len_q) && (len_b <= ENCWORD_LEN_MAX))
  {
    *encoder = b_encoder;
    *wlen = len_b;
    return 0;
  }
  else if (len_q <= ENCWORD_LEN_MAX)
  {
    *encoder = q_encoder;
    *wlen = len_q;
    return 0;
  }
  else
  {
    return dlen;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

encode_block()

size_t encode_block ( char * str, char * buf, size_t buflen, const char * fromcode, const char * tocode, encoder_t encoder )

static

Encode a block of text using an encoder.

Parameters

str	String to convert
buf	Buffer for result
buflen	Buffer length
fromcode	Original encoding
tocode	New encoding
encoder	Encoding function

Return values

num	Length of the encoded word

Encode the data (buf, buflen) into str using the encoder.

Definition at line 286 of file rfc2047.c.

{
  if (!fromcode)
  {
    return (*encoder)(str, buf, buflen, tocode);
  }
 
  const iconv_t cd = mutt_ch_iconv_open(tocode, fromcode, MUTT_ICONV_NONE);
  ASSERT(iconv_t_valid(cd));
  const char *ib = buf;
  size_t ibl = buflen;
  char tmp[ENCWORD_LEN_MAX - ENCWORD_LEN_MIN + 1] = { 0 };
  char *ob = tmp;
  size_t obl = sizeof(tmp) - strlen(tocode);
  const size_t n1 = iconv(cd, (ICONV_CONST char **) &ib, &ibl, &ob, &obl);
  const size_t n2 = iconv(cd, NULL, NULL, &ob, &obl);
  ASSERT((n1 != ICONV_ILLEGAL_SEQ) && (n2 != ICONV_ILLEGAL_SEQ));
  return (*encoder)(str, tmp, ob - tmp, tocode);
}

Here is the call graph for this function:

Here is the caller graph for this function:

choose_block()

size_t choose_block ( char * d, size_t dlen, int col, const char * fromcode, const char * tocode, encoder_t * encoder, size_t * wlen )

static

Calculate how much data can be converted.

Parameters

d	String to convert
dlen	Length of string
col	Starting column to convert
fromcode	Original encoding
tocode	New encoding
encoder	Encoding function
wlen	Number of characters converted

Return values

num	Bytes that can be converted

Discover how much of the data (d, dlen) can be converted into a single encoded word. Return how much data can be converted, and set the length *wlen of the encoded word and *encoder. We start in column col, which limits the length of the word.

Definition at line 323 of file rfc2047.c.

{
  const bool utf8 = fromcode && mutt_istr_equal(fromcode, "utf-8");
 
  size_t n = dlen;
  while (true)
  {
    ASSERT(n > 0);
    const size_t nn = try_block(d, n, fromcode, tocode, encoder, wlen);
    if ((nn == 0) && (((col + *wlen) <= (ENCWORD_LEN_MAX + 1)) || (n <= 1)))
      break;
    n = ((nn != 0) ? nn : n) - 1;
    ASSERT(n > 0);
    if (utf8)
      while ((n > 1) && CONTINUATION_BYTE(d[n]))
        n--;
  }
  return n;
}

Here is the call graph for this function:

Here is the caller graph for this function:

finalize_chunk()

void finalize_chunk ( struct Buffer * res, struct Buffer * buf, char * charset, size_t charsetlen )

static

Perform charset conversion and filtering.

Parameters

[out]	res	Buffer where the resulting string is appended
[in]	buf	Buffer with the input string
[in]	charset	Charset to use for the conversion
[in]	charsetlen	Length of the charset parameter

The buffer buf is reinitialized at the end of this function.

Definition at line 353 of file rfc2047.c.

{
  if (!charset)
    return;
  char end = charset[charsetlen];
  charset[charsetlen] = '\0';
  mutt_ch_convert_string(&buf->data, charset, cc_charset(), MUTT_ICONV_HOOK_FROM);
  charset[charsetlen] = end;
  mutt_mb_filter_unprintable(&buf->data);
  buf_addstr(res, buf->data);
  FREE(&buf->data);
  buf_init(buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

decode_word()

char * decode_word ( const char * s, size_t len, enum ContentEncoding enc )

static

Decode an RFC2047-encoded string.

Parameters

s	String to decode
len	Length of the string
enc	Encoding type

Return values

ptr	Decoded string

Note

The input string must be NUL-terminated; the len parameter is an optimization. The caller must free the returned string.

Definition at line 377 of file rfc2047.c.

{
  const char *it = s;
  const char *end = s + len;
 
  ASSERT(*end == '\0');
 
  if (enc == ENC_QUOTED_PRINTABLE)
  {
    struct Buffer *buf = buf_pool_get();
    for (; it < end; it++)
    {
      if (*it == '_')
      {
        buf_addch(buf, ' ');
      }
      else if ((it[0] == '=') && (!(it[1] & ~127) && (hexval(it[1]) != -1)) &&
               (!(it[2] & ~127) && (hexval(it[2]) != -1)))
      {
        buf_addch(buf, (hexval(it[1]) << 4) | hexval(it[2]));
        it += 2;
      }
      else
      {
        buf_addch(buf, *it);
      }
    }
    char *str = buf_strdup(buf);
    buf_pool_release(&buf);
    return str;
  }
  else if (enc == ENC_BASE64)
  {
    const int olen = 3 * len / 4 + 1;
    char *out = MUTT_MEM_MALLOC(olen, char);
    int dlen = mutt_b64_decode(it, out, olen);
    if (dlen == -1)
    {
      FREE(&out);
      return NULL;
    }
    out[dlen] = '\0';
    return out;
  }
 
  ASSERT(0); /* The enc parameter has an invalid value */
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

encode()

int encode ( const char * d, size_t dlen, int col, const char * fromcode, const struct Slist * charsets, char ** e, size_t * elen, const char * specials )

static

RFC2047-encode a string.

Parameters

[in]	d	String to convert
[in]	dlen	Length of string
[in]	col	Starting column to convert
[in]	fromcode	Original encoding
[in]	charsets	List of allowable encodings (colon separated)
[out]	e	Encoded string
[out]	elen	Length of encoded string
[in]	specials	Special characters to be encoded

Return values

0

Success

Definition at line 438 of file rfc2047.c.

{
  int rc = 0;
  char *buf = NULL;
  size_t bufpos;
  size_t buflen;
  char *t0 = NULL;
  char *t1 = NULL;
  char *t = NULL;
  char *s0 = NULL;
  char *s1 = NULL;
  size_t ulen;
  size_t r;
  size_t wlen = 0;
  encoder_t encoder = NULL;
  char *tocode1 = NULL;
  const char *tocode = NULL;
  const char *icode = "utf-8";
 
  /* Try to convert to UTF-8. */
  char *u = mutt_strn_dup(d, dlen);
  if (mutt_ch_convert_string(&u, fromcode, icode, MUTT_ICONV_NONE) != 0)
  {
    rc = 1;
    icode = 0;
  }
  ulen = mutt_str_len(u);
 
  /* Find earliest and latest things we must encode. */
  s0 = 0;
  s1 = 0;
  t0 = 0;
  t1 = 0;
  for (t = u; t < (u + ulen); t++)
  {
    if ((*t & 0x80) || ((*t == '=') && (t[1] == '?') && ((t == u) || HSPACE(*(t - 1)))))
    {
      if (!t0)
        t0 = t;
      t1 = t;
    }
    else if (specials && *t && strchr(specials, *t))
    {
      if (!s0)
        s0 = t;
      s1 = t;
    }
  }
 
  /* If we have something to encode, include RFC822 specials */
  if (t0 && s0 && (s0 < t0))
    t0 = s0;
  if (t1 && s1 && (s1 > t1))
    t1 = s1;
 
  if (!t0)
  {
    /* No encoding is required. */
    *e = u;
    *elen = ulen;
    return rc;
  }
 
  /* Choose target charset. */
  tocode = fromcode;
  if (icode)
  {
    tocode1 = mutt_ch_choose(icode, charsets, u, ulen, 0, 0);
    if (tocode1)
    {
      tocode = tocode1;
    }
    else
    {
      rc = 2;
      icode = 0;
    }
  }
 
  /* Hack to avoid labelling 8-bit data as us-ascii. */
  if (!icode && mutt_ch_is_us_ascii(tocode))
    tocode = "unknown-8bit";
 
  /* Adjust t0 for maximum length of line. */
  t = u + (ENCWORD_LEN_MAX + 1) - col - ENCWORD_LEN_MIN;
  if (t < u)
    t = u;
  if (t < t0)
    t0 = t;
 
  /* Adjust t0 until we can encode a character after a space. */
  for (; t0 > u; t0--)
  {
    if (!HSPACE(*(t0 - 1)))
      continue;
    t = t0 + 1;
    if (icode)
      while ((t < (u + ulen)) && CONTINUATION_BYTE(*t))
        t++;
    if ((try_block(t0, t - t0, icode, tocode, &encoder, &wlen) == 0) &&
        ((col + (t0 - u) + wlen) <= (ENCWORD_LEN_MAX + 1)))
    {
      break;
    }
  }
 
  /* Adjust t1 until we can encode a character before a space. */
  for (; t1 < (u + ulen); t1++)
  {
    if (!HSPACE(*t1))
      continue;
    t = t1 - 1;
    if (icode)
      while (CONTINUATION_BYTE(*t))
        t--;
    if ((try_block(t, t1 - t, icode, tocode, &encoder, &wlen) == 0) &&
        ((1 + wlen + (u + ulen - t1)) <= (ENCWORD_LEN_MAX + 1)))
    {
      break;
    }
  }
 
  /* We shall encode the region [t0,t1). */
 
  /* Initialise the output buffer with the us-ascii prefix. */
  buflen = 2 * ulen;
  buf = MUTT_MEM_MALLOC(buflen, char);
  bufpos = t0 - u;
  memcpy(buf, u, t0 - u);
 
  col += t0 - u;
 
  t = t0;
  while (true)
  {
    /* Find how much we can encode. */
    size_t n = choose_block(t, t1 - t, col, icode, tocode, &encoder, &wlen);
    if (n == (t1 - t))
    {
      /* See if we can fit the us-ascii suffix, too. */
      if ((col + wlen + (u + ulen - t1)) <= (ENCWORD_LEN_MAX + 1))
        break;
      n = t1 - t - 1;
      if (icode)
        while (CONTINUATION_BYTE(t[n]))
          n--;
      if (n == 0)
      {
        /* This should only happen in the really stupid case where the
         * only word that needs encoding is one character long, but
         * there is too much us-ascii stuff after it to use a single
         * encoded word. We add the next word to the encoded region
         * and try again. */
        ASSERT(t1 < (u + ulen));
        for (t1++; (t1 < (u + ulen)) && !HSPACE(*t1); t1++)
          ; // do nothing
 
        continue;
      }
      n = choose_block(t, n, col, icode, tocode, &encoder, &wlen);
    }
 
    /* Add to output buffer. */
    const char *line_break = "\n\t";
    const int lb_len = 2; /* strlen(line_break) */
 
    if ((bufpos + wlen + lb_len) > buflen)
    {
      buflen = bufpos + wlen + lb_len;
      MUTT_MEM_REALLOC(&buf, buflen, char);
    }
    r = encode_block(buf + bufpos, t, n, icode, tocode, encoder);
    ASSERT(r == wlen);
    bufpos += wlen;
    memcpy(buf + bufpos, line_break, lb_len);
    bufpos += lb_len;
 
    col = 1;
 
    t += n;
  }
 
  /* Add last encoded word and us-ascii suffix to buffer. */
  buflen = bufpos + wlen + (u + ulen - t1);
  MUTT_MEM_REALLOC(&buf, buflen + 1, char);
  r = encode_block(buf + bufpos, t, t1 - t, icode, tocode, encoder);
  ASSERT(r == wlen);
  bufpos += wlen;
  memcpy(buf + bufpos, t1, u + ulen - t1);
 
  FREE(&tocode1);
  FREE(&u);
 
  buf[buflen] = '\0';
 
  *e = buf;
  *elen = buflen + 1;
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

rfc2047_encode()

void rfc2047_encode	(	char **	pd,
		const char *	specials,
		int	col,
		const struct Slist *	charsets )

RFC-2047-encode a string.

Parameters

[in,out]	pd	String to be encoded, and resulting encoded string
[in]	specials	Special characters to be encoded
[in]	col	Starting index in string
[in]	charsets	List of charsets to choose from

Definition at line 646 of file rfc2047.c.

{
  if (!pd || !*pd)
    return;
 
  const char *const c_charset = cc_charset();
  if (!c_charset)
    return;
 
  struct Slist *fallback = NULL;
  if (!charsets)
  {
    fallback = slist_parse("utf-8", D_SLIST_SEP_COLON);
    charsets = fallback;
  }
 
  char *e = NULL;
  size_t elen = 0;
  encode(*pd, strlen(*pd), col, c_charset, charsets, &e, &elen, specials);
 
  slist_free(&fallback);
  FREE(pd);
  *pd = e;
}

Here is the call graph for this function:

Here is the caller graph for this function:

rfc2047_decode()

void rfc2047_decode

(

char **

pd

)

Decode any RFC2047-encoded header fields.

Parameters

[in,out]

pd

String to be decoded, and resulting decoded string

Try to decode anything that looks like a valid RFC2047 encoded header field, ignoring RFC822 parsing rules. If decoding fails, for example due to an invalid base64 string, the original input is left untouched.

Definition at line 679 of file rfc2047.c.

{
  if (!pd || !*pd)
    return;
 
  struct Buffer *buf = buf_pool_get();  // Output buffer
  char *s = *pd;                        // Read pointer
  char *beg = NULL;                     // Begin of encoded word
  enum ContentEncoding enc = ENC_OTHER; // ENC_BASE64 or ENC_QUOTED_PRINTABLE
  char *charset = NULL;                 // Which charset
  size_t charsetlen = 0;                // Length of the charset
  char *text = NULL;                    // Encoded text
  size_t textlen = 0;                   // Length of encoded text
 
  /* Keep some state in case the next decoded word is using the same charset
   * and it happens to be split in the middle of a multibyte character.
   * See https://github.com/neomutt/neomutt/issues/1015 */
  struct Buffer *prev = buf_pool_get(); /* Previously decoded word  */
  char *prev_charset = NULL;  /* Previously used charset                */
  size_t prev_charsetlen = 0; /* Length of the previously used charset  */
 
  const struct Slist *c_assumed_charset = cc_assumed_charset();
  const char *c_charset = cc_charset();
  while (*s)
  {
    beg = parse_encoded_word(s, &enc, &charset, &charsetlen, &text, &textlen);
    if (beg != s)
    {
      /* Some non-encoded text was found */
      size_t holelen = beg ? beg - s : mutt_str_len(s);
 
      /* Ignore whitespace between encoded words */
      if (beg && (mutt_str_lws_len(s, holelen) == holelen))
      {
        s = beg;
        continue;
      }
 
      /* If we have some previously decoded text, add it now */
      if (!buf_is_empty(prev))
      {
        finalize_chunk(buf, prev, prev_charset, prev_charsetlen);
      }
 
      /* Add non-encoded part */
      if (slist_is_empty(c_assumed_charset))
      {
        buf_addstr_n(buf, s, holelen);
      }
      else
      {
        char *conv = mutt_strn_dup(s, holelen);
        mutt_ch_convert_nonmime_string(c_assumed_charset, c_charset, &conv);
        buf_addstr(buf, conv);
        FREE(&conv);
      }
      s += holelen;
    }
    if (beg)
    {
      /* Some encoded text was found */
      text[textlen] = '\0';
      char *decoded = decode_word(text, textlen, enc);
      if (!decoded)
      {
        goto done;
      }
      if (!buf_is_empty(prev) && ((prev_charsetlen != charsetlen) ||
                                  !mutt_strn_equal(prev_charset, charset, charsetlen)))
      {
        /* Different charset, convert the previous chunk and add it to the
         * final result */
        finalize_chunk(buf, prev, prev_charset, prev_charsetlen);
      }
 
      buf_addstr(prev, decoded);
      FREE(&decoded);
      prev_charset = charset;
      prev_charsetlen = charsetlen;
      s = text + textlen + 2; /* Skip final ?= */
    }
  }
 
  /* Save the last chunk */
  if (!buf_is_empty(prev))
  {
    finalize_chunk(buf, prev, prev_charset, prev_charsetlen);
  }
 
  FREE(pd);
  *pd = buf_strdup(buf);
 
done:
  buf_pool_release(&buf);
  buf_pool_release(&prev);
}

Here is the call graph for this function:

Here is the caller graph for this function:

rfc2047_encode_addrlist()

void rfc2047_encode_addrlist	(	struct AddressList *	al,
		const char *	tag )

Encode any RFC2047 headers, where required, in an Address list.

Parameters

al	AddressList
tag	Header tag (used for wrapping calculation)

Note

rfc2047_encode() may realloc the data pointer it's given, so work on a copy to avoid breaking the Buffer

Definition at line 784 of file rfc2047.c.

{
  if (!al)
    return;
 
  int col = tag ? strlen(tag) + 2 : 32;
  struct Address *a = NULL;
  char *data = NULL;
  const struct Slist *const c_send_charset = cs_subset_slist(NeoMutt->sub, "send_charset");
  TAILQ_FOREACH(a, al, entries)
  {
    if (a->personal)
    {
      data = buf_strdup(a->personal);
      rfc2047_encode(&data, AddressSpecials, col, c_send_charset);
      buf_strcpy(a->personal, data);
      FREE(&data);
    }
    else if (a->group && a->mailbox)
    {
      data = buf_strdup(a->mailbox);
      rfc2047_encode(&data, AddressSpecials, col, c_send_charset);
      buf_strcpy(a->mailbox, data);
      FREE(&data);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

rfc2047_decode_addrlist()

void rfc2047_decode_addrlist

(

struct AddressList *

al

)

Decode any RFC2047 headers in an Address list.

Parameters

al	AddressList

Note

rfc2047_decode() may realloc the data pointer it's given, so work on a copy to avoid breaking the Buffer

Definition at line 819 of file rfc2047.c.

{
  if (!al)
    return;
 
  const bool assumed = !slist_is_empty(cc_assumed_charset());
  struct Address *a = NULL;
  char *data = NULL;
  TAILQ_FOREACH(a, al, entries)
  {
    if (a->personal && ((buf_find_string(a->personal, "=?")) || assumed))
    {
      data = buf_strdup(a->personal);
      rfc2047_decode(&data);
      buf_strcpy(a->personal, data);
      FREE(&data);
    }
    else if (a->group && a->mailbox && buf_find_string(a->mailbox, "=?"))
    {
      data = buf_strdup(a->mailbox);
      rfc2047_decode(&data);
      buf_strcpy(a->mailbox, data);
      FREE(&data);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

rfc2047_decode_envelope()

void rfc2047_decode_envelope

(

struct Envelope *

env

)

Decode the fields of an Envelope.

Parameters

env

Envelope

Definition at line 850 of file rfc2047.c.

{
  if (!env)
    return;
  rfc2047_decode_addrlist(&env->from);
  rfc2047_decode_addrlist(&env->to);
  rfc2047_decode_addrlist(&env->cc);
  rfc2047_decode_addrlist(&env->bcc);
  rfc2047_decode_addrlist(&env->reply_to);
  rfc2047_decode_addrlist(&env->mail_followup_to);
  rfc2047_decode_addrlist(&env->return_path);
  rfc2047_decode_addrlist(&env->sender);
  rfc2047_decode(&env->x_label);
 
  char *subj = env->subject;
  *(char **) &env->subject = NULL;
  rfc2047_decode(&subj);
  mutt_env_set_subject(env, subj);
  FREE(&subj);
}

Here is the call graph for this function:

Here is the caller graph for this function:

rfc2047_encode_envelope()

void rfc2047_encode_envelope

(

struct Envelope *

env

)

Encode the fields of an Envelope.

Parameters

env

Envelope

Definition at line 875 of file rfc2047.c.

{
  if (!env)
    return;
  rfc2047_encode_addrlist(&env->from, "From");
  rfc2047_encode_addrlist(&env->to, "To");
  rfc2047_encode_addrlist(&env->cc, "Cc");
  rfc2047_encode_addrlist(&env->bcc, "Bcc");
  rfc2047_encode_addrlist(&env->reply_to, "Reply-To");
  rfc2047_encode_addrlist(&env->mail_followup_to, "Mail-Followup-To");
  rfc2047_encode_addrlist(&env->sender, "Sender");
  const struct Slist *const c_send_charset = cs_subset_slist(NeoMutt->sub, "send_charset");
  rfc2047_encode(&env->x_label, NULL, sizeof("X-Label:"), c_send_charset);
 
  char *subj = env->subject;
  *(char **) &env->subject = NULL;
  rfc2047_encode(&subj, NULL, sizeof("Subject:"), c_send_charset);
  mutt_env_set_subject(env, subj);
  FREE(&subj);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

RFC2047Specials

const char RFC2047Specials[] = "@.,;:<>[]\\\"()?/= \t"

static

Definition at line 72 of file rfc2047.c.