2 * mhstoresbr.c -- routines to save/store the contents of MIME messages
4 * This code is Copyright (c) 2002, by the authors of nmh. See the
5 * COPYRIGHT file in the root directory of the nmh distribution for
6 * complete copyright information.
11 #include <h/signals.h>
19 #include <h/mhparse.h>
24 * The list of top-level contents to display
31 * Cache of current directory. This must be
32 * set before these routines are called.
37 * The directory in which to store the contents.
42 * Type for a compare function for qsort. This keeps
45 typedef int (*qsort_comp) (const void *, const void *);
49 int part_ok (CT, int);
50 int type_ok (CT, int);
51 int make_intermediates (char *);
52 void flush_errors (void);
55 int show_content_aux (CT, int, int, char *, char *);
60 void store_all_messages (CT *);
65 static void store_single_message (CT);
66 static int store_switch (CT);
67 static int store_generic (CT);
68 static int store_application (CT);
69 static int store_multi (CT);
70 static int store_partial (CT);
71 static int store_external (CT);
72 static int ct_compar (CT *, CT *);
73 static int store_content (CT, CT);
74 static int output_content_file (CT, int);
75 static int output_content_folder (char *, char *);
76 static int parse_format_string (CT, char *, char *, int, char *);
77 static void get_storeproc (CT);
78 static int copy_some_headers (FILE *, CT);
82 * Main entry point to store content
83 * from a collection of messages.
87 store_all_messages (CT *cts)
93 * Check for the directory in which to
98 else if ((cp = context_find (nmhstorage)) && *cp)
103 for (ctp = cts; *ctp; ctp++) {
105 store_single_message (ct);
113 * Entry point to store the content
114 * in a (single) message
118 store_single_message (CT ct)
120 if (type_ok (ct, 1)) {
127 if (ct->c_ceclosefnx)
128 (*ct->c_ceclosefnx) (ct);
134 * Switching routine to store different content types
140 switch (ct->c_type) {
142 return store_multi (ct);
146 switch (ct->c_subtype) {
147 case MESSAGE_PARTIAL:
148 return store_partial (ct);
151 case MESSAGE_EXTERNAL:
152 return store_external (ct);
156 return store_generic (ct);
162 return store_application (ct);
169 return store_generic (ct);
173 adios (NULL, "unknown content type %d", ct->c_type);
177 return OK; /* NOT REACHED */
182 * Generic routine to store a MIME content.
183 * (audio, video, image, text, message/rfc922)
187 store_generic (CT ct)
190 * Check if the content specifies a filename.
191 * Don't bother with this for type "message"
192 * (only "message/rfc822" will use store_generic).
194 if (autosw && ct->c_type != CT_MESSAGE)
197 return store_content (ct, NULL);
202 * Store content of type "application"
206 store_application (CT ct)
209 CI ci = &ct->c_ctinfo;
211 /* Check if the content specifies a filename */
216 * If storeproc is not defined, and the content is type
217 * "application/octet-stream", we also check for various
218 * attribute/value pairs which specify if this a tar file.
220 if (!ct->c_storeproc && ct->c_subtype == APPLICATION_OCTETS) {
221 int tarP = 0, zP = 0, gzP = 0;
223 for (ap = ci->ci_attrs, ep = ci->ci_values; *ap; ap++, ep++) {
224 /* check for "type=tar" attribute */
225 if (!mh_strcasecmp (*ap, "type")) {
226 if (mh_strcasecmp (*ep, "tar"))
233 /* check for "conversions=compress" attribute */
234 if ((!mh_strcasecmp (*ap, "conversions") || !mh_strcasecmp (*ap, "x-conversions"))
235 && (!mh_strcasecmp (*ep, "compress") || !mh_strcasecmp (*ep, "x-compress"))) {
239 /* check for "conversions=gzip" attribute */
240 if ((!mh_strcasecmp (*ap, "conversions") || !mh_strcasecmp (*ap, "x-conversions"))
241 && (!mh_strcasecmp (*ep, "gzip") || !mh_strcasecmp (*ep, "x-gzip"))) {
248 ct->c_showproc = add (zP ? "%euncompress | tar tvf -"
249 : (gzP ? "%egzip -dc | tar tvf -"
250 : "%etar tvf -"), NULL);
251 if (!ct->c_storeproc) {
253 ct->c_storeproc = add (zP ? "| uncompress | tar xvpf -"
254 : (gzP ? "| gzip -dc | tar xvpf -"
255 : "| tar xvpf -"), NULL);
258 ct->c_storeproc= add (zP ? "%m%P.tar.Z"
259 : (gzP ? "%m%P.tar.gz"
260 : "%m%P.tar"), NULL);
266 return store_content (ct, NULL);
271 * Store the content of a multipart message
278 struct multipart *m = (struct multipart *) ct->c_ctparams;
282 for (part = m->mp_parts; part; part = part->mp_next) {
283 CT p = part->mp_part;
285 if (part_ok (p, 1) && type_ok (p, 1)) {
286 result = store_switch (p);
287 if (result == OK && ct->c_subtype == MULTI_ALTERNATE)
297 * Reassemble and store the contents of a collection
298 * of messages of type "message/partial".
302 store_partial (CT ct)
307 struct partial *pm, *qm;
309 qm = (struct partial *) ct->c_ctparams;
314 for (ctp = cts; *ctp; ctp++) {
316 if (p->c_type == CT_MESSAGE && p->c_subtype == ct->c_subtype) {
317 pm = (struct partial *) p->c_ctparams;
319 && strcmp (qm->pm_partid, pm->pm_partid) == 0) {
320 pm->pm_marked = pm->pm_partno;
331 advise (NULL, "missing (at least) last part of multipart message");
335 if ((base = (CT *) calloc ((size_t) (i + 1), sizeof(*base))) == NULL)
336 adios (NULL, "out of memory");
339 for (ctp = cts; *ctp; ctp++) {
341 if (p->c_type == CT_MESSAGE && p->c_subtype == ct->c_subtype) {
342 pm = (struct partial *) p->c_ctparams;
350 qsort ((char *) base, i, sizeof(*base), (qsort_comp) ct_compar);
353 for (ctq = base; *ctq; ctq++) {
355 pm = (struct partial *) p->c_ctparams;
356 if (pm->pm_marked != cur) {
357 if (pm->pm_marked == cur - 1) {
359 "duplicate part %d of %d part multipart message",
366 "missing %spart %d of %d part multipart message",
367 cur != hi ? "(at least) " : "", cur, hi);
378 * Now cycle through the sorted list of messages of type
379 * "message/partial" and save/append them to a file.
384 if (store_content (ct, NULL) == NOTOK) {
386 free ((char *) base);
390 for (; *ctq; ctq++) {
392 if (store_content (p, ct) == NOTOK)
396 free ((char *) base);
402 * Store content from a message of type "message/external".
406 store_external (CT ct)
409 struct exbody *e = (struct exbody *) ct->c_ctparams;
410 CT p = e->eb_content;
416 * Check if the parameters for the external body
417 * specified a filename.
422 if ((cp = e->eb_name)
427 && !strchr (cp, '%')) {
428 if (!ct->c_storeproc)
429 ct->c_storeproc = add (cp, NULL);
431 p->c_storeproc = add (cp, NULL);
436 * Since we will let the Content structure for the
437 * external body substitute for the current content,
438 * we temporarily change its partno (number inside
439 * multipart), so everything looks right.
441 p->c_partno = ct->c_partno;
443 /* we probably need to check if content is really there */
444 result = store_switch (p);
452 * Compare the numbering from two different
453 * message/partials (needed for sorting).
457 ct_compar (CT *a, CT *b)
459 struct partial *am = (struct partial *) ((*a)->c_ctparams);
460 struct partial *bm = (struct partial *) ((*b)->c_ctparams);
462 return (am->pm_marked - bm->pm_marked);
467 * Store contents of a message or message part to
468 * a folder, a file, the standard output, or pass
469 * the contents to a command.
471 * If the current content to be saved is a followup part
472 * to a collection of messages of type "message/partial",
473 * then field "p" is a pointer to the Content structure
474 * to the first message/partial in the group.
478 store_content (CT ct, CT p)
480 int appending = 0, msgnum = 0;
481 int is_partial = 0, first_partial = 0;
482 int last_partial = 0;
483 char *cp, buffer[BUFSIZ];
486 * Do special processing for messages of
487 * type "message/partial".
489 * We first check if this content is of type
490 * "message/partial". If it is, then we need to check
491 * whether it is the first and/or last in the group.
493 * Then if "p" is a valid pointer, it points to the Content
494 * structure of the first partial in the group. So we copy
495 * the file name and/or folder name from that message. In
496 * this case, we also note that we will be appending.
498 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
499 struct partial *pm = (struct partial *) ct->c_ctparams;
501 /* Yep, it's a message/partial */
504 /* But is it the first and/or last in the collection? */
505 if (pm->pm_partno == 1)
507 if (pm->pm_maxno && pm->pm_partno == pm->pm_maxno)
511 * If "p" is a valid pointer, then it points to the
512 * Content structure for the first message in the group.
513 * So we just copy the filename or foldername information
514 * from the previous iteration of this function.
518 ct->c_storage = add (p->c_storage, NULL);
520 /* record the folder name */
522 ct->c_folder = add (p->c_folder, NULL);
529 * Get storage formatting string.
531 * 1) If we have storeproc defined, then use that
532 * 2) Else check for a mhstore-store-<type>/<subtype> entry
533 * 3) Else check for a mhstore-store-<type> entry
534 * 4) Else if content is "message", use "+" (current folder)
535 * 5) Else use string "%m%P.%s".
537 if ((cp = ct->c_storeproc) == NULL || *cp == '\0') {
538 CI ci = &ct->c_ctinfo;
540 snprintf (buffer, sizeof(buffer), "%s-store-%s/%s",
541 invo_name, ci->ci_type, ci->ci_subtype);
542 if ((cp = context_find (buffer)) == NULL || *cp == '\0') {
543 snprintf (buffer, sizeof(buffer), "%s-store-%s", invo_name, ci->ci_type);
544 if ((cp = context_find (buffer)) == NULL || *cp == '\0') {
545 cp = ct->c_type == CT_MESSAGE ? "+" : "%m%P.%s";
551 * Check the beginning of storage formatting string
552 * to see if we are saving content to a folder.
554 if (*cp == '+' || *cp == '@') {
555 char *tmpfilenam, *folder;
557 /* Store content in temporary file for now */
558 tmpfilenam = m_mktemp(invo_name, NULL, NULL);
559 ct->c_storage = add (tmpfilenam, NULL);
561 /* Get the folder name */
563 folder = pluspath (cp);
565 folder = getfolder (1);
567 /* Check if folder exists */
568 create_folder(m_mailpath(folder), 0, exit);
570 /* Record the folder name */
571 ct->c_folder = add (folder, NULL);
580 * Parse and expand the storage formatting string
581 * in `cp' into `buffer'.
583 parse_format_string (ct, cp, buffer, sizeof(buffer), dir);
586 * If formatting begins with '|' or '!', then pass
587 * content to standard input of a command and return.
589 if (buffer[0] == '|' || buffer[0] == '!')
590 return show_content_aux (ct, 1, 0, buffer + 1, dir);
592 /* record the filename */
593 ct->c_storage = add (buffer, NULL);
596 /* flush the output stream */
599 /* Now save or append the content to a file */
600 if (output_content_file (ct, appending) == NOTOK)
604 * If necessary, link the file into a folder and remove
605 * the temporary file. If this message is a partial,
606 * then only do this if it is the last one in the group.
608 if (ct->c_folder && (!is_partial || last_partial)) {
609 msgnum = output_content_folder (ct->c_folder, ct->c_storage);
610 unlink (ct->c_storage);
616 * Now print out the name/number of the message
617 * that we are storing.
621 fprintf (stderr, "reassembling partials ");
623 fprintf (stderr, "%s", ct->c_file);
625 fprintf (stderr, "%s,", ct->c_file);
627 fprintf (stderr, "storing message %s", ct->c_file);
629 fprintf (stderr, " part %s", ct->c_partno);
633 * Unless we are in the "middle" of group of message/partials,
634 * we now print the name of the file, folder, and/or message
635 * to which we are storing the content.
637 if (!is_partial || last_partial) {
639 fprintf (stderr, " to folder %s as message %d\n", ct->c_folder, msgnum);
640 } else if (!strcmp(ct->c_storage, "-")) {
641 fprintf (stderr, " to stdout\n");
645 cwdlen = strlen (cwd);
646 fprintf (stderr, " as file %s\n",
647 strncmp (ct->c_storage, cwd, cwdlen)
648 || ct->c_storage[cwdlen] != '/'
649 ? ct->c_storage : ct->c_storage + cwdlen + 1);
658 * Output content to a file
662 output_content_file (CT ct, int appending)
665 char *file, buffer[BUFSIZ];
670 * If the pathname is absolute, make sure
671 * all the relevant directories exist.
673 if (strchr(ct->c_storage, '/')
674 && make_intermediates (ct->c_storage) == NOTOK)
677 if (ct->c_encoding != CE_7BIT) {
680 if (!ct->c_ceopenfnx) {
681 advise (NULL, "don't know how to decode part %s of message %s",
682 ct->c_partno, ct->c_file);
686 file = appending || !strcmp (ct->c_storage, "-") ? NULL
688 if ((fd = (*ct->c_ceopenfnx) (ct, &file)) == NOTOK)
690 if (!strcmp (file, ct->c_storage)) {
691 (*ct->c_ceclosefnx) (ct);
696 * Send to standard output
698 if (!strcmp (ct->c_storage, "-")) {
701 if ((gd = dup (fileno (stdout))) == NOTOK) {
702 advise ("stdout", "unable to dup");
704 (*ct->c_ceclosefnx) (ct);
707 if ((fp = fdopen (gd, appending ? "a" : "w")) == NULL) {
708 advise ("stdout", "unable to fdopen (%d, \"%s\") from", gd,
709 appending ? "a" : "w");
717 if ((fp = fopen (ct->c_storage, appending ? "a" : "w")) == NULL) {
718 advise (ct->c_storage, "unable to fopen for %s",
719 appending ? "appending" : "writing");
725 * Filter the header fields of the initial enclosing
726 * message/partial into the file.
728 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
729 struct partial *pm = (struct partial *) ct->c_ctparams;
731 if (pm->pm_partno == 1)
732 copy_some_headers (fp, ct);
736 switch (cc = read (fd, buffer, sizeof(buffer))) {
738 advise (file, "error reading content from");
745 fwrite (buffer, sizeof(*buffer), cc, fp);
751 (*ct->c_ceclosefnx) (ct);
753 if (cc != NOTOK && fflush (fp))
754 advise (ct->c_storage, "error writing to");
758 return (cc != NOTOK ? OK : NOTOK);
761 if (!ct->c_fp && (ct->c_fp = fopen (ct->c_file, "r")) == NULL) {
762 advise (ct->c_file, "unable to open for reading");
768 fseek (ct->c_fp, pos, SEEK_SET);
770 if (!strcmp (ct->c_storage, "-")) {
773 if ((gd = dup (fileno (stdout))) == NOTOK) {
774 advise ("stdout", "unable to dup");
777 if ((fp = fdopen (gd, appending ? "a" : "w")) == NULL) {
778 advise ("stdout", "unable to fdopen (%d, \"%s\") from", gd,
779 appending ? "a" : "w");
784 if ((fp = fopen (ct->c_storage, appending ? "a" : "w")) == NULL) {
785 advise (ct->c_storage, "unable to fopen for %s",
786 appending ? "appending" : "writing");
792 * Copy a few of the header fields of the initial
793 * enclosing message/partial into the file.
796 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
797 struct partial *pm = (struct partial *) ct->c_ctparams;
799 if (pm->pm_partno == 1) {
800 copy_some_headers (fp, ct);
805 while (fgets (buffer, sizeof(buffer) - 1, ct->c_fp)) {
806 if ((pos += strlen (buffer)) > last) {
809 diff = strlen (buffer) - (pos - last);
814 * If this is the first content of a group of
815 * message/partial contents, then we only copy a few
816 * of the header fields of the enclosed message.
831 if (!uprf (buffer, XXX_FIELD_PRF)
832 && !uprf (buffer, VRSN_FIELD)
833 && !uprf (buffer, "Subject:")
834 && !uprf (buffer, "Encrypted:")
835 && !uprf (buffer, "Message-ID:")) {
850 advise (ct->c_storage, "error writing to");
860 * Add a file to a folder.
862 * Return the new message number of the file
863 * when added to the folder. Return -1, if
868 output_content_folder (char *folder, char *filename)
873 /* Read the folder. */
874 if ((mp = folder_read (folder))) {
875 /* Link file into folder */
876 msgnum = folder_addmsg (&mp, filename, 0, 0, 0, 0, (char *)0);
878 advise (NULL, "unable to read folder %s", folder);
882 /* free folder structure */
886 * Return msgnum. We are relying on the fact that
887 * msgnum will be -1, if folder_addmsg() had an error.
894 * Parse and expand the storage formatting string
895 * pointed to by "cp" into "buffer".
899 parse_format_string (CT ct, char *cp, char *buffer, int buflen, char *dir)
903 CI ci = &ct->c_ctinfo;
906 * If storage string is "-", just copy it, and
907 * return (send content to standard output).
909 if (cp[0] == '-' && cp[1] == '\0') {
910 strncpy (buffer, cp, buflen);
918 * If formatting string is a pathname that doesn't
919 * begin with '/', then preface the path with the
920 * appropriate directory.
922 if (*cp != '/' && *cp != '|' && *cp != '!') {
923 snprintf (bp, buflen, "%s/", dir[1] ? dir : "");
931 /* We are processing a storage escape */
936 * Insert parameters from Content-Type.
937 * This is only valid for '|' commands.
939 if (buffer[0] != '|' && buffer[0] != '!') {
948 for (ap = ci->ci_attrs, ep = ci->ci_values;
950 snprintf (bp, buflen, "%s%s=\"%s\"", s, *ap, *ep);
960 /* insert message number */
961 snprintf (bp, buflen, "%s", r1bindex (ct->c_file, '/'));
965 /* insert part number with leading dot */
967 snprintf (bp, buflen, ".%s", ct->c_partno);
971 /* insert part number withouth leading dot */
973 strncpy (bp, ct->c_partno, buflen);
977 /* insert content type */
978 strncpy (bp, ci->ci_type, buflen);
982 /* insert content subtype */
983 strncpy (bp, ci->ci_subtype, buflen);
987 /* insert the character % */
997 /* Advance bp and decrement buflen */
1015 * Check if the content specifies a filename
1016 * in its MIME parameters.
1020 get_storeproc (CT ct)
1022 char **ap, **ep, *cp;
1023 CI ci = &ct->c_ctinfo;
1026 * If the storeproc has already been defined,
1027 * we just return (for instance, if this content
1028 * is part of a "message/external".
1030 if (ct->c_storeproc)
1034 * Check the attribute/value pairs, for the attribute "name".
1035 * If found, do a few sanity checks and copy the value into
1038 for (ap = ci->ci_attrs, ep = ci->ci_values; *ap; ap++, ep++) {
1039 if (!mh_strcasecmp (*ap, "name")
1040 && *(cp = *ep) != '/'
1044 && !strchr (cp, '%')) {
1045 ct->c_storeproc = add (cp, NULL);
1053 * Copy some of the header fields of the initial message/partial
1054 * message into the header of the reassembled message.
1058 copy_some_headers (FILE *out, CT ct)
1062 hp = ct->c_first_hf; /* start at first header field */
1066 * A few of the header fields of the enclosing
1067 * messages are not copied.
1069 if (!uprf (hp->name, XXX_FIELD_PRF)
1070 && mh_strcasecmp (hp->name, VRSN_FIELD)
1071 && mh_strcasecmp (hp->name, "Subject")
1072 && mh_strcasecmp (hp->name, "Encrypted")
1073 && mh_strcasecmp (hp->name, "Message-ID"))
1074 fprintf (out, "%s:%s", hp->name, hp->value);
1075 hp = hp->next; /* next header field */