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>
16 #include <h/mhparse.h>
22 static struct swit switches[] = {
27 #define FILESW 2 /* interface from show */
32 { "type content", 0 },
44 extern char *tmp; /* directory to place temp files */
49 extern char *parts[NPARTS + 1];
50 extern char *types[NTYPES + 1];
55 #define quitser pipeser
58 CT parse_mime(char *);
63 void set_endian(void);
64 void flush_errors(void);
67 void free_content(CT);
68 extern CT *cts; /* The list of top-level contents to display */
74 static void pipeser(int);
79 ** Cache of current directory. This must be
80 ** set before these routines are called.
85 ** The directory in which to store the contents.
90 ** Type for a compare function for qsort. This keeps
91 ** the compiler happy.
93 typedef int (*qsort_comp) (const void *, const void *);
99 int make_intermediates(char *);
100 void flush_errors(void);
103 int show_content_aux(CT, int, char *, char *);
108 static void store_single_message(CT);
109 static int store_switch(CT);
110 static int store_generic(CT);
111 static int store_multi(CT);
112 static int store_partial(CT);
113 static int store_external(CT);
114 static int ct_compar(CT *, CT *);
115 static int store_content(CT, CT);
116 static int output_content_file(CT, int);
117 static int output_content_folder(char *, char *);
118 static int parse_format_string(CT, char *, char *, int, char *);
119 static int copy_some_headers(FILE *, CT);
120 static void store_all_messages(CT *);
124 main(int argc, char **argv)
127 char *cp, *file = NULL, *folder = NULL;
128 char *maildir, buf[100], **argp;
130 struct msgs_array msgs = { 0, 0, NULL };
131 struct msgs *mp = NULL;
135 if (atexit(freects_done) != 0) {
136 adios(NULL, "atexit failed");
139 setlocale(LC_ALL, "");
140 invo_name = mhbasename(argv[0]);
142 /* read user profile/context */
145 arguments = getarguments(invo_name, argc, argv, 1);
151 while ((cp = *argp++)) {
153 switch (smatch(++cp, switches)) {
155 ambigsw(cp, switches);
158 adios(NULL, "-%s unknown", cp);
161 snprintf(buf, sizeof(buf), "%s [+folder] [msgs] [switches]", invo_name);
162 print_help(buf, switches, 1);
165 print_version(invo_name);
176 if (!(cp = *argp++) || *cp == '-')
177 adios(NULL, "missing argument to %s",
180 adios(NULL, "too many parts (starting with %s), %d max", cp, NPARTS);
185 if (!(cp = *argp++) || *cp == '-')
186 adios(NULL, "missing argument to %s",
189 adios(NULL, "too many types (starting with %s), %d max", cp, NTYPES);
194 if (!(cp = *argp++) || (*cp == '-' && cp[1]))
195 adios(NULL, "missing argument to %s",
197 file = *cp == '-' ? cp : getcpy(expanddir(cp));
205 if (*cp == '+' || *cp == '@') {
207 adios(NULL, "only one folder at a time!");
209 folder = getcpy(expandfol(cp));
211 app_msgarg(&msgs, cp);
214 /* null terminate the list of acceptable parts/types */
221 ** Check if we've specified an additional profile
223 if ((cp = getenv("MHSTORE"))) {
224 if ((fp = fopen(cp, "r"))) {
225 readconfig((struct node **) 0, fp, cp, 0);
228 admonish("", "unable to read $MHSTORE profile (%s)",
234 ** Read the standard profile setup
236 if ((fp = fopen(cp = etcpath("mhn.defaults"), "r"))) {
237 readconfig((struct node **) 0, fp, cp, 0);
242 ** Cache the current directory before we do any chdirs()'s.
247 ** Check for storage directory. If specified,
248 ** then store temporary files there. Else we
249 ** store them in standard nmh directory.
251 if ((cp = context_find(nmhstorage)) && *cp)
252 tmp = concat(cp, "/", invo_name, NULL);
254 tmp = getcpy(toabsdir(invo_name));
256 if (file && msgs.size)
257 adios(NULL, "cannot specify msg and file at same time!");
260 ** check if message is coming from file
263 if (!(cts = (CT *) calloc((size_t) 2, sizeof(*cts))))
264 adios(NULL, "out of memory");
267 if ((ct = parse_mime(file)))
271 ** message(s) are coming from a folder
274 app_msgarg(&msgs, seq_cur);
276 folder = getcurfol();
277 maildir = toabsdir(folder);
279 if (chdir(maildir) == NOTOK)
280 adios(maildir, "unable to change directory to");
282 /* read folder and create message structure */
283 if (!(mp = folder_read(folder)))
284 adios(NULL, "unable to read folder %s", folder);
286 /* check for empty folder */
288 adios(NULL, "no messages in %s", folder);
290 /* parse all the message ranges/sequences and set SELECTED */
291 for (msgnum = 0; msgnum < msgs.size; msgnum++)
292 if (!m_convert(mp, msgs.msgs[msgnum]))
294 seq_setprev(mp); /* set the previous-sequence */
296 if (!(cts = (CT *) calloc((size_t) (mp->numsel + 1),
298 adios(NULL, "out of memory");
301 for (msgnum = mp->lowsel; msgnum <= mp->hghsel; msgnum++) {
302 if (is_selected(mp, msgnum)) {
305 msgnam = m_name(msgnum);
306 if ((ct = parse_mime(msgnam)))
316 SIGNAL(SIGQUIT, quitser);
317 SIGNAL(SIGPIPE, pipeser);
320 ** Get the associated umask for the relevant contents.
322 for (ctp = cts; *ctp; ctp++) {
326 if (type_ok(ct, 1) && !ct->c_umask) {
327 if (stat(ct->c_file, &st) != NOTOK)
328 ct->c_umask = ~(st.st_mode & 0777);
330 ct->c_umask = ~m_gmprot();
335 ** Store the message content
337 store_all_messages(cts);
339 /* Now free all the structures for the content */
340 for (ctp = cts; *ctp; ctp++)
346 /* If reading from a folder, do some updating */
348 context_replace(curfolder, folder); /* update current folder */
349 seq_setcur(mp, mp->hghsel); /* update current message */
350 seq_save(mp); /* synchronize sequences */
351 context_save(); /* save the context file */
364 fprintf(stderr, "\n");
374 ** Main entry point to store content from a collection of messages.
377 store_all_messages(CT *cts)
383 ** Check for the directory in which to
384 ** store any contents.
386 if ((cp = context_find(nmhstorage)) && *cp)
391 for (ctp = cts; *ctp; ctp++) {
393 store_single_message(ct);
401 ** Entry point to store the content
402 ** in a (single) message
406 store_single_message(CT ct)
408 if (type_ok(ct, 1)) {
415 if (ct->c_ceclosefnx)
416 (*ct->c_ceclosefnx) (ct);
422 ** Switching routine to store different content types
428 switch (ct->c_type) {
430 return store_multi(ct);
434 switch (ct->c_subtype) {
435 case MESSAGE_PARTIAL:
436 return store_partial(ct);
439 case MESSAGE_EXTERNAL:
440 return store_external(ct);
444 return store_generic(ct);
454 return store_generic(ct);
458 adios(NULL, "unknown content type %d", ct->c_type);
462 return OK; /* NOT REACHED */
467 ** Generic routine to store a MIME content.
468 ** (application, audio, video, image, text, message/rfc922)
473 char **ap, **vp, *cp;
474 CI ci = &ct->c_ctinfo;
477 ** Check if the content specifies a filename in its MIME parameters.
478 ** Don't bother with this for type "message"
479 ** (only the "message" subtype "rfc822" will use store_generic).
481 if (autosw && ct->c_type != CT_MESSAGE) {
483 ** Check the attribute/value pairs, for the attribute "name".
484 ** If found, take the basename, do a few sanity checks and
485 ** copy the value into c_storeproc.
487 for (ap = ci->ci_attrs, vp = ci->ci_values; *ap; ap++,vp++) {
488 if (mh_strcasecmp(*ap, "name")!=0) {
491 cp = mhbasename(*vp);
492 if (*cp && *cp!='.' && *cp!='|' && *cp!='!' &&
494 /* filename looks good: use it */
495 ct->c_storeproc = getcpy(cp);
501 return store_content(ct, NULL);
506 ** Store the content of a multipart message
513 struct multipart *m = (struct multipart *) ct->c_ctparams;
517 for (part = m->mp_parts; part; part = part->mp_next) {
518 CT p = part->mp_part;
520 if (part_ok(p, 1) && type_ok(p, 1)) {
521 result = store_switch(p);
522 if (result == OK && ct->c_subtype == MULTI_ALTERNATE)
532 ** Reassemble and store the contents of a collection
533 ** of messages of type "message/partial".
542 struct partial *pm, *qm;
544 qm = (struct partial *) ct->c_ctparams;
549 for (ctp = cts; *ctp; ctp++) {
551 if (p->c_type == CT_MESSAGE && p->c_subtype == ct->c_subtype) {
552 pm = (struct partial *) p->c_ctparams;
553 if (!pm->pm_stored &&
554 strcmp(qm->pm_partid, pm->pm_partid)
556 pm->pm_marked = pm->pm_partno;
567 advise(NULL, "missing (at least) last part of multipart message");
571 if ((base = (CT *) calloc((size_t) (i + 1), sizeof(*base))) == NULL)
572 adios(NULL, "out of memory");
575 for (ctp = cts; *ctp; ctp++) {
577 if (p->c_type == CT_MESSAGE && p->c_subtype == ct->c_subtype) {
578 pm = (struct partial *) p->c_ctparams;
586 qsort((char *) base, i, sizeof(*base), (qsort_comp) ct_compar);
589 for (ctq = base; *ctq; ctq++) {
591 pm = (struct partial *) p->c_ctparams;
592 if (pm->pm_marked != cur) {
593 if (pm->pm_marked == cur - 1) {
594 admonish(NULL, "duplicate part %d of %d part multipart message", pm->pm_marked, hi);
599 advise (NULL, "missing %spart %d of %d part multipart message", cur != hi ? "(at least) " : "", cur, hi);
610 ** Now cycle through the sorted list of messages of type
611 ** "message/partial" and save/append them to a file.
616 if (store_content(ct, NULL) == NOTOK) {
622 for (; *ctq; ctq++) {
624 if (store_content(p, ct) == NOTOK)
634 ** Show how to retrieve content of type "message/external".
637 store_external(CT ct)
644 msg = add("You need to fetch the contents yourself:", NULL);
645 ap = ct->c_ctinfo.ci_attrs;
646 ep = ct->c_ctinfo.ci_values;
647 for (; *ap; ap++, ep++) {
648 msg = add(concat("\n\t", *ap, ": ", *ep, NULL), msg);
650 if (!(fp = fopen(ct->c_file, "r"))) {
651 adios(ct->c_file, "unable to open");
653 fseek(fp, ct->c_begin, SEEK_SET);
654 while (!feof(fp) && ftell(fp) < ct->c_end) {
655 if (!fgets(buf, sizeof buf, fp)) {
656 adios(ct->c_file, "unable to read");
658 *strchr(buf, '\n') = '\0';
659 msg = add(concat("\n\t", buf, NULL), msg);
668 ** Compare the numbering from two different
669 ** message/partials (needed for sorting).
673 ct_compar(CT *a, CT *b)
675 struct partial *am = (struct partial *) ((*a)->c_ctparams);
676 struct partial *bm = (struct partial *) ((*b)->c_ctparams);
678 return (am->pm_marked - bm->pm_marked);
683 ** Store contents of a message or message part to
684 ** a folder, a file, the standard output, or pass
685 ** the contents to a command.
687 ** If the current content to be saved is a followup part
688 ** to a collection of messages of type "message/partial",
689 ** then field "p" is a pointer to the Content structure
690 ** to the first message/partial in the group.
694 store_content(CT ct, CT p)
696 int appending = 0, msgnum = 0;
697 int is_partial = 0, first_partial = 0;
698 int last_partial = 0;
699 char *cp, buffer[BUFSIZ];
702 ** Do special processing for messages of
703 ** type "message/partial".
705 ** We first check if this content is of type
706 ** "message/partial". If it is, then we need to check
707 ** whether it is the first and/or last in the group.
709 ** Then if "p" is a valid pointer, it points to the Content
710 ** structure of the first partial in the group. So we copy
711 ** the file name and/or folder name from that message. In
712 ** this case, we also note that we will be appending.
714 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
715 struct partial *pm = (struct partial *) ct->c_ctparams;
717 /* Yep, it's a message/partial */
720 /* But is it the first and/or last in the collection? */
721 if (pm->pm_partno == 1)
723 if (pm->pm_maxno && pm->pm_partno == pm->pm_maxno)
727 ** If "p" is a valid pointer, then it points to the
728 ** Content structure for the first message in the group.
729 ** So we just copy the filename or foldername information
730 ** from the previous iteration of this function.
734 ct->c_storage = getcpy(p->c_storage);
736 /* record the folder name */
738 ct->c_folder = getcpy(p->c_folder);
745 ** Get storage formatting string.
747 ** 1) If we have storeproc defined, then use that
748 ** 2) Else check for a mhstore-store-<type>/<subtype> entry
749 ** 3) Else check for a mhstore-store-<type> entry
750 ** 4) Else if content is "message", use "+" (current folder)
751 ** 5) Else use string "%m%P.%s".
753 if (!(cp = ct->c_storeproc) || !*cp) {
754 CI ci = &ct->c_ctinfo;
756 snprintf(buffer, sizeof(buffer), "%s-store-%s/%s",
757 invo_name, ci->ci_type, ci->ci_subtype);
758 if ((cp = context_find(buffer)) == NULL || *cp == '\0') {
759 snprintf(buffer, sizeof(buffer), "%s-store-%s",
760 invo_name, ci->ci_type);
761 if ((cp = context_find(buffer)) == NULL ||
763 cp = ct->c_type == CT_MESSAGE ?
770 ** Check the beginning of storage formatting string
771 ** to see if we are saving content to a folder.
773 if (*cp == '+' || *cp == '@') {
774 char *tmpfilenam, *folder;
776 /* Store content in temporary file for now */
777 tmpfilenam = m_mktemp(invo_name, NULL, NULL);
778 ct->c_storage = getcpy(tmpfilenam);
780 /* Get the folder name */
782 folder = getcpy(expandfol(cp));
784 folder = getcurfol();
786 /* Check if folder exists */
787 create_folder(toabsdir(folder), 0, exit);
789 /* Record the folder name */
790 ct->c_folder = getcpy(folder);
799 ** Parse and expand the storage formatting string
800 ** in `cp' into `buffer'.
802 parse_format_string(ct, cp, buffer, sizeof(buffer), dir);
805 ** If formatting begins with '|' or '!', then pass
806 ** content to standard input of a command and return.
808 if (buffer[0] == '|' || buffer[0] == '!')
809 return show_content_aux(ct, 0, buffer + 1, dir);
811 /* record the filename */
812 ct->c_storage = getcpy(buffer);
815 /* flush the output stream */
818 /* Now save or append the content to a file */
819 if (output_content_file(ct, appending) == NOTOK)
823 ** If necessary, link the file into a folder and remove
824 ** the temporary file. If this message is a partial,
825 ** then only do this if it is the last one in the group.
827 if (ct->c_folder && (!is_partial || last_partial)) {
828 msgnum = output_content_folder(ct->c_folder, ct->c_storage);
829 unlink(ct->c_storage);
835 ** Now print out the name/number of the message
836 ** that we are storing.
840 fprintf(stderr, "reassembling partials ");
842 fprintf(stderr, "%s", ct->c_file);
844 fprintf(stderr, "%s,", ct->c_file);
846 fprintf(stderr, "storing message %s", ct->c_file);
848 fprintf(stderr, " part %s", ct->c_partno);
852 ** Unless we are in the "middle" of group of message/partials,
853 ** we now print the name of the file, folder, and/or message
854 ** to which we are storing the content.
856 if (!is_partial || last_partial) {
858 fprintf(stderr, " to folder %s as message %d\n",
859 ct->c_folder, msgnum);
860 } else if (strcmp(ct->c_storage, "-")==0) {
861 fprintf(stderr, " to stdout\n");
865 cwdlen = strlen(cwd);
866 fprintf(stderr, " as file %s\n",
867 strncmp(ct->c_storage, cwd,
869 ct->c_storage[cwdlen] != '/' ?
871 ct->c_storage + cwdlen + 1);
880 ** Output content to a file
884 output_content_file(CT ct, int appending)
887 char *file, buffer[BUFSIZ];
892 ** If the pathname contains directories, make sure
893 ** all of them exist.
895 if (strchr(ct->c_storage, '/') && make_intermediates(ct->c_storage)
899 if (ct->c_encoding != CE_7BIT) {
902 if (!ct->c_ceopenfnx) {
903 advise(NULL, "don't know how to decode part %s of message %s", ct->c_partno, ct->c_file);
907 file = appending || strcmp(ct->c_storage, "-")==0 ?
908 NULL : ct->c_storage;
909 if ((fd = (*ct->c_ceopenfnx) (ct, &file)) == NOTOK)
911 if (strcmp(file, ct->c_storage)==0) {
912 (*ct->c_ceclosefnx) (ct);
917 ** Send to standard output
919 if (strcmp(ct->c_storage, "-")==0) {
922 if ((gd = dup(fileno(stdout))) == NOTOK) {
923 advise("stdout", "unable to dup");
925 (*ct->c_ceclosefnx) (ct);
928 if ((fp = fdopen(gd, appending ? "a" : "w")) == NULL) {
929 advise("stdout", "unable to fdopen (%d, \"%s\") from", gd, appending ? "a" : "w");
937 if ((fp = fopen(ct->c_storage, appending ? "a" : "w"))
939 advise(ct->c_storage, "unable to fopen for %s",
941 "appending" : "writing");
947 ** Filter the header fields of the initial enclosing
948 ** message/partial into the file.
950 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
951 struct partial *pm = (struct partial *) ct->c_ctparams;
953 if (pm->pm_partno == 1)
954 copy_some_headers(fp, ct);
958 switch (cc = read(fd, buffer, sizeof(buffer))) {
960 advise(file, "error reading content from");
967 fwrite(buffer, sizeof(*buffer), cc, fp);
973 (*ct->c_ceclosefnx) (ct);
975 if (cc != NOTOK && fflush(fp))
976 advise(ct->c_storage, "error writing to");
980 return (cc != NOTOK ? OK : NOTOK);
983 if (!ct->c_fp && (ct->c_fp = fopen(ct->c_file, "r")) == NULL) {
984 advise(ct->c_file, "unable to open for reading");
990 fseek(ct->c_fp, pos, SEEK_SET);
992 if (strcmp(ct->c_storage, "-")==0) {
995 if ((gd = dup(fileno(stdout))) == NOTOK) {
996 advise("stdout", "unable to dup");
999 if ((fp = fdopen(gd, appending ? "a" : "w")) == NULL) {
1000 advise("stdout", "unable to fdopen (%d, \"%s\") from",
1001 gd, appending ? "a" : "w");
1006 if ((fp = fopen(ct->c_storage, appending ? "a" : "w"))
1008 advise(ct->c_storage, "unable to fopen for %s",
1009 appending ? "appending" : "writing");
1015 ** Copy a few of the header fields of the initial
1016 ** enclosing message/partial into the file.
1019 if (ct->c_type == CT_MESSAGE && ct->c_subtype == MESSAGE_PARTIAL) {
1020 struct partial *pm = (struct partial *) ct->c_ctparams;
1022 if (pm->pm_partno == 1) {
1023 copy_some_headers(fp, ct);
1028 while (fgets(buffer, sizeof(buffer) - 1, ct->c_fp)) {
1029 if ((pos += strlen(buffer)) > last) {
1032 diff = strlen(buffer) - (pos - last);
1034 buffer[diff] = '\0';
1037 ** If this is the first content of a group of
1038 ** message/partial contents, then we only copy a few
1039 ** of the header fields of the enclosed message.
1042 switch (buffer[0]) {
1045 if (filterstate < 0)
1054 if (!uprf(buffer, XXX_FIELD_PRF) && !uprf(buffer, VRSN_FIELD) && !uprf(buffer, "Subject:") && !uprf(buffer, "Message-ID:")) {
1069 advise(ct->c_storage, "error writing to");
1079 ** Add a file to a folder.
1081 ** Return the new message number of the file
1082 ** when added to the folder. Return -1, if
1083 ** there is an error.
1087 output_content_folder(char *folder, char *filename)
1092 /* Read the folder. */
1093 if ((mp = folder_read(folder))) {
1094 /* Link file into folder */
1095 msgnum = folder_addmsg(&mp, filename, 0, 0, 0, 0, NULL);
1097 advise(NULL, "unable to read folder %s", folder);
1101 /* free folder structure */
1105 ** Return msgnum. We are relying on the fact that
1106 ** msgnum will be -1, if folder_addmsg() had an error.
1113 ** Parse and expand the storage formatting string
1114 ** pointed to by "cp" into "buffer".
1118 parse_format_string(CT ct, char *cp, char *buffer, int buflen, char *dir)
1122 CI ci = &ct->c_ctinfo;
1125 ** If storage string is "-", just copy it, and
1126 ** return (send content to standard output).
1128 if (cp[0] == '-' && cp[1] == '\0') {
1129 strncpy(buffer, cp, buflen);
1137 ** If formatting string is a pathname that doesn't
1138 ** begin with '/', then preface the path with the
1139 ** appropriate directory.
1141 if (*cp != '/' && *cp != '|' && *cp != '!') {
1142 snprintf(bp, buflen, "%s/", dir[1] ? dir : "");
1150 /* We are processing a storage escape */
1155 ** Insert parameters from Content-Type.
1156 ** This is only valid for '|' commands.
1158 if (buffer[0] != '|' && buffer[0] != '!') {
1167 for (ap=ci->ci_attrs, ep=ci->ci_values;
1169 snprintf(bp, buflen,
1181 /* insert message number */
1182 snprintf(bp, buflen, "%s",
1183 mhbasename(ct->c_file));
1187 /* insert part number with leading dot */
1189 snprintf(bp, buflen, ".%s",
1194 /* insert part number withouth leading dot */
1196 strncpy(bp, ct->c_partno, buflen);
1200 /* insert content type */
1201 strncpy(bp, ci->ci_type, buflen);
1205 /* insert content subtype */
1206 strncpy(bp, ci->ci_subtype, buflen);
1210 /* insert the character % */
1220 /* Advance bp and decrement buflen */
1238 ** Copy some of the header fields of the initial message/partial
1239 ** message into the header of the reassembled message.
1243 copy_some_headers(FILE *out, CT ct)
1247 hp = ct->c_first_hf; /* start at first header field */
1251 ** A few of the header fields of the enclosing
1252 ** messages are not copied.
1254 if (!uprf(hp->name, XXX_FIELD_PRF) &&
1255 mh_strcasecmp(hp->name, VRSN_FIELD) &&
1256 mh_strcasecmp(hp->name, "Subject") &&
1257 mh_strcasecmp(hp->name, "Message-ID"))
1258 fprintf(out, "%s:%s", hp->name, hp->value);
1259 hp = hp->next; /* next header field */