plugins/OStatus/lib/webfinger.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * A sample module to show best practices for StatusNet plugins
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @package   StatusNet
  24  * @author    James Walker <james@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 define('WEBFINGER_SERVICE_REL_VALUE', 'lrdd');
  31
  32 /**
  33  * Implement the webfinger protocol.
  34  */
  35
  36 class Webfinger
  37 {
  38     const PROFILEPAGE = 'http://webfinger.net/rel/profile-page';
  39     const UPDATESFROM = 'http://schemas.google.com/g/2010#updates-from';
  40     const HCARD       = 'http://microformats.org/profile/hcard';
  41
  42     /**
  43      * Perform a webfinger lookup given an account.
  44      */
  45
  46     public function lookup($id)
  47     {
  48         $id = $this->normalize($id);
  49         list($name, $domain) = explode('@', $id);
  50
  51         $links = $this->getServiceLinks($domain);
  52         if (!$links) {
  53             return false;
  54         }
  55
  56         $services = array();
  57         foreach ($links as $link) {
  58             if ($link['template']) {
  59                 return $this->getServiceDescription($link['template'], $id);
  60             }
  61             if ($link['href']) {
  62                 return $this->getServiceDescription($link['href'], $id);
  63             }
  64         }
  65     }
  66
  67     /**
  68      * Normalize an account ID
  69      */
  70     function normalize($id)
  71     {
  72         if (substr($id, 0, 7) == 'acct://') {
  73             return substr($id, 7);
  74         } else if (substr($id, 0, 5) == 'acct:') {
  75             return substr($id, 5);
  76         }
  77
  78         return $id;
  79     }
  80
  81     function getServiceLinks($domain)
  82     {
  83         $url = 'http://'. $domain .'/.well-known/host-meta';
  84
  85         $content = $this->fetchURL($url);
  86
  87         if (empty($content)) {
  88             common_log(LOG_DEBUG, 'Error fetching host-meta');
  89             return false;
  90         }
  91
  92         $result = XRD::parse($content);
  93
  94         // Ensure that the host == domain (spec may include signing later)
  95         if ($result->host != $domain) {
  96             return false;
  97         }
  98
  99         $links = array();
 100         foreach ($result->links as $link) {
 101             if ($link['rel'] == WEBFINGER_SERVICE_REL_VALUE) {
 102                 $links[] = $link;
 103             }
 104
 105         }
 106         return $links;
 107     }
 108
 109     function getServiceDescription($template, $id)
 110     {
 111         $url = $this->applyTemplate($template, 'acct:' . $id);
 112
 113         $content = $this->fetchURL($url);
 114
 115         if (!$content) {
 116             return false;
 117         }
 118
 119         return XRD::parse($content);
 120     }
 121
 122     function fetchURL($url)
 123     {
 124         try {
 125             $c = Cache::instance();
 126             $content = $c->get('webfinger:url:'.$url);
 127             if ($content !== false) {
 128                 return $content;
 129             }
 130             $client = new HTTPClient();
 131             $response = $client->get($url);
 132         } catch (HTTP_Request2_Exception $e) {
 133             return false;
 134         }
 135
 136         if ($response->getStatus() != 200) {
 137             return false;
 138         }
 139
 140         $body = $response->getBody();
 141
 142         $c->set('webfinger:url:'.$url, $body);
 143
 144         return $body;
 145     }
 146
 147     function applyTemplate($template, $id)
 148     {
 149         $template = str_replace('{uri}', urlencode($id), $template);
 150
 151         return $template;
 152     }
 153
 154     function getHostMeta($domain, $template) {
 155         $xrd = new XRD();
 156         $xrd->host = $domain;
 157         $xrd->links[] = array('rel' => 'lrdd',
 158                               'template' => $template,
 159                               'title' => array('Resource Descriptor'));
 160
 161         return $xrd->toXML();
 162     }
 163 }
 164