NeoMutt  2022-04-29-70-g0c028c
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 "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 "postpone/lib.h"
#include "send/lib.h"
#include "muttlib.h"
#include "options.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 54 of file mutt_header.c.

55 {
56  struct HashElem *elem = mutt_hash_find_elem(m->label_hash, label);
57  if (!elem)
58  return;
59 
60  uintptr_t count = (uintptr_t) elem->data;
61  if (count <= 1)
62  {
63  mutt_hash_delete(m->label_hash, label, NULL);
64  return;
65  }
66 
67  count--;
68  elem->data = (void *) count;
69 }
void mutt_hash_delete(struct HashTable *table, const char *strkey, const void *data)
Remove an element from a Hash Table.
Definition: hash.c:427
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:377
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:126
+ 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 76 of file mutt_header.c.

77 {
78  uintptr_t count;
79 
80  struct HashElem *elem = mutt_hash_find_elem(m->label_hash, label);
81  if (!elem)
82  {
83  count = 1;
84  mutt_hash_insert(m->label_hash, label, (void *) count);
85  return;
86  }
87 
88  count = (uintptr_t) elem->data;
89  count++;
90  elem->data = (void *) count;
91 }
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:335
+ 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 100 of file mutt_header.c.

101 {
102  if (!e)
103  return false;
104  if (mutt_str_equal(e->env->x_label, new_label))
105  return false;
106 
107  if (e->env->x_label)
108  label_ref_dec(m, e->env->x_label);
109  if (mutt_str_replace(&e->env->x_label, new_label))
110  label_ref_inc(m, e->env->x_label);
111 
112  e->changed = true;
114  return true;
115 }
#define MUTT_ENV_CHANGED_XLABEL
X-Label edited.
Definition: envelope.h:36
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:784
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:326
static void label_ref_inc(struct Mailbox *m, char *label)
Increase the refcount of a label.
Definition: mutt_header.c:76
static void label_ref_dec(struct Mailbox *m, char *label)
Decrease the refcount of a label.
Definition: mutt_header.c:54
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:92
char * x_label
X-Label.
Definition: envelope.h:76
+ 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 123 of file mutt_header.c.

124 {
125  if (!m || !el)
126  return 0;
127 
128  int changed = 0;
129  struct Buffer *buf = mutt_buffer_pool_get();
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_buffer_strcpy(buf, en->email->env->x_label);
137  }
138 
139  if (mutt_buffer_get_field("Label: ", buf, MUTT_COMP_LABEL /* | MUTT_COMP_CLEAR */,
140  false, NULL, NULL, NULL) != 0)
141  {
142  goto done;
143  }
144 
145  char *new_label = buf->data;
146  SKIPWS(new_label);
147  if (*new_label == '\0')
148  new_label = NULL;
149 
150  STAILQ_FOREACH(en, el, entries)
151  {
152  if (label_message(m, en->email, new_label))
153  {
154  changed++;
156  }
157  }
158 
159 done:
161  return changed;
162 }
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
int mutt_buffer_get_field(const char *field, struct Buffer *buf, CompletionFlags complete, bool multiple, struct Mailbox *m, char ***files, int *numfiles)
Ask the user for a string.
Definition: curs_lib.c:337
void mutt_set_header_color(struct Mailbox *m, struct Email *e)
Select a colour for a message.
Definition: dlg_index.c:1330
#define MUTT_COMP_LABEL
Label completion.
Definition: mutt.h:58
static bool label_message(struct Mailbox *m, struct Email *e, char *new_label)
Add an X-Label: field.
Definition: mutt_header.c:100
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
#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
String manipulation buffer.
Definition: buffer.h:34
char * data
Pointer to data.
Definition: buffer.h:35
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 171 of file mutt_header.c.

