gitmail 31.5 KB
Newer Older
1
2
#!/usr/bin/perl -w
#
3
# EMULAB-COPYRIGHT
4
# Copyright (c) 2009-2011 University of Utah and the Flux Group.
5
# All rights reserved.
6
#
7
# To set this script up:
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# 1) Copy or link it to .git/hooks/post-receive in your repository. Make sure
#    it's world-readable and executable.
# 2) Set configuration options by editng the values of variables directly
#    below
#       OR
#    Set the simple values with git options: run
#       git config --add hooks.gitmail.<optname> value
#       (for example:
#           git config --add hooks.gitmail.alwaysmail ricci@cs.utah.edu
# 3) Test it by running it with the -d and -t options, which will not send
#    mail and will give you a chance to make sure everything looks right
#
# TODO:
#    Users can add notifications for themselves
#

use strict;
25
use IPC::Open2;
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
use POSIX 'setsid';
use Getopt::Long;
sub get_config($$);
my $CONFIGBASE = "hooks.gitmail";

######################################################################
# Configuration Options
# Options that use get_config can be set using 'git config' - if not
# set, the second parameter is used as the default
######################################################################

#
# If debugging is enabled, prints a lot of messages and doesn't actually send
# mail.
#
my $debug = get_config("debug",undef);

#
# If set, just picks up the most recent commits instead of reading them from
# stdin. Note that this one doesn't look in the git config; that wouldn't
# make any sense.
#
my $testmode = undef;

50
#
51
52
53
# If set, hide trivial merges (those where no diff hunks needed to be modified
# as part of the merge).  Trivial merges that have a non-empty commit message
# are still shown in case the committer decided to document the merge.
54
55
56
#
my $hide_trivial_merges = get_config("hidetrivialmerges",undef);

57
58
59
60
61
#
# Command-line options - have to do this before setting other options, since
# we want to be able to turn on debugging early
#
my %opt;
62
Getopt::Long::Configure("no_ignore_case");
63
64
if (!GetOptions(\%opt, 'd', 'h', 't', 'T=s', 'C=s', 'o=s@')
        || @ARGV || $opt{h}) {
65
    print STDERR "Usage: gitmail [-h|-d]\n";
66
67
68
69
    print STDERR "  -h     this message\n";
    print STDERR "  -d     enable debugging output and don't send mail\n";
    print STDERR "  -t     test mode - operate on last 3 commits to master\n";
    print STDERR "  -T br  like '-t', but use branch 'br' instead of master\n";
70
    print STDERR "  -C n   in test mode, use the last n commits for testing \n";
71
72
    print STDERR "  -o o=v give option o the value v (may be given multiple\n";
    print STDERR "         times)\n";
73
    exit 1;
74
75
}

76
my $testbranch = "master";
77
my $testcommits = 3;
78
79
if ($opt{d}) { $debug    = 1; }
if ($opt{t}) { $testmode = 1; }
80
if ($opt{T}) { $testmode = 1; $testbranch = $opt{T} }
81
if ($opt{C}) { $testcommits = $opt{C} }
82
83
84
85
86
87
88
89

#
# Name of this repository - set it to a string to get it included in the
# mail subject line and the X-Git-Repo header
#
my $reponame = get_config("reponame",undef);

#
90
91
92
93
94
95
96
97
# Data structure mapping branch names and path names to email address. Each
# entry is a triple:
#    Branch name
#    File path
#    Mail address
# If *both* the branch and path match for a commit, mail will be sent to the
# associated address. The branch and paths are interpreted as perl regexps,
# with the special value 'undef' matching anything at all. Any of these may
98
# be array references: for the branch and path fields, if *any* of the
99
100
# elements in the array match, the field is considered to match. For the email
# address field, the mail will be sent to all addresses in the array.
101
102
#
# *NOTE* This are perl regexps, not shell globs! *NOTE*
103
# *NOTE* This can also be read from a file - see below *NOTE*
104
#
105
106
107
108
109
110
111
112
113
my @mailto = (
  # Branch              # Path             # Send mail to
# Examples
# [ undef,              undef,             'cvs-testbed@flux.utah.edu' ],
# [ undef,              'snmpit',         ['ricci@flux.utah.edu',
#                                          'sklower@vangogh.cs.berkeley.edu']],
# [ ['^ricci-',
#    '^test-'],         'assign/',         'ricci+assign@flux.utah.edu'],
# [ 'gitmail',          'tools/git',       'ricci+git@flux.utah.edu']
114
115
);

116
117
118
119
120
121
122
123
124
125
#
# If set, look in a file for the @mailto structure.  This file should be
# executable perl code that returns an array following the same format as the
# @mailto array below. For example, the file could contain:
# ( [ undef, undef, 'me@example.com'] )
#
# *NOTE* If this is set, overrides the @mailto setting above *NOTE*
#
my $mailconfigfile = get_config("mailconfigfile",undef);

126
127
128
129
130
131
132
133
134
135
#
# Default mail address - if none of the more specific regular expressions
# match, send to this address
#
my $defmail = get_config("defmail",undef);

#
# If set, *always* send mail to this address (even if one or more regexps
# match). ($defmail will still be used if no regexps match)
#
136
137
my @alwaysmail = get_config("alwaysmail",undef);

138
139
140
141
142
143
144
#
# This works exactly like alwaysmail, but it causes seperate mail to get sent
# to each address (this mail is also seperate from the 'main' message that will
# get sent to all of the other addresses)
#
my @archivemail = get_config("archivemail",undef);

145
146
147
148
149
#
# If set, set the 'Reply-To' header in the mail, so that discussion can
# take place on, for example, a particular development mailing list
#
my $replyto = get_config("replyto",undef);
150
151
152
153
154
155
156
157
158
159
160
161
162
163

#
# If set to true, detach and run in background - the push doesn't return until
# the hook finishes, so doing this means the pusher doesn't have to wait for
# us to finish
# Note: Not well tested!
#
my $detach = get_config("detach",undef);

#
# If set to true, send a separate mail message for every single commit. If
# false, pushes of multiple commits along a branch get included in the same
# mail.
#
164
165
166
167
168
169
170
my $separate_mail = get_config("separatemail",undef);

#
# If set, these arguments will be passed *in addition* to the regular arguments
# to 'git show' to produce descriptions of commits
#
my $showcommit_extra = get_config("showcommitextra",undef);
171

Ryan Jackson's avatar
Ryan Jackson committed
172
173
174
175
#
# If set, check all commit objects to see if they exist in the repository
# at the specified path.  If a commit object exists in this repository,
# do not include its log in the email message.
176
177
178
# Note: This should point at the .git directory - for a 'bare' repository,
# this is just the path the repository. For a 'reglar' repository, this is the
# .git/ directory *inside* the repositry.
Ryan Jackson's avatar
Ryan Jackson committed
179
180
181
#
my $exclude_repo = get_config("excluderepo",undef);

182
183
184
185
186
187
188
#
# If set, these values will be used to create 'X-Git-Repo-Keyword' headers, one
# for each value.  This is to facilitate filtering of commit mails for those only
# interested in certain projects.
#
my @repo_keywords = get_config("keyword",undef);

189
190
191
192
193
194
195
196
197
######################################################################
# Constants
######################################################################

#
# Programs we use
#
my $GIT = "git";
my $SENDMAIL = get_config("sendmail","sendmail");
198
my $HOSTNAME = get_config("hostname","hostname");
199
200
201
202
203
204
205
206
207
208
209
210

#
# Magic 'hash' that indicates an empty or non-existant rev
#
my $EMPTYREV = "0"x40;

#
# Types of changes
#
my $CT_CREATE = "create";
my $CT_UPDATE = "update";
my $CT_DELETE = "delete";
211
212
my $CT_REWIND = "rewind";
my $CT_REBASE = "rebase";
213
214
215
216
217
218
219
220
221

#
# Tired of typing this and getting it wrong
#
my $STDERRNULL = " 2> /dev/null";

######################################################################
# Function Prototypes
######################################################################
222
223
sub change_type($$$);
sub ref_type($);
224
225
sub rev_type($);
sub revparse($);
226
sub changed_files(@);
227
sub get_mail_addresses($@);
228
sub get_merge_base($$);
229
230
sub uniq(@);
sub flatten_arrayref($);
Ryan Jackson's avatar
Ryan Jackson committed
231
sub commit_mail($\@$@);
232
sub get_commits($$$);
Robert Ricci's avatar
Robert Ricci committed
233
sub send_mail($$$@);
234
235
sub short_refname($);
sub debug(@);
236
237
sub object_exists($$);
sub filter_out_objects_in_repo($@);
238
sub generate_messageid();
239
240
241
242
243
244
245

######################################################################
# Main Body
######################################################################

