6 static void cleanup_space(struct strbuf *sb)
9 for (pos = 0; pos < sb->len; pos++) {
10 if (isspace(sb->buf[pos])) {
12 for (cnt = 0; isspace(sb->buf[pos + cnt + 1]); cnt++);
13 strbuf_remove(sb, pos + 1, cnt);
18 static void get_sane_name(struct strbuf *out, struct strbuf *name, struct strbuf *email)
20 struct strbuf *src = name;
21 if (name->len < 3 || 60 < name->len || strchr(name->buf, '@') ||
22 strchr(name->buf, '<') || strchr(name->buf, '>'))
27 strbuf_addbuf(out, src);
30 static void parse_bogus_from(struct mailinfo *mi, const struct strbuf *line)
32 /* John Doe <johndoe> */
35 /* This is fallback, so do not bother if we already have an
41 bra = strchr(line->buf, '<');
44 ket = strchr(bra, '>');
48 strbuf_reset(&mi->email);
49 strbuf_add(&mi->email, bra + 1, ket - bra - 1);
51 strbuf_reset(&mi->name);
52 strbuf_add(&mi->name, line->buf, bra - line->buf);
53 strbuf_trim(&mi->name);
54 get_sane_name(&mi->name, &mi->name, &mi->email);
57 static void handle_from(struct mailinfo *mi, const struct strbuf *from)
63 strbuf_init(&f, from->len);
64 strbuf_addbuf(&f, from);
66 at = strchr(f.buf, '@');
68 parse_bogus_from(mi, from);
73 * If we already have one email, don't take any confusing lines
75 if (mi->email.len && strchr(at + 1, '@')) {
80 /* Pick up the string around '@', possibly delimited with <>
81 * pair; that is the email part.
93 el = strcspn(at, " \n\t\r\v\f>");
94 strbuf_reset(&mi->email);
95 strbuf_add(&mi->email, at, el);
96 strbuf_remove(&f, at - f.buf, el + (at[el] ? 1 : 0));
98 /* The remainder is name. It could be
100 * - "John Doe <john.doe@xz>" (a), or
101 * - "john.doe@xz (John Doe)" (b), or
102 * - "John (zzz) Doe <john.doe@xz> (Comment)" (c)
104 * but we have removed the email part, so
106 * - remove extra spaces which could stay after email (case 'c'), and
107 * - trim from both ends, possibly removing the () pair at the end
108 * (cases 'a' and 'b').
112 if (f.buf[0] == '(' && f.len && f.buf[f.len - 1] == ')') {
113 strbuf_remove(&f, 0, 1);
114 strbuf_setlen(&f, f.len - 1);
117 get_sane_name(&mi->name, &f, &mi->email);
121 static void handle_header(struct strbuf **out, const struct strbuf *line)
124 *out = xmalloc(sizeof(struct strbuf));
125 strbuf_init(*out, line->len);
129 strbuf_addbuf(*out, line);
132 /* NOTE NOTE NOTE. We do not claim we do full MIME. We just attempt
133 * to have enough heuristics to grok MIME encoded patches often found
134 * on our mailing lists. For example, we do not even treat header lines
135 * case insensitively.
138 static int slurp_attr(const char *line, const char *name, struct strbuf *attr)
140 const char *ends, *ap = strcasestr(line, name);
143 strbuf_setlen(attr, 0);
153 sz = strcspn(ap, ends);
154 strbuf_add(attr, ap, sz);
158 static void handle_content_type(struct mailinfo *mi, struct strbuf *line)
160 struct strbuf *boundary = xmalloc(sizeof(struct strbuf));
161 strbuf_init(boundary, line->len);
163 if (slurp_attr(line->buf, "boundary=", boundary)) {
164 strbuf_insert(boundary, 0, "--", 2);
165 if (++mi->content_top >= &mi->content[MAX_BOUNDARIES]) {
166 error("Too many boundaries to handle");
167 mi->input_error = -1;
168 mi->content_top = &mi->content[MAX_BOUNDARIES] - 1;
171 *(mi->content_top) = boundary;
174 slurp_attr(line->buf, "charset=", &mi->charset);
177 strbuf_release(boundary);
182 static void handle_message_id(struct mailinfo *mi, const struct strbuf *line)
184 if (mi->add_message_id)
185 mi->message_id = strdup(line->buf);
188 static void handle_content_transfer_encoding(struct mailinfo *mi,
189 const struct strbuf *line)
191 if (strcasestr(line->buf, "base64"))
192 mi->transfer_encoding = TE_BASE64;
193 else if (strcasestr(line->buf, "quoted-printable"))
194 mi->transfer_encoding = TE_QP;
196 mi->transfer_encoding = TE_DONTCARE;
199 static int is_multipart_boundary(struct mailinfo *mi, const struct strbuf *line)
201 struct strbuf *content_top = *(mi->content_top);
203 return ((content_top->len <= line->len) &&
204 !memcmp(line->buf, content_top->buf, content_top->len));
207 static void cleanup_subject(struct mailinfo *mi, struct strbuf *subject)
211 while (at < subject->len) {
215 switch (subject->buf[at]) {
217 if (subject->len <= at + 3)
219 if ((subject->buf[at + 1] == 'e' ||
220 subject->buf[at + 1] == 'E') &&
221 subject->buf[at + 2] == ':') {
222 strbuf_remove(subject, at, 3);
227 case ' ': case '\t': case ':':
228 strbuf_remove(subject, at, 1);
231 pos = strchr(subject->buf + at, ']');
234 remove = pos - subject->buf + at + 1;
235 if (!mi->keep_non_patch_brackets_in_subject ||
237 memmem(subject->buf + at, remove, "PATCH", 5)))
238 strbuf_remove(subject, at, remove);
242 * If the input had a space after the ], keep
243 * it. We don't bother with finding the end of
244 * the space, since we later normalize it
247 if (isspace(subject->buf[at]))
254 strbuf_trim(subject);
257 #define MAX_HDR_PARSED 10
258 static const char *header[MAX_HDR_PARSED] = {
259 "From","Subject","Date",
262 static inline int cmp_header(const struct strbuf *line, const char *hdr)
264 int len = strlen(hdr);
265 return !strncasecmp(line->buf, hdr, len) && line->len > len &&
266 line->buf[len] == ':' && isspace(line->buf[len + 1]);
269 static int is_format_patch_separator(const char *line, int len)
271 static const char SAMPLE[] =
272 "From e6807f3efca28b30decfecb1732a56c7db1137ee Mon Sep 17 00:00:00 2001\n";
275 if (len != strlen(SAMPLE))
277 if (!skip_prefix(line, "From ", &cp))
279 if (strspn(cp, "0123456789abcdef") != 40)
282 return !memcmp(SAMPLE + (cp - line), cp, strlen(SAMPLE) - (cp - line));
285 static struct strbuf *decode_q_segment(const struct strbuf *q_seg, int rfc2047)
287 const char *in = q_seg->buf;
289 struct strbuf *out = xmalloc(sizeof(struct strbuf));
290 strbuf_init(out, q_seg->len);
292 while ((c = *in++) != 0) {
296 break; /* drop trailing newline */
297 strbuf_addch(out, (hexval(d) << 4) | hexval(*in++));
300 if (rfc2047 && c == '_') /* rfc2047 4.2 (2) */
302 strbuf_addch(out, c);
307 static struct strbuf *decode_b_segment(const struct strbuf *b_seg)
309 /* Decode in..ep, possibly in-place to ot */
310 int c, pos = 0, acc = 0;
311 const char *in = b_seg->buf;
312 struct strbuf *out = xmalloc(sizeof(struct strbuf));
313 strbuf_init(out, b_seg->len);
315 while ((c = *in++) != 0) {
320 else if ('A' <= c && c <= 'Z')
322 else if ('a' <= c && c <= 'z')
324 else if ('0' <= c && c <= '9')
327 continue; /* garbage */
333 strbuf_addch(out, (acc | (c >> 4)));
337 strbuf_addch(out, (acc | (c >> 2)));
341 strbuf_addch(out, (acc | c));
349 static int convert_to_utf8(struct mailinfo *mi,
350 struct strbuf *line, const char *charset)
354 if (!mi->metainfo_charset || !charset || !*charset)
357 if (same_encoding(mi->metainfo_charset, charset))
359 out = reencode_string(line->buf, mi->metainfo_charset, charset);
361 mi->input_error = -1;
362 return error("cannot convert from %s to %s",
363 charset, mi->metainfo_charset);
365 strbuf_attach(line, out, strlen(out), strlen(out));
369 static void decode_header(struct mailinfo *mi, struct strbuf *it)
372 struct strbuf outbuf = STRBUF_INIT, *dec;
373 struct strbuf charset_q = STRBUF_INIT, piecebuf = STRBUF_INIT;
374 int found_error = 1; /* pessimism */
377 while (in - it->buf <= it->len && (ep = strstr(in, "=?")) != NULL) {
379 strbuf_reset(&charset_q);
380 strbuf_reset(&piecebuf);
384 * We are about to process an encoded-word
385 * that begins at ep, but there is something
386 * before the encoded word.
389 for (scan = in; scan < ep; scan++)
393 if (scan != ep || in == it->buf) {
395 * We should not lose that "something",
396 * unless we have just processed an
397 * encoded-word, and there is only LWS
398 * before the one we are about to process.
400 strbuf_add(&outbuf, in, ep - in);
404 * ep : "=?iso-2022-jp?B?GyR...?= foo"
405 * ep : "=?ISO-8859-1?Q?Foo=FCbar?= baz"
409 if (ep - it->buf >= it->len || !(cp = strchr(ep, '?')))
412 if (cp + 3 - it->buf > it->len)
414 strbuf_add(&charset_q, ep, cp - ep);
417 if (!encoding || cp[2] != '?')
419 ep = strstr(cp + 3, "?=");
422 strbuf_add(&piecebuf, cp + 3, ep - cp - 3);
423 switch (tolower(encoding)) {
427 dec = decode_b_segment(&piecebuf);
430 dec = decode_q_segment(&piecebuf, 1);
433 if (convert_to_utf8(mi, dec, charset_q.buf))
436 strbuf_addbuf(&outbuf, dec);
441 strbuf_addstr(&outbuf, in);
443 strbuf_addbuf(it, &outbuf);
446 strbuf_release(&outbuf);
447 strbuf_release(&charset_q);
448 strbuf_release(&piecebuf);
451 mi->input_error = -1;
454 static int check_header(struct mailinfo *mi,
455 const struct strbuf *line,
456 struct strbuf *hdr_data[], int overwrite)
459 struct strbuf sb = STRBUF_INIT;
461 /* search for the interesting parts */
462 for (i = 0; header[i]; i++) {
463 int len = strlen(header[i]);
464 if ((!hdr_data[i] || overwrite) && cmp_header(line, header[i])) {
465 /* Unwrap inline B and Q encoding, and optionally
466 * normalize the meta information to utf8.
468 strbuf_add(&sb, line->buf + len + 2, line->len - len - 2);
469 decode_header(mi, &sb);
470 handle_header(&hdr_data[i], &sb);
472 goto check_header_out;
477 if (cmp_header(line, "Content-Type")) {
478 len = strlen("Content-Type: ");
479 strbuf_add(&sb, line->buf + len, line->len - len);
480 decode_header(mi, &sb);
481 strbuf_insert(&sb, 0, "Content-Type: ", len);
482 handle_content_type(mi, &sb);
484 goto check_header_out;
486 if (cmp_header(line, "Content-Transfer-Encoding")) {
487 len = strlen("Content-Transfer-Encoding: ");
488 strbuf_add(&sb, line->buf + len, line->len - len);
489 decode_header(mi, &sb);
490 handle_content_transfer_encoding(mi, &sb);
492 goto check_header_out;
494 if (cmp_header(line, "Message-Id")) {
495 len = strlen("Message-Id: ");
496 strbuf_add(&sb, line->buf + len, line->len - len);
497 decode_header(mi, &sb);
498 handle_message_id(mi, &sb);
500 goto check_header_out;
503 /* for inbody stuff */
504 if (starts_with(line->buf, ">From") && isspace(line->buf[5])) {
505 ret = is_format_patch_separator(line->buf + 1, line->len - 1);
506 goto check_header_out;
508 if (starts_with(line->buf, "[PATCH]") && isspace(line->buf[7])) {
509 for (i = 0; header[i]; i++) {
510 if (!strcmp("Subject", header[i])) {
511 handle_header(&hdr_data[i], line);
513 goto check_header_out;
523 static void decode_transfer_encoding(struct mailinfo *mi, struct strbuf *line)
527 switch (mi->transfer_encoding) {
529 ret = decode_q_segment(line, 0);
532 ret = decode_b_segment(line);
539 strbuf_addbuf(line, ret);
544 static inline int patchbreak(const struct strbuf *line)
548 /* Beginning of a "diff -" header? */
549 if (starts_with(line->buf, "diff -"))
552 /* CVS "Index: " line? */
553 if (starts_with(line->buf, "Index: "))
557 * "--- <filename>" starts patches without headers
558 * "---<sp>*" is a manual separator
563 if (starts_with(line->buf, "---")) {
564 /* space followed by a filename? */
565 if (line->buf[3] == ' ' && !isspace(line->buf[4]))
567 /* Just whitespace? */
568 for (i = 3; i < line->len; i++) {
569 unsigned char c = line->buf[i];
580 static int is_scissors_line(const struct strbuf *line)
582 size_t i, len = line->len;
583 int scissors = 0, gap = 0;
584 int first_nonblank = -1;
585 int last_nonblank = 0, visible, perforation = 0, in_perforation = 0;
586 const char *buf = line->buf;
588 for (i = 0; i < len; i++) {
589 if (isspace(buf[i])) {
590 if (in_perforation) {
597 if (first_nonblank < 0)
605 (!memcmp(buf + i, ">8", 2) || !memcmp(buf + i, "8<", 2) ||
606 !memcmp(buf + i, ">%", 2) || !memcmp(buf + i, "%<", 2))) {
617 * The mark must be at least 8 bytes long (e.g. "-- >8 --").
618 * Even though there can be arbitrary cruft on the same line
619 * (e.g. "cut here"), in order to avoid misidentification, the
620 * perforation must occupy more than a third of the visible
621 * width of the line, and dashes and scissors must occupy more
622 * than half of the perforation.
625 visible = last_nonblank - first_nonblank + 1;
626 return (scissors && 8 <= visible &&
627 visible < perforation * 3 &&
628 gap * 2 < perforation);
631 static int handle_commit_msg(struct mailinfo *mi, struct strbuf *line)
633 assert(!mi->filter_stage);
635 if (mi->header_stage) {
636 if (!line->len || (line->len == 1 && line->buf[0] == '\n'))
640 if (mi->use_inbody_headers && mi->header_stage) {
641 mi->header_stage = check_header(mi, line, mi->s_hdr_data, 0);
642 if (mi->header_stage)
645 /* Only trim the first (blank) line of the commit message
646 * when ignoring in-body headers.
648 mi->header_stage = 0;
650 /* normalize the log message to UTF-8. */
651 if (convert_to_utf8(mi, line, mi->charset.buf))
652 return 0; /* mi->input_error already set */
654 if (mi->use_scissors && is_scissors_line(line)) {
657 strbuf_setlen(&mi->log_message, 0);
658 mi->header_stage = 1;
661 * We may have already read "secondary headers"; purge
662 * them to give ourselves a clean restart.
664 for (i = 0; header[i]; i++) {
665 if (mi->s_hdr_data[i])
666 strbuf_release(mi->s_hdr_data[i]);
667 mi->s_hdr_data[i] = NULL;
672 if (patchbreak(line)) {
674 strbuf_addf(&mi->log_message,
675 "Message-Id: %s\n", mi->message_id);
679 strbuf_addbuf(&mi->log_message, line);
683 static void handle_patch(struct mailinfo *mi, const struct strbuf *line)
685 fwrite(line->buf, 1, line->len, mi->patchfile);
689 static void handle_filter(struct mailinfo *mi, struct strbuf *line)
691 switch (mi->filter_stage) {
693 if (!handle_commit_msg(mi, line))
697 handle_patch(mi, line);
702 static int is_rfc2822_header(const struct strbuf *line)
705 * The section that defines the loosest possible
706 * field name is "3.6.8 Optional fields".
708 * optional-field = field-name ":" unstructured CRLF
709 * field-name = 1*ftext
710 * ftext = %d33-57 / %59-126
713 char *cp = line->buf;
715 /* Count mbox From headers as headers */
716 if (starts_with(cp, "From ") || starts_with(cp, ">From "))
719 while ((ch = *cp++)) {
722 if ((33 <= ch && ch <= 57) ||
723 (59 <= ch && ch <= 126))
730 static int read_one_header_line(struct strbuf *line, FILE *in)
732 struct strbuf continuation = STRBUF_INIT;
734 /* Get the first part of the line. */
735 if (strbuf_getline_lf(line, in))
739 * Is it an empty line or not a valid rfc2822 header?
740 * If so, stop here, and return false ("not a header")
743 if (!line->len || !is_rfc2822_header(line)) {
744 /* Re-add the newline */
745 strbuf_addch(line, '\n');
750 * Now we need to eat all the continuation lines..
751 * Yuck, 2822 header "folding"
756 peek = fgetc(in); ungetc(peek, in);
757 if (peek != ' ' && peek != '\t')
759 if (strbuf_getline_lf(&continuation, in))
761 continuation.buf[0] = ' ';
762 strbuf_rtrim(&continuation);
763 strbuf_addbuf(line, &continuation);
765 strbuf_release(&continuation);
770 static int find_boundary(struct mailinfo *mi, struct strbuf *line)
772 while (!strbuf_getline_lf(line, mi->input)) {
773 if (*(mi->content_top) && is_multipart_boundary(mi, line))
779 static int handle_boundary(struct mailinfo *mi, struct strbuf *line)
781 struct strbuf newline = STRBUF_INIT;
783 strbuf_addch(&newline, '\n');
785 if (line->len >= (*(mi->content_top))->len + 2 &&
786 !memcmp(line->buf + (*(mi->content_top))->len, "--", 2)) {
787 /* we hit an end boundary */
788 /* pop the current boundary off the stack */
789 strbuf_release(*(mi->content_top));
790 free(*(mi->content_top));
791 *(mi->content_top) = NULL;
793 /* technically won't happen as is_multipart_boundary()
794 will fail first. But just in case..
796 if (--mi->content_top < mi->content) {
797 error("Detected mismatched boundaries, can't recover");
798 mi->input_error = -1;
799 mi->content_top = mi->content;
802 handle_filter(mi, &newline);
803 strbuf_release(&newline);
807 /* skip to the next boundary */
808 if (!find_boundary(mi, line))
813 /* set some defaults */
814 mi->transfer_encoding = TE_DONTCARE;
815 strbuf_reset(&mi->charset);
817 /* slurp in this section's info */
818 while (read_one_header_line(line, mi->input))
819 check_header(mi, line, mi->p_hdr_data, 0);
821 strbuf_release(&newline);
823 if (strbuf_getline_lf(line, mi->input))
825 strbuf_addch(line, '\n');
829 static void handle_body(struct mailinfo *mi, struct strbuf *line)
831 struct strbuf prev = STRBUF_INIT;
833 /* Skip up to the first boundary */
834 if (*(mi->content_top)) {
835 if (!find_boundary(mi, line))
836 goto handle_body_out;
840 /* process any boundary lines */
841 if (*(mi->content_top) && is_multipart_boundary(mi, line)) {
842 /* flush any leftover */
844 handle_filter(mi, &prev);
847 if (!handle_boundary(mi, line))
848 goto handle_body_out;
851 /* Unwrap transfer encoding */
852 decode_transfer_encoding(mi, line);
854 switch (mi->transfer_encoding) {
858 struct strbuf **lines, **it, *sb;
860 /* Prepend any previous partial lines */
861 strbuf_insert(line, 0, prev.buf, prev.len);
865 * This is a decoded line that may contain
866 * multiple new lines. Pass only one chunk
867 * at a time to handle_filter()
869 lines = strbuf_split(line, '\n');
870 for (it = lines; (sb = *it); it++) {
871 if (*(it + 1) == NULL) /* The last line */
872 if (sb->buf[sb->len - 1] != '\n') {
873 /* Partial line, save it for later. */
874 strbuf_addbuf(&prev, sb);
877 handle_filter(mi, sb);
880 * The partial chunk is saved in "prev" and will be
881 * appended by the next iteration of read_line_with_nul().
883 strbuf_list_free(lines);
887 handle_filter(mi, line);
892 } while (!strbuf_getwholeline(line, mi->input, '\n'));
895 strbuf_release(&prev);
898 static void output_header_lines(FILE *fout, const char *hdr, const struct strbuf *data)
900 const char *sp = data->buf;
902 char *ep = strchr(sp, '\n');
908 fprintf(fout, "%s: %.*s\n", hdr, len, sp);
915 static void handle_info(struct mailinfo *mi)
920 for (i = 0; header[i]; i++) {
921 /* only print inbody headers if we output a patch file */
922 if (mi->patch_lines && mi->s_hdr_data[i])
923 hdr = mi->s_hdr_data[i];
924 else if (mi->p_hdr_data[i])
925 hdr = mi->p_hdr_data[i];
929 if (!strcmp(header[i], "Subject")) {
930 if (!mi->keep_subject) {
931 cleanup_subject(mi, hdr);
934 output_header_lines(mi->output, "Subject", hdr);
935 } else if (!strcmp(header[i], "From")) {
937 handle_from(mi, hdr);
938 fprintf(mi->output, "Author: %s\n", mi->name.buf);
939 fprintf(mi->output, "Email: %s\n", mi->email.buf);
942 fprintf(mi->output, "%s: %s\n", header[i], hdr->buf);
945 fprintf(mi->output, "\n");
948 int mailinfo(struct mailinfo *mi, const char *msg, const char *patch)
952 struct strbuf line = STRBUF_INIT;
954 cmitmsg = fopen(msg, "w");
959 mi->patchfile = fopen(patch, "w");
960 if (!mi->patchfile) {
966 mi->p_hdr_data = xcalloc(MAX_HDR_PARSED, sizeof(*(mi->p_hdr_data)));
967 mi->s_hdr_data = xcalloc(MAX_HDR_PARSED, sizeof(*(mi->s_hdr_data)));
970 peek = fgetc(mi->input);
971 } while (isspace(peek));
972 ungetc(peek, mi->input);
974 /* process the email header */
975 while (read_one_header_line(&line, mi->input))
976 check_header(mi, &line, mi->p_hdr_data, 1);
978 handle_body(mi, &line);
979 fwrite(mi->log_message.buf, 1, mi->log_message.len, cmitmsg);
981 fclose(mi->patchfile);
984 strbuf_release(&line);
985 return mi->input_error;
988 static int git_mailinfo_config(const char *var, const char *value, void *mi_)
990 struct mailinfo *mi = mi_;
992 if (!starts_with(var, "mailinfo."))
993 return git_default_config(var, value, NULL);
994 if (!strcmp(var, "mailinfo.scissors")) {
995 mi->use_scissors = git_config_bool(var, value);
998 /* perhaps others here */
1002 void setup_mailinfo(struct mailinfo *mi)
1004 memset(mi, 0, sizeof(*mi));
1005 strbuf_init(&mi->name, 0);
1006 strbuf_init(&mi->email, 0);
1007 strbuf_init(&mi->charset, 0);
1008 strbuf_init(&mi->log_message, 0);
1009 mi->header_stage = 1;
1010 mi->use_inbody_headers = 1;
1011 mi->content_top = mi->content;
1012 git_config(git_mailinfo_config, mi);
1015 void clear_mailinfo(struct mailinfo *mi)
1019 strbuf_release(&mi->name);
1020 strbuf_release(&mi->email);
1021 strbuf_release(&mi->charset);
1022 free(mi->message_id);
1024 for (i = 0; mi->p_hdr_data[i]; i++)
1025 strbuf_release(mi->p_hdr_data[i]);
1026 free(mi->p_hdr_data);
1027 for (i = 0; mi->s_hdr_data[i]; i++)
1028 strbuf_release(mi->s_hdr_data[i]);
1029 free(mi->s_hdr_data);
1031 while (mi->content < mi->content_top) {
1032 free(*(mi->content_top));
1036 strbuf_release(&mi->log_message);