]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/LRDD/lib/discovery.php
Introduced common_location_shared() to check if location sharing is always,
[quix0rs-gnu-social.git] / plugins / LRDD / lib / discovery.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2010, StatusNet, Inc.
5  *
6  * This class performs lookups based on methods implemented in separate
7  * classes, where a resource uri is given. Examples are WebFinger (RFC7033)
8  * and the LRDD (Link-based Resource Descriptor Discovery) in RFC6415.
9  *
10  * PHP version 5
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU Affero General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU Affero General Public License for more details.
21  *
22  * You should have received a copy of the GNU Affero General Public License
23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
24  *
25  * @category  Discovery
26  * @package   GNUsocial
27  * @author    James Walker <james@status.net>
28  * @author    Mikael Nordfeldth <mmn@hethane.se>
29  * @copyright 2010 StatusNet, Inc.
30  * @copyright 2013 Free Software Foundation, Inc.
31  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
32  * @link      http://www.gnu.org/software/social/
33  */
34
35 if (!defined('GNUSOCIAL')) { exit(1); }
36
37 class Discovery
38 {
39     const LRDD_REL    = 'lrdd';
40     const UPDATESFROM = 'http://schemas.google.com/g/2010#updates-from';
41     const HCARD       = 'http://microformats.org/profile/hcard';
42     const MF2_HCARD   = 'http://microformats.org/profile/h-card';   // microformats2 h-card
43
44     const JRD_MIMETYPE_OLD = 'application/json';    // RFC6415 uses this
45     const JRD_MIMETYPE = 'application/jrd+json';
46     const XRD_MIMETYPE = 'application/xrd+xml';
47
48     public $methods = array();
49
50     /**
51      * Constructor for a discovery object
52      *
53      * Registers different discovery methods.
54      *
55      * @return Discovery this
56      */
57
58     public function __construct()
59     {
60         if (Event::handle('StartDiscoveryMethodRegistration', array($this))) {
61             Event::handle('EndDiscoveryMethodRegistration', array($this));
62         }
63     }
64
65     public static function supportedMimeTypes()
66     {
67         return array('json'=>self::JRD_MIMETYPE,
68                      'jsonold'=>self::JRD_MIMETYPE_OLD,
69                      'xml'=>self::XRD_MIMETYPE);
70     }
71
72     /**
73      * Register a discovery class
74      *
75      * @param string $class Class name
76      *
77      * @return void
78      */
79     public function registerMethod($class)
80     {
81         $this->methods[] = $class;
82     }
83
84     /**
85      * Given a user ID, return the first available resource descriptor
86      *
87      * @param string $id User ID URI
88      *
89      * @return XML_XRD object for the resource descriptor of the id
90      */
91     public function lookup($id)
92     {
93         // Normalize the incoming $id to make sure we have a uri
94         $uri = self::normalize($id);
95
96         foreach ($this->methods as $class) {
97             try {
98                 $xrd = new XML_XRD();
99
100                 common_debug("LRDD discovery method for '$uri': {$class}");
101                 $lrdd = new $class;
102                 $links = call_user_func(array($lrdd, 'discover'), $uri);
103                 $link = Discovery::getService($links, Discovery::LRDD_REL);
104
105                 // Load the LRDD XRD
106                 if (!empty($link->template)) {
107                     $xrd_uri = Discovery::applyTemplate($link->template, $uri);
108                 } elseif (!empty($link->href)) {
109                     $xrd_uri = $link->href;
110                 } else {
111                     throw new Exception('No resource descriptor URI in link.');
112                 }
113
114                 $client  = new HTTPClient();
115                 $headers = array();
116                 if (!is_null($link->type)) {
117                     $headers[] = "Accept: {$link->type}";
118                 }
119
120                 $response = $client->get($xrd_uri, $headers); 
121                 if ($response->getStatus() != 200) {
122                     throw new Exception('Unexpected HTTP status code.');
123                 }
124
125                 $xrd->loadString($response->getBody());
126                 return $xrd;
127             } catch (Exception $e) {
128                 continue;
129             }
130         }
131
132         // TRANS: Exception. %s is an ID.
133         throw new Exception(sprintf(_('Unable to find services for %s.'), $id));
134     }
135
136     /**
137      * Given an array of links, returns the matching service
138      *
139      * @param array  $links   Links to check (as instances of XML_XRD_Element_Link)
140      * @param string $service Service to find
141      *
142      * @return array $link assoc array representing the link
143      */
144     public static function getService(array $links, $service)
145     {
146         foreach ($links as $link) {
147             if ($link->rel === $service) {
148                 return $link;
149             }
150             common_debug('LINK: rel '.$link->rel.' !== '.$service);
151         }
152
153         throw new Exception('No service link found');
154     }
155
156     /**
157      * Given a "user id" make sure it's normalized to an acct: uri
158      *
159      * @param string $user_id User ID to normalize
160      *
161      * @return string normalized acct: URI
162      */
163     public static function normalize($uri)
164     {
165         if (is_null($uri) || $uri==='') {
166             throw new Exception(_('No resource given.'));
167         }
168
169         $parts = parse_url($uri);
170         // If we don't have a scheme, but the path implies user@host,
171         // though this is far from a perfect matching procedure...
172         if (!isset($parts['scheme']) && isset($parts['path'])
173                 && preg_match('/[\w@\w]/u', $parts['path'])) {
174             return 'acct:' . $uri;
175         }
176
177         return $uri;
178     }
179
180     public static function isAcct($uri)
181     {
182         return (mb_strtolower(mb_substr($uri, 0, 5)) == 'acct:');
183     }
184
185     /**
186      * Apply a template using an ID
187      *
188      * Replaces {uri} in template string with the ID given.
189      *
190      * @param string $template Template to match
191      * @param string $uri      URI to replace with
192      *
193      * @return string replaced values
194      */
195     public static function applyTemplate($template, $uri)
196     {
197         $template = str_replace('{uri}', urlencode($uri), $template);
198
199         return $template;
200     }
201 }
202
203