gnu-social/plugins/Linkback/lib/util.php

<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.

defined('GNUSOCIAL') || die();

function linkback_lenient_target_match($body, $target)
{
    return strpos('' . $body, str_replace(
        ['http://www.', 'http://', 'https://www.', 'https://'],
        '',
        preg_replace('/\/+$/', '', preg_replace('/#.*/', '', $target))
    ));
}

function linkback_get_source($source, $target)
{
    // Check if we are pinging ourselves and ignore
    $localprefix = common_config('site', 'server') . '/' . common_config('site', 'path');
    if (linkback_lenient_target_match($source, $localprefix) === 0) {
        common_debug('Ignoring self ping from ' . $source . ' to ' . $target);
        return null;
    }

    $request = HTTPClient::start();

    try {
        $response = $request->get($source);
    } catch (Exception $ex) {
        return null;
    }

    $body = htmlspecialchars_decode($response->getBody());
    // We're slightly more lenient in our link detection than the spec requires
    if (linkback_lenient_target_match($body, $target) === false) {
        return null;
    }

    return $response;
}

function linkback_get_target($target)
{
    // Resolve target (https://github.com/converspace/webmention/issues/43)
    $request = HTTPClient::start();

    try {
        $response = $request->head($target);
    } catch (Exception $ex) {
        return null;
    }

    try {
        $notice = Notice::fromUri($response->getEffectiveUrl());
    } catch (UnknownUriException $ex) {
        preg_match('/\/notice\/(\d+)(?:#.*)?$/', $response->getEffectiveUrl(), $match);
        $notice = Notice::getKV('id', $match[1]);
    }

    if ($notice instanceof Notice && $notice->isLocal()) {
        return $notice;
    } else {
        $user = User::getKV('uri', $response->getEffectiveUrl());
        if (!$user) {
            preg_match('/\/user\/(\d+)(?:#.*)?$/', $response->getEffectiveUrl(), $match);
            $user = User::getKV('id', $match[1]);
        }
        if (!$user) {
            preg_match('/\/([^\/\?#]+)(?:#.*)?$/', $response->getEffectiveUrl(), $match);
            if (linkback_lenient_target_match(
                common_profile_url($match[1]),
                $response->getEffectiveUrl()
            ) !== false) {
                $user = User::getKV('nickname', $match[1]);
            }
        }
        if ($user instanceof User) {
            return $user;
        }
    }

    return null;
}

function linkback_is_contained_in($entry, $target)
{
    foreach ((array)$entry['properties'] as $key => $values) {
        if (count(array_filter($values, function ($x) use ($target) {
            return linkback_lenient_target_match($x, $target) !== false;
        })) > 0) {
            return $entry['properties'];
        }

        // check included h-* formats and their links
        foreach ($values as $obj) {
            if (
                array_key_exists('type', $obj)
                && array_intersect(['h-cite', 'h-entry'], $obj['type'])
                && array_key_exists('properties', $obj)
                && array_key_exists('url', $obj['properties'])
                && count(array_filter(
                    $obj['properties']['url'],
                    function ($x) use ($target) {
                        return linkback_lenient_target_match($x, $target) !== false;
                    }
                )) > 0
            ) {
                return $entry['properties'];
            }
        }

        // check content for the link
        if ($key == "content" && preg_match_all("/<a[^>]+?".preg_quote($target, "/")."[^>]*>([^>]+?)<\/a>/i", htmlspecialchars_decode($values[0]['html']), $context)) {
            return $entry['properties'];
        // check summary for the link
        } elseif ($key == "summary" && preg_match_all("/<a[^>]+?".preg_quote($target, "/")."[^>]*>([^>]+?)<\/a>/i", htmlspecialchars_decode($values[0]), $context)) {
            return $entry['properties'];
        }
    }

    foreach ((array) $entry['children'] as $mf2) {
        if (linkback_is_contained_in($mf2, $target)) {
            return $entry['properties'];
        }
    }

    return null;
}

// Based on https://github.com/acegiak/Semantic-Linkbacks/blob/master/semantic-linkbacks-microformats-handler.php, GPL-2.0+
function linkback_find_entry($mf2, $target)
{
    if (
        array_key_exists('type', $mf2['items'][0])
        && in_array('h-feed', $mf2['items'][0]['type'])
        && array_key_exists('children', $mf2['items'][0])
    ) {
        $mf2['items'] = $mf2['items'][0]['children'];
    }

    $entries = array_filter($mf2['items'], function ($x) {
        return array_key_exists('type', $x) && in_array('h-entry', $x['type']);
    });

    foreach ($entries as $entry) {
        if (($prop = linkback_is_contained_in($entry, $target))) {
            return $prop;
        }
    }

    // Default to first one
    if (count($entries) > 0) {
        return $entries[0]['properties'];
    }

    return null;
}

