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