NeoMutt  2021-10-22-8-g9cb437
Teaching an old dog new tricks
DOXYGEN
mutt_header.c File Reference

Manipulate an email's header. More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <sys/stat.h>
#include <time.h>
#include "mutt/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "alias/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "mutt_header.h"
#include "index/lib.h"
#include "ncrypt/lib.h"
#include "send/lib.h"
#include "muttlib.h"
#include "options.h"
#include "protos.h"
+ Include dependency graph for mutt_header.c:

Go to the source code of this file.

Functions

static void label_ref_dec (struct Mailbox *m, char *label)
 Decrease the refcount of a label. More...
 
static void label_ref_inc (struct Mailbox *m, char *label)
 Increase the refcount of a label. More...
 
static bool label_message (struct Mailbox *m, struct Email *e, char *new_label)
 Add an X-Label: field. More...
 
int mutt_label_message (struct Mailbox *m, struct EmailList *el)
 Let the user label a message. More...
 
void mutt_edit_headers (const char *editor, const char *body, struct Email *e, struct Buffer *fcc)
 Let the user edit the message header and body. More...
 
void mutt_make_label_hash (struct Mailbox *m)
 Create a Hash Table to store the labels. More...
 
void mutt_label_hash_add (struct Mailbox *m, struct Email *e)
 Add a message's labels to the Hash Table. More...
 
void mutt_label_hash_remove (struct Mailbox *m, struct Email *e)
 Remove a message's labels from the Hash Table. More...
 

Detailed Description

Manipulate an email's header.

Authors
  • 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 mutt_header.c.

Function Documentation

◆ label_ref_dec()

static void label_ref_dec ( struct Mailbox m,
char *  label 
)
static

Decrease the refcount of a label.

Parameters
mMailbox
labelLabel

Definition at line 55 of file mutt_header.c.

56 {
57  struct HashElem *elem = mutt_hash_find_elem(m->label_hash, label);
58  if (!elem)
59  return;
60 
61  uintptr_t count = (uintptr_t) elem->data;
62  if (count <= 1)
63  {
64  mutt_hash_delete(m->label_hash, label, NULL);
65  return;
66  }
67 
68  count--;
69  elem->data = (void *) count;
70 }
void mutt_hash_delete(struct HashTable *table, const char *strkey, const void *data)
Remove an element from a Hash Table.
Definition: hash.c:419
struct HashElem * mutt_hash_find_elem(const struct HashTable *table, const char *strkey)
Find the HashElem in a Hash Table element using a key.
Definition: hash.c:369
The item stored in a Hash Table.
Definition: hash.h:44
void * data
User-supplied data.
Definition: hash.h:47
struct HashTable * label_hash
Hash Table for x-labels.
Definition: mailbox.h:129
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ label_ref_inc()

static void label_ref_inc ( struct Mailbox m,
char *  label 
)
static

Increase the refcount of a label.

Parameters
mMailbox
labelLabel

Definition at line 77 of file mutt_header.c.

78 {
79  uintptr_t count;
80 
81  struct HashElem *elem = mutt_hash_find_elem(m->label_hash, label);
82  if (!elem)
83  {
84  count = 1;
85  mutt_hash_insert(m->label_hash, label, (void *) count);
86  return;
87  }
88 
89  count = (uintptr_t) elem->data;
90  count++;
91  elem->data = (void *) count;
92 }
struct HashElem * mutt_hash_insert(struct HashTable *table, const char *strkey, void *data)
Add a new element to the Hash Table (with string keys)
Definition: hash.c:327
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ label_message()

static bool label_message ( struct Mailbox m,
struct Email e,
char *  new_label 
)
static

Add an X-Label: field.

Parameters
[in]mMailbox
[in]eEmail
[out]new_labelSet to true if this is a new label
Return values
trueThe label was added

Definition at line 101 of file mutt_header.c.

102 {
103  if (!e)
104  return false;
105  if (mutt_str_equal(e->env->x_label, new_label))
106  return false;
107 
108  if (e->env->x_label)
109  label_ref_dec(m, e->env->x_label);
110  if (mutt_str_replace(&e->env->x_label, new_label))
111  label_ref_inc(m, e->env->x_label);
112 
113  e->changed = true;
115  return true;
116 }
#define MUTT_ENV_CHANGED_XLABEL
X-Label edited.
Definition: envelope.h:34
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:904
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:446
static void label_ref_inc(struct Mailbox *m, char *label)
Increase the refcount of a label.
Definition: mutt_header.c:77
static void label_ref_dec(struct Mailbox *m, char *label)
Decrease the refcount of a label.
Definition: mutt_header.c:55
struct Envelope * env
Envelope information.
Definition: email.h:66
bool changed
Email has been edited.
Definition: email.h:75
unsigned char changed
Changed fields, e.g. MUTT_ENV_CHANGED_SUBJECT.
Definition: envelope.h:90
char * x_label
X-Label.
Definition: envelope.h:74
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_label_message()

