3 * @file src/Protocol/ActivityPub/Processor.php
5 namespace Friendica\Protocol\ActivityPub;
7 use Friendica\Database\DBA;
8 use Friendica\Core\Logger;
9 use Friendica\Core\Protocol;
10 use Friendica\Model\Conversation;
11 use Friendica\Model\Contact;
12 use Friendica\Model\APContact;
13 use Friendica\Model\Item;
14 use Friendica\Model\Event;
15 use Friendica\Model\User;
16 use Friendica\Content\Text\HTML;
17 use Friendica\Util\JsonLD;
18 use Friendica\Core\Config;
19 use Friendica\Protocol\ActivityPub;
20 use Friendica\Util\DateTimeFormat;
23 * ActivityPub Processor Protocol class
28 * Converts mentions from Pleroma into the Friendica format
32 * @return converted body
34 private static function convertMentions($body)
36 $URLSearchString = "^\[\]";
37 $body = preg_replace("/\[url\=([$URLSearchString]*)\]([#@!])(.*?)\[\/url\]/ism", '$2[url=$1]$3[/url]', $body);
43 * Constructs a string with tags for a given tag array
46 * @param boolean $sensitive
48 * @return string with tags
50 private static function constructTagList($tags, $sensitive)
57 foreach ($tags as $tag) {
58 if (in_array(defaults($tag, 'type', ''), ['Mention', 'Hashtag'])) {
59 if (!empty($tag_text)) {
63 $tag_text .= substr($tag['name'], 0, 1) . '[url=' . $tag['href'] . ']' . substr($tag['name'], 1) . '[/url]';
67 /// @todo add nsfw for $sensitive
73 * Add attachment data to the item array
75 * @param array $attachments
80 private static function constructAttachList($attachments, $item)
82 if (empty($attachments)) {
86 foreach ($attachments as $attach) {
87 $filetype = strtolower(substr($attach['mediaType'], 0, strpos($attach['mediaType'], '/')));
88 if ($filetype == 'image') {
89 $item['body'] .= "\n[img]" . $attach['url'] . '[/img]';
91 if (!empty($item["attach"])) {
92 $item["attach"] .= ',';
96 if (!isset($attach['length'])) {
97 $attach['length'] = "0";
99 $item["attach"] .= '[attach]href="'.$attach['url'].'" length="'.$attach['length'].'" type="'.$attach['mediaType'].'" title="'.defaults($attach, 'name', '').'"[/attach]';
109 * @param array $activity Activity array
111 public static function updateItem($activity)
114 $item['changed'] = DateTimeFormat::utcNow();
115 $item['edited'] = $activity['updated'];
116 $item['title'] = HTML::toBBCode($activity['name']);
117 $item['content-warning'] = HTML::toBBCode($activity['summary']);
118 $item['body'] = self::convertMentions(HTML::toBBCode($activity['content']));
119 $item['tag'] = self::constructTagList($activity['tags'], $activity['sensitive']);
121 Item::update($item, ['uri' => $activity['id']]);
125 * Prepares data for a message
127 * @param array $activity Activity array
129 public static function createItem($activity)
132 $item['verb'] = ACTIVITY_POST;
133 $item['parent-uri'] = $activity['reply-to-id'];
135 if ($activity['reply-to-id'] == $activity['id']) {
136 $item['gravity'] = GRAVITY_PARENT;
137 $item['object-type'] = ACTIVITY_OBJ_NOTE;
139 $item['gravity'] = GRAVITY_COMMENT;
140 $item['object-type'] = ACTIVITY_OBJ_COMMENT;
143 if (($activity['id'] != $activity['reply-to-id']) && !Item::exists(['uri' => $activity['reply-to-id']])) {
144 Logger::log('Parent ' . $activity['reply-to-id'] . ' not found. Try to refetch it.');
145 self::fetchMissingActivity($activity['reply-to-id'], $activity);
148 $item['diaspora_signed_text'] = defaults($activity, 'diaspora:comment', '');
150 self::postItem($activity, $item);
156 * @param array $activity
158 public static function deleteItem($activity)
160 $owner = Contact::getIdForURL($activity['actor']);
162 Logger::log('Deleting item ' . $activity['object_id'] . ' from ' . $owner, Logger::DEBUG);
163 Item::delete(['uri' => $activity['object_id'], 'owner-id' => $owner]);
167 * Prepare the item array for an activity
169 * @param array $activity Activity array
170 * @param string $verb Activity verb
172 public static function createActivity($activity, $verb)
175 $item['verb'] = $verb;
176 $item['parent-uri'] = $activity['object_id'];
177 $item['gravity'] = GRAVITY_ACTIVITY;
178 $item['object-type'] = ACTIVITY_OBJ_NOTE;
180 $item['diaspora_signed_text'] = defaults($activity, 'diaspora:like', '');
182 self::postItem($activity, $item);
188 * @param array $activity Activity array
191 public static function createEvent($activity, $item)
193 $event['summary'] = $activity['name'];
194 $event['desc'] = $activity['content'];
195 $event['start'] = $activity['start-time'];
196 $event['finish'] = $activity['end-time'];
197 $event['nofinish'] = empty($event['finish']);
198 $event['location'] = $activity['location'];
199 $event['adjust'] = true;
200 $event['cid'] = $item['contact-id'];
201 $event['uid'] = $item['uid'];
202 $event['uri'] = $item['uri'];
203 $event['edited'] = $item['edited'];
204 $event['private'] = $item['private'];
205 $event['guid'] = $item['guid'];
206 $event['plink'] = $item['plink'];
208 $condition = ['uri' => $item['uri'], 'uid' => $item['uid']];
209 $ev = DBA::selectFirst('event', ['id'], $condition);
210 if (DBA::isResult($ev)) {
211 $event['id'] = $ev['id'];
214 $event_id = Event::store($event);
215 Logger::log('Event '.$event_id.' was stored', Logger::DEBUG);
219 * Creates an item post
221 * @param array $activity Activity data
222 * @param array $item item array
224 private static function postItem($activity, $item)
226 /// @todo What to do with $activity['context']?
228 if (($item['gravity'] != GRAVITY_PARENT) && !Item::exists(['uri' => $item['parent-uri']])) {
229 Logger::log('Parent ' . $item['parent-uri'] . ' not found, message will be discarded.', Logger::DEBUG);
233 $item['network'] = Protocol::ACTIVITYPUB;
234 $item['private'] = !in_array(0, $activity['receiver']);
235 $item['author-link'] = $activity['author'];
236 $item['author-id'] = Contact::getIdForURL($activity['author'], 0, true);
238 if (empty($activity['thread-completion'])) {
239 $item['owner-link'] = $activity['actor'];
240 $item['owner-id'] = Contact::getIdForURL($activity['actor'], 0, true);
242 Logger::log('Ignoring actor because of thread completion.', Logger::DEBUG);
243 $item['owner-link'] = $item['author-link'];
244 $item['owner-id'] = $item['author-id'];
247 $item['uri'] = $activity['id'];
248 $item['created'] = $activity['published'];
249 $item['edited'] = $activity['updated'];
250 $item['guid'] = $activity['diaspora:guid'];
251 $item['title'] = HTML::toBBCode($activity['name']);
252 $item['content-warning'] = HTML::toBBCode($activity['summary']);
253 $item['body'] = self::convertMentions(HTML::toBBCode($activity['content']));
255 if (($activity['object_type'] == 'as:Video') && !empty($activity['alternate-url'])) {
256 $item['body'] .= "\n[video]" . $activity['alternate-url'] . '[/video]';
259 $item['location'] = $activity['location'];
261 if (!empty($item['latitude']) && !empty($item['longitude'])) {
262 $item['coord'] = $item['latitude'] . ' ' . $item['longitude'];
265 $item['tag'] = self::constructTagList($activity['tags'], $activity['sensitive']);
266 $item['app'] = $activity['generator'];
267 $item['plink'] = defaults($activity, 'alternate-url', $item['uri']);
269 $item = self::constructAttachList($activity['attachments'], $item);
271 if (!empty($activity['source'])) {
272 $item['body'] = $activity['source'];
275 foreach ($activity['receiver'] as $receiver) {
276 $item['uid'] = $receiver;
277 $item['contact-id'] = Contact::getIdForURL($activity['author'], $receiver, true);
279 if (($receiver != 0) && empty($item['contact-id'])) {
280 $item['contact-id'] = Contact::getIdForURL($activity['author'], 0, true);
283 if ($activity['object_type'] == 'as:Event') {
284 self::createEvent($activity, $item);
287 $item_id = Item::insert($item);
288 Logger::log('Storing for user ' . $item['uid'] . ': ' . $item_id);
293 * Fetches missing posts
298 private static function fetchMissingActivity($url, $child)
300 if (Config::get('system', 'ostatus_full_threads')) {
304 $uid = ActivityPub\Receiver::getFirstUserFromReceivers($child['receiver']);
306 $object = ActivityPub::fetchContent($url, $uid);
307 if (empty($object)) {
308 Logger::log('Activity ' . $url . ' was not fetchable, aborting.');
313 $activity['@context'] = $object['@context'];
314 unset($object['@context']);
315 $activity['id'] = $object['id'];
316 $activity['to'] = defaults($object, 'to', []);
317 $activity['cc'] = defaults($object, 'cc', []);
318 $activity['actor'] = $child['author'];
319 $activity['object'] = $object;
320 $activity['published'] = defaults($object, 'published', $child['published']);
321 $activity['type'] = 'Create';
323 $ldactivity = JsonLD::compact($activity);
325 $ldactivity['thread-completion'] = true;
327 ActivityPub\Receiver::processActivity($ldactivity);
328 Logger::log('Activity ' . $url . ' had been fetched and processed.');
332 * perform a "follow" request
334 * @param array $activity
336 public static function followUser($activity)
338 $uid = User::getIdForURL($activity['object_id']);
343 $owner = User::getOwnerDataById($uid);
345 $cid = Contact::getIdForURL($activity['actor'], $uid);
347 self::switchContact($cid);
348 $contact = DBA::selectFirst('contact', [], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
353 $item = ['author-id' => Contact::getIdForURL($activity['actor']),
354 'author-link' => $activity['actor']];
356 // Ensure that the contact has got the right network type
357 self::switchContact($item['author-id']);
359 Contact::addRelationship($owner, $contact, $item);
360 $cid = Contact::getIdForURL($activity['actor'], $uid);
365 DBA::update('contact', ['hub-verify' => $activity['id']], ['id' => $cid]);
366 Logger::log('Follow user ' . $uid . ' from contact ' . $cid . ' with id ' . $activity['id']);
370 * Update the given profile
372 * @param array $activity
374 public static function updatePerson($activity)
376 if (empty($activity['object_id'])) {
380 Logger::log('Updating profile for ' . $activity['object_id'], Logger::DEBUG);
381 APContact::getByURL($activity['object_id'], true);
385 * Delete the given profile
387 * @param array $activity
389 public static function deletePerson($activity)
391 if (empty($activity['object_id']) || empty($activity['actor'])) {
392 Logger::log('Empty object id or actor.', Logger::DEBUG);
396 if ($activity['object_id'] != $activity['actor']) {
397 Logger::log('Object id does not match actor.', Logger::DEBUG);
401 $contacts = DBA::select('contact', ['id'], ['nurl' => normalise_link($activity['object_id'])]);
402 while ($contact = DBA::fetch($contacts)) {
403 Contact::remove($contact['id']);
405 DBA::close($contacts);
407 Logger::log('Deleted contact ' . $activity['object_id'], Logger::DEBUG);
411 * Accept a follow request
413 * @param array $activity
415 public static function acceptFollowUser($activity)
417 $uid = User::getIdForURL($activity['object_actor']);
422 $owner = User::getOwnerDataById($uid);
424 $cid = Contact::getIdForURL($activity['actor'], $uid);
426 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
430 self::switchContact($cid);
432 $fields = ['pending' => false];
434 $contact = DBA::selectFirst('contact', ['rel'], ['id' => $cid]);
435 if ($contact['rel'] == Contact::FOLLOWER) {
436 $fields['rel'] = Contact::FRIEND;
439 $condition = ['id' => $cid];
440 DBA::update('contact', $fields, $condition);
441 Logger::log('Accept contact request from contact ' . $cid . ' for user ' . $uid, Logger::DEBUG);
445 * Reject a follow request
447 * @param array $activity
449 public static function rejectFollowUser($activity)
451 $uid = User::getIdForURL($activity['object_actor']);
456 $owner = User::getOwnerDataById($uid);
458 $cid = Contact::getIdForURL($activity['actor'], $uid);
460 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
464 self::switchContact($cid);
466 if (DBA::exists('contact', ['id' => $cid, 'rel' => Contact::SHARING, 'pending' => true])) {
467 Contact::remove($cid);
468 Logger::log('Rejected contact request from contact ' . $cid . ' for user ' . $uid . ' - contact had been removed.', Logger::DEBUG);
470 Logger::log('Rejected contact request from contact ' . $cid . ' for user ' . $uid . '.', Logger::DEBUG);
475 * Undo activity like "like" or "dislike"
477 * @param array $activity
479 public static function undoActivity($activity)
481 if (empty($activity['object_id'])) {
485 if (empty($activity['object_actor'])) {
489 $author_id = Contact::getIdForURL($activity['object_actor']);
490 if (empty($author_id)) {
494 Item::delete(['uri' => $activity['object_id'], 'author-id' => $author_id, 'gravity' => GRAVITY_ACTIVITY]);
498 * Activity to remove a follower
500 * @param array $activity
502 public static function undoFollowUser($activity)
504 $uid = User::getIdForURL($activity['object_object']);
509 $owner = User::getOwnerDataById($uid);
511 $cid = Contact::getIdForURL($activity['actor'], $uid);
513 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
517 self::switchContact($cid);
519 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
520 if (!DBA::isResult($contact)) {
524 Contact::removeFollower($owner, $contact);
525 Logger::log('Undo following request from contact ' . $cid . ' for user ' . $uid, Logger::DEBUG);
529 * Switches a contact to AP if needed
531 * @param integer $cid Contact ID
533 private static function switchContact($cid)
535 $contact = DBA::selectFirst('contact', ['network'], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
536 if (!DBA::isResult($contact) || ($contact['network'] == Protocol::ACTIVITYPUB)) {
540 Logger::log('Change existing contact ' . $cid . ' from ' . $contact['network'] . ' to ActivityPub.');
541 Contact::updateFromProbe($cid, Protocol::ACTIVITYPUB);