Project.pm: add "Tag notify" field and clean them all up
[girocco/readme.git] / taskd / mail.sh
blob46c3e87d9c5a581c4fac01f1ba607e030ad7cf7c
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 and show -C.
21 # * Nicer subject line.
22 # * Limit mail size to 256kb.
23 # =================
25 # This hook is stored in the contrib/hooks directory. Your distribution
26 # will have put this somewhere standard. You should make this script
27 # executable then link to it in the repository you would like to use it in.
28 # For example, on debian the hook is stored in
29 # /usr/share/git-core/contrib/hooks/post-receive-email:
31 # chmod a+x post-receive-email
32 # cd /path/to/your/repository.git
33 # ln -sf /usr/share/git-core/contrib/hooks/post-receive-email hooks/post-receive
35 # This hook script assumes it is enabled on the central repository of a
36 # project, with all users pushing only to it and not between each other. It
37 # will still work if you don't operate in that style, but it would become
38 # possible for the email to be from someone other than the person doing the
39 # push.
41 # Config
42 # ------
43 # hooks.mailinglist
44 # This is the list that all pushes will go to; leave it blank to not send
45 # emails for every ref update.
46 # hooks.announcelist
47 # This is the list that all pushes of annotated tags will go to. Leave it
48 # blank to default to the mailinglist field. The announce emails lists
49 # the short log summary of the changes since the last annotated tag.
50 # hooks.envelopesender
51 # If set then the -f option is passed to sendmail to allow the envelope
52 # sender address to be set
53 # hooks.emailprefix
54 # All emails have their subjects prefixed with this prefix, or "[SCM]"
55 # if emailprefix is unset, to aid filtering
56 # hooks.showrev
57 # The shell command used to format each revision in the email, with
58 # "%s" replaced with the commit id. Defaults to "git rev-list -1
59 # --pretty %s", displaying the commit id, author, date and log
60 # message. To list full patches separated by a blank line, you
61 # could set this to "git show -C %s; echo".
62 # To list a gitweb/cgit URL *and* a full patch for each change set, use this:
63 # "t=%s; printf 'http://.../?id=%%s' \$t; echo;echo; git show -C \$t; echo"
64 # Be careful if "..." contains things that will be expanded by shell "eval"
65 # or printf.
67 # Notes
68 # -----
69 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",
70 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and
71 # give information for debugging.
74 # ---------------------------- Functions
77 # Function to output arguments without interpretation followed by \n
79 echol()
81 printf '%s\n' "$*"
85 # Function to prepare for email generation. This decides what type
86 # of update this is and whether an email should even be generated.
88 prep_for_email()
90 # --- Arguments
91 oldrev=$(git rev-parse $1)
92 newrev=$(git rev-parse $2)
93 refname="$3"
95 # --- Interpret
96 # 0000->1234 (create)
97 # 1234->2345 (update)
98 # 2345->0000 (delete)
99 if expr "$oldrev" : '0*$' >/dev/null
100 then
101 change_type="create"
102 else
103 if expr "$newrev" : '0*$' >/dev/null
104 then
105 change_type="delete"
106 else
107 change_type="update"
111 # --- Get the revision types
112 newrev_type=$(git cat-file -t $newrev 2> /dev/null)
113 oldrev_type=$(git cat-file -t "$oldrev" 2> /dev/null)
114 case "$change_type" in
115 create|update)
116 rev="$newrev"
117 rev_type="$newrev_type"
119 delete)
120 rev="$oldrev"
121 rev_type="$oldrev_type"
123 esac
125 # The revision type tells us what type the commit is, combined with
126 # the location of the ref we can decide between
127 # - working branch
128 # - tracking branch
129 # - unannoted tag
130 # - annotated tag
131 case "$refname","$rev_type" in
132 refs/tags/*,commit)
133 # un-annotated tag
134 refname_type="tag"
135 short_refname=${refname##refs/tags/}
137 refs/tags/*,tag)
138 # annotated tag
139 refname_type="annotated tag"
140 short_refname=${refname##refs/tags/}
141 # change recipients
142 if [ -n "$announcerecipients" ]; then
143 recipients="$announcerecipients"
146 refs/heads/*,commit)
147 # branch
148 refname_type="branch"
149 short_refname=${refname##refs/heads/}
151 refs/remotes/*,commit)
152 # tracking branch
153 refname_type="tracking branch"
154 short_refname=${refname##refs/remotes/}
155 echol >&2 "*** Push-update of tracking branch, $refname"
156 echol >&2 "*** - no email generated."
157 return 1
159 refs/mob/*,commit|refs/mob/*,tag)
160 # personal mob ref
161 refname_type="personal mob ref"
162 short_refname=${refname##refs/mob/}
163 echol >&2 "*** Push-update of personal mob ref, $refname"
164 echol >&2 "*** - no email generated."
165 return 1
168 # Anything else (is there anything else?)
169 echol >&2 "*** Unknown type of update to $refname ($rev_type)"
170 echol >&2 "*** - no email generated"
171 return 1
173 esac
175 # Check if we've got anyone to send to
176 if [ -z "$recipients" ]; then
177 case "$refname_type" in
178 "annotated tag")
179 config_name="hooks.announcelist"
182 config_name="hooks.mailinglist"
184 esac
185 echol >&2 "*** $config_name is not set so no email will be sent"
186 echol >&2 "*** for $refname update $oldrev->$newrev"
187 return 1
190 return 0
194 # Top level email generation function. This calls the appropriate
195 # body-generation routine after outputting the common header.
197 # Note this function doesn't actually generate any email output, that is
198 # taken care of by the functions it calls:
199 # - generate_email_header
200 # - generate_create_XXXX_email
201 # - generate_update_XXXX_email
202 # - generate_delete_XXXX_email
203 # - generate_email_footer
205 # Note also that this function cannot 'exit' from the script; when this
206 # function is running (in hook script mode), the send_mail() function
207 # is already executing in another process, connected via a pipe, and
208 # if this function exits without, whatever has been generated to that
209 # point will be sent as an email... even if nothing has been generated.
211 generate_email()
213 # Email parameters
214 # The email subject will contain the best description of the ref
215 # that we can build from the parameters
216 describe=$(git describe $rev 2>/dev/null)
217 if [ -z "$describe" ]; then
218 describe=$rev
221 generate_email_header
223 # Call the correct body generation function
224 fn_name=general
225 case "$refname_type" in
226 "tracking branch"|branch)
227 fn_name=branch
229 "annotated tag")
230 fn_name=atag
232 esac
233 generate_${change_type}_${fn_name}_email
235 generate_email_footer
238 generate_email_header()
240 # --- Email (all stdout will be the email)
241 # Generate header
242 if [ -n "$emailsender" ]; then
243 echol "From: $emailsender"
245 cat <<-EOF
246 To: $recipients
247 Subject: ${emailprefix}$projectname $refname_type $short_refname ${change_type}d: $describe
248 MIME-Version: 1.0
249 Content-Type: text/plain; charset=utf-8
250 Content-Transfer-Encoding: 8bit
252 [ -z "$emailextraheader" ] || echol "$emailextraheader"
253 cat <<-EOF
254 X-Git-Refname: $refname
255 X-Git-Reftype: $refname_type
256 X-Git-Oldrev: $oldrev
257 X-Git-Newrev: $newrev
258 Auto-Submitted: auto-generated
260 This is an automated email from the git hooks/post-receive script. It was
261 generated because a ref change was pushed to the repository containing
262 the project $projectname.
264 The $refname_type, $short_refname has been ${change_type}d
268 generate_email_footer()
270 SPACE=" "
271 cat <<-EOF
274 $cfg_name automatic notification. Contact project admin $projectowner
275 if you want to unsubscribe, or site admin $cfg_admin if you receive
276 no reply.
277 --${SPACE}
278 $projectboth
282 # --------------- Branches
285 # Called for the creation of a branch
287 generate_create_branch_email()
289 # This is a new branch and so oldrev is not valid
290 echol " at $newrev ($newrev_type)"
291 echol ""
293 echol $LOGBEGIN
294 show_new_revisions
295 echol $LOGEND
299 # Called for the change of a pre-existing branch
301 generate_update_branch_email()
303 # Consider this:
304 # 1 --- 2 --- O --- X --- 3 --- 4 --- N
306 # O is $oldrev for $refname
307 # N is $newrev for $refname
308 # X is a revision pointed to by some other ref, for which we may
309 # assume that an email has already been generated.
310 # In this case we want to issue an email containing only revisions
311 # 3, 4, and N. Given (almost) by
313 # git rev-list N ^O --not --all
315 # The reason for the "almost", is that the "--not --all" will take
316 # precedence over the "N", and effectively will translate to
318 # git rev-list N ^O ^X ^N
320 # So, we need to build up the list more carefully. git rev-parse
321 # will generate a list of revs that may be fed into git rev-list.
322 # We can get it to make the "--not --all" part and then filter out
323 # the "^N" with:
325 # git rev-parse --not --all | grep -v N
327 # Then, using the --stdin switch to git rev-list we have effectively
328 # manufactured
330 # git rev-list N ^O ^X
332 # This leaves a problem when someone else updates the repository
333 # while this script is running. Their new value of the ref we're
334 # working on would be included in the "--not --all" output; and as
335 # our $newrev would be an ancestor of that commit, it would exclude
336 # all of our commits. What we really want is to exclude the current
337 # value of $refname from the --not list, rather than N itself. So:
339 # git rev-parse --not --all | grep -v $(git rev-parse $refname)
341 # Get's us to something pretty safe (apart from the small time
342 # between refname being read, and git rev-parse running - for that,
343 # I give up)
346 # Next problem, consider this:
347 # * --- B --- * --- O ($oldrev)
349 # * --- X --- * --- N ($newrev)
351 # That is to say, there is no guarantee that oldrev is a strict
352 # subset of newrev (it would have required a --force, but that's
353 # allowed). So, we can't simply say rev-list $oldrev..$newrev.
354 # Instead we find the common base of the two revs and list from
355 # there.
357 # As above, we need to take into account the presence of X; if
358 # another branch is already in the repository and points at some of
359 # the revisions that we are about to output - we don't want them.
360 # The solution is as before: git rev-parse output filtered.
362 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
364 # Tags pushed into the repository generate nice shortlog emails that
365 # summarise the commits between them and the previous tag. However,
366 # those emails don't include the full commit messages that we output
367 # for a branch update. Therefore we still want to output revisions
368 # that have been output on a tag email.
370 # Luckily, git rev-parse includes just the tool. Instead of using
371 # "--all" we use "--branches"; this has the added benefit that
372 # "remotes/" will be ignored as well.
374 # List all of the revisions that were removed by this update, in a
375 # fast-forward update, this list will be empty, because rev-list O
376 # ^N is empty. For a non-fast-forward, O ^N is the list of removed
377 # revisions
378 fast_forward=""
379 rev=""
380 for rev in $(git rev-list $newrev..$oldrev)
382 revtype=$(git cat-file -t "$rev")
383 echol " discards $rev ($revtype)"
384 done
385 if [ -z "$rev" ]; then
386 fast_forward=1
389 # List all the revisions from baserev to newrev in a kind of
390 # "table-of-contents"; note this list can include revisions that
391 # have already had notification emails and is present to show the
392 # full detail of the change from rolling back the old revision to
393 # the base revision and then forward to the new revision
394 for rev in $(git rev-list $oldrev..$newrev)
396 revtype=$(git cat-file -t "$rev")
397 echol " via $rev ($revtype)"
398 done
400 if [ "$fast_forward" ]; then
401 echol " from $oldrev ($oldrev_type)"
402 else
403 # 1. Existing revisions were removed. In this case newrev
404 # is a subset of oldrev - this is the reverse of a
405 # fast-forward, a rewind
406 # 2. New revisions were added on top of an old revision,
407 # this is a rewind and addition.
409 # (1) certainly happened, (2) possibly. When (2) hasn't
410 # happened, we set a flag to indicate that no log printout
411 # is required.
413 echol ""
415 # Find the common ancestor of the old and new revisions and
416 # compare it with newrev
417 baserev=$(git merge-base $oldrev $newrev)
418 rewind_only=""
419 if [ "$baserev" = "$newrev" ]; then
420 echol "This update discarded existing revisions and left the branch pointing at"
421 echol "a previous point in the repository history."
422 echol ""
423 echol " * -- * -- N ($newrev)"
424 echol " \\"
425 echol " O -- O -- O ($oldrev)"
426 echol ""
427 echol "The removed revisions are not necessarily gone - if another reference"
428 echol "still refers to them they will stay in the repository."
429 rewind_only=1
430 else
431 echol "This update added new revisions after undoing existing revisions. That is"
432 echol "to say, the old revision is not a strict subset of the new revision. This"
433 echol "situation occurs when you --force push a change and generate a repository"
434 echol "containing something like this:"
435 echol ""
436 echol " * -- * -- B -- O -- O -- O ($oldrev)"
437 echol " \\"
438 echol " N -- N -- N ($newrev)"
439 echol ""
440 echol "When this happens we assume that you've already had alert emails for all"
441 echol "of the O revisions, and so we here report only the revisions in the N"
442 echol "branch from the common base, B."
446 echol ""
447 if [ -z "$rewind_only" ]; then
448 echol "Those revisions listed above that are new to this repository have"
449 echol "not appeared on any other notification email; so we list those"
450 echol "revisions in full, below."
452 echol ""
453 echol $LOGBEGIN
454 show_new_revisions
456 # XXX: Need a way of detecting whether git rev-list actually
457 # outputted anything, so that we can issue a "no new
458 # revisions added by this update" message
460 echol $LOGEND
461 else
462 echol "No new revisions were added by this update."
465 # The diffstat is shown from the old revision to the new revision.
466 # This is to show the truth of what happened in this change.
467 # There's no point showing the stat from the base to the new
468 # revision because the base is effectively a random revision at this
469 # point - the user will be interested in what this revision changed
470 # - including the undoing of previous revisions in the case of
471 # non-fast-forward updates.
472 echol ""
473 echol "Summary of changes:"
474 git diff-tree --no-color --stat --summary --find-copies-harder $oldrev..$newrev
478 # Called for the deletion of a branch
480 generate_delete_branch_email()
482 echol " was $oldrev"
483 echol ""
484 echol $LOGBEGIN
485 git diff-tree --no-color -s --always --encoding=UTF-8 --pretty=oneline $oldrev
486 echol $LOGEND
489 # --------------- Annotated tags
492 # Called for the creation of an annotated tag
494 generate_create_atag_email()
496 echol " at $newrev ($newrev_type)"
498 generate_atag_email
502 # Called for the update of an annotated tag (this is probably a rare event
503 # and may not even be allowed)
505 generate_update_atag_email()
507 echol " to $newrev ($newrev_type)"
508 echol " from $oldrev (which is now obsolete)"
510 generate_atag_email
514 # Called when an annotated tag is created or changed
516 generate_atag_email()
518 # Use git for-each-ref to pull out the individual fields from the
519 # tag
520 eval $(git for-each-ref --shell --format='
521 tagobject=%(*objectname)
522 tagtype=%(*objecttype)
523 tagger=%(taggername)
524 tagged=%(taggerdate)' $refname
527 echol " tagging $tagobject ($tagtype)"
528 case "$tagtype" in
529 commit)
531 # If the tagged object is a commit, then we assume this is a
532 # release, and so we calculate which tag this tag is
533 # replacing
534 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)
536 if [ -n "$prevtag" ]; then
537 echol " replaces $prevtag"
541 echol " length $(git cat-file -s $tagobject) bytes"
543 esac
544 echol " tagged by $tagger"
545 echol " on $tagged"
547 echol ""
548 echol $LOGBEGIN
550 # Show the content of the tag message; this might contain a change
551 # log or release notes so is worth displaying.
552 git cat-file tag $newrev | sed -e '1,/^$/d'
554 echol ""
555 case "$tagtype" in
556 commit)
557 # Only commit tags make sense to have rev-list operations
558 # performed on them
559 if [ -n "$prevtag" ]; then
560 # Show changes since the previous release
561 git shortlog "$prevtag..$newrev"
562 else
563 # No previous tag, show all the changes since time
564 # began
565 git shortlog $newrev
569 # XXX: Is there anything useful we can do for non-commit
570 # objects?
572 esac
574 echol $LOGEND
578 # Called for the deletion of an annotated tag
580 generate_delete_atag_email()
582 echol " was $oldrev"
583 echol ""
584 echol $LOGBEGIN
585 git diff-tree --no-color -s --always --encoding=UTF-8 --pretty=oneline $oldrev
586 echol $LOGEND
589 # --------------- General references
592 # Called when any other type of reference is created (most likely a
593 # non-annotated tag)
595 generate_create_general_email()
597 echol " at $newrev ($newrev_type)"
599 generate_general_email
603 # Called when any other type of reference is updated (most likely a
604 # non-annotated tag)
606 generate_update_general_email()
608 echol " to $newrev ($newrev_type)"
609 echol " from $oldrev"
611 generate_general_email
615 # Called for creation or update of any other type of reference
617 generate_general_email()
619 # Unannotated tags are more about marking a point than releasing a
620 # version; therefore we don't do the shortlog summary that we do for
621 # annotated tags above - we simply show that the point has been
622 # marked, and print the log message for the marked point for
623 # reference purposes
625 # Note this section also catches any other reference type (although
626 # there aren't any) and deals with them in the same way.
628 echol ""
629 if [ "$newrev_type" = "commit" ]; then
630 echol $LOGBEGIN
631 git diff-tree --no-color --root -s --always --encoding=UTF-8 --pretty=medium $newrev
632 echol $LOGEND
633 else
634 # What can we do here? The tag marks an object that is not
635 # a commit, so there is no log for us to display. It's
636 # probably not wise to output git cat-file as it could be a
637 # binary blob. We'll just say how big it is
638 echol "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
643 # Called for the deletion of any other type of reference
645 generate_delete_general_email()
647 echol " was $oldrev"
648 echol ""
649 echol $LOGBEGIN
650 git diff-tree --no-color -s --always --encoding=UTF-8 --pretty=oneline $oldrev
651 echol $LOGEND
655 # --------------- Miscellaneous utilities
658 # Show new revisions as the user would like to see them in the email.
660 show_new_revisions()
662 # This shows all log entries that are not already covered by
663 # another ref - i.e. commits that are now accessible from this
664 # ref that were previously not accessible
665 # (see generate_update_branch_email for the explanation of this
666 # command)
668 # Revision range passed to rev-list differs for new vs. updated
669 # branches.
670 if [ "$change_type" = create ]
671 then
672 # Show all revisions exclusive to this (new) branch.
673 revspec=$newrev
674 else
675 # Branch update; show revisions not part of $oldrev.
676 revspec=$oldrev..$newrev
679 other_branches=$(git for-each-ref --format='%(refname)' refs/heads/ |
680 grep -F -v $refname)
681 git rev-parse --not $other_branches |
682 # if [ -z "$custom_showrev" ]
683 # then
684 # git rev-list --pretty --stdin $revspec
685 # else
686 git rev-list --stdin $revspec |
687 while read onerev
689 if [ -n "$custom_showrev" ]; then
690 eval $(printf "$custom_showrev" $onerev)
691 else
692 echol "$cfg_gitweburl/$projectname/commit/$onerev"
693 echo
694 git diff-tree --no-color -p --always --encoding=UTF-8 --pretty=medium -C $onerev
695 echo
697 done
698 # fi
702 size_limit()
704 size=0
705 while IFS= read -r line; do
706 # Include size of RFC 822 trailing CR+LF on each line
707 size=$(($size+${#line}+2))
708 if [ $size -gt $1 ]; then
709 echol "...e-mail trimmed, has been too large."
710 break
712 echol "$line"
713 done
717 send_mail()
719 if [ -n "$cfg_sender" ]; then
720 "${cfg_sendmail_bin:-/usr/sbin/sendmail}" -i -t -f "$cfg_sender"
721 else
722 "${cfg_sendmail_bin:-/usr/sbin/sendmail}" -i -t
726 # ---------------------------- main()
728 # --- Constants
729 LOGBEGIN="- Log -----------------------------------------------------------------"
730 LOGEND="-----------------------------------------------------------------------"
732 # --- Config
733 . @basedir@/shlib.sh
735 # Set GIT_DIR either from the working directory, or from the environment
736 # variable.
737 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)
738 if [ -z "$GIT_DIR" ]; then
739 echol >&2 "fatal: post-receive: GIT_DIR not set"
740 exit 1
743 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")
744 # Check if the description is unchanged from it's default, and shorten it to
745 # a more manageable length if it is
746 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null
747 then
748 projectdesc="UNNAMED PROJECT"
751 projectname="$4"
752 if [ -n "$projectname" ]; then
753 projectname="$projectname.git"
754 projectboth="$projectname (\"$projectdesc\")"
755 projectowner="$(config_get owner)"
756 else
757 projectname="$projectdesc"
758 projectboth="$projectdesc"
761 emailsender="$5"
762 emailextraheader="$6"
764 recipients=$(git config hooks.mailinglist)
765 announcerecipients=$(git config hooks.announcelist)
766 envelopesender=$(git config hooks.envelopesender)
767 emailprefix=$(git config hooks.emailprefix || echol "[$cfg_name] ")
768 custom_showrev=$(git config hooks.showrev)
770 # --- Main loop
771 # Allow dual mode: run from the command line just like the update hook, or
772 # if no arguments are given then run as a hook script
773 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then
774 # Output to the terminal in command line mode - if someone wanted to
775 # resend an email; they could redirect the output to sendmail
776 # themselves
777 if prep_for_email $2 $3 $1; then
778 PAGER= generate_email | size_limit $((256*1024)) | send_mail
780 else
781 while read oldrev newrev refname
783 prep_for_email $oldrev $newrev $refname || continue
784 PAGER= generate_email | size_limit $((256*1024)) | send_mail
785 done
788 exit 0