3 * StatusNet, the distributed open-source microblogging tool
5 * Plugin to do linkbacks for notices containing links
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @copyright 2009 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 require_once('Auth/Yadis/Yadis.php');
35 require_once(__DIR__ . '/lib/util.php');
37 define('LINKBACKPLUGIN_VERSION', '0.1');
40 * Plugin to do linkbacks for notices containing URLs
42 * After new notices are saved, we check their text for URLs. If there
43 * are URLs, we test each URL to see if it supports any
47 * @author Evan Prodromou <evan@status.net>
48 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
49 * @link http://status.net/
53 class LinkbackPlugin extends Plugin
57 function __construct()
59 parent::__construct();
62 function onHandleQueuedNotice($notice)
64 if (intval($notice->is_local) === Notice::LOCAL_PUBLIC) {
65 // Try to avoid actually mucking with the
67 $c = $notice->content;
68 $this->notice = $notice;
70 if(!$notice->getProfile()->
71 getPref("linkbackplugin", "disable_linkbacks")
74 common_replace_urls_callback($c,
75 array($this, 'linkbackUrl'));
78 if($notice->isRepeat()) {
79 $repeat = Notice::getByID($notice->repeat_of);
80 $this->linkbackUrl($repeat->getUrl());
81 } else if(!empty($notice->reply_to)) {
83 $parent = $notice->getParent();
84 $this->linkbackUrl($parent->getUrl());
85 } catch (NoParentNoticeException $e) {
86 // can't link back to what we don't know (apparently parent notice disappeared from our db)
91 // doubling up getReplies and getAttentionProfileIDs because we're not entirely migrated yet
92 $replyProfiles = Profile::multiGet('id', array_unique(array_merge($notice->getReplies(), $notice->getAttentionProfileIDs())));
93 foreach($replyProfiles->fetchAll('profileurl') as $profileurl) {
94 $this->linkbackUrl($profileurl);
100 function linkbackUrl($url)
102 common_log(LOG_DEBUG,"Attempting linkback for " . $url);
105 $url = htmlspecialchars_decode($orig);
106 $scheme = parse_url($url, PHP_URL_SCHEME);
107 if (!in_array($scheme, array('http', 'https'))) {
111 // XXX: Do a HEAD first to save some time/bandwidth
113 $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
115 $result = $fetcher->get($url,
116 array('User-Agent: ' . $this->userAgent(),
117 'Accept: application/html+xml,text/html'));
119 if (!in_array($result->status, array('200', '206'))) {
123 // XXX: Should handle relative-URI resolution in these detections
125 $wm = $this->getWebmention($result);
127 // It is the webmention receiver's job to resolve source
128 // Ref: https://github.com/converspace/webmention/issues/43
129 $this->webmention($url, $wm);
131 $pb = $this->getPingback($result);
133 // Pingback still looks for exact URL in our source, so we
134 // must send what we have
135 $this->pingback($url, $pb);
137 $tb = $this->getTrackback($result);
139 $this->trackback($result->final_url, $tb);
147 // Based on https://github.com/indieweb/mention-client-php
148 // which is licensed Apache 2.0
149 function getWebmention($result) {
150 if (isset($result->headers['Link'])) {
151 // XXX: the fetcher only gives back one of each header, so this may fail on multiple Link headers
152 if(preg_match('~<((?:https?://)?[^>]+)>; rel="webmention"~', $result->headers['Link'], $match)) {
154 } elseif(preg_match('~<((?:https?://)?[^>]+)>; rel="http://webmention.org/?"~', $result->headers['Link'], $match)) {
159 // FIXME: Do proper DOM traversal
160 if(preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="[^" ]* ?webmention ?[^" ]*"[ ]*\/?>/i', $result->body, $match)
161 || preg_match('/<(?:link|a)[ ]+rel="[^" ]* ?webmention ?[^" ]*"[ ]+href="([^"]+)"[ ]*\/?>/i', $result->body, $match)) {
163 } elseif(preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="http:\/\/webmention\.org\/?"[ ]*\/?>/i', $result->body, $match)
164 || preg_match('/<(?:link|a)[ ]+rel="http:\/\/webmention\.org\/?"[ ]+href="([^"]+)"[ ]*\/?>/i', $result->body, $match)) {
169 function webmention($url, $endpoint) {
170 $source = $this->notice->getUrl();
177 $request = HTTPClient::start();
179 $response = $request->post($endpoint,
181 'Content-type: application/x-www-form-urlencoded',
182 'Accept: application/json'
187 if(!in_array($response->getStatus(), array(200,202))) {
188 common_log(LOG_WARNING,
189 "Webmention request failed for '$url' ($endpoint)");
191 } catch (Exception $e) {
192 common_log(LOG_WARNING, "Webmention request failed for '{$url}' ({$endpoint}): {$e->getMessage()}");
196 function getPingback($result) {
197 if (array_key_exists('X-Pingback', $result->headers)) {
198 return $result->headers['X-Pingback'];
199 } else if(preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]*\/?>/i', $result->body, $match)
200 || preg_match('/<(?:link|a)[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]+href="([^"]+)"[ ]*\/?>/i', $result->body, $match)) {
205 function pingback($url, $endpoint)
207 $args = array($this->notice->getUrl(), $url);
209 if (!extension_loaded('xmlrpc')) {
210 if (!dl('xmlrpc.so')) {
211 common_log(LOG_ERR, "Can't pingback; xmlrpc extension not available.");
216 $request = HTTPClient::start();
218 $request->setBody(xmlrpc_encode_request('pingback.ping', $args));
219 $response = $request->post($endpoint,
220 array('Content-Type: text/xml'),
222 $response = xmlrpc_decode($response->getBody());
223 if (xmlrpc_is_fault($response)) {
224 common_log(LOG_WARNING,
225 "Pingback error for '$url' ($endpoint): ".
226 "$response[faultString] ($response[faultCode])");
229 "Pingback success for '$url' ($endpoint): ".
232 } catch (Exception $e) {
233 common_log(LOG_WARNING, "Pingback request failed for '{$url}' ({$endpoint}): {$e->getMessage()}");
237 // Largely cadged from trackback_cls.php by
238 // Ran Aroussi <ran@blogish.org>, GPL2 or any later version
239 // http://phptrackback.sourceforge.net/
240 function getTrackback($result)
242 $text = $result->body;
243 $url = $result->final_url;
245 if (preg_match_all('/(<rdf:RDF.*?<\/rdf:RDF>)/sm', $text, $match, PREG_SET_ORDER)) {
246 for ($i = 0; $i < count($match); $i++) {
247 if (preg_match('|dc:identifier="' . preg_quote($url) . '"|ms', $match[$i][1])) {
248 $rdf_array[] = trim($match[$i][1]);
252 // Loop through the RDFs array and extract trackback URIs
254 $tb_array = array(); // <- holds list of trackback URIs
256 if (!empty($rdf_array)) {
258 for ($i = 0; $i < count($rdf_array); $i++) {
259 if (preg_match('/trackback:ping="([^"]+)"/', $rdf_array[$i], $array)) {
260 $tb_array[] = trim($array[1]);
268 if (empty($tb_array)) {
275 if (preg_match_all('/(<a[^>]*?rel=[\'"]trackback[\'"][^>]*?>)/', $text, $match)) {
276 foreach ($match[1] as $atag) {
277 if (preg_match('/href=[\'"]([^\'"]*?)[\'"]/', $atag, $url)) {
287 function trackback($url, $endpoint)
289 $profile = $this->notice->getProfile();
291 // TRANS: Trackback title.
292 // TRANS: %1$s is a profile nickname, %2$s is a timestamp.
293 $args = array('title' => sprintf(_m('%1$s\'s status on %2$s'),
295 common_exact_date($this->notice->created)),
296 'excerpt' => $this->notice->content,
297 'url' => $this->notice->getUrl(),
298 'blog_name' => $profile->nickname);
300 $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
302 $result = $fetcher->post($endpoint,
303 http_build_query($args),
304 array('User-Agent: ' . $this->userAgent()));
306 if ($result->status != '200') {
307 common_log(LOG_WARNING,
308 "Trackback error for '$url' ($endpoint): ".
312 "Trackback success for '$url' ($endpoint): ".
318 public function onRouterInitialized(URLMapper $m)
320 $m->connect('main/linkback/webmention', array('action' => 'webmention'));
321 $m->connect('main/linkback/pingback', array('action' => 'pingback'));
324 public function onStartShowHTML($action)
326 header('Link: <' . common_local_url('webmention') . '>; rel="webmention"', false);
327 header('X-Pingback: ' . common_local_url('pingback'));
330 public function version()
332 return LINKBACKPLUGIN_VERSION;
335 function onPluginVersion(array &$versions)
337 $versions[] = array('name' => 'Linkback',
338 'version' => LINKBACKPLUGIN_VERSION,
339 'author' => 'Evan Prodromou',
340 'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/Linkback',
342 // TRANS: Plugin description.
343 _m('Notify blog authors when their posts have been linked in '.
344 'microblog notices using '.
345 '<a href="http://www.hixie.ch/specs/pingback/pingback">Pingback</a> '.
346 'or <a href="http://www.movabletype.org/docs/mttrackback.html">Trackback</a> protocols.'));
350 public function onStartInitializeRouter(URLMapper $m)
352 $m->connect('settings/linkback', array('action' => 'linkbacksettings'));
356 function onEndAccountSettingsNav($action)
358 $action_name = $action->trimmed('action');
360 $action->menuItem(common_local_url('linkbacksettings'),
361 // TRANS: OpenID plugin menu item on user settings page.
362 _m('MENU', 'Send Linkbacks'),
363 // TRANS: OpenID plugin tooltip for user settings menu item.
364 _m('Opt-out of sending linkbacks.'),
365 $action_name === 'linkbacksettings');
369 function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
371 // If we don't handle this, keep the event handler going
372 if (!in_array($notice->source, array('linkback'))) {
377 $url = $notice->getUrl();
378 // If getUrl() throws exception, $url is never set
380 $bits = parse_url($url);
381 $domain = $bits['host'];
382 if (substr($domain, 0, 4) == 'www.') {
383 $name = substr($domain, 4);
388 // TRANS: Title. %s is a domain name.
389 $title = sprintf(_m('Sent from %s via Linkback'), $domain);
391 // Abort event handler, we have a name and URL!
393 } catch (InvalidUrlException $e) {
394 // This just means we don't have the notice source data