src/Model/Contact.php

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