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 ($notice->is_local == 1) {
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)) {
82 $parent = $notice->getParent();
83 $this->linkbackUrl($parent->getUrl());
86 $replyProfiles = Profile::multiGet('id', $notice->getReplies());
87 foreach($replyProfiles->fetchAll('profileurl') as $profileurl) {
88 $this->linkbackUrl($profileurl);
94 function linkbackUrl($url)
96 common_log(LOG_DEBUG,"Attempting linkback for " . $url);
99 $url = htmlspecialchars_decode($orig);
100 $scheme = parse_url($url, PHP_URL_SCHEME);
101 if (!in_array($scheme, array('http', 'https'))) {
105 // XXX: Do a HEAD first to save some time/bandwidth
107 $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
109 $result = $fetcher->get($url,
110 array('User-Agent: ' . $this->userAgent(),
111 'Accept: application/html+xml,text/html'));
113 if (!in_array($result->status, array('200', '206'))) {
117 // XXX: Should handle relative-URI resolution in these detections
119 $wm = $this->getWebmention($result);
121 // It is the webmention receiver's job to resolve source
122 // Ref: https://github.com/converspace/webmention/issues/43
123 $this->webmention($url, $wm);
125 $pb = $this->getPingback($result);
127 // Pingback still looks for exact URL in our source, so we
128 // must send what we have
129 $this->pingback($url, $pb);
131 $tb = $this->getTrackback($result);
133 $this->trackback($result->final_url, $tb);
141 // Based on https://github.com/indieweb/mention-client-php
142 // which is licensed Apache 2.0
143 function getWebmention($result) {
144 // XXX: the fetcher only gives back one of each header, so this may fail on multiple Link headers
145 if(preg_match('~<((?:https?://)?[^>]+)>; rel="webmention"~', $result->headers['Link'], $match)) {
147 } elseif(preg_match('~<((?:https?://)?[^>]+)>; rel="http://webmention.org/?"~', $result->headers['Link'], $match)) {
151 if(preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="[^" ]* ?webmention ?[^" ]*"[ ]*\/?>/i', $result->body, $match)
152 || preg_match('/<(?:link|a)[ ]+rel="[^" ]* ?webmention ?[^" ]*"[ ]+href="([^"]+)"[ ]*\/?>/i', $result->body, $match)) {
154 } elseif(preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="http:\/\/webmention\.org\/?"[ ]*\/?>/i', $result->body, $match)
155 || preg_match('/<(?:link|a)[ ]+rel="http:\/\/webmention\.org\/?"[ ]+href="([^"]+)"[ ]*\/?>/i', $result->body, $match)) {
160 function webmention($url, $endpoint) {
161 $source = $this->notice->getUrl();
168 $request = HTTPClient::start();
170 $response = $request->post($endpoint,
172 'Content-type: application/x-www-form-urlencoded',
173 'Accept: application/json'
178 if(!in_array($response->getStatus(), array(200,202))) {
179 common_log(LOG_WARNING,
180 "Webmention request failed for '$url' ($endpoint)");
182 } catch (HTTP_Request2_Exception $e) {
183 common_log(LOG_WARNING,
184 "Webmention request failed for '$url' ($endpoint)");
188 function getPingback($result) {
189 if (array_key_exists('X-Pingback', $result->headers)) {
190 return $result->headers['X-Pingback'];
191 } else if(preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]*\/?>/i', $result->body, $match)
192 || preg_match('/<(?:link|a)[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]+href="([^"]+)"[ ]*\/?>/i', $result->body, $match)) {
197 function pingback($url, $endpoint)
199 $args = array($this->notice->getUrl(), $url);
201 if (!extension_loaded('xmlrpc')) {
202 if (!dl('xmlrpc.so')) {
203 common_log(LOG_ERR, "Can't pingback; xmlrpc extension not available.");
208 $request = HTTPClient::start();
210 $request->setBody(xmlrpc_encode_request('pingback.ping', $args));
211 $response = $request->post($endpoint,
212 array('Content-Type: text/xml'),
214 $response = xmlrpc_decode($response->getBody());
215 if (xmlrpc_is_fault($response)) {
216 common_log(LOG_WARNING,
217 "Pingback error for '$url' ($endpoint): ".
218 "$response[faultString] ($response[faultCode])");
221 "Pingback success for '$url' ($endpoint): ".
224 } catch (HTTP_Request2_Exception $e) {
225 common_log(LOG_WARNING,
226 "Pingback request failed for '$url' ($endpoint)");
230 // Largely cadged from trackback_cls.php by
231 // Ran Aroussi <ran@blogish.org>, GPL2 or any later version
232 // http://phptrackback.sourceforge.net/
233 function getTrackback($result)
235 $text = $result->body;
236 $url = $result->final_url;
238 if (preg_match_all('/(<rdf:RDF.*?<\/rdf:RDF>)/sm', $text, $match, PREG_SET_ORDER)) {
239 for ($i = 0; $i < count($match); $i++) {
240 if (preg_match('|dc:identifier="' . preg_quote($url) . '"|ms', $match[$i][1])) {
241 $rdf_array[] = trim($match[$i][1]);
245 // Loop through the RDFs array and extract trackback URIs
247 $tb_array = array(); // <- holds list of trackback URIs
249 if (!empty($rdf_array)) {
251 for ($i = 0; $i < count($rdf_array); $i++) {
252 if (preg_match('/trackback:ping="([^"]+)"/', $rdf_array[$i], $array)) {
253 $tb_array[] = trim($array[1]);
261 if (empty($tb_array)) {
268 if (preg_match_all('/(<a[^>]*?rel=[\'"]trackback[\'"][^>]*?>)/', $text, $match)) {
269 foreach ($match[1] as $atag) {
270 if (preg_match('/href=[\'"]([^\'"]*?)[\'"]/', $atag, $url)) {
280 function trackback($url, $endpoint)
282 $profile = $this->notice->getProfile();
284 // TRANS: Trackback title.
285 // TRANS: %1$s is a profile nickname, %2$s is a timestamp.
286 $args = array('title' => sprintf(_m('%1$s\'s status on %2$s'),
288 common_exact_date($this->notice->created)),
289 'excerpt' => $this->notice->content,
290 'url' => $this->notice->getUrl(),
291 'blog_name' => $profile->nickname);
293 $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
295 $result = $fetcher->post($endpoint,
296 http_build_query($args),
297 array('User-Agent: ' . $this->userAgent()));
299 if ($result->status != '200') {
300 common_log(LOG_WARNING,
301 "Trackback error for '$url' ($endpoint): ".
305 "Trackback success for '$url' ($endpoint): ".
311 public function onRouterInitialized(URLMapper $m)
313 $m->connect('main/linkback/webmention', array('action' => 'webmention'));
314 $m->connect('main/linkback/pingback', array('action' => 'pingback'));
317 public function onStartShowHTML($action)
319 header('Link: <' . common_local_url('webmention') . '>; rel="webmention"', false);
320 header('X-Pingback: ' . common_local_url('pingback'));
323 public function version()
325 return LINKBACKPLUGIN_VERSION;
328 function onPluginVersion(array &$versions)
330 $versions[] = array('name' => 'Linkback',
331 'version' => LINKBACKPLUGIN_VERSION,
332 'author' => 'Evan Prodromou',
333 'homepage' => 'http://status.net/wiki/Plugin:Linkback',
335 // TRANS: Plugin description.
336 _m('Notify blog authors when their posts have been linked in '.
337 'microblog notices using '.
338 '<a href="http://www.hixie.ch/specs/pingback/pingback">Pingback</a> '.
339 'or <a href="http://www.movabletype.org/docs/mttrackback.html">Trackback</a> protocols.'));
343 public function onStartInitializeRouter(URLMapper $m)
345 $m->connect('settings/linkback', array('action' => 'linkbacksettings'));
349 function onEndAccountSettingsNav($action)
351 $action_name = $action->trimmed('action');
353 $action->menuItem(common_local_url('linkbacksettings'),
354 // TRANS: OpenID plugin menu item on user settings page.
355 _m('MENU', 'Send Linkbacks'),
356 // TRANS: OpenID plugin tooltip for user settings menu item.
357 _m('Opt-out of sending linkbacks.'),
358 $action_name === 'linkbacksettings');