NeoMutt  2020-06-26-250-g349c94
Teaching an old dog new tricks
DOXYGEN
mailcap.h File Reference

RFC1524 Mailcap routines. More...

#include <stddef.h>
#include <stdbool.h>
+ Include dependency graph for mailcap.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  MailcapEntry
 A mailcap entry. More...
 

Enumerations

enum  MailcapLookup {
  MUTT_MC_NO_FLAGS = 0, MUTT_MC_EDIT, MUTT_MC_COMPOSE, MUTT_MC_PRINT,
  MUTT_MC_AUTOVIEW
}
 Mailcap actions. More...
 

Functions

void mailcap_entry_free (struct MailcapEntry **ptr)
 Deallocate an struct MailcapEntry. More...
 
struct MailcapEntrymailcap_entry_new (void)
 Allocate memory for a new rfc1524 entry. More...
 
int mailcap_expand_command (struct Body *a, const char *filename, const char *type, struct Buffer *command)
 Expand expandos in a command. More...
 
void mailcap_expand_filename (const char *nametemplate, const char *oldfile, struct Buffer *newfile)
 Expand a new filename from a template or existing filename. More...
 
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. More...
 

Variables

bool C_MailcapSanitize
 Config: Restrict the possible characters in mailcap expandos. More...
 

Detailed Description

RFC1524 Mailcap routines.

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 mailcap.h.

Enumeration Type Documentation

◆ MailcapLookup

Mailcap actions.

Enumerator
MUTT_MC_NO_FLAGS 

No flags set.

MUTT_MC_EDIT 

Mailcap edit field.

MUTT_MC_COMPOSE 

Mailcap compose field.

MUTT_MC_PRINT 

Mailcap print field.

MUTT_MC_AUTOVIEW 

Mailcap autoview field.

Definition at line 56 of file mailcap.h.

57 {
58  MUTT_MC_NO_FLAGS = 0,
59  MUTT_MC_EDIT,
63 };
Mailcap autoview field.
Definition: mailcap.h:62
No flags set.
Definition: mailcap.h:58
Mailcap compose field.
Definition: mailcap.h:60
Mailcap print field.
Definition: mailcap.h:61
Mailcap edit field.
Definition: mailcap.h:59

Function Documentation

◆ mailcap_entry_free()

void mailcap_entry_free ( struct MailcapEntry **  ptr)

Deallocate an struct MailcapEntry.

Parameters
[out]ptrMailcapEntry to deallocate

Definition at line 436 of file mailcap.c.

437 {
438  if (!ptr || !*ptr)
439  return;
440 
441  struct MailcapEntry *me = *ptr;
442 
443  FREE(&me->command);
444  FREE(&me->testcommand);
445  FREE(&me->composecommand);
446  FREE(&me->composetypecommand);
447  FREE(&me->editcommand);
448  FREE(&me->printcommand);
449  FREE(&me->nametemplate);
450  FREE(ptr);
451 }
A mailcap entry.
Definition: mailcap.h:38
char * composetypecommand
Definition: mailcap.h:43
char * editcommand
Definition: mailcap.h:44
char * command
Definition: mailcap.h:40
char * printcommand
Definition: mailcap.h:45
char * nametemplate
Definition: mailcap.h:46
char * composecommand
Definition: mailcap.h:42
#define FREE(x)
Definition: memory.h:40
char * testcommand
Definition: mailcap.h:41
+ Here is the caller graph for this function:

◆ mailcap_entry_new()

struct MailcapEntry* mailcap_entry_new ( void  )

Allocate memory for a new rfc1524 entry.

Return values
ptrAn un-initialized struct MailcapEntry

Definition at line 427 of file mailcap.c.

428 {
429  return mutt_mem_calloc(1, sizeof(struct MailcapEntry));
430 }
A mailcap entry.
Definition: mailcap.h:38
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailcap_expand_command()

int mailcap_expand_command ( struct Body a,
const char *  filename,
const char *  type,
struct Buffer command 
)

Expand expandos in a command.

Parameters
aEmail Body
filenameFile containing the email text
typeType, e.g. "text/plain"
commandBuffer containing command
Return values
0Command works on a file
1Command works on a pipe

The command semantics include the following: s is the filename that contains the mail body data t is the content type, like text/plain %{parameter} is replaced by the parameter value from the content-type field % is % Unsupported rfc1524 parameters: these would probably require some doing by neomutt, and can probably just be done by piping the message to metamail n is the integer number of sub-parts in the multipart F is "content-type filename" repeated for each sub-part

Definition at line 69 of file mailcap.c.

