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 fprintf(stderr, "Too many boundaries to handle\n");
169 *(mi->content_top) = boundary;
172 slurp_attr(line->buf, "charset=", &mi->charset);
175 strbuf_release(boundary);
180 static void handle_message_id(struct mailinfo *mi, const struct strbuf *line)
182 if (mi->add_message_id)
183 mi->message_id = strdup(line->buf);
186 static void handle_content_transfer_encoding(struct mailinfo *mi,
187 const struct strbuf *line)
189 if (strcasestr(line->buf, "base64"))
190 mi->transfer_encoding = TE_BASE64;
191 else if (strcasestr(line->buf, "quoted-printable"))
192 mi->transfer_encoding = TE_QP;
194 mi->transfer_encoding = TE_DONTCARE;
197 static int is_multipart_boundary(struct mailinfo *mi, const struct strbuf *line)
199 struct strbuf *content_top = *(mi->content_top);
201 return ((content_top->len <= line->len) &&
202 !memcmp(line->buf, content_top->buf, content_top->len));
205 static void cleanup_subject(struct mailinfo *mi, struct strbuf *subject)
209 while (at < subject->len) {
213 switch (subject->buf[at]) {
215 if (subject->len <= at + 3)
217 if ((subject->buf[at + 1] == 'e' ||
218 subject->buf[at + 1] == 'E') &&
219 subject->buf[at + 2] == ':') {
220 strbuf_remove(subject, at, 3);
225 case ' ': case '\t': case ':':
226 strbuf_remove(subject, at, 1);
229 pos = strchr(subject->buf + at, ']');
232 remove = pos - subject->buf + at + 1;
233 if (!mi->keep_non_patch_brackets_in_subject ||
235 memmem(subject->buf + at, remove, "PATCH", 5)))
236 strbuf_remove(subject, at, remove);
240 * If the input had a space after the ], keep
241 * it. We don't bother with finding the end of
242 * the space, since we later normalize it
245 if (isspace(subject->buf[at]))
252 strbuf_trim(subject);
255 #define MAX_HDR_PARSED 10
256 static const char *header[MAX_HDR_PARSED] = {
257 "From","Subject","Date",
260 static inline int cmp_header(const struct strbuf *line, const char *hdr)
262 int len = strlen(hdr);
263 return !strncasecmp(line->buf, hdr, len) && line->len > len &&
264 line->buf[len] == ':' && isspace(line->buf[len + 1]);
267 static int is_format_patch_separator(const char *line, int len)
269 static const char SAMPLE[] =
270 "From e6807f3efca28b30decfecb1732a56c7db1137ee Mon Sep 17 00:00:00 2001\n";
273 if (len != strlen(SAMPLE))
275 if (!skip_prefix(line, "From ", &cp))
277 if (strspn(cp, "0123456789abcdef") != 40)
280 return !memcmp(SAMPLE + (cp - line), cp, strlen(SAMPLE) - (cp - line));
283 static struct strbuf *decode_q_segment(const struct strbuf *q_seg, int rfc2047)
285 const char *in = q_seg->buf;
287 struct strbuf *out = xmalloc(sizeof(struct strbuf));
288 strbuf_init(out, q_seg->len);
290 while ((c = *in++) != 0) {
294 break; /* drop trailing newline */
295 strbuf_addch(out, (hexval(d) << 4) | hexval(*in++));
298 if (rfc2047 && c == '_') /* rfc2047 4.2 (2) */
300 strbuf_addch(out, c);
305 static struct strbuf *decode_b_segment(const struct strbuf *b_seg)
307 /* Decode in..ep, possibly in-place to ot */
308 int c, pos = 0, acc = 0;
309 const char *in = b_seg->buf;
310 struct strbuf *out = xmalloc(sizeof(struct strbuf));
311 strbuf_init(out, b_seg->len);
313 while ((c = *in++) != 0) {
318 else if ('A' <= c && c <= 'Z')
320 else if ('a' <= c && c <= 'z')
322 else if ('0' <= c && c <= '9')
325 continue; /* garbage */
331 strbuf_addch(out, (acc | (c >> 4)));
335 strbuf_addch(out, (acc | (c >> 2)));
339 strbuf_addch(out, (acc | c));
347 static int convert_to_utf8(struct mailinfo *mi,
348 struct strbuf *line, const char *charset)
352 if (!mi->metainfo_charset || !charset || !*charset)
355 if (same_encoding(mi->metainfo_charset, charset))
357 out = reencode_string(line->buf, mi->metainfo_charset, charset);
359 return error("cannot convert from %s to %s",
360 charset, mi->metainfo_charset);
361 strbuf_attach(line, out, strlen(out), strlen(out));
365 static void decode_header(struct mailinfo *mi, struct strbuf *it)
368 struct strbuf outbuf = STRBUF_INIT, *dec;
369 struct strbuf charset_q = STRBUF_INIT, piecebuf = STRBUF_INIT;
372 while (in - it->buf <= it->len && (ep = strstr(in, "=?")) != NULL) {
374 strbuf_reset(&charset_q);
375 strbuf_reset(&piecebuf);
379 * We are about to process an encoded-word
380 * that begins at ep, but there is something
381 * before the encoded word.
384 for (scan = in; scan < ep; scan++)
388 if (scan != ep || in == it->buf) {
390 * We should not lose that "something",
391 * unless we have just processed an
392 * encoded-word, and there is only LWS
393 * before the one we are about to process.
395 strbuf_add(&outbuf, in, ep - in);
399 * ep : "=?iso-2022-jp?B?GyR...?= foo"
400 * ep : "=?ISO-8859-1?Q?Foo=FCbar?= baz"
404 if (ep - it->buf >= it->len || !(cp = strchr(ep, '?')))
407 if (cp + 3 - it->buf > it->len)
409 strbuf_add(&charset_q, ep, cp - ep);
412 if (!encoding || cp[2] != '?')
414 ep = strstr(cp + 3, "?=");
417 strbuf_add(&piecebuf, cp + 3, ep - cp - 3);
418 switch (tolower(encoding)) {
422 dec = decode_b_segment(&piecebuf);
425 dec = decode_q_segment(&piecebuf, 1);
428 if (convert_to_utf8(mi, dec, charset_q.buf))
431 strbuf_addbuf(&outbuf, dec);
436 strbuf_addstr(&outbuf, in);
438 strbuf_addbuf(it, &outbuf);
440 strbuf_release(&outbuf);
441 strbuf_release(&charset_q);
442 strbuf_release(&piecebuf);
445 static int check_header(struct mailinfo *mi,
446 const struct strbuf *line,
447 struct strbuf *hdr_data[], int overwrite)
450 struct strbuf sb = STRBUF_INIT;
452 /* search for the interesting parts */
453 for (i = 0; header[i]; i++) {
454 int len = strlen(header[i]);
455 if ((!hdr_data[i] || overwrite) && cmp_header(line, header[i])) {
456 /* Unwrap inline B and Q encoding, and optionally
457 * normalize the meta information to utf8.
459 strbuf_add(&sb, line->buf + len + 2, line->len - len - 2);
460 decode_header(mi, &sb);
461 handle_header(&hdr_data[i], &sb);
463 goto check_header_out;
468 if (cmp_header(line, "Content-Type")) {
469 len = strlen("Content-Type: ");
470 strbuf_add(&sb, line->buf + len, line->len - len);
471 decode_header(mi, &sb);
472 strbuf_insert(&sb, 0, "Content-Type: ", len);
473 handle_content_type(mi, &sb);
475 goto check_header_out;
477 if (cmp_header(line, "Content-Transfer-Encoding")) {
478 len = strlen("Content-Transfer-Encoding: ");
479 strbuf_add(&sb, line->buf + len, line->len - len);
480 decode_header(mi, &sb);
481 handle_content_transfer_encoding(mi, &sb);
483 goto check_header_out;
485 if (cmp_header(line, "Message-Id")) {
486 len = strlen("Message-Id: ");
487 strbuf_add(&sb, line->buf + len, line->len - len);
488 decode_header(mi, &sb);
489 handle_message_id(mi, &sb);
491 goto check_header_out;
494 /* for inbody stuff */
495 if (starts_with(line->buf, ">From") && isspace(line->buf[5])) {
496 ret = is_format_patch_separator(line->buf + 1, line->len - 1);
497 goto check_header_out;
499 if (starts_with(line->buf, "[PATCH]") && isspace(line->buf[7])) {
500 for (i = 0; header[i]; i++) {
501 if (!strcmp("Subject", header[i])) {
502 handle_header(&hdr_data[i], line);
504 goto check_header_out;
514 static void decode_transfer_encoding(struct mailinfo *mi, struct strbuf *line)
518 switch (mi->transfer_encoding) {
520 ret = decode_q_segment(line, 0);
523 ret = decode_b_segment(line);
530 strbuf_addbuf(line, ret);
535 static inline int patchbreak(const struct strbuf *line)
539 /* Beginning of a "diff -" header? */
540 if (starts_with(line->buf, "diff -"))
543 /* CVS "Index: " line? */
544 if (starts_with(line->buf, "Index: "))
548 * "--- <filename>" starts patches without headers
549 * "---<sp>*" is a manual separator
554 if (starts_with(line->buf, "---")) {
555 /* space followed by a filename? */
556 if (line->buf[3] == ' ' && !isspace(line->buf[4]))
558 /* Just whitespace? */
559 for (i = 3; i < line->len; i++) {
560 unsigned char c = line->buf[i];
571 static int is_scissors_line(const struct strbuf *line)
573 size_t i, len = line->len;
574 int scissors = 0, gap = 0;
575 int first_nonblank = -1;
576 int last_nonblank = 0, visible, perforation = 0, in_perforation = 0;
577 const char *buf = line->buf;
579 for (i = 0; i < len; i++) {
580 if (isspace(buf[i])) {
581 if (in_perforation) {
588 if (first_nonblank < 0)
596 (!memcmp(buf + i, ">8", 2) || !memcmp(buf + i, "8<", 2) ||
597 !memcmp(buf + i, ">%", 2) || !memcmp(buf + i, "%<", 2))) {
608 * The mark must be at least 8 bytes long (e.g. "-- >8 --").
609 * Even though there can be arbitrary cruft on the same line
610 * (e.g. "cut here"), in order to avoid misidentification, the
611 * perforation must occupy more than a third of the visible
612 * width of the line, and dashes and scissors must occupy more
613 * than half of the perforation.
616 visible = last_nonblank - first_nonblank + 1;
617 return (scissors && 8 <= visible &&
618 visible < perforation * 3 &&
619 gap * 2 < perforation);
622 static int handle_commit_msg(struct mailinfo *mi, struct strbuf *line)
624 assert(!mi->filter_stage);
626 if (mi->header_stage) {
627 if (!line->len || (line->len == 1 && line->buf[0] == '\n'))
631 if (mi->use_inbody_headers && mi->header_stage) {
632 mi->header_stage = check_header(mi, line, mi->s_hdr_data, 0);
633 if (mi->header_stage)
636 /* Only trim the first (blank) line of the commit message
637 * when ignoring in-body headers.
639 mi->header_stage = 0;
641 /* normalize the log message to UTF-8. */
642 if (convert_to_utf8(mi, line, mi->charset.buf))
645 if (mi->use_scissors && is_scissors_line(line)) {
648 strbuf_setlen(&mi->log_message, 0);
649 mi->header_stage = 1;
652 * We may have already read "secondary headers"; purge
653 * them to give ourselves a clean restart.
655 for (i = 0; header[i]; i++) {
656 if (mi->s_hdr_data[i])
657 strbuf_release(mi->s_hdr_data[i]);
658 mi->s_hdr_data[i] = NULL;
663 if (patchbreak(line)) {
665 strbuf_addf(&mi->log_message,
666 "Message-Id: %s\n", mi->message_id);
670 strbuf_addbuf(&mi->log_message, line);
674 static void handle_patch(struct mailinfo *mi, const struct strbuf *line)
676 fwrite(line->buf, 1, line->len, mi->patchfile);
680 static void handle_filter(struct mailinfo *mi, struct strbuf *line)
682 switch (mi->filter_stage) {
684 if (!handle_commit_msg(mi, line))
688 handle_patch(mi, line);
693 static int is_rfc2822_header(const struct strbuf *line)
696 * The section that defines the loosest possible
697 * field name is "3.6.8 Optional fields".
699 * optional-field = field-name ":" unstructured CRLF
700 * field-name = 1*ftext
701 * ftext = %d33-57 / %59-126
704 char *cp = line->buf;
706 /* Count mbox From headers as headers */
707 if (starts_with(cp, "From ") || starts_with(cp, ">From "))
710 while ((ch = *cp++)) {
713 if ((33 <= ch && ch <= 57) ||
714 (59 <= ch && ch <= 126))
721 static int read_one_header_line(struct strbuf *line, FILE *in)
723 struct strbuf continuation = STRBUF_INIT;
725 /* Get the first part of the line. */
726 if (strbuf_getline(line, in, '\n'))
730 * Is it an empty line or not a valid rfc2822 header?
731 * If so, stop here, and return false ("not a header")
734 if (!line->len || !is_rfc2822_header(line)) {
735 /* Re-add the newline */
736 strbuf_addch(line, '\n');
741 * Now we need to eat all the continuation lines..
742 * Yuck, 2822 header "folding"
747 peek = fgetc(in); ungetc(peek, in);
748 if (peek != ' ' && peek != '\t')
750 if (strbuf_getline(&continuation, in, '\n'))
752 continuation.buf[0] = ' ';
753 strbuf_rtrim(&continuation);
754 strbuf_addbuf(line, &continuation);
756 strbuf_release(&continuation);
761 static int find_boundary(struct mailinfo *mi, struct strbuf *line)
763 while (!strbuf_getline(line, mi->input, '\n')) {
764 if (*(mi->content_top) && is_multipart_boundary(mi, line))
770 static int handle_boundary(struct mailinfo *mi, struct strbuf *line)
772 struct strbuf newline = STRBUF_INIT;
774 strbuf_addch(&newline, '\n');
776 if (line->len >= (*(mi->content_top))->len + 2 &&
777 !memcmp(line->buf + (*(mi->content_top))->len, "--", 2)) {
778 /* we hit an end boundary */
779 /* pop the current boundary off the stack */
780 strbuf_release(*(mi->content_top));
781 free(*(mi->content_top));
782 *(mi->content_top) = NULL;
784 /* technically won't happen as is_multipart_boundary()
785 will fail first. But just in case..
787 if (--mi->content_top < mi->content) {
788 fprintf(stderr, "Detected mismatched boundaries, "
792 handle_filter(mi, &newline);
793 strbuf_release(&newline);
795 /* skip to the next boundary */
796 if (!find_boundary(mi, line))
801 /* set some defaults */
802 mi->transfer_encoding = TE_DONTCARE;
803 strbuf_reset(&mi->charset);
805 /* slurp in this section's info */
806 while (read_one_header_line(line, mi->input))
807 check_header(mi, line, mi->p_hdr_data, 0);
809 strbuf_release(&newline);
811 if (strbuf_getline(line, mi->input, '\n'))
813 strbuf_addch(line, '\n');
817 static void handle_body(struct mailinfo *mi, struct strbuf *line)
819 struct strbuf prev = STRBUF_INIT;
821 /* Skip up to the first boundary */
822 if (*(mi->content_top)) {
823 if (!find_boundary(mi, line))
824 goto handle_body_out;
828 /* process any boundary lines */
829 if (*(mi->content_top) && is_multipart_boundary(mi, line)) {
830 /* flush any leftover */
832 handle_filter(mi, &prev);
835 if (!handle_boundary(mi, line))
836 goto handle_body_out;
839 /* Unwrap transfer encoding */
840 decode_transfer_encoding(mi, line);
842 switch (mi->transfer_encoding) {
846 struct strbuf **lines, **it, *sb;
848 /* Prepend any previous partial lines */
849 strbuf_insert(line, 0, prev.buf, prev.len);
853 * This is a decoded line that may contain
854 * multiple new lines. Pass only one chunk
855 * at a time to handle_filter()
857 lines = strbuf_split(line, '\n');
858 for (it = lines; (sb = *it); it++) {
859 if (*(it + 1) == NULL) /* The last line */
860 if (sb->buf[sb->len - 1] != '\n') {
861 /* Partial line, save it for later. */
862 strbuf_addbuf(&prev, sb);
865 handle_filter(mi, sb);
868 * The partial chunk is saved in "prev" and will be
869 * appended by the next iteration of read_line_with_nul().
871 strbuf_list_free(lines);
875 handle_filter(mi, line);
878 } while (!strbuf_getwholeline(line, mi->input, '\n'));
881 strbuf_release(&prev);
884 static void output_header_lines(FILE *fout, const char *hdr, const struct strbuf *data)
886 const char *sp = data->buf;
888 char *ep = strchr(sp, '\n');
894 fprintf(fout, "%s: %.*s\n", hdr, len, sp);
901 static void handle_info(struct mailinfo *mi)
906 for (i = 0; header[i]; i++) {
907 /* only print inbody headers if we output a patch file */
908 if (mi->patch_lines && mi->s_hdr_data[i])
909 hdr = mi->s_hdr_data[i];
910 else if (mi->p_hdr_data[i])
911 hdr = mi->p_hdr_data[i];
915 if (!strcmp(header[i], "Subject")) {
916 if (!mi->keep_subject) {
917 cleanup_subject(mi, hdr);
920 output_header_lines(mi->output, "Subject", hdr);
921 } else if (!strcmp(header[i], "From")) {
923 handle_from(mi, hdr);
924 fprintf(mi->output, "Author: %s\n", mi->name.buf);
925 fprintf(mi->output, "Email: %s\n", mi->email.buf);
928 fprintf(mi->output, "%s: %s\n", header[i], hdr->buf);
931 fprintf(mi->output, "\n");
934 int mailinfo(struct mailinfo *mi, const char *msg, const char *patch)
938 struct strbuf line = STRBUF_INIT;
940 cmitmsg = fopen(msg, "w");
945 mi->patchfile = fopen(patch, "w");
946 if (!mi->patchfile) {
952 mi->p_hdr_data = xcalloc(MAX_HDR_PARSED, sizeof(*(mi->p_hdr_data)));
953 mi->s_hdr_data = xcalloc(MAX_HDR_PARSED, sizeof(*(mi->s_hdr_data)));
956 peek = fgetc(mi->input);
957 } while (isspace(peek));
958 ungetc(peek, mi->input);
960 /* process the email header */
961 while (read_one_header_line(&line, mi->input))
962 check_header(mi, &line, mi->p_hdr_data, 1);
964 handle_body(mi, &line);
965 fwrite(mi->log_message.buf, 1, mi->log_message.len, cmitmsg);
967 fclose(mi->patchfile);
970 strbuf_release(&line);
974 static int git_mailinfo_config(const char *var, const char *value, void *mi_)
976 struct mailinfo *mi = mi_;
978 if (!starts_with(var, "mailinfo."))
979 return git_default_config(var, value, NULL);
980 if (!strcmp(var, "mailinfo.scissors")) {
981 mi->use_scissors = git_config_bool(var, value);
984 /* perhaps others here */
988 void setup_mailinfo(struct mailinfo *mi)
990 memset(mi, 0, sizeof(*mi));
991 strbuf_init(&mi->name, 0);
992 strbuf_init(&mi->email, 0);
993 strbuf_init(&mi->charset, 0);
994 strbuf_init(&mi->log_message, 0);
995 mi->header_stage = 1;
996 mi->use_inbody_headers = 1;
997 mi->content_top = mi->content;
998 git_config(git_mailinfo_config, &mi);
1001 void clear_mailinfo(struct mailinfo *mi)
1005 strbuf_release(&mi->name);
1006 strbuf_release(&mi->email);
1007 strbuf_release(&mi->charset);
1008 free(mi->message_id);
1010 for (i = 0; mi->p_hdr_data[i]; i++)
1011 strbuf_release(mi->p_hdr_data[i]);
1012 free(mi->p_hdr_data);
1013 for (i = 0; mi->s_hdr_data[i]; i++)
1014 strbuf_release(mi->s_hdr_data[i]);
1015 free(mi->s_hdr_data);
1017 while (mi->content < mi->content_top) {
1018 free(*(mi->content_top));
1022 strbuf_release(&mi->log_message);