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
31 #include "lib/debug.h"
42 /* The command semantics include the following:
43 * %s is the filename that contains the mail body data
44 * %t is the content type, like text/plain
45 * %{parameter} is replaced by the parameter value from the content-type field
47 * Unsupported rfc1524 parameters: these would probably require some doing
48 * by mutt, and can probably just be done by piping the message to metamail
49 * %n is the integer number of sub-parts in the multipart
50 * %F is "content-type filename" repeated for each sub-part
52 * In addition, this function returns a 0 if the command works on a file,
53 * and 1 if the command works on a pipe.
55 int rfc1524_expand_command (BODY * a, char *filename, char *_type,
56 char *command, int clen)
60 char buf[LONG_STRING];
61 char type[LONG_STRING];
63 strfcpy (type, _type, sizeof (type));
65 if (option (OPTMAILCAPSANITIZE))
66 mutt_sanitize_filename (type, 0);
68 while (command[x] && x < clen && y < sizeof (buf)) {
69 if (command[x] == '\\') {
71 buf[y++] = command[x++];
73 else if (command[x] == '%') {
75 if (command[x] == '{') {
82 while (command[x] && command[x] != '}' && z < sizeof (param))
83 param[z++] = command[x++];
86 _pvalue = mutt_get_parameter (param, a->parameter);
87 strfcpy (pvalue, NONULL (_pvalue), sizeof (pvalue));
88 if (option (OPTMAILCAPSANITIZE))
89 mutt_sanitize_filename (pvalue, 0);
91 y += mutt_quote_filename (buf + y, sizeof (buf) - y, pvalue);
93 else if (command[x] == 's' && filename != NULL) {
94 y += mutt_quote_filename (buf + y, sizeof (buf) - y, filename);
97 else if (command[x] == 't') {
98 y += mutt_quote_filename (buf + y, sizeof (buf) - y, type);
103 buf[y++] = command[x++];
106 strfcpy (command, buf, clen);
111 /* NUL terminates a rfc 1524 field,
112 * returns start of next field or NULL */
113 static char *get_field (char *s)
120 while ((ch = strpbrk (s, ";\\")) != NULL) {
132 str_skip_trailws (s);
136 static int get_field_text (char *field, char **entry,
137 char *type, char *filename, int line)
139 field = str_skip_initws (field);
143 field = str_skip_initws (field);
144 str_replace (entry, field);
149 mutt_error (_("Improperly formated entry for type %s in \"%s\" line %d"),
150 type, filename, line);
155 static int rfc1524_mailcap_parse (BODY * a,
157 char *type, rfc1524_entry * entry, int opt)
172 /* rfc1524 mailcap file is of the format:
173 * base/type; command; extradefs
174 * type can be * for matching all
175 * base with no /type is an implicit wild
176 * command contains a %s for the filename to pass, default to pipe on stdin
177 * extradefs are of the form:
178 * def1="definition"; def2="define \;";
179 * line wraps with a \ at the end of the line
183 /* find length of basetype */
184 if ((ch = strchr (type, '/')) == NULL)
188 if ((fp = fopen (filename, "r")) != NULL) {
189 while (!found && (buf = mutt_read_line (buf, &buflen, fp, &line)) != NULL) {
190 /* ignore comments */
193 debug_print (2, ("mailcap entry: %s\n", buf));
196 ch = get_field (buf);
197 if (ascii_strcasecmp (buf, type) && (ascii_strncasecmp (buf, type, btlen) || (buf[btlen] != 0 && /* implicit wild */
198 str_cmp (buf + btlen, "/*")))) /* wildsubtype */
201 /* next field is the viewcommand */
205 entry->command = str_dup (field);
207 /* parse the optional fields */
209 copiousoutput = FALSE;
210 composecommand = FALSE;
212 printcommand = FALSE;
217 debug_print (2, ("field: %s\n", field));
219 if (!ascii_strcasecmp (field, "needsterminal")) {
221 entry->needsterminal = TRUE;
223 else if (!ascii_strcasecmp (field, "copiousoutput")) {
224 copiousoutput = TRUE;
226 entry->copiousoutput = TRUE;
228 else if (!ascii_strncasecmp (field, "composetyped", 12)) {
229 /* this compare most occur before compose to match correctly */
231 (field + 12, entry ? &entry->composetypecommand : NULL, type,
233 composecommand = TRUE;
235 else if (!ascii_strncasecmp (field, "compose", 7)) {
237 (field + 7, entry ? &entry->composecommand : NULL, type,
239 composecommand = TRUE;
241 else if (!ascii_strncasecmp (field, "print", 5)) {
242 if (get_field_text (field + 5, entry ? &entry->printcommand : NULL,
243 type, filename, line))
246 else if (!ascii_strncasecmp (field, "edit", 4)) {
247 if (get_field_text (field + 4, entry ? &entry->editcommand : NULL,
248 type, filename, line))
251 else if (!ascii_strncasecmp (field, "nametemplate", 12)) {
252 get_field_text (field + 12, entry ? &entry->nametemplate : NULL,
253 type, filename, line);
255 else if (!ascii_strncasecmp (field, "x-convert", 9)) {
256 get_field_text (field + 9, entry ? &entry->convert : NULL,
257 type, filename, line);
259 else if (!ascii_strncasecmp (field, "test", 4)) {
261 * This routine executes the given test command to determine
262 * if this is the right entry.
264 char *test_command = NULL;
267 if (get_field_text (field + 4, &test_command, type, filename, line)
269 len = str_len (test_command) + STRING;
270 mem_realloc (&test_command, len);
271 rfc1524_expand_command (a, a->filename, type, test_command, len);
272 if (mutt_system (test_command)) {
273 /* a non-zero exit code means test failed */
276 mem_free (&test_command);
281 if (opt == M_AUTOVIEW) {
285 else if (opt == M_COMPOSE) {
289 else if (opt == M_EDIT) {
293 else if (opt == M_PRINT) {
301 mem_free (&entry->command);
302 mem_free (&entry->composecommand);
303 mem_free (&entry->composetypecommand);
304 mem_free (&entry->editcommand);
305 mem_free (&entry->printcommand);
306 mem_free (&entry->nametemplate);
307 mem_free (&entry->convert);
308 entry->needsterminal = 0;
309 entry->copiousoutput = 0;
312 } /* while (!found && (buf = mutt_read_line ())) */
314 } /* if ((fp = fopen ())) */
319 rfc1524_entry *rfc1524_new_entry (void)
321 return (rfc1524_entry *) mem_calloc (1, sizeof (rfc1524_entry));
324 void rfc1524_free_entry (rfc1524_entry ** entry)
326 rfc1524_entry *p = *entry;
328 mem_free (&p->command);
329 mem_free (&p->testcommand);
330 mem_free (&p->composecommand);
331 mem_free (&p->composetypecommand);
332 mem_free (&p->editcommand);
333 mem_free (&p->printcommand);
334 mem_free (&p->nametemplate);
339 * rfc1524_mailcap_lookup attempts to find the given type in the
340 * list of mailcap files. On success, this returns the entry information
341 * in *entry, and returns 1. On failure (not found), returns 0.
342 * If entry == NULL just return 1 if the given type is found.
344 int rfc1524_mailcap_lookup (BODY * a, char *type, rfc1524_entry * entry,
347 char path[_POSIX_PATH_MAX];
350 char *curr = MailcapPath;
352 /* rfc1524 specifies that a path of mailcap files should be searched.
354 * $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap, etc
355 * and overriden by the MAILCAPS environment variable, and, just to be nice,
356 * we'll make it specifiable in .muttrc
358 if (!curr || !*curr) {
359 mutt_error _("No mailcap path specified");
364 mutt_check_lookup_list (a, type, SHORT_STRING);
366 while (!found && *curr) {
368 while (*curr && *curr != ':' && x < sizeof (path) - 1) {
379 mutt_expand_path (path, sizeof (path));
381 debug_print (2, ("Checking mailcap file: %s\n", path));
382 found = rfc1524_mailcap_parse (a, path, type, entry, opt);
386 mutt_error (_("mailcap entry for type %s not found"), type);
392 /* This routine will create a _temporary_ filename matching the
393 * name template given if this needs to be done.
395 * Please note that only the last path element of the
396 * template and/or the old file name will be used for the
397 * comparison and the temporary file name.
399 * Returns 0 if oldfile is fine as is.
400 * Returns 1 if newfile specified
403 static void strnfcpy (char *d, char *s, size_t siz, size_t len)
410 int rfc1524_expand_filename (char *nametemplate,
411 char *oldfile, char *newfile, size_t nflen)
415 short lmatch = 0, rmatch = 0;
416 char left[_POSIX_PATH_MAX];
417 char right[_POSIX_PATH_MAX];
421 /* first, ignore leading path components.
424 if (nametemplate && (s = strrchr (nametemplate, '/')))
425 nametemplate = s + 1;
427 if (oldfile && (s = strrchr (oldfile, '/')))
432 strfcpy (newfile, oldfile, nflen);
435 mutt_expand_fmt (newfile, nflen, nametemplate, "mutt");
437 else { /* oldfile && nametemplate */
440 /* first, compare everything left from the "%s"
446 for (i = 0; nametemplate[i]; i++) {
447 if (nametemplate[i] == '%' && nametemplate[i + 1] == 's') {
452 /* note that the following will _not_ read beyond oldfile's end. */
454 if (lmatch && nametemplate[i] != oldfile[i])
460 /* If we had a "%s", check the rest. */
462 /* now, for the right part: compare everything right from
463 * the "%s" to the final part of oldfile.
465 * The logic here is as follows:
467 * - We start reading from the end.
468 * - There must be a match _right_ from the "%s",
470 * - If there was a left hand match, this stuff
471 * must not be counted again. That's done by the
472 * condition (j >= (lmatch ? i : 0)).
477 for (r = 0, j = str_len (oldfile) - 1, k =
478 str_len (nametemplate) - 1;
479 j >= (lmatch ? i : 0) && k >= i + 2; j--, k--) {
480 if (nametemplate[k] != oldfile[j]) {
486 /* Now, check if we had a full match. */
494 strnfcpy (left, nametemplate, sizeof (left), i);
499 strfcpy (right, nametemplate + i + 2, sizeof (right));
501 snprintf (newfile, nflen, "%s%s%s", left, oldfile, right);
504 /* no "%s" in the name template. */
505 strfcpy (newfile, nametemplate, nflen);
509 mutt_adv_mktemp (newfile, nflen);
511 if (rmatch && lmatch)
518 /* If rfc1524_expand_command() is used on a recv'd message, then
519 * the filename doesn't exist yet, but if its used while sending a message,
520 * then we need to rename the existing file.
522 * This function returns 0 on successful move, 1 on old file doesn't exist,
523 * 2 on new file already exists, and 3 on other failure.
526 /* note on access(2) use: No dangling symlink problems here due to
530 int _mutt_rename_file (char *oldfile, char *newfile, int overwrite)
534 if (access (oldfile, F_OK) != 0)
536 if (!overwrite && access (newfile, F_OK) == 0)
538 if ((ofp = fopen (oldfile, "r")) == NULL)
540 if ((nfp = safe_fopen (newfile, "w")) == NULL) {
544 mutt_copy_stream (ofp, nfp);
547 mutt_unlink (oldfile);
551 int mutt_rename_file (char *oldfile, char *newfile)
553 return _mutt_rename_file (oldfile, newfile, 0);