filter-branch: preserve and restore $GIT_AUTHOR_* and $GIT_COMMITTER_*
[git/git.git] / git-filter-branch.sh
CommitLineData
6f6826c5
JS
1#!/bin/sh
2#
3# Rewrite revision history
4# Copyright (c) Petr Baudis, 2006
5# Minimal changes to "port" it to core-git (c) Johannes Schindelin, 2007
6#
c401b33c
JS
7# Lets you rewrite the revision history of the current branch, creating
8# a new branch. You can specify a number of filters to modify the commits,
9# files and trees.
6f6826c5 10
16ed34ad
JS
11# The following functions will also be available in the commit filter:
12
13functions=$(cat << \EOF
b5669a05 14warn () {
285c6cbf 15 echo "$*" >&2
b5669a05
SP
16}
17
6f6826c5
JS
18map()
19{
3520e1e8 20 # if it was not rewritten, take the original
c57a3494
JS
21 if test -r "$workdir/../map/$1"
22 then
23 cat "$workdir/../map/$1"
24 else
25 echo "$1"
26 fi
6f6826c5
JS
27}
28
f95eef15
JS
29# if you run 'skip_commit "$@"' in a commit filter, it will print
30# the (mapped) parents, effectively skipping the commit.
31
32skip_commit()
33{
34 shift;
35 while [ -n "$1" ];
36 do
37 shift;
38 map "$1";
39 shift;
40 done;
41}
42
d3240d93
PH
43# if you run 'git_commit_non_empty_tree "$@"' in a commit filter,
44# it will skip commits that leave the tree untouched, commit the other.
45git_commit_non_empty_tree()
46{
47 if test $# = 3 && test "$1" = $(git rev-parse "$3^{tree}"); then
48 map "$3"
a582a82d
DP
49 elif test $# = 1 && test "$1" = 4b825dc642cb6eb9a060e54bf8d69288fbee4904; then
50 :
d3240d93
PH
51 else
52 git commit-tree "$@"
53 fi
54}
8c1ce0f4
JS
55# override die(): this version puts in an extra line break, so that
56# the progress is still visible
57
58die()
59{
60 echo >&2
61 echo "$*" >&2
62 exit 1
63}
16ed34ad
JS
64EOF
65)
66
67eval "$functions"
8c1ce0f4 68
3c730fab
JK
69finish_ident() {
70 # Ensure non-empty id name.
71 echo "case \"\$GIT_$1_NAME\" in \"\") GIT_$1_NAME=\"\${GIT_$1_EMAIL%%@*}\" && export GIT_$1_NAME;; esac"
72 # And make sure everything is exported.
73 echo "export GIT_$1_NAME"
74 echo "export GIT_$1_EMAIL"
75 echo "export GIT_$1_DATE"
76}
6f6826c5
JS
77
78set_ident () {
3c730fab
JK
79 parse_ident_from_commit author AUTHOR committer COMMITTER
80 finish_ident AUTHOR
81 finish_ident COMMITTER
6f6826c5
JS
82}
83
3b117f73
AH
84USAGE="[--setup <command>] [--env-filter <command>]
85 [--tree-filter <command>] [--index-filter <command>]
86 [--parent-filter <command>] [--msg-filter <command>]
87 [--commit-filter <command>] [--tag-name-filter <command>]
88 [--subdirectory-filter <directory>] [--original <namespace>]
89 [-d <directory>] [-f | --force]
d612975e 90 [--] [<rev-list options>...]"
7e0f1704 91
8f321a39 92OPTIONS_SPEC=
7e0f1704
JS
93. git-sh-setup
94
a4661b01 95if [ "$(is_bare_repository)" = false ]; then
5347a50f 96 require_clean_work_tree 'rewrite branches'
a4661b01 97fi
46eb449c 98
6f6826c5 99tempdir=.git-rewrite
3b117f73 100filter_setup=
6f6826c5
JS
101filter_env=
102filter_tree=
103filter_index=
104filter_parent=
105filter_msg=cat
d3240d93 106filter_commit=
6f6826c5 107filter_tag_name=
685ef546 108filter_subdir=
dfd05e38
JS
109orig_namespace=refs/original/
110force=
d3240d93 111prune_empty=
f2f3a6b8 112remap_to_ancestor=
822f7c73 113while :
6f6826c5
JS
114do
115 case "$1" in
116 --)
117 shift
118 break
119 ;;
dfd05e38
JS
120 --force|-f)
121 shift
122 force=t
123 continue
124 ;;
f2f3a6b8 125 --remap-to-ancestor)
7ec344d8 126 # deprecated ($remap_to_ancestor is set now automatically)
f2f3a6b8
TR
127 shift
128 remap_to_ancestor=t
129 continue
130 ;;
d3240d93
PH
131 --prune-empty)
132 shift
133 prune_empty=t
134 continue
135 ;;
6f6826c5
JS
136 -*)
137 ;;
138 *)
139 break;
140 esac
141
142 # all switches take one argument
143 ARG="$1"
144 case "$#" in 1) usage ;; esac
145 shift
146 OPTARG="$1"
147 shift
148
149 case "$ARG" in
150 -d)
151 tempdir="$OPTARG"
152 ;;
3b117f73
AH
153 --setup)
154 filter_setup="$OPTARG"
155 ;;
6f6826c5
JS
156 --env-filter)
157 filter_env="$OPTARG"
158 ;;
159 --tree-filter)
160 filter_tree="$OPTARG"
161 ;;
162 --index-filter)
163 filter_index="$OPTARG"
164 ;;
165 --parent-filter)
166 filter_parent="$OPTARG"
167 ;;
168 --msg-filter)
169 filter_msg="$OPTARG"
170 ;;
171 --commit-filter)
16ed34ad 172 filter_commit="$functions; $OPTARG"
6f6826c5
JS
173 ;;
174 --tag-name-filter)
175 filter_tag_name="$OPTARG"
176 ;;
685ef546
JS
177 --subdirectory-filter)
178 filter_subdir="$OPTARG"
f2f3a6b8 179 remap_to_ancestor=t
685ef546 180 ;;
dfd05e38 181 --original)
55ced83d 182 orig_namespace=$(expr "$OPTARG/" : '\(.*[^/]\)/*$')/
dfd05e38 183 ;;
6f6826c5
JS
184 *)
185 usage
186 ;;
187 esac
188done
189
d3240d93
PH
190case "$prune_empty,$filter_commit" in
191,)
192 filter_commit='git commit-tree "$@"';;
193t,)
194 filter_commit="$functions;"' git_commit_non_empty_tree "$@"';;
195,*)
196 ;;
197*)
5da81713 198 die "Cannot set --prune-empty and --commit-filter at the same time"
d3240d93
PH
199esac
200
dfd05e38
JS
201case "$force" in
202t)
203 rm -rf "$tempdir"
204;;
205'')
206 test -d "$tempdir" &&
207 die "$tempdir already exists, please remove it"
208esac
97276019 209orig_dir=$(pwd)
af580e9c 210mkdir -p "$tempdir/t" &&
dfd05e38 211tempdir="$(cd "$tempdir"; pwd)" &&
af580e9c
JS
212cd "$tempdir/t" &&
213workdir="$(pwd)" ||
214die ""
6f6826c5 215
def16e71 216# Remove tempdir on exit
97276019 217trap 'cd "$orig_dir"; rm -rf "$tempdir"' 0
def16e71 218
88e38808
LN
219ORIG_GIT_DIR="$GIT_DIR"
220ORIG_GIT_WORK_TREE="$GIT_WORK_TREE"
221ORIG_GIT_INDEX_FILE="$GIT_INDEX_FILE"
7b1378bd
IC
222ORIG_GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME"
223ORIG_GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL"
224ORIG_GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE"
225ORIG_GIT_COMMITTER_NAME="$GIT_COMMITTER_NAME"
226ORIG_GIT_COMMITTER_EMAIL="$GIT_COMMITTER_EMAIL"
227ORIG_GIT_COMMITTER_DATE="$GIT_COMMITTER_DATE"
228
88e38808
LN
229GIT_WORK_TREE=.
230export GIT_DIR GIT_WORK_TREE
231
dfd05e38 232# Make sure refs/original is empty
0ea29cce 233git for-each-ref > "$tempdir"/backup-refs || exit
dfd05e38
JS
234while read sha1 type name
235do
236 case "$force,$name" in
237 ,$orig_namespace*)
734cd572
JT
238 die "Cannot create a new backup.
239A previous backup already exists in $orig_namespace
240Force overwriting the backup with -f"
dfd05e38
JS
241 ;;
242 t,$orig_namespace*)
243 git update-ref -d "$name" $sha1
244 ;;
245 esac
246done < "$tempdir"/backup-refs
247
418fa3a5 248# The refs should be updated if their heads were rewritten
0ea29cce
EK
249git rev-parse --no-flags --revs-only --symbolic-full-name \
250 --default HEAD "$@" > "$tempdir"/raw-heads || exit
251sed -e '/^^/d' "$tempdir"/raw-heads >"$tempdir"/heads
dfd05e38
JS
252
253test -s "$tempdir"/heads ||
69638939 254 die "You must specify a ref to rewrite."
dfd05e38 255
3addc94a
JS
256GIT_INDEX_FILE="$(pwd)/../index"
257export GIT_INDEX_FILE
6f6826c5 258
af580e9c
JS
259# map old->new commit ids for rewriting parents
260mkdir ../map || die "Could not create map/ directory"
6f6826c5 261
2c1d2d81
TR
262# we need "--" only if there are no path arguments in $@
263nonrevs=$(git rev-parse --no-revs "$@") || exit
7ec344d8
CH
264if test -z "$nonrevs"
265then
266 dashdash=--
267else
268 dashdash=
269 remap_to_ancestor=t
270fi
271
3361a548 272git rev-parse --revs-only "$@" >../parse
2c1d2d81 273
685ef546
JS
274case "$filter_subdir" in
275"")
2c1d2d81 276 eval set -- "$(git rev-parse --sq --no-revs "$@")"
685ef546
JS
277 ;;
278*)
2c1d2d81
TR
279 eval set -- "$(git rev-parse --sq --no-revs "$@" $dashdash \
280 "$filter_subdir")"
281 ;;
282esac
283
284git rev-list --reverse --topo-order --default HEAD \
3361a548 285 --parents --simplify-merges --stdin "$@" <../parse >../revs ||
2c1d2d81 286 die "Could not get the commits"
9d6f220c 287commits=$(wc -l <../revs | tr -d " ")
6f6826c5
JS
288
289test $commits -eq 0 && die "Found nothing to rewrite"
290
dfd05e38 291# Rewrite the commits
6a9d16a0
GB
292report_progress ()
293{
294 if test -n "$progress" &&
295 test $git_filter_branch__commit_count -gt $next_sample_at
296 then
71400d97
JH
297 count=$git_filter_branch__commit_count
298
299 now=$(date +%s)
300 elapsed=$(($now - $start_timestamp))
301 remaining=$(( ($commits - $count) * $elapsed / $count ))
302 if test $elapsed -gt 0
6a9d16a0 303 then
71400d97 304 next_sample_at=$(( ($elapsed + 1) * $count / $elapsed ))
6a9d16a0
GB
305 else
306 next_sample_at=$(($next_sample_at + 1))
307 fi
71400d97 308 progress=" ($elapsed seconds passed, remaining $remaining predicted)"
6a9d16a0 309 fi
71400d97 310 printf "\rRewrite $commit ($count/$commits)$progress "
6a9d16a0 311}
dfd05e38 312
d5b0c97d 313git_filter_branch__commit_count=0
6a9d16a0
GB
314
315progress= start_timestamp=
316if date '+%s' 2>/dev/null | grep -q '^[0-9][0-9]*$'
317then
318 next_sample_at=0
319 progress="dummy to ensure this is not empty"
320 start_timestamp=$(date '+%s')
321fi
322
348d4f2f
JK
323if test -n "$filter_index" ||
324 test -n "$filter_tree" ||
325 test -n "$filter_subdir"
326then
327 need_index=t
328else
329 need_index=
330fi
331
3b117f73
AH
332eval "$filter_setup" < /dev/null ||
333 die "filter setup failed: $filter_setup"
334
813b4734 335while read commit parents; do
d5b0c97d 336 git_filter_branch__commit_count=$(($git_filter_branch__commit_count+1))
6a9d16a0
GB
337
338 report_progress
6f6826c5 339
685ef546
JS
340 case "$filter_subdir" in
341 "")
348d4f2f
JK
342 if test -n "$need_index"
343 then
344 GIT_ALLOW_NULL_SHA1=1 git read-tree -i -m $commit
345 fi
685ef546
JS
346 ;;
347 *)
5b044ac3 348 # The commit may not have the subdirectory at all
83bd7437
JK
349 err=$(GIT_ALLOW_NULL_SHA1=1 \
350 git read-tree -i -m $commit:"$filter_subdir" 2>&1) || {
d69da76d 351 if ! git rev-parse -q --verify $commit:"$filter_subdir"
5b044ac3
JH
352 then
353 rm -f "$GIT_INDEX_FILE"
354 else
355 echo >&2 "$err"
356 false
357 fi
358 }
af580e9c 359 esac || die "Could not initialize the index"
6f6826c5 360
3addc94a
JS
361 GIT_COMMIT=$commit
362 export GIT_COMMIT
af580e9c
JS
363 git cat-file commit "$commit" >../commit ||
364 die "Cannot read commit $commit"
6f6826c5 365
3c730fab
JK
366 eval "$(set_ident <../commit)" ||
367 die "setting author/committer failed for commit $commit"
8c1ce0f4
JS
368 eval "$filter_env" < /dev/null ||
369 die "env filter failed: $filter_env"
6f6826c5
JS
370
371 if [ "$filter_tree" ]; then
af580e9c
JS
372 git checkout-index -f -u -a ||
373 die "Could not checkout the index"
6f6826c5
JS
374 # files that $commit removed are now still in the working tree;
375 # remove them, else they would be added again
6a589fda 376 git clean -d -q -f -x
8c1ce0f4
JS
377 eval "$filter_tree" < /dev/null ||
378 die "tree filter failed: $filter_tree"
379
1fe32cb9 380 (
4d2a3646 381 git diff-index -r --name-only --ignore-submodules $commit -- &&
1fe32cb9 382 git ls-files --others
0ea29cce
EK
383 ) > "$tempdir"/tree-state || exit
384 git update-index --add --replace --remove --stdin \
385 < "$tempdir"/tree-state || exit
6f6826c5
JS
386 fi
387
8c1ce0f4
JS
388 eval "$filter_index" < /dev/null ||
389 die "index filter failed: $filter_index"
6f6826c5
JS
390
391 parentstr=
813b4734 392 for parent in $parents; do
3520e1e8 393 for reparent in $(map "$parent"); do
79bc4ef3
CB
394 case "$parentstr " in
395 *" -p $reparent "*)
396 ;;
397 *)
398 parentstr="$parentstr -p $reparent"
399 ;;
400 esac
3520e1e8 401 done
6f6826c5
JS
402 done
403 if [ "$filter_parent" ]; then
8c1ce0f4
JS
404 parentstr="$(echo "$parentstr" | eval "$filter_parent")" ||
405 die "parent filter failed: $filter_parent"
6f6826c5
JS
406 fi
407
df062010 408 {
a5a4b3ff 409 while IFS='' read -r header_line && test -n "$header_line"
df062010
JK
410 do
411 # skip header lines...
412 :;
413 done
414 # and output the actual commit message
415 cat
416 } <../commit |
8c1ce0f4
JS
417 eval "$filter_msg" > ../message ||
418 die "msg filter failed: $filter_msg"
348d4f2f
JK
419
420 if test -n "$need_index"
421 then
422 tree=$(git write-tree)
423 else
1dc413eb 424 tree=$(git rev-parse "$commit^{tree}")
348d4f2f 425 fi
0906f6e1 426 workdir=$workdir @SHELL_PATH@ -c "$filter_commit" "git commit-tree" \
348d4f2f 427 "$tree" $parentstr < ../message > ../map/$commit ||
0ea29cce 428 die "could not write rewritten commit"
6f6826c5
JS
429done <../revs
430
f2f3a6b8
TR
431# If we are filtering for paths, as in the case of a subdirectory
432# filter, it is possible that a specified head is not in the set of
433# rewritten commits, because it was pruned by the revision walker.
434# Ancestor remapping fixes this by mapping these heads to the unique
435# nearest ancestor that survived the pruning.
dfd05e38 436
f2f3a6b8 437if test "$remap_to_ancestor" = t
a0e46390
TR
438then
439 while read ref
dfd05e38 440 do
a0e46390
TR
441 sha1=$(git rev-parse "$ref"^0)
442 test -f "$workdir"/../map/$sha1 && continue
2c1d2d81 443 ancestor=$(git rev-list --simplify-merges -1 "$ref" "$@")
a0e46390
TR
444 test "$ancestor" && echo $(map $ancestor) >> "$workdir"/../map/$sha1
445 done < "$tempdir"/heads
446fi
dfd05e38
JS
447
448# Finally update the refs
449
450_x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
451_x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
dfd05e38
JS
452echo
453while read ref
454do
455 # avoid rewriting a ref twice
456 test -f "$orig_namespace$ref" && continue
457
458 sha1=$(git rev-parse "$ref"^0)
459 rewritten=$(map $sha1)
460
461 test $sha1 = "$rewritten" &&
462 warn "WARNING: Ref '$ref' is unchanged" &&
463 continue
464
465 case "$rewritten" in
466 '')
467 echo "Ref '$ref' was deleted"
468 git update-ref -m "filter-branch: delete" -d "$ref" $sha1 ||
469 die "Could not delete $ref"
98409060 470 ;;
dfd05e38
JS
471 $_x40)
472 echo "Ref '$ref' was rewritten"
261044e8
TR
473 if ! git update-ref -m "filter-branch: rewrite" \
474 "$ref" $rewritten $sha1 2>/dev/null; then
475 if test $(git cat-file -t "$ref") = tag; then
476 if test -z "$filter_tag_name"; then
477 warn "WARNING: You said to rewrite tagged commits, but not the corresponding tag."
478 warn "WARNING: Perhaps use '--tag-name-filter cat' to rewrite the tag."
479 fi
480 else
481 die "Could not rewrite $ref"
482 fi
483 fi
98409060 484 ;;
dfd05e38
JS
485 *)
486 # NEEDSWORK: possibly add -Werror, making this an error
487 warn "WARNING: '$ref' was rewritten into multiple commits:"
488 warn "$rewritten"
489 warn "WARNING: Ref '$ref' points to the first one now."
490 rewritten=$(echo "$rewritten" | head -n 1)
491 git update-ref -m "filter-branch: rewrite to first" \
492 "$ref" $rewritten $sha1 ||
493 die "Could not rewrite $ref"
494 ;;
495 esac
0ea29cce
EK
496 git update-ref -m "filter-branch: backup" "$orig_namespace$ref" $sha1 ||
497 exit
dfd05e38
JS
498done < "$tempdir"/heads
499
500# TODO: This should possibly go, with the semantics that all positive given
501# refs are updated, and their original heads stored in refs/original/
502# Filter tags
6f6826c5
JS
503
504if [ "$filter_tag_name" ]; then
5be60078 505 git for-each-ref --format='%(objectname) %(objecttype) %(refname)' refs/tags |
6f6826c5
JS
506 while read sha1 type ref; do
507 ref="${ref#refs/tags/}"
508 # XXX: Rewrite tagged trees as well?
509 if [ "$type" != "commit" -a "$type" != "tag" ]; then
510 continue;
511 fi
512
513 if [ "$type" = "tag" ]; then
514 # Dereference to a commit
515 sha1t="$sha1"
7bd93c1c 516 sha1="$(git rev-parse -q "$sha1"^{commit})" || continue
6f6826c5
JS
517 fi
518
519 [ -f "../map/$sha1" ] || continue
520 new_sha1="$(cat "../map/$sha1")"
3addc94a
JS
521 GIT_COMMIT="$sha1"
522 export GIT_COMMIT
8c1ce0f4
JS
523 new_ref="$(echo "$ref" | eval "$filter_tag_name")" ||
524 die "tag name filter failed: $filter_tag_name"
6f6826c5
JS
525
526 echo "$ref -> $new_ref ($sha1 -> $new_sha1)"
527
528 if [ "$type" = "tag" ]; then
a9da1663
JS
529 new_sha1=$( ( printf 'object %s\ntype commit\ntag %s\n' \
530 "$new_sha1" "$new_ref"
531 git cat-file tag "$ref" |
1bf6551e 532 sed -n \
9524cf29 533 -e '1,/^$/{
a9da1663
JS
534 /^object /d
535 /^type /d
536 /^tag /d
9524cf29 537 }' \
1bf6551e 538 -e '/^-----BEGIN PGP SIGNATURE-----/q' \
a9da1663 539 -e 'p' ) |
1bf6551e
BC
540 git mktag) ||
541 die "Could not create new tag object for $ref"
542 if git cat-file tag "$ref" | \
e1622bfc 543 sane_grep '^-----BEGIN PGP SIGNATURE-----' >/dev/null 2>&1
1bf6551e
BC
544 then
545 warn "gpg signature stripped from tag object $sha1t"
546 fi
6f6826c5
JS
547 fi
548
af580e9c
JS
549 git update-ref "refs/tags/$new_ref" "$new_sha1" ||
550 die "Could not write tag $new_ref"
6f6826c5
JS
551 done
552fi
553
9273b562 554unset GIT_DIR GIT_WORK_TREE GIT_INDEX_FILE
7b1378bd
IC
555unset GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE
556unset GIT_COMMITTER_NAME GIT_COMMITTER_EMAIL GIT_COMMITTER_DATE
9273b562
EK
557test -z "$ORIG_GIT_DIR" || {
558 GIT_DIR="$ORIG_GIT_DIR" && export GIT_DIR
559}
560test -z "$ORIG_GIT_WORK_TREE" || {
561 GIT_WORK_TREE="$ORIG_GIT_WORK_TREE" &&
562 export GIT_WORK_TREE
563}
564test -z "$ORIG_GIT_INDEX_FILE" || {
565 GIT_INDEX_FILE="$ORIG_GIT_INDEX_FILE" &&
566 export GIT_INDEX_FILE
567}
7b1378bd
IC
568test -z "$ORIG_GIT_AUTHOR_NAME" || {
569 GIT_AUTHOR_NAME="$ORIG_GIT_AUTHOR_NAME" &&
570 export GIT_AUTHOR_NAME
571}
572test -z "$ORIG_GIT_AUTHOR_EMAIL" || {
573 GIT_AUTHOR_EMAIL="$ORIG_GIT_AUTHOR_EMAIL" &&
574 export GIT_AUTHOR_EMAIL
575}
576test -z "$ORIG_GIT_AUTHOR_DATE" || {
577 GIT_AUTHOR_DATE="$ORIG_GIT_AUTHOR_DATE" &&
578 export GIT_AUTHOR_DATE
579}
580test -z "$ORIG_GIT_COMMITTER_NAME" || {
581 GIT_COMMITTER_NAME="$ORIG_GIT_COMMITTER_NAME" &&
582 export GIT_COMMITTER_NAME
583}
584test -z "$ORIG_GIT_COMMITTER_EMAIL" || {
585 GIT_COMMITTER_EMAIL="$ORIG_GIT_COMMITTER_EMAIL" &&
586 export GIT_COMMITTER_EMAIL
587}
588test -z "$ORIG_GIT_COMMITTER_DATE" || {
589 GIT_COMMITTER_DATE="$ORIG_GIT_COMMITTER_DATE" &&
590 export GIT_COMMITTER_DATE
591}
9273b562 592
d24813c4
IC
593cd "$orig_dir"
594rm -rf "$tempdir"
595
596trap - 0
597
a4661b01 598if [ "$(is_bare_repository)" = false ]; then
0ea29cce 599 git read-tree -u -m HEAD || exit
a4661b01 600fi
46eb449c 601
0ea29cce 602exit 0