src/Protocol/ActivityPub/Processor.php

   1 <?php
   2 /**
   3  * @file src/Protocol/ActivityPub/Processor.php
   4  */
   5 namespace Friendica\Protocol\ActivityPub;
   6
   7 use Friendica\Database\DBA;
   8 use Friendica\Core\Protocol;
   9 use Friendica\Model\Conversation;
  10 use Friendica\Model\Contact;
  11 use Friendica\Model\APContact;
  12 use Friendica\Model\Item;
  13 use Friendica\Model\User;
  14 use Friendica\Content\Text\HTML;
  15 use Friendica\Util\JsonLD;
  16 use Friendica\Core\Config;
  17 use Friendica\Protocol\ActivityPub;
  18
  19 /**
  20  * ActivityPub Protocol class
  21  *
  22  * To-Do:
  23  * - Store Diaspora signature
  24  */
  25 class Processor
  26 {
  27         /**
  28          * Converts mentions from Pleroma into the Friendica format
  29          *
  30          * @param string $body
  31          *
  32          * @return converted body
  33          */
  34         private static function convertMentions($body)
  35         {
  36                 $URLSearchString = "^\[\]";
  37                 $body = preg_replace("/\[url\=([$URLSearchString]*)\]([#@!])(.*?)\[\/url\]/ism", '$2[url=$1]$3[/url]', $body);
  38
  39                 return $body;
  40         }
  41
  42         /**
  43          * Constructs a string with tags for a given tag array
  44          *
  45          * @param array $tags
  46          * @param boolean $sensitive
  47          *
  48          * @return string with tags
  49          */
  50         private static function constructTagList($tags, $sensitive)
  51         {
  52                 if (empty($tags)) {
  53                         return '';
  54                 }
  55
  56                 $tag_text = '';
  57                 foreach ($tags as $tag) {
  58                         if (in_array(defaults($tag, 'type', ''), ['Mention', 'Hashtag'])) {
  59                                 if (!empty($tag_text)) {
  60                                         $tag_text .= ',';
  61                                 }
  62
  63                                 $tag_text .= substr($tag['name'], 0, 1) . '[url=' . $tag['href'] . ']' . substr($tag['name'], 1) . '[/url]';
  64                         }
  65                 }
  66
  67                 /// @todo add nsfw for $sensitive
  68
  69                 return $tag_text;
  70         }
  71
  72         /**
  73          * Add attachment data to the item array
  74          *
  75          * @param array $attachments
  76          * @param array $item
  77          *
  78          * @return item array
  79          */
  80         private static function constructAttachList($attachments, $item)
  81         {
  82                 if (empty($attachments)) {
  83                         return $item;
  84                 }
  85
  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]';
  90                         } else {
  91                                 if (!empty($item["attach"])) {
  92                                         $item["attach"] .= ',';
  93                                 } else {
  94                                         $item["attach"] = '';
  95                                 }
  96                                 if (!isset($attach['length'])) {
  97                                         $attach['length'] = "0";
  98                                 }
  99                                 $item["attach"] .= '[attach]href="'.$attach['url'].'" length="'.$attach['length'].'" type="'.$attach['mediaType'].'" title="'.defaults($attach, 'name', '').'"[/attach]';
 100                         }
 101                 }
 102
 103                 return $item;
 104         }
 105
 106         /**
 107          * Prepares data for a message
 108          *
 109          * @param array  $activity Activity array
 110          */
 111         public static function createItem($activity)
 112         {
 113                 $item = [];
 114                 $item['verb'] = ACTIVITY_POST;
 115                 $item['parent-uri'] = $activity['reply-to-id'];
 116
 117                 if ($activity['reply-to-id'] == $activity['id']) {
 118                         $item['gravity'] = GRAVITY_PARENT;
 119                         $item['object-type'] = ACTIVITY_OBJ_NOTE;
 120                 } else {
 121                         $item['gravity'] = GRAVITY_COMMENT;
 122                         $item['object-type'] = ACTIVITY_OBJ_COMMENT;
 123                 }
 124
 125                 if (($activity['id'] != $activity['reply-to-id']) && !Item::exists(['uri' => $activity['reply-to-id']])) {
 126                         logger('Parent ' . $activity['reply-to-id'] . ' not found. Try to refetch it.');
 127                         self::fetchMissingActivity($activity['reply-to-id'], $activity);
 128                 }
 129
 130                 self::postItem($activity, $item);
 131         }
 132
 133         /**
 134          * Prepare the item array for a "like"
 135          *
 136          * @param array  $activity Activity array
 137          */
 138         public static function likeItem($activity)
 139         {
 140                 $item = [];
 141                 $item['verb'] = ACTIVITY_LIKE;
 142                 $item['parent-uri'] = $activity['object_id'];
 143                 $item['gravity'] = GRAVITY_ACTIVITY;
 144                 $item['object-type'] = ACTIVITY_OBJ_NOTE;
 145
 146                 self::postItem($activity, $item);
 147         }
 148
 149         /**
 150          * Delete items
 151          *
 152          * @param array $activity
 153          */
 154         public static function deleteItem($activity)
 155         {
 156                 $owner = Contact::getIdForURL($activity['actor']);
 157
 158                 logger('Deleting item ' . $activity['object_id'] . ' from ' . $owner, LOGGER_DEBUG);
 159                 Item::delete(['uri' => $activity['object_id'], 'owner-id' => $owner]);
 160         }
 161
 162         /**
 163          * Prepare the item array for a "dislike"
 164          *
 165          * @param array  $activity Activity array
 166          */
 167         public static function dislikeItem($activity)
 168         {
 169                 $item = [];
 170                 $item['verb'] = ACTIVITY_DISLIKE;
 171                 $item['parent-uri'] = $activity['object_id'];
 172                 $item['gravity'] = GRAVITY_ACTIVITY;
 173                 $item['object-type'] = ACTIVITY_OBJ_NOTE;
 174
 175                 self::postItem($activity, $item);
 176         }
 177
 178         /**
 179          * Creates an item post
 180          *
 181          * @param array  $activity Activity data
 182          * @param array  $item     item array
 183          */
 184         private static function postItem($activity, $item)
 185         {
 186                 /// @todo What to do with $activity['context']?
 187
 188                 if (($item['gravity'] != GRAVITY_PARENT) && !Item::exists(['uri' => $item['parent-uri']])) {
 189                         logger('Parent ' . $item['parent-uri'] . ' not found, message will be discarded.', LOGGER_DEBUG);
 190                         return;
 191                 }
 192
 193                 $item['network'] = Protocol::ACTIVITYPUB;
 194                 $item['private'] = !in_array(0, $activity['receiver']);
 195                 $item['author-link'] = $activity['author'];
 196                 $item['author-id'] = Contact::getIdForURL($activity['author'], 0, true);
 197
 198                 if (empty($activity['thread-completion'])) {
 199                         $item['owner-link'] = $activity['actor'];
 200                         $item['owner-id'] = Contact::getIdForURL($activity['actor'], 0, true);
 201                 } else {
 202                         logger('Ignoring actor because of thread completion.', LOGGER_DEBUG);
 203                         $item['owner-link'] = $item['author-link'];
 204                         $item['owner-id'] = $item['author-id'];
 205                 }
 206
 207                 $item['uri'] = $activity['id'];
 208                 $item['created'] = $activity['published'];
 209                 $item['edited'] = $activity['updated'];
 210                 $item['guid'] = $activity['diaspora:guid'];
 211                 $item['title'] = HTML::toBBCode($activity['name']);
 212                 $item['content-warning'] = HTML::toBBCode($activity['summary']);
 213                 $item['body'] = self::convertMentions(HTML::toBBCode($activity['content']));
 214
 215                 if (($activity['object_type'] == 'as:Video') && !empty($activity['alternate-url'])) {
 216                         $item['body'] .= "\n[video]" . $activity['alternate-url'] . '[/video]';
 217                 }
 218
 219                 $item['location'] = $activity['location'];
 220
 221                 if (!empty($item['latitude']) && !empty($item['longitude'])) {
 222                         $item['coord'] = $item['latitude'] . ' ' . $item['longitude'];
 223                 }
 224
 225                 $item['tag'] = self::constructTagList($activity['tags'], $activity['sensitive']);
 226                 $item['app'] = $activity['generator'];
 227                 $item['plink'] = defaults($activity, 'alternate-url', $item['uri']);
 228                 $item['diaspora_signed_text'] = defaults($activity, 'diaspora:comment', '');
 229
 230                 $item = self::constructAttachList($activity['attachments'], $item);
 231
 232                 if (!empty($activity['source'])) {
 233                         $item['body'] = $activity['source'];
 234                 }
 235
 236                 foreach ($activity['receiver'] as $receiver) {
 237                         $item['uid'] = $receiver;
 238                         $item['contact-id'] = Contact::getIdForURL($activity['author'], $receiver, true);
 239
 240                         if (($receiver != 0) && empty($item['contact-id'])) {
 241                                 $item['contact-id'] = Contact::getIdForURL($activity['author'], 0, true);
 242                         }
 243
 244                         $item_id = Item::insert($item);
 245                         logger('Storing for user ' . $item['uid'] . ': ' . $item_id);
 246                 }
 247         }
 248
 249         /**
 250          * Fetches missing posts
 251          *
 252          * @param $url
 253          * @param $child
 254          */
 255         private static function fetchMissingActivity($url, $child)
 256         {
 257                 if (Config::get('system', 'ostatus_full_threads')) {
 258                         return;
 259                 }
 260
 261                 $object = ActivityPub::fetchContent($url);
 262                 if (empty($object)) {
 263                         logger('Activity ' . $url . ' was not fetchable, aborting.');
 264                         return;
 265                 }
 266
 267                 $activity = [];
 268                 $activity['@context'] = $object['@context'];
 269                 unset($object['@context']);
 270                 $activity['id'] = $object['id'];
 271                 $activity['to'] = defaults($object, 'to', []);
 272                 $activity['cc'] = defaults($object, 'cc', []);
 273                 $activity['actor'] = $child['author'];
 274                 $activity['object'] = $object;
 275                 $activity['published'] = $object['published'];
 276                 $activity['type'] = 'Create';
 277
 278                 $ldactivity = JsonLD::compact($activity);
 279
 280                 $ldactivity['thread-completion'] = true;
 281
 282                 ActivityPub\Receiver::processActivity($ldactivity);
 283                 logger('Activity ' . $url . ' had been fetched and processed.');
 284         }
 285
 286         /**
 287          * perform a "follow" request
 288          *
 289          * @param array $activity
 290          */
 291         public static function followUser($activity)
 292         {
 293                 $uid = User::getIdForURL($activity['object_id']);
 294                 if (empty($uid)) {
 295                         return;
 296                 }
 297
 298                 $owner = User::getOwnerDataById($uid);
 299
 300                 $cid = Contact::getIdForURL($activity['actor'], $uid);
 301                 if (!empty($cid)) {
 302                         self::switchContact($cid);
 303                         $contact = DBA::selectFirst('contact', [], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
 304                 } else {
 305                         $contact = false;
 306                 }
 307
 308                 $item = ['author-id' => Contact::getIdForURL($activity['actor']),
 309                         'author-link' => $activity['actor']];
 310
 311                 // Ensure that the contact has got the right network type
 312                 self::switchContact($item['author-id']);
 313
 314                 Contact::addRelationship($owner, $contact, $item);
 315                 $cid = Contact::getIdForURL($activity['actor'], $uid);
 316                 if (empty($cid)) {
 317                         return;
 318                 }
 319
 320                 DBA::update('contact', ['hub-verify' => $activity['id']], ['id' => $cid]);
 321                 logger('Follow user ' . $uid . ' from contact ' . $cid . ' with id ' . $activity['id']);
 322         }
 323
 324         /**
 325          * Update the given profile
 326          *
 327          * @param array $activity
 328          */
 329         public static function updatePerson($activity)
 330         {
 331                 if (empty($activity['object_id'])) {
 332                         return;
 333                 }
 334
 335                 logger('Updating profile for ' . $activity['object_id'], LOGGER_DEBUG);
 336                 APContact::getByURL($activity['object_id'], true);
 337         }
 338
 339         /**
 340          * Delete the given profile
 341          *
 342          * @param array $activity
 343          */
 344         public static function deletePerson($activity)
 345         {
 346                 if (empty($activity['object_id']) || empty($activity['actor'])) {
 347                         logger('Empty object id or actor.', LOGGER_DEBUG);
 348                         return;
 349                 }
 350
 351                 if ($activity['object_id'] != $activity['actor']) {
 352                         logger('Object id does not match actor.', LOGGER_DEBUG);
 353                         return;
 354                 }
 355
 356                 $contacts = DBA::select('contact', ['id'], ['nurl' => normalise_link($activity['object_id'])]);
 357                 while ($contact = DBA::fetch($contacts)) {
 358                         Contact::remove($contact['id']);
 359                 }
 360                 DBA::close($contacts);
 361
 362                 logger('Deleted contact ' . $activity['object_id'], LOGGER_DEBUG);
 363         }
 364
 365         /**
 366          * Accept a follow request
 367          *
 368          * @param array $activity
 369          */
 370         public static function acceptFollowUser($activity)
 371         {
 372                 $uid = User::getIdForURL($activity['object_actor']);
 373                 if (empty($uid)) {
 374                         return;
 375                 }
 376
 377                 $owner = User::getOwnerDataById($uid);
 378
 379                 $cid = Contact::getIdForURL($activity['actor'], $uid);
 380                 if (empty($cid)) {
 381                         logger('No contact found for ' . $activity['actor'], LOGGER_DEBUG);
 382                         return;
 383                 }
 384
 385                 self::switchContact($cid);
 386
 387                 $fields = ['pending' => false];
 388
 389                 $contact = DBA::selectFirst('contact', ['rel'], ['id' => $cid]);
 390                 if ($contact['rel'] == Contact::FOLLOWER) {
 391                         $fields['rel'] = Contact::FRIEND;
 392                 }
 393
 394                 $condition = ['id' => $cid];
 395                 DBA::update('contact', $fields, $condition);
 396                 logger('Accept contact request from contact ' . $cid . ' for user ' . $uid, LOGGER_DEBUG);
 397         }
 398
 399         /**
 400          * Reject a follow request
 401          *
 402          * @param array $activity
 403          */
 404         public static function rejectFollowUser($activity)
 405         {
 406                 $uid = User::getIdForURL($activity['object_actor']);
 407                 if (empty($uid)) {
 408                         return;
 409                 }
 410
 411                 $owner = User::getOwnerDataById($uid);
 412
 413                 $cid = Contact::getIdForURL($activity['actor'], $uid);
 414                 if (empty($cid)) {
 415                         logger('No contact found for ' . $activity['actor'], LOGGER_DEBUG);
 416                         return;
 417                 }
 418
 419                 self::switchContact($cid);
 420
 421                 if (DBA::exists('contact', ['id' => $cid, 'rel' => Contact::SHARING, 'pending' => true])) {
 422                         Contact::remove($cid);
 423                         logger('Rejected contact request from contact ' . $cid . ' for user ' . $uid . ' - contact had been removed.', LOGGER_DEBUG);
 424                 } else {
 425                         logger('Rejected contact request from contact ' . $cid . ' for user ' . $uid . '.', LOGGER_DEBUG);
 426                 }
 427         }
 428
 429         /**
 430          * Undo activity like "like" or "dislike"
 431          *
 432          * @param array $activity
 433          */
 434         public static function undoActivity($activity)
 435         {
 436                 if (empty($activity['object_id'])) {
 437                         return;
 438                 }
 439
 440                 if (empty($activity['object_actor'])) {
 441                         return;
 442                 }
 443
 444                 $author_id = Contact::getIdForURL($activity['object_actor']);
 445                 if (empty($author_id)) {
 446                         return;
 447                 }
 448
 449                 Item::delete(['uri' => $activity['object_id'], 'author-id' => $author_id, 'gravity' => GRAVITY_ACTIVITY]);
 450         }
 451
 452         /**
 453          * Activity to remove a follower
 454          *
 455          * @param array $activity
 456          */
 457         public static function undoFollowUser($activity)
 458         {
 459                 $uid = User::getIdForURL($activity['object_object']);
 460                 if (empty($uid)) {
 461                         return;
 462                 }
 463
 464                 $owner = User::getOwnerDataById($uid);
 465
 466                 $cid = Contact::getIdForURL($activity['actor'], $uid);
 467                 if (empty($cid)) {
 468                         logger('No contact found for ' . $activity['actor'], LOGGER_DEBUG);
 469                         return;
 470                 }
 471
 472                 self::switchContact($cid);
 473
 474                 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
 475                 if (!DBA::isResult($contact)) {
 476                         return;
 477                 }
 478
 479                 Contact::removeFollower($owner, $contact);
 480                 logger('Undo following request from contact ' . $cid . ' for user ' . $uid, LOGGER_DEBUG);
 481         }
 482
 483         /**
 484          * Switches a contact to AP if needed
 485          *
 486          * @param integer $cid Contact ID
 487          */
 488         private static function switchContact($cid)
 489         {
 490                 $contact = DBA::selectFirst('contact', ['network'], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
 491                 if (!DBA::isResult($contact) || ($contact['network'] == Protocol::ACTIVITYPUB)) {
 492                         return;
 493                 }
 494
 495                 logger('Change existing contact ' . $cid . ' from ' . $contact['network'] . ' to ActivityPub.');
 496                 Contact::updateFromProbe($cid, Protocol::ACTIVITYPUB);
 497         }
 498 }