NeoMutt  2023-05-17-16-g61469c
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{
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 446 of file mailcap.c.

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);
457 FREE(&me->editcommand);
458 FREE(&me->printcommand);
459 FREE(&me->nametemplate);
460 FREE(ptr);
461}
#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 437 of file mailcap.c.

438{
439 return mutt_mem_calloc(1, sizeof(struct MailcapEntry));
440}
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 = buf_pool_get();
72 struct Buffer *quoted = buf_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 = buf_string(command);
78 while (*cptr)
79 {
80 if (*cptr == '\\')
81 {
82 cptr++;
83 if (*cptr)
84 buf_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 buf_reset(param);
95 else
96 param = buf_pool_get();
97
98 /* Copy parameter name into param buffer */
99 cptr++;
100 while (*cptr && (*cptr != '}'))
101 buf_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(buf_string(param), "charset") && a->charset && !a->noconv)
107 pvalue2 = a->charset;
108 else
109 pvalue2 = mutt_param_get(&a->parameter, buf_string(param));
110
111 /* Now copy the parameter value into param buffer */
112 if (c_mailcap_sanitize)
113 buf_sanitize_filename(param, NONULL(pvalue2), false);
114 else
115 buf_strcpy(param, NONULL(pvalue2));
116
117 buf_quote_filename(quoted, buf_string(param), true);
118 buf_addstr(buf, buf_string(quoted));
119 }
120 else if ((*cptr == 's') && filename)
121 {
122 buf_quote_filename(quoted, filename, true);
123 buf_addstr(buf, buf_string(quoted));
124 needspipe = false;
125 }
126 else if (*cptr == 't')
127 {
128 if (!type2)
129 {
130 type2 = buf_pool_get();
131 if (c_mailcap_sanitize)
132 buf_sanitize_filename(type2, type, false);
133 else
134 buf_strcpy(type2, type);
135 }
136 buf_quote_filename(quoted, buf_string(type2), true);
137 buf_addstr(buf, buf_string(quoted));
138 }
139
140 if (*cptr)
141 cptr++;
142 }
143 else
144 {
145 buf_addch(buf, *cptr++);
146 }
147 }
148 buf_copy(command, buf);
149
150 buf_pool_release(&buf);
151 buf_pool_release(&quoted);
152 buf_pool_release(&param);
153 buf_pool_release(&type2);
154
155 return needspipe;
156}
void buf_reset(struct Buffer *buf)
Reset an existing Buffer.
Definition: buffer.c:86
size_t buf_addch(struct Buffer *buf, char c)
Add a single character to a Buffer.
Definition: buffer.c:251
size_t buf_addstr(struct Buffer *buf, const char *s)
Add a string to a Buffer.
Definition: buffer.c:236
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:370
size_t buf_copy(struct Buffer *dst, const struct Buffer *src)
Copy a Buffer's contents to another Buffer.
Definition: buffer.c:505
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:78
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:73
void buf_quote_filename(struct Buffer *buf, const char *filename, bool add_outer)
Quote a filename to survive the shell's quoting rules.
Definition: file.c:911
bool mutt_istr_equal(const char *a, const char *b)
Compare two strings, ignoring case.
Definition: string.c:810
void buf_sanitize_filename(struct Buffer *buf, const char *path, short slash)
Replace unsafe characters in a filename.
Definition: muttlib.c:1625
char * mutt_param_get(const struct ParameterList *pl, const char *s)
Find a matching Parameter.
Definition: parameter.c:84
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition: pool.c:106
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition: pool.c:119
#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 544 of file mailcap.c.

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

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 = cs_subset_slist(NeoMutt->sub, "mailcap_path");
484 if (!c_mailcap_path || (c_mailcap_path->count == 0))
485 {
486 /* L10N:
487 Mutt is trying to look up a mailcap value, but $mailcap_path is empty.
488 We added a reference to the MAILCAPS environment variable as a hint too.
489
490 Because the variable is automatically populated by Mutt, this
491 should only occur if the user deliberately runs in their shell:
492 export MAILCAPS=
493
494 or deliberately runs inside Mutt or their .muttrc:
495 set mailcap_path=""
496 -or-
497 unset mailcap_path
498 */
499 mutt_error(_("Neither mailcap_path nor MAILCAPS specified"));
500 return false;
501 }
502
503 mutt_check_lookup_list(a, type, typelen);
504
505 struct Buffer *path = buf_pool_get();
506 bool found = false;
507
508 struct ListNode *np = NULL;
509 STAILQ_FOREACH(np, &c_mailcap_path->head, entries)
510 {
511 buf_strcpy(path, np->data);
512 buf_expand_path(path);
513
514 mutt_debug(LL_DEBUG2, "Checking mailcap file: %s\n", buf_string(path));
515 found = rfc1524_mailcap_parse(a, buf_string(path), type, entry, opt);
516 if (found)
517 break;
518 }
519
520 buf_pool_release(&path);
521
522 if (entry && !found)
523 mutt_error(_("mailcap entry for type %s not found"), type);
524
525 return found;
526}
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: logging2.h:87
#define mutt_debug(LEVEL,...)
Definition: logging2.h:84
@ LL_DEBUG2
Log at debug level 2.
Definition: logging2.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:232
#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:342
void buf_expand_path(struct Buffer *buf)
Create the canonical path.
Definition: muttlib.c:333
#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: