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