src/Model/Contact.php

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