NeoMutt  2022-04-29-145-g9b6a0e
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...
 

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 54 of file mailcap.h.

55 {
56  MUTT_MC_NO_FLAGS = 0,
57  MUTT_MC_EDIT,
61 };
@ 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_NO_FLAGS
No flags set.
Definition: mailcap.h:56
@ MUTT_MC_COMPOSE
Mailcap compose field.
Definition: mailcap.h:58

Function Documentation

◆ mailcap_entry_free()

void mailcap_entry_free ( struct MailcapEntry **  ptr)

Deallocate an struct MailcapEntry.

Parameters
[out]ptrMailcapEntry to deallocate

Definition at line 444 of file mailcap.c.

445 {
446  if (!ptr || !*ptr)
447  return;
448 
449  struct MailcapEntry *me = *ptr;
450 
451  FREE(&me->command);
452  FREE(&me->testcommand);
453  FREE(&me->composecommand);
454  FREE(&me->composetypecommand);
455  FREE(&me->editcommand);
456  FREE(&me->printcommand);
457  FREE(&me->nametemplate);
458  FREE(ptr);
459 }
#define FREE(x)
Definition: memory.h:43
A mailcap entry.
Definition: mailcap.h:36
char * composecommand
Definition: mailcap.h:39
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
+ 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 435 of file mailcap.c.

436 {
437  return mutt_mem_calloc(1, sizeof(struct MailcapEntry));
438 }
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 67 of file mailcap.c.

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 = cs_subset_bool(NeoMutt->sub, "mailcap_sanitize");
77  const char *cptr = mutt_buffer_string(command);
78  while (*cptr)
79  {
80  if (*cptr == '\\')
81  {
82  cptr++;
83  if (*cptr)
84  mutt_buffer_addch(buf, *cptr++);
85  }
86  else if (*cptr == '%')
87  {
88  cptr++;
89  if (*cptr == '{')
90  {
91  const char *pvalue2 = NULL;
92 
93  if (param)
94  mutt_buffer_reset(param);
95  else
96  param = mutt_buffer_pool_get();
97 
98  /* Copy parameter name into param buffer */
99  cptr++;
100  while (*cptr && (*cptr != '}'))
101  mutt_buffer_addch(param, *cptr++);
102 
103  /* In send mode, use the current charset, since the message hasn't
104  * been converted yet. If noconv is set, then we assume the
105  * charset parameter has the correct value instead. */
106  if (mutt_istr_equal(mutt_buffer_string(param), "charset") && a->charset && !a->noconv)
107  pvalue2 = a->charset;
108  else
109  pvalue2 = mutt_param_get(&a->parameter, mutt_buffer_string(param));
110 
111  /* Now copy the parameter value into param buffer */
112  if (c_mailcap_sanitize)
113  mutt_buffer_sanitize_filename(param, NONULL(pvalue2), false);
114  else
115  mutt_buffer_strcpy(param, NONULL(pvalue2));
116 
117  mutt_buffer_quote_filename(quoted, mutt_buffer_string(param), true);
119  }
120  else if ((*cptr == 's') && filename)
121  {
122  mutt_buffer_quote_filename(quoted, filename, true);
124  needspipe = false;
125  }
126  else if (*cptr == 't')
127  {
128  if (!type2)
129  {
130  type2 = mutt_buffer_pool_get();
131  if (c_mailcap_sanitize)
132  mutt_buffer_sanitize_filename(type2, type, false);
133  else
134  mutt_buffer_strcpy(type2, type);
135  }
136  mutt_buffer_quote_filename(quoted, mutt_buffer_string(type2), true);
138  }
139 
140  if (*cptr)
141  cptr++;
142  }
143  else
144  mutt_buffer_addch(buf, *cptr++);
145  }
146  mutt_buffer_copy(command, buf);
147 
149  mutt_buffer_pool_release(&quoted);
150  mutt_buffer_pool_release(&param);
151  mutt_buffer_pool_release(&type2);
152 
153  return needspipe;
154 }
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:310
size_t mutt_buffer_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:238
size_t mutt_buffer_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:223
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:81
static const char * mutt_buffer_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:77
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
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:891
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:796
void mutt_buffer_sanitize_filename(struct Buffer *buf, const char *path, short slash)
Replace unsafe characters in a filename.
Definition: muttlib.c:1651
char * mutt_param_get(const struct ParameterList *pl, const char *s)
Find a matching Parameter.
Definition: parameter.c:84
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 NONULL(x)
Definition: string2.h:37
bool noconv
Don't do character set conversion.
Definition: body.h:46
char * charset
Send mode: charset of attached file as stored on disk.
Definition: body.h:78
struct ParameterList parameter
Parameters of the content-type.
Definition: body.h:62
String manipulation buffer.
Definition: buffer.h:34
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:

◆ 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 542 of file mailcap.c.

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

475 {
476  /* rfc1524 specifies that a path of mailcap files should be searched.
477  * joy. They say
478  * $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap, etc
479  * and overridden by the MAILCAPS environment variable, and, just to be nice,
480  * we'll make it specifiable in .neomuttrc */
481  const struct Slist *c_mailcap_path = cs_subset_slist(NeoMutt->sub, "mailcap_path");
482  if (!c_mailcap_path || (c_mailcap_path->count == 0))
483  {
484  /* L10N:
485  Mutt is trying to look up a mailcap value, but $mailcap_path is empty.
486  We added a reference to the MAILCAPS environment variable as a hint too.
487 
488  Because the variable is automatically populated by Mutt, this
489  should only occur if the user deliberately runs in their shell:
490  export MAILCAPS=
491 
492  or deliberately runs inside Mutt or their .muttrc:
493  set mailcap_path=""
494  -or-
495  unset mailcap_path
496  */
497  mutt_error(_("Neither mailcap_path nor MAILCAPS specified"));
498  return false;
499  }
500 
501  mutt_check_lookup_list(a, type, typelen);
502 
503  struct Buffer *path = mutt_buffer_pool_get();
504  bool found = false;
505 
506  struct ListNode *np = NULL;
507  STAILQ_FOREACH(np, &c_mailcap_path->head, entries)
508  {
509  mutt_buffer_strcpy(path, np->data);
511 
512  mutt_debug(LL_DEBUG2, "Checking mailcap file: %s\n", mutt_buffer_string(path));
513  found = rfc1524_mailcap_parse(a, mutt_buffer_string(path), type, entry, opt);
514  if (found)
515  break;
516  }
517 
519 
520  if (entry && !found)
521  mutt_error(_("mailcap entry for type %s not found"), type);
522 
523  return found;
524 }
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
#define mutt_error(...)
Definition: logging.h:87
#define mutt_debug(LEVEL,...)
Definition: logging.h:84
@ LL_DEBUG2
Log at debug level 2.
Definition: logging.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:230
#define _(a)
Definition: message.h:28
void mutt_check_lookup_list(struct Body *b, char *type, size_t len)
Update the mime type.
Definition: mutt_attach.c:337
void mutt_buffer_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:322
#define STAILQ_FOREACH(var, head, field)
Definition: queue.h:352
A List node for strings.
Definition: list.h:35
char * data
String.
Definition: list.h:36
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
+ Here is the call graph for this function:
+ Here is the caller graph for this function: