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