3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Model;
24 use Friendica\App\BaseURL;
25 use Friendica\Contact\Introduction\Exception\IntroductionNotFoundException;
26 use Friendica\Content\Pager;
27 use Friendica\Content\Text\HTML;
28 use Friendica\Core\Hook;
29 use Friendica\Core\Logger;
30 use Friendica\Core\Protocol;
31 use Friendica\Core\Renderer;
32 use Friendica\Core\Session;
33 use Friendica\Core\System;
34 use Friendica\Core\Worker;
35 use Friendica\Database\Database;
36 use Friendica\Database\DBA;
38 use Friendica\Network\HTTPException;
39 use Friendica\Network\Probe;
40 use Friendica\Protocol\Activity;
41 use Friendica\Protocol\ActivityPub;
42 use Friendica\Protocol\Diaspora;
43 use Friendica\Protocol\OStatus;
44 use Friendica\Protocol\Salmon;
45 use Friendica\Util\DateTimeFormat;
46 use Friendica\Util\Images;
47 use Friendica\Util\Network;
48 use Friendica\Util\Proxy;
49 use Friendica\Util\Strings;
52 * functions for interacting with a contact
56 const DEFAULT_AVATAR_PHOTO = '/images/person-300.jpg';
57 const DEFAULT_AVATAR_THUMB = '/images/person-80.jpg';
58 const DEFAULT_AVATAR_MICRO = '/images/person-48.jpg';
64 const LOCK_INSERT = 'contact-insert';
69 * TYPE_UNKNOWN - unknown type
71 * TYPE_PERSON - the account belongs to a person
72 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
74 * TYPE_ORGANISATION - the account belongs to an organisation
75 * Associated page type: PAGE_SOAPBOX
77 * TYPE_NEWS - the account is a news reflector
78 * Associated page type: PAGE_SOAPBOX
80 * TYPE_COMMUNITY - the account is community forum
81 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
83 * TYPE_RELAY - the account is a relay
84 * This will only be assigned to contacts, not to user accounts
87 const TYPE_UNKNOWN = -1;
88 const TYPE_PERSON = User::ACCOUNT_TYPE_PERSON;
89 const TYPE_ORGANISATION = User::ACCOUNT_TYPE_ORGANISATION;
90 const TYPE_NEWS = User::ACCOUNT_TYPE_NEWS;
91 const TYPE_COMMUNITY = User::ACCOUNT_TYPE_COMMUNITY;
92 const TYPE_RELAY = User::ACCOUNT_TYPE_RELAY;
112 const MIRROR_DEACTIVATED = 0;
113 const MIRROR_FORWARDED = 1;
114 const MIRROR_OWN_POST = 2;
115 const MIRROR_NATIVE_RESHARE = 3;
118 * @param array $fields Array of selected fields, empty for all
119 * @param array $condition Array of fields for condition
120 * @param array $params Array of several parameters
124 public static function selectToArray(array $fields = [], array $condition = [], array $params = [])
126 return DBA::selectToArray('contact', $fields, $condition, $params);
130 * @param array $fields Array of selected fields, empty for all
131 * @param array $condition Array of fields for condition
132 * @param array $params Array of several parameters
136 public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
138 $contact = DBA::selectFirst('contact', $fields, $condition, $params);
144 * Insert a row into the contact table
145 * Important: You can't use DBA::lastInsertId() after this call since it will be set to 0.
147 * @param array $fields field array
148 * @param int $duplicate_mode Do an update on a duplicate entry
150 * @return int id of the created contact
153 public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT)
155 if (!empty($fields['baseurl']) && empty($fields['gsid'])) {
156 $fields['gsid'] = GServer::getID($fields['baseurl'], true);
159 $fields['uri-id'] = ItemURI::getIdByURI($fields['url']);
161 if (empty($fields['created'])) {
162 $fields['created'] = DateTimeFormat::utcNow();
165 DBA::insert('contact', $fields, $duplicate_mode);
166 $contact = DBA::selectFirst('contact', [], ['id' => DBA::lastInsertId()]);
167 if (!DBA::isResult($contact)) {
169 Logger::warning('Created contact could not be found', ['fields' => $fields]);
173 Contact\User::insertForContactArray($contact);
175 // Search for duplicated contacts and get rid of them
176 if (!$contact['self']) {
177 self::removeDuplicates($contact['nurl'], $contact['uid']);
180 return $contact['id'];
184 * Updates rows in the contact table
186 * @param array $fields contains the fields that are updated
187 * @param array $condition condition array with the key values
188 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate, false = don't update identical fields)
190 * @return boolean was the update successfull?
193 public static function update(array $fields, array $condition, $old_fields = [])
195 $ret = DBA::update('contact', $fields, $condition, $old_fields);
197 // Apply changes to the "user-contact" table on dedicated fields
198 Contact\User::updateByContactUpdate($fields, $condition);
204 * @param integer $id Contact ID
205 * @param array $fields Array of selected fields, empty for all
206 * @return array|boolean Contact record if it exists, false otherwise
209 public static function getById($id, $fields = [])
211 return DBA::selectFirst('contact', $fields, ['id' => $id]);
215 * Fetch the first contact with the provided uri-id.
217 * @param integer $uri_id uri-id of the contact
218 * @param array $fields Array of selected fields, empty for all
219 * @return array|boolean Contact record if it exists, false otherwise
222 public static function getByUriId($uri_id, $fields = [])
224 return DBA::selectFirst('contact', $fields, ['uri-id' => $uri_id], ['order' => ['uid']]);
228 * Fetches a contact by a given url
230 * @param string $url profile url
231 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
232 * @param array $fields Field list
233 * @param integer $uid User ID of the contact
234 * @return array contact array
236 public static function getByURL(string $url, $update = null, array $fields = [], int $uid = 0)
238 if ($update || is_null($update)) {
239 $cid = self::getIdForURL($url, $uid, $update);
244 $contact = self::getById($cid, $fields);
245 if (empty($contact)) {
251 // Add internal fields
253 if (!empty($fields)) {
254 foreach (['id', 'avatar', 'created', 'updated', 'last-update', 'success_update', 'failure_update', 'network'] as $internal) {
255 if (!in_array($internal, $fields)) {
256 $fields[] = $internal;
257 $removal[] = $internal;
262 // We first try the nurl (http://server.tld/nick), most common case
263 $options = ['order' => ['id']];
264 $contact = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url), 'uid' => $uid, 'deleted' => false], $options);
266 // Then the addr (nick@server.tld)
267 if (!DBA::isResult($contact)) {
268 $contact = DBA::selectFirst('contact', $fields, ['addr' => str_replace('acct:', '', $url), 'uid' => $uid, 'deleted' => false], $options);
271 // Then the alias (which could be anything)
272 if (!DBA::isResult($contact)) {
273 // The link could be provided as http although we stored it as https
274 $ssl_url = str_replace('http://', 'https://', $url);
275 $condition = ['`alias` IN (?, ?, ?) AND `uid` = ? AND NOT `deleted`', $url, Strings::normaliseLink($url), $ssl_url, $uid];
276 $contact = DBA::selectFirst('contact', $fields, $condition, $options);
279 if (!DBA::isResult($contact)) {
283 // Update the contact in the background if needed
284 $updated = max($contact['success_update'], $contact['created'], $contact['updated'], $contact['last-update'], $contact['failure_update']);
285 if (($updated < DateTimeFormat::utc('now -7 days')) && in_array($contact['network'], Protocol::FEDERATED) && !self::isLocalById($contact['id'])) {
286 Worker::add(PRIORITY_LOW, "UpdateContact", $contact['id']);
289 // Remove the internal fields
290 foreach ($removal as $internal) {
291 unset($contact[$internal]);
298 * Fetches a contact for a given user by a given url.
299 * In difference to "getByURL" the function will fetch a public contact when no user contact had been found.
301 * @param string $url profile url
302 * @param integer $uid User ID of the contact
303 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
304 * @param array $fields Field list
305 * @return array contact array
307 public static function getByURLForUser(string $url, int $uid = 0, $update = false, array $fields = [])
310 $contact = self::getByURL($url, $update, $fields, $uid);
311 if (!empty($contact)) {
312 if (!empty($contact['id'])) {
313 $contact['cid'] = $contact['id'];
320 $contact = self::getByURL($url, $update, $fields);
321 if (!empty($contact['id'])) {
323 $contact['zid'] = $contact['id'];
329 * Tests if the given contact is a follower
331 * @param int $cid Either public contact id or user's contact id
332 * @param int $uid User ID
334 * @return boolean is the contact id a follower?
335 * @throws HTTPException\InternalServerErrorException
336 * @throws \ImagickException
338 public static function isFollower($cid, $uid)
340 if (Contact\User::isBlocked($cid, $uid)) {
344 $cdata = self::getPublicAndUserContactID($cid, $uid);
345 if (empty($cdata['user'])) {
349 $condition = ['id' => $cdata['user'], 'rel' => [self::FOLLOWER, self::FRIEND]];
350 return DBA::exists('contact', $condition);
354 * Tests if the given contact url is a follower
356 * @param string $url Contact URL
357 * @param int $uid User ID
359 * @return boolean is the contact id a follower?
360 * @throws HTTPException\InternalServerErrorException
361 * @throws \ImagickException
363 public static function isFollowerByURL($url, $uid)
365 $cid = self::getIdForURL($url, $uid);
371 return self::isFollower($cid, $uid);
375 * Tests if the given user follow the given contact
377 * @param int $cid Either public contact id or user's contact id
378 * @param int $uid User ID
380 * @return boolean is the contact url being followed?
381 * @throws HTTPException\InternalServerErrorException
382 * @throws \ImagickException
384 public static function isSharing($cid, $uid)
386 if (Contact\User::isBlocked($cid, $uid)) {
390 $cdata = self::getPublicAndUserContactID($cid, $uid);
391 if (empty($cdata['user'])) {
395 $condition = ['id' => $cdata['user'], 'rel' => [self::SHARING, self::FRIEND]];
396 return DBA::exists('contact', $condition);
400 * Tests if the given user follow the given contact url
402 * @param string $url Contact URL
403 * @param int $uid User ID
405 * @return boolean is the contact url being followed?
406 * @throws HTTPException\InternalServerErrorException
407 * @throws \ImagickException
409 public static function isSharingByURL($url, $uid)
411 $cid = self::getIdForURL($url, $uid);
417 return self::isSharing($cid, $uid);
421 * Get the basepath for a given contact link
423 * @param string $url The contact link
424 * @param boolean $dont_update Don't update the contact
426 * @return string basepath
427 * @throws HTTPException\InternalServerErrorException
428 * @throws \ImagickException
430 public static function getBasepath($url, $dont_update = false)
432 $contact = DBA::selectFirst('contact', ['id', 'baseurl'], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
433 if (!DBA::isResult($contact)) {
437 if (!empty($contact['baseurl'])) {
438 return $contact['baseurl'];
439 } elseif ($dont_update) {
443 // Update the existing contact
444 self::updateFromProbe($contact['id']);
446 // And fetch the result
447 $contact = DBA::selectFirst('contact', ['baseurl'], ['id' => $contact['id']]);
448 if (empty($contact['baseurl'])) {
449 Logger::info('No baseurl for contact', ['url' => $url]);
453 Logger::info('Found baseurl for contact', ['url' => $url, 'baseurl' => $contact['baseurl']]);
454 return $contact['baseurl'];
458 * Check if the given contact url is on the same server
460 * @param string $url The contact link
462 * @return boolean Is it the same server?
464 public static function isLocal($url)
466 if (!parse_url($url, PHP_URL_SCHEME)) {
467 $addr_parts = explode('@', $url);
468 return (count($addr_parts) == 2) && ($addr_parts[1] == DI::baseUrl()->getHostname());
471 return Strings::compareLink(self::getBasepath($url, true), DI::baseUrl());
475 * Check if the given contact ID is on the same server
477 * @param string $url The contact link
479 * @return boolean Is it the same server?
481 public static function isLocalById(int $cid)
483 $contact = DBA::selectFirst('contact', ['url', 'baseurl'], ['id' => $cid]);
484 if (!DBA::isResult($contact)) {
488 if (empty($contact['baseurl'])) {
489 $baseurl = self::getBasepath($contact['url'], true);
491 $baseurl = $contact['baseurl'];
494 return Strings::compareLink($baseurl, DI::baseUrl());
498 * Returns the public contact id of the given user id
500 * @param integer $uid User ID
502 * @return integer|boolean Public contact id for given user id
505 public static function getPublicIdByUserId($uid)
507 $self = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
508 if (!DBA::isResult($self)) {
511 return self::getIdForURL($self['url']);
515 * Returns the contact id for the user and the public contact id for a given contact id
517 * @param int $cid Either public contact id or user's contact id
518 * @param int $uid User ID
520 * @return array with public and user's contact id
521 * @throws HTTPException\InternalServerErrorException
522 * @throws \ImagickException
524 public static function getPublicAndUserContactID($cid, $uid)
526 // We have to use the legacy function as long as the post update hasn't finished
527 if (DI::config()->get('system', 'post_update_version') < 1427) {
528 return self::legacyGetPublicAndUserContactID($cid, $uid);
531 if (empty($uid) || empty($cid)) {
535 $contact = DBA::selectFirst('account-user-view', ['id', 'uid', 'pid'], ['id' => $cid]);
536 if (!DBA::isResult($contact) || !in_array($contact['uid'], [0, $uid])) {
540 $pcid = $contact['pid'];
541 if ($contact['uid'] == $uid) {
542 $ucid = $contact['id'];
544 $contact = DBA::selectFirst('account-user-view', ['id', 'uid'], ['pid' => $cid, 'uid' => $uid]);
545 if (DBA::isResult($contact)) {
546 $ucid = $contact['id'];
552 return ['public' => $pcid, 'user' => $ucid];
556 * Helper function for "getPublicAndUserContactID"
558 * @param int $cid Either public contact id or user's contact id
559 * @param int $uid User ID
561 * @return array with public and user's contact id
562 * @throws HTTPException\InternalServerErrorException
563 * @throws \ImagickException
565 private static function legacyGetPublicAndUserContactID($cid, $uid)
567 if (empty($uid) || empty($cid)) {
571 $contact = DBA::selectFirst('contact', ['id', 'uid', 'url'], ['id' => $cid]);
572 if (!DBA::isResult($contact)) {
576 // We quit when the user id don't match the user id of the provided contact
577 if (($contact['uid'] != $uid) && ($contact['uid'] != 0)) {
581 if ($contact['uid'] != 0) {
582 $pcid = self::getIdForURL($contact['url'], 0, false, ['url' => $contact['url']]);
586 $ucid = $contact['id'];
588 $pcid = $contact['id'];
589 $ucid = self::getIdForURL($contact['url'], $uid);
592 return ['public' => $pcid, 'user' => $ucid];
596 * Returns contact details for a given contact id in combination with a user id
598 * @param int $cid A contact ID
599 * @param int $uid The User ID
600 * @param array $fields The selected fields for the contact
602 * @return array The contact details
606 public static function getContactForUser($cid, $uid, array $fields = [])
608 $contact = DBA::selectFirst('contact', $fields, ['id' => $cid, 'uid' => $uid]);
610 if (!DBA::isResult($contact)) {
618 * Creates the self-contact for the provided user id
621 * @return bool Operation success
622 * @throws HTTPException\InternalServerErrorException
624 public static function createSelfFromUserId($uid)
626 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname', 'pubkey', 'prvkey'],
627 ['uid' => $uid, 'account_expired' => false]);
628 if (!DBA::isResult($user)) {
633 'uid' => $user['uid'],
634 'created' => DateTimeFormat::utcNow(),
636 'name' => $user['username'],
637 'nick' => $user['nickname'],
638 'pubkey' => $user['pubkey'],
639 'prvkey' => $user['prvkey'],
640 'photo' => User::getAvatarUrl($user),
641 'thumb' => User::getAvatarUrl($user, Proxy::SIZE_THUMB),
642 'micro' => User::getAvatarUrl($user, Proxy::SIZE_MICRO),
645 'url' => DI::baseUrl() . '/profile/' . $user['nickname'],
646 'nurl' => Strings::normaliseLink(DI::baseUrl() . '/profile/' . $user['nickname']),
647 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
648 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
649 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
650 'poll' => DI::baseUrl() . '/dfrn_poll/' . $user['nickname'],
651 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
652 'poco' => DI::baseUrl() . '/poco/' . $user['nickname'],
653 'name-date' => DateTimeFormat::utcNow(),
654 'uri-date' => DateTimeFormat::utcNow(),
655 'avatar-date' => DateTimeFormat::utcNow(),
661 // Only create the entry if it doesn't exist yet
662 if (!DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
663 $return = (bool)self::insert($contact);
666 // Create the public contact
667 if (!DBA::exists('contact', ['nurl' => $contact['nurl'], 'uid' => 0])) {
668 $contact['self'] = false;
670 $contact['prvkey'] = null;
672 self::insert($contact, Database::INSERT_IGNORE);
679 * Updates the self-contact for the provided user id
682 * @param boolean $update_avatar Force the avatar update
683 * @return bool "true" if updated
684 * @throws HTTPException\InternalServerErrorException
686 public static function updateSelfFromUserID($uid, $update_avatar = false)
688 $fields = ['id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey',
689 'xmpp', 'matrix', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
690 'photo', 'thumb', 'micro', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco', 'network'];
691 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
692 if (!DBA::isResult($self)) {
696 $fields = ['uid', 'nickname', 'page-flags', 'account-type', 'prvkey', 'pubkey'];
697 $user = DBA::selectFirst('user', $fields, ['uid' => $uid, 'account_expired' => false]);
698 if (!DBA::isResult($user)) {
702 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
703 'country-name', 'pub_keywords', 'xmpp', 'matrix', 'net-publish'];
704 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid]);
705 if (!DBA::isResult($profile)) {
709 $file_suffix = 'jpg';
711 $fields = ['name' => $profile['name'], 'nick' => $user['nickname'],
712 'avatar-date' => $self['avatar-date'], 'location' => Profile::formatLocation($profile),
713 'about' => $profile['about'], 'keywords' => $profile['pub_keywords'],
714 'contact-type' => $user['account-type'], 'prvkey' => $user['prvkey'],
715 'pubkey' => $user['pubkey'], 'xmpp' => $profile['xmpp'], 'matrix' => $profile['matrix'], 'network' => Protocol::DFRN];
717 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
718 $fields['url'] = DI::baseUrl() . '/profile/' . $user['nickname'];
719 $fields['nurl'] = Strings::normaliseLink($fields['url']);
720 $fields['addr'] = $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3);
721 $fields['request'] = DI::baseUrl() . '/dfrn_request/' . $user['nickname'];
722 $fields['notify'] = DI::baseUrl() . '/dfrn_notify/' . $user['nickname'];
723 $fields['poll'] = DI::baseUrl() . '/dfrn_poll/'. $user['nickname'];
724 $fields['confirm'] = DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'];
725 $fields['poco'] = DI::baseUrl() . '/poco/' . $user['nickname'];
727 $avatar = Photo::selectFirst(['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
728 if (DBA::isResult($avatar)) {
729 if ($update_avatar) {
730 $fields['avatar-date'] = DateTimeFormat::utcNow();
733 // Creating the path to the avatar, beginning with the file suffix
734 $types = Images::supportedTypes();
735 if (isset($types[$avatar['type']])) {
736 $file_suffix = $types[$avatar['type']];
739 // We are adding a timestamp value so that other systems won't use cached content
740 $timestamp = strtotime($fields['avatar-date']);
742 $prefix = DI::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
743 $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
745 $fields['photo'] = $prefix . '4' . $suffix;
746 $fields['thumb'] = $prefix . '5' . $suffix;
747 $fields['micro'] = $prefix . '6' . $suffix;
749 // We hadn't found a photo entry, so we use the default avatar
750 $fields['photo'] = self::getDefaultAvatar($fields, Proxy::SIZE_SMALL);
751 $fields['thumb'] = self::getDefaultAvatar($fields, Proxy::SIZE_THUMB);
752 $fields['micro'] = self::getDefaultAvatar($fields, Proxy::SIZE_MICRO);
755 $fields['avatar'] = User::getAvatarUrl($user);
756 $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
757 $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
758 $fields['unsearchable'] = !$profile['net-publish'];
762 foreach ($fields as $field => $content) {
763 if ($self[$field] != $content) {
769 if ($fields['name'] != $self['name']) {
770 $fields['name-date'] = DateTimeFormat::utcNow();
772 $fields['updated'] = DateTimeFormat::utcNow();
773 self::update($fields, ['id' => $self['id']]);
775 // Update the public contact as well
776 $fields['prvkey'] = null;
777 $fields['self'] = false;
778 self::update($fields, ['uid' => 0, 'nurl' => $self['nurl']]);
780 // Update the profile
782 'photo' => User::getAvatarUrl($user),
783 'thumb' => User::getAvatarUrl($user, Proxy::SIZE_THUMB)
786 DBA::update('profile', $fields, ['uid' => $uid]);
793 * Marks a contact for removal
795 * @param int $id contact id
796 * @throws HTTPException\InternalServerErrorException
798 public static function remove($id)
800 // We want just to make sure that we don't delete our "self" contact
801 $contact = DBA::selectFirst('contact', ['uid'], ['id' => $id, 'self' => false]);
802 if (!DBA::isResult($contact)) {
806 // Archive the contact
807 self::update(['archive' => true, 'network' => Protocol::PHANTOM, 'deleted' => true], ['id' => $id]);
809 // Delete it in the background
810 Worker::add(PRIORITY_MEDIUM, 'Contact\Remove', $id);
814 * Sends an unfriend message. Removes the contact for two-way unfriending or sharing only protocols (feed an mail)
816 * @param array $user User unfriending
817 * @param array $contact Contact (uid != 0) unfriended
818 * @param boolean $two_way Revoke eventual inbound follow as well
819 * @return bool|null true if successful, false if not, null if no remote action was performed
820 * @throws HTTPException\InternalServerErrorException
821 * @throws \ImagickException
823 public static function terminateFriendship(array $user, array $contact): ?bool
825 $result = Protocol::terminateFriendship($user, $contact);
827 if ($contact['rel'] == Contact::SHARING || in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
828 self::remove($contact['id']);
830 self::update(['rel' => Contact::FOLLOWER], ['id' => $contact['id']]);
837 * Revoke follow privileges of the remote user contact
839 * @param array $contact Contact unfriended
840 * @return bool|null Whether the remote operation is successful or null if no remote operation was performed
841 * @throws HTTPException\InternalServerErrorException
842 * @throws \ImagickException
844 public static function revokeFollow(array $contact): ?bool
846 if (empty($contact['network'])) {
847 throw new \InvalidArgumentException('Empty network in contact array');
850 if (empty($contact['uid'])) {
851 throw new \InvalidArgumentException('Unexpected public contact record');
854 $result = Protocol::revokeFollow($contact);
856 // A null value here means the remote network doesn't support explicit follow revocation, we can still
857 // break the locally recorded relationship
858 if ($result !== false) {
859 if ($contact['rel'] == self::FRIEND) {
860 self::update(['rel' => self::SHARING], ['id' => $contact['id']]);
862 self::remove($contact['id']);
871 * Marks a contact for archival after a communication issue delay
873 * Contact has refused to recognise us as a friend. We will start a countdown.
874 * If they still don't recognise us in 32 days, the relationship is over,
875 * and we won't waste any more time trying to communicate with them.
876 * This provides for the possibility that their database is temporarily messed
877 * up or some other transient event and that there's a possibility we could recover from it.
879 * @param array $contact contact to mark for archival
881 * @throws HTTPException\InternalServerErrorException
883 public static function markForArchival(array $contact)
885 if (!isset($contact['url']) && !empty($contact['id'])) {
886 $fields = ['id', 'url', 'archive', 'self', 'term-date'];
887 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
888 if (!DBA::isResult($contact)) {
891 } elseif (!isset($contact['url'])) {
892 Logger::info('Empty contact', ['contact' => $contact, 'callstack' => System::callstack(20)]);
895 Logger::info('Contact is marked for archival', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
897 // Contact already archived or "self" contact? => nothing to do
898 if ($contact['archive'] || $contact['self']) {
902 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
903 self::update(['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
904 self::update(['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
907 * We really should send a notification to the owner after 2-3 weeks
908 * so they won't be surprised when the contact vanishes and can take
909 * remedial action if this was a serious mistake or glitch
912 /// @todo Check for contact vitality via probing
913 $archival_days = DI::config()->get('system', 'archival_days', 32);
915 $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
916 if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
917 /* Relationship is really truly dead. archive them rather than
918 * delete, though if the owner tries to unarchive them we'll start
919 * the whole process over again.
921 self::update(['archive' => true], ['id' => $contact['id']]);
922 self::update(['archive' => true], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
928 * Cancels the archival countdown
930 * @see Contact::markForArchival()
932 * @param array $contact contact to be unmarked for archival
936 public static function unmarkForArchival(array $contact)
938 // Always unarchive the relay contact entry
939 if (!empty($contact['batch']) && !empty($contact['term-date']) && ($contact['term-date'] > DBA::NULL_DATETIME)) {
940 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
941 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
942 if (!DBA::exists('contact', array_merge($condition, $fields))) {
943 self::update($fields, $condition);
947 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
948 $exists = DBA::exists('contact', $condition);
950 // We don't need to update, we never marked this contact for archival
955 Logger::info('Contact is marked as vital again', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
957 if (!isset($contact['url']) && !empty($contact['id'])) {
958 $fields = ['id', 'url', 'batch'];
959 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
960 if (!DBA::isResult($contact)) {
965 // It's a miracle. Our dead contact has inexplicably come back to life.
966 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
967 self::update($fields, ['id' => $contact['id']]);
968 self::update($fields, ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
972 * Returns the data array for the photo menu of a given contact
974 * @param array $contact contact
975 * @param int $uid optional, default 0
977 * @throws HTTPException\InternalServerErrorException
978 * @throws \ImagickException
980 public static function photoMenu(array $contact, $uid = 0)
991 if (empty($contact['uid']) || ($contact['uid'] != $uid)) {
993 $profile_link = self::magicLinkByContact($contact);
994 $menu = ['profile' => [DI::l10n()->t('View Profile'), $profile_link, true]];
999 // Look for our own contact if the uid doesn't match and isn't public
1000 $contact_own = DBA::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
1001 if (DBA::isResult($contact_own)) {
1002 return self::photoMenu($contact_own, $uid);
1007 if (($contact['network'] === Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1009 $profile_link = DI::baseUrl() . '/redir/' . $contact['id'];
1011 $profile_link = $contact['url'];
1014 if ($profile_link === 'mailbox') {
1019 $status_link = $profile_link . '/status';
1020 $photos_link = str_replace('/profile/', '/photos/', $profile_link);
1021 $profile_link = $profile_link . '/profile';
1024 if (self::canReceivePrivateMessages($contact) && empty($contact['pending'])) {
1025 $pm_url = DI::baseUrl() . '/message/new/' . $contact['id'];
1028 if (($contact['network'] == Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1029 $poke_link = 'contact/' . $contact['id'] . '/poke';
1032 $contact_url = DI::baseUrl() . '/contact/' . $contact['id'];
1034 $posts_link = DI::baseUrl() . '/contact/' . $contact['id'] . '/conversations';
1037 $unfollow_link = '';
1038 if (!$contact['self'] && Protocol::supportsFollow($contact['network'])) {
1039 if ($contact['uid'] && in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
1040 $unfollow_link = 'unfollow?url=' . urlencode($contact['url']) . '&auto=1';
1041 } elseif(!$contact['pending']) {
1042 $follow_link = 'follow?url=' . urlencode($contact['url']) . '&auto=1';
1048 * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
1050 if (empty($contact['uid'])) {
1052 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
1053 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1054 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1055 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
1056 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link, true],
1060 'status' => [DI::l10n()->t('View Status') , $status_link , true],
1061 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
1062 'photos' => [DI::l10n()->t('View Photos') , $photos_link , true],
1063 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1064 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1065 'pm' => [DI::l10n()->t('Send PM') , $pm_url , false],
1066 'poke' => [DI::l10n()->t('Poke') , $poke_link , false],
1067 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
1068 'unfollow'=> [DI::l10n()->t('UnFollow') , $unfollow_link , true],
1071 if (!empty($contact['pending'])) {
1073 $intro = DI::intro()->selectForContact($contact['id']);
1074 $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro->id, true];
1075 } catch (IntroductionNotFoundException $exception) {
1076 DI::logger()->error('Pending contact doesn\'t have an introduction.', ['exception' => $exception]);
1081 $args = ['contact' => $contact, 'menu' => &$menu];
1083 Hook::callAll('contact_photo_menu', $args);
1085 $menucondensed = [];
1087 foreach ($menu as $menuname => $menuitem) {
1088 if ($menuitem[1] != '') {
1089 $menucondensed[$menuname] = $menuitem;
1093 return $menucondensed;
1097 * Fetch the contact id for a given URL and user
1099 * First lookup in the contact table to find a record matching either `url`, `nurl`,
1100 * `addr` or `alias`.
1102 * If there's no record and we aren't looking for a public contact, we quit.
1103 * If there's one, we check that it isn't time to update the picture else we
1104 * directly return the found contact id.
1106 * Second, we probe the provided $url whether it's http://server.tld/profile or
1107 * nick@server.tld. We quit if we can't get any info back.
1109 * Third, we create the contact record if it doesn't exist
1111 * Fourth, we update the existing record with the new data (avatar, alias, nick)
1112 * if there's any updates
1114 * @param string $url Contact URL
1115 * @param integer $uid The user id for the contact (0 = public contact)
1116 * @param boolean $update true = always update, false = never update, null = update when not found
1117 * @param array $default Default value for creating the contact when everything else fails
1119 * @return integer Contact ID
1120 * @throws HTTPException\InternalServerErrorException
1121 * @throws \ImagickException
1123 public static function getIdForURL($url, $uid = 0, $update = null, $default = [])
1128 Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
1132 $contact = self::getByURL($url, false, ['id', 'network', 'uri-id'], $uid);
1134 if (!empty($contact)) {
1135 $contact_id = $contact["id"];
1137 if (empty($update) && (!empty($contact['uri-id']) || is_bool($update))) {
1138 Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1141 } elseif ($uid != 0) {
1142 Logger::debug('Contact does not exist for the user', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1144 } elseif (empty($default) && !is_null($update) && !$update) {
1145 Logger::info('Contact not found, update not desired', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1151 if (empty($default['network']) || $update) {
1152 $data = Probe::uri($url, "", $uid);
1154 // Take the default values when probing failed
1155 if (!empty($default) && !in_array($data["network"], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1156 $data = array_merge($data, $default);
1158 } elseif (!empty($default['network'])) {
1162 if (($uid == 0) && (empty($data['network']) || ($data['network'] == Protocol::PHANTOM))) {
1163 // Fetch data for the public contact via the first found personal contact
1164 /// @todo Check if this case can happen at all (possibly with mail accounts?)
1165 $fields = ['name', 'nick', 'url', 'addr', 'alias', 'avatar', 'header', 'contact-type',
1166 'keywords', 'location', 'about', 'unsearchable', 'batch', 'notify', 'poll',
1167 'request', 'confirm', 'poco', 'subscribe', 'network', 'baseurl', 'gsid'];
1169 $personal_contact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `uid` != 0", $url]);
1170 if (!DBA::isResult($personal_contact)) {
1171 $personal_contact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `uid` != 0", Strings::normaliseLink($url)]);
1174 if (DBA::isResult($personal_contact)) {
1175 Logger::info('Take contact data from personal contact', ['url' => $url, 'update' => $update, 'contact' => $personal_contact, 'callstack' => System::callstack(20)]);
1176 $data = $personal_contact;
1177 $data['photo'] = $personal_contact['avatar'];
1178 $data['account-type'] = $personal_contact['contact-type'];
1179 $data['hide'] = $personal_contact['unsearchable'];
1180 unset($data['avatar']);
1181 unset($data['contact-type']);
1182 unset($data['unsearchable']);
1186 if (empty($data['network']) || ($data['network'] == Protocol::PHANTOM)) {
1187 Logger::notice('No valid network found', ['url' => $url, 'uid' => $uid, 'default' => $default, 'update' => $update, 'callstack' => System::callstack(20)]);
1192 $urls = [Strings::normaliseLink($url), Strings::normaliseLink($data['url'])];
1193 if (!empty($data['alias'])) {
1194 $urls[] = Strings::normaliseLink($data['alias']);
1196 $contact = self::selectFirst(['id'], ['nurl' => $urls, 'uid' => $uid]);
1197 if (!empty($contact['id'])) {
1198 $contact_id = $contact['id'];
1199 Logger::info('Fetched id by url', ['cid' => $contact_id, 'uid' => $uid, 'url' => $url, 'data' => $data]);
1204 // We only insert the basic data. The rest will be done in "updateFromProbeArray"
1207 'url' => $data['url'],
1208 'nurl' => Strings::normaliseLink($data['url']),
1209 'network' => $data['network'],
1210 'created' => DateTimeFormat::utcNow(),
1211 'rel' => self::SHARING,
1217 $condition = ['nurl' => Strings::normaliseLink($data["url"]), 'uid' => $uid, 'deleted' => false];
1219 // Before inserting we do check if the entry does exist now.
1220 if (DI::lock()->acquire(self::LOCK_INSERT, 0)) {
1221 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1222 if (DBA::isResult($contact)) {
1223 $contact_id = $contact['id'];
1224 Logger::notice('Contact had been created (shortly) before', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1226 $contact_id = self::insert($fields);
1228 Logger::info('Contact inserted', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1231 DI::lock()->release(self::LOCK_INSERT);
1233 Logger::warning('Contact lock had not been acquired');
1237 Logger::info('Contact was not inserted', ['url' => $url, 'uid' => $uid]);
1241 Logger::info('Contact will be updated', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1244 if ($data['network'] == Protocol::DIASPORA) {
1245 FContact::updateFromProbeArray($data);
1248 self::updateFromProbeArray($contact_id, $data);
1250 // Don't return a number for a deleted account
1251 if (!empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1252 Logger::info('Contact is a tombstone', ['url' => $url, 'uid' => $uid]);
1260 * Checks if the contact is archived
1262 * @param int $cid contact id
1264 * @return boolean Is the contact archived?
1265 * @throws HTTPException\InternalServerErrorException
1267 public static function isArchived(int $cid)
1273 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1274 if (!DBA::isResult($contact)) {
1278 if ($contact['archive']) {
1282 // Check status of ActivityPub endpoints
1283 $apcontact = APContact::getByURL($contact['url'], false);
1284 if (!empty($apcontact)) {
1285 if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1289 if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1294 // Check status of Diaspora endpoints
1295 if (!empty($contact['batch'])) {
1296 $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1297 return DBA::exists('contact', $condition);
1304 * Checks if the contact is blocked
1306 * @param int $cid contact id
1308 * @return boolean Is the contact blocked?
1309 * @throws HTTPException\InternalServerErrorException
1311 public static function isBlocked($cid)
1317 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1318 if (!DBA::isResult($blocked)) {
1322 if (Network::isUrlBlocked($blocked['url'])) {
1326 return (bool) $blocked['blocked'];
1330 * Checks if the contact is hidden
1332 * @param int $cid contact id
1334 * @return boolean Is the contact hidden?
1335 * @throws \Exception
1337 public static function isHidden($cid)
1343 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1344 if (!DBA::isResult($hidden)) {
1347 return (bool) $hidden['hidden'];
1351 * Returns posts from a given contact url
1353 * @param string $contact_url Contact URL
1354 * @param bool $thread_mode
1355 * @param int $update Update mode
1356 * @param int $parent Item parent ID for the update mode
1357 * @param bool $only_media Only display media content
1358 * @return string posts in HTML
1359 * @throws \Exception
1361 public static function getPostsFromUrl($contact_url, $thread_mode = false, $update = 0, $parent = 0, bool $only_media = false)
1363 return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent, $only_media);
1367 * Returns posts from a given contact id
1369 * @param int $cid Contact ID
1370 * @param bool $thread_mode
1371 * @param int $update Update mode
1372 * @param int $parent Item parent ID for the update mode
1373 * @param bool $only_media Only display media content
1374 * @return string posts in HTML
1375 * @throws \Exception
1377 public static function getPostsFromId($cid, $thread_mode = false, $update = 0, $parent = 0, bool $only_media = false)
1379 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1380 if (!DBA::isResult($contact)) {
1384 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1385 $sql = "(`uid` = 0 OR (`uid` = ? AND NOT `global`))";
1390 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1393 $condition = ["((`$contact_field` = ? AND `gravity` = ?) OR (`author-id` = ? AND `gravity` = ? AND `vid` = ?)) AND " . $sql,
1394 $cid, GRAVITY_PARENT, $cid, GRAVITY_ACTIVITY, Verb::getID(Activity::ANNOUNCE), local_user()];
1396 $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1397 $cid, GRAVITY_PARENT, GRAVITY_COMMENT, local_user()];
1400 if (!empty($parent)) {
1401 $condition = DBA::mergeConditions($condition, ['parent' => $parent]);
1403 $last_received = isset($_GET['last_received']) ? DateTimeFormat::utc($_GET['last_received']) : '';
1404 if (!empty($last_received)) {
1405 $condition = DBA::mergeConditions($condition, ["`received` < ?", $last_received]);
1410 $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
1411 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
1414 if (DI::mode()->isMobile()) {
1415 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_mobile_network',
1416 DI::config()->get('system', 'itemspage_network_mobile'));
1418 $itemsPerPage = DI::pConfig()->get(local_user(), 'system', 'itemspage_network',
1419 DI::config()->get('system', 'itemspage_network'));
1422 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1424 $params = ['order' => ['received' => true], 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1426 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1427 $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
1428 $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
1434 $items = Post::toArray(Post::selectForUser(local_user(), ['uri-id', 'gravity', 'parent-uri-id', 'thr-parent-id', 'author-id'], $condition, $params));
1436 $o .= DI::conversation()->create($items, 'contacts', $update, false, 'commented', local_user());
1438 $items = Post::toArray(Post::selectForUser(local_user(), Item::DISPLAY_FIELDLIST, $condition, $params));
1440 $o .= DI::conversation()->create($items, 'contact-posts', $update);
1444 if (DI::pConfig()->get(local_user(), 'system', 'infinite_scroll')) {
1445 $o .= HTML::scrollLoader();
1447 $o .= $pager->renderMinimal(count($items));
1455 * Returns the account type name
1457 * The function can be called with either the user or the contact array
1459 * @param array $contact contact or user array
1462 public static function getAccountType(array $contact)
1464 // There are several fields that indicate that the contact or user is a forum
1465 // "page-flags" is a field in the user table,
1466 // "forum" and "prv" are used in the contact table. They stand for User::PAGE_FLAGS_COMMUNITY and User::PAGE_FLAGS_PRVGROUP.
1467 if ((isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_COMMUNITY))
1468 || (isset($contact['page-flags']) && (intval($contact['page-flags']) == User::PAGE_FLAGS_PRVGROUP))
1469 || (isset($contact['forum']) && intval($contact['forum']))
1470 || (isset($contact['prv']) && intval($contact['prv']))
1471 || (isset($contact['community']) && intval($contact['community']))
1473 $type = self::TYPE_COMMUNITY;
1475 $type = self::TYPE_PERSON;
1478 // The "contact-type" (contact table) and "account-type" (user table) are more general then the chaos from above.
1479 if (isset($contact["contact-type"])) {
1480 $type = $contact["contact-type"];
1483 if (isset($contact["account-type"])) {
1484 $type = $contact["account-type"];
1488 case self::TYPE_ORGANISATION:
1489 $account_type = DI::l10n()->t("Organisation");
1492 case self::TYPE_NEWS:
1493 $account_type = DI::l10n()->t('News');
1496 case self::TYPE_COMMUNITY:
1497 $account_type = DI::l10n()->t("Forum");
1505 return $account_type;
1513 * @throws \Exception
1515 public static function block($cid, $reason = null)
1517 $return = self::update(['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1523 * Unblocks a contact
1527 * @throws \Exception
1529 public static function unblock($cid)
1531 $return = self::update(['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1537 * Ensure that cached avatar exist
1539 * @param integer $cid
1541 public static function checkAvatarCache(int $cid)
1543 $contact = DBA::selectFirst('contact', ['url', 'network', 'avatar', 'photo', 'thumb', 'micro'], ['id' => $cid, 'uid' => 0, 'self' => false]);
1544 if (!DBA::isResult($contact)) {
1548 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || DI::config()->get('system', 'cache_contact_avatar')) {
1549 if (!empty($contact['avatar']) && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1550 Logger::info('Adding avatar cache', ['id' => $cid, 'contact' => $contact]);
1551 self::updateAvatar($cid, $contact['avatar'], true);
1554 } elseif (!empty($contact['photo']) || !empty($contact['thumb']) || !empty($contact['micro'])) {
1555 Logger::info('Removing avatar cache', ['id' => $cid, 'contact' => $contact]);
1556 self::updateAvatar($cid, $contact['avatar'], true);
1562 * Return the photo path for a given contact array in the given size
1564 * @param array $contact contact array
1565 * @param string $field Fieldname of the photo in the contact array
1566 * @param string $size Size of the avatar picture
1567 * @param string $avatar Avatar path that is displayed when no photo had been found
1568 * @param bool $no_update Don't perfom an update if no cached avatar was found
1569 * @return string photo path
1571 private static function getAvatarPath(array $contact, string $size, $no_update = false)
1573 $contact = self::checkAvatarCacheByArray($contact, $no_update);
1574 return self::getAvatarUrlForId($contact['id'], $size, $contact['updated'] ?? '');
1578 * Return the photo path for a given contact array
1580 * @param array $contact Contact array
1581 * @param bool $no_update Don't perfom an update if no cached avatar was found
1582 * @return string photo path
1584 public static function getPhoto(array $contact, bool $no_update = false)
1586 return self::getAvatarPath($contact, Proxy::SIZE_SMALL, $no_update);
1590 * Return the photo path (thumb size) for a given contact array
1592 * @param array $contact Contact array
1593 * @param bool $no_update Don't perfom an update if no cached avatar was found
1594 * @return string photo path
1596 public static function getThumb(array $contact, bool $no_update = false)
1598 return self::getAvatarPath($contact, Proxy::SIZE_THUMB, $no_update);
1602 * Return the photo path (micro size) for a given contact array
1604 * @param array $contact Contact array
1605 * @param bool $no_update Don't perfom an update if no cached avatar was found
1606 * @return string photo path
1608 public static function getMicro(array $contact, bool $no_update = false)
1610 return self::getAvatarPath($contact, Proxy::SIZE_MICRO, $no_update);
1614 * Check the given contact array for avatar cache fields
1616 * @param array $contact
1617 * @param bool $no_update Don't perfom an update if no cached avatar was found
1618 * @return array contact array with avatar cache fields
1620 private static function checkAvatarCacheByArray(array $contact, bool $no_update = false)
1623 $contact_fields = [];
1624 $fields = ['photo', 'thumb', 'micro'];
1625 foreach ($fields as $field) {
1626 if (isset($contact[$field])) {
1627 $contact_fields[] = $field;
1629 if (isset($contact[$field]) && empty($contact[$field])) {
1634 if (!$update || $no_update) {
1638 if (!empty($contact['id']) && !empty($contact['avatar'])) {
1639 self::updateAvatar($contact['id'], $contact['avatar'], true);
1641 $new_contact = self::getById($contact['id'], $contact_fields);
1642 if (DBA::isResult($new_contact)) {
1643 // We only update the cache fields
1644 $contact = array_merge($contact, $new_contact);
1648 /// add the default avatars if the fields aren't filled
1649 if (isset($contact['photo']) && empty($contact['photo'])) {
1650 $contact['photo'] = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1652 if (isset($contact['thumb']) && empty($contact['thumb'])) {
1653 $contact['thumb'] = self::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
1655 if (isset($contact['micro']) && empty($contact['micro'])) {
1656 $contact['micro'] = self::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
1663 * Fetch the default avatar for the given contact and size
1665 * @param array $contact contact array
1666 * @param string $size Size of the avatar picture
1667 * @return string avatar URL
1669 public static function getDefaultAvatar(array $contact, string $size)
1672 case Proxy::SIZE_MICRO:
1673 $avatar['size'] = 48;
1674 $default = self::DEFAULT_AVATAR_MICRO;
1677 case Proxy::SIZE_THUMB:
1678 $avatar['size'] = 80;
1679 $default = self::DEFAULT_AVATAR_THUMB;
1682 case Proxy::SIZE_SMALL:
1684 $avatar['size'] = 300;
1685 $default = self::DEFAULT_AVATAR_PHOTO;
1689 if (!DI::config()->get('system', 'remote_avatar_lookup')) {
1690 return DI::baseUrl() . $default;
1693 if (!empty($contact['xmpp'])) {
1694 $avatar['email'] = $contact['xmpp'];
1695 } elseif (!empty($contact['addr'])) {
1696 $avatar['email'] = $contact['addr'];
1697 } elseif (!empty($contact['url'])) {
1698 $avatar['email'] = $contact['url'];
1700 return DI::baseUrl() . $default;
1703 $avatar['url'] = '';
1704 $avatar['success'] = false;
1706 Hook::callAll('avatar_lookup', $avatar);
1708 if ($avatar['success'] && !empty($avatar['url'])) {
1709 return $avatar['url'];
1712 return DI::baseUrl() . $default;
1716 * Get avatar link for given contact id
1718 * @param integer $cid contact id
1719 * @param string $size One of the Proxy::SIZE_* constants
1720 * @param string $updated Contact update date
1721 * @return string avatar link
1723 public static function getAvatarUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''):string
1725 // We have to fetch the "updated" variable when it wasn't provided
1726 // The parameter can be provided to improve performance
1727 if (empty($updated) || empty($guid)) {
1728 $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
1729 $updated = $account['updated'] ?? '';
1730 $guid = $account['guid'] ?? '';
1733 $guid = urlencode($guid);
1735 $url = DI::baseUrl() . '/photo/contact/';
1737 case Proxy::SIZE_MICRO:
1738 $url .= Proxy::PIXEL_MICRO . '/';
1740 case Proxy::SIZE_THUMB:
1741 $url .= Proxy::PIXEL_THUMB . '/';
1743 case Proxy::SIZE_SMALL:
1744 $url .= Proxy::PIXEL_SMALL . '/';
1746 case Proxy::SIZE_MEDIUM:
1747 $url .= Proxy::PIXEL_MEDIUM . '/';
1749 case Proxy::SIZE_LARGE:
1750 $url .= Proxy::PIXEL_LARGE . '/';
1753 return $url . ($guid ?: $cid) . ($updated ? '?ts=' . strtotime($updated) : '');
1757 * Get avatar link for given contact URL
1759 * @param string $url contact url
1760 * @param integer $uid user id
1761 * @param string $size One of the Proxy::SIZE_* constants
1762 * @return string avatar link
1764 public static function getAvatarUrlForUrl(string $url, int $uid, string $size = ''):string
1766 $condition = ["`nurl` = ? AND ((`uid` = ? AND `network` IN (?, ?)) OR `uid` = ?)",
1767 Strings::normaliseLink($url), $uid, Protocol::FEED, Protocol::MAIL, 0];
1768 $contact = self::selectFirst(['id', 'updated'], $condition, ['order' => ['uid' => true]]);
1769 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
1773 * Get header link for given contact id
1775 * @param integer $cid contact id
1776 * @param string $size One of the Proxy::SIZE_* constants
1777 * @param string $updated Contact update date
1778 * @return string header link
1780 public static function getHeaderUrlForId(int $cid, string $size = '', string $updated = '', string $guid = ''):string
1782 // We have to fetch the "updated" variable when it wasn't provided
1783 // The parameter can be provided to improve performance
1784 if (empty($updated) || empty($guid)) {
1785 $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
1786 $updated = $account['updated'] ?? '';
1787 $guid = $account['guid'] ?? '';
1790 $guid = urlencode($guid);
1792 $url = DI::baseUrl() . '/photo/header/';
1794 case Proxy::SIZE_MICRO:
1795 $url .= Proxy::PIXEL_MICRO . '/';
1797 case Proxy::SIZE_THUMB:
1798 $url .= Proxy::PIXEL_THUMB . '/';
1800 case Proxy::SIZE_SMALL:
1801 $url .= Proxy::PIXEL_SMALL . '/';
1803 case Proxy::SIZE_MEDIUM:
1804 $url .= Proxy::PIXEL_MEDIUM . '/';
1806 case Proxy::SIZE_LARGE:
1807 $url .= Proxy::PIXEL_LARGE . '/';
1811 return $url . ($guid ?: $cid) . ($updated ? '?ts=' . strtotime($updated) : '');
1815 * Updates the avatar links in a contact only if needed
1817 * @param int $cid Contact id
1818 * @param string $avatar Link to avatar picture
1819 * @param bool $force force picture update
1820 * @param bool $create_cache Enforces the creation of cached avatar fields
1823 * @throws HTTPException\InternalServerErrorException
1824 * @throws HTTPException\NotFoundException
1825 * @throws \ImagickException
1827 public static function updateAvatar(int $cid, string $avatar, bool $force = false, bool $create_cache = false)
1829 $contact = DBA::selectFirst('contact', ['uid', 'avatar', 'photo', 'thumb', 'micro', 'xmpp', 'addr', 'nurl', 'url', 'network'],
1830 ['id' => $cid, 'self' => false]);
1831 if (!DBA::isResult($contact)) {
1835 $uid = $contact['uid'];
1837 // Only update the cached photo links of public contacts when they already are cached
1838 if (($uid == 0) && !$force && empty($contact['thumb']) && empty($contact['micro']) && !$create_cache) {
1839 if ($contact['avatar'] != $avatar) {
1840 self::update(['avatar' => $avatar], ['id' => $cid]);
1841 Logger::info('Only update the avatar', ['id' => $cid, 'avatar' => $avatar, 'contact' => $contact]);
1846 // User contacts use are updated through the public contacts
1847 if (($uid != 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
1848 $pcid = self::getIdForURL($contact['url'], 0, false);
1849 if (!empty($pcid)) {
1850 Logger::debug('Update the private contact via the public contact', ['id' => $cid, 'uid' => $uid, 'public' => $pcid]);
1851 self::updateAvatar($pcid, $avatar, $force, true);
1856 $default_avatar = empty($avatar) || strpos($avatar, self::DEFAULT_AVATAR_PHOTO);
1858 if ($default_avatar) {
1859 $avatar = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1862 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || DI::config()->get('system', 'cache_contact_avatar')) {
1863 if ($default_avatar && Proxy::isLocalImage($avatar)) {
1864 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
1866 'thumb' => self::getDefaultAvatar($contact, Proxy::SIZE_THUMB),
1867 'micro' => self::getDefaultAvatar($contact, Proxy::SIZE_MICRO)];
1868 Logger::debug('Use default avatar', ['id' => $cid, 'uid' => $uid]);
1871 // Use the data from the self account
1872 if (empty($fields)) {
1873 $local_uid = User::getIdForURL($contact['url']);
1874 if (!empty($local_uid)) {
1875 $fields = self::selectFirst(['avatar', 'avatar-date', 'photo', 'thumb', 'micro'], ['self' => true, 'uid' => $local_uid]);
1876 Logger::debug('Use owner data', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
1880 if (empty($fields)) {
1881 $update = ($contact['avatar'] != $avatar) || $force;
1885 $contact['photo'] ?? '',
1886 $contact['thumb'] ?? '',
1887 $contact['micro'] ?? '',
1890 foreach ($data as $image_uri) {
1891 $image_rid = Photo::ridFromURI($image_uri);
1892 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
1893 Logger::debug('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
1900 $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
1902 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'avatar-date' => DateTimeFormat::utcNow()];
1903 $update = !empty($fields);
1904 Logger::debug('Created new cached avatars', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
1910 $update = ($fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
1913 Photo::delete(['uid' => $uid, 'contact-id' => $cid, 'photo-type' => Photo::CONTACT_AVATAR]);
1914 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
1915 'photo' => '', 'thumb' => '', 'micro' => ''];
1916 $update = ($avatar != $contact['avatar'] . $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
1925 if (($uid == 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
1926 // Collect all user contacts of the given public contact
1927 $personal_contacts = DBA::select('contact', ['id', 'uid'],
1928 ["`nurl` = ? AND `id` != ? AND NOT `self`", $contact['nurl'], $cid]);
1929 while ($personal_contact = DBA::fetch($personal_contacts)) {
1930 $cids[] = $personal_contact['id'];
1931 $uids[] = $personal_contact['uid'];
1933 DBA::close($personal_contacts);
1935 if (!empty($cids)) {
1936 // Delete possibly existing cached user contact avatars
1937 Photo::delete(['uid' => $uids, 'contact-id' => $cids, 'photo-type' => Photo::CONTACT_AVATAR]);
1943 Logger::info('Updating cached contact avatars', ['cid' => $cids, 'uid' => $uids, 'fields' => $fields]);
1944 self::update($fields, ['id' => $cids]);
1947 public static function deleteContactByUrl(string $url)
1949 // Update contact data for all users
1950 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
1951 $contacts = DBA::select('contact', ['id', 'uid'], $condition);
1952 while ($contact = DBA::fetch($contacts)) {
1953 Logger::info('Deleting contact', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $url]);
1954 self::remove($contact['id']);
1959 * Helper function for "updateFromProbe". Updates personal and public contact
1961 * @param integer $id contact id
1962 * @param integer $uid user id
1963 * @param string $old_url The previous profile URL of the contact
1964 * @param string $new_url The profile URL of the contact
1965 * @param array $fields The fields that are updated
1967 * @throws \Exception
1969 private static function updateContact(int $id, int $uid, string $old_url, string $new_url, array $fields)
1971 if (!self::update($fields, ['id' => $id])) {
1972 Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
1976 // Search for duplicated contacts and get rid of them
1977 if (self::removeDuplicates(Strings::normaliseLink($new_url), $uid)) {
1981 // Archive or unarchive the contact.
1982 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
1983 if (!DBA::isResult($contact)) {
1984 Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
1988 if (isset($fields['failed'])) {
1989 if ($fields['failed']) {
1990 self::markForArchival($contact);
1992 self::unmarkForArchival($contact);
1996 if ($contact['uid'] != 0) {
2000 // Update contact data for all users
2001 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($old_url)];
2003 $condition['network'] = [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB];
2004 self::update($fields, $condition);
2006 // We mustn't set the update fields for OStatus contacts since they are updated in OnePoll
2007 $condition['network'] = Protocol::OSTATUS;
2009 // If the contact failed, propagate the update fields to all contacts
2010 if (empty($fields['failed'])) {
2011 unset($fields['last-update']);
2012 unset($fields['success_update']);
2013 unset($fields['failure_update']);
2016 if (empty($fields)) {
2020 self::update($fields, $condition);
2024 * Remove duplicated contacts
2026 * @param string $nurl Normalised contact url
2027 * @param integer $uid User id
2029 * @throws \Exception
2031 public static function removeDuplicates(string $nurl, int $uid)
2033 $condition = ['nurl' => $nurl, 'uid' => $uid, 'self' => false, 'deleted' => false, 'network' => Protocol::FEDERATED];
2034 $count = DBA::count('contact', $condition);
2039 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
2040 if (!DBA::isResult($first_contact)) {
2041 // Shouldn't happen - so we handle it
2045 $first = $first_contact['id'];
2046 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
2047 if (($uid != 0 && ($first_contact['network'] == Protocol::DFRN))) {
2048 // Don't handle non public DFRN duplicates by now (legacy DFRN is very special because of the key handling)
2049 Logger::info('Not handling non public DFRN duplicate', ['uid' => $uid, 'nurl' => $nurl]);
2053 // Find all duplicates
2054 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
2055 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
2056 while ($duplicate = DBA::fetch($duplicates)) {
2057 if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
2061 Worker::add(PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
2063 DBA::close($duplicates);
2064 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl, 'callstack' => System::callstack(20)]);
2069 * @param integer $id contact id
2070 * @param string $network Optional network we are probing for
2072 * @throws HTTPException\InternalServerErrorException
2073 * @throws \ImagickException
2075 public static function updateFromProbe(int $id, string $network = '')
2077 $contact = DBA::selectFirst('contact', ['uid', 'url'], ['id' => $id]);
2078 if (!DBA::isResult($contact)) {
2082 $ret = Probe::uri($contact['url'], $network, $contact['uid']);
2084 if ($ret['network'] == Protocol::DIASPORA) {
2085 FContact::updateFromProbeArray($ret);
2088 return self::updateFromProbeArray($id, $ret);
2092 * @param integer $id contact id
2093 * @param array $ret Probed data
2095 * @throws HTTPException\InternalServerErrorException
2096 * @throws \ImagickException
2098 private static function updateFromProbeArray(int $id, array $ret)
2101 Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
2102 This will reliably kill your communication with old Friendica contacts.
2105 // These fields aren't updated by this routine:
2108 $fields = ['uid', 'uri-id', 'avatar', 'header', 'name', 'nick', 'location', 'keywords', 'about', 'subscribe',
2109 'manually-approve', 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
2110 'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey', 'last-item', 'xmpp', 'matrix'];
2111 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
2112 if (!DBA::isResult($contact)) {
2116 if (self::isLocal($ret['url'])) {
2117 if ($contact['uid'] == 0) {
2118 Logger::info('Local contacts are not updated here.');
2120 self::updateFromPublicContact($id, $contact);
2125 if (!empty($ret['account-type']) && $ret['account-type'] == User::ACCOUNT_TYPE_DELETED) {
2126 Logger::info('Deleted account', ['id' => $id, 'url' => $ret['url'], 'ret' => $ret]);
2129 // Delete all contacts with the same URL
2130 self::deleteContactByUrl($ret['url']);
2134 $uid = $contact['uid'];
2135 unset($contact['uid']);
2137 $uriid = $contact['uri-id'];
2138 unset($contact['uri-id']);
2140 $pubkey = $contact['pubkey'];
2141 unset($contact['pubkey']);
2143 $contact['photo'] = $contact['avatar'];
2144 unset($contact['avatar']);
2146 $updated = DateTimeFormat::utcNow();
2148 if (Strings::normaliseLink($contact['url']) != Strings::normaliseLink($ret['url'])) {
2149 Logger::notice('New URL differs from old URL', ['id' => $id, 'uid' => $uid, 'old' => $contact['url'], 'new' => $ret['url']]);
2150 self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => true, 'last-update' => $updated, 'failure_update' => $updated]);
2154 // We must not try to update relay contacts via probe. They are no real contacts.
2155 // We check after the probing to be able to correct falsely detected contact types.
2156 if (($contact['contact-type'] == self::TYPE_RELAY) &&
2157 (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))) {
2158 self::updateContact($id, $uid, $contact['url'], $contact['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
2159 Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
2163 // If Probe::uri fails the network code will be different ("feed" or "unkn")
2164 if (($ret['network'] == Protocol::PHANTOM) || (($ret['network'] == Protocol::FEED) && ($ret['network'] != $contact['network']))) {
2165 self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => true, 'last-update' => $updated, 'failure_update' => $updated]);
2169 if (Strings::normaliseLink($ret['url']) != Strings::normaliseLink($contact['url'])) {
2170 $cid = self::getIdForURL($ret['url'], 0, false);
2171 if (!empty($cid) && ($cid != $id)) {
2172 Logger::notice('URL of contact changed.', ['id' => $id, 'new_id' => $cid, 'old' => $contact['url'], 'new' => $ret['url']]);
2173 return self::updateFromProbeArray($cid, $ret);
2177 if (isset($ret['hide']) && is_bool($ret['hide'])) {
2178 $ret['unsearchable'] = $ret['hide'];
2181 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
2182 $ret['forum'] = false;
2183 $ret['prv'] = false;
2184 $ret['contact-type'] = $ret['account-type'];
2185 if (($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) && isset($ret['manually-approve'])) {
2186 $ret['forum'] = (bool)!$ret['manually-approve'];
2187 $ret['prv'] = (bool)!$ret['forum'];
2191 $new_pubkey = $ret['pubkey'] ?? '';
2194 $ret['last-item'] = Probe::getLastUpdate($ret);
2195 Logger::info('Fetched last item', ['id' => $id, 'probed_url' => $ret['url'], 'last-item' => $ret['last-item'], 'callstack' => System::callstack(20)]);
2199 $guid = ($ret['guid'] ?? '') ?: Item::guidFromUri($ret['url'], parse_url($ret['url'], PHP_URL_HOST));
2201 // make sure to not overwrite existing values with blank entries except some technical fields
2202 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2203 foreach ($ret as $key => $val) {
2204 if (!array_key_exists($key, $contact)) {
2206 } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2207 $ret[$key] = $contact[$key];
2208 } elseif ($ret[$key] != $contact[$key]) {
2213 if (!empty($ret['last-item']) && ($contact['last-item'] < $ret['last-item'])) {
2216 unset($ret['last-item']);
2219 if (empty($uriid)) {
2223 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2224 self::updateAvatar($id, $ret['photo'], $update);
2227 $uriid = ItemURI::insert(['uri' => $ret['url'], 'guid' => $guid]);
2230 self::updateContact($id, $uid, $contact['url'], $ret['url'], ['failed' => false, 'last-update' => $updated, 'success_update' => $updated]);
2232 if (Contact\Relation::isDiscoverable($ret['url'])) {
2233 Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2236 // Update the public contact
2238 $contact = self::getByURL($ret['url'], false, ['id']);
2239 if (!empty($contact['id'])) {
2240 self::updateFromProbeArray($contact['id'], $ret);
2247 $ret['uri-id'] = $uriid;
2248 $ret['nurl'] = Strings::normaliseLink($ret['url']);
2249 $ret['updated'] = $updated;
2250 $ret['failed'] = false;
2252 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2253 if (empty($pubkey) && !empty($new_pubkey)) {
2254 $ret['pubkey'] = $new_pubkey;
2257 if ((!empty($ret['addr']) && ($ret['addr'] != $contact['addr'])) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2258 $ret['uri-date'] = $updated;
2261 if ((!empty($ret['name']) && ($ret['name'] != $contact['name'])) || (!empty($ret['nick']) && ($ret['nick'] != $contact['nick']))) {
2262 $ret['name-date'] = $updated;
2265 if (($uid == 0) || in_array($ret['network'], [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2266 $ret['last-update'] = $updated;
2267 $ret['success_update'] = $updated;
2270 unset($ret['photo']);
2272 self::updateContact($id, $uid, $contact['url'], $ret['url'], $ret);
2274 if (Contact\Relation::isDiscoverable($ret['url'])) {
2275 Worker::add(PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2281 private static function updateFromPublicContact(int $id, array $contact)
2283 $public = self::getByURL($contact['url'], false);
2287 foreach ($contact as $field => $value) {
2288 if ($field == 'uid') {
2291 if ($public[$field] != $value) {
2292 $fields[$field] = $public[$field];
2295 if (!empty($fields)) {
2296 self::update($fields, ['id' => $id, 'self' => false]);
2297 Logger::info('Updating local contact', ['id' => $id]);
2302 * @param integer $url contact url
2303 * @return integer Contact id
2304 * @throws HTTPException\InternalServerErrorException
2305 * @throws \ImagickException
2307 public static function updateFromProbeByURL($url)
2309 $id = self::getIdForURL($url);
2315 self::updateFromProbe($id);
2321 * Detects the communication protocol for a given contact url.
2322 * This is used to detect Friendica contacts that we can communicate via AP.
2324 * @param string $url contact url
2325 * @param string $network Network of that contact
2326 * @return string with protocol
2328 public static function getProtocol($url, $network)
2330 if ($network != Protocol::DFRN) {
2334 $apcontact = APContact::getByURL($url);
2335 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2336 return Protocol::ACTIVITYPUB;
2343 * Takes a $uid and a url/handle and adds a new contact
2345 * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2346 * dfrn_request page.
2348 * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
2351 * $return['success'] boolean true if successful
2352 * $return['message'] error text if success is false.
2354 * Takes a $uid and a url/handle and adds a new contact
2356 * @param int $uid The user id the contact should be created for
2357 * @param string $url The profile URL of the contact
2358 * @param string $network
2360 * @throws HTTPException\InternalServerErrorException
2361 * @throws HTTPException\NotFoundException
2362 * @throws \ImagickException
2364 public static function createFromProbeForUser(int $uid, $url, $network = '')
2366 $result = ['cid' => -1, 'success' => false, 'message' => ''];
2368 // remove ajax junk, e.g. Twitter
2369 $url = str_replace('/#!/', '/', $url);
2371 if (!Network::isUrlAllowed($url)) {
2372 $result['message'] = DI::l10n()->t('Disallowed profile URL.');
2376 if (Network::isUrlBlocked($url)) {
2377 $result['message'] = DI::l10n()->t('Blocked domain');
2382 $result['message'] = DI::l10n()->t('Connect URL missing.');
2386 $arr = ['url' => $url, 'contact' => []];
2388 Hook::callAll('follow', $arr);
2391 $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
2395 if (!empty($arr['contact']['name'])) {
2397 $ret = $arr['contact'];
2400 $ret = Probe::uri($url, $network, $uid);
2403 if (($network != '') && ($ret['network'] != $network)) {
2404 Logger::notice('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
2408 // check if we already have a contact
2409 // the poll url is more reliable than the profile url, as we may have
2410 // indirect links or webfinger links
2412 $condition = ['uid' => $uid, 'poll' => [$ret['poll'], Strings::normaliseLink($ret['poll'])], 'network' => $ret['network'], 'pending' => false];
2413 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2414 if (!DBA::isResult($contact)) {
2415 $condition = ['uid' => $uid, 'nurl' => Strings::normaliseLink($ret['url']), 'network' => $ret['network'], 'pending' => false];
2416 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2419 $protocol = self::getProtocol($ret['url'], $ret['network']);
2421 // This extra param just confuses things, remove it
2422 if ($protocol === Protocol::DIASPORA) {
2423 $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
2426 // do we have enough information?
2427 if (empty($protocol) || ($protocol == Protocol::PHANTOM) || (empty($ret['url']) && empty($ret['addr']))) {
2428 $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . EOL;
2429 if (empty($ret['poll'])) {
2430 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . EOL;
2432 if (empty($ret['name'])) {
2433 $result['message'] .= DI::l10n()->t('An author or name was not found.') . EOL;
2435 if (empty($ret['url'])) {
2436 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . EOL;
2438 if (strpos($ret['url'], '@') !== false) {
2439 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . EOL;
2440 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . EOL;
2445 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
2446 $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . EOL;
2447 $ret['notify'] = '';
2450 if (!$ret['notify']) {
2451 $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . EOL;
2454 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
2456 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
2458 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
2461 if (($protocol == Protocol::ACTIVITYPUB) && isset($ret['manually-approve'])) {
2462 $pending = (bool)$ret['manually-approve'];
2465 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2469 if (DBA::isResult($contact)) {
2471 $new_relation = (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) ? self::FRIEND : self::SHARING);
2473 $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
2474 self::update($fields, ['id' => $contact['id']]);
2476 $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
2478 // create contact record
2481 'created' => DateTimeFormat::utcNow(),
2482 'url' => $ret['url'],
2483 'nurl' => Strings::normaliseLink($ret['url']),
2484 'addr' => $ret['addr'],
2485 'alias' => $ret['alias'],
2486 'batch' => $ret['batch'],
2487 'notify' => $ret['notify'],
2488 'poll' => $ret['poll'],
2489 'poco' => $ret['poco'],
2490 'name' => $ret['name'],
2491 'nick' => $ret['nick'],
2492 'network' => $ret['network'],
2493 'baseurl' => $ret['baseurl'],
2494 'gsid' => $ret['gsid'] ?? null,
2495 'protocol' => $protocol,
2496 'pubkey' => $ret['pubkey'],
2497 'rel' => $new_relation,
2498 'priority'=> $ret['priority'],
2499 'writable'=> $writeable,
2500 'hidden' => $hidden,
2503 'pending' => $pending,
2508 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
2509 if (!DBA::isResult($contact)) {
2510 $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . EOL;
2514 $contact_id = $contact['id'];
2515 $result['cid'] = $contact_id;
2517 Group::addMember(User::getDefaultGroup($uid), $contact_id);
2519 // Update the avatar
2520 self::updateAvatar($contact_id, $ret['photo']);
2522 // pull feed and consume it, which should subscribe to the hub.
2523 if ($contact['network'] == Protocol::OSTATUS) {
2524 Worker::add(PRIORITY_HIGH, 'OnePoll', $contact_id, 'force');
2528 self::updateFromProbeArray($contact_id, $ret);
2530 Worker::add(PRIORITY_HIGH, 'UpdateContact', $contact_id);
2533 $result['success'] = Protocol::follow($uid, $contact, $protocol);
2539 * Unfollow a contact
2541 * @param int $cid Public contact id
2542 * @param int $uid User ID
2544 * @return bool "true" if unfollowing had been successful
2546 public static function unfollow(int $cid, int $uid)
2548 $cdata = self::getPublicAndUserContactID($cid, $uid);
2549 if (empty($cdata['user'])) {
2553 $contact = self::getById($cdata['user']);
2555 self::removeSharer([], $contact);
2561 * @param array $importer Owner (local user) data
2562 * @param array $contact Existing owner-specific contact data we want to expand the relationship with. Optional.
2563 * @param array $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
2564 * @param bool $sharing True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
2565 * @param string $note Introduction additional message
2566 * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
2567 * @throws HTTPException\InternalServerErrorException
2568 * @throws \ImagickException
2570 public static function addRelationship(array $importer, array $contact, array $datarray, $sharing = false, $note = '')
2572 // Should always be set
2573 if (empty($datarray['author-id'])) {
2577 $fields = ['url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked'];
2578 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
2579 if (!DBA::isResult($pub_contact)) {
2580 // Should never happen
2584 // Contact is blocked at node-level
2585 if (self::isBlocked($datarray['author-id'])) {
2589 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
2590 $name = $pub_contact['name'];
2591 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
2592 $nick = $pub_contact['nick'];
2593 $network = $pub_contact['network'];
2595 // Ensure that we don't create a new contact when there already is one
2596 $cid = self::getIdForURL($url, $importer['uid']);
2598 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
2601 if (!empty($contact)) {
2602 if (!empty($contact['pending'])) {
2603 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
2607 // Contact is blocked at user-level
2608 if (!empty($contact['id']) && !empty($importer['id']) &&
2609 Contact\User::isBlocked($contact['id'], $importer['id'])) {
2613 // Make sure that the existing contact isn't archived
2614 self::unmarkForArchival($contact);
2616 if (($contact['rel'] == self::SHARING)
2617 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
2618 self::update(['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
2619 ['id' => $contact['id'], 'uid' => $importer['uid']]);
2622 // Ensure to always have the correct network type, independent from the connection request method
2623 self::updateFromProbe($contact['id']);
2625 Post\UserNotification::insertNotification($contact['id'], Activity::FOLLOW, $importer['uid']);
2629 // send email notification to owner?
2630 if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
2631 Logger::notice('ignoring duplicated connection request from pending contact ' . $url);
2635 // create contact record
2636 $contact_id = self::insert([
2637 'uid' => $importer['uid'],
2638 'created' => DateTimeFormat::utcNow(),
2640 'nurl' => Strings::normaliseLink($url),
2643 'network' => $network,
2644 'rel' => self::FOLLOWER,
2651 // Ensure to always have the correct network type, independent from the connection request method
2652 self::updateFromProbe($contact_id);
2654 self::updateAvatar($contact_id, $photo, true);
2656 Post\UserNotification::insertNotification($contact_id, Activity::FOLLOW, $importer['uid']);
2658 $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo'], ['id' => $contact_id]);
2660 /// @TODO Encapsulate this into a function/method
2661 $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
2662 $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
2663 if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2664 // create notification
2665 if (is_array($contact_record)) {
2666 $intro = DI::introFactory()->createNew(
2668 $contact_record['id'],
2671 DI::intro()->save($intro);
2674 Group::addMember(User::getDefaultGroup($importer['uid']), $contact_record['id']);
2676 if (($user['notify-flags'] & Notification\Type::INTRO) &&
2677 in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL])) {
2679 DI::notify()->createFromArray([
2680 'type' => Notification\Type::INTRO,
2681 'otype' => Notification\ObjectType::INTRO,
2682 'verb' => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
2683 'uid' => $user['uid'],
2684 'cid' => $contact_record['id'],
2685 'link' => DI::baseUrl() . '/notifications/intros',
2688 } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
2689 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
2690 self::createFromProbeForUser($importer['uid'], $url, $network);
2693 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
2694 $fields = ['pending' => false];
2695 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
2696 $fields['rel'] = self::FRIEND;
2699 self::update($fields, $condition);
2708 public static function removeFollower(array $contact)
2710 if (in_array($contact['rel'] ?? [], [self::FRIEND, self::SHARING])) {
2711 DBA::update('contact', ['rel' => self::SHARING], ['id' => $contact['id']]);
2712 } elseif (!empty($contact['id'])) {
2713 self::remove($contact['id']);
2715 DI::logger()->info('Couldn\'t remove follower because of invalid contact array', ['contact' => $contact, 'callstack' => System::callstack()]);
2719 public static function removeSharer($importer, $contact)
2721 if (($contact['rel'] == self::FRIEND) || ($contact['rel'] == self::FOLLOWER)) {
2722 self::update(['rel' => self::FOLLOWER], ['id' => $contact['id']]);
2724 self::remove($contact['id']);
2729 * Create a birthday event.
2731 * Update the year and the birthday.
2733 public static function updateBirthdays()
2737 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
2738 AND NOT `contact`.`pending`
2739 AND NOT `contact`.`hidden`
2740 AND NOT `contact`.`blocked`
2741 AND NOT `contact`.`archive`
2742 AND NOT `contact`.`deleted`',
2748 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
2750 while ($contact = DBA::fetch($contacts)) {
2751 Logger::notice('update_contact_birthday: ' . $contact['bd']);
2753 $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
2755 if (Event::createBirthday($contact, $nextbd)) {
2759 ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
2760 ['id' => $contact['id']]
2764 DBA::close($contacts);
2768 * Remove the unavailable contact ids from the provided list
2770 * @param array $contact_ids Contact id list
2772 * @throws \Exception
2774 public static function pruneUnavailable(array $contact_ids)
2776 if (empty($contact_ids)) {
2780 $contacts = self::selectToArray(['id'], [
2781 'id' => $contact_ids,
2787 return array_column($contacts, 'id');
2791 * Returns a magic link to authenticate remote visitors
2793 * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
2795 * @param string $contact_url The address of the target contact profile
2796 * @param string $url An url that we will be redirected to after the authentication
2798 * @return string with "redir" link
2799 * @throws HTTPException\InternalServerErrorException
2800 * @throws \ImagickException
2802 public static function magicLink($contact_url, $url = '')
2804 if (!Session::isAuthenticated()) {
2805 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2808 $contact = self::getByURL($contact_url, false);
2809 if (empty($contact)) {
2810 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
2813 // Prevents endless loop in case only a non-public contact exists for the contact URL
2814 unset($contact['uid']);
2816 return self::magicLinkByContact($contact, $url ?: $contact_url);
2820 * Returns a magic link to authenticate remote visitors
2822 * @param integer $cid The contact id of the target contact profile
2823 * @param string $url An url that we will be redirected to after the authentication
2825 * @return string with "redir" link
2826 * @throws HTTPException\InternalServerErrorException
2827 * @throws \ImagickException
2829 public static function magicLinkById($cid, $url = '')
2831 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
2833 return self::magicLinkByContact($contact, $url);
2837 * Returns a magic link to authenticate remote visitors
2839 * @param array $contact The contact array with "uid", "network" and "url"
2840 * @param string $url An url that we will be redirected to after the authentication
2842 * @return string with "redir" link
2843 * @throws HTTPException\InternalServerErrorException
2844 * @throws \ImagickException
2846 public static function magicLinkByContact($contact, $url = '')
2848 $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
2850 if (!Session::isAuthenticated()) {
2851 return $destination;
2854 // Only redirections to the same host do make sense
2855 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
2859 if (DI::pConfig()->get(local_user(), 'system', 'stay_local') && ($url == '')) {
2860 return 'contact/' . $contact['id'] . '/conversations';
2863 if (!empty($contact['network']) && $contact['network'] != Protocol::DFRN) {
2864 return $destination;
2867 if (empty($contact['id'])) {
2868 return $destination;
2871 $redirect = 'redir/' . $contact['id'];
2873 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
2874 $redirect .= '?url=' . $url;
2881 * Is the contact a forum?
2883 * @param integer $contactid ID of the contact
2885 * @return boolean "true" if it is a forum
2887 public static function isForum($contactid)
2889 $fields = ['forum', 'prv'];
2890 $condition = ['id' => $contactid];
2891 $contact = DBA::selectFirst('contact', $fields, $condition);
2892 if (!DBA::isResult($contact)) {
2897 return ($contact['forum'] || $contact['prv']);
2901 * Can the remote contact receive private messages?
2903 * @param array $contact
2906 public static function canReceivePrivateMessages(array $contact)
2908 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
2909 $self = $contact['self'] ?? false;
2911 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;
2915 * Search contact table by nick or name
2917 * @param string $search Name or nick
2918 * @param string $mode Search mode (e.g. "community")
2919 * @param int $uid User ID
2921 * @return array with search results
2922 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2924 public static function searchByName(string $search, string $mode = '', int $uid = 0)
2926 if (empty($search)) {
2930 // check supported networks
2931 $networks = [Protocol::DFRN, Protocol::ACTIVITYPUB];
2932 if (DI::config()->get('system', 'diaspora_enabled')) {
2933 $networks[] = Protocol::DIASPORA;
2936 if (!DI::config()->get('system', 'ostatus_disabled')) {
2937 $networks[] = Protocol::OSTATUS;
2940 $condition = ['network' => $networks, 'failed' => false, 'deleted' => false, 'uid' => $uid];
2943 $condition['blocked'] = false;
2946 // check if we search only communities or every contact
2947 if ($mode === 'community') {
2948 $condition['contact-type'] = self::TYPE_COMMUNITY;
2953 $condition = DBA::mergeConditions($condition,
2954 ["(NOT `unsearchable` OR `nurl` IN (SELECT `nurl` FROM `owner-view` WHERE `publish` OR `net-publish`))
2955 AND (`addr` LIKE ? OR `name` LIKE ? OR `nick` LIKE ?)", $search, $search, $search]);
2957 $contacts = self::selectToArray([], $condition);
2962 * Add public contacts from an array
2964 * @param array $urls
2965 * @return array result "count", "added" and "updated"
2967 public static function addByUrls(array $urls)
2974 foreach ($urls as $url) {
2975 if (empty($url) || !is_string($url)) {
2978 $contact = self::getByURL($url, false, ['id', 'updated']);
2979 if (empty($contact['id'])) {
2980 Worker::add(PRIORITY_LOW, 'AddContact', 0, $url);
2982 } elseif ($contact['updated'] < DateTimeFormat::utc('now -7 days')) {
2983 Worker::add(PRIORITY_LOW, 'UpdateContact', $contact['id']);
2991 return ['count' => $count, 'added' => $added, 'updated' => $updated, 'unchanged' => $unchanged];
2995 * Returns a random, global contact array of the current node
2997 * @return array The profile array
3000 public static function getRandomContact()
3002 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], [
3003 "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",
3004 0, Protocol::DFRN, DateTimeFormat::utc('now - 1 month'),
3005 ], ['order' => ['RAND()']]);
3007 if (DBA::isResult($contact)) {