Attached (and pasted below, but I believe Gmail messes up the whitespace) is a patch for a new ciabot script that is the revamped version of the old Perl script. --- >From f80c041dcd7db6abfa0354c89adcb8b811b27e89 Mon Sep 17 00:00:00 2001 From: JD Horelick <jdhore1@xxxxxxxxx> Date: Sat, 11 Jun 2011 18:16:16 -0400 Subject: [PATCH] ciabot: Add a revamped Perl version. This revamped Perl version offers more features and uses the recommended interface to the CIA.vc Service (XML-RPC, with email as a backup option). Some of the additional features include the ability to send a module field to CIA and the ability to set script all relevant script options with git config. Signed-off-by: JD Horelick <jdhore1@xxxxxxxxx> --- contrib/ciabot/README | 13 +- contrib/ciabot/ciabot.pl | 321 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 329 insertions(+), 5 deletions(-) create mode 100755 contrib/ciabot/ciabot.pl diff --git a/contrib/ciabot/README b/contrib/ciabot/README index 3b916ac..5683fa2 100644 --- a/contrib/ciabot/README +++ b/contrib/ciabot/README @@ -1,12 +1,15 @@ These are hook scripts for the CIA notification service at <http://cia.vc/> -They are maintained by Eric S. Raymond <esr@xxxxxxxxxxx>. There is an -upstream resource page for them at <http://www.catb.org/esr/ciabot/>, +The Perl version is maintained by JD Horelick <jdhore1@xxxxxxxxx>. + +The Python and shell versions are maintained by Eric S. Raymond <esr@xxxxxxxxxxx>. +There is an upstream resource page for them at <http://www.catb.org/esr/ciabot/>, but they are unlikely to change rapidly. -You probably want the Python version; it's faster, more capable, and -better documented. The shell version is maintained only as a fallback -for use on hosting sites that don't permit Python hook scripts. +You probably want the Perl version; it's faster, more capable, uses the +recommended CIA interface and is better documented. The shell version +is maintained only as a fallback for use on hosting sites that don't +permit Perl hook scripts. You will find installation instructions for each script in its comment header. diff --git a/contrib/ciabot/ciabot.pl b/contrib/ciabot/ciabot.pl new file mode 100755 index 0000000..56c37ca --- /dev/null +++ b/contrib/ciabot/ciabot.pl @@ -0,0 +1,321 @@ +#!/usr/bin/perl -w +# +# ciabot -- Mail a git log message to a given address, for the purposes of CIA +# +# Loosely based on cvslog by Russ Allbery <rra@xxxxxxxxxxxx> +# Copyright 1998 Board of Trustees, Leland Stanford Jr. University +# +# Copyright 2001, 2003, 2004, 2005 Petr Baudis <pasky@xxxxxx> +# Copyright 2011 JD Horelick <jdhore1@xxxxxxxxx> +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License version 2, as published by the +# Free Software Foundation. +# +# The master location of this file is in the Cogito repository +# (see http://www.kernel.org/git/). +# +# This program is designed to run as the .git/hooks/post-commit hook. It takes +# the commit information, massages it and mails it to the address given below. +# +# The calling convention of the post-commit hook is: +# +# .git/hooks/post-commit $commit_sha1 $branch_name +# +# If it does not work, try to disable $xml_rpc in the configuration section +# below. Also, remember to make the hook file executable. +# +# +# Note that you can (and it might be actually more desirable) also use this +# script as the GIT update hook: +# +# refname=${1#refs/heads/} +# [ "$refname" = "master" ] && refname= +# oldhead=$2 +# newhead=$3 +# for merged in $(git rev-list $newhead ^$oldhead | tac); do +# /path/to/ciabot.pl $merged $refname +# done +# +# This is useful when you use a remote repository that you only push to. The +# update hook will be triggered each time you push into that repository, and +# the pushed commits will be reported through CIA. + +use strict; +use Carp; +use vars qw ($project $module $repo $baseurl $from_email $dest_email $noisy $rpc_uri $sendmail + $xml_rpc $ignore_regexp $alt_local_message_target); + + + + +### Configuration + +# Project name (as known to CIA). +chomp($project = `git config --get cia.project`); + +# Module name (if applicable) +chomp($module = `git config --get cia.module`); + +# Repository name in the web interface +chomp($repo = `git config --get cia.repo`); + +# Base URL for a GitWeb or cgit instance +# You must comment all the baseurl lines out if you do not have a web interface +# or do not want the web interface URL for the commit displayed +# Gitweb +#$baseurl = "http://git.example.com/cgi-bin/gitweb.cgi?p=$repo;a=commit;h=";; +# cgit +$baseurl = "http://git.example.com/$repo/commit/?id=";; + +# The from address in generated mails. +$from_email = 'cia@xxxxxxxxxxx'; + +# Mail all reports to this address. +$dest_email = 'cia@xxxxxx'; + +# If using XML-RPC, connect to this URI. +$rpc_uri = 'http://cia.vc/RPC2'; + +# Path to your USCD sendmail compatible binary (your mailer daemon created this +# program somewhere). +$sendmail = '/usr/sbin/sendmail'; + +# If set, the script will send CIA the full commit message. If unset, only the +# first line of the commit message will be sent. +$noisy = 1; + +# This script can communicate with CIA either by mail or by an XML-RPC +# interface. The XML-RPC interface is faster and more efficient, however you +# need to have RPC::XML perl module installed, and some large CVS hosting sites +# (like Savannah or Sourceforge) might not allow outgoing HTTP connections +# while they allow outgoing mail. Also, this script will hang and eventually +# not deliver the event at all if CIA server happens to be down, which is +# unfortunately not an uncommon condition. +$xml_rpc = 1; + +# This variable should contain a regexp, against which each file will be +# checked, and if the regexp is matched, the file is ignored. This can be +# useful if you do not want auto-updated files, such as e.g. ChangeLog, to +# appear via CIA. +# +# The following example will make the script ignore all changes in two specific +# files in two different modules, and everything concerning module 'admin': +# +# $ignore_regexp = "^(gentoo/Manifest|elinks/src/bfu/inphist.c|admin/)"; +$ignore_regexp = ""; + +# It can be useful to also grab the generated XML message by some other +# programs and e.g. autogenerate some content based on it. Here you can specify +# a file to which it will be appended. +$alt_local_message_target = ""; + + + + +### The code itself + +use vars qw ($commit $tree @parent $author $committer); +use vars qw ($user $branch $rev @files $logmsg $message $shorturl); +my $line; + +if ($project eq "") { + croak "Project variable is required. Please set one with git config --add cia.project"; +} + +if ($repo eq "") { + undef $baseurl; +} + +# Let's be extra-safe here +if ($module eq "") { + undef $module; +} + + +### Input data loading + + +# The commit stuff +$commit = $ARGV[0]; +$branch = $ARGV[1]; + +open COMMIT, "git cat-file commit $commit|" or die "git cat-file commit $commit: $!"; +my $state = 0; +$logmsg = ''; +while (defined ($line = <COMMIT>)) { + if ($state == 1) { + $logmsg .= $line; + $noisy or $state++; + next; + } elsif ($state > 1) { + next; + } + + chomp $line; + unless ($line) { + $state = 1; + next; + } + + my ($key, $value) = split(/ /, $line, 2); + if ($key eq 'tree') { + $tree = $value; + } elsif ($key eq 'parent') { + push(@parent, $value); + } elsif ($key eq 'author') { + $author = $value; + } elsif ($key eq 'committer') { + $committer = $value; + } +} +close COMMIT; + + +open DIFF, "git diff-tree -r $parent[0] $tree|" or die "git diff-tree $parent[0] $tree: $!"; +while (defined ($line = <DIFF>)) { + chomp $line; + my @f; + (undef, @f) = split(/\t/, $line, 2); + push (@files, @f); +} +close DIFF; + + +# Figure out who is doing the update. +# XXX: Too trivial this way? +($user) = $author =~ /<(.*?)@/; + + +$rev = substr($commit, 0, 12); + + + + +### Remove to-be-ignored files + +@files = grep { $_ !~ m/$ignore_regexp/; } @files + if ($ignore_regexp); +exit unless @files; + + + +### Compose the mail message + + +my ($VERSION) = '2.0'; +my $ts = time; + +$message = <<EM +<message> + <generator> + <name>CIA Perl client for Git</name> + <version>$VERSION</version> + </generator> + <source> + <project>$project</project> + +EM +; +$message .= " <module>$module</module>" if ($module); +$message .= " <branch>$branch</branch>" if ($branch); +$message .= <<EM + </source> + <timestamp> + $ts + </timestamp> + <body> + <commit> + <author>$user</author> + <revision>$rev</revision> + <files> +EM +; + +foreach (@files) { + s/&/&/g; + s/</</g; + s/>/>/g; + $message .= " <file>$_</file>\n"; +} + +$logmsg =~ s/&/&/g; +$logmsg =~ s/</</g; +$logmsg =~ s/>/>/g; + +if (defined $baseurl) { + $shorturl = $baseurl . $rev; + $logmsg = $logmsg . $shorturl; +} + +$message .= <<EM + </files> + <log>$logmsg</log> + </commit> + </body> +</message> +EM +; + + + +### Write the message to an alt-target + +if ($alt_local_message_target and open (ALT, ">>$alt_local_message_target")) { + print ALT $message; + close ALT; +} + + + +### Send out the XML-RPC message + + +if ($xml_rpc) { + # We gotta be careful from now on. We silence all the warnings because + # RPC::XML code is crappy and works with undefs etc. + $^W = 0; + $RPC::XML::ERROR if (0); # silence perl's compile-time warning + + require RPC::XML; + require RPC::XML::Client; + + my $rpc_client = new RPC::XML::Client $rpc_uri; + my $rpc_request = RPC::XML::request->new('hub.deliver', $message); + my $rpc_response = $rpc_client->send_request($rpc_request); + + unless (ref $rpc_response) { + carp "XML-RPC Error: $RPC::XML::ERROR. No CIA notification will be displayed for what was pushed.\n"; + } + exit; +} + + + +### Send out the mail + + +# Open our mail program + +open (MAIL, "| $sendmail -t -oi -oem") or die "Cannot execute $sendmail : " . ($?>>8); + + +# The mail header + +print MAIL <<EOM; +From: $from_email +To: $dest_email +Content-type: text/xml +Subject: DeliverXML + +EOM + +print MAIL $message; + + +# Close the mail + +close MAIL; +die "$0: sendmail exit status " . ($? >> 8) . "\n" unless ($? == 0); + +# vi: set sw=2: -- 1.7.5.1
From f80c041dcd7db6abfa0354c89adcb8b811b27e89 Mon Sep 17 00:00:00 2001 From: JD Horelick <jdhore1@xxxxxxxxx> Date: Sat, 11 Jun 2011 18:16:16 -0400 Subject: [PATCH] ciabot: Add a revamped Perl version. This revamped Perl version offers more features and uses the recommended interface to the CIA.vc Service (XML-RPC, with email as a backup option). Some of the additional features include the ability to send a module field to CIA and the ability to set script all relevant script options with git config. Signed-off-by: JD Horelick <jdhore1@xxxxxxxxx> --- contrib/ciabot/README | 13 +- contrib/ciabot/ciabot.pl | 321 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 329 insertions(+), 5 deletions(-) create mode 100755 contrib/ciabot/ciabot.pl diff --git a/contrib/ciabot/README b/contrib/ciabot/README index 3b916ac..5683fa2 100644 --- a/contrib/ciabot/README +++ b/contrib/ciabot/README @@ -1,12 +1,15 @@ These are hook scripts for the CIA notification service at <http://cia.vc/> -They are maintained by Eric S. Raymond <esr@xxxxxxxxxxx>. There is an -upstream resource page for them at <http://www.catb.org/esr/ciabot/>, +The Perl version is maintained by JD Horelick <jdhore1@xxxxxxxxx>. + +The Python and shell versions are maintained by Eric S. Raymond <esr@xxxxxxxxxxx>. +There is an upstream resource page for them at <http://www.catb.org/esr/ciabot/>, but they are unlikely to change rapidly. -You probably want the Python version; it's faster, more capable, and -better documented. The shell version is maintained only as a fallback -for use on hosting sites that don't permit Python hook scripts. +You probably want the Perl version; it's faster, more capable, uses the +recommended CIA interface and is better documented. The shell version +is maintained only as a fallback for use on hosting sites that don't +permit Perl hook scripts. You will find installation instructions for each script in its comment header. diff --git a/contrib/ciabot/ciabot.pl b/contrib/ciabot/ciabot.pl new file mode 100755 index 0000000..56c37ca --- /dev/null +++ b/contrib/ciabot/ciabot.pl @@ -0,0 +1,321 @@ +#!/usr/bin/perl -w +# +# ciabot -- Mail a git log message to a given address, for the purposes of CIA +# +# Loosely based on cvslog by Russ Allbery <rra@xxxxxxxxxxxx> +# Copyright 1998 Board of Trustees, Leland Stanford Jr. University +# +# Copyright 2001, 2003, 2004, 2005 Petr Baudis <pasky@xxxxxx> +# Copyright 2011 JD Horelick <jdhore1@xxxxxxxxx> +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License version 2, as published by the +# Free Software Foundation. +# +# The master location of this file is in the Cogito repository +# (see http://www.kernel.org/git/). +# +# This program is designed to run as the .git/hooks/post-commit hook. It takes +# the commit information, massages it and mails it to the address given below. +# +# The calling convention of the post-commit hook is: +# +# .git/hooks/post-commit $commit_sha1 $branch_name +# +# If it does not work, try to disable $xml_rpc in the configuration section +# below. Also, remember to make the hook file executable. +# +# +# Note that you can (and it might be actually more desirable) also use this +# script as the GIT update hook: +# +# refname=${1#refs/heads/} +# [ "$refname" = "master" ] && refname= +# oldhead=$2 +# newhead=$3 +# for merged in $(git rev-list $newhead ^$oldhead | tac); do +# /path/to/ciabot.pl $merged $refname +# done +# +# This is useful when you use a remote repository that you only push to. The +# update hook will be triggered each time you push into that repository, and +# the pushed commits will be reported through CIA. + +use strict; +use Carp; +use vars qw ($project $module $repo $baseurl $from_email $dest_email $noisy $rpc_uri $sendmail + $xml_rpc $ignore_regexp $alt_local_message_target); + + + + +### Configuration + +# Project name (as known to CIA). +chomp($project = `git config --get cia.project`); + +# Module name (if applicable) +chomp($module = `git config --get cia.module`); + +# Repository name in the web interface +chomp($repo = `git config --get cia.repo`); + +# Base URL for a GitWeb or cgit instance +# You must comment all the baseurl lines out if you do not have a web interface +# or do not want the web interface URL for the commit displayed +# Gitweb +#$baseurl = "http://git.example.com/cgi-bin/gitweb.cgi?p=$repo;a=commit;h=";; +# cgit +$baseurl = "http://git.example.com/$repo/commit/?id=";; + +# The from address in generated mails. +$from_email = 'cia@xxxxxxxxxxx'; + +# Mail all reports to this address. +$dest_email = 'cia@xxxxxx'; + +# If using XML-RPC, connect to this URI. +$rpc_uri = 'http://cia.vc/RPC2'; + +# Path to your USCD sendmail compatible binary (your mailer daemon created this +# program somewhere). +$sendmail = '/usr/sbin/sendmail'; + +# If set, the script will send CIA the full commit message. If unset, only the +# first line of the commit message will be sent. +$noisy = 1; + +# This script can communicate with CIA either by mail or by an XML-RPC +# interface. The XML-RPC interface is faster and more efficient, however you +# need to have RPC::XML perl module installed, and some large CVS hosting sites +# (like Savannah or Sourceforge) might not allow outgoing HTTP connections +# while they allow outgoing mail. Also, this script will hang and eventually +# not deliver the event at all if CIA server happens to be down, which is +# unfortunately not an uncommon condition. +$xml_rpc = 1; + +# This variable should contain a regexp, against which each file will be +# checked, and if the regexp is matched, the file is ignored. This can be +# useful if you do not want auto-updated files, such as e.g. ChangeLog, to +# appear via CIA. +# +# The following example will make the script ignore all changes in two specific +# files in two different modules, and everything concerning module 'admin': +# +# $ignore_regexp = "^(gentoo/Manifest|elinks/src/bfu/inphist.c|admin/)"; +$ignore_regexp = ""; + +# It can be useful to also grab the generated XML message by some other +# programs and e.g. autogenerate some content based on it. Here you can specify +# a file to which it will be appended. +$alt_local_message_target = ""; + + + + +### The code itself + +use vars qw ($commit $tree @parent $author $committer); +use vars qw ($user $branch $rev @files $logmsg $message $shorturl); +my $line; + +if ($project eq "") { + croak "Project variable is required. Please set one with git config --add cia.project"; +} + +if ($repo eq "") { + undef $baseurl; +} + +# Let's be extra-safe here +if ($module eq "") { + undef $module; +} + + +### Input data loading + + +# The commit stuff +$commit = $ARGV[0]; +$branch = $ARGV[1]; + +open COMMIT, "git cat-file commit $commit|" or die "git cat-file commit $commit: $!"; +my $state = 0; +$logmsg = ''; +while (defined ($line = <COMMIT>)) { + if ($state == 1) { + $logmsg .= $line; + $noisy or $state++; + next; + } elsif ($state > 1) { + next; + } + + chomp $line; + unless ($line) { + $state = 1; + next; + } + + my ($key, $value) = split(/ /, $line, 2); + if ($key eq 'tree') { + $tree = $value; + } elsif ($key eq 'parent') { + push(@parent, $value); + } elsif ($key eq 'author') { + $author = $value; + } elsif ($key eq 'committer') { + $committer = $value; + } +} +close COMMIT; + + +open DIFF, "git diff-tree -r $parent[0] $tree|" or die "git diff-tree $parent[0] $tree: $!"; +while (defined ($line = <DIFF>)) { + chomp $line; + my @f; + (undef, @f) = split(/\t/, $line, 2); + push (@files, @f); +} +close DIFF; + + +# Figure out who is doing the update. +# XXX: Too trivial this way? +($user) = $author =~ /<(.*?)@/; + + +$rev = substr($commit, 0, 12); + + + + +### Remove to-be-ignored files + +@files = grep { $_ !~ m/$ignore_regexp/; } @files + if ($ignore_regexp); +exit unless @files; + + + +### Compose the mail message + + +my ($VERSION) = '2.0'; +my $ts = time; + +$message = <<EM +<message> + <generator> + <name>CIA Perl client for Git</name> + <version>$VERSION</version> + </generator> + <source> + <project>$project</project> + +EM +; +$message .= " <module>$module</module>" if ($module); +$message .= " <branch>$branch</branch>" if ($branch); +$message .= <<EM + </source> + <timestamp> + $ts + </timestamp> + <body> + <commit> + <author>$user</author> + <revision>$rev</revision> + <files> +EM +; + +foreach (@files) { + s/&/&/g; + s/</</g; + s/>/>/g; + $message .= " <file>$_</file>\n"; +} + +$logmsg =~ s/&/&/g; +$logmsg =~ s/</</g; +$logmsg =~ s/>/>/g; + +if (defined $baseurl) { + $shorturl = $baseurl . $rev; + $logmsg = $logmsg . $shorturl; +} + +$message .= <<EM + </files> + <log>$logmsg</log> + </commit> + </body> +</message> +EM +; + + + +### Write the message to an alt-target + +if ($alt_local_message_target and open (ALT, ">>$alt_local_message_target")) { + print ALT $message; + close ALT; +} + + + +### Send out the XML-RPC message + + +if ($xml_rpc) { + # We gotta be careful from now on. We silence all the warnings because + # RPC::XML code is crappy and works with undefs etc. + $^W = 0; + $RPC::XML::ERROR if (0); # silence perl's compile-time warning + + require RPC::XML; + require RPC::XML::Client; + + my $rpc_client = new RPC::XML::Client $rpc_uri; + my $rpc_request = RPC::XML::request->new('hub.deliver', $message); + my $rpc_response = $rpc_client->send_request($rpc_request); + + unless (ref $rpc_response) { + carp "XML-RPC Error: $RPC::XML::ERROR. No CIA notification will be displayed for what was pushed.\n"; + } + exit; +} + + + +### Send out the mail + + +# Open our mail program + +open (MAIL, "| $sendmail -t -oi -oem") or die "Cannot execute $sendmail : " . ($?>>8); + + +# The mail header + +print MAIL <<EOM; +From: $from_email +To: $dest_email +Content-type: text/xml +Subject: DeliverXML + +EOM + +print MAIL $message; + + +# Close the mail + +close MAIL; +die "$0: sendmail exit status " . ($? >> 8) . "\n" unless ($? == 0); + +# vi: set sw=2: -- 1.7.5.1