2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2000 Michael R. Elkins <me@mutt.org>
5 * This file is part of mutt-ng, see http://www.muttng.org/.
6 * It's licensed under the GNU General Public License,
7 * please see the file GPL in the top level source directory.
11 * rfc1524 defines a format for the Multimedia Mail Configuration, which
12 * is the standard mailcap file format under Unix which specifies what
13 * external programs should be used to view/compose/edit multimedia files
14 * based on content type.
16 * This file contains various functions for implementing a fair subset of
32 #include "lib/debug.h"
43 /* The command semantics include the following:
44 * %s is the filename that contains the mail body data
45 * %t is the content type, like text/plain
46 * %{parameter} is replaced by the parameter value from the content-type field
48 * Unsupported rfc1524 parameters: these would probably require some doing
49 * by mutt, and can probably just be done by piping the message to metamail
50 * %n is the integer number of sub-parts in the multipart
51 * %F is "content-type filename" repeated for each sub-part
53 * In addition, this function returns a 0 if the command works on a file,
54 * and 1 if the command works on a pipe.
56 int rfc1524_expand_command (BODY * a, char *filename, char *_type,
57 char *command, int clen)
61 char buf[LONG_STRING];
62 char type[LONG_STRING];
64 strfcpy (type, _type, sizeof (type));
66 if (option (OPTMAILCAPSANITIZE))
67 mutt_sanitize_filename (type, 0);
69 while (command[x] && x < clen && y < sizeof (buf)) {
70 if (command[x] == '\\') {
72 buf[y++] = command[x++];
74 else if (command[x] == '%') {
76 if (command[x] == '{') {
83 while (command[x] && command[x] != '}' && z < sizeof (param))
84 param[z++] = command[x++];
87 _pvalue = mutt_get_parameter (param, a->parameter);
88 strfcpy (pvalue, NONULL (_pvalue), sizeof (pvalue));
89 if (option (OPTMAILCAPSANITIZE))
90 mutt_sanitize_filename (pvalue, 0);
92 y += mutt_quote_filename (buf + y, sizeof (buf) - y, pvalue);
94 else if (command[x] == 's' && filename != NULL) {
95 y += mutt_quote_filename (buf + y, sizeof (buf) - y, filename);
98 else if (command[x] == 't') {
99 y += mutt_quote_filename (buf + y, sizeof (buf) - y, type);
104 buf[y++] = command[x++];
107 strfcpy (command, buf, clen);
112 /* NUL terminates a rfc 1524 field,
113 * returns start of next field or NULL */
114 static char *get_field (char *s)
121 while ((ch = strpbrk (s, ";\\")) != NULL) {
133 str_skip_trailws (s);
137 static int get_field_text (char *field, char **entry,
138 char *type, char *filename, int line)
140 field = str_skip_initws (field);
144 field = str_skip_initws (field);
145 str_replace (entry, field);
150 mutt_error (_("Improperly formated entry for type %s in \"%s\" line %d"),
151 type, filename, line);
156 static int rfc1524_mailcap_parse (BODY * a,
158 char *type, rfc1524_entry * entry, int opt)
173 /* rfc1524 mailcap file is of the format:
174 * base/type; command; extradefs
175 * type can be * for matching all
176 * base with no /type is an implicit wild
177 * command contains a %s for the filename to pass, default to pipe on stdin
178 * extradefs are of the form:
179 * def1="definition"; def2="define \;";
180 * line wraps with a \ at the end of the line
184 /* find length of basetype */
185 if ((ch = strchr (type, '/')) == NULL)
189 if ((fp = fopen (filename, "r")) != NULL) {
190 while (!found && (buf = mutt_read_line (buf, &buflen, fp, &line)) != NULL) {
191 /* ignore comments */
194 debug_print (2, ("mailcap entry: %s\n", buf));
197 ch = get_field (buf);
198 if (ascii_strcasecmp (buf, type) && (ascii_strncasecmp (buf, type, btlen) || (buf[btlen] != 0 && /* implicit wild */
199 str_cmp (buf + btlen, "/*")))) /* wildsubtype */
202 /* next field is the viewcommand */
206 entry->command = str_dup (field);
208 /* parse the optional fields */
210 copiousoutput = FALSE;
211 composecommand = FALSE;
213 printcommand = FALSE;
218 debug_print (2, ("field: %s\n", field));
220 if (!ascii_strcasecmp (field, "needsterminal")) {
222 entry->needsterminal = TRUE;
224 else if (!ascii_strcasecmp (field, "copiousoutput")) {
225 copiousoutput = TRUE;
227 entry->copiousoutput = TRUE;
229 else if (!ascii_strncasecmp (field, "composetyped", 12)) {
230 /* this compare most occur before compose to match correctly */
232 (field + 12, entry ? &entry->composetypecommand : NULL, type,
234 composecommand = TRUE;
236 else if (!ascii_strncasecmp (field, "compose", 7)) {
238 (field + 7, entry ? &entry->composecommand : NULL, type,
240 composecommand = TRUE;
242 else if (!ascii_strncasecmp (field, "print", 5)) {
243 if (get_field_text (field + 5, entry ? &entry->printcommand : NULL,
244 type, filename, line))
247 else if (!ascii_strncasecmp (field, "edit", 4)) {
248 if (get_field_text (field + 4, entry ? &entry->editcommand : NULL,
249 type, filename, line))
252 else if (!ascii_strncasecmp (field, "nametemplate", 12)) {
253 get_field_text (field + 12, entry ? &entry->nametemplate : NULL,
254 type, filename, line);
256 else if (!ascii_strncasecmp (field, "x-convert", 9)) {
257 get_field_text (field + 9, entry ? &entry->convert : NULL,
258 type, filename, line);
260 else if (!ascii_strncasecmp (field, "test", 4)) {
262 * This routine executes the given test command to determine
263 * if this is the right entry.
265 char *test_command = NULL;
268 if (get_field_text (field + 4, &test_command, type, filename, line)
270 len = str_len (test_command) + STRING;
271 mem_realloc (&test_command, len);
272 rfc1524_expand_command (a, a->filename, type, test_command, len);
273 if (mutt_system (test_command)) {
274 /* a non-zero exit code means test failed */
277 mem_free (&test_command);
282 if (opt == M_AUTOVIEW) {
286 else if (opt == M_COMPOSE) {
290 else if (opt == M_EDIT) {
294 else if (opt == M_PRINT) {
302 mem_free (&entry->command);
303 mem_free (&entry->composecommand);
304 mem_free (&entry->composetypecommand);
305 mem_free (&entry->editcommand);
306 mem_free (&entry->printcommand);
307 mem_free (&entry->nametemplate);
308 mem_free (&entry->convert);
309 entry->needsterminal = 0;
310 entry->copiousoutput = 0;
313 } /* while (!found && (buf = mutt_read_line ())) */
315 } /* if ((fp = fopen ())) */
320 rfc1524_entry *rfc1524_new_entry (void)
322 return (rfc1524_entry *) mem_calloc (1, sizeof (rfc1524_entry));
325 void rfc1524_free_entry (rfc1524_entry ** entry)
327 rfc1524_entry *p = *entry;
329 mem_free (&p->command);
330 mem_free (&p->testcommand);
331 mem_free (&p->composecommand);
332 mem_free (&p->composetypecommand);
333 mem_free (&p->editcommand);
334 mem_free (&p->printcommand);
335 mem_free (&p->nametemplate);
340 * rfc1524_mailcap_lookup attempts to find the given type in the
341 * list of mailcap files. On success, this returns the entry information
342 * in *entry, and returns 1. On failure (not found), returns 0.
343 * If entry == NULL just return 1 if the given type is found.
345 int rfc1524_mailcap_lookup (BODY * a, char *type, rfc1524_entry * entry,
348 char path[_POSIX_PATH_MAX];
351 char *curr = MailcapPath;
353 /* rfc1524 specifies that a path of mailcap files should be searched.
355 * $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap, etc
356 * and overriden by the MAILCAPS environment variable, and, just to be nice,
357 * we'll make it specifiable in .muttrc
359 if (!curr || !*curr) {
360 mutt_error _("No mailcap path specified");
365 mutt_check_lookup_list (a, type, SHORT_STRING);
367 while (!found && *curr) {
369 while (*curr && *curr != ':' && x < sizeof (path) - 1) {
380 mutt_expand_path (path, sizeof (path));
382 debug_print (2, ("Checking mailcap file: %s\n", path));
383 found = rfc1524_mailcap_parse (a, path, type, entry, opt);
387 mutt_error (_("mailcap entry for type %s not found"), type);
393 /* This routine will create a _temporary_ filename matching the
394 * name template given if this needs to be done.
396 * Please note that only the last path element of the
397 * template and/or the old file name will be used for the
398 * comparison and the temporary file name.
400 * Returns 0 if oldfile is fine as is.
401 * Returns 1 if newfile specified
404 static void strnfcpy (char *d, char *s, size_t siz, size_t len)
411 int rfc1524_expand_filename (char *nametemplate,
412 char *oldfile, char *newfile, size_t nflen)
416 short lmatch = 0, rmatch = 0;
417 char left[_POSIX_PATH_MAX];
418 char right[_POSIX_PATH_MAX];
422 /* first, ignore leading path components.
425 if (nametemplate && (s = strrchr (nametemplate, '/')))
426 nametemplate = s + 1;
428 if (oldfile && (s = strrchr (oldfile, '/')))
433 strfcpy (newfile, oldfile, nflen);
436 mutt_expand_fmt (newfile, nflen, nametemplate, "mutt");
438 else { /* oldfile && nametemplate */
441 /* first, compare everything left from the "%s"
447 for (i = 0; nametemplate[i]; i++) {
448 if (nametemplate[i] == '%' && nametemplate[i + 1] == 's') {
453 /* note that the following will _not_ read beyond oldfile's end. */
455 if (lmatch && nametemplate[i] != oldfile[i])
461 /* If we had a "%s", check the rest. */
463 /* now, for the right part: compare everything right from
464 * the "%s" to the final part of oldfile.
466 * The logic here is as follows:
468 * - We start reading from the end.
469 * - There must be a match _right_ from the "%s",
471 * - If there was a left hand match, this stuff
472 * must not be counted again. That's done by the
473 * condition (j >= (lmatch ? i : 0)).
478 for (r = 0, j = str_len (oldfile) - 1, k =
479 str_len (nametemplate) - 1;
480 j >= (lmatch ? i : 0) && k >= i + 2; j--, k--) {
481 if (nametemplate[k] != oldfile[j]) {
487 /* Now, check if we had a full match. */
495 strnfcpy (left, nametemplate, sizeof (left), i);
500 strfcpy (right, nametemplate + i + 2, sizeof (right));
502 snprintf (newfile, nflen, "%s%s%s", left, oldfile, right);
505 /* no "%s" in the name template. */
506 strfcpy (newfile, nametemplate, nflen);
510 mutt_adv_mktemp (NULL, newfile, nflen);
512 if (rmatch && lmatch)
519 /* If rfc1524_expand_command() is used on a recv'd message, then
520 * the filename doesn't exist yet, but if its used while sending a message,
521 * then we need to rename the existing file.
523 * This function returns 0 on successful move, 1 on old file doesn't exist,
524 * 2 on new file already exists, and 3 on other failure.
527 /* note on access(2) use: No dangling symlink problems here due to
531 int _mutt_rename_file (char *oldfile, char *newfile, int overwrite)
535 if (access (oldfile, F_OK) != 0)
537 if (!overwrite && access (newfile, F_OK) == 0)
539 if ((ofp = fopen (oldfile, "r")) == NULL)
541 if ((nfp = safe_fopen (newfile, "w")) == NULL) {
545 mutt_copy_stream (ofp, nfp);
548 mutt_unlink (oldfile);
552 int mutt_rename_file (char *oldfile, char *newfile)
554 return _mutt_rename_file (oldfile, newfile, 0);