debug("starting");

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
#
# Read from the mail config file, if requested. We do this before detaching
# so that we can report an error if one occurs.
#
if ($mailconfigfile) {
    #
    # We open the file, read the contents, then eval them. If we didn't get any
    # errors, the result becomes the new contents of the @mailto array
    #
    if (!open(MCF,"<$mailconfigfile")) {
        warn "gitmail: Unable to open config file $mailconfigfile - $!\n";
    } else {
        my @mailcode = <MCF>;
        close MCF;

        #
        # Have to turn array back into a single string before we can call
        # eval on it. Put the result in a temp. variable so that we don't
        # overwrite @mailto if there is an error
        #
        my @mailconfig = eval join("\n",@mailcode);

        #
        # If there were any errors in the eval, they will be found in the magic
        # variable $@ - however, they will also have been printed to stderr, so
        # don't print again
        #
        if ($@) {
274
            warn "gitmail: Error in $mailconfigfile: $@\n";
275
276
277
278
279
280
281
282
283
        } else {
            @mailto = @mailconfig;
        }
    }
}

#
# Get the actual references
#
284
285
my @reflines;
if ($testmode) {
286
    my $fullref = `$GIT rev-parse --symbolic-full-name $testbranch`;
287
288
289
    if (!$fullref) {
	    exit(1);
    }
290
    my $newrev = `$GIT rev-parse $fullref $STDERRNULL`;
291
292
    chomp $newrev;

293
294
295
    #
    # Provide a simple way to grab some commits - the three most recent ones
    #
296
    @reflines = ("$newrev~'$testcommits' $newrev $fullref");
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
} else {
    #
    # Get all of the references that are being pushed from stdin - we do this in
    # one slurp so that we can detach below
    #
    @reflines = <STDIN>;
    debug("finished reading stdin");
}

#
# Detach?
#
if ($detach && !$debug) {
    # Stolen from perlipc manpage
    chdir '/'               or die "Can't chdir to /: $!";
    open STDIN, '/dev/null' or die "Can't read /dev/null: $!";
    open STDOUT, '>/dev/null'
                            or die "Can't write to /dev/null: $!";
    defined(my $pid = fork) or die "Can't fork: $!";
    exit if $pid;
    setsid                  or die "Can't start a new session: $!";
    open STDERR, '>&STDOUT' or die "Can't dup stdout: $!";
}

#
# Loop over all of the references we got on stdin
#
foreach my $refline (@reflines) {
325
326
327
    my @commits;
    my @changed_files;

328
329
330
331
332
333
334
335
336
    chomp $refline;
    debug("Read line '$refline'");

    #
    # Each line we get on stdin gives us an old revision, a new revision, and
    # a reference (such as the branch name). It's our job to figure out what
    # happened in the middle
    #
    my ($oldrev, $newrev, $refname) = split(/\s+/, $refline);
337
    my $ref_type = ref_type($refname);
338
339
340
341
342
343
344
345
346
347
348
349

    #
    # Use rev-parse so that fancy symbolic names, etc. can be used
    # Note: revparse can die if the name given is bogus
    #
    $oldrev = revparse($oldrev);
    $newrev = revparse($newrev);

    #
    # Figure out what type of change occured (update, creation, deletion, etc.)
    # and what type of objects (commit, tree, etc.) we got
    #
350
    my $ct = change_type($oldrev,$newrev,$ref_type);
351
352
353
354
355
356
    my $old_type = rev_type($oldrev);
    my $new_type = rev_type($newrev);

    debug("Change type: $ct ($old_type,$new_type)");

    #
357
    # For now, only handle commit objects.  Tag objects require extra work.
358
    #
359
    if ($new_type && $new_type ne "commit") {
360
361
362
363
364
        debug("Skipping non-commit");
        next;
    }

    #
365
366
    # Figure out which commits we're interested in based on reference type
    # and change type.
367
    #
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
    if ($ref_type eq 'tag') {
	if ($ct eq $CT_DELETE) {
	    # We want to know where the tag used to point before deletion
	    push @commits, $oldrev;
	} else {
	    # Tags only have delete, create, and update.  Rewind and rebase
	    # don't make sense in tag context.
	    #
	    # We only care about the new value of the tag here.
	    push @commits, $newrev;
	}
    } elsif ($ref_type eq 'branch') {
	if ($ct eq $CT_DELETE) {
	    # We want to know where the branch used to point before deletion
	    push @commits, $oldrev;
	} elsif ($ct eq $CT_REWIND) {
	    # There's no new history to show, but we still want to see where
	    # the branch now points.
	    push @commits, $newrev;
	} else {
	    @commits = get_commits($oldrev,$newrev,$refname);
	    # We only want to see *new* commits, which means that commits already
	    # in the main repository need to be excluded too.
	    if (defined $exclude_repo) {
		@commits = filter_out_objects_in_repo($exclude_repo, @commits);
	    }
	}
    }

    next unless (@commits);
Ryan Jackson's avatar
Ryan Jackson committed
398
399
    debug("commits are: ", join(" ",@commits));

400
    @changed_files = changed_files(@commits);
401
402
403
404
405
406
407
408
409
410
411
    debug("Changed files: ", join(",",@changed_files));

    #
    # Based on the list of files, figure out who to mail
    #
    my @mailaddrs = get_mail_addresses($refname,@changed_files);

    #
    # Send off the mail!
    #
    if (@mailaddrs) {
Ryan Jackson's avatar
Ryan Jackson committed
412
        commit_mail($ct,@commits,$refname,@mailaddrs);
413
414
415
416
417
418
419
420
421
422
423
424
425
    }
}

