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
33 #include <lib-lib/mem.h>
34 #include <lib-lib/str.h>
35 #include <lib-lib/ascii.h>
36 #include <lib-lib/macros.h>
37 #include <lib-lib/file.h>
38 #include <lib-lib/debug.h>
40 #include <lib-sys/unix.h>
46 /* The command semantics include the following:
47 * %s is the filename that contains the mail body data
48 * %t is the content type, like text/plain
49 * %{parameter} is replaced by the parameter value from the content-type field
51 * Unsupported rfc1524 parameters: these would probably require some doing
52 * by mutt, and can probably just be done by piping the message to metamail
53 * %n is the integer number of sub-parts in the multipart
54 * %F is "content-type filename" repeated for each sub-part
56 * In addition, this function returns a 0 if the command works on a file,
57 * and 1 if the command works on a pipe.
59 int rfc1524_expand_command (BODY * a, char *filename, char *_type,
60 char *command, int clen)
64 char buf[LONG_STRING];
65 char type[LONG_STRING];
67 m_strcpy(type, sizeof(type), _type);
69 if (option (OPTMAILCAPSANITIZE))
70 mutt_sanitize_filename (type, 0);
72 while (command[x] && x < clen && y < sizeof (buf)) {
73 if (command[x] == '\\') {
75 buf[y++] = command[x++];
77 else if (command[x] == '%') {
79 if (command[x] == '{') {
86 while (command[x] && command[x] != '}' && z < sizeof (param))
87 param[z++] = command[x++];
90 _pvalue = mutt_get_parameter (param, a->parameter);
91 m_strcpy(pvalue, sizeof(pvalue), NONULL(_pvalue));
92 if (option (OPTMAILCAPSANITIZE))
93 mutt_sanitize_filename (pvalue, 0);
95 y += mutt_quote_filename (buf + y, sizeof (buf) - y, pvalue);
97 else if (command[x] == 's' && filename != NULL) {
98 y += mutt_quote_filename (buf + y, sizeof (buf) - y, filename);
101 else if (command[x] == 't') {
102 y += mutt_quote_filename (buf + y, sizeof (buf) - y, type);
107 buf[y++] = command[x++];
110 m_strcpy(command, clen, buf);
115 /* NUL terminates a rfc 1524 field,
116 * returns start of next field or NULL */
117 static char *get_field (char *s)
124 while ((ch = strpbrk (s, ";\\")) != NULL) {
132 ch = vskipspaces(ch);
140 static int get_field_text (char *field, char **entry,
141 char *type, char *filename, int line)
143 field = vskipspaces(field);
146 field = vskipspaces(field + 1);
147 m_strreplace(entry, field);
152 mutt_error (_("Improperly formated entry for type %s in \"%s\" line %d"),
153 type, filename, line);
158 static int rfc1524_mailcap_parse (BODY * a,
160 char *type, rfc1524_entry * entry, int opt)
175 /* rfc1524 mailcap file is of the format:
176 * base/type; command; extradefs
177 * type can be * for matching all
178 * base with no /type is an implicit wild
179 * command contains a %s for the filename to pass, default to pipe on stdin
180 * extradefs are of the form:
181 * def1="definition"; def2="define \;";
182 * line wraps with a \ at the end of the line
186 /* find length of basetype */
187 if ((ch = strchr (type, '/')) == NULL)
191 if ((fp = fopen (filename, "r")) != NULL) {
192 while (!found && (buf = mutt_read_line (buf, &buflen, fp, &line)) != NULL) {
193 /* ignore comments */
196 debug_print (2, ("mailcap entry: %s\n", buf));
199 ch = get_field (buf);
200 if (ascii_strcasecmp (buf, type) && (ascii_strncasecmp (buf, type, btlen) || (buf[btlen] != 0 && /* implicit wild */
201 m_strcmp(buf + btlen, "/*")))) /* wildsubtype */
204 /* next field is the viewcommand */
208 entry->command = m_strdup(field);
210 /* parse the optional fields */
212 copiousoutput = FALSE;
213 composecommand = FALSE;
215 printcommand = FALSE;
220 debug_print (2, ("field: %s\n", field));
222 if (!ascii_strcasecmp (field, "needsterminal")) {
224 entry->needsterminal = TRUE;
226 else if (!ascii_strcasecmp (field, "copiousoutput")) {
227 copiousoutput = TRUE;
229 entry->copiousoutput = TRUE;
231 else if (!ascii_strncasecmp (field, "composetyped", 12)) {
232 /* this compare most occur before compose to match correctly */
234 (field + 12, entry ? &entry->composetypecommand : NULL, type,
236 composecommand = TRUE;
238 else if (!ascii_strncasecmp (field, "compose", 7)) {
240 (field + 7, entry ? &entry->composecommand : NULL, type,
242 composecommand = TRUE;
244 else if (!ascii_strncasecmp (field, "print", 5)) {
245 if (get_field_text (field + 5, entry ? &entry->printcommand : NULL,
246 type, filename, line))
249 else if (!ascii_strncasecmp (field, "edit", 4)) {
250 if (get_field_text (field + 4, entry ? &entry->editcommand : NULL,
251 type, filename, line))
254 else if (!ascii_strncasecmp (field, "nametemplate", 12)) {
255 get_field_text (field + 12, entry ? &entry->nametemplate : NULL,
256 type, filename, line);
258 else if (!ascii_strncasecmp (field, "x-convert", 9)) {
259 get_field_text (field + 9, entry ? &entry->convert : NULL,
260 type, filename, line);
262 else if (!ascii_strncasecmp (field, "test", 4)) {
264 * This routine executes the given test command to determine
265 * if this is the right entry.
267 char *test_command = NULL;
270 if (get_field_text (field + 4, &test_command, type, filename, line)
272 len = m_strlen(test_command) + STRING;
273 p_realloc(&test_command, len);
274 rfc1524_expand_command (a, a->filename, type, test_command, len);
275 if (mutt_system (test_command)) {
276 /* a non-zero exit code means test failed */
279 p_delete(&test_command);
284 if (opt == M_AUTOVIEW) {
288 else if (opt == M_COMPOSE) {
292 else if (opt == M_EDIT) {
296 else if (opt == M_PRINT) {
304 p_delete(&entry->command);
305 p_delete(&entry->composecommand);
306 p_delete(&entry->composetypecommand);
307 p_delete(&entry->editcommand);
308 p_delete(&entry->printcommand);
309 p_delete(&entry->nametemplate);
310 p_delete(&entry->convert);
311 entry->needsterminal = 0;
312 entry->copiousoutput = 0;
315 } /* while (!found && (buf = mutt_read_line ())) */
317 } /* if ((fp = fopen ())) */
322 rfc1524_entry *rfc1524_new_entry (void)
324 return p_new(rfc1524_entry, 1);
327 void rfc1524_free_entry (rfc1524_entry ** entry)
329 rfc1524_entry *p = *entry;
331 p_delete(&p->command);
332 p_delete(&p->testcommand);
333 p_delete(&p->composecommand);
334 p_delete(&p->composetypecommand);
335 p_delete(&p->editcommand);
336 p_delete(&p->printcommand);
337 p_delete(&p->nametemplate);
342 * rfc1524_mailcap_lookup attempts to find the given type in the
343 * list of mailcap files. On success, this returns the entry information
344 * in *entry, and returns 1. On failure (not found), returns 0.
345 * If entry == NULL just return 1 if the given type is found.
347 int rfc1524_mailcap_lookup (BODY * a, char *type, rfc1524_entry * entry,
350 char path[_POSIX_PATH_MAX];
353 char *curr = MailcapPath;
355 /* rfc1524 specifies that a path of mailcap files should be searched.
357 * $HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap, etc
358 * and overriden by the MAILCAPS environment variable, and, just to be nice,
359 * we'll make it specifiable in .muttrc
361 if (!curr || !*curr) {
362 mutt_error _("No mailcap path specified");
367 mutt_check_lookup_list (a, type, SHORT_STRING);
369 while (!found && *curr) {
371 while (*curr && *curr != ':' && x < sizeof (path) - 1) {
382 mutt_expand_path (path, sizeof (path));
384 debug_print (2, ("Checking mailcap file: %s\n", path));
385 found = rfc1524_mailcap_parse (a, path, type, entry, opt);
389 mutt_error (_("mailcap entry for type %s not found"), type);
395 /* This routine will create a _temporary_ filename matching the
396 * name template given if this needs to be done.
398 * Please note that only the last path element of the
399 * template and/or the old file name will be used for the
400 * comparison and the temporary file name.
402 * Returns 0 if oldfile is fine as is.
403 * Returns 1 if newfile specified
406 static void strnfcpy (char *d, char *s, size_t siz, size_t len)
413 int rfc1524_expand_filename (char *nametemplate,
414 char *oldfile, char *newfile, size_t nflen)
418 short lmatch = 0, rmatch = 0;
419 char left[_POSIX_PATH_MAX];
420 char right[_POSIX_PATH_MAX];
424 /* first, ignore leading path components.
427 if (nametemplate && (s = strrchr (nametemplate, '/')))
428 nametemplate = s + 1;
430 if (oldfile && (s = strrchr (oldfile, '/')))
435 m_strcpy(newfile, nflen, oldfile);
438 mutt_expand_fmt (newfile, nflen, nametemplate, "mutt");
440 else { /* oldfile && nametemplate */
443 /* first, compare everything left from the "%s"
449 for (i = 0; nametemplate[i]; i++) {
450 if (nametemplate[i] == '%' && nametemplate[i + 1] == 's') {
455 /* note that the following will _not_ read beyond oldfile's end. */
457 if (lmatch && nametemplate[i] != oldfile[i])
463 /* If we had a "%s", check the rest. */
465 /* now, for the right part: compare everything right from
466 * the "%s" to the final part of oldfile.
468 * The logic here is as follows:
470 * - We start reading from the end.
471 * - There must be a match _right_ from the "%s",
473 * - If there was a left hand match, this stuff
474 * must not be counted again. That's done by the
475 * condition (j >= (lmatch ? i : 0)).
480 for (r = 0, j = m_strlen(oldfile) - 1, k =
481 m_strlen(nametemplate) - 1;
482 j >= (lmatch ? i : 0) && k >= i + 2; j--, k--) {
483 if (nametemplate[k] != oldfile[j]) {
489 /* Now, check if we had a full match. */
497 strnfcpy (left, nametemplate, sizeof (left), i);
502 m_strcpy(right, sizeof(right), nametemplate + i + 2);
504 snprintf (newfile, nflen, "%s%s%s", left, oldfile, right);
507 /* no "%s" in the name template. */
508 m_strcpy(newfile, nflen, nametemplate);
512 mutt_adv_mktemp (NULL, newfile, nflen);
514 if (rmatch && lmatch)
521 /* If rfc1524_expand_command() is used on a recv'd message, then
522 * the filename doesn't exist yet, but if its used while sending a message,
523 * then we need to rename the existing file.
525 * This function returns 0 on successful move, 1 on old file doesn't exist,
526 * 2 on new file already exists, and 3 on other failure.
529 /* note on access(2) use: No dangling symlink problems here due to
533 int _mutt_rename_file (char *oldfile, char *newfile, int overwrite)
537 if (access (oldfile, F_OK) != 0)
539 if (!overwrite && access (newfile, F_OK) == 0)
541 if ((ofp = fopen (oldfile, "r")) == NULL)
543 if ((nfp = safe_fopen (newfile, "w")) == NULL) {
547 mutt_copy_stream (ofp, nfp);
550 mutt_unlink (oldfile);
554 int mutt_rename_file (char *oldfile, char *newfile)
556 return _mutt_rename_file (oldfile, newfile, 0);