src/Model/Contact.php

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