<?php
/**
- * @file src/Protocol/ActivityPub/Receiver.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program 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.
+ *
+ * This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Protocol\ActivityPub;
+use Friendica\Content\Text\BBCode;
use Friendica\Database\DBA;
use Friendica\Content\Text\HTML;
use Friendica\Content\Text\Markdown;
use Friendica\Core\Protocol;
use Friendica\Model\Contact;
use Friendica\Model\APContact;
-use Friendica\Model\Conversation;
use Friendica\Model\Item;
use Friendica\Model\User;
use Friendica\Protocol\Activity;
use Friendica\Util\Strings;
/**
- * @brief ActivityPub Receiver Protocol class
+ * ActivityPub Receiver Protocol class
*
* To-Do:
- * - Undo Announce
+ * @todo Undo Announce
*
* Check what this is meant to do:
* - Add
{
const PUBLIC_COLLECTION = 'as:Public';
const ACCOUNT_TYPES = ['as:Person', 'as:Organization', 'as:Service', 'as:Group', 'as:Application'];
- const CONTENT_TYPES = ['as:Note', 'as:Article', 'as:Video', 'as:Image', 'as:Event'];
+ const CONTENT_TYPES = ['as:Note', 'as:Article', 'as:Video', 'as:Image', 'as:Event', 'as:Audio'];
const ACTIVITY_TYPES = ['as:Like', 'as:Dislike', 'as:Accept', 'as:Reject', 'as:TentativeAccept'];
/**
$trust_source = false;
}
- self::processActivity($ldactivity, $body, $uid, $trust_source);
+ self::processActivity($ldactivity, $body, $uid, $trust_source, true);
}
/**
/**
* Prepare the object array
*
- * @param array $activity
- * @param integer $uid User ID
- * @param $trust_source
+ * @param array $activity Array with activity data
+ * @param integer $uid User ID
+ * @param boolean $push Message had been pushed to our system
+ * @param boolean $trust_source Do we trust the source?
*
* @return array with object data
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- private static function prepareObjectData($activity, $uid, &$trust_source)
+ public static function prepareObjectData($activity, $uid, $push, &$trust_source)
{
$actor = JsonLD::fetchElement($activity, 'as:actor', '@id');
if (empty($actor)) {
if ($type == 'as:Announce') {
$trust_source = false;
}
+
$object_data = self::fetchObject($object_id, $activity['as:object'], $trust_source, $uid);
if (empty($object_data)) {
Logger::log("Object data couldn't be processed", Logger::DEBUG);
return [];
}
+
$object_data['object_id'] = $object_id;
+ if ($type == 'as:Announce') {
+ $object_data['push'] = false;
+ } else {
+ $object_data['push'] = $push;
+ }
+
// Test if it is an answer to a mail
if (DBA::exists('mail', ['uri' => $object_data['reply-to-id']])) {
$object_data['directmessage'] = true;
$object_data['object_type'] = JsonLD::fetchElement($activity['as:object'], '@type');
// An Undo is done on the object of an object, so we need that type as well
- if ($type == 'as:Undo') {
+ if (($type == 'as:Undo') && !empty($object_data['object_object'])) {
$object_data['object_object_type'] = self::fetchObjectType([], $object_data['object_object'], $uid);
}
}
return 0;
}
- /**
- * Store the unprocessed data into the conversation table
- * This has to be done outside the regular function,
- * since we store everything - not only item posts.
- *
- * @param array $activity Array with activity data
- * @param string $body The raw message
- * @throws \Exception
- */
- private static function storeConversation($activity, $body)
- {
- if (empty($body) || empty($activity['id'])) {
- return;
- }
-
- $conversation = [
- 'protocol' => Conversation::PARCEL_ACTIVITYPUB,
- 'item-uri' => $activity['id'],
- 'reply-to-uri' => $activity['reply-to-id'] ?? '',
- 'conversation-href' => $activity['context'] ?? '',
- 'conversation-uri' => $activity['conversation'] ?? '',
- 'source' => $body,
- 'received' => DateTimeFormat::utcNow()];
-
- DBA::insert('conversation', $conversation, true);
- }
-
/**
* Processes the activity object
*
* @param string $body
* @param integer $uid User ID
* @param boolean $trust_source Do we trust the source?
+ * @param boolean $push Message had been pushed to our system
* @throws \Exception
*/
- public static function processActivity($activity, $body = '', $uid = null, $trust_source = false)
+ public static function processActivity($activity, $body = '', $uid = null, $trust_source = false, $push = false)
{
$type = JsonLD::fetchElement($activity, '@type');
if (!$type) {
if (!JsonLD::fetchElement($activity, 'as:actor', '@id')) {
Logger::log('Empty actor', Logger::DEBUG);
return;
-
}
// Don't trust the source if "actor" differs from "attributedTo". The content could be forged.
}
// $trust_source is called by reference and is set to true if the content was retrieved successfully
- $object_data = self::prepareObjectData($activity, $uid, $trust_source);
+ $object_data = self::prepareObjectData($activity, $uid, $push, $trust_source);
if (empty($object_data)) {
Logger::log('No object data found', Logger::DEBUG);
return;
return;
}
- // Only store content related stuff - and no announces, since they possibly overwrite the original content
- if (in_array($object_data['object_type'], self::CONTENT_TYPES) && ($type != 'as:Announce')) {
- self::storeConversation($object_data, $body);
+ if (!empty($body) && empty($object_data['raw'])) {
+ $object_data['raw'] = $body;
}
// Internal flag for thread completion. See Processor.php
switch ($type) {
case 'as:Create':
if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
- ActivityPub\Processor::createItem($object_data);
+ $item = ActivityPub\Processor::createItem($object_data);
+ ActivityPub\Processor::postItem($object_data, $item);
}
break;
// If this isn't set, then a single reshare appears on top. This is used for groups.
$object_data['thread-completion'] = ($profile['type'] != 'Group');
- ActivityPub\Processor::createItem($object_data);
+ $item = ActivityPub\Processor::createItem($object_data);
+ ActivityPub\Processor::postItem($object_data, $item);
// Add the bottom reshare information only for persons
if ($profile['type'] != 'Group') {
$announce_object_data['author'] = JsonLD::fetchElement($activity, 'as:actor', '@id');
$announce_object_data['object_id'] = $object_data['object_id'];
$announce_object_data['object_type'] = $object_data['object_type'];
+ $announce_object_data['push'] = $push;
+
+ if (!empty($body)) {
+ $announce_object_data['raw'] = $body;
+ }
ActivityPub\Processor::createActivity($announce_object_data, Activity::ANNOUNCE);
}
/**
* Fetch the receiver list from an activity array
*
- * @param array $activity
- * @param string $actor
- * @param array $tags
+ * @param array $activity
+ * @param string $actor
+ * @param array $tags
+ * @param boolean $fetch_unlisted
*
* @return array with receivers (user id)
* @throws \Exception
*/
- private static function getReceivers($activity, $actor, $tags = [])
+ private static function getReceivers($activity, $actor, $tags = [], $fetch_unlisted = false)
{
$receivers = [];
// When it is an answer, we inherite the receivers from the parent
$replyto = JsonLD::fetchElement($activity, 'as:inReplyTo', '@id');
if (!empty($replyto)) {
+ // Fix possibly wrong item URI (could be an answer to a plink uri)
+ $fixedReplyTo = Item::getURIByLink($replyto);
+ $replyto = $fixedReplyTo ?: $replyto;
+
$parents = Item::select(['uid'], ['uri' => $replyto]);
while ($parent = Item::fetch($parents)) {
$receivers['uid:' . $parent['uid']] = $parent['uid'];
$receivers['uid:0'] = 0;
}
+ // Add receiver "-1" for unlisted posts
+ if ($fetch_unlisted && ($receiver == self::PUBLIC_COLLECTION) && ($element == 'as:cc')) {
+ $receivers['uid:-1'] = -1;
+ }
+
if (($receiver == self::PUBLIC_COLLECTION) && !empty($actor)) {
// This will most likely catch all OStatus connections to Mastodon
$condition = ['alias' => [$actor, Strings::normaliseLink($actor)], 'rel' => [Contact::SHARING, Contact::FRIEND]
return;
}
- if (Contact::updateFromProbe($cid, '', true)) {
+ if (Contact::updateFromProbe($cid)) {
Logger::info('Update was successful', ['id' => $cid, 'uid' => $uid, 'url' => $url]);
}
$object_data['service'] = JsonLD::fetchElement($activity, 'as:instrument', 'as:name', '@type', 'as:Service');
$object_data['service'] = JsonLD::fetchElement($object_data, 'service', '@value');
+ if (!empty($object_data['object_id'])) {
+ // Some systems (e.g. GNU Social) don't reply to the "id" field but the "uri" field.
+ $objectId = Item::getURIByLink($object_data['object_id']);
+ if (!empty($objectId) && ($object_data['object_id'] != $objectId)) {
+ Logger::notice('Fix wrong object-id', ['received' => $object_data['object_id'], 'correct' => $objectId]);
+ $object_data['object_id'] = $objectId;
+ }
+ }
+
return $object_data;
}
}
if (in_array($type, self::CONTENT_TYPES)) {
- return self::processObject($object);
+ $object_data = self::processObject($object);
+
+ if (!empty($data)) {
+ $object_data['raw'] = json_encode($data);
+ }
+ return $object_data;
}
if ($type == 'as:Announce') {
*
* @return array with tags in a simplified format
*/
- private static function processTags($tags)
+ private static function processTags(array $tags)
{
$taglist = [];
- if (empty($tags)) {
- return [];
- }
-
foreach ($tags as $tag) {
if (empty($tag)) {
continue;
continue;
}
+ if (empty($element['href'])) {
+ $element['href'] = $element['name'];
+ }
+
$taglist[] = $element;
}
return $taglist;
/**
* Convert emojis from JSON-LD format into a simplified format
*
- * @param $emojis
+ * @param array $emojis
* @return array with emojis in a simplified format
*/
- private static function processEmojis($emojis)
+ private static function processEmojis(array $emojis)
{
$emojilist = [];
- if (empty($emojis)) {
- return [];
- }
-
foreach ($emojis as $emoji) {
if (empty($emoji) || (JsonLD::fetchElement($emoji, '@type') != 'toot:Emoji') || empty($emoji['as:icon'])) {
continue;
$emojilist[] = $element;
}
+
return $emojilist;
}
*
* @param array $attachments Attachments in JSON-LD format
*
- * @return array with attachmants in a simplified format
+ * @return array Attachments in a simplified format
*/
- private static function processAttachments($attachments)
+ private static function processAttachments(array $attachments)
{
$attachlist = [];
- if (empty($attachments)) {
- return [];
- }
+ // Removes empty values
+ $attachments = array_filter($attachments);
foreach ($attachments as $attachment) {
- if (empty($attachment)) {
- continue;
- }
+ switch (JsonLD::fetchElement($attachment, '@type')) {
+ case 'as:Page':
+ $pageUrl = null;
+ $pageImage = null;
+
+ $urls = JsonLD::fetchElementArray($attachment, 'as:url');
+ foreach ($urls as $url) {
+ // Single scalar URL case
+ if (is_string($url)) {
+ $pageUrl = $url;
+ continue;
+ }
+
+ $href = JsonLD::fetchElement($url, 'as:href', '@id');
+ $mediaType = JsonLD::fetchElement($url, 'as:mediaType', '@value');
+ if (Strings::startsWith($mediaType, 'image')) {
+ $pageImage = $href;
+ } else {
+ $pageUrl = $href;
+ }
+ }
+
+ $attachlist[] = [
+ 'type' => 'link',
+ 'title' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
+ 'desc' => JsonLD::fetchElement($attachment, 'as:summary', '@value'),
+ 'url' => $pageUrl,
+ 'image' => $pageImage,
+ ];
+ break;
+ case 'as:Link':
+ $attachlist[] = [
+ 'type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
+ 'mediaType' => JsonLD::fetchElement($attachment, 'as:mediaType', '@value'),
+ 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
+ 'url' => JsonLD::fetchElement($attachment, 'as:href', '@id')
+ ];
+ break;
+ case 'as:Image':
+ $mediaType = JsonLD::fetchElement($attachment, 'as:mediaType', '@value');
+ $imageFullUrl = JsonLD::fetchElement($attachment, 'as:url', '@id');
+ $imagePreviewUrl = null;
+ // Multiple URLs?
+ if (!$imageFullUrl && ($urls = JsonLD::fetchElementArray($attachment, 'as:url'))) {
+ $imageVariants = [];
+ $previewVariants = [];
+ foreach ($urls as $url) {
+ // Scalar URL, no discrimination possible
+ if (is_string($url)) {
+ $imageFullUrl = $url;
+ continue;
+ }
+
+ // Not sure what to do with a different Link media type than the base Image, we skip
+ if ($mediaType != JsonLD::fetchElement($url, 'as:mediaType', '@value')) {
+ continue;
+ }
+
+ $href = JsonLD::fetchElement($url, 'as:href', '@id');
+
+ // Default URL choice if no discriminating width is provided
+ $imageFullUrl = $href ?? $imageFullUrl;
+
+ $width = intval(JsonLD::fetchElement($url, 'as:width', '@value') ?? 1);
+
+ if ($href && $width) {
+ $imageVariants[$width] = $href;
+ // 632 is the ideal width for full screen frio posts, we compute the absolute distance to it
+ $previewVariants[abs(632 - $width)] = $href;
+ }
+ }
+
+ if ($imageVariants) {
+ // Taking the maximum size image
+ ksort($imageVariants);
+ $imageFullUrl = array_pop($imageVariants);
+
+ // Taking the minimum number distance to the target distance
+ ksort($previewVariants);
+ $imagePreviewUrl = array_shift($previewVariants);
+ }
+
+ unset($imageVariants);
+ unset($previewVariants);
+ }
- $attachlist[] = ['type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
- 'mediaType' => JsonLD::fetchElement($attachment, 'as:mediaType', '@value'),
- 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
- 'url' => JsonLD::fetchElement($attachment, 'as:url', '@id')];
+ $attachlist[] = [
+ 'type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
+ 'mediaType' => $mediaType,
+ 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
+ 'url' => $imageFullUrl,
+ 'image' => $imagePreviewUrl !== $imageFullUrl ? $imagePreviewUrl : null,
+ ];
+ break;
+ default:
+ $attachlist[] = [
+ 'type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
+ 'mediaType' => JsonLD::fetchElement($attachment, 'as:mediaType', '@value'),
+ 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
+ 'url' => JsonLD::fetchElement($attachment, 'as:url', '@id')
+ ];
+ }
}
+
return $attachlist;
}
return $object_data;
}
+ /**
+ * Check if the "as:url" element is an array with multiple links
+ * This is the case with audio and video posts.
+ * Then the links are added as attachments
+ *
+ * @param array $object The raw object
+ * @param array $object_data The parsed object data for later processing
+ * @return array the object data
+ */
+ private static function processAttachmentUrls(array $object, array $object_data) {
+ // Check if this is some url with multiple links
+ if (empty($object['as:url'])) {
+ return $object_data;
+ }
+
+ $urls = $object['as:url'];
+ $keys = array_keys($urls);
+ if (!is_numeric(array_pop($keys))) {
+ return $object_data;
+ }
+
+ $attachments = [];
+
+ foreach ($urls as $url) {
+ if (empty($url['@type']) || ($url['@type'] != 'as:Link')) {
+ continue;
+ }
+
+ $href = JsonLD::fetchElement($url, 'as:href', '@id');
+ if (empty($href)) {
+ continue;
+ }
+
+ $mediatype = JsonLD::fetchElement($url, 'as:mediaType');
+ if (empty($mediatype)) {
+ continue;
+ }
+
+ if ($mediatype == 'text/html') {
+ $object_data['alternate-url'] = $href;
+ }
+
+ $filetype = strtolower(substr($mediatype, 0, strpos($mediatype, '/')));
+
+ if ($filetype == 'audio') {
+ $attachments[$filetype] = ['type' => $mediatype, 'url' => $href];
+ } elseif ($filetype == 'video') {
+ $height = (int)JsonLD::fetchElement($url, 'as:height', '@value');
+
+ // We save bandwidth by using a moderate height
+ // Peertube normally uses these heights: 240, 360, 480, 720, 1080
+ if (!empty($attachments[$filetype]['height']) &&
+ (($height > 480) || $height < $attachments[$filetype]['height'])) {
+ continue;
+ }
+
+ $attachments[$filetype] = ['type' => $mediatype, 'url' => $href, 'height' => $height];
+ }
+ }
+
+ foreach ($attachments as $type => $attachment) {
+ $object_data['attachments'][] = ['type' => $type,
+ 'mediaType' => $attachment['type'],
+ 'name' => '',
+ 'url' => $attachment['url']];
+ }
+ return $object_data;
+ }
+
/**
* Fetches data from the object part of an activity
*
// An empty "id" field is translated to "./" by the compactor, so we have to check for this content
if (empty($object_data['reply-to-id']) || ($object_data['reply-to-id'] == './')) {
$object_data['reply-to-id'] = $object_data['id'];
+ } else {
+ // Some systems (e.g. GNU Social) don't reply to the "id" field but the "uri" field.
+ $replyToId = Item::getURIByLink($object_data['reply-to-id']);
+ if (!empty($replyToId) && ($object_data['reply-to-id'] != $replyToId)) {
+ Logger::notice('Fix wrong reply-to', ['received' => $object_data['reply-to-id'], 'correct' => $replyToId]);
+ $object_data['reply-to-id'] = $replyToId;
+ }
}
$object_data['published'] = JsonLD::fetchElement($object, 'as:published', '@value');
$actor = JsonLD::fetchElement($object, 'as:actor', '@id');
}
+ $location = JsonLD::fetchElement($object, 'as:location', 'as:name', '@type', 'as:Place');
+ $location = JsonLD::fetchElement($location, 'location', '@value');
+ if ($location) {
+ // Some AP software allow formatted text in post location, so we run all the text converters we have to boil
+ // down to HTML and then finally format to plaintext.
+ $location = Markdown::convert($location);
+ $location = BBCode::convert($location);
+ $location = HTML::toPlaintext($location);
+ }
+
+ $object_data['sc:identifier'] = JsonLD::fetchElement($object, 'sc:identifier', '@value');
$object_data['diaspora:guid'] = JsonLD::fetchElement($object, 'diaspora:guid', '@value');
$object_data['diaspora:comment'] = JsonLD::fetchElement($object, 'diaspora:comment', '@value');
$object_data['diaspora:like'] = JsonLD::fetchElement($object, 'diaspora:like', '@value');
$object_data = self::getSource($object, $object_data);
$object_data['start-time'] = JsonLD::fetchElement($object, 'as:startTime', '@value');
$object_data['end-time'] = JsonLD::fetchElement($object, 'as:endTime', '@value');
- $object_data['location'] = JsonLD::fetchElement($object, 'as:location', 'as:name', '@type', 'as:Place');
- $object_data['location'] = JsonLD::fetchElement($object_data, 'location', '@value');
+ $object_data['location'] = $location;
$object_data['latitude'] = JsonLD::fetchElement($object, 'as:location', 'as:latitude', '@type', 'as:Place');
$object_data['latitude'] = JsonLD::fetchElement($object_data, 'latitude', '@value');
$object_data['longitude'] = JsonLD::fetchElement($object, 'as:location', 'as:longitude', '@type', 'as:Place');
$object_data['longitude'] = JsonLD::fetchElement($object_data, 'longitude', '@value');
- $object_data['attachments'] = self::processAttachments(JsonLD::fetchElementArray($object, 'as:attachment'));
- $object_data['tags'] = self::processTags(JsonLD::fetchElementArray($object, 'as:tag'));
- $object_data['emojis'] = self::processEmojis(JsonLD::fetchElementArray($object, 'as:tag', 'toot:Emoji'));
+ $object_data['attachments'] = self::processAttachments(JsonLD::fetchElementArray($object, 'as:attachment') ?? []);
+ $object_data['tags'] = self::processTags(JsonLD::fetchElementArray($object, 'as:tag') ?? []);
+ $object_data['emojis'] = self::processEmojis(JsonLD::fetchElementArray($object, 'as:tag', 'toot:Emoji') ?? []);
$object_data['generator'] = JsonLD::fetchElement($object, 'as:generator', 'as:name', '@type', 'as:Application');
$object_data['generator'] = JsonLD::fetchElement($object_data, 'generator', '@value');
$object_data['alternate-url'] = JsonLD::fetchElement($object, 'as:url', '@id');
}
}
- $object_data['receiver'] = self::getReceivers($object, $object_data['actor'], $object_data['tags']);
+ if (in_array($object_data['object_type'], ['as:Audio', 'as:Video'])) {
+ $object_data = self::processAttachmentUrls($object, $object_data);
+ }
+
+ $object_data['receiver'] = self::getReceivers($object, $object_data['actor'], $object_data['tags'], true);
+ $object_data['unlisted'] = in_array(-1, $object_data['receiver']);
+ unset($object_data['receiver']['uid:-1']);
// Common object data: