NeoMutt  2023-11-03-85-g512e01
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
rfc3676.c File Reference

RFC3676 Format Flowed routines. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include <unistd.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "rfc3676.h"
+ Include dependency graph for rfc3676.c:

Go to the source code of this file.

Data Structures

struct  FlowedState
 State of a Format-Flowed line of text. More...
 

Macros

#define FLOWED_MAX   72
 

Functions

static int get_quote_level (const char *line)
 Get the quote level of a line.
 
static int space_quotes (struct State *state)
 Should we add spaces between quote levels.
 
static bool add_quote_suffix (struct State *state, int ql)
 Should we add a trailing space to quotes.
 
static size_t print_indent (int ql, struct State *state, int add_suffix)
 Print indented text.
 
static void flush_par (struct State *state, struct FlowedState *fst)
 Write out the paragraph.
 
static int quote_width (struct State *state, int ql)
 Calculate the paragraph width based upon the quote level.
 
static void print_flowed_line (char *line, struct State *state, int ql, struct FlowedState *fst, bool term)
 Print a format-flowed line.
 
static void print_fixed_line (const char *line, struct State *state, int ql, struct FlowedState *fst)
 Print a fixed format line.
 
int rfc3676_handler (struct Body *b_email, struct State *state)
 Handler for format=flowed - Implements handler_t -.
 
bool mutt_rfc3676_is_format_flowed (struct Body *b)
 Is the Email "format-flowed"?
 
static void rfc3676_space_stuff (const char *filename, bool unstuff)
 Perform required RFC3676 space stuffing.
 
void mutt_rfc3676_space_stuff (struct Email *e)
 Perform RFC3676 space stuffing on an Email.
 
void mutt_rfc3676_space_unstuff (struct Email *e)
 Remove RFC3676 space stuffing.
 
void mutt_rfc3676_space_unstuff_attachment (struct Body *b, const char *filename)
 Unstuff attachments.
 
void mutt_rfc3676_space_stuff_attachment (struct Body *b, const char *filename)
 Stuff attachments.
 

Detailed Description

RFC3676 Format Flowed routines.

Authors
  • Andreas Krennmair
  • Peter J. Holzer
  • Rocco Rutte
  • Michael R. Elkins

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

Macro Definition Documentation

◆ FLOWED_MAX

#define FLOWED_MAX   72

Definition at line 43 of file rfc3676.c.

Function Documentation

◆ get_quote_level()

static int get_quote_level ( const char *  line)
static

Get the quote level of a line.

Parameters
lineText to examine
Return values
numQuote level

Definition at line 60 of file rfc3676.c.

61{
62 int quoted = 0;
63 const char *p = line;
64
65 while (p && (*p == '>'))
66 {
67 quoted++;
68 p++;
69 }
70
71 return quoted;
72}
+ Here is the caller graph for this function:

◆ space_quotes()

static int space_quotes ( struct State state)
static

Should we add spaces between quote levels.

Parameters
stateState to use
Return values
trueSpaces should be added

Determines whether to add spacing between/after each quote level: >>>foo becomes > > > foo

Definition at line 84 of file rfc3676.c.

85{
86 /* Allow quote spacing in the pager even for `$text_flowed`,
87 * but obviously not when replying. */
88 const bool c_text_flowed = cs_subset_bool(NeoMutt->sub, "text_flowed");
89 if (c_text_flowed && (state->flags & STATE_REPLYING))
90 return 0;
91
92 const bool c_reflow_space_quotes = cs_subset_bool(NeoMutt->sub, "reflow_space_quotes");
93 return c_reflow_space_quotes;
94}
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:48
#define STATE_REPLYING
Are we replying?
Definition: state.h:38
Container for Accounts, Notifications.
Definition: neomutt.h:41
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:45
StateFlags flags
Flags, e.g. STATE_DISPLAY.
Definition: state.h:51
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ add_quote_suffix()

