2 ** mhstore.c -- 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>
17 #include <h/mhparse.h>
20 static struct swit switches[] = {
25 #define FILESW 2 /* interface from show */
30 { "type content", 0 },
42 extern char *tmp; /* directory to place temp files */
47 extern char *parts[NPARTS + 1];
48 extern char *types[NTYPES + 1];
53 #define quitser pipeser
56 CT parse_mime(char *);
61 void set_endian(void);
62 void flush_errors(void);
65 void free_content(CT);
66 extern CT *cts; /* The list of top-level contents to display */
72 static void pipeser(int);
77 ** Cache of current directory. This must be
78 ** set before these routines are called.
83 ** The directory in which to store the contents.
88 ** Type for a compare function for qsort. This keeps
89 ** the compiler happy.
91 typedef int (*qsort_comp) (const void *, const void *);
97 int make_intermediates(char *);
98 void flush_errors(void);
101 int show_content_aux(CT, int, char *, char *);
106 static void store_single_message(CT);
107 static int store_switch(CT);
108 static int store_generic(CT);
109 static int store_multi(CT);
110 static int store_partial(CT);
111 static int store_external(CT);
112 static int ct_compar(CT *, CT *);
113 static int store_content(CT, CT);
114 static int output_content_file(CT, int);
115 static int output_content_folder(char *, char *);
116 static int parse_format_string(CT, char *, char *, int, char *);
117 static int copy_some_headers(FILE *, CT);
118 static void store_all_messages(CT *);
122 main(int argc, char **argv)
125 char *cp, *file = NULL, *folder = NULL;
126 char *maildir, buf[100], **argp;
128 struct msgs_array msgs = { 0, 0, NULL };
129 struct msgs *mp = NULL;
133 atexit(freects_done);
135 setlocale(LC_ALL, "");
136 invo_name = mhbasename(argv[0]);
138 /* read user profile/context */
141 arguments = getarguments(invo_name, argc, argv, 1);
147 while ((cp = *argp++)) {
149 switch (smatch(++cp, switches)) {
151 ambigsw(cp, switches);
154 adios(NULL, "-%s unknown", cp);
157 snprintf(buf, sizeof(buf), "%s [+folder] [msgs] [switches]", invo_name);
158 print_help(buf, switches, 1);
161 print_version(invo_name);
172 if (!(cp = *argp++) || *cp == '-')
173 adios(NULL, "missing argument to %s",
176 adios(NULL, "too many parts (starting with %s), %d max", cp, NPARTS);
181 if (!(cp = *argp++) || *cp == '-')
182 adios(NULL, "missing argument to %s",
185 adios(NULL, "too many types (starting with %s), %d max", cp, NTYPES);
190 if (!(cp = *argp++) || (*cp == '-' && cp[1]))
191 adios(NULL, "missing argument to %s",
193 file = *cp == '-' ? cp : getcpy(expanddir(cp));
201 if (*cp == '+' || *cp == '@') {
203 adios(NULL, "only one folder at a time!");
205 folder = getcpy(expandfol(cp));
207 app_msgarg(&msgs, cp);
210 /* null terminate the list of acceptable parts/types */
217 ** Check if we've specified an additional profile
219 if ((cp = getenv("MHSTORE"))) {
220 if ((fp = fopen(cp, "r"))) {
221 readconfig((struct node **) 0, fp, cp, 0);
224 admonish("", "unable to read $MHSTORE profile (%s)",
230 ** Read the standard profile setup
232 if ((fp = fopen(cp = etcpath("mhn.defaults"), "r"))) {
233 readconfig((struct node **) 0, fp, cp, 0);
238 ** Cache the current directory before we do any chdirs()'s.
243 ** Check for storage directory. If specified,
244 ** then store temporary files there. Else we
245 ** store them in standard nmh directory.
247 if ((cp = context_find(nmhstorage)) && *cp)
248 tmp = concat(cp, "/", invo_name, NULL);
250 tmp = getcpy(toabsdir(invo_name));
252 if (file && msgs.size)
253 adios(NULL, "cannot specify msg and file at same time!");
256 ** check if message is coming from file
259 if (!(cts = (CT *) calloc((size_t) 2, sizeof(*cts))))
260 adios(NULL, "out of memory");
263 if ((ct = parse_mime(file)))
267 ** message(s) are coming from a folder
270 app_msgarg(&msgs, seq_cur);
272 folder = getcurfol();
273 maildir = toabsdir(folder);
275 if (chdir(maildir) == NOTOK)
276 adios(maildir, "unable to change directory to");
278 /* read folder and create message structure */
279 if (!(mp = folder_read(folder)))
280 adios(NULL, "unable to read folder %s", folder);
282 /* check for empty folder */
284 adios(NULL, "no messages in %s", folder);
286 /* parse all the message ranges/sequences and set SELECTED */
287 for (msgnum = 0; msgnum < msgs.size; msgnum++)
288 if (!m_convert(mp, msgs.msgs[msgnum]))
290 seq_setprev(mp); /* set the previous-sequence */
292 if (!(cts = (CT *) calloc((size_t) (mp->numsel + 1),
294 adios(NULL, "out of memory");
297 for (msgnum = mp->lowsel; msgnum <= mp->hghsel; msgnum++) {
298 if (is_selected(mp, msgnum)) {
301 msgnam = m_name(msgnum);
302 if ((ct = parse_mime(msgnam)))
312 SIGNAL(SIGQUIT, quitser);
313 SIGNAL(SIGPIPE, pipeser);
316 ** Get the associated umask for the relevant contents.
318 for (ctp = cts; *ctp; ctp++) {
322 if (type_ok(ct, 1) && !ct->c_umask) {
323 if (stat(ct->c_file, &st) != NOTOK)
324 ct->c_umask = ~(st.st_mode & 0777);
326 ct->c_umask = ~m_gmprot();
331 ** Store the message content
333 store_all_messages(cts);
335 /* Now free all the structures for the content */
336 for (ctp = cts; *ctp; ctp++)
342 /* If reading from a folder, do some updating */
344 context_replace(curfolder, folder); /* update current folder */
345 seq_setcur(mp, mp->hghsel); /* update current message */
346 seq_save(mp); /* synchronize sequences */
347 context_save(); /* save the context file */
360 fprintf(stderr, "\n");
370 ** Main entry point to store content from a collection of messages.
373 store_all_messages(CT *cts)
379 ** Check for the directory in which to
380 ** store any contents.
382 if ((cp = context_find(nmhstorage)) && *cp)
387 for (ctp = cts; *ctp; ctp++) {
389 store_single_message(ct);
397 ** Entry point to store the content
398 ** in a (single) message
402 store_single_message(CT ct)
404 if (type_ok(ct, 1)) {
411 if (ct->c_ceclosefnx)
412 (*ct->c_ceclosefnx) (ct);
418 ** Switching routine to store different content types
424 switch (ct->c_type) {
426 return store_multi(ct);
430 switch (ct->c_subtype) {
431 case MESSAGE_PARTIAL:
432 return store_partial(ct);
435 case MESSAGE_EXTERNAL:
436 return store_external(ct);
440 return store_generic(ct);
450 return store_generic(ct);
454 adios(NULL, "unknown content type %d", ct->c_type);
458 return OK; /* NOT REACHED */
463 ** Generic routine to store a MIME content.
464 ** (application, audio, video, image, text, message/rfc922)
469 char **ap, **vp, *cp;
470 CI ci = &ct->c_ctinfo;
473 ** Check if the content specifies a filename in its MIME parameters.
474 ** Don't bother with this for type "message"
475 ** (only the "message" subtype "rfc822" will use store_generic).
477 if (autosw && ct->c_type != CT_MESSAGE) {
479 ** Check the attribute/value pairs, for the attribute "name".
480 ** If found, take the basename, do a few sanity checks and
481 ** copy the value into c_storeproc.
483 for (ap = ci->ci_attrs, vp = ci->ci_values; *ap; ap++,vp++) {
484 if (mh_strcasecmp(*ap, "name")!=0) {
487 cp = mhbasename(*vp);
488 if (*cp && *cp!='.' && *cp!='|' && *cp!='!' &&
490 /* filename looks good: use it */
491 ct->c_storeproc = getcpy(cp);
497 return store_content(ct, NULL);
502 ** Store the content of a multipart message
509 struct multipart *m = (struct multipart *) ct->c_ctparams;
513 for (part = m->mp_parts; part; part = part->mp_next) {
514 CT p = part->mp_part;
516 if (part_ok(p, 1) && type_ok(p, 1)) {
517 result = store_switch(p);
518 if (result == OK && ct->c_subtype == MULTI_ALTERNATE)
528 ** Reassemble and store the contents of a collection
529 ** of messages of type "message/partial".
538 struct partial *pm, *qm;
540 qm = (struct partial *) ct->c_ctparams;
545 for (ctp = cts; *ctp; ctp++) {
547 if (p->c_type == CT_MESSAGE && p->c_subtype == ct->c_subtype) {
548 pm = (struct partial *) p->c_ctparams;
549 if (!pm->pm_stored &&
550 strcmp(qm->pm_partid, pm->pm_partid)
552 pm->pm_marked = pm->pm_partno;
563 advise(NULL, "missing (at least) last part of multipart message");
567 if ((base = (CT *) calloc((size_t) (i + 1), sizeof(*base))) == NULL)
568 adios(NULL, "out of memory");
571 for (ctp = cts; *ctp; ctp++) {
573 if (p->c_type == CT_MESSAGE && p->c_subtype == ct->c_subtype) {
574 pm = (struct partial *) p->c_ctparams;
582 qsort((char *) base, i, sizeof(*base), (qsort_comp) ct_compar);
585 for (ctq = base; *ctq; ctq++) {
587 pm = (struct partial *) p->c_ctparams;
588 if (pm->pm_marked != cur) {
589 if (pm->pm_marked == cur - 1) {
590 admonish(NULL, "duplicate part %d of %d part multipart message", pm->pm_marked, hi);
595 advise (NULL, "missing %spart %d of %d part multipart message", cur != hi ? "(at least) " : "", cur, hi);
606 ** Now cycle through the sorted list of messages of type
607 ** "message/partial" and save/append them to a file.
612 if (store_content(ct, NULL) == NOTOK) {
618 for (; *ctq; ctq++) {
620 if (store_content(p, ct) == NOTOK)
630 ** Show how to retrieve content of type "message/external".
633 store_external(CT ct)
640 msg = add("You need to fetch the contents yourself:", NULL);
641 ap = ct->c_ctinfo.ci_attrs;
642 ep = ct->c_ctinfo.ci_values;
643 for (; *ap; ap++, ep++) {
644 msg = add(concat("\n\t", *ap, ": ", *ep, NULL), msg);
646 if (!(fp = fopen(ct->c_file, "r"))) {
647 adios(ct->c_file, "unable to open");
649 fseek(fp, ct->c_begin, SEEK_SET);
650 while (!feof(fp) && ftell(fp) < ct->c_end) {
651 if (!fgets(buf, sizeof buf, fp)) {
652 adios(ct->c_file, "unable to read");
654 *strchr(buf, '\n') = '\0';
655 msg = add(concat("\n\t", buf, NULL), msg);
664 ** Compare the numbering from two different
665 ** message/partials (needed for sorting).
669 ct_compar(CT *a, CT *b)
671 struct partial *am = (struct partial *) ((*a)->c_ctparams);
672 struct partial *bm = (struct partial *) ((*b)->c_ctparams);
674 return (am->pm_marked - bm->pm_marked);
679 ** Store contents of a message or message part to
680 ** a folder, a file, the standard output, or pass
681 ** the contents to a command.
683 ** If the current content to be saved is a followup part
684 ** to a collection of messages of type "message/partial",
685 ** then field "p" is a pointer to the Content structure
686 ** to the first message/partial in the group.
690 store_content(CT ct, CT p)
692 int appending = 0, msgnum = 0;
693 int is_partial = 0, first_partial = 0;
694 int last_partial = 0;
695 char *cp, buffer[BUFSIZ];
698 ** Do special processing for messages of
699 ** type "message/partial".
701 ** We first check if this content is of type
702 ** "message/partial". If it is, then we need to check
703 ** whether it is the first and/or last in the group.
705 ** Then if "p" is a valid pointer, it points to the Content
706 ** structure of the first partial in the group. So we copy
707 ** the file name and/or folder name from that message. In
708 ** this case, we also note that we will be appending.
710 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
711 struct partial *pm = (struct partial *) ct->c_ctparams;
713 /* Yep, it's a message/partial */
716 /* But is it the first and/or last in the collection? */
717 if (pm->pm_partno == 1)
719 if (pm->pm_maxno && pm->pm_partno == pm->pm_maxno)
723 ** If "p" is a valid pointer, then it points to the
724 ** Content structure for the first message in the group.
725 ** So we just copy the filename or foldername information
726 ** from the previous iteration of this function.
730 ct->c_storage = getcpy(p->c_storage);
732 /* record the folder name */
734 ct->c_folder = getcpy(p->c_folder);
741 ** Get storage formatting string.
743 ** 1) If we have storeproc defined, then use that
744 ** 2) Else check for a mhstore-store-<type>/<subtype> entry
745 ** 3) Else check for a mhstore-store-<type> entry
746 ** 4) Else if content is "message", use "+" (current folder)
747 ** 5) Else use string "%m%P.%s".
749 if (!(cp = ct->c_storeproc) || !*cp) {
750 CI ci = &ct->c_ctinfo;
752 snprintf(buffer, sizeof(buffer), "%s-store-%s/%s",
753 invo_name, ci->ci_type, ci->ci_subtype);
754 if ((cp = context_find(buffer)) == NULL || *cp == '\0') {
755 snprintf(buffer, sizeof(buffer), "%s-store-%s",
756 invo_name, ci->ci_type);
757 if ((cp = context_find(buffer)) == NULL ||
759 cp = ct->c_type == CT_MESSAGE ?
766 ** Check the beginning of storage formatting string
767 ** to see if we are saving content to a folder.
769 if (*cp == '+' || *cp == '@') {
770 char *tmpfilenam, *folder;
772 /* Store content in temporary file for now */
773 tmpfilenam = m_mktemp(invo_name, NULL, NULL);
774 ct->c_storage = getcpy(tmpfilenam);
776 /* Get the folder name */
778 folder = getcpy(expandfol(cp));
780 folder = getcurfol();
782 /* Check if folder exists */
783 create_folder(toabsdir(folder), 0, exit);
785 /* Record the folder name */
786 ct->c_folder = getcpy(folder);
795 ** Parse and expand the storage formatting string
796 ** in `cp' into `buffer'.
798 parse_format_string(ct, cp, buffer, sizeof(buffer), dir);
801 ** If formatting begins with '|' or '!', then pass
802 ** content to standard input of a command and return.
804 if (buffer[0] == '|' || buffer[0] == '!')
805 return show_content_aux(ct, 0, buffer + 1, dir);
807 /* record the filename */
808 ct->c_storage = getcpy(buffer);
811 /* flush the output stream */
814 /* Now save or append the content to a file */
815 if (output_content_file(ct, appending) == NOTOK)
819 ** If necessary, link the file into a folder and remove
820 ** the temporary file. If this message is a partial,
821 ** then only do this if it is the last one in the group.
823 if (ct->c_folder && (!is_partial || last_partial)) {
824 msgnum = output_content_folder(ct->c_folder, ct->c_storage);
825 unlink(ct->c_storage);
831 ** Now print out the name/number of the message
832 ** that we are storing.
836 fprintf(stderr, "reassembling partials ");
838 fprintf(stderr, "%s", ct->c_file);
840 fprintf(stderr, "%s,", ct->c_file);
842 fprintf(stderr, "storing message %s", ct->c_file);
844 fprintf(stderr, " part %s", ct->c_partno);
848 ** Unless we are in the "middle" of group of message/partials,
849 ** we now print the name of the file, folder, and/or message
850 ** to which we are storing the content.
852 if (!is_partial || last_partial) {
854 fprintf(stderr, " to folder %s as message %d\n",
855 ct->c_folder, msgnum);
856 } else if (strcmp(ct->c_storage, "-")==0) {
857 fprintf(stderr, " to stdout\n");
861 cwdlen = strlen(cwd);
862 fprintf(stderr, " as file %s\n",
863 strncmp(ct->c_storage, cwd,
865 ct->c_storage[cwdlen] != '/' ?
867 ct->c_storage + cwdlen + 1);
876 ** Output content to a file
880 output_content_file(CT ct, int appending)
883 char *file, buffer[BUFSIZ];
888 ** If the pathname contains directories, make sure
889 ** all of them exist.
891 if (strchr(ct->c_storage, '/') && make_intermediates(ct->c_storage)
895 if (ct->c_encoding != CE_7BIT) {
898 if (!ct->c_ceopenfnx) {
899 advise(NULL, "don't know how to decode part %s of message %s", ct->c_partno, ct->c_file);
903 file = appending || strcmp(ct->c_storage, "-")==0 ?
904 NULL : ct->c_storage;
905 if ((fd = (*ct->c_ceopenfnx) (ct, &file)) == NOTOK)
907 if (strcmp(file, ct->c_storage)==0) {
908 (*ct->c_ceclosefnx) (ct);
913 ** Send to standard output
915 if (strcmp(ct->c_storage, "-")==0) {
918 if ((gd = dup(fileno(stdout))) == NOTOK) {
919 advise("stdout", "unable to dup");
921 (*ct->c_ceclosefnx) (ct);
924 if ((fp = fdopen(gd, appending ? "a" : "w")) == NULL) {
925 advise("stdout", "unable to fdopen (%d, \"%s\") from", gd, appending ? "a" : "w");
933 if ((fp = fopen(ct->c_storage, appending ? "a" : "w"))
935 advise(ct->c_storage, "unable to fopen for %s",
937 "appending" : "writing");
943 ** Filter the header fields of the initial enclosing
944 ** message/partial into the file.
946 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
947 struct partial *pm = (struct partial *) ct->c_ctparams;
949 if (pm->pm_partno == 1)
950 copy_some_headers(fp, ct);
954 switch (cc = read(fd, buffer, sizeof(buffer))) {
956 advise(file, "error reading content from");
963 fwrite(buffer, sizeof(*buffer), cc, fp);
969 (*ct->c_ceclosefnx) (ct);
971 if (cc != NOTOK && fflush(fp))
972 advise(ct->c_storage, "error writing to");
976 return (cc != NOTOK ? OK : NOTOK);
979 if (!ct->c_fp && (ct->c_fp = fopen(ct->c_file, "r")) == NULL) {
980 advise(ct->c_file, "unable to open for reading");
986 fseek(ct->c_fp, pos, SEEK_SET);
988 if (strcmp(ct->c_storage, "-")==0) {
991 if ((gd = dup(fileno(stdout))) == NOTOK) {
992 advise("stdout", "unable to dup");
995 if ((fp = fdopen(gd, appending ? "a" : "w")) == NULL) {
996 advise("stdout", "unable to fdopen (%d, \"%s\") from",
997 gd, appending ? "a" : "w");
1002 if ((fp = fopen(ct->c_storage, appending ? "a" : "w"))
1004 advise(ct->c_storage, "unable to fopen for %s",
1005 appending ? "appending" : "writing");
1011 ** Copy a few of the header fields of the initial
1012 ** enclosing message/partial into the file.
1015 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
1016 struct partial *pm = (struct partial *) ct->c_ctparams;
1018 if (pm->pm_partno == 1) {
1019 copy_some_headers(fp, ct);
1024 while (fgets(buffer, sizeof(buffer) - 1, ct->c_fp)) {
1025 if ((pos += strlen(buffer)) > last) {
1028 diff = strlen(buffer) - (pos - last);
1030 buffer[diff] = '\0';
1033 ** If this is the first content of a group of
1034 ** message/partial contents, then we only copy a few
1035 ** of the header fields of the enclosed message.
1038 switch (buffer[0]) {
1041 if (filterstate < 0)
1050 if (!uprf(buffer, XXX_FIELD_PRF) && !uprf(buffer, VRSN_FIELD) && !uprf(buffer, "Subject:") && !uprf(buffer, "Message-ID:")) {
1065 advise(ct->c_storage, "error writing to");
1075 ** Add a file to a folder.
1077 ** Return the new message number of the file
1078 ** when added to the folder. Return -1, if
1079 ** there is an error.
1083 output_content_folder(char *folder, char *filename)
1088 /* Read the folder. */
1089 if ((mp = folder_read(folder))) {
1090 /* Link file into folder */
1091 msgnum = folder_addmsg(&mp, filename, 0, 0, 0, 0, NULL);
1093 advise(NULL, "unable to read folder %s", folder);
1097 /* free folder structure */
1101 ** Return msgnum. We are relying on the fact that
1102 ** msgnum will be -1, if folder_addmsg() had an error.
1109 ** Parse and expand the storage formatting string
1110 ** pointed to by "cp" into "buffer".
1114 parse_format_string(CT ct, char *cp, char *buffer, int buflen, char *dir)
1118 CI ci = &ct->c_ctinfo;
1121 ** If storage string is "-", just copy it, and
1122 ** return (send content to standard output).
1124 if (cp[0] == '-' && cp[1] == '\0') {
1125 strncpy(buffer, cp, buflen);
1133 ** If formatting string is a pathname that doesn't
1134 ** begin with '/', then preface the path with the
1135 ** appropriate directory.
1137 if (*cp != '/' && *cp != '|' && *cp != '!') {
1138 snprintf(bp, buflen, "%s/", dir[1] ? dir : "");
1146 /* We are processing a storage escape */
1151 ** Insert parameters from Content-Type.
1152 ** This is only valid for '|' commands.
1154 if (buffer[0] != '|' && buffer[0] != '!') {
1163 for (ap=ci->ci_attrs, ep=ci->ci_values;
1165 snprintf(bp, buflen,
1177 /* insert message number */
1178 snprintf(bp, buflen, "%s",
1179 mhbasename(ct->c_file));
1183 /* insert part number with leading dot */
1185 snprintf(bp, buflen, ".%s",
1190 /* insert part number withouth leading dot */
1192 strncpy(bp, ct->c_partno, buflen);
1196 /* insert content type */
1197 strncpy(bp, ci->ci_type, buflen);
1201 /* insert content subtype */
1202 strncpy(bp, ci->ci_subtype, buflen);
1206 /* insert the character % */
1216 /* Advance bp and decrement buflen */
1234 ** Copy some of the header fields of the initial message/partial
1235 ** message into the header of the reassembled message.
1239 copy_some_headers(FILE *out, CT ct)
1243 hp = ct->c_first_hf; /* start at first header field */
1247 ** A few of the header fields of the enclosing
1248 ** messages are not copied.
1250 if (!uprf(hp->name, XXX_FIELD_PRF) &&
1251 mh_strcasecmp(hp->name, VRSN_FIELD) &&
1252 mh_strcasecmp(hp->name, "Subject") &&
1253 mh_strcasecmp(hp->name, "Message-ID"))
1254 fprintf(out, "%s:%s", hp->name, hp->value);
1255 hp = hp->next; /* next header field */