debug("finishing");

######################################################################
# Functions
######################################################################

#
# Does this change represent the creation, deletion, or update of an object?
# Takes old and new revs
#
426
427
sub change_type($$$) {
    my ($oldrev, $newrev, $ref_type) = @_;
428

429
430
431
432
433
434
435
436
    #
    # We can detect creates and deletes by looking for a special 'null'
    # revision
    #
    if ($oldrev eq $EMPTYREV) {
        return $CT_CREATE;
    } elsif ($newrev eq $EMPTYREV) {
        return $CT_DELETE;
437
438
    } elsif ($ref_type eq 'tag') {
	    return $CT_UPDATE;
439
    } else {
440
	my $merge_base = get_merge_base($oldrev,$newrev);
441
	my $oldrev = revparse($oldrev);
442
	my $newrev = revparse($newrev);
443
	if ($merge_base eq $oldrev) {
444
445
446
	    return $CT_UPDATE;
	} elsif ($merge_base eq $newrev) {
	    return $CT_REWIND;
447
	} else {
448
	    return $CT_REBASE;
449
	}
450
451
452
453
454
455
456
457
    }
}

#
# Find out what type an object has
#
sub rev_type($) {
    my ($rev) = @_;
458
    my $rev_type = `$GIT cat-file -t '$rev' $STDERRNULL`;
459
460
461
462
    chomp $rev_type;
    return $rev_type;
}

463
464
465
466
467
468
469
470
471
472
473
474
475
476
#
# Find out what type of reference this is
#
sub ref_type($) {
    my ($ref) = @_;
    my $type;
    if ($ref =~ m#^refs/heads/#) {
	    $type = 'branch';
    } elsif ($ref =~ m#^refs/tags/#) {
	    $type = 'tag';
    }
    return $type;
}

477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
#
# Parse (possibly) symbolic revision name into hash
# Note: Dies if the revision name is bogus!
#
sub revparse($) {
    my ($rev) = @_;
    open(RP,"$GIT rev-parse $rev $STDERRNULL |");
    my $parsedrev = <RP>;
    my $okay = close(RP);
    if (!$okay) {
        die "gitmail: $rev is not a valid revision\n";
    }
    chomp $parsedrev;
    return $parsedrev;
}

#
494
495
# Given a list of commit object hashes, return the list of files changed by
# all commits.
496
#
497
498
sub changed_files(@) {
    my %files;
499

500
501
    debug("running '$GIT diff-tree --stdin -r --name-only --no-commit-id' on '@_'");
    my $pid = open2(\*OUT, \*IN, "$GIT diff-tree --stdin -r --name-only --no-commit-id");
502

503
504
505
506
507
508
509
510
    print IN "$_\n" for (@_);
    close(IN);

    while (<OUT>) {
	    chomp;
	    $files{$_} = 1;
    }
    close(OUT);
Ryan Jackson's avatar
Ryan Jackson committed
511

512
513
514
515
516
517
518
    waitpid($pid, 0);
    my $rc = $? >> 8;
    if ($rc) {
	    die "'git diff-tree' exited with return code $rc\n";
    }

    return keys(%files);
Ryan Jackson's avatar
Ryan Jackson committed
519
520
}