static bool add_quote_suffix ( struct State state,
int  ql 
)
static

Should we add a trailing space to quotes.

Parameters
stateState to use
qlQuote level
Return values
trueSpaces should be added

Determines whether to add a trailing space to quotes: >>> foo as opposed to >>>foo

Definition at line 107 of file rfc3676.c.

108{
109 if (state->flags & STATE_REPLYING)
110 return false;
111
112 if (space_quotes(state))
113 return false;
114
115 if (!ql && !state->prefix)
116 return false;
117
118 /* The prefix will add its own space */
119 const bool c_text_flowed = cs_subset_bool(NeoMutt->sub, "text_flowed");
120 if (!c_text_flowed && !ql && state->prefix)
121 return false;
122
123 return true;
124}
static int space_quotes(struct State *state)
Should we add spaces between quote levels.
Definition: rfc3676.c:84
char * prefix
String to add to the beginning of each output line.
Definition: state.h:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ print_indent()

static size_t print_indent ( int  ql,
struct State state,
int  add_suffix 
)
static

Print indented text.

Parameters
qlQuote level
stateState to work with
add_suffixIf true, write a trailing space character
Return values
numNumber of characters written

Definition at line 133 of file rfc3676.c.

134{
135 size_t wid = 0;
136
137 if (state->prefix)
138 {
139 /* use given prefix only for format=fixed replies to format=flowed,
140 * for format=flowed replies to format=flowed, use '>' indentation */
141 const bool c_text_flowed = cs_subset_bool(NeoMutt->sub, "text_flowed");
142 if (c_text_flowed)
143 {
144 ql++;
145 }
146 else
147 {
148 state_puts(state, state->prefix);
149 wid = mutt_strwidth(state->prefix);
150 }
151 }
152 for (int i = 0; i < ql; i++)
153 {
154 state_putc(state, '>');
155 if (space_quotes(state))
156 state_putc(state, ' ');
157 }
158 if (add_suffix)
159 state_putc(state, ' ');
160
161 if (space_quotes(state))
162 ql *= 2;
163
164 return ql + add_suffix + wid;
165}
size_t mutt_strwidth(const char *s)
Measure a string's width in screen cells.
Definition: curs_lib.c:454
#define state_puts(STATE, STR)
Definition: state.h:57
#define state_putc(STATE, STR)
Definition: state.h:58
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ flush_par()

static void flush_par ( struct State state,
struct FlowedState fst 
)
static

Write out the paragraph.

Parameters
stateState to work with
fstState of the flowed text

Definition at line 172 of file rfc3676.c.

173{
174 if (fst->width > 0)
175 {
176 state_putc(state, '\n');
177 fst->width = 0;
178 }
179 fst->spaces = 0;
180}
size_t width
Definition: rfc3676.c:50
size_t spaces
Definition: rfc3676.c:51
+ Here is the caller graph for this function:

◆ quote_width()

static int quote_width ( struct State state,
int  ql 
)
static

Calculate the paragraph width based upon the quote level.

Parameters
stateState to use
qlQuote level
Return values
numParagraph width

The start of a quoted line will be ">>> ", so we need to subtract the space required for the prefix from the terminal width.

Definition at line 191 of file rfc3676.c.

