3 * @copyright Copyright (C) 2010-2022, 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\Contact\Avatar;
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\System;
33 use Friendica\Core\Worker;
34 use Friendica\Database\Database;
35 use Friendica\Database\DBA;
37 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
38 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
39 use Friendica\Network\HTTPException;
40 use Friendica\Network\Probe;
41 use Friendica\Object\Image;
42 use Friendica\Protocol\Activity;
43 use Friendica\Protocol\ActivityPub;
44 use Friendica\Util\DateTimeFormat;
45 use Friendica\Util\HTTPSignature;
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;
103 const NOTHING = 0; // There is no relationship between the contact and the user
104 const FOLLOWER = 1; // The contact is following this user (the contact is the subscriber)
105 const SHARING = 2; // The contact shares their content with this user (the user is the subscriber)
106 const FRIEND = 3; // There is a mutual relationship between the contact and the user
107 const SELF = 4; // This is the user theirself
112 const MIRROR_DEACTIVATED = 0;
113 const MIRROR_FORWARDED = 1; // Deprecated, now does the same like MIRROR_OWN_POST
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 = []): array
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 * @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
150 public static function selectAccountToArray(array $fields = [], array $condition = [], array $params = []): array
152 return DBA::selectToArray('account-user-view', $fields, $condition, $params);
156 * @param array $fields Array of selected fields, empty for all
157 * @param array $condition Array of fields for condition
158 * @param array $params Array of several parameters
162 public static function selectFirstAccount(array $fields = [], array $condition = [], array $params = [])
164 return DBA::selectFirst('account-view', $fields, $condition, $params);
168 * Insert a row into the contact table
169 * Important: You can't use DBA::lastInsertId() after this call since it will be set to 0.
171 * @param array $fields field array
172 * @param int $duplicate_mode Do an update on a duplicate entry
174 * @return int id of the created contact
177 public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT): int
179 if (!empty($fields['baseurl']) && empty($fields['gsid'])) {
180 $fields['gsid'] = GServer::getID($fields['baseurl'], true);
183 $fields['uri-id'] = ItemURI::getIdByURI($fields['url']);
185 if (empty($fields['created'])) {
186 $fields['created'] = DateTimeFormat::utcNow();
189 $fields = DI::dbaDefinition()->truncateFieldsForTable('contact', $fields);
190 DBA::insert('contact', $fields, $duplicate_mode);
191 $contact = DBA::selectFirst('contact', [], ['id' => DBA::lastInsertId()]);
192 if (!DBA::isResult($contact)) {
194 Logger::warning('Created contact could not be found', ['fields' => $fields]);
198 $fields = DI::dbaDefinition()->truncateFieldsForTable('account-user', $contact);
199 DBA::insert('account-user', $fields, Database::INSERT_IGNORE);
200 $account_user = DBA::selectFirst('account-user', ['id'], ['uid' => $contact['uid'], 'uri-id' => $contact['uri-id']]);
201 if (empty($account_user['id'])) {
202 Logger::warning('Account-user entry not found', ['cid' => $contact['id'], 'uid' => $contact['uid'], 'uri-id' => $contact['uri-id'], 'url' => $contact['url']]);
203 } elseif ($account_user['id'] != $contact['id']) {
204 $duplicate = DBA::selectFirst('contact', [], ['id' => $account_user['id'], 'deleted' => false]);
205 if (!empty($duplicate['id'])) {
206 $ret = Contact::deleteById($contact['id']);
207 Logger::notice('Deleted duplicated contact', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $duplicate['id'], 'uid' => $duplicate['uid'], 'uri-id' => $duplicate['uri-id'], 'url' => $duplicate['url']]);
208 $contact = $duplicate;
210 $ret = DBA::update('account-user', ['id' => $contact['id']], ['uid' => $contact['uid'], 'uri-id' => $contact['uri-id']]);
211 Logger::notice('Updated account-user', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $contact['id'], 'uid' => $contact['uid'], 'uri-id' => $contact['uri-id'], 'url' => $contact['url']]);
215 Contact\User::insertForContactArray($contact);
217 return $contact['id'];
221 * Delete contact by id
226 public static function deleteById(int $id): bool
228 Logger::debug('Delete contact', ['id' => $id]);
229 DBA::delete('account-user', ['id' => $id]);
230 return DBA::delete('contact', ['id' => $id]);
234 * Updates rows in the contact table
236 * @param array $fields contains the fields that are updated
237 * @param array $condition condition array with the key values
238 * @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)
240 * @return boolean was the update successfull?
242 * @todo Let's get rid of boolean type of $old_fields
244 public static function update(array $fields, array $condition, $old_fields = [])
246 $fields = DI::dbaDefinition()->truncateFieldsForTable('contact', $fields);
247 $ret = DBA::update('contact', $fields, $condition, $old_fields);
249 // Apply changes to the "user-contact" table on dedicated fields
250 Contact\User::updateByContactUpdate($fields, $condition);
256 * @param integer $id Contact ID
257 * @param array $fields Array of selected fields, empty for all
258 * @return array|boolean Contact record if it exists, false otherwise
261 public static function getById(int $id, array $fields = [])
263 return DBA::selectFirst('contact', $fields, ['id' => $id]);
267 * Fetch the first contact with the provided uri-id.
269 * @param integer $uri_id uri-id of the contact
270 * @param array $fields Array of selected fields, empty for all
271 * @return array|boolean Contact record if it exists, false otherwise
274 public static function getByUriId(int $uri_id, array $fields = [])
276 return DBA::selectFirst('contact', $fields, ['uri-id' => $uri_id], ['order' => ['uid']]);
280 * Fetch all remote contacts for a given contact url
282 * @param string $url The URL of the contact
283 * @param array $fields The wanted fields
285 * @return array all remote contacts
289 public static function getVisitorByUrl(string $url, array $fields = ['id', 'uid']): array
293 $remote_contacts = DBA::select('contact', ['id', 'uid'], ['nurl' => Strings::normaliseLink($url), 'rel' => [Contact::FOLLOWER, Contact::FRIEND], 'self' => false]);
294 while ($contact = DBA::fetch($remote_contacts)) {
295 if (($contact['uid'] == 0) || Contact\User::isBlocked($contact['id'], $contact['uid'])) {
298 $remote[$contact['uid']] = $contact['id'];
300 DBA::close($remote_contacts);
306 * Fetches a contact by a given url
308 * @param string $url profile url
309 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
310 * @param array $fields Field list
311 * @param integer $uid User ID of the contact
312 * @return array contact array
314 public static function getByURL(string $url, $update = null, array $fields = [], int $uid = 0): array
316 if ($update || is_null($update)) {
317 $cid = self::getIdForURL($url, $uid, $update);
322 $contact = self::getById($cid, $fields);
323 if (empty($contact)) {
329 // Add internal fields
331 if (!empty($fields)) {
332 foreach (['id', 'next-update', 'network'] as $internal) {
333 if (!in_array($internal, $fields)) {
334 $fields[] = $internal;
335 $removal[] = $internal;
340 // We first try the nurl (http://server.tld/nick), most common case
341 $options = ['order' => ['id']];
342 $contact = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url), 'uid' => $uid, 'deleted' => false], $options);
344 // Then the addr (nick@server.tld)
345 if (!DBA::isResult($contact)) {
346 $contact = DBA::selectFirst('contact', $fields, ['addr' => str_replace('acct:', '', $url), 'uid' => $uid, 'deleted' => false], $options);
349 // Then the alias (which could be anything)
350 if (!DBA::isResult($contact)) {
351 // The link could be provided as http although we stored it as https
352 $ssl_url = str_replace('http://', 'https://', $url);
353 $condition = ['`alias` IN (?, ?, ?) AND `uid` = ? AND NOT `deleted`', $url, Strings::normaliseLink($url), $ssl_url, $uid];
354 $contact = DBA::selectFirst('contact', $fields, $condition, $options);
357 if (!DBA::isResult($contact)) {
361 // Update the contact in the background if needed
362 if (Probe::isProbable($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
363 Worker::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], 'UpdateContact', $contact['id']);
366 // Remove the internal fields
367 foreach ($removal as $internal) {
368 unset($contact[$internal]);
375 * Fetches a contact for a given user by a given url.
376 * In difference to "getByURL" the function will fetch a public contact when no user contact had been found.
378 * @param string $url profile url
379 * @param integer $uid User ID of the contact
380 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
381 * @param array $fields Field list
382 * @return array contact array
384 public static function getByURLForUser(string $url, int $uid = 0, $update = false, array $fields = []): array
387 $contact = self::getByURL($url, $update, $fields, $uid);
388 if (!empty($contact)) {
389 if (!empty($contact['id'])) {
390 $contact['cid'] = $contact['id'];
397 $contact = self::getByURL($url, $update, $fields);
398 if (!empty($contact['id'])) {
400 $contact['zid'] = $contact['id'];
406 * Checks if a contact uses a specific platform
409 * @param string $platform
412 public static function isPlatform(string $url, string $platform): bool
414 return DBA::exists('account-view', ['nurl' => Strings::normaliseLink($url), 'platform' => $platform]);
418 * Tests if the given contact is a follower
420 * @param int $cid Either public contact id or user's contact id
421 * @param int $uid User ID
422 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
424 * @return boolean is the contact id a follower?
425 * @throws HTTPException\InternalServerErrorException
426 * @throws \ImagickException
428 public static function isFollower(int $cid, int $uid, bool $strict = false): bool
430 if (Contact\User::isBlocked($cid, $uid)) {
434 $cdata = self::getPublicAndUserContactID($cid, $uid);
435 if (empty($cdata['user'])) {
439 $condition = ['id' => $cdata['user'], 'rel' => [self::FOLLOWER, self::FRIEND]];
441 $condition = array_merge($condition, ['pending' => false, 'readonly' => false, 'blocked' => false]);
443 return DBA::exists('contact', $condition);
447 * Tests if the given contact url is a follower
449 * @param string $url Contact URL
450 * @param int $uid User ID
451 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
453 * @return boolean is the contact id a follower?
454 * @throws HTTPException\InternalServerErrorException
455 * @throws \ImagickException
457 public static function isFollowerByURL(string $url, int $uid, bool $strict = false): bool
459 $cid = self::getIdForURL($url, $uid);
465 return self::isFollower($cid, $uid, $strict);
469 * Tests if the given user shares with the given contact
471 * @param int $cid Either public contact id or user's contact id
472 * @param int $uid User ID
473 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
475 * @return boolean is the contact sharing with given user?
476 * @throws HTTPException\InternalServerErrorException
477 * @throws \ImagickException
479 public static function isSharing(int $cid, int $uid, bool $strict = false): bool
481 if (Contact\User::isBlocked($cid, $uid)) {
485 $cdata = self::getPublicAndUserContactID($cid, $uid);
486 if (empty($cdata['user'])) {
490 $condition = ['id' => $cdata['user'], 'rel' => [self::SHARING, self::FRIEND]];
492 $condition = array_merge($condition, ['pending' => false, 'readonly' => false, 'blocked' => false]);
494 return DBA::exists('contact', $condition);
498 * Tests if the given user follow the given contact url
500 * @param string $url Contact URL
501 * @param int $uid User ID
502 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
504 * @return boolean is the contact url being followed?
505 * @throws HTTPException\InternalServerErrorException
506 * @throws \ImagickException
508 public static function isSharingByURL(string $url, int $uid, bool $strict = false): bool
510 $cid = self::getIdForURL($url, $uid);
516 return self::isSharing($cid, $uid, $strict);
520 * Get the basepath for a given contact link
522 * @param string $url The contact link
523 * @param boolean $dont_update Don't update the contact
525 * @return string basepath
526 * @throws HTTPException\InternalServerErrorException
527 * @throws \ImagickException
529 public static function getBasepath(string $url, bool $dont_update = false): string
531 $contact = DBA::selectFirst('contact', ['id', 'baseurl'], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
532 if (!DBA::isResult($contact)) {
536 if (!empty($contact['baseurl'])) {
537 return $contact['baseurl'];
538 } elseif ($dont_update) {
542 // Update the existing contact
543 self::updateFromProbe($contact['id']);
545 // And fetch the result
546 $contact = DBA::selectFirst('contact', ['baseurl'], ['id' => $contact['id']]);
547 if (empty($contact['baseurl'])) {
548 Logger::info('No baseurl for contact', ['url' => $url]);
552 Logger::info('Found baseurl for contact', ['url' => $url, 'baseurl' => $contact['baseurl']]);
553 return $contact['baseurl'];
557 * Check if the given contact url is on the same server
559 * @param string $url The contact link
561 * @return boolean Is it the same server?
563 public static function isLocal(string $url): bool
565 if (!parse_url($url, PHP_URL_SCHEME)) {
566 $addr_parts = explode('@', $url);
567 return (count($addr_parts) == 2) && ($addr_parts[1] == DI::baseUrl()->getHostname());
570 return Strings::compareLink(self::getBasepath($url, true), DI::baseUrl());
574 * Check if the given contact ID is on the same server
576 * @param string $url The contact link
577 * @return boolean Is it the same server?
579 public static function isLocalById(int $cid): bool
581 $contact = DBA::selectFirst('contact', ['url', 'baseurl'], ['id' => $cid]);
582 if (!DBA::isResult($contact)) {
586 if (empty($contact['baseurl'])) {
587 $baseurl = self::getBasepath($contact['url'], true);
589 $baseurl = $contact['baseurl'];
592 return Strings::compareLink($baseurl, DI::baseUrl());
596 * Returns the public contact id of the given user id
598 * @param integer $uid User ID
600 * @return integer|boolean Public contact id for given user id
603 public static function getPublicIdByUserId(int $uid)
605 $self = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
606 if (!DBA::isResult($self)) {
609 return self::getIdForURL($self['url']);
613 * Returns the contact id for the user and the public contact id for a given contact id
615 * @param int $cid Either public contact id or user's contact id
616 * @param int $uid User ID
618 * @return array with public and user's contact id
619 * @throws HTTPException\InternalServerErrorException
620 * @throws \ImagickException
622 public static function getPublicAndUserContactID(int $cid, int $uid): array
624 // We have to use the legacy function as long as the post update hasn't finished
625 if (DI::config()->get('system', 'post_update_version') < 1427) {
626 return self::legacyGetPublicAndUserContactID($cid, $uid);
629 if (empty($uid) || empty($cid)) {
633 $contact = DBA::selectFirst('account-user-view', ['id', 'uid', 'pid'], ['id' => $cid]);
634 if (!DBA::isResult($contact) || !in_array($contact['uid'], [0, $uid])) {
638 $pcid = $contact['pid'];
639 if ($contact['uid'] == $uid) {
640 $ucid = $contact['id'];
642 $contact = DBA::selectFirst('account-user-view', ['id', 'uid'], ['pid' => $cid, 'uid' => $uid]);
643 if (DBA::isResult($contact)) {
644 $ucid = $contact['id'];
650 return ['public' => $pcid, 'user' => $ucid];
654 * Helper function for "getPublicAndUserContactID"
656 * @param int $cid Either public contact id or user's contact id
657 * @param int $uid User ID
658 * @return array with public and user's contact id
659 * @throws HTTPException\InternalServerErrorException
660 * @throws \ImagickException
662 private static function legacyGetPublicAndUserContactID(int $cid, int $uid): array
664 if (empty($uid) || empty($cid)) {
668 $contact = DBA::selectFirst('contact', ['id', 'uid', 'url'], ['id' => $cid]);
669 if (!DBA::isResult($contact)) {
673 // We quit when the user id don't match the user id of the provided contact
674 if (($contact['uid'] != $uid) && ($contact['uid'] != 0)) {
678 if ($contact['uid'] != 0) {
679 $pcid = self::getIdForURL($contact['url'], 0, false, ['url' => $contact['url']]);
683 $ucid = $contact['id'];
685 $pcid = $contact['id'];
686 $ucid = self::getIdForURL($contact['url'], $uid);
689 return ['public' => $pcid, 'user' => $ucid];
693 * Returns contact details for a given contact id in combination with a user id
695 * @param int $cid A contact ID
696 * @param int $uid The User ID
697 * @param array $fields The selected fields for the contact
698 * @return array The contact details
702 public static function getContactForUser(int $cid, int $uid, array $fields = []): array
704 $contact = DBA::selectFirst('contact', $fields, ['id' => $cid, 'uid' => $uid]);
706 if (!DBA::isResult($contact)) {
714 * Creates the self-contact for the provided user id
717 * @return bool Operation success
718 * @throws HTTPException\InternalServerErrorException
720 public static function createSelfFromUserId(int $uid): bool
722 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname', 'pubkey', 'prvkey'],
723 ['uid' => $uid, 'account_expired' => false]);
724 if (!DBA::isResult($user)) {
729 'uid' => $user['uid'],
730 'created' => DateTimeFormat::utcNow(),
732 'name' => $user['username'],
733 'nick' => $user['nickname'],
734 'pubkey' => $user['pubkey'],
735 'prvkey' => $user['prvkey'],
736 'photo' => User::getAvatarUrl($user),
737 'thumb' => User::getAvatarUrl($user, Proxy::SIZE_THUMB),
738 'micro' => User::getAvatarUrl($user, Proxy::SIZE_MICRO),
741 'url' => DI::baseUrl() . '/profile/' . $user['nickname'],
742 'nurl' => Strings::normaliseLink(DI::baseUrl() . '/profile/' . $user['nickname']),
743 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
744 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
745 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
746 'poll' => DI::baseUrl() . '/dfrn_poll/' . $user['nickname'],
747 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
748 'name-date' => DateTimeFormat::utcNow(),
749 'uri-date' => DateTimeFormat::utcNow(),
750 'avatar-date' => DateTimeFormat::utcNow(),
756 // Only create the entry if it doesn't exist yet
757 if (!DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
758 $return = (bool)self::insert($contact);
761 // Create the public contact
762 if (!DBA::exists('contact', ['nurl' => $contact['nurl'], 'uid' => 0])) {
763 $contact['self'] = false;
765 $contact['prvkey'] = null;
767 self::insert($contact, Database::INSERT_IGNORE);
774 * Updates the self-contact for the provided user id
777 * @param bool $update_avatar Force the avatar update
778 * @return bool "true" if updated
779 * @throws HTTPException\InternalServerErrorException
781 public static function updateSelfFromUserID(int $uid, bool $update_avatar = false): bool
783 $fields = ['id', 'uri-id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey', 'manually-approve',
784 'xmpp', 'matrix', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
785 'photo', 'thumb', 'micro', 'header', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco', 'network'];
786 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
787 if (!DBA::isResult($self)) {
791 $fields = ['uid', 'nickname', 'page-flags', 'account-type', 'prvkey', 'pubkey'];
792 $user = DBA::selectFirst('user', $fields, ['uid' => $uid, 'account_expired' => false]);
793 if (!DBA::isResult($user)) {
797 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
798 'country-name', 'pub_keywords', 'xmpp', 'matrix', 'net-publish'];
799 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid]);
800 if (!DBA::isResult($profile)) {
804 $file_suffix = 'jpg';
805 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
808 'name' => $profile['name'],
809 'nick' => $user['nickname'],
810 'avatar-date' => $self['avatar-date'],
811 'location' => Profile::formatLocation($profile),
812 'about' => $profile['about'],
813 'keywords' => $profile['pub_keywords'],
814 'contact-type' => $user['account-type'],
815 'prvkey' => $user['prvkey'],
816 'pubkey' => $user['pubkey'],
817 'xmpp' => $profile['xmpp'],
818 'matrix' => $profile['matrix'],
819 'network' => Protocol::DFRN,
821 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
822 'nurl' => Strings::normaliseLink($url),
823 'uri-id' => ItemURI::getIdByURI($url),
824 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
825 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
826 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
827 'poll' => DI::baseUrl() . '/dfrn_poll/'. $user['nickname'],
828 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
832 $avatar = Photo::selectFirst(['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
833 if (DBA::isResult($avatar)) {
834 if ($update_avatar) {
835 $fields['avatar-date'] = DateTimeFormat::utcNow();
838 // Creating the path to the avatar, beginning with the file suffix
839 $types = Images::supportedTypes();
840 if (isset($types[$avatar['type']])) {
841 $file_suffix = $types[$avatar['type']];
844 // We are adding a timestamp value so that other systems won't use cached content
845 $timestamp = strtotime($fields['avatar-date']);
847 $prefix = DI::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
848 $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
850 $fields['photo'] = $prefix . '4' . $suffix;
851 $fields['thumb'] = $prefix . '5' . $suffix;
852 $fields['micro'] = $prefix . '6' . $suffix;
854 // We hadn't found a photo entry, so we use the default avatar
855 $fields['photo'] = self::getDefaultAvatar($fields, Proxy::SIZE_SMALL);
856 $fields['thumb'] = self::getDefaultAvatar($fields, Proxy::SIZE_THUMB);
857 $fields['micro'] = self::getDefaultAvatar($fields, Proxy::SIZE_MICRO);
860 $fields['avatar'] = User::getAvatarUrl($user);
861 $fields['header'] = User::getBannerUrl($user);
862 $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
863 $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
864 $fields['unsearchable'] = !$profile['net-publish'];
865 $fields['manually-approve'] = in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL, User::PAGE_FLAGS_PRVGROUP]);
869 foreach ($fields as $field => $content) {
870 if ($self[$field] != $content) {
876 if ($fields['name'] != $self['name']) {
877 $fields['name-date'] = DateTimeFormat::utcNow();
879 $fields['updated'] = DateTimeFormat::utcNow();
880 self::update($fields, ['id' => $self['id']]);
882 // Update the other contacts as well
883 unset($fields['prvkey']);
884 $fields['self'] = false;
885 self::update($fields, ['uri-id' => $self['uri-id'], 'self' => false]);
887 // Update the profile
889 'photo' => User::getAvatarUrl($user),
890 'thumb' => User::getAvatarUrl($user, Proxy::SIZE_THUMB)
893 DBA::update('profile', $fields, ['uid' => $uid]);
900 * Marks a contact for removal
902 * @param int $id contact id
904 * @throws HTTPException\InternalServerErrorException
906 public static function remove(int $id)
908 // We want just to make sure that we don't delete our "self" contact
909 $contact = DBA::selectFirst('contact', ['uri-id', 'photo', 'thumb', 'micro', 'uid'], ['id' => $id, 'self' => false]);
910 if (!DBA::isResult($contact)) {
914 DBA::delete('account-user', ['id' => $id]);
916 self::clearFollowerFollowingEndpointCache($contact['uid']);
918 // Archive the contact
919 self::update(['archive' => true, 'network' => Protocol::PHANTOM, 'rel' => self::NOTHING, 'deleted' => true], ['id' => $id]);
921 if (!DBA::exists('contact', ['uri-id' => $contact['uri-id'], 'deleted' => false])) {
922 Avatar::deleteCache($contact);
925 // Delete it in the background
926 Worker::add(Worker::PRIORITY_MEDIUM, 'Contact\Remove', $id);
930 * Unfollow the remote contact
932 * @param array $contact Target user-specific contact (uid != 0) array
934 * @throws HTTPException\InternalServerErrorException
935 * @throws \ImagickException
937 public static function unfollow(array $contact): void
939 if (empty($contact['network'])) {
940 throw new \InvalidArgumentException('Empty network in contact array');
943 if (empty($contact['uid'])) {
944 throw new \InvalidArgumentException('Unexpected public contact record');
947 if (in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
948 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
949 if (!empty($cdata['public'])) {
950 Worker::add(Worker::PRIORITY_HIGH, 'Contact\Unfollow', $cdata['public'], $contact['uid']);
954 self::removeSharer($contact);
958 * Revoke follow privileges of the remote user contact
960 * The local relationship is updated immediately, the eventual remote server is messaged in the background.
962 * @param array $contact User-specific contact array (uid != 0) to revoke the follow from
964 * @throws HTTPException\InternalServerErrorException
965 * @throws \ImagickException
967 public static function revokeFollow(array $contact): void
969 if (empty($contact['network'])) {
970 throw new \InvalidArgumentException('Empty network in contact array');
973 if (empty($contact['uid'])) {
974 throw new \InvalidArgumentException('Unexpected public contact record');
977 if (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND])) {
978 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
979 if (!empty($cdata['public'])) {
980 Worker::add(Worker::PRIORITY_HIGH, 'Contact\RevokeFollow', $cdata['public'], $contact['uid']);
984 self::removeFollower($contact);
988 * Completely severs a relationship with a contact
990 * @param array $contact User-specific contact (uid != 0) array
992 * @throws HTTPException\InternalServerErrorException
993 * @throws \ImagickException
995 public static function terminateFriendship(array $contact)
997 if (empty($contact['network'])) {
998 throw new \InvalidArgumentException('Empty network in contact array');
1001 if (empty($contact['uid'])) {
1002 throw new \InvalidArgumentException('Unexpected public contact record');
1005 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
1007 if (in_array($contact['rel'], [self::SHARING, self::FRIEND]) && !empty($cdata['public'])) {
1008 Worker::add(Worker::PRIORITY_HIGH, 'Contact\Unfollow', $cdata['public'], $contact['uid']);
1011 if (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) && !empty($cdata['public'])) {
1012 Worker::add(Worker::PRIORITY_HIGH, 'Contact\RevokeFollow', $cdata['public'], $contact['uid']);
1015 self::remove($contact['id']);
1018 private static function clearFollowerFollowingEndpointCache(int $uid)
1024 DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_CONTACTS . 'followers:' . $uid);
1025 DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_CONTACTS . 'following:' . $uid);
1029 * Marks a contact for archival after a communication issue delay
1031 * Contact has refused to recognise us as a friend. We will start a countdown.
1032 * If they still don't recognise us in 32 days, the relationship is over,
1033 * and we won't waste any more time trying to communicate with them.
1034 * This provides for the possibility that their database is temporarily messed
1035 * up or some other transient event and that there's a possibility we could recover from it.
1037 * @param array $contact contact to mark for archival
1039 * @throws HTTPException\InternalServerErrorException
1041 public static function markForArchival(array $contact)
1043 if (!isset($contact['url']) && !empty($contact['id'])) {
1044 $fields = ['id', 'url', 'archive', 'self', 'term-date'];
1045 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
1046 if (!DBA::isResult($contact)) {
1049 } elseif (!isset($contact['url'])) {
1050 Logger::info('Empty contact', ['contact' => $contact, 'callstack' => System::callstack(20)]);
1053 Logger::info('Contact is marked for archival', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
1055 // Contact already archived or "self" contact? => nothing to do
1056 if ($contact['archive'] || $contact['self']) {
1060 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
1061 self::update(['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
1062 self::update(['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
1065 * We really should send a notification to the owner after 2-3 weeks
1066 * so they won't be surprised when the contact vanishes and can take
1067 * remedial action if this was a serious mistake or glitch
1070 /// @todo Check for contact vitality via probing
1071 $archival_days = DI::config()->get('system', 'archival_days', 32);
1073 $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
1074 if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
1075 /* Relationship is really truly dead. archive them rather than
1076 * delete, though if the owner tries to unarchive them we'll start
1077 * the whole process over again.
1079 self::update(['archive' => true], ['id' => $contact['id']]);
1080 self::update(['archive' => true], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
1086 * Cancels the archival countdown
1088 * @see Contact::markForArchival()
1090 * @param array $contact contact to be unmarked for archival
1092 * @throws \Exception
1094 public static function unmarkForArchival(array $contact)
1096 // Always unarchive the relay contact entry
1097 if (!empty($contact['batch']) && !empty($contact['term-date']) && ($contact['term-date'] > DBA::NULL_DATETIME)) {
1098 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
1099 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1100 if (!DBA::exists('contact', array_merge($condition, $fields))) {
1101 self::update($fields, $condition);
1105 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
1106 $exists = DBA::exists('contact', $condition);
1108 // We don't need to update, we never marked this contact for archival
1113 Logger::info('Contact is marked as vital again', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
1115 if (!isset($contact['url']) && !empty($contact['id'])) {
1116 $fields = ['id', 'url', 'batch'];
1117 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
1118 if (!DBA::isResult($contact)) {
1123 // It's a miracle. Our dead contact has inexplicably come back to life.
1124 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
1125 self::update($fields, ['id' => $contact['id']]);
1126 self::update($fields, ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
1130 * Returns the data array for the photo menu of a given contact
1132 * @param array $contact contact
1133 * @param int $uid optional, default 0
1135 * @throws HTTPException\InternalServerErrorException
1136 * @throws \ImagickException
1138 public static function photoMenu(array $contact, int $uid = 0): array
1145 $uid = DI::userSession()->getLocalUserId();
1148 if (empty($contact['uid']) || ($contact['uid'] != $uid)) {
1150 $profile_link = self::magicLinkByContact($contact);
1151 $menu = ['profile' => [DI::l10n()->t('View Profile'), $profile_link, true]];
1156 // Look for our own contact if the uid doesn't match and isn't public
1157 $contact_own = DBA::selectFirst('contact', [], ['nurl' => $contact['nurl'], 'network' => $contact['network'], 'uid' => $uid]);
1158 if (DBA::isResult($contact_own)) {
1159 return self::photoMenu($contact_own, $uid);
1164 if (($contact['network'] === Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1166 $profile_link = 'contact/redir/' . $contact['id'];
1168 $profile_link = $contact['url'];
1171 if ($profile_link === 'mailbox') {
1176 $status_link = $profile_link . '/status';
1177 $photos_link = $profile_link . '/photos';
1178 $profile_link = $profile_link . '/profile';
1181 if (self::canReceivePrivateMessages($contact) && empty($contact['pending'])) {
1182 $pm_url = 'message/new/' . $contact['id'];
1185 $contact_url = 'contact/' . $contact['id'];
1187 $posts_link = 'contact/' . $contact['id'] . '/conversations';
1190 $unfollow_link = '';
1191 if (!$contact['self'] && Protocol::supportsFollow($contact['network'])) {
1192 if ($contact['uid'] && in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
1193 $unfollow_link = 'contact/unfollow?url=' . urlencode($contact['url']) . '&auto=1';
1194 } elseif(!$contact['pending']) {
1195 $follow_link = 'contact/follow?url=' . urlencode($contact['url']) . '&auto=1';
1201 * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
1203 if (empty($contact['uid'])) {
1205 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
1206 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1207 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1208 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
1209 'unfollow'=> [DI::l10n()->t('Unfollow') , $unfollow_link, true],
1213 'status' => [DI::l10n()->t('View Status') , $status_link , true],
1214 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true],
1215 'photos' => [DI::l10n()->t('View Photos') , $photos_link , true],
1216 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1217 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1218 'pm' => [DI::l10n()->t('Send PM') , $pm_url , false],
1219 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true],
1220 'unfollow'=> [DI::l10n()->t('Unfollow') , $unfollow_link , true],
1223 if (!empty($contact['pending'])) {
1225 $intro = DI::intro()->selectForContact($contact['id']);
1226 $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro->id, true];
1227 } catch (IntroductionNotFoundException $exception) {
1228 DI::logger()->error('Pending contact doesn\'t have an introduction.', ['exception' => $exception]);
1233 $args = ['contact' => $contact, 'menu' => &$menu];
1235 Hook::callAll('contact_photo_menu', $args);
1237 $menucondensed = [];
1239 foreach ($menu as $menuname => $menuitem) {
1240 if ($menuitem[1] != '') {
1241 $menucondensed[$menuname] = $menuitem;
1245 return $menucondensed;
1249 * Fetch the contact id for a given URL and user
1251 * First lookup in the contact table to find a record matching either `url`, `nurl`,
1252 * `addr` or `alias`.
1254 * If there's no record and we aren't looking for a public contact, we quit.
1255 * If there's one, we check that it isn't time to update the picture else we
1256 * directly return the found contact id.
1258 * Second, we probe the provided $url whether it's http://server.tld/profile or
1259 * nick@server.tld. We quit if we can't get any info back.
1261 * Third, we create the contact record if it doesn't exist
1263 * Fourth, we update the existing record with the new data (avatar, alias, nick)
1264 * if there's any updates
1266 * @param string $url Contact URL
1267 * @param integer $uid The user id for the contact (0 = public contact)
1268 * @param boolean $update true = always update, false = never update, null = update when not found
1269 * @param array $default Default value for creating the contact when everything else fails
1271 * @return integer Contact ID
1272 * @throws HTTPException\InternalServerErrorException
1273 * @throws \ImagickException
1275 public static function getIdForURL(string $url = null, int $uid = 0, $update = null, array $default = []): int
1280 Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
1284 $contact = self::getByURL($url, false, ['id', 'network', 'uri-id', 'next-update'], $uid);
1286 if (!empty($contact)) {
1287 $contact_id = $contact['id'];
1289 if (Probe::isProbable($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
1290 Worker::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], 'UpdateContact', $contact['id']);
1293 if (empty($update) && (!empty($contact['uri-id']) || is_bool($update))) {
1294 Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1297 } elseif ($uid != 0) {
1298 Logger::debug('Contact does not exist for the user', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1300 } elseif (empty($default) && !is_null($update) && !$update) {
1301 Logger::info('Contact not found, update not desired', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1307 if (empty($default['network']) || $update) {
1308 $data = Probe::uri($url, '', $uid);
1310 // Take the default values when probing failed
1311 if (!empty($default) && !in_array($data['network'], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1312 $data = array_merge($data, $default);
1314 } elseif (!empty($default['network'])) {
1318 if (($uid == 0) && (empty($data['network']) || ($data['network'] == Protocol::PHANTOM))) {
1319 // Fetch data for the public contact via the first found personal contact
1320 /// @todo Check if this case can happen at all (possibly with mail accounts?)
1321 $fields = ['name', 'nick', 'url', 'addr', 'alias', 'avatar', 'header', 'contact-type',
1322 'keywords', 'location', 'about', 'unsearchable', 'batch', 'notify', 'poll',
1323 'request', 'confirm', 'poco', 'subscribe', 'network', 'baseurl', 'gsid'];
1325 $personal_contact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `uid` != 0", $url]);
1326 if (!DBA::isResult($personal_contact)) {
1327 $personal_contact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `uid` != 0", Strings::normaliseLink($url)]);
1330 if (DBA::isResult($personal_contact)) {
1331 Logger::info('Take contact data from personal contact', ['url' => $url, 'update' => $update, 'contact' => $personal_contact, 'callstack' => System::callstack(20)]);
1332 $data = $personal_contact;
1333 $data['photo'] = $personal_contact['avatar'];
1334 $data['account-type'] = $personal_contact['contact-type'];
1335 $data['hide'] = $personal_contact['unsearchable'];
1336 unset($data['avatar']);
1337 unset($data['contact-type']);
1338 unset($data['unsearchable']);
1342 if (empty($data['network']) || ($data['network'] == Protocol::PHANTOM)) {
1343 Logger::notice('No valid network found', ['url' => $url, 'uid' => $uid, 'default' => $default, 'update' => $update, 'callstack' => System::callstack(20)]);
1347 if (!$contact_id && !empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1348 Logger::info('Contact is a tombstone. It will not be inserted', ['url' => $url, 'uid' => $uid]);
1353 $urls = [Strings::normaliseLink($url), Strings::normaliseLink($data['url'])];
1354 if (!empty($data['alias'])) {
1355 $urls[] = Strings::normaliseLink($data['alias']);
1357 $contact = self::selectFirst(['id'], ['nurl' => $urls, 'uid' => $uid]);
1358 if (!empty($contact['id'])) {
1359 $contact_id = $contact['id'];
1360 Logger::info('Fetched id by url', ['cid' => $contact_id, 'uid' => $uid, 'url' => $url, 'data' => $data]);
1365 // We only insert the basic data. The rest will be done in "updateFromProbeArray"
1368 'url' => $data['url'],
1369 'nurl' => Strings::normaliseLink($data['url']),
1370 'network' => $data['network'],
1371 'created' => DateTimeFormat::utcNow(),
1372 'rel' => self::SHARING,
1379 $condition = ['nurl' => Strings::normaliseLink($data['url']), 'uid' => $uid, 'deleted' => false];
1381 // Before inserting we do check if the entry does exist now.
1382 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1383 if (DBA::isResult($contact)) {
1384 $contact_id = $contact['id'];
1385 Logger::notice('Contact had been created (shortly) before', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1387 $contact_id = self::insert($fields);
1389 Logger::info('Contact inserted', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1394 Logger::warning('Contact was not inserted', ['url' => $url, 'uid' => $uid]);
1398 Logger::info('Contact will be updated', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1401 if ($data['network'] == Protocol::DIASPORA) {
1403 DI::dsprContact()->updateFromProbeArray($data);
1404 } catch (\InvalidArgumentException $e) {
1405 Logger::error($e->getMessage(), ['url' => $url, 'data' => $data]);
1407 } elseif (!empty($data['networks'][Protocol::DIASPORA])) {
1409 DI::dsprContact()->updateFromProbeArray($data['networks'][Protocol::DIASPORA]);
1410 } catch (\InvalidArgumentException $e) {
1411 Logger::error($e->getMessage(), ['url' => $url, 'data' => $data['networks'][Protocol::DIASPORA]]);
1415 self::updateFromProbeArray($contact_id, $data);
1417 // Don't return a number for a deleted account
1418 if (!empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1419 Logger::info('Contact is a tombstone', ['url' => $url, 'uid' => $uid]);
1427 * Checks if the contact is archived
1429 * @param int $cid contact id
1431 * @return boolean Is the contact archived?
1432 * @throws HTTPException\InternalServerErrorException
1434 public static function isArchived(int $cid): bool
1440 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1441 if (!DBA::isResult($contact)) {
1445 if ($contact['archive']) {
1449 // Check status of ActivityPub endpoints
1450 $apcontact = APContact::getByURL($contact['url'], false);
1451 if (!empty($apcontact)) {
1452 if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1456 if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1461 // Check status of Diaspora endpoints
1462 if (!empty($contact['batch'])) {
1463 $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1464 return DBA::exists('contact', $condition);
1471 * Checks if the contact is blocked
1473 * @param int $cid contact id
1474 * @return boolean Is the contact blocked?
1475 * @throws HTTPException\InternalServerErrorException
1477 public static function isBlocked(int $cid): bool
1483 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1484 if (!DBA::isResult($blocked)) {
1488 if (Network::isUrlBlocked($blocked['url'])) {
1492 return (bool) $blocked['blocked'];
1496 * Checks if the contact is hidden
1498 * @param int $cid contact id
1499 * @return boolean Is the contact hidden?
1500 * @throws \Exception
1502 public static function isHidden(int $cid): bool
1508 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1509 if (!DBA::isResult($hidden)) {
1512 return (bool) $hidden['hidden'];
1516 * Returns posts from a given contact url
1518 * @param string $contact_url Contact URL
1519 * @param bool $thread_mode
1520 * @param int $update Update mode
1521 * @param int $parent Item parent ID for the update mode
1522 * @param bool $only_media Only display media content
1523 * @return string posts in HTML
1524 * @throws \Exception
1526 public static function getPostsFromUrl(string $contact_url, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1528 return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent, $only_media);
1532 * Returns posts from a given contact id
1534 * @param int $cid Contact ID
1535 * @param bool $thread_mode
1536 * @param int $update Update mode
1537 * @param int $parent Item parent ID for the update mode
1538 * @param bool $only_media Only display media content
1539 * @return string posts in HTML
1540 * @throws \Exception
1542 public static function getPostsFromId(int $cid, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1544 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1545 if (!DBA::isResult($contact)) {
1549 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1550 $sql = "(`uid` = 0 OR (`uid` = ? AND NOT `global`))";
1555 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1558 $condition = ["((`$contact_field` = ? AND `gravity` = ?) OR (`author-id` = ? AND `gravity` = ? AND `vid` = ? AND `thr-parent-id` = `parent-uri-id`)) AND " . $sql,
1559 $cid, Item::GRAVITY_PARENT, $cid, Item::GRAVITY_ACTIVITY, Verb::getID(Activity::ANNOUNCE), DI::userSession()->getLocalUserId()];
1561 $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1562 $cid, Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT, DI::userSession()->getLocalUserId()];
1565 if (!empty($parent)) {
1566 $condition = DBA::mergeConditions($condition, ['parent' => $parent]);
1568 $last_received = isset($_GET['last_received']) ? DateTimeFormat::utc($_GET['last_received']) : '';
1569 if (!empty($last_received)) {
1570 $condition = DBA::mergeConditions($condition, ["`received` < ?", $last_received]);
1575 $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
1576 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
1579 if (DI::mode()->isMobile()) {
1580 $itemsPerPage = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'itemspage_mobile_network',
1581 DI::config()->get('system', 'itemspage_network_mobile'));
1583 $itemsPerPage = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'itemspage_network',
1584 DI::config()->get('system', 'itemspage_network'));
1587 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1589 $params = ['order' => ['received' => true], 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1591 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'infinite_scroll')) {
1592 $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
1593 $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
1599 $fields = ['uri-id', 'thr-parent-id', 'gravity', 'author-id', 'commented'];
1600 $items = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1602 if ($pager->getStart() == 0) {
1603 $cdata = self::getPublicAndUserContactID($cid, DI::userSession()->getLocalUserId());
1604 if (!empty($cdata['public'])) {
1605 $pinned = Post\Collection::selectToArrayForContact($cdata['public'], Post\Collection::FEATURED, $fields);
1606 $items = array_merge($items, $pinned);
1610 $o .= DI::conversation()->create($items, 'contacts', $update, false, 'pinned_commented', DI::userSession()->getLocalUserId());
1612 $fields = array_merge(Item::DISPLAY_FIELDLIST, ['featured']);
1613 $items = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1615 if ($pager->getStart() == 0) {
1616 $cdata = self::getPublicAndUserContactID($cid, DI::userSession()->getLocalUserId());
1617 if (!empty($cdata['public'])) {
1618 $condition = ["`uri-id` IN (SELECT `uri-id` FROM `collection-view` WHERE `cid` = ? AND `type` = ?)",
1619 $cdata['public'], Post\Collection::FEATURED];
1620 $pinned = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1621 $items = array_merge($pinned, $items);
1625 $o .= DI::conversation()->create($items, 'contact-posts', $update);
1629 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'infinite_scroll')) {
1630 $o .= HTML::scrollLoader();
1632 $o .= $pager->renderMinimal(count($items));
1640 * Returns the account type name
1642 * The function can be called with either the user or the contact array
1644 * @param int $type type of contact or account
1647 public static function getAccountType(int $type): string
1650 case self::TYPE_ORGANISATION:
1651 $account_type = DI::l10n()->t("Organisation");
1654 case self::TYPE_NEWS:
1655 $account_type = DI::l10n()->t('News');
1658 case self::TYPE_COMMUNITY:
1659 $account_type = DI::l10n()->t("Forum");
1667 return $account_type;
1673 * @param int $cid Contact id to block
1674 * @param string $reason Block reason
1675 * @return bool Whether it was successful
1677 public static function block(int $cid, string $reason = null): bool
1679 $return = self::update(['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1685 * Unblocks a contact
1687 * @param int $cid Contact id to unblock
1688 * @return bool Whether it was successfull
1690 public static function unblock(int $cid): bool
1692 $return = self::update(['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1698 * Ensure that cached avatar exist
1700 * @param integer $cid Contact id
1702 public static function checkAvatarCache(int $cid)
1704 $contact = DBA::selectFirst('contact', ['url', 'network', 'avatar', 'photo', 'thumb', 'micro'], ['id' => $cid, 'uid' => 0, 'self' => false]);
1705 if (!DBA::isResult($contact)) {
1709 if (Network::isLocalLink($contact['url'])) {
1713 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || DI::config()->get('system', 'cache_contact_avatar')) {
1714 if (!empty($contact['avatar']) && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1715 Logger::info('Adding avatar cache', ['id' => $cid, 'contact' => $contact]);
1716 self::updateAvatar($cid, $contact['avatar'], true);
1719 } elseif (Photo::isPhotoURI($contact['photo']) || Photo::isPhotoURI($contact['thumb']) || Photo::isPhotoURI($contact['micro'])) {
1720 Logger::info('Replacing legacy avatar cache', ['id' => $cid, 'contact' => $contact]);
1721 self::updateAvatar($cid, $contact['avatar'], true);
1723 } elseif (DI::config()->get('system', 'avatar_cache') && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1724 Logger::info('Adding avatar cache file', ['id' => $cid, 'contact' => $contact]);
1725 self::updateAvatar($cid, $contact['avatar'], true);
1731 * Return the photo path for a given contact array in the given size
1733 * @param array $contact contact array
1734 * @param string $size Size of the avatar picture
1735 * @param bool $no_update Don't perfom an update if no cached avatar was found
1736 * @return string photo path
1738 private static function getAvatarPath(array $contact, string $size, bool $no_update = false): string
1740 $contact = self::checkAvatarCacheByArray($contact, $no_update);
1742 if (DI::config()->get('system', 'avatar_cache')) {
1744 case Proxy::SIZE_MICRO:
1745 if (!empty($contact['micro']) && !Photo::isPhotoURI($contact['micro'])) {
1746 return $contact['micro'];
1749 case Proxy::SIZE_THUMB:
1750 if (!empty($contact['thumb']) && !Photo::isPhotoURI($contact['thumb'])) {
1751 return $contact['thumb'];
1754 case Proxy::SIZE_SMALL:
1755 if (!empty($contact['photo']) && !Photo::isPhotoURI($contact['photo'])) {
1756 return $contact['photo'];
1762 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
1766 * Return the photo path for a given contact array
1768 * @param array $contact Contact array
1769 * @param bool $no_update Don't perfom an update if no cached avatar was found
1770 * @return string photo path
1772 public static function getPhoto(array $contact, bool $no_update = false): string
1774 return self::getAvatarPath($contact, Proxy::SIZE_SMALL, $no_update);
1778 * Return the photo path (thumb size) for a given contact array
1780 * @param array $contact Contact array
1781 * @param bool $no_update Don't perfom an update if no cached avatar was found
1782 * @return string photo path
1784 public static function getThumb(array $contact, bool $no_update = false): string
1786 return self::getAvatarPath($contact, Proxy::SIZE_THUMB, $no_update);
1790 * Return the photo path (micro size) for a given contact array
1792 * @param array $contact Contact array
1793 * @param bool $no_update Don't perfom an update if no cached avatar was found
1794 * @return string photo path
1796 public static function getMicro(array $contact, bool $no_update = false): string
1798 return self::getAvatarPath($contact, Proxy::SIZE_MICRO, $no_update);
1802 * Check the given contact array for avatar cache fields
1804 * @param array $contact
1805 * @param bool $no_update Don't perfom an update if no cached avatar was found
1806 * @return array contact array with avatar cache fields
1808 private static function checkAvatarCacheByArray(array $contact, bool $no_update = false): array
1811 $contact_fields = [];
1812 $fields = ['photo', 'thumb', 'micro'];
1813 foreach ($fields as $field) {
1814 if (isset($contact[$field])) {
1815 $contact_fields[] = $field;
1817 if (isset($contact[$field]) && empty($contact[$field])) {
1822 if (!$update || $no_update) {
1826 $local = !empty($contact['url']) && Network::isLocalLink($contact['url']);
1828 if (!$local && !empty($contact['id']) && !empty($contact['avatar'])) {
1829 self::updateAvatar($contact['id'], $contact['avatar'], true);
1831 $new_contact = self::getById($contact['id'], $contact_fields);
1832 if (DBA::isResult($new_contact)) {
1833 // We only update the cache fields
1834 $contact = array_merge($contact, $new_contact);
1836 } elseif ($local && !empty($contact['avatar'])) {
1840 /// add the default avatars if the fields aren't filled
1841 if (isset($contact['photo']) && empty($contact['photo'])) {
1842 $contact['photo'] = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1844 if (isset($contact['thumb']) && empty($contact['thumb'])) {
1845 $contact['thumb'] = self::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
1847 if (isset($contact['micro']) && empty($contact['micro'])) {
1848 $contact['micro'] = self::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
1855 * Fetch the default header for the given contact
1857 * @param array $contact contact array
1858 * @return string avatar URL
1860 public static function getDefaultHeader(array $contact): string
1862 if (!empty($contact['header'])) {
1863 return $contact['header'];
1866 if (!empty($contact['gsid'])) {
1867 // Use default banners for certain platforms
1868 $gserver = DBA::selectFirst('gserver', ['platform'], ['id' => $contact['gsid']]);
1869 $platform = strtolower($gserver['platform'] ?? '');
1874 switch ($platform) {
1879 * @author Lostinlight <https://mastodon.xyz/@lightone>
1880 * @license CC0 https://creativecommons.org/share-your-work/public-domain/cc0/
1881 * @link https://gitlab.com/lostinlight/per_aspera_ad_astra/-/blob/master/friendica-404/friendica-promo-bubbles.jpg
1883 $header = DI::baseUrl() . '/images/friendica-banner.jpg';
1888 * @author John Liu <https://www.flickr.com/photos/8047705@N02/>
1889 * @license CC BY 2.0 https://creativecommons.org/licenses/by/2.0/
1890 * @link https://www.flickr.com/photos/8047705@N02/5572197407
1892 $header = DI::baseUrl() . '/images/diaspora-banner.jpg';
1896 * Use a random picture.
1897 * The service provides random pictures from Unsplash.
1898 * @license https://unsplash.com/license
1900 $header = 'https://picsum.photos/seed/' . hash('ripemd128', $contact['url']) . '/960/300';
1908 * Fetch the default avatar for the given contact and size
1910 * @param array $contact contact array
1911 * @param string $size Size of the avatar picture
1912 * @return string avatar URL
1914 public static function getDefaultAvatar(array $contact, string $size): string
1917 case Proxy::SIZE_MICRO:
1918 $avatar['size'] = 48;
1919 $default = self::DEFAULT_AVATAR_MICRO;
1922 case Proxy::SIZE_THUMB:
1923 $avatar['size'] = 80;
1924 $default = self::DEFAULT_AVATAR_THUMB;
1927 case Proxy::SIZE_SMALL:
1929 $avatar['size'] = 300;
1930 $default = self::DEFAULT_AVATAR_PHOTO;
1934 if (!DI::config()->get('system', 'remote_avatar_lookup')) {
1936 $type = Contact::TYPE_PERSON;
1938 if (!empty($contact['id'])) {
1939 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['id' => $contact['id']]);
1940 $platform = $account['platform'] ?? '';
1941 $type = $account['contact-type'] ?? Contact::TYPE_PERSON;
1944 if (empty($platform) && !empty($contact['uri-id'])) {
1945 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['uri-id' => $contact['uri-id']]);
1946 $platform = $account['platform'] ?? '';
1947 $type = $account['contact-type'] ?? Contact::TYPE_PERSON;
1950 switch ($platform) {
1954 * @license GNU Affero General Public License v3.0
1955 * @link https://github.com/msdos621/corgidon/blob/main/public/avatars/original/missing.png
1957 $default = '/images/default/corgidon.png';
1963 * @license GNU Affero General Public License v3.0
1964 * @link https://github.com/diaspora/diaspora/
1966 $default = '/images/default/diaspora.png';
1972 * @license GNU Affero General Public License v3.0
1973 * @link https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/default_avatars/GoToSocial_icon1.svg
1975 $default = '/images/default/gotosocial.svg';
1981 * @license GNU Affero General Public License v3.0
1982 * @link https://github.com/hometown-fork/hometown/blob/hometown-dev/public/avatars/original/missing.png
1984 $default = '/images/default/hometown.png';
1990 * @license GNU Affero General Public License v3.0
1991 * @link https://github.com/koyuspace/mastodon/blob/main/public/avatars/original/missing.png
1993 $default = '/images/default/koyuspace.png';
2001 * @license GNU Affero General Public License v3.0
2002 * @link https://github.com/mastodon/mastodon/tree/main/public/avatars/original/missing.png
2004 $default = '/images/default/mastodon.png';
2008 if ($type == Contact::TYPE_COMMUNITY) {
2011 * @license GNU Affero General Public License v3.0
2012 * @link https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-video-channel.png
2014 $default = '/images/default/peertube-channel.png';
2018 * @license GNU Affero General Public License v3.0
2019 * @link https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-account.png
2021 $default = '/images/default/peertube-account.png';
2028 * @license GNU Affero General Public License v3.0
2029 * @link https://git.pleroma.social/pleroma/pleroma/-/blob/develop/priv/static/images/avi.png
2031 $default = '/images/default/pleroma.png';
2037 * @license GNU Affero General Public License v3.0
2038 * @link https://github.com/Plume-org/Plume/blob/main/assets/images/default-avatar.png
2040 $default = '/images/default/plume.png';
2043 return DI::baseUrl() . $default;
2046 if (!empty($contact['xmpp'])) {
2047 $avatar['email'] = $contact['xmpp'];
2048 } elseif (!empty($contact['addr'])) {
2049 $avatar['email'] = $contact['addr'];
2050 } elseif (!empty($contact['url'])) {
2051 $avatar['email'] = $contact['url'];
2053 return DI::baseUrl() . $default;
2056 $avatar['url'] = '';
2057 $avatar['success'] = false;
2059 Hook::callAll('avatar_lookup', $avatar);
2061 if ($avatar['success'] && !empty($avatar['url'])) {
2062 return $avatar['url'];
2065 return DI::baseUrl() . $default;
2069 * Get avatar link for given contact id
2071 * @param integer $cid contact id
2072 * @param string $size One of the Proxy::SIZE_* constants
2073 * @param string $updated Contact update date
2074 * @param bool $static If "true" a parameter is added to convert the avatar to a static one
2075 * @return string avatar link
2077 public static function getAvatarUrlForId(int $cid, string $size = '', string $updated = '', string $guid = '', bool $static = false): string
2079 // We have to fetch the "updated" variable when it wasn't provided
2080 // The parameter can be provided to improve performance
2081 if (empty($updated)) {
2082 $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
2083 $updated = $account['updated'] ?? '';
2084 $guid = $account['guid'] ?? '';
2087 $guid = urlencode($guid);
2089 $url = DI::baseUrl() . '/photo/contact/';
2091 case Proxy::SIZE_MICRO:
2092 $url .= Proxy::PIXEL_MICRO . '/';
2094 case Proxy::SIZE_THUMB:
2095 $url .= Proxy::PIXEL_THUMB . '/';
2097 case Proxy::SIZE_SMALL:
2098 $url .= Proxy::PIXEL_SMALL . '/';
2100 case Proxy::SIZE_MEDIUM:
2101 $url .= Proxy::PIXEL_MEDIUM . '/';
2103 case Proxy::SIZE_LARGE:
2104 $url .= Proxy::PIXEL_LARGE . '/';
2109 $query_params['ts'] = strtotime($updated);
2112 $query_params['static'] = true;
2115 return $url . ($guid ?: $cid) . (!empty($query_params) ? '?' . http_build_query($query_params) : '');
2119 * Get avatar link for given contact URL
2121 * @param string $url contact url
2122 * @param integer $uid user id
2123 * @param string $size One of the Proxy::SIZE_* constants
2124 * @return string avatar link
2126 public static function getAvatarUrlForUrl(string $url, int $uid, string $size = ''): string
2128 $condition = ["`nurl` = ? AND ((`uid` = ? AND `network` IN (?, ?)) OR `uid` = ?)",
2129 Strings::normaliseLink($url), $uid, Protocol::FEED, Protocol::MAIL, 0];
2130 $contact = self::selectFirst(['id', 'updated'], $condition, ['order' => ['uid' => true]]);
2131 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
2135 * Get header link for given contact id
2137 * @param integer $cid contact id
2138 * @param string $size One of the Proxy::SIZE_* constants
2139 * @param string $updated Contact update date
2140 * @param bool $static If "true" a parameter is added to convert the header to a static one
2141 * @return string header link
2143 public static function getHeaderUrlForId(int $cid, string $size = '', string $updated = '', string $guid = '', bool $static = false): string
2145 // We have to fetch the "updated" variable when it wasn't provided
2146 // The parameter can be provided to improve performance
2147 if (empty($updated) || empty($guid)) {
2148 $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
2149 $updated = $account['updated'] ?? '';
2150 $guid = $account['guid'] ?? '';
2153 $guid = urlencode($guid);
2155 $url = DI::baseUrl() . '/photo/header/';
2157 case Proxy::SIZE_MICRO:
2158 $url .= Proxy::PIXEL_MICRO . '/';
2160 case Proxy::SIZE_THUMB:
2161 $url .= Proxy::PIXEL_THUMB . '/';
2163 case Proxy::SIZE_SMALL:
2164 $url .= Proxy::PIXEL_SMALL . '/';
2166 case Proxy::SIZE_MEDIUM:
2167 $url .= Proxy::PIXEL_MEDIUM . '/';
2169 case Proxy::SIZE_LARGE:
2170 $url .= Proxy::PIXEL_LARGE . '/';
2176 $query_params['ts'] = strtotime($updated);
2179 $query_params['static'] = true;
2182 return $url . ($guid ?: $cid) . (!empty($query_params) ? '?' . http_build_query($query_params) : '');
2186 * Updates the avatar links in a contact only if needed
2188 * @param int $cid Contact id
2189 * @param string $avatar Link to avatar picture
2190 * @param bool $force force picture update
2191 * @param bool $create_cache Enforces the creation of cached avatar fields
2194 * @throws HTTPException\InternalServerErrorException
2195 * @throws HTTPException\NotFoundException
2196 * @throws \ImagickException
2198 public static function updateAvatar(int $cid, string $avatar, bool $force = false, bool $create_cache = false)
2200 $contact = DBA::selectFirst('contact', ['uid', 'avatar', 'photo', 'thumb', 'micro', 'blurhash', 'xmpp', 'addr', 'nurl', 'url', 'network', 'uri-id'],
2201 ['id' => $cid, 'self' => false]);
2202 if (!DBA::isResult($contact)) {
2206 $uid = $contact['uid'];
2208 // Only update the cached photo links of public contacts when they already are cached
2209 if (($uid == 0) && !$force && empty($contact['thumb']) && empty($contact['micro']) && !$create_cache) {
2210 if (($contact['avatar'] != $avatar) || empty($contact['blurhash'])) {
2211 $update_fields = ['avatar' => $avatar];
2212 $fetchResult = HTTPSignature::fetchRaw($avatar, 0, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
2214 $img_str = $fetchResult->getBody();
2215 if (!empty($img_str)) {
2216 $image = new Image($img_str, Images::getMimeTypeByData($img_str));
2217 if ($image->isValid()) {
2218 $update_fields['blurhash'] = $image->getBlurHash();
2222 self::update($update_fields, ['id' => $cid]);
2223 Logger::info('Only update the avatar', ['id' => $cid, 'avatar' => $avatar, 'contact' => $contact]);
2228 // User contacts use are updated through the public contacts
2229 if (($uid != 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2230 $pcid = self::getIdForURL($contact['url'], 0, false);
2231 if (!empty($pcid)) {
2232 Logger::debug('Update the private contact via the public contact', ['id' => $cid, 'uid' => $uid, 'public' => $pcid]);
2233 self::updateAvatar($pcid, $avatar, $force, true);
2238 $default_avatar = empty($avatar) || strpos($avatar, self::DEFAULT_AVATAR_PHOTO);
2240 if ($default_avatar) {
2241 $avatar = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
2244 $cache_avatar = DI::config()->get('system', 'cache_contact_avatar');
2246 // Local contact avatars don't need to be cached
2247 if ($cache_avatar && Network::isLocalLink($contact['url'])) {
2248 $cache_avatar = !DBA::exists('contact', ['nurl' => $contact['nurl'], 'self' => true]);
2251 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || $cache_avatar) {
2252 Avatar::deleteCache($contact);
2254 if ($default_avatar && Proxy::isLocalImage($avatar)) {
2255 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
2257 'thumb' => self::getDefaultAvatar($contact, Proxy::SIZE_THUMB),
2258 'micro' => self::getDefaultAvatar($contact, Proxy::SIZE_MICRO)];
2259 Logger::debug('Use default avatar', ['id' => $cid, 'uid' => $uid]);
2262 // Use the data from the self account
2263 if (empty($fields)) {
2264 $local_uid = User::getIdForURL($contact['url']);
2265 if (!empty($local_uid)) {
2266 $fields = self::selectFirst(['avatar', 'avatar-date', 'photo', 'thumb', 'micro'], ['self' => true, 'uid' => $local_uid]);
2267 Logger::debug('Use owner data', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2271 if (empty($fields)) {
2272 $update = ($contact['avatar'] != $avatar) || $force;
2276 $contact['photo'] ?? '',
2277 $contact['thumb'] ?? '',
2278 $contact['micro'] ?? '',
2281 foreach ($data as $image_uri) {
2282 $image_rid = Photo::ridFromURI($image_uri);
2283 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
2284 Logger::debug('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
2291 $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
2293 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'blurhash' => $photos[3], 'avatar-date' => DateTimeFormat::utcNow()];
2294 $update = !empty($fields);
2295 Logger::debug('Created new cached avatars', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2301 $update = ($fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2304 Photo::delete(['uid' => $uid, 'contact-id' => $cid, 'photo-type' => Photo::CONTACT_AVATAR]);
2305 $fields = Avatar::fetchAvatarContact($contact, $avatar, $force);
2306 $update = ($avatar . $fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['avatar'] . $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2315 if (($uid == 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2316 // Collect all user contacts of the given public contact
2317 $personal_contacts = DBA::select('contact', ['id', 'uid'],
2318 ["`nurl` = ? AND `id` != ? AND NOT `self`", $contact['nurl'], $cid]);
2319 while ($personal_contact = DBA::fetch($personal_contacts)) {
2320 $cids[] = $personal_contact['id'];
2321 $uids[] = $personal_contact['uid'];
2323 DBA::close($personal_contacts);
2325 if (!empty($cids)) {
2326 // Delete possibly existing cached user contact avatars
2327 Photo::delete(['uid' => $uids, 'contact-id' => $cids, 'photo-type' => Photo::CONTACT_AVATAR]);
2333 Logger::info('Updating cached contact avatars', ['cid' => $cids, 'uid' => $uids, 'fields' => $fields]);
2334 self::update($fields, ['id' => $cids]);
2337 public static function deleteContactByUrl(string $url)
2339 // Update contact data for all users
2340 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
2341 $contacts = DBA::select('contact', ['id', 'uid'], $condition);
2342 while ($contact = DBA::fetch($contacts)) {
2343 Logger::info('Deleting contact', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $url]);
2344 self::remove($contact['id']);
2349 * Helper function for "updateFromProbe". Updates personal and public contact
2351 * @param integer $id contact id
2352 * @param integer $uid user id
2353 * @param integer $uri_id Uri-Id
2354 * @param string $url The profile URL of the contact
2355 * @param array $fields The fields that are updated
2357 * @throws \Exception
2359 private static function updateContact(int $id, int $uid, int $uri_id, string $url, array $fields)
2361 if (!self::update($fields, ['id' => $id])) {
2362 Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
2366 self::setAccountUser($id, $uid, $uri_id, $url);
2368 // Archive or unarchive the contact.
2369 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
2370 if (!DBA::isResult($contact)) {
2371 Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
2375 if (isset($fields['failed'])) {
2376 if ($fields['failed']) {
2377 self::markForArchival($contact);
2379 self::unmarkForArchival($contact);
2383 if ($contact['uid'] != 0) {
2387 // Update contact data for all users
2388 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
2390 $condition['network'] = [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB];
2391 self::update($fields, $condition);
2393 // We mustn't set the update fields for OStatus contacts since they are updated in OnePoll
2394 $condition['network'] = Protocol::OSTATUS;
2396 // If the contact failed, propagate the update fields to all contacts
2397 if (empty($fields['failed'])) {
2398 unset($fields['last-update']);
2399 unset($fields['success_update']);
2400 unset($fields['failure_update']);
2403 if (empty($fields)) {
2407 self::update($fields, $condition);
2411 * Create or update an "account-user" entry
2413 * @param integer $id
2414 * @param integer $uid
2415 * @param integer $uri_id
2416 * @param string $url
2419 public static function setAccountUser(int $id, int $uid, int $uri_id, string $url)
2421 if (empty($uri_id)) {
2425 $account_user = DBA::selectFirst('account-user', ['id', 'uid', 'uri-id'], ['id' => $id]);
2426 if (!empty($account_user['uri-id']) && ($account_user['uri-id'] != $uri_id)) {
2427 if ($account_user['uid'] == $uid) {
2428 $ret = DBA::update('account-user', ['uri-id' => $uri_id], ['id' => $id]);
2429 Logger::notice('Updated account-user uri-id', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2431 // This should never happen
2432 Logger::warning('account-user exists for a different uri-id and uid', ['account_user' => $account_user, 'id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2436 $account_user = DBA::selectFirst('account-user', ['id', 'uid', 'uri-id'], ['uid' => $uid, 'uri-id' => $uri_id]);
2437 if (!empty($account_user['id'])) {
2438 if ($account_user['id'] == $id) {
2439 Logger::debug('account-user already exists', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2441 } elseif (!DBA::exists('contact', ['id' => $account_user['id'], 'deleted' => false])) {
2442 $ret = DBA::update('account-user', ['id' => $id], ['uid' => $uid, 'uri-id' => $uri_id]);
2443 Logger::notice('Updated account-user', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2446 Logger::warning('account-user exists for a different contact id', ['account_user' => $account_user, 'id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2447 Worker::add(Worker::PRIORITY_HIGH, 'MergeContact', $account_user['id'], $id, $uid);
2448 } elseif (DBA::insert('account-user', ['id' => $id, 'uri-id' => $uri_id, 'uid' => $uid], Database::INSERT_IGNORE)) {
2449 Logger::notice('account-user was added', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2451 Logger::warning('account-user was not added', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2456 * Remove duplicated contacts
2458 * @param string $nurl Normalised contact url
2459 * @param integer $uid User id
2461 * @throws \Exception
2463 public static function removeDuplicates(string $nurl, int $uid)
2465 $condition = ['nurl' => $nurl, 'uid' => $uid, 'self' => false, 'deleted' => false, 'network' => Protocol::FEDERATED];
2466 $count = DBA::count('contact', $condition);
2471 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
2472 if (!DBA::isResult($first_contact)) {
2473 // Shouldn't happen - so we handle it
2477 $first = $first_contact['id'];
2478 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
2480 // Find all duplicates
2481 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
2482 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
2483 while ($duplicate = DBA::fetch($duplicates)) {
2484 if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
2488 Worker::add(Worker::PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
2490 DBA::close($duplicates);
2491 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl, 'callstack' => System::callstack(20)]);
2496 * Updates contact record by provided id and optional network
2498 * @param integer $id contact id
2499 * @param string $network Optional network we are probing for
2501 * @throws HTTPException\InternalServerErrorException
2502 * @throws \ImagickException
2504 public static function updateFromProbe(int $id, string $network = '')
2506 $contact = DBA::selectFirst('contact', ['uid', 'url'], ['id' => $id]);
2507 if (!DBA::isResult($contact)) {
2511 $data = Probe::uri($contact['url'], $network, $contact['uid']);
2513 if ($data['network'] == Protocol::DIASPORA) {
2515 DI::dsprContact()->updateFromProbeArray($data);
2516 } catch (\InvalidArgumentException $e) {
2517 Logger::error($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2519 } elseif (!empty($data['networks'][Protocol::DIASPORA])) {
2521 DI::dsprContact()->updateFromProbeArray($data['networks'][Protocol::DIASPORA]);
2522 } catch (\InvalidArgumentException $e) {
2523 Logger::error($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2527 return self::updateFromProbeArray($id, $data);
2531 * Checks if the given contact has got local data
2534 * @param array $contact
2538 private static function hasLocalData(int $id, array $contact): bool
2540 if (!empty($contact['uri-id']) && DBA::exists('contact', ["`uri-id` = ? AND `uid` != ?", $contact['uri-id'], 0])) {
2541 // User contacts with the same uri-id exist
2543 } elseif (DBA::exists('contact', ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($contact['url']), 0])) {
2544 // User contacts with the same nurl exists (compatibility mode for systems with missing uri-id values)
2547 if (DBA::exists('post-tag', ['cid' => $id])) {
2548 // Is tagged in a post
2551 if (DBA::exists('user-contact', ['cid' => $id])) {
2552 // Has got user-contact data
2555 if (Post::exists(['author-id' => $id])) {
2556 // Posts with this author exist
2559 if (Post::exists(['owner-id' => $id])) {
2560 // Posts with this owner exist
2563 if (Post::exists(['causer-id' => $id])) {
2564 // Posts with this causer exist
2567 // We don't have got this contact locally
2572 * Updates contact record by provided id and probed data
2574 * @param integer $id contact id
2575 * @param array $ret Probed data
2577 * @throws HTTPException\InternalServerErrorException
2578 * @throws \ImagickException
2580 private static function updateFromProbeArray(int $id, array $ret): bool
2583 Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
2584 This will reliably kill your communication with old Friendica contacts.
2587 // These fields aren't updated by this routine:
2590 $fields = ['uid', 'uri-id', 'avatar', 'header', 'name', 'nick', 'location', 'keywords', 'about', 'subscribe',
2591 'manually-approve', 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
2592 'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey', 'last-item', 'xmpp', 'matrix',
2593 'created', 'last-update'];
2594 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
2595 if (!DBA::isResult($contact)) {
2599 if (self::isLocal($ret['url'])) {
2600 if ($contact['uid'] == 0) {
2601 Logger::info('Local contacts are not updated here.');
2603 self::updateFromPublicContact($id, $contact);
2608 if (!empty($ret['account-type']) && $ret['account-type'] == User::ACCOUNT_TYPE_DELETED) {
2609 Logger::info('Deleted account', ['id' => $id, 'url' => $ret['url'], 'ret' => $ret]);
2612 // Delete all contacts with the same URL
2613 self::deleteContactByUrl($ret['url']);
2617 $uid = $contact['uid'];
2618 unset($contact['uid']);
2620 $uriid = $contact['uri-id'];
2621 unset($contact['uri-id']);
2623 $pubkey = $contact['pubkey'];
2624 unset($contact['pubkey']);
2626 $created = $contact['created'];
2627 unset($contact['created']);
2629 $last_update = $contact['last-update'];
2630 unset($contact['last-update']);
2632 $contact['photo'] = $contact['avatar'];
2633 unset($contact['avatar']);
2635 $updated = DateTimeFormat::utcNow();
2637 $has_local_data = self::hasLocalData($id, $contact);
2639 if (!Probe::isProbable($ret['network'])) {
2640 // Periodical checks are only done on federated contacts
2641 $failed_next_update = null;
2642 $success_next_update = null;
2643 } elseif ($has_local_data) {
2644 $failed_next_update = GServer::getNextUpdateDate(false, $created, $last_update, !in_array($contact['network'], Protocol::FEDERATED));
2645 $success_next_update = GServer::getNextUpdateDate(true, $created, $last_update, !in_array($contact['network'], Protocol::FEDERATED));
2647 $failed_next_update = DateTimeFormat::utc('now +6 month');
2648 $success_next_update = DateTimeFormat::utc('now +1 month');
2651 if (Strings::normaliseLink($contact['url']) != Strings::normaliseLink($ret['url'])) {
2652 Logger::notice('New URL differs from old URL', ['id' => $id, 'uid' => $uid, 'old' => $contact['url'], 'new' => $ret['url']]);
2653 self::updateContact($id, $uid, $uriid, $contact['url'], ['failed' => true, 'local-data' => $has_local_data, 'last-update' => $updated, 'next-update' => $failed_next_update, 'failure_update' => $updated]);
2657 // We must not try to update relay contacts via probe. They are no real contacts.
2658 // We check after the probing to be able to correct falsely detected contact types.
2659 if (($contact['contact-type'] == self::TYPE_RELAY) &&
2660 (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))) {
2661 self::updateContact($id, $uid, $uriid, $contact['url'], ['failed' => false, 'local-data' => $has_local_data, 'last-update' => $updated, 'next-update' => $success_next_update, 'success_update' => $updated]);
2662 Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
2666 // If Probe::uri fails the network code will be different ("feed" or "unkn")
2667 if (($ret['network'] == Protocol::PHANTOM) || (($ret['network'] == Protocol::FEED) && ($ret['network'] != $contact['network']))) {
2668 self::updateContact($id, $uid, $uriid, $contact['url'], ['failed' => true, 'local-data' => $has_local_data, 'last-update' => $updated, 'next-update' => $failed_next_update, 'failure_update' => $updated]);
2672 if (Strings::normaliseLink($ret['url']) != Strings::normaliseLink($contact['url'])) {
2673 $cid = self::getIdForURL($ret['url'], 0, false);
2674 if (!empty($cid) && ($cid != $id)) {
2675 Logger::notice('URL of contact changed.', ['id' => $id, 'new_id' => $cid, 'old' => $contact['url'], 'new' => $ret['url']]);
2676 return self::updateFromProbeArray($cid, $ret);
2680 if (isset($ret['hide']) && is_bool($ret['hide'])) {
2681 $ret['unsearchable'] = $ret['hide'];
2684 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
2685 $ret['forum'] = false;
2686 $ret['prv'] = false;
2687 $ret['contact-type'] = $ret['account-type'];
2688 if (($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) && isset($ret['manually-approve'])) {
2689 $ret['forum'] = (bool)!$ret['manually-approve'];
2690 $ret['prv'] = (bool)!$ret['forum'];
2694 $new_pubkey = $ret['pubkey'] ?? '';
2696 if ($uid == 0 && DI::config()->get('system', 'fetch_featured_posts')) {
2697 if ($ret['network'] == Protocol::ACTIVITYPUB) {
2698 $apcontact = APContact::getByURL($ret['url'], false);
2699 if (!empty($apcontact['featured'])) {
2700 Worker::add(Worker::PRIORITY_LOW, 'FetchFeaturedPosts', $ret['url']);
2704 $ret['last-item'] = Probe::getLastUpdate($ret);
2705 Logger::info('Fetched last item', ['id' => $id, 'probed_url' => $ret['url'], 'last-item' => $ret['last-item'], 'callstack' => System::callstack(20)]);
2709 $guid = ($ret['guid'] ?? '') ?: Item::guidFromUri($ret['url']);
2711 // make sure to not overwrite existing values with blank entries except some technical fields
2712 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2713 foreach ($ret as $key => $val) {
2714 if (!array_key_exists($key, $contact)) {
2716 } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2717 $ret[$key] = $contact[$key];
2718 } elseif ($ret[$key] != $contact[$key]) {
2723 if (!empty($ret['last-item']) && ($contact['last-item'] < $ret['last-item'])) {
2726 unset($ret['last-item']);
2729 if (empty($uriid)) {
2733 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2734 self::updateAvatar($id, $ret['photo'], $update);
2738 self::updateContact($id, $uid, $uriid, $contact['url'], ['failed' => false, 'local-data' => $has_local_data, 'last-update' => $updated, 'next-update' => $success_next_update, 'success_update' => $updated]);
2740 if (Contact\Relation::isDiscoverable($ret['url'])) {
2741 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2744 // Update the public contact
2746 $contact = self::getByURL($ret['url'], false, ['id']);
2747 if (!empty($contact['id'])) {
2748 self::updateFromProbeArray($contact['id'], $ret);
2755 $ret['uri-id'] = ItemURI::insert(['uri' => $ret['url'], 'guid' => $guid]);
2756 $ret['nurl'] = Strings::normaliseLink($ret['url']);
2757 $ret['updated'] = $updated;
2758 $ret['failed'] = false;
2759 $ret['next-update'] = $success_next_update;
2760 $ret['local-data'] = $has_local_data;
2762 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2763 if (empty($pubkey) && !empty($new_pubkey)) {
2764 $ret['pubkey'] = $new_pubkey;
2767 if ((!empty($ret['addr']) && ($ret['addr'] != $contact['addr'])) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2768 $ret['uri-date'] = $updated;
2771 if ((!empty($ret['name']) && ($ret['name'] != $contact['name'])) || (!empty($ret['nick']) && ($ret['nick'] != $contact['nick']))) {
2772 $ret['name-date'] = $updated;
2775 if (($uid == 0) || in_array($ret['network'], [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2776 $ret['last-update'] = $updated;
2777 $ret['success_update'] = $updated;
2780 unset($ret['photo']);
2782 self::updateContact($id, $uid, $ret['uri-id'], $ret['url'], $ret);
2784 if (Contact\Relation::isDiscoverable($ret['url'])) {
2785 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2791 private static function updateFromPublicContact(int $id, array $contact)
2793 $public = self::getByURL($contact['url'], false);
2797 foreach ($contact as $field => $value) {
2798 if ($field == 'uid') {
2801 if ($public[$field] != $value) {
2802 $fields[$field] = $public[$field];
2805 if (!empty($fields)) {
2806 self::update($fields, ['id' => $id, 'self' => false]);
2807 Logger::info('Updating local contact', ['id' => $id]);
2812 * Updates contact record by provided URL
2814 * @param integer $url contact url
2815 * @return integer Contact id
2816 * @throws HTTPException\InternalServerErrorException
2817 * @throws \ImagickException
2819 public static function updateFromProbeByURL(string $url): int
2821 $id = self::getIdForURL($url);
2827 self::updateFromProbe($id);
2833 * Detects the communication protocol for a given contact url.
2834 * This is used to detect Friendica contacts that we can communicate via AP.
2836 * @param string $url contact url
2837 * @param string $network Network of that contact
2838 * @return string with protocol
2840 public static function getProtocol(string $url, string $network): string
2842 if ($network != Protocol::DFRN) {
2846 $apcontact = APContact::getByURL($url);
2847 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2848 return Protocol::ACTIVITYPUB;
2855 * Takes a $uid and a url/handle and adds a new contact
2857 * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2858 * dfrn_request page.
2860 * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
2863 * $return['success'] boolean true if successful
2864 * $return['message'] error text if success is false.
2866 * Takes a $uid and a url/handle and adds a new contact
2868 * @param int $uid The user id the contact should be created for
2869 * @param string $url The profile URL of the contact
2870 * @param string $network
2872 * @throws HTTPException\InternalServerErrorException
2873 * @throws HTTPException\NotFoundException
2874 * @throws \ImagickException
2876 public static function createFromProbeForUser(int $uid, string $url, string $network = ''): array
2878 $result = ['cid' => -1, 'success' => false, 'message' => ''];
2880 // remove ajax junk, e.g. Twitter
2881 $url = str_replace('/#!/', '/', $url);
2883 if (!Network::isUrlAllowed($url)) {
2884 $result['message'] = DI::l10n()->t('Disallowed profile URL.');
2888 if (Network::isUrlBlocked($url)) {
2889 $result['message'] = DI::l10n()->t('Blocked domain');
2894 $result['message'] = DI::l10n()->t('Connect URL missing.');
2898 $arr = ['url' => $url, 'contact' => []];
2900 Hook::callAll('follow', $arr);
2903 $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
2907 if (!empty($arr['contact']['name'])) {
2909 $ret = $arr['contact'];
2912 $ret = Probe::uri($url, $network, $uid);
2914 // Ensure that the public contact exists
2915 if ($ret['network'] != Protocol::PHANTOM) {
2916 self::getIdForURL($url);
2920 if (($network != '') && ($ret['network'] != $network)) {
2921 Logger::notice('Expected network ' . $network . ' does not match actual network ' . $ret['network']);
2925 // check if we already have a contact
2926 // the poll url is more reliable than the profile url, as we may have
2927 // indirect links or webfinger links
2929 $condition = ['uid' => $uid, 'poll' => [$ret['poll'], Strings::normaliseLink($ret['poll'])], 'network' => $ret['network'], 'pending' => false];
2930 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2931 if (!DBA::isResult($contact)) {
2932 $condition = ['uid' => $uid, 'nurl' => Strings::normaliseLink($ret['url']), 'network' => $ret['network'], 'pending' => false];
2933 $contact = DBA::selectFirst('contact', ['id', 'rel'], $condition);
2936 $protocol = self::getProtocol($ret['url'], $ret['network']);
2938 // This extra param just confuses things, remove it
2939 if ($protocol === Protocol::DIASPORA) {
2940 $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
2943 // do we have enough information?
2944 if (empty($protocol) || ($protocol == Protocol::PHANTOM) || (empty($ret['url']) && empty($ret['addr']))) {
2945 $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . '<br />';
2946 if (empty($ret['poll'])) {
2947 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . '<br />';
2949 if (empty($ret['name'])) {
2950 $result['message'] .= DI::l10n()->t('An author or name was not found.') . '<br />';
2952 if (empty($ret['url'])) {
2953 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . '<br />';
2955 if (strpos($ret['url'], '@') !== false) {
2956 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . '<br />';
2957 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . '<br />';
2962 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
2963 $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . '<br />';
2964 $ret['notify'] = '';
2967 if (!$ret['notify']) {
2968 $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . '<br />';
2971 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
2973 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
2975 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
2978 if (($protocol == Protocol::ACTIVITYPUB) && isset($ret['manually-approve'])) {
2979 $pending = (bool)$ret['manually-approve'];
2982 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2986 if (DBA::isResult($contact)) {
2988 $new_relation = (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) ? self::FRIEND : self::SHARING);
2990 $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false];
2991 self::update($fields, ['id' => $contact['id']]);
2993 $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
2995 // create contact record
2998 'created' => DateTimeFormat::utcNow(),
2999 'url' => $ret['url'],
3000 'nurl' => Strings::normaliseLink($ret['url']),
3001 'addr' => $ret['addr'],
3002 'alias' => $ret['alias'],
3003 'batch' => $ret['batch'],
3004 'notify' => $ret['notify'],
3005 'poll' => $ret['poll'],
3006 'poco' => $ret['poco'],
3007 'name' => $ret['name'],
3008 'nick' => $ret['nick'],
3009 'network' => $ret['network'],
3010 'baseurl' => $ret['baseurl'],
3011 'gsid' => $ret['gsid'] ?? null,
3012 'protocol' => $protocol,
3013 'pubkey' => $ret['pubkey'],
3014 'rel' => $new_relation,
3015 'priority'=> $ret['priority'],
3016 'writable'=> $writeable,
3017 'hidden' => $hidden,
3020 'pending' => $pending,
3025 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
3026 if (!DBA::isResult($contact)) {
3027 $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . '<br />';
3031 $contact_id = $contact['id'];
3032 $result['cid'] = $contact_id;
3034 Group::addMember(User::getDefaultGroup($uid), $contact_id);
3036 // Update the avatar
3037 self::updateAvatar($contact_id, $ret['photo']);
3039 // pull feed and consume it, which should subscribe to the hub.
3040 if ($contact['network'] == Protocol::OSTATUS) {
3041 Worker::add(Worker::PRIORITY_HIGH, 'OnePoll', $contact_id, 'force');
3045 self::updateFromProbeArray($contact_id, $ret);
3047 Worker::add(Worker::PRIORITY_HIGH, 'UpdateContact', $contact_id);
3050 $result['success'] = Protocol::follow($uid, $contact, $protocol);
3056 * @param array $importer Owner (local user) data
3057 * @param array $contact Existing owner-specific contact data we want to expand the relationship with. Optional.
3058 * @param array $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
3059 * @param bool $sharing True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
3060 * @param string $note Introduction additional message
3061 * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
3062 * @throws HTTPException\InternalServerErrorException
3063 * @throws \ImagickException
3065 public static function addRelationship(array $importer, array $contact, array $datarray, bool $sharing = false, string $note = '')
3067 // Should always be set
3068 if (empty($datarray['author-id'])) {
3072 $fields = ['id', 'url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked'];
3073 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
3074 if (!DBA::isResult($pub_contact)) {
3075 // Should never happen
3079 // Contact is blocked at node-level
3080 if (self::isBlocked($datarray['author-id'])) {
3084 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
3085 $name = $pub_contact['name'];
3086 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
3087 $nick = $pub_contact['nick'];
3088 $network = $pub_contact['network'];
3090 // Ensure that we don't create a new contact when there already is one
3091 $cid = self::getIdForURL($url, $importer['uid']);
3093 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
3096 self::clearFollowerFollowingEndpointCache($importer['uid']);
3098 if (!empty($contact)) {
3099 if (!empty($contact['pending'])) {
3100 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
3104 // Contact is blocked at user-level
3105 if (!empty($contact['id']) && !empty($importer['id']) &&
3106 Contact\User::isBlocked($contact['id'], $importer['id'])) {
3110 // Make sure that the existing contact isn't archived
3111 self::unmarkForArchival($contact);
3113 if (($contact['rel'] == self::SHARING)
3114 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
3115 self::update(['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
3116 ['id' => $contact['id'], 'uid' => $importer['uid']]);
3119 // Ensure to always have the correct network type, independent from the connection request method
3120 self::updateFromProbe($contact['id']);
3122 Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
3126 // send email notification to owner?
3127 if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
3128 Logger::notice('ignoring duplicated connection request from pending contact ' . $url);
3132 // create contact record
3133 $contact_id = self::insert([
3134 'uid' => $importer['uid'],
3135 'created' => DateTimeFormat::utcNow(),
3137 'nurl' => Strings::normaliseLink($url),
3140 'network' => $network,
3141 'rel' => self::FOLLOWER,
3148 // Ensure to always have the correct network type, independent from the connection request method
3149 self::updateFromProbe($contact_id);
3151 self::updateAvatar($contact_id, $photo, true);
3153 Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
3155 $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo'], ['id' => $contact_id]);
3157 /// @TODO Encapsulate this into a function/method
3158 $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
3159 $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
3160 if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
3161 // create notification
3162 if (is_array($contact_record)) {
3163 $intro = DI::introFactory()->createNew(
3165 $contact_record['id'],
3168 DI::intro()->save($intro);
3171 Group::addMember(User::getDefaultGroup($importer['uid']), $contact_record['id']);
3173 if (($user['notify-flags'] & Notification\Type::INTRO) && $user['page-flags'] == User::PAGE_FLAGS_NORMAL) {
3174 DI::notify()->createFromArray([
3175 'type' => Notification\Type::INTRO,
3176 'otype' => Notification\ObjectType::INTRO,
3177 'verb' => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
3178 'uid' => $user['uid'],
3179 'cid' => $contact_record['id'],
3180 'link' => DI::baseUrl() . '/notifications/intros',
3183 } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
3184 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
3185 self::createFromProbeForUser($importer['uid'], $url, $network);
3188 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
3189 $fields = ['pending' => false];
3190 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
3191 $fields['rel'] = self::FRIEND;
3194 self::update($fields, $condition);
3204 * Update the local relationship when a local user loses a follower
3206 * @param array $contact User-specific contact (uid != 0) array
3208 * @throws HTTPException\InternalServerErrorException
3209 * @throws \ImagickException
3211 public static function removeFollower(array $contact)
3213 if (in_array($contact['rel'] ?? [], [self::FRIEND, self::SHARING])) {
3214 self::update(['rel' => self::SHARING], ['id' => $contact['id']]);
3215 } elseif (!empty($contact['id'])) {
3216 self::remove($contact['id']);
3218 DI::logger()->info('Couldn\'t remove follower because of invalid contact array', ['contact' => $contact, 'callstack' => System::callstack()]);
3222 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscoveryForUser', $contact['uid']);
3224 self::clearFollowerFollowingEndpointCache($contact['uid']);
3226 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
3227 if (!empty($cdata['public'])) {
3228 DI::notification()->deleteForUserByVerb($contact['uid'], Activity::FOLLOW, ['actor-id' => $cdata['public']]);
3233 * Update the local relationship when a local user unfollow a contact.
3234 * Removes the contact for sharing-only protocols (feed and mail).
3236 * @param array $contact User-specific contact (uid != 0) array
3237 * @throws HTTPException\InternalServerErrorException
3239 public static function removeSharer(array $contact)
3241 self::clearFollowerFollowingEndpointCache($contact['uid']);
3243 if ($contact['rel'] == self::SHARING || in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
3244 self::remove($contact['id']);
3246 self::update(['rel' => self::FOLLOWER], ['id' => $contact['id']]);
3249 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscoveryForUser', $contact['uid']);
3253 * Create a birthday event.
3255 * Update the year and the birthday.
3257 public static function updateBirthdays()
3261 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
3262 AND NOT `contact`.`pending`
3263 AND NOT `contact`.`hidden`
3264 AND NOT `contact`.`blocked`
3265 AND NOT `contact`.`archive`
3266 AND NOT `contact`.`deleted`',
3272 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
3274 while ($contact = DBA::fetch($contacts)) {
3275 Logger::notice('update_contact_birthday: ' . $contact['bd']);
3277 $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
3279 if (Event::createBirthday($contact, $nextbd)) {
3283 ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
3284 ['id' => $contact['id']]
3288 DBA::close($contacts);
3292 * Remove the unavailable contact ids from the provided list
3294 * @param array $contact_ids Contact id list
3296 * @throws \Exception
3298 public static function pruneUnavailable(array $contact_ids): array
3300 if (empty($contact_ids)) {
3304 $contacts = self::selectToArray(['id'], [
3305 'id' => $contact_ids,
3311 return array_column($contacts, 'id');
3315 * Returns a magic link to authenticate remote visitors
3317 * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
3319 * @param string $contact_url The address of the target contact profile
3320 * @param string $url An url that we will be redirected to after the authentication
3322 * @return string with "redir" link
3323 * @throws HTTPException\InternalServerErrorException
3324 * @throws \ImagickException
3326 public static function magicLink(string $contact_url, string $url = ''): string
3328 if (!DI::userSession()->isAuthenticated()) {
3329 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3332 $contact = self::getByURL($contact_url, false);
3333 if (empty($contact)) {
3334 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3337 // Prevents endless loop in case only a non-public contact exists for the contact URL
3338 unset($contact['uid']);
3340 return self::magicLinkByContact($contact, $url ?: $contact_url);
3344 * Returns a magic link to authenticate remote visitors
3346 * @param integer $cid The contact id of the target contact profile
3347 * @param string $url An url that we will be redirected to after the authentication
3349 * @return string with "redir" link
3350 * @throws HTTPException\InternalServerErrorException
3351 * @throws \ImagickException
3353 public static function magicLinkById(int $cid, string $url = ''): string
3355 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
3357 return self::magicLinkByContact($contact, $url);
3361 * Returns a magic link to authenticate remote visitors
3363 * @param array $contact The contact array with "uid", "network" and "url"
3364 * @param string $url An url that we will be redirected to after the authentication
3366 * @return string with "redir" link
3367 * @throws HTTPException\InternalServerErrorException
3368 * @throws \ImagickException
3370 public static function magicLinkByContact(array $contact, string $url = ''): string
3372 $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
3374 if (!DI::userSession()->isAuthenticated()) {
3375 return $destination;
3378 // Only redirections to the same host do make sense
3379 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
3383 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'stay_local') && ($url == '')) {
3384 return 'contact/' . $contact['id'] . '/conversations';
3387 if (!empty($contact['network']) && $contact['network'] != Protocol::DFRN) {
3388 return $destination;
3391 if (empty($contact['id'])) {
3392 return $destination;
3395 $redirect = 'contact/redir/' . $contact['id'];
3397 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
3398 $redirect .= '?url=' . $url;
3405 * Is the contact a forum?
3407 * @param integer $contactid ID of the contact
3409 * @return boolean "true" if it is a forum
3411 public static function isForum(int $contactid): bool
3413 $fields = ['contact-type'];
3414 $condition = ['id' => $contactid];
3415 $contact = DBA::selectFirst('contact', $fields, $condition);
3416 if (!DBA::isResult($contact)) {
3421 return ($contact['contact-type'] == self::TYPE_COMMUNITY);
3425 * Can the remote contact receive private messages?
3427 * @param array $contact
3430 public static function canReceivePrivateMessages(array $contact): bool
3432 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
3433 $self = $contact['self'] ?? false;
3435 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;
3439 * Search contact table by nick or name
3441 * @param string $search Name or nick
3442 * @param string $mode Search mode (e.g. "community")
3443 * @param int $uid User ID
3444 * @param int $limit Maximum amount of returned values
3445 * @param int $offset Limit offset
3447 * @return array with search results
3448 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3450 public static function searchByName(string $search, string $mode = '', int $uid = 0, int $limit = 0, int $offset = 0): array
3452 if (empty($search)) {
3456 // check supported networks
3457 $networks = [Protocol::DFRN, Protocol::ACTIVITYPUB];
3458 if (DI::config()->get('system', 'diaspora_enabled')) {
3459 $networks[] = Protocol::DIASPORA;
3462 if (!DI::config()->get('system', 'ostatus_disabled')) {
3463 $networks[] = Protocol::OSTATUS;
3466 $condition = ['network' => $networks, 'failed' => false, 'deleted' => false, 'uid' => $uid];
3469 $condition['blocked'] = false;
3471 $condition['rel'] = [Contact::SHARING, Contact::FRIEND];
3474 // check if we search only communities or every contact
3475 if ($mode === 'community') {
3476 $condition['contact-type'] = self::TYPE_COMMUNITY;
3483 if (!empty($limit) && !empty($offset)) {
3484 $params['limit'] = [$offset, $limit];
3485 } elseif (!empty($limit)) {
3486 $params['limit'] = $limit;
3489 $condition = DBA::mergeConditions($condition,
3490 ["(NOT `unsearchable` OR `nurl` IN (SELECT `nurl` FROM `owner-view` WHERE `publish` OR `net-publish`))
3491 AND (`addr` LIKE ? OR `name` LIKE ? OR `nick` LIKE ?)", $search, $search, $search]);
3493 return self::selectToArray([], $condition, $params);
3497 * Add public contacts from an array
3499 * @param array $urls
3500 * @return array result "count", "added" and "updated"
3502 public static function addByUrls(array $urls): array
3509 foreach ($urls as $url) {
3510 if (empty($url) || !is_string($url)) {
3513 $contact = self::getByURL($url, false, ['id', 'network', 'next-update']);
3514 if (empty($contact['id']) && Network::isValidHttpUrl($url)) {
3515 Worker::add(Worker::PRIORITY_LOW, 'AddContact', 0, $url);
3517 } elseif (!empty($contact['network']) && Probe::isProbable($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
3518 Worker::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], 'UpdateContact', $contact['id']);
3526 return ['count' => $count, 'added' => $added, 'updated' => $updated, 'unchanged' => $unchanged];
3530 * Returns a random, global contact array of the current node
3532 * @return array The profile array
3535 public static function getRandomContact(): array
3537 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], [
3538 "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",
3539 0, Protocol::DFRN, DateTimeFormat::utc('now - 1 month'),
3540 ], ['order' => ['RAND()']]);
3542 if (DBA::isResult($contact)) {
3550 * Checks, if contacts with the given condition exists
3552 * @param array $condition
3555 * @throws \Exception
3557 public static function exists(array $condition): bool
3559 return DBA::exists('contact', $condition);