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