X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=tools%2Fgit-notify;h=b3223a87a384f85b92d913e775b786e543da0267;hb=71351c5a4db3a143ca23d7614c23e80b31bdd15c;hp=a786f8393aa6a0e267cf227b74dc6ebd049883c3;hpb=aa5dfec91726da8d9d4a4fa63f11c7b0da8c9401;p=nagiosplug.git diff --git a/tools/git-notify b/tools/git-notify index a786f83..b3223a8 100755 --- a/tools/git-notify +++ b/tools/git-notify @@ -3,6 +3,7 @@ # Tool to send git commit notifications # # Copyright 2005 Alexandre Julliard +# Copyright 2009 Nagios Plugins Development Team # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License as @@ -14,25 +15,29 @@ # # Usage: git-notify [options] [--] old-sha1 new-sha1 refname # +# -A Omit the author name from the mail subject +# -C Show committer in the body if different from the author # -c name Send CIA notifications under specified project name +# -H The mail(1) utility doesn't accept headers via "-a" # -m addr Send mail notifications to specified address # -n max Set max number of individual mails to send # -r name Set the git repository name # -s bytes Set the maximum diff size in bytes (-1 for no limit) +# -T Prefix the mail subject with a [repository name] tag +# -t file Prevent duplicate notifications by saving state to this file +# -U mask Set the umask for creating the state file # -u url Set the URL to the gitweb browser # -i branch If at least one -i is given, report only for specified branches # -x branch Exclude changes to the specified branch from reports # -X Exclude merge commits +# -z Try to abbreviate the SHA1 name within gitweb URLs (unsafe) # use strict; -use open ':utf8'; -use Encode 'encode'; +use Fcntl ':flock'; +use Encode qw(encode decode); use Cwd 'realpath'; -binmode STDIN, ':utf8'; -binmode STDOUT, ':utf8'; - sub git_config($); sub get_repos_name(); @@ -47,14 +52,26 @@ my $cia_address = "cia\@cia.navi.cx"; # debug mode my $debug = 0; -# number of generated (non-CIA) notifications -my $sent_notices = 0; - # configuration parameters +# the $mailer doesn't accept headers via "-a" (can be set with the -H option) +my $legacy_mail = git_config( "notify.legacymail" ); + +# omit the author from the mail subject (can be set with the -A option) +my $omit_author = git_config( "notify.omitauthor" ); + +# prefix the mail subject with a [repository name] tag (can be set with the -T option) +my $emit_repo = git_config( "notify.emitrepository" ); + +# show the committer if different from the author (can be set with the -C option) +my $show_committer = git_config( "notify.showcommitter" ); + # base URL of the gitweb repository browser (can be set with the -u option) my $gitweb_url = git_config( "notify.baseurl" ); +# abbreviate the SHA1 name within gitweb URLs (can be set with the -z option) +my $abbreviate_url = git_config( "notify.shorturls" ); + # default repository name (can be changed with the -r option) my $repos_name = git_config( "notify.repository" ) || get_repos_name(); @@ -76,21 +93,34 @@ my @include_list = split /\s+/, git_config( "notify.include" ) || ""; # branches to exclude my @exclude_list = split /\s+/, git_config( "notify.exclude" ) || ""; +# the state file we use (can be set with the -t option) +my $state_file = git_config( "notify.statefile" ); + +# umask for creating the state file (can be set with -U option) +my $mode_mask = git_config( "notify.umask" ) || 002; + # Extra options to git rev-list my @revlist_options; sub usage() { print "Usage: $0 [options] [--] old-sha1 new-sha1 refname\n"; + print " -A Omit the author name from the mail subject\n"; + print " -C Show committer in the body if different from the author\n"; print " -c name Send CIA notifications under specified project name\n"; + print " -H The mail(1) utility doesn't accept headers via `-a'\n"; print " -m addr Send mail notifications to specified address\n"; print " -n max Set max number of individual mails to send\n"; print " -r name Set the git repository name\n"; print " -s bytes Set the maximum diff size in bytes (-1 for no limit)\n"; + print " -T Prefix the mail subject with a [repository name] tag\n"; + print " -t file Prevent duplicate notifications by saving state to this file\n"; + print " -U mask Set the umask for creating the state file\n"; print " -u url Set the URL to the gitweb browser\n"; print " -i branch If at least one -i is given, report only for specified branches\n"; print " -x branch Exclude changes to the specified branch from reports\n"; print " -X Exclude merge commits\n"; + print " -z Try to abbreviate the SHA1 name within gitweb URLs (unsafe)\n"; exit 1; } @@ -120,13 +150,69 @@ sub git_rev_list(@) while () { chomp; - die "Invalid commit: $_" if not /^[0-9a-f]{40}$/; + unless (grep {$_ eq "--pretty"} @args) + { + die "Invalid commit: $_" if not /^[0-9a-f]{40}$/; + } push @$revlist, $_; } close REVLIST or die $! ? "Cannot execute rev-list: $!" : "rev-list exited with status: $?"; return $revlist; } +# append the given commit hashes to the state file +sub save_commits($) +{ + my $commits = shift; + + open STATE, ">>", $state_file or die "Cannot open $state_file: $!"; + flock STATE, LOCK_EX or die "Cannot lock $state_file"; + print STATE "$_\n" for @$commits; + flock STATE, LOCK_UN or die "Cannot unlock $state_file"; + close STATE or die "Cannot close $state_file: $!"; +} + +# for the given range, return the new hashes (and append them to the state file) +sub get_new_commits($$) +{ + my ($old_sha1, $new_sha1) = @_; + my ($seen, @args); + my $newrevs = []; + + @args = ( "^$old_sha1" ) unless $old_sha1 eq '0' x 40; + push @args, $new_sha1, @exclude_list; + + my $revlist = git_rev_list(@args); + + if (not defined $state_file or not -e $state_file) + { + save_commits(git_rev_list("--all", "--full-history")) if defined $state_file; + return $revlist; + } + + open STATE, $state_file or die "Cannot open $state_file: $!"; + flock STATE, LOCK_SH or die "Cannot lock $state_file"; + while () + { + chomp; + die "Invalid commit: $_" if not /^[0-9a-f]{40}$/; + $seen->{$_} = 1; + } + flock STATE, LOCK_UN or die "Cannot unlock $state_file"; + close STATE or die "Cannot close $state_file: $!"; + + # FIXME: if another git-notify process reads the $state_file at *this* + # point, that process might generate duplicates of our notifications. + + save_commits($revlist); + + foreach my $commit (@$revlist) + { + push @$newrevs, $commit unless $seen->{$commit}; + } + return $newrevs; +} + # truncate the given string if it exceeds the specified number of characters sub truncate_str($$) { @@ -207,15 +293,22 @@ sub parse_options() my $arg = shift @ARGV; if ($arg eq '--') { last; } + elsif ($arg eq '-A') { $omit_author = 1; } + elsif ($arg eq '-C') { $show_committer = 1; } elsif ($arg eq '-c') { $cia_project_name = shift @ARGV; } + elsif ($arg eq '-H') { $legacy_mail = 1; } elsif ($arg eq '-m') { $commitlist_address = shift @ARGV; } elsif ($arg eq '-n') { $max_individual_notices = shift @ARGV; } elsif ($arg eq '-r') { $repos_name = shift @ARGV; } elsif ($arg eq '-s') { $max_diff_size = shift @ARGV; } + elsif ($arg eq '-T') { $emit_repo = 1; } + elsif ($arg eq '-t') { $state_file = shift @ARGV; } + elsif ($arg eq '-U') { $mode_mask = shift @ARGV; } elsif ($arg eq '-u') { $gitweb_url = shift @ARGV; } elsif ($arg eq '-i') { push @include_list, shift @ARGV; } elsif ($arg eq '-x') { push @exclude_list, shift @ARGV; } elsif ($arg eq '-X') { push @revlist_options, "--no-merges"; } + elsif ($arg eq '-z') { $abbreviate_url = 1; } elsif ($arg eq '-d') { $debug++; } else { usage(); } } @@ -227,9 +320,13 @@ sub parse_options() sub mail_notification($$$@) { my ($name, $subject, $content_type, @text) = @_; + + $subject = "[$repos_name] $subject" if $emit_repo; $subject = encode("MIME-Q",$subject); + if ($debug) { + binmode STDOUT, ":utf8"; print "---------------------\n"; print "To: $name\n"; print "Subject: $subject\n"; @@ -242,10 +339,17 @@ sub mail_notification($$$@) return unless defined $pid; if (!$pid) { - exec $mailer, "-s", $subject, "-a", "Content-Type: $content_type", $name or die "Cannot exec $mailer"; + my @mailer_options = ( "-s", $subject ); + + unless ($legacy_mail) + { + push @mailer_options, "-a", "Content-Type: $content_type"; + } + exec $mailer, @mailer_options, $name or die "Cannot exec $mailer"; } + binmode MAIL, ":utf8"; print MAIL join("\n", @text), "\n"; - close MAIL; + close MAIL or warn $! ? "Cannot execute $mailer: $!" : "$mailer exited with status: $?"; } } @@ -260,7 +364,19 @@ sub get_repos_name() return $repos; } -# extract the information from a commit object and return a hash containing the various fields +# return the type of the given object +sub get_object_type($) +{ + my $obj = shift; + + open TYPE, "-|" or exec "git", "cat-file", "-t", $obj or die "cannot run git-cat-file"; + my $type = ; + chomp $type; + close TYPE or die $! ? "Cannot execute cat-file: $!" : "cat-file exited with status: $?"; + return $type; +} + +# extract the information from a commit or tag object and return a hash containing the various fields sub get_object_info($) { my $obj = shift; @@ -268,13 +384,20 @@ sub get_object_info($) my @log = (); my $do_log = 0; - open OBJ, "-|" or exec "git", "cat-file", "commit", $obj or die "cannot run git-cat-file"; + $info{"encoding"} = "utf-8"; + + my $type = get_object_type($obj); + + open OBJ, "-|" or exec "git", "cat-file", $type, $obj or die "cannot run git-cat-file"; while () { chomp; - if ($do_log) { push @log, $_; } - elsif (/^$/) { $do_log = 1; } - elsif (/^(author|committer) ((.*) (<.*>)) (\d+) ([+-]\d+)$/) + if ($do_log) + { + last if /^-----BEGIN PGP SIGNATURE-----/; + push @log, $_; + } + elsif (/^(author|committer|tagger) ((.*) (<.*>)) (\d+) ([+-]\d+)$/) { $info{$1} = $2; $info{$1 . "_name"} = $3; @@ -282,9 +405,19 @@ sub get_object_info($) $info{$1 . "_date"} = $5; $info{$1 . "_tz"} = $6; } + elsif (/^tag (.+)/) + { + $info{"tag"} = $1; + } + elsif (/^encoding (.+)/) + { + $info{"encoding"} = $1; + } + elsif (/^$/) { $do_log = 1; } } - close OBJ; + close OBJ or die $! ? "Cannot execute cat-file: $!" : "cat-file exited with status: $?"; + $info{"type"} = $type; $info{"log"} = \@log; return %info; } @@ -308,7 +441,6 @@ sub send_ref_notice($$@) mail_notification($commitlist_address, "$refname $reftype $action", "text/plain; charset=us-ascii", @notice); - $sent_notices++; } # send a commit notice to a mailing list @@ -317,44 +449,74 @@ sub send_commit_notice($$) my ($ref,$obj) = @_; my %info = get_object_info($obj); my @notice = (); + my ($url,$subject,$obj_string); - open DIFF, "-|" or exec "git", "diff-tree", "-p", "-M", "--no-commit-id", $obj or die "cannot exec git-diff-tree"; - my $diff = join("", ); - close DIFF; - - return if length($diff) == 0; - - push @notice, format_table( - "Module: $repos_name", - "Branch: $ref", - "Commit: $obj", - "Author:" . $info{"author"}, - $info{"committer"} ne $info{"author"} ? "Committer:" . $info{"committer"} : undef, - "Date:" . format_date($info{"author_date"},$info{"author_tz"}), - $gitweb_url ? "URL: $gitweb_url/?a=commit;h=$obj" : undef), - "", - @{$info{"log"}}, - "", - "---", - ""; - - open STAT, "-|" or exec "git", "diff-tree", "--stat", "-M", "--no-commit-id", $obj or die "cannot exec git-diff-tree"; - push @notice, join("", ); - close STAT; + if ($gitweb_url) + { + if ($abbreviate_url) + { + open REVPARSE, "-|" or exec "git", "rev-parse", "--short", $obj or die "cannot exec git-rev-parse"; + $obj_string = ; + chomp $obj_string if defined $obj_string; + close REVPARSE or die $! ? "Cannot execute rev-parse: $!" : "rev-parse exited with status: $?"; + } + $obj_string = $obj if not defined $obj_string; + $url = "$gitweb_url/?a=$info{type};h=$obj_string"; + } - if (($max_diff_size == -1) || (length($diff) < $max_diff_size)) + if ($info{"type"} eq "tag") { - push @notice, $diff; + push @notice, format_table( + "Module: $repos_name", + "Tag: $ref", + "SHA1: $obj", + "Tagger:" . $info{"tagger"}, + "Date:" . format_date($info{"tagger_date"},$info{"tagger_tz"}), + $url ? "URL: $url" : undef), + "", + join "\n", @{$info{"log"}}; + + $subject = "Tag " . $info{"tag"} . ": "; + $subject .= $info{"tagger_name"} . ": " unless $omit_author; } else { - push @notice, "Diff: $gitweb_url/?a=commitdiff;h=$obj" if $gitweb_url; + push @notice, format_table( + "Module: $repos_name", + "Branch: $ref", + "Commit: $obj", + "Author:" . $info{"author"}, + $show_committer && $info{"committer"} ne $info{"author"} ? "Committer:" . $info{"committer"} : undef, + "Date:" . format_date($info{"author_date"},$info{"author_tz"}), + $url ? "URL: $url" : undef), + "", + @{$info{"log"}}, + "", + "---", + ""; + + open STAT, "-|" or exec "git", "diff-tree", "--stat", "-M", "--no-commit-id", $obj or die "cannot exec git-diff-tree"; + push @notice, join("", ); + close STAT or die $! ? "Cannot execute diff-tree: $!" : "diff-tree exited with status: $?"; + + open DIFF, "-|" or exec "git", "diff-tree", "-p", "-M", "--no-commit-id", $obj or die "cannot exec git-diff-tree"; + my $diff = join("", ); + close DIFF or die $! ? "Cannot execute diff-tree: $!" : "diff-tree exited with status: $?"; + + if (($max_diff_size == -1) || (length($diff) < $max_diff_size)) + { + push @notice, $diff; + } + else + { + push @notice, "Diff: $gitweb_url/?a=commitdiff;h=$obj_string" if $gitweb_url; + } + $subject = $info{"author_name"} . ": " unless $omit_author; } - mail_notification($commitlist_address, - $info{"author_name"} . ": " . truncate_str(${$info{"log"}}[0], 50), - "text/plain; charset=UTF-8", @notice); - $sent_notices++; + $subject .= truncate_str(${$info{"log"}}[0],50); + $_ = decode($info{"encoding"}, $_) for @notice; + mail_notification($commitlist_address, $subject, "text/plain; charset=UTF-8", @notice); } # send a commit notice to the CIA server @@ -364,6 +526,8 @@ sub send_cia_notice($$) my %info = get_object_info($commit); my @cia_text = (); + return if $info{"type"} ne "commit"; + push @cia_text, "", " ", @@ -398,7 +562,7 @@ sub send_cia_notice($$) push @cia_text, " " . xml_escape($old) . ""; } } - close COMMIT; + close COMMIT or die $! ? "Cannot execute diff-tree: $!" : "diff-tree exited with status: $?"; push @cia_text, " ", @@ -423,20 +587,24 @@ sub send_global_notice($$$) } mail_notification($commitlist_address, "New commits on branch $ref", "text/plain; charset=UTF-8", @$notice); - $sent_notices++; } # send all the notices sub send_all_notices($$$) { my ($old_sha1, $new_sha1, $ref) = @_; - my ($reftype, $refname, $action, @notice); + my ($reftype, $refname, $tagtype, $action, @notice); return if ($ref =~ /^refs\/remotes\// or (@include_list && !grep {$_ eq $ref} @include_list)); die "The name \"$ref\" doesn't sound like a local branch or tag" if not (($reftype, $refname) = ($ref =~ /^refs\/(head|tag)s\/(.+)/)); + if ($reftype eq "tag") + { + $tagtype = get_object_type($ref) eq "tag" ? "annotated" : "lightweight"; + } + if ($new_sha1 eq '0' x 40) { $action = "removed"; @@ -444,6 +612,11 @@ sub send_all_notices($$$) } elsif ($old_sha1 eq '0' x 40) { + if ($reftype eq "tag" and $tagtype eq "annotated") + { + send_commit_notice( $refname, $new_sha1 ) if $commitlist_address; + return; + } $action = "created"; @notice = ( "SHA1: $new_sha1" ); } @@ -468,7 +641,7 @@ sub send_all_notices($$$) { send_global_notice( $refname, $old_sha1, $new_sha1 ) if $commitlist_address; } - else + elsif (@$commits > 0) { foreach my $commit (@$commits) { @@ -476,7 +649,7 @@ sub send_all_notices($$$) send_cia_notice( $refname, $commit ) if $cia_project_name; } } - if ($sent_notices == 0 and $commitlist_address) + elsif ($commitlist_address) { @notice = ( "Old SHA1: $old_sha1", "New SHA1: $new_sha1" ); send_ref_notice( $ref, "modified", @notice ); @@ -486,6 +659,8 @@ sub send_all_notices($$$) parse_options(); +umask( $mode_mask ); + # append repository path to URL $gitweb_url .= "/$repos_name.git" if $gitweb_url;