function linkback_entry_type($entry, $mf2, $target)
{
    if (!$entry) {
        return 'mention';
    }

    if ($mf2['rels'] && $mf2['rels']['in-reply-to']) {
        foreach ($mf2['rels']['in-reply-to'] as $url) {
            if (linkback_lenient_target_match($url, $target) !== false) {
                return 'reply';
            }
        }
    }

    $classes = array(
        'in-reply-to' => 'reply',
        'repost-of' => 'repost',
        'like-of' => 'like',
        'tag-of' => 'tag'
    );

    foreach ((array) $entry as $key => $values) {
        if (count(array_filter($values, function ($x) use ($target) {
            return linkback_lenient_target_match($x, $target) !== false;
        })) > 0) {
            if ($classes[$key]) {
                return $classes[$key];
            }
        }

        foreach ($values as $obj) {
            if (
                array_key_exists('type', $obj)
                && array_intersect(['h-cite', 'h-entry'], $obj['type'])
                && array_key_exists('properties', $obj)
                && array_key_exists('url', $obj['properties'])
                && count(array_filter(
                    $obj['properties']['url'],
                    function ($x) use ($target) {
                        return linkback_lenient_target_match($x, $target) !== false;
                    }
                )) > 0
            ) {
                if ($classes[$key]) {
                    return $classes[$key];
                }
            }
        }
    }

    return 'mention';
}

function linkback_is_dupe($key, $url)
{
    $dupe = Notice::getKV($key, $url);
    if ($dupe instanceof Notice) {
        return $dupe;
    }

    return false;
}


function linkback_hcard($mf2, $url)
{
    if (empty($mf2['items'])) {
        return null;
    }
  
    $hcards = array();
    foreach ($mf2['items'] as $item) {
        if (!in_array('h-card', $item['type'])) {
            continue;
        }

        // We found a match, return it immediately
        if (
            array_key_exists('url', $item['properties'])
            && in_array($url, $item['properties']['url'])
        ) {
            return $item['properties'];
        }

        // Let's keep all the hcards for later, to return one of them at least
        $hcards[] = $item['properties'];
    }
  
    // No match immediately for the url we expected, but there were h-cards found
    if (count($hcards) > 0) {
        return $hcards[0];
    }
  
    return null;
}

function linkback_notice($source, $notice_or_user, $entry, $author, $mf2)
{
    $content = isset($entry['content']) ? $entry['content'][0]['html'] :
              (isset($entry['summary']) ? $entry['summary'][0] : $entry['name'][0]);

    $rendered = common_purify($content);

    if ($notice_or_user instanceof Notice && $entry['type'] === 'mention') {
        $name = isset($entry['name']) ? $entry['name'][0] : substr(common_strip_html($content), 0, 20).'…';
        $rendered = _m('linked to this from <a href="'.htmlspecialchars($source).'">'.htmlspecialchars($name).'</a>');
    }

    $content = common_strip_html($rendered);
    $shortened = common_shorten_links($content);
    if (Notice::contentTooLong($shortened)) {
        $content = substr(
            $content,
            0,
            (Notice::maxContent() - (mb_strlen($source) + 2))
        );
        $rendered = $content . '<a href="'.htmlspecialchars($source).'">…</a>';
        $content .= ' ' . $source;
    }

    $options = array('is_local' => Notice::REMOTE,
                    'url' => $entry['url'][0],
                    'uri' => $entry['url'][0],
                    'rendered' => $rendered,
                    'replies' => array(),
                    'groups' => array(),
                    'peopletags' => array(),
                    'tags' => array(),
                    'urls' => array());

    if ($notice_or_user instanceof User) {
        $options['replies'][] = $notice_or_user->getUri();
    } else {
        if ($entry['type'] === 'repost') {
            $options['repeat_of'] = $notice_or_user->id;
        } else {
            $options['reply_to'] = $notice_or_user->id;
        }
    }

    if (isset($entry['published']) || isset($entry['updated'])) {
        $options['created'] = isset($entry['published'])
                                ? common_sql_date(strtotime($entry['published'][0]))
                                : common_sql_date(strtotime($entry['updated'][0]));
    }

    if (isset($entry['photo']) && common_valid_http_url($entry['photo'])) {
        $options['urls'][] = $entry['photo'][0];
    } elseif (isset($entry['photo'])) {
        common_debug('Linkback got invalid HTTP URL for photo: '._ve($entry['photo']));
    }

    foreach ((array) $entry['category'] as $tag) {
        $tag = common_canonical_tag($tag);
        if ($tag) {
            $options['tags'][] = $tag;
        }
    }


    if ($mf2['rels'] && $mf2['rels']['enclosure']) {
        foreach ($mf2['rels']['enclosure'] as $url) {
            $options['urls'][] = $url;
        }
    }

    if ($mf2['rels'] && $mf2['rels']['tag']) {
        foreach ($mf2['rels']['tag'] as $url) {
            preg_match('/\/([^\/]+)\/*$/', $url, $match);
            $tag = common_canonical_tag($match[1]);
            if ($tag) {
                $options['tags'][] = $tag;
            }
        }
    }

    if ($entry['type'] !== 'reply' && $entry['type'] !== 'repost') {
        $options['urls'] = [];
    }

    return [$content, $options];
}

