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