521
522
523
524
525
526
#
# Given a refname and a list of filenames, return the set of email addresses
# the report should be sent to
#
sub get_mail_addresses($@) {
    my ($refname, @changedfiles) = @_;
527
    my (@addrs,@archiveaddrs);
528
529
530
531
532
533
534
535
536
537
    my $matched = 0;

    #
    # Note: we use flatten_arrayref so that either individual strings or array
    # references containing lists of addresses can be used
    #

    #
    # If there's an address we're always supposed to send to, include that now
    #
538
539
540
    if (@alwaysmail) {
        push @addrs, @alwaysmail;
        debug("Used alwaysmail address(es) " . join(",",@alwaysmail));
541
542
    }

543
544
545
546
547
548
549
550
551
552
    #
    # If there are any 'archive' mail addresses, put them into array refs,
    # which will cause them to get sent separately
    #
    if (@archivemail) {
        push @archiveaddrs, map {[$_]} @archivemail;
        debug("Used archivemail address(es) " . join(",",@archivemail));
    }


553
    #
554
555
556
    # Find out if this is a branch, and of so, what it's name is. If it's not,
    # set the branch name to be empty, so that only empty regexps will match
    # it
557
    #
558
    my $branchname = "";
559
    if ($refname =~ /^refs\/heads\/(.*)/) {
560
       $branchname = $1;
561
562
563
    }

    #
564
    # Loop through each entry, making sure both branch and path match
565
    #
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
    ENTRY: foreach my $entry (@mailto) {
        my ($branches, $paths, $addresses) = @$entry;
        my @branches = flatten_arrayref($branches);
        my @paths = flatten_arrayref($paths);
        my @addresses = flatten_arrayref($addresses);

        #
        # If the branch doesn't match, go on to the next entry
        #
        my $branch_matched = 0;
        BRANCH: foreach my $branchRE (@branches) {
            if (!defined($branchRE)) {
                debug("Empty branch matched");
                $branch_matched = 1;
                last BRANCH;
            } elsif ($branchname =~ $branchRE) {
                debug("Matched branch regexp /$branchRE/");
                $branch_matched = 1;
                last BRANCH;
585
586
            }
        }
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623

        if (!$branch_matched) {
            next ENTRY;
        }

        #
        # If the path doesn't match, go on to the next entry
        #
        my $paths_matched = 0;
        PATH: foreach my $regexp (@paths) {
            if (!defined($regexp)) {
                debug("  Empty path matched");
                $paths_matched = 1;
                last PATH;
            }
            # Have to check against every file in the changeset
            foreach my $file (@changedfiles) {
                if ($file =~ $regexp) {
                    debug("  Matched path regexp /$regexp/");
                    $paths_matched = 1;
                    last PATH;
                }
            }
        }

        if (!$paths_matched) {
            debug("  Path match failed");
            next ENTRY;
        }

        #
        # Great, made it through - we add all addresses, we'll weed out
        # duplicates later
        #
        debug("  Adding adddresses ", join(",",@addresses));
        $matched = 1;
        push @addrs, @addresses;
624
625
626
627
628
629
630
631
632
    }

    #
    # Fall back to default if no matches (note that an earlier match with an
    # empty list of addresses will cause this case to not be triggered - this
    # is intentional)
    #
    if (!$matched && defined($defmail)) {
        @addrs = flatten_arrayref($defmail);
633
        debug("Used default address $defmail");
634
    }
635

636
637
638
    #
    # Pull out unique values to return
    #
639
    return (uniq(@addrs),@archiveaddrs);
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
}

#
# Return only the unique elements of the supplied list. Input does not have
# to be sorted, sort order of output is undefined.
#
sub uniq(@) {
    my %uniq;
    map { $uniq{$_} = 1 } @_;
    return keys %uniq;
}

#
# If the parameter is a scalar, just return a one-element array containing the
# scalar. If it's a reference to an array, return the array referenced.
#
sub flatten_arrayref($) {
    my ($ref) = @_;
    if (ref($ref) eq "ARRAY") {
        return @$ref;
    } else {
        return ($ref);
    }
}