int mutt_label_message ( struct Mailbox m,
struct EmailList *  el 
)

Let the user label a message.

Parameters
mMailbox
elList of Emails to label
Return values
numNumber of messages changed

Definition at line 124 of file mutt_header.c.

125 {
126  if (!m || !el)
127  return 0;
128 
129  char buf[1024] = { 0 };
130 
131  struct EmailNode *en = STAILQ_FIRST(el);
132  if (!STAILQ_NEXT(en, entries))
133  {
134  // If there's only one email, use its label as a template
135  if (en->email->env->x_label)
136  mutt_str_copy(buf, en->email->env->x_label, sizeof(buf));
137  }
138 
139  if (mutt_get_field("Label: ", buf, sizeof(buf), MUTT_LABEL /* | MUTT_CLEAR */,
140  false, NULL, NULL) != 0)
141  {
142  return 0;
143  }
144 
145  char *new_label = buf;
146  SKIPWS(new_label);
147  if (*new_label == '\0')
148  new_label = NULL;
149 
150  int changed = 0;
151  STAILQ_FOREACH(en, el, entries)
152  {
153  if (label_message(m, en->email, new_label))
154  {
155  changed++;
157  }
158  }
159 
160  return changed;
161 }
int mutt_get_field(const char *field, char *buf, size_t buflen, CompletionFlags complete, bool multiple, char ***files, int *numfiles)
Ask the user for a string.
Definition: curs_lib.c:335
void mutt_set_header_color(struct Mailbox *m, struct Email *e)
Select a colour for a message.
Definition: dlg_index.c:1384
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:749
#define MUTT_LABEL
Do label completion.
Definition: mutt.h:61
static bool label_message(struct Mailbox *m, struct Email *e, char *new_label)
Add an X-Label: field.
Definition: mutt_header.c:101
#define STAILQ_FIRST(head)
Definition: queue.h:350
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define STAILQ_NEXT(elm, field)
Definition: queue.h:400
#define SKIPWS(ch)
Definition: string2.h:46
List of Emails.
Definition: email.h:131
struct Email * email
Email in the list.
Definition: email.h:132
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_edit_headers()

void mutt_edit_headers ( const char *  editor,
const char *  body,
struct Email e,
struct Buffer fcc 
)

Let the user edit the message header and body.

Parameters
editorEditor command
bodyFile containing message body
eEmail
fccBuffer for the fcc field

Definition at line 170 of file mutt_header.c.

