irkerhook.py

#!/usr/bin/env python
# Copyright (c) 2012 Eric S. Raymond <esr@thyrsus.com>
# Distributed under BSD terms.
#
# This script contains git porcelain and porcelain byproducts.
# Requires Python 2.6, or 2.4 with the 2.6 json library installed.
#
# usage: irkerhook.py [-V] [-n]
#
# This script is meant to be run in a post-commit hook.  Try it with
# -n to see the notification dumped to stdout and verify that it looks
# sane. With -V this script dumps its version and exits.
#
# See the irkerhook manual page in the distribution for a detailed
# explanation of how to configure this hook.
#
# Other configuration changes you may want to make are to:
#
# urlprefix: the current version should work for viewcvs or gitweb
# installations, but will require modification for other systems.
#
# tinyfier: If your project maintains its own url-shrinking service

# The default location of the irker proxy, if the project configuration
# does not override it.
default_server = "localhost"
IRKER_PORT = 6659

# 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="

#
# No user-serviceable parts below this line:
#

import os, sys, commands, socket, urllib, json

version = "1.2"

def shellquote(s):
    return "'" + s.replace("'","'\\''") + "'"

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

def urlify(extractor, commit):
    prefix = urlprefix % extractor.__dict__
    # Try to tinyfy a reference to a web view for this commit.
    try:
        url = open(urllib.urlretrieve(tinyifier + prefix + commit)[0]).read()
    except:
        url = prefix + commit
    return url

class GitExtractor:
    "Metadata extraction for the git version control system."
    def __init__(self, project=None):
        # Get all global config variables
        self.project = project or do("git config --get irker.project")
        self.repo = do("git config --get irker.repo")
        self.server = do("git config --get irker.server")
        self.channels = do("git config --get irker.channels")
        self.tcp = do("git config --bool --get irker.tcp")
        # This one is git-specific
        self.revformat = do("git config --get irker.revformat")
        # The project variable defaults to the name of the repository toplevel.
        if not self.project:
            bare = do("git config --bool --get core.bare")
            if bare.lower() == "true":
                keyfile = "HEAD"
            else:
                keyfile = ".git/HEAD"
            here = os.getcwd()
            while True:
                if os.path.exists(os.path.join(here, keyfile)):
                    self.project = os.path.basename(here)
                    break
                elif here == '/':
                    sys.stderr.write("irkerhook.py: no git repo below root!\n")
                    sys.exit(1)
                here = os.path.dirname(here)
        # Revision level
        self.refname = do("git symbolic-ref HEAD 2>/dev/null")
        self.commit = do("git rev-parse HEAD")

        self.branch = os.path.basename(self.refname)

        # Compute a description for the revision
        if self.revformat == 'raw':
            self.rev = self.commit
        elif self.revformat == 'short':
            self.rev = ''
        else: # self.revformat == 'describe'
            self.rev = do("git describe %s 2>/dev/null" % shellquote(self.commit))
        if not self.rev:
            self.rev = self.commit[:12]

        # Extract the meta-information for the commit
        self.files = do("git diff-tree -r --name-only " + shellquote(self.commit))
        self.files = " ".join(self.files.strip().split("\n")[1:])
        metainfo = do("git log -1 '--pretty=format:%an <%ae>%n%s' " + shellquote(self.commit))
        (self.author, self.logmsg) = metainfo.split("\n")
        # 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.
        self.author = self.author.replace("<", "").split("@")[0].split()[-1]

def load_preferences(extractor, conf):
    "Load preferences from a file in the repository root."
    ln = 0
    for line in open(conf):
        ln += 1
        if line.startswith("#") or not line.strip():
            continue
        elif line.count('=') != 1:
            sys.stderr.write('"%s", line %d: missing = in config line\n' \
                             % (conf, ln))
            continue
        fields = line.split('=')
        if len(fields) != 2:
            sys.stderr.write('"%s", line %d: too many fields in config line\n' \
                             % (conf, ln))
            continue
        fld = fields[0].strip()
        val = fields[1].strip()
        if val.lower() == "true":
            val = True
        if val.lower() == "false":
            val = False
        setattr(extractor, fld, val)

