[v5,0/4] Add support for mailmap in cat-file

Message

Siddharth Asthana July 16, 2022, 7:40 a.m. UTC

Thanks a lot Johannes and Junio for helping me identify and fix the memory
corruption in commit_rewrite_person()!  :)

= Description

This patch series adds mailmap support to the git-cat-file command. It
adds the mailmap support only for the commit and tag objects by
replacing the idents for "author", "committer" and "tagger" headers. The
mailmap only takes effect when --[no-]-use-mailmap or --[no-]-mailmap
option is passed to the git cat-file command. The changes will work with
the batch mode as well.

So, if one wants to enable mailmap they can use either of the following
commands:
$ git cat-file --use-mailmap -p <object>
$ git cat-file --use-mailmap <type> <object>

To use it in the batch mode, one can use the following command:
$ git cat-file --use-mailmap --batch

= Patch Organization

- The first patch improves the commit_rewrite_person() by restricting it 
  to traverse only through the header part of the commit object buffer.
  It also adds an argument called headers which the callers can pass. 
  The function will replace idents only on these  passed headers. 
  Thus, the caller won't have to make repeated calls to the function.
- The second patch moves commit_rewrite_person() to ident.c to expose it
  as a public function so that it can be used to replace idents in the
  headers of desired objects.
- The third patch renames commit_rewrite_person() to a name which
  describes its functionality clearly. It is renamed to
  apply_mailmap_to_header().
- The last patch adds mailmap support to the git cat-file command. It
  adds the required documentation and tests as well.

Changes in v5:
- In commit_rewrite_person(), we make calls to rewrite_ident_line(),
  where the strbuf can grow. This moves the buffer to a new address,
  which invalidates the `line` pointer, which still points at the same
  address . This issue has been fixed by breaking out of the inner for
  loop as soon as there we find a match for any commit headers that we
  are passing to the function.
- The commit_rewrite_person() no longer has a `linelen` variable and
  instead we now rely on `buf_offset` for navigating through the buffer.
- Some overly long lines have been wrapped.

Siddharth Asthana (4):
  revision: improve commit_rewrite_person()
  ident: move commit_rewrite_person() to ident.c
  ident: rename commit_rewrite_person() to apply_mailmap_to_header()
  cat-file: add mailmap support

 Documentation/git-cat-file.txt |  6 +++
 builtin/cat-file.c             | 43 ++++++++++++++++++-
 cache.h                        |  6 +++
 ident.c                        | 75 ++++++++++++++++++++++++++++++++++
 revision.c                     | 50 ++---------------------
 t/t4203-mailmap.sh             | 59 ++++++++++++++++++++++++++
 6 files changed, 191 insertions(+), 48 deletions(-)

