2 * Another stupid program, this one parsing the headers of an
3 * email to figure out authorship and subject
10 static FILE *cmitmsg
, *patchfile
, *fin
, *fout
;
12 static int keep_subject
;
13 static const char *metainfo_charset
;
14 static struct strbuf line
= STRBUF_INIT
;
15 static struct strbuf name
= STRBUF_INIT
;
16 static struct strbuf email
= STRBUF_INIT
;
19 TE_DONTCARE
, TE_QP
, TE_BASE64
,
22 TYPE_TEXT
, TYPE_OTHER
,
25 static struct strbuf charset
= STRBUF_INIT
;
26 static int patch_lines
;
27 static struct strbuf
**p_hdr_data
, **s_hdr_data
;
29 #define MAX_HDR_PARSED 10
30 #define MAX_BOUNDARIES 5
32 static void cleanup_space(struct strbuf
*sb
);
35 static void get_sane_name(struct strbuf
*out
, struct strbuf
*name
, struct strbuf
*email
)
37 struct strbuf
*src
= name
;
38 if (name
->len
< 3 || 60 < name
->len
|| strchr(name
->buf
, '@') ||
39 strchr(name
->buf
, '<') || strchr(name
->buf
, '>'))
44 strbuf_addbuf(out
, src
);
47 static void parse_bogus_from(const struct strbuf
*line
)
49 /* John Doe <johndoe> */
52 /* This is fallback, so do not bother if we already have an
58 bra
= strchr(line
->buf
, '<');
61 ket
= strchr(bra
, '>');
66 strbuf_add(&email
, bra
+ 1, ket
- bra
- 1);
69 strbuf_add(&name
, line
->buf
, bra
- line
->buf
);
71 get_sane_name(&name
, &name
, &email
);
74 static void handle_from(const struct strbuf
*from
)
80 strbuf_init(&f
, from
->len
);
81 strbuf_addbuf(&f
, from
);
83 at
= strchr(f
.buf
, '@');
85 parse_bogus_from(from
);
90 * If we already have one email, don't take any confusing lines
92 if (email
.len
&& strchr(at
+ 1, '@')) {
97 /* Pick up the string around '@', possibly delimited with <>
98 * pair; that is the email part.
110 el
= strcspn(at
, " \n\t\r\v\f>");
111 strbuf_reset(&email
);
112 strbuf_add(&email
, at
, el
);
113 strbuf_remove(&f
, at
- f
.buf
, el
+ (at
[el
] ? 1 : 0));
115 /* The remainder is name. It could be
117 * - "John Doe <john.doe@xz>" (a), or
118 * - "john.doe@xz (John Doe)" (b), or
119 * - "John (zzz) Doe <john.doe@xz> (Comment)" (c)
121 * but we have removed the email part, so
123 * - remove extra spaces which could stay after email (case 'c'), and
124 * - trim from both ends, possibly removing the () pair at the end
125 * (cases 'a' and 'b').
129 if (f
.buf
[0] == '(' && f
.len
&& f
.buf
[f
.len
- 1] == ')') {
130 strbuf_remove(&f
, 0, 1);
131 strbuf_setlen(&f
, f
.len
- 1);
134 get_sane_name(&name
, &f
, &email
);
138 static void handle_header(struct strbuf
**out
, const struct strbuf
*line
)
141 *out
= xmalloc(sizeof(struct strbuf
));
142 strbuf_init(*out
, line
->len
);
146 strbuf_addbuf(*out
, line
);
149 /* NOTE NOTE NOTE. We do not claim we do full MIME. We just attempt
150 * to have enough heuristics to grok MIME encoded patches often found
151 * on our mailing lists. For example, we do not even treat header lines
152 * case insensitively.
155 static int slurp_attr(const char *line
, const char *name
, struct strbuf
*attr
)
157 const char *ends
, *ap
= strcasestr(line
, name
);
161 strbuf_setlen(attr
, 0);
171 sz
= strcspn(ap
, ends
);
172 strbuf_add(attr
, ap
, sz
);
176 static struct strbuf
*content
[MAX_BOUNDARIES
];
178 static struct strbuf
**content_top
= content
;
180 static void handle_content_type(struct strbuf
*line
)
182 struct strbuf
*boundary
= xmalloc(sizeof(struct strbuf
));
183 strbuf_init(boundary
, line
->len
);
185 if (!strcasestr(line
->buf
, "text/"))
186 message_type
= TYPE_OTHER
;
187 if (slurp_attr(line
->buf
, "boundary=", boundary
)) {
188 strbuf_insert(boundary
, 0, "--", 2);
189 if (++content_top
> &content
[MAX_BOUNDARIES
]) {
190 fprintf(stderr
, "Too many boundaries to handle\n");
193 *content_top
= boundary
;
196 slurp_attr(line
->buf
, "charset=", &charset
);
199 strbuf_release(boundary
);
204 static void handle_content_transfer_encoding(const struct strbuf
*line
)
206 if (strcasestr(line
->buf
, "base64"))
207 transfer_encoding
= TE_BASE64
;
208 else if (strcasestr(line
->buf
, "quoted-printable"))
209 transfer_encoding
= TE_QP
;
211 transfer_encoding
= TE_DONTCARE
;
214 static int is_multipart_boundary(const struct strbuf
*line
)
216 return (((*content_top
)->len
<= line
->len
) &&
217 !memcmp(line
->buf
, (*content_top
)->buf
, (*content_top
)->len
));
220 static void cleanup_subject(struct strbuf
*subject
)
224 while (subject
->len
) {
225 switch (*subject
->buf
) {
227 if (subject
->len
<= 3)
229 if (!memcmp(subject
->buf
+ 1, "e:", 2)) {
230 strbuf_remove(subject
, 0, 3);
234 case ' ': case '\t': case ':':
235 strbuf_remove(subject
, 0, 1);
238 if ((pos
= strchr(subject
->buf
, ']'))) {
239 remove
= pos
- subject
->buf
;
240 if (remove
<= (subject
->len
- remove
) * 2) {
241 strbuf_remove(subject
, 0, remove
+ 1);
245 strbuf_remove(subject
, 0, 1);
248 strbuf_trim(subject
);
253 static void cleanup_space(struct strbuf
*sb
)
256 for (pos
= 0; pos
< sb
->len
; pos
++) {
257 if (isspace(sb
->buf
[pos
])) {
259 for (cnt
= 0; isspace(sb
->buf
[pos
+ cnt
+ 1]); cnt
++);
260 strbuf_remove(sb
, pos
+ 1, cnt
);
265 static void decode_header(struct strbuf
*line
);
266 static const char *header
[MAX_HDR_PARSED
] = {
267 "From","Subject","Date",
270 static inline int cmp_header(const struct strbuf
*line
, const char *hdr
)
272 int len
= strlen(hdr
);
273 return !strncasecmp(line
->buf
, hdr
, len
) && line
->len
> len
&&
274 line
->buf
[len
] == ':' && isspace(line
->buf
[len
+ 1]);
277 static int check_header(const struct strbuf
*line
,
278 struct strbuf
*hdr_data
[], int overwrite
)
281 struct strbuf sb
= STRBUF_INIT
;
282 /* search for the interesting parts */
283 for (i
= 0; header
[i
]; i
++) {
284 int len
= strlen(header
[i
]);
285 if ((!hdr_data
[i
] || overwrite
) && cmp_header(line
, header
[i
])) {
286 /* Unwrap inline B and Q encoding, and optionally
287 * normalize the meta information to utf8.
289 strbuf_add(&sb
, line
->buf
+ len
+ 2, line
->len
- len
- 2);
291 handle_header(&hdr_data
[i
], &sb
);
293 goto check_header_out
;
298 if (cmp_header(line
, "Content-Type")) {
299 len
= strlen("Content-Type: ");
300 strbuf_add(&sb
, line
->buf
+ len
, line
->len
- len
);
302 strbuf_insert(&sb
, 0, "Content-Type: ", len
);
303 handle_content_type(&sb
);
305 goto check_header_out
;
307 if (cmp_header(line
, "Content-Transfer-Encoding")) {
308 len
= strlen("Content-Transfer-Encoding: ");
309 strbuf_add(&sb
, line
->buf
+ len
, line
->len
- len
);
311 handle_content_transfer_encoding(&sb
);
313 goto check_header_out
;
316 /* for inbody stuff */
317 if (!prefixcmp(line
->buf
, ">From") && isspace(line
->buf
[5])) {
318 ret
= 1; /* Should this return 0? */
319 goto check_header_out
;
321 if (!prefixcmp(line
->buf
, "[PATCH]") && isspace(line
->buf
[7])) {
322 for (i
= 0; header
[i
]; i
++) {
323 if (!memcmp("Subject", header
[i
], 7)) {
324 handle_header(&hdr_data
[i
], line
);
326 goto check_header_out
;
336 static int is_rfc2822_header(const struct strbuf
*line
)
339 * The section that defines the loosest possible
340 * field name is "3.6.8 Optional fields".
342 * optional-field = field-name ":" unstructured CRLF
343 * field-name = 1*ftext
344 * ftext = %d33-57 / %59-126
347 char *cp
= line
->buf
;
349 /* Count mbox From headers as headers */
350 if (!prefixcmp(cp
, "From ") || !prefixcmp(cp
, ">From "))
353 while ((ch
= *cp
++)) {
356 if ((33 <= ch
&& ch
<= 57) ||
357 (59 <= ch
&& ch
<= 126))
364 static int read_one_header_line(struct strbuf
*line
, FILE *in
)
366 /* Get the first part of the line. */
367 if (strbuf_getline(line
, in
, '\n'))
371 * Is it an empty line or not a valid rfc2822 header?
372 * If so, stop here, and return false ("not a header")
375 if (!line
->len
|| !is_rfc2822_header(line
)) {
376 /* Re-add the newline */
377 strbuf_addch(line
, '\n');
382 * Now we need to eat all the continuation lines..
383 * Yuck, 2822 header "folding"
387 struct strbuf continuation
= STRBUF_INIT
;
389 peek
= fgetc(in
); ungetc(peek
, in
);
390 if (peek
!= ' ' && peek
!= '\t')
392 if (strbuf_getline(&continuation
, in
, '\n'))
394 continuation
.buf
[0] = '\n';
395 strbuf_rtrim(&continuation
);
396 strbuf_addbuf(line
, &continuation
);
402 static struct strbuf
*decode_q_segment(const struct strbuf
*q_seg
, int rfc2047
)
404 const char *in
= q_seg
->buf
;
406 struct strbuf
*out
= xmalloc(sizeof(struct strbuf
));
407 strbuf_init(out
, q_seg
->len
);
409 while ((c
= *in
++) != 0) {
413 break; /* drop trailing newline */
414 strbuf_addch(out
, (hexval(d
) << 4) | hexval(*in
++));
417 if (rfc2047
&& c
== '_') /* rfc2047 4.2 (2) */
419 strbuf_addch(out
, c
);
424 static struct strbuf
*decode_b_segment(const struct strbuf
*b_seg
)
426 /* Decode in..ep, possibly in-place to ot */
427 int c
, pos
= 0, acc
= 0;
428 const char *in
= b_seg
->buf
;
429 struct strbuf
*out
= xmalloc(sizeof(struct strbuf
));
430 strbuf_init(out
, b_seg
->len
);
432 while ((c
= *in
++) != 0) {
437 else if ('A' <= c
&& c
<= 'Z')
439 else if ('a' <= c
&& c
<= 'z')
441 else if ('0' <= c
&& c
<= '9')
444 continue; /* garbage */
450 strbuf_addch(out
, (acc
| (c
>> 4)));
454 strbuf_addch(out
, (acc
| (c
>> 2)));
458 strbuf_addch(out
, (acc
| c
));
467 * When there is no known charset, guess.
469 * Right now we assume that if the target is UTF-8 (the default),
470 * and it already looks like UTF-8 (which includes US-ASCII as its
471 * subset, of course) then that is what it is and there is nothing
474 * Otherwise, we default to assuming it is Latin1 for historical
477 static const char *guess_charset(const struct strbuf
*line
, const char *target_charset
)
479 if (is_encoding_utf8(target_charset
)) {
480 if (is_utf8(line
->buf
))
486 static void convert_to_utf8(struct strbuf
*line
, const char *charset
)
490 if (!charset
|| !*charset
) {
491 charset
= guess_charset(line
, metainfo_charset
);
496 if (!strcasecmp(metainfo_charset
, charset
))
498 out
= reencode_string(line
->buf
, metainfo_charset
, charset
);
500 die("cannot convert from %s to %s",
501 charset
, metainfo_charset
);
502 strbuf_attach(line
, out
, strlen(out
), strlen(out
));
505 static int decode_header_bq(struct strbuf
*it
)
508 struct strbuf outbuf
= STRBUF_INIT
, *dec
;
509 struct strbuf charset_q
= STRBUF_INIT
, piecebuf
= STRBUF_INIT
;
513 while (in
- it
->buf
<= it
->len
&& (ep
= strstr(in
, "=?")) != NULL
) {
515 strbuf_reset(&charset_q
);
516 strbuf_reset(&piecebuf
);
521 * We are about to process an encoded-word
522 * that begins at ep, but there is something
523 * before the encoded word.
526 for (scan
= in
; scan
< ep
; scan
++)
530 if (scan
!= ep
|| in
== it
->buf
) {
532 * We should not lose that "something",
533 * unless we have just processed an
534 * encoded-word, and there is only LWS
535 * before the one we are about to process.
537 strbuf_add(&outbuf
, in
, ep
- in
);
541 * ep : "=?iso-2022-jp?B?GyR...?= foo"
542 * ep : "=?ISO-8859-1?Q?Foo=FCbar?= baz"
546 if (ep
- it
->buf
>= it
->len
|| !(cp
= strchr(ep
, '?')))
547 goto decode_header_bq_out
;
549 if (cp
+ 3 - it
->buf
> it
->len
)
550 goto decode_header_bq_out
;
551 strbuf_add(&charset_q
, ep
, cp
- ep
);
554 if (!encoding
|| cp
[2] != '?')
555 goto decode_header_bq_out
;
556 ep
= strstr(cp
+ 3, "?=");
558 goto decode_header_bq_out
;
559 strbuf_add(&piecebuf
, cp
+ 3, ep
- cp
- 3);
560 switch (tolower(encoding
)) {
562 goto decode_header_bq_out
;
564 dec
= decode_b_segment(&piecebuf
);
567 dec
= decode_q_segment(&piecebuf
, 1);
570 if (metainfo_charset
)
571 convert_to_utf8(dec
, charset_q
.buf
);
573 strbuf_addbuf(&outbuf
, dec
);
578 strbuf_addstr(&outbuf
, in
);
580 strbuf_addbuf(it
, &outbuf
);
581 decode_header_bq_out
:
582 strbuf_release(&outbuf
);
583 strbuf_release(&charset_q
);
584 strbuf_release(&piecebuf
);
588 static void decode_header(struct strbuf
*it
)
590 if (decode_header_bq(it
))
592 /* otherwise "it" is a straight copy of the input.
593 * This can be binary guck but there is no charset specified.
595 if (metainfo_charset
)
596 convert_to_utf8(it
, "");
599 static void decode_transfer_encoding(struct strbuf
*line
)
603 switch (transfer_encoding
) {
605 ret
= decode_q_segment(line
, 0);
608 ret
= decode_b_segment(line
);
615 strbuf_addbuf(line
, ret
);
620 static void handle_filter(struct strbuf
*line
);
622 static int find_boundary(void)
624 while (!strbuf_getline(&line
, fin
, '\n')) {
625 if (*content_top
&& is_multipart_boundary(&line
))
631 static int handle_boundary(void)
633 struct strbuf newline
= STRBUF_INIT
;
635 strbuf_addch(&newline
, '\n');
637 if (line
.len
>= (*content_top
)->len
+ 2 &&
638 !memcmp(line
.buf
+ (*content_top
)->len
, "--", 2)) {
639 /* we hit an end boundary */
640 /* pop the current boundary off the stack */
641 strbuf_release(*content_top
);
645 /* technically won't happen as is_multipart_boundary()
646 will fail first. But just in case..
648 if (--content_top
< content
) {
649 fprintf(stderr
, "Detected mismatched boundaries, "
653 handle_filter(&newline
);
654 strbuf_release(&newline
);
656 /* skip to the next boundary */
657 if (!find_boundary())
662 /* set some defaults */
663 transfer_encoding
= TE_DONTCARE
;
664 strbuf_reset(&charset
);
665 message_type
= TYPE_TEXT
;
667 /* slurp in this section's info */
668 while (read_one_header_line(&line
, fin
))
669 check_header(&line
, p_hdr_data
, 0);
671 strbuf_release(&newline
);
673 if (strbuf_getline(&line
, fin
, '\n'))
675 strbuf_addch(&line
, '\n');
679 static inline int patchbreak(const struct strbuf
*line
)
683 /* Beginning of a "diff -" header? */
684 if (!prefixcmp(line
->buf
, "diff -"))
687 /* CVS "Index: " line? */
688 if (!prefixcmp(line
->buf
, "Index: "))
692 * "--- <filename>" starts patches without headers
693 * "---<sp>*" is a manual separator
698 if (!prefixcmp(line
->buf
, "---")) {
699 /* space followed by a filename? */
700 if (line
->buf
[3] == ' ' && !isspace(line
->buf
[4]))
702 /* Just whitespace? */
703 for (i
= 3; i
< line
->len
; i
++) {
704 unsigned char c
= line
->buf
[i
];
715 static int is_scissors_line(const struct strbuf
*line
)
717 size_t i
, len
= line
->len
;
718 int scissors
= 0, gap
= 0;
719 int first_nonblank
= -1;
720 int last_nonblank
= 0, visible
, perforation
= 0, in_perforation
= 0;
721 const char *buf
= line
->buf
;
723 for (i
= 0; i
< len
; i
++) {
724 if (isspace(buf
[i
])) {
725 if (in_perforation
) {
732 if (first_nonblank
< 0)
740 (!memcmp(buf
+ i
, ">8", 2) || !memcmp(buf
+ i
, "8<", 2))) {
751 * The mark must be at least 8 bytes long (e.g. "-- >8 --").
752 * Even though there can be arbitrary cruft on the same line
753 * (e.g. "cut here"), in order to avoid misidentification, the
754 * perforation must occupy more than a third of the visible
755 * width of the line, and dashes and scissors must occupy more
756 * than half of the perforation.
759 visible
= last_nonblank
- first_nonblank
+ 1;
760 return (scissors
&& 8 <= visible
&&
761 visible
< perforation
* 3 &&
762 gap
* 2 < perforation
);
765 static int handle_commit_msg(struct strbuf
*line
)
767 static int still_looking
= 1;
776 still_looking
= check_header(line
, s_hdr_data
, 0);
781 /* normalize the log message to UTF-8. */
782 if (metainfo_charset
)
783 convert_to_utf8(line
, charset
.buf
);
785 if (is_scissors_line(line
)) {
788 ftruncate(fileno(cmitmsg
), 0);
792 * We may have already read "secondary headers"; purge
793 * them to give ourselves a clean restart.
795 for (i
= 0; header
[i
]; i
++) {
797 strbuf_release(s_hdr_data
[i
]);
798 s_hdr_data
[i
] = NULL
;
803 if (patchbreak(line
)) {
809 fputs(line
->buf
, cmitmsg
);
813 static void handle_patch(const struct strbuf
*line
)
815 fwrite(line
->buf
, 1, line
->len
, patchfile
);
819 static void handle_filter(struct strbuf
*line
)
821 static int filter
= 0;
823 /* filter tells us which part we left off on */
826 if (!handle_commit_msg(line
))
835 static void handle_body(void)
837 struct strbuf prev
= STRBUF_INIT
;
839 /* Skip up to the first boundary */
841 if (!find_boundary())
842 goto handle_body_out
;
846 /* process any boundary lines */
847 if (*content_top
&& is_multipart_boundary(&line
)) {
848 /* flush any leftover */
850 handle_filter(&prev
);
853 if (!handle_boundary())
854 goto handle_body_out
;
857 /* Unwrap transfer encoding */
858 decode_transfer_encoding(&line
);
860 switch (transfer_encoding
) {
864 struct strbuf
**lines
, **it
, *sb
;
866 /* Prepend any previous partial lines */
867 strbuf_insert(&line
, 0, prev
.buf
, prev
.len
);
870 /* binary data most likely doesn't have newlines */
871 if (message_type
!= TYPE_TEXT
) {
872 handle_filter(&line
);
876 * This is a decoded line that may contain
877 * multiple new lines. Pass only one chunk
878 * at a time to handle_filter()
880 lines
= strbuf_split(&line
, '\n');
881 for (it
= lines
; (sb
= *it
); it
++) {
882 if (*(it
+ 1) == NULL
) /* The last line */
883 if (sb
->buf
[sb
->len
- 1] != '\n') {
884 /* Partial line, save it for later. */
885 strbuf_addbuf(&prev
, sb
);
891 * The partial chunk is saved in "prev" and will be
892 * appended by the next iteration of read_line_with_nul().
894 strbuf_list_free(lines
);
898 handle_filter(&line
);
901 } while (!strbuf_getwholeline(&line
, fin
, '\n'));
904 strbuf_release(&prev
);
907 static void output_header_lines(FILE *fout
, const char *hdr
, const struct strbuf
*data
)
909 const char *sp
= data
->buf
;
911 char *ep
= strchr(sp
, '\n');
917 fprintf(fout
, "%s: %.*s\n", hdr
, len
, sp
);
924 static void handle_info(void)
929 for (i
= 0; header
[i
]; i
++) {
930 /* only print inbody headers if we output a patch file */
931 if (patch_lines
&& s_hdr_data
[i
])
933 else if (p_hdr_data
[i
])
938 if (!memcmp(header
[i
], "Subject", 7)) {
940 cleanup_subject(hdr
);
943 output_header_lines(fout
, "Subject", hdr
);
944 } else if (!memcmp(header
[i
], "From", 4)) {
947 fprintf(fout
, "Author: %s\n", name
.buf
);
948 fprintf(fout
, "Email: %s\n", email
.buf
);
951 fprintf(fout
, "%s: %s\n", header
[i
], hdr
->buf
);
957 static int mailinfo(FILE *in
, FILE *out
, const char *msg
, const char *patch
)
963 cmitmsg
= fopen(msg
, "w");
968 patchfile
= fopen(patch
, "w");
975 p_hdr_data
= xcalloc(MAX_HDR_PARSED
, sizeof(*p_hdr_data
));
976 s_hdr_data
= xcalloc(MAX_HDR_PARSED
, sizeof(*s_hdr_data
));
980 } while (isspace(peek
));
983 /* process the email header */
984 while (read_one_header_line(&line
, fin
))
985 check_header(&line
, p_hdr_data
, 1);
993 static const char mailinfo_usage
[] =
994 "git mailinfo [-k] [-u | --encoding=<encoding> | -n] msg patch <mail >info";
996 int cmd_mailinfo(int argc
, const char **argv
, const char *prefix
)
998 const char *def_charset
;
1000 /* NEEDSWORK: might want to do the optional .git/ directory
1003 git_config(git_default_config
, NULL
);
1005 def_charset
= (git_commit_encoding
? git_commit_encoding
: "UTF-8");
1006 metainfo_charset
= def_charset
;
1008 while (1 < argc
&& argv
[1][0] == '-') {
1009 if (!strcmp(argv
[1], "-k"))
1011 else if (!strcmp(argv
[1], "-u"))
1012 metainfo_charset
= def_charset
;
1013 else if (!strcmp(argv
[1], "-n"))
1014 metainfo_charset
= NULL
;
1015 else if (!prefixcmp(argv
[1], "--encoding="))
1016 metainfo_charset
= argv
[1] + 11;
1018 usage(mailinfo_usage
);
1023 usage(mailinfo_usage
);
1025 return !!mailinfo(stdin
, stdout
, argv
[1], argv
[2]);