]>
diplodocus.org Git - nmh/blob - uip/mhstoresbr.c
3 * mhstoresbr.c -- routines to save/store the contents of MIME messages
5 * This code is Copyright (c) 2002, by the authors of nmh. See the
6 * COPYRIGHT file in the root directory of the nmh distribution for
7 * complete copyright information.
12 #include <h/signals.h>
20 #include <h/mhparse.h>
25 * The list of top-level contents to display
32 * Cache of current directory. This must be
33 * set before these routines are called.
38 * The directory in which to store the contents.
43 * Type for a compare function for qsort. This keeps
46 typedef int (*qsort_comp
) (const void *, const void *);
50 int part_ok (CT
, int);
51 int type_ok (CT
, int);
52 int make_intermediates (char *);
53 void flush_errors (void);
56 int show_content_aux (CT
, int, int, char *, char *);
61 void store_all_messages (CT
*);
66 static void store_single_message (CT
);
67 static int store_switch (CT
);
68 static int store_generic (CT
);
69 static int store_application (CT
);
70 static int store_multi (CT
);
71 static int store_partial (CT
);
72 static int store_external (CT
);
73 static int ct_compar (CT
*, CT
*);
74 static int store_content (CT
, CT
);
75 static int output_content_file (CT
, int);
76 static int output_content_folder (char *, char *);
77 static int parse_format_string (CT
, char *, char *, int, char *);
78 static void get_storeproc (CT
);
79 static int copy_some_headers (FILE *, CT
);
83 * Main entry point to store content
84 * from a collection of messages.
88 store_all_messages (CT
*cts
)
94 * Check for the directory in which to
99 else if ((cp
= context_find (nmhstorage
)) && *cp
)
104 for (ctp
= cts
; *ctp
; ctp
++) {
106 store_single_message (ct
);
114 * Entry point to store the content
115 * in a (single) message
119 store_single_message (CT ct
)
121 if (type_ok (ct
, 1)) {
128 if (ct
->c_ceclosefnx
)
129 (*ct
->c_ceclosefnx
) (ct
);
135 * Switching routine to store different content types
141 switch (ct
->c_type
) {
143 return store_multi (ct
);
147 switch (ct
->c_subtype
) {
148 case MESSAGE_PARTIAL
:
149 return store_partial (ct
);
152 case MESSAGE_EXTERNAL
:
153 return store_external (ct
);
157 return store_generic (ct
);
163 return store_application (ct
);
170 return store_generic (ct
);
174 adios (NULL
, "unknown content type %d", ct
->c_type
);
178 return OK
; /* NOT REACHED */
183 * Generic routine to store a MIME content.
184 * (audio, video, image, text, message/rfc922)
188 store_generic (CT ct
)
191 * Check if the content specifies a filename.
192 * Don't bother with this for type "message"
193 * (only "message/rfc822" will use store_generic).
195 if (autosw
&& ct
->c_type
!= CT_MESSAGE
)
198 return store_content (ct
, NULL
);
203 * Store content of type "application"
207 store_application (CT ct
)
210 CI ci
= &ct
->c_ctinfo
;
212 /* Check if the content specifies a filename */
217 * If storeproc is not defined, and the content is type
218 * "application/octet-stream", we also check for various
219 * attribute/value pairs which specify if this a tar file.
221 if (!ct
->c_storeproc
&& ct
->c_subtype
== APPLICATION_OCTETS
) {
222 int tarP
= 0, zP
= 0, gzP
= 0;
224 for (ap
= ci
->ci_attrs
, ep
= ci
->ci_values
; *ap
; ap
++, ep
++) {
225 /* check for "type=tar" attribute */
226 if (!mh_strcasecmp (*ap
, "type")) {
227 if (mh_strcasecmp (*ep
, "tar"))
234 /* check for "conversions=compress" attribute */
235 if ((!mh_strcasecmp (*ap
, "conversions") || !mh_strcasecmp (*ap
, "x-conversions"))
236 && (!mh_strcasecmp (*ep
, "compress") || !mh_strcasecmp (*ep
, "x-compress"))) {
240 /* check for "conversions=gzip" attribute */
241 if ((!mh_strcasecmp (*ap
, "conversions") || !mh_strcasecmp (*ap
, "x-conversions"))
242 && (!mh_strcasecmp (*ep
, "gzip") || !mh_strcasecmp (*ep
, "x-gzip"))) {
249 ct
->c_showproc
= add (zP
? "%euncompress | tar tvf -"
250 : (gzP
? "%egzip -dc | tar tvf -"
251 : "%etar tvf -"), NULL
);
252 if (!ct
->c_storeproc
) {
254 ct
->c_storeproc
= add (zP
? "| uncompress | tar xvpf -"
255 : (gzP
? "| gzip -dc | tar xvpf -"
256 : "| tar xvpf -"), NULL
);
259 ct
->c_storeproc
= add (zP
? "%m%P.tar.Z"
260 : (gzP
? "%m%P.tar.gz"
261 : "%m%P.tar"), NULL
);
267 return store_content (ct
, NULL
);
272 * Store the content of a multipart message
279 struct multipart
*m
= (struct multipart
*) ct
->c_ctparams
;
283 for (part
= m
->mp_parts
; part
; part
= part
->mp_next
) {
284 CT p
= part
->mp_part
;
286 if (part_ok (p
, 1) && type_ok (p
, 1)) {
287 result
= store_switch (p
);
288 if (result
== OK
&& ct
->c_subtype
== MULTI_ALTERNATE
)
298 * Reassemble and store the contents of a collection
299 * of messages of type "message/partial".
303 store_partial (CT ct
)
308 struct partial
*pm
, *qm
;
310 qm
= (struct partial
*) ct
->c_ctparams
;
315 for (ctp
= cts
; *ctp
; ctp
++) {
317 if (p
->c_type
== CT_MESSAGE
&& p
->c_subtype
== ct
->c_subtype
) {
318 pm
= (struct partial
*) p
->c_ctparams
;
320 && strcmp (qm
->pm_partid
, pm
->pm_partid
) == 0) {
321 pm
->pm_marked
= pm
->pm_partno
;
333 advise (NULL
, "missing (at least) last part of multipart message");
337 if ((base
= (CT
*) calloc ((size_t) (i
+ 1), sizeof(*base
))) == NULL
)
338 adios (NULL
, "out of memory");
341 for (ctp
= cts
; *ctp
; ctp
++) {
343 if (p
->c_type
== CT_MESSAGE
&& p
->c_subtype
== ct
->c_subtype
) {
344 pm
= (struct partial
*) p
->c_ctparams
;
352 qsort ((char *) base
, i
, sizeof(*base
), (qsort_comp
) ct_compar
);
355 for (ctq
= base
; *ctq
; ctq
++) {
357 pm
= (struct partial
*) p
->c_ctparams
;
358 if (pm
->pm_marked
!= cur
) {
359 if (pm
->pm_marked
== cur
- 1) {
361 "duplicate part %d of %d part multipart message",
368 "missing %spart %d of %d part multipart message",
369 cur
!= hi
? "(at least) " : "", cur
, hi
);
381 * Now cycle through the sorted list of messages of type
382 * "message/partial" and save/append them to a file.
387 if (store_content (ct
, NULL
) == NOTOK
) {
389 free ((char *) base
);
393 for (; *ctq
; ctq
++) {
395 if (store_content (p
, ct
) == NOTOK
)
399 free ((char *) base
);
405 * Store content from a message of type "message/external".
409 store_external (CT ct
)
412 struct exbody
*e
= (struct exbody
*) ct
->c_ctparams
;
413 CT p
= e
->eb_content
;
419 * Check if the parameters for the external body
420 * specified a filename.
425 if ((cp
= e
->eb_name
)
430 && !strchr (cp
, '%')) {
431 if (!ct
->c_storeproc
)
432 ct
->c_storeproc
= add (cp
, NULL
);
434 p
->c_storeproc
= add (cp
, NULL
);
439 * Since we will let the Content structure for the
440 * external body substitute for the current content,
441 * we temporarily change its partno (number inside
442 * multipart), so everything looks right.
444 p
->c_partno
= ct
->c_partno
;
446 /* we probably need to check if content is really there */
447 result
= store_switch (p
);
455 * Compare the numbering from two different
456 * message/partials (needed for sorting).
460 ct_compar (CT
*a
, CT
*b
)
462 struct partial
*am
= (struct partial
*) ((*a
)->c_ctparams
);
463 struct partial
*bm
= (struct partial
*) ((*b
)->c_ctparams
);
465 return (am
->pm_marked
- bm
->pm_marked
);
470 * Store contents of a message or message part to
471 * a folder, a file, the standard output, or pass
472 * the contents to a command.
474 * If the current content to be saved is a followup part
475 * to a collection of messages of type "message/partial",
476 * then field "p" is a pointer to the Content structure
477 * to the first message/partial in the group.
481 store_content (CT ct
, CT p
)
483 int appending
= 0, msgnum
= 0;
484 int is_partial
= 0, first_partial
= 0;
485 int last_partial
= 0;
486 char *cp
, buffer
[BUFSIZ
];
489 * Do special processing for messages of
490 * type "message/partial".
492 * We first check if this content is of type
493 * "message/partial". If it is, then we need to check
494 * whether it is the first and/or last in the group.
496 * Then if "p" is a valid pointer, it points to the Content
497 * structure of the first partial in the group. So we copy
498 * the file name and/or folder name from that message. In
499 * this case, we also note that we will be appending.
501 if (ct
->c_type
== CT_MESSAGE
&& ct
->c_subtype
== MESSAGE_PARTIAL
) {
502 struct partial
*pm
= (struct partial
*) ct
->c_ctparams
;
504 /* Yep, it's a message/partial */
507 /* But is it the first and/or last in the collection? */
508 if (pm
->pm_partno
== 1)
510 if (pm
->pm_maxno
&& pm
->pm_partno
== pm
->pm_maxno
)
514 * If "p" is a valid pointer, then it points to the
515 * Content structure for the first message in the group.
516 * So we just copy the filename or foldername information
517 * from the previous iteration of this function.
521 ct
->c_storage
= add (p
->c_storage
, NULL
);
523 /* record the folder name */
525 ct
->c_folder
= add (p
->c_folder
, NULL
);
532 * Get storage formatting string.
534 * 1) If we have storeproc defined, then use that
535 * 2) Else check for a mhn-store-<type>/<subtype> entry
536 * 3) Else check for a mhn-store-<type> entry
537 * 4) Else if content is "message", use "+" (current folder)
538 * 5) Else use string "%m%P.%s".
540 if ((cp
= ct
->c_storeproc
) == NULL
|| *cp
== '\0') {
541 CI ci
= &ct
->c_ctinfo
;
543 snprintf (buffer
, sizeof(buffer
), "%s-store-%s/%s",
544 invo_name
, ci
->ci_type
, ci
->ci_subtype
);
545 if ((cp
= context_find (buffer
)) == NULL
|| *cp
== '\0') {
546 snprintf (buffer
, sizeof(buffer
), "%s-store-%s", invo_name
, ci
->ci_type
);
547 if ((cp
= context_find (buffer
)) == NULL
|| *cp
== '\0') {
548 cp
= ct
->c_type
== CT_MESSAGE
? "+" : "%m%P.%s";
554 * Check the beginning of storage formatting string
555 * to see if we are saving content to a folder.
557 if (*cp
== '+' || *cp
== '@') {
558 char *tmpfilenam
, *folder
;
560 /* Store content in temporary file for now */
561 tmpfilenam
= m_mktemp(invo_name
, NULL
, NULL
);
562 ct
->c_storage
= add (tmpfilenam
, NULL
);
564 /* Get the folder name */
566 folder
= pluspath (cp
);
568 folder
= getfolder (1);
570 /* Check if folder exists */
571 create_folder(m_mailpath(folder
), 0, exit
);
573 /* Record the folder name */
574 ct
->c_folder
= add (folder
, NULL
);
583 * Parse and expand the storage formatting string
584 * in `cp' into `buffer'.
586 parse_format_string (ct
, cp
, buffer
, sizeof(buffer
), dir
);
589 * If formatting begins with '|' or '!', then pass
590 * content to standard input of a command and return.
592 if (buffer
[0] == '|' || buffer
[0] == '!')
593 return show_content_aux (ct
, 1, 0, buffer
+ 1, dir
);
595 /* record the filename */
596 ct
->c_storage
= add (buffer
, NULL
);
599 /* flush the output stream */
602 /* Now save or append the content to a file */
603 if (output_content_file (ct
, appending
) == NOTOK
)
607 * If necessary, link the file into a folder and remove
608 * the temporary file. If this message is a partial,
609 * then only do this if it is the last one in the group.
611 if (ct
->c_folder
&& (!is_partial
|| last_partial
)) {
612 msgnum
= output_content_folder (ct
->c_folder
, ct
->c_storage
);
613 unlink (ct
->c_storage
);
619 * Now print out the name/number of the message
620 * that we are storing.
624 fprintf (stderr
, "reassembling partials ");
626 fprintf (stderr
, "%s", ct
->c_file
);
628 fprintf (stderr
, "%s,", ct
->c_file
);
630 fprintf (stderr
, "storing message %s", ct
->c_file
);
632 fprintf (stderr
, " part %s", ct
->c_partno
);
636 * Unless we are in the "middle" of group of message/partials,
637 * we now print the name of the file, folder, and/or message
638 * to which we are storing the content.
640 if (!is_partial
|| last_partial
) {
642 fprintf (stderr
, " to folder %s as message %d\n", ct
->c_folder
, msgnum
);
643 } else if (!strcmp(ct
->c_storage
, "-")) {
644 fprintf (stderr
, " to stdout\n");
648 cwdlen
= strlen (cwd
);
649 fprintf (stderr
, " as file %s\n",
650 strncmp (ct
->c_storage
, cwd
, cwdlen
)
651 || ct
->c_storage
[cwdlen
] != '/'
652 ? ct
->c_storage
: ct
->c_storage
+ cwdlen
+ 1);
661 * Output content to a file
665 output_content_file (CT ct
, int appending
)
668 char *file
, buffer
[BUFSIZ
];
673 * If the pathname is absolute, make sure
674 * all the relevant directories exist.
676 if (strchr(ct
->c_storage
, '/')
677 && make_intermediates (ct
->c_storage
) == NOTOK
)
680 if (ct
->c_encoding
!= CE_7BIT
) {
683 if (!ct
->c_ceopenfnx
) {
684 advise (NULL
, "don't know how to decode part %s of message %s",
685 ct
->c_partno
, ct
->c_file
);
689 file
= appending
|| !strcmp (ct
->c_storage
, "-") ? NULL
691 if ((fd
= (*ct
->c_ceopenfnx
) (ct
, &file
)) == NOTOK
)
693 if (!strcmp (file
, ct
->c_storage
)) {
694 (*ct
->c_ceclosefnx
) (ct
);
699 * Send to standard output
701 if (!strcmp (ct
->c_storage
, "-")) {
704 if ((gd
= dup (fileno (stdout
))) == NOTOK
) {
705 advise ("stdout", "unable to dup");
707 (*ct
->c_ceclosefnx
) (ct
);
710 if ((fp
= fdopen (gd
, appending
? "a" : "w")) == NULL
) {
711 advise ("stdout", "unable to fdopen (%d, \"%s\") from", gd
,
712 appending
? "a" : "w");
720 if ((fp
= fopen (ct
->c_storage
, appending
? "a" : "w")) == NULL
) {
721 advise (ct
->c_storage
, "unable to fopen for %s",
722 appending
? "appending" : "writing");
728 * Filter the header fields of the initial enclosing
729 * message/partial into the file.
731 if (ct
->c_type
== CT_MESSAGE
&& ct
->c_subtype
== MESSAGE_PARTIAL
) {
732 struct partial
*pm
= (struct partial
*) ct
->c_ctparams
;
734 if (pm
->pm_partno
== 1)
735 copy_some_headers (fp
, ct
);
739 switch (cc
= read (fd
, buffer
, sizeof(buffer
))) {
741 advise (file
, "error reading content from");
748 fwrite (buffer
, sizeof(*buffer
), cc
, fp
);
754 (*ct
->c_ceclosefnx
) (ct
);
756 if (cc
!= NOTOK
&& fflush (fp
))
757 advise (ct
->c_storage
, "error writing to");
761 return (cc
!= NOTOK
? OK
: NOTOK
);
764 if (!ct
->c_fp
&& (ct
->c_fp
= fopen (ct
->c_file
, "r")) == NULL
) {
765 advise (ct
->c_file
, "unable to open for reading");
771 fseek (ct
->c_fp
, pos
, SEEK_SET
);
773 if (!strcmp (ct
->c_storage
, "-")) {
776 if ((gd
= dup (fileno (stdout
))) == NOTOK
) {
777 advise ("stdout", "unable to dup");
780 if ((fp
= fdopen (gd
, appending
? "a" : "w")) == NULL
) {
781 advise ("stdout", "unable to fdopen (%d, \"%s\") from", gd
,
782 appending
? "a" : "w");
787 if ((fp
= fopen (ct
->c_storage
, appending
? "a" : "w")) == NULL
) {
788 advise (ct
->c_storage
, "unable to fopen for %s",
789 appending
? "appending" : "writing");
795 * Copy a few of the header fields of the initial
796 * enclosing message/partial into the file.
799 if (ct
->c_type
== CT_MESSAGE
&& ct
->c_subtype
== MESSAGE_PARTIAL
) {
800 struct partial
*pm
= (struct partial
*) ct
->c_ctparams
;
802 if (pm
->pm_partno
== 1) {
803 copy_some_headers (fp
, ct
);
808 while (fgets (buffer
, sizeof(buffer
) - 1, ct
->c_fp
)) {
809 if ((pos
+= strlen (buffer
)) > last
) {
812 diff
= strlen (buffer
) - (pos
- last
);
817 * If this is the first content of a group of
818 * message/partial contents, then we only copy a few
819 * of the header fields of the enclosed message.
834 if (!uprf (buffer
, XXX_FIELD_PRF
)
835 && !uprf (buffer
, VRSN_FIELD
)
836 && !uprf (buffer
, "Subject:")
837 && !uprf (buffer
, "Encrypted:")
838 && !uprf (buffer
, "Message-ID:")) {
853 advise (ct
->c_storage
, "error writing to");
863 * Add a file to a folder.
865 * Return the new message number of the file
866 * when added to the folder. Return -1, if
871 output_content_folder (char *folder
, char *filename
)
876 /* Read the folder. */
877 if ((mp
= folder_read (folder
))) {
878 /* Link file into folder */
879 msgnum
= folder_addmsg (&mp
, filename
, 0, 0, 0, 0, (char *)0);
881 advise (NULL
, "unable to read folder %s", folder
);
885 /* free folder structure */
889 * Return msgnum. We are relying on the fact that
890 * msgnum will be -1, if folder_addmsg() had an error.
897 * Parse and expand the storage formatting string
898 * pointed to by "cp" into "buffer".
902 parse_format_string (CT ct
, char *cp
, char *buffer
, int buflen
, char *dir
)
906 CI ci
= &ct
->c_ctinfo
;
909 * If storage string is "-", just copy it, and
910 * return (send content to standard output).
912 if (cp
[0] == '-' && cp
[1] == '\0') {
913 strncpy (buffer
, cp
, buflen
);
921 * If formatting string is a pathname that doesn't
922 * begin with '/', then preface the path with the
923 * appropriate directory.
925 if (*cp
!= '/' && *cp
!= '|' && *cp
!= '!') {
926 snprintf (bp
, buflen
, "%s/", dir
[1] ? dir
: "");
934 /* We are processing a storage escape */
939 * Insert parameters from Content-Type.
940 * This is only valid for '|' commands.
942 if (buffer
[0] != '|' && buffer
[0] != '!') {
951 for (ap
= ci
->ci_attrs
, ep
= ci
->ci_values
;
953 snprintf (bp
, buflen
, "%s%s=\"%s\"", s
, *ap
, *ep
);
963 /* insert message number */
964 snprintf (bp
, buflen
, "%s", r1bindex (ct
->c_file
, '/'));
968 /* insert part number with leading dot */
970 snprintf (bp
, buflen
, ".%s", ct
->c_partno
);
974 /* insert part number withouth leading dot */
976 strncpy (bp
, ct
->c_partno
, buflen
);
980 /* insert content type */
981 strncpy (bp
, ci
->ci_type
, buflen
);
985 /* insert content subtype */
986 strncpy (bp
, ci
->ci_subtype
, buflen
);
990 /* insert the character % */
1000 /* Advance bp and decrement buflen */
1018 * Check if the content specifies a filename
1019 * in its MIME parameters.
1023 get_storeproc (CT ct
)
1025 char **ap
, **ep
, *cp
;
1026 CI ci
= &ct
->c_ctinfo
;
1029 * If the storeproc has already been defined,
1030 * we just return (for instance, if this content
1031 * is part of a "message/external".
1033 if (ct
->c_storeproc
)
1037 * Check the attribute/value pairs, for the attribute "name".
1038 * If found, do a few sanity checks and copy the value into
1041 for (ap
= ci
->ci_attrs
, ep
= ci
->ci_values
; *ap
; ap
++, ep
++) {
1042 if (!mh_strcasecmp (*ap
, "name")
1043 && *(cp
= *ep
) != '/'
1047 && !strchr (cp
, '%')) {
1048 ct
->c_storeproc
= add (cp
, NULL
);
1056 * Copy some of the header fields of the initial message/partial
1057 * message into the header of the reassembled message.
1061 copy_some_headers (FILE *out
, CT ct
)
1065 hp
= ct
->c_first_hf
; /* start at first header field */
1069 * A few of the header fields of the enclosing
1070 * messages are not copied.
1072 if (!uprf (hp
->name
, XXX_FIELD_PRF
)
1073 && mh_strcasecmp (hp
->name
, VRSN_FIELD
)
1074 && mh_strcasecmp (hp
->name
, "Subject")
1075 && mh_strcasecmp (hp
->name
, "Encrypted")
1076 && mh_strcasecmp (hp
->name
, "Message-ID"))
1077 fprintf (out
, "%s:%s", hp
->name
, hp
->value
);
1078 hp
= hp
->next
; /* next header field */