function linkback_avatar($profile, $url)
{
    // Ripped from OStatus plugin for now
    $tempfile = new TemporaryFile('gs-avatarlinback');
    $img_data = HTTPClient::quickGet($url);
    // Make sure it's at least an image file. ImageFile can do the rest.
    if (getimagesizefromstring($img_data) === false) {
        return false;
    }
    fwrite($tempfile->getResource(), $img_data);
    fflush($tempfile->getResource());
    // No need to carry this in memory.
    unset($img_data);

    $imagefile = new ImageFile(-1, $tempfile->getRealPath());
    $filename = Avatar::filename(
        $profile->id,
        image_type_to_extension($imagefile->type),
        null,
        common_timestamp()
    );
    $tempfile->commit(Avatar::path($filename));

    $profile->setOriginal($filename);
}

function linkback_profile($entry, $mf2, $response, $target)
{
    if (
        array_key_exists('author', $entry)
        && array_key_exists('properties', $entry['author'][0])
    ) {
        $author = $entry['author'][0]['properties'];
    } else {
        $author = linkback_hcard($mf2, $response->getEffectiveUrl());
    }

    if (!$author) {
        $author = array('name' => $entry['name']);
    }

    if (!isset($author['url']) || empty($author['url'])) {
        $author['url'] = array($response->getEffectiveUrl());
    }

    $user = User::getKV('uri', $author['url'][0]);
    if ($user instanceof User) {
        common_log(LOG_INFO, "Linkback: ignoring linkback from local user: $url");
        return true;
    }

    try {
        $profile = Profile::fromUri($author['url'][0]);
    } catch (UnknownUriException $ex) {
        $profile = Profile::getKV('profileurl', $author['url'][0]);
    }

    // XXX: Is this a good way to create the profile?
    if (!$profile instanceof Profile) {
        $profile = new Profile();
        $profile->profileurl = $author['url'][0];
        $profile->fullname = $author['name'][0];
        $profile->nickname = isset($author['nickname']) ? $author['nickname'][0] : str_replace(' ', '', $author['name'][0]);
        $profile->created = common_sql_now();
        $profile->insert();

        if ($author['photo'] && $author['photo'][0]) {
            linkback_avatar($profile, $author['photo'][0]);
        }
    }

    return array($profile, $author);
}

function linkback_save($source, $target, $response, $notice_or_user)
{
    $dupe = linkback_is_dupe('uri', $response->getEffectiveUrl());
    if (!$dupe) {
        $dupe = linkback_is_dupe('url', $response->getEffectiveUrl());
    }
    if (!$dupe) {
        $dupe = linkback_is_dupe('uri', $source);
    }
    if (!$dupe) {
        $dupe = linkback_is_dupe('url', $source);
    }

    $mf2 = new Mf2\Parser($response->getBody(), $response->getEffectiveUrl());
    $mf2 = $mf2->parse();

    $entry = linkback_find_entry($mf2, $target);
    if (!$entry) {
        preg_match('/<title>([^<]+)', $response->getBody(), $match);
        $entry = array(
            'content' => array('html' => $response->getBody()),
            'name' => $match[1] ? htmlspecialchars_decode($match[1]) : $source
        );
    }

    if (!$entry['url']) {
        $entry['url'] = array($response->getEffectiveUrl());
    }

    if (!$dupe) {
        $dupe = linkback_is_dupe('uri', $entry['url'][0]);
    }
    if (!$dupe) {
        $dupe = linkback_is_dupe('url', $entry['url'][0]);
    }

    $entry['type'] = linkback_entry_type($entry, $mf2, $target);
    list($profile, $author) =  linkback_profile($entry, $mf2, $response, $target);
    list($content, $options) = linkback_notice($source, $notice_or_user, $entry, $author, $mf2);

    if ($dupe) {
        $orig = clone($dupe);

        try {
            // Ignore duplicate save error
            try {
                $dupe->saveKnownReplies($options['replies']);
            } catch (ServerException $ex) {
            }
            try {
                $dupe->saveKnownTags($options['tags']);
            } catch (ServerException $ex) {
            }
            try {
                $dupe->saveKnownUrls($options['urls']);
            } catch (ServerException $ex) {
            }

            if (isset($options['reply_to'])) {
                $dupe->reply_to = $options['reply_to'];
            }
            if (isset($options['repeat_of'])) {
                $dupe->repeat_of = $options['repeat_of'];
            }
            if ($dupe->reply_to != $orig->reply_to || $dupe->repeat_of != $orig->repeat_of) {
                $parent = Notice::getKV('id', $dupe->repeat_of ?: $dupe->reply_to);
                if ($parent instanceof Notice) {
                    // If we changed the reply_to or repeat_of we might live in a new conversation now
                    $dupe->conversation = $parent->conversation;
                }
            }
            if ($dupe->update($orig)) {
                $saved = $dupe;
            }
            if (
                $dupe->conversation !== $orig->conversation
                && Conversation::noticeCount($orig->conversation) < 1
            ) {
                // Delete empty conversation
                $emptyConversation = Conversation::getKV('id', $orig->conversation);
                $emptyConversation->delete();
            }
        } catch (Exception $e) {
            common_log(LOG_ERR, "Linkback update of remote message $source failed: " . $e->getMessage());
            return false;
        }
        common_log(LOG_INFO, "Linkback updated remote message $source as notice id $saved->id");
    } elseif (
        $entry['type'] === 'like'
        || ($entry['type'] === 'reply' && $entry['rsvp'])
    ) {
        $act = new Activity();
        $act->type    = ActivityObject::ACTIVITY;
        $act->time    = $options['created'] ? strtotime($options['created']) : time();
        $act->title   = $entry["name"] ? $entry["name"][0] : _m("Favor");
        $act->actor   = $profile->asActivityObject();
        $act->target  = $notice_or_user->asActivityObject();
        $act->objects = array(clone($act->target));

        // TRANS: Message that is the "content" of a favorite (%1$s is the actor's nickname, %2$ is the favorited
        //        notice's nickname and %3$s is the content of the favorited notice.)
        $act->content = sprintf(
            _('%1$s favorited something by %2$s: %3$s'),
            $profile->getNickname(),
            $notice_or_user->getProfile()->getNickname(),
            $notice_or_user->getRendered()
        );
        if ($entry['rsvp']) {
            $act->content = $options['rendered'];
        }

        $act->verb    = ActivityVerb::FAVORITE;
        if (strtolower($entry['rsvp'][0]) === 'yes') {
            $act->verb = 'http://activitystrea.ms/schema/1.0/rsvp-yes';
        } elseif (strtolower($entry['rsvp'][0]) === 'no') {
            $act->verb = 'http://activitystrea.ms/schema/1.0/rsvp-no';
        } elseif (strtolower($entry['rsvp'][0]) === 'maybe') {
            $act->verb = 'http://activitystrea.ms/schema/1.0/rsvp-maybe';
        }

        $act->id = $source;
        $act->link = $entry['url'][0];

        $options['source'] = 'linkback';
        $options['mentions'] = $options['replies'];
        unset($options['reply_to']);
        unset($options['repeat_of']);

        try {
            $saved = Notice::saveActivity($act, $profile, $options);
        } catch (Exception $e) {
            common_log(LOG_ERR, "Linkback save of remote message $source failed: " . $e->getMessage());
            return false;
        }
        common_log(LOG_INFO, "Linkback saved remote message $source as notice id $saved->id");
    } else {
        // Fallback is to make a notice manually
        try {
            $saved = Notice::saveNew(
                $profile->id,
                $content,
                'linkback',
                $options
            );
        } catch (Exception $e) {
            common_log(LOG_ERR, "Linkback save of remote message $source failed: " . $e->getMessage());
            return false;
        }
        common_log(LOG_INFO, "Linkback saved remote message $source as notice id $saved->id");
    }

    return $saved->getLocalUrl();
}