]>
git.ipfire.org Git - thirdparty/git.git/blob - builtin-mailinfo.c
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 if (slurp_attr(line
->buf
, "charset=", &charset
))
197 strbuf_tolower(&charset
);
200 strbuf_release(boundary
);
205 static void handle_content_transfer_encoding(const struct strbuf
*line
)
207 if (strcasestr(line
->buf
, "base64"))
208 transfer_encoding
= TE_BASE64
;
209 else if (strcasestr(line
->buf
, "quoted-printable"))
210 transfer_encoding
= TE_QP
;
212 transfer_encoding
= TE_DONTCARE
;
215 static int is_multipart_boundary(const struct strbuf
*line
)
217 return (((*content_top
)->len
<= line
->len
) &&
218 !memcmp(line
->buf
, (*content_top
)->buf
, (*content_top
)->len
));
221 static void cleanup_subject(struct strbuf
*subject
)
225 while (subject
->len
) {
226 switch (*subject
->buf
) {
228 if (subject
->len
<= 3)
230 if (!memcmp(subject
->buf
+ 1, "e:", 2)) {
231 strbuf_remove(subject
, 0, 3);
235 case ' ': case '\t': case ':':
236 strbuf_remove(subject
, 0, 1);
239 if ((pos
= strchr(subject
->buf
, ']'))) {
240 remove
= pos
- subject
->buf
;
241 if (remove
<= (subject
->len
- remove
) * 2) {
242 strbuf_remove(subject
, 0, remove
+ 1);
246 strbuf_remove(subject
, 0, 1);
249 strbuf_trim(subject
);
254 static void cleanup_space(struct strbuf
*sb
)
257 for (pos
= 0; pos
< sb
->len
; pos
++) {
258 if (isspace(sb
->buf
[pos
])) {
260 for (cnt
= 0; isspace(sb
->buf
[pos
+ cnt
+ 1]); cnt
++);
261 strbuf_remove(sb
, pos
+ 1, cnt
);
266 static void decode_header(struct strbuf
*line
);
267 static const char *header
[MAX_HDR_PARSED
] = {
268 "From","Subject","Date",
271 static inline int cmp_header(const struct strbuf
*line
, const char *hdr
)
273 int len
= strlen(hdr
);
274 return !strncasecmp(line
->buf
, hdr
, len
) && line
->len
> len
&&
275 line
->buf
[len
] == ':' && isspace(line
->buf
[len
+ 1]);
278 static int check_header(const struct strbuf
*line
,
279 struct strbuf
*hdr_data
[], int overwrite
)
282 struct strbuf sb
= STRBUF_INIT
;
283 /* search for the interesting parts */
284 for (i
= 0; header
[i
]; i
++) {
285 int len
= strlen(header
[i
]);
286 if ((!hdr_data
[i
] || overwrite
) && cmp_header(line
, header
[i
])) {
287 /* Unwrap inline B and Q encoding, and optionally
288 * normalize the meta information to utf8.
290 strbuf_add(&sb
, line
->buf
+ len
+ 2, line
->len
- len
- 2);
292 handle_header(&hdr_data
[i
], &sb
);
294 goto check_header_out
;
299 if (cmp_header(line
, "Content-Type")) {
300 len
= strlen("Content-Type: ");
301 strbuf_add(&sb
, line
->buf
+ len
, line
->len
- len
);
303 strbuf_insert(&sb
, 0, "Content-Type: ", len
);
304 handle_content_type(&sb
);
306 goto check_header_out
;
308 if (cmp_header(line
, "Content-Transfer-Encoding")) {
309 len
= strlen("Content-Transfer-Encoding: ");
310 strbuf_add(&sb
, line
->buf
+ len
, line
->len
- len
);
312 handle_content_transfer_encoding(&sb
);
314 goto check_header_out
;
317 /* for inbody stuff */
318 if (!prefixcmp(line
->buf
, ">From") && isspace(line
->buf
[5])) {
319 ret
= 1; /* Should this return 0? */
320 goto check_header_out
;
322 if (!prefixcmp(line
->buf
, "[PATCH]") && isspace(line
->buf
[7])) {
323 for (i
= 0; header
[i
]; i
++) {
324 if (!memcmp("Subject", header
[i
], 7)) {
325 handle_header(&hdr_data
[i
], line
);
327 goto check_header_out
;
337 static int is_rfc2822_header(const struct strbuf
*line
)
340 * The section that defines the loosest possible
341 * field name is "3.6.8 Optional fields".
343 * optional-field = field-name ":" unstructured CRLF
344 * field-name = 1*ftext
345 * ftext = %d33-57 / %59-126
348 char *cp
= line
->buf
;
350 /* Count mbox From headers as headers */
351 if (!prefixcmp(cp
, "From ") || !prefixcmp(cp
, ">From "))
354 while ((ch
= *cp
++)) {
357 if ((33 <= ch
&& ch
<= 57) ||
358 (59 <= ch
&& ch
<= 126))
365 static int read_one_header_line(struct strbuf
*line
, FILE *in
)
367 /* Get the first part of the line. */
368 if (strbuf_getline(line
, in
, '\n'))
372 * Is it an empty line or not a valid rfc2822 header?
373 * If so, stop here, and return false ("not a header")
376 if (!line
->len
|| !is_rfc2822_header(line
)) {
377 /* Re-add the newline */
378 strbuf_addch(line
, '\n');
383 * Now we need to eat all the continuation lines..
384 * Yuck, 2822 header "folding"
388 struct strbuf continuation
= STRBUF_INIT
;
390 peek
= fgetc(in
); ungetc(peek
, in
);
391 if (peek
!= ' ' && peek
!= '\t')
393 if (strbuf_getline(&continuation
, in
, '\n'))
395 continuation
.buf
[0] = '\n';
396 strbuf_rtrim(&continuation
);
397 strbuf_addbuf(line
, &continuation
);
403 static struct strbuf
*decode_q_segment(const struct strbuf
*q_seg
, int rfc2047
)
405 const char *in
= q_seg
->buf
;
407 struct strbuf
*out
= xmalloc(sizeof(struct strbuf
));
408 strbuf_init(out
, q_seg
->len
);
410 while ((c
= *in
++) != 0) {
414 break; /* drop trailing newline */
415 strbuf_addch(out
, (hexval(d
) << 4) | hexval(*in
++));
418 if (rfc2047
&& c
== '_') /* rfc2047 4.2 (2) */
420 strbuf_addch(out
, c
);
425 static struct strbuf
*decode_b_segment(const struct strbuf
*b_seg
)
427 /* Decode in..ep, possibly in-place to ot */
428 int c
, pos
= 0, acc
= 0;
429 const char *in
= b_seg
->buf
;
430 struct strbuf
*out
= xmalloc(sizeof(struct strbuf
));
431 strbuf_init(out
, b_seg
->len
);
433 while ((c
= *in
++) != 0) {
438 else if ('A' <= c
&& c
<= 'Z')
440 else if ('a' <= c
&& c
<= 'z')
442 else if ('0' <= c
&& c
<= '9')
445 continue; /* garbage */
451 strbuf_addch(out
, (acc
| (c
>> 4)));
455 strbuf_addch(out
, (acc
| (c
>> 2)));
459 strbuf_addch(out
, (acc
| c
));
468 * When there is no known charset, guess.
470 * Right now we assume that if the target is UTF-8 (the default),
471 * and it already looks like UTF-8 (which includes US-ASCII as its
472 * subset, of course) then that is what it is and there is nothing
475 * Otherwise, we default to assuming it is Latin1 for historical
478 static const char *guess_charset(const struct strbuf
*line
, const char *target_charset
)
480 if (is_encoding_utf8(target_charset
)) {
481 if (is_utf8(line
->buf
))
487 static void convert_to_utf8(struct strbuf
*line
, const char *charset
)
491 if (!charset
|| !*charset
) {
492 charset
= guess_charset(line
, metainfo_charset
);
497 if (!strcmp(metainfo_charset
, charset
))
499 out
= reencode_string(line
->buf
, metainfo_charset
, charset
);
501 die("cannot convert from %s to %s",
502 charset
, metainfo_charset
);
503 strbuf_attach(line
, out
, strlen(out
), strlen(out
));
506 static int decode_header_bq(struct strbuf
*it
)
509 struct strbuf outbuf
= STRBUF_INIT
, *dec
;
510 struct strbuf charset_q
= STRBUF_INIT
, piecebuf
= STRBUF_INIT
;
514 while (in
- it
->buf
<= it
->len
&& (ep
= strstr(in
, "=?")) != NULL
) {
516 strbuf_reset(&charset_q
);
517 strbuf_reset(&piecebuf
);
522 * We are about to process an encoded-word
523 * that begins at ep, but there is something
524 * before the encoded word.
527 for (scan
= in
; scan
< ep
; scan
++)
531 if (scan
!= ep
|| in
== it
->buf
) {
533 * We should not lose that "something",
534 * unless we have just processed an
535 * encoded-word, and there is only LWS
536 * before the one we are about to process.
538 strbuf_add(&outbuf
, in
, ep
- in
);
543 * ep : "=?iso-2022-jp?B?GyR...?= foo"
544 * ep : "=?ISO-8859-1?Q?Foo=FCbar?= baz"
548 if (ep
- it
->buf
>= it
->len
|| !(cp
= strchr(ep
, '?')))
549 goto decode_header_bq_out
;
551 if (cp
+ 3 - it
->buf
> it
->len
)
552 goto decode_header_bq_out
;
553 strbuf_add(&charset_q
, ep
, cp
- ep
);
554 strbuf_tolower(&charset_q
);
557 if (!encoding
|| cp
[2] != '?')
558 goto decode_header_bq_out
;
559 ep
= strstr(cp
+ 3, "?=");
561 goto decode_header_bq_out
;
562 strbuf_add(&piecebuf
, cp
+ 3, ep
- cp
- 3);
563 switch (tolower(encoding
)) {
565 goto decode_header_bq_out
;
567 dec
= decode_b_segment(&piecebuf
);
570 dec
= decode_q_segment(&piecebuf
, 1);
573 if (metainfo_charset
)
574 convert_to_utf8(dec
, charset_q
.buf
);
576 strbuf_addbuf(&outbuf
, dec
);
581 strbuf_addstr(&outbuf
, in
);
583 strbuf_addbuf(it
, &outbuf
);
584 decode_header_bq_out
:
585 strbuf_release(&outbuf
);
586 strbuf_release(&charset_q
);
587 strbuf_release(&piecebuf
);
591 static void decode_header(struct strbuf
*it
)
593 if (decode_header_bq(it
))
595 /* otherwise "it" is a straight copy of the input.
596 * This can be binary guck but there is no charset specified.
598 if (metainfo_charset
)
599 convert_to_utf8(it
, "");
602 static void decode_transfer_encoding(struct strbuf
*line
)
606 switch (transfer_encoding
) {
608 ret
= decode_q_segment(line
, 0);
611 ret
= decode_b_segment(line
);
618 strbuf_addbuf(line
, ret
);
623 static void handle_filter(struct strbuf
*line
);
625 static int find_boundary(void)
627 while (!strbuf_getline(&line
, fin
, '\n')) {
628 if (*content_top
&& is_multipart_boundary(&line
))
634 static int handle_boundary(void)
636 struct strbuf newline
= STRBUF_INIT
;
638 strbuf_addch(&newline
, '\n');
640 if (line
.len
>= (*content_top
)->len
+ 2 &&
641 !memcmp(line
.buf
+ (*content_top
)->len
, "--", 2)) {
642 /* we hit an end boundary */
643 /* pop the current boundary off the stack */
644 strbuf_release(*content_top
);
648 /* technically won't happen as is_multipart_boundary()
649 will fail first. But just in case..
651 if (--content_top
< content
) {
652 fprintf(stderr
, "Detected mismatched boundaries, "
656 handle_filter(&newline
);
657 strbuf_release(&newline
);
659 /* skip to the next boundary */
660 if (!find_boundary())
665 /* set some defaults */
666 transfer_encoding
= TE_DONTCARE
;
667 strbuf_reset(&charset
);
668 message_type
= TYPE_TEXT
;
670 /* slurp in this section's info */
671 while (read_one_header_line(&line
, fin
))
672 check_header(&line
, p_hdr_data
, 0);
674 strbuf_release(&newline
);
676 if (strbuf_getline(&line
, fin
, '\n'))
678 strbuf_addch(&line
, '\n');
682 static inline int patchbreak(const struct strbuf
*line
)
686 /* Beginning of a "diff -" header? */
687 if (!prefixcmp(line
->buf
, "diff -"))
690 /* CVS "Index: " line? */
691 if (!prefixcmp(line
->buf
, "Index: "))
695 * "--- <filename>" starts patches without headers
696 * "---<sp>*" is a manual separator
701 if (!prefixcmp(line
->buf
, "---")) {
702 /* space followed by a filename? */
703 if (line
->buf
[3] == ' ' && !isspace(line
->buf
[4]))
705 /* Just whitespace? */
706 for (i
= 3; i
< line
->len
; i
++) {
707 unsigned char c
= line
->buf
[i
];
718 static int handle_commit_msg(struct strbuf
*line
)
720 static int still_looking
= 1;
729 if ((still_looking
= check_header(line
, s_hdr_data
, 0)) != 0)
733 /* normalize the log message to UTF-8. */
734 if (metainfo_charset
)
735 convert_to_utf8(line
, charset
.buf
);
737 if (patchbreak(line
)) {
743 fputs(line
->buf
, cmitmsg
);
747 static void handle_patch(const struct strbuf
*line
)
749 fwrite(line
->buf
, 1, line
->len
, patchfile
);
753 static void handle_filter(struct strbuf
*line
)
755 static int filter
= 0;
757 /* filter tells us which part we left off on */
760 if (!handle_commit_msg(line
))
769 static void handle_body(void)
772 struct strbuf prev
= STRBUF_INIT
;
774 /* Skip up to the first boundary */
776 if (!find_boundary())
777 goto handle_body_out
;
781 strbuf_setlen(&line
, line
.len
+ len
);
783 /* process any boundary lines */
784 if (*content_top
&& is_multipart_boundary(&line
)) {
785 /* flush any leftover */
787 handle_filter(&prev
);
790 if (!handle_boundary())
791 goto handle_body_out
;
794 /* Unwrap transfer encoding */
795 decode_transfer_encoding(&line
);
797 switch (transfer_encoding
) {
801 struct strbuf
**lines
, **it
, *sb
;
803 /* Prepend any previous partial lines */
804 strbuf_insert(&line
, 0, prev
.buf
, prev
.len
);
807 /* binary data most likely doesn't have newlines */
808 if (message_type
!= TYPE_TEXT
) {
809 handle_filter(&line
);
813 * This is a decoded line that may contain
814 * multiple new lines. Pass only one chunk
815 * at a time to handle_filter()
817 lines
= strbuf_split(&line
, '\n');
818 for (it
= lines
; (sb
= *it
); it
++) {
819 if (*(it
+ 1) == NULL
) /* The last line */
820 if (sb
->buf
[sb
->len
- 1] != '\n') {
821 /* Partial line, save it for later. */
822 strbuf_addbuf(&prev
, sb
);
828 * The partial chunk is saved in "prev" and will be
829 * appended by the next iteration of read_line_with_nul().
831 strbuf_list_free(lines
);
835 handle_filter(&line
);
839 if (strbuf_avail(&line
) < 100)
840 strbuf_grow(&line
, 100);
841 } while ((len
= read_line_with_nul(line
.buf
, strbuf_avail(&line
), fin
)));
844 strbuf_release(&prev
);
847 static void output_header_lines(FILE *fout
, const char *hdr
, const struct strbuf
*data
)
849 const char *sp
= data
->buf
;
851 char *ep
= strchr(sp
, '\n');
857 fprintf(fout
, "%s: %.*s\n", hdr
, len
, sp
);
864 static void handle_info(void)
869 for (i
= 0; header
[i
]; i
++) {
870 /* only print inbody headers if we output a patch file */
871 if (patch_lines
&& s_hdr_data
[i
])
873 else if (p_hdr_data
[i
])
878 if (!memcmp(header
[i
], "Subject", 7)) {
880 cleanup_subject(hdr
);
883 output_header_lines(fout
, "Subject", hdr
);
884 } else if (!memcmp(header
[i
], "From", 4)) {
887 fprintf(fout
, "Author: %s\n", name
.buf
);
888 fprintf(fout
, "Email: %s\n", email
.buf
);
891 fprintf(fout
, "%s: %s\n", header
[i
], hdr
->buf
);
897 static int mailinfo(FILE *in
, FILE *out
, int ks
, const char *encoding
,
898 const char *msg
, const char *patch
)
902 metainfo_charset
= encoding
;
906 cmitmsg
= fopen(msg
, "w");
911 patchfile
= fopen(patch
, "w");
918 p_hdr_data
= xcalloc(MAX_HDR_PARSED
, sizeof(*p_hdr_data
));
919 s_hdr_data
= xcalloc(MAX_HDR_PARSED
, sizeof(*s_hdr_data
));
923 } while (isspace(peek
));
926 /* process the email header */
927 while (read_one_header_line(&line
, fin
))
928 check_header(&line
, p_hdr_data
, 1);
936 static const char mailinfo_usage
[] =
937 "git mailinfo [-k] [-u | --encoding=<encoding> | -n] msg patch <mail >info";
939 int cmd_mailinfo(int argc
, const char **argv
, const char *prefix
)
941 const char *def_charset
;
943 /* NEEDSWORK: might want to do the optional .git/ directory
946 git_config(git_default_config
, NULL
);
948 def_charset
= (git_commit_encoding
? git_commit_encoding
: "utf-8");
949 metainfo_charset
= def_charset
;
951 while (1 < argc
&& argv
[1][0] == '-') {
952 if (!strcmp(argv
[1], "-k"))
954 else if (!strcmp(argv
[1], "-u"))
955 metainfo_charset
= def_charset
;
956 else if (!strcmp(argv
[1], "-n"))
957 metainfo_charset
= NULL
;
958 else if (!prefixcmp(argv
[1], "--encoding="))
959 metainfo_charset
= argv
[1] + 11;
961 usage(mailinfo_usage
);
966 usage(mailinfo_usage
);
968 return !!mailinfo(stdin
, stdout
, keep_subject
, metainfo_charset
, argv
[1], argv
[2]);