2010-04-02 12:10:11 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
|
# Copyright (c) 2010 Eric S. Raymond <esr@thyrsus.com>
|
|
|
|
|
# Distributed under BSD terms.
|
|
|
|
|
#
|
|
|
|
|
# This script contains porcelain and porcelain byproducts.
|
|
|
|
|
# It's Python because the Python standard libraries avoid portability/security
|
|
|
|
|
# issues raised by callouts in the ancestral Perl and sh scripts. It should
|
|
|
|
|
# be compatible back to Python 2.1.5
|
|
|
|
|
#
|
|
|
|
|
# usage: ciabot.py [-V] [-n] [-p projectname] [refname [commits...]]
|
|
|
|
|
#
|
|
|
|
|
# This script is meant to be run either in a post-commit hook or in an
|
2012-08-23 07:21:53 +02:00
|
|
|
# update hook. Try it with -n to see the notification mail dumped to
|
|
|
|
|
# stdout and verify that it looks sane. With -V it dumps its version
|
|
|
|
|
# and exits.
|
2010-04-02 12:10:11 +02:00
|
|
|
#
|
2012-08-22 12:52:30 +02:00
|
|
|
# In post-commit, run it without arguments. It will query for
|
|
|
|
|
# current HEAD and the latest commit ID to get the information it
|
|
|
|
|
# needs.
|
2010-04-02 12:10:11 +02:00
|
|
|
#
|
|
|
|
|
# In update, call it with a refname followed by a list of commits:
|
2012-08-22 12:52:30 +02:00
|
|
|
# You want to reverse the order git rev-list emits because it lists
|
2010-04-02 12:10:11 +02:00
|
|
|
# from most recent to oldest.
|
|
|
|
|
#
|
|
|
|
|
# /path/to/ciabot.py ${refname} $(git rev-list ${oldhead}..${newhead} | tac)
|
|
|
|
|
#
|
2012-08-22 12:52:30 +02:00
|
|
|
# Configuration variables affecting this script:
|
2012-08-23 07:21:53 +02:00
|
|
|
#
|
|
|
|
|
# ciabot.project = name of the project
|
2012-08-22 12:52:30 +02:00
|
|
|
# ciabot.repo = name of the project repo for gitweb/cgit purposes
|
|
|
|
|
# ciabot.xmlrpc = if true (default), ship notifications via XML-RPC
|
|
|
|
|
# ciabot.revformat = format in which the revision is shown
|
2010-04-02 12:10:11 +02:00
|
|
|
#
|
2012-08-23 07:21:53 +02:00
|
|
|
# ciabot.project defaults to the directory name of the repository toplevel.
|
|
|
|
|
# ciabot.repo defaults to ciabot.project lowercased.
|
|
|
|
|
#
|
|
|
|
|
# This means that in the normal case you need not do any configuration at all,
|
|
|
|
|
# but setting the project name will speed it up slightly.
|
2010-04-02 12:10:11 +02:00
|
|
|
#
|
2012-08-22 12:52:30 +02:00
|
|
|
# The revformat variable may have the following values
|
|
|
|
|
# raw -> full hex ID of commit
|
|
|
|
|
# short -> first 12 chars of hex ID
|
|
|
|
|
# describe = -> describe relative to last tag, falling back to short
|
|
|
|
|
# The default is 'describe'.
|
2010-04-02 12:10:11 +02:00
|
|
|
#
|
2012-08-22 12:52:30 +02:00
|
|
|
# Note: the CIA project now says only XML-RPC is reliable, so
|
|
|
|
|
# we default to that.
|
2010-04-02 12:10:11 +02:00
|
|
|
#
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
import os, sys, commands, socket, urllib
|
|
|
|
|
from xml.sax.saxutils import escape
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
# Changeset URL prefix for your repo: when the commit ID is appended
|
|
|
|
|
# to this, it should point at a CGI that will display the commit
|
|
|
|
|
# through gitweb or something similar. The defaults will probably
|
|
|
|
|
# work if you have a typical gitweb/cgit setup.
|
|
|
|
|
#
|
|
|
|
|
#urlprefix="http://%(host)s/cgi-bin/gitweb.cgi?p=%(repo)s;a=commit;h="
|
|
|
|
|
urlprefix="http://%(host)s/cgi-bin/cgit.cgi/%(repo)s/commit/?id="
|
|
|
|
|
|
|
|
|
|
# The service used to turn your gitwebbish URL into a tinyurl so it
|
|
|
|
|
# will take up less space on the IRC notification line.
|
|
|
|
|
tinyifier = "http://tinyurl.com/api-create.php?url="
|
|
|
|
|
|
|
|
|
|
# The template used to generate the XML messages to CIA. You can make
|
|
|
|
|
# visible changes to the IRC-bot notification lines by hacking this.
|
|
|
|
|
# The default will produce a notfication line that looks like this:
|
|
|
|
|
#
|
|
|
|
|
# ${project}: ${author} ${repo}:${branch} * ${rev} ${files}: ${logmsg} ${url}
|
|
|
|
|
#
|
|
|
|
|
# By omitting $files you can collapse the files part to a single slash.
|
|
|
|
|
xml = '''\
|
|
|
|
|
<message>
|
|
|
|
|
<generator>
|
|
|
|
|
<name>CIA Python client for Git</name>
|
2012-08-22 12:52:30 +02:00
|
|
|
<version>%(version)s</version>
|
2010-04-02 12:10:11 +02:00
|
|
|
<url>%(generator)s</url>
|
|
|
|
|
</generator>
|
|
|
|
|
<source>
|
|
|
|
|
<project>%(project)s</project>
|
|
|
|
|
<branch>%(repo)s:%(branch)s</branch>
|
|
|
|
|
</source>
|
|
|
|
|
<timestamp>%(ts)s</timestamp>
|
|
|
|
|
<body>
|
|
|
|
|
<commit>
|
|
|
|
|
<author>%(author)s</author>
|
|
|
|
|
<revision>%(rev)s</revision>
|
|
|
|
|
<files>
|
|
|
|
|
%(files)s
|
|
|
|
|
</files>
|
|
|
|
|
<log>%(logmsg)s %(url)s</log>
|
|
|
|
|
<url>%(url)s</url>
|
|
|
|
|
</commit>
|
|
|
|
|
</body>
|
|
|
|
|
</message>
|
|
|
|
|
'''
|
|
|
|
|
|
|
|
|
|
#
|
|
|
|
|
# No user-serviceable parts below this line:
|
|
|
|
|
#
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
# Where to ship e-mail notifications.
|
|
|
|
|
toaddr = "cia@cia.vc"
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
# Identify the generator script.
|
|
|
|
|
# Should only change when the script itself gets a new home and maintainer.
|
2012-08-22 12:52:30 +02:00
|
|
|
generator = "http://www.catb.org/~esr/ciabot.py"
|
2012-08-23 07:21:53 +02:00
|
|
|
version = "3.6"
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
def do(command):
|
|
|
|
|
return commands.getstatusoutput(command)[1]
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
def report(refname, merged, xmlrpc=True):
|
2010-04-02 12:10:11 +02:00
|
|
|
"Generate a commit notification to be reported to CIA"
|
|
|
|
|
|
|
|
|
|
# Try to tinyfy a reference to a web view for this commit.
|
|
|
|
|
try:
|
|
|
|
|
url = open(urllib.urlretrieve(tinyifier + urlprefix + merged)[0]).read()
|
|
|
|
|
except:
|
|
|
|
|
url = urlprefix + merged
|
|
|
|
|
|
|
|
|
|
branch = os.path.basename(refname)
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
# Compute a description for the revision
|
|
|
|
|
if revformat == 'raw':
|
|
|
|
|
rev = merged
|
|
|
|
|
elif revformat == 'short':
|
|
|
|
|
rev = ''
|
|
|
|
|
else: # revformat == 'describe'
|
|
|
|
|
rev = do("git describe %s 2>/dev/null" % merged)
|
|
|
|
|
if not rev:
|
|
|
|
|
rev = merged[:12]
|
|
|
|
|
|
|
|
|
|
# Extract the meta-information for the commit
|
2010-04-02 12:10:11 +02:00
|
|
|
files=do("git diff-tree -r --name-only '"+ merged +"' | sed -e '1d' -e 's-.*-<file>&</file>-'")
|
2012-08-22 12:52:30 +02:00
|
|
|
metainfo = do("git log -1 '--pretty=format:%an <%ae>%n%at%n%s' " + merged)
|
|
|
|
|
(author, ts, logmsg) = metainfo.split("\n")
|
|
|
|
|
logmsg = escape(logmsg)
|
2010-04-02 12:10:11 +02:00
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
# This discards the part of the author's address after @.
|
|
|
|
|
# Might be be nice to ship the full email address, if not
|
2010-04-02 12:10:11 +02:00
|
|
|
# for spammers' address harvesters - getting this wrong
|
|
|
|
|
# would make the freenode #commits channel into harvester heaven.
|
2012-08-22 12:52:30 +02:00
|
|
|
author = escape(author.replace("<", "").split("@")[0].split()[-1])
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
# This ignores the timezone. Not clear what to do with it...
|
|
|
|
|
ts = ts.strip().split()[0]
|
|
|
|
|
|
|
|
|
|
context = locals()
|
|
|
|
|
context.update(globals())
|
|
|
|
|
|
|
|
|
|
out = xml % context
|
2012-08-22 12:52:30 +02:00
|
|
|
mail = '''\
|
2010-04-02 12:10:11 +02:00
|
|
|
Message-ID: <%(merged)s.%(author)s@%(project)s>
|
|
|
|
|
From: %(fromaddr)s
|
|
|
|
|
To: %(toaddr)s
|
|
|
|
|
Content-type: text/xml
|
|
|
|
|
Subject: DeliverXML
|
|
|
|
|
|
|
|
|
|
%(out)s''' % locals()
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
if xmlrpc:
|
|
|
|
|
return out
|
|
|
|
|
else:
|
|
|
|
|
return mail
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
|
import getopt
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
# Get all config variables
|
|
|
|
|
revformat = do("git config --get ciabot.revformat")
|
|
|
|
|
project = do("git config --get ciabot.project")
|
|
|
|
|
repo = do("git config --get ciabot.repo")
|
|
|
|
|
xmlrpc = do("git config --get ciabot.xmlrpc")
|
|
|
|
|
xmlrpc = not (xmlrpc and xmlrpc == "false")
|
|
|
|
|
|
|
|
|
|
host = socket.getfqdn()
|
|
|
|
|
fromaddr = "CIABOT-NOREPLY@" + host
|
|
|
|
|
|
2010-04-02 12:10:11 +02:00
|
|
|
try:
|
2012-08-22 12:52:30 +02:00
|
|
|
(options, arguments) = getopt.getopt(sys.argv[1:], "np:xV")
|
2010-04-02 12:10:11 +02:00
|
|
|
except getopt.GetoptError, msg:
|
|
|
|
|
print "ciabot.py: " + str(msg)
|
|
|
|
|
raise SystemExit, 1
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
notify = True
|
2010-04-02 12:10:11 +02:00
|
|
|
for (switch, val) in options:
|
|
|
|
|
if switch == '-p':
|
|
|
|
|
project = val
|
|
|
|
|
elif switch == '-n':
|
2012-08-22 12:52:30 +02:00
|
|
|
notify = False
|
|
|
|
|
elif switch == '-x':
|
|
|
|
|
xmlrpc = True
|
2010-04-02 12:10:11 +02:00
|
|
|
elif switch == '-V':
|
2012-08-22 12:52:30 +02:00
|
|
|
print "ciabot.py: version", version
|
2010-04-02 12:10:11 +02:00
|
|
|
sys.exit(0)
|
|
|
|
|
|
2012-08-23 07:21:53 +02:00
|
|
|
# The project variable defaults to the name of the repository toplevel.
|
2010-04-02 12:10:11 +02:00
|
|
|
if not project:
|
2012-08-23 07:21:53 +02:00
|
|
|
here = os.getcwd()
|
|
|
|
|
while True:
|
|
|
|
|
if os.path.exists(os.path.join(here, ".git")):
|
|
|
|
|
project = os.path.basename(here)
|
|
|
|
|
break
|
|
|
|
|
elif here == '/':
|
|
|
|
|
sys.stderr.write("ciabot.py: no .git below root!\n")
|
|
|
|
|
sys.exit(1)
|
|
|
|
|
here = os.path.dirname(here)
|
2010-04-02 12:10:11 +02:00
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
if not repo:
|
|
|
|
|
repo = project.lower()
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
urlprefix = urlprefix % globals()
|
|
|
|
|
|
|
|
|
|
# The script wants a reference to head followed by the list of
|
|
|
|
|
# commit ID to report about.
|
|
|
|
|
if len(arguments) == 0:
|
|
|
|
|
refname = do("git symbolic-ref HEAD 2>/dev/null")
|
|
|
|
|
merges = [do("git rev-parse HEAD")]
|
|
|
|
|
else:
|
|
|
|
|
refname = arguments[0]
|
|
|
|
|
merges = arguments[1:]
|
|
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
if notify:
|
|
|
|
|
if xmlrpc:
|
|
|
|
|
import xmlrpclib
|
|
|
|
|
server = xmlrpclib.Server('http://cia.vc/RPC2');
|
|
|
|
|
else:
|
|
|
|
|
import smtplib
|
|
|
|
|
server = smtplib.SMTP('localhost')
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
for merged in merges:
|
2012-08-22 12:52:30 +02:00
|
|
|
message = report(refname, merged, xmlrpc)
|
|
|
|
|
if not notify:
|
2010-04-02 12:10:11 +02:00
|
|
|
print message
|
2012-08-22 12:52:30 +02:00
|
|
|
elif xmlrpc:
|
|
|
|
|
try:
|
|
|
|
|
# RPC server is flaky, this can fail due to timeout.
|
|
|
|
|
server.hub.deliver(message)
|
|
|
|
|
except socket.error, e:
|
|
|
|
|
sys.stderr.write("%s\n" % e)
|
|
|
|
|
else:
|
|
|
|
|
server.sendmail(fromaddr, [toaddr], message)
|
2010-04-02 12:10:11 +02:00
|
|
|
|
2012-08-22 12:52:30 +02:00
|
|
|
if notify:
|
|
|
|
|
if not xmlrpc:
|
|
|
|
|
server.quit()
|
2010-04-02 12:10:11 +02:00
|
|
|
|
|
|
|
|
#End
|