#
# Send mail about a regular update commit
#
Ryan Jackson's avatar
Ryan Jackson committed
668
669
sub commit_mail($\@$@) {
    my ($ct,$commits,$refname,@mailaddrs) = @_;
670
671
672

    #
    # Construct the subject line. For now, we just say what repo (if defined)
673
    # and what branch/tag it happened on
674
675
    #
    my $subject = "git commit: ";
676
    my $ref_type;
677
    my $short_rev;
678
679
680
    if (defined($reponame)) {
        $subject .= "[$reponame] ";
    }
681

682
    $ref_type = ref_type($refname);
683
684

    $subject .= $ref_type . ' ' . short_refname($refname);
685

686
    my $what_happened;
687
    if ($ct eq $CT_UPDATE) {
688
689
690
691
692
        $what_happened .= 'updated';
    } elsif ($ct eq $CT_REWIND) {
        $what_happened .= 'rewound';
    } elsif ($ct eq $CT_REBASE) {
        $what_happened .= 'rebased';
693
    } elsif ($ct eq $CT_CREATE) {
694
        $what_happened .= 'created';
695
    } elsif ($ct eq $CT_DELETE) {
696
        $what_happened .= 'deleted';
697
698
    }

699
    $subject .= ' ' . $what_happened;
700
    my $actionstring = ucfirst($ref_type) . ' ' . short_refname($refname) .
701
                       " has been $what_happened";
702

703
    $short_rev = `$GIT rev-parse --short $refname $STDERRNULL`;
704
705
706
    chomp $short_rev;
    $subject .= " ($short_rev)" if ($short_rev);

707
708
709
710
711
712
    if ($ct eq $CT_REBASE) {
        $actionstring .= ".  The following commits are new or have been modified:";
    } elsif ($ct eq $CT_REWIND) {
        $actionstring .= "  to point to the following commit:";
    } elsif ($ct eq $CT_DELETE) {
	$actionstring .= ".  It previously pointed to the following commit:";
713
714
    }

715
716
    $actionstring .= "\n\n";

717
    my @fullbody;
Ryan Jackson's avatar
Ryan Jackson committed
718
    foreach my $rev (@$commits) {
719
720
721
722
        #
        # Just use regular git show command, with purty +/- summary at the
        # bottom (formatted to be narrow enough for email)
        #
723
724
725
726
727
728
729
        my $showcommand = "$GIT show --numstat --shortstat ";
        if (defined($showcommit_extra)) {
            $showcommand .= "$showcommit_extra ";
        }
        $showcommand .= "'$rev'";
        debug("running '$showcommand'");
        my @body = `$showcommand`;
730
731
732
733
734
        
        if ($hide_trivial_merges) {
	        my $is_merge = 0;
	        my $body_lines = 0;
	        my $subject;
735
736
737
738
739
740
	        my @diff_lines;

		# This is a bit of a hack.  It assumes that the output
		# of git-show will not change.  We could use --pretty
		# to produce exactly the format we want, but since we've
		# already called git-show we'll just use that.
741
742
743
744
745
746
747
748
749
750
	        for (@body) {
		        $is_merge = 1 if (/^Merge:/);
			if (/^ /) {
				if (not defined $subject) {
					$subject = $_;
				} else {
					$body_lines++;
				}
			}
		}
751
752
753
754

		if ($is_merge) {
			@diff_lines = `$GIT diff-tree --no-commit-id --cc $rev`;
		}
755
		
756
757
758
759
		if ($is_merge && !@diff_lines && !$body_lines) {
			# We have a trivial merge, i.e. no hunks were modified as
			# part of the merge.  We still want to show the commit if
			# the commit message is non-standard.
760
761
762
			next;
		}
	}
763
764
765

        if ($separate_mail) {
            # Send this message by itself
Robert Ricci's avatar
Robert Ricci committed
766
767
            send_mail($subject,$actionstring . join("",@body),
                short_refname($refname), @mailaddrs);
768
769
770
771
772
773
774
775
        } else {
            push @fullbody,\@body;
        }
    }

    #
    # Send all the changes together in one message
    #
776
    if (!$separate_mail && @fullbody) {
777
        send_mail($subject,
778
779
            $actionstring . join("\n" . "-"x72 . "\n\n",
                                 map { join "",@$_} @fullbody),
Robert Ricci's avatar
Robert Ricci committed
780
            short_refname($refname),
781
782
783
784
785
786
787
788
789
790
791
            @mailaddrs);
    }
}

