3 * @copyright Copyright (C) 2010-2023, 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\Conversation As ConversationContent;
27 use Friendica\Content\Pager;
28 use Friendica\Content\Text\HTML;
29 use Friendica\Core\Hook;
30 use Friendica\Core\Logger;
31 use Friendica\Core\Protocol;
32 use Friendica\Core\Renderer;
33 use Friendica\Core\System;
34 use Friendica\Core\Worker;
35 use Friendica\Database\Database;
36 use Friendica\Database\DBA;
38 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
39 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
40 use Friendica\Network\HTTPException;
41 use Friendica\Network\Probe;
42 use Friendica\Object\Image;
43 use Friendica\Protocol\Activity;
44 use Friendica\Protocol\ActivityPub;
45 use Friendica\Util\DateTimeFormat;
46 use Friendica\Util\HTTPSignature;
47 use Friendica\Util\Images;
48 use Friendica\Util\Network;
49 use Friendica\Util\Proxy;
50 use Friendica\Util\Strings;
51 use Friendica\Worker\UpdateContact;
54 * functions for interacting with a contact
58 const DEFAULT_AVATAR_PHOTO = '/images/person-300.jpg';
59 const DEFAULT_AVATAR_THUMB = '/images/person-80.jpg';
60 const DEFAULT_AVATAR_MICRO = '/images/person-48.jpg';
66 const LOCK_INSERT = 'contact-insert';
71 * TYPE_UNKNOWN - unknown type
73 * TYPE_PERSON - the account belongs to a person
74 * Associated page types: PAGE_NORMAL, PAGE_SOAPBOX, PAGE_FREELOVE
76 * TYPE_ORGANISATION - the account belongs to an organisation
77 * Associated page type: PAGE_SOAPBOX
79 * TYPE_NEWS - the account is a news reflector
80 * Associated page type: PAGE_SOAPBOX
82 * TYPE_COMMUNITY - the account is community forum
83 * Associated page types: PAGE_COMMUNITY, PAGE_PRVGROUP
85 * TYPE_RELAY - the account is a relay
86 * This will only be assigned to contacts, not to user accounts
89 const TYPE_UNKNOWN = -1;
90 const TYPE_PERSON = User::ACCOUNT_TYPE_PERSON;
91 const TYPE_ORGANISATION = User::ACCOUNT_TYPE_ORGANISATION;
92 const TYPE_NEWS = User::ACCOUNT_TYPE_NEWS;
93 const TYPE_COMMUNITY = User::ACCOUNT_TYPE_COMMUNITY;
94 const TYPE_RELAY = User::ACCOUNT_TYPE_RELAY;
105 const NOTHING = 0; // There is no relationship between the contact and the user
106 const FOLLOWER = 1; // The contact is following this user (the contact is the subscriber)
107 const SHARING = 2; // The contact shares their content with this user (the user is the subscriber)
108 const FRIEND = 3; // There is a mutual relationship between the contact and the user
109 const SELF = 4; // This is the user theirself
114 const MIRROR_DEACTIVATED = 0;
115 const MIRROR_FORWARDED = 1; // Deprecated, now does the same like MIRROR_OWN_POST
116 const MIRROR_OWN_POST = 2;
117 const MIRROR_NATIVE_RESHARE = 3;
120 * @param array $fields Array of selected fields, empty for all
121 * @param array $condition Array of fields for condition
122 * @param array $params Array of several parameters
126 public static function selectToArray(array $fields = [], array $condition = [], array $params = []): array
128 return DBA::selectToArray('contact', $fields, $condition, $params);
132 * @param array $fields Array of selected fields, empty for all
133 * @param array $condition Array of fields for condition
134 * @param array $params Array of several parameters
138 public static function selectFirst(array $fields = [], array $condition = [], array $params = [])
140 $contact = DBA::selectFirst('contact', $fields, $condition, $params);
146 * @param array $fields Array of selected fields, empty for all
147 * @param array $condition Array of fields for condition
148 * @param array $params Array of several parameters
152 public static function selectAccountToArray(array $fields = [], array $condition = [], array $params = []): array
154 return DBA::selectToArray('account-user-view', $fields, $condition, $params);
158 * @param array $fields Array of selected fields, empty for all
159 * @param array $condition Array of fields for condition
160 * @param array $params Array of several parameters
164 public static function selectFirstAccount(array $fields = [], array $condition = [], array $params = [])
166 return DBA::selectFirst('account-view', $fields, $condition, $params);
170 * Insert a row into the contact table
171 * Important: You can't use DBA::lastInsertId() after this call since it will be set to 0.
173 * @param array $fields field array
174 * @param int $duplicate_mode Do an update on a duplicate entry
176 * @return int id of the created contact
179 public static function insert(array $fields, int $duplicate_mode = Database::INSERT_DEFAULT): int
181 if (!empty($fields['baseurl']) && empty($fields['gsid'])) {
182 $fields['gsid'] = GServer::getID($fields['baseurl'], true);
185 $fields['uri-id'] = ItemURI::getIdByURI($fields['url']);
187 if (empty($fields['created'])) {
188 $fields['created'] = DateTimeFormat::utcNow();
191 $fields = DI::dbaDefinition()->truncateFieldsForTable('contact', $fields);
192 DBA::insert('contact', $fields, $duplicate_mode);
193 $contact = DBA::selectFirst('contact', [], ['id' => DBA::lastInsertId()]);
194 if (!DBA::isResult($contact)) {
196 Logger::warning('Created contact could not be found', ['fields' => $fields]);
200 $fields = DI::dbaDefinition()->truncateFieldsForTable('account-user', $contact);
201 DBA::insert('account-user', $fields, Database::INSERT_IGNORE);
202 $account_user = DBA::selectFirst('account-user', ['id'], ['uid' => $contact['uid'], 'uri-id' => $contact['uri-id']]);
203 if (empty($account_user['id'])) {
204 Logger::warning('Account-user entry not found', ['cid' => $contact['id'], 'uid' => $contact['uid'], 'uri-id' => $contact['uri-id'], 'url' => $contact['url']]);
205 } elseif ($account_user['id'] != $contact['id']) {
206 $duplicate = DBA::selectFirst('contact', [], ['id' => $account_user['id'], 'deleted' => false]);
207 if (!empty($duplicate['id'])) {
208 $ret = Contact::deleteById($contact['id']);
209 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']]);
210 $contact = $duplicate;
212 $ret = DBA::update('account-user', ['id' => $contact['id']], ['uid' => $contact['uid'], 'uri-id' => $contact['uri-id']]);
213 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']]);
217 Contact\User::insertForContactArray($contact);
219 return $contact['id'];
223 * Delete contact by id
228 public static function deleteById(int $id): bool
230 Logger::debug('Delete contact', ['id' => $id]);
231 DBA::delete('account-user', ['id' => $id]);
232 return DBA::delete('contact', ['id' => $id]);
236 * Updates rows in the contact table
238 * @param array $fields contains the fields that are updated
239 * @param array $condition condition array with the key values
240 * @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)
242 * @return boolean was the update successfull?
244 * @todo Let's get rid of boolean type of $old_fields
246 public static function update(array $fields, array $condition, $old_fields = [])
248 $fields = DI::dbaDefinition()->truncateFieldsForTable('contact', $fields);
249 $ret = DBA::update('contact', $fields, $condition, $old_fields);
251 // Apply changes to the "user-contact" table on dedicated fields
252 Contact\User::updateByContactUpdate($fields, $condition);
258 * @param integer $id Contact ID
259 * @param array $fields Array of selected fields, empty for all
260 * @return array|boolean Contact record if it exists, false otherwise
263 public static function getById(int $id, array $fields = [])
265 return DBA::selectFirst('contact', $fields, ['id' => $id]);
269 * Fetch the first contact with the provided uri-id.
271 * @param integer $uri_id uri-id of the contact
272 * @param array $fields Array of selected fields, empty for all
273 * @return array|boolean Contact record if it exists, false otherwise
276 public static function getByUriId(int $uri_id, array $fields = [])
278 return DBA::selectFirst('contact', $fields, ['uri-id' => $uri_id], ['order' => ['uid']]);
282 * Fetch all remote contacts for a given contact url
284 * @param string $url The URL of the contact
285 * @param array $fields The wanted fields
287 * @return array all remote contacts
291 public static function getVisitorByUrl(string $url, array $fields = ['id', 'uid']): array
295 $remote_contacts = DBA::select('contact', ['id', 'uid'], ['nurl' => Strings::normaliseLink($url), 'rel' => [Contact::FOLLOWER, Contact::FRIEND], 'self' => false]);
296 while ($contact = DBA::fetch($remote_contacts)) {
297 if (($contact['uid'] == 0) || Contact\User::isBlocked($contact['id'], $contact['uid'])) {
300 $remote[$contact['uid']] = $contact['id'];
302 DBA::close($remote_contacts);
308 * Fetches a contact by a given url
310 * @param string $url profile url
311 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
312 * @param array $fields Field list
313 * @param integer $uid User ID of the contact
314 * @return array contact array
316 public static function getByURL(string $url, $update = null, array $fields = [], int $uid = 0): array
318 if ($update || is_null($update)) {
319 $cid = self::getIdForURL($url, $uid, $update);
324 $contact = self::getById($cid, $fields);
325 if (empty($contact)) {
331 // Add internal fields
333 if (!empty($fields)) {
334 foreach (['id', 'next-update', 'network', 'local-data'] as $internal) {
335 if (!in_array($internal, $fields)) {
336 $fields[] = $internal;
337 $removal[] = $internal;
342 // We first try the nurl (http://server.tld/nick), most common case
343 $options = ['order' => ['id']];
344 $contact = DBA::selectFirst('contact', $fields, ['nurl' => Strings::normaliseLink($url), 'uid' => $uid, 'deleted' => false], $options);
346 // Then the addr (nick@server.tld)
347 if (!DBA::isResult($contact)) {
348 $contact = DBA::selectFirst('contact', $fields, ['addr' => str_replace('acct:', '', $url), 'uid' => $uid, 'deleted' => false], $options);
351 // Then the alias (which could be anything)
352 if (!DBA::isResult($contact)) {
353 // The link could be provided as http although we stored it as https
354 $ssl_url = str_replace('http://', 'https://', $url);
355 $condition = ['`alias` IN (?, ?, ?) AND `uid` = ? AND NOT `deleted`', $url, Strings::normaliseLink($url), $ssl_url, $uid];
356 $contact = DBA::selectFirst('contact', $fields, $condition, $options);
359 if (!DBA::isResult($contact)) {
363 $background_update = DI::config()->get('system', 'update_active_contacts') ? $contact['local-data'] : true;
365 // Update the contact in the background if needed
366 if ($background_update && !self::isLocal($url) && Probe::isProbable($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
368 UpdateContact::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], $contact['id']);
369 } catch (\InvalidArgumentException $e) {
370 Logger::notice($e->getMessage(), ['contact' => $contact]);
374 // Remove the internal fields
375 foreach ($removal as $internal) {
376 unset($contact[$internal]);
383 * Fetches a contact for a given user by a given url.
384 * In difference to "getByURL" the function will fetch a public contact when no user contact had been found.
386 * @param string $url profile url
387 * @param integer $uid User ID of the contact
388 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
389 * @param array $fields Field list
390 * @return array contact array
392 public static function getByURLForUser(string $url, int $uid = 0, $update = false, array $fields = []): array
395 $contact = self::getByURL($url, $update, $fields, $uid);
396 if (!empty($contact)) {
397 if (!empty($contact['id'])) {
398 $contact['cid'] = $contact['id'];
405 $contact = self::getByURL($url, $update, $fields);
406 if (!empty($contact['id'])) {
408 $contact['zid'] = $contact['id'];
414 * Checks if a contact uses a specific platform
417 * @param string $platform
420 public static function isPlatform(string $url, string $platform): bool
422 return DBA::exists('account-view', ['nurl' => Strings::normaliseLink($url), 'platform' => $platform]);
426 * Tests if the given contact is a follower
428 * @param int $cid Either public contact id or user's contact id
429 * @param int $uid User ID
430 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
432 * @return boolean is the contact id a follower?
433 * @throws HTTPException\InternalServerErrorException
434 * @throws \ImagickException
436 public static function isFollower(int $cid, int $uid, bool $strict = false): bool
438 if (Contact\User::isBlocked($cid, $uid)) {
442 $cdata = self::getPublicAndUserContactID($cid, $uid);
443 if (empty($cdata['user'])) {
447 $condition = ['id' => $cdata['user'], 'rel' => [self::FOLLOWER, self::FRIEND]];
449 $condition = array_merge($condition, ['pending' => false, 'readonly' => false, 'blocked' => false]);
451 return DBA::exists('contact', $condition);
455 * Tests if the given contact url is a follower
457 * @param string $url Contact URL
458 * @param int $uid User ID
459 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
461 * @return boolean is the contact id a follower?
462 * @throws HTTPException\InternalServerErrorException
463 * @throws \ImagickException
465 public static function isFollowerByURL(string $url, int $uid, bool $strict = false): bool
467 $cid = self::getIdForURL($url, $uid);
473 return self::isFollower($cid, $uid, $strict);
477 * Tests if the given user shares with the given contact
479 * @param int $cid Either public contact id or user's contact id
480 * @param int $uid User ID
481 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
483 * @return boolean is the contact sharing with given user?
484 * @throws HTTPException\InternalServerErrorException
485 * @throws \ImagickException
487 public static function isSharing(int $cid, int $uid, bool $strict = false): bool
489 if (Contact\User::isBlocked($cid, $uid)) {
493 $cdata = self::getPublicAndUserContactID($cid, $uid);
494 if (empty($cdata['user'])) {
498 $condition = ['id' => $cdata['user'], 'rel' => [self::SHARING, self::FRIEND]];
500 $condition = array_merge($condition, ['pending' => false, 'readonly' => false, 'blocked' => false]);
502 return DBA::exists('contact', $condition);
506 * Tests if the given user follow the given contact url
508 * @param string $url Contact URL
509 * @param int $uid User ID
510 * @param bool $strict If "true" then contact mustn't be set to pending or readonly
512 * @return boolean is the contact url being followed?
513 * @throws HTTPException\InternalServerErrorException
514 * @throws \ImagickException
516 public static function isSharingByURL(string $url, int $uid, bool $strict = false): bool
518 $cid = self::getIdForURL($url, $uid);
524 return self::isSharing($cid, $uid, $strict);
528 * Get the basepath for a given contact link
530 * @param string $url The contact link
531 * @param boolean $dont_update Don't update the contact
533 * @return string basepath
534 * @throws HTTPException\InternalServerErrorException
535 * @throws \ImagickException
537 public static function getBasepath(string $url, bool $dont_update = false): string
539 $contact = DBA::selectFirst('contact', ['id', 'baseurl'], ['uid' => 0, 'nurl' => Strings::normaliseLink($url)]);
540 if (!DBA::isResult($contact)) {
544 if (!empty($contact['baseurl'])) {
545 return $contact['baseurl'];
546 } elseif ($dont_update) {
550 // Update the existing contact
551 self::updateFromProbe($contact['id']);
553 // And fetch the result
554 $contact = DBA::selectFirst('contact', ['baseurl'], ['id' => $contact['id']]);
555 if (empty($contact['baseurl'])) {
556 Logger::info('No baseurl for contact', ['url' => $url]);
560 Logger::info('Found baseurl for contact', ['url' => $url, 'baseurl' => $contact['baseurl']]);
561 return $contact['baseurl'];
565 * Check if the given contact url is on the same server
567 * @param string $url The contact link
569 * @return boolean Is it the same server?
571 public static function isLocal(string $url): bool
573 if (!parse_url($url, PHP_URL_SCHEME)) {
574 $addr_parts = explode('@', $url);
575 return (count($addr_parts) == 2) && ($addr_parts[1] == DI::baseUrl()->getHostname());
578 return Strings::compareLink(self::getBasepath($url, true), DI::baseUrl());
582 * Check if the given contact ID is on the same server
584 * @param string $url The contact link
585 * @return boolean Is it the same server?
587 public static function isLocalById(int $cid): bool
589 $contact = DBA::selectFirst('contact', ['url', 'baseurl'], ['id' => $cid]);
590 if (!DBA::isResult($contact)) {
594 if (empty($contact['baseurl'])) {
595 $baseurl = self::getBasepath($contact['url'], true);
597 $baseurl = $contact['baseurl'];
600 return Strings::compareLink($baseurl, DI::baseUrl());
604 * Returns the public contact id of the given user id
606 * @param integer $uid User ID
608 * @return integer|boolean Public contact id for given user id
611 public static function getPublicIdByUserId(int $uid)
613 $self = DBA::selectFirst('contact', ['url'], ['self' => true, 'uid' => $uid]);
614 if (!DBA::isResult($self)) {
617 return self::getIdForURL($self['url']);
621 * Returns the contact id for the user and the public contact id for a given contact id
623 * @param int $cid Either public contact id or user's contact id
624 * @param int $uid User ID
626 * @return array with public and user's contact id
627 * @throws HTTPException\InternalServerErrorException
628 * @throws \ImagickException
630 public static function getPublicAndUserContactID(int $cid, int $uid): array
632 // We have to use the legacy function as long as the post update hasn't finished
633 if (DI::keyValue()->get('post_update_version') < 1427) {
634 return self::legacyGetPublicAndUserContactID($cid, $uid);
637 if (empty($uid) || empty($cid)) {
641 $contact = DBA::selectFirst('account-user-view', ['id', 'uid', 'pid'], ['id' => $cid]);
642 if (!DBA::isResult($contact) || !in_array($contact['uid'], [0, $uid])) {
646 $pcid = $contact['pid'];
647 if ($contact['uid'] == $uid) {
648 $ucid = $contact['id'];
650 $contact = DBA::selectFirst('account-user-view', ['id', 'uid'], ['pid' => $cid, 'uid' => $uid]);
651 if (DBA::isResult($contact)) {
652 $ucid = $contact['id'];
658 return ['public' => $pcid, 'user' => $ucid];
662 * Helper function for "getPublicAndUserContactID"
664 * @param int $cid Either public contact id or user's contact id
665 * @param int $uid User ID
666 * @return array with public and user's contact id
667 * @throws HTTPException\InternalServerErrorException
668 * @throws \ImagickException
670 private static function legacyGetPublicAndUserContactID(int $cid, int $uid): array
672 if (empty($uid) || empty($cid)) {
676 $contact = DBA::selectFirst('contact', ['id', 'uid', 'url'], ['id' => $cid]);
677 if (!DBA::isResult($contact)) {
681 // We quit when the user id don't match the user id of the provided contact
682 if (($contact['uid'] != $uid) && ($contact['uid'] != 0)) {
686 if ($contact['uid'] != 0) {
687 $pcid = self::getIdForURL($contact['url'], 0, false, ['url' => $contact['url']]);
691 $ucid = $contact['id'];
693 $pcid = $contact['id'];
694 $ucid = self::getIdForURL($contact['url'], $uid);
697 return ['public' => $pcid, 'user' => $ucid];
701 * Returns contact details for a given contact id in combination with a user id
703 * @param int $cid A contact ID
704 * @param int $uid The User ID
705 * @param array $fields The selected fields for the contact
706 * @return array The contact details
710 public static function getContactForUser(int $cid, int $uid, array $fields = []): array
712 $contact = DBA::selectFirst('contact', $fields, ['id' => $cid, 'uid' => $uid]);
714 if (!DBA::isResult($contact)) {
722 * Creates the self-contact for the provided user id
725 * @return bool Operation success
726 * @throws HTTPException\InternalServerErrorException
728 public static function createSelfFromUserId(int $uid): bool
730 $user = DBA::selectFirst('user', ['uid', 'username', 'nickname', 'pubkey', 'prvkey'],
731 ['uid' => $uid, 'account_expired' => false]);
732 if (!DBA::isResult($user)) {
737 'uid' => $user['uid'],
738 'created' => DateTimeFormat::utcNow(),
740 'name' => $user['username'],
741 'nick' => $user['nickname'],
742 'pubkey' => $user['pubkey'],
743 'prvkey' => $user['prvkey'],
744 'photo' => User::getAvatarUrl($user),
745 'thumb' => User::getAvatarUrl($user, Proxy::SIZE_THUMB),
746 'micro' => User::getAvatarUrl($user, Proxy::SIZE_MICRO),
749 'url' => DI::baseUrl() . '/profile/' . $user['nickname'],
750 'nurl' => Strings::normaliseLink(DI::baseUrl() . '/profile/' . $user['nickname']),
751 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
752 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
753 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
754 'poll' => DI::baseUrl() . '/dfrn_poll/' . $user['nickname'],
755 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
756 'name-date' => DateTimeFormat::utcNow(),
757 'uri-date' => DateTimeFormat::utcNow(),
758 'avatar-date' => DateTimeFormat::utcNow(),
764 // Only create the entry if it doesn't exist yet
765 if (!DBA::exists('contact', ['uid' => $uid, 'self' => true])) {
766 $return = (bool)self::insert($contact);
769 // Create the public contact
770 if (!DBA::exists('contact', ['nurl' => $contact['nurl'], 'uid' => 0])) {
771 $contact['self'] = false;
773 $contact['prvkey'] = null;
775 self::insert($contact, Database::INSERT_IGNORE);
782 * Updates the self-contact for the provided user id
785 * @param bool $update_avatar Force the avatar update
786 * @return bool "true" if updated
787 * @throws HTTPException\InternalServerErrorException
789 public static function updateSelfFromUserID(int $uid, bool $update_avatar = false): bool
791 $fields = ['id', 'uri-id', 'name', 'nick', 'location', 'about', 'keywords', 'avatar', 'prvkey', 'pubkey', 'manually-approve',
792 'xmpp', 'matrix', 'contact-type', 'forum', 'prv', 'avatar-date', 'url', 'nurl', 'unsearchable',
793 'photo', 'thumb', 'micro', 'header', 'addr', 'request', 'notify', 'poll', 'confirm', 'poco', 'network'];
794 $self = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
795 if (!DBA::isResult($self)) {
799 $fields = ['uid', 'nickname', 'page-flags', 'account-type', 'prvkey', 'pubkey'];
800 $user = DBA::selectFirst('user', $fields, ['uid' => $uid, 'account_expired' => false]);
801 if (!DBA::isResult($user)) {
805 $fields = ['name', 'photo', 'thumb', 'about', 'address', 'locality', 'region',
806 'country-name', 'pub_keywords', 'xmpp', 'matrix', 'net-publish'];
807 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid]);
808 if (!DBA::isResult($profile)) {
812 $file_suffix = 'jpg';
813 $url = DI::baseUrl() . '/profile/' . $user['nickname'];
816 'name' => $profile['name'],
817 'nick' => $user['nickname'],
818 'avatar-date' => $self['avatar-date'],
819 'location' => Profile::formatLocation($profile),
820 'about' => $profile['about'],
821 'keywords' => $profile['pub_keywords'],
822 'contact-type' => $user['account-type'],
823 'prvkey' => $user['prvkey'],
824 'pubkey' => $user['pubkey'],
825 'xmpp' => $profile['xmpp'],
826 'matrix' => $profile['matrix'],
827 'network' => Protocol::DFRN,
829 // it seems as if ported accounts can have wrong values, so we make sure that now everything is fine.
830 'nurl' => Strings::normaliseLink($url),
831 'uri-id' => ItemURI::getIdByURI($url),
832 'addr' => $user['nickname'] . '@' . substr(DI::baseUrl(), strpos(DI::baseUrl(), '://') + 3),
833 'request' => DI::baseUrl() . '/dfrn_request/' . $user['nickname'],
834 'notify' => DI::baseUrl() . '/dfrn_notify/' . $user['nickname'],
835 'poll' => DI::baseUrl() . '/dfrn_poll/'. $user['nickname'],
836 'confirm' => DI::baseUrl() . '/dfrn_confirm/' . $user['nickname'],
840 $avatar = Photo::selectFirst(['resource-id', 'type'], ['uid' => $uid, 'profile' => true]);
841 if (DBA::isResult($avatar)) {
842 if ($update_avatar) {
843 $fields['avatar-date'] = DateTimeFormat::utcNow();
846 // Creating the path to the avatar, beginning with the file suffix
847 $types = Images::supportedTypes();
848 if (isset($types[$avatar['type']])) {
849 $file_suffix = $types[$avatar['type']];
852 // We are adding a timestamp value so that other systems won't use cached content
853 $timestamp = strtotime($fields['avatar-date']);
855 $prefix = DI::baseUrl() . '/photo/' .$avatar['resource-id'] . '-';
856 $suffix = '.' . $file_suffix . '?ts=' . $timestamp;
858 $fields['photo'] = $prefix . '4' . $suffix;
859 $fields['thumb'] = $prefix . '5' . $suffix;
860 $fields['micro'] = $prefix . '6' . $suffix;
862 // We hadn't found a photo entry, so we use the default avatar
863 $fields['photo'] = self::getDefaultAvatar($fields, Proxy::SIZE_SMALL);
864 $fields['thumb'] = self::getDefaultAvatar($fields, Proxy::SIZE_THUMB);
865 $fields['micro'] = self::getDefaultAvatar($fields, Proxy::SIZE_MICRO);
868 $fields['avatar'] = User::getAvatarUrl($user);
869 $fields['header'] = User::getBannerUrl($user);
870 $fields['forum'] = $user['page-flags'] == User::PAGE_FLAGS_COMMUNITY;
871 $fields['prv'] = $user['page-flags'] == User::PAGE_FLAGS_PRVGROUP;
872 $fields['unsearchable'] = !$profile['net-publish'];
873 $fields['manually-approve'] = in_array($user['page-flags'], [User::PAGE_FLAGS_NORMAL, User::PAGE_FLAGS_PRVGROUP]);
877 foreach ($fields as $field => $content) {
878 if ($self[$field] != $content) {
884 if ($fields['name'] != $self['name']) {
885 $fields['name-date'] = DateTimeFormat::utcNow();
887 $fields['updated'] = DateTimeFormat::utcNow();
888 self::update($fields, ['id' => $self['id']]);
890 // Update the other contacts as well
891 unset($fields['prvkey']);
892 $fields['self'] = false;
893 self::update($fields, ['uri-id' => $self['uri-id'], 'self' => false]);
895 // Update the profile
897 'photo' => User::getAvatarUrl($user),
898 'thumb' => User::getAvatarUrl($user, Proxy::SIZE_THUMB)
901 DBA::update('profile', $fields, ['uid' => $uid]);
908 * Marks a contact for removal
910 * @param int $id contact id
912 * @throws HTTPException\InternalServerErrorException
914 public static function remove(int $id)
916 // We want just to make sure that we don't delete our "self" contact
917 $contact = DBA::selectFirst('contact', ['uri-id', 'photo', 'thumb', 'micro', 'uid'], ['id' => $id, 'self' => false]);
918 if (!DBA::isResult($contact)) {
922 DBA::delete('account-user', ['id' => $id]);
924 self::clearFollowerFollowingEndpointCache($contact['uid']);
926 // Archive the contact
927 self::update(['archive' => true, 'network' => Protocol::PHANTOM, 'rel' => self::NOTHING, 'deleted' => true], ['id' => $id]);
929 if (!DBA::exists('contact', ['uri-id' => $contact['uri-id'], 'deleted' => false])) {
930 Avatar::deleteCache($contact);
933 // Delete it in the background
934 Worker::add(Worker::PRIORITY_MEDIUM, 'Contact\Remove', $id);
938 * Unfollow the remote contact
940 * @param array $contact Target user-specific contact (uid != 0) array
942 * @throws HTTPException\InternalServerErrorException
943 * @throws \ImagickException
945 public static function unfollow(array $contact): void
947 if (empty($contact['network'])) {
948 throw new \InvalidArgumentException('Empty network in contact array');
951 if (empty($contact['uid'])) {
952 throw new \InvalidArgumentException('Unexpected public contact record');
955 if (in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
956 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
957 if (!empty($cdata['public'])) {
958 Worker::add(Worker::PRIORITY_HIGH, 'Contact\Unfollow', $cdata['public'], $contact['uid']);
962 self::removeSharer($contact);
966 * Revoke follow privileges of the remote user contact
968 * The local relationship is updated immediately, the eventual remote server is messaged in the background.
970 * @param array $contact User-specific contact array (uid != 0) to revoke the follow from
972 * @throws HTTPException\InternalServerErrorException
973 * @throws \ImagickException
975 public static function revokeFollow(array $contact): void
977 if (empty($contact['network'])) {
978 throw new \InvalidArgumentException('Empty network in contact array');
981 if (empty($contact['uid'])) {
982 throw new \InvalidArgumentException('Unexpected public contact record');
985 if (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND])) {
986 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
987 if (!empty($cdata['public'])) {
988 Worker::add(Worker::PRIORITY_HIGH, 'Contact\RevokeFollow', $cdata['public'], $contact['uid']);
992 self::removeFollower($contact);
996 * Completely severs a relationship with a contact
998 * @param array $contact User-specific contact (uid != 0) array
1000 * @throws HTTPException\InternalServerErrorException
1001 * @throws \ImagickException
1003 public static function terminateFriendship(array $contact)
1005 if (empty($contact['network'])) {
1006 throw new \InvalidArgumentException('Empty network in contact array');
1009 if (empty($contact['uid'])) {
1010 throw new \InvalidArgumentException('Unexpected public contact record');
1013 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
1015 if (in_array($contact['rel'], [self::SHARING, self::FRIEND]) && !empty($cdata['public'])) {
1016 Worker::add(Worker::PRIORITY_HIGH, 'Contact\Unfollow', $cdata['public'], $contact['uid']);
1019 if (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) && !empty($cdata['public'])) {
1020 Worker::add(Worker::PRIORITY_HIGH, 'Contact\RevokeFollow', $cdata['public'], $contact['uid']);
1023 self::remove($contact['id']);
1026 private static function clearFollowerFollowingEndpointCache(int $uid)
1032 DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_CONTACTS . 'followers:' . $uid);
1033 DI::cache()->delete(ActivityPub\Transmitter::CACHEKEY_CONTACTS . 'following:' . $uid);
1037 * Marks a contact for archival after a communication issue delay
1039 * Contact has refused to recognise us as a friend. We will start a countdown.
1040 * If they still don't recognise us in 32 days, the relationship is over,
1041 * and we won't waste any more time trying to communicate with them.
1042 * This provides for the possibility that their database is temporarily messed
1043 * up or some other transient event and that there's a possibility we could recover from it.
1045 * @param array $contact contact to mark for archival
1047 * @throws HTTPException\InternalServerErrorException
1049 public static function markForArchival(array $contact)
1051 if (!isset($contact['url']) && !empty($contact['id'])) {
1052 $fields = ['id', 'url', 'archive', 'self', 'term-date'];
1053 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
1054 if (!DBA::isResult($contact)) {
1057 } elseif (!isset($contact['url'])) {
1058 Logger::info('Empty contact', ['contact' => $contact, 'callstack' => System::callstack(20)]);
1061 Logger::info('Contact is marked for archival', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
1063 // Contact already archived or "self" contact? => nothing to do
1064 if ($contact['archive'] || $contact['self']) {
1068 if ($contact['term-date'] <= DBA::NULL_DATETIME) {
1069 self::update(['term-date' => DateTimeFormat::utcNow()], ['id' => $contact['id']]);
1070 self::update(['term-date' => DateTimeFormat::utcNow()], ['`nurl` = ? AND `term-date` <= ? AND NOT `self`', Strings::normaliseLink($contact['url']), DBA::NULL_DATETIME]);
1073 * We really should send a notification to the owner after 2-3 weeks
1074 * so they won't be surprised when the contact vanishes and can take
1075 * remedial action if this was a serious mistake or glitch
1078 /// @todo Check for contact vitality via probing
1079 $archival_days = DI::config()->get('system', 'archival_days', 32);
1081 $expiry = $contact['term-date'] . ' + ' . $archival_days . ' days ';
1082 if (DateTimeFormat::utcNow() > DateTimeFormat::utc($expiry)) {
1083 /* Relationship is really truly dead. archive them rather than
1084 * delete, though if the owner tries to unarchive them we'll start
1085 * the whole process over again.
1087 self::update(['archive' => true], ['id' => $contact['id']]);
1088 self::update(['archive' => true], ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
1094 * Cancels the archival countdown
1096 * @see Contact::markForArchival()
1098 * @param array $contact contact to be unmarked for archival
1100 * @throws \Exception
1102 public static function unmarkForArchival(array $contact)
1104 // Always unarchive the relay contact entry
1105 if (!empty($contact['batch']) && !empty($contact['term-date']) && ($contact['term-date'] > DBA::NULL_DATETIME)) {
1106 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
1107 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1108 if (!DBA::exists('contact', array_merge($condition, $fields))) {
1109 self::update($fields, $condition);
1113 $condition = ['`id` = ? AND (`term-date` > ? OR `archive`)', $contact['id'], DBA::NULL_DATETIME];
1114 $exists = DBA::exists('contact', $condition);
1116 // We don't need to update, we never marked this contact for archival
1121 Logger::info('Contact is marked as vital again', ['id' => $contact['id'], 'term-date' => $contact['term-date']]);
1123 if (!isset($contact['url']) && !empty($contact['id'])) {
1124 $fields = ['id', 'url', 'batch'];
1125 $contact = DBA::selectFirst('contact', $fields, ['id' => $contact['id']]);
1126 if (!DBA::isResult($contact)) {
1131 // It's a miracle. Our dead contact has inexplicably come back to life.
1132 $fields = ['failed' => false, 'term-date' => DBA::NULL_DATETIME, 'archive' => false];
1133 self::update($fields, ['id' => $contact['id']]);
1134 self::update($fields, ['nurl' => Strings::normaliseLink($contact['url']), 'self' => false]);
1138 * Returns the data array for the photo menu of a given contact
1140 * @param array $contact contact
1141 * @param int $uid Visitor user id
1143 * @throws HTTPException\InternalServerErrorException
1144 * @throws \ImagickException
1146 public static function photoMenu(array $contact, int $uid): array
1148 // Anonymous visitor
1150 return ['profile' => [DI::l10n()->t('View Profile'), self::magicLinkByContact($contact), true]];
1158 if (($contact['network'] === Protocol::DFRN) && !$contact['self'] && empty($contact['pending'])) {
1160 $profile_link = 'contact/redir/' . $contact['id'];
1162 $profile_link = $contact['url'];
1165 if ($profile_link === 'mailbox') {
1170 $status_link = $profile_link . '/status';
1171 $photos_link = $profile_link . '/photos';
1172 $profile_link = $profile_link . '/profile';
1175 if (self::canReceivePrivateMessages($contact) && empty($contact['pending'])) {
1176 $pm_url = 'message/new/' . $contact['id'];
1179 $contact_url = 'contact/' . $contact['id'];
1180 $posts_link = 'contact/' . $contact['id'] . '/conversations';
1183 $unfollow_link = '';
1184 if (!$contact['self'] && Protocol::supportsFollow($contact['network'])) {
1185 if ($contact['uid'] && in_array($contact['rel'], [self::SHARING, self::FRIEND])) {
1186 $unfollow_link = 'contact/unfollow?url=' . urlencode($contact['url']) . '&auto=1';
1187 } elseif (!$contact['pending']) {
1188 $follow_link = 'contact/follow?url=' . urlencode($contact['url']) . '&auto=1';
1194 * "name" => [ "Label", "link", (bool)Should the link opened in a new tab? ]
1196 if (empty($contact['uid'])) {
1198 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true ],
1199 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1200 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1201 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true ],
1202 'unfollow' => [DI::l10n()->t('Unfollow') , $unfollow_link, true ],
1206 'status' => [DI::l10n()->t('View Status') , $status_link , true ],
1207 'profile' => [DI::l10n()->t('View Profile') , $profile_link , true ],
1208 'photos' => [DI::l10n()->t('View Photos') , $photos_link , true ],
1209 'network' => [DI::l10n()->t('Network Posts') , $posts_link , false],
1210 'edit' => [DI::l10n()->t('View Contact') , $contact_url , false],
1211 'pm' => [DI::l10n()->t('Send PM') , $pm_url , false],
1212 'follow' => [DI::l10n()->t('Connect/Follow'), $follow_link , true ],
1213 'unfollow' => [DI::l10n()->t('Unfollow') , $unfollow_link, true ],
1216 if (!empty($contact['pending'])) {
1218 $intro = DI::intro()->selectForContact($contact['id']);
1219 $menu['follow'] = [DI::l10n()->t('Approve'), 'notifications/intros/' . $intro->id, true];
1220 } catch (IntroductionNotFoundException $exception) {
1221 DI::logger()->error('Pending contact doesn\'t have an introduction.', ['exception' => $exception]);
1226 $args = ['contact' => $contact, 'menu' => &$menu];
1228 Hook::callAll('contact_photo_menu', $args);
1230 $menucondensed = [];
1232 foreach ($menu as $menuname => $menuitem) {
1233 if ($menuitem[1] != '') {
1234 $menucondensed[$menuname] = $menuitem;
1238 return $menucondensed;
1242 * Fetch the contact id for a given URL and user
1244 * First lookup in the contact table to find a record matching either `url`, `nurl`,
1245 * `addr` or `alias`.
1247 * If there's no record and we aren't looking for a public contact, we quit.
1248 * If there's one, we check that it isn't time to update the picture else we
1249 * directly return the found contact id.
1251 * Second, we probe the provided $url whether it's http://server.tld/profile or
1252 * nick@server.tld. We quit if we can't get any info back.
1254 * Third, we create the contact record if it doesn't exist
1256 * Fourth, we update the existing record with the new data (avatar, alias, nick)
1257 * if there's any updates
1259 * @param string $url Contact URL
1260 * @param integer $uid The user id for the contact (0 = public contact)
1261 * @param boolean $update true = always update, false = never update, null = update when not found
1262 * @param array $default Default value for creating the contact when everything else fails
1264 * @return integer Contact ID
1265 * @throws HTTPException\InternalServerErrorException
1266 * @throws \ImagickException
1268 public static function getIdForURL(string $url = null, int $uid = 0, $update = null, array $default = []): int
1273 Logger::notice('Empty url, quitting', ['url' => $url, 'user' => $uid, 'default' => $default]);
1277 $contact = self::getByURL($url, false, ['id', 'network', 'uri-id', 'next-update', 'local-data'], $uid);
1279 if (!empty($contact)) {
1280 $contact_id = $contact['id'];
1282 $background_update = DI::config()->get('system', 'update_active_contacts') ? $contact['local-data'] : true;
1284 if ($background_update && !self::isLocal($url) && Probe::isProbable($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
1286 UpdateContact::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], $contact['id']);
1287 } catch (\InvalidArgumentException $e) {
1288 Logger::notice($e->getMessage(), ['contact' => $contact]);
1292 if (empty($update) && (!empty($contact['uri-id']) || is_bool($update))) {
1293 Logger::debug('Contact found', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1296 } elseif ($uid != 0) {
1297 Logger::debug('Contact does not exist for the user', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1299 } elseif (empty($default) && !is_null($update) && !$update) {
1300 Logger::info('Contact not found, update not desired', ['url' => $url, 'uid' => $uid, 'update' => $update]);
1306 if (empty($default['network']) || $update) {
1307 $data = Probe::uri($url, '', $uid);
1309 // Take the default values when probing failed
1310 if (!empty($default) && !in_array($data['network'], array_merge(Protocol::NATIVE_SUPPORT, [Protocol::PUMPIO]))) {
1311 $data = array_merge($data, $default);
1313 } elseif (!empty($default['network'])) {
1317 if (($uid == 0) && (empty($data['network']) || ($data['network'] == Protocol::PHANTOM))) {
1318 // Fetch data for the public contact via the first found personal contact
1319 /// @todo Check if this case can happen at all (possibly with mail accounts?)
1320 $fields = ['name', 'nick', 'url', 'addr', 'alias', 'avatar', 'header', 'contact-type',
1321 'keywords', 'location', 'about', 'unsearchable', 'batch', 'notify', 'poll',
1322 'request', 'confirm', 'poco', 'subscribe', 'network', 'baseurl', 'gsid'];
1324 $personal_contact = DBA::selectFirst('contact', $fields, ["`addr` = ? AND `uid` != 0", $url]);
1325 if (!DBA::isResult($personal_contact)) {
1326 $personal_contact = DBA::selectFirst('contact', $fields, ["`nurl` = ? AND `uid` != 0", Strings::normaliseLink($url)]);
1329 if (DBA::isResult($personal_contact)) {
1330 Logger::info('Take contact data from personal contact', ['url' => $url, 'update' => $update, 'contact' => $personal_contact, 'callstack' => System::callstack(20)]);
1331 $data = $personal_contact;
1332 $data['photo'] = $personal_contact['avatar'];
1333 $data['account-type'] = $personal_contact['contact-type'];
1334 $data['hide'] = $personal_contact['unsearchable'];
1335 unset($data['avatar']);
1336 unset($data['contact-type']);
1337 unset($data['unsearchable']);
1341 if (empty($data['network']) || ($data['network'] == Protocol::PHANTOM)) {
1342 Logger::notice('No valid network found', ['url' => $url, 'uid' => $uid, 'default' => $default, 'update' => $update, 'callstack' => System::callstack(20)]);
1346 if (!$contact_id && !empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1347 Logger::info('Contact is a tombstone. It will not be inserted', ['url' => $url, 'uid' => $uid]);
1352 $urls = [Strings::normaliseLink($url), Strings::normaliseLink($data['url'])];
1353 if (!empty($data['alias'])) {
1354 $urls[] = Strings::normaliseLink($data['alias']);
1356 $contact = self::selectFirst(['id'], ['nurl' => $urls, 'uid' => $uid]);
1357 if (!empty($contact['id'])) {
1358 $contact_id = $contact['id'];
1359 Logger::info('Fetched id by url', ['cid' => $contact_id, 'uid' => $uid, 'url' => $url, 'data' => $data]);
1364 // We only insert the basic data. The rest will be done in "updateFromProbeArray"
1367 'url' => $data['url'],
1368 'nurl' => Strings::normaliseLink($data['url']),
1369 'network' => $data['network'],
1370 'created' => DateTimeFormat::utcNow(),
1371 'rel' => self::SHARING,
1378 $condition = ['nurl' => Strings::normaliseLink($data['url']), 'uid' => $uid, 'deleted' => false];
1380 // Before inserting we do check if the entry does exist now.
1381 $contact = DBA::selectFirst('contact', ['id'], $condition, ['order' => ['id']]);
1382 if (DBA::isResult($contact)) {
1383 $contact_id = $contact['id'];
1384 Logger::notice('Contact had been created (shortly) before', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1386 $contact_id = self::insert($fields);
1388 Logger::info('Contact inserted', ['id' => $contact_id, 'url' => $url, 'uid' => $uid]);
1393 Logger::warning('Contact was not inserted', ['url' => $url, 'uid' => $uid]);
1397 Logger::info('Contact will be updated', ['url' => $url, 'uid' => $uid, 'update' => $update, 'cid' => $contact_id]);
1400 if ($data['network'] == Protocol::DIASPORA) {
1402 DI::dsprContact()->updateFromProbeArray($data);
1403 } catch (HTTPException\NotFoundException $e) {
1404 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data]);
1405 } catch (\InvalidArgumentException $e) {
1406 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data]);
1408 } elseif (!empty($data['networks'][Protocol::DIASPORA])) {
1410 DI::dsprContact()->updateFromProbeArray($data['networks'][Protocol::DIASPORA]);
1411 } catch (HTTPException\NotFoundException $e) {
1412 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data['networks'][Protocol::DIASPORA]]);
1413 } catch (\InvalidArgumentException $e) {
1414 Logger::notice($e->getMessage(), ['url' => $url, 'data' => $data['networks'][Protocol::DIASPORA]]);
1418 self::updateFromProbeArray($contact_id, $data);
1420 // Don't return a number for a deleted account
1421 if (!empty($data['account-type']) && $data['account-type'] == User::ACCOUNT_TYPE_DELETED) {
1422 Logger::info('Contact is a tombstone', ['url' => $url, 'uid' => $uid]);
1430 * Checks if the contact is archived
1432 * @param int $cid contact id
1434 * @return boolean Is the contact archived?
1435 * @throws HTTPException\InternalServerErrorException
1437 public static function isArchived(int $cid): bool
1443 $contact = DBA::selectFirst('contact', ['archive', 'url', 'batch'], ['id' => $cid]);
1444 if (!DBA::isResult($contact)) {
1448 if ($contact['archive']) {
1452 // Check status of ActivityPub endpoints
1453 $apcontact = APContact::getByURL($contact['url'], false);
1454 if (!empty($apcontact)) {
1455 if (!empty($apcontact['inbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['inbox']])) {
1459 if (!empty($apcontact['sharedinbox']) && DBA::exists('inbox-status', ['archive' => true, 'url' => $apcontact['sharedinbox']])) {
1464 // Check status of Diaspora endpoints
1465 if (!empty($contact['batch'])) {
1466 $condition = ['archive' => true, 'uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => self::TYPE_RELAY];
1467 return DBA::exists('contact', $condition);
1474 * Checks if the contact is blocked
1476 * @param int $cid contact id
1477 * @return boolean Is the contact blocked?
1478 * @throws HTTPException\InternalServerErrorException
1480 public static function isBlocked(int $cid): bool
1486 $blocked = DBA::selectFirst('contact', ['blocked', 'url'], ['id' => $cid]);
1487 if (!DBA::isResult($blocked)) {
1491 if (Network::isUrlBlocked($blocked['url'])) {
1495 return (bool) $blocked['blocked'];
1499 * Checks if the contact is hidden
1501 * @param int $cid contact id
1502 * @return boolean Is the contact hidden?
1503 * @throws \Exception
1505 public static function isHidden(int $cid): bool
1511 $hidden = DBA::selectFirst('contact', ['hidden'], ['id' => $cid]);
1512 if (!DBA::isResult($hidden)) {
1515 return (bool) $hidden['hidden'];
1519 * Returns posts from a given contact url
1521 * @param string $contact_url Contact URL
1522 * @param bool $thread_mode
1523 * @param int $update Update mode
1524 * @param int $parent Item parent ID for the update mode
1525 * @param bool $only_media Only display media content
1526 * @return string posts in HTML
1527 * @throws \Exception
1529 public static function getPostsFromUrl(string $contact_url, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1531 return self::getPostsFromId(self::getIdForURL($contact_url), $thread_mode, $update, $parent, $only_media);
1535 * Returns posts from a given contact id
1537 * @param int $cid Contact ID
1538 * @param bool $thread_mode
1539 * @param int $update Update mode
1540 * @param int $parent Item parent ID for the update mode
1541 * @param bool $only_media Only display media content
1542 * @return string posts in HTML
1543 * @throws \Exception
1545 public static function getPostsFromId(int $cid, bool $thread_mode = false, int $update = 0, int $parent = 0, bool $only_media = false): string
1547 $contact = DBA::selectFirst('contact', ['contact-type', 'network'], ['id' => $cid]);
1548 if (!DBA::isResult($contact)) {
1552 if (empty($contact["network"]) || in_array($contact["network"], Protocol::FEDERATED)) {
1553 $sql = "(`uid` = 0 OR (`uid` = ? AND NOT `global`))";
1558 $contact_field = ((($contact["contact-type"] == self::TYPE_COMMUNITY) || ($contact['network'] == Protocol::MAIL)) ? 'owner-id' : 'author-id');
1561 $condition = ["((`$contact_field` = ? AND `gravity` = ?) OR (`author-id` = ? AND `gravity` = ? AND `vid` = ? AND `protocol` != ? AND `thr-parent-id` = `parent-uri-id`)) AND " . $sql,
1562 $cid, Item::GRAVITY_PARENT, $cid, Item::GRAVITY_ACTIVITY, Verb::getID(Activity::ANNOUNCE), Conversation::PARCEL_DIASPORA, DI::userSession()->getLocalUserId()];
1564 $condition = ["`$contact_field` = ? AND `gravity` IN (?, ?) AND " . $sql,
1565 $cid, Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT, DI::userSession()->getLocalUserId()];
1568 if (!empty($parent)) {
1569 $condition = DBA::mergeConditions($condition, ['parent' => $parent]);
1571 $last_received = isset($_GET['last_received']) ? DateTimeFormat::utc($_GET['last_received']) : '';
1572 if (!empty($last_received)) {
1573 $condition = DBA::mergeConditions($condition, ["`received` < ?", $last_received]);
1578 $condition = DBA::mergeConditions($condition, ["`uri-id` IN (SELECT `uri-id` FROM `post-media` WHERE `type` IN (?, ?, ?))",
1579 Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO]);
1582 if (DI::mode()->isMobile()) {
1583 $itemsPerPage = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'itemspage_mobile_network',
1584 DI::config()->get('system', 'itemspage_network_mobile'));
1586 $itemsPerPage = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'itemspage_network',
1587 DI::config()->get('system', 'itemspage_network'));
1590 $pager = new Pager(DI::l10n(), DI::args()->getQueryString(), $itemsPerPage);
1592 $params = ['order' => ['received' => true], 'limit' => [$pager->getStart(), $pager->getItemsPerPage()]];
1594 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'infinite_scroll')) {
1595 $tpl = Renderer::getMarkupTemplate('infinite_scroll_head.tpl');
1596 $o = Renderer::replaceMacros($tpl, ['$reload_uri' => DI::args()->getQueryString()]);
1602 $fields = ['uri-id', 'thr-parent-id', 'gravity', 'author-id', 'commented'];
1603 $items = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1605 if ($pager->getStart() == 0) {
1606 $cdata = self::getPublicAndUserContactID($cid, DI::userSession()->getLocalUserId());
1607 if (!empty($cdata['public'])) {
1608 $pinned = Post\Collection::selectToArrayForContact($cdata['public'], Post\Collection::FEATURED, $fields);
1609 $items = array_merge($items, $pinned);
1613 $o .= DI::conversation()->create($items, ConversationContent::MODE_CONTACTS, $update, false, 'pinned_commented', DI::userSession()->getLocalUserId());
1615 $fields = array_merge(Item::DISPLAY_FIELDLIST, ['featured']);
1616 $items = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1618 if ($pager->getStart() == 0) {
1619 $cdata = self::getPublicAndUserContactID($cid, DI::userSession()->getLocalUserId());
1620 if (!empty($cdata['public'])) {
1621 $condition = ["`uri-id` IN (SELECT `uri-id` FROM `collection-view` WHERE `cid` = ? AND `type` = ?)",
1622 $cdata['public'], Post\Collection::FEATURED];
1623 $pinned = Post::toArray(Post::selectForUser(DI::userSession()->getLocalUserId(), $fields, $condition, $params));
1624 $items = array_merge($pinned, $items);
1628 $o .= DI::conversation()->create($items, ConversationContent::MODE_CONTACT_POSTS, $update);
1632 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'infinite_scroll')) {
1633 $o .= HTML::scrollLoader();
1635 $o .= $pager->renderMinimal(count($items));
1643 * Returns the account type name
1645 * The function can be called with either the user or the contact array
1647 * @param int $type type of contact or account
1650 public static function getAccountType(int $type): string
1653 case self::TYPE_ORGANISATION:
1654 $account_type = DI::l10n()->t("Organisation");
1657 case self::TYPE_NEWS:
1658 $account_type = DI::l10n()->t('News');
1661 case self::TYPE_COMMUNITY:
1662 $account_type = DI::l10n()->t("Forum");
1670 return $account_type;
1676 * @param int $cid Contact id to block
1677 * @param string $reason Block reason
1678 * @return bool Whether it was successful
1680 public static function block(int $cid, string $reason = null): bool
1682 $return = self::update(['blocked' => true, 'block_reason' => $reason], ['id' => $cid]);
1688 * Unblocks a contact
1690 * @param int $cid Contact id to unblock
1691 * @return bool Whether it was successfull
1693 public static function unblock(int $cid): bool
1695 $return = self::update(['blocked' => false, 'block_reason' => null], ['id' => $cid]);
1701 * Ensure that cached avatar exist
1703 * @param integer $cid Contact id
1705 public static function checkAvatarCache(int $cid)
1707 $contact = DBA::selectFirst('contact', ['url', 'network', 'avatar', 'photo', 'thumb', 'micro'], ['id' => $cid, 'uid' => 0, 'self' => false]);
1708 if (!DBA::isResult($contact)) {
1712 if (Network::isLocalLink($contact['url'])) {
1716 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || DI::config()->get('system', 'cache_contact_avatar')) {
1717 if (!empty($contact['avatar']) && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1718 Logger::info('Adding avatar cache', ['id' => $cid, 'contact' => $contact]);
1719 self::updateAvatar($cid, $contact['avatar'], true);
1722 } elseif (Photo::isPhotoURI($contact['photo']) || Photo::isPhotoURI($contact['thumb']) || Photo::isPhotoURI($contact['micro'])) {
1723 Logger::info('Replacing legacy avatar cache', ['id' => $cid, 'contact' => $contact]);
1724 self::updateAvatar($cid, $contact['avatar'], true);
1726 } elseif (DI::config()->get('system', 'avatar_cache') && (empty($contact['photo']) || empty($contact['thumb']) || empty($contact['micro']))) {
1727 Logger::info('Adding avatar cache file', ['id' => $cid, 'contact' => $contact]);
1728 self::updateAvatar($cid, $contact['avatar'], true);
1734 * Return the photo path for a given contact array in the given size
1736 * @param array $contact contact array
1737 * @param string $size Size of the avatar picture
1738 * @param bool $no_update Don't perfom an update if no cached avatar was found
1739 * @return string photo path
1741 private static function getAvatarPath(array $contact, string $size, bool $no_update = false): string
1743 $contact = self::checkAvatarCacheByArray($contact, $no_update);
1745 if (DI::config()->get('system', 'avatar_cache')) {
1747 case Proxy::SIZE_MICRO:
1748 if (!empty($contact['micro']) && !Photo::isPhotoURI($contact['micro'])) {
1749 return $contact['micro'];
1752 case Proxy::SIZE_THUMB:
1753 if (!empty($contact['thumb']) && !Photo::isPhotoURI($contact['thumb'])) {
1754 return $contact['thumb'];
1757 case Proxy::SIZE_SMALL:
1758 if (!empty($contact['photo']) && !Photo::isPhotoURI($contact['photo'])) {
1759 return $contact['photo'];
1765 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
1769 * Return the photo path for a given contact array
1771 * @param array $contact Contact array
1772 * @param bool $no_update Don't perfom an update if no cached avatar was found
1773 * @return string photo path
1775 public static function getPhoto(array $contact, bool $no_update = false): string
1777 return self::getAvatarPath($contact, Proxy::SIZE_SMALL, $no_update);
1781 * Return the photo path (thumb size) for a given contact array
1783 * @param array $contact Contact array
1784 * @param bool $no_update Don't perfom an update if no cached avatar was found
1785 * @return string photo path
1787 public static function getThumb(array $contact, bool $no_update = false): string
1789 return self::getAvatarPath($contact, Proxy::SIZE_THUMB, $no_update);
1793 * Return the photo path (micro size) for a given contact array
1795 * @param array $contact Contact array
1796 * @param bool $no_update Don't perfom an update if no cached avatar was found
1797 * @return string photo path
1799 public static function getMicro(array $contact, bool $no_update = false): string
1801 return self::getAvatarPath($contact, Proxy::SIZE_MICRO, $no_update);
1805 * Check the given contact array for avatar cache fields
1807 * @param array $contact
1808 * @param bool $no_update Don't perfom an update if no cached avatar was found
1809 * @return array contact array with avatar cache fields
1811 private static function checkAvatarCacheByArray(array $contact, bool $no_update = false): array
1814 $contact_fields = [];
1815 $fields = ['photo', 'thumb', 'micro'];
1816 foreach ($fields as $field) {
1817 if (isset($contact[$field])) {
1818 $contact_fields[] = $field;
1820 if (isset($contact[$field]) && empty($contact[$field])) {
1825 if (!$update || $no_update) {
1829 $local = !empty($contact['url']) && Network::isLocalLink($contact['url']);
1831 if (!$local && !empty($contact['id']) && !empty($contact['avatar'])) {
1832 self::updateAvatar($contact['id'], $contact['avatar'], true);
1834 $new_contact = self::getById($contact['id'], $contact_fields);
1835 if (DBA::isResult($new_contact)) {
1836 // We only update the cache fields
1837 $contact = array_merge($contact, $new_contact);
1839 } elseif ($local && !empty($contact['avatar'])) {
1843 /// add the default avatars if the fields aren't filled
1844 if (isset($contact['photo']) && empty($contact['photo'])) {
1845 $contact['photo'] = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
1847 if (isset($contact['thumb']) && empty($contact['thumb'])) {
1848 $contact['thumb'] = self::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
1850 if (isset($contact['micro']) && empty($contact['micro'])) {
1851 $contact['micro'] = self::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
1858 * Fetch the default header for the given contact
1860 * @param array $contact contact array
1861 * @return string avatar URL
1863 public static function getDefaultHeader(array $contact): string
1865 if (!empty($contact['header'])) {
1866 return $contact['header'];
1869 if (!empty($contact['gsid'])) {
1870 // Use default banners for certain platforms
1871 $gserver = DBA::selectFirst('gserver', ['platform'], ['id' => $contact['gsid']]);
1872 $platform = strtolower($gserver['platform'] ?? '');
1877 switch ($platform) {
1882 * @author Lostinlight <https://mastodon.xyz/@lightone>
1883 * @license CC0 https://creativecommons.org/share-your-work/public-domain/cc0/
1884 * @link https://gitlab.com/lostinlight/per_aspera_ad_astra/-/blob/master/friendica-404/friendica-promo-bubbles.jpg
1886 $header = DI::baseUrl() . '/images/friendica-banner.jpg';
1891 * @author John Liu <https://www.flickr.com/photos/8047705@N02/>
1892 * @license CC BY 2.0 https://creativecommons.org/licenses/by/2.0/
1893 * @link https://www.flickr.com/photos/8047705@N02/5572197407
1895 $header = DI::baseUrl() . '/images/diaspora-banner.jpg';
1899 * Use a random picture.
1900 * The service provides random pictures from Unsplash.
1901 * @license https://unsplash.com/license
1903 $header = 'https://picsum.photos/seed/' . hash('ripemd128', $contact['url']) . '/960/300';
1911 * Fetch the default avatar for the given contact and size
1913 * @param array $contact contact array
1914 * @param string $size Size of the avatar picture
1915 * @return string avatar URL
1917 public static function getDefaultAvatar(array $contact, string $size): string
1920 case Proxy::SIZE_MICRO:
1921 $avatar['size'] = 48;
1922 $default = self::DEFAULT_AVATAR_MICRO;
1925 case Proxy::SIZE_THUMB:
1926 $avatar['size'] = 80;
1927 $default = self::DEFAULT_AVATAR_THUMB;
1930 case Proxy::SIZE_SMALL:
1932 $avatar['size'] = 300;
1933 $default = self::DEFAULT_AVATAR_PHOTO;
1937 if (!DI::config()->get('system', 'remote_avatar_lookup')) {
1939 $type = Contact::TYPE_PERSON;
1941 if (!empty($contact['id'])) {
1942 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['id' => $contact['id']]);
1943 $platform = $account['platform'] ?? '';
1944 $type = $account['contact-type'] ?? Contact::TYPE_PERSON;
1947 if (empty($platform) && !empty($contact['uri-id'])) {
1948 $account = DBA::selectFirst('account-user-view', ['platform', 'contact-type'], ['uri-id' => $contact['uri-id']]);
1949 $platform = $account['platform'] ?? '';
1950 $type = $account['contact-type'] ?? Contact::TYPE_PERSON;
1953 switch ($platform) {
1957 * @license GNU Affero General Public License v3.0
1958 * @link https://github.com/msdos621/corgidon/blob/main/public/avatars/original/missing.png
1960 $default = '/images/default/corgidon.png';
1966 * @license GNU Affero General Public License v3.0
1967 * @link https://github.com/diaspora/diaspora/
1969 $default = '/images/default/diaspora.png';
1975 * @license GNU Affero General Public License v3.0
1976 * @link https://github.com/superseriousbusiness/gotosocial/blob/main/web/assets/default_avatars/GoToSocial_icon1.svg
1978 $default = '/images/default/gotosocial.svg';
1984 * @license GNU Affero General Public License v3.0
1985 * @link https://github.com/hometown-fork/hometown/blob/hometown-dev/public/avatars/original/missing.png
1987 $default = '/images/default/hometown.png';
1993 * @license GNU Affero General Public License v3.0
1994 * @link https://github.com/koyuspace/mastodon/blob/main/public/avatars/original/missing.png
1996 $default = '/images/default/koyuspace.png';
2004 * @license GNU Affero General Public License v3.0
2005 * @link https://github.com/mastodon/mastodon/tree/main/public/avatars/original/missing.png
2007 $default = '/images/default/mastodon.png';
2011 if ($type == Contact::TYPE_COMMUNITY) {
2014 * @license GNU Affero General Public License v3.0
2015 * @link https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-video-channel.png
2017 $default = '/images/default/peertube-channel.png';
2021 * @license GNU Affero General Public License v3.0
2022 * @link https://github.com/Chocobozzz/PeerTube/blob/develop/client/src/assets/images/default-avatar-account.png
2024 $default = '/images/default/peertube-account.png';
2031 * @license GNU Affero General Public License v3.0
2032 * @link https://git.pleroma.social/pleroma/pleroma/-/blob/develop/priv/static/images/avi.png
2034 $default = '/images/default/pleroma.png';
2040 * @license GNU Affero General Public License v3.0
2041 * @link https://github.com/Plume-org/Plume/blob/main/assets/images/default-avatar.png
2043 $default = '/images/default/plume.png';
2046 return DI::baseUrl() . $default;
2049 if (!empty($contact['xmpp'])) {
2050 $avatar['email'] = $contact['xmpp'];
2051 } elseif (!empty($contact['addr'])) {
2052 $avatar['email'] = $contact['addr'];
2053 } elseif (!empty($contact['url'])) {
2054 $avatar['email'] = $contact['url'];
2056 return DI::baseUrl() . $default;
2059 $avatar['url'] = '';
2060 $avatar['success'] = false;
2062 Hook::callAll('avatar_lookup', $avatar);
2064 if ($avatar['success'] && !empty($avatar['url'])) {
2065 return $avatar['url'];
2068 return DI::baseUrl() . $default;
2072 * Get avatar link for given contact id
2074 * @param integer $cid contact id
2075 * @param string $size One of the Proxy::SIZE_* constants
2076 * @param string $updated Contact update date
2077 * @param bool $static If "true" a parameter is added to convert the avatar to a static one
2078 * @return string avatar link
2080 public static function getAvatarUrlForId(int $cid, string $size = '', string $updated = '', string $guid = '', bool $static = false): string
2082 // We have to fetch the "updated" variable when it wasn't provided
2083 // The parameter can be provided to improve performance
2084 if (empty($updated)) {
2085 $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
2086 $updated = $account['updated'] ?? '';
2087 $guid = $account['guid'] ?? '';
2090 $guid = urlencode($guid);
2092 $url = DI::baseUrl() . '/photo/contact/';
2094 case Proxy::SIZE_MICRO:
2095 $url .= Proxy::PIXEL_MICRO . '/';
2097 case Proxy::SIZE_THUMB:
2098 $url .= Proxy::PIXEL_THUMB . '/';
2100 case Proxy::SIZE_SMALL:
2101 $url .= Proxy::PIXEL_SMALL . '/';
2103 case Proxy::SIZE_MEDIUM:
2104 $url .= Proxy::PIXEL_MEDIUM . '/';
2106 case Proxy::SIZE_LARGE:
2107 $url .= Proxy::PIXEL_LARGE . '/';
2112 $query_params['ts'] = strtotime($updated);
2115 $query_params['static'] = true;
2118 return $url . ($guid ?: $cid) . (!empty($query_params) ? '?' . http_build_query($query_params) : '');
2122 * Get avatar link for given contact URL
2124 * @param string $url contact url
2125 * @param integer $uid user id
2126 * @param string $size One of the Proxy::SIZE_* constants
2127 * @return string avatar link
2129 public static function getAvatarUrlForUrl(string $url, int $uid, string $size = ''): string
2131 $condition = ["`nurl` = ? AND ((`uid` = ? AND `network` IN (?, ?)) OR `uid` = ?)",
2132 Strings::normaliseLink($url), $uid, Protocol::FEED, Protocol::MAIL, 0];
2133 $contact = self::selectFirst(['id', 'updated'], $condition, ['order' => ['uid' => true]]);
2134 return self::getAvatarUrlForId($contact['id'] ?? 0, $size, $contact['updated'] ?? '');
2138 * Get header link for given contact id
2140 * @param integer $cid contact id
2141 * @param string $size One of the Proxy::SIZE_* constants
2142 * @param string $updated Contact update date
2143 * @param bool $static If "true" a parameter is added to convert the header to a static one
2144 * @return string header link
2146 public static function getHeaderUrlForId(int $cid, string $size = '', string $updated = '', string $guid = '', bool $static = false): string
2148 // We have to fetch the "updated" variable when it wasn't provided
2149 // The parameter can be provided to improve performance
2150 if (empty($updated) || empty($guid)) {
2151 $account = DBA::selectFirst('account-user-view', ['updated', 'guid'], ['id' => $cid]);
2152 $updated = $account['updated'] ?? '';
2153 $guid = $account['guid'] ?? '';
2156 $guid = urlencode($guid);
2158 $url = DI::baseUrl() . '/photo/header/';
2160 case Proxy::SIZE_MICRO:
2161 $url .= Proxy::PIXEL_MICRO . '/';
2163 case Proxy::SIZE_THUMB:
2164 $url .= Proxy::PIXEL_THUMB . '/';
2166 case Proxy::SIZE_SMALL:
2167 $url .= Proxy::PIXEL_SMALL . '/';
2169 case Proxy::SIZE_MEDIUM:
2170 $url .= Proxy::PIXEL_MEDIUM . '/';
2172 case Proxy::SIZE_LARGE:
2173 $url .= Proxy::PIXEL_LARGE . '/';
2179 $query_params['ts'] = strtotime($updated);
2182 $query_params['static'] = true;
2185 return $url . ($guid ?: $cid) . (!empty($query_params) ? '?' . http_build_query($query_params) : '');
2189 * Updates the avatar links in a contact only if needed
2191 * @param int $cid Contact id
2192 * @param string $avatar Link to avatar picture
2193 * @param bool $force force picture update
2194 * @param bool $create_cache Enforces the creation of cached avatar fields
2197 * @throws HTTPException\InternalServerErrorException
2198 * @throws HTTPException\NotFoundException
2199 * @throws \ImagickException
2201 public static function updateAvatar(int $cid, string $avatar, bool $force = false, bool $create_cache = false)
2203 $contact = DBA::selectFirst('contact', ['uid', 'avatar', 'photo', 'thumb', 'micro', 'blurhash', 'xmpp', 'addr', 'nurl', 'url', 'network', 'uri-id'],
2204 ['id' => $cid, 'self' => false]);
2205 if (!DBA::isResult($contact)) {
2209 $uid = $contact['uid'];
2211 // Only update the cached photo links of public contacts when they already are cached
2212 if (($uid == 0) && !$force && empty($contact['thumb']) && empty($contact['micro']) && !$create_cache) {
2213 if (($contact['avatar'] != $avatar) || empty($contact['blurhash'])) {
2214 $update_fields = ['avatar' => $avatar];
2215 $fetchResult = HTTPSignature::fetchRaw($avatar, 0, [HttpClientOptions::ACCEPT_CONTENT => [HttpClientAccept::IMAGE]]);
2217 $img_str = $fetchResult->getBody();
2218 if (!empty($img_str)) {
2219 $image = new Image($img_str, Images::getMimeTypeByData($img_str));
2220 if ($image->isValid()) {
2221 $update_fields['blurhash'] = $image->getBlurHash();
2225 self::update($update_fields, ['id' => $cid]);
2226 Logger::info('Only update the avatar', ['id' => $cid, 'avatar' => $avatar, 'contact' => $contact]);
2231 // User contacts use are updated through the public contacts
2232 if (($uid != 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2233 $pcid = self::getIdForURL($contact['url'], 0, false);
2234 if (!empty($pcid)) {
2235 Logger::debug('Update the private contact via the public contact', ['id' => $cid, 'uid' => $uid, 'public' => $pcid]);
2236 self::updateAvatar($pcid, $avatar, $force, true);
2241 $default_avatar = empty($avatar) || strpos($avatar, self::DEFAULT_AVATAR_PHOTO);
2243 if ($default_avatar) {
2244 $avatar = self::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
2247 $cache_avatar = DI::config()->get('system', 'cache_contact_avatar');
2249 // Local contact avatars don't need to be cached
2250 if ($cache_avatar && Network::isLocalLink($contact['url'])) {
2251 $cache_avatar = !DBA::exists('contact', ['nurl' => $contact['nurl'], 'self' => true]);
2254 if (in_array($contact['network'], [Protocol::FEED, Protocol::MAIL]) || $cache_avatar) {
2255 Avatar::deleteCache($contact);
2257 if ($default_avatar && Proxy::isLocalImage($avatar)) {
2258 $fields = ['avatar' => $avatar, 'avatar-date' => DateTimeFormat::utcNow(),
2260 'thumb' => self::getDefaultAvatar($contact, Proxy::SIZE_THUMB),
2261 'micro' => self::getDefaultAvatar($contact, Proxy::SIZE_MICRO)];
2262 Logger::debug('Use default avatar', ['id' => $cid, 'uid' => $uid]);
2265 // Use the data from the self account
2266 if (empty($fields)) {
2267 $local_uid = User::getIdForURL($contact['url']);
2268 if (!empty($local_uid)) {
2269 $fields = self::selectFirst(['avatar', 'avatar-date', 'photo', 'thumb', 'micro'], ['self' => true, 'uid' => $local_uid]);
2270 Logger::debug('Use owner data', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2274 if (empty($fields)) {
2275 $update = ($contact['avatar'] != $avatar) || $force;
2279 $contact['photo'] ?? '',
2280 $contact['thumb'] ?? '',
2281 $contact['micro'] ?? '',
2284 foreach ($data as $image_uri) {
2285 $image_rid = Photo::ridFromURI($image_uri);
2286 if ($image_rid && !Photo::exists(['resource-id' => $image_rid, 'uid' => $uid])) {
2287 Logger::debug('Regenerating avatar', ['contact uid' => $uid, 'cid' => $cid, 'missing photo' => $image_rid, 'avatar' => $contact['avatar']]);
2294 $photos = Photo::importProfilePhoto($avatar, $uid, $cid, true);
2296 $fields = ['avatar' => $avatar, 'photo' => $photos[0], 'thumb' => $photos[1], 'micro' => $photos[2], 'blurhash' => $photos[3], 'avatar-date' => DateTimeFormat::utcNow()];
2297 $update = !empty($fields);
2298 Logger::debug('Created new cached avatars', ['id' => $cid, 'uid' => $uid, 'owner-uid' => $local_uid]);
2304 $update = ($fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2307 Photo::delete(['uid' => $uid, 'contact-id' => $cid, 'photo-type' => Photo::CONTACT_AVATAR]);
2308 $fields = Avatar::fetchAvatarContact($contact, $avatar, $force);
2309 $update = ($avatar . $fields['photo'] . $fields['thumb'] . $fields['micro'] != $contact['avatar'] . $contact['photo'] . $contact['thumb'] . $contact['micro']) || $force;
2318 if (($uid == 0) && !in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
2319 // Collect all user contacts of the given public contact
2320 $personal_contacts = DBA::select('contact', ['id', 'uid'],
2321 ["`nurl` = ? AND `id` != ? AND NOT `self`", $contact['nurl'], $cid]);
2322 while ($personal_contact = DBA::fetch($personal_contacts)) {
2323 $cids[] = $personal_contact['id'];
2324 $uids[] = $personal_contact['uid'];
2326 DBA::close($personal_contacts);
2328 if (!empty($cids)) {
2329 // Delete possibly existing cached user contact avatars
2330 Photo::delete(['uid' => $uids, 'contact-id' => $cids, 'photo-type' => Photo::CONTACT_AVATAR]);
2336 Logger::info('Updating cached contact avatars', ['cid' => $cids, 'uid' => $uids, 'fields' => $fields]);
2337 self::update($fields, ['id' => $cids]);
2340 public static function deleteContactByUrl(string $url)
2342 // Update contact data for all users
2343 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
2344 $contacts = DBA::select('contact', ['id', 'uid'], $condition);
2345 while ($contact = DBA::fetch($contacts)) {
2346 Logger::info('Deleting contact', ['id' => $contact['id'], 'uid' => $contact['uid'], 'url' => $url]);
2347 self::remove($contact['id']);
2352 * Helper function for "updateFromProbe". Updates personal and public contact
2354 * @param integer $id contact id
2355 * @param integer $uid user id
2356 * @param integer $uri_id Uri-Id
2357 * @param string $url The profile URL of the contact
2358 * @param array $fields The fields that are updated
2360 * @throws \Exception
2362 private static function updateContact(int $id, int $uid, int $uri_id, string $url, array $fields)
2364 if (!self::update($fields, ['id' => $id])) {
2365 Logger::info('Couldn\'t update contact.', ['id' => $id, 'fields' => $fields]);
2369 self::setAccountUser($id, $uid, $uri_id, $url);
2371 // Archive or unarchive the contact.
2372 $contact = DBA::selectFirst('contact', [], ['id' => $id]);
2373 if (!DBA::isResult($contact)) {
2374 Logger::info('Couldn\'t select contact for archival.', ['id' => $id]);
2378 if (isset($fields['failed'])) {
2379 if ($fields['failed']) {
2380 self::markForArchival($contact);
2382 self::unmarkForArchival($contact);
2386 if ($contact['uid'] != 0) {
2390 // Update contact data for all users
2391 $condition = ['self' => false, 'nurl' => Strings::normaliseLink($url)];
2393 $condition['network'] = [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB];
2394 self::update($fields, $condition);
2396 // We mustn't set the update fields for OStatus contacts since they are updated in OnePoll
2397 $condition['network'] = Protocol::OSTATUS;
2399 // If the contact failed, propagate the update fields to all contacts
2400 if (empty($fields['failed'])) {
2401 unset($fields['last-update']);
2402 unset($fields['success_update']);
2403 unset($fields['failure_update']);
2406 if (empty($fields)) {
2410 self::update($fields, $condition);
2414 * Create or update an "account-user" entry
2416 * @param integer $id
2417 * @param integer $uid
2418 * @param integer $uri_id
2419 * @param string $url
2422 public static function setAccountUser(int $id, int $uid, int $uri_id, string $url)
2424 if (empty($uri_id)) {
2428 $account_user = DBA::selectFirst('account-user', ['id', 'uid', 'uri-id'], ['id' => $id]);
2429 if (!empty($account_user['uri-id']) && ($account_user['uri-id'] != $uri_id)) {
2430 if ($account_user['uid'] == $uid) {
2431 $ret = DBA::update('account-user', ['uri-id' => $uri_id], ['id' => $id]);
2432 Logger::notice('Updated account-user uri-id', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2434 // This should never happen
2435 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]);
2439 $account_user = DBA::selectFirst('account-user', ['id', 'uid', 'uri-id'], ['uid' => $uid, 'uri-id' => $uri_id]);
2440 if (!empty($account_user['id'])) {
2441 if ($account_user['id'] == $id) {
2442 Logger::debug('account-user already exists', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2444 } elseif (!DBA::exists('contact', ['id' => $account_user['id'], 'deleted' => false])) {
2445 $ret = DBA::update('account-user', ['id' => $id], ['uid' => $uid, 'uri-id' => $uri_id]);
2446 Logger::notice('Updated account-user', ['ret' => $ret, 'account-user' => $account_user, 'cid' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2449 Logger::warning('account-user exists for a different contact id', ['account_user' => $account_user, 'id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2450 Worker::add(Worker::PRIORITY_HIGH, 'MergeContact', $account_user['id'], $id, $uid);
2451 } elseif (DBA::insert('account-user', ['id' => $id, 'uri-id' => $uri_id, 'uid' => $uid], Database::INSERT_IGNORE)) {
2452 Logger::notice('account-user was added', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2454 Logger::warning('account-user was not added', ['id' => $id, 'uid' => $uid, 'uri-id' => $uri_id, 'url' => $url]);
2459 * Remove duplicated contacts
2461 * @param string $nurl Normalised contact url
2462 * @param integer $uid User id
2464 * @throws \Exception
2466 public static function removeDuplicates(string $nurl, int $uid)
2468 $condition = ['nurl' => $nurl, 'uid' => $uid, 'self' => false, 'deleted' => false, 'network' => Protocol::FEDERATED];
2469 $count = DBA::count('contact', $condition);
2474 $first_contact = DBA::selectFirst('contact', ['id', 'network'], $condition, ['order' => ['id']]);
2475 if (!DBA::isResult($first_contact)) {
2476 // Shouldn't happen - so we handle it
2480 $first = $first_contact['id'];
2481 Logger::info('Found duplicates', ['count' => $count, 'first' => $first, 'uid' => $uid, 'nurl' => $nurl]);
2483 // Find all duplicates
2484 $condition = ["`nurl` = ? AND `uid` = ? AND `id` != ? AND NOT `self` AND NOT `deleted`", $nurl, $uid, $first];
2485 $duplicates = DBA::select('contact', ['id', 'network'], $condition);
2486 while ($duplicate = DBA::fetch($duplicates)) {
2487 if (!in_array($duplicate['network'], Protocol::FEDERATED)) {
2491 Worker::add(Worker::PRIORITY_HIGH, 'MergeContact', $first, $duplicate['id'], $uid);
2493 DBA::close($duplicates);
2494 Logger::info('Duplicates handled', ['uid' => $uid, 'nurl' => $nurl, 'callstack' => System::callstack(20)]);
2499 * Perform a contact update if the contact is outdated
2501 * @param integer $id contact id
2504 public static function updateByIdIfNeeded(int $id): bool
2506 $contact = self::selectFirst(['url'], ["`id` = ? AND `next-update` < ?", $id, DateTimeFormat::utcNow()]);
2507 if (empty($contact['url'])) {
2511 if (self::isLocal($contact['url'])) {
2515 $stamp = (float)microtime(true);
2516 self::updateFromProbe($id);
2517 Logger::debug('Contact data is updated.', ['duration' => round((float)microtime(true) - $stamp, 3), 'id' => $id, 'url' => $contact['url'], 'callstack' => System::callstack(20)]);
2522 * Perform a contact update if the contact is outdated
2524 * @param string $url contact url
2527 public static function updateByUrlIfNeeded(string $url): bool
2529 $id = self::getIdForURL($url, 0, false);
2531 return self::updateByIdIfNeeded($id);
2533 return (bool)self::getIdForURL($url);
2537 * Updates contact record by provided id and optional network
2539 * @param integer $id contact id
2540 * @param string $network Optional network we are probing for
2542 * @throws HTTPException\InternalServerErrorException
2543 * @throws \ImagickException
2545 public static function updateFromProbe(int $id, string $network = '')
2547 $contact = DBA::selectFirst('contact', ['uid', 'url'], ['id' => $id]);
2548 if (!DBA::isResult($contact)) {
2552 $data = Probe::uri($contact['url'], $network, $contact['uid']);
2554 if ($data['network'] == Protocol::DIASPORA) {
2556 DI::dsprContact()->updateFromProbeArray($data);
2557 } catch (HTTPException\NotFoundException $e) {
2558 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2559 } catch (\InvalidArgumentException $e) {
2560 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2562 } elseif (!empty($data['networks'][Protocol::DIASPORA])) {
2564 DI::dsprContact()->updateFromProbeArray($data['networks'][Protocol::DIASPORA]);
2565 } catch (HTTPException\NotFoundException $e) {
2566 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2567 } catch (\InvalidArgumentException $e) {
2568 Logger::notice($e->getMessage(), ['id' => $id, 'network' => $network, 'contact' => $contact, 'data' => $data]);
2572 return self::updateFromProbeArray($id, $data);
2576 * Checks if the given contact has got local data
2579 * @param array $contact
2583 private static function hasLocalData(int $id, array $contact): bool
2585 if (!empty($contact['uri-id']) && DBA::exists('contact', ["`uri-id` = ? AND `uid` != ?", $contact['uri-id'], 0])) {
2586 // User contacts with the same uri-id exist
2588 } elseif (DBA::exists('contact', ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($contact['url']), 0])) {
2589 // User contacts with the same nurl exists (compatibility mode for systems with missing uri-id values)
2592 if (DBA::exists('post-tag', ['cid' => $id])) {
2593 // Is tagged in a post
2596 if (DBA::exists('user-contact', ['cid' => $id])) {
2597 // Has got user-contact data
2600 if (Post::exists(['author-id' => $id])) {
2601 // Posts with this author exist
2604 if (Post::exists(['owner-id' => $id])) {
2605 // Posts with this owner exist
2608 if (Post::exists(['causer-id' => $id])) {
2609 // Posts with this causer exist
2612 // We don't have got this contact locally
2617 * Updates contact record by provided id and probed data
2619 * @param integer $id contact id
2620 * @param array $ret Probed data
2622 * @throws HTTPException\InternalServerErrorException
2623 * @throws \ImagickException
2625 private static function updateFromProbeArray(int $id, array $ret): bool
2628 Warning: Never ever fetch the public key via Probe::uri and write it into the contacts.
2629 This will reliably kill your communication with old Friendica contacts.
2632 // These fields aren't updated by this routine:
2635 $fields = ['uid', 'uri-id', 'avatar', 'header', 'name', 'nick', 'location', 'keywords', 'about', 'subscribe',
2636 'manually-approve', 'unsearchable', 'url', 'addr', 'batch', 'notify', 'poll', 'request', 'confirm', 'poco',
2637 'network', 'alias', 'baseurl', 'gsid', 'forum', 'prv', 'contact-type', 'pubkey', 'last-item', 'xmpp', 'matrix',
2638 'created', 'last-update'];
2639 $contact = DBA::selectFirst('contact', $fields, ['id' => $id]);
2640 if (!DBA::isResult($contact)) {
2644 if (self::isLocal($ret['url'])) {
2645 if ($contact['uid'] == 0) {
2646 Logger::info('Local contacts are not updated here.');
2648 self::updateFromPublicContact($id, $contact);
2653 if (!empty($ret['account-type']) && $ret['account-type'] == User::ACCOUNT_TYPE_DELETED) {
2654 Logger::info('Deleted account', ['id' => $id, 'url' => $ret['url'], 'ret' => $ret]);
2657 // Delete all contacts with the same URL
2658 self::deleteContactByUrl($ret['url']);
2662 $uid = $contact['uid'];
2663 unset($contact['uid']);
2665 $uriid = $contact['uri-id'];
2666 unset($contact['uri-id']);
2668 $pubkey = $contact['pubkey'];
2669 unset($contact['pubkey']);
2671 $created = $contact['created'];
2672 unset($contact['created']);
2674 $last_update = $contact['last-update'];
2675 unset($contact['last-update']);
2677 $contact['photo'] = $contact['avatar'];
2678 unset($contact['avatar']);
2680 $updated = DateTimeFormat::utcNow();
2682 $has_local_data = self::hasLocalData($id, $contact);
2684 if (!Probe::isProbable($ret['network'])) {
2685 // Periodical checks are only done on federated contacts
2686 $failed_next_update = null;
2687 $success_next_update = null;
2688 } elseif ($has_local_data) {
2689 $failed_next_update = GServer::getNextUpdateDate(false, $created, $last_update, !in_array($contact['network'], Protocol::FEDERATED));
2690 $success_next_update = GServer::getNextUpdateDate(true, $created, $last_update, !in_array($contact['network'], Protocol::FEDERATED));
2692 $failed_next_update = DateTimeFormat::utc('now +6 month');
2693 $success_next_update = DateTimeFormat::utc('now +1 month');
2696 if (Strings::normaliseLink($contact['url']) != Strings::normaliseLink($ret['url'])) {
2697 Logger::notice('New URL differs from old URL', ['id' => $id, 'uid' => $uid, 'old' => $contact['url'], 'new' => $ret['url']]);
2698 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]);
2702 // We must not try to update relay contacts via probe. They are no real contacts.
2703 // We check after the probing to be able to correct falsely detected contact types.
2704 if (($contact['contact-type'] == self::TYPE_RELAY) &&
2705 (!Strings::compareLink($ret['url'], $contact['url']) || in_array($ret['network'], [Protocol::FEED, Protocol::PHANTOM]))) {
2706 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]);
2707 Logger::info('Not updating relais', ['id' => $id, 'url' => $contact['url']]);
2711 // If Probe::uri fails the network code will be different ("feed" or "unkn")
2712 if (($ret['network'] == Protocol::PHANTOM) || (($ret['network'] == Protocol::FEED) && ($ret['network'] != $contact['network']))) {
2713 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]);
2717 if (Strings::normaliseLink($ret['url']) != Strings::normaliseLink($contact['url'])) {
2718 $cid = self::getIdForURL($ret['url'], 0, false);
2719 if (!empty($cid) && ($cid != $id)) {
2720 Logger::notice('URL of contact changed.', ['id' => $id, 'new_id' => $cid, 'old' => $contact['url'], 'new' => $ret['url']]);
2721 return self::updateFromProbeArray($cid, $ret);
2725 if (isset($ret['hide']) && is_bool($ret['hide'])) {
2726 $ret['unsearchable'] = $ret['hide'];
2729 if (isset($ret['account-type']) && is_int($ret['account-type'])) {
2730 $ret['forum'] = false;
2731 $ret['prv'] = false;
2732 $ret['contact-type'] = $ret['account-type'];
2733 if (($ret['contact-type'] == User::ACCOUNT_TYPE_COMMUNITY) && isset($ret['manually-approve'])) {
2734 $ret['forum'] = (bool)!$ret['manually-approve'];
2735 $ret['prv'] = (bool)!$ret['forum'];
2739 $new_pubkey = $ret['pubkey'] ?? '';
2741 if ($uid == 0 && DI::config()->get('system', 'fetch_featured_posts')) {
2742 if ($ret['network'] == Protocol::ACTIVITYPUB) {
2743 $apcontact = APContact::getByURL($ret['url'], false);
2744 if (!empty($apcontact['featured'])) {
2745 Worker::add(Worker::PRIORITY_LOW, 'FetchFeaturedPosts', $ret['url']);
2749 $ret['last-item'] = Probe::getLastUpdate($ret);
2750 Logger::info('Fetched last item', ['id' => $id, 'probed_url' => $ret['url'], 'last-item' => $ret['last-item'], 'callstack' => System::callstack(20)]);
2754 $guid = ($ret['guid'] ?? '') ?: Item::guidFromUri($ret['url']);
2756 // make sure to not overwrite existing values with blank entries except some technical fields
2757 $keep = ['batch', 'notify', 'poll', 'request', 'confirm', 'poco', 'baseurl'];
2758 foreach ($ret as $key => $val) {
2759 if (!array_key_exists($key, $contact)) {
2761 } elseif (($contact[$key] != '') && ($val === '') && !is_bool($ret[$key]) && !in_array($key, $keep)) {
2762 $ret[$key] = $contact[$key];
2763 } elseif ($ret[$key] != $contact[$key]) {
2768 if (!empty($ret['last-item']) && ($contact['last-item'] < $ret['last-item'])) {
2771 unset($ret['last-item']);
2774 if (empty($uriid)) {
2778 if (!empty($ret['photo']) && ($ret['network'] != Protocol::FEED)) {
2779 self::updateAvatar($id, $ret['photo'], $update);
2783 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]);
2785 if (Contact\Relation::isDiscoverable($ret['url'])) {
2786 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2789 // Update the public contact
2791 $contact = self::getByURL($ret['url'], false, ['id']);
2792 if (!empty($contact['id'])) {
2793 self::updateFromProbeArray($contact['id'], $ret);
2800 $ret['uri-id'] = ItemURI::insert(['uri' => $ret['url'], 'guid' => $guid]);
2801 $ret['nurl'] = Strings::normaliseLink($ret['url']);
2802 $ret['updated'] = $updated;
2803 $ret['failed'] = false;
2804 $ret['next-update'] = $success_next_update;
2805 $ret['local-data'] = $has_local_data;
2807 // Only fill the pubkey if it had been empty before. We have to prevent identity theft.
2808 if (empty($pubkey) && !empty($new_pubkey)) {
2809 $ret['pubkey'] = $new_pubkey;
2812 if ((!empty($ret['addr']) && ($ret['addr'] != $contact['addr'])) || (!empty($ret['alias']) && ($ret['alias'] != $contact['alias']))) {
2813 $ret['uri-date'] = $updated;
2816 if ((!empty($ret['name']) && ($ret['name'] != $contact['name'])) || (!empty($ret['nick']) && ($ret['nick'] != $contact['nick']))) {
2817 $ret['name-date'] = $updated;
2820 if (($uid == 0) || in_array($ret['network'], [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
2821 $ret['last-update'] = $updated;
2822 $ret['success_update'] = $updated;
2825 unset($ret['photo']);
2827 self::updateContact($id, $uid, $ret['uri-id'], $ret['url'], $ret);
2829 if (Contact\Relation::isDiscoverable($ret['url'])) {
2830 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscovery', $ret['url']);
2836 private static function updateFromPublicContact(int $id, array $contact)
2838 $public = self::getByURL($contact['url'], false);
2842 foreach ($contact as $field => $value) {
2843 if ($field == 'uid') {
2846 if ($public[$field] != $value) {
2847 $fields[$field] = $public[$field];
2850 if (!empty($fields)) {
2851 self::update($fields, ['id' => $id, 'self' => false]);
2852 Logger::info('Updating local contact', ['id' => $id]);
2857 * Updates contact record by provided URL
2859 * @param integer $url contact url
2860 * @return integer Contact id
2861 * @throws HTTPException\InternalServerErrorException
2862 * @throws \ImagickException
2864 public static function updateFromProbeByURL(string $url): int
2866 $id = self::getIdForURL($url);
2872 self::updateFromProbe($id);
2878 * Detects the communication protocol for a given contact url.
2879 * This is used to detect Friendica contacts that we can communicate via AP.
2881 * @param string $url contact url
2882 * @param string $network Network of that contact
2883 * @return string with protocol
2885 public static function getProtocol(string $url, string $network): string
2887 if ($network != Protocol::DFRN) {
2891 $apcontact = APContact::getByURL($url);
2892 if (!empty($apcontact) && !empty($apcontact['generator'])) {
2893 return Protocol::ACTIVITYPUB;
2900 * Takes a $uid and a url/handle and adds a new contact
2902 * Currently if the contact is DFRN, interactive needs to be true, to redirect to the
2903 * dfrn_request page.
2905 * Otherwise this can be used to bulk add StatusNet contacts, Twitter contacts, etc.
2908 * $return['success'] boolean true if successful
2909 * $return['message'] error text if success is false.
2911 * Takes a $uid and a url/handle and adds a new contact
2913 * @param int $uid The user id the contact should be created for
2914 * @param string $url The profile URL of the contact
2915 * @param string $network
2917 * @throws HTTPException\InternalServerErrorException
2918 * @throws HTTPException\NotFoundException
2919 * @throws \ImagickException
2921 public static function createFromProbeForUser(int $uid, string $url, string $network = ''): array
2923 $result = ['cid' => -1, 'success' => false, 'message' => ''];
2925 // remove ajax junk, e.g. Twitter
2926 $url = str_replace('/#!/', '/', $url);
2928 if (!Network::isUrlAllowed($url)) {
2929 $result['message'] = DI::l10n()->t('Disallowed profile URL.');
2933 if (Network::isUrlBlocked($url)) {
2934 $result['message'] = DI::l10n()->t('Blocked domain');
2939 $result['message'] = DI::l10n()->t('Connect URL missing.');
2943 $arr = ['url' => $url, 'contact' => []];
2945 Hook::callAll('follow', $arr);
2948 $result['message'] = DI::l10n()->t('The contact could not be added. Please check the relevant network credentials in your Settings -> Social Networks page.');
2952 if (!empty($arr['contact']['name'])) {
2954 $ret = $arr['contact'];
2957 $ret = Probe::uri($url, $network, $uid);
2959 // Ensure that the public contact exists
2960 if ($ret['network'] != Protocol::PHANTOM) {
2961 self::getIdForURL($url);
2965 if (($network != '') && ($ret['network'] != $network)) {
2966 $result['message'] = DI::l10n()->t('Expected network %s does not match actual network %s', $network, $ret['network']);
2970 // check if we already have a contact
2971 $condition = ['uid' => $uid, 'nurl' => Strings::normaliseLink($ret['url'])];
2972 $contact = DBA::selectFirst('contact', ['id', 'rel', 'url', 'pending', 'hub-verify'], $condition);
2974 $protocol = self::getProtocol($ret['url'], $ret['network']);
2976 // This extra param just confuses things, remove it
2977 if ($protocol === Protocol::DIASPORA) {
2978 $ret['url'] = str_replace('?absolute=true', '', $ret['url']);
2981 // do we have enough information?
2982 if (empty($protocol) || ($protocol == Protocol::PHANTOM) || (empty($ret['url']) && empty($ret['addr']))) {
2983 $result['message'] .= DI::l10n()->t('The profile address specified does not provide adequate information.') . '<br />';
2984 if (empty($ret['poll'])) {
2985 $result['message'] .= DI::l10n()->t('No compatible communication protocols or feeds were discovered.') . '<br />';
2987 if (empty($ret['name'])) {
2988 $result['message'] .= DI::l10n()->t('An author or name was not found.') . '<br />';
2990 if (empty($ret['url'])) {
2991 $result['message'] .= DI::l10n()->t('No browser URL could be matched to this address.') . '<br />';
2993 if (strpos($ret['url'], '@') !== false) {
2994 $result['message'] .= DI::l10n()->t('Unable to match @-style Identity Address with a known protocol or email contact.') . '<br />';
2995 $result['message'] .= DI::l10n()->t('Use mailto: in front of address to force email check.') . '<br />';
3000 if ($protocol === Protocol::OSTATUS && DI::config()->get('system', 'ostatus_disabled')) {
3001 $result['message'] .= DI::l10n()->t('The profile address specified belongs to a network which has been disabled on this site.') . '<br />';
3002 $ret['notify'] = '';
3005 if (!$ret['notify']) {
3006 $result['message'] .= DI::l10n()->t('Limited profile. This person will be unable to receive direct/personal notifications from you.') . '<br />';
3009 $writeable = ((($protocol === Protocol::OSTATUS) && ($ret['notify'])) ? 1 : 0);
3011 $subhub = (($protocol === Protocol::OSTATUS) ? true : false);
3013 $hidden = (($protocol === Protocol::MAIL) ? 1 : 0);
3016 if (($protocol == Protocol::ACTIVITYPUB) && isset($ret['manually-approve'])) {
3017 $pending = (bool)$ret['manually-approve'];
3020 if (in_array($protocol, [Protocol::MAIL, Protocol::DIASPORA, Protocol::ACTIVITYPUB])) {
3024 if (DBA::isResult($contact)) {
3026 $new_relation = (in_array($contact['rel'], [self::FOLLOWER, self::FRIEND]) ? self::FRIEND : self::SHARING);
3028 $fields = ['rel' => $new_relation, 'subhub' => $subhub, 'readonly' => false, 'network' => $ret['network']];
3030 if ($contact['pending'] && !empty($contact['hub-verify'])) {
3031 ActivityPub\Transmitter::sendContactAccept($contact['url'], $contact['hub-verify'], $uid);
3032 $fields['pending'] = false;
3035 self::update($fields, ['id' => $contact['id']]);
3037 $new_relation = (in_array($protocol, [Protocol::MAIL]) ? self::FRIEND : self::SHARING);
3039 // create contact record
3042 'created' => DateTimeFormat::utcNow(),
3043 'url' => $ret['url'],
3044 'nurl' => Strings::normaliseLink($ret['url']),
3045 'addr' => $ret['addr'],
3046 'alias' => $ret['alias'],
3047 'batch' => $ret['batch'],
3048 'notify' => $ret['notify'],
3049 'poll' => $ret['poll'],
3050 'poco' => $ret['poco'],
3051 'name' => $ret['name'],
3052 'nick' => $ret['nick'],
3053 'network' => $ret['network'],
3054 'baseurl' => $ret['baseurl'],
3055 'gsid' => $ret['gsid'] ?? null,
3056 'protocol' => $protocol,
3057 'pubkey' => $ret['pubkey'],
3058 'rel' => $new_relation,
3059 'priority'=> $ret['priority'],
3060 'writable'=> $writeable,
3061 'hidden' => $hidden,
3064 'pending' => $pending,
3069 $contact = DBA::selectFirst('contact', [], ['url' => $ret['url'], 'network' => $ret['network'], 'uid' => $uid]);
3070 if (!DBA::isResult($contact)) {
3071 $result['message'] .= DI::l10n()->t('Unable to retrieve contact information.') . '<br />';
3075 $contact_id = $contact['id'];
3076 $result['cid'] = $contact_id;
3078 Group::addMember(User::getDefaultGroup($uid), $contact_id);
3080 // Update the avatar
3081 self::updateAvatar($contact_id, $ret['photo']);
3083 // pull feed and consume it, which should subscribe to the hub.
3084 if ($contact['network'] == Protocol::OSTATUS) {
3085 Worker::add(Worker::PRIORITY_HIGH, 'OnePoll', $contact_id, 'force');
3089 self::updateFromProbeArray($contact_id, $ret);
3092 UpdateContact::add(Worker::PRIORITY_HIGH, $contact['id']);
3093 } catch (\InvalidArgumentException $e) {
3094 Logger::notice($e->getMessage(), ['contact' => $contact]);
3098 $result['success'] = Protocol::follow($uid, $contact, $protocol);
3104 * @param array $importer Owner (local user) data
3105 * @param array $contact Existing owner-specific contact data we want to expand the relationship with. Optional.
3106 * @param array $datarray An item-like array with at least the 'author-id' and 'author-url' keys for the contact. Mandatory.
3107 * @param bool $sharing True: Contact is now sharing with Owner; False: Contact is now following Owner (default)
3108 * @param string $note Introduction additional message
3109 * @return bool|null True: follow request is accepted; False: relationship is rejected; Null: relationship is pending
3110 * @throws HTTPException\InternalServerErrorException
3111 * @throws \ImagickException
3113 public static function addRelationship(array $importer, array $contact, array $datarray, bool $sharing = false, string $note = '')
3115 // Should always be set
3116 if (empty($datarray['author-id'])) {
3120 $fields = ['id', 'url', 'name', 'nick', 'avatar', 'photo', 'network', 'blocked'];
3121 $pub_contact = DBA::selectFirst('contact', $fields, ['id' => $datarray['author-id']]);
3122 if (!DBA::isResult($pub_contact)) {
3123 // Should never happen
3127 // Contact is blocked at node-level
3128 if (self::isBlocked($datarray['author-id'])) {
3132 $url = ($datarray['author-link'] ?? '') ?: $pub_contact['url'];
3133 $name = $pub_contact['name'];
3134 $photo = ($pub_contact['avatar'] ?? '') ?: $pub_contact["photo"];
3135 $nick = $pub_contact['nick'];
3136 $network = $pub_contact['network'];
3138 // Ensure that we don't create a new contact when there already is one
3139 $cid = self::getIdForURL($url, $importer['uid']);
3141 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
3144 self::clearFollowerFollowingEndpointCache($importer['uid']);
3146 if (!empty($contact)) {
3147 if (!empty($contact['pending'])) {
3148 Logger::info('Pending contact request already exists.', ['url' => $url, 'uid' => $importer['uid']]);
3152 // Contact is blocked at user-level
3153 if (!empty($contact['id']) && !empty($importer['id']) &&
3154 Contact\User::isBlocked($contact['id'], $importer['id'])) {
3158 // Make sure that the existing contact isn't archived
3159 self::unmarkForArchival($contact);
3161 if (($contact['rel'] == self::SHARING)
3162 || ($sharing && $contact['rel'] == self::FOLLOWER)) {
3163 self::update(['rel' => self::FRIEND, 'writable' => true, 'pending' => false],
3164 ['id' => $contact['id'], 'uid' => $importer['uid']]);
3167 // Ensure to always have the correct network type, independent from the connection request method
3168 self::updateFromProbe($contact['id']);
3170 Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
3174 // send email notification to owner?
3175 if (DBA::exists('contact', ['nurl' => Strings::normaliseLink($url), 'uid' => $importer['uid'], 'pending' => true])) {
3176 Logger::notice('ignoring duplicated connection request from pending contact ' . $url);
3180 // create contact record
3181 $contact_id = self::insert([
3182 'uid' => $importer['uid'],
3183 'created' => DateTimeFormat::utcNow(),
3185 'nurl' => Strings::normaliseLink($url),
3188 'network' => $network,
3189 'rel' => self::FOLLOWER,
3196 // Ensure to always have the correct network type, independent from the connection request method
3197 self::updateFromProbe($contact_id);
3199 self::updateAvatar($contact_id, $photo, true);
3201 Post\UserNotification::insertNotification($pub_contact['id'], Activity::FOLLOW, $importer['uid']);
3203 $contact_record = DBA::selectFirst('contact', ['id', 'network', 'name', 'url', 'photo'], ['id' => $contact_id]);
3205 /// @TODO Encapsulate this into a function/method
3206 $fields = ['uid', 'username', 'email', 'page-flags', 'notify-flags', 'language'];
3207 $user = DBA::selectFirst('user', $fields, ['uid' => $importer['uid']]);
3208 if (DBA::isResult($user) && !in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
3209 // create notification
3210 if (is_array($contact_record)) {
3211 $intro = DI::introFactory()->createNew(
3213 $contact_record['id'],
3216 DI::intro()->save($intro);
3219 Group::addMember(User::getDefaultGroup($importer['uid']), $contact_record['id']);
3221 if (($user['notify-flags'] & Notification\Type::INTRO) && $user['page-flags'] == User::PAGE_FLAGS_NORMAL) {
3222 DI::notify()->createFromArray([
3223 'type' => Notification\Type::INTRO,
3224 'otype' => Notification\ObjectType::INTRO,
3225 'verb' => ($sharing ? Activity::FRIEND : Activity::FOLLOW),
3226 'uid' => $user['uid'],
3227 'cid' => $contact_record['id'],
3228 'link' => DI::baseUrl() . '/notifications/intros',
3231 } elseif (DBA::isResult($user) && in_array($user['page-flags'], [User::PAGE_FLAGS_SOAPBOX, User::PAGE_FLAGS_FREELOVE, User::PAGE_FLAGS_COMMUNITY])) {
3232 if (($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) && ($network != Protocol::DIASPORA)) {
3233 self::createFromProbeForUser($importer['uid'], $url, $network);
3236 $condition = ['uid' => $importer['uid'], 'url' => $url, 'pending' => true];
3237 $fields = ['pending' => false];
3238 if ($user['page-flags'] == User::PAGE_FLAGS_FREELOVE) {
3239 $fields['rel'] = self::FRIEND;
3242 self::update($fields, $condition);
3252 * Update the local relationship when a local user loses a follower
3254 * @param array $contact User-specific contact (uid != 0) array
3256 * @throws HTTPException\InternalServerErrorException
3257 * @throws \ImagickException
3259 public static function removeFollower(array $contact)
3261 if (in_array($contact['rel'] ?? [], [self::FRIEND, self::SHARING])) {
3262 self::update(['rel' => self::SHARING], ['id' => $contact['id']]);
3263 } elseif (!empty($contact['id'])) {
3264 self::remove($contact['id']);
3266 DI::logger()->info('Couldn\'t remove follower because of invalid contact array', ['contact' => $contact, 'callstack' => System::callstack()]);
3270 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscoveryForUser', $contact['uid']);
3272 self::clearFollowerFollowingEndpointCache($contact['uid']);
3274 $cdata = self::getPublicAndUserContactID($contact['id'], $contact['uid']);
3275 if (!empty($cdata['public'])) {
3276 DI::notification()->deleteForUserByVerb($contact['uid'], Activity::FOLLOW, ['actor-id' => $cdata['public']]);
3281 * Update the local relationship when a local user unfollow a contact.
3282 * Removes the contact for sharing-only protocols (feed and mail).
3284 * @param array $contact User-specific contact (uid != 0) array
3285 * @throws HTTPException\InternalServerErrorException
3287 public static function removeSharer(array $contact)
3289 self::clearFollowerFollowingEndpointCache($contact['uid']);
3291 if ($contact['rel'] == self::SHARING || in_array($contact['network'], [Protocol::FEED, Protocol::MAIL])) {
3292 self::remove($contact['id']);
3294 self::update(['rel' => self::FOLLOWER], ['id' => $contact['id']]);
3297 Worker::add(Worker::PRIORITY_LOW, 'ContactDiscoveryForUser', $contact['uid']);
3301 * Create a birthday event.
3303 * Update the year and the birthday.
3305 public static function updateBirthdays()
3309 AND (`contact`.`rel` = ? OR `contact`.`rel` = ?)
3310 AND NOT `contact`.`pending`
3311 AND NOT `contact`.`hidden`
3312 AND NOT `contact`.`blocked`
3313 AND NOT `contact`.`archive`
3314 AND NOT `contact`.`deleted`',
3320 $contacts = DBA::select('contact', ['id', 'uid', 'name', 'url', 'bd'], $condition);
3322 while ($contact = DBA::fetch($contacts)) {
3323 Logger::notice('update_contact_birthday: ' . $contact['bd']);
3325 $nextbd = DateTimeFormat::utcNow('Y') . substr($contact['bd'], 4);
3327 if (Event::createBirthday($contact, $nextbd)) {
3331 ['bdyear' => substr($nextbd, 0, 4), 'bd' => $nextbd],
3332 ['id' => $contact['id']]
3336 DBA::close($contacts);
3340 * Remove the unavailable contact ids from the provided list
3342 * @param array $contact_ids Contact id list
3344 * @throws \Exception
3346 public static function pruneUnavailable(array $contact_ids): array
3348 if (empty($contact_ids)) {
3352 $contacts = self::selectToArray(['id'], [
3353 'id' => $contact_ids,
3359 return array_column($contacts, 'id');
3363 * Returns a magic link to authenticate remote visitors
3365 * @todo check if the return is either a fully qualified URL or a relative path to Friendica basedir
3367 * @param string $contact_url The address of the target contact profile
3368 * @param string $url An url that we will be redirected to after the authentication
3370 * @return string with "redir" link
3371 * @throws HTTPException\InternalServerErrorException
3372 * @throws \ImagickException
3374 public static function magicLink(string $contact_url, string $url = ''): string
3376 if (!DI::userSession()->isAuthenticated()) {
3377 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3380 $contact = self::getByURL($contact_url, false);
3381 if (empty($contact)) {
3382 return $url ?: $contact_url; // Equivalent to: ($url != '') ? $url : $contact_url;
3385 // Prevents endless loop in case only a non-public contact exists for the contact URL
3386 unset($contact['uid']);
3388 return self::magicLinkByContact($contact, $url ?: $contact_url);
3392 * Returns a magic link to authenticate remote visitors
3394 * @param integer $cid The contact id of the target contact profile
3395 * @param string $url An url that we will be redirected to after the authentication
3397 * @return string with "redir" link
3398 * @throws HTTPException\InternalServerErrorException
3399 * @throws \ImagickException
3401 public static function magicLinkById(int $cid, string $url = ''): string
3403 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], ['id' => $cid]);
3405 return self::magicLinkByContact($contact, $url);
3409 * Returns a magic link to authenticate remote visitors
3411 * @param array $contact The contact array with "uid", "network" and "url"
3412 * @param string $url An url that we will be redirected to after the authentication
3414 * @return string with "redir" link
3415 * @throws HTTPException\InternalServerErrorException
3416 * @throws \ImagickException
3418 public static function magicLinkByContact(array $contact, string $url = ''): string
3420 $destination = $url ?: $contact['url']; // Equivalent to ($url != '') ? $url : $contact['url'];
3422 if (!DI::userSession()->isAuthenticated()) {
3423 return $destination;
3426 // Only redirections to the same host do make sense
3427 if (($url != '') && (parse_url($url, PHP_URL_HOST) != parse_url($contact['url'], PHP_URL_HOST))) {
3431 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'stay_local') && ($url == '')) {
3432 return 'contact/' . $contact['id'] . '/conversations';
3435 if (!empty($contact['network']) && $contact['network'] != Protocol::DFRN) {
3436 return $destination;
3439 if (empty($contact['id'])) {
3440 return $destination;
3443 $redirect = 'contact/redir/' . $contact['id'];
3445 if (($url != '') && !Strings::compareLink($contact['url'], $url)) {
3446 $redirect .= '?url=' . $url;
3453 * Is the contact a forum?
3455 * @param integer $contactid ID of the contact
3457 * @return boolean "true" if it is a forum
3459 public static function isForum(int $contactid): bool
3461 $fields = ['contact-type'];
3462 $condition = ['id' => $contactid];
3463 $contact = DBA::selectFirst('contact', $fields, $condition);
3464 if (!DBA::isResult($contact)) {
3469 return ($contact['contact-type'] == self::TYPE_COMMUNITY);
3473 * Can the remote contact receive private messages?
3475 * @param array $contact
3478 public static function canReceivePrivateMessages(array $contact): bool
3480 $protocol = $contact['network'] ?? $contact['protocol'] ?? Protocol::PHANTOM;
3481 $self = $contact['self'] ?? false;
3483 return in_array($protocol, [Protocol::DFRN, Protocol::DIASPORA, Protocol::ACTIVITYPUB]) && !$self;
3487 * Search contact table by nick or name
3489 * @param string $search Name or nick
3490 * @param string $mode Search mode (e.g. "community")
3491 * @param int $uid User ID
3492 * @param int $limit Maximum amount of returned values
3493 * @param int $offset Limit offset
3495 * @return array with search results
3496 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
3498 public static function searchByName(string $search, string $mode = '', int $uid = 0, int $limit = 0, int $offset = 0): array
3500 if (empty($search)) {
3504 // check supported networks
3505 $networks = [Protocol::DFRN, Protocol::ACTIVITYPUB];
3506 if (DI::config()->get('system', 'diaspora_enabled')) {
3507 $networks[] = Protocol::DIASPORA;
3510 if (!DI::config()->get('system', 'ostatus_disabled')) {
3511 $networks[] = Protocol::OSTATUS;
3514 $condition = ['network' => $networks, 'failed' => false, 'deleted' => false, 'uid' => $uid];
3517 $condition['blocked'] = false;
3519 $condition['rel'] = [Contact::SHARING, Contact::FRIEND];
3522 // check if we search only communities or every contact
3523 if ($mode === 'community') {
3524 $condition['contact-type'] = self::TYPE_COMMUNITY;
3531 if (!empty($limit) && !empty($offset)) {
3532 $params['limit'] = [$offset, $limit];
3533 } elseif (!empty($limit)) {
3534 $params['limit'] = $limit;
3537 $condition = DBA::mergeConditions($condition,
3538 ["(NOT `unsearchable` OR `nurl` IN (SELECT `nurl` FROM `owner-view` WHERE `publish` OR `net-publish`))
3539 AND (`addr` LIKE ? OR `name` LIKE ? OR `nick` LIKE ?)", $search, $search, $search]);
3541 return self::selectToArray([], $condition, $params);
3545 * Add public contacts from an array
3547 * @param array $urls
3548 * @return array result "count", "added" and "updated"
3550 public static function addByUrls(array $urls): array
3557 foreach ($urls as $url) {
3558 if (empty($url) || !is_string($url)) {
3561 $contact = self::getByURL($url, false, ['id', 'network', 'next-update']);
3562 if (empty($contact['id']) && Network::isValidHttpUrl($url)) {
3563 Worker::add(Worker::PRIORITY_LOW, 'AddContact', 0, $url);
3565 } elseif (!empty($contact['network']) && Probe::isProbable($contact['network']) && ($contact['next-update'] < DateTimeFormat::utcNow())) {
3567 UpdateContact::add(['priority' => Worker::PRIORITY_LOW, 'dont_fork' => true], $contact['id']);
3569 } catch (\InvalidArgumentException $e) {
3570 Logger::notice($e->getMessage(), ['contact' => $contact]);
3578 return ['count' => $count, 'added' => $added, 'updated' => $updated, 'unchanged' => $unchanged];
3582 * Returns a random, global contact array of the current node
3584 * @return array The profile array
3587 public static function getRandomContact(): array
3589 $contact = DBA::selectFirst('contact', ['id', 'network', 'url', 'uid'], [
3590 "`uid` = ? AND `network` = ? AND NOT `failed` AND `last-item` > ?",
3591 0, Protocol::DFRN, DateTimeFormat::utc('now - 1 month'),
3592 ], ['order' => ['RAND()']]);
3594 if (DBA::isResult($contact)) {
3602 * Checks, if contacts with the given condition exists
3604 * @param array $condition
3607 * @throws \Exception
3609 public static function exists(array $condition): bool
3611 return DBA::exists('contact', $condition);