]> git.mxchange.org Git - friendica.git/blob - src/Model/Contact.php
Merge pull request #13484 from xundeenergie/better-navigation
[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'  => [$mention_label, $mention_url, false],
1243                         ];
1244                 } else {
1245                         $menu = [
1246                                 'status'   => [DI::l10n()->t('View Status'), $status_link, true],
1247                                 'profile'  => [DI::l10n()->t('View Profile'), $profile_link, true],
1248                                 'photos'   => [DI::l10n()->t('View Photos'), $photos_link, true],
1249                                 'network'  => [$network_label, $network_url, false],
1250                                 'edit'     => [DI::l10n()->t('View Contact'), $contact_url, false],
1251                                 'pm'       => [DI::l10n()->t('Send PM'), $pm_url, false],
1252                                 'follow'   => [DI::l10n()->t('Connect/Follow'), $follow_link, true],
1253                                 'unfollow' => [DI::l10n()->t('Unfollow'), $unfollow_link, true],
1254                                 'mention'  => [$mention_label, $mention_url, false],
1255                         ];
1256
1257                         if (!empty($contact['pending'])) {
1258                                 try {
1259                                         $intro          = DI::intro()->selectForContact($contact['id']);
1260                                         $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro->id, true];
1261                                 } catch (IntroductionNotFoundException $exception) {
1262                                         DI::logger()->error('Pending contact doesn\'t have an introduction.', ['exception' => $exception]);
1263                                 }
1264                         }
1265                 }
1266
1267                 $args = ['contact' => $contact, 'menu' => &$menu];
1268
1269                 Hook::callAll('contact_photo_menu', $args);
1270
1271                 $menucondensed = [];
1272
1273                 foreach ($menu as $menuname => $menuitem) {
1274                         if ($menuitem[1] != '') {
1275                                 $menucondensed[$menuname] = $menuitem;
1276                         }
1277                 }
1278
1279                 return $menucondensed;
1280         }
1281
1282         /**
1283          * Fetch the contact id for a given URL and user
1284          *
1285          * First lookup in the contact table to find a record matching either `url`, `nurl`,
1286          * `addr` or `alias`.
1287          *
1288          * If there's no record and we aren't looking for a public contact, we quit.
1289          * If there's one, we check that it isn't time to update the picture else we
1290          * directly return the found contact id.
1291          *
1292          * Second, we probe the provided $url whether it's http://server.tld/profile or
1293          * nick@server.tld. We quit if we can't get any info back.
1294          *
1295          * Third, we create the contact record if it doesn't exist
1296          *
1297          * Fourth, we update the existing record with the new data (avatar, alias, nick)
1298          * if there's any updates
1299          *
1300          * @param string  $url       Contact URL
1301          * @param integer $uid       The user id for the contact (0 = public contact)
1302          * @param boolean $update    true = always update, false = never update, null = update when not found
1303          * @param array   $default   Default value for creating the contact when everything else fails
1304          *
1305          * @return integer Contact ID
1306          * @throws HTTPException\InternalServerErrorException
1307          * @throws \ImagickException
1308          */
1309         public static function getIdForURL(string $url = null, int $uid = 0, $update = null, array $default = []): int
1310         {
1311                 $contact_id = 0;
1312
1313                 if (empty($url)) {
1314                         Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
1315                         return 0;
1316                 }
1317
1318                 $contact = self::getByURL($url, false, ['id', 'network', 'uri-id', 'next-update', 'local-data'], $uid);
1319
1320                 if (!empty($contact)) {
1321                         $contact_id = $contact['id'];
1322
1323                         $background_update = DI::config()->get('system', 'update_active_contacts') ? $contact['local-data'] : true;
1324
1325                         if ($background_update && !self::isLocal($url) && Protocol::supportsProbe($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
1326                                 try {
1327                                         UpdateContact::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], $contact['id']);
1328                                 } catch (\InvalidArgumentException $e) {
1329                                         Logger::notice($e->getMessage(), ['contact' => $contact]);
1330                                 }
1331                         }
1332
1333                         if (empty($update) && (!empty($contact['uri-id']) || is_bool($update))) {
1334                                 Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1335                                 return $contact_id;
1336                         }
1337                 } elseif ($uid != 0) {
1338                         Logger::debug('Contact does not exist for the user', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1339                         return 0;
1340                 } elseif (empty($default) && !is_null($update) && !$update) {
1341                         Logger::info('Contact not found, update not desired', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1342                         return 0;
1343                 }
1344
1345                 $data = [];
1346
1347                 if (empty($default['network']) || $update) {
1348                         $data = Probe::uri($url, '', $uid);
1349
1350                         // Take the default values when probing failed
1351                         if (!empty($default) && !in_array($data['network'], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1352                                 $data = array_merge($data, $default);
1353                         }
1354                 } elseif (!empty($default['network'])) {
1355                         $data = $default;
1356                 }
1357
1358                 if (($uid == 0) && (empty($data['network']) || ($data['network'] == Protocol::PHANTOM))) {
1359                         // Fetch data for the public contact via the first found personal contact
1360                         /// @todo Check if this case can happen at all (possibly with mail accounts?)
1361                         $fields = [
1362                                 'name', 'nick', 'url', 'addr', 'alias', 'avatar', 'header', 'contact-type',
1363                                 'keywords', 'location', 'about', 'unsearchable', 'batch', 'notify', 'poll',
1364                                 'request', 'confirm', 'poco', 'subscribe', 'network', 'baseurl', 'gsid'
1365                         ];
1366
1367                         $personal_contact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `uid` != 0", $url]);
1368                         if (!DBA::isResult($personal_contact)) {
1369                                 $personal_contact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `uid` != 0", Strings::normaliseLink($url)]);
1370                         }
1371
1372                         if (DBA::isResult($personal_contact)) {
1373                                 Logger::info('Take contact data from personal contact', ['url' => $url, 'update' => $update, 'contact' => $personal_contact, 'callstack' => System::callstack(20)]);
1374                                 $data = $personal_contact;
1375                                 $data['photo'] = $personal_contact['avatar'];
1376                                 $data['account-type'] = $personal_contact['contact-type'];
1377                                 $data['hide'] = $personal_contact['unsearchable'];
1378                                 unset($data['avatar']);
1379                                 unset($data['contact-type']);
1380                                 unset($data['unsearchable']);
1381                         }
1382                 }
1383
1384                 if (empty($data['network']) || ($data['network'] == Protocol::PHANTOM)) {
1385                         Logger::notice('No valid network found', ['url' => $url, 'uid' => $uid, 'default' => $default, 'update' => $update, 'callstack' => System::callstack(20)]);
1386                         return 0;
1387                 }
1388
1389                 if (!$contact_id && !empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1390                         Logger::info('Contact is a tombstone. It will not be inserted', ['url' => $url, 'uid' => $uid]);
1391                         return 0;
1392                 }
1393
1394                 if (!$contact_id) {
1395                         $urls = [Strings::normaliseLink($url), Strings::normaliseLink($data['url'])];
1396                         if (!empty($data['alias'])) {
1397                                 $urls[] = Strings::normaliseLink($data['alias']);
1398                         }
1399                         $contact = self::selectFirst(['id'], ['nurl' => $urls, 'uid' => $uid]);
1400                         if (!empty($contact['id'])) {
1401                                 $contact_id = $contact['id'];
1402                                 Logger::info('Fetched id by url', ['cid' => $contact_id, 'uid' => $uid, 'url' => $url, 'data' => $data]);
1403                         }
1404                 }
1405
1406                 if (!$contact_id) {
1407                         // We only insert the basic data. The rest will be done in "updateFromProbeArray"
1408                         $fields = [
1409                                 'uid'       => $uid,
1410                                 'url'       => $data['url'],
1411                                 'baseurl'   => $data['baseurl'] ?? '',
1412                                 'nurl'      => Strings::normaliseLink($data['url']),
1413                                 'network'   => $data['network'],
1414                                 'created'   => DateTimeFormat::utcNow(),
1415                                 'rel'       => self::SHARING,
1416                                 'writable'  => 1,
1417                                 'blocked'   => 0,
1418                                 'readonly'  => 0,
1419                                 'pending'   => 0,
1420                         ];
1421
1422                         $condition = ['nurl' => Strings::normaliseLink($data['url']), 'uid' => $uid, 'deleted' => false];
1423
1424                         // Before inserting we do check if the entry does exist now.
1425                         $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1426                         if (DBA::isResult($contact)) {
1427                                 $contact_id = $contact['id'];
1428                                 Logger::notice('Contact had been created (shortly) before', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1429                         } else {
1430                                 $contact_id = self::insert($fields);
1431                                 if ($contact_id) {
1432                                         Logger::info('Contact inserted', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1433                                 }
1434                         }
1435
1436                         if (!$contact_id) {
1437                                 Logger::warning('Contact was not inserted', ['url' => $url, 'uid' => $uid]);
1438                                 return 0;
1439                         }
1440                 } else {
1441                         Logger::info('Contact will be updated', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1442                 }
1443
1444                 if ($data['network'] == Protocol::DIASPORA) {
1445                         try {
1446                                 DI::dsprContact()->updateFromProbeArray($data);
1447                         } catch (HTTPException\NotFoundException $e) {
1448                                 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data]);
1449                         } catch (\InvalidArgumentException $e) {
1450                                 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data]);
1451                         }
1452                 } elseif (!empty($data['networks'][Protocol::DIASPORA])) {
1453                         try {
1454                                 DI::dsprContact()->updateFromProbeArray($data['networks'][Protocol::DIASPORA]);
1455                         } catch (HTTPException\NotFoundException $e) {
1456                                 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data['networks'][Protocol::DIASPORA]]);
1457                         } catch (\InvalidArgumentException $e) {
1458                                 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data['networks'][Protocol::DIASPORA]]);
1459                         }
1460                 }
1461
1462                 self::updateFromProbeArray($contact_id, $data);
1463
1464                 // Don't return a number for a deleted account
1465                 if (!empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1466                         Logger::info('Contact is a tombstone', ['url' => $url, 'uid' => $uid]);
1467                         return 0;
1468                 }
1469
1470                 return $contact_id;
1471         }
1472
1473         /**
1474          * Checks if the contact is archived
1475          *
1476          * @param int $cid contact id
1477          *
1478          * @return boolean Is the contact archived?
1479          * @throws HTTPException\InternalServerErrorException
1480          */
1481         public static function isArchived(int $cid): bool
1482         {
1483                 if ($cid == 0) {
1484                         return false;
1485                 }
1486
1487                 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1488                 if (!DBA::isResult($contact)) {
1489                         return false;
1490                 }
1491
1492                 if ($contact['archive']) {
1493                         return true;
1494                 }
1495
1496                 // Check status of ActivityPub endpoints
1497                 $apcontact = APContact::getByURL($contact['url'], false);
1498                 if (!empty($apcontact)) {
1499                         if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1500                                 return true;
1501                         }
1502
1503                         if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1504                                 return true;
1505                         }
1506                 }
1507
1508                 // Check status of Diaspora endpoints
1509                 if (!empty($contact['batch'])) {
1510                         $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1511                         return DBA::exists('contact', $condition);
1512                 }
1513
1514                 return false;
1515         }
1516
1517         /**
1518          * Checks if the contact is blocked
1519          *
1520          * @param int $cid contact id
1521          * @return boolean Is the contact blocked?
1522          * @throws HTTPException\InternalServerErrorException
1523          */
1524         public static function isBlocked(int $cid): bool
1525         {
1526                 if ($cid == 0) {
1527                         return false;
1528                 }
1529
1530                 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1531                 if (!DBA::isResult($blocked)) {
1532                         return false;
1533                 }
1534
1535                 if (Network::isUrlBlocked($blocked['url'])) {
1536                         return true;
1537                 }
1538
1539                 return (bool) $blocked['blocked'];
1540         }
1541
1542         /**
1543          * Checks if the contact is hidden
1544          *
1545          * @param int $cid contact id
1546          * @return boolean Is the contact hidden?
1547          * @throws \Exception
1548          */
1549         public static function isHidden(int $cid): bool
1550         {
1551                 if ($cid == 0) {
1552                         return false;
1553                 }
1554
1555                 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1556                 if (!DBA::isResult($hidden)) {
1557                         return false;
1558                 }
1559                 return (bool) $hidden['hidden'];
1560         }
1561
1562         /**
1563          * Returns posts from a given contact url
1564          *
1565          * @param string $contact_url Contact URL
1566          * @param bool   $thread_mode
1567          * @param int    $update      Update mode
1568          * @param int    $parent      Item parent ID for the update mode
1569          * @param bool   $only_media  Only display media content
1570          * @return string posts in HTML
1571          * @throws \Exception
1572          */
1573         public static function getPostsFromUrl(string $contact_url, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1574         {
1575                 return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent, $only_media);
1576         }
1577
1578         /**
1579          * Returns posts from a given contact id
1580          *
1581          * @param int  $cid         Contact ID
1582          * @param bool $thread_mode
1583          * @param int  $update      Update mode
1584          * @param int  $parent      Item parent ID for the update mode
1585          * @param bool $only_media  Only display media content
1586          * @return string posts in HTML
1587          * @throws \Exception
1588          */
1589         public static function getPostsFromId(int $cid, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1590         {
1591                 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1592                 if (!DBA::isResult($contact)) {
1593                         return '';
1594                 }
1595
1596                 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1597                         $sql = "(`uid` = 0 OR (`uid` = ? AND NOT `global`))";
1598                 } else {
1599                         $sql = "`uid` = ?";
1600                 }
1601
1602                 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1603
1604                 if ($thread_mode) {
1605                         $condition = [
1606                                 "((`$contact_field` = ? AND `gravity` = ?) OR (`author-id` = ? AND `gravity` = ? AND `vid` = ? AND `protocol` != ? AND `thr-parent-id` = `parent-uri-id`)) AND " . $sql,
1607                                 $cid, Item::GRAVITY_PARENT, $cid, Item::GRAVITY_ACTIVITY, Verb::getID(Activity::ANNOUNCE), Conversation::PARCEL_DIASPORA, DI::userSession()->getLocalUserId()
1608                         ];
1609                 } else {
1610                         $condition = [
1611                                 "`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1612                                 $cid, Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT, DI::userSession()->getLocalUserId()
1613                         ];
1614                 }
1615
1616                 if (!empty($parent)) {
1617                         $condition = DBA::mergeConditions($condition, ['parent' => $parent]);
1618                 } else {
1619                         $last_received = isset($_GET['last_received']) ? DateTimeFormat::utc($_GET['last_received']) : '';
1620                         if (!empty($last_received)) {
1621                                 $condition = DBA::mergeConditions($condition, ["`received` < ?", $last_received]);
1622                         }
1623                 }
1624
1625                 if ($only_media) {
1626                         $condition = DBA::mergeConditions($condition, [
1627                                 "`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
1628                                 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO
1629                         ]);
1630                 }
1631
1632                 if (DI::mode()->isMobile()) {
1633                         $itemsPerPage = DI::pConfig()->get(
1634                                 DI::userSession()->getLocalUserId(),
1635                                 'system',
1636                                 'itemspage_mobile_network',
1637                                 DI::config()->get('system', 'itemspage_network_mobile')
1638                         );
1639                 } else {
1640                         $itemsPerPage = DI::pConfig()->get(
1641                                 DI::userSession()->getLocalUserId(),
1642                                 'system',
1643                                 'itemspage_network',
1644                                 DI::config()->get('system', 'itemspage_network')
1645                         );
1646                 }
1647
1648                 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1649
1650                 $params = ['order' => ['received' => true], 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1651
1652                 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'infinite_scroll')) {
1653                         $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
1654                         $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
1655                 } else {
1656                         $o = '';
1657                 }
1658
1659                 if ($thread_mode) {
1660                         $fields = ['uri-id', 'thr-parent-id', 'gravity', 'author-id', 'commented'];
1661                         $items = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1662
1663                         if ($pager->getStart() == 0) {
1664                                 $cdata = self::getPublicAndUserContactID($cid, DI::userSession()->getLocalUserId());
1665                                 if (!empty($cdata['public'])) {
1666                                         $pinned = Post\Collection::selectToArrayForContact($cdata['public'], Post\Collection::FEATURED, $fields);
1667                                         $items = array_merge($items, $pinned);
1668                                 }
1669                         }
1670
1671                         $o .= DI::conversation()->render($items, ConversationContent::MODE_CONTACTS, $update, false, 'pinned_commented', DI::userSession()->getLocalUserId());
1672                 } else {
1673                         $fields = array_merge(Item::DISPLAY_FIELDLIST, ['featured']);
1674                         $items = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1675
1676                         if ($pager->getStart() == 0) {
1677                                 $cdata = self::getPublicAndUserContactID($cid, DI::userSession()->getLocalUserId());
1678                                 if (!empty($cdata['public'])) {
1679                                         $condition = [
1680                                                 "`uri-id` IN (SELECT `uri-id` FROM `collection-view` WHERE `cid` = ? AND `type` = ?)",
1681                                                 $cdata['public'], Post\Collection::FEATURED
1682                                         ];
1683                                         $pinned = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1684                                         $items = array_merge($pinned, $items);
1685                                 }
1686                         }
1687
1688                         $o .= DI::conversation()->render($items, ConversationContent::MODE_CONTACT_POSTS, $update);
1689                 }
1690
1691                 if (!$update) {
1692                         if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'infinite_scroll')) {
1693                                 $o .= HTML::scrollLoader();
1694                         } else {
1695                                 $o .= $pager->renderMinimal(count($items));
1696                         }
1697                 }
1698
1699                 return $o;
1700         }
1701
1702         /**
1703          * Returns the account type name
1704          *
1705          * The function can be called with either the user or the contact array
1706          *
1707          * @param int $type type of contact or account
1708          * @return string
1709          */
1710         public static function getAccountType(int $type): string
1711         {
1712                 switch ($type) {
1713                         case self::TYPE_ORGANISATION:
1714                                 $account_type = DI::l10n()->t("Organisation");
1715                                 break;
1716
1717                         case self::TYPE_NEWS:
1718                                 $account_type = DI::l10n()->t('News');
1719                                 break;
1720
1721                         case self::TYPE_COMMUNITY:
1722                                 $account_type = DI::l10n()->t("Group");
1723                                 break;
1724
1725                         default:
1726                                 $account_type = "";
1727                                 break;
1728                 }
1729
1730                 return $account_type;
1731         }
1732
1733         /**
1734          * Blocks a contact
1735          *
1736          * @param int $cid Contact id to block
1737          * @param string $reason Block reason
1738          * @return bool Whether it was successful
1739          */
1740         public static function block(int $cid, string $reason = null): bool
1741         {
1742                 $return = self::update(['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1743
1744                 return $return;
1745         }
1746
1747         /**
1748          * Unblocks a contact
1749          *
1750          * @param int $cid Contact id to unblock
1751          * @return bool Whether it was successful
1752          */
1753         public static function unblock(int $cid): bool
1754         {
1755                 $return = self::update(['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1756
1757                 return $return;
1758         }
1759
1760         /**
1761          * Ensure that cached avatar exist
1762          *
1763          * @param integer $cid Contact id
1764          */
1765         public static function checkAvatarCache(int $cid)
1766         {
1767                 $contact = DBA::selectFirst('contact', ['url', 'network', 'avatar', 'photo', 'thumb', 'micro'], ['id' => $cid, 'uid' => 0, 'self' => false]);
1768                 if (!DBA::isResult($contact)) {
1769                         return;
1770                 }
1771
1772                 if (Network::isLocalLink($contact['url'])) {
1773                         return;
1774                 }
1775
1776                 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || DI::config()->get('system', 'cache_contact_avatar')) {
1777                         if (!empty($contact['avatar']) && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1778                                 Logger::info('Adding avatar cache', ['id' => $cid, 'contact' => $contact]);
1779                                 self::updateAvatar($cid, $contact['avatar'], true);
1780                                 return;
1781                         }
1782                 } elseif (Photo::isPhotoURI($contact['photo']) || Photo::isPhotoURI($contact['thumb']) || Photo::isPhotoURI($contact['micro'])) {
1783                         Logger::info('Replacing legacy avatar cache', ['id' => $cid, 'contact' => $contact]);
1784                         self::updateAvatar($cid, $contact['avatar'], true);
1785                         return;
1786                 } elseif (DI::config()->get('system', 'avatar_cache') && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1787                         Logger::info('Adding avatar cache file', ['id' => $cid, 'contact' => $contact]);
1788                         self::updateAvatar($cid, $contact['avatar'], true);
1789                         return;
1790                 }
1791         }
1792
1793         /**
1794          * Return the photo path for a given contact array in the given size
1795          *
1796          * @param array  $contact   contact array
1797          * @param string $size      Size of the avatar picture
1798          * @param bool   $no_update Don't perform an update if no cached avatar was found
1799          * @return string photo path
1800          */
1801         private static function getAvatarPath(array $contact, string $size, bool $no_update = false): string
1802         {
1803                 $contact = self::checkAvatarCacheByArray($contact, $no_update);
1804
1805                 if (DI::config()->get('system', 'avatar_cache')) {
1806                         switch ($size) {
1807                                 case Proxy::SIZE_MICRO:
1808                                         if (!empty($contact['micro']) && !Photo::isPhotoURI($contact['micro'])) {
1809                                                 return $contact['micro'];
1810                                         }
1811                                         break;
1812                                 case Proxy::SIZE_THUMB:
1813                                         if (!empty($contact['thumb']) && !Photo::isPhotoURI($contact['thumb'])) {
1814                                                 return $contact['thumb'];
1815                                         }
1816                                         break;
1817                                 case Proxy::SIZE_SMALL:
1818                                         if (!empty($contact['photo']) && !Photo::isPhotoURI($contact['photo'])) {
1819                                                 return $contact['photo'];
1820                                         }
1821                                         break;
1822                         }
1823                 }
1824
1825                 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
1826         }
1827
1828         /**
1829          * Return the photo path for a given contact array
1830          *
1831          * @param array  $contact   Contact array
1832          * @param bool   $no_update Don't perform an update if no cached avatar was found
1833          * @return string photo path
1834          */
1835         public static function getPhoto(array $contact, bool $no_update = false): string
1836         {
1837                 return self::getAvatarPath($contact, Proxy::SIZE_SMALL, $no_update);
1838         }
1839
1840         /**
1841          * Return the photo path (thumb size) for a given contact array
1842          *
1843          * @param array  $contact   Contact array
1844          * @param bool   $no_update Don't perform an update if no cached avatar was found
1845          * @return string photo path
1846          */
1847         public static function getThumb(array $contact, bool $no_update = false): string
1848         {
1849                 return self::getAvatarPath($contact, Proxy::SIZE_THUMB, $no_update);
1850         }
1851
1852         /**
1853          * Return the photo path (micro size) for a given contact array
1854          *
1855          * @param array  $contact   Contact array
1856          * @param bool   $no_update Don't perform an update if no cached avatar was found
1857          * @return string photo path
1858          */
1859         public static function getMicro(array $contact, bool $no_update = false): string
1860         {
1861                 return self::getAvatarPath($contact, Proxy::SIZE_MICRO, $no_update);
1862         }
1863
1864         /**
1865          * Check the given contact array for avatar cache fields
1866          *
1867          * @param array $contact
1868          * @param bool  $no_update Don't perform an update if no cached avatar was found
1869          * @return array contact array with avatar cache fields
1870          */
1871         private static function checkAvatarCacheByArray(array $contact, bool $no_update = false): array
1872         {
1873                 $update = false;
1874                 $contact_fields = [];
1875                 $fields = ['photo', 'thumb', 'micro'];
1876                 foreach ($fields as $field) {
1877                         if (isset($contact[$field])) {
1878                                 $contact_fields[] = $field;
1879                         }
1880                         if (isset($contact[$field]) && empty($contact[$field])) {
1881                                 $update = true;
1882                         }
1883                 }
1884
1885                 if (!$update || $no_update) {
1886                         return $contact;
1887                 }
1888
1889                 $local = !empty($contact['url']) && Network::isLocalLink($contact['url']);
1890
1891                 if (!$local && !empty($contact['id']) && !empty($contact['avatar'])) {
1892                         self::updateAvatar($contact['id'], $contact['avatar'], true);
1893
1894                         $new_contact = self::getById($contact['id'], $contact_fields);
1895                         if (DBA::isResult($new_contact)) {
1896                                 // We only update the cache fields
1897                                 $contact = array_merge($contact, $new_contact);
1898                         }
1899                 } elseif ($local && !empty($contact['avatar'])) {
1900                         return $contact;
1901                 }
1902
1903                 /// add the default avatars if the fields aren't filled
1904                 if (isset($contact['photo']) && empty($contact['photo'])) {
1905                         $contact['photo'] = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1906                 }
1907                 if (isset($contact['thumb']) && empty($contact['thumb'])) {
1908                         $contact['thumb'] = self::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
1909                 }
1910                 if (isset($contact['micro']) && empty($contact['micro'])) {
1911                         $contact['micro'] = self::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
1912                 }
1913
1914                 return $contact;
1915         }
1916
1917         /**
1918          * Fetch the default header for the given contact
1919          *
1920          * @param array $contact  contact array
1921          * @return string avatar URL
1922          */
1923         public static function getDefaultHeader(array $contact): string
1924         {
1925                 if (!empty($contact['header'])) {
1926                         return $contact['header'];
1927                 }
1928
1929                 if (!empty($contact['gsid'])) {
1930                         // Use default banners for certain platforms
1931                         $gserver = DBA::selectFirst('gserver', ['platform'], ['id' => $contact['gsid']]);
1932                         $platform = strtolower($gserver['platform'] ?? '');
1933                 } else {
1934                         $platform = '';
1935                 }
1936
1937                 switch ($platform) {
1938                         case 'friendica':
1939                         case 'friendika':
1940                                 $header = DI::baseUrl() . (new Header(DI::config()))->getMastodonBannerPath();
1941                                 break;
1942                         case 'diaspora':
1943                                 /**
1944                                  * Picture credits
1945                                  * @author  John Liu <https://www.flickr.com/photos/8047705@N02/>
1946                                  * @license CC BY 2.0 https://creativecommons.org/licenses/by/2.0/
1947                                  * @link    https://www.flickr.com/photos/8047705@N02/5572197407
1948                                  */
1949                                 $header = DI::baseUrl() . '/images/diaspora-banner.jpg';
1950                                 break;
1951                         default:
1952                                 /**
1953                                  * Use a random picture.
1954                                  * The service provides random pictures from Unsplash.
1955                                  * @license https://unsplash.com/license
1956                                  */
1957                                 $header = 'https://picsum.photos/seed/' . hash('ripemd128', $contact['url']) . '/960/300';
1958                                 break;
1959                 }
1960
1961                 return $header;
1962         }
1963
1964         /**
1965          * Fetch the default avatar for the given contact and size
1966          *
1967          * @param array $contact  contact array
1968          * @param string $size    Size of the avatar picture
1969          * @return string avatar URL
1970          */
1971         public static function getDefaultAvatar(array $contact, string $size): string
1972         {
1973                 switch ($size) {
1974                         case Proxy::SIZE_MICRO:
1975                                 $avatar['size'] = 48;
1976                                 $default = self::DEFAULT_AVATAR_MICRO;
1977                                 break;
1978
1979                         case Proxy::SIZE_THUMB:
1980                                 $avatar['size'] = 80;
1981                                 $default = self::DEFAULT_AVATAR_THUMB;
1982                                 break;
1983
1984                         case Proxy::SIZE_SMALL:
1985                         default:
1986                                 $avatar['size'] = 300;
1987                                 $default = self::DEFAULT_AVATAR_PHOTO;
1988                                 break;
1989                 }
1990
1991                 if (!DI::config()->get('system', 'remote_avatar_lookup')) {
1992                         $platform = '';
1993                         $type     = Contact::TYPE_PERSON;
1994
1995                         if (!empty($contact['id'])) {
1996                                 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['id' => $contact['id']]);
1997                                 $platform = $account['platform'] ?? '';
1998                                 $type     = $account['contact-type'] ?? Contact::TYPE_PERSON;
1999                         }
2000
2001                         if (empty($platform) && !empty($contact['uri-id'])) {
2002                                 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['uri-id' => $contact['uri-id']]);
2003                                 $platform = $account['platform'] ?? '';
2004                                 $type     = $account['contact-type'] ?? Contact::TYPE_PERSON;
2005                         }
2006
2007                         switch ($platform) {
2008                                 case 'corgidon':
2009                                         /**
2010                                          * Picture credits
2011                                          * @license GNU Affero General Public License v3.0
2012                                          * @link    https://github.com/msdos621/corgidon/blob/main/public/avatars/original/missing.png
2013                                          */
2014                                         $default = '/images/default/corgidon.png';
2015                                         break;
2016
2017                                 case 'diaspora':
2018                                         /**
2019                                          * Picture credits
2020                                          * @license GNU Affero General Public License v3.0
2021                                          * @link    https://github.com/diaspora/diaspora/
2022                                          */
2023                                         $default = '/images/default/diaspora.png';
2024                                         break;
2025
2026                                 case 'gotosocial':
2027                                         /**
2028                                          * Picture credits
2029                                          * @license GNU Affero General Public License v3.0
2030                                          * @link    https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/default_avatars/GoToSocial_icon1.svg
2031                                          */
2032                                         $default = '/images/default/gotosocial.svg';
2033                                         break;
2034
2035                                 case 'hometown':
2036                                         /**
2037                                          * Picture credits
2038                                          * @license GNU Affero General Public License v3.0
2039                                          * @link    https://github.com/hometown-fork/hometown/blob/hometown-dev/public/avatars/original/missing.png
2040                                          */
2041                                         $default = '/images/default/hometown.png';
2042                                         break;
2043
2044                                 case 'koyuspace':
2045                                         /**
2046                                          * Picture credits
2047                                          * @license GNU Affero General Public License v3.0
2048                                          * @link    https://github.com/koyuspace/mastodon/blob/main/public/avatars/original/missing.png
2049                                          */
2050                                         $default = '/images/default/koyuspace.png';
2051                                         break;
2052
2053                                 case 'ecko':
2054                                 case 'qoto':
2055                                 case 'mastodon':
2056                                         /**
2057                                          * Picture credits
2058                                          * @license GNU Affero General Public License v3.0
2059                                          * @link    https://github.com/mastodon/mastodon/tree/main/public/avatars/original/missing.png
2060                                          */
2061                                         $default = '/images/default/mastodon.png';
2062                                         break;
2063
2064                                 case 'peertube':
2065                                         if ($type == Contact::TYPE_COMMUNITY) {
2066                                                 /**
2067                                                  * Picture credits
2068                                                  * @license GNU Affero General Public License v3.0
2069                                                  * @link    https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-video-channel.png
2070                                                  */
2071                                                 $default = '/images/default/peertube-channel.png';
2072                                         } else {
2073                                                 /**
2074                                                  * Picture credits
2075                                                  * @license GNU Affero General Public License v3.0
2076                                                  * @link    https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-account.png
2077                                                  */
2078                                                 $default = '/images/default/peertube-account.png';
2079                                         }
2080                                         break;
2081
2082                                 case 'pleroma':
2083                                         /**
2084                                          * Picture credits
2085                                          * @license GNU Affero General Public License v3.0
2086                                          * @link    https://git.pleroma.social/pleroma/pleroma/-/blob/develop/priv/static/images/avi.png
2087                                          */
2088                                         $default = '/images/default/pleroma.png';
2089                                         break;
2090
2091                                 case 'plume':
2092                                         /**
2093                                          * Picture credits
2094                                          * @license GNU Affero General Public License v3.0
2095                                          * @link    https://github.com/Plume-org/Plume/blob/main/assets/images/default-avatar.png
2096                                          */
2097                                         $default = '/images/default/plume.png';
2098                                         break;
2099                         }
2100                         return DI::baseUrl() . $default;
2101                 }
2102
2103                 if (!empty($contact['xmpp'])) {
2104                         $avatar['email'] = $contact['xmpp'];
2105                 } elseif (!empty($contact['addr'])) {
2106                         $avatar['email'] = $contact['addr'];
2107                 } elseif (!empty($contact['url'])) {
2108                         $avatar['email'] = $contact['url'];
2109                 } else {
2110                         return DI::baseUrl() . $default;
2111                 }
2112
2113                 $avatar['url'] = '';
2114                 $avatar['success'] = false;
2115
2116                 Hook::callAll('avatar_lookup', $avatar);
2117
2118                 if ($avatar['success'] && !empty($avatar['url'])) {
2119                         return $avatar['url'];
2120                 }
2121
2122                 return DI::baseUrl() . $default;
2123         }
2124
2125         /**
2126          * Get avatar link for given contact id
2127          *
2128          * @param integer $cid     contact id
2129          * @param string  $size    One of the Proxy::SIZE_* constants
2130          * @param string  $updated Contact update date
2131          * @param bool    $static  If "true" a parameter is added to convert the avatar to a static one
2132          * @return string avatar link
2133          */
2134         public static function getAvatarUrlForId(int $cid, string $size = '', string $updated = '', string $guid = '', bool $static = false): string
2135         {
2136                 // We have to fetch the "updated" variable when it wasn't provided
2137                 // The parameter can be provided to improve performance
2138                 if (empty($updated)) {
2139                         $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
2140                         $updated = $account['updated'] ?? '';
2141                         $guid = $account['guid'] ?? '';
2142                 }
2143
2144                 $guid = urlencode($guid);
2145
2146                 $url = DI::baseUrl() . '/photo/contact/';
2147                 switch ($size) {
2148                         case Proxy::SIZE_MICRO:
2149                                 $url .= Proxy::PIXEL_MICRO . '/';
2150                                 break;
2151                         case Proxy::SIZE_THUMB:
2152                                 $url .= Proxy::PIXEL_THUMB . '/';
2153                                 break;
2154                         case Proxy::SIZE_SMALL:
2155                                 $url .= Proxy::PIXEL_SMALL . '/';
2156                                 break;
2157                         case Proxy::SIZE_MEDIUM:
2158                                 $url .= Proxy::PIXEL_MEDIUM . '/';
2159                                 break;
2160                         case Proxy::SIZE_LARGE:
2161                                 $url .= Proxy::PIXEL_LARGE . '/';
2162                                 break;
2163                 }
2164                 $query_params = [];
2165                 if ($updated) {
2166                         $query_params['ts'] = strtotime($updated);
2167                 }
2168                 if ($static) {
2169                         $query_params['static'] = true;
2170                 }
2171
2172                 return $url . ($guid ?: $cid) . (!empty($query_params) ? '?' . http_build_query($query_params) : '');
2173         }
2174
2175         /**
2176          * Get avatar link for given contact URL
2177          *
2178          * @param string  $url  contact url
2179          * @param integer $uid  user id
2180          * @param string  $size One of the Proxy::SIZE_* constants
2181          * @return string avatar link
2182          */
2183         public static function getAvatarUrlForUrl(string $url, int $uid, string $size = ''): string
2184         {
2185                 $condition = [
2186                         "`nurl` = ? AND ((`uid` = ? AND `network` IN (?, ?)) OR `uid` = ?)",
2187                         Strings::normaliseLink($url), $uid, Protocol::FEED, Protocol::MAIL, 0
2188                 ];
2189                 $contact = self::selectFirst(['id', 'updated'], $condition, ['order' => ['uid' => true]]);
2190                 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
2191         }
2192
2193         /**
2194          * Get header link for given contact id
2195          *
2196          * @param integer $cid     contact id
2197          * @param string  $size    One of the Proxy::SIZE_* constants
2198          * @param string  $updated Contact update date
2199          * @param bool    $static  If "true" a parameter is added to convert the header to a static one
2200          * @return string header link
2201          */
2202         public static function getHeaderUrlForId(int $cid, string $size = '', string $updated = '', string $guid = '', bool $static = false): string
2203         {
2204                 // We have to fetch the "updated" variable when it wasn't provided
2205                 // The parameter can be provided to improve performance
2206                 if (empty($updated) || empty($guid)) {
2207                         $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
2208                         $updated = $account['updated'] ?? '';
2209                         $guid = $account['guid'] ?? '';
2210                 }
2211
2212                 $guid = urlencode($guid);
2213
2214                 $url = DI::baseUrl() . '/photo/header/';
2215                 switch ($size) {
2216                         case Proxy::SIZE_MICRO:
2217                                 $url .= Proxy::PIXEL_MICRO . '/';
2218                                 break;
2219                         case Proxy::SIZE_THUMB:
2220                                 $url .= Proxy::PIXEL_THUMB . '/';
2221                                 break;
2222                         case Proxy::SIZE_SMALL:
2223                                 $url .= Proxy::PIXEL_SMALL . '/';
2224                                 break;
2225                         case Proxy::SIZE_MEDIUM:
2226                                 $url .= Proxy::PIXEL_MEDIUM . '/';
2227                                 break;
2228                         case Proxy::SIZE_LARGE:
2229                                 $url .= Proxy::PIXEL_LARGE . '/';
2230                                 break;
2231                 }
2232
2233                 $query_params = [];
2234                 if ($updated) {
2235                         $query_params['ts'] = strtotime($updated);
2236                 }
2237                 if ($static) {
2238                         $query_params['static'] = true;
2239                 }
2240
2241                 return $url . ($guid ?: $cid) . (!empty($query_params) ? '?' . http_build_query($query_params) : '');
2242         }
2243
2244         /**
2245          * Updates the avatar links in a contact only if needed
2246          *
2247          * @param int    $cid          Contact id
2248          * @param string $avatar       Link to avatar picture
2249          * @param bool   $force        force picture update
2250          * @param bool   $create_cache Enforces the creation of cached avatar fields
2251          *
2252          * @return void
2253          * @throws HTTPException\InternalServerErrorException
2254          * @throws HTTPException\NotFoundException
2255          * @throws \ImagickException
2256          */
2257         public static function updateAvatar(int $cid, string $avatar, bool $force = false, bool $create_cache = false)
2258         {
2259                 $contact = DBA::selectFirst(
2260                         'contact',
2261                         ['uid', 'avatar', 'photo', 'thumb', 'micro', 'blurhash', 'xmpp', 'addr', 'nurl', 'url', 'network', 'uri-id'],
2262                         ['id' => $cid, 'self' => false]
2263                 );
2264                 if (!DBA::isResult($contact)) {
2265                         return;
2266                 }
2267
2268                 if (!Network::isValidHttpUrl($avatar)) {
2269                         Logger::warning('Invalid avatar', ['cid' => $cid, 'avatar' => $avatar]);
2270                         $avatar = '';
2271                 }
2272
2273                 $uid = $contact['uid'];
2274
2275                 // Only update the cached photo links of public contacts when they already are cached
2276                 if (($uid == 0) && !$force && empty($contact['thumb']) && empty($contact['micro']) && !$create_cache) {
2277                         if (($contact['avatar'] != $avatar) || empty($contact['blurhash'])) {
2278                                 $update_fields = ['avatar' => $avatar];
2279                                 if (!Network::isLocalLink($avatar)) {
2280                                         try {
2281                                                 $fetchResult = HTTPSignature::fetchRaw($avatar, 0, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
2282
2283                                                 $img_str = $fetchResult->getBody();
2284                                                 if (!empty($img_str)) {
2285                                                         $image = new Image($img_str, Images::getMimeTypeByData($img_str));
2286                                                         if ($image->isValid()) {
2287                                                                 $update_fields['blurhash'] = $image->getBlurHash();
2288                                                         } else {
2289                                                                 return;
2290                                                         }
2291                                                 }
2292                                         } catch (\Exception $exception) {
2293                                                 Logger::notice('Error fetching avatar', ['avatar' => $avatar, 'exception' => $exception]);
2294                                                 return;
2295                                         }
2296                                 } elseif (!empty($contact['blurhash'])) {
2297                                         $update_fields['blurhash'] = null;
2298                                 } else {
2299                                         return;
2300                                 }
2301
2302                                 self::update($update_fields, ['id' => $cid]);
2303                                 Logger::info('Only update the avatar', ['id' => $cid, 'avatar' => $avatar, 'contact' => $contact]);
2304                         }
2305                         return;
2306                 }
2307
2308                 // User contacts use are updated through the public contacts
2309                 if (($uid != 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2310                         $pcid = self::getIdForURL($contact['url'], 0, false);
2311                         if (!empty($pcid)) {
2312                                 Logger::debug('Update the private contact via the public contact', ['id' => $cid, 'uid' => $uid, 'public' => $pcid]);
2313                                 self::updateAvatar($pcid, $avatar, $force, true);
2314                                 return;
2315                         }
2316                 }
2317
2318                 $default_avatar = empty($avatar) || strpos($avatar, self::DEFAULT_AVATAR_PHOTO);
2319
2320                 if ($default_avatar) {
2321                         $avatar = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
2322                 }
2323
2324                 $cache_avatar = DI::config()->get('system', 'cache_contact_avatar');
2325
2326                 // Local contact avatars don't need to be cached
2327                 if ($cache_avatar && Network::isLocalLink($contact['url'])) {
2328                         $cache_avatar = !DBA::exists('contact', ['nurl' => $contact['nurl'], 'self' => true]);
2329                 }
2330
2331                 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || $cache_avatar) {
2332                         if (Avatar::deleteCache($contact)) {
2333                                 $force = true;
2334                         }
2335
2336                         if ($default_avatar && Proxy::isLocalImage($avatar)) {
2337                                 $fields = [
2338                                         'avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
2339                                         'photo' => $avatar,
2340                                         'thumb' => self::getDefaultAvatar($contact, Proxy::SIZE_THUMB),
2341                                         'micro' => self::getDefaultAvatar($contact, Proxy::SIZE_MICRO)
2342                                 ];
2343                                 Logger::debug('Use default avatar', ['id' => $cid, 'uid' => $uid]);
2344                         }
2345
2346                         // Use the data from the self account
2347                         if (empty($fields)) {
2348                                 $local_uid = User::getIdForURL($contact['url']);
2349                                 if (!empty($local_uid)) {
2350                                         $fields = self::selectFirst(['avatar', 'avatar-date', 'photo', 'thumb', 'micro'], ['self' => true, 'uid' => $local_uid]);
2351                                         Logger::debug('Use owner data', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2352                                 }
2353                         }
2354
2355                         if (empty($fields)) {
2356                                 $update = ($contact['avatar'] != $avatar) || $force;
2357
2358                                 if (!$update) {
2359                                         $data = [
2360                                                 $contact['photo'] ?? '',
2361                                                 $contact['thumb'] ?? '',
2362                                                 $contact['micro'] ?? '',
2363                                         ];
2364
2365                                         foreach ($data as $image_uri) {
2366                                                 $image_rid = Photo::ridFromURI($image_uri);
2367                                                 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
2368                                                         Logger::debug('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
2369                                                         $update = true;
2370                                                 }
2371                                         }
2372                                 }
2373
2374                                 if ($update) {
2375                                         $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
2376                                         if ($photos) {
2377                                                 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'blurhash' => $photos[3], 'avatar-date' => DateTimeFormat::utcNow()];
2378                                                 $update = !empty($fields);
2379                                                 Logger::debug('Created new cached avatars', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2380                                         } else {
2381                                                 $update = false;
2382                                         }
2383                                 }
2384                         } else {
2385                                 $update = ($fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2386                         }
2387                 } else {
2388                         Photo::delete(['uid' => $uid, 'contact-id' => $cid, 'photo-type' => Photo::CONTACT_AVATAR]);
2389                         $fields = Avatar::fetchAvatarContact($contact, $avatar, $force);
2390                         $update = ($avatar . $fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['avatar'] . $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2391                 }
2392
2393                 if (!$update) {
2394                         return;
2395                 }
2396
2397                 $cids = [];
2398                 $uids = [];
2399                 if (($uid == 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2400                         // Collect all user contacts of the given public contact
2401                         $personal_contacts = DBA::select(
2402                                 'contact',
2403                                 ['id', 'uid'],
2404                                 ["`nurl` = ? AND `id` != ? AND NOT `self`", $contact['nurl'], $cid]
2405                         );
2406                         while ($personal_contact = DBA::fetch($personal_contacts)) {
2407                                 $cids[] = $personal_contact['id'];
2408                                 $uids[] = $personal_contact['uid'];
2409                         }
2410                         DBA::close($personal_contacts);
2411
2412                         if (!empty($cids)) {
2413                                 // Delete possibly existing cached user contact avatars
2414                                 Photo::delete(['uid' => $uids, 'contact-id' => $cids, 'photo-type' => Photo::CONTACT_AVATAR]);
2415                         }
2416                 }
2417
2418                 $cids[] = $cid;
2419                 $uids[] = $uid;
2420                 Logger::info('Updating cached contact avatars', ['cid' => $cids, 'uid' => $uids, 'fields' => $fields]);
2421                 self::update($fields, ['id' => $cids]);
2422         }
2423
2424         public static function deleteContactByUrl(string $url)
2425         {
2426                 // Update contact data for all users
2427                 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
2428                 $contacts = DBA::select('contact', ['id', 'uid'], $condition);
2429                 while ($contact = DBA::fetch($contacts)) {
2430                         Logger::info('Deleting contact', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $url]);
2431                         self::remove($contact['id']);
2432                 }
2433         }
2434
2435         /**
2436          * Helper function for "updateFromProbe". Updates personal and public contact
2437          *
2438          * @param integer $id     contact id
2439          * @param integer $uid    user id
2440          * @param integer $uri_id Uri-Id
2441          * @param string  $url    The profile URL of the contact
2442          * @param array   $fields The fields that are updated
2443          *
2444          * @throws \Exception
2445          */
2446         private static function updateContact(int $id, int $uid, int $uri_id, string $url, array $fields)
2447         {
2448                 if (!self::update($fields, ['id' => $id])) {
2449                         Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
2450                         return;
2451                 }
2452
2453                 self::setAccountUser($id, $uid, $uri_id, $url);
2454
2455                 // Archive or unarchive the contact.
2456                 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
2457                 if (!DBA::isResult($contact)) {
2458                         Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
2459                         return;
2460                 }
2461
2462                 if (isset($fields['failed'])) {
2463                         if ($fields['failed']) {
2464                                 self::markForArchival($contact);
2465                         } else {
2466                                 self::unmarkForArchival($contact);
2467                         }
2468                 }
2469
2470                 if ($contact['uid'] != 0) {
2471                         return;
2472                 }
2473
2474                 // Update contact data for all users
2475                 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
2476
2477                 $condition['network'] = [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB];
2478
2479                 if (!in_array($contact['network'], Protocol::NATIVE_SUPPORT) && Protocol::supportsProbe($contact['network'])) {
2480                         $condition['network'][] = $contact['network'];
2481                 }
2482
2483                 self::update($fields, $condition);
2484
2485                 // We mustn't set the update fields for OStatus contacts since they are updated in OnePoll
2486                 $condition['network'] = Protocol::OSTATUS;
2487
2488                 // If the contact failed, propagate the update fields to all contacts
2489                 if (empty($fields['failed'])) {
2490                         unset($fields['last-update']);
2491                         unset($fields['success_update']);
2492                         unset($fields['failure_update']);
2493                 }
2494
2495                 if (empty($fields)) {
2496                         return;
2497                 }
2498
2499                 self::update($fields, $condition);
2500         }
2501
2502         /**
2503          * Create or update an "account-user" entry
2504          *
2505          * @param integer $id
2506          * @param integer $uid
2507          * @param integer $uri_id
2508          * @param string $url
2509          * @return void
2510          */
2511         public static function setAccountUser(int $id, int $uid, int $uri_id, string $url)
2512         {
2513                 if (empty($uri_id)) {
2514                         return;
2515                 }
2516
2517                 $account_user = DBA::selectFirst('account-user', ['id', 'uid', 'uri-id'], ['id' => $id]);
2518                 if (!empty($account_user['uri-id']) && ($account_user['uri-id'] != $uri_id)) {
2519                         if ($account_user['uid'] == $uid) {
2520                                 $ret = DBA::update('account-user', ['uri-id' => $uri_id], ['id' => $id]);
2521                                 Logger::notice('Updated account-user uri-id', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2522                         } else {
2523                                 // This should never happen
2524                                 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]);
2525                         }
2526                 }
2527
2528                 $account_user = DBA::selectFirst('account-user', ['id', 'uid', 'uri-id'], ['uid' => $uid, 'uri-id' => $uri_id]);
2529                 if (!empty($account_user['id'])) {
2530                         if ($account_user['id'] == $id) {
2531                                 Logger::debug('account-user already exists', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2532                                 return;
2533                         } elseif (!DBA::exists('contact', ['id' => $account_user['id'], 'deleted' => false])) {
2534                                 $ret = DBA::update('account-user', ['id' => $id], ['uid' => $uid, 'uri-id' => $uri_id]);
2535                                 Logger::notice('Updated account-user', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2536                                 return;
2537                         }
2538                         Logger::warning('account-user exists for a different contact id', ['account_user' => $account_user, 'id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2539                         Worker::add(Worker::PRIORITY_HIGH, 'MergeContact', $account_user['id'], $id, $uid);
2540                 } elseif (DBA::insert('account-user', ['id' => $id, 'uri-id' => $uri_id, 'uid' => $uid], Database::INSERT_IGNORE)) {
2541                         Logger::notice('account-user was added', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2542                 } else {
2543                         Logger::warning('account-user was not added', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2544                 }
2545         }
2546
2547         /**
2548          * Remove duplicated contacts
2549          *
2550          * @param string  $nurl  Normalised contact url
2551          * @param integer $uid   User id
2552          * @return boolean
2553          * @throws \Exception
2554          */
2555         public static function removeDuplicates(string $nurl, int $uid)
2556         {
2557                 $condition = ['nurl' => $nurl, 'uid' => $uid, 'self' => false, 'deleted' => false, 'network' => Protocol::FEDERATED];
2558                 $count = DBA::count('contact', $condition);
2559                 if ($count <= 1) {
2560                         return false;
2561                 }
2562
2563                 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
2564                 if (!DBA::isResult($first_contact)) {
2565                         // Shouldn't happen - so we handle it
2566                         return false;
2567                 }
2568
2569                 $first = $first_contact['id'];
2570                 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
2571
2572                 // Find all duplicates
2573                 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
2574                 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
2575                 while ($duplicate = DBA::fetch($duplicates)) {
2576                         if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
2577                                 continue;
2578                         }
2579
2580                         Worker::add(Worker::PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
2581                 }
2582                 DBA::close($duplicates);
2583                 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl, 'callstack' => System::callstack(20)]);
2584                 return true;
2585         }
2586
2587         /**
2588          * Perform a contact update if the contact is outdated
2589          *
2590          * @param integer $id contact id
2591          * @return bool
2592          */
2593         public static function updateByIdIfNeeded(int $id): bool
2594         {
2595                 $contact = self::selectFirst(['url'], ["`id` = ? AND `next-update` < ?", $id, DateTimeFormat::utcNow()]);
2596                 if (empty($contact['url'])) {
2597                         return false;
2598                 }
2599
2600                 if (self::isLocal($contact['url'])) {
2601                         return true;
2602                 }
2603
2604                 $stamp = (float)microtime(true);
2605                 self::updateFromProbe($id);
2606                 Logger::debug('Contact data is updated.', ['duration' => round((float)microtime(true) - $stamp, 3), 'id' => $id, 'url' => $contact['url'], 'callstack' => System::callstack(20)]);
2607                 return true;
2608         }
2609
2610         /**
2611          * Perform a contact update if the contact is outdated
2612          *
2613          * @param string $url contact url
2614          * @return bool
2615          */
2616         public static function updateByUrlIfNeeded(string $url): bool
2617         {
2618                 $id = self::getIdForURL($url, 0, false);
2619                 if (!empty($id)) {
2620                         return self::updateByIdIfNeeded($id);
2621                 }
2622                 return (bool)self::getIdForURL($url);
2623         }
2624
2625         /**
2626          * Updates contact record by provided id and optional network
2627          *
2628          * @param integer $id      contact id
2629          * @param string  $network Optional network we are probing for
2630          * @return boolean
2631          * @throws HTTPException\InternalServerErrorException
2632          * @throws \ImagickException
2633          */
2634         public static function updateFromProbe(int $id, string $network = ''): bool
2635         {
2636                 $contact = DBA::selectFirst('contact', ['uid', 'url'], ['id' => $id]);
2637                 if (!DBA::isResult($contact)) {
2638                         return false;
2639                 }
2640
2641                 $data = Probe::uri($contact['url'], $network, $contact['uid']);
2642
2643                 if ($data['network'] == Protocol::DIASPORA) {
2644                         try {
2645                                 DI::dsprContact()->updateFromProbeArray($data);
2646                         } catch (HTTPException\NotFoundException $e) {
2647                                 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2648                         } catch (\InvalidArgumentException $e) {
2649                                 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2650                         }
2651                 } elseif (!empty($data['networks'][Protocol::DIASPORA])) {
2652                         try {
2653                                 DI::dsprContact()->updateFromProbeArray($data['networks'][Protocol::DIASPORA]);
2654                         } catch (HTTPException\NotFoundException $e) {
2655                                 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2656                         } catch (\InvalidArgumentException $e) {
2657                                 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2658                         }
2659                 }
2660
2661                 return self::updateFromProbeArray($id, $data);
2662         }
2663
2664         /**
2665          * Checks if the given contact has got local data
2666          *
2667          * @param int   $id
2668          * @param array $contact
2669          *
2670          * @return boolean
2671          */
2672         private static function hasLocalData(int $id, array $contact): bool
2673         {
2674                 if (!empty($contact['uri-id']) && DBA::exists('contact', ["`uri-id` = ? AND `uid` != ?", $contact['uri-id'], 0])) {
2675                         // User contacts with the same uri-id exist
2676                         return true;
2677                 } elseif (DBA::exists('contact', ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($contact['url']), 0])) {
2678                         // User contacts with the same nurl exists (compatibility mode for systems with missing uri-id values)
2679                         return true;
2680                 }
2681                 if (DBA::exists('post-tag', ['cid' => $id])) {
2682                         // Is tagged in a post
2683                         return true;
2684                 }
2685                 if (DBA::exists('user-contact', ['cid' => $id])) {
2686                         // Has got user-contact data
2687                         return true;
2688                 }
2689                 if (Post::exists(['author-id' => $id])) {
2690                         // Posts with this author exist
2691                         return true;
2692                 }
2693                 if (Post::exists(['owner-id' => $id])) {
2694                         // Posts with this owner exist
2695                         return true;
2696                 }
2697                 if (Post::exists(['causer-id' => $id])) {
2698                         // Posts with this causer exist
2699                         return true;
2700                 }
2701                 // We don't have got this contact locally
2702                 return false;
2703         }
2704
2705         /**
2706          * Updates contact record by provided id and probed data
2707          *
2708          * @param integer $id      contact id
2709          * @param array   $ret     Probed data
2710          * @return boolean
2711          * @throws HTTPException\InternalServerErrorException
2712          * @throws \ImagickException
2713          */
2714         private static function updateFromProbeArray(int $id, array $ret): bool
2715         {
2716                 /*
2717                   Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
2718                   This will reliably kill your communication with old Friendica contacts.
2719                  */
2720
2721                 // These fields aren't updated by this routine:
2722                 // 'sensitive'
2723
2724                 $fields = [
2725                         'uid', 'uri-id', 'avatar', 'header', 'name', 'nick', 'location', 'keywords', 'about', 'subscribe',
2726                         'manually-approve', 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
2727                         'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey', 'last-item', 'xmpp', 'matrix',
2728                         'created', 'last-update'
2729                 ];
2730                 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
2731                 if (!DBA::isResult($contact)) {
2732                         return false;
2733                 }
2734
2735                 if (self::isLocal($ret['url'])) {
2736                         if ($contact['uid'] == 0) {
2737                                 Logger::info('Local contacts are not updated here.');
2738                         } else {
2739                                 self::updateFromPublicContact($id, $contact);
2740                         }
2741                         return true;
2742                 }
2743
2744                 if (!empty($ret['account-type']) && $ret['account-type'] == User::ACCOUNT_TYPE_DELETED) {
2745                         Logger::info('Deleted account', ['id' => $id, 'url' => $ret['url'], 'ret' => $ret]);
2746                         self::remove($id);
2747
2748                         // Delete all contacts with the same URL
2749                         self::deleteContactByUrl($ret['url']);
2750                         return true;
2751                 }
2752
2753                 $has_local_data = self::hasLocalData($id, $contact);
2754
2755                 $uid = $contact['uid'];
2756                 unset($contact['uid']);
2757
2758                 $uriid = $contact['uri-id'];
2759                 unset($contact['uri-id']);
2760
2761                 $pubkey = $contact['pubkey'];
2762                 unset($contact['pubkey']);
2763
2764                 $created = $contact['created'];
2765                 unset($contact['created']);
2766
2767                 $last_update = $contact['last-update'];
2768                 unset($contact['last-update']);
2769
2770                 $contact['photo'] = $contact['avatar'];
2771                 unset($contact['avatar']);
2772
2773                 $updated = DateTimeFormat::utcNow();
2774
2775                 if (!Protocol::supportsProbe($ret['network']) && !Protocol::supportsProbe($contact['network'])) {
2776                         // Periodical checks are only done on federated contacts
2777                         $failed_next_update  = null;
2778                         $success_next_update = null;
2779                 } elseif ($has_local_data) {
2780                         $failed_next_update  = GServer::getNextUpdateDate(false, $created, $last_update, !in_array($contact['network'], Protocol::FEDERATED));
2781                         $success_next_update = GServer::getNextUpdateDate(true, $created, $last_update, !in_array($contact['network'], Protocol::FEDERATED));
2782                 } elseif (in_array($ret['network'], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::ZOT, Protocol::PHANTOM]))) {
2783                         $failed_next_update  = DateTimeFormat::utc('now +6 month');
2784                         $success_next_update = DateTimeFormat::utc('now +1 month');
2785                 } else {
2786                         // We don't check connector networks very often to not run into API rate limits
2787                         $failed_next_update  = DateTimeFormat::utc('now +12 month');
2788                         $success_next_update = DateTimeFormat::utc('now +12 month');
2789                 }
2790
2791                 if (Strings::normaliseLink($contact['url']) != Strings::normaliseLink($ret['url'])) {
2792                         Logger::notice('New URL differs from old URL', ['id' => $id, 'uid' => $uid, 'old' => $contact['url'], 'new' => $ret['url']]);
2793                         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]);
2794                         return false;
2795                 }
2796
2797                 // We must not try to update relay contacts via probe. They are no real contacts.
2798                 // We check after the probing to be able to correct falsely detected contact types.
2799                 if (($contact['contact-type'] == self::TYPE_RELAY) &&
2800                         (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))
2801                 ) {
2802                         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]);
2803                         Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
2804                         return true;
2805                 }
2806
2807                 // If Probe::uri fails the network code will be different ("feed" or "unkn")
2808                 if (($ret['network'] == Protocol::PHANTOM) || (($ret['network'] == Protocol::FEED) && ($ret['network'] != $contact['network']))) {
2809                         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]);
2810                         return false;
2811                 }
2812
2813                 if (Strings::normaliseLink($ret['url']) != Strings::normaliseLink($contact['url'])) {
2814                         $cid = self::getIdForURL($ret['url'], 0, false);
2815                         if (!empty($cid) && ($cid != $id)) {
2816                                 Logger::notice('URL of contact changed.', ['id' => $id, 'new_id' => $cid, 'old' => $contact['url'], 'new' => $ret['url']]);
2817                                 return self::updateFromProbeArray($cid, $ret);
2818                         }
2819                 }
2820
2821                 if (isset($ret['hide']) && is_bool($ret['hide'])) {
2822                         $ret['unsearchable'] = $ret['hide'];
2823                 }
2824
2825                 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
2826                         $ret['forum'] = false;
2827                         $ret['prv'] = false;
2828                         $ret['contact-type'] = $ret['account-type'];
2829                         if (($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) && isset($ret['manually-approve'])) {
2830                                 $ret['forum'] = (bool)!$ret['manually-approve'];
2831                                 $ret['prv'] = (bool)!$ret['forum'];
2832                         }
2833                 }
2834
2835                 $new_pubkey = $ret['pubkey'] ?? '';
2836
2837                 if ($uid == 0 && DI::config()->get('system', 'fetch_featured_posts')) {
2838                         if ($ret['network'] == Protocol::ACTIVITYPUB) {
2839                                 $apcontact = APContact::getByURL($ret['url'], false);
2840                                 if (!empty($apcontact['featured'])) {
2841                                         Worker::add(Worker::PRIORITY_LOW, 'FetchFeaturedPosts', $ret['url']);
2842                                 }
2843                         }
2844
2845                         $ret['last-item'] = Probe::getLastUpdate($ret);
2846                         Logger::info('Fetched last item', ['id' => $id, 'probed_url' => $ret['url'], 'last-item' => $ret['last-item'], 'callstack' => System::callstack(20)]);
2847                 }
2848
2849                 $update = false;
2850                 $guid = ($ret['guid'] ?? '') ?: Item::guidFromUri($ret['url'], $ret['baseurl'] ?? $ret['alias'] ?? '');
2851
2852                 // make sure to not overwrite existing values with blank entries except some technical fields
2853                 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2854                 foreach ($ret as $key => $val) {
2855                         if (!array_key_exists($key, $contact)) {
2856                                 unset($ret[$key]);
2857                         } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2858                                 $ret[$key] = $contact[$key];
2859                         } elseif ($ret[$key] != $contact[$key]) {
2860                                 $update = true;
2861                         }
2862                 }
2863
2864                 if (!empty($ret['last-item']) && ($contact['last-item'] < $ret['last-item'])) {
2865                         $update = true;
2866                 } else {
2867                         unset($ret['last-item']);
2868                 }
2869
2870                 if (empty($uriid)) {
2871                         $update = true;
2872                 }
2873
2874                 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2875                         self::updateAvatar($id, $ret['photo'], $update);
2876                 }
2877
2878                 if (!$update) {
2879                         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]);
2880
2881                         if (Contact\Relation::isDiscoverable($ret['url'])) {
2882                                 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2883                         }
2884
2885                         // Update the public contact
2886                         if ($uid != 0) {
2887                                 $contact = self::getByURL($ret['url'], false, ['id']);
2888                                 if (!empty($contact['id'])) {
2889                                         self::updateFromProbeArray($contact['id'], $ret);
2890                                 }
2891                         }
2892
2893                         return true;
2894                 }
2895
2896                 $ret['uri-id']      = ItemURI::insert(['uri' => $ret['url'], 'guid' => $guid]);
2897                 $ret['nurl']        = Strings::normaliseLink($ret['url']);
2898                 $ret['updated']     = $updated;
2899                 $ret['failed']      = false;
2900                 $ret['next-update'] = $success_next_update;
2901                 $ret['local-data']  = $has_local_data;
2902
2903                 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2904                 if (empty($pubkey) && !empty($new_pubkey)) {
2905                         $ret['pubkey'] = $new_pubkey;
2906                 }
2907
2908                 if ((!empty($ret['addr']) && ($ret['addr'] != $contact['addr'])) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2909                         $ret['uri-date'] = $updated;
2910                 }
2911
2912                 if ((!empty($ret['name']) && ($ret['name'] != $contact['name'])) || (!empty($ret['nick']) && ($ret['nick'] != $contact['nick']))) {
2913                         $ret['name-date'] = $updated;
2914                 }
2915
2916                 if (($uid == 0) || in_array($ret['network'], [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2917                         $ret['last-update'] = $updated;
2918                         $ret['success_update'] = $updated;
2919                 }
2920
2921                 unset($ret['photo']);
2922
2923                 self::updateContact($id, $uid, $ret['uri-id'], $ret['url'], $ret);
2924
2925                 if (Contact\Relation::isDiscoverable($ret['url'])) {
2926                         Worker::add(Worker::PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2927                 }
2928
2929                 return true;
2930         }
2931
2932         private static function updateFromPublicContact(int $id, array $contact)
2933         {
2934                 $public = self::getByURL($contact['url'], false);
2935
2936                 $fields = [];
2937
2938                 foreach ($contact as $field => $value) {
2939                         if ($field == 'uid') {
2940                                 continue;
2941                         }
2942                         if ($public[$field] != $value) {
2943                                 $fields[$field] = $public[$field];
2944                         }
2945                 }
2946                 if (!empty($fields)) {
2947                         self::update($fields, ['id' => $id, 'self' => false]);
2948                         Logger::info('Updating local contact', ['id' => $id]);
2949                 }
2950         }
2951
2952         /**
2953          * Updates contact record by provided URL
2954          *
2955          * @param integer $url contact url
2956          * @return integer Contact id
2957          * @throws HTTPException\InternalServerErrorException
2958          * @throws \ImagickException
2959          */
2960         public static function updateFromProbeByURL(string $url): int
2961         {
2962                 $id = self::getIdForURL($url);
2963
2964                 if (empty($id)) {
2965                         return $id;
2966                 }
2967
2968                 self::updateFromProbe($id);
2969
2970                 return $id;
2971         }
2972
2973         /**
2974          * Detects the communication protocol for a given contact url.
2975          * This is used to detect Friendica contacts that we can communicate via AP.
2976          *
2977          * @param string $url contact url
2978          * @param string $network Network of that contact
2979          * @return string with protocol
2980          */
2981         public static function getProtocol(string $url, string $network): string
2982         {
2983                 if ($network != Protocol::DFRN) {
2984                         return $network;
2985                 }
2986
2987                 $apcontact = APContact::getByURL($url);
2988                 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2989                         return Protocol::ACTIVITYPUB;
2990                 } else {
2991                         return $network;
2992                 }
2993         }
2994
2995         /**
2996          * Takes a $uid and a url/handle and adds a new contact
2997          *
2998          * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2999          * dfrn_request page.
3000          *
3001          * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
3002          *
3003          * Returns an array
3004          * $return['success'] boolean true if successful
3005          * $return['message'] error text if success is false.
3006          *
3007          * Takes a $uid and a url/handle and adds a new contact
3008          *
3009          * @param int    $uid         The user id the contact should be created for
3010          * @param string $url         The profile URL of the contact
3011          * @param string $network
3012          * @return array
3013          * @throws HTTPException\InternalServerErrorException
3014          * @throws HTTPException\NotFoundException
3015          * @throws \ImagickException
3016          */
3017         public static function createFromProbeForUser(int $uid, string $url, string $network = ''): array
3018         {
3019                 $result = ['cid' => -1, 'success' => false, 'message' => ''];
3020
3021                 // remove ajax junk, e.g. Twitter
3022                 $url = str_replace('/#!/', '/', $url);
3023
3024                 if (!Network::isUrlAllowed($url)) {
3025                         $result['message'] = DI::l10n()->t('Disallowed profile URL.');
3026                         return $result;
3027                 }
3028
3029                 if (Network::isUrlBlocked($url)) {
3030                         $result['message'] = DI::l10n()->t('Blocked domain');
3031                         return $result;
3032                 }
3033
3034                 if (!$url) {
3035                         $result['message'] = DI::l10n()->t('Connect URL missing.');
3036                         return $result;
3037                 }
3038
3039                 $arr = ['url' => $url, 'uid' => $uid, 'contact' => []];
3040
3041                 Hook::callAll('follow', $arr);
3042
3043                 if (empty($arr)) {
3044                         $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
3045                         return $result;
3046                 }
3047
3048                 if (!empty($arr['contact']['name'])) {
3049                         $probed = false;
3050                         $ret = $arr['contact'];
3051                 } else {
3052                         $probed = true;
3053                         $ret = Probe::uri($url, $network, $uid);
3054
3055                         // Ensure that the public contact exists
3056                         if ($ret['network'] != Protocol::PHANTOM) {
3057                                 self::getIdForURL($url);
3058                         }
3059                 }
3060
3061                 if (($network != '') && ($ret['network'] != $network)) {
3062                         $result['message'] = DI::l10n()->t('Expected network %s does not match actual network %s', $network, $ret['network']);
3063                         return $result;
3064                 }
3065
3066                 // check if we already have a contact
3067                 $condition = ['uid' => $uid, 'nurl' => Strings::normaliseLink($ret['url']), 'deleted' => false];
3068                 $contact = DBA::selectFirst('contact', ['id', 'rel', 'url', 'pending', 'hub-verify'], $condition);
3069
3070                 $protocol = self::getProtocol($ret['url'], $ret['network']);
3071
3072                 // This extra param just confuses things, remove it
3073                 if ($protocol === Protocol::DIASPORA) {
3074                         $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
3075                 }
3076
3077                 // do we have enough information?
3078                 if (empty($protocol) || ($protocol == Protocol::PHANTOM) || (empty($ret['url']) && empty($ret['addr']))) {
3079                         $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . '<br />';
3080                         if (empty($ret['poll'])) {
3081                                 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . '<br />';
3082                         }
3083                         if (empty($ret['name'])) {
3084                                 $result['message'] .= DI::l10n()->t('An author or name was not found.') . '<br />';
3085                         }
3086                         if (empty($ret['url'])) {
3087                                 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . '<br />';
3088                         }
3089                         if (strpos($ret['url'], '@') !== false) {
3090                                 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . '<br />';
3091                                 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . '<br />';
3092                         }
3093                         return $result;
3094                 }
3095
3096                 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
3097                         $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . '<br />';
3098                         $ret['notify'] = '';
3099                 }
3100
3101                 if (!$ret['notify']) {
3102                         $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . '<br />';
3103                 }
3104
3105                 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
3106
3107                 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
3108
3109                 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
3110
3111                 $pending = false;
3112                 if (($protocol == Protocol::ACTIVITYPUB) && isset($ret['manually-approve'])) {
3113                         $pending = (bool)$ret['manually-approve'];
3114                 }
3115
3116                 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
3117                         $writeable = 1;
3118                 }
3119
3120                 if (DBA::isResult($contact)) {
3121                         // update contact
3122                         $new_relation = (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) ? self::FRIEND : self::SHARING);
3123
3124                         $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false, 'network' => $ret['network']];
3125
3126                         if ($contact['pending'] && !empty($contact['hub-verify'])) {
3127                                 ActivityPub\Transmitter::sendContactAccept($contact['url'], $contact['hub-verify'], $uid);
3128                                 $fields['pending'] = false;
3129                         }
3130
3131                         self::update($fields, ['id' => $contact['id']]);
3132                 } else {
3133                         $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
3134
3135                         // create contact record
3136                         self::insert([
3137                                 'uid'          => $uid,
3138                                 'created'      => DateTimeFormat::utcNow(),
3139                                 'url'          => $ret['url'],
3140                                 'nurl'         => Strings::normaliseLink($ret['url']),
3141                                 'addr'         => $ret['addr'],
3142                                 'alias'        => $ret['alias'],
3143                                 'batch'        => $ret['batch'],
3144                                 'notify'       => $ret['notify'],
3145                                 'poll'         => $ret['poll'],
3146                                 'poco'         => $ret['poco'],
3147                                 'name'         => $ret['name'],
3148                                 'nick'         => $ret['nick'],
3149                                 'network'      => $ret['network'],
3150                                 'baseurl'      => $ret['baseurl'],
3151                                 'gsid'         => $ret['gsid'] ?? null,
3152                                 'contact-type' => $ret['account-type'] ?? self::TYPE_PERSON,
3153                                 'protocol'     => $protocol,
3154                                 'pubkey'       => $ret['pubkey'],
3155                                 'rel'          => $new_relation,
3156                                 'priority'     => $ret['priority'],
3157                                 'writable'     => $writeable,
3158                                 'hidden'       => $hidden,
3159                                 'blocked'      => 0,
3160                                 'readonly'     => 0,
3161                                 'pending'      => $pending,
3162                                 'subhub'       => $subhub
3163                         ]);
3164                 }
3165
3166                 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
3167                 if (!DBA::isResult($contact)) {
3168                         $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . '<br />';
3169                         return $result;
3170                 }
3171
3172                 $contact_id = $contact['id'];
3173                 $result['cid'] = $contact_id;
3174
3175                 if ($contact['contact-type'] == self::TYPE_COMMUNITY) {
3176                         Circle::addMember(User::getDefaultGroupCircle($uid), $contact_id);
3177                 } else {
3178                         Circle::addMember(User::getDefaultCircle($uid), $contact_id);
3179                 }
3180
3181                 // Update the avatar
3182                 self::updateAvatar($contact_id, $ret['photo']);
3183
3184                 // pull feed and consume it, which should subscribe to the hub.
3185                 if ($contact['network'] == Protocol::OSTATUS) {
3186                         Worker::add(Worker::PRIORITY_HIGH, 'OnePoll', $contact_id, 'force');
3187                 }
3188
3189                 if ($probed) {
3190                         self::updateFromProbeArray($contact_id, $ret);
3191                 } else {
3192                         try {
3193                                 UpdateContact::add(Worker::PRIORITY_HIGH, $contact['id']);
3194                         } catch (\InvalidArgumentException $e) {
3195                                 Logger::notice($e->getMessage(), ['contact' => $contact]);
3196                         }
3197                 }
3198
3199                 $result['success'] = Protocol::follow($uid, $contact, $protocol);
3200
3201                 return $result;
3202         }
3203
3204         /**
3205          * @param array  $importer Owner (local user) data
3206          * @param array  $contact  Existing owner-specific contact data we want to expand the relationship with. Optional.
3207          * @param array  $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
3208          * @param bool   $sharing  True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
3209          * @param string $note     Introduction additional message
3210          * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
3211          * @throws HTTPException\InternalServerErrorException
3212          * @throws \ImagickException
3213          */
3214         public static function addRelationship(array $importer, array $contact, array $datarray, bool $sharing = false, string $note = '')
3215         {
3216                 // Should always be set
3217                 if (empty($datarray['author-id'])) {
3218                         return false;
3219                 }
3220
3221                 $fields = ['id', 'url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked', 'baseurl'];
3222                 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
3223                 if (!DBA::isResult($pub_contact)) {
3224                         // Should never happen
3225                         return false;
3226                 }
3227
3228                 // Contact is blocked at node-level
3229                 if (self::isBlocked($datarray['author-id'])) {
3230                         return false;
3231                 }
3232
3233                 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
3234                 $name = $pub_contact['name'];
3235                 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
3236                 $nick = $pub_contact['nick'];
3237                 $network = $pub_contact['network'];
3238
3239                 // Ensure that we don't create a new contact when there already is one
3240                 $cid = self::getIdForURL($url, $importer['uid']);
3241                 if (!empty($cid)) {
3242                         $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
3243                 }
3244
3245                 self::clearFollowerFollowingEndpointCache($importer['uid']);
3246
3247                 if (!empty($contact)) {
3248                         if (!empty($contact['pending'])) {
3249                                 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
3250                                 return null;
3251                         }
3252
3253                         // Contact is blocked at user-level
3254                         if (
3255                                 !empty($contact['id']) && !empty($importer['id']) &&
3256                                 Contact\User::isBlocked($contact['id'], $importer['id'])
3257                         ) {
3258                                 return false;
3259                         }
3260
3261                         // Make sure that the existing contact isn't archived
3262                         self::unmarkForArchival($contact);
3263
3264                         if (($contact['rel'] == self::SHARING)
3265                                 || ($sharing && $contact['rel'] == self::FOLLOWER)
3266                         ) {
3267                                 self::update(
3268                                         ['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
3269                                         ['id' => $contact['id'], 'uid' => $importer['uid']]
3270                                 );
3271                         }
3272
3273                         // Ensure to always have the correct network type, independent from the connection request method
3274                         self::updateFromProbe($contact['id']);
3275
3276                         Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
3277
3278                         return true;
3279                 } else {
3280                         // send email notification to owner?
3281                         if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
3282                                 Logger::notice('ignoring duplicated connection request from pending contact ' . $url);
3283                                 return null;
3284                         }
3285
3286                         // create contact record
3287                         $contact_id = self::insert([
3288                                 'uid'      => $importer['uid'],
3289                                 'created'  => DateTimeFormat::utcNow(),
3290                                 'url'      => $url,
3291                                 'nurl'     => Strings::normaliseLink($url),
3292                                 'baseurl'  => $pub_contact['baseurl'] ?? '',
3293                                 'name'     => $name,
3294                                 'nick'     => $nick,
3295                                 'network'  => $network,
3296                                 'rel'      => self::FOLLOWER,
3297                                 'blocked'  => 0,
3298                                 'readonly' => 0,
3299                                 'pending'  => 1,
3300                                 'writable' => 1,
3301                         ]);
3302
3303                         // Ensure to always have the correct network type, independent from the connection request method
3304                         self::updateFromProbe($contact_id);
3305
3306                         self::updateAvatar($contact_id, $photo, true);
3307
3308                         Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
3309
3310                         $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo', 'contact-type'], ['id' => $contact_id]);
3311
3312                         /// @TODO Encapsulate this into a function/method
3313                         $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
3314                         $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
3315                         if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
3316                                 // create notification
3317                                 if (is_array($contact_record)) {
3318                                         $intro = DI::introFactory()->createNew(
3319                                                 $importer['uid'],
3320                                                 $contact_record['id'],
3321                                                 $note
3322                                         );
3323                                         DI::intro()->save($intro);
3324                                 }
3325
3326                                 if ($contact_record['contact-type'] == self::TYPE_COMMUNITY) {
3327                                         Circle::addMember(User::getDefaultGroupCircle($importer['uid']), $contact_record['id']);
3328                                 } else {
3329                                         Circle::addMember(User::getDefaultCircle($importer['uid']), $contact_record['id']);
3330                                 }
3331
3332                                 if (($user['notify-flags'] & Notification\Type::INTRO) && $user['page-flags'] == User::PAGE_FLAGS_NORMAL) {
3333                                         DI::notify()->createFromArray([
3334                                                 'type'  => Notification\Type::INTRO,
3335                                                 'otype' => Notification\ObjectType::INTRO,
3336                                                 'verb'  => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
3337                                                 'uid'   => $user['uid'],
3338                                                 'cid'   => $contact_record['id'],
3339                                                 'link'  => DI::baseUrl() . '/notifications/intros',
3340                                         ]);
3341                                 }
3342                         } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
3343                                 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
3344                                         self::createFromProbeForUser($importer['uid'], $url, $network);
3345                                 }
3346
3347                                 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
3348                                 $fields = ['pending' => false];
3349                                 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
3350                                         $fields['rel'] = self::FRIEND;
3351                                 }
3352
3353                                 self::update($fields, $condition);
3354
3355                                 return true;
3356                         }
3357                 }
3358
3359                 return null;
3360         }
3361
3362         /**
3363          * Update the local relationship when a local user loses a follower
3364          *
3365          * @param array $contact User-specific contact (uid != 0) array
3366          * @return void
3367          * @throws HTTPException\InternalServerErrorException
3368          * @throws \ImagickException
3369          */
3370         public static function removeFollower(array $contact)
3371         {
3372                 if (in_array($contact['rel'] ?? [], [self::FRIEND, self::SHARING])) {
3373                         self::update(['rel' => self::SHARING], ['id' => $contact['id']]);
3374                 } elseif (!empty($contact['id'])) {
3375                         self::remove($contact['id']);
3376                 } else {
3377                         DI::logger()->info('Couldn\'t remove follower because of invalid contact array', ['contact' => $contact, 'callstack' => System::callstack()]);
3378                         return;
3379                 }
3380
3381                 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscoveryForUser', $contact['uid']);
3382
3383                 self::clearFollowerFollowingEndpointCache($contact['uid']);
3384
3385                 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
3386                 if (!empty($cdata['public'])) {
3387                         DI::notification()->deleteForUserByVerb($contact['uid'], Activity::FOLLOW, ['actor-id' => $cdata['public']]);
3388                 }
3389         }
3390
3391         /**
3392          * Update the local relationship when a local user unfollow a contact.
3393          * Removes the contact for sharing-only protocols (feed and mail).
3394          *
3395          * @param array $contact User-specific contact (uid != 0) array
3396          * @throws HTTPException\InternalServerErrorException
3397          */
3398         public static function removeSharer(array $contact)
3399         {
3400                 self::clearFollowerFollowingEndpointCache($contact['uid']);
3401
3402                 if ($contact['rel'] == self::SHARING || in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
3403                         self::remove($contact['id']);
3404                 } else {
3405                         self::update(['rel' => self::FOLLOWER, 'pending' => false], ['id' => $contact['id']]);
3406                 }
3407
3408                 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscoveryForUser', $contact['uid']);
3409         }
3410
3411         /**
3412          * Create a birthday event.
3413          *
3414          * Update the year and the birthday.
3415          */
3416         public static function updateBirthdays()
3417         {
3418                 $condition = [
3419                         '`bd` > ?
3420                         AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
3421                         AND NOT `contact`.`pending`
3422                         AND NOT `contact`.`hidden`
3423                         AND NOT `contact`.`blocked`
3424                         AND NOT `contact`.`archive`
3425                         AND NOT `contact`.`deleted`',
3426                         DBA::NULL_DATE,
3427                         self::SHARING,
3428                         self::FRIEND
3429                 ];
3430
3431                 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
3432
3433                 while ($contact = DBA::fetch($contacts)) {
3434                         Logger::notice('update_contact_birthday: ' . $contact['bd']);
3435
3436                         $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
3437
3438                         if (Event::createBirthday($contact, $nextbd)) {
3439                                 // update bdyear
3440                                 DBA::update(
3441                                         'contact',
3442                                         ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
3443                                         ['id' => $contact['id']]
3444                                 );
3445                         }
3446                 }
3447                 DBA::close($contacts);
3448         }
3449
3450         /**
3451          * Remove the unavailable contact ids from the provided list
3452          *
3453          * @param array $contact_ids Contact id list
3454          * @return array
3455          * @throws \Exception
3456          */
3457         public static function pruneUnavailable(array $contact_ids): array
3458         {
3459                 if (empty($contact_ids)) {
3460                         return [];
3461                 }
3462
3463                 $contacts = self::selectToArray(['id'], [
3464                         'id'      => $contact_ids,
3465                         'blocked' => false,
3466                         'pending' => false,
3467                         'archive' => false,
3468                 ]);
3469
3470                 return array_column($contacts, 'id');
3471         }
3472
3473         /**
3474          * Returns a magic link to authenticate remote visitors
3475          *
3476          * @todo  check if the return is either a fully qualified URL or a relative path to Friendica basedir
3477          *
3478          * @param string $contact_url The address of the target contact profile
3479          * @param string $url         An url that we will be redirected to after the authentication
3480          *
3481          * @return string with "redir" link
3482          * @throws HTTPException\InternalServerErrorException
3483          * @throws \ImagickException
3484          */
3485         public static function magicLink(string $contact_url, string $url = ''): string
3486         {
3487                 if (!DI::userSession()->isAuthenticated()) {
3488                         return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3489                 }
3490
3491                 $contact = self::getByURL($contact_url, false);
3492                 if (empty($contact)) {
3493                         return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3494                 }
3495
3496                 // Prevents endless loop in case only a non-public contact exists for the contact URL
3497                 unset($contact['uid']);
3498
3499                 return self::magicLinkByContact($contact, $url ?: $contact_url);
3500         }
3501
3502         /**
3503          * Returns a magic link to authenticate remote visitors
3504          *
3505          * @param integer $cid The contact id of the target contact profile
3506          * @param string  $url An url that we will be redirected to after the authentication
3507          *
3508          * @return string with "redir" link
3509          * @throws HTTPException\InternalServerErrorException
3510          * @throws \ImagickException
3511          */
3512         public static function magicLinkById(int $cid, string $url = ''): string
3513         {
3514                 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'alias', 'uid'], ['id' => $cid]);
3515
3516                 return self::magicLinkByContact($contact, $url);
3517         }
3518
3519         /**
3520          * Returns a magic link to authenticate remote visitors
3521          *
3522          * @param array  $contact The contact array with "uid", "network" and "url"
3523          * @param string $url     An url that we will be redirected to after the authentication
3524          *
3525          * @return string with "redir" link
3526          * @throws HTTPException\InternalServerErrorException
3527          * @throws \ImagickException
3528          */
3529         public static function magicLinkByContact(array $contact, string $url = ''): string
3530         {
3531                 $destination = $url ?: (!Network::isValidHttpUrl($contact['url']) && !empty($contact['alias']) && Network::isValidHttpUrl($contact['alias']) ? $contact['alias'] : $contact['url']);
3532
3533                 if (!DI::userSession()->isAuthenticated()) {
3534                         return $destination;
3535                 }
3536
3537                 // Only redirections to the same host do make sense
3538                 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
3539                         return $url;
3540                 }
3541
3542                 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'stay_local') && ($url == '')) {
3543                         return 'contact/' . $contact['id'] . '/conversations';
3544                 }
3545
3546                 if (!empty($contact['network']) && $contact['network'] != Protocol::DFRN) {
3547                         return $destination;
3548                 }
3549
3550                 if (empty($contact['id'])) {
3551                         return $destination;
3552                 }
3553
3554                 $redirect = 'contact/redir/' . $contact['id'];
3555
3556                 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
3557                         $redirect .= '?url=' . $url;
3558                 }
3559
3560                 return $redirect;
3561         }
3562
3563         /**
3564          * Is the contact a group?
3565          *
3566          * @param integer $contactid ID of the contact
3567          *
3568          * @return boolean "true" if it is a group
3569          */
3570         public static function isGroup(int $contactid): bool
3571         {
3572                 $fields = ['contact-type'];
3573                 $condition = ['id' => $contactid];
3574                 $contact = DBA::selectFirst('contact', $fields, $condition);
3575                 if (!DBA::isResult($contact)) {
3576                         return false;
3577                 }
3578
3579                 // Is it a group?
3580                 return ($contact['contact-type'] == self::TYPE_COMMUNITY);
3581         }
3582
3583         /**
3584          * Can the remote contact receive private messages?
3585          *
3586          * @param array $contact
3587          * @return bool
3588          */
3589         public static function canReceivePrivateMessages(array $contact): bool
3590         {
3591                 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
3592                 $self = $contact['self'] ?? false;
3593
3594                 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;
3595         }
3596
3597         /**
3598          * Search contact table by nick or name
3599          *
3600          * @param string $search       Name or nick
3601          * @param string $mode         Search mode (e.g. "community")
3602          * @param bool   $show_blocked Show users from blocked servers. Default is false
3603          * @param int    $uid          User ID
3604          * @param int    $limit        Maximum amount of returned values
3605          * @param int    $offset       Limit offset
3606          *
3607          * @return array with search results
3608          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3609          */
3610         public static function searchByName(string $search, string $mode = '', bool $show_blocked = false, int $uid = 0, int $limit = 0, int $offset = 0): array
3611         {
3612                 if (empty($search)) {
3613                         return [];
3614                 }
3615
3616                 // check supported networks
3617                 $networks = [Protocol::DFRN, Protocol::ACTIVITYPUB];
3618                 if (DI::config()->get('system', 'diaspora_enabled')) {
3619                         $networks[] = Protocol::DIASPORA;
3620                 }
3621
3622                 if (!DI::config()->get('system', 'ostatus_disabled')) {
3623                         $networks[] = Protocol::OSTATUS;
3624                 }
3625
3626                 $condition = [
3627                         'network'        => $networks,
3628                         'server-failed'  => false,
3629                         'failed'         => false,
3630                         'deleted'        => false,
3631                         'unsearchable'   => false,
3632                         'uid'            => $uid
3633                 ];
3634
3635                 if (!$show_blocked) {
3636                         $condition['server-blocked'] = true;
3637                 }
3638
3639                 if ($uid == 0) {
3640                         $condition['blocked'] = false;
3641                 } else {
3642                         $condition['rel'] = [Contact::SHARING, Contact::FRIEND];
3643                 }
3644
3645                 // check if we search only communities or every contact
3646                 if ($mode === 'community') {
3647                         $condition['contact-type'] = self::TYPE_COMMUNITY;
3648                 }
3649
3650                 $search .= '%';
3651
3652                 $params = [];
3653
3654                 if (!empty($limit) && !empty($offset)) {
3655                         $params['limit'] = [$offset, $limit];
3656                 } elseif (!empty($limit)) {
3657                         $params['limit'] = $limit;
3658                 }
3659
3660                 $condition = DBA::mergeConditions(
3661                         $condition,
3662                         ["(`addr` LIKE ? OR `name` LIKE ? OR `nick` LIKE ?)", $search, $search, $search]
3663                 );
3664
3665                 return DBA::selectToArray('account-user-view', [], $condition, $params);
3666         }
3667
3668         /**
3669          * Add public contacts from an array
3670          *
3671          * @param array $urls
3672          * @return array result "count", "added" and "updated"
3673          */
3674         public static function addByUrls(array $urls): array
3675         {
3676                 $added = 0;
3677                 $updated = 0;
3678                 $unchanged = 0;
3679                 $count = 0;
3680
3681                 foreach ($urls as $url) {
3682                         if (empty($url) || !is_string($url)) {
3683                                 continue;
3684                         }
3685                         $contact = self::getByURL($url, false, ['id', 'network', 'next-update']);
3686                         if (empty($contact['id']) && Network::isValidHttpUrl($url)) {
3687                                 Worker::add(Worker::PRIORITY_LOW, 'AddContact', 0, $url);
3688                                 ++$added;
3689                         } elseif (!empty($contact['network']) && Protocol::supportsProbe($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
3690                                 try {
3691                                         UpdateContact::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], $contact['id']);
3692                                         ++$updated;
3693                                 } catch (\InvalidArgumentException $e) {
3694                                         Logger::notice($e->getMessage(), ['contact' => $contact]);
3695                                 }
3696                         } else {
3697                                 ++$unchanged;
3698                         }
3699                         ++$count;
3700                 }
3701
3702                 return ['count' => $count, 'added' => $added, 'updated' => $updated, 'unchanged' => $unchanged];
3703         }
3704
3705         /**
3706          * Returns a random, global contact array of the current node
3707          *
3708          * @return array The profile array
3709          * @throws Exception
3710          */
3711         public static function getRandomContact(): array
3712         {
3713                 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'alias', 'uid'], [
3714                         "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",
3715                         0, Protocol::DFRN, DateTimeFormat::utc('now - 1 month'),
3716                 ], ['order' => ['RAND()']]);
3717
3718                 if (DBA::isResult($contact)) {
3719                         return $contact;
3720                 }
3721
3722                 return [];
3723         }
3724
3725         /**
3726          * Checks, if contacts with the given condition exists
3727          *
3728          * @param array $condition
3729          *
3730          * @return bool
3731          * @throws \Exception
3732          */
3733         public static function exists(array $condition): bool
3734         {
3735                 return DBA::exists('contact', $condition);
3736         }
3737 }