71 {
72  int needspipe = true;
73  struct Buffer *buf = mutt_buffer_pool_get();
74  struct Buffer *quoted = mutt_buffer_pool_get();
75  struct Buffer *param = NULL;
76  struct Buffer *type2 = NULL;
77 
78  const char *cptr = mutt_b2s(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_b2s(param), "charset") && a->charset && !a->noconv)
108  pvalue2 = a->charset;
109  else
110  pvalue2 = mutt_param_get(&a->parameter, mutt_b2s(param));
111 
112  /* Now copy the parameter value into param buffer */
113  if (C_MailcapSanitize)
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_b2s(param), true);
119  mutt_buffer_addstr(buf, mutt_b2s(quoted));
120  }
121  else if ((*cptr == 's') && filename)
122  {
123  mutt_buffer_quote_filename(quoted, filename, true);
124  mutt_buffer_addstr(buf, mutt_b2s(quoted));
125  needspipe = false;
126  }
127  else if (*cptr == 't')
128  {
129  if (!type2)
130  {
131  type2 = mutt_buffer_pool_get();
132  if (C_MailcapSanitize)
133  mutt_buffer_sanitize_filename(type2, type, false);
134  else
135  mutt_buffer_strcpy(type2, type);
136  }
137  mutt_buffer_quote_filename(quoted, mutt_b2s(type2), true);
138  mutt_buffer_addstr(buf, mutt_b2s(quoted));
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 }
void mutt_buffer_quote_filename(struct Buffer *buf, const char *filename, bool add_outer)
Quote a filename to survive the shell&#39;s quoting rules.
Definition: file.c:836
#define NONULL(x)
Definition: string2.h:37
void mutt_buffer_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:79
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
size_t mutt_buffer_copy(struct Buffer *dst, const struct Buffer *src)
Copy a Buffer&#39;s contents to another Buffer.
Definition: buffer.c:445
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
bool noconv
Don&#39;t do character set conversion.
Definition: body.h:73
String manipulation buffer.
Definition: buffer.h:33
size_t mutt_buffer_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:225
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:888
#define mutt_b2s(buf)
Definition: buffer.h:41
char * charset
Send mode: charset of attached file as stored on disk.
Definition: body.h:49
bool C_MailcapSanitize
Config: Restrict the possible characters in mailcap expandos.
Definition: mailcap.c:48
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_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
void mutt_buffer_sanitize_filename(struct Buffer *buf, const char *path, short slash)
Replace unsafe characters in a filename.
Definition: muttlib.c:1637
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:39
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailcap_expand_filename()

void mailcap_expand_filename ( const char *  nametemplate,
const char *  oldfile,
struct Buffer newfile 
)

Expand a new filename from a template or existing filename.

Parameters
nametemplateTemplate
oldfileOriginal filename
newfileBuffer for new filename

If there is no nametemplate, the stripped oldfile name is used as the template for newfile.

If there is no oldfile, the stripped nametemplate name is used as the template for newfile.

If both a nametemplate and oldfile are specified, the template is checked for a "%s". If none is found, the nametemplate is used as the template for newfile. The first path component of the nametemplate and oldfile are ignored.

Definition at line 533 of file mailcap.c.

535 {
536  int i, j, k;
537  char *s = NULL;
538  bool lmatch = false, rmatch = false;
539 
540  mutt_buffer_reset(newfile);
541 
542  /* first, ignore leading path components */
543 
544  if (nametemplate && (s = strrchr(nametemplate, '/')))
545  nametemplate = s + 1;
546 
547  if (oldfile && (s = strrchr(oldfile, '/')))
548  oldfile = s + 1;
549 
550  if (!nametemplate)
551  {
552  if (oldfile)
553  mutt_buffer_strcpy(newfile, oldfile);
554  }
555  else if (!oldfile)
556  {
557  mutt_file_expand_fmt(newfile, nametemplate, "neomutt");
558  }
559  else /* oldfile && nametemplate */
560  {
561  /* first, compare everything left from the "%s"
562  * (if there is one). */
563 
564  lmatch = true;
565  bool ps = false;
566  for (i = 0; nametemplate[i]; i++)
567  {
568  if ((nametemplate[i] == '%') && (nametemplate[i + 1] == 's'))
569  {
570  ps = true;
571  break;
572  }
573 
574  /* note that the following will _not_ read beyond oldfile's end. */
575 
576  if (lmatch && (nametemplate[i] != oldfile[i]))
577  lmatch = false;
578  }
579 
580  if (ps)
581  {
582  /* If we had a "%s", check the rest. */
583 
584  /* now, for the right part: compare everything right from
585  * the "%s" to the final part of oldfile.
586  *
587  * The logic here is as follows:
588  *
589  * - We start reading from the end.
590  * - There must be a match _right_ from the "%s",
591  * thus the i + 2.
592  * - If there was a left hand match, this stuff
593  * must not be counted again. That's done by the
594  * condition (j >= (lmatch ? i : 0)). */
595 
596  rmatch = true;
597 
598  for (j = mutt_str_len(oldfile) - 1, k = mutt_str_len(nametemplate) - 1;
599  (j >= (lmatch ? i : 0)) && (k >= (i + 2)); j--, k--)
600  {
601  if (nametemplate[k] != oldfile[j])
602  {
603  rmatch = false;
604  break;
605  }
606  }
607 
608  /* Now, check if we had a full match. */
609 
610  if (k >= i + 2)
611  rmatch = false;
612 
613  struct Buffer *left = mutt_buffer_pool_get();
614  struct Buffer *right = mutt_buffer_pool_get();
615 
616  if (!lmatch)
617  mutt_buffer_strcpy_n(left, nametemplate, i);
618  if (!rmatch)
619  mutt_buffer_strcpy(right, nametemplate + i + 2);
620  mutt_buffer_printf(newfile, "%s%s%s", mutt_b2s(left), oldfile, mutt_b2s(right));
621 
623  mutt_buffer_pool_release(&right);
624  }
625  else
626  {
627  /* no "%s" in the name template. */
628  mutt_buffer_strcpy(newfile, nametemplate);
629  }
630  }
631 
632  mutt_adv_mktemp(newfile);
633 }
void mutt_buffer_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:79
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
String manipulation buffer.
Definition: buffer.h:33
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
#define mutt_b2s(buf)
Definition: buffer.h:41
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
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:1447
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
size_t mutt_str_len(const char *a)
Calculate the length of a string, safely.
Definition: string.c:636
void mutt_adv_mktemp(struct Buffer *buf)
Create a temporary file.
Definition: muttlib.c:90
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mailcap_lookup()

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.

