server/post-receive-email

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2007 Andy Parkins
   4 #
   5 # An example hook script to mail out commit update information.  This hook
   6 # sends emails listing new revisions to the repository introduced by the
   7 # change being reported.  The rule is that (for branch updates) each commit
   8 # will appear on one email and one email only.
   9 #
  10 # This hook is stored in the contrib/hooks directory.  Your distribution
  11 # will have put this somewhere standard.  You should make this script
  12 # executable then link to it in the repository you would like to use it in.
  13 # For example, on debian the hook is stored in
  14 # /usr/share/doc/git-core/contrib/hooks/post-receive-email:
  15 #
  16 #  chmod a+x post-receive-email
  17 #  cd /path/to/your/repository.git
  18 #  ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive
  19 #
  20 # This hook script assumes it is enabled on the central repository of a
  21 # project, with all users pushing only to it and not between each other.  It
  22 # will still work if you don't operate in that style, but it would become
  23 # possible for the email to be from someone other than the person doing the
  24 # push.
  25 #
  26 # Config
  27 # ------
  28 # hooks.post-receive-email.mailinglist
  29 #   This is the list that all pushes will go to; leave it blank to not send
  30 #   emails for every ref update.
  31 # hooks.post-receive-email.announcelist
  32 #   This is the list that all pushes of annotated tags will go to.  Leave it
  33 #   blank to default to the mailinglist field.  The announce emails lists
  34 #   the short log summary of the changes since the last annotated tag.
  35 # hooks.post-receive-email.envelopesender
  36 #   If set then the -f option is passed to sendmail to allow the envelope
  37 #   sender address to be set
  38 #
  39 # Notes
  40 # -----
  41 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
  42 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
  43 # give information for debugging.
  44 #
  45
  46 # ---------------------------- Functions
  47
  48 . $(dirname $0)/functions
  49
  50 #
  51 # Top level email generation function.  This decides what type of update
  52 # this is and calls the appropriate body-generation routine after outputting
  53 # the common header
  54 #
  55 # Note this function doesn't actually generate any email output, that is
  56 # taken care of by the functions it calls:
  57 #  - generate_email_header
  58 #  - generate_create_XXXX_email
  59 #  - generate_update_XXXX_email
  60 #  - generate_delete_XXXX_email
  61 #  - generate_email_footer
  62 #
  63 generate_email()
  64 {
  65         # --- Arguments
  66         oldrev=$(git rev-parse $1)
  67         newrev=$(git rev-parse $2)
  68         refname="$3"
  69
  70         # --- Interpret
  71         # 0000->1234 (create)
  72         # 1234->2345 (update)
  73         # 2345->0000 (delete)
  74         if expr "$oldrev" : '0*$' >/dev/null
  75         then
  76                 change_type="create"
  77         else
  78                 if expr "$newrev" : '0*$' >/dev/null
  79                 then
  80                         change_type="delete"
  81                 else
  82                         change_type="update"
  83                 fi
  84         fi
  85
  86         # --- Get the revision types
  87         newrev_type=$(git cat-file -t $newrev 2> /dev/null)
  88         oldrev_type=$(git cat-file -t "$oldrev" 2> /dev/null)
  89         case "$change_type" in
  90         create|update)
  91                 rev="$newrev"
  92                 rev_type="$newrev_type"
  93                 ;;
  94         delete)
  95                 rev="$oldrev"
  96                 rev_type="$oldrev_type"
  97                 ;;
  98         esac
  99
 100         # The revision type tells us what type the commit is, combined with
 101         # the location of the ref we can decide between
 102         #  - working branch
 103         #  - tracking branch
 104         #  - unannoted tag
 105         #  - annotated tag
 106         case "$refname","$rev_type" in
 107                 refs/tags/*,commit)
 108                         # un-annotated tag
 109                         refname_type="tag"
 110                         short_refname=${refname##refs/tags/}
 111                         ;;
 112                 refs/tags/*,tag)
 113                         # annotated tag
 114                         refname_type="annotated tag"
 115                         short_refname=${refname##refs/tags/}
 116                         # change recipients
 117                         if [ -n "$announcerecipients" ]; then
 118                                 recipients="$announcerecipients"
 119                         fi
 120                         ;;
 121                 refs/heads/*,commit)
 122                         # branch
 123                         refname_type="branch"
 124                         short_refname=${refname##refs/heads/}
 125                         ;;
 126                 refs/remotes/*,commit)
 127                         # tracking branch
 128                         refname_type="tracking branch"
 129                         short_refname=${refname##refs/remotes/}
 130                         echo >&2 "*** Push-update of tracking branch, $refname"
 131                         echo >&2 "***  - no email generated."
 132                         exit 0
 133                         ;;
 134                 *)
 135                         # Anything else (is there anything else?)
 136                         echo >&2 "*** Unknown type of update to $refname ($rev_type)"
 137                         echo >&2 "***  - no email generated"
 138                         exit 1
 139                         ;;
 140         esac
 141
 142         # Check if we've got anyone to send to
 143         if [ -z "$recipients" ]; then
 144                 case "$refname_type" in
 145                         "annotated tag")
 146                                 config_name="hooks.post-receive-email.announcelist"
 147                                 ;;
 148                         *)
 149                                 config_name="hooks.post-receive-email.mailinglist"
 150                                 ;;
 151                 esac
 152                 echo >&2 "*** $config_name is not set so no email will be sent"
 153                 echo >&2 "*** for $refname update $oldrev->$newrev"
 154                 exit 0
 155         fi
 156
 157         # Email parameters
 158         # The email subject will contain the best description of the ref
 159         # that we can build from the parameters
 160         describe=$(git describe $rev 2>/dev/null)
 161         if [ -z "$describe" ]; then
 162                 describe=$rev
 163         fi
 164
 165         generate_email_header
 166
 167         # Call the correct body generation function
 168         fn_name=general
 169         case "$refname_type" in
 170         "tracking branch"|branch)
 171                 fn_name=branch
 172                 ;;
 173         "annotated tag")
 174                 fn_name=atag
 175                 ;;
 176         esac
 177         generate_${change_type}_${fn_name}_email
 178
 179         generate_email_footer
 180 }
 181
 182 generate_email_header()
 183 {
 184         # --- Email (all stdout will be the email)
 185         # Generate header
 186         cat <<-EOF
 187         From: ${USER}@payflex.com
 188         To: $recipients
 189         Subject: ${emailprefix} $short_refname $refname_type ${change_type}d. $describe
 190         X-Git-Refname: $refname
 191         X-Git-Reftype: $refname_type
 192         X-Git-Oldrev: $oldrev
 193         X-Git-Newrev: $newrev
 194
 195         The $refname_type, $short_refname has been ${change_type}d
 196         EOF
 197 }
 198
 199 generate_email_footer()
 200 {
 201         cat <<-EOF
 202
 203
 204         hooks/post-receive
 205         --
 206         $projectdesc
 207         EOF
 208 }
 209
 210 # --------------- Branches
 211
 212 #
 213 # Called for the creation of a branch
 214 #
 215 generate_create_branch_email()
 216 {
 217         # This is a new branch and so oldrev is not valid
 218         echo "        at  $newrev ($newrev_type)"
 219         echo ""
 220
 221         echo $LOGBEGIN
 222         # This shows all log entries that are not already covered by
 223         # another ref - i.e. commits that are now accessible from this
 224         # ref that were previously not accessible
 225         # (see generate_update_branch_email for the explanation of this
 226         # command)
 227
 228         set_new_commits
 229         echo "$new_commits" | git rev-list --pretty --reverse --stdin
 230         echo $LOGEND
 231
 232         echo ""
 233         echo "Summary of changes:"
 234
 235         oldest_new=$(echo "$new_commits" | git rev-list --stdin | tail -n 1)
 236         if [ "$oldest_new" != "" ] ; then
 237                 git diff-tree --stat -p $oldest_new^..$newrev
 238         fi
 239 }
 240
 241 #
 242 # Called for the change of a pre-existing branch
 243 #
 244 generate_update_branch_email()
 245 {
 246         # Consider this:
 247         #   1 --- 2 --- O --- X --- 3 --- 4 --- N
 248         #
 249         # O is $oldrev for $refname
 250         # N is $newrev for $refname
 251         # X is a revision pointed to by some other ref, for which we may
 252         #   assume that an email has already been generated.
 253         # In this case we want to issue an email containing only revisions
 254         # 3, 4, and N.  Given (almost) by
 255         #
 256         #  git rev-list N ^O --not --all
 257         #
 258         # The reason for the "almost", is that the "--not --all" will take
 259         # precedence over the "N", and effectively will translate to
 260         #
 261         #  git rev-list N ^O ^X ^N
 262         #
 263         # So, we need to build up the list more carefully.  git rev-parse
 264         # will generate a list of revs that may be fed into git rev-list.
 265         # We can get it to make the "--not --all" part and then filter out
 266         # the "^N" with:
 267         #
 268         #  git rev-parse --not --all | grep -v N
 269         #
 270         # Then, using the --stdin switch to git rev-list we have effectively
 271         # manufactured
 272         #
 273         #  git rev-list N ^O ^X
 274         #
 275         # This leaves a problem when someone else updates the repository
 276         # while this script is running.  Their new value of the ref we're
 277         # working on would be included in the "--not --all" output; and as
 278         # our $newrev would be an ancestor of that commit, it would exclude
 279         # all of our commits.  What we really want is to exclude the current
 280         # value of $refname from the --not list, rather than N itself.  So:
 281         #
 282         #  git rev-parse --not --all | grep -v $(git rev-parse $refname)
 283         #
 284         # Get's us to something pretty safe (apart from the small time
 285         # between refname being read, and git rev-parse running - for that,
 286         # I give up)
 287         #
 288         #
 289         # Next problem, consider this:
 290         #   * --- B --- * --- O ($oldrev)
 291         #          \
 292         #           * --- X --- * --- N ($newrev)
 293         #
 294         # That is to say, there is no guarantee that oldrev is a strict
 295         # subset of newrev (it would have required a --force, but that's
 296         # allowed).  So, we can't simply say rev-list $oldrev..$newrev.
 297         # Instead we find the common base of the two revs and list from
 298         # there.
 299         #
 300         # As above, we need to take into account the presence of X; if
 301         # another branch is already in the repository and points at some of
 302         # the revisions that we are about to output - we don't want them.
 303         # The solution is as before: git rev-parse output filtered.
 304         #
 305         # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
 306         #
 307         # Tags pushed into the repository generate nice shortlog emails that
 308         # summarise the commits between them and the previous tag.  However,
 309         # those emails don't include the full commit messages that we output
 310         # for a branch update.  Therefore we still want to output revisions
 311         # that have been output on a tag email.
 312         #
 313         # Luckily, git rev-parse includes just the tool.  Instead of using
 314         # "--all" we use "--branches"; this has the added benefit that
 315         # "remotes/" will be ignored as well.
 316
 317         # List all of the revisions that were removed by this update, in a
 318         # fast forward update, this list will be empty, because rev-list O
 319         # ^N is empty.  For a non fast forward, O ^N is the list of removed
 320         # revisions
 321         fast_forward=""
 322         rev=""
 323         for rev in $(git rev-list $newrev..$oldrev)
 324         do
 325                 revtype=$(git cat-file -t "$rev")
 326                 echo "  discards  $rev ($revtype)"
 327         done
 328         if [ -z "$rev" ]; then
 329                 fast_forward=1
 330         fi
 331
 332         # List all the revisions from baserev to newrev in a kind of
 333         # "table-of-contents"; note this list can include revisions that
 334         # have already had notification emails and is present to show the
 335         # full detail of the change from rolling back the old revision to
 336         # the base revision and then forward to the new revision
 337         # Changed: added --first-parent to not go down merge commits
 338         for rev in $(git rev-list --first-parent $oldrev..$newrev)
 339         do
 340                 revtype=$(git cat-file -t "$rev")
 341                 echo "       via  $rev ($revtype)"
 342         done
 343
 344         if [ "$fast_forward" ]; then
 345                 echo "      from  $oldrev ($oldrev_type)"
 346         else
 347                 #  1. Existing revisions were removed.  In this case newrev
 348                 #     is a subset of oldrev - this is the reverse of a
 349                 #     fast-forward, a rewind
 350                 #  2. New revisions were added on top of an old revision,
 351                 #     this is a rewind and addition.
 352
 353                 # (1) certainly happened, (2) possibly.  When (2) hasn't
 354                 # happened, we set a flag to indicate that no log printout
 355                 # is required.
 356
 357                 echo ""
 358
 359                 # Find the common ancestor of the old and new revisions and
 360                 # compare it with newrev
 361                 baserev=$(git merge-base $oldrev $newrev)
 362                 rewind_only=""
 363                 if [ "$baserev" = "$newrev" ]; then
 364                         echo "This update discarded existing revisions and left the branch pointing at"
 365                         echo "a previous point in the repository history."
 366                         echo ""
 367                         echo " * -- * -- N ($newrev)"
 368                         echo "            \\"
 369                         echo "             O -- O -- O ($oldrev)"
 370                         echo ""
 371                         echo "The removed revisions are not necessarilly gone - if another reference"
 372                         echo "still refers to them they will stay in the repository."
 373                         rewind_only=1
 374                 else
 375                         echo "This update added new revisions after undoing existing revisions.  That is"
 376                         echo "to say, the old revision is not a strict subset of the new revision.  This"
 377                         echo "situation occurs when you --force push a change and generate a repository"
 378                         echo "containing something like this:"
 379                         echo ""
 380                         echo " * -- * -- B -- O -- O -- O ($oldrev)"
 381                         echo "            \\"
 382                         echo "             N -- N -- N ($newrev)"
 383                         echo ""
 384                         echo "When this happens we assume that you've already had alert emails for all"
 385                         echo "of the O revisions, and so we here report only the revisions in the N"
 386                         echo "branch from the common base, B."
 387                 fi
 388         fi
 389
 390         echo ""
 391         if [ -z "$rewind_only" ]; then
 392                 echo "Those revisions listed above that are new to this repository have"
 393                 echo "not appeared on any other notification email; so we list those"
 394                 echo "revisions in full, below."
 395
 396                 echo ""
 397                 echo $LOGBEGIN
 398
 399                 set_new_commits
 400                 echo "$new_commits" | git rev-list --reverse --pretty --stdin
 401
 402                 # XXX: Need a way of detecting whether git rev-list actually
 403                 # outputted anything, so that we can issue a "no new
 404                 # revisions added by this update" message
 405
 406                 echo $LOGEND
 407         else
 408                 echo "No new revisions were added by this update."
 409         fi
 410
 411         # The diffstat is shown from the old revision to the new revision.
 412         # This is to show the truth of what happened in this change.
 413         # There's no point showing the stat from the base to the new
 414         # revision because the base is effectively a random revision at this
 415         # point - the user will be interested in what this revision changed
 416         # - including the undoing of previous revisions in the case of
 417         # non-fast forward updates.
 418         echo ""
 419         echo "Summary of changes:"
 420         git diff-tree --stat -p --find-copies-harder $oldrev..$newrev
 421 }
 422
 423 #
 424 # Called for the deletion of a branch
 425 #
 426 generate_delete_branch_email()
 427 {
 428         echo "       was  $oldrev"
 429         echo ""
 430         echo $LOGEND
 431         git show -s --pretty=oneline $oldrev
 432         echo $LOGEND
 433 }
 434
 435 # --------------- Annotated tags
 436
 437 #
 438 # Called for the creation of an annotated tag
 439 #
 440 generate_create_atag_email()
 441 {
 442         echo "        at  $newrev ($newrev_type)"
 443
 444         generate_atag_email
 445 }
 446
 447 #
 448 # Called for the update of an annotated tag (this is probably a rare event
 449 # and may not even be allowed)
 450 #
 451 generate_update_atag_email()
 452 {
 453         echo "        to  $newrev ($newrev_type)"
 454         echo "      from  $oldrev (which is now obsolete)"
 455
 456         generate_atag_email
 457 }
 458
 459 #
 460 # Called when an annotated tag is created or changed
 461 #
 462 generate_atag_email()
 463 {
 464         # Use git for-each-ref to pull out the individual fields from the
 465         # tag
 466         eval $(git for-each-ref --shell --format='
 467         tagobject=%(*objectname)
 468         tagtype=%(*objecttype)
 469         tagger=%(taggername)
 470         tagged=%(taggerdate)' $refname
 471         )
 472
 473         echo "   tagging  $tagobject ($tagtype)"
 474         case "$tagtype" in
 475         commit)
 476
 477                 # If the tagged object is a commit, then we assume this is a
 478                 # release, and so we calculate which tag this tag is
 479                 # replacing
 480                 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
 481
 482                 if [ -n "$prevtag" ]; then
 483                         echo "  replaces  $prevtag"
 484                 fi
 485                 ;;
 486         *)
 487                 echo "    length  $(git cat-file -s $tagobject) bytes"
 488                 ;;
 489         esac
 490         echo " tagged by  $tagger"
 491         echo "        on  $tagged"
 492
 493         echo ""
 494         echo $LOGBEGIN
 495
 496         # Show the content of the tag message; this might contain a change
 497         # log or release notes so is worth displaying.
 498         git cat-file tag $newrev | sed -e '1,/^$/d'
 499
 500         echo ""
 501         case "$tagtype" in
 502         commit)
 503                 # Only commit tags make sense to have rev-list operations
 504                 # performed on them
 505                 if [ -n "$prevtag" ]; then
 506                         # Show changes since the previous release
 507                         git rev-list --pretty=short "$prevtag..$newrev" | git shortlog
 508                 else
 509                         # No previous tag, show all the changes since time
 510                         # began
 511                         git rev-list --pretty=short $newrev | git shortlog
 512                 fi
 513                 ;;
 514         *)
 515                 # XXX: Is there anything useful we can do for non-commit
 516                 # objects?
 517                 ;;
 518         esac
 519
 520         echo $LOGEND
 521 }
 522
 523 #
 524 # Called for the deletion of an annotated tag
 525 #
 526 generate_delete_atag_email()
 527 {
 528         echo "       was  $oldrev"
 529         echo ""
 530         echo $LOGEND
 531         git show -s --pretty=oneline $oldrev
 532         echo $LOGEND
 533 }
 534
 535 # --------------- General references
 536
 537 #
 538 # Called when any other type of reference is created (most likely a
 539 # non-annotated tag)
 540 #
 541 generate_create_general_email()
 542 {
 543         echo "        at  $newrev ($newrev_type)"
 544
 545         generate_general_email
 546 }
 547
 548 #
 549 # Called when any other type of reference is updated (most likely a
 550 # non-annotated tag)
 551 #
 552 generate_update_general_email()
 553 {
 554         echo "        to  $newrev ($newrev_type)"
 555         echo "      from  $oldrev"
 556
 557         generate_general_email
 558 }
 559
 560 #
 561 # Called for creation or update of any other type of reference
 562 #
 563 generate_general_email()
 564 {
 565         # Unannotated tags are more about marking a point than releasing a
 566         # version; therefore we don't do the shortlog summary that we do for
 567         # annotated tags above - we simply show that the point has been
 568         # marked, and print the log message for the marked point for
 569         # reference purposes
 570         #
 571         # Note this section also catches any other reference type (although
 572         # there aren't any) and deals with them in the same way.
 573
 574         echo ""
 575         if [ "$newrev_type" = "commit" ]; then
 576                 echo $LOGBEGIN
 577                 git show --no-color --root -s --pretty=medium $newrev
 578                 echo $LOGEND
 579         else
 580                 # What can we do here?  The tag marks an object that is not
 581                 # a commit, so there is no log for us to display.  It's
 582                 # probably not wise to output git cat-file as it could be a
 583                 # binary blob.  We'll just say how big it is
 584                 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
 585         fi
 586 }
 587
 588 #
 589 # Called for the deletion of any other type of reference
 590 #
 591 generate_delete_general_email()
 592 {
 593         echo "       was  $oldrev"
 594         echo ""
 595         echo $LOGEND
 596         git show -s --pretty=oneline $oldrev
 597         echo $LOGEND
 598 }
 599
 600 send_mail()
 601 {
 602         if [ -n "$envelopesender" ] ; then
 603                 /usr/sbin/sendmail -t -f "$envelopesender"
 604         else
 605                 # /usr/sbin/sendmail -t
 606                 /home/BIPFS/shaberman/local/bin/msmtp -t
 607         fi
 608 }
 609
 610 # ---------------------------- main()
 611
 612 # --- Constants
 613 LOGBEGIN="- Log -----------------------------------------------------------------"
 614 LOGEND="-----------------------------------------------------------------------"
 615
 616 # --- Config
 617 # Set GIT_DIR either from the working directory, or from the environment
 618 # variable.
 619 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
 620 if [ -z "$GIT_DIR" ]; then
 621         echo >&2 "fatal: post-receive: GIT_DIR not set"
 622         exit 1
 623 fi
 624
 625 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
 626 # Check if the description is unchanged from it's default, and shorten it to
 627 # a more manageable length if it is
 628 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
 629 then
 630         projectdesc="UNNAMED PROJECT"
 631 fi
 632
 633 recipients=$(git config hooks.post-receive-email.mailinglist)
 634 announcerecipients=$(git config hooks.post-receive-email.announcelist)
 635 envelopesender=$(git config hooks.post-receive-email.envelopesender)
 636 emailprefix="[$projectdesc]"
 637 debug=$(git config hooks.post-receive-email.debug)
 638
 639 # --- Main loop
 640 # Allow dual mode: run from the command line just like the update hook, or
 641 # if no arguments are given then run as a hook script
 642 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
 643         # Output to the terminal in command line mode - if someone wanted to
 644         # resend an email; they could redirect the output to sendmail
 645         # themselves
 646         PAGER= generate_email $2 $3 $1
 647 else
 648         while read oldrev newrev refname
 649         do
 650                 if [ "$debug" == "true" ] ; then
 651                         generate_email $oldrev $newrev $refname > "${refname//\//.}.out"
 652                 else
 653                         generate_email $oldrev $newrev $refname | send_mail
 654                 fi
 655         done
 656 fi