guilt

   1 #!/bin/bash
   2 #
   3 # Copyright (c) Josef "Jeff" Sipek, 2006, 2007
   4 #
   5
   6 GUILT_VERSION="0.20"
   7 GUILT_NAME="Buddy Holly"
   8
   9 if [ `basename $0` = "guilt" ]; then
  10         # being run as standalone
  11
  12         # by default, we shouldn't fail
  13         fail=0
  14
  15         if [ $# -ne 0 ]; then
  16                 # take first arg, and try to execute it
  17
  18                 cmd="$1"
  19                 dir=`dirname $0`
  20
  21                 if [ ! -x "$dir/guilt-$cmd" ]; then
  22                         echo "Command $cmd not found" >&2
  23                         echo "" >&2
  24                         fail=1
  25                 else
  26                         shift
  27                         exec "$dir/guilt-$cmd" "$@"
  28
  29                         # this is not reached because of the exec
  30                         echo "Exec failed! Something is terribly wrong!" >&2
  31                         exit 1
  32                 fi
  33         fi
  34
  35         # no args passed or invalid command entered, just output help summary
  36
  37         echo "Guilt v$GUILT_VERSION"
  38         echo ""
  39         echo "Pick a command:"
  40         for x in `dirname $0`/guilt-*; do
  41                 [ -x $x ] && echo -e "\t`basename $x`"
  42         done
  43
  44         echo ""
  45         echo "Example:"
  46         echo -e "\tguilt-push"
  47         echo "or"
  48         echo -e "\tguilt push"
  49
  50         # now, let's exit
  51         exit $fail
  52 fi
  53
  54 ########
  55
  56 #
  57 # Library goodies
  58 #
  59
  60 function print_usage
  61 {
  62         echo "$USAGE" >&2
  63 }
  64
  65 function find_git_dir
  66 {
  67         local d=`git-rev-parse --git-dir`
  68
  69         if [ $? -ne 0 -o -z "$d" ]; then
  70                 echo "Not a git repository" >&2
  71                 return 1
  72         fi
  73
  74         echo "$d"
  75 }
  76
  77 function get_branch
  78 {
  79         git-symbolic-ref HEAD | sed -e 's,^refs/heads/,,'
  80 }
  81
  82 function verify_branch
  83 {
  84         local b=$branch
  85
  86         [ ! -d "$GIT_DIR/patches" ] &&
  87                 echo "Patches directory doesn't exist, try guilt-init" >&2 &&
  88                 return 1
  89         [ ! -d "$GIT_DIR/patches/$b" ] &&
  90                 echo "Branch $b is not initialized, try guilt-init" >&2 &&
  91                 return 1
  92         [ ! -f "$GIT_DIR/patches/$b/series" ] &&
  93                 echo "Branch $b does not have a series file" >&2 &&
  94                 return 1
  95         [ ! -f "$GIT_DIR/patches/$b/status" ] &&
  96                 echo "Branch $b does not have a status file" >&2 &&
  97                 return 1
  98         [ -f "$GIT_DIR/patches/$b/applied" ] &&
  99                 echo "Warning: Branch $b has 'applied' file - guilt is not compatible with stgit" >&2 &&
 100                 return 1
 101
 102         return 0
 103 }
 104
 105 function get_top
 106 {
 107         tail -1 $GUILT_DIR/$branch/status | cut -d: -f 2-
 108 }
 109
 110 function get_prev
 111 {
 112         local n=`wc -l < $GUILT_DIR/$branch/status`
 113         local n=`expr $n - 1`
 114
 115         local idx=0
 116         for p in `cat $GUILT_DIR/$branch/status`; do
 117                 idx=`expr $idx + 1`
 118                 [ $idx -lt $n ] && continue
 119                 [ $idx -gt $n ] && break
 120
 121                 echo $p
 122         done
 123 }
 124
 125 function get_series
 126 {
 127         # ignore all lines matching:
 128         #       - empty lines
 129         #       - whitespace only
 130         #       - optional whitespace followed by '#' followed by more
 131         #         optional whitespace
 132         grep -ve '^[[:space:]]*\(#.*\)*$' < $series
 133 }
 134
 135 # usage: do_make_header <hash>
 136 function do_make_header
 137 {
 138         # which revision do we want to work with?
 139         local rev=$1
 140
 141         # we should try to work with commit objects only
 142         if [ `git-cat-file -t $rev` != "commit" ]; then
 143                 echo "Hash $rev is not a commit object" >&2
 144                 echo "Aborting..." >&2
 145                 exit 2
 146         fi
 147
 148         # get the author line from the commit object
 149         local author=`git-cat-file -p $rev | grep -e '^author ' | head -1`
 150
 151         # strip the timestamp & '^author ' string
 152         author=`echo $author | sed -e 's/^author //' -e 's/ [0-9]* [+-]*[0-9][0-9]*$//'`
 153
 154         git-cat-file -p $rev | awk "
 155 BEGIN{ok=0}
 156 (ok==1){print \$0; print \"\nFrom: $author\"; ok=2; next}
 157 (ok==2){print \$0}
 158 /^\$/ && (ok==0){ok=1}
 159 "
 160 }
 161
 162 # usage: do_get_header patchfile
 163 function do_get_header
 164 {
 165         # The complexity arises from the fact that we want to ignore the
 166         # From line and the empty line after it if it exists
 167
 168         # 2nd line skips the From line
 169         # 3rd line skips the empty line right after a From line
 170         do_get_full_header $1 | awk '
 171 BEGIN{skip=0}
 172 /^From:/{skip=1; next}
 173 /^[ \t\f\n\r\v]*$/ && (skip==1){skip=0; next}
 174 {print $0}
 175 END{}
 176 '
 177 }
 178
 179 # usage: do_get_full_header patchfile
 180 function do_get_full_header
 181 {
 182         # 2nd line checks for the begining of a patch
 183         # 3rd line outputs the line if it didn't get pruned by the above rules
 184         cat $1 | awk '
 185 BEGIN{ok=1}
 186 /^(diff|---)/{ok=0}
 187 (ok==1){print $0}
 188 END{}
 189 '
 190 }
 191
 192 # usage: assert_head_check
 193 function assert_head_check
 194 {
 195         local eh=`tail -1 < $applied | cut -d: -f 1`
 196
 197         if ! head_check $eh; then
 198                 echo "aborting..." >&2
 199                 exit 1
 200         fi
 201
 202         return 0
 203 }
 204
 205 # usage: head_check <expected hash>
 206 function head_check
 207 {
 208         # make sure we're not doing funky things to commits that don't
 209         # belong to us
 210         local ch=`cat $GIT_DIR/refs/heads/$branch`
 211
 212         # if the expected hash is empty, just return
 213         [ -z "$1" ] && return 0
 214
 215         if [ "$ch" != "$1" ]; then
 216                 echo "Expected HEAD commit $1" >&2
 217                 echo "                 got $ch" >&2
 218                 return 1
 219         fi
 220         return 0
 221 }
 222
 223 # usage: series_insert_patch <patchname>
 224 function series_insert_patch
 225 {
 226         local top=`get_top`
 227
 228         if [ ! -z "$top" ]; then
 229                 sed -i -e "s,^$top\$,$top\n$1," $series
 230         else
 231                 echo "$1" > $series.tmp
 232                 cat $series >> $series.tmp
 233                 mv $series.tmp $series
 234         fi
 235 }
 236
 237 # usage: pop_patch
 238 function pop_patch
 239 {
 240         pop_many_patches HEAD^ 1
 241 }
 242
 243 # usage: pop_many_patches <commitish> <number of patches>
 244 function pop_many_patches
 245 {
 246         assert_head_check
 247
 248         cd $TOP_DIR
 249
 250         git-reset --hard $1 > /dev/null
 251         head -n -$2 < $applied > $applied.tmp
 252         mv $applied{.tmp,}
 253
 254         cd - 2>&1 >/dev/null
 255 }
 256
 257 # usage: push_patch patchname
 258 function push_patch
 259 {
 260         local p="$GUILT_DIR/$branch/$1"
 261         local pname="$1"
 262
 263         local bail=0
 264
 265         assert_head_check
 266
 267         cd $TOP_DIR
 268
 269         # apply the patch if and only if there is something to apply
 270         if [ `git-apply --numstat $p | wc -l` -gt 0 ]; then
 271                 git-apply -C$guilt_push_diff_context \
 272                         --reject $p > /dev/null 2> /tmp/guilt.log.$$
 273                 bail=$?
 274
 275                 [ $bail -ne 0 ] && cat /tmp/guilt.log.$$ >&2
 276
 277                 # FIXME: Path munging is being done, we need to convince
 278                 # git-apply to just give us list of files with \0 as a
 279                 # delimiter, and pass -z to git-update-index
 280                 git-apply --numstat $p | cut -f 3- | git-update-index --add --remove --stdin
 281         fi
 282
 283         # grab a commit message out of the patch
 284         do_get_header $p > /tmp/guilt.msg.$$
 285
 286         # make a default commit message if patch doesn't contain one
 287         [ ! -s /tmp/guilt.msg.$$ ] && echo "patch $pname" > /tmp/guilt.msg.$$
 288
 289         # extract a From line from the patch header, and set
 290         # GIT_AUTHOR_{NAME,EMAIL}
 291         local author_str=`cat $p | grep -e '^From: ' | sed -e 's/^From: //'`
 292         if [ ! -z "$author_str" ]; then
 293                 local backup_author_name="$GIT_AUTHOR_NAME"
 294                 local backup_author_email="$GIT_AUTHOR_EMAIL"
 295                 GIT_AUTHOR_NAME=`echo $author_str | sed -e 's/ *<.*$//'`
 296                 GIT_AUTHOR_EMAIL=`echo $author_str | sed -e 's/[^<]*//'`
 297
 298                 if [ -z "$GIT_AUTHOR_NAME" ]; then
 299                         GIT_AUTHOR_NAME=" "
 300                 fi
 301
 302                 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL
 303         fi
 304         local backup_author_date="$GIT_AUTHOR_DATE"
 305         local backup_committer_date="$GIT_COMMITTER_DATE"
 306         export GIT_AUTHOR_DATE=`stat -c %y $p`
 307         export GIT_COMMITTER_DATE=$GIT_AUTHOR_DATE
 308
 309         # commit
 310         local treeish=`git-write-tree`
 311         local commitish=`git-commit-tree $treeish -p HEAD < /tmp/guilt.msg.$$`
 312         echo $commitish > $GIT_DIR/`git-symbolic-ref HEAD`
 313
 314         # mark patch as applied
 315         echo "$commitish:$pname" >> $applied
 316
 317         # restore original GIT_AUTHOR_{NAME,EMAIL}
 318         if [ ! -z "$author_str" ]; then
 319                 if [ ! -z "$backup_author_name" ]; then
 320                         export GIT_AUTHOR_NAME="$backup_author_name"
 321                 else
 322                         unset GIT_AUTHOR_NAME
 323                 fi
 324
 325                 if [ ! -z "$backup_author_name" ]; then
 326                         export GIT_AUTHOR_EMAIL="$backup_author_email"
 327                 else
 328                         unset GIT_AUTHOR_EMAIL
 329                 fi
 330         fi
 331         if [ ! -z "$backup_author_date" ]; then
 332                 export GIT_AUTHOR_DATE="$backup_author_date"
 333         else
 334                 unset GIT_AUTHOR_DATE
 335         fi
 336                 if [ ! -z "$backup_committer_date" ]; then
 337                 export GIT_COMMITTER_DATE="$backup_committer_date"
 338         else
 339                 unset GIT_COMMITTER_DATE
 340         fi
 341
 342         rm -f /tmp/guilt.msg.$$ /tmp/guilt.log.$$
 343
 344         cd - 2>&1 >/dev/null
 345
 346         return $bail
 347 }
 348
 349 # usage: must_commit_first
 350 function must_commit_first
 351 {
 352         [ `git-diff-files | wc -l` -eq 0 ]
 353         return $?
 354 }
 355
 356 # usage: refresh_patch patchname
 357 function refresh_patch
 358 {
 359         local p="$GUILT_DIR/$branch/$1"
 360
 361         assert_head_check
 362
 363         cd $TOP_DIR
 364
 365         git-diff-files --name-only | (while read n; do git-update-index $n ; done)
 366
 367         # get the patch header
 368         do_get_full_header $p > /tmp/guilt.diff.$$
 369
 370         # get the new patch
 371         git-diff HEAD^ >> /tmp/guilt.diff.$$
 372
 373         # move the new patch in
 374         mv $p $p.prev
 375         mv /tmp/guilt.diff.$$ $p
 376
 377         cd - 2>&1 >/dev/null
 378
 379         # drop the currently applied patch, pop_patch does it's own cd
 380         # $TOP_DIR
 381         pop_patch
 382
 383         # push_patch does it's own cd $TOP_DIR
 384         push_patch $1
 385 }
 386
 387 # usage: munge_hash_range <hash range>
 388 #
 389 # this means:
 390 #       <hash>                  - one commit
 391 #       <hash>..                - hash until head (excludes hash, includes head)
 392 #       ..<hash>                - until hash (includes hash)
 393 #       <hash1>..<hash2>        - from hash to hash (inclusive)
 394 #
 395 # The output of this function is suitable to be passed to git-rev-list
 396 function munge_hash_range
 397 {
 398         local l=`echo "$1" | sed -e 's/\.\./ /'`
 399
 400         local h1=`echo "$l" | cut -s -d' ' -f 1`
 401         local h2=`echo "$l" | cut -s -d' ' -f 2`
 402
 403         if [ -z "$h1" -a -z "$h2" ]; then
 404                 # e.g., "v0.19"
 405                 echo "$l^..$l"
 406         elif [ -z "$h1" ]; then
 407                 # e.g., "..v0.10"
 408                 echo "$h2"
 409         elif [ -z "$h2" ]; then
 410                 # e.g., "v0.19.."
 411                 echo "$h1..HEAD"
 412         else
 413                 # e.g., "v0.19-rc1..v0.19"
 414                 echo "$h1..$h2"
 415         fi
 416 }
 417
 418 # Some constants
 419
 420 # used for: git-apply -C <val>
 421 guilt_push_diff_context=1
 422
 423 #
 424 # The following gets run every time this file is source'd
 425 #
 426
 427 GIT_DIR=`find_git_dir`
 428 [ $? -ne 0 ] && exit 1
 429
 430 TOP_DIR=`git-rev-parse --show-cdup`
 431 if [ -z "$TOP_DIR" ]; then
 432         TOP_DIR="./"
 433 fi
 434
 435 GUILT_DIR="$GIT_DIR/patches"
 436
 437 branch=`get_branch`
 438
 439 # most of the time we want to verify that the repo's branch has been
 440 # initialized, but every once in a blue moon (e.g., we want to run guilt-init),
 441 # we must avoid the checks
 442 if [ -z "$DO_NOT_CHECK_BRANCH_EXISTENCE" ]; then
 443         verify_branch || exit 1
 444 fi
 445
 446 # very useful files
 447 series="$GUILT_DIR/$branch/series"
 448 applied="$GUILT_DIR/$branch/status"
 449
 450 USAGE="Usage: `basename $0`"
 451
 452 # determine an editor to use for anything interactive (fall back to vi)
 453 editor="vi"
 454 [ ! -z "$EDITOR" ] && editor="$EDITOR"
 455
 456 # determine a pager to use for anything interactive (fall back to more)
 457 pager="more"
 458 [ -z "$pager" ] && pager="$PAGER"