192{
193 const int screen_width = (state->flags & STATE_DISPLAY) ? state->wraplen : 80;
194 const short c_reflow_wrap = cs_subset_number(NeoMutt->sub, "reflow_wrap");
195 int width = mutt_window_wrap_cols(screen_width, c_reflow_wrap);
196 const bool c_text_flowed = cs_subset_bool(NeoMutt->sub, "text_flowed");
197 if (c_text_flowed && (state->flags & STATE_REPLYING))
198 {
199 /* When replying, force a wrap at FLOWED_MAX to comply with RFC3676
200 * guidelines */
201 if (width > FLOWED_MAX)
202 width = FLOWED_MAX;
203 ql++; /* When replying, we will add an additional quote level */
204 }
205 /* adjust the paragraph width subtracting the number of prefix chars */
206 width -= space_quotes(state) ? ql * 2 : ql;
207 /* When displaying (not replying), there may be a space between the prefix
208 * string and the paragraph */
209 if (add_quote_suffix(state, ql))
210 width--;
211 /* failsafe for really long quotes */
212 if (width <= 0)
213 width = FLOWED_MAX; /* arbitrary, since the line will wrap */
214 return width;
215}
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:144
#define STATE_DISPLAY
Output is displayed to the user.
Definition: state.h:32
int mutt_window_wrap_cols(int width, short wrap)
Calculate the wrap column for a given screen width.
Definition: mutt_window.c:372
#define FLOWED_MAX
Definition: rfc3676.c:43
static bool add_quote_suffix(struct State *state, int ql)
Should we add a trailing space to quotes.
Definition: rfc3676.c:107
int wraplen
Width to wrap lines to (when flags & STATE_DISPLAY)
Definition: state.h:52
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ print_flowed_line()

static void print_flowed_line ( char *  line,
struct State state,
int  ql,
struct FlowedState fst,
bool  term 
)
static

Print a format-flowed line.

Parameters
lineText to print
stateState to work with
qlQuote level
fstState of the flowed text
termIf true, terminate with a new line

Definition at line 225 of file rfc3676.c.

227{
228 size_t width, w, words = 0;
229 char *p = NULL;
230 char last;
231
232 if (!line || (*line == '\0'))
233 {
234 /* flush current paragraph (if any) first */
235 flush_par(state, fst);
236 print_indent(ql, state, 0);
237 state_putc(state, '\n');
238 return;
239 }
240
241 width = quote_width(state, ql);
242 last = line[mutt_str_len(line) - 1];
243
244 mutt_debug(LL_DEBUG5, "f=f: line [%s], width = %ld, spaces = %zu\n", line,
245 (long) width, fst->spaces);
246
247 for (words = 0; (p = mutt_str_sep(&line, " "));)
248 {
249 mutt_debug(LL_DEBUG5, "f=f: word [%s], width: %zu, remaining = [%s]\n", p,
250 fst->width, line);
251
252 /* remember number of spaces */
253 if (*p == '\0')
254 {
255 mutt_debug(LL_DEBUG3, "f=f: additional space\n");
256 fst->spaces++;
257 continue;
258 }
259 /* there's exactly one space prior to every but the first word */
260 if (words)
261 fst->spaces++;
262
263 w = mutt_strwidth(p);
264 /* see if we need to break the line but make sure the first word is put on
265 * the line regardless; if for DelSp=yes only one trailing space is used,
266 * we probably have a long word that we should break within (we leave that
267 * up to the pager or user) */
268 if (!(!fst->spaces && fst->delsp && (last != ' ')) && (w < width) &&
269 (w + fst->width + fst->spaces > width))
270 {
271 mutt_debug(LL_DEBUG3, "f=f: break line at %zu, %zu spaces left\n",
272 fst->width, fst->spaces);
273 /* only honor trailing spaces for format=flowed replies */
274 const bool c_text_flowed = cs_subset_bool(NeoMutt->sub, "text_flowed");
275 if (c_text_flowed)
276 for (; fst->spaces; fst->spaces--)
277 state_putc(state, ' ');
278 state_putc(state, '\n');
279 fst->width = 0;
280 fst->spaces = 0;
281 words = 0;
282 }
283
284 if (!words && !fst->width)
285 fst->width = print_indent(ql, state, add_quote_suffix(state, ql));
286 fst->width += w + fst->spaces;
287 for (; fst->spaces; fst->spaces--)
288 state_putc(state, ' ');
289 state_puts(state, p);
290 words++;
291 }
292
293 if (term)
294 flush_par(state, fst);
295}
#define mutt_debug(LEVEL,...)
Definition: logging2.h:89
@ LL_DEBUG3
Log at debug level 3.
Definition: logging2.h:45
@ LL_DEBUG5
Log at debug level 5.
Definition: logging2.h:47
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:568
char * mutt_str_sep(char **stringp, const char *delim)
Find first occurrence of any of delim characters in *stringp.
Definition: string.c:184
static size_t print_indent(int ql, struct State *state, int add_suffix)
Print indented text.
Definition: rfc3676.c:133
static int quote_width(struct State *state, int ql)
Calculate the paragraph width based upon the quote level.
Definition: rfc3676.c:191
static void flush_par(struct State *state, struct FlowedState *fst)
Write out the paragraph.
Definition: rfc3676.c:172
bool delsp
Definition: rfc3676.c:52
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ print_fixed_line()

