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 # * Optional fifth parameter is email sender.
  17 # * Optional sixth parameter is extra e-mail header to add.
  18 # * If MAIL_SH_OTHER_BRANCHES is set it is taken as branch tips of already seen
  19 #   revisions when running show_new_revisions and mail.sh skips its own
  20 #   computation.  If it starts with '@' the rest is the hash of a blob that
  21 #   contains the information (one tip per line).
  22 #   If MAIL_SH_OTHER_BRANCHES is not set, guess at what they are.
  23 #   MAIL_SH_OTHER_BRANCHES is ignored if updates are piped in via stdin.
  24 # * Load shlib.
  25 # * Default subject prefix is site name.
  26 # * Unsubscribe instructions in email footer.
  27 # * Default showrev includes gitweb link and show -C.
  28 # * Nicer subject line.
  29 # * Limit mail size to 256kb.
  30 # =================
  31 #
  32 # This hook is stored in the contrib/hooks directory.  Your distribution
  33 # will have put this somewhere standard.  You should make this script
  34 # executable then link to it in the repository you would like to use it in.
  35 # For example, on debian the hook is stored in
  36 # /usr/share/git-core/contrib/hooks/post-receive-email:
  37 #
  38 #  chmod a+x post-receive-email
  39 #  cd /path/to/your/repository.git
  40 #  ln -sf /usr/share/git-core/contrib/hooks/post-receive-email hooks/post-receive
  41 #
  42 # This hook script assumes it is enabled on the central repository of a
  43 # project, with all users pushing only to it and not between each other.  It
  44 # will still work if you don't operate in that style, but it would become
  45 # possible for the email to be from someone other than the person doing the
  46 # push.
  47 #
  48 # Config
  49 # ------
  50 # hooks.mailinglist
  51 #   This is the list that all pushes will go to; leave it blank to not send
  52 #   emails for every ref update.
  53 # hooks.reverseorder
  54 #   If true new revisions are shown in reverse order (i.e. oldest to newest)
  55 # hooks.summaryonly
  56 #   If true do not include the actual diff when showing new commits (the
  57 #   summary information will still be shown).  Default is false.
  58 # hooks.announcelist
  59 #   This is the list that all pushes of annotated tags will go to.  Leave it
  60 #   blank to default to the mailinglist field.  The announce emails lists
  61 #   the short log summary of the changes since the last annotated tag.
  62 # hooks.envelopesender
  63 #   If set then the -f option is passed to sendmail to allow the envelope
  64 #   sender address to be set
  65 # hooks.emailprefix
  66 #   All emails have their subjects prefixed with this prefix, or "[SCM]"
  67 #   if emailprefix is unset, to aid filtering
  68 # hooks.showrev
  69 #   The shell command used to format each revision in the email, with
  70 #   "%s" replaced with the commit id.  Defaults to "git rev-list -1
  71 #   --pretty %s", displaying the commit id, author, date and log
  72 #   message.  To list full patches separated by a blank line, you
  73 #   could set this to "git show -C %s; echo".
  74 #   To list a gitweb/cgit URL *and* a full patch for each change set, use this:
  75 #     "t=%s; printf 'http://.../?id=%%s' \$t; echo;echo; git show -C \$t; echo"
  76 #   Be careful if "..." contains things that will be expanded by shell "eval"
  77 #   or printf.
  78 #
  79 # Notes
  80 # -----
  81 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
  82 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
  83 # give information for debugging.
  84 #
  85
  86 # ---------------------------- Functions
  87
  88 #
  89 # Function to output arguments without interpretation followed by \n
  90 #
  91 echol()
  92 {
  93         printf '%s\n' "$*"
  94 }
  95
  96 #
  97 # Function to read a tag's (the single argument) header fields into
  98 #   tagobject    the "object" value
  99 #   tagtype      the "type" value
 100 #   tagtag       the "tag" value
 101 #   taggername   from "tagger" value before first '<'
 102 #   taggerdate   from "tagger" value after '>' but formatted into a date string
 103 #   taggeremail  from "tagger" value between '<' and '>'
 104 # On return all fields will be set (to empty if failure) and the three tagger
 105 # fields will only be set to non-empty if a "tagger" header field is present.
 106 # If the object does not exist or is not a tag the function returns failure.
 107 read_tag_fields()
 108 {
 109         tagobject=
 110         tagtype=
 111         tagtag=
 112         taggername=
 113         taggerdate=
 114         taggeremail=
 115         if _tagfields="$(git cat-file tag "$1" | LC_ALL=C awk -F '[ ]' '
 116                         function quotesh(sv) {
 117                                 gsub(/'\''/, "'\'\\\\\'\''", sv)
 118                                 return "'\''" sv "'\''"
 119                         }
 120                         function trim(sv) {
 121                                 sub(/^[ \t]+/, "", sv)
 122                                 sub(/[ \t]+$/, "", sv)
 123                                 return sv
 124                         }
 125                         function hval(sv) {
 126                                 sub(/^[^ ]* /, "", sv)
 127                                 return sv
 128                         }
 129                         NR==1,/^$/ {
 130                                 if ($1 == "object") to=hval($0)
 131                                 if ($1 == "type") ty=hval($0)
 132                                 if ($1 == "tag") tt=hval($0)
 133                                 if ($1 == "tagger") tr=hval($0)
 134                         }
 135                         END {
 136                                 if (tt == "" || to == "" || ty == "") exit 1
 137                                 print "tagobject=" quotesh(to)
 138                                 print "tagtype=" quotesh(ty)
 139                                 print "tagtag=" quotesh(tt)
 140                                 if (match(tr, /^[ \t]*[^ \t<][^<]*/)) {
 141                                         tn=substr(tr, RSTART, RLENGTH)
 142                                         tr=substr(tr, RSTART + RLENGTH)
 143                                         tn=trim(tn)
 144                                         if (tn != "")
 145                                                 print "taggername=" quotesh(tn)
 146                                         if (match(tr, /^<.*>/)) {
 147                                                 if (RLENGTH > 2)
 148                                                         te=substr(tr, RSTART+1, RLENGTH-2)
 149                                                 tr=substr(tr, RSTART + RLENGTH)
 150                                                 te=trim(te)
 151                                                 if (te != "")
 152                                                         print "taggeremail=" quotesh(te)
 153                                                 if (match(tr, /^[ \t]*[0-9]+([ \t]+[-+]?[0-9][0-9]([0-9][0-9]([0-9][0-9])?)?)[ \t]*$/))
 154                                                         td=trim(tr)
 155                                                 if (td != "")
 156                                                         print "taggerdate=" quotesh(td)
 157                                         }
 158                                 }
 159                         }
 160                         ')"; then
 161                 eval "$_tagfields"
 162                 [ -z "$taggerdate" ] || taggerdate="$(strftime "$sdatefmt" $taggerdate)"
 163                 return 0
 164         fi
 165         return 1
 166 }
 167
 168 #
 169 # Function to prepare for email generation. This decides what type
 170 # of update this is and whether an email should even be generated.
 171 #
 172 prep_for_email()
 173 {
 174         # --- Arguments
 175         oldrev=$(git rev-parse --revs-only "$1" --)
 176         newrev=$(git rev-parse --revs-only "$2" --)
 177         [ "$oldrev" != "$newrev" ] || return 1
 178         scratch="${newrev#????????????????}"
 179         newrev16="${newrev%$scratch}"
 180         refname="$3"
 181
 182         # --- Interpret
 183         # 0000->1234 (create)
 184         # 1234->2345 (update)
 185         # 2345->0000 (delete)
 186         if LC_ALL=C expr "$oldrev" : '0*$' >/dev/null
 187         then
 188                 change_type="create"
 189         else
 190                 if LC_ALL=C expr "$newrev" : '0*$' >/dev/null
 191                 then
 192                         change_type="delete"
 193                 else
 194                         change_type="update"
 195                 fi
 196         fi
 197
 198         # --- Get the revision types
 199         newrev_type=$(git cat-file -t $newrev 2> /dev/null)
 200         oldrev_type=$(git cat-file -t "$oldrev" 2> /dev/null)
 201         case "$change_type" in
 202         create|update)
 203                 rev="$newrev"
 204                 rev_type="$newrev_type"
 205                 ;;
 206         delete)
 207                 rev="$oldrev"
 208                 rev_type="$oldrev_type"
 209                 ;;
 210         esac
 211
 212         # The revision type tells us what type the commit is, combined with
 213         # the location of the ref we can decide between
 214         #  - working branch
 215         #  - tracking branch
 216         #  - unannoted tag
 217         #  - annotated tag
 218         case "$refname","$rev_type" in
 219                 refs/tags/*,commit)
 220                         # un-annotated tag
 221                         refname_type="tag"
 222                         short_refname=${refname##refs/tags/}
 223                         ;;
 224                 refs/tags/*,tag)
 225                         # annotated tag
 226                         refname_type="annotated tag"
 227                         short_refname=${refname##refs/tags/}
 228                         # change recipients
 229                         if [ -n "$announcerecipients" ]; then
 230                                 recipients="$announcerecipients"
 231                         fi
 232                         ;;
 233                 refs/heads/*,commit|refs/heads/*,tag)
 234                         # branch
 235                         refname_type="branch"
 236                         short_refname=${refname##refs/heads/}
 237                         ;;
 238                 refs/remotes/*,commit)
 239                         # tracking branch
 240                         refname_type="tracking branch"
 241                         short_refname=${refname##refs/remotes/}
 242                         echol >&2 "*** Push-update of tracking branch, $refname"
 243                         echol >&2 "***  - no email generated."
 244                         return 1
 245                         ;;
 246                 refs/mob/*,commit|refs/mob/*,tag)
 247                         # personal mob ref
 248                         refname_type="personal mob ref"
 249                         short_refname=${refname##refs/mob/}
 250                         echol >&2 "*** Push-update of personal mob ref, $refname"
 251                         echol >&2 "***  - no email generated."
 252                         return 1
 253                         ;;
 254                 *)
 255                         # Anything else (is there anything else?)
 256                         echol >&2 "*** Unknown type of update to $refname ($rev_type)"
 257                         echol >&2 "***  - no email generated"
 258                         return 1
 259                         ;;
 260         esac
 261
 262         # Check if we've got anyone to send to
 263         if [ -z "$recipients" ]; then
 264                 case "$refname_type" in
 265                         "annotated tag")
 266                                 config_name="hooks.announcelist"
 267                                 ;;
 268                         *)
 269                                 config_name="hooks.mailinglist"
 270                                 ;;
 271                 esac
 272                 echol >&2 "*** $config_name is not set so no email will be sent"
 273                 echol >&2 "*** for $refname update $oldrev->$newrev"
 274                 return 1
 275         fi
 276
 277         return 0
 278 }
 279
 280 #
 281 # Top level email generation function.  This calls the appropriate
 282 # body-generation routine after outputting the common header.
 283 #
 284 # Note this function doesn't actually generate any email output, that is
 285 # taken care of by the functions it calls:
 286 #  - generate_email_header
 287 #  - generate_create_XXXX_email
 288 #  - generate_update_XXXX_email
 289 #  - generate_delete_XXXX_email
 290 #  - generate_email_footer
 291 #
 292 # Note also that this function cannot 'exit' from the script; when this
 293 # function is running (in hook script mode), the send_mail() function
 294 # is already executing in another process, connected via a pipe, and
 295 # if this function exits without, whatever has been generated to that
 296 # point will be sent as an email... even if nothing has been generated.
 297 #
 298 generate_email()
 299 {
 300         # Email parameters
 301         # The email subject will contain the best description of the ref
 302         # that we can build from the parameters
 303         describe=$(git describe $rev 2>/dev/null)
 304         if [ -z "$describe" ]; then
 305                 describe=$rev
 306         fi
 307
 308         generate_email_header
 309
 310         # Call the correct body generation function
 311         fn_name=general
 312         case "$refname_type" in
 313         "tracking branch"|branch)
 314                 fn_name=branch
 315                 ;;
 316         "annotated tag")
 317                 fn_name=atag
 318                 ;;
 319         esac
 320         generate_${change_type}_${fn_name}_email
 321
 322         generate_email_footer
 323 }
 324
 325 generate_email_header()
 326 {
 327         # --- Email (all stdout will be the email)
 328         # Generate header
 329         if [ -n "$emailsender" ]; then
 330                 echol "From: $emailsender"
 331         fi
 332         cat <<-EOF
 333         To: $recipients
 334         Subject: ${emailprefix}$projectname $refname_type $short_refname ${change_type}d: $describe
 335         MIME-Version: 1.0
 336         Content-Type: text/plain; charset=utf-8
 337         Content-Transfer-Encoding: 8bit
 338         EOF
 339         [ -n "$cfg_suppress_x_girocco" ] || echol "X-Girocco: $cfg_gitweburl"
 340         [ -z "$emailextraheader" ] || echol "$emailextraheader"
 341         cat <<-EOF
 342         X-Git-Refname: $refname
 343         X-Git-Reftype: $refname_type
 344         X-Git-Oldrev: $oldrev
 345         X-Git-Newrev: $newrev
 346         Auto-Submitted: auto-generated
 347
 348         This is an automated email generated because a ref change occurred in the
 349         git repository for project $projectname.
 350
 351         The $refname_type, $short_refname has been ${change_type}d
 352         EOF
 353 }
 354
 355 generate_email_footer()
 356 {
 357         SPACE=" "
 358         cat <<-EOF
 359
 360
 361         $cfg_name automatic notification. Contact project admin $projectowner
 362         if you want to unsubscribe, or site admin $cfg_admin if you receive
 363         no reply.
 364         --${SPACE}
 365         $projectboth
 366         EOF
 367 }
 368
 369 # --------------- Branches
 370
 371 #
 372 # Called for the creation of a branch
 373 #
 374 generate_create_branch_email()
 375 {
 376         # This is a new branch and so oldrev is not valid
 377         echol "        at  $newrev ($newrev_type)"
 378         echol ""
 379
 380         echol "Those revisions in this branch that are new to this repository"
 381         echol "have not appeared on any other notification email; so we list"
 382         echol "those revisions in full, below."
 383
 384         echol ""
 385         echol $LOGBEGIN
 386         show_new_revisions
 387         echol $LOGEND
 388
 389         # If any revisions were shown by show_new_revisions then we show
 390         # a diffstat from the last shown revisions's parent (or the empty tree
 391         # if the last revision shown is a root revision) to the new revision
 392         # provided the last shown revision is not a merge commit and there
 393         # was at most a single boundary commit encountered by show_new_revisions.
 394         # This is to show the truth of what happened in this change.
 395
 396         if [ -n "$LAST_SHOWN_REVISION" ] && [ -n "$LAST_SHOWN_NPARENTS" ] && [ -n "$LAST_SHOWN_NBOUNDARY" ] && \
 397            [ "$LAST_SHOWN_NPARENTS" -le 1 ] && [ "$LAST_SHOWN_NBOUNDARY" -le 1 ]; then
 398                 if [ "$LAST_SHOWN_NPARENTS" -eq 0 ]; then
 399                         # Note that since Git 1.5.5 the empty tree object is ALWAYS available
 400                         # whether or not it's actually present in the repository.
 401
 402                         # Set oldrev to the result of $(git hash-object -t tree --stdin < /dev/null)
 403                         oldrev="4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 404                 else
 405                         # Set oldrev to the parent of the last shown revision
 406                         oldrev="$LAST_SHOWN_REVISION^"
 407                 fi
 408                 echol ""
 409                 echol "Summary of changes:"
 410                 git diff-tree --no-color --stat=72 --summary -B --find-copies-harder $oldrev $newrev
 411         fi
 412 }
 413
 414 #
 415 # Called for the change of a pre-existing branch
 416 #
 417 generate_update_branch_email()
 418 {
 419         # Consider this:
 420         #   1 --- 2 --- O --- X --- 3 --- 4 --- N
 421         #
 422         # O is $oldrev for $refname
 423         # N is $newrev for $refname
 424         # X is a revision pointed to by some other ref, for which we may
 425         #   assume that an email has already been generated.
 426         # In this case we want to issue an email containing only revisions
 427         # 3, 4, and N.  Given (almost) by
 428         #
 429         #  git rev-list N ^O --not --all
 430         #
 431         # The reason for the "almost", is that the "--not --all" will take
 432         # precedence over the "N", and effectively will translate to
 433         #
 434         #  git rev-list N ^O ^X ^N
 435         #
 436         # So, we need to build up the list more carefully.  git rev-parse
 437         # will generate a list of revs that may be fed into git rev-list.
 438         # We can get it to make the "--not --all" part and then filter out
 439         # the "^N" with:
 440         #
 441         #  git rev-parse --not --all | grep -v N
 442         #
 443         # Then, using the --stdin switch to git rev-list we have effectively
 444         # manufactured
 445         #
 446         #  git rev-list N ^O ^X
 447         #
 448         # This leaves a problem when someone else updates the repository
 449         # while this script is running.  Their new value of the ref we're
 450         # working on would be included in the "--not --all" output; and as
 451         # our $newrev would be an ancestor of that commit, it would exclude
 452         # all of our commits.  What we really want is to exclude the current
 453         # value of $refname from the --not list, rather than N itself.  So:
 454         #
 455         #  git rev-parse --not --all | grep -v $(git rev-parse $refname)
 456         #
 457         # Get's us to something pretty safe (apart from the small time
 458         # between refname being read, and git rev-parse running - for that,
 459         # I give up)
 460         #
 461         #
 462         # Next problem, consider this:
 463         #   * --- B --- * --- O ($oldrev)
 464         #          \
 465         #           * --- X --- * --- N ($newrev)
 466         #
 467         # That is to say, there is no guarantee that oldrev is a strict
 468         # subset of newrev (it would have required a --force, but that's
 469         # allowed).  So, we can't simply say rev-list $oldrev..$newrev.
 470         # Instead we find the common base of the two revs and list from
 471         # there.
 472         #
 473         # As above, we need to take into account the presence of X; if
 474         # another branch is already in the repository and points at some of
 475         # the revisions that we are about to output - we don't want them.
 476         # The solution is as before: git rev-parse output filtered.
 477         #
 478         # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
 479         #
 480         # Tags pushed into the repository generate nice shortlog emails that
 481         # summarise the commits between them and the previous tag.  However,
 482         # those emails don't include the full commit messages that we output
 483         # for a branch update.  Therefore we still want to output revisions
 484         # that have been output on a tag email.
 485         #
 486         # Luckily, git rev-parse includes just the tool.  Instead of using
 487         # "--all" we use "--branches"; this has the added benefit that
 488         # "remotes/" will be ignored as well.
 489
 490         # List all of the revisions that were removed by this update, in a
 491         # fast-forward update, this list will be empty, because rev-list O
 492         # ^N is empty.  For a non-fast-forward, O ^N is the list of removed
 493         # revisions
 494         fast_forward=""
 495         rev=""
 496         for rev in $(git rev-list $newrev..$oldrev)
 497         do
 498                 revtype=$(git cat-file -t "$rev")
 499                 echol "  discards  $rev ($revtype)"
 500         done
 501         if [ -z "$rev" ]; then
 502                 fast_forward=1
 503         fi
 504
 505         # List all the revisions from baserev to newrev in a kind of
 506         # "table-of-contents"; note this list can include revisions that
 507         # have already had notification emails and is present to show the
 508         # full detail of the change from rolling back the old revision to
 509         # the base revision and then forward to the new revision
 510         for rev in $(git rev-list $oldrev..$newrev)
 511         do
 512                 revtype=$(git cat-file -t "$rev")
 513                 echol "       via  $rev ($revtype)"
 514         done
 515
 516         if [ "$fast_forward" ]; then
 517                 echol "      from  $oldrev ($oldrev_type)"
 518         else
 519                 #  1. Existing revisions were removed.  In this case newrev
 520                 #     is a subset of oldrev - this is the reverse of a
 521                 #     fast-forward, a rewind
 522                 #  2. New revisions were added on top of an old revision,
 523                 #     this is a rewind and addition.
 524
 525                 # (1) certainly happened, (2) possibly.  When (2) hasn't
 526                 # happened, we set a flag to indicate that no log printout
 527                 # is required.
 528
 529                 echol ""
 530
 531                 # Find the common ancestor of the old and new revisions and
 532                 # compare it with newrev
 533                 baserev=$(git merge-base $oldrev $newrev)
 534                 rewind_only=""
 535                 if [ "$baserev" = "$newrev" ]; then
 536                         echol "This update discarded existing revisions and left the branch pointing at"
 537                         echol "a previous point in the repository history."
 538                         echol ""
 539                         echol " * -- * -- N ($newrev)"
 540                         echol "            \\"
 541                         echol "             O -- O -- O ($oldrev)"
 542                         echol ""
 543                         echol "The removed revisions are not necessarily gone - if another reference"
 544                         echol "still refers to them they will stay in the repository."
 545                         rewind_only=1
 546                 else
 547                         echol "This update added new revisions after undoing existing revisions.  That is"
 548                         echol "to say, the old revision is not a strict subset of the new revision.  This"
 549                         echol "situation occurs when you --force push a change and generate a repository"
 550                         echol "containing something like this:"
 551                         echol ""
 552                         echol " * -- * -- B -- O -- O -- O ($oldrev)"
 553                         echol "            \\"
 554                         echol "             N -- N -- N ($newrev)"
 555                         echol ""
 556                         echol "When this happens we assume that you've already had alert emails for all"
 557                         echol "of the O revisions, and so we here report only the revisions in the N"
 558                         echol "branch from the common base, B."
 559                 fi
 560         fi
 561
 562         echol ""
 563         if [ -z "$rewind_only" ]; then
 564                 echol "Those revisions listed above that are new to this repository have"
 565                 echol "not appeared on any other notification email; so we list those"
 566                 echol "revisions in full, below."
 567
 568                 echol ""
 569                 echol $LOGBEGIN
 570                 show_new_revisions
 571
 572                 # XXX: Need a way of detecting whether git rev-list actually
 573                 # outputted anything, so that we can issue a "no new
 574                 # revisions added by this update" message
 575
 576                 echol $LOGEND
 577         else
 578                 echol "No new revisions were added by this update."
 579         fi
 580
 581         # The diffstat is shown from the old revision to the new revision.
 582         # This is to show the truth of what happened in this change.
 583         # There's no point showing the stat from the base to the new
 584         # revision because the base is effectively a random revision at this
 585         # point - the user will be interested in what this revision changed
 586         # - including the undoing of previous revisions in the case of
 587         # non-fast-forward updates.
 588         echol ""
 589         echol "Summary of changes:"
 590         git diff-tree --no-color --stat=72 --summary -B --find-copies-harder $oldrev..$newrev
 591 }
 592
 593 #
 594 # Called for the deletion of a branch
 595 #
 596 generate_delete_branch_email()
 597 {
 598         echol "       was  $oldrev"
 599         echol ""
 600         echol $LOGBEGIN
 601         git diff-tree --no-color --date=$datefmt -s --abbrev-commit --abbrev=$habbr --always --encoding=UTF-8 --pretty=oneline $oldrev
 602         echol $LOGEND
 603 }
 604
 605 # --------------- Annotated tags
 606
 607 #
 608 # Called for the creation of an annotated tag
 609 #
 610 generate_create_atag_email()
 611 {
 612         echol "        at  $newrev ($newrev_type)"
 613
 614         generate_atag_email
 615 }
 616
 617 #
 618 # Called for the update of an annotated tag (this is probably a rare event
 619 # and may not even be allowed)
 620 #
 621 generate_update_atag_email()
 622 {
 623         echol "        to  $newrev ($newrev_type)"
 624         echol "      from  $oldrev (which is now obsolete)"
 625
 626         generate_atag_email
 627 }
 628
 629 #
 630 # Called when an annotated tag is created or changed
 631 #
 632 generate_atag_email()
 633 {
 634         # Use read_tag_fields to pull out the individual fields from the
 635         # tag and git cat-file --batch-check to fully peel the tag if needed
 636         tagrev="$newrev"
 637         tagrev16="$newrev16"
 638         read_tag_fields "$tagrev"
 639         if [ "$tagtype" = "tag" ]; then
 640                 # fully peel the tag
 641                 peeledobject=
 642                 peeledtype=
 643                 info="$(echo "$tagrev^{}" | git cat-file --batch-check='
 644                 peeledobject=%(objectname)
 645                 peeledtype=%(objecttype)'
 646                 )"
 647                 case "$info" in *type=*) eval "$info";; *)
 648                         peeledtype=missing
 649                 esac
 650         else
 651                 peeledobject="$tagobject"
 652                 peeledtype="$tagtype"
 653         fi
 654
 655         echol "   tagging  $peeledobject ($peeledtype)"
 656         case "$peeledtype" in
 657         commit)
 658
 659                 # If the tagged object is a commit, then we assume this is a
 660                 # release, and so we calculate which tag this tag is
 661                 # replacing
 662                 prevtag=$(git describe --abbrev=0 "$peeledobject^" 2>/dev/null)
 663
 664                 if [ -n "$prevtag" ]; then
 665                         echol "  replaces  $prevtag"
 666                 fi
 667                 ;;
 668         *)
 669                 echol "    length  $(git cat-file -s "$peeledobject" 2>/dev/null) bytes"
 670                 ;;
 671         esac
 672         echol " tagged by  $taggername"
 673         echol "        on  $taggerdate"
 674
 675         echol ""
 676         echol $LOGBEGIN
 677
 678         while
 679                 echol "tag $tagrev"
 680                 echol "Tag:    $tagtag"
 681                 echol "Object: $tagobject ($tagtype)"
 682                 [ -z "$taggername" ] || \
 683                 echol "Tagger: $taggername"
 684                 [ -z "$taggerdate" ] || \
 685                 echol "Date:   $taggerdate"
 686                 echol "URL:    <$projurl/$tagrev16>"
 687                 echol ""
 688
 689                 # Show the content of the tag message; this might contain a change
 690                 # log or release notes so is worth displaying.
 691                 git cat-file tag "$tagrev" | LC_ALL=C sed -e '1,/^$/d;s/^/    /;'
 692                 echol ""
 693                 [ "$tagtype" = "tag" ]
 694         do
 695                 tagrev="$tagobject"
 696                 scratch="${tagrev#????????????????}"
 697                 tagrev16="${tagrev%$scratch}"
 698                 read_tag_fields "$tagrev" || break
 699         done
 700
 701         case "$peeledtype" in
 702         commit)
 703                 # Only commit tags make sense to have rev-list operations
 704                 # performed on them
 705                 if [ -n "$prevtag" ]; then
 706                         # Show changes since the previous release
 707                         git shortlog "$prevtag..$newrev"
 708                 else
 709                         # No previous tag, show all the changes since time
 710                         # began
 711                         git shortlog $newrev
 712                 fi
 713                 ;;
 714         *)
 715                 # XXX: Is there anything useful we can do for non-commit
 716                 # objects?
 717                 ;;
 718         esac
 719
 720         echol $LOGEND
 721 }
 722
 723 #
 724 # Called for the deletion of an annotated tag
 725 #
 726 generate_delete_atag_email()
 727 {
 728         echol "       was  $oldrev"
 729         echol ""
 730         echol $LOGBEGIN
 731         git diff-tree --no-color --date=$datefmt -s --abbrev-commit --abbrev=$habbr --always --encoding=UTF-8 --pretty=oneline $oldrev
 732         echol $LOGEND
 733 }
 734
 735 # --------------- General references
 736
 737 #
 738 # Called when any other type of reference is created (most likely a
 739 # non-annotated tag)
 740 #
 741 generate_create_general_email()
 742 {
 743         echol "        at  $newrev ($newrev_type)"
 744
 745         generate_general_email
 746 }
 747
 748 #
 749 # Called when any other type of reference is updated (most likely a
 750 # non-annotated tag)
 751 #
 752 generate_update_general_email()
 753 {
 754         echol "        to  $newrev ($newrev_type)"
 755         echol "      from  $oldrev"
 756
 757         generate_general_email
 758 }
 759
 760 #
 761 # Called for creation or update of any other type of reference
 762 #
 763 generate_general_email()
 764 {
 765         # Unannotated tags are more about marking a point than releasing a
 766         # version; therefore we don't do the shortlog summary that we do for
 767         # annotated tags above - we simply show that the point has been
 768         # marked, and print the log message for the marked point for
 769         # reference purposes
 770         #
 771         # Note this section also catches any other reference type (although
 772         # there aren't any) and deals with them in the same way.
 773
 774         echol ""
 775         if [ "$newrev_type" = "commit" ]; then
 776                 if [ -n "$(git rev-list --no-walk --merges $newrev)" ]; then
 777                         pfmt12="$pfmt1$pfmt1m$pfmt2"
 778                 else
 779                         pfmt12="$pfmt1$pfmt2"
 780                 fi
 781                 echol $LOGBEGIN
 782                 git diff-tree --no-color --date=$datefmt --root -s --always --encoding=UTF-8 --format="$pfmt12$projurlesc/$newrev16$pfmt3" --abbrev=$habbr $newrev
 783                 echol $LOGEND
 784         else
 785                 # What can we do here?  The tag marks an object that is not
 786                 # a commit, so there is no log for us to display.  It's
 787                 # probably not wise to output git cat-file as it could be a
 788                 # binary blob.  We'll just say how big it is
 789                 echol "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
 790         fi
 791 }
 792
 793 #
 794 # Called for the deletion of any other type of reference
 795 #
 796 generate_delete_general_email()
 797 {
 798         echol "       was  $oldrev"
 799         echol ""
 800         echol $LOGBEGIN
 801         git diff-tree --no-color --date=$datefmt -s --abbrev-commit --abbrev=$habbr --always --encoding=UTF-8 --pretty=oneline $oldrev
 802         echol $LOGEND
 803 }
 804
 805
 806 # --------------- Miscellaneous utilities
 807
 808 #
 809 # Show new revisions as the user would like to see them in the email.
 810 #
 811 # On return LAST_SHOWN_REVISION will be set to non-empty if any revisions shown
 812 # and LAST_SHOWN_NPARENTS will be the number of parents it has (possibly 0)
 813 # and LAST_SHOWN_NBOUNDARY will be the number of shown leaves (possibly 0)
 814 #
 815 show_new_revisions()
 816 {
 817         # This shows all log entries that are not already covered by
 818         # another ref - i.e. commits that are now accessible from this
 819         # ref that were previously not accessible
 820         # (see generate_update_branch_email for the explanation of this
 821         # command)
 822         LAST_SHOWN_REVISION=
 823         LAST_SHOWN_NPARENTS=
 824         LAST_SHOWN_NBOUNDARY=0
 825
 826         # Revision range passed to rev-list differs for new vs. updated
 827         # branches.
 828         if [ "$change_type" = create ]
 829         then
 830                 # Show all revisions exclusive to this (new) branch.
 831                 revspec=$newrev
 832         else
 833                 # Branch update; show revisions not part of $oldrev.
 834                 revspec=$oldrev..$newrev
 835         fi
 836
 837         if [ "${MAIL_SH_OTHER_BRANCHES+set}" = "set" ]; then
 838                 case "$MAIL_SH_OTHER_BRANCHES" in
 839                 @*)
 840                         othertips="git cat-file blob '${MAIL_SH_OTHER_BRANCHES#@}' 2>/dev/null"
 841                         ;;
 842                 *)
 843                         othertips='printf "%s\n" $MAIL_SH_OTHER_BRANCHES'
 844                         ;;
 845                 esac
 846         else
 847                 othertips='git for-each-ref --format="%(refname)" refs/heads |
 848                     LC_ALL=C awk -v "refname=$refname" "\$1 != refname"'
 849         fi
 850 #       if [ -z "$custom_showrev" ]
 851 #       then
 852 #               git rev-list --pretty --stdin $revspec
 853 #       else
 854                 while read onerev mark pcnt && [ -n "$onerev" ] && [ -n "$mark" ] && [ -n "$pcnt" ]
 855                 do
 856                         if [ "$mark" = "-" ]; then
 857                                 LAST_SHOWN_NBOUNDARY=$(( $LAST_SHOWN_NBOUNDARY + 1 ))
 858                                 continue
 859                         fi
 860                         if [ -z "$reverseopt" ] || [ -z "$LAST_SHOWN_REVISION" ]; then
 861                                 LAST_SHOWN_REVISION="$onerev"
 862                                 LAST_SHOWN_NPARENTS="$pcnt"
 863                         fi
 864                         if [ -n "$custom_showrev" ]; then
 865                                 eval $(printf "$custom_showrev" $onerev)
 866                         else
 867                                 if [ ${summaryonly:-false} = false ]; then
 868                                         if [ ${pcnt:-1} -gt 1 ]; then
 869                                                 opts="-p --cc"
 870                                                 pfmt12="$pfmt1$pfmt1m$pfmt2"
 871                                         else
 872                                                 opts="-p --stat=72 --summary"
 873                                                 pfmt12="$pfmt1$pfmt2"
 874                                         fi
 875                                 else
 876                                         if [ ${pcnt:-1} -gt 1 ]; then
 877                                                 opts="-s"
 878                                                 pfmt12="$pfmt1$pfmt1m$pfmt2"
 879                                         else
 880                                                 opts="--stat=72 --summary"
 881                                                 pfmt12="$pfmt1$pfmt2"
 882                                         fi
 883                                 fi
 884                                 scratch="${onerev#????????????????}"
 885                                 onerev16="${onerev%$scratch}"
 886                                 git diff-tree --no-color --date=$datefmt $opts --always --encoding=UTF-8 --format="$pfmt12$projurlesc/$onerev16$pfmt3" --abbrev=$habbr -B -C --root $onerev
 887                                 echo
 888                         fi
 889                 done <<EOT
 890 $(eval "$othertips" |
 891 git cat-file --batch-check='^%(objectname)' |
 892 LC_ALL=C sed -e '/ missing$/d' |
 893 git --no-pager log --stdin --no-color $reverseopt --boundary --format=tformat:"%H %m %p" $revspec |
 894 LC_ALL=C awk '{print $1 " " $2 " " NF-2}')
 895 EOT
 896 #       fi
 897 }
 898
 899
 900 size_limit()
 901 {
 902         size=0
 903         while IFS= read -r line; do
 904                 # Include size of RFC 822 trailing CR+LF on each line
 905                 size=$(($size+${#line}+2))
 906                 if [ $size -gt $1 ]; then
 907                         echol "...e-mail trimmed, has been too large."
 908                         break
 909                 fi
 910                 echol "$line"
 911         done
 912 }
 913
 914
 915 sendmail_to_stdout()
 916 {
 917         cat
 918 }
 919
 920
 921 send_mail()
 922 {
 923         if [ -n "$cfg_sender" ]; then
 924                 "${cfg_sendmail_bin:-/usr/sbin/sendmail}" -i -t -f "$cfg_sender"
 925         else
 926                 "${cfg_sendmail_bin:-/usr/sbin/sendmail}" -i -t
 927         fi
 928 }
 929
 930 # ---------------------------- main()
 931
 932 # --- Constants
 933 LOGBEGIN="- Log -----------------------------------------------------------------"
 934 LOGEND="-----------------------------------------------------------------------"
 935
 936 # --- Config
 937 . @basedir@/shlib.sh
 938
 939 # Git formatting to use
 940 datefmt=rfc2822
 941 habbr=12
 942
 943 # strftime formatting to use (empty is default rfc2822 format)
 944 sdatefmt=
 945
 946 # This is --pretty=medium in four parts with a URL: line added
 947 # The pfmt1m value must be inserted after the pfmt1 value but only for merges
 948 # The URL must be inserted between pfmt2 and pfmt3
 949 pfmt1='format:commit %H%n'
 950 pfmt1m='Merge: %p%n'
 951 pfmt2='Author: %an <%ae>%nDate:   %ad%nURL:    <'
 952 pfmt3='>%n%n%w(0,4,4)%s%n%n%b'
 953
 954 git_add_config core.abbrev=$habbr
 955
 956 # Set GIT_DIR either from the working directory, or from the environment
 957 # variable.
 958 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
 959 if [ -z "$GIT_DIR" ]; then
 960         echol >&2 "fatal: mail.sh: GIT_DIR not set"
 961         exit 1
 962 fi
 963
 964 projectdesc=
 965 ! [ -s "$GIT_DIR/description" ] || projectdesc=$(LC_ALL=C sed -ne '1p' "$GIT_DIR/description")
 966 # Check if the description is unchanged from it's default, and shorten it to
 967 # a more manageable length if it is
 968 if [ -z "$projectdesc" ] || LC_ALL=C expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
 969 then
 970         projectdesc="UNNAMED PROJECT"
 971 fi
 972
 973 # If --stdout is first argument send all output there instead of mailing
 974 if [ "$1" = "--stdout" ]; then
 975         shift
 976         cfg_sendmail_bin="sendmail_to_stdout"
 977 fi
 978
 979 projectname="${4%.git}"
 980 if [ -n "$projectname" ]; then
 981         projectname="$projectname.git"
 982         projectowner="$(config_get owner)"
 983 else
 984         projectname="$(basename "$PWD")"
 985 fi
 986 projectboth="$projectname (\"$projectdesc\")"
 987 projurl="$cfg_gitweburl/$projectname"
 988 projurlesc="$(printf '%s\n' "$projurl" | sed -e 's/%/%%/g')"
 989
 990 emailsender="$5"
 991 emailextraheader="$6"
 992
 993 recipients=$(git config hooks.mailinglist)
 994 summaryonly=$(git config --bool hooks.summaryonly 2>/dev/null || :)
 995 reverseopt=
 996 [ "$(git config --bool hooks.reverseorder 2>/dev/null || :)" != "true" ] || reverseopt=--reverse
 997 announcerecipients=$(git config hooks.announcelist)
 998 envelopesender=$(git config hooks.envelopesender)
 999 emailprefix=$(git config hooks.emailprefix || echol "[$cfg_name] ")
1000 custom_showrev=$(git config hooks.showrev)
1001
1002 # --- Main loop
1003 # Allow dual mode: run from the command line just like the update hook, or
1004 # if no arguments are given then run as a hook script
1005 # If --stdout is first argument send all output there instead (handled above)
1006 # Optional 4th (projectname), 5th (sender) and 6th (extra header) arguments
1007 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
1008         # Handle a single update rather than a batch on stdin
1009         # Output will still be sent to sendmail unless --stdout is used
1010         # Same 3 args as update hook (<refname> <old> <new>)
1011         if prep_for_email $2 $3 $1; then
1012                 PAGER= generate_email | size_limit $((256*1024)) | send_mail
1013         fi
1014 else
1015         # MAIL_SH_OTHER_BRANCHES cannot possibly be valid for multiple updates
1016         unset MAIL_SH_OTHER_BRANCHES
1017         # Same input as pre-receive hook (each line is <old> <new> <refname>)
1018         while read oldrev newrev refname
1019         do
1020                 prep_for_email $oldrev $newrev $refname || continue
1021                 PAGER= generate_email | size_limit $((256*1024)) | send_mail
1022         done
1023 fi
1024
1025 exit 0