#
# Given two revisions, get a list of the commits that occured between them
# TODO: Consider leaving out already-reachable commits like the contrib script
#       does, or at least making it an option
#
sub get_commits($$$) {
    my ($oldrev,$newrev,$refname) = @_;
792
    my $ct = change_type($oldrev,$newrev, ref_type($refname));
793
794
795

    #
    # If this is an update, we can just ask git for the revisions between the
796
    # two revisions we were given.
797
    #
798
799
800
801
802
803
804
805
    if ($ct eq $CT_UPDATE) {
	my $revstring = "$oldrev..$newrev";

	debug("running '$GIT rev-list --reverse --date-order '$revstring'");
	my @revs = `$GIT rev-list --reverse --date-order '$revstring'`;
	chomp @revs;
        return @revs;
    } elsif ($ct eq $CT_REBASE) {
806
807
        debug("running '$GIT cherry '$oldrev' '$newrev'");
	# Only return revs prefixed with a '+' since commits prefixed with a
808
809
810
811
812
813
814
815
816
	# '-' are already in the repository with a different commit hash.
	#
	# The '-' commits are the same as their non-rebased counterparts, except
	# their ancestry is different.  For the email messages, we don't care
	# about these since we should have seen the original commits already.
	#
	# The '+' commits are either new or are rebased commits whose *content*
	# has changed.  We definitely want to see these.  Note that this only
	# applies to the content of the commit, not the commit message.
817
	my @revs;
818
	my @all_revs;
819
	for (`$GIT cherry '$oldrev' '$newrev'`) {
820
		debug($_);
821
		chomp;
822
823
824
		@_ = split /\s+/, $_;
		unshift @revs, $_[1] if ($_[0] eq '+');
		unshift @all_revs, $_[1];
825
	}
826

827
828
829
830
831
	# If cherry finds that all of the commits are already present,
	# report 'em all anyway.  We still need to know that the rebase
	# happened, and reporting just the head doesn't make any sense.
	@revs = @all_revs if (!@revs);
        return @revs;
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
    } elsif ($ct eq $CT_CREATE) {
        #
        # If it's a create, we have to be a bit more fancy: we look for all
        # commits reachable from the new branch, but *not* reachable from any
        # other branch (otherwise, we get all of the history back to the dawn
        # of time). I stole this magic from the contrib post-receive-email hook
        # from the git distro.
        #

        #
        # Get the list of all other branch heads
        #
        my @other_branches = `$GIT for-each-ref --format='%(refname)' refs/heads/ | grep -F -v $refname`;
        chomp @other_branches;

        my $other_branches = join(" ",@other_branches);
        debug("other branches are: '$other_branches'");

        #
        # Get a list of commits that are reachable from this branch, and no
        # others.
        #
        debug("running '$GIT rev-parse --not $other_branches | $GIT rev-list --pretty --stdin $newrev'");
        my @commits = `$GIT rev-parse --not $other_branches | $GIT rev-list --reverse --date-order --stdin $newrev`;

857
858
859
860
861
862
        # We always want to be notified when a branch is created, so if there are no commits reachable
        # from only this branch just report on the head of the branch.
        push @commits, $newrev if (!@commits);

        debug("commits are @commits");

863
864
865
866
867
868
869
870
        chomp @commits;
        return @commits;
    }

}

#
# Send out some mail (or not, if in debug mode)
871
872
# If any parameters are references to lists, then we send a seperate peice
# of mail to each of those lists
873
#
Robert Ricci's avatar
Robert Ricci committed
874
875
sub send_mail($$$@) {
    my ($subject, $body, $refname, @to) = @_;
876
877

    #
878
879
880
    # Generate our own messageid - this will be helpful if we are sending
    # multiple copies to multiple addesses, so that people's duplicate
    # supression can pick up on the fact that they are the same message
881
    #
882
    my $messageid = generate_messageid();
883

884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
    my @regular_addresses = grep { ref($_) ne "ARRAY" } @to;
    my @list_refs = grep { ref($_) eq "ARRAY" } @to;

    debug("regular addresses are: ", join(",",@regular_addresses));
    debug("there are " . scalar(@list_refs) . " list_refs");

    foreach my $mailto (\@regular_addresses, @list_refs) {

        # The list ref could be empty (eg. if there were no @regular_addresses)
        next unless @$mailto;

        print "Sending email notification to ", join(",",@$mailto), "\n";

        if ($debug) {
               open(MAIL,">&STDERR");
               print MAIL "\n\n";
        } else {
               # sendmail args:
               # -oem causes errors in mail to be "mailed back"
               # -odb deliver mail in background
               # -t causes sendmail to look in the message for 'To:' 'Cc:' and
               #    'Bcc:' lines
               open(MAIL, "| $SENDMAIL -odb -oem -t");
        }

        print MAIL "To: " . join(", ",@$mailto) . "\n";
        print MAIL "Subject: $subject\n";
        print MAIL "Message-Id: $messageid\n";
        
        # If requested, set the Reply-To header
        if (defined($replyto)) {
            print MAIL "Reply-To: $replyto\n"
        }

        #
        # Add an X-Git-Repo header to help people procmail
        #
        if (defined($reponame)) {
            print MAIL "X-Git-Repo: $reponame\n";
        }
924
925
926
927
	if (@repo_keywords) {
		@repo_keywords = map { split /\s+/ } @repo_keywords;
		print MAIL "X-Git-Repo-Keyword: $_\n" for (@repo_keywords);
	}
Robert Ricci's avatar
Robert Ricci committed
928
        print MAIL "X-Git-Ref: $refname\n";
929
930
931
932
933
934
935

        #
        # Marks end of headers
        #
        print MAIL "\n";

        print MAIL $body;
936

937
938
939
940
        if ($debug) {
            print MAIL "\n\n";
        }
    }
941
942
943
944
945
946
947

}