173 {
174  struct Buffer *path = mutt_buffer_pool_get();
175  mutt_buffer_mktemp(path);
176  FILE *fp_out = mutt_file_fopen(mutt_buffer_string(path), "w");
177  if (!fp_out)
178  {
180  goto cleanup;
181  }
182 
185  false, false, NeoMutt->sub);
186  fputc('\n', fp_out); /* tie off the header. */
187 
188  /* now copy the body of the message. */
189  FILE *fp_in = fopen(body, "r");
190  if (!fp_in)
191  {
192  mutt_perror(body);
193  mutt_file_fclose(&fp_out);
194  goto cleanup;
195  }
196 
197  mutt_file_copy_stream(fp_in, fp_out);
198 
199  mutt_file_fclose(&fp_in);
200  mutt_file_fclose(&fp_out);
201 
202  struct stat st = { 0 };
203  if (stat(mutt_buffer_string(path), &st) == -1)
204  {
206  goto cleanup;
207  }
208 
209  time_t mtime = mutt_file_decrease_mtime(mutt_buffer_string(path), &st);
210  if (mtime == (time_t) -1)
211  {
213  goto cleanup;
214  }
215 
216  mutt_edit_file(editor, mutt_buffer_string(path));
217  if ((stat(mutt_buffer_string(path), &st) != 0) || (mtime == st.st_mtime))
218  {
219  mutt_debug(LL_DEBUG1, "temp file was not modified\n");
220  /* the file has not changed! */
222  goto cleanup;
223  }
224 
225  mutt_file_unlink(body);
227 
228  /* Read the temp file back in */
229  fp_in = fopen(mutt_buffer_string(path), "r");
230  if (!fp_in)
231  {
233  goto cleanup;
234  }
235 
236  fp_out = mutt_file_fopen(body, "w");
237  if (!fp_out)
238  {
239  /* intentionally leak a possible temporary file here */
240  mutt_file_fclose(&fp_in);
241  mutt_perror(body);
242  goto cleanup;
243  }
244 
245  struct Envelope *env_new = NULL;
246  char buf[1024];
247  env_new = mutt_rfc822_read_header(fp_in, NULL, true, false);
248  int bytes_read;
249  while ((bytes_read = fread(buf, 1, sizeof(buf), fp_in)) > 0)
250  fwrite(buf, 1, bytes_read, fp_out);
251  mutt_file_fclose(&fp_out);
252  mutt_file_fclose(&fp_in);
254 
255  /* in case the user modifies/removes the In-Reply-To header with
256  * $edit_headers set, we remove References: as they're likely invalid;
257  * we can simply compare strings as we don't generate References for
258  * multiple Message-Ids in IRT anyways */
259 #ifdef USE_NNTP
260  if (!OptNewsSend)
261 #endif
262  {
263  if (!STAILQ_EMPTY(&e->env->in_reply_to) &&
264  (STAILQ_EMPTY(&env_new->in_reply_to) ||
265  !mutt_str_equal(STAILQ_FIRST(&env_new->in_reply_to)->data,
266  STAILQ_FIRST(&e->env->in_reply_to)->data)))
267  {
269  }
270  }
271 
272  /* restore old info. */
273  mutt_list_free(&env_new->references);
274  STAILQ_SWAP(&env_new->references, &e->env->references, ListNode);
275 
276  mutt_env_free(&e->env);
277  e->env = env_new;
278  env_new = NULL;
279 
281 
282  /* search through the user defined headers added to see if
283  * fcc: or attach: or pgp: was specified */
284 
285  struct ListNode *np = NULL, *tmp = NULL;
286  STAILQ_FOREACH_SAFE(np, &e->env->userhdrs, entries, tmp)
287  {
288  bool keep = true;
289  size_t plen;
290 
291  if (fcc && (plen = mutt_istr_startswith(np->data, "fcc:")))
292  {
293  const char *p = mutt_str_skip_email_wsp(np->data + plen);
294  if (*p)
295  {
296  mutt_buffer_strcpy(fcc, p);
298  }
299  keep = false;
300  }
301  else if ((plen = mutt_istr_startswith(np->data, "attach:")))
302  {
303  struct Body *body2 = NULL;
304  struct Body *parts = NULL;
305 
306  const char *p = mutt_str_skip_email_wsp(np->data + plen);
307  if (*p)
308  {
309  mutt_buffer_reset(path);
310  for (; (p[0] != '\0') && (p[0] != ' ') && (p[0] != '\t'); p++)
311  {
312  if (p[0] == '\\')
313  {
314  if (p[1] == '\0')
315  break;
316  p++;
317  }
318  mutt_buffer_addch(path, *p);
319  }
321 
324  if (body2)
325  {
326  body2->description = mutt_str_dup(p);
327  for (parts = e->body; parts->next; parts = parts->next)
328  ; // do nothing
329 
330  parts->next = body2;
331  }
332  else
333  {
335  mutt_error(_("%s: unable to attach file"), mutt_buffer_string(path));
336  }
337  }
338  keep = false;
339  }
340  else if (((WithCrypto & APPLICATION_PGP) != 0) &&
341  (plen = mutt_istr_startswith(np->data, "pgp:")))
342  {
344  if (sec != SEC_NO_FLAGS)
345  sec |= APPLICATION_PGP;
346  if (sec != e->security)
347  {
348  e->security = sec;
350  }
351  keep = false;
352  }
353 
354  if (!keep)
355  {
356  STAILQ_REMOVE(&e->env->userhdrs, np, ListNode, entries);
357  FREE(&np->data);
358  FREE(&np);
359  }
360  }
361 
362 cleanup:
364 }
void mutt_expand_aliases_env(struct Envelope *env)
Expand aliases in all the fields of an Envelope.
Definition: alias.c:311
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:423
@ NT_EMAIL_CHANGE
Email has changed.
Definition: email.h:150
void mutt_env_free(struct Envelope **ptr)
Free an Envelope.
Definition: envelope.c:97
void mutt_env_to_local(struct Envelope *env)
Convert an Envelope's Address fields to local format.
Definition: envelope.c:288
int mutt_file_copy_stream(FILE *fp_in, FILE *fp_out)
Copy the contents of one file into another.
Definition: file.c:260
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:152
time_t mutt_file_decrease_mtime(const char *fp, struct stat *st)
Decrease a file's modification time by 1 second.
Definition: file.c:1019
FILE * mutt_file_fopen(const char *path, const char *mode)
Call fopen() safely.
Definition: file.c:618
void mutt_file_unlink(const char *s)
Delete a file, carefully.
Definition: file.c:194
#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
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:250
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition: string.c:656
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:239
void mutt_buffer_pretty_mailbox(struct Buffer *buf)
Shorten a mailbox path using '~' or '='.
Definition: muttlib.c:598
void mutt_buffer_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:321
#define mutt_buffer_mktemp(buf)
Definition: muttlib.h:74
uint16_t SecurityFlags
Flags, e.g. SEC_ENCRYPT.
Definition: lib.h:74
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:90
#define SEC_NO_FLAGS
No flags are set.
Definition: lib.h:77
#define WithCrypto
Definition: lib.h:116
@ NT_EMAIL
Email has changed, NotifyEmail, EventEmail.
Definition: notify_type.h:44
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:1158
static size_t plen
Length of cached packet.
Definition: pgppacket.c:39
SecurityFlags mutt_parse_crypt_hdr(const char *p, bool set_empty_signas, SecurityFlags crypt_app)
Parse a crypto header string.
Definition: postpone.c:210
#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:598
The body of an email.
Definition: body.h:36
struct Body * parts
parts of a multipart or message/rfc822
Definition: body.h:72
char * description
content-description
Definition: body.h:55
struct Body * next
next attachment in the list
Definition: body.h:71
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
struct Notify * notify
Notifications: NotifyEmail, EventEmail.
Definition: email.h:71
The header of an Email.
Definition: envelope.h:57
struct ListHead userhdrs
user defined headers
Definition: envelope.h:87
struct ListHead references
message references (in reverse order)
Definition: envelope.h:85
struct ListHead in_reply_to
in-reply-to header content
Definition: envelope.h:86
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 370 of file mutt_header.c.

371 {
372  /* 131 is just a rough prime estimate of how many distinct
373  * labels someone might have in a m. */
375 }
struct HashTable * mutt_hash_new(size_t num_elems, HashFlags flags)
Create a new Hash Table (with string keys)
Definition: hash.c:259
#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 382 of file mutt_header.c.

383 {
384  if (!m || !m->label_hash)
385  return;
386  if (e->env->x_label)
387  label_ref_inc(m, e->env->x_label);
388 }
+ 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 395 of file mutt_header.c.

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