src/Model/Contact.php

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