X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=tools%2Fgit-notify;h=b3223a87a384f85b92d913e775b786e543da0267;hb=71351c5a4db3a143ca23d7614c23e80b31bdd15c;hp=265f37b190b1acffda7bfe8c208ffe8f84cb9d4d;hpb=9e686891791001155d535634572eb0753835e7fd;p=nagiosplug.git diff --git a/tools/git-notify b/tools/git-notify index 265f37b..b3223a8 100755 --- a/tools/git-notify +++ b/tools/git-notify @@ -15,17 +15,22 @@ # # 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 file Set the file to use for reading and saving state +# -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; @@ -49,9 +54,24 @@ my $debug = 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(); @@ -73,8 +93,8 @@ 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 changed with the -t option) -my $state_file = git_config( "notify.statefile" ) || "/var/tmp/git-notify.state"; +# 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; @@ -85,17 +105,22 @@ 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 file Set the file to use for reading and saving state\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; } @@ -125,7 +150,10 @@ 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: $?"; @@ -144,7 +172,7 @@ sub save_commits($) close STATE or die "Cannot close $state_file: $!"; } -# for the given range, return the new hashes and append them to the 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) = @_; @@ -156,9 +184,9 @@ sub get_new_commits($$) my $revlist = git_rev_list(@args); - if (not -e $state_file) # initialize the state file with all hashes + if (not defined $state_file or not -e $state_file) { - save_commits(git_rev_list("--all", "--full-history")); + save_commits(git_rev_list("--all", "--full-history")) if defined $state_file; return $revlist; } @@ -265,17 +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(); } } @@ -287,7 +320,10 @@ 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"; @@ -303,7 +339,13 @@ 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"; @@ -322,6 +364,18 @@ sub get_repos_name() return $repos; } +# 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($) { @@ -332,10 +386,7 @@ sub get_object_info($) $info{"encoding"} = "utf-8"; - 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: $?"; + my $type = get_object_type($obj); open OBJ, "-|" or exec "git", "cat-file", $type, $obj or die "cannot run git-cat-file"; while () @@ -398,32 +449,35 @@ sub send_commit_notice($$) my ($ref,$obj) = @_; my %info = get_object_info($obj); my @notice = (); - my ($url,$subject); + my ($url,$subject,$obj_string); if ($gitweb_url) { - open REVPARSE, "-|" or exec "git", "rev-parse", "--short", $obj or die "cannot exec git-rev-parse"; - my $short_obj = ; - close REVPARSE or die $! ? "Cannot execute rev-parse: $!" : "rev-parse exited with status: $?"; - - $short_obj = $obj if not defined $short_obj; - chomp $short_obj; - $url = "$gitweb_url/?a=$info{type};h=$short_obj"; + 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 ($info{"type"} eq "tag") { push @notice, format_table( "Module: $repos_name", - "Branch: $ref", - "Tag: $obj", + "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"} . ": " . $info{"tagger_name"}; + $subject = "Tag " . $info{"tag"} . ": "; + $subject .= $info{"tagger_name"} . ": " unless $omit_author; } else { @@ -432,7 +486,7 @@ sub send_commit_notice($$) "Branch: $ref", "Commit: $obj", "Author:" . $info{"author"}, - $info{"committer"} ne $info{"author"} ? "Committer:" . $info{"committer"} : undef, + $show_committer && $info{"committer"} ne $info{"author"} ? "Committer:" . $info{"committer"} : undef, "Date:" . format_date($info{"author_date"},$info{"author_tz"}), $url ? "URL: $url" : undef), "", @@ -455,12 +509,12 @@ sub send_commit_notice($$) } else { - push @notice, "Diff: $gitweb_url/?a=commitdiff;h=$obj" if $gitweb_url; + push @notice, "Diff: $gitweb_url/?a=commitdiff;h=$obj_string" if $gitweb_url; } - $subject = $info{"author_name"}; + $subject = $info{"author_name"} . ": " unless $omit_author; } - $subject .= ": " . truncate_str(${$info{"log"}}[0],50); + $subject .= truncate_str(${$info{"log"}}[0],50); $_ = decode($info{"encoding"}, $_) for @notice; mail_notification($commitlist_address, $subject, "text/plain; charset=UTF-8", @notice); } @@ -539,13 +593,18 @@ sub send_global_notice($$$) 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"; @@ -553,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" ); }