NeoMutt  2021-10-29-33-g41675a
Teaching an old dog new tricks
DOXYGEN
mailcap.c
Go to the documentation of this file.
1 
35 #include "config.h"
36 #include <stdbool.h>
37 #include <stdio.h>
38 #include <string.h>
39 #include "mutt/lib.h"
40 #include "config/lib.h"
41 #include "email/lib.h"
42 #include "core/lib.h"
43 #include "mailcap.h"
44 #include "attach/lib.h"
45 #include "muttlib.h"
46 #include "protos.h"
47 
67 int mailcap_expand_command(struct Body *a, const char *filename,
68  const char *type, struct Buffer *command)
69 {
70  int needspipe = true;
71  struct Buffer *buf = mutt_buffer_pool_get();
72  struct Buffer *quoted = mutt_buffer_pool_get();
73  struct Buffer *param = NULL;
74  struct Buffer *type2 = NULL;
75 
76  const bool c_mailcap_sanitize =
77  cs_subset_bool(NeoMutt->sub, "mailcap_sanitize");
78  const char *cptr = mutt_buffer_string(command);
79  while (*cptr)
80  {
81  if (*cptr == '\\')
82  {
83  cptr++;
84  if (*cptr)
85  mutt_buffer_addch(buf, *cptr++);
86  }
87  else if (*cptr == '%')
88  {
89  cptr++;
90  if (*cptr == '{')
91  {
92  const char *pvalue2 = NULL;
93 
94  if (param)
95  mutt_buffer_reset(param);
96  else
97  param = mutt_buffer_pool_get();
98 
99  /* Copy parameter name into param buffer */
100  cptr++;
101  while (*cptr && (*cptr != '}'))
102  mutt_buffer_addch(param, *cptr++);
103 
104  /* In send mode, use the current charset, since the message hasn't
105  * been converted yet. If noconv is set, then we assume the
106  * charset parameter has the correct value instead. */
107  if (mutt_istr_equal(mutt_buffer_string(param), "charset") && a->charset && !a->noconv)
108  pvalue2 = a->charset;
109  else
110  pvalue2 = mutt_param_get(&a->parameter, mutt_buffer_string(param));
111 
112  /* Now copy the parameter value into param buffer */
113  if (c_mailcap_sanitize)
114  mutt_buffer_sanitize_filename(param, NONULL(pvalue2), false);
115  else
116  mutt_buffer_strcpy(param, NONULL(pvalue2));
117 
118  mutt_buffer_quote_filename(quoted, mutt_buffer_string(param), true);
120  }
121  else if ((*cptr == 's') && filename)
122  {
123  mutt_buffer_quote_filename(quoted, filename, true);
125  needspipe = false;
126  }
127  else if (*cptr == 't')
128  {
129  if (!type2)
130  {
131  type2 = mutt_buffer_pool_get();
132  if (c_mailcap_sanitize)
133  mutt_buffer_sanitize_filename(type2, type, false);
134  else
135  mutt_buffer_strcpy(type2, type);
136  }
137  mutt_buffer_quote_filename(quoted, mutt_buffer_string(type2), true);
139  }
140 
141  if (*cptr)
142  cptr++;
143  }
144  else
145  mutt_buffer_addch(buf, *cptr++);
146  }
147  mutt_buffer_copy(command, buf);
148 
150  mutt_buffer_pool_release(&quoted);
151  mutt_buffer_pool_release(&param);
152  mutt_buffer_pool_release(&type2);
153 
154  return needspipe;
155 }
156 
163 static char *get_field(char *s)
164 {
165  if (!s)
166  return NULL;
167 
168  char *ch = NULL;
169 
170  while ((ch = strpbrk(s, ";\\")))
171  {
172  if (*ch == '\\')
173  {
174  s = ch + 1;
175  if (*s)
176  s++;
177  }
178  else
179  {
180  *ch = '\0';
181  ch = mutt_str_skip_email_wsp(ch + 1);
182  break;
183  }
184  }
186  return ch;
187 }
188 
199 static int get_field_text(char *field, char **entry, const char *type,
200  const char *filename, int line)
201 {
202  field = mutt_str_skip_whitespace(field);
203  if (*field == '=')
204  {
205  if (entry)
206  {
207  field++;
208  field = mutt_str_skip_whitespace(field);
209  mutt_str_replace(entry, field);
210  }
211  return 1;
212  }
213  else
214  {
215  mutt_error(_("Improperly formatted entry for type %s in \"%s\" line %d"),
216  type, filename, line);
217  return 0;
218  }
219 }
220 
231 static bool rfc1524_mailcap_parse(struct Body *a, const char *filename, const char *type,
232  struct MailcapEntry *entry, enum MailcapLookup opt)
233 {
234  char *buf = NULL;
235  bool found = false;
236  int line = 0;
237 
238  /* rfc1524 mailcap file is of the format:
239  * base/type; command; extradefs
240  * type can be * for matching all
241  * base with no /type is an implicit wild
242  * command contains a %s for the filename to pass, default to pipe on stdin
243  * extradefs are of the form:
244  * def1="definition"; def2="define \;";
245  * line wraps with a \ at the end of the line
246  * # for comments */
247 
248  /* find length of basetype */
249  char *ch = strchr(type, '/');
250  if (!ch)
251  return false;
252  const int btlen = ch - type;
253 
254  FILE *fp = fopen(filename, "r");
255  if (fp)
256  {
257  size_t buflen;
258  while (!found && (buf = mutt_file_read_line(buf, &buflen, fp, &line, MUTT_RL_CONT)))
259  {
260  /* ignore comments */
261  if (*buf == '#')
262  continue;
263  mutt_debug(LL_DEBUG2, "mailcap entry: %s\n", buf);
264 
265  /* check type */
266  ch = get_field(buf);
267  if (!mutt_istr_equal(buf, type) && (!mutt_istrn_equal(buf, type, btlen) ||
268  ((buf[btlen] != '\0') && /* implicit wild */
269  !mutt_str_equal(buf + btlen, "/*")))) /* wildsubtype */
270  {
271  continue;
272  }
273 
274  /* next field is the viewcommand */
275  char *field = ch;
276  ch = get_field(ch);
277  if (entry)
278  entry->command = mutt_str_dup(field);
279 
280  /* parse the optional fields */
281  found = true;
282  bool copiousoutput = false;
283  bool composecommand = false;
284  bool editcommand = false;
285  bool printcommand = false;
286 
287  while (ch)
288  {
289  field = ch;
290  ch = get_field(ch);
291  mutt_debug(LL_DEBUG2, "field: %s\n", field);
292  size_t plen;
293 
294  if (mutt_istr_equal(field, "needsterminal"))
295  {
296  if (entry)
297  entry->needsterminal = true;
298  }
299  else if (mutt_istr_equal(field, "copiousoutput"))
300  {
301  copiousoutput = true;
302  if (entry)
303  entry->copiousoutput = true;
304  }
305  else if ((plen = mutt_istr_startswith(field, "composetyped")))
306  {
307  /* this compare most occur before compose to match correctly */
308  if (get_field_text(field + plen, entry ? &entry->composetypecommand : NULL,
309  type, filename, line))
310  {
311  composecommand = true;
312  }
313  }
314  else if ((plen = mutt_istr_startswith(field, "compose")))
315  {
316  if (get_field_text(field + plen, entry ? &entry->composecommand : NULL,
317  type, filename, line))
318  {
319  composecommand = true;
320  }
321  }
322  else if ((plen = mutt_istr_startswith(field, "print")))
323  {
324  if (get_field_text(field + plen, entry ? &entry->printcommand : NULL,
325  type, filename, line))
326  {
327  printcommand = true;
328  }
329  }
330  else if ((plen = mutt_istr_startswith(field, "edit")))
331  {
332  if (get_field_text(field + plen, entry ? &entry->editcommand : NULL,
333  type, filename, line))
334  {
335  editcommand = true;
336  }
337  }
338  else if ((plen = mutt_istr_startswith(field, "nametemplate")))
339  {
340  get_field_text(field + plen, entry ? &entry->nametemplate : NULL,
341  type, filename, line);
342  }
343  else if ((plen = mutt_istr_startswith(field, "x-convert")))
344  {
345  get_field_text(field + plen, entry ? &entry->convert : NULL, type, filename, line);
346  }
347  else if ((plen = mutt_istr_startswith(field, "test")))
348  {
349  /* This routine executes the given test command to determine
350  * if this is the right entry. */
351  char *test_command = NULL;
352 
353  if (get_field_text(field + plen, &test_command, type, filename, line) && test_command)
354  {
355  struct Buffer *command = mutt_buffer_pool_get();
356  struct Buffer *afilename = mutt_buffer_pool_get();
357  mutt_buffer_strcpy(command, test_command);
358  const bool c_mailcap_sanitize =
359  cs_subset_bool(NeoMutt->sub, "mailcap_sanitize");
360  if (c_mailcap_sanitize)
361  mutt_buffer_sanitize_filename(afilename, NONULL(a->filename), true);
362  else
363  mutt_buffer_strcpy(afilename, NONULL(a->filename));
364  mailcap_expand_command(a, mutt_buffer_string(afilename), type, command);
365  if (mutt_system(mutt_buffer_string(command)))
366  {
367  /* a non-zero exit code means test failed */
368  found = false;
369  }
370  FREE(&test_command);
371  mutt_buffer_pool_release(&command);
372  mutt_buffer_pool_release(&afilename);
373  }
374  }
375  else if (mutt_istr_startswith(field, "x-neomutt-keep"))
376  {
377  if (entry)
378  entry->xneomuttkeep = true;
379  }
380  else if (mutt_istr_startswith(field, "x-neomutt-nowrap"))
381  {
382  if (entry)
383  entry->xneomuttnowrap = true;
384  a->nowrap = true;
385  }
386  } /* while (ch) */
387 
388  if (opt == MUTT_MC_AUTOVIEW)
389  {
390  if (!copiousoutput)
391  found = false;
392  }
393  else if (opt == MUTT_MC_COMPOSE)
394  {
395  if (!composecommand)
396  found = false;
397  }
398  else if (opt == MUTT_MC_EDIT)
399  {
400  if (!editcommand)
401  found = false;
402  }
403  else if (opt == MUTT_MC_PRINT)
404  {
405  if (!printcommand)
406  found = false;
407  }
408 
409  if (!found)
410  {
411  /* reset */
412  if (entry)
413  {
414  FREE(&entry->command);
415  FREE(&entry->composecommand);
416  FREE(&entry->composetypecommand);
417  FREE(&entry->editcommand);
418  FREE(&entry->printcommand);
419  FREE(&entry->nametemplate);
420  FREE(&entry->convert);
421  entry->needsterminal = false;
422  entry->copiousoutput = false;
423  entry->xneomuttkeep = false;
424  }
425  }
426  } /* while (!found && (buf = mutt_file_read_line ())) */
427  mutt_file_fclose(&fp);
428  } /* if ((fp = fopen ())) */
429  FREE(&buf);
430  return found;
431 }
432 
438 {
439  return mutt_mem_calloc(1, sizeof(struct MailcapEntry));
440 }
441 
447 {
448  if (!ptr || !*ptr)
449  return;
450 
451  struct MailcapEntry *me = *ptr;
452 
453  FREE(&me->command);
454  FREE(&me->testcommand);
455  FREE(&me->composecommand);
456  FREE(&me->composetypecommand);
457  FREE(&me->editcommand);
458  FREE(&me->printcommand);
459  FREE(&me->nametemplate);
460  FREE(ptr);
461 }
462 
475 bool mailcap_lookup(struct Body *a, char *type, size_t typelen,
476  struct MailcapEntry *entry, enum MailcapLookup opt)
477 {
478  /* rfc1524 specifies that a path of mailcap files should be searched.
479  * joy. They say
480  * $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap, etc
481  * and overridden by the MAILCAPS environment variable, and, just to be nice,
482  * we'll make it specifiable in .neomuttrc */
483  const struct Slist *c_mailcap_path =
484  cs_subset_slist(NeoMutt->sub, "mailcap_path");
485  if (!c_mailcap_path || (c_mailcap_path->count == 0))
486  {
487  /* L10N:
488  Mutt is trying to look up a mailcap value, but $mailcap_path is empty.
489  We added a reference to the MAILCAPS environment variable as a hint too.
490 
491  Because the variable is automatically populated by Mutt, this
492  should only occur if the user deliberately runs in their shell:
493  export MAILCAPS=
494 
495  or deliberately runs inside Mutt or their .muttrc:
496  set mailcap_path=""
497  -or-
498  unset mailcap_path
499  */
500  mutt_error(_("Neither mailcap_path nor MAILCAPS specified"));
501  return false;
502  }
503 
504  mutt_check_lookup_list(a, type, typelen);
505 
506  struct Buffer *path = mutt_buffer_pool_get();
507  bool found = false;
508 
509  struct ListNode *np = NULL;
510  STAILQ_FOREACH(np, &c_mailcap_path->head, entries)
511  {
512  mutt_buffer_strcpy(path, np->data);
514 
515  mutt_debug(LL_DEBUG2, "Checking mailcap file: %s\n", mutt_buffer_string(path));
516  found = rfc1524_mailcap_parse(a, mutt_buffer_string(path), type, entry, opt);
517  if (found)
518  break;
519  }
520 
522 
523  if (entry && !found)
524  mutt_error(_("mailcap entry for type %s not found"), type);
525 
526  return found;
527 }
528 
545 void mailcap_expand_filename(const char *nametemplate, const char *oldfile,
546  struct Buffer *newfile)
547 {
548  int i, j, k;
549  char *s = NULL;
550  bool lmatch = false, rmatch = false;
551 
552  mutt_buffer_reset(newfile);
553 
554  /* first, ignore leading path components */
555 
556  if (nametemplate && (s = strrchr(nametemplate, '/')))
557  nametemplate = s + 1;
558 
559  if (oldfile && (s = strrchr(oldfile, '/')))
560  oldfile = s + 1;
561 
562  if (!nametemplate)
563  {
564  if (oldfile)
565  mutt_buffer_strcpy(newfile, oldfile);
566  }
567  else if (!oldfile)
568  {
569  mutt_file_expand_fmt(newfile, nametemplate, "neomutt");
570  }
571  else /* oldfile && nametemplate */
572  {
573  /* first, compare everything left from the "%s"
574  * (if there is one). */
575 
576  lmatch = true;
577  bool ps = false;
578  for (i = 0; nametemplate[i]; i++)
579  {
580  if ((nametemplate[i] == '%') && (nametemplate[i + 1] == 's'))
581  {
582  ps = true;
583  break;
584  }
585 
586  /* note that the following will _not_ read beyond oldfile's end. */
587 
588  if (lmatch && (nametemplate[i] != oldfile[i]))
589  lmatch = false;
590  }
591 
592  if (ps)
593  {
594  /* If we had a "%s", check the rest. */
595 
596  /* now, for the right part: compare everything right from
597  * the "%s" to the final part of oldfile.
598  *
599  * The logic here is as follows:
600  *
601  * - We start reading from the end.
602  * - There must be a match _right_ from the "%s",
603  * thus the i + 2.
604  * - If there was a left hand match, this stuff
605  * must not be counted again. That's done by the
606  * condition (j >= (lmatch ? i : 0)). */
607 
608  rmatch = true;
609 
610  for (j = mutt_str_len(oldfile) - 1, k = mutt_str_len(nametemplate) - 1;
611  (j >= (lmatch ? i : 0)) && (k >= (i + 2)); j--, k--)
612  {
613  if (nametemplate[k] != oldfile[j])
614  {
615  rmatch = false;
616  break;
617  }
618  }
619 
620  /* Now, check if we had a full match. */
621 
622  if (k >= i + 2)
623  rmatch = false;
624 
625  struct Buffer *left = mutt_buffer_pool_get();
626  struct Buffer *right = mutt_buffer_pool_get();
627 
628  if (!lmatch)
629  mutt_buffer_strcpy_n(left, nametemplate, i);
630  if (!rmatch)
631  mutt_buffer_strcpy(right, nametemplate + i + 2);
632  mutt_buffer_printf(newfile, "%s%s%s", mutt_buffer_string(left), oldfile,
633  mutt_buffer_string(right));
634 
636  mutt_buffer_pool_release(&right);
637  }
638  else
639  {
640  /* no "%s" in the name template. */
641  mutt_buffer_strcpy(newfile, nametemplate);
642  }
643  }
644 
645  mutt_adv_mktemp(newfile);
646 }
GUI display the mailboxes in a side panel.
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
size_t mutt_buffer_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:225
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
size_t mutt_buffer_copy(struct Buffer *dst, const struct Buffer *src)
Copy a Buffer's contents to another Buffer.
Definition: buffer.c:445
void mutt_buffer_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:79
size_t mutt_buffer_strcpy_n(struct Buffer *buf, const char *s, size_t len)
Copy a string into a Buffer.
Definition: buffer.c:327
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
Convenience wrapper for the config headers.
Convenience wrapper for the core headers.
Structs that make up an email.
int mutt_file_fclose(FILE **fp)
Close a FILE handle (and NULL the pointer)
Definition: file.c:153
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:695
void mutt_buffer_quote_filename(struct Buffer *buf, const char *filename, bool add_outer)
Quote a filename to survive the shell's quoting rules.
Definition: file.c:866
void mutt_file_expand_fmt(struct Buffer *dest, const char *fmt, const char *src)
Replace s in a string with a filename.
Definition: file.c:1478
#define MUTT_RL_CONT
-continuation
Definition: file.h:39
#define mutt_error(...)
Definition: logging.h:87
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
const struct Slist * cs_subset_slist(const struct ConfigSubset *sub, const char *name)
Get a string-list config item by name.
Definition: helpers.c:268
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
@ LL_DEBUG2
Log at debug level 2.
Definition: logging.h:41
struct MailcapEntry * mailcap_entry_new(void)
Allocate memory for a new rfc1524 entry.
Definition: mailcap.c:437
bool mailcap_lookup(struct Body *a, char *type, size_t typelen, struct MailcapEntry *entry, enum MailcapLookup opt)
Find given type in the list of mailcap files.
Definition: mailcap.c:475
void mailcap_entry_free(struct MailcapEntry **ptr)
Deallocate an struct MailcapEntry.
Definition: mailcap.c:446
static bool rfc1524_mailcap_parse(struct Body *a, const char *filename, const char *type, struct MailcapEntry *entry, enum MailcapLookup opt)
Parse a mailcap entry.
Definition: mailcap.c:231
static int get_field_text(char *field, char **entry, const char *type, const char *filename, int line)
Get the matching text from a mailcap.
Definition: mailcap.c:199
int mailcap_expand_command(struct Body *a, const char *filename, const char *type, struct Buffer *command)
Expand expandos in a command.
Definition: mailcap.c:67
void mailcap_expand_filename(const char *nametemplate, const char *oldfile, struct Buffer *newfile)
Expand a new filename from a template or existing filename.
Definition: mailcap.c:545
static char * get_field(char *s)
NUL terminate a RFC1524 field.
Definition: mailcap.c:163
RFC1524 Mailcap routines.
MailcapLookup
Mailcap actions.
Definition: mailcap.h:55
@ MUTT_MC_PRINT
Mailcap print field.
Definition: mailcap.h:59
@ MUTT_MC_EDIT
Mailcap edit field.
Definition: mailcap.h:57
@ MUTT_MC_AUTOVIEW
Mailcap autoview field.
Definition: mailcap.h:60
@ MUTT_MC_COMPOSE
Mailcap compose field.
Definition: mailcap.h:58
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
#define FREE(x)
Definition: memory.h:40
Convenience wrapper for the library headers.
#define _(a)
Definition: message.h:28
void mutt_str_remove_trailing_ws(char *s)
Trim trailing whitespace from a string.
Definition: string.c:544
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:727
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:181
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:715
char * mutt_str_skip_whitespace(const char *p)
Find the first non-whitespace character in a string.
Definition: string.c:530
char * mutt_str_skip_email_wsp(const char *s)
Skip over whitespace as defined by RFC5322.
Definition: string.c:587
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:475
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:257
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:170
bool mutt_istrn_equal(const char *a, const char *b, size_t num)
Check for equality of two strings ignoring case (to a maximum), safely.
Definition: string.c:432
void mutt_check_lookup_list(struct Body *b, char *type, size_t len)
Update the mime type.
Definition: mutt_attach.c:340
void mutt_buffer_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:322
void mutt_adv_mktemp(struct Buffer *buf)
Create a temporary file.
Definition: muttlib.c:83
void mutt_buffer_sanitize_filename(struct Buffer *buf, const char *path, short slash)
Replace unsafe characters in a filename.
Definition: muttlib.c:1657
Some miscellaneous functions.
char * mutt_param_get(const struct ParameterList *pl, const char *s)
Find a matching Parameter.
Definition: parameter.c:84
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
Prototypes for many functions.
int mutt_system(const char *cmd)
Run an external command.
Definition: system.c:51
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
#define NONULL(x)
Definition: string2.h:37
The body of an email.
Definition: body.h:35
bool noconv
Don't do character set conversion.
Definition: body.h:45
char * charset
Send mode: charset of attached file as stored on disk.
Definition: body.h:77
struct ParameterList parameter
Parameters of the content-type.
Definition: body.h:61
bool nowrap
Do not wrap the output in the pager.
Definition: body.h:88
char * filename
When sending a message, this is the file to which this structure refers.
Definition: body.h:57
String manipulation buffer.
Definition: buffer.h:34
A List node for strings.
Definition: list.h:35
char * data
String.
Definition: list.h:36
A mailcap entry.
Definition: mailcap.h:36
char * composecommand
Definition: mailcap.h:39
bool needsterminal
endwin() and system
Definition: mailcap.h:45
char * testcommand
Definition: mailcap.h:38
char * nametemplate
Definition: mailcap.h:43
char * printcommand
Definition: mailcap.h:42
char * composetypecommand
Definition: mailcap.h:40
char * editcommand
Definition: mailcap.h:41
char * command
Definition: mailcap.h:37
bool copiousoutput
needs pager, basically
Definition: mailcap.h:46
bool xneomuttkeep
do not remove the file on command exit
Definition: mailcap.h:47
char * convert
Definition: mailcap.h:44
bool xneomuttnowrap
do not wrap the output in the pager
Definition: mailcap.h:48
Container for Accounts, Notifications.
Definition: neomutt.h:37
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:39
String list.
Definition: slist.h:47
struct ListHead head
List containing values.
Definition: slist.h:48
size_t count
Number of values in list.
Definition: slist.h:49