class SvnExtractor:
    "Metadata extraction for the svn version control system."
    def __init__(self, arguments):
        self.commit = None
        # Some things we need to have before metadata queries will work
        for tok in arguments:
            if tok.startswith("repository="):
                self.repository = tok[11:]
            elif tok.startswith("commit="):
                self.commit = tok[7:]
        self.project = os.path.basename(self.repository)
        self.repo = None
        self.server = None
        self.channels = None
        self.tcp = True
        self.author = self.svnlook("author")
        self.files = self.svnlook("dirs-changed").strip().replace("\n", " ")
        self.logmsg = self.svnlook("log")
        self.rev = "r%s" % self.commit
        load_preferences(self, os.path.join(self.repository, "irker.conf"))
    def svnlook(self, info):
        return do("svnlook %s %s --revision %s" % (shellquote(info), shellquote(self.repository), shellquote(self.commit)))

if __name__ == "__main__":
    import getopt

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

    notify = True
    channels = ""
    commit = ""
    repository = ""
    for (switch, val) in options:
        if switch == '-n':
            notify = False
        elif switch == '-V':
            print "irkerhook.py: version", version
            sys.exit(0)

    # Gather info for repo type discrimination, make globals settable
    for tok in arguments:
        if tok.startswith("tinyfier="):
            tinyfier = tok[9:]
        elif tok.startswith("repository="):
            repository = tok[11:]

    # Determine the repository type. Default to git unless user has pointed
    # us at a repo with identifiable internals.
    vcs = "git"
    if os.path.exists(os.path.join(repository, "format")):
        vcs = "svn"

    # Someday we'll have extractors for several version-control systems
    if vcs == "svn":
        extractor = SvnExtractor(arguments)
    else:
        extractor = GitExtractor()

    # 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="
    if vcs == "svn":
        urlprefix = "http://%(host)s/viewcvs/%(repo)s?view=revision&revision="
    else:
        urlprefix = "http://%(host)s/cgi-bin/cgit.cgi/%(repo)s/commit/?id="
    # The template used to generate notifications.  You can make
    # visible changes to the IRC-bot notification lines by hacking this.
    #
    # ${project}: ${author} ${repo}:${branch} * ${rev} / ${files}: ${logmsg} ${url}
    if vcs == "svn":
        template = '%(project)s: %(author)s %(repo)s * %(rev)s / %(files)s: %(logmsg)s %(url)s'
    else:
        template = '%(project)s: %(author)s %(repo)s:%(branch)s * %(rev)s / %(files)s: %(logmsg)s %(url)s'

    # Make command-line overrides possible.
    # Each argument of the form <key>=<value> can override the
    # <key> member of the extractor class. 
    booleans = ["tcp"]
    for tok in arguments:
        for key in extractor.__dict__:
            if tok.startswith(key + "="):
                val = tok[len(key)+1:]
                if key in booleans:
                    if val.lower() == "true":
                        setattr(extractor, key, True)
                    elif val.lower() == "false":
                        setattr(extractor, key, False)
                else:
                    setattr(extractor, key, val)

    # By default, the channel list includes the freenode #commits list 
    if not extractor.channels:
        extractor.channels = "irc://chat.freenode.net/%s,irc://chat.freenode.net/#commits" % extractor.project
    # Other defaults get set here
    if not extractor.repo:
        extractor.repo = extractor.project.lower()
    extractor.host = socket.getfqdn()            
    extractor.url = urlify(extractor, extractor.commit)

    if not extractor.project:
        sys.stderr.write("irkerhook.py: no project name set!\n")
        sys.exit(1)

    # Message reduction.  The assumption here is that IRC can't handle
    # lines more than 510 characters long. If we exceed that length, we
    # try knocking out the file list, on the theory that for notification
    # purposes the commit text is more important.  If it's still too long
    # there's nothing much can be done other than ship it expecting the IRC
    # server to truncate.
    privmsg = template % extractor.__dict__
    if len(privmsg) > 510:
        extractor.files = ""
        privmsg = template % extractor.__dict__

    channel_list = extractor.channels.split(",")
    structure = {"to":channel_list, "privmsg":privmsg}
    message = json.dumps(structure)
    if not notify:
        print message
    else:
        try:
            if extractor.tcp:
                try:
                    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
                    sock.connect((extractor.server or default_server, IRKER_PORT))
                    sock.sendall(message + "\n")
                finally:
                    sock.close()
            else:
                try:
                    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
                    sock.sendto(message + "\n", (extractor.server or default_server, IRKER_PORT))
                finally:
                    sock.close()
        except socket.error, e:
            sys.stderr.write("%s\n" % e)

#End