plugins/LinkbackPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Plugin to do linkbacks for notices containing links
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  Plugin
  23  * @package   StatusNet
  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/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once('Auth/Yadis/Yadis.php');
  35
  36 define('LINKBACKPLUGIN_VERSION', '0.1');
  37
  38 /**
  39  * Plugin to do linkbacks for notices containing URLs
  40  *
  41  * After new notices are saved, we check their text for URLs. If there
  42  * are URLs, we test each URL to see if it supports any
  43  *
  44  * @category Plugin
  45  * @package  StatusNet
  46  * @author   Evan Prodromou <evan@status.net>
  47  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  48  * @link     http://status.net/
  49  *
  50  * @see      Event
  51  */
  52
  53 class LinkbackPlugin extends Plugin
  54 {
  55     var $notice = null;
  56
  57     function __construct()
  58     {
  59         parent::__construct();
  60     }
  61
  62     function onHandleQueuedNotice($notice)
  63     {
  64         if ($notice->is_local == 1) {
  65             // Try to avoid actually mucking with the
  66             // notice content
  67             $c = $notice->content;
  68             $this->notice = $notice;
  69             // Ignoring results
  70             common_replace_urls_callback($c,
  71                                          array($this, 'linkbackUrl'));
  72         }
  73         return true;
  74     }
  75
  76     function linkbackUrl($url)
  77     {
  78         common_log(LOG_DEBUG,"Attempting linkback for " . $url);
  79
  80         $orig = $url;
  81         $url = htmlspecialchars_decode($orig);
  82         $scheme = parse_url($url, PHP_URL_SCHEME);
  83         if (!in_array($scheme, array('http', 'https'))) {
  84             return $orig;
  85         }
  86
  87         // XXX: Do a HEAD first to save some time/bandwidth
  88
  89         $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
  90
  91         $result = $fetcher->get($url,
  92                                 array('User-Agent: ' . $this->userAgent(),
  93                                       'Accept: application/html+xml,text/html'));
  94
  95         if (!in_array($result->status, array('200', '206'))) {
  96             return $orig;
  97         }
  98
  99         $pb = null;
 100         $tb = null;
 101
 102         if (array_key_exists('X-Pingback', $result->headers)) {
 103             $pb = $result->headers['X-Pingback'];
 104         } else if (preg_match('/<link rel="pingback" href="([^"]+)" ?\/?>/',
 105                               $result->body,
 106                               $match)) {
 107             $pb = $match[1];
 108         }
 109
 110         if (!empty($pb)) {
 111             $this->pingback($result->final_url, $pb);
 112         } else {
 113             $tb = $this->getTrackback($result->body, $result->final_url);
 114             if (!empty($tb)) {
 115                 $this->trackback($result->final_url, $tb);
 116             }
 117         }
 118
 119         return $orig;
 120     }
 121
 122     function pingback($url, $endpoint)
 123     {
 124         $args = array($this->notice->uri, $url);
 125
 126         if (!extension_loaded('xmlrpc')) {
 127             if (!dl('xmlrpc.so')) {
 128                 common_log(LOG_ERR, "Can't pingback; xmlrpc extension not available.");
 129                 return;
 130             }
 131         }
 132
 133         $request = HTTPClient::start();
 134         try {
 135             $response = $request->post($endpoint,
 136                 array('Content-Type: text/xml'),
 137                 xmlrpc_encode_request('pingback.ping', $args));
 138             $response = xmlrpc_decode($response->getBody());
 139             if (xmlrpc_is_fault($response)) {
 140                 common_log(LOG_WARNING,
 141                        "Pingback error for '$url' ($endpoint): ".
 142                        "$response[faultString] ($response[faultCode])");
 143             } else {
 144                 common_log(LOG_INFO,
 145                        "Pingback success for '$url' ($endpoint): ".
 146                        "'$response'");
 147             }
 148         } catch (HTTP_Request2_Exception $e) {
 149             common_log(LOG_WARNING,
 150                    "Pingback request failed for '$url' ($endpoint)");
 151         }
 152     }
 153
 154     // Largely cadged from trackback_cls.php by
 155     // Ran Aroussi <ran@blogish.org>, GPL2 or any later version
 156     // http://phptrackback.sourceforge.net/
 157
 158     function getTrackback($text, $url)
 159     {
 160         if (preg_match_all('/(<rdf:RDF.*?<\/rdf:RDF>)/sm', $text, $match, PREG_SET_ORDER)) {
 161             for ($i = 0; $i < count($match); $i++) {
 162                 if (preg_match('|dc:identifier="' . preg_quote($url) . '"|ms', $match[$i][1])) {
 163                     $rdf_array[] = trim($match[$i][1]);
 164                 }
 165             }
 166
 167             // Loop through the RDFs array and extract trackback URIs
 168
 169             $tb_array = array(); // <- holds list of trackback URIs
 170
 171             if (!empty($rdf_array)) {
 172
 173                 for ($i = 0; $i < count($rdf_array); $i++) {
 174                     if (preg_match('/trackback:ping="([^"]+)"/', $rdf_array[$i], $array)) {
 175                         $tb_array[] = trim($array[1]);
 176                         break;
 177                     }
 178                 }
 179             }
 180
 181             // Return Trackbacks
 182
 183             if (empty($tb_array)) {
 184                 return null;
 185             } else {
 186                 return $tb_array[0];
 187             }
 188         }
 189
 190         if (preg_match_all('/(<a[^>]*?rel=[\'"]trackback[\'"][^>]*?>)/', $text, $match)) {
 191             foreach ($match[1] as $atag) {
 192                 if (preg_match('/href=[\'"]([^\'"]*?)[\'"]/', $atag, $url)) {
 193                     return $url[1];
 194                 }
 195             }
 196         }
 197
 198         return null;
 199
 200     }
 201
 202     function trackback($url, $endpoint)
 203     {
 204         $profile = $this->notice->getProfile();
 205
 206         $args = array('title' => sprintf(_('%1$s\'s status on %2$s'),
 207                                          $profile->nickname,
 208                                          common_exact_date($this->notice->created)),
 209                       'excerpt' => $this->notice->content,
 210                       'url' => $this->notice->uri,
 211                       'blog_name' => $profile->nickname);
 212
 213         $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 214
 215         $result = $fetcher->post($endpoint,
 216                                  http_build_query($args),
 217                                  array('User-Agent: ' . $this->userAgent()));
 218
 219         if ($result->status != '200') {
 220             common_log(LOG_WARNING,
 221                        "Trackback error for '$url' ($endpoint): ".
 222                        "$result->body");
 223         } else {
 224             common_log(LOG_INFO,
 225                        "Trackback success for '$url' ($endpoint): ".
 226                        "'$result->body'");
 227         }
 228     }
 229
 230     function userAgent()
 231     {
 232         return 'LinkbackPlugin/'.LINKBACKPLUGIN_VERSION .
 233           ' StatusNet/' . STATUSNET_VERSION;
 234     }
 235
 236     function onPluginVersion(&$versions)
 237     {
 238         $versions[] = array('name' => 'Linkback',
 239                             'version' => LINKBACKPLUGIN_VERSION,
 240                             'author' => 'Evan Prodromou',
 241                             'homepage' => 'http://status.net/wiki/Plugin:Linkback',
 242                             'rawdescription' =>
 243                             _m('Notify blog authors when their posts have been linked in '.
 244                                'microblog notices using '.
 245                                '<a href="http://www.hixie.ch/specs/pingback/pingback">Pingback</a> '.
 246                                'or <a href="http://www.movabletype.org/docs/mttrackback.html">Trackback</a> protocols.'));
 247         return true;
 248     }
 249 }