]> git.mxchange.org Git - friendica.git/blob - src/Model/Contact.php
Funkwhale context file moved
[friendica.git] / src / Model / Contact.php
1 <?php
2 /**
3  * @copyright Copyright (C) 2010-2022, the Friendica project
4  *
5  * @license GNU AGPL version 3 or any later version
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU Affero General Public License as
9  * published by the Free Software Foundation, either version 3 of the
10  * License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Affero General Public License for more details.
16  *
17  * You should have received a copy of the GNU Affero General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  *
20  */
21
22 namespace Friendica\Model;
23
24 use Friendica\Contact\Avatar;
25 use Friendica\Contact\Introduction\Exception\IntroductionNotFoundException;
26 use Friendica\Content\Pager;
27 use Friendica\Content\Text\HTML;
28 use Friendica\Core\Hook;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Protocol;
31 use Friendica\Core\Renderer;
32 use Friendica\Core\Session;
33 use Friendica\Core\System;
34 use Friendica\Core\Worker;
35 use Friendica\Database\Database;
36 use Friendica\Database\DBA;
37 use Friendica\DI;
38 use Friendica\Module\NoScrape;
39 use Friendica\Network\HTTPException;
40 use Friendica\Network\Probe;
41 use Friendica\Protocol\Activity;
42 use Friendica\Protocol\ActivityPub;
43 use Friendica\Util\DateTimeFormat;
44 use Friendica\Util\Images;
45 use Friendica\Util\Network;
46 use Friendica\Util\Proxy;
47 use Friendica\Util\Strings;
48
49 /**
50  * functions for interacting with a contact
51  */
52 class Contact
53 {
54         const DEFAULT_AVATAR_PHOTO = '/images/person-300.jpg';
55         const DEFAULT_AVATAR_THUMB = '/images/person-80.jpg';
56         const DEFAULT_AVATAR_MICRO = '/images/person-48.jpg';
57
58         /**
59          * @}
60          */
61
62         const LOCK_INSERT = 'contact-insert';
63
64         /**
65          * Account types
66          *
67          * TYPE_UNKNOWN - unknown type
68          *
69          * TYPE_PERSON - the account belongs to a person
70          *      Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
71          *
72          * TYPE_ORGANISATION - the account belongs to an organisation
73          *      Associated page type: PAGE_SOAPBOX
74          *
75          * TYPE_NEWS - the account is a news reflector
76          *      Associated page type: PAGE_SOAPBOX
77          *
78          * TYPE_COMMUNITY - the account is community forum
79          *      Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
80          *
81          * TYPE_RELAY - the account is a relay
82          *      This will only be assigned to contacts, not to user accounts
83          * @{
84          */
85         const TYPE_UNKNOWN =     -1;
86         const TYPE_PERSON =       User::ACCOUNT_TYPE_PERSON;
87         const TYPE_ORGANISATION = User::ACCOUNT_TYPE_ORGANISATION;
88         const TYPE_NEWS =         User::ACCOUNT_TYPE_NEWS;
89         const TYPE_COMMUNITY =    User::ACCOUNT_TYPE_COMMUNITY;
90         const TYPE_RELAY =        User::ACCOUNT_TYPE_RELAY;
91         /**
92          * @}
93          */
94
95         /**
96          * Contact_is
97          *
98          * Relationship types
99          * @{
100          */
101         const NOTHING  = 0;
102         const FOLLOWER = 1;
103         const SHARING  = 2;
104         const FRIEND   = 3;
105         const SELF     = 4;
106         /**
107          * @}
108          */
109
110          const MIRROR_DEACTIVATED = 0;
111          const MIRROR_FORWARDED = 1;
112          const MIRROR_OWN_POST = 2;
113          const MIRROR_NATIVE_RESHARE = 3;
114
115          /**
116          * @param array $fields    Array of selected fields, empty for all
117          * @param array $condition Array of fields for condition
118          * @param array $params    Array of several parameters
119          * @return array
120          * @throws \Exception
121          */
122         public static function selectToArray(array $fields = [], array $condition = [], array $params = []): array
123         {
124                 return DBA::selectToArray('contact', $fields, $condition, $params);
125         }
126
127         /**
128          * @param array $fields    Array of selected fields, empty for all
129          * @param array $condition Array of fields for condition
130          * @param array $params    Array of several parameters
131          * @return array|bool
132          * @throws \Exception
133          */
134         public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
135         {
136                 $contact = DBA::selectFirst('contact', $fields, $condition, $params);
137
138                 return $contact;
139         }
140
141         /**
142          * Insert a row into the contact table
143          * Important: You can't use DBA::lastInsertId() after this call since it will be set to 0.
144          *
145          * @param array $fields         field array
146          * @param int   $duplicate_mode Do an update on a duplicate entry
147          *
148          * @return int  id of the created contact
149          * @throws \Exception
150          */
151         public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT): int
152         {
153                 if (!empty($fields['baseurl']) && empty($fields['gsid'])) {
154                         $fields['gsid'] = GServer::getID($fields['baseurl'], true);
155                 }
156
157                 $fields['uri-id'] = ItemURI::getIdByURI($fields['url']);
158
159                 if (empty($fields['created'])) {
160                         $fields['created'] = DateTimeFormat::utcNow();
161                 }
162
163                 DBA::insert('contact', $fields, $duplicate_mode);
164                 $contact = DBA::selectFirst('contact', [], ['id' => DBA::lastInsertId()]);
165                 if (!DBA::isResult($contact)) {
166                         // Shouldn't happen
167                         Logger::warning('Created contact could not be found', ['fields' => $fields]);
168                         return 0;
169                 }
170
171                 Contact\User::insertForContactArray($contact);
172
173                 // Search for duplicated contacts and get rid of them
174                 if (!$contact['self']) {
175                         self::removeDuplicates($contact['nurl'], $contact['uid']);
176                 }
177
178                 return $contact['id'];
179         }
180
181         /**
182          * Updates rows in the contact table
183          *
184          * @param array         $fields     contains the fields that are updated
185          * @param array         $condition  condition array with the key values
186          * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate, false = don't update identical fields)
187          *
188          * @return boolean was the update successfull?
189          * @throws \Exception
190          * @todo Let's get rid of boolean type of $old_fields
191          */
192         public static function update(array $fields, array $condition, $old_fields = [])
193         {
194                 $ret = DBA::update('contact', $fields, $condition, $old_fields);
195
196                 // Apply changes to the "user-contact" table on dedicated fields
197                 Contact\User::updateByContactUpdate($fields, $condition);
198
199                 return $ret;
200         }
201
202         /**
203          * @param integer $id     Contact ID
204          * @param array   $fields Array of selected fields, empty for all
205          * @return array|boolean Contact record if it exists, false otherwise
206          * @throws \Exception
207          */
208         public static function getById(int $id, array $fields = [])
209         {
210                 return DBA::selectFirst('contact', $fields, ['id' => $id]);
211         }
212
213         /**
214          * Fetch the first contact with the provided uri-id.
215          *
216          * @param integer $uri_id uri-id of the contact
217          * @param array   $fields Array of selected fields, empty for all
218          * @return array|boolean Contact record if it exists, false otherwise
219          * @throws \Exception
220          */
221         public static function getByUriId(int $uri_id, array $fields = [])
222         {
223                 return DBA::selectFirst('contact', $fields, ['uri-id' => $uri_id], ['order' => ['uid']]);
224         }
225
226         /**
227          * Fetches a contact by a given url
228          *
229          * @param string  $url    profile url
230          * @param boolean $update true = always update, false = never update, null = update when not found or outdated
231          * @param array   $fields Field list
232          * @param integer $uid    User ID of the contact
233          * @return array contact array
234          */
235         public static function getByURL(string $url, $update = null, array $fields = [], int $uid = 0): array
236         {
237                 if ($update || is_null($update)) {
238                         $cid = self::getIdForURL($url, $uid, $update);
239                         if (empty($cid)) {
240                                 return [];
241                         }
242
243                         $contact = self::getById($cid, $fields);
244                         if (empty($contact)) {
245                                 return [];
246                         }
247                         return $contact;
248                 }
249
250                 // Add internal fields
251                 $removal = [];
252                 if (!empty($fields)) {
253                         foreach (['id', 'avatar', 'created', 'updated', 'last-update', 'success_update', 'failure_update', 'network'] as $internal) {
254                                 if (!in_array($internal, $fields)) {
255                                         $fields[] = $internal;
256                                         $removal[] = $internal;
257                                 }
258                         }
259                 }
260
261                 // We first try the nurl (http://server.tld/nick), most common case
262                 $options = ['order' => ['id']];
263                 $contact = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url), 'uid' => $uid, 'deleted' => false], $options);
264
265                 // Then the addr (nick@server.tld)
266                 if (!DBA::isResult($contact)) {
267                         $contact = DBA::selectFirst('contact', $fields, ['addr' => str_replace('acct:', '', $url), 'uid' => $uid, 'deleted' => false], $options);
268                 }
269
270                 // Then the alias (which could be anything)
271                 if (!DBA::isResult($contact)) {
272                         // The link could be provided as http although we stored it as https
273                         $ssl_url = str_replace('http://', 'https://', $url);
274                         $condition = ['`alias` IN (?, ?, ?) AND `uid` = ? AND NOT `deleted`', $url, Strings::normaliseLink($url), $ssl_url, $uid];
275                         $contact = DBA::selectFirst('contact', $fields, $condition, $options);
276                 }
277
278                 if (!DBA::isResult($contact)) {
279                         return [];
280                 }
281
282                 // Update the contact in the background if needed
283                 $updated = max($contact['success_update'], $contact['created'], $contact['updated'], $contact['last-update'], $contact['failure_update']);
284                 if (($updated < DateTimeFormat::utc('now -7 days')) && in_array($contact['network'], Protocol::FEDERATED) && !self::isLocalById($contact['id'])) {
285                         Worker::add(PRIORITY_LOW, "UpdateContact", $contact['id']);
286                 }
287
288                 // Remove the internal fields
289                 foreach ($removal as $internal) {
290                         unset($contact[$internal]);
291                 }
292
293                 return $contact;
294         }
295
296         /**
297          * Fetches a contact for a given user by a given url.
298          * In difference to "getByURL" the function will fetch a public contact when no user contact had been found.
299          *
300          * @param string  $url    profile url
301          * @param integer $uid    User ID of the contact
302          * @param boolean $update true = always update, false = never update, null = update when not found or outdated
303          * @param array   $fields Field list
304          * @return array contact array
305          */
306         public static function getByURLForUser(string $url, int $uid = 0, $update = false, array $fields = []): array
307         {
308                 if ($uid != 0) {
309                         $contact = self::getByURL($url, $update, $fields, $uid);
310                         if (!empty($contact)) {
311                                 if (!empty($contact['id'])) {
312                                         $contact['cid'] = $contact['id'];
313                                         $contact['zid'] = 0;
314                                 }
315                                 return $contact;
316                         }
317                 }
318
319                 $contact = self::getByURL($url, $update, $fields);
320                 if (!empty($contact['id'])) {
321                         $contact['cid'] = 0;
322                         $contact['zid'] = $contact['id'];
323                 }
324                 return $contact;
325         }
326
327         /**
328          * Tests if the given contact is a follower
329          *
330          * @param int $cid Either public contact id or user's contact id
331          * @param int $uid User ID
332          *
333          * @return boolean is the contact id a follower?
334          * @throws HTTPException\InternalServerErrorException
335          * @throws \ImagickException
336          */
337         public static function isFollower(int $cid, int $uid): bool
338         {
339                 if (Contact\User::isBlocked($cid, $uid)) {
340                         return false;
341                 }
342
343                 $cdata = self::getPublicAndUserContactID($cid, $uid);
344                 if (empty($cdata['user'])) {
345                         return false;
346                 }
347
348                 $condition = ['id' => $cdata['user'], 'rel' => [self::FOLLOWER, self::FRIEND]];
349                 return DBA::exists('contact', $condition);
350         }
351
352         /**
353          * Tests if the given contact url is a follower
354          *
355          * @param string $url Contact URL
356          * @param int    $uid User ID
357          *
358          * @return boolean is the contact id a follower?
359          * @throws HTTPException\InternalServerErrorException
360          * @throws \ImagickException
361          */
362         public static function isFollowerByURL(string $url, int $uid): bool
363         {
364                 $cid = self::getIdForURL($url, $uid);
365
366                 if (empty($cid)) {
367                         return false;
368                 }
369
370                 return self::isFollower($cid, $uid);
371         }
372
373         /**
374          * Tests if the given user shares with the given contact
375          *
376          * @param int $cid Either public contact id or user's contact id
377          * @param int $uid User ID
378          *
379          * @return boolean is the contact sharing with given user?
380          * @throws HTTPException\InternalServerErrorException
381          * @throws \ImagickException
382          */
383         public static function isSharing(int $cid, int $uid): bool
384         {
385                 if (Contact\User::isBlocked($cid, $uid)) {
386                         return false;
387                 }
388
389                 $cdata = self::getPublicAndUserContactID($cid, $uid);
390                 if (empty($cdata['user'])) {
391                         return false;
392                 }
393
394                 $condition = ['id' => $cdata['user'], 'rel' => [self::SHARING, self::FRIEND]];
395                 return DBA::exists('contact', $condition);
396         }
397
398         /**
399          * Tests if the given user follow the given contact url
400          *
401          * @param string $url Contact URL
402          * @param int    $uid User ID
403          *
404          * @return boolean is the contact url being followed?
405          * @throws HTTPException\InternalServerErrorException
406          * @throws \ImagickException
407          */
408         public static function isSharingByURL(string $url, int $uid): bool
409         {
410                 $cid = self::getIdForURL($url, $uid);
411
412                 if (empty($cid)) {
413                         return false;
414                 }
415
416                 return self::isSharing($cid, $uid);
417         }
418
419         /**
420          * Get the basepath for a given contact link
421          *
422          * @param string $url The contact link
423          * @param boolean $dont_update Don't update the contact
424          *
425          * @return string basepath
426          * @throws HTTPException\InternalServerErrorException
427          * @throws \ImagickException
428          */
429         public static function getBasepath(string $url, bool $dont_update = false): string
430         {
431                 $contact = DBA::selectFirst('contact', ['id', 'baseurl'], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
432                 if (!DBA::isResult($contact)) {
433                         return '';
434                 }
435
436                 if (!empty($contact['baseurl'])) {
437                         return $contact['baseurl'];
438                 } elseif ($dont_update) {
439                         return '';
440                 }
441
442                 // Update the existing contact
443                 self::updateFromProbe($contact['id']);
444
445                 // And fetch the result
446                 $contact = DBA::selectFirst('contact', ['baseurl'], ['id' => $contact['id']]);
447                 if (empty($contact['baseurl'])) {
448                         Logger::info('No baseurl for contact', ['url' => $url]);
449                         return '';
450                 }
451
452                 Logger::info('Found baseurl for contact', ['url' => $url, 'baseurl' => $contact['baseurl']]);
453                 return $contact['baseurl'];
454         }
455
456         /**
457          * Check if the given contact url is on the same server
458          *
459          * @param string $url The contact link
460          *
461          * @return boolean Is it the same server?
462          */
463         public static function isLocal(string $url): bool
464         {
465                 if (!parse_url($url, PHP_URL_SCHEME)) {
466                         $addr_parts = explode('@', $url);
467                         return (count($addr_parts) == 2) && ($addr_parts[1] == DI::baseUrl()->getHostname());
468                 }
469
470                 return Strings::compareLink(self::getBasepath($url, true), DI::baseUrl());
471         }
472
473         /**
474          * Check if the given contact ID is on the same server
475          *
476          * @param string $url The contact link
477          * @return boolean Is it the same server?
478          */
479         public static function isLocalById(int $cid): bool
480         {
481                 $contact = DBA::selectFirst('contact', ['url', 'baseurl'], ['id' => $cid]);
482                 if (!DBA::isResult($contact)) {
483                         return false;
484                 }
485
486                 if (empty($contact['baseurl'])) {
487                         $baseurl = self::getBasepath($contact['url'], true);
488                 } else {
489                         $baseurl = $contact['baseurl'];
490                 }
491
492                 return Strings::compareLink($baseurl, DI::baseUrl());
493         }
494
495         /**
496          * Returns the public contact id of the given user id
497          *
498          * @param  integer $uid User ID
499          *
500          * @return integer|boolean Public contact id for given user id
501          * @throws \Exception
502          */
503         public static function getPublicIdByUserId(int $uid)
504         {
505                 $self = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
506                 if (!DBA::isResult($self)) {
507                         return false;
508                 }
509                 return self::getIdForURL($self['url']);
510         }
511
512         /**
513          * Returns the contact id for the user and the public contact id for a given contact id
514          *
515          * @param int $cid Either public contact id or user's contact id
516          * @param int $uid User ID
517          *
518          * @return array with public and user's contact id
519          * @throws HTTPException\InternalServerErrorException
520          * @throws \ImagickException
521          */
522         public static function getPublicAndUserContactID(int $cid, int $uid): array
523         {
524                 // We have to use the legacy function as long as the post update hasn't finished
525                 if (DI::config()->get('system', 'post_update_version') < 1427) {
526                         return self::legacyGetPublicAndUserContactID($cid, $uid);
527                 }
528
529                 if (empty($uid) || empty($cid)) {
530                         return [];
531                 }
532
533                 $contact = DBA::selectFirst('account-user-view', ['id', 'uid', 'pid'], ['id' => $cid]);
534                 if (!DBA::isResult($contact) || !in_array($contact['uid'], [0, $uid])) {
535                         return [];
536                 }
537
538                 $pcid = $contact['pid'];
539                 if ($contact['uid'] == $uid) {
540                         $ucid = $contact['id'];
541                 } else {
542                         $contact = DBA::selectFirst('account-user-view', ['id', 'uid'], ['pid' => $cid, 'uid' => $uid]);
543                         if (DBA::isResult($contact)) {
544                                 $ucid = $contact['id'];
545                         } else {
546                                 $ucid = 0;
547                         }
548                 }
549
550                 return ['public' => $pcid, 'user' => $ucid];
551         }
552
553         /**
554          * Helper function for "getPublicAndUserContactID"
555          *
556          * @param int $cid Either public contact id or user's contact id
557          * @param int $uid User ID
558          * @return array with public and user's contact id
559          * @throws HTTPException\InternalServerErrorException
560          * @throws \ImagickException
561          */
562         private static function legacyGetPublicAndUserContactID(int $cid, int $uid): array
563         {
564                 if (empty($uid) || empty($cid)) {
565                         return [];
566                 }
567
568                 $contact = DBA::selectFirst('contact', ['id', 'uid', 'url'], ['id' => $cid]);
569                 if (!DBA::isResult($contact)) {
570                         return [];
571                 }
572
573                 // We quit when the user id don't match the user id of the provided contact
574                 if (($contact['uid'] != $uid) && ($contact['uid'] != 0)) {
575                         return [];
576                 }
577
578                 if ($contact['uid'] != 0) {
579                         $pcid = self::getIdForURL($contact['url'], 0, false, ['url' => $contact['url']]);
580                         if (empty($pcid)) {
581                                 return [];
582                         }
583                         $ucid = $contact['id'];
584                 } else {
585                         $pcid = $contact['id'];
586                         $ucid = self::getIdForURL($contact['url'], $uid);
587                 }
588
589                 return ['public' => $pcid, 'user' => $ucid];
590         }
591
592         /**
593          * Returns contact details for a given contact id in combination with a user id
594          *
595          * @param int $cid A contact ID
596          * @param int $uid The User ID
597          * @param array $fields The selected fields for the contact
598          * @return array The contact details
599          *
600          * @throws \Exception
601          */
602         public static function getContactForUser(int $cid, int $uid, array $fields = []): array
603         {
604                 $contact = DBA::selectFirst('contact', $fields, ['id' => $cid, 'uid' => $uid]);
605
606                 if (!DBA::isResult($contact)) {
607                         return [];
608                 } else {
609                         return $contact;
610                 }
611         }
612
613         /**
614          * Creates the self-contact for the provided user id
615          *
616          * @param int $uid
617          * @return bool Operation success
618          * @throws HTTPException\InternalServerErrorException
619          */
620         public static function createSelfFromUserId(int $uid): bool
621         {
622                 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname', 'pubkey', 'prvkey'],
623                         ['uid' => $uid, 'account_expired' => false]);
624                 if (!DBA::isResult($user)) {
625                         return false;
626                 }
627
628                 $contact = [
629                         'uid'         => $user['uid'],
630                         'created'     => DateTimeFormat::utcNow(),
631                         'self'        => 1,
632                         'name'        => $user['username'],
633                         'nick'        => $user['nickname'],
634                         'pubkey'      => $user['pubkey'],
635                         'prvkey'      => $user['prvkey'],
636                         'photo'       => User::getAvatarUrl($user),
637                         'thumb'       => User::getAvatarUrl($user, Proxy::SIZE_THUMB),
638                         'micro'       => User::getAvatarUrl($user, Proxy::SIZE_MICRO),
639                         'blocked'     => 0,
640                         'pending'     => 0,
641                         'url'         => DI::baseUrl() . '/profile/' . $user['nickname'],
642                         'nurl'        => Strings::normaliseLink(DI::baseUrl() . '/profile/' . $user['nickname']),
643                         'addr'        => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
644                         'request'     => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
645                         'notify'      => DI::baseUrl() . '/dfrn_notify/'  . $user['nickname'],
646                         'poll'        => DI::baseUrl() . '/dfrn_poll/'    . $user['nickname'],
647                         'confirm'     => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
648                         'poco'        => DI::baseUrl() . '/poco/'         . $user['nickname'],
649                         'name-date'   => DateTimeFormat::utcNow(),
650                         'uri-date'    => DateTimeFormat::utcNow(),
651                         'avatar-date' => DateTimeFormat::utcNow(),
652                         'closeness'   => 0
653                 ];
654
655                 $return = true;
656
657                 // Only create the entry if it doesn't exist yet
658                 if (!DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
659                         $return = (bool)self::insert($contact);
660                 }
661
662                 // Create the public contact
663                 if (!DBA::exists('contact', ['nurl' => $contact['nurl'], 'uid' => 0])) {
664                         $contact['self']   = false;
665                         $contact['uid']    = 0;
666                         $contact['prvkey'] = null;
667
668                         self::insert($contact, Database::INSERT_IGNORE);
669                 }
670
671                 return $return;
672         }
673
674         /**
675          * Updates the self-contact for the provided user id
676          *
677          * @param int   $uid
678          * @param bool  $update_avatar Force the avatar update
679          * @return bool "true" if updated
680          * @throws HTTPException\InternalServerErrorException
681          */
682         public static function updateSelfFromUserID(int $uid, bool $update_avatar = false): bool
683         {
684                 $fields = ['id', 'uri-id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey', 'manually-approve',
685                         'xmpp', 'matrix', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
686                         'photo', 'thumb', 'micro', 'header', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco', 'network'];
687                 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
688                 if (!DBA::isResult($self)) {
689                         return false;
690                 }
691
692                 $fields = ['uid', 'nickname', 'page-flags', 'account-type', 'prvkey', 'pubkey'];
693                 $user = DBA::selectFirst('user', $fields, ['uid' => $uid, 'account_expired' => false]);
694                 if (!DBA::isResult($user)) {
695                         return false;
696                 }
697
698                 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
699                         'country-name', 'pub_keywords', 'xmpp', 'matrix', 'net-publish'];
700                 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid]);
701                 if (!DBA::isResult($profile)) {
702                         return false;
703                 }
704
705                 $file_suffix = 'jpg';
706
707                 $fields = ['name' => $profile['name'], 'nick' => $user['nickname'],
708                         'avatar-date' => $self['avatar-date'], 'location' => Profile::formatLocation($profile),
709                         'about' => $profile['about'], 'keywords' => $profile['pub_keywords'],
710                         'contact-type' => $user['account-type'], 'prvkey' => $user['prvkey'],
711                         'pubkey' => $user['pubkey'], 'xmpp' => $profile['xmpp'], 'matrix' => $profile['matrix'], 'network' => Protocol::DFRN];
712
713                 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
714                 $fields['url'] = DI::baseUrl() . '/profile/' . $user['nickname'];
715                 $fields['nurl'] = Strings::normaliseLink($fields['url']);
716                 $fields['uri-id'] = ItemURI::getIdByURI($fields['url']);
717                 $fields['addr'] = $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
718                 $fields['request'] = DI::baseUrl() . '/dfrn_request/' . $user['nickname'];
719                 $fields['notify'] = DI::baseUrl() . '/dfrn_notify/' . $user['nickname'];
720                 $fields['poll'] = DI::baseUrl() . '/dfrn_poll/'. $user['nickname'];
721                 $fields['confirm'] = DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'];
722                 $fields['poco'] = DI::baseUrl() . '/poco/' . $user['nickname'];
723
724                 $avatar = Photo::selectFirst(['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
725                 if (DBA::isResult($avatar)) {
726                         if ($update_avatar) {
727                                 $fields['avatar-date'] = DateTimeFormat::utcNow();
728                         }
729
730                         // Creating the path to the avatar, beginning with the file suffix
731                         $types = Images::supportedTypes();
732                         if (isset($types[$avatar['type']])) {
733                                 $file_suffix = $types[$avatar['type']];
734                         }
735
736                         // We are adding a timestamp value so that other systems won't use cached content
737                         $timestamp = strtotime($fields['avatar-date']);
738
739                         $prefix = DI::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
740                         $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
741
742                         $fields['photo'] = $prefix . '4' . $suffix;
743                         $fields['thumb'] = $prefix . '5' . $suffix;
744                         $fields['micro'] = $prefix . '6' . $suffix;
745                 } else {
746                         // We hadn't found a photo entry, so we use the default avatar
747                         $fields['photo'] = self::getDefaultAvatar($fields, Proxy::SIZE_SMALL);
748                         $fields['thumb'] = self::getDefaultAvatar($fields, Proxy::SIZE_THUMB);
749                         $fields['micro'] = self::getDefaultAvatar($fields, Proxy::SIZE_MICRO);
750                 }
751
752                 $fields['avatar'] = User::getAvatarUrl($user);
753                 $fields['header'] = User::getBannerUrl($user);
754                 $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
755                 $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
756                 $fields['unsearchable'] = !$profile['net-publish'];
757                 $fields['manually-approve'] = in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL, User::PAGE_FLAGS_PRVGROUP]);
758
759                 $update = false;
760
761                 foreach ($fields as $field => $content) {
762                         if ($self[$field] != $content) {
763                                 $update = true;
764                         }
765                 }
766
767                 if ($update) {
768                         if ($fields['name'] != $self['name']) {
769                                 $fields['name-date'] = DateTimeFormat::utcNow();
770                         }
771                         $fields['updated'] = DateTimeFormat::utcNow();
772                         self::update($fields, ['id' => $self['id']]);
773
774                         // Update the other contacts as well
775                         unset($fields['prvkey']);
776                         $fields['self'] = false;
777                         self::update($fields, ['uri-id' => $self['uri-id'], 'self' => false]);
778
779                         // Update the profile
780                         $fields = [
781                                 'photo' => User::getAvatarUrl($user),
782                                 'thumb' => User::getAvatarUrl($user, Proxy::SIZE_THUMB)
783                         ];
784
785                         DBA::update('profile', $fields, ['uid' => $uid]);
786                 }
787
788                 return $update;
789         }
790
791         /**
792          * Marks a contact for removal
793          *
794          * @param int $id contact id
795          * @return void
796          * @throws HTTPException\InternalServerErrorException
797          */
798         public static function remove(int $id)
799         {
800                 // We want just to make sure that we don't delete our "self" contact
801                 $contact = DBA::selectFirst('contact', ['uri-id', 'photo', 'thumb', 'micro', 'uid'], ['id' => $id, 'self' => false]);
802                 if (!DBA::isResult($contact)) {
803                         return;
804                 }
805
806                 self::clearFollowerFollowingEndpointCache($contact['uid']);
807
808                 // Archive the contact
809                 self::update(['archive' => true, 'network' => Protocol::PHANTOM, 'deleted' => true], ['id' => $id]);
810
811                 if (!DBA::exists('contact', ['uri-id' => $contact['uri-id'], 'deleted' => false])) {
812                         Avatar::deleteCache($contact);
813                 }
814
815                 // Delete it in the background
816                 Worker::add(PRIORITY_MEDIUM, 'Contact\Remove', $id);
817         }
818
819         /**
820          * Unfollow the remote contact
821          *
822          * @param array $contact Target user-specific contact (uid != 0) array
823          * @return void
824          * @throws HTTPException\InternalServerErrorException
825          * @throws \ImagickException
826          */
827         public static function unfollow(array $contact): void
828         {
829                 if (empty($contact['network'])) {
830                         throw new \InvalidArgumentException('Empty network in contact array');
831                 }
832
833                 if (empty($contact['uid'])) {
834                         throw new \InvalidArgumentException('Unexpected public contact record');
835                 }
836
837                 if (in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
838                         $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
839                         if (!empty($cdata['public'])) {
840                                 Worker::add(PRIORITY_HIGH, 'Contact\Unfollow', $cdata['public'], $contact['uid']);
841                         }
842                 }
843
844                 self::removeSharer($contact);
845         }
846
847         /**
848          * Revoke follow privileges of the remote user contact
849          *
850          * The local relationship is updated immediately, the eventual remote server is messaged in the background.
851          *
852          * @param array $contact User-specific contact array (uid != 0) to revoke the follow from
853          * @return void
854          * @throws HTTPException\InternalServerErrorException
855          * @throws \ImagickException
856          */
857         public static function revokeFollow(array $contact): void
858         {
859                 if (empty($contact['network'])) {
860                         throw new \InvalidArgumentException('Empty network in contact array');
861                 }
862
863                 if (empty($contact['uid'])) {
864                         throw new \InvalidArgumentException('Unexpected public contact record');
865                 }
866
867                 if (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND])) {
868                         $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
869                         if (!empty($cdata['public'])) {
870                                 Worker::add(PRIORITY_HIGH, 'Contact\RevokeFollow', $cdata['public'], $contact['uid']);
871                         }
872                 }
873
874                 self::removeFollower($contact);
875         }
876
877         /**
878          * Completely severs a relationship with a contact
879          *
880          * @param array $contact User-specific contact (uid != 0) array
881          * @return void
882          * @throws HTTPException\InternalServerErrorException
883          * @throws \ImagickException
884          */
885         public static function terminateFriendship(array $contact)
886         {
887                 if (empty($contact['network'])) {
888                         throw new \InvalidArgumentException('Empty network in contact array');
889                 }
890
891                 if (empty($contact['uid'])) {
892                         throw new \InvalidArgumentException('Unexpected public contact record');
893                 }
894
895                 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
896
897                 if (in_array($contact['rel'], [self::SHARING, self::FRIEND]) && !empty($cdata['public'])) {
898                         Worker::add(PRIORITY_HIGH, 'Contact\Unfollow', $cdata['public'], $contact['uid']);
899                 }
900
901                 if (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) && !empty($cdata['public'])) {
902                         Worker::add(PRIORITY_HIGH, 'Contact\RevokeFollow', $cdata['public'], $contact['uid']);
903                 }
904
905                 self::remove($contact['id']);
906         }
907
908         private static function clearFollowerFollowingEndpointCache(int $uid)
909         {
910                 if (empty($uid)) {
911                         return;
912                 }
913
914                 DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_CONTACTS . 'followers:' . $uid);
915                 DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_CONTACTS . 'following:' . $uid);
916                 DI::cache()->delete(NoScrape::CACHEKEY . $uid);
917         }
918
919         /**
920          * Marks a contact for archival after a communication issue delay
921          *
922          * Contact has refused to recognise us as a friend. We will start a countdown.
923          * If they still don't recognise us in 32 days, the relationship is over,
924          * and we won't waste any more time trying to communicate with them.
925          * This provides for the possibility that their database is temporarily messed
926          * up or some other transient event and that there's a possibility we could recover from it.
927          *
928          * @param array $contact contact to mark for archival
929          * @return void
930          * @throws HTTPException\InternalServerErrorException
931          */
932         public static function markForArchival(array $contact)
933         {
934                 if (!isset($contact['url']) && !empty($contact['id'])) {
935                         $fields = ['id', 'url', 'archive', 'self', 'term-date'];
936                         $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
937                         if (!DBA::isResult($contact)) {
938                                 return;
939                         }
940                 } elseif (!isset($contact['url'])) {
941                         Logger::info('Empty contact', ['contact' => $contact, 'callstack' => System::callstack(20)]);
942                 }
943
944                 Logger::info('Contact is marked for archival', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
945
946                 // Contact already archived or "self" contact? => nothing to do
947                 if ($contact['archive'] || $contact['self']) {
948                         return;
949                 }
950
951                 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
952                         self::update(['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
953                         self::update(['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
954                 } else {
955                         /* @todo
956                          * We really should send a notification to the owner after 2-3 weeks
957                          * so they won't be surprised when the contact vanishes and can take
958                          * remedial action if this was a serious mistake or glitch
959                          */
960
961                         /// @todo Check for contact vitality via probing
962                         $archival_days = DI::config()->get('system', 'archival_days', 32);
963
964                         $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
965                         if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
966                                 /* Relationship is really truly dead. archive them rather than
967                                  * delete, though if the owner tries to unarchive them we'll start
968                                  * the whole process over again.
969                                  */
970                                 self::update(['archive' => true], ['id' => $contact['id']]);
971                                 self::update(['archive' => true], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
972                         }
973                 }
974         }
975
976         /**
977          * Cancels the archival countdown
978          *
979          * @see   Contact::markForArchival()
980          *
981          * @param array $contact contact to be unmarked for archival
982          * @return void
983          * @throws \Exception
984          */
985         public static function unmarkForArchival(array $contact)
986         {
987                 // Always unarchive the relay contact entry
988                 if (!empty($contact['batch']) && !empty($contact['term-date']) && ($contact['term-date'] > DBA::NULL_DATETIME)) {
989                         $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
990                         $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
991                         if (!DBA::exists('contact', array_merge($condition, $fields))) {
992                                 self::update($fields, $condition);
993                         }
994                 }
995
996                 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
997                 $exists = DBA::exists('contact', $condition);
998
999                 // We don't need to update, we never marked this contact for archival
1000                 if (!$exists) {
1001                         return;
1002                 }
1003
1004                 Logger::info('Contact is marked as vital again', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
1005
1006                 if (!isset($contact['url']) && !empty($contact['id'])) {
1007                         $fields = ['id', 'url', 'batch'];
1008                         $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
1009                         if (!DBA::isResult($contact)) {
1010                                 return;
1011                         }
1012                 }
1013
1014                 // It's a miracle. Our dead contact has inexplicably come back to life.
1015                 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
1016                 self::update($fields, ['id' => $contact['id']]);
1017                 self::update($fields, ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
1018         }
1019
1020         /**
1021          * Returns the data array for the photo menu of a given contact
1022          *
1023          * @param array $contact contact
1024          * @param int   $uid     optional, default 0
1025          * @return array
1026          * @throws HTTPException\InternalServerErrorException
1027          * @throws \ImagickException
1028          */
1029         public static function photoMenu(array $contact, int $uid = 0): array
1030         {
1031                 $pm_url = '';
1032                 $status_link = '';
1033                 $photos_link = '';
1034                 $poke_link = '';
1035
1036                 if ($uid == 0) {
1037                         $uid = local_user();
1038                 }
1039
1040                 if (empty($contact['uid']) || ($contact['uid'] != $uid)) {
1041                         if ($uid == 0) {
1042                                 $profile_link = self::magicLinkByContact($contact);
1043                                 $menu = ['profile' => [DI::l10n()->t('View Profile'), $profile_link, true]];
1044
1045                                 return $menu;
1046                         }
1047
1048                         // Look for our own contact if the uid doesn't match and isn't public
1049                         $contact_own = DBA::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
1050                         if (DBA::isResult($contact_own)) {
1051                                 return self::photoMenu($contact_own, $uid);
1052                         }
1053                 }
1054
1055                 $sparkle = false;
1056                 if (($contact['network'] === Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1057                         $sparkle = true;
1058                         $profile_link = DI::baseUrl() . '/redir/' . $contact['id'];
1059                 } else {
1060                         $profile_link = $contact['url'];
1061                 }
1062
1063                 if ($profile_link === 'mailbox') {
1064                         $profile_link = '';
1065                 }
1066
1067                 if ($sparkle) {
1068                         $status_link = $profile_link . '/status';
1069                         $photos_link = str_replace('/profile/', '/photos/', $profile_link);
1070                         $profile_link = $profile_link . '/profile';
1071                 }
1072
1073                 if (self::canReceivePrivateMessages($contact) && empty($contact['pending'])) {
1074                         $pm_url = DI::baseUrl() . '/message/new/' . $contact['id'];
1075                 }
1076
1077                 if (($contact['network'] == Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1078                         $poke_link = 'contact/' . $contact['id'] . '/poke';
1079                 }
1080
1081                 $contact_url = DI::baseUrl() . '/contact/' . $contact['id'];
1082
1083                 $posts_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/conversations';
1084
1085                 $follow_link = '';
1086                 $unfollow_link = '';
1087                 if (!$contact['self'] && Protocol::supportsFollow($contact['network'])) {
1088                         if ($contact['uid'] && in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
1089                                 $unfollow_link = 'unfollow?url=' . urlencode($contact['url']) . '&auto=1';
1090                         } elseif(!$contact['pending']) {
1091                                 $follow_link = 'follow?url=' . urlencode($contact['url']) . '&auto=1';
1092                         }
1093                 }
1094
1095                 /**
1096                  * Menu array:
1097                  * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
1098                  */
1099                 if (empty($contact['uid'])) {
1100                         $menu = [
1101                                 'profile' => [DI::l10n()->t('View Profile')  , $profile_link , true],
1102                                 'network' => [DI::l10n()->t('Network Posts') , $posts_link   , false],
1103                                 'edit'    => [DI::l10n()->t('View Contact')  , $contact_url  , false],
1104                                 'follow'  => [DI::l10n()->t('Connect/Follow'), $follow_link  , true],
1105                                 'unfollow'=> [DI::l10n()->t('UnFollow')      , $unfollow_link, true],
1106                         ];
1107                 } else {
1108                         $menu = [
1109                                 'status'  => [DI::l10n()->t('View Status')   , $status_link      , true],
1110                                 'profile' => [DI::l10n()->t('View Profile')  , $profile_link     , true],
1111                                 'photos'  => [DI::l10n()->t('View Photos')   , $photos_link      , true],
1112                                 'network' => [DI::l10n()->t('Network Posts') , $posts_link       , false],
1113                                 'edit'    => [DI::l10n()->t('View Contact')  , $contact_url      , false],
1114                                 'pm'      => [DI::l10n()->t('Send PM')       , $pm_url           , false],
1115                                 'poke'    => [DI::l10n()->t('Poke')          , $poke_link        , false],
1116                                 'follow'  => [DI::l10n()->t('Connect/Follow'), $follow_link      , true],
1117                                 'unfollow'=> [DI::l10n()->t('UnFollow')      , $unfollow_link    , true],
1118                         ];
1119
1120                         if (!empty($contact['pending'])) {
1121                                 try {
1122                                         $intro = DI::intro()->selectForContact($contact['id']);
1123                                         $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro->id, true];
1124                                 } catch (IntroductionNotFoundException $exception) {
1125                                         DI::logger()->error('Pending contact doesn\'t have an introduction.', ['exception' => $exception]);
1126                                 }
1127                         }
1128                 }
1129
1130                 $args = ['contact' => $contact, 'menu' => &$menu];
1131
1132                 Hook::callAll('contact_photo_menu', $args);
1133
1134                 $menucondensed = [];
1135
1136                 foreach ($menu as $menuname => $menuitem) {
1137                         if ($menuitem[1] != '') {
1138                                 $menucondensed[$menuname] = $menuitem;
1139                         }
1140                 }
1141
1142                 return $menucondensed;
1143         }
1144
1145         /**
1146          * Fetch the contact id for a given URL and user
1147          *
1148          * First lookup in the contact table to find a record matching either `url`, `nurl`,
1149          * `addr` or `alias`.
1150          *
1151          * If there's no record and we aren't looking for a public contact, we quit.
1152          * If there's one, we check that it isn't time to update the picture else we
1153          * directly return the found contact id.
1154          *
1155          * Second, we probe the provided $url whether it's http://server.tld/profile or
1156          * nick@server.tld. We quit if we can't get any info back.
1157          *
1158          * Third, we create the contact record if it doesn't exist
1159          *
1160          * Fourth, we update the existing record with the new data (avatar, alias, nick)
1161          * if there's any updates
1162          *
1163          * @param string  $url       Contact URL
1164          * @param integer $uid       The user id for the contact (0 = public contact)
1165          * @param boolean $update    true = always update, false = never update, null = update when not found
1166          * @param array   $default   Default value for creating the contact when everything else fails
1167          *
1168          * @return integer Contact ID
1169          * @throws HTTPException\InternalServerErrorException
1170          * @throws \ImagickException
1171          */
1172         public static function getIdForURL(string $url = null, int $uid = 0, $update = null, array $default = []): int
1173         {
1174                 $contact_id = 0;
1175
1176                 if (empty($url)) {
1177                         Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
1178                         return 0;
1179                 }
1180
1181                 $contact = self::getByURL($url, false, ['id', 'network', 'uri-id'], $uid);
1182
1183                 if (!empty($contact)) {
1184                         $contact_id = $contact['id'];
1185
1186                         if (empty($update) && (!empty($contact['uri-id']) || is_bool($update))) {
1187                                 Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1188                                 return $contact_id;
1189                         }
1190                 } elseif ($uid != 0) {
1191                         Logger::debug('Contact does not exist for the user', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1192                         return 0;
1193                 } elseif (empty($default) && !is_null($update) && !$update) {
1194                         Logger::info('Contact not found, update not desired', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1195                         return 0;
1196                 }
1197
1198                 $data = [];
1199
1200                 if (empty($default['network']) || $update) {
1201                         $data = Probe::uri($url, '', $uid);
1202
1203                         // Take the default values when probing failed
1204                         if (!empty($default) && !in_array($data['network'], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1205                                 $data = array_merge($data, $default);
1206                         }
1207                 } elseif (!empty($default['network'])) {
1208                         $data = $default;
1209                 }
1210
1211                 if (($uid == 0) && (empty($data['network']) || ($data['network'] == Protocol::PHANTOM))) {
1212                         // Fetch data for the public contact via the first found personal contact
1213                         /// @todo Check if this case can happen at all (possibly with mail accounts?)
1214                         $fields = ['name', 'nick', 'url', 'addr', 'alias', 'avatar', 'header', 'contact-type',
1215                                 'keywords', 'location', 'about', 'unsearchable', 'batch', 'notify', 'poll',
1216                                 'request', 'confirm', 'poco', 'subscribe', 'network', 'baseurl', 'gsid'];
1217
1218                         $personal_contact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `uid` != 0", $url]);
1219                         if (!DBA::isResult($personal_contact)) {
1220                                 $personal_contact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `uid` != 0", Strings::normaliseLink($url)]);
1221                         }
1222
1223                         if (DBA::isResult($personal_contact)) {
1224                                 Logger::info('Take contact data from personal contact', ['url' => $url, 'update' => $update, 'contact' => $personal_contact, 'callstack' => System::callstack(20)]);
1225                                 $data = $personal_contact;
1226                                 $data['photo'] = $personal_contact['avatar'];
1227                                 $data['account-type'] = $personal_contact['contact-type'];
1228                                 $data['hide'] = $personal_contact['unsearchable'];
1229                                 unset($data['avatar']);
1230                                 unset($data['contact-type']);
1231                                 unset($data['unsearchable']);
1232                         }
1233                 }
1234
1235                 if (empty($data['network']) || ($data['network'] == Protocol::PHANTOM)) {
1236                         Logger::notice('No valid network found', ['url' => $url, 'uid' => $uid, 'default' => $default, 'update' => $update, 'callstack' => System::callstack(20)]);
1237                         return 0;
1238                 }
1239
1240                 if (!$contact_id) {
1241                         $urls = [Strings::normaliseLink($url), Strings::normaliseLink($data['url'])];
1242                         if (!empty($data['alias'])) {
1243                                 $urls[] = Strings::normaliseLink($data['alias']);
1244                         }
1245                         $contact = self::selectFirst(['id'], ['nurl' => $urls, 'uid' => $uid]);
1246                         if (!empty($contact['id'])) {
1247                                 $contact_id = $contact['id'];
1248                                 Logger::info('Fetched id by url', ['cid' => $contact_id, 'uid' => $uid, 'url' => $url, 'data' => $data]);
1249                         }
1250                 }
1251
1252                 if (!$contact_id) {
1253                         // We only insert the basic data. The rest will be done in "updateFromProbeArray"
1254                         $fields = [
1255                                 'uid'       => $uid,
1256                                 'url'       => $data['url'],
1257                                 'nurl'      => Strings::normaliseLink($data['url']),
1258                                 'network'   => $data['network'],
1259                                 'created'   => DateTimeFormat::utcNow(),
1260                                 'rel'       => self::SHARING,
1261                                 'writable'  => 1,
1262                                 'blocked'   => 0,
1263                                 'readonly'  => 0,
1264                                 'pending'   => 0];
1265
1266                         $condition = ['nurl' => Strings::normaliseLink($data["url"]), 'uid' => $uid, 'deleted' => false];
1267
1268                         // Before inserting we do check if the entry does exist now.
1269                         if (DI::lock()->acquire(self::LOCK_INSERT, 0)) {
1270                                 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1271                                 if (DBA::isResult($contact)) {
1272                                         $contact_id = $contact['id'];
1273                                         Logger::notice('Contact had been created (shortly) before', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1274                                 } else {
1275                                         $contact_id = self::insert($fields);
1276                                         if ($contact_id) {
1277                                                 Logger::info('Contact inserted', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1278                                         }
1279                                 }
1280                                 DI::lock()->release(self::LOCK_INSERT);
1281                         } else {
1282                                 Logger::warning('Contact lock had not been acquired');
1283                         }
1284
1285                         if (!$contact_id) {
1286                                 Logger::info('Contact was not inserted', ['url' => $url, 'uid' => $uid]);
1287                                 return 0;
1288                         }
1289                 } else {
1290                         Logger::info('Contact will be updated', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1291                 }
1292
1293                 if ($data['network'] == Protocol::DIASPORA) {
1294                         FContact::updateFromProbeArray($data);
1295                 }
1296
1297                 self::updateFromProbeArray($contact_id, $data);
1298
1299                 // Don't return a number for a deleted account
1300                 if (!empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1301                         Logger::info('Contact is a tombstone', ['url' => $url, 'uid' => $uid]);
1302                         return 0;
1303                 }
1304
1305                 return $contact_id;
1306         }
1307
1308         /**
1309          * Checks if the contact is archived
1310          *
1311          * @param int $cid contact id
1312          *
1313          * @return boolean Is the contact archived?
1314          * @throws HTTPException\InternalServerErrorException
1315          */
1316         public static function isArchived(int $cid): bool
1317         {
1318                 if ($cid == 0) {
1319                         return false;
1320                 }
1321
1322                 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1323                 if (!DBA::isResult($contact)) {
1324                         return false;
1325                 }
1326
1327                 if ($contact['archive']) {
1328                         return true;
1329                 }
1330
1331                 // Check status of ActivityPub endpoints
1332                 $apcontact = APContact::getByURL($contact['url'], false);
1333                 if (!empty($apcontact)) {
1334                         if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1335                                 return true;
1336                         }
1337
1338                         if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1339                                 return true;
1340                         }
1341                 }
1342
1343                 // Check status of Diaspora endpoints
1344                 if (!empty($contact['batch'])) {
1345                         $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1346                         return DBA::exists('contact', $condition);
1347                 }
1348
1349                 return false;
1350         }
1351
1352         /**
1353          * Checks if the contact is blocked
1354          *
1355          * @param int $cid contact id
1356          * @return boolean Is the contact blocked?
1357          * @throws HTTPException\InternalServerErrorException
1358          */
1359         public static function isBlocked(int $cid): bool
1360         {
1361                 if ($cid == 0) {
1362                         return false;
1363                 }
1364
1365                 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1366                 if (!DBA::isResult($blocked)) {
1367                         return false;
1368                 }
1369
1370                 if (Network::isUrlBlocked($blocked['url'])) {
1371                         return true;
1372                 }
1373
1374                 return (bool) $blocked['blocked'];
1375         }
1376
1377         /**
1378          * Checks if the contact is hidden
1379          *
1380          * @param int $cid contact id
1381          * @return boolean Is the contact hidden?
1382          * @throws \Exception
1383          */
1384         public static function isHidden(int $cid): bool
1385         {
1386                 if ($cid == 0) {
1387                         return false;
1388                 }
1389
1390                 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1391                 if (!DBA::isResult($hidden)) {
1392                         return false;
1393                 }
1394                 return (bool) $hidden['hidden'];
1395         }
1396
1397         /**
1398          * Returns posts from a given contact url
1399          *
1400          * @param string $contact_url Contact URL
1401          * @param bool   $thread_mode
1402          * @param int    $update      Update mode
1403          * @param int    $parent      Item parent ID for the update mode
1404          * @param bool   $only_media  Only display media content
1405          * @return string posts in HTML
1406          * @throws \Exception
1407          */
1408         public static function getPostsFromUrl(string $contact_url, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1409         {
1410                 return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent, $only_media);
1411         }
1412
1413         /**
1414          * Returns posts from a given contact id
1415          *
1416          * @param int  $cid         Contact ID
1417          * @param bool $thread_mode
1418          * @param int  $update      Update mode
1419          * @param int  $parent      Item parent ID for the update mode
1420          * @param bool $only_media  Only display media content
1421          * @return string posts in HTML
1422          * @throws \Exception
1423          */
1424         public static function getPostsFromId(int $cid, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1425         {
1426                 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1427                 if (!DBA::isResult($contact)) {
1428                         return '';
1429                 }
1430
1431                 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1432                         $sql = "(`uid` = 0 OR (`uid` = ? AND NOT `global`))";
1433                 } else {
1434                         $sql = "`uid` = ?";
1435                 }
1436
1437                 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1438
1439                 if ($thread_mode) {
1440                         $condition = ["((`$contact_field` = ? AND `gravity` = ?) OR (`author-id` = ? AND `gravity` = ? AND `vid` = ?)) AND " . $sql,
1441                                 $cid, GRAVITY_PARENT, $cid, GRAVITY_ACTIVITY, Verb::getID(Activity::ANNOUNCE), local_user()];
1442                 } else {
1443                         $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1444                                 $cid, GRAVITY_PARENT, GRAVITY_COMMENT, local_user()];
1445                 }
1446
1447                 if (!empty($parent)) {
1448                         $condition = DBA::mergeConditions($condition, ['parent' => $parent]);
1449                 } else {
1450                         $last_received = isset($_GET['last_received']) ? DateTimeFormat::utc($_GET['last_received']) : '';
1451                         if (!empty($last_received)) {
1452                                 $condition = DBA::mergeConditions($condition, ["`received` < ?", $last_received]);
1453                         }
1454                 }
1455
1456                 if ($only_media) {
1457                         $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
1458                                 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
1459                 }
1460
1461                 if (DI::mode()->isMobile()) {
1462                         $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
1463                                 DI::config()->get('system', 'itemspage_network_mobile'));
1464                 } else {
1465                         $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
1466                                 DI::config()->get('system', 'itemspage_network'));
1467                 }
1468
1469                 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1470
1471                 $params = ['order' => ['received' => true], 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1472
1473                 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1474                         $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
1475                         $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
1476                 } else {
1477                         $o = '';
1478                 }
1479
1480                 if ($thread_mode) {
1481                         $fields = ['uri-id', 'thr-parent-id', 'gravity', 'author-id', 'commented'];
1482                         $items = Post::toArray(Post::selectForUser(local_user(), $fields, $condition, $params));
1483
1484                         if ($pager->getStart() == 0) {
1485                                 $cdata = self::getPublicAndUserContactID($cid, local_user());
1486                                 if (!empty($cdata['public'])) {
1487                                         $pinned = Post\Collection::selectToArrayForContact($cdata['public'], Post\Collection::FEATURED, $fields);
1488                                         $items = array_merge($items, $pinned);
1489                                 }
1490                         }
1491
1492                         $o .= DI::conversation()->create($items, 'contacts', $update, false, 'pinned_commented', local_user());
1493                 } else {
1494                         $fields = array_merge(Item::DISPLAY_FIELDLIST, ['featured']);
1495                         $items = Post::toArray(Post::selectForUser(local_user(), $fields, $condition, $params));
1496
1497                         if ($pager->getStart() == 0) {
1498                                 $cdata = self::getPublicAndUserContactID($cid, local_user());
1499                                 if (!empty($cdata['public'])) {
1500                                         $condition = ["`uri-id` IN (SELECT `uri-id` FROM `collection-view` WHERE `cid` = ? AND `type` = ?)",
1501                                                 $cdata['public'], Post\Collection::FEATURED];
1502                                         $pinned = Post::toArray(Post::selectForUser(local_user(), $fields, $condition, $params));
1503                                         $items = array_merge($pinned, $items);
1504                                 }
1505                         }
1506
1507                         $o .= DI::conversation()->create($items, 'contact-posts', $update);
1508                 }
1509
1510                 if (!$update) {
1511                         if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1512                                 $o .= HTML::scrollLoader();
1513                         } else {
1514                                 $o .= $pager->renderMinimal(count($items));
1515                         }
1516                 }
1517
1518                 return $o;
1519         }
1520
1521         /**
1522          * Returns the account type name
1523          *
1524          * The function can be called with either the user or the contact array
1525          *
1526          * @param int $type type of contact or account
1527          * @return string
1528          */
1529         public static function getAccountType(int $type): string
1530         {
1531                 switch ($type) {
1532                         case self::TYPE_ORGANISATION:
1533                                 $account_type = DI::l10n()->t("Organisation");
1534                                 break;
1535
1536                         case self::TYPE_NEWS:
1537                                 $account_type = DI::l10n()->t('News');
1538                                 break;
1539
1540                         case self::TYPE_COMMUNITY:
1541                                 $account_type = DI::l10n()->t("Forum");
1542                                 break;
1543
1544                         default:
1545                                 $account_type = "";
1546                                 break;
1547                 }
1548
1549                 return $account_type;
1550         }
1551
1552         /**
1553          * Blocks a contact
1554          *
1555          * @param int $cid Contact id to block
1556          * @param string $reason Block reason
1557          * @return bool Whether it was successful
1558          */
1559         public static function block(int $cid, string $reason = null): bool
1560         {
1561                 $return = self::update(['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1562
1563                 return $return;
1564         }
1565
1566         /**
1567          * Unblocks a contact
1568          *
1569          * @param int $cid Contact id to unblock
1570          * @return bool Whether it was successfull
1571          */
1572         public static function unblock(int $cid): bool
1573         {
1574                 $return = self::update(['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1575
1576                 return $return;
1577         }
1578
1579         /**
1580          * Ensure that cached avatar exist
1581          *
1582          * @param integer $cid Contact id
1583          */
1584         public static function checkAvatarCache(int $cid)
1585         {
1586                 $contact = DBA::selectFirst('contact', ['url', 'network', 'avatar', 'photo', 'thumb', 'micro'], ['id' => $cid, 'uid' => 0, 'self' => false]);
1587                 if (!DBA::isResult($contact)) {
1588                         return;
1589                 }
1590
1591                 if (Network::isLocalLink($contact['url'])) {
1592                         return;
1593                 }
1594
1595                 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || DI::config()->get('system', 'cache_contact_avatar')) {
1596                         if (!empty($contact['avatar']) && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1597                                 Logger::info('Adding avatar cache', ['id' => $cid, 'contact' => $contact]);
1598                                 self::updateAvatar($cid, $contact['avatar'], true);
1599                                 return;
1600                         }
1601                 } elseif (Photo::isPhotoURI($contact['photo']) || Photo::isPhotoURI($contact['thumb']) || Photo::isPhotoURI($contact['micro'])) {
1602                         Logger::info('Replacing legacy avatar cache', ['id' => $cid, 'contact' => $contact]);
1603                         self::updateAvatar($cid, $contact['avatar'], true);
1604                         return;
1605                 } elseif (DI::config()->get('system', 'avatar_cache') && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1606                         Logger::info('Adding avatar cache file', ['id' => $cid, 'contact' => $contact]);
1607                         self::updateAvatar($cid, $contact['avatar'], true);
1608                 return;
1609                 }
1610         }
1611
1612         /**
1613          * Return the photo path for a given contact array in the given size
1614          *
1615          * @param array $contact    contact array
1616          * @param string $field     Fieldname of the photo in the contact array
1617          * @param string $size      Size of the avatar picture
1618          * @param string $avatar    Avatar path that is displayed when no photo had been found
1619          * @param bool  $no_update Don't perfom an update if no cached avatar was found
1620          * @return string photo path
1621          */
1622         private static function getAvatarPath(array $contact, string $size, bool $no_update = false): string
1623         {
1624                 $contact = self::checkAvatarCacheByArray($contact, $no_update);
1625
1626                 if (DI::config()->get('system', 'avatar_cache')) {
1627                         switch ($size) {
1628                                 case Proxy::SIZE_MICRO:
1629                                         if (!empty($contact['micro']) && !Photo::isPhotoURI($contact['micro'])) {
1630                                                 return $contact['micro'];
1631                                         }
1632                                         break;
1633                                 case Proxy::SIZE_THUMB:
1634                                         if (!empty($contact['thumb']) && !Photo::isPhotoURI($contact['thumb'])) {
1635                                                 return $contact['thumb'];
1636                                         }
1637                                         break;
1638                                 case Proxy::SIZE_SMALL:
1639                                         if (!empty($contact['photo']) && !Photo::isPhotoURI($contact['photo'])) {
1640                                                 return $contact['photo'];
1641                                         }
1642                                         break;
1643                         }
1644                 }
1645
1646                 return self::getAvatarUrlForId($contact['id'], $size, $contact['updated'] ?? '');
1647         }
1648
1649         /**
1650          * Return the photo path for a given contact array
1651          *
1652          * @param array  $contact   Contact array
1653          * @param bool   $no_update Don't perfom an update if no cached avatar was found
1654          * @return string photo path
1655          */
1656         public static function getPhoto(array $contact, bool $no_update = false): string
1657         {
1658                 return self::getAvatarPath($contact, Proxy::SIZE_SMALL, $no_update);
1659         }
1660
1661         /**
1662          * Return the photo path (thumb size) for a given contact array
1663          *
1664          * @param array  $contact   Contact array
1665          * @param bool   $no_update Don't perfom an update if no cached avatar was found
1666          * @return string photo path
1667          */
1668         public static function getThumb(array $contact, bool $no_update = false): string
1669         {
1670                 return self::getAvatarPath($contact, Proxy::SIZE_THUMB, $no_update);
1671         }
1672
1673         /**
1674          * Return the photo path (micro size) for a given contact array
1675          *
1676          * @param array  $contact   Contact array
1677          * @param bool   $no_update Don't perfom an update if no cached avatar was found
1678          * @return string photo path
1679          */
1680         public static function getMicro(array $contact, bool $no_update = false): string
1681         {
1682                 return self::getAvatarPath($contact, Proxy::SIZE_MICRO, $no_update);
1683         }
1684
1685         /**
1686          * Check the given contact array for avatar cache fields
1687          *
1688          * @param array $contact
1689          * @param bool  $no_update Don't perfom an update if no cached avatar was found
1690          * @return array contact array with avatar cache fields
1691          */
1692         private static function checkAvatarCacheByArray(array $contact, bool $no_update = false): array
1693         {
1694                 $update = false;
1695                 $contact_fields = [];
1696                 $fields = ['photo', 'thumb', 'micro'];
1697                 foreach ($fields as $field) {
1698                         if (isset($contact[$field])) {
1699                                 $contact_fields[] = $field;
1700                         }
1701                         if (isset($contact[$field]) && empty($contact[$field])) {
1702                                 $update = true;
1703                         }
1704                 }
1705
1706                 if (!$update || $no_update) {
1707                         return $contact;
1708                 }
1709
1710                 $local = !empty($contact['url']) && Network::isLocalLink($contact['url']);
1711
1712                 if (!$local && !empty($contact['id']) && !empty($contact['avatar'])) {
1713                         self::updateAvatar($contact['id'], $contact['avatar'], true);
1714
1715                         $new_contact = self::getById($contact['id'], $contact_fields);
1716                         if (DBA::isResult($new_contact)) {
1717                                 // We only update the cache fields
1718                                 $contact = array_merge($contact, $new_contact);
1719                         }
1720                 } elseif ($local && !empty($contact['avatar'])) {
1721                         return $contact;
1722                 }
1723
1724                 /// add the default avatars if the fields aren't filled
1725                 if (isset($contact['photo']) && empty($contact['photo'])) {
1726                         $contact['photo'] = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1727                 }
1728                 if (isset($contact['thumb']) && empty($contact['thumb'])) {
1729                         $contact['thumb'] = self::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
1730                 }
1731                 if (isset($contact['micro']) && empty($contact['micro'])) {
1732                         $contact['micro'] = self::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
1733                 }
1734
1735                 return $contact;
1736         }
1737
1738         /**
1739          * Fetch the default header for the given contact
1740          *
1741          * @param array $contact  contact array
1742          * @return string avatar URL
1743          */
1744         public static function getDefaultHeader(array $contact): string
1745         {
1746                 if (!empty($contact['header'])) {
1747                         return $contact['header'];
1748                 }
1749
1750                 if (!empty($contact['gsid'])) {
1751                         // Use default banners for certain platforms
1752                         $gserver = DBA::selectFirst('gserver', ['platform'], ['id' => $contact['gsid']]);
1753                         $platform = strtolower($gserver['platform'] ?? '');
1754                 } else {
1755                         $platform = '';
1756                 }
1757
1758                 switch ($platform) {
1759                         case 'friendica':
1760                         case 'friendika':
1761                                 /**
1762                                  * Picture credits
1763                                  * @author  Lostinlight <https://mastodon.xyz/@lightone>
1764                                  * @license CC0 https://creativecommons.org/share-your-work/public-domain/cc0/
1765                                  * @link    https://gitlab.com/lostinlight/per_aspera_ad_astra/-/blob/master/friendica-404/friendica-promo-bubbles.jpg
1766                                  */
1767                                 $header = DI::baseUrl() . '/images/friendica-banner.jpg';
1768                                 break;
1769                         case 'diaspora':
1770                                 /**
1771                                  * Picture credits
1772                                  * @author  John Liu <https://www.flickr.com/photos/8047705@N02/>
1773                                  * @license CC BY 2.0 https://creativecommons.org/licenses/by/2.0/
1774                                  * @link    https://www.flickr.com/photos/8047705@N02/5572197407
1775                                  */
1776                                 $header = DI::baseUrl() . '/images/diaspora-banner.jpg';
1777                                 break;
1778                         default:
1779                                 /**
1780                                  * Use a random picture.
1781                                  * The service provides random pictures from Unsplash.
1782                                  * @license https://unsplash.com/license
1783                                  */
1784                                 $header = 'https://picsum.photos/seed/' . hash('ripemd128', $contact['url']) . '/960/300';
1785                                 break;
1786                 }
1787
1788                 return $header;
1789         }
1790
1791         /**
1792          * Fetch the default avatar for the given contact and size
1793          *
1794          * @param array $contact  contact array
1795          * @param string $size    Size of the avatar picture
1796          * @return string avatar URL
1797          */
1798         public static function getDefaultAvatar(array $contact, string $size): string
1799         {
1800                 switch ($size) {
1801                         case Proxy::SIZE_MICRO:
1802                                 $avatar['size'] = 48;
1803                                 $default = self::DEFAULT_AVATAR_MICRO;
1804                                 break;
1805
1806                         case Proxy::SIZE_THUMB:
1807                                 $avatar['size'] = 80;
1808                                 $default = self::DEFAULT_AVATAR_THUMB;
1809                                 break;
1810
1811                         case Proxy::SIZE_SMALL:
1812                         default:
1813                                 $avatar['size'] = 300;
1814                                 $default = self::DEFAULT_AVATAR_PHOTO;
1815                                 break;
1816                 }
1817
1818                 if (!DI::config()->get('system', 'remote_avatar_lookup')) {
1819                         $platform = '';
1820                         $type     = Contact::TYPE_PERSON;
1821
1822                         if (!empty($contact['id'])) {
1823                                 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['id' => $contact['id']]);
1824                                 $platform = $account['platform'] ?? '';
1825                                 $type     = $account['contact-type'] ?? Contact::TYPE_PERSON;
1826                         }
1827
1828                         if (empty($platform) && !empty($contact['uri-id'])) {
1829                                 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['uri-id' => $contact['uri-id']]);
1830                                 $platform = $account['platform'] ?? '';
1831                                 $type     = $account['contact-type'] ?? Contact::TYPE_PERSON;
1832                         }
1833
1834                         switch ($platform) {
1835                                 case 'corgidon':
1836                                         /**
1837                                          * Picture credits
1838                                          * @license GNU Affero General Public License v3.0
1839                                          * @link    https://github.com/msdos621/corgidon/blob/main/public/avatars/original/missing.png
1840                                          */
1841                                         $default = '/images/default/corgidon.png';
1842                                         break;
1843
1844                                 case 'diaspora':
1845                                         /**
1846                                          * Picture credits
1847                                          * @license GNU Affero General Public License v3.0
1848                                          * @link    https://github.com/diaspora/diaspora/
1849                                          */
1850                                         $default = '/images/default/diaspora.png';
1851                                         break;
1852
1853                                 case 'gotosocial':
1854                                         /**
1855                                          * Picture credits
1856                                          * @license GNU Affero General Public License v3.0
1857                                          * @link    https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/default_avatars/GoToSocial_icon1.svg
1858                                          */
1859                                         $default = '/images/default/gotosocial.svg';
1860                                         break;
1861
1862                                 case 'hometown':
1863                                         /**
1864                                          * Picture credits
1865                                          * @license GNU Affero General Public License v3.0
1866                                          * @link    https://github.com/hometown-fork/hometown/blob/hometown-dev/public/avatars/original/missing.png
1867                                          */
1868                                         $default = '/images/default/hometown.png';
1869                                         break;
1870
1871                                 case 'koyuspace':
1872                                         /**
1873                                          * Picture credits
1874                                          * @license GNU Affero General Public License v3.0
1875                                          * @link    https://github.com/koyuspace/mastodon/blob/main/public/avatars/original/missing.png
1876                                          */
1877                                         $default = '/images/default/koyuspace.png';
1878                                         break;
1879
1880                                 case 'ecko':
1881                                 case 'qoto':
1882                                 case 'mastodon':
1883                                         /**
1884                                          * Picture credits
1885                                          * @license GNU Affero General Public License v3.0
1886                                          * @link    https://github.com/mastodon/mastodon/tree/main/public/avatars/original/missing.png
1887                                          */
1888                                         $default = '/images/default/mastodon.png';
1889                                         break;
1890
1891                                 case 'peertube':
1892                                         if ($type == Contact::TYPE_COMMUNITY) {
1893                                                 /**
1894                                                  * Picture credits
1895                                                  * @license GNU Affero General Public License v3.0
1896                                                  * @link    https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-video-channel.png
1897                                                  */
1898                                                 $default = '/images/default/peertube-channel.png';
1899                                         } else {
1900                                                 /**
1901                                                  * Picture credits
1902                                                  * @license GNU Affero General Public License v3.0
1903                                                  * @link    https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-account.png
1904                                                  */
1905                                                 $default = '/images/default/peertube-account.png';
1906                                         }
1907                                         break;
1908
1909                                 case 'pleroma':
1910                                         /**
1911                                          * Picture credits
1912                                          * @license GNU Affero General Public License v3.0
1913                                          * @link    https://git.pleroma.social/pleroma/pleroma/-/blob/develop/priv/static/images/avi.png
1914                                          */
1915                                         $default = '/images/default/pleroma.png';
1916                                         break;
1917
1918                                 case 'plume':
1919                                         /**
1920                                          * Picture credits
1921                                          * @license GNU Affero General Public License v3.0
1922                                          * @link    https://github.com/Plume-org/Plume/blob/main/assets/images/default-avatar.png
1923                                          */
1924                                         $default = '/images/default/plume.png';
1925                                         break;
1926                         }
1927                         return DI::baseUrl() . $default;
1928                 }
1929
1930                 if (!empty($contact['xmpp'])) {
1931                         $avatar['email'] = $contact['xmpp'];
1932                 } elseif (!empty($contact['addr'])) {
1933                         $avatar['email'] = $contact['addr'];
1934                 } elseif (!empty($contact['url'])) {
1935                         $avatar['email'] = $contact['url'];
1936                 } else {
1937                         return DI::baseUrl() . $default;
1938                 }
1939
1940                 $avatar['url'] = '';
1941                 $avatar['success'] = false;
1942
1943                 Hook::callAll('avatar_lookup', $avatar);
1944
1945                 if ($avatar['success'] && !empty($avatar['url'])) {
1946                         return $avatar['url'];
1947                 }
1948
1949                 return DI::baseUrl() . $default;
1950         }
1951
1952         /**
1953          * Get avatar link for given contact id
1954          *
1955          * @param integer $cid     contact id
1956          * @param string  $size    One of the Proxy::SIZE_* constants
1957          * @param string  $updated Contact update date
1958          * @return string avatar link
1959          */
1960         public static function getAvatarUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''): string
1961         {
1962                 // We have to fetch the "updated" variable when it wasn't provided
1963                 // The parameter can be provided to improve performance
1964                 if (empty($updated)) {
1965                         $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
1966                         $updated = $account['updated'] ?? '';
1967                         $guid = $account['guid'] ?? '';
1968                 }
1969
1970                 $guid = urlencode($guid);
1971
1972                 $url = DI::baseUrl() . '/photo/contact/';
1973                 switch ($size) {
1974                         case Proxy::SIZE_MICRO:
1975                                 $url .= Proxy::PIXEL_MICRO . '/';
1976                                 break;
1977                         case Proxy::SIZE_THUMB:
1978                                 $url .= Proxy::PIXEL_THUMB . '/';
1979                                 break;
1980                         case Proxy::SIZE_SMALL:
1981                                 $url .= Proxy::PIXEL_SMALL . '/';
1982                                 break;
1983                         case Proxy::SIZE_MEDIUM:
1984                                 $url .= Proxy::PIXEL_MEDIUM . '/';
1985                                 break;
1986                         case Proxy::SIZE_LARGE:
1987                                 $url .= Proxy::PIXEL_LARGE . '/';
1988                                 break;
1989                 }
1990                 return $url . ($guid ?: $cid) . ($updated ? '?ts=' . strtotime($updated) : '');
1991         }
1992
1993         /**
1994          * Get avatar link for given contact URL
1995          *
1996          * @param string  $url  contact url
1997          * @param integer $uid  user id
1998          * @param string  $size One of the Proxy::SIZE_* constants
1999          * @return string avatar link
2000          */
2001         public static function getAvatarUrlForUrl(string $url, int $uid, string $size = ''): string
2002         {
2003                 $condition = ["`nurl` = ? AND ((`uid` = ? AND `network` IN (?, ?)) OR `uid` = ?)",
2004                         Strings::normaliseLink($url), $uid, Protocol::FEED, Protocol::MAIL, 0];
2005                 $contact = self::selectFirst(['id', 'updated'], $condition, ['order' => ['uid' => true]]);
2006                 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
2007         }
2008
2009         /**
2010          * Get header link for given contact id
2011          *
2012          * @param integer $cid     contact id
2013          * @param string  $size    One of the Proxy::SIZE_* constants
2014          * @param string  $updated Contact update date
2015          * @return string header link
2016          */
2017         public static function getHeaderUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''): string
2018         {
2019                 // We have to fetch the "updated" variable when it wasn't provided
2020                 // The parameter can be provided to improve performance
2021                 if (empty($updated) || empty($guid)) {
2022                         $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
2023                         $updated = $account['updated'] ?? '';
2024                         $guid = $account['guid'] ?? '';
2025                 }
2026
2027                 $guid = urlencode($guid);
2028
2029                 $url = DI::baseUrl() . '/photo/header/';
2030                 switch ($size) {
2031                         case Proxy::SIZE_MICRO:
2032                                 $url .= Proxy::PIXEL_MICRO . '/';
2033                                 break;
2034                         case Proxy::SIZE_THUMB:
2035                                 $url .= Proxy::PIXEL_THUMB . '/';
2036                                 break;
2037                         case Proxy::SIZE_SMALL:
2038                                 $url .= Proxy::PIXEL_SMALL . '/';
2039                                 break;
2040                         case Proxy::SIZE_MEDIUM:
2041                                 $url .= Proxy::PIXEL_MEDIUM . '/';
2042                                 break;
2043                         case Proxy::SIZE_LARGE:
2044                                 $url .= Proxy::PIXEL_LARGE . '/';
2045                                 break;
2046                 }
2047
2048                 return $url . ($guid ?: $cid) . ($updated ? '?ts=' . strtotime($updated) : '');
2049         }
2050
2051         /**
2052          * Updates the avatar links in a contact only if needed
2053          *
2054          * @param int    $cid          Contact id
2055          * @param string $avatar       Link to avatar picture
2056          * @param bool   $force        force picture update
2057          * @param bool   $create_cache Enforces the creation of cached avatar fields
2058          *
2059          * @return void
2060          * @throws HTTPException\InternalServerErrorException
2061          * @throws HTTPException\NotFoundException
2062          * @throws \ImagickException
2063          */
2064         public static function updateAvatar(int $cid, string $avatar, bool $force = false, bool $create_cache = false)
2065         {
2066                 $contact = DBA::selectFirst('contact', ['uid', 'avatar', 'photo', 'thumb', 'micro', 'xmpp', 'addr', 'nurl', 'url', 'network', 'uri-id'],
2067                         ['id' => $cid, 'self' => false]);
2068                 if (!DBA::isResult($contact)) {
2069                         return;
2070                 }
2071
2072                 $uid = $contact['uid'];
2073
2074                 // Only update the cached photo links of public contacts when they already are cached
2075                 if (($uid == 0) && !$force && empty($contact['thumb']) && empty($contact['micro']) && !$create_cache) {
2076                         if ($contact['avatar'] != $avatar) {
2077                                 self::update(['avatar' => $avatar], ['id' => $cid]);
2078                                 Logger::info('Only update the avatar', ['id' => $cid, 'avatar' => $avatar, 'contact' => $contact]);
2079                         }
2080                         return;
2081                 }
2082
2083                 // User contacts use are updated through the public contacts
2084                 if (($uid != 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2085                         $pcid = self::getIdForURL($contact['url'], 0, false);
2086                         if (!empty($pcid)) {
2087                                 Logger::debug('Update the private contact via the public contact', ['id' => $cid, 'uid' => $uid, 'public' => $pcid]);
2088                                 self::updateAvatar($pcid, $avatar, $force, true);
2089                                 return;
2090                         }
2091                 }
2092
2093                 $default_avatar = empty($avatar) || strpos($avatar, self::DEFAULT_AVATAR_PHOTO);
2094
2095                 if ($default_avatar) {
2096                         $avatar = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
2097                 }
2098
2099                 $cache_avatar = DI::config()->get('system', 'cache_contact_avatar');
2100
2101                 // Local contact avatars don't need to be cached
2102                 if ($cache_avatar && Network::isLocalLink($contact['url'])) {
2103                         $cache_avatar = !DBA::exists('contact', ['nurl' => $contact['nurl'], 'self' => true]);
2104                 }
2105
2106                 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || $cache_avatar) {
2107                         Avatar::deleteCache($contact);
2108
2109                         if ($default_avatar && Proxy::isLocalImage($avatar)) {
2110                                 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
2111                                         'photo' => $avatar,
2112                                         'thumb' => self::getDefaultAvatar($contact, Proxy::SIZE_THUMB),
2113                                         'micro' => self::getDefaultAvatar($contact, Proxy::SIZE_MICRO)];
2114                                 Logger::debug('Use default avatar', ['id' => $cid, 'uid' => $uid]);
2115                         }
2116
2117                         // Use the data from the self account
2118                         if (empty($fields)) {
2119                                 $local_uid = User::getIdForURL($contact['url']);
2120                                 if (!empty($local_uid)) {
2121                                         $fields = self::selectFirst(['avatar', 'avatar-date', 'photo', 'thumb', 'micro'], ['self' => true, 'uid' => $local_uid]);
2122                                         Logger::debug('Use owner data', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2123                                 }
2124                         }
2125
2126                         if (empty($fields)) {
2127                                 $update = ($contact['avatar'] != $avatar) || $force;
2128
2129                                 if (!$update) {
2130                                         $data = [
2131                                                 $contact['photo'] ?? '',
2132                                                 $contact['thumb'] ?? '',
2133                                                 $contact['micro'] ?? '',
2134                                         ];
2135
2136                                         foreach ($data as $image_uri) {
2137                                                 $image_rid = Photo::ridFromURI($image_uri);
2138                                                 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
2139                                                         Logger::debug('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
2140                                                         $update = true;
2141                                                 }
2142                                         }
2143                                 }
2144
2145                                 if ($update) {
2146                                         $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
2147                                         if ($photos) {
2148                                                 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'avatar-date' => DateTimeFormat::utcNow()];
2149                                                 $update = !empty($fields);
2150                                                 Logger::debug('Created new cached avatars', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2151                                         } else {
2152                                                 $update = false;
2153                                         }
2154                                 }
2155                         } else {
2156                                 $update = ($fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2157                         }
2158                 } else {
2159                         Photo::delete(['uid' => $uid, 'contact-id' => $cid, 'photo-type' => Photo::CONTACT_AVATAR]);
2160                         $fields = Avatar::fetchAvatarContact($contact, $avatar, $force);
2161                         $update = ($avatar . $fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['avatar'] . $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2162                 }
2163
2164                 if (!$update) {
2165                         return;
2166                 }
2167
2168                 $cids = [];
2169                 $uids = [];
2170                 if (($uid == 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2171                         // Collect all user contacts of the given public contact
2172                         $personal_contacts = DBA::select('contact', ['id', 'uid'],
2173                                 ["`nurl` = ? AND `id` != ? AND NOT `self`", $contact['nurl'], $cid]);
2174                         while ($personal_contact = DBA::fetch($personal_contacts)) {
2175                                 $cids[] = $personal_contact['id'];
2176                                 $uids[] = $personal_contact['uid'];
2177                         }
2178                         DBA::close($personal_contacts);
2179
2180                         if (!empty($cids)) {
2181                                 // Delete possibly existing cached user contact avatars
2182                                 Photo::delete(['uid' => $uids, 'contact-id' => $cids, 'photo-type' => Photo::CONTACT_AVATAR]);
2183                         }
2184                 }
2185
2186                 $cids[] = $cid;
2187                 $uids[] = $uid;
2188                 Logger::info('Updating cached contact avatars', ['cid' => $cids, 'uid' => $uids, 'fields' => $fields]);
2189                 self::update($fields, ['id' => $cids]);
2190         }
2191
2192         public static function deleteContactByUrl(string $url)
2193         {
2194                 // Update contact data for all users
2195                 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
2196                 $contacts = DBA::select('contact', ['id', 'uid'], $condition);
2197                 while ($contact = DBA::fetch($contacts)) {
2198                         Logger::info('Deleting contact', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $url]);
2199                         self::remove($contact['id']);
2200                 }
2201         }
2202
2203         /**
2204          * Helper function for "updateFromProbe". Updates personal and public contact
2205          *
2206          * @param integer $id      contact id
2207          * @param integer $uid     user id
2208          * @param string  $old_url The previous profile URL of the contact
2209          * @param string  $new_url The profile URL of the contact
2210          * @param array   $fields  The fields that are updated
2211          *
2212          * @throws \Exception
2213          */
2214         private static function updateContact(int $id, int $uid, string $old_url, string $new_url, array $fields)
2215         {
2216                 if (!self::update($fields, ['id' => $id])) {
2217                         Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
2218                         return;
2219                 }
2220
2221                 // Search for duplicated contacts and get rid of them
2222                 if (self::removeDuplicates(Strings::normaliseLink($new_url), $uid)) {
2223                         return;
2224                 }
2225
2226                 // Archive or unarchive the contact.
2227                 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
2228                 if (!DBA::isResult($contact)) {
2229                         Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
2230                         return;
2231                 }
2232
2233                 if (isset($fields['failed'])) {
2234                         if ($fields['failed']) {
2235                                 self::markForArchival($contact);
2236                         } else {
2237                                 self::unmarkForArchival($contact);
2238                         }
2239                 }
2240
2241                 if ($contact['uid'] != 0) {
2242                         return;
2243                 }
2244
2245                 // Update contact data for all users
2246                 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($old_url)];
2247
2248                 $condition['network'] = [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB];
2249                 self::update($fields, $condition);
2250
2251                 // We mustn't set the update fields for OStatus contacts since they are updated in OnePoll
2252                 $condition['network'] = Protocol::OSTATUS;
2253
2254                 // If the contact failed, propagate the update fields to all contacts
2255                 if (empty($fields['failed'])) {
2256                         unset($fields['last-update']);
2257                         unset($fields['success_update']);
2258                         unset($fields['failure_update']);
2259                 }
2260
2261                 if (empty($fields)) {
2262                         return;
2263                 }
2264
2265                 self::update($fields, $condition);
2266         }
2267
2268         /**
2269          * Remove duplicated contacts
2270          *
2271          * @param string  $nurl  Normalised contact url
2272          * @param integer $uid   User id
2273          * @return boolean
2274          * @throws \Exception
2275          */
2276         public static function removeDuplicates(string $nurl, int $uid)
2277         {
2278                 $condition = ['nurl' => $nurl, 'uid' => $uid, 'self' => false, 'deleted' => false, 'network' => Protocol::FEDERATED];
2279                 $count = DBA::count('contact', $condition);
2280                 if ($count <= 1) {
2281                         return false;
2282                 }
2283
2284                 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
2285                 if (!DBA::isResult($first_contact)) {
2286                         // Shouldn't happen - so we handle it
2287                         return false;
2288                 }
2289
2290                 $first = $first_contact['id'];
2291                 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
2292                 if (($uid != 0 && ($first_contact['network'] == Protocol::DFRN))) {
2293                         // Don't handle non public DFRN duplicates by now (legacy DFRN is very special because of the key handling)
2294                         Logger::info('Not handling non public DFRN duplicate', ['uid' => $uid, 'nurl' => $nurl]);
2295                         return false;
2296                 }
2297
2298                 // Find all duplicates
2299                 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
2300                 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
2301                 while ($duplicate = DBA::fetch($duplicates)) {
2302                         if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
2303                                 continue;
2304                         }
2305
2306                         Worker::add(PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
2307                 }
2308                 DBA::close($duplicates);
2309                 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl, 'callstack' => System::callstack(20)]);
2310                 return true;
2311         }
2312
2313         /**
2314          * Updates contact record by provided id and optional network
2315          *
2316          * @param integer $id      contact id
2317          * @param string  $network Optional network we are probing for
2318          * @return boolean
2319          * @throws HTTPException\InternalServerErrorException
2320          * @throws \ImagickException
2321          */
2322         public static function updateFromProbe(int $id, string $network = '')
2323         {
2324                 $contact = DBA::selectFirst('contact', ['uid', 'url'], ['id' => $id]);
2325                 if (!DBA::isResult($contact)) {
2326                         return false;
2327                 }
2328
2329                 $ret = Probe::uri($contact['url'], $network, $contact['uid']);
2330
2331                 if ($ret['network'] == Protocol::DIASPORA) {
2332                         FContact::updateFromProbeArray($ret);
2333                 }
2334
2335                 return self::updateFromProbeArray($id, $ret);
2336         }
2337
2338         /**
2339          * Updates contact record by provided id and probed data
2340          *
2341          * @param integer $id      contact id
2342          * @param array   $ret     Probed data
2343          * @return boolean
2344          * @throws HTTPException\InternalServerErrorException
2345          * @throws \ImagickException
2346          */
2347         private static function updateFromProbeArray(int $id, array $ret): bool
2348         {
2349                 /*
2350                   Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
2351                   This will reliably kill your communication with old Friendica contacts.
2352                  */
2353
2354                 // These fields aren't updated by this routine:
2355                 // 'sensitive'
2356
2357                 $fields = ['uid', 'uri-id', 'avatar', 'header', 'name', 'nick', 'location', 'keywords', 'about', 'subscribe',
2358                         'manually-approve', 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
2359                         'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey', 'last-item', 'xmpp', 'matrix'];
2360                 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
2361                 if (!DBA::isResult($contact)) {
2362                         return false;
2363                 }
2364
2365                 if (self::isLocal($ret['url'])) {
2366                         if ($contact['uid'] == 0) {
2367                                 Logger::info('Local contacts are not updated here.');
2368                         } else {
2369                                 self::updateFromPublicContact($id, $contact);
2370                         }
2371                         return true;
2372                 }
2373
2374                 if (!empty($ret['account-type']) && $ret['account-type'] == User::ACCOUNT_TYPE_DELETED) {
2375                         Logger::info('Deleted account', ['id' => $id, 'url' => $ret['url'], 'ret' => $ret]);
2376                         self::remove($id);
2377
2378                         // Delete all contacts with the same URL
2379                         self::deleteContactByUrl($ret['url']);
2380                         return true;
2381                 }
2382
2383                 $uid = $contact['uid'];
2384                 unset($contact['uid']);
2385
2386                 $uriid = $contact['uri-id'];
2387                 unset($contact['uri-id']);
2388
2389                 $pubkey = $contact['pubkey'];
2390                 unset($contact['pubkey']);
2391
2392                 $contact['photo'] = $contact['avatar'];
2393                 unset($contact['avatar']);
2394
2395                 $updated = DateTimeFormat::utcNow();
2396
2397                 if (Strings::normaliseLink($contact['url']) != Strings::normaliseLink($ret['url'])) {
2398                         Logger::notice('New URL differs from old URL', ['id' => $id, 'uid' => $uid, 'old' => $contact['url'], 'new' => $ret['url']]);
2399                         self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => true, 'last-update' => $updated, 'failure_update' => $updated]);
2400                         return false;
2401                 }
2402
2403                 // We must not try to update relay contacts via probe. They are no real contacts.
2404                 // We check after the probing to be able to correct falsely detected contact types.
2405                 if (($contact['contact-type'] == self::TYPE_RELAY) &&
2406                         (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))) {
2407                         self::updateContact($id, $uid, $contact['url'], $contact['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
2408                         Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
2409                         return true;
2410                 }
2411
2412                 // If Probe::uri fails the network code will be different ("feed" or "unkn")
2413                 if (($ret['network'] == Protocol::PHANTOM) || (($ret['network'] == Protocol::FEED) && ($ret['network'] != $contact['network']))) {
2414                         self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => true, 'last-update' => $updated, 'failure_update' => $updated]);
2415                         return false;
2416                 }
2417
2418                 if (Strings::normaliseLink($ret['url']) != Strings::normaliseLink($contact['url'])) {
2419                         $cid = self::getIdForURL($ret['url'], 0, false);
2420                         if (!empty($cid) && ($cid != $id)) {
2421                                 Logger::notice('URL of contact changed.', ['id' => $id, 'new_id' => $cid, 'old' => $contact['url'], 'new' => $ret['url']]);
2422                                 return self::updateFromProbeArray($cid, $ret);
2423                         }
2424                 }
2425
2426                 if (isset($ret['hide']) && is_bool($ret['hide'])) {
2427                         $ret['unsearchable'] = $ret['hide'];
2428                 }
2429
2430                 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
2431                         $ret['forum'] = false;
2432                         $ret['prv'] = false;
2433                         $ret['contact-type'] = $ret['account-type'];
2434                         if (($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) && isset($ret['manually-approve'])) {
2435                                 $ret['forum'] = (bool)!$ret['manually-approve'];
2436                                 $ret['prv'] = (bool)!$ret['forum'];
2437                         }
2438                 }
2439
2440                 $new_pubkey = $ret['pubkey'] ?? '';
2441
2442                 if ($uid == 0) {
2443                         if ($ret['network'] == Protocol::ACTIVITYPUB) {
2444                                 $apcontact = APContact::getByURL($ret['url'], false);
2445                                 if (!empty($apcontact['featured'])) {
2446                                         Worker::add(PRIORITY_LOW, 'FetchFeaturedPosts', $ret['url']);
2447                                 }
2448                         }
2449
2450                         $ret['last-item'] = Probe::getLastUpdate($ret);
2451                         Logger::info('Fetched last item', ['id' => $id, 'probed_url' => $ret['url'], 'last-item' => $ret['last-item'], 'callstack' => System::callstack(20)]);
2452                 }
2453
2454                 $update = false;
2455                 $guid = ($ret['guid'] ?? '') ?: Item::guidFromUri($ret['url'], parse_url($ret['url'], PHP_URL_HOST));
2456
2457                 // make sure to not overwrite existing values with blank entries except some technical fields
2458                 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2459                 foreach ($ret as $key => $val) {
2460                         if (!array_key_exists($key, $contact)) {
2461                                 unset($ret[$key]);
2462                         } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2463                                 $ret[$key] = $contact[$key];
2464                         } elseif ($ret[$key] != $contact[$key]) {
2465                                 $update = true;
2466                         }
2467                 }
2468
2469                 if (!empty($ret['last-item']) && ($contact['last-item'] < $ret['last-item'])) {
2470                         $update = true;
2471                 } else {
2472                         unset($ret['last-item']);
2473                 }
2474
2475                 if (empty($uriid)) {
2476                         $update = true;
2477                 }
2478
2479                 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2480                         self::updateAvatar($id, $ret['photo'], $update);
2481                 }
2482
2483                 $uriid = ItemURI::insert(['uri' => $ret['url'], 'guid' => $guid]);
2484
2485                 if (!$update) {
2486                         self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
2487
2488                         if (Contact\Relation::isDiscoverable($ret['url'])) {
2489                                 Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2490                         }
2491
2492                         // Update the public contact
2493                         if ($uid != 0) {
2494                                 $contact = self::getByURL($ret['url'], false, ['id']);
2495                                 if (!empty($contact['id'])) {
2496                                         self::updateFromProbeArray($contact['id'], $ret);
2497                                 }
2498                         }
2499
2500                         return true;
2501                 }
2502
2503                 $ret['uri-id']  = $uriid;
2504                 $ret['nurl']    = Strings::normaliseLink($ret['url']);
2505                 $ret['updated'] = $updated;
2506                 $ret['failed']  = false;
2507
2508                 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2509                 if (empty($pubkey) && !empty($new_pubkey)) {
2510                         $ret['pubkey'] = $new_pubkey;
2511                 }
2512
2513                 if ((!empty($ret['addr']) && ($ret['addr'] != $contact['addr'])) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2514                         $ret['uri-date'] = $updated;
2515                 }
2516
2517                 if ((!empty($ret['name']) && ($ret['name'] != $contact['name'])) || (!empty($ret['nick']) && ($ret['nick'] != $contact['nick']))) {
2518                         $ret['name-date'] = $updated;
2519                 }
2520
2521                 if (($uid == 0) || in_array($ret['network'], [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2522                         $ret['last-update'] = $updated;
2523                         $ret['success_update'] = $updated;
2524                 }
2525
2526                 unset($ret['photo']);
2527
2528                 self::updateContact($id, $uid, $contact['url'], $ret['url'], $ret);
2529
2530                 if (Contact\Relation::isDiscoverable($ret['url'])) {
2531                         Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2532                 }
2533
2534                 return true;
2535         }
2536
2537         private static function updateFromPublicContact(int $id, array $contact)
2538         {
2539                 $public = self::getByURL($contact['url'], false);
2540
2541                 $fields = [];
2542
2543                 foreach ($contact as $field => $value) {
2544                         if ($field == 'uid') {
2545                                 continue;
2546                         }
2547                         if ($public[$field] != $value) {
2548                                 $fields[$field] = $public[$field];
2549                         }
2550                 }
2551                 if (!empty($fields)) {
2552                         self::update($fields, ['id' => $id, 'self' => false]);
2553                         Logger::info('Updating local contact', ['id' => $id]);
2554                 }
2555         }
2556
2557         /**
2558          * Updates contact record by provided URL
2559          *
2560          * @param integer $url contact url
2561          * @return integer Contact id
2562          * @throws HTTPException\InternalServerErrorException
2563          * @throws \ImagickException
2564          */
2565         public static function updateFromProbeByURL(string $url): int
2566         {
2567                 $id = self::getIdForURL($url);
2568
2569                 if (empty($id)) {
2570                         return $id;
2571                 }
2572
2573                 self::updateFromProbe($id);
2574
2575                 return $id;
2576         }
2577
2578         /**
2579          * Detects the communication protocol for a given contact url.
2580          * This is used to detect Friendica contacts that we can communicate via AP.
2581          *
2582          * @param string $url contact url
2583          * @param string $network Network of that contact
2584          * @return string with protocol
2585          */
2586         public static function getProtocol(string $url, string $network): string
2587         {
2588                 if ($network != Protocol::DFRN) {
2589                         return $network;
2590                 }
2591
2592                 $apcontact = APContact::getByURL($url);
2593                 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2594                         return Protocol::ACTIVITYPUB;
2595                 } else {
2596                         return $network;
2597                 }
2598         }
2599
2600         /**
2601          * Takes a $uid and a url/handle and adds a new contact
2602          *
2603          * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2604          * dfrn_request page.
2605          *
2606          * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
2607          *
2608          * Returns an array
2609          * $return['success'] boolean true if successful
2610          * $return['message'] error text if success is false.
2611          *
2612          * Takes a $uid and a url/handle and adds a new contact
2613          *
2614          * @param int    $uid         The user id the contact should be created for
2615          * @param string $url         The profile URL of the contact
2616          * @param string $network
2617          * @return array
2618          * @throws HTTPException\InternalServerErrorException
2619          * @throws HTTPException\NotFoundException
2620          * @throws \ImagickException
2621          */
2622         public static function createFromProbeForUser(int $uid, string $url, string $network = ''): array
2623         {
2624                 $result = ['cid' => -1, 'success' => false, 'message' => ''];
2625
2626                 // remove ajax junk, e.g. Twitter
2627                 $url = str_replace('/#!/', '/', $url);
2628
2629                 if (!Network::isUrlAllowed($url)) {
2630                         $result['message'] = DI::l10n()->t('Disallowed profile URL.');
2631                         return $result;
2632                 }
2633
2634                 if (Network::isUrlBlocked($url)) {
2635                         $result['message'] = DI::l10n()->t('Blocked domain');
2636                         return $result;
2637                 }
2638
2639                 if (!$url) {
2640                         $result['message'] = DI::l10n()->t('Connect URL missing.');
2641                         return $result;
2642                 }
2643
2644                 $arr = ['url' => $url, 'contact' => []];
2645
2646                 Hook::callAll('follow', $arr);
2647
2648                 if (empty($arr)) {
2649                         $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
2650                         return $result;
2651                 }
2652
2653                 if (!empty($arr['contact']['name'])) {
2654                         $probed = false;
2655                         $ret = $arr['contact'];
2656                 } else {
2657                         $probed = true;
2658                         $ret = Probe::uri($url, $network, $uid);
2659
2660                         // Ensure that the public contact exists
2661                         if ($ret['network'] != Protocol::PHANTOM) {
2662                                 self::getIdForURL($url);
2663                         }
2664                 }
2665
2666                 if (($network != '') && ($ret['network'] != $network)) {
2667                         Logger::notice('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
2668                         return $result;
2669                 }
2670
2671                 // check if we already have a contact
2672                 // the poll url is more reliable than the profile url, as we may have
2673                 // indirect links or webfinger links
2674
2675                 $condition = ['uid' => $uid, 'poll' => [$ret['poll'], Strings::normaliseLink($ret['poll'])], 'network' => $ret['network'], 'pending' => false];
2676                 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2677                 if (!DBA::isResult($contact)) {
2678                         $condition = ['uid' => $uid, 'nurl' => Strings::normaliseLink($ret['url']), 'network' => $ret['network'], 'pending' => false];
2679                         $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2680                 }
2681
2682                 $protocol = self::getProtocol($ret['url'], $ret['network']);
2683
2684                 // This extra param just confuses things, remove it
2685                 if ($protocol === Protocol::DIASPORA) {
2686                         $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
2687                 }
2688
2689                 // do we have enough information?
2690                 if (empty($protocol) || ($protocol == Protocol::PHANTOM) || (empty($ret['url']) && empty($ret['addr']))) {
2691                         $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . EOL;
2692                         if (empty($ret['poll'])) {
2693                                 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2694                         }
2695                         if (empty($ret['name'])) {
2696                                 $result['message'] .= DI::l10n()->t('An author or name was not found.') . EOL;
2697                         }
2698                         if (empty($ret['url'])) {
2699                                 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . EOL;
2700                         }
2701                         if (strpos($ret['url'], '@') !== false) {
2702                                 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . EOL;
2703                                 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . EOL;
2704                         }
2705                         return $result;
2706                 }
2707
2708                 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
2709                         $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . EOL;
2710                         $ret['notify'] = '';
2711                 }
2712
2713                 if (!$ret['notify']) {
2714                         $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . EOL;
2715                 }
2716
2717                 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
2718
2719                 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
2720
2721                 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
2722
2723                 $pending = false;
2724                 if (($protocol == Protocol::ACTIVITYPUB) && isset($ret['manually-approve'])) {
2725                         $pending = (bool)$ret['manually-approve'];
2726                 }
2727
2728                 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2729                         $writeable = 1;
2730                 }
2731
2732                 if (DBA::isResult($contact)) {
2733                         // update contact
2734                         $new_relation = (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) ? self::FRIEND : self::SHARING);
2735
2736                         $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
2737                         self::update($fields, ['id' => $contact['id']]);
2738                 } else {
2739                         $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
2740
2741                         // create contact record
2742                         self::insert([
2743                                 'uid'     => $uid,
2744                                 'created' => DateTimeFormat::utcNow(),
2745                                 'url'     => $ret['url'],
2746                                 'nurl'    => Strings::normaliseLink($ret['url']),
2747                                 'addr'    => $ret['addr'],
2748                                 'alias'   => $ret['alias'],
2749                                 'batch'   => $ret['batch'],
2750                                 'notify'  => $ret['notify'],
2751                                 'poll'    => $ret['poll'],
2752                                 'poco'    => $ret['poco'],
2753                                 'name'    => $ret['name'],
2754                                 'nick'    => $ret['nick'],
2755                                 'network' => $ret['network'],
2756                                 'baseurl' => $ret['baseurl'],
2757                                 'gsid'    => $ret['gsid'] ?? null,
2758                                 'protocol' => $protocol,
2759                                 'pubkey'  => $ret['pubkey'],
2760                                 'rel'     => $new_relation,
2761                                 'priority'=> $ret['priority'],
2762                                 'writable'=> $writeable,
2763                                 'hidden'  => $hidden,
2764                                 'blocked' => 0,
2765                                 'readonly'=> 0,
2766                                 'pending' => $pending,
2767                                 'subhub'  => $subhub
2768                         ]);
2769                 }
2770
2771                 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
2772                 if (!DBA::isResult($contact)) {
2773                         $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . EOL;
2774                         return $result;
2775                 }
2776
2777                 $contact_id = $contact['id'];
2778                 $result['cid'] = $contact_id;
2779
2780                 Group::addMember(User::getDefaultGroup($uid), $contact_id);
2781
2782                 // Update the avatar
2783                 self::updateAvatar($contact_id, $ret['photo']);
2784
2785                 // pull feed and consume it, which should subscribe to the hub.
2786                 if ($contact['network'] == Protocol::OSTATUS) {
2787                         Worker::add(PRIORITY_HIGH, 'OnePoll', $contact_id, 'force');
2788                 }
2789
2790                 if ($probed) {
2791                         self::updateFromProbeArray($contact_id, $ret);
2792                 } else {
2793                         Worker::add(PRIORITY_HIGH, 'UpdateContact', $contact_id);
2794                 }
2795
2796                 $result['success'] = Protocol::follow($uid, $contact, $protocol);
2797
2798                 return $result;
2799         }
2800
2801         /**
2802          * @param array  $importer Owner (local user) data
2803          * @param array  $contact  Existing owner-specific contact data we want to expand the relationship with. Optional.
2804          * @param array  $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
2805          * @param bool   $sharing  True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
2806          * @param string $note     Introduction additional message
2807          * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
2808          * @throws HTTPException\InternalServerErrorException
2809          * @throws \ImagickException
2810          */
2811         public static function addRelationship(array $importer, array $contact, array $datarray, bool $sharing = false, string $note = '')
2812         {
2813                 // Should always be set
2814                 if (empty($datarray['author-id'])) {
2815                         return false;
2816                 }
2817
2818                 $fields = ['id', 'url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked'];
2819                 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
2820                 if (!DBA::isResult($pub_contact)) {
2821                         // Should never happen
2822                         return false;
2823                 }
2824
2825                 // Contact is blocked at node-level
2826                 if (self::isBlocked($datarray['author-id'])) {
2827                         return false;
2828                 }
2829
2830                 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
2831                 $name = $pub_contact['name'];
2832                 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
2833                 $nick = $pub_contact['nick'];
2834                 $network = $pub_contact['network'];
2835
2836                 // Ensure that we don't create a new contact when there already is one
2837                 $cid = self::getIdForURL($url, $importer['uid']);
2838                 if (!empty($cid)) {
2839                         $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
2840                 }
2841
2842                 self::clearFollowerFollowingEndpointCache($importer['uid']);
2843
2844                 if (!empty($contact)) {
2845                         if (!empty($contact['pending'])) {
2846                                 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
2847                                 return null;
2848                         }
2849
2850                         // Contact is blocked at user-level
2851                         if (!empty($contact['id']) && !empty($importer['id']) &&
2852                                 Contact\User::isBlocked($contact['id'], $importer['id'])) {
2853                                 return false;
2854                         }
2855
2856                         // Make sure that the existing contact isn't archived
2857                         self::unmarkForArchival($contact);
2858
2859                         if (($contact['rel'] == self::SHARING)
2860                                 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
2861                                 self::update(['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
2862                                                 ['id' => $contact['id'], 'uid' => $importer['uid']]);
2863                         }
2864
2865                         // Ensure to always have the correct network type, independent from the connection request method
2866                         self::updateFromProbe($contact['id']);
2867
2868                         Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
2869
2870                         return true;
2871                 } else {
2872                         // send email notification to owner?
2873                         if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
2874                                 Logger::notice('ignoring duplicated connection request from pending contact ' . $url);
2875                                 return null;
2876                         }
2877
2878                         // create contact record
2879                         $contact_id = self::insert([
2880                                 'uid'      => $importer['uid'],
2881                                 'created'  => DateTimeFormat::utcNow(),
2882                                 'url'      => $url,
2883                                 'nurl'     => Strings::normaliseLink($url),
2884                                 'name'     => $name,
2885                                 'nick'     => $nick,
2886                                 'network'  => $network,
2887                                 'rel'      => self::FOLLOWER,
2888                                 'blocked'  => 0,
2889                                 'readonly' => 0,
2890                                 'pending'  => 1,
2891                                 'writable' => 1,
2892                         ]);
2893
2894                         // Ensure to always have the correct network type, independent from the connection request method
2895                         self::updateFromProbe($contact_id);
2896
2897                         self::updateAvatar($contact_id, $photo, true);
2898
2899                         Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
2900
2901                         $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo'], ['id' => $contact_id]);
2902
2903                         /// @TODO Encapsulate this into a function/method
2904                         $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
2905                         $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
2906                         if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2907                                 // create notification
2908                                 if (is_array($contact_record)) {
2909                                         $intro = DI::introFactory()->createNew(
2910                                                 $importer['uid'],
2911                                                 $contact_record['id'],
2912                                                 $note
2913                                         );
2914                                         DI::intro()->save($intro);
2915                                 }
2916
2917                                 Group::addMember(User::getDefaultGroup($importer['uid']), $contact_record['id']);
2918
2919                                 if (($user['notify-flags'] & Notification\Type::INTRO) && $user['page-flags'] == User::PAGE_FLAGS_NORMAL) {
2920                                         DI::notify()->createFromArray([
2921                                                 'type'  => Notification\Type::INTRO,
2922                                                 'otype' => Notification\ObjectType::INTRO,
2923                                                 'verb'  => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
2924                                                 'uid'   => $user['uid'],
2925                                                 'cid'   => $contact_record['id'],
2926                                                 'link'  => DI::baseUrl() . '/notifications/intros',
2927                                         ]);
2928                                 }
2929                         } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2930                                 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
2931                                         self::createFromProbeForUser($importer['uid'], $url, $network);
2932                                 }
2933
2934                                 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
2935                                 $fields = ['pending' => false];
2936                                 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
2937                                         $fields['rel'] = self::FRIEND;
2938                                 }
2939
2940                                 self::update($fields, $condition);
2941
2942                                 return true;
2943                         }
2944                 }
2945
2946                 return null;
2947         }
2948
2949         /**
2950          * Update the local relationship when a local user loses a follower
2951          *
2952          * @param array $contact User-specific contact (uid != 0) array
2953          * @return void
2954          * @throws HTTPException\InternalServerErrorException
2955          * @throws \ImagickException
2956          */
2957         public static function removeFollower(array $contact)
2958         {
2959                 if (in_array($contact['rel'] ?? [], [self::FRIEND, self::SHARING])) {
2960                         self::update(['rel' => self::SHARING], ['id' => $contact['id']]);
2961                 } elseif (!empty($contact['id'])) {
2962                         self::remove($contact['id']);
2963                 } else {
2964                         DI::logger()->info('Couldn\'t remove follower because of invalid contact array', ['contact' => $contact, 'callstack' => System::callstack()]);
2965                         return;
2966                 }
2967
2968                 self::clearFollowerFollowingEndpointCache($contact['uid']);
2969
2970                 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
2971
2972                 DI::notification()->deleteForUserByVerb($contact['uid'], Activity::FOLLOW, ['actor-id' => $cdata['public']]);
2973         }
2974
2975         /**
2976          * Update the local relationship when a local user unfollow a contact.
2977          * Removes the contact for sharing-only protocols (feed and mail).
2978          *
2979          * @param array $contact User-specific contact (uid != 0) array
2980          * @throws HTTPException\InternalServerErrorException
2981          */
2982         public static function removeSharer(array $contact)
2983         {
2984                 self::clearFollowerFollowingEndpointCache($contact['uid']);
2985
2986                 if ($contact['rel'] == self::SHARING || in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2987                         self::remove($contact['id']);
2988                 } else {
2989                         self::update(['rel' => self::FOLLOWER], ['id' => $contact['id']]);
2990                 }
2991         }
2992
2993         /**
2994          * Create a birthday event.
2995          *
2996          * Update the year and the birthday.
2997          */
2998         public static function updateBirthdays()
2999         {
3000                 $condition = [
3001                         '`bd` > ?
3002                         AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
3003                         AND NOT `contact`.`pending`
3004                         AND NOT `contact`.`hidden`
3005                         AND NOT `contact`.`blocked`
3006                         AND NOT `contact`.`archive`
3007                         AND NOT `contact`.`deleted`',
3008                         DBA::NULL_DATE,
3009                         self::SHARING,
3010                         self::FRIEND
3011                 ];
3012
3013                 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
3014
3015                 while ($contact = DBA::fetch($contacts)) {
3016                         Logger::notice('update_contact_birthday: ' . $contact['bd']);
3017
3018                         $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
3019
3020                         if (Event::createBirthday($contact, $nextbd)) {
3021                                 // update bdyear
3022                                 DBA::update(
3023                                         'contact',
3024                                         ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
3025                                         ['id' => $contact['id']]
3026                                 );
3027                         }
3028                 }
3029                 DBA::close($contacts);
3030         }
3031
3032         /**
3033          * Remove the unavailable contact ids from the provided list
3034          *
3035          * @param array $contact_ids Contact id list
3036          * @return array
3037          * @throws \Exception
3038          */
3039         public static function pruneUnavailable(array $contact_ids): array
3040         {
3041                 if (empty($contact_ids)) {
3042                         return [];
3043                 }
3044
3045                 $contacts = self::selectToArray(['id'], [
3046                         'id'      => $contact_ids,
3047                         'blocked' => false,
3048                         'pending' => false,
3049                         'archive' => false,
3050                 ]);
3051
3052                 return array_column($contacts, 'id');
3053         }
3054
3055         /**
3056          * Returns a magic link to authenticate remote visitors
3057          *
3058          * @todo  check if the return is either a fully qualified URL or a relative path to Friendica basedir
3059          *
3060          * @param string $contact_url The address of the target contact profile
3061          * @param string $url         An url that we will be redirected to after the authentication
3062          *
3063          * @return string with "redir" link
3064          * @throws HTTPException\InternalServerErrorException
3065          * @throws \ImagickException
3066          */
3067         public static function magicLink(string $contact_url, string $url = ''): string
3068         {
3069                 if (!Session::isAuthenticated()) {
3070                         return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3071                 }
3072
3073                 $contact = self::getByURL($contact_url, false);
3074                 if (empty($contact)) {
3075                         return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3076                 }
3077
3078                 // Prevents endless loop in case only a non-public contact exists for the contact URL
3079                 unset($contact['uid']);
3080
3081                 return self::magicLinkByContact($contact, $url ?: $contact_url);
3082         }
3083
3084         /**
3085          * Returns a magic link to authenticate remote visitors
3086          *
3087          * @param integer $cid The contact id of the target contact profile
3088          * @param string  $url An url that we will be redirected to after the authentication
3089          *
3090          * @return string with "redir" link
3091          * @throws HTTPException\InternalServerErrorException
3092          * @throws \ImagickException
3093          */
3094         public static function magicLinkById(int $cid, string $url = ''): string
3095         {
3096                 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
3097
3098                 return self::magicLinkByContact($contact, $url);
3099         }
3100
3101         /**
3102          * Returns a magic link to authenticate remote visitors
3103          *
3104          * @param array  $contact The contact array with "uid", "network" and "url"
3105          * @param string $url     An url that we will be redirected to after the authentication
3106          *
3107          * @return string with "redir" link
3108          * @throws HTTPException\InternalServerErrorException
3109          * @throws \ImagickException
3110          */
3111         public static function magicLinkByContact(array $contact, string $url = ''): string
3112         {
3113                 $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
3114
3115                 if (!Session::isAuthenticated()) {
3116                         return $destination;
3117                 }
3118
3119                 // Only redirections to the same host do make sense
3120                 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
3121                         return $url;
3122                 }
3123
3124                 if (DI::pConfig()->get(local_user(), 'system', 'stay_local') && ($url == '')) {
3125                         return 'contact/' . $contact['id'] . '/conversations';
3126                 }
3127
3128                 if (!empty($contact['network']) && $contact['network'] != Protocol::DFRN) {
3129                         return $destination;
3130                 }
3131
3132                 if (empty($contact['id'])) {
3133                         return $destination;
3134                 }
3135
3136                 $redirect = 'redir/' . $contact['id'];
3137
3138                 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
3139                         $redirect .= '?url=' . $url;
3140                 }
3141
3142                 return $redirect;
3143         }
3144
3145         /**
3146          * Is the contact a forum?
3147          *
3148          * @param integer $contactid ID of the contact
3149          *
3150          * @return boolean "true" if it is a forum
3151          */
3152         public static function isForum(int $contactid): bool
3153         {
3154                 $fields = ['contact-type'];
3155                 $condition = ['id' => $contactid];
3156                 $contact = DBA::selectFirst('contact', $fields, $condition);
3157                 if (!DBA::isResult($contact)) {
3158                         return false;
3159                 }
3160
3161                 // Is it a forum?
3162                 return ($contact['contact-type'] == self::TYPE_COMMUNITY);
3163         }
3164
3165         /**
3166          * Can the remote contact receive private messages?
3167          *
3168          * @param array $contact
3169          * @return bool
3170          */
3171         public static function canReceivePrivateMessages(array $contact): bool
3172         {
3173                 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
3174                 $self = $contact['self'] ?? false;
3175
3176                 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;
3177         }
3178
3179         /**
3180          * Search contact table by nick or name
3181          *
3182          * @param string $search Name or nick
3183          * @param string $mode   Search mode (e.g. "community")
3184          * @param int    $uid    User ID
3185          *
3186          * @return array with search results
3187          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3188          */
3189         public static function searchByName(string $search, string $mode = '', int $uid = 0): array
3190         {
3191                 if (empty($search)) {
3192                         return [];
3193                 }
3194
3195                 // check supported networks
3196                 $networks = [Protocol::DFRN, Protocol::ACTIVITYPUB];
3197                 if (DI::config()->get('system', 'diaspora_enabled')) {
3198                         $networks[] = Protocol::DIASPORA;
3199                 }
3200
3201                 if (!DI::config()->get('system', 'ostatus_disabled')) {
3202                         $networks[] = Protocol::OSTATUS;
3203                 }
3204
3205                 $condition = ['network' => $networks, 'failed' => false, 'deleted' => false, 'uid' => $uid];
3206
3207                 if ($uid == 0) {
3208                         $condition['blocked'] = false;
3209                 }
3210
3211                 // check if we search only communities or every contact
3212                 if ($mode === 'community') {
3213                         $condition['contact-type'] = self::TYPE_COMMUNITY;
3214                 }
3215
3216                 $search .= '%';
3217
3218                 $condition = DBA::mergeConditions($condition,
3219                         ["(NOT `unsearchable` OR `nurl` IN (SELECT `nurl` FROM `owner-view` WHERE `publish` OR `net-publish`))
3220                         AND (`addr` LIKE ? OR `name` LIKE ? OR `nick` LIKE ?)", $search, $search, $search]);
3221
3222                 $contacts = self::selectToArray([], $condition);
3223                 return $contacts;
3224         }
3225
3226         /**
3227          * Add public contacts from an array
3228          *
3229          * @param array $urls
3230          * @return array result "count", "added" and "updated"
3231          */
3232         public static function addByUrls(array $urls): array
3233         {
3234                 $added = 0;
3235                 $updated = 0;
3236                 $unchanged = 0;
3237                 $count = 0;
3238
3239                 foreach ($urls as $url) {
3240                         if (empty($url) || !is_string($url)) {
3241                                 continue;
3242                         }
3243                         $contact = self::getByURL($url, false, ['id', 'updated']);
3244                         if (empty($contact['id'])) {
3245                                 Worker::add(PRIORITY_LOW, 'AddContact', 0, $url);
3246                                 ++$added;
3247                         } elseif ($contact['updated'] < DateTimeFormat::utc('now -7 days')) {
3248                                 Worker::add(PRIORITY_LOW, 'UpdateContact', $contact['id']);
3249                                 ++$updated;
3250                         } else {
3251                                 ++$unchanged;
3252                         }
3253                         ++$count;
3254                 }
3255
3256                 return ['count' => $count, 'added' => $added, 'updated' => $updated, 'unchanged' => $unchanged];
3257         }
3258
3259         /**
3260          * Returns a random, global contact array of the current node
3261          *
3262          * @return array The profile array
3263          * @throws Exception
3264          */
3265         public static function getRandomContact(): array
3266         {
3267                 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], [
3268                         "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",
3269                         0, Protocol::DFRN, DateTimeFormat::utc('now - 1 month'),
3270                 ], ['order' => ['RAND()']]);
3271
3272                 if (DBA::isResult($contact)) {
3273                         return $contact;
3274                 }
3275
3276                 return [];
3277         }
3278 }