static void print_fixed_line ( const char *  line,
struct State state,
int  ql,
struct FlowedState fst 
)
static

Print a fixed format line.

Parameters
lineText to print
stateState to work with
qlQuote level
fstState of the flowed text

Definition at line 304 of file rfc3676.c.

306{
307 print_indent(ql, state, add_quote_suffix(state, ql));
308 if (line && *line)
309 state_puts(state, line);
310 state_putc(state, '\n');
311
312 fst->width = 0;
313 fst->spaces = 0;
314}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_rfc3676_is_format_flowed()

bool mutt_rfc3676_is_format_flowed ( struct Body b)

Is the Email "format-flowed"?

Parameters
bEmail Body to examine
Return values
trueEmail is "format-flowed"

Definition at line 391 of file rfc3676.c.

392{
393 if (b && (b->type == TYPE_TEXT) && mutt_istr_equal("plain", b->subtype))
394 {
395 const char *format = mutt_param_get(&b->parameter, "format");
396 if (mutt_istr_equal("flowed", format))
397 return true;
398 }
399
400 return false;
401}
@ TYPE_TEXT
Type: 'text/*'.
Definition: mime.h:38
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:810
char * mutt_param_get(const struct ParameterList *pl, const char *s)
Find a matching Parameter.
Definition: parameter.c:84
struct ParameterList parameter
Parameters of the content-type.
Definition: body.h:62
char * subtype
content-type subtype
Definition: body.h:60
unsigned int type
content-type primary type, ContentType
Definition: body.h:40
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ rfc3676_space_stuff()

static void rfc3676_space_stuff ( const char *  filename,
bool  unstuff 
)
static

Perform required RFC3676 space stuffing.

Parameters
filenameAttachment file
unstuffIf true, remove space stuffing

Space stuffing means that we have to add leading spaces to certain lines:

  • lines starting with a space
  • lines starting with 'From '

Care is taken to preserve the e->body->filename, as mutt -i -E can directly edit a passed in filename.

Definition at line 416 of file rfc3676.c.