172 {
173  char buf[1024];
174  const char *p = NULL;
175  int i;
176  struct Envelope *n = NULL;
177  time_t mtime;
178  struct stat st = { 0 };
179 
180  struct Buffer *path = mutt_buffer_pool_get();
181  mutt_buffer_mktemp(path);
182  FILE *fp_out = mutt_file_fopen(mutt_buffer_string(path), "w");
183  if (!fp_out)
184  {
186  goto cleanup;
187  }
188 
191  false, false, NeoMutt->sub);
192  fputc('\n', fp_out); /* tie off the header. */
193 
194  /* now copy the body of the message. */
195  FILE *fp_in = fopen(body, "r");
196  if (!fp_in)
197  {
198  mutt_perror(body);
199  mutt_file_fclose(&fp_out);
200  goto cleanup;
201  }
202 
203  mutt_file_copy_stream(fp_in, fp_out);
204 
205  mutt_file_fclose(&fp_in);
206  mutt_file_fclose(&fp_out);
207 
208  if (stat(mutt_buffer_string(path), &st) == -1)
209  {
211  goto cleanup;
212  }
213 
214  mtime = mutt_file_decrease_mtime(mutt_buffer_string(path), &st);
215  if (mtime == (time_t) -1)
216  {
218  goto cleanup;
219  }
220 
221  mutt_edit_file(editor, mutt_buffer_string(path));
222  if ((stat(mutt_buffer_string(path), &st) != 0) || (mtime == st.st_mtime))
223  {
224  mutt_debug(LL_DEBUG1, "temp file was not modified\n");
225  /* the file has not changed! */
227  goto cleanup;
228  }
229 
230  mutt_file_unlink(body);
232 
233  /* Read the temp file back in */
234  fp_in = fopen(mutt_buffer_string(path), "r");
235  if (!fp_in)
236  {
238  goto cleanup;
239  }
240 
241  fp_out = mutt_file_fopen(body, "w");
242  if (!fp_out)
243  {
244  /* intentionally leak a possible temporary file here */
245  mutt_file_fclose(&fp_in);
246  mutt_perror(body);
247  goto cleanup;
248  }
249 
250  n = mutt_rfc822_read_header(fp_in, NULL, true, false);
251  while ((i = fread(buf, 1, sizeof(buf), fp_in)) > 0)
252  fwrite(buf, 1, i, fp_out);
253  mutt_file_fclose(&fp_out);
254  mutt_file_fclose(&fp_in);
256 
257  /* in case the user modifies/removes the In-Reply-To header with
258  * $edit_headers set, we remove References: as they're likely invalid;
259  * we can simply compare strings as we don't generate References for
260  * multiple Message-Ids in IRT anyways */
261 #ifdef USE_NNTP
262  if (!OptNewsSend)
263 #endif
264  {
265  if (!STAILQ_EMPTY(&e->env->in_reply_to) &&
266  (STAILQ_EMPTY(&n->in_reply_to) ||
268  STAILQ_FIRST(&e->env->in_reply_to)->data)))
269  {
271  }
272  }
273 
274  /* restore old info. */
277 
278  mutt_env_free(&e->env);
279  e->env = n;
280  n = NULL;
281 
283 
284  /* search through the user defined headers added to see if
285  * fcc: or attach: or pgp: was specified */
286 
287  struct ListNode *np = NULL, *tmp = NULL;
288  STAILQ_FOREACH_SAFE(np, &e->env->userhdrs, entries, tmp)
289  {
290  bool keep = true;
291  size_t plen;
292 
293  if (fcc && (plen = mutt_istr_startswith(np->data, "fcc:")))
294  {
295  p = mutt_str_skip_email_wsp(np->data + plen);
296  if (*p)
297  {
298  mutt_buffer_strcpy(fcc, p);
300  }
301  keep = false;
302  }
303  else if ((plen = mutt_istr_startswith(np->data, "attach:")))
304  {
305  struct Body *body2 = NULL;
306  struct Body *parts = NULL;
307 
308  p = mutt_str_skip_email_wsp(np->data + plen);
309  if (*p)
310  {
311  mutt_buffer_reset(path);
312  for (; (p[0] != '\0') && (p[0] != ' ') && (p[0] != '\t'); p++)
313  {
314  if (p[0] == '\\')
315  {
316  if (p[1] == '\0')
317  break;
318  p++;
319  }
320  mutt_buffer_addch(path, *p);
321  }
323 
326  if (body2)
327  {
328  body2->description = mutt_str_dup(p);
329  for (parts = e->body; parts->next; parts = parts->next)
330  ; // do nothing
331 
332  parts->next = body2;
333  }
334  else
335  {
337  mutt_error(_("%s: unable to attach file"), mutt_buffer_string(path));
338  }
339  }
340  keep = false;
341  }
342  else if (((WithCrypto & APPLICATION_PGP) != 0) &&
343  (plen = mutt_istr_startswith(np->data, "pgp:")))
344  {
346  if (e->security)
348  keep = false;
349  }
350 
351  if (!keep)
352  {
353  STAILQ_REMOVE(&e->env->userhdrs, np, ListNode, entries);
354  FREE(&np->data);
355  FREE(&np);
356  }
357  }
358 
359 cleanup:
361 }
void mutt_expand_aliases_env(struct Envelope *env)
Expand aliases in all the fields of an Envelope.
Definition: alias.c:314
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
size_t mutt_buffer_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:240
void mutt_buffer_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:79
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
void mutt_edit_file(const char *editor, const char *file)
Let the user edit a file.
Definition: curs_lib.c:380
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:96
void mutt_env_to_local(struct Envelope *env)
Convert an Envelope's Address fields to local format.
Definition: envelope.c:275
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition: file.c:271
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:153
time_t mutt_file_decrease_mtime(const char *fp, struct stat *st)
Decrease a file's modification time by 1 second.
Definition: file.c:970
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:593
void mutt_file_unlink(const char *s)
Delete a file, carefully.
Definition: file.c:195
#define mutt_error(...)
Definition: logging.h:87
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
#define mutt_perror(...)
Definition: logging.h:88
int mutt_rfc822_write_header(FILE *fp, struct Envelope *env, struct Body *attach, enum MuttWriteHeaderMode mode, bool privacy, bool hide_protected_subject, struct ConfigSubset *sub)
Write out one RFC822 header line.
Definition: header.c:572
@ MUTT_WRITE_HEADER_EDITHDRS
"light" mode (used for edit_hdrs)
Definition: header.h:43
void mutt_list_free(struct ListHead *h)
Free a List AND its strings.
Definition: list.c:122
@ LL_DEBUG1
Log at debug level 1.
Definition: logging.h:40
#define FREE(x)
Definition: memory.h:40
#define _(a)
Definition: message.h:28
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:370
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition: string.c:776
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:172
void mutt_buffer_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:603
void mutt_buffer_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:322
#define mutt_buffer_mktemp(buf)
Definition: muttlib.h:74
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:87
#define WithCrypto
Definition: lib.h:113
bool OptNewsSend
(pseudo) used to change behavior when posting
Definition: options.h:51
struct Envelope * mutt_rfc822_read_header(FILE *fp, struct Email *e, bool user_hdrs, bool weed)
Parses an RFC822 header.
Definition: parse.c:1168
static size_t plen
Length of cached packet.
Definition: pgppacket.c:39
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
SecurityFlags mutt_parse_crypt_hdr(const char *p, bool set_empty_signas, SecurityFlags crypt_app)
Parse a crypto header string.
Definition: postpone.c:211
#define STAILQ_REMOVE(head, elm, type, field)
Definition: queue.h:402
#define STAILQ_EMPTY(head)
Definition: queue.h:348
#define STAILQ_FOREACH_SAFE(var, head, field, tvar)
Definition: queue.h:362
#define STAILQ_SWAP(head1, head2, type)
Definition: queue.h:428
struct Body * mutt_make_file_attach(const char *path, struct ConfigSubset *sub)
Create a file attachment.
Definition: sendlib.c:1093
The body of an email.
Definition: body.h:35
struct Body * parts
parts of a multipart or message/rfc822
Definition: body.h:71
char * description
content-description
Definition: body.h:54
struct Body * next
next attachment in the list
Definition: body.h:70
String manipulation buffer.
Definition: buffer.h:34
SecurityFlags security
bit 0-10: flags, bit 11,12: application, bit 13: traditional pgp See: ncrypt/lib.h pgplib....
Definition: email.h:41
struct Body * body
List of MIME parts.
Definition: email.h:67
The header of an Email.
Definition: envelope.h:55
struct ListHead userhdrs
user defined headers
Definition: envelope.h:85
struct ListHead references
message references (in reverse order)
Definition: envelope.h:83
struct ListHead in_reply_to
in-reply-to header content
Definition: envelope.h:84
A List node for strings.
Definition: list.h:35
char * data
String.
Definition: list.h:36
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_make_label_hash()

