[thirdparty/git.git] / contrib / ciabot / ciabot.py

#!/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
# 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.
#
# In post-commit, run it without arguments. It will query for
# current HEAD and the latest commit ID to get the information it
# needs.
#
# In update, call it with a refname followed by a list of commits:
# You want to reverse the order git rev-list emits because it lists
# from most recent to oldest.
#
# /path/to/ciabot.py ${refname} $(git rev-list ${oldhead}..${newhead} | tac)
#
# Configuration variables affecting this script:
#
# ciabot.project = name of the project
# 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
#
# 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.
#
# 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'.
#
# Note: the CIA project now says only XML-RPC is reliable, so
# we default to that.
#

import sys
if sys.hexversion < 0x02000000:
        # The limiter is the xml.sax module
        sys.stderr.write("ciabot.py: requires Python 2.0.0 or later.\n")
        sys.exit(1)

import os, commands, socket, urllib
from xml.sax.saxutils import escape

# 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 notification 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>
    <version>%(version)s</version>
    <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:
#

# Where to ship e-mail notifications.
toaddr = "cia@cia.vc"

# Identify the generator script.
# Should only change when the script itself gets a new home and maintainer.
generator = "http://www.catb.org/~esr/ciabot.py"
version = "3.6"

def do(command):
    return commands.getstatusoutput(command)[1]

def report(refname, merged, xmlrpc=True):
    "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)

    # 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
    files=do("git diff-tree -r --name-only '"+ merged +"' | sed -e '1d' -e 's-.*-<file>&</file>-'")
    metainfo = do("git log -1 '--pretty=format:%an <%ae>%n%at%n%s' " + merged)
    (author, ts, logmsg) = metainfo.split("\n")
    logmsg = escape(logmsg)

    # This discards the part of the author's address after @.
    # Might be be nice to ship the full email address, if not
    # for spammers' address harvesters - getting this wrong
    # would make the freenode #commits channel into harvester heaven.
    author = escape(author.replace("<", "").split("@")[0].split()[-1])

    # This ignores the timezone.  Not clear what to do with it...
    ts = ts.strip().split()[0]

    context = locals()
    context.update(globals())

    out = xml % context
    mail = '''\
Message-ID: <%(merged)s.%(author)s@%(project)s>
From: %(fromaddr)s
To: %(toaddr)s
Content-type: text/xml
Subject: DeliverXML

%(out)s''' % locals()

    if xmlrpc:
        return out
    else:
        return mail

if __name__ == "__main__":
    import getopt

    # 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

    try:
        (options, arguments) = getopt.getopt(sys.argv[1:], "np:xV")
    except getopt.GetoptError, msg:
        print "ciabot.py: " + str(msg)
        raise SystemExit, 1

    notify = True
    for (switch, val) in options:
        if switch == '-p':
            project = val
        elif switch == '-n':
            notify = False
        elif switch == '-x':
            xmlrpc = True
        elif switch == '-V':
            print "ciabot.py: version", version
            sys.exit(0)

    # The project variable defaults to the name of the repository toplevel.
    if not project:
        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)

    if not repo:
        repo = project.lower()

    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:]

    if notify:
        if xmlrpc:
            import xmlrpclib
            server = xmlrpclib.Server('http://cia.vc/RPC2');
        else:
            import smtplib
            server = smtplib.SMTP('localhost')

    for merged in merges:
        message = report(refname, merged, xmlrpc)
        if not notify:
            print message
        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)

    if notify:
        if not xmlrpc:
            server.quit()

#End
Commit	Line	Data
2c4dc023 ER	1	#!/usr/bin/env python
	2	# Copyright (c) 2010 Eric S. Raymond <esr@thyrsus.com>
	3	# Distributed under BSD terms.
	4	#
	5	# This script contains porcelain and porcelain byproducts.
	6	# It's Python because the Python standard libraries avoid portability/security
	7	# issues raised by callouts in the ancestral Perl and sh scripts. It should
	8	# be compatible back to Python 2.1.5
	9	#
	10	# usage: ciabot.py [-V] [-n] [-p projectname] [refname [commits...]]
	11	#
	12	# This script is meant to be run either in a post-commit hook or in an
df1effa6 ER	13	# update hook. Try it with -n to see the notification mail dumped to
	14	# stdout and verify that it looks sane. With -V it dumps its version
	15	# and exits.
2c4dc023	16	#
c142616f ER	17	# In post-commit, run it without arguments. It will query for
	18	# current HEAD and the latest commit ID to get the information it
	19	# needs.
2c4dc023 ER	20	#
2c4dc023 ER	21	# In update, call it with a refname followed by a list of commits:
c142616f	22	# You want to reverse the order git rev-list emits because it lists
2c4dc023 ER	23	# from most recent to oldest.
	24	#
	25	# /path/to/ciabot.py ${refname} $(git rev-list ${oldhead}..${newhead} \| tac)
	26	#
c142616f	27	# Configuration variables affecting this script:
df1effa6 ER	28	#
df1effa6 ER	29	# ciabot.project = name of the project
c142616f ER	30	# ciabot.repo = name of the project repo for gitweb/cgit purposes
	31	# ciabot.xmlrpc = if true (default), ship notifications via XML-RPC
	32	# ciabot.revformat = format in which the revision is shown
2c4dc023	33	#
df1effa6 ER	34	# ciabot.project defaults to the directory name of the repository toplevel.
	35	# ciabot.repo defaults to ciabot.project lowercased.
	36	#
	37	# This means that in the normal case you need not do any configuration at all,
	38	# but setting the project name will speed it up slightly.
2c4dc023	39	#
c142616f ER	40	# The revformat variable may have the following values
	41	# raw -> full hex ID of commit
	42	# short -> first 12 chars of hex ID
	43	# describe = -> describe relative to last tag, falling back to short
	44	# The default is 'describe'.
2c4dc023	45	#
c142616f ER	46	# Note: the CIA project now says only XML-RPC is reliable, so
c142616f ER	47	# we default to that.
2c4dc023	48	#
2c4dc023	49
a33faf28 ER	50	import sys
	51	if sys.hexversion < 0x02000000:
	52	# The limiter is the xml.sax module
	53	sys.stderr.write("ciabot.py: requires Python 2.0.0 or later.\n")
	54	sys.exit(1)
	55
	56	import os, commands, socket, urllib
c142616f	57	from xml.sax.saxutils import escape
2c4dc023 ER	58
	59	# Changeset URL prefix for your repo: when the commit ID is appended
	60	# to this, it should point at a CGI that will display the commit
	61	# through gitweb or something similar. The defaults will probably
	62	# work if you have a typical gitweb/cgit setup.
	63	#
	64	#urlprefix="http://%(host)s/cgi-bin/gitweb.cgi?p=%(repo)s;a=commit;h="
	65	urlprefix="http://%(host)s/cgi-bin/cgit.cgi/%(repo)s/commit/?id="
	66
	67	# The service used to turn your gitwebbish URL into a tinyurl so it
	68	# will take up less space on the IRC notification line.
	69	tinyifier = "http://tinyurl.com/api-create.php?url="
	70
	71	# The template used to generate the XML messages to CIA. You can make
	72	# visible changes to the IRC-bot notification lines by hacking this.
98e023de	73	# The default will produce a notification line that looks like this:
2c4dc023 ER	74	#
	75	# ${project}: ${author} ${repo}:${branch} * ${rev} ${files}: ${logmsg} ${url}
	76	#
	77	# By omitting $files you can collapse the files part to a single slash.
	78	xml = '''\
	79	<message>
	80	<generator>
	81	<name>CIA Python client for Git</name>
c142616f	82	<version>%(version)s</version>
2c4dc023 ER	83	<url>%(generator)s</url>
	84	</generator>
	85	<source>
	86	<project>%(project)s</project>
	87	<branch>%(repo)s:%(branch)s</branch>
	88	</source>
	89	<timestamp>%(ts)s</timestamp>
	90	<body>
	91	<commit>
	92	<author>%(author)s</author>
	93	<revision>%(rev)s</revision>
	94	<files>
	95	%(files)s
	96	</files>
	97	<log>%(logmsg)s %(url)s</log>
	98	<url>%(url)s</url>
	99	</commit>
	100	</body>
	101	</message>
	102	'''
	103
	104	#
	105	# No user-serviceable parts below this line:
	106	#
	107
c142616f ER	108	# Where to ship e-mail notifications.
c142616f ER	109	toaddr = "cia@cia.vc"
2c4dc023 ER	110
	111	# Identify the generator script.
	112	# Should only change when the script itself gets a new home and maintainer.
c142616f	113	generator = "http://www.catb.org/~esr/ciabot.py"
df1effa6	114	version = "3.6"
2c4dc023 ER	115
	116	def do(command):
	117	return commands.getstatusoutput(command)[1]
	118
c142616f	119	def report(refname, merged, xmlrpc=True):
2c4dc023 ER	120	"Generate a commit notification to be reported to CIA"
	121
	122	# Try to tinyfy a reference to a web view for this commit.
	123	try:
	124	url = open(urllib.urlretrieve(tinyifier + urlprefix + merged)[0]).read()
	125	except:
	126	url = urlprefix + merged
	127
	128	branch = os.path.basename(refname)
	129
c142616f ER	130	# Compute a description for the revision
	131	if revformat == 'raw':
	132	rev = merged
	133	elif revformat == 'short':
	134	rev = ''
	135	else: # revformat == 'describe'
	136	rev = do("git describe %s 2>/dev/null" % merged)
	137	if not rev:
	138	rev = merged[:12]
	139
	140	# Extract the meta-information for the commit
2c4dc023	141	files=do("git diff-tree -r --name-only '"+ merged +"' \| sed -e '1d' -e 's-.*-<file>&</file>-'")
c142616f ER	142	metainfo = do("git log -1 '--pretty=format:%an <%ae>%n%at%n%s' " + merged)
	143	(author, ts, logmsg) = metainfo.split("\n")
	144	logmsg = escape(logmsg)
2c4dc023	145
c142616f ER	146	# This discards the part of the author's address after @.
c142616f ER	147	# Might be be nice to ship the full email address, if not
2c4dc023 ER	148	# for spammers' address harvesters - getting this wrong
2c4dc023 ER	149	# would make the freenode #commits channel into harvester heaven.
c142616f	150	author = escape(author.replace("<", "").split("@")[0].split()[-1])
2c4dc023 ER	151
	152	# This ignores the timezone. Not clear what to do with it...
	153	ts = ts.strip().split()[0]
	154
	155	context = locals()
	156	context.update(globals())
	157
	158	out = xml % context
c142616f	159	mail = '''\
2c4dc023 ER	160	Message-ID: <%(merged)s.%(author)s@%(project)s>
	161	From: %(fromaddr)s
	162	To: %(toaddr)s
	163	Content-type: text/xml
	164	Subject: DeliverXML
	165
	166	%(out)s''' % locals()
	167
c142616f ER	168	if xmlrpc:
	169	return out
	170	else:
	171	return mail
2c4dc023 ER	172
	173	if __name__ == "__main__":
	174	import getopt
	175
c142616f ER	176	# Get all config variables
	177	revformat = do("git config --get ciabot.revformat")
	178	project = do("git config --get ciabot.project")
	179	repo = do("git config --get ciabot.repo")
	180	xmlrpc = do("git config --get ciabot.xmlrpc")
	181	xmlrpc = not (xmlrpc and xmlrpc == "false")
	182
	183	host = socket.getfqdn()
	184	fromaddr = "CIABOT-NOREPLY@" + host
	185
2c4dc023	186	try:
c142616f	187	(options, arguments) = getopt.getopt(sys.argv[1:], "np:xV")
2c4dc023 ER	188	except getopt.GetoptError, msg:
	189	print "ciabot.py: " + str(msg)
	190	raise SystemExit, 1
	191
c142616f	192	notify = True
2c4dc023 ER	193	for (switch, val) in options:
	194	if switch == '-p':
	195	project = val
	196	elif switch == '-n':
c142616f ER	197	notify = False
	198	elif switch == '-x':
	199	xmlrpc = True
2c4dc023	200	elif switch == '-V':
c142616f	201	print "ciabot.py: version", version
2c4dc023 ER	202	sys.exit(0)
2c4dc023 ER	203
df1effa6	204	# The project variable defaults to the name of the repository toplevel.
2c4dc023	205	if not project:
df1effa6 ER	206	here = os.getcwd()
	207	while True:
	208	if os.path.exists(os.path.join(here, ".git")):
	209	project = os.path.basename(here)
	210	break
	211	elif here == '/':
	212	sys.stderr.write("ciabot.py: no .git below root!\n")
	213	sys.exit(1)
	214	here = os.path.dirname(here)
2c4dc023	215
c142616f ER	216	if not repo:
c142616f ER	217	repo = project.lower()
2c4dc023 ER	218
	219	urlprefix = urlprefix % globals()
	220
	221	# The script wants a reference to head followed by the list of
	222	# commit ID to report about.
	223	if len(arguments) == 0:
	224	refname = do("git symbolic-ref HEAD 2>/dev/null")
	225	merges = [do("git rev-parse HEAD")]
	226	else:
	227	refname = arguments[0]
	228	merges = arguments[1:]
	229
c142616f ER	230	if notify:
	231	if xmlrpc:
	232	import xmlrpclib
	233	server = xmlrpclib.Server('http://cia.vc/RPC2');
	234	else:
	235	import smtplib
	236	server = smtplib.SMTP('localhost')
2c4dc023 ER	237
2c4dc023 ER	238	for merged in merges:
c142616f ER	239	message = report(refname, merged, xmlrpc)
c142616f ER	240	if not notify:
2c4dc023	241	print message
c142616f ER	242	elif xmlrpc:
	243	try:
	244	# RPC server is flaky, this can fail due to timeout.
	245	server.hub.deliver(message)
	246	except socket.error, e:
	247	sys.stderr.write("%s\n" % e)
	248	else:
	249	server.sendmail(fromaddr, [toaddr], message)
2c4dc023	250
c142616f ER	251	if notify:
	252	if not xmlrpc:
	253	server.quit()
2c4dc023 ER	254
2c4dc023 ER	255	#End