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