Range-diff against v4:
1:  9e95326c58 ! 1:  8c29ad9351 revision: improve commit_rewrite_person()
    @@ Commit message
         Mentored-by: Christian Couder <[e-mail]>
         Mentored-by: John Cai <[e-mail]>
         Helped-by: Đoàn Trần Công Danh <[e-mail]>
    +    Helped-by: Johannes Schindelin <[e-mail]>
         Signed-off-by: Siddharth Asthana <[e-mail]>
     
      ## revision.c ##
    @@ revision.c: int rewrite_parents(struct rev_info *revs, struct commit *commit,
     +/*
     + * Returns the difference between the new and old length of the ident line.
     + */
    -+static ssize_t rewrite_ident_line(const char* person, struct strbuf *buf, struct string_list *mailmap)
    ++static ssize_t rewrite_ident_line(const char *person, struct strbuf *buf,
    ++								  struct string_list *mailmap)
      {
     -	char *person, *endp;
     +	char *endp;
    @@ revision.c: static int commit_rewrite_person(struct strbuf *buf, const char *wha
      	return 0;
      }
      
    -+static void commit_rewrite_person(struct strbuf *buf, const char **headers, struct string_list *mailmap)
    ++static void commit_rewrite_person(struct strbuf *buf, const char **header,
    ++								  struct string_list *mailmap)
     +{
     +	size_t buf_offset = 0;
     +
    @@ revision.c: static int commit_rewrite_person(struct strbuf *buf, const char *wha
     +
     +	for (;;) {
     +		const char *person, *line;
    -+		size_t i, linelen;
    ++		size_t i;
     +
     +		line = buf->buf + buf_offset;
    -+		linelen = strchrnul(line, '\n') - line + 1;
    ++		if (!*line || *line == '\n')
    ++			return; /* End of header */
     +
    -+		if (linelen <= 1)
    -+			/* End of header */
    -+			return;
    ++		for (i = 0; header[i]; i++)
    ++			if (skip_prefix(line, header[i], &person)) {
    ++				rewrite_ident_line(person, buf, mailmap);
    ++				break;
    ++			}
     +
    -+		buf_offset += linelen;
    -+
    -+		for (i = 0; headers[i]; i++)
    -+			if (skip_prefix(line, headers[i], &person))
    -+				buf_offset += rewrite_ident_line(person, buf, mailmap);
    ++		buf_offset = strchrnul(buf->buf + buf_offset, '\n') - buf->buf;
    ++		if (buf->buf[buf_offset] == '\n')
    ++			++buf_offset;
     +	}
     +}
     +
2:  d9395cb8b2 ! 2:  ccb7f72fcb ident: move commit_rewrite_person() to ident.c
    @@ cache.h: struct ident_split {
     + * Given a commit object buffer and the commit headers, replaces the idents
     + * in the headers with their canonical versions using the mailmap mechanism.
     + */
    -+void commit_rewrite_person(struct strbuf *buf, const char **commit_headers, struct string_list *mailmap);
    ++void commit_rewrite_person(struct strbuf *, const char **, struct string_list *);
     +
      /*
       * Compare split idents for equality or strict ordering. Note that we
    @@ ident.c: int split_ident_line(struct ident_split *split, const char *line, int l
     +/*
     + * Returns the difference between the new and old length of the ident line.
     + */
    -+static ssize_t rewrite_ident_line(const char* person, struct strbuf *buf, struct string_list *mailmap)
    ++static ssize_t rewrite_ident_line(const char *person, struct strbuf *buf,
    ++								  struct string_list *mailmap)
     +{
     +	char *endp;
     +	size_t len, namelen, maillen;
    @@ ident.c: int split_ident_line(struct ident_split *split, const char *line, int l
     +	return 0;
     +}
     +
    -+void commit_rewrite_person(struct strbuf *buf, const char **headers, struct string_list *mailmap)
    ++void commit_rewrite_person(struct strbuf *buf, const char **header,
    ++						   struct string_list *mailmap)
     +{
     +	size_t buf_offset = 0;
     +
    @@ ident.c: int split_ident_line(struct ident_split *split, const char *line, int l
     +
     +	for (;;) {
     +		const char *person, *line;
    -+		size_t i, linelen;
    ++		size_t i;
     +
     +		line = buf->buf + buf_offset;
    -+		linelen = strchrnul(line, '\n') - line + 1;
    -+
    -+		if (linelen <= 1)
    -+			/* End of header */
    -+			return;
    -+
    -+		buf_offset += linelen;
    -+
    -+		for (i = 0; headers[i]; i++)
    -+			if (skip_prefix(line, headers[i], &person))
    -+				buf_offset += rewrite_ident_line(person, buf, mailmap);
    ++		if (!*line || *line == '\n')
    ++			return; /* End of header */
    ++
    ++		for (i = 0; header[i]; i++)
    ++			if (skip_prefix(line, header[i], &person)) {
    ++				rewrite_ident_line(person, buf, mailmap);
    ++				break;
    ++			}
    ++
    ++		buf_offset = strchrnul(buf->buf + buf_offset, '\n') - buf->buf;
    ++		if (buf->buf[buf_offset] == '\n')
    ++			++buf_offset;
     +	}
     +}
      
    @@ revision.c: int rewrite_parents(struct rev_info *revs, struct commit *commit,
     -/*
     - * Returns the difference between the new and old length of the ident line.
     - */
    --static ssize_t rewrite_ident_line(const char* person, struct strbuf *buf, struct string_list *mailmap)
    +-static ssize_t rewrite_ident_line(const char *person, struct strbuf *buf,
    +-								  struct string_list *mailmap)
     -{
     -	char *endp;
     -	size_t len, namelen, maillen;
    @@ revision.c: int rewrite_parents(struct rev_info *revs, struct commit *commit,
     -	return 0;
     -}
     -
    --static void commit_rewrite_person(struct strbuf *buf, const char **headers, struct string_list *mailmap)
    +-static void commit_rewrite_person(struct strbuf *buf, const char **header,
    +-								  struct string_list *mailmap)
     -{
     -	size_t buf_offset = 0;
     -
    @@ revision.c: int rewrite_parents(struct rev_info *revs, struct commit *commit,
     -
     -	for (;;) {
     -		const char *person, *line;
    --		size_t i, linelen;
    +-		size_t i;
     -
     -		line = buf->buf + buf_offset;
    --		linelen = strchrnul(line, '\n') - line + 1;
    --
    --		if (linelen <= 1)
    --			/* End of header */
    --			return;
    --
    --		buf_offset += linelen;
    --
    --		for (i = 0; headers[i]; i++)
    --			if (skip_prefix(line, headers[i], &person))
    --				buf_offset += rewrite_ident_line(person, buf, mailmap);
    +-		if (!*line || *line == '\n')
    +-			return; /* End of header */
    +-
    +-		for (i = 0; header[i]; i++)
    +-			if (skip_prefix(line, header[i], &person)) {
    +-				rewrite_ident_line(person, buf, mailmap);
    +-				break;
    +-			}
    +-
    +-		buf_offset = strchrnul(buf->buf + buf_offset, '\n') - buf->buf;
    +-		if (buf->buf[buf_offset] == '\n')
    +-			++buf_offset;
     -	}
     -}
     -
3:  355bbda25e ! 3:  38c18fd10d ident: rename commit_rewrite_person() to apply_mailmap_to_header()
    @@ cache.h: struct ident_split {
     + * Given a commit or tag object buffer and the commit or tag headers, replaces
     + * the idents in the headers with their canonical versions using the mailmap mechanism.
       */
    --void commit_rewrite_person(struct strbuf *buf, const char **commit_headers, struct string_list *mailmap);
    -+void apply_mailmap_to_header(struct strbuf *buf, const char **headers, struct string_list *mailmap);
    +-void commit_rewrite_person(struct strbuf *, const char **, struct string_list *);
    ++void apply_mailmap_to_header(struct strbuf *, const char **, struct string_list *);
      
      /*
       * Compare split idents for equality or strict ordering. Note that we
     
      ## ident.c ##
    -@@ ident.c: static ssize_t rewrite_ident_line(const char* person, struct strbuf *buf, struct
    +@@ ident.c: static ssize_t rewrite_ident_line(const char *person, struct strbuf *buf,
      	return 0;
      }
      
    --void commit_rewrite_person(struct strbuf *buf, const char **headers, struct string_list *mailmap)
    -+void apply_mailmap_to_header(struct strbuf *buf, const char **headers, struct string_list *mailmap)
    +-void commit_rewrite_person(struct strbuf *buf, const char **header,
    +-						   struct string_list *mailmap)
    ++void apply_mailmap_to_header(struct strbuf *buf, const char **header,
    ++							 struct string_list *mailmap)
      {
      	size_t buf_offset = 0;
      
4:  ac532965b4 ! 4:  0a459d4c53 cat-file: add mailmap support
    @@ Commit message
         This patch also introduces new test cases to test the mailmap mechanism in
         git cat-file command.
     
    -    The tests added in this patch series rely on the side effects of the earlier
    -    test case `set up symlink tests`. However, that test case is guarded behind the
    -    `SYMLINKS` prereq, therefore it is not run e.g. on Windows which can cause the
    -    added tests to fail on Windows. So, fix that by removing the prereq from the
    -    `set up` test case, and adjusting its title to reflect its broadened responsibility.
    -
         Mentored-by: Christian Couder <[e-mail]>
         Mentored-by: John Cai <[e-mail]>
         Helped-by: Phillip Wood <[e-mail]>
    @@ builtin/cat-file.c: int cmd_cat_file(int argc, const char **argv, const char *pr
      		batch.all_objects = 1;
     
      ## t/t4203-mailmap.sh ##
    -@@ t/t4203-mailmap.sh: test_expect_success 'find top-level mailmap from subdir' '
    - 	test_cmp expect actual
    - '
    - 
    --test_expect_success SYMLINKS 'set up symlink tests' '
    -+test_expect_success 'prepare for symlink/--use-mailmap tests' '
    - 	git commit --allow-empty -m foo --author="Orig <[e-mail]>" &&
    - 	echo "New <[e-mail]> <[e-mail]>" >map &&
    - 	rm -f .mailmap
     @@ t/t4203-mailmap.sh: test_expect_success SYMLINKS 'symlinks not respected in-tree' '
      	test_cmp expect actual
      '
      
    ++test_expect_success 'prepare for cat-file --mailmap' '
    ++	rm -f .mailmap &&
    ++	git commit --allow-empty -m foo --author="Orig <[e-mail]>"
    ++'
    ++
     +test_expect_success '--no-use-mailmap disables mailmap in cat-file' '
     +	test_when_finished "rm .mailmap" &&
     +	cat >.mailmap <<-EOF &&