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