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