src/Model/Contact.php

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