taskd/mail.sh

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