417{
418 FILE *fp_out = NULL;
419 char *buf = NULL;
420 size_t blen = 0;
421
422 struct Buffer *tmpfile = buf_pool_get();
423
424 FILE *fp_in = mutt_file_fopen(filename, "r");
425 if (!fp_in)
426 goto bail;
427
428 buf_mktemp(tmpfile);
429 fp_out = mutt_file_fopen(buf_string(tmpfile), "w+");
430 if (!fp_out)
431 goto bail;
432
433 while ((buf = mutt_file_read_line(buf, &blen, fp_in, NULL, MUTT_RL_NO_FLAGS)) != NULL)
434 {
435 if (unstuff)
436 {
437 if (buf[0] == ' ')
438 fputs(buf + 1, fp_out);
439 else
440 fputs(buf, fp_out);
441 }
442 else
443 {
444 if ((buf[0] == ' ') || mutt_str_startswith(buf, "From "))
445 fputc(' ', fp_out);
446 fputs(buf, fp_out);
447 }
448 fputc('\n', fp_out);
449 }
450 FREE(&buf);
451 mutt_file_fclose(&fp_in);
452 mutt_file_fclose(&fp_out);
453 mutt_file_set_mtime(filename, buf_string(tmpfile));
454
455 fp_in = mutt_file_fopen(buf_string(tmpfile), "r");
456 if (!fp_in)
457 goto bail;
458
459 if ((truncate(filename, 0) == -1) || ((fp_out = mutt_file_fopen(filename, "a")) == NULL))
460 {
461 mutt_perror("%s", filename);
462 goto bail;
463 }
464
465 mutt_file_copy_stream(fp_in, fp_out);
466 mutt_file_set_mtime(buf_string(tmpfile), filename);
467 unlink(buf_string(tmpfile));
468
469bail:
470 mutt_file_fclose(&fp_in);
471 mutt_file_fclose(&fp_out);
472 buf_pool_release(&tmpfile);
473}
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:93
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition: file.c:262
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags)
Read a line from a file.
Definition: file.c:763
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:636
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:152
void mutt_file_set_mtime(const char *from, const char *to)
Set the modification time of one file from another.
Definition: file.c:1071
#define MUTT_RL_NO_FLAGS
No flags are set.
Definition: file.h:39
#define mutt_perror(...)
Definition: logging2.h:93
#define FREE(x)
Definition: memory.h:45
size_t mutt_str_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix.
Definition: string.c:228
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:81
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:94
String manipulation buffer.
Definition: buffer.h:34
#define buf_mktemp(buf)
Definition: tmp.h:33
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_rfc3676_space_stuff()

void mutt_rfc3676_space_stuff ( struct Email e)

Perform RFC3676 space stuffing on an Email.

Parameters
eEmail
Note
We don't check the option $text_flowed because we want to stuff based the actual content type. The option only decides whether to set format=flowed on new messages.

Definition at line 483 of file rfc3676.c.

484{
485 if (!e || !e->body || !e->body->filename)
486 return;
487
490}
static void rfc3676_space_stuff(const char *filename, bool unstuff)
Perform required RFC3676 space stuffing.
Definition: rfc3676.c:416
bool mutt_rfc3676_is_format_flowed(struct Body *b)
Is the Email "format-flowed"?
Definition: rfc3676.c:391
char * filename
When sending a message, this is the file to which this structure refers.
Definition: body.h:58
struct Body * body
List of MIME parts.
Definition: email.h:67
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_rfc3676_space_unstuff()

void mutt_rfc3676_space_unstuff ( struct Email e)

Remove RFC3676 space stuffing.

Parameters
eEmail

Definition at line 496 of file rfc3676.c.

497{
498 if (!e || !e->body || !e->body->filename)
499 return;
500
503}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_rfc3676_space_unstuff_attachment()

void mutt_rfc3676_space_unstuff_attachment ( struct Body b,
const char *  filename 
)

Unstuff attachments.

Parameters
bEmail Body (OPTIONAL)
filenameAttachment file

This routine is used when saving/piping/viewing rfc3676 attachments.

If b is provided, the function will verify that the Email is format-flowed. The filename will be unstuffed, not b->filename or b->fp.

Definition at line 515 of file rfc3676.c.

516{
517 if (!filename)
518 return;
519
521 return;
522
523 rfc3676_space_stuff(filename, true);
524}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_rfc3676_space_stuff_attachment()

void mutt_rfc3676_space_stuff_attachment ( struct Body b,
const char *  filename 
)

Stuff attachments.

Parameters
bEmail Body (OPTIONAL)
filenameAttachment file

This routine is used when filtering rfc3676 attachments.

If b is provided, the function will verify that the Email is format-flowed. The filename will be unstuffed, not b->filename or b->fp.

Definition at line 536 of file rfc3676.c.

537{
538 if (!filename)
539 return;
540
542 return;
543
544 rfc3676_space_stuff(filename, false);
545}
+ Here is the call graph for this function:
+ Here is the caller graph for this function: