Transmit via BCC if contact is hidden, don't store announces
[friendica.git/.git] / src / Protocol / ActivityPub / Transmitter.php
1 <?php
2 /**
3  * @file src/Protocol/ActivityPub/Transmitter.php
4  */
5 namespace Friendica\Protocol\ActivityPub;
6
7 use Friendica\BaseObject;
8 use Friendica\Database\DBA;
9 use Friendica\Core\Logger;
10 use Friendica\Core\System;
11 use Friendica\Util\HTTPSignature;
12 use Friendica\Core\Protocol;
13 use Friendica\Model\Conversation;
14 use Friendica\Model\Contact;
15 use Friendica\Model\APContact;
16 use Friendica\Model\Item;
17 use Friendica\Model\Term;
18 use Friendica\Model\User;
19 use Friendica\Util\DateTimeFormat;
20 use Friendica\Content\Text\BBCode;
21 use Friendica\Util\JsonLD;
22 use Friendica\Util\LDSignature;
23 use Friendica\Model\Profile;
24 use Friendica\Core\Config;
25 use Friendica\Object\Image;
26 use Friendica\Protocol\ActivityPub;
27 use Friendica\Protocol\Diaspora;
28 use Friendica\Core\Cache;
29 use Friendica\Util\Map;
30 use Friendica\Util\Network;
31
32 require_once 'include/api.php';
33
34 /**
35  * @brief ActivityPub Transmitter Protocol class
36  *
37  * To-Do:
38  * - Undo Announce
39  */
40 class Transmitter
41 {
42         /**
43          * collects the lost of followers of the given owner
44          *
45          * @param array $owner Owner array
46          * @param integer $page Page number
47          *
48          * @return array of owners
49          */
50         public static function getFollowers($owner, $page = null)
51         {
52                 $condition = ['rel' => [Contact::FOLLOWER, Contact::FRIEND], 'network' => Protocol::NATIVE_SUPPORT, 'uid' => $owner['uid'],
53                         'self' => false, 'deleted' => false, 'hidden' => false, 'archive' => false, 'pending' => false];
54                 $count = DBA::count('contact', $condition);
55
56                 $data = ['@context' => ActivityPub::CONTEXT];
57                 $data['id'] = System::baseUrl() . '/followers/' . $owner['nickname'];
58                 $data['type'] = 'OrderedCollection';
59                 $data['totalItems'] = $count;
60
61                 // When we hide our friends we will only show the pure number but don't allow more.
62                 $profile = Profile::getByUID($owner['uid']);
63                 if (!empty($profile['hide-friends'])) {
64                         return $data;
65                 }
66
67                 if (empty($page)) {
68                         $data['first'] = System::baseUrl() . '/followers/' . $owner['nickname'] . '?page=1';
69                 } else {
70                         $list = [];
71
72                         $contacts = DBA::select('contact', ['url'], $condition, ['limit' => [($page - 1) * 100, 100]]);
73                         while ($contact = DBA::fetch($contacts)) {
74                                 $list[] = $contact['url'];
75                         }
76
77                         if (!empty($list)) {
78                                 $data['next'] = System::baseUrl() . '/followers/' . $owner['nickname'] . '?page=' . ($page + 1);
79                         }
80
81                         $data['partOf'] = System::baseUrl() . '/followers/' . $owner['nickname'];
82
83                         $data['orderedItems'] = $list;
84                 }
85
86                 return $data;
87         }
88
89         /**
90          * Create list of following contacts
91          *
92          * @param array $owner Owner array
93          * @param integer $page Page numbe
94          *
95          * @return array of following contacts
96          */
97         public static function getFollowing($owner, $page = null)
98         {
99                 $condition = ['rel' => [Contact::SHARING, Contact::FRIEND], 'network' => Protocol::NATIVE_SUPPORT, 'uid' => $owner['uid'],
100                         'self' => false, 'deleted' => false, 'hidden' => false, 'archive' => false, 'pending' => false];
101                 $count = DBA::count('contact', $condition);
102
103                 $data = ['@context' => ActivityPub::CONTEXT];
104                 $data['id'] = System::baseUrl() . '/following/' . $owner['nickname'];
105                 $data['type'] = 'OrderedCollection';
106                 $data['totalItems'] = $count;
107
108                 // When we hide our friends we will only show the pure number but don't allow more.
109                 $profile = Profile::getByUID($owner['uid']);
110                 if (!empty($profile['hide-friends'])) {
111                         return $data;
112                 }
113
114                 if (empty($page)) {
115                         $data['first'] = System::baseUrl() . '/following/' . $owner['nickname'] . '?page=1';
116                 } else {
117                         $list = [];
118
119                         $contacts = DBA::select('contact', ['url'], $condition, ['limit' => [($page - 1) * 100, 100]]);
120                         while ($contact = DBA::fetch($contacts)) {
121                                 $list[] = $contact['url'];
122                         }
123
124                         if (!empty($list)) {
125                                 $data['next'] = System::baseUrl() . '/following/' . $owner['nickname'] . '?page=' . ($page + 1);
126                         }
127
128                         $data['partOf'] = System::baseUrl() . '/following/' . $owner['nickname'];
129
130                         $data['orderedItems'] = $list;
131                 }
132
133                 return $data;
134         }
135
136         /**
137          * Public posts for the given owner
138          *
139          * @param array $owner Owner array
140          * @param integer $page Page numbe
141          *
142          * @return array of posts
143          */
144         public static function getOutbox($owner, $page = null)
145         {
146                 $public_contact = Contact::getIdForURL($owner['url'], 0, true);
147
148                 $condition = ['uid' => 0, 'contact-id' => $public_contact, 'author-id' => $public_contact,
149                         'private' => false, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT],
150                         'deleted' => false, 'visible' => true];
151                 $count = DBA::count('item', $condition);
152
153                 $data = ['@context' => ActivityPub::CONTEXT];
154                 $data['id'] = System::baseUrl() . '/outbox/' . $owner['nickname'];
155                 $data['type'] = 'OrderedCollection';
156                 $data['totalItems'] = $count;
157
158                 if (empty($page)) {
159                         $data['first'] = System::baseUrl() . '/outbox/' . $owner['nickname'] . '?page=1';
160                 } else {
161                         $list = [];
162
163                         $condition['parent-network'] = Protocol::NATIVE_SUPPORT;
164
165                         $items = Item::select(['id'], $condition, ['limit' => [($page - 1) * 20, 20], 'order' => ['created' => true]]);
166                         while ($item = Item::fetch($items)) {
167                                 $object = self::createObjectFromItemID($item['id']);
168                                 unset($object['@context']);
169                                 $list[] = $object;
170                         }
171
172                         if (!empty($list)) {
173                                 $data['next'] = System::baseUrl() . '/outbox/' . $owner['nickname'] . '?page=' . ($page + 1);
174                         }
175
176                         $data['partOf'] = System::baseUrl() . '/outbox/' . $owner['nickname'];
177
178                         $data['orderedItems'] = $list;
179                 }
180
181                 return $data;
182         }
183
184         /**
185          * Return the ActivityPub profile of the given user
186          *
187          * @param integer $uid User ID
188          * @return array with profile data
189          */
190         public static function getProfile($uid)
191         {
192                 $condition = ['uid' => $uid, 'blocked' => false, 'account_expired' => false,
193                         'account_removed' => false, 'verified' => true];
194                 $fields = ['guid', 'nickname', 'pubkey', 'account-type', 'page-flags'];
195                 $user = DBA::selectFirst('user', $fields, $condition);
196                 if (!DBA::isResult($user)) {
197                         return [];
198                 }
199
200                 $fields = ['locality', 'region', 'country-name'];
201                 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid, 'is-default' => true]);
202                 if (!DBA::isResult($profile)) {
203                         return [];
204                 }
205
206                 $fields = ['name', 'url', 'location', 'about', 'avatar', 'photo'];
207                 $contact = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
208                 if (!DBA::isResult($contact)) {
209                         return [];
210                 }
211
212                 // On old installations and never changed contacts this might not be filled
213                 if (empty($contact['avatar'])) {
214                         $contact['avatar'] = $contact['photo'];
215                 }
216
217                 $data = ['@context' => ActivityPub::CONTEXT];
218                 $data['id'] = $contact['url'];
219                 $data['diaspora:guid'] = $user['guid'];
220                 $data['type'] = ActivityPub::ACCOUNT_TYPES[$user['account-type']];
221                 $data['following'] = System::baseUrl() . '/following/' . $user['nickname'];
222                 $data['followers'] = System::baseUrl() . '/followers/' . $user['nickname'];
223                 $data['inbox'] = System::baseUrl() . '/inbox/' . $user['nickname'];
224                 $data['outbox'] = System::baseUrl() . '/outbox/' . $user['nickname'];
225                 $data['preferredUsername'] = $user['nickname'];
226                 $data['name'] = $contact['name'];
227                 $data['vcard:hasAddress'] = ['@type' => 'vcard:Home', 'vcard:country-name' => $profile['country-name'],
228                         'vcard:region' => $profile['region'], 'vcard:locality' => $profile['locality']];
229                 $data['summary'] = $contact['about'];
230                 $data['url'] = $contact['url'];
231                 $data['manuallyApprovesFollowers'] = in_array($user['page-flags'], [Contact::PAGE_NORMAL, Contact::PAGE_PRVGROUP]);
232                 $data['publicKey'] = ['id' => $contact['url'] . '#main-key',
233                         'owner' => $contact['url'],
234                         'publicKeyPem' => $user['pubkey']];
235                 $data['endpoints'] = ['sharedInbox' => System::baseUrl() . '/inbox'];
236                 $data['icon'] = ['type' => 'Image',
237                         'url' => $contact['avatar']];
238
239                 // tags: https://kitty.town/@inmysocks/100656097926961126.json
240                 return $data;
241         }
242
243         /**
244          * Returns an array with permissions of a given item array
245          *
246          * @param array $item
247          *
248          * @return array with permissions
249          */
250         private static function fetchPermissionBlockFromConversation($item)
251         {
252                 if (empty($item['thr-parent'])) {
253                         return [];
254                 }
255
256                 $condition = ['item-uri' => $item['thr-parent'], 'protocol' => Conversation::PARCEL_ACTIVITYPUB];
257                 $conversation = DBA::selectFirst('conversation', ['source'], $condition);
258                 if (!DBA::isResult($conversation)) {
259                         return [];
260                 }
261
262                 $activity = json_decode($conversation['source'], true);
263
264                 $actor = JsonLD::fetchElement($activity, 'actor', 'id');
265                 $profile = APContact::getByURL($actor);
266
267                 $item_profile = APContact::getByURL($item['author-link']);
268                 $exclude[] = $item['author-link'];
269
270                 if ($item['gravity'] == GRAVITY_PARENT) {
271                         $exclude[] = $item['owner-link'];
272                 }
273
274                 $permissions['to'][] = $actor;
275
276                 foreach (['to', 'cc', 'bto', 'bcc'] as $element) {
277                         if (empty($activity[$element])) {
278                                 continue;
279                         }
280                         if (is_string($activity[$element])) {
281                                 $activity[$element] = [$activity[$element]];
282                         }
283
284                         foreach ($activity[$element] as $receiver) {
285                                 if ($receiver == $profile['followers'] && !empty($item_profile['followers'])) {
286                                         $permissions[$element][] = $item_profile['followers'];
287                                 } elseif (!in_array($receiver, $exclude)) {
288                                         $permissions[$element][] = $receiver;
289                                 }
290                         }
291                 }
292                 return $permissions;
293         }
294
295         /**
296          * Creates an array of permissions from an item thread
297          *
298          * @param array $item
299          * @param boolean $blindcopy
300          * @param boolean $last_id
301          *
302          * @return array with permission data
303          */
304         private static function createPermissionBlockForItem($item, $blindcopy, $last_id = 0)
305         {
306                 if ($last_id == 0) {
307                         $last_id = $item['id'];
308                 }
309
310                 $always_bcc = false;
311
312                 // Check if we should always deliver our stuff via BCC
313                 if (!empty($item['uid'])) {
314                         $profile = Profile::getByUID($item['uid']);
315                         if (!empty($profile)) {
316                                 $always_bcc = $profile['hide-friends'];
317                         }
318                 }
319
320                 // Will be activated in a later step
321                 // $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS];
322
323                 // For now only send to these contacts:
324                 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
325
326                 $data = ['to' => [], 'cc' => [], 'bcc' => []];
327
328                 $actor_profile = APContact::getByURL($item['author-link']);
329
330                 $terms = Term::tagArrayFromItemId($item['id'], TERM_MENTION);
331
332                 if (!$item['private']) {
333                         $data = array_merge($data, self::fetchPermissionBlockFromConversation($item));
334
335                         $data['to'][] = ActivityPub::PUBLIC_COLLECTION;
336                         if (!empty($actor_profile['followers'])) {
337                                 $data['cc'][] = $actor_profile['followers'];
338                         }
339
340                         foreach ($terms as $term) {
341                                 $profile = APContact::getByURL($term['url'], false);
342                                 if (!empty($profile)) {
343                                         $data['to'][] = $profile['url'];
344                                 }
345                         }
346                 } else {
347                         $receiver_list = Item::enumeratePermissions($item);
348
349                         $mentioned = [];
350
351                         foreach ($terms as $term) {
352                                 $cid = Contact::getIdForURL($term['url'], $item['uid']);
353                                 if (!empty($cid) && in_array($cid, $receiver_list)) {
354                                         $contact = DBA::selectFirst('contact', ['url'], ['id' => $cid, 'network' => $networks]);
355                                         if (DBA::isResult($contact) && !empty($profile = APContact::getByURL($contact['url'], false))) {
356                                                 $data['to'][] = $profile['url'];
357                                         }
358                                 }
359                         }
360
361                         foreach ($receiver_list as $receiver) {
362                                 $contact = DBA::selectFirst('contact', ['url', 'hidden'], ['id' => $receiver, 'network' => $networks]);
363                                 if (DBA::isResult($contact) && !empty($profile = APContact::getByURL($contact['url'], false))) {
364                                         if ($contact['hidden'] || $always_bcc) {
365                                                 $data['bcc'][] = $profile['url'];
366                                         } else {
367                                                 $data['cc'][] = $profile['url'];
368                                         }
369                                 }
370                         }
371                 }
372
373                 $parents = Item::select(['id', 'author-link', 'owner-link', 'gravity', 'uri'], ['parent' => $item['parent']]);
374                 while ($parent = Item::fetch($parents)) {
375                         // Don't include data from future posts
376                         if ($parent['id'] >= $last_id) {
377                                 continue;
378                         }
379
380                         $profile = APContact::getByURL($parent['author-link'], false);
381                         if (!empty($profile)) {
382                                 if ($parent['uri'] == $item['thr-parent']) {
383                                         $data['to'][] = $profile['url'];
384                                 } else {
385                                         $data['cc'][] = $profile['url'];
386                                 }
387                         }
388
389                         if ($item['gravity'] != GRAVITY_PARENT) {
390                                 continue;
391                         }
392
393                         $profile = APContact::getByURL($parent['owner-link'], false);
394                         if (!empty($profile)) {
395                                 $data['cc'][] = $profile['url'];
396                         }
397                 }
398                 DBA::close($parents);
399
400                 $data['to'] = array_unique($data['to']);
401                 $data['cc'] = array_unique($data['cc']);
402                 $data['bcc'] = array_unique($data['bcc']);
403
404                 if (($key = array_search($item['author-link'], $data['to'])) !== false) {
405                         unset($data['to'][$key]);
406                 }
407
408                 if (($key = array_search($item['author-link'], $data['cc'])) !== false) {
409                         unset($data['cc'][$key]);
410                 }
411
412                 if (($key = array_search($item['author-link'], $data['bcc'])) !== false) {
413                         unset($data['bcc'][$key]);
414                 }
415
416                 foreach ($data['to'] as $to) {
417                         if (($key = array_search($to, $data['cc'])) !== false) {
418                                 unset($data['cc'][$key]);
419                         }
420
421                         if (($key = array_search($to, $data['bcc'])) !== false) {
422                                 unset($data['bcc'][$key]);
423                         }
424                 }
425
426                 foreach ($data['cc'] as $cc) {
427                         if (($key = array_search($cc, $data['bcc'])) !== false) {
428                                 unset($data['bcc'][$key]);
429                         }
430                 }
431
432                 $receivers = ['to' => array_values($data['to']), 'cc' => array_values($data['cc']), 'bcc' => array_values($data['bcc'])];
433
434                 if (!$blindcopy) {
435                         unset($receivers['bcc']);
436                 }
437
438                 return $receivers;
439         }
440
441         /**
442          * Fetches a list of inboxes of followers of a given user
443          *
444          * @param integer $uid User ID
445          * @param boolean $personal fetch personal inboxes
446          *
447          * @return array of follower inboxes
448          */
449         public static function fetchTargetInboxesforUser($uid, $personal = false)
450         {
451                 $inboxes = [];
452
453                 // Will be activated in a later step
454                 // $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS];
455
456                 // For now only send to these contacts:
457                 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
458
459                 $condition = ['uid' => $uid, 'network' => $networks, 'archive' => false, 'pending' => false];
460
461                 if (!empty($uid)) {
462                         $condition['rel'] = [Contact::FOLLOWER, Contact::FRIEND];
463                 }
464
465                 $contacts = DBA::select('contact', ['url'], $condition);
466                 while ($contact = DBA::fetch($contacts)) {
467                         if (Network::isUrlBlocked($contact['url'])) {
468                                 continue;
469                         }
470
471                         $profile = APContact::getByURL($contact['url'], false);
472                         if (!empty($profile)) {
473                                 if (empty($profile['sharedinbox']) || $personal) {
474                                         $target = $profile['inbox'];
475                                 } else {
476                                         $target = $profile['sharedinbox'];
477                                 }
478                                 $inboxes[$target] = $target;
479                         }
480                 }
481                 DBA::close($contacts);
482
483                 return $inboxes;
484         }
485
486         /**
487          * Fetches an array of inboxes for the given item and user
488          *
489          * @param array $item
490          * @param integer $uid User ID
491          * @param boolean $personal fetch personal inboxes
492          * @param integer $last_id Last item id for adding receivers
493          *
494          * @return array with inboxes
495          */
496         public static function fetchTargetInboxes($item, $uid, $personal = false, $last_id = 0)
497         {
498                 $permissions = self::createPermissionBlockForItem($item, true, $last_id);
499                 if (empty($permissions)) {
500                         return [];
501                 }
502
503                 $inboxes = [];
504
505                 if ($item['gravity'] == GRAVITY_ACTIVITY) {
506                         $item_profile = APContact::getByURL($item['author-link'], false);
507                 } else {
508                         $item_profile = APContact::getByURL($item['owner-link'], false);
509                 }
510
511                 foreach (['to', 'cc', 'bto', 'bcc'] as $element) {
512                         if (empty($permissions[$element])) {
513                                 continue;
514                         }
515
516                         $blindcopy = in_array($element, ['bto', 'bcc']);
517
518                         foreach ($permissions[$element] as $receiver) {
519                                 if (Network::isUrlBlocked($receiver)) {
520                                         continue;
521                                 }
522
523                                 if ($receiver == $item_profile['followers']) {
524                                         $inboxes = array_merge($inboxes, self::fetchTargetInboxesforUser($uid, $personal));
525                                 } else {
526                                         $profile = APContact::getByURL($receiver, false);
527                                         if (!empty($profile)) {
528                                                 if (empty($profile['sharedinbox']) || $personal || $blindcopy) {
529                                                         $target = $profile['inbox'];
530                                                 } else {
531                                                         $target = $profile['sharedinbox'];
532                                                 }
533                                                 $inboxes[$target] = $target;
534                                         }
535                                 }
536                         }
537                 }
538
539                 return $inboxes;
540         }
541
542         /**
543          * Returns the activity type of a given item
544          *
545          * @param array $item
546          *
547          * @return string with activity type
548          */
549         private static function getTypeOfItem($item)
550         {
551                 if (!empty(Diaspora::isReshare($item['body'], false))) {
552                         $type = 'Announce';
553                 } elseif ($item['verb'] == ACTIVITY_POST) {
554                         if ($item['created'] == $item['edited']) {
555                                 $type = 'Create';
556                         } else {
557                                 $type = 'Update';
558                         }
559                 } elseif ($item['verb'] == ACTIVITY_LIKE) {
560                         $type = 'Like';
561                 } elseif ($item['verb'] == ACTIVITY_DISLIKE) {
562                         $type = 'Dislike';
563                 } elseif ($item['verb'] == ACTIVITY_ATTEND) {
564                         $type = 'Accept';
565                 } elseif ($item['verb'] == ACTIVITY_ATTENDNO) {
566                         $type = 'Reject';
567                 } elseif ($item['verb'] == ACTIVITY_ATTENDMAYBE) {
568                         $type = 'TentativeAccept';
569                 } else {
570                         $type = '';
571                 }
572
573                 return $type;
574         }
575
576         /**
577          * Creates the activity or fetches it from the cache
578          *
579          * @param integer $item_id
580          * @param boolean $force   Force new cache entry
581          *
582          * @return array with the activity
583          */
584         public static function createCachedActivityFromItem($item_id, $force = false)
585         {
586                 $cachekey = 'APDelivery:createActivity:' . $item_id;
587
588                 if (!$force) {
589                         $data = Cache::get($cachekey);
590                         if (!is_null($data)) {
591                                 return $data;
592                         }
593                 }
594
595                 $data = ActivityPub\Transmitter::createActivityFromItem($item_id);
596
597                 Cache::set($cachekey, $data, Cache::QUARTER_HOUR);
598                 return $data;
599         }
600
601         /**
602          * Creates an activity array for a given item id
603          *
604          * @param integer $item_id
605          * @param boolean $object_mode Is the activity item is used inside another object?
606          *
607          * @return array of activity
608          */
609         public static function createActivityFromItem($item_id, $object_mode = false)
610         {
611                 $item = Item::selectFirst([], ['id' => $item_id, 'parent-network' => Protocol::NATIVE_SUPPORT]);
612
613                 if (!DBA::isResult($item)) {
614                         return false;
615                 }
616
617                 $condition = ['item-uri' => $item['uri'], 'protocol' => Conversation::PARCEL_ACTIVITYPUB];
618                 $conversation = DBA::selectFirst('conversation', ['source'], $condition);
619                 if (DBA::isResult($conversation)) {
620                         $data = json_decode($conversation['source']);
621                         if (!empty($data)) {
622                                 return $data;
623                         }
624                 }
625
626                 $type = self::getTypeOfItem($item);
627
628                 if (!$object_mode) {
629                         $data = ['@context' => ActivityPub::CONTEXT];
630
631                         if ($item['deleted'] && ($item['gravity'] == GRAVITY_ACTIVITY)) {
632                                 $type = 'Undo';
633                         } elseif ($item['deleted']) {
634                                 $type = 'Delete';
635                         }
636                 } else {
637                         $data = [];
638                 }
639
640                 $data['id'] = $item['uri'] . '#' . $type;
641                 $data['type'] = $type;
642                 $data['actor'] = $item['owner-link'];
643
644                 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
645
646                 $data['instrument'] = ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()];
647
648                 $data = array_merge($data, self::createPermissionBlockForItem($item, false));
649
650                 if (in_array($data['type'], ['Create', 'Update', 'Delete'])) {
651                         $data['object'] = self::createNote($item);
652                 } elseif ($data['type'] == 'Announce') {
653                         $data['object'] = self::createAnnounce($item);
654                 } elseif ($data['type'] == 'Undo') {
655                         $data['object'] = self::createActivityFromItem($item_id, true);
656                 } else {
657                         $data['diaspora:guid'] = $item['guid'];
658                         if (!empty($item['signed_text'])) {
659                                 $data['diaspora:like'] = $item['signed_text'];
660                         }
661                         $data['object'] = $item['thr-parent'];
662                 }
663
664                 if (!empty($item['contact-uid'])) {
665                         $uid = $item['contact-uid'];
666                 } else {
667                         $uid = $item['uid'];
668                 }
669
670                 $owner = User::getOwnerDataById($uid);
671
672                 if (!$object_mode && !empty($owner)) {
673                         return LDSignature::sign($data, $owner);
674                 } else {
675                         return $data;
676                 }
677
678                 /// @todo Create "conversation" entry
679         }
680
681         /**
682          * Creates an object array for a given item id
683          *
684          * @param integer $item_id
685          *
686          * @return array with the object data
687          */
688         public static function createObjectFromItemID($item_id)
689         {
690                 $item = Item::selectFirst([], ['id' => $item_id, 'parent-network' => Protocol::NATIVE_SUPPORT]);
691
692                 if (!DBA::isResult($item)) {
693                         return false;
694                 }
695
696                 $data = ['@context' => ActivityPub::CONTEXT];
697                 $data = array_merge($data, self::createNote($item));
698
699                 return $data;
700         }
701
702         /**
703          * Creates a location entry for a given item array
704          *
705          * @param array $item
706          *
707          * @return array with location array
708          */
709         private static function createLocation($item)
710         {
711                 $location = ['type' => 'Place'];
712
713                 if (!empty($item['location'])) {
714                         $location['name'] = $item['location'];
715                 }
716
717                 $coord = [];
718
719                 if (empty($item['coord'])) {
720                         $coord = Map::getCoordinates($item['location']);
721                 } else {
722                         $coords = explode(' ', $item['coord']);
723                         if (count($coords) == 2) {
724                                 $coord = ['lat' => $coords[0], 'lon' => $coords[1]];
725                         }
726                 }
727
728                 if (!empty($coord['lat']) && !empty($coord['lon'])) {
729                         $location['latitude'] = $coord['lat'];
730                         $location['longitude'] = $coord['lon'];
731                 }
732
733                 return $location;
734         }
735
736         /**
737          * Returns a tag array for a given item array
738          *
739          * @param array $item
740          *
741          * @return array of tags
742          */
743         private static function createTagList($item)
744         {
745                 $tags = [];
746
747                 $terms = Term::tagArrayFromItemId($item['id']);
748                 foreach ($terms as $term) {
749                         if ($term['type'] == TERM_HASHTAG) {
750                                 $tags[] = ['type' => 'Hashtag', 'href' => $term['url'], 'name' => '#' . $term['term']];
751                         } elseif ($term['type'] == TERM_MENTION) {
752                                 $contact = Contact::getDetailsByURL($term['url']);
753                                 if (!empty($contact['addr'])) {
754                                         $mention = '@' . $contact['addr'];
755                                 } else {
756                                         $mention = '@' . $term['url'];
757                                 }
758
759                                 $tags[] = ['type' => 'Mention', 'href' => $term['url'], 'name' => $mention];
760                         }
761                 }
762                 return $tags;
763         }
764
765         /**
766          * Adds attachment data to the JSON document
767          *
768          * @param array $item Data of the item that is to be posted
769          * @param text $type Object type
770          *
771          * @return array with attachment data
772          */
773         private static function createAttachmentList($item, $type)
774         {
775                 $attachments = [];
776
777                 $arr = explode('[/attach],', $item['attach']);
778                 if (count($arr)) {
779                         foreach ($arr as $r) {
780                                 $matches = false;
781                                 $cnt = preg_match('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|', $r, $matches);
782                                 if ($cnt) {
783                                         $attributes = ['type' => 'Document',
784                                                         'mediaType' => $matches[3],
785                                                         'url' => $matches[1],
786                                                         'name' => null];
787
788                                         if (trim($matches[4]) != '') {
789                                                 $attributes['name'] = trim($matches[4]);
790                                         }
791
792                                         $attachments[] = $attributes;
793                                 }
794                         }
795                 }
796
797                 if ($type != 'Note') {
798                         return $attachments;
799                 }
800
801                 // Simplify image codes
802                 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $item['body']);
803
804                 // Grab all pictures and create attachments out of them
805                 if (preg_match_all("/\[img\]([^\[\]]*)\[\/img\]/Usi", $body, $pictures)) {
806                         foreach ($pictures[1] as $picture) {
807                                 $imgdata = Image::getInfoFromURL($picture);
808                                 if ($imgdata) {
809                                         $attachments[] = ['type' => 'Document',
810                                                 'mediaType' => $imgdata['mime'],
811                                                 'url' => $picture,
812                                                 'name' => null];
813                                 }
814                         }
815                 }
816
817                 return $attachments;
818         }
819
820         /**
821          * @brief Callback function to replace a Friendica style mention in a mention that is used on AP
822          *
823          * @param array $match Matching values for the callback
824          * @return string Replaced mention
825          */
826         private static function mentionCallback($match)
827         {
828                 if (empty($match[1])) {
829                         return;
830                 }
831
832                 $data = Contact::getDetailsByURL($match[1]);
833                 if (empty($data) || empty($data['nick'])) {
834                         return;
835                 }
836
837                 return '@[url=' . $data['url'] . ']' . $data['nick'] . '[/url]';
838         }
839
840         /**
841          * Remove image elements and replaces them with links to the image
842          *
843          * @param string $body
844          *
845          * @return string with replaced elements
846          */
847         private static function removePictures($body)
848         {
849                 // Simplify image codes
850                 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
851
852                 $body = preg_replace("/\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]/Usi", '[url]$1[/url]', $body);
853                 $body = preg_replace("/\[img\]([^\[\]]*)\[\/img\]/Usi", '[url]$1[/url]', $body);
854
855                 return $body;
856         }
857
858         /**
859          * Fetches the "context" value for a givem item array from the "conversation" table
860          *
861          * @param array $item
862          *
863          * @return string with context url
864          */
865         private static function fetchContextURLForItem($item)
866         {
867                 $conversation = DBA::selectFirst('conversation', ['conversation-href', 'conversation-uri'], ['item-uri' => $item['parent-uri']]);
868                 if (DBA::isResult($conversation) && !empty($conversation['conversation-href'])) {
869                         $context_uri = $conversation['conversation-href'];
870                 } elseif (DBA::isResult($conversation) && !empty($conversation['conversation-uri'])) {
871                         $context_uri = $conversation['conversation-uri'];
872                 } else {
873                         $context_uri = $item['parent-uri'] . '#context';
874                 }
875                 return $context_uri;
876         }
877
878         /**
879          * Returns if the post contains sensitive content ("nsfw")
880          *
881          * @param integer $item_id
882          *
883          * @return boolean
884          */
885         private static function isSensitive($item_id)
886         {
887                 $condition = ['otype' => TERM_OBJ_POST, 'oid' => $item_id, 'type' => TERM_HASHTAG, 'term' => 'nsfw'];
888                 return DBA::exists('term', $condition);
889         }
890
891         /**
892          * Creates event data
893          *
894          * @param array $item
895          *
896          * @return array with the event data
897          */
898         public static function createEvent($item)
899         {
900                 $event = [];
901                 $event['name'] = $item['event-summary'];
902                 $event['content'] = BBCode::convert($item['event-desc'], false, 7);
903                 $event['startTime'] = DateTimeFormat::utc($item['event-start'] . '+00:00', DateTimeFormat::ATOM);
904
905                 if (!$item['event-nofinish']) {
906                         $event['endTime'] = DateTimeFormat::utc($item['event-finish'] . '+00:00', DateTimeFormat::ATOM);
907                 }
908
909                 if (!empty($item['event-location'])) {
910                         $item['location'] = $item['event-location'];
911                         $event['location'] = self::createLocation($item);
912                 }
913
914                 return $event;
915         }
916
917         /**
918          * Creates a note/article object array
919          *
920          * @param array $item
921          *
922          * @return array with the object data
923          */
924         public static function createNote($item)
925         {
926                 if ($item['event-type'] == 'event') {
927                         $type = 'Event';
928                 } elseif (!empty($item['title'])) {
929                         $type = 'Article';
930                 } else {
931                         $type = 'Note';
932                 }
933
934                 if ($item['deleted']) {
935                         $type = 'Tombstone';
936                 }
937
938                 $data = [];
939                 $data['id'] = $item['uri'];
940                 $data['type'] = $type;
941
942                 if ($item['deleted']) {
943                         return $data;
944                 }
945
946                 $data['summary'] = null; // Ignore by now
947
948                 if ($item['uri'] != $item['thr-parent']) {
949                         $data['inReplyTo'] = $item['thr-parent'];
950                 } else {
951                         $data['inReplyTo'] = null;
952                 }
953
954                 $data['diaspora:guid'] = $item['guid'];
955                 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
956
957                 if ($item['created'] != $item['edited']) {
958                         $data['updated'] = DateTimeFormat::utc($item['edited'] . '+00:00', DateTimeFormat::ATOM);
959                 }
960
961                 $data['url'] = $item['plink'];
962                 $data['attributedTo'] = $item['author-link'];
963                 $data['sensitive'] = self::isSensitive($item['id']);
964                 $data['context'] = self::fetchContextURLForItem($item);
965
966                 if (!empty($item['title'])) {
967                         $data['name'] = BBCode::toPlaintext($item['title'], false);
968                 }
969
970                 $body = $item['body'];
971
972                 if ($type == 'Note') {
973                         $body = self::removePictures($body);
974                 }
975
976                 if ($type == 'Event') {
977                         $data = array_merge($data, self::createEvent($item));
978                 } else {
979                         $regexp = "/[@!]\[url\=([^\[\]]*)\].*?\[\/url\]/ism";
980                         $body = preg_replace_callback($regexp, ['self', 'mentionCallback'], $body);
981
982                         $data['content'] = BBCode::convert($body, false, 7);
983                 }
984
985                 $data['source'] = ['content' => $item['body'], 'mediaType' => "text/bbcode"];
986
987                 if (!empty($item['signed_text']) && ($item['uri'] != $item['thr-parent'])) {
988                         $data['diaspora:comment'] = $item['signed_text'];
989                 }
990
991                 $data['attachment'] = self::createAttachmentList($item, $type);
992                 $data['tag'] = self::createTagList($item);
993
994                 if (empty($data['location']) && (!empty($item['coord']) || !empty($item['location']))) {
995                         $data['location'] = self::createLocation($item);
996                 }
997
998                 if (!empty($item['app'])) {
999                         $data['generator'] = ['type' => 'Application', 'name' => $item['app']];
1000                 }
1001
1002                 $data = array_merge($data, self::createPermissionBlockForItem($item, false));
1003
1004                 return $data;
1005         }
1006
1007         /**
1008          * Creates an announce object entry
1009          *
1010          * @param array $item
1011          *
1012          * @return string with announced object url
1013          */
1014         public static function createAnnounce($item)
1015         {
1016                 $announce = api_share_as_retweet($item);
1017                 if (empty($announce['plink'])) {
1018                         return self::createNote($item);
1019                 }
1020
1021                 return $announce['plink'];
1022         }
1023
1024         /**
1025          * Creates an activity id for a given contact id
1026          *
1027          * @param integer $cid Contact ID of target
1028          *
1029          * @return bool|string activity id
1030          */
1031         public static function activityIDFromContact($cid)
1032         {
1033                 $contact = DBA::selectFirst('contact', ['uid', 'id', 'created'], ['id' => $cid]);
1034                 if (!DBA::isResult($contact)) {
1035                         return false;
1036                 }
1037
1038                 $hash = hash('ripemd128', $contact['uid'].'-'.$contact['id'].'-'.$contact['created']);
1039                 $uuid = substr($hash, 0, 8). '-' . substr($hash, 8, 4) . '-' . substr($hash, 12, 4) . '-' . substr($hash, 16, 4) . '-' . substr($hash, 20, 12);
1040                 return System::baseUrl() . '/activity/' . $uuid;
1041         }
1042
1043         /**
1044          * Transmits a contact suggestion to a given inbox
1045          *
1046          * @param integer $uid User ID
1047          * @param string $inbox Target inbox
1048          * @param integer $suggestion_id Suggestion ID
1049          *
1050          * @return boolean was the transmission successful?
1051          */
1052         public static function sendContactSuggestion($uid, $inbox, $suggestion_id)
1053         {
1054                 $owner = User::getOwnerDataById($uid);
1055
1056                 $suggestion = DBA::selectFirst('fsuggest', ['url', 'note', 'created'], ['id' => $suggestion_id]);
1057
1058                 $data = ['@context' => ActivityPub::CONTEXT,
1059                         'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1060                         'type' => 'Announce',
1061                         'actor' => $owner['url'],
1062                         'object' => $suggestion['url'],
1063                         'content' => $suggestion['note'],
1064                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1065                         'to' => [ActivityPub::PUBLIC_COLLECTION],
1066                         'cc' => []];
1067
1068                 $signed = LDSignature::sign($data, $owner);
1069
1070                 Logger::log('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1071                 return HTTPSignature::transmit($signed, $inbox, $uid);
1072         }
1073
1074         /**
1075          * Transmits a profile relocation to a given inbox
1076          *
1077          * @param integer $uid User ID
1078          * @param string $inbox Target inbox
1079          *
1080          * @return boolean was the transmission successful?
1081          */
1082         public static function sendProfileRelocation($uid, $inbox)
1083         {
1084                 $owner = User::getOwnerDataById($uid);
1085
1086                 $data = ['@context' => ActivityPub::CONTEXT,
1087                         'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1088                         'type' => 'dfrn:relocate',
1089                         'actor' => $owner['url'],
1090                         'object' => $owner['url'],
1091                         'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1092                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1093                         'to' => [ActivityPub::PUBLIC_COLLECTION],
1094                         'cc' => []];
1095
1096                 $signed = LDSignature::sign($data, $owner);
1097
1098                 Logger::log('Deliver profile relocation for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1099                 return HTTPSignature::transmit($signed, $inbox, $uid);
1100         }
1101
1102         /**
1103          * Transmits a profile deletion to a given inbox
1104          *
1105          * @param integer $uid User ID
1106          * @param string $inbox Target inbox
1107          *
1108          * @return boolean was the transmission successful?
1109          */
1110         public static function sendProfileDeletion($uid, $inbox)
1111         {
1112                 $owner = User::getOwnerDataById($uid);
1113
1114                 $data = ['@context' => ActivityPub::CONTEXT,
1115                         'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1116                         'type' => 'Delete',
1117                         'actor' => $owner['url'],
1118                         'object' => $owner['url'],
1119                         'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1120                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1121                         'to' => [ActivityPub::PUBLIC_COLLECTION],
1122                         'cc' => []];
1123
1124                 $signed = LDSignature::sign($data, $owner);
1125
1126                 Logger::log('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1127                 return HTTPSignature::transmit($signed, $inbox, $uid);
1128         }
1129
1130         /**
1131          * Transmits a profile change to a given inbox
1132          *
1133          * @param integer $uid User ID
1134          * @param string $inbox Target inbox
1135          *
1136          * @return boolean was the transmission successful?
1137          */
1138         public static function sendProfileUpdate($uid, $inbox)
1139         {
1140                 $owner = User::getOwnerDataById($uid);
1141                 $profile = APContact::getByURL($owner['url']);
1142
1143                 $data = ['@context' => ActivityPub::CONTEXT,
1144                         'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1145                         'type' => 'Update',
1146                         'actor' => $owner['url'],
1147                         'object' => self::getProfile($uid),
1148                         'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1149                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1150                         'to' => [$profile['followers']],
1151                         'cc' => []];
1152
1153                 $signed = LDSignature::sign($data, $owner);
1154
1155                 Logger::log('Deliver profile update for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1156                 return HTTPSignature::transmit($signed, $inbox, $uid);
1157         }
1158
1159         /**
1160          * Transmits a given activity to a target
1161          *
1162          * @param array $activity
1163          * @param string $target Target profile
1164          * @param integer $uid User ID
1165          * @param string $id activity id
1166          */
1167         public static function sendActivity($activity, $target, $uid, $id = '')
1168         {
1169                 $profile = APContact::getByURL($target);
1170
1171                 $owner = User::getOwnerDataById($uid);
1172
1173                 if (empty($id)) {
1174                         $id = System::baseUrl() . '/activity/' . System::createGUID();
1175                 }
1176
1177                 $data = ['@context' => ActivityPub::CONTEXT,
1178                         'id' => $id,
1179                         'type' => $activity,
1180                         'actor' => $owner['url'],
1181                         'object' => $profile['url'],
1182                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1183                         'to' => [$profile['url']]];
1184
1185                 Logger::log('Sending activity ' . $activity . ' to ' . $target . ' for user ' . $uid, Logger::DEBUG);
1186
1187                 $signed = LDSignature::sign($data, $owner);
1188                 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1189         }
1190
1191         /**
1192          * Transmit a message that the contact request had been accepted
1193          *
1194          * @param string $target Target profile
1195          * @param $id
1196          * @param integer $uid User ID
1197          */
1198         public static function sendContactAccept($target, $id, $uid)
1199         {
1200                 $profile = APContact::getByURL($target);
1201
1202                 $owner = User::getOwnerDataById($uid);
1203                 $data = ['@context' => ActivityPub::CONTEXT,
1204                         'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1205                         'type' => 'Accept',
1206                         'actor' => $owner['url'],
1207                         'object' => ['id' => $id, 'type' => 'Follow',
1208                                 'actor' => $profile['url'],
1209                                 'object' => $owner['url']],
1210                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1211                         'to' => [$profile['url']]];
1212
1213                 Logger::log('Sending accept to ' . $target . ' for user ' . $uid . ' with id ' . $id, Logger::DEBUG);
1214
1215                 $signed = LDSignature::sign($data, $owner);
1216                 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1217         }
1218
1219         /**
1220          * Reject a contact request or terminates the contact relation
1221          *
1222          * @param string $target Target profile
1223          * @param $id
1224          * @param integer $uid User ID
1225          */
1226         public static function sendContactReject($target, $id, $uid)
1227         {
1228                 $profile = APContact::getByURL($target);
1229
1230                 $owner = User::getOwnerDataById($uid);
1231                 $data = ['@context' => ActivityPub::CONTEXT,
1232                         'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1233                         'type' => 'Reject',
1234                         'actor' => $owner['url'],
1235                         'object' => ['id' => $id, 'type' => 'Follow',
1236                                 'actor' => $profile['url'],
1237                                 'object' => $owner['url']],
1238                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1239                         'to' => [$profile['url']]];
1240
1241                 Logger::log('Sending reject to ' . $target . ' for user ' . $uid . ' with id ' . $id, Logger::DEBUG);
1242
1243                 $signed = LDSignature::sign($data, $owner);
1244                 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1245         }
1246
1247         /**
1248          * Transmits a message that we don't want to follow this contact anymore
1249          *
1250          * @param string $target Target profile
1251          * @param integer $cid Contact ID of target
1252          * @param integer $uid User ID
1253          */
1254         public static function sendContactUndo($target, $cid, $uid)
1255         {
1256                 $profile = APContact::getByURL($target);
1257
1258                 $object_id = self::activityIDFromContact($cid);
1259                 if (empty($object_id)) {
1260                         return;
1261                 }
1262
1263                 $id = System::baseUrl() . '/activity/' . System::createGUID();
1264
1265                 $owner = User::getOwnerDataById($uid);
1266                 $data = ['@context' => ActivityPub::CONTEXT,
1267                         'id' => $id,
1268                         'type' => 'Undo',
1269                         'actor' => $owner['url'],
1270                         'object' => ['id' => $object_id, 'type' => 'Follow',
1271                                 'actor' => $owner['url'],
1272                                 'object' => $profile['url']],
1273                         'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1274                         'to' => [$profile['url']]];
1275
1276                 Logger::log('Sending undo to ' . $target . ' for user ' . $uid . ' with id ' . $id, Logger::DEBUG);
1277
1278                 $signed = LDSignature::sign($data, $owner);
1279                 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1280         }
1281 }