void mutt_make_label_hash ( struct Mailbox m)

Create a Hash Table to store the labels.

Parameters
mMailbox

Definition at line 367 of file mutt_header.c.

368 {
369  /* 131 is just a rough prime estimate of how many distinct
370  * labels someone might have in a m. */
372 }
struct HashTable * mutt_hash_new(size_t num_elems, HashFlags flags)
Create a new Hash Table (with string keys)
Definition: hash.c:251
#define MUTT_HASH_STRDUP_KEYS
make a copy of the keys
Definition: hash.h:111
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_label_hash_add()

void mutt_label_hash_add ( struct Mailbox m,
struct Email e 
)

Add a message's labels to the Hash Table.

Parameters
mMailbox
eEmail

Definition at line 379 of file mutt_header.c.

380 {
381  if (!m || !m->label_hash)
382  return;
383  if (e->env->x_label)
384  label_ref_inc(m, e->env->x_label);
385 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_label_hash_remove()

void mutt_label_hash_remove ( struct Mailbox m,
struct Email e 
)

Remove a message's labels from the Hash Table.

Parameters
mMailbox
eEmail

Definition at line 392 of file mutt_header.c.

393 {
394  if (!m || !m->label_hash)
395  return;
396  if (e->env->x_label)
397  label_ref_dec(m, e->env->x_label);
398 }
+ Here is the call graph for this function:
+ Here is the caller graph for this function: