1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-30 05:47:53 +01:00
git/contrib/ciabot/ciabot.py
Ondřej Bílka 98e023dea4 many small typofixes
Signed-off-by: Ondřej Bílka <neleai@seznam.cz>
Reviewed-by: Marc Branchaud <marcnarc@xiplink.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-07-29 12:32:25 -07:00

255 lines
7.9 KiB
Python
Executable file

#!/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