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