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