]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - plugins/Linkback/LinkbackPlugin.php
[TRANSLATION] Update POTs and normalize files
[quix0rs-gnu-social.git] / plugins / Linkback / LinkbackPlugin.php
index 84215046fa5deecf891f5805000c5b6f8c7ccd3f..bb0f1370da54560bb99d1f0f1a718b0789e00c79 100644 (file)
@@ -31,9 +31,9 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
-require_once('Auth/Yadis/Yadis.php');
+require_once(__DIR__ . '/lib/util.php');
 
-define('LINKBACKPLUGIN_VERSION', '0.1');
+define('LINKBACKPLUGIN_VERSION', '0.2');
 
 /**
  * Plugin to do linkbacks for notices containing URLs
@@ -58,71 +58,171 @@ class LinkbackPlugin extends Plugin
         parent::__construct();
     }
 
-    function onHandleQueuedNotice($notice)
+    function onHandleQueuedNotice(Notice $notice)
     {
-        if ($notice->is_local == 1) {
-            // Try to avoid actually mucking with the
-            // notice content
-            $c = $notice->content;
-            $this->notice = $notice;
+        if (!$notice->isLocal() || !$notice->isPublic()) {
+            return true;
+        }
+
+        // Try to avoid actually mucking with the
+        // notice content
+        $c = $notice->content;
+        $this->notice = $notice;
+
+        if (!$notice->getProfile()->getPref('linkbackplugin', 'disable_linkbacks')) {
             // Ignoring results
-            common_replace_urls_callback($c,
-                                         array($this, 'linkbackUrl'));
+            common_replace_urls_callback($c, array($this, 'linkbackUrl'));
+        }
 
-            if($notice->isRepeat()) {
+        try {
+            if ($notice->isRepeat()) {
                 $repeat = Notice::getByID($notice->repeat_of);
                 $this->linkbackUrl($repeat->getUrl());
-            } else if(!empty($notice->reply_to)) {
+            } elseif (!empty($notice->reply_to)) {
                 $parent = $notice->getParent();
                 $this->linkbackUrl($parent->getUrl());
             }
+        } catch (InvalidUrlException $e) {
+            // can't send linkback to notice if we don't have a remote HTTP(S) URL
+            // but we can still ping the attention-receivers below
+        } catch (NoParentNoticeException $e) {
+            // can't send linkback to non-existing parent URL
+            return true;
         }
+
+        // doubling up getReplies and getAttentionProfileIDs because we're not entirely migrated yet
+        $replyProfiles = Profile::multiGet('id', array_unique(array_merge($notice->getReplies(), $notice->getAttentionProfileIDs())));
+        foreach ($replyProfiles->fetchAll('profileurl') as $profileurl) {
+            if (common_valid_http_url($profileurl)) {
+                $this->linkbackUrl($profileurl);
+            }
+        }
+
         return true;
     }
 
+    function unparse_url($parsed_url)
+    {
+       $scheme   = isset($parsed_url['scheme']) ? $parsed_url['scheme'] . '://' : '';
+       $host     = isset($parsed_url['host']) ? $parsed_url['host'] : '';
+       $port     = isset($parsed_url['port']) ? ':' . $parsed_url['port'] : '';
+       $user     = isset($parsed_url['user']) ? $parsed_url['user'] : '';
+       $pass     = isset($parsed_url['pass']) ? ':' . $parsed_url['pass']  : '';
+       $pass     = ($user || $pass) ? "$pass@" : '';
+       $path     = isset($parsed_url['path']) ? $parsed_url['path'] : '';
+       $query    = isset($parsed_url['query']) ? '?' . $parsed_url['query'] : '';
+       $fragment = isset($parsed_url['fragment']) ? '#' . $parsed_url['fragment'] : '';
+       return "$scheme$user$pass$host$port$path$query$fragment";
+    }
+
     function linkbackUrl($url)
     {
         common_log(LOG_DEBUG,"Attempting linkback for " . $url);
 
         $orig = $url;
         $url = htmlspecialchars_decode($orig);
-        $scheme = parse_url($url, PHP_URL_SCHEME);
-        if (!in_array($scheme, array('http', 'https'))) {
+        $base = parse_url($url);
+        if (!in_array($base['scheme'], array('http', 'https'))) {
             return $orig;
         }
 
         // XXX: Do a HEAD first to save some time/bandwidth
+        try {
+            $httpclient = new HTTPClient();
+            $response = $httpclient->get($url, ["User-Agent: {$this->userAgent()}",
+                                                "Accept: application/html+xml,text/html"]);
 
-        $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
-
-        $result = $fetcher->get($url,
-                                array('User-Agent: ' . $this->userAgent(),
-                                      'Accept: application/html+xml,text/html'));
-
-        if (!in_array($result->status, array('200', '206'))) {
+            if (!in_array($response->getStatus(), array(200, 206))) {
+                throw new Exception('Invalid response code for GET request');
+            }
+        } catch (Exception $e) {
+            // something didn't work out in our GET request
             return $orig;
         }
 
-        $pb = $this->getPingback($result);
-        if (!empty($pb)) {
-            $this->pingback($result->final_url, $pb);
-        // XXX: Should handle relative-URI resolution in these detections
-
+        $wm = $this->getWebmention($response);
+        if(!is_null($wm)) {
+            $wm = parse_url($wm);
+            if(!$wm) $wm = array();
+            if(!$wm['host']) $wm['host'] = $base['host'];
+            if(!$wm['scheme']) $wm['scheme'] = $base['scheme'];
+            if(!$wm['path']) $wm['path'] = $base['path'];
+
+            // It is the webmention receiver's job to resolve source
+            // Ref: https://github.com/converspace/webmention/issues/43
+            $this->webmention($url, $this->unparse_url($wm));
         } else {
-            $tb = $this->getTrackback($result);
-            if (!empty($tb)) {
-                $this->trackback($result->final_url, $tb);
+            $pb = $this->getPingback($response);
+            if (!empty($pb)) {
+                // Pingback still looks for exact URL in our source, so we
+                // must send what we have
+                $this->pingback($url, $pb);
+            } else {
+                $tb = $this->getTrackback($response);
+                if (!empty($tb)) {
+                    $this->trackback($response->getEffectiveUrl(), $tb);
+                }
             }
         }
 
         return $orig;
     }
 
-    function getPingback($result) {
-        if (array_key_exists('X-Pingback', $result->headers)) {
-            return $result->headers['X-Pingback'];
-        } else if(preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]*\/?>/i', $result->body, $match)
-                  || preg_match('/<(?:link|a)[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]+href="([^"]+)"[ ]*\/?>/i', $result->body, $match)) {
+    // Based on https://github.com/indieweb/mention-client-php
+    // which is licensed Apache 2.0
+    function getWebmention(HTTP_Request2_Response $response) {
+        $link = $response->getHeader('Link');
+        if (!is_null($link)) {
+            // XXX: the fetcher gives back a comma-separated string of all Link headers, I hope the parsing works reliably
+            if (preg_match('~<([^>]+)>; rel="?(?:[^" ]* )*(?:http://webmention.org/|webmention)(?: [^" ]*)*"?~', $link, $match)) {
+                return $match[1];
+            }
+        }
+
+        // FIXME: Do proper DOM traversal
+        // Currently fails https://webmention.rocks/test/13, https://webmention.rocks/test/17
+        if(preg_match('~<(?:link|a)[ ]+href="([^"]*)"[ ]+rel="(?:[^" ]* )*(?:http://webmention.org/|webmention)(?: [^" ]*)*"[ ]*/?>~i', $response->getBody(), $match)
+                || preg_match('~<(?:link|a)[ ]+rel="(?:[^" ]* )*(?:http://webmention.org/|webmention)(?: [^" ]*)*"[ ]+href="([^"]*)"[ ]*/?>~i', $response->getBody(), $match)) {
+            return $match[1];
+        }
+
+        return NULL;
+    }
+
+    function webmention($url, $endpoint) {
+        $source = $this->notice->getUrl();
+
+        common_log(LOG_DEBUG,"Attempting webmention to $endpoint for $url from $source");
+
+        $payload = array(
+            'source' => $source,
+            'target' => $url
+        );
+
+        $request = HTTPClient::start();
+        try {
+            $response = $request->post($endpoint,
+                array(
+                    'Content-type: application/x-www-form-urlencoded',
+                    'Accept: application/json'
+                ),
+                $payload
+            );
+
+            if(!in_array($response->getStatus(), array(200,201,202))) {
+                common_log(LOG_WARNING,
+                           "Webmention request failed for '$url' ($endpoint)");
+            }
+        } catch (Exception $e) {
+            common_log(LOG_WARNING, "Webmention request failed for '{$url}' ({$endpoint}): {$e->getMessage()}");
+        }
+    }
+
+    function getPingback(HTTP_Request2_Response $response) {
+        if ($response->getHeader('X-Pingback')) {
+            return $response->getHeader('X-Pingback');
+        } elseif (preg_match('/<(?:link|a)[ ]+href="([^"]+)"[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]*\/?>/i', $response->getBody(), $match)
+                || preg_match('/<(?:link|a)[ ]+rel="[^" ]* ?pingback ?[^" ]*"[ ]+href="([^"]+)"[ ]*\/?>/i', $response->getBody(), $match)) {
             return $match[1];
         }
     }