#
# Given a full refname, pull off the last part for pretty printing
#
sub short_refname($) {
948
    my ($ref) = @_;
949
    my $refname = `$GIT rev-parse --abbrev-ref $ref $STDERRNULL`;
950
951
    chomp $refname;

952
    # Fall back to full name if rev-parse fails for some reason
953
    $refname = $ref if (!$refname);
954
955
956
957
958
959
960
961
962
    debug("got short refname \"$refname\"");


    # If the ref didn't get shortened, it may be because it was deleted.  Just
    # chop off 'refs/heads' or 'refs/tags' and return the rest.
    if ($refname =~ m#^refs/(?:heads|tags)/(.*)#) {
	    $refname = $1;
    }

963
    return $refname;
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
}

#
# Print only if in debug mode
#
sub debug(@) {
    if ($debug) {
        print STDERR "*** gitmail: ", @_, "\n";
    }
}

#
# Return either the config value associated with the repo or the second
# argument, which supplies the default.
#
sub get_config($$) {
    my ($var,$default) = @_;
Ryan Jackson's avatar
Ryan Jackson committed
981

982
983
984
985
986
987
988
989
    my $multivalue = 0;

    # This lets us check whether the caller wanted multiple values or not -
    # if we were called in list context, this will be true
    if (wantarray()) {
        $multivalue = 1;
    }

990
991
992
993
    #
    # Allow the user to override on command line
    #
    if ($opt{o}) {
994
        my @values;
995
996
997
998
        foreach my $pair (@{$opt{o}}) {
            my ($name,$value) = split /=/, $pair;
            if ($name eq $var) {
                debug("Using config value $value for $name from command line");
999
1000
1001
1002
1003
                if ($multivalue) {
                    push @values, $value;
                } else {
                    return $value;
                }
1004
1005
            }
        }
1006
1007
1008
        if ($multivalue && (@values > 0)) {
            return @values;
        }
1009
1010
    }

1011
1012
1013
1014
1015
    my $getcommand = "--get";
    if ($multivalue) {
        $getcommand = "--get-all";
    }

1016
1017
    # Note: We have to use 'git', not '$GIT' here, since the latter is fetched
    # using this function
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
    my @value = `git config $getcommand $CONFIGBASE.$var`;
    chomp @value;

    if (@value) {
        if ($multivalue) {
            foreach my $value (@value) {
                debug("Got $value from git config for $var");
            }
            return @value;
        } else {
            debug("Got $value[0] from git config for $var");
            return $value[0];
        }
1031
    } else {
1032
1033
        if (!$multivalue) {
            debug("Using " , defined($default)?$default : "(undef)" , " for $var");
1034
            return $default;
1035
1036
1037
1038
        } else {
            # Multivalue always returns the empty array for the defauly
            debug("Using the emtpy list for $var");
            return ();
1039
        }
1040
1041
1042
    }
}

1043
1044
1045
1046
1047
1048
1049
#
# Returns the merge base (i.e., common ancestor) of
# the two supplied revisions.
#
sub get_merge_base($$)
{
	my ($rev_a, $rev_b) = @_;
1050
	my $mb = `$GIT merge-base '$rev_a' '$rev_b'`;
1051
1052
1053
1054
1055
	chomp $mb;

	return $mb
}

1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
#
# Returns 1 if the given object (identified by hash) exists in the given
# repository (identified by path); 0 if it does not .
#
sub object_exists($$) {
    my ($obj, $repo) = @_;

    #
    # 'cat-file -e' is like 'test -e', and don't be fooled by the name, it
    # works on non-files too
    #
    debug("running $GIT --git-dir='$repo' cat-file -e $obj");
    my $rv = system "$GIT --git-dir='$repo' cat-file -e $obj";
    if ($rv) {
        return 0;
    } else {
        return 1;
    }
}

#
# Return a list of all objects from the input list that do *not* exist in
# the given repo
#
sub filter_out_objects_in_repo($@) {
    my $repo = shift @_;
    return grep { !object_exists($_,$repo)} @_;
}
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105

#
# Generate a value suitable for use in a Message-Id header
#
sub generate_messageid() {
    # First part: current time
    my $first = time();
    # Second part: some random junk
    my $second;
    foreach my $i (0 .. 8) {
        $second .= sprintf "%02x", int(rand(256));
    }
    # Third part: hostname
    my $hostname = `$HOSTNAME -f`;
    chomp $hostname;

    my $msgid = "<$first.$second\@$hostname>";

    debug("generated message id $msgid");

    return $msgid;
}