guilt

   1 #!/bin/sh
   2 #
   3 # Copyright (c) Josef "Jeff" Sipek, 2006, 2007
   4 #
   5
   6 GUILT_VERSION="0.28"
   7 GUILT_NAME="Voodoo"
   8
   9 # If the first argument is one of the below, display the man page instead of
  10 # the rather silly and mostly useless usage string
  11 case $1 in
  12         -h|--h|--he|--hel|--help)
  13         shift
  14         exec "guilt-help" "`basename $0`"
  15         exit
  16         ;;
  17         -V|--ver|--versi|--versio|--version)
  18         echo "Guilt version $GUILT_VERSION"
  19         exit
  20         ;;
  21 esac
  22
  23 # we change directories ourselves
  24 SUBDIRECTORY_OK=1
  25
  26 . git-sh-setup
  27
  28 #
  29 # Git version check
  30 #
  31 gitver=`git --version | cut -d' ' -f3`
  32 case "$gitver" in
  33         1.5.*)  ;; # git-config
  34         *)      die "Unsupported version of git ($gitver)" ;;
  35 esac
  36
  37 #
  38 # Shell library
  39 #
  40
  41 # echo -e is a bashism, fallback to /bin/echo if the builtin does not supports it
  42 echo()
  43 {
  44         /bin/echo "$@"
  45 }
  46
  47 noerr()
  48 {
  49         "$@" 2>/dev/null
  50 }
  51
  52 silent()
  53 {
  54         "$@" >/dev/null 2>/dev/null
  55 }
  56
  57 ########
  58
  59 guilt_commands()
  60 {
  61         find "`dirname $0`" -maxdepth 1 -name "guilt-*" -type f -perm /111 | sed -e "s/.*\\/`basename $0`-//"
  62 }
  63
  64 if [ "`basename $0`" = "guilt" ]; then
  65         # being run as standalone
  66
  67         # by default, we shouldn't fail
  68         cmd=
  69
  70         if [ $# -ne 0 ]; then
  71                 # take first arg, and try to execute it
  72
  73                 arg="$1"
  74                 dir=`dirname $0`
  75
  76                 if [ -x "$dir/guilt-$arg" ]; then
  77                         cmd=$arg
  78                 else
  79                         # might be a short handed
  80                         for command in $(guilt_commands); do
  81                                 case $command in
  82                                 $arg*)
  83                                         if [ -x "$dir/guilt-$command" ]; then
  84                                                 cmd=$command
  85                                         fi
  86                                         ;;
  87                                 esac
  88                         done
  89                 fi
  90                 if [ -n "$cmd" ]; then
  91                         shift
  92                         exec "$dir/guilt-$cmd" "$@"
  93
  94                         # this is not reached because of the exec
  95                         die "Exec failed! Something is terribly wrong!"
  96                 else
  97                         echo "Command $arg not found" >&2
  98                         echo "" >&2
  99                 fi
 100         fi
 101
 102         # no args passed or invalid command entered, just output help summary
 103
 104         echo "Guilt v$GUILT_VERSION"
 105         echo ""
 106         echo "Pick a command:"
 107         guilt_commands | sort | column | column -t | sed -e 's/^/\t/'
 108
 109         echo ""
 110         echo "Example:"
 111         echo -e "\tguilt-push"
 112         echo "or"
 113         echo -e "\tguilt push"
 114
 115         # now, let's exit
 116         exit 1
 117 fi
 118
 119 ########
 120
 121 #
 122 # Library goodies
 123 #
 124
 125 # usage: valid_patchname <patchname>
 126 valid_patchname()
 127 {
 128         case "$1" in
 129                 /*|./*|../*|*/./*|*/../*|*/.|*/..|*/)
 130                         return 1;;
 131                 *)
 132                         return 0;;
 133         esac
 134 }
 135
 136 get_branch()
 137 {
 138         git-symbolic-ref HEAD | sed -e 's,^refs/heads/,,'
 139 }
 140
 141 verify_branch()
 142 {
 143         [ ! -d "$GIT_DIR/patches" ] &&
 144                 echo "Patches directory doesn't exist, try guilt-init" >&2 &&
 145                 return 1
 146         [ ! -d "$GIT_DIR/patches/$branch" ] &&
 147                 echo "Branch $branch is not initialized, try guilt-init" >&2 &&
 148                 return 1
 149         [ ! -f "$GIT_DIR/patches/$branch/series" ] &&
 150                 echo "Branch $branch does not have a series file" >&2 &&
 151                 return 1
 152         [ ! -f "$GIT_DIR/patches/$branch/status" ] &&
 153                 echo "Branch $branch does not have a status file" >&2 &&
 154                 return 1
 155         [ -f "$GIT_DIR/patches/$branch/applied" ] &&
 156                 echo "Warning: Branch $branch has 'applied' file - guilt is not compatible with stgit" >&2 &&
 157                 return 1
 158
 159         return 0
 160 }
 161
 162 get_top()
 163 {
 164         tail -1 "$GUILT_DIR/$branch/status" | cut -d: -f 2-
 165 }
 166
 167 get_prev()
 168 {
 169         if [ `wc -l < "$GUILT_DIR/$branch/status"` -gt 1 ]; then
 170                 tail -n 2 "$GUILT_DIR/$branch/status" | head -n 1
 171         fi
 172 }
 173
 174 get_series()
 175 {
 176         # ignore all lines matching:
 177         #       - empty lines
 178         #       - whitespace only
 179         #       - optional whitespace followed by '#' followed by more
 180         #         optional whitespace
 181         grep -ve '^[[:space:]]*\(#.*\)*$' "$series"
 182 }
 183
 184 # usage: do_make_header <hash>
 185 do_make_header()
 186 {
 187         # we should try to work with commit objects only
 188         if [ `git-cat-file -t "$1"` != "commit" ]; then
 189                 echo "Hash $1 is not a commit object" >&2
 190                 echo "Aborting..." >&2
 191                 exit 2
 192         fi
 193
 194         git-cat-file -p "$1" | awk '
 195                 BEGIN{headers=1; firstline=1}
 196                 /^author / && headers {
 197                         sub(/^author +/, "");
 198                         sub(/ [0-9]* [+-]*[0-9][0-9]*$/, "");
 199                         author=$0
 200                 }
 201                 !headers {
 202                         print
 203                         if (firstline) {
 204                                 firstline = 0;
 205                                 print "\nFrom: " author;
 206                         }
 207                 }
 208                 /^$/ && headers { headers = 0 }
 209         '
 210 }
 211
 212 # usage: do_get_patch patchfile
 213 do_get_patch()
 214 {
 215         cat "$1" | awk '
 216 BEGIN{}
 217 /^(diff |---)/,/END{}/
 218 '
 219 }
 220
 221 # usage: do_get_header patchfile
 222 do_get_header()
 223 {
 224         # The complexity arises from the fact that we want to ignore the
 225         # From line and the empty line after it if it exists
 226
 227         # 2nd line skips the From line
 228         # 3rd line skips the empty line right after a From line
 229         # 4th line terminates execution when we encounter the diff
 230         cat "$1" | awk '
 231 BEGIN{skip=0}
 232 /^Subject:/ && (NR==1){print substr($0, 10); next}
 233 /^From:/{skip=1; next}
 234 /^[ \t\f\n\r\v]*$/ && (skip==1){skip=0; next}
 235 /^(diff |---)/{exit}
 236 {print $0}
 237 END{}
 238 '
 239 }
 240
 241 # usage: do_get_full_header patchfile
 242 do_get_full_header()
 243 {
 244         # 2nd line checks for the begining of a patch
 245         # 3rd line outputs the line if it didn't get pruned by the above rules
 246         cat "$1" | awk '
 247 BEGIN{}
 248 /^(diff |---)/{exit}
 249 {print $0}
 250 END{}
 251 '
 252 }
 253
 254 # usage: assert_head_check
 255 assert_head_check()
 256 {
 257         if ! head_check "`tail -1 < "$applied" | cut -d: -f 1`"; then
 258                 die "aborting..."
 259         fi
 260 }
 261
 262 # usage: head_check <expected hash>
 263 head_check()
 264 {
 265         # make sure we're not doing funky things to commits that don't
 266         # belong to us
 267         # if the expected hash is empty, just return
 268         [ -z "$1" ] && return 0
 269
 270         if [ "`git show-ref -s "refs/heads/$branch"`" != "$1" ]; then
 271                 echo "Expected HEAD commit $1" >&2
 272                 echo "                 got `cat "$GIT_DIR/refs/heads/$branch"`" >&2
 273                 return 1
 274         fi
 275         return 0
 276 }
 277
 278 # usage: series_insert_patch <patchname>
 279 series_insert_patch()
 280 {
 281         awk -v top="`get_top`" -v new="$1" \
 282                 'BEGIN{if (top == "") print new;}
 283                 {
 284                         print $0;
 285                         if (top != "" && top == $0) print new;
 286                 }' "$series" > "$series.tmp"
 287         mv "$series.tmp" "$series"
 288 }
 289
 290 # usage: series_remove_patch <patchname>
 291 series_remove_patch()
 292 {
 293         grep -v "^$1\$" < "$series" > "$series.tmp"
 294         mv "$series.tmp" "$series"
 295 }
 296
 297 # usage: series_rename_patch <oldname> <newname>
 298 series_rename_patch()
 299 {
 300         awk -v old="$1" -v new="$2" \
 301                 '{ if ($0 == old) print new; else print $0 }' \
 302                 "$series" > "$series.tmp"
 303
 304         mv "$series.tmp" "$series"
 305 }
 306
 307 # Beware! This is one of the few (only?) places where we modify the applied
 308 # file directly
 309 #
 310 # usage: applied_rename_patch <oldname> <newname>
 311 applied_rename_patch()
 312 {
 313         awk -v old="$1" -v new="$2" \
 314                         'BEGIN{FS=":"}
 315                         { if ($1 ~ /^[0-9a-f]*$/ && length($1) == 40 && substr($0, 42) == old)
 316                                 print substr($0, 0, 41) new;
 317                         else
 318                                 print;
 319                         }' "$applied" > "$applied.tmp"
 320
 321         mv "$applied.tmp" "$applied"
 322 }
 323
 324 # usage: pop_many_patches <commitish> <number of patches>
 325 pop_many_patches()
 326 {
 327         assert_head_check
 328
 329         (
 330                 cd "$TOP_DIR"
 331
 332                 git-reset --hard "$1" > /dev/null
 333                 head -n "-$2" < "$applied" > "$applied.tmp"
 334                 mv "$applied.tmp" "$applied"
 335         )
 336
 337         # update references to top, bottom, and base
 338         update_stack_tags
 339 }
 340
 341 # usage: pop_all_patches
 342 pop_all_patches()
 343 {
 344         pop_many_patches \
 345                 `head -1 "$applied" | cut -d: -f1`^ \
 346                 `wc -l < "$applied"`
 347 }
 348
 349 # usage: update_stack_tags
 350 update_stack_tags()
 351 {
 352         # bail if autotagging is not enabled
 353         if [ $autotag -eq 0 ]; then
 354                 return 0
 355         fi
 356
 357         if [ -s "$applied" ]; then
 358                 # there are patches applied, therefore we must get the top,
 359                 # bottom and base hashes, and update the tags
 360
 361                 mkdir -p `dirname "$GIT_DIR/refs/tags/${branch}_top"`
 362                 git-rev-parse HEAD > "$GIT_DIR/refs/tags/${branch}_top"
 363                 head -1 < $applied | cut -d: -f1 > "$GIT_DIR/refs/tags/${branch}_bottom"
 364                 git-rev-parse $(head -1 < $applied | cut -d: -f1)^ > "$GIT_DIR/refs/tags/${branch}_base"
 365         else
 366                 # there are no patches applied, therefore we must remove the
 367                 # tags to old top, bottom, and base
 368
 369                 rm -f "$GIT_DIR/refs/tags/${branch}_top"
 370                 rm -f "$GIT_DIR/refs/tags/${branch}_bottom"
 371                 rm -f "$GIT_DIR/refs/tags/${branch}_base"
 372         fi
 373 }
 374
 375 # usage: push_patch patchname [bail_action]
 376 push_patch()
 377 {
 378         __push_patch_bail=0
 379
 380         (
 381                 TMP_LOG=`get_tmp_file log`
 382                 TMP_MSG=`get_tmp_file msg`
 383
 384                 p="$GUILT_DIR/$branch/$1"
 385                 pname="$1"
 386                 bail_action="$2"
 387                 reject="--reject"
 388
 389                 assert_head_check
 390                 cd "$TOP_DIR"
 391
 392                 # apply the patch if and only if there is something to apply
 393                 if [ `git-apply --numstat "$p" | wc -l` -gt 0 ]; then
 394                         if [ "$bail_action" = abort ]; then
 395                                 reject=""
 396                         fi
 397                         git-apply -C$guilt_push_diff_context --index \
 398                                 $reject "$p" > /dev/null 2> "$TMP_LOG"
 399                         __push_patch_bail=$?
 400
 401                         if [ $__push_patch_bail -ne 0 ]; then
 402                                 cat "$TMP_LOG" >&2
 403                                 if [ "$bail_action" = "abort" ]; then
 404                                         rm -f "$TMP_LOG" "$TMP_MSG"
 405                                         return $__push_patch_bail
 406                                 fi
 407                         fi
 408                 fi
 409
 410                 # grab a commit message out of the patch
 411                 do_get_header "$p" > "$TMP_MSG"
 412
 413                 # make a default commit message if patch doesn't contain one
 414                 [ ! -s "$TMP_MSG" ] && echo "patch $pname" > "$TMP_MSG"
 415
 416                 # extract a From line from the patch header, and set
 417                 # GIT_AUTHOR_{NAME,EMAIL}
 418                 author_str=`sed -n -e '/^From:/ { s/^From: //; p; q }; /^(diff |---)/ q' "$p"`
 419                 if [ ! -z "$author_str" ]; then
 420                         GIT_AUTHOR_NAME=`echo $author_str | sed -e 's/ *<.*$//'`
 421                         export GIT_AUTHOR_NAME="${GIT_AUTHOR_NAME:-" "}"
 422                         export GIT_AUTHOR_EMAIL="`echo $author_str | sed -e 's/[^<]*//'`"
 423                 fi
 424
 425                 # must strip nano-second part otherwise git gets very
 426                 # confused, and makes up strange timestamps from the past
 427                 # (chances are it decides to interpret it as a unix
 428                 # timestamp).
 429                 export GIT_AUTHOR_DATE="`stat -c %y "$p" | sed -e '
 430 s/^\([0-9]\{4\}\)-\([0-9]\{2\}\)-\([0-9]\{2\}\) \([0-9]\{2\}\):\([0-9]\{2\}\):\([0-9]\{2\}\)\.[0-9]* \(.*\)$/\1-\2-\3 \4:\5:\6 \7/'`"
 431                 export GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
 432
 433                 # commit
 434                 treeish=`git-write-tree`
 435                 commitish=`git-commit-tree $treeish -p HEAD < "$TMP_MSG"`
 436                 echo $commitish > $GIT_DIR/`git-symbolic-ref HEAD`
 437
 438                 # mark patch as applied
 439                 echo "$commitish:$pname" >> $applied
 440
 441                 rm -f "$TMP_MSG" "$TMP_LOG"
 442         )
 443
 444         # sub-shell funky-ness
 445         __push_patch_bail=$?
 446
 447         # update references to top, bottom, and base of the stack
 448         update_stack_tags
 449
 450         return $__push_patch_bail
 451 }
 452
 453 # usage: must_commit_first
 454 must_commit_first()
 455 {
 456         [ `git-diff-files | wc -l` -eq 0 ]
 457         return $?
 458 }
 459
 460 # usage: fold_patch patchname
 461 fold_patch()
 462 {
 463         set -- "$1" "`get_top`"
 464
 465         assert_head_check
 466
 467         push_patch "$1"
 468
 469         __refresh_patch "$2" HEAD^^ 2 "" ""
 470
 471         series_remove_patch "$1"
 472 }
 473
 474 # usage: refresh_patch patchname gengitdiff incldiffstat
 475 refresh_patch()
 476 {
 477         __refresh_patch "$1" HEAD^ 1 "$2" "$3"
 478 }
 479
 480 # usage: __refresh_patch patchname commitish number_of_commits gengitdiff
 481 #                        incldiffstat
 482 __refresh_patch()
 483 {
 484         assert_head_check
 485
 486         (
 487                 TMP_DIFF=`get_tmp_file diff`
 488
 489                 cd "$TOP_DIR"
 490                 p="$GUILT_DIR/$branch/$1"
 491
 492                 git-diff-files --name-only | (while read n; do git-update-index "$n" ; done)
 493
 494                 # get the patch header
 495                 do_get_full_header "$p" > "$TMP_DIFF"
 496
 497                 [ ! -z "$4" ] && diffopts="-C -M --find-copies-harder"
 498
 499                 if [ ! -z "$5" ]; then
 500                         (
 501                                 echo "---"
 502                                 git-diff --stat $diffopts "$2"
 503                                 echo ""
 504                         ) >> "$TMP_DIFF"
 505                 fi
 506
 507                 # get the new patch
 508                 git-diff $diffopts "$2" >> "$TMP_DIFF"
 509
 510                 # move the new patch in
 511                 mv "$p" "$p~"
 512                 mv "$TMP_DIFF" $p
 513         )
 514
 515         # drop the currently applied patch, pop_many_patches does it's own
 516         # cd $TOP_DIR
 517         pop_many_patches "$2" "$3"
 518
 519         # push_patch does it's own cd $TOP_DIR
 520         push_patch "$1"
 521 }
 522
 523 # usage: munge_hash_range <hash range>
 524 #
 525 # this means:
 526 #       <hash>                  - one commit
 527 #       <hash>..                - hash until head (excludes hash, includes head)
 528 #       ..<hash>                - until hash (includes hash)
 529 #       <hash1>..<hash2>        - from hash to hash (inclusive)
 530 #
 531 # The output of this function is suitable to be passed to git-rev-list
 532 munge_hash_range()
 533 {
 534         case "$1" in
 535                 *..*..*|*\ *)
 536                         # double .. or space is illegal
 537                         return 1;;
 538                 ..*)
 539                         # e.g., "..v0.10"
 540                         echo ${1#..};;
 541                 *..)
 542                         # e.g., "v0.19.."
 543                         echo ${1%..}..HEAD;;
 544                 *..*)
 545                         # e.g., "v0.19-rc1..v0.19"
 546                         echo ${1%%..*}..${1#*..};;
 547                 ?*)
 548                         # e.g., "v0.19"
 549                         echo $1^..$1;;
 550                 *)  # empty
 551                         return 1;;
 552         esac
 553         return 0
 554 }
 555
 556 # usage: get_tmp_file <prefix>
 557 #
 558 # Get a unique filename and create the file in a non-racy way
 559 get_tmp_file()
 560 {
 561         while true; do
 562                 mktemp "/tmp/guilt.$1.XXXXXXXXXXXXXXX" && break
 563         done
 564 }
 565
 566 # usage: guilt_hook <hook name> <args....>
 567 guilt_hook()
 568 {
 569         __hookname="$1"
 570         [ ! -x "$GIT_DIR/hooks/guilt/$__hookname" ] && return 0
 571
 572         shift
 573
 574         "$GIT_DIR/hooks/guilt/$__hookname" "$@"
 575         return $?
 576 }
 577
 578 #
 579 # Some constants
 580 #
 581
 582 # used for: git-apply -C <val>
 583 guilt_push_diff_context=1
 584
 585 #
 586 # Parse any part of .git/config that belongs to us
 587 #
 588
 589 # autotag?
 590 autotag=`git-config guilt.autotag`
 591 [ -z "$autotag" ] && autotag=1
 592
 593 #
 594 # The following gets run every time this file is source'd
 595 #
 596
 597 TOP_DIR=`git-rev-parse --show-cdup`
 598 if [ -z "$TOP_DIR" ]; then
 599         TOP_DIR="./"
 600 fi
 601
 602 GUILT_DIR="$GIT_DIR/patches"
 603
 604 branch=`get_branch`
 605
 606 # most of the time we want to verify that the repo's branch has been
 607 # initialized, but every once in a blue moon (e.g., we want to run guilt-init),
 608 # we must avoid the checks
 609 if [ -z "$DO_NOT_CHECK_BRANCH_EXISTENCE" ]; then
 610         verify_branch || exit 1
 611 fi
 612
 613 # very useful files
 614 series="$GUILT_DIR/$branch/series"
 615 applied="$GUILT_DIR/$branch/status"
 616
 617 # determine an editor to use for anything interactive (fall back to vi)
 618 editor="vi"
 619 [ ! -z "$EDITOR" ] && editor="$EDITOR"
 620
 621 # determine a pager to use for anything interactive (fall back to more)
 622 pager="more"
 623 [ ! -z "$PAGER" ] && pager="$PAGER"