@@ -140,9 +240,10 @@ class LinkbackPlugin extends Plugin
 
         $request = HTTPClient::start();
         try {
+            $request->setBody(xmlrpc_encode_request('pingback.ping', $args));
             $response = $request->post($endpoint,
                 array('Content-Type: text/xml'),
-                xmlrpc_encode_request('pingback.ping', $args));
+                false);
             $response = xmlrpc_decode($response->getBody());
             if (xmlrpc_is_fault($response)) {
                 common_log(LOG_WARNING,
@@ -153,19 +254,18 @@ class LinkbackPlugin extends Plugin
                        "Pingback success for '$url' ($endpoint): ".
                        "'$response'");
             }
-        } catch (HTTP_Request2_Exception $e) {
-            common_log(LOG_WARNING,
-                   "Pingback request failed for '$url' ($endpoint)");
+        } catch (Exception $e) {
+            common_log(LOG_WARNING, "Pingback request failed for '{$url}' ({$endpoint}): {$e->getMessage()}");
         }
     }
 
     // Largely cadged from trackback_cls.php by
     // Ran Aroussi <ran@blogish.org>, GPL2 or any later version
     // http://phptrackback.sourceforge.net/
-    function getTrackback($result)
+    function getTrackback(HTTP_Request2_Response $response)
     {
-        $text = $result->body;
-        $url = $result->final_url;
+        $text = $response->getBody();
+        $url = $response->getEffectiveUrl();
 
         if (preg_match_all('/(<rdf:RDF.*?<\/rdf:RDF>)/sm', $text, $match, PREG_SET_ORDER)) {
             for ($i = 0; $i < count($match); $i++) {
@@ -216,27 +316,36 @@ class LinkbackPlugin extends Plugin
         // TRANS: Trackback title.
         // TRANS: %1$s is a profile nickname, %2$s is a timestamp.
         $args = array('title' => sprintf(_m('%1$s\'s status on %2$s'),
-                                         $profile->nickname,
-                                         common_exact_date($this->notice->created)),
-                      'excerpt' => $this->notice->content,
+                                         $profile->getNickname(),
+                                         common_exact_date($this->notice->getCreated())),
+                      'excerpt' => $this->notice->getContent(),
                       'url' => $this->notice->getUrl(),
-                      'blog_name' => $profile->nickname);
+                      'blog_name' => $profile->getNickname());
 
-        $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
+        try {
+            $httpclient = new HTTPClient(null, HTTPClient::METHOD_POST);
+            $response = $httpclient->post($endpoint, ["User-Agent: {$this->userAgent()}"], $args);
+            if ($response->getStatus() === 200) {
+                common_log(LOG_INFO, "Trackback success for '$url' ($endpoint): "._ve($response->getBody()));
+            } else {
+                common_log(LOG_WARNING, "Trackback error for '$url' ($endpoint): "._ve($response->getBody()));
+            }
+        } catch (Exception $e) {
+            common_log(LOG_INFO, "Trackback error for '$url' ($endpoint): "._ve($e->getMessage()));
+        }
+    }
 