Parameters
aMessage body
typeText type in "type/subtype" format
typelenLength of the type
entrystruct MailcapEntry to populate with results
optType of mailcap entry to lookup, see MailcapLookup
Return values
trueIf *entry is not NULL it populates it with the mailcap entry
falseNo matching entry is found

Find the given type in the list of mailcap files.

Definition at line 465 of file mailcap.c.

467 {
468  /* rfc1524 specifies that a path of mailcap files should be searched.
469  * joy. They say
470  * $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap, etc
471  * and overridden by the MAILCAPS environment variable, and, just to be nice,
472  * we'll make it specifiable in .neomuttrc */
473  if (!C_MailcapPath || (C_MailcapPath->count == 0))
474  {
475  /* L10N:
476  Mutt is trying to look up a mailcap value, but $mailcap_path is empty.
477  We added a reference to the MAILCAPS environment variable as a hint too.
478 
479  Because the variable is automatically populated by Mutt, this
480  should only occur if the user deliberately runs in their shell:
481  export MAILCAPS=
482 
483  or deliberately runs inside Mutt or their .muttrc:
484  set mailcap_path=""
485  -or-
486  unset mailcap_path
487  */
488  mutt_error(_("Neither mailcap_path nor MAILCAPS specified"));
489  return false;
490  }
491 
492  mutt_check_lookup_list(a, type, typelen);
493 
494  struct Buffer *path = mutt_buffer_pool_get();
495  bool found = false;
496 
497  struct ListNode *np = NULL;
498  STAILQ_FOREACH(np, &C_MailcapPath->head, entries)
499  {
500  mutt_buffer_strcpy(path, np->data);
502 
503  mutt_debug(LL_DEBUG2, "Checking mailcap file: %s\n", mutt_b2s(path));
504  found = rfc1524_mailcap_parse(a, mutt_b2s(path), type, entry, opt);
505  if (found)
506  break;
507  }
508 
510 
511  if (entry && !found)
512  mutt_error(_("mailcap entry for type %s not found"), type);
513 
514  return found;
515 }
struct Buffer * mutt_buffer_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:101
void mutt_buffer_pool_release(struct Buffer **pbuf)
Free a Buffer from the pool.
Definition: pool.c:112
String manipulation buffer.
Definition: buffer.h:33
#define _(a)
Definition: message.h:28
WHERE struct Slist * C_MailcapPath
Config: Colon-separated list of mailcap files.
Definition: mutt_globals.h:96
Log at debug level 2.
Definition: logging.h:41
struct ListHead head
Definition: slist.h:45
size_t count
Definition: slist.h:46
#define mutt_b2s(buf)
Definition: buffer.h:41
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
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:349
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
char * data
String.
Definition: list.h:36
void mutt_buffer_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:323
void mutt_check_lookup_list(struct Body *b, char *type, size_t len)
Update the mime type.
Definition: mutt_attach.c:333
#define mutt_error(...)
Definition: logging.h:84
#define mutt_debug(LEVEL,...)
Definition: logging.h:81
A List node for strings.
Definition: list.h:34
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ C_MailcapSanitize

bool C_MailcapSanitize

Config: Restrict the possible characters in mailcap expandos.

Definition at line 48 of file mailcap.c.