python-webfinger/webfinger.py

import urllib
import urllib2

__version__ = '0.2'

RELS = {
    'activity_streams': 'http://activitystrea.ms/spec/1.0',
    'avatar': 'http://webfinger.net/rel/avatar',
    'hcard': 'http://microformats.org/profile/hcard',
    'open_id': 'http://specs.openid.net/auth/2.0/provider',
    'opensocial': 'http://ns.opensocial.org/2008/opensocial/activitystreams',
    'portable_contacts': 'http://portablecontacts.net/spec/1.0',
    'profile': 'http://webfinger.net/rel/profile-page',
    'xfn': 'http://gmpg.org/xfn/11',
}

WEBFINGER_TYPES = (
    'lrdd',                                 # current
    'http://lrdd.net/rel/descriptor',       # deprecated on 12/11/2009
    'http://webfinger.net/rel/acct-desc',   # deprecated on 11/26/2009
    'http://webfinger.info/rel/service',    # deprecated on 09/17/2009
)

UNOFFICIAL_ENDPOINTS = {
    'facebook.com': 'facebook-webfinger.appspot.com',
    'twitter.com': 'twitter-webfinger.appspot.com',
}


class WebFingerException(Exception):
    pass


class WebFingerResponse(object):

    def __init__(self, xrd, insecure):
        self.insecure = insecure
        self._xrd = xrd

    def __getattr__(self, name):
        if name in RELS:
            return self._xrd.find_link(RELS[name], attr='href')
        return getattr(self._xrd, name)


class WebFingerClient(object):

    def __init__(self, host, timeout=None, official=False):
        self._host = host
        self._official = official
        self._opener = urllib2.build_opener(urllib2.HTTPRedirectHandler())
        self._opener.addheaders = [('User-agent', 'python-webfinger')]

        self._timeout = timeout

    def _hm_hosts(self, xrd):
        hosts = [e.value for e in xrd.elements if e.name == 'hm:Host']
        if not self._official and hosts and self._host in UNOFFICIAL_ENDPOINTS:
            hosts.append(UNOFFICIAL_ENDPOINTS[self._host])
        return hosts

    def xrd(self, url, raw=False):

        from xrd import XRD

        conn = self._opener.open(url, timeout=self._timeout)
        response = conn.read()
        conn.close()

        return response if raw else XRD.parse(response)

    def hostmeta(self, protocol):
        if not self._official and self._host in UNOFFICIAL_ENDPOINTS:
            host = UNOFFICIAL_ENDPOINTS[self._host]
        else:
            host = self._host
        hostmeta_url = "%s://%s/.well-known/host-meta" % (protocol, host)
        return self.xrd(hostmeta_url)

    def finger(self, username):
        try:
            hm = self.hostmeta('https')
            insecure = False
        except (urllib2.URLError, urllib2.HTTPError):
            hm = self.hostmeta('http')
            insecure = True

        hm_hosts = self._hm_hosts(hm)

        if hm_hosts and self._host not in hm_hosts:
            raise WebFingerException("hostmeta host did not match account host")

        template = hm.find_link(WEBFINGER_TYPES, attr='template')
        if not template.startswith('https://'):
            insecure = True
        xrd_url = template.replace('{uri}',
                    urllib.quote_plus('acct:%s@%s' % (username, self._host)))

        data = self.xrd(xrd_url)
        return WebFingerResponse(data, insecure)


def finger(identifier, timeout=None, official=False):
    if identifier.startswith('acct:'):
        (acct, identifier) = identifier.split(':', 1)
    (username, host) = identifier.split('@')
    client = WebFingerClient(host, timeout=timeout, official=official)
    return client.finger(username)


if __name__ == '__main__':

    # example usage

    import sys

    try:
        acct = sys.argv[1]
    except IndexError:
        acct = "jcarbaugh@twitter.com"

    wf = finger(acct)

    print "Activity Streams:  ", wf.activity_streams
    print "Avatar:            ", wf.avatar
    print "HCard:             ", wf.hcard
    print "OpenID:            ", wf.open_id
    print "Open Social:       ", wf.opensocial
    print "Profile:           ", wf.profile
    print "Portable Contacts: ", wf.portable_contacts
    print "XFN:               ", wf.find_link('http://gmpg.org/xfn/11', attr='href')

    if wf.insecure:
        print "*** Warning: Data was retrieved over an insecure connection"