-        $result = $fetcher->post($endpoint,
-                                 http_build_query($args),
-                                 array('User-Agent: ' . $this->userAgent()));
 
-        if ($result->status != '200') {
-            common_log(LOG_WARNING,
-                       "Trackback error for '$url' ($endpoint): ".
-                       "$result->body");
-        } else {
-            common_log(LOG_INFO,
-                       "Trackback success for '$url' ($endpoint): ".
-                       "'$result->body'");
-        }
+    public function onRouterInitialized(URLMapper $m)
+    {
+        $m->connect('main/linkback/webmention', array('action' => 'webmention'));
+        $m->connect('main/linkback/pingback', array('action' => 'pingback'));
+    }
+
+    public function onStartShowHTML($action)
+    {
+        header('Link: <' . common_local_url('webmention') . '>; rel="webmention"', false);
+        header('X-Pingback: ' . common_local_url('pingback'));
     }
 
     public function version()
@@ -249,7 +358,7 @@ class LinkbackPlugin extends Plugin
         $versions[] = array('name' => 'Linkback',
                             'version' => LINKBACKPLUGIN_VERSION,
                             'author' => 'Evan Prodromou',
-                            'homepage' => 'http://status.net/wiki/Plugin:Linkback',
+                            'homepage' => 'https://git.gnu.io/gnu/gnu-social/tree/master/plugins/Linkback',
                             'rawdescription' =>
                             // TRANS: Plugin description.
                             _m('Notify blog authors when their posts have been linked in '.
@@ -258,4 +367,53 @@ class LinkbackPlugin extends Plugin
                                'or <a href="http://www.movabletype.org/docs/mttrackback.html">Trackback</a> protocols.'));
         return true;
     }
