GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

Move discovery library from OStatus plugin to core

Browse Source
This commit is contained in:
Evan Prodromou 2011-01-02 10:21:52 -08:00
parent a953b93194
commit 1152b0c3e8
1 changed files with 14 additions and 209 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

223
lib/discovery.php
View File

@ -3,7 +3,7 @@
* StatusNet - the distributed open-source microblogging tool * StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2010, StatusNet, Inc. * Copyright (C) 2010, StatusNet, Inc.
* *
* Use Hammer discovery stack to find out interesting things about an URI * A sample module to show best practices for StatusNet plugins
* *
* PHP version 5 * PHP version 5
* *
@ -20,7 +20,6 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
* *
* @category Discovery
* @package StatusNet * @package StatusNet
* @author James Walker <james@status.net> * @author James Walker <james@status.net>
* @copyright 2010 StatusNet, Inc. * @copyright 2010 StatusNet, Inc.
@ -28,41 +27,22 @@
* @link http://status.net/ * @link http://status.net/
*/ */
if (!defined('STATUSNET')) {
exit(1);
}
/** /**
* This class implements LRDD-based service discovery based on the "Hammer Draft" * This class implements LRDD-based service discovery based on the "Hammer Draft"
* (including webfinger) * (including webfinger)
* *
* @category Discovery * @see http://groups.google.com/group/webfinger/browse_thread/thread/9f3d93a479e91bbf
* @package StatusNet
* @author James Walker <james@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*
* @see http://groups.google.com/group/webfinger/browse_thread/thread/9f3d93a479e91bbf
*/ */
class Discovery class Discovery
{ {
const LRDD_REL = 'lrdd';
const LRDD_REL = 'lrdd';
const PROFILEPAGE = 'http://webfinger.net/rel/profile-page'; const PROFILEPAGE = 'http://webfinger.net/rel/profile-page';
const UPDATESFROM = 'http://schemas.google.com/g/2010#updates-from'; const UPDATESFROM = 'http://schemas.google.com/g/2010#updates-from';
const HCARD = 'http://microformats.org/profile/hcard'; const HCARD = 'http://microformats.org/profile/hcard';
public $methods = array(); public $methods = array();
/**
* Constructor for a discovery object
*
* Registers different discovery methods.
*
* @return Discovery this
*/
public function __construct() public function __construct()
{ {
$this->registerMethod('Discovery_LRDD_Host_Meta'); $this->registerMethod('Discovery_LRDD_Host_Meta');
@ -70,14 +50,6 @@ class Discovery
$this->registerMethod('Discovery_LRDD_Link_HTML'); $this->registerMethod('Discovery_LRDD_Link_HTML');
} }
/**
* Register a discovery class
*
* @param string $class Class name
*
* @return void
*/
public function registerMethod($class) public function registerMethod($class)
{ {
$this->methods[] = $class; $this->methods[] = $class;
@ -86,12 +58,7 @@ class Discovery
/** /**
* Given a "user id" make sure it's normalized to either a webfinger * Given a "user id" make sure it's normalized to either a webfinger
* acct: uri or a profile HTTP URL. * acct: uri or a profile HTTP URL.
*
* @param string $user_id User ID to normalize
*
* @return string normalized acct: or http(s)?: URI
*/ */
public static function normalize($user_id) public static function normalize($user_id)
{ {
if (substr($user_id, 0, 5) == 'http:' || if (substr($user_id, 0, 5) == 'http:' ||
@ -100,23 +67,13 @@ class Discovery
return $user_id; return $user_id;
} }
if (strpos($user_id, '@') !== false) { if (strpos($user_id, '@') !== FALSE) {
return 'acct:' . $user_id; return 'acct:' . $user_id;
} }
return 'http://' . $user_id; return 'http://' . $user_id;
} }
/**
* Determine if a string is a Webfinger ID
*
* Webfinger IDs look like foo@example.com or acct:foo@example.com
*
* @param string $user_id ID to check
*
* @return boolean true if $user_id is a Webfinger, else false
*/
public static function isWebfinger($user_id) public static function isWebfinger($user_id)
{ {
$uri = Discovery::normalize($user_id); $uri = Discovery::normalize($user_id);
@ -125,13 +82,8 @@ class Discovery
} }
/** /**
* Given a user ID, return the first available XRD * This implements the actual lookup procedure
*
* @param string $id User ID URI
*
* @return XRD XRD object for the user
*/ */
public function lookup($id) public function lookup($id)
{ {
// Normalize the incoming $id to make sure we have a uri // Normalize the incoming $id to make sure we have a uri
@ -155,20 +107,10 @@ class Discovery
} }
// TRANS: Exception. // TRANS: Exception.
throw new Exception(sprintf(_('Unable to find services for %s.'), $id)); throw new Exception(sprintf(_m('Unable to find services for %s.'),$id));
} }
/** public static function getService($links, $service) {
* Given an array of links, returns the matching service
*
* @param array $links Links to check
* @param string $service Service to find
*
* @return array $link assoc array representing the link
*/
public static function getService($links, $service)
{
if (!is_array($links)) { if (!is_array($links)) {
return false; return false;
} }
@ -180,17 +122,6 @@ class Discovery
} }
} }
/**
* Apply a template using an ID
*
* Replaces {uri} in template string with the ID given.
*
* @param string $template Template to match
* @param string $id User ID to replace with
*
* @return string replaced values
*/
public static function applyTemplate($template, $id) public static function applyTemplate($template, $id)
{ {
$template = str_replace('{uri}', urlencode($id), $template); $template = str_replace('{uri}', urlencode($id), $template);
@ -198,18 +129,10 @@ class Discovery
return $template; return $template;
} }
/**
* Fetch an XRD file and parse
*
* @param string $url URL of the XRD
*
* @return XRD object representing the XRD file
*/
public static function fetchXrd($url) public static function fetchXrd($url)
{ {
try { try {
$client = new HTTPClient(); $client = new HTTPClient();
$response = $client->get($url); $response = $client->get($url);
} catch (HTTP_Request2_Exception $e) { } catch (HTTP_Request2_Exception $e) {
return false; return false;
@ -223,60 +146,13 @@ class Discovery
} }
} }
/**
* Abstract interface for discovery
*
* Objects that implement this interface can retrieve an array of
* XRD links for the URI.
*
* @category Discovery
* @package StatusNet
* @author James Walker <james@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
interface Discovery_LRDD interface Discovery_LRDD
{ {
/**
* Discover interesting info about the URI
*
* @param string $uri URI to inquire about
*
* @return array Links in the XRD file
*/
public function discover($uri); public function discover($uri);
} }
/**
* Implementation of discovery using host-meta file
*
* Discovers XRD file for a user by going to the organization's
* host-meta file and trying to find a template for LRDD.
*
* @category Discovery
* @package StatusNet
* @author James Walker <james@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class Discovery_LRDD_Host_Meta implements Discovery_LRDD class Discovery_LRDD_Host_Meta implements Discovery_LRDD
{ {
/**
* Discovery core method
*
* For Webfinger and HTTP URIs, fetch the host-meta file
* and look for LRDD templates
*
* @param string $uri URI to inquire about
*
* @return array Links in the XRD file
*/
public function discover($uri) public function discover($uri)
{ {
if (Discovery::isWebfinger($uri)) { if (Discovery::isWebfinger($uri)) {
@ -300,38 +176,12 @@ class Discovery_LRDD_Host_Meta implements Discovery_LRDD
} }
} }
/**
* Implementation of discovery using HTTP Link header
*
* Discovers XRD file for a user by fetching the URL and reading any
* Link: headers in the HTTP response.
*
* @category Discovery
* @package StatusNet
* @author James Walker <james@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class Discovery_LRDD_Link_Header implements Discovery_LRDD class Discovery_LRDD_Link_Header implements Discovery_LRDD
{ {
/**
* Discovery core method
*
* For HTTP IDs fetch the URL and look for Link headers.
*
* @param string $uri URI to inquire about
*
* @return array Links in the XRD file
*
* @todo fail out of Webfinger URIs faster
*/
public function discover($uri) public function discover($uri)
{ {
try { try {
$client = new HTTPClient(); $client = new HTTPClient();
$response = $client->get($uri); $response = $client->get($uri);
} catch (HTTP_Request2_Exception $e) { } catch (HTTP_Request2_Exception $e) {
return false; return false;
@ -349,14 +199,6 @@ class Discovery_LRDD_Link_Header implements Discovery_LRDD
return array(Discovery_LRDD_Link_Header::parseHeader($link_header)); return array(Discovery_LRDD_Link_Header::parseHeader($link_header));
} }
/**
* Given a string or array of headers, returns XRD-like assoc array
*
* @param string|array $header string or array of strings for headers
*
* @return array Link header in XRD-like format
*/
protected static function parseHeader($header) protected static function parseHeader($header)
{ {
$lh = new LinkHeader($header); $lh = new LinkHeader($header);
@ -367,39 +209,12 @@ class Discovery_LRDD_Link_Header implements Discovery_LRDD
} }
} }
/**
* Implementation of discovery using HTML <link> element
*
* Discovers XRD file for a user by fetching the URL and reading any
* <link> elements in the HTML response.
*
* @category Discovery
* @package StatusNet
* @author James Walker <james@status.net>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class Discovery_LRDD_Link_HTML implements Discovery_LRDD class Discovery_LRDD_Link_HTML implements Discovery_LRDD
{ {
/**
* Discovery core method
*
* For HTTP IDs, fetch the URL and look for <link> elements
* in the HTML response.
*
* @param string $uri URI to inquire about
*
* @return array Links in XRD-ish assoc array
*
* @todo fail out of Webfinger URIs faster
*/
public function discover($uri) public function discover($uri)
{ {
try { try {
$client = new HTTPClient(); $client = new HTTPClient();
$response = $client->get($uri); $response = $client->get($uri);
} catch (HTTP_Request2_Exception $e) { } catch (HTTP_Request2_Exception $e) {
return false; return false;
@ -412,16 +227,6 @@ class Discovery_LRDD_Link_HTML implements Discovery_LRDD
return Discovery_LRDD_Link_HTML::parse($response->getBody()); return Discovery_LRDD_Link_HTML::parse($response->getBody());
} }
/**
* Parse HTML and return <link> elements
*
* Given an HTML string, scans the string for <link> elements
*
* @param string $html HTML to scan
*
* @return array array of associative arrays in XRD-ish format
*/
public function parse($html) public function parse($html)
{ {
$links = array(); $links = array();
@ -432,8 +237,8 @@ class Discovery_LRDD_Link_HTML implements Discovery_LRDD
preg_match_all('/<link\s[^>]*>/i', $head_html, $link_matches); preg_match_all('/<link\s[^>]*>/i', $head_html, $link_matches);
foreach ($link_matches[0] as $link_html) { foreach ($link_matches[0] as $link_html) {
$link_url = null; $link_url = null;
$link_rel = null; $link_rel = null;
$link_type = null; $link_type = null;
preg_match('/\srel=(("|\')([^\\2]*?)\\2|[^"\'\s]+)/i', $link_html, $rel_matches); preg_match('/\srel=(("|\')([^\\2]*?)\\2|[^"\'\s]+)/i', $link_html, $rel_matches);