+
+    public function onStartInitializeRouter(URLMapper $m)
+    {
+        $m->connect('settings/linkback', array('action' => 'linkbacksettings'));
+        return true;
+    }
+
+    function onEndAccountSettingsNav($action)
+    {
+        $action_name = $action->trimmed('action');
+
+        $action->menuItem(common_local_url('linkbacksettings'),
+                          // TRANS: OpenID plugin menu item on user settings page.
+                          _m('MENU', 'Send Linkbacks'),
+                          // TRANS: OpenID plugin tooltip for user settings menu item.
+                          _m('Opt-out of sending linkbacks.'),
+                          $action_name === 'linkbacksettings');
+        return true;
+    }
+
+    function onStartNoticeSourceLink($notice, &$name, &$url, &$title)
+    {
+        // If we don't handle this, keep the event handler going
+        if (!in_array($notice->source, array('linkback'))) {
+            return true;
+        }
+
+        try {
+            $url = $notice->getUrl();
+            // If getUrl() throws exception, $url is never set
+
+            $bits = parse_url($url);
+            $domain = $bits['host'];
+            if (substr($domain, 0, 4) == 'www.') {
+                $name = substr($domain, 4);
+            } else {
+                $name = $domain;
+            }
+
+            // TRANS: Title. %s is a domain name.
+            $title = sprintf(_m('Sent from %s via Linkback'), $domain);
+
+            // Abort event handler, we have a name and URL!
+            return false;
+        } catch (InvalidUrlException $e) {
+            // This just means we don't have the notice source data
+            return true;
+        }
+    }
 }