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\Module\Contact;
25 use Friendica\BaseModule;
26 use Friendica\Contact\LocalRelationship;
27 use Friendica\Content\ContactSelector;
28 use Friendica\Content\Nav;
29 use Friendica\Content\Text\BBCode;
30 use Friendica\Content\Widget;
31 use Friendica\Core\Config\Capability\IManageConfigValues;
32 use Friendica\Core\Hook;
33 use Friendica\Core\L10n;
34 use Friendica\Core\Protocol;
35 use Friendica\Core\Renderer;
36 use Friendica\Core\Session\Capability\IHandleUserSessions;
37 use Friendica\Database\Database;
38 use Friendica\Database\DBA;
39 use Friendica\Model\Circle;
40 use Friendica\Model\Contact;
42 use Friendica\Module\Response;
43 use Friendica\Navigation\SystemMessages;
44 use Friendica\Network\HTTPException;
45 use Friendica\User\Settings;
46 use Friendica\Util\DateTimeFormat;
47 use Friendica\Util\Profiler;
48 use Psr\Log\LoggerInterface;
51 * Show a contact profile
53 class Profile extends BaseModule
55 /** @var LocalRelationship\Repository\LocalRelationship */
56 private $localRelationship;
59 /** @var IManageConfigValues */
61 /** @var IHandleUserSessions */
63 /** @var SystemMessages */
64 private $systemMessages;
67 /** @var Settings\Repository\UserGServer */
70 public function __construct(Settings\Repository\UserGServer $userGServer, Database $db, SystemMessages $systemMessages, IHandleUserSessions $session, L10n $l10n, LocalRelationship\Repository\LocalRelationship $localRelationship, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, App\Page $page, IManageConfigValues $config, array $server, array $parameters = [])
72 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
74 $this->localRelationship = $localRelationship;
76 $this->config = $config;
77 $this->session = $session;
78 $this->systemMessages = $systemMessages;
80 $this->userGServer = $userGServer;
83 protected function post(array $request = [])
85 if (!$this->session->getLocalUserId()) {
89 $contact_id = $this->parameters['id'];
91 // Backward compatibility: The update still needs a user-specific contact ID
92 // Change to user-contact table check by version 2022.03
93 $cdata = Contact::getPublicAndUserContactID($contact_id, $this->session->getLocalUserId());
94 if (empty($cdata['user']) || !$this->db->exists('contact', ['id' => $cdata['user'], 'deleted' => false])) {
98 Hook::callAll('contact_edit_post', $_POST);
102 if (isset($_POST['hidden'])) {
103 $fields['hidden'] = !empty($_POST['hidden']);
106 if (isset($_POST['notify_new_posts'])) {
107 $fields['notify_new_posts'] = !empty($_POST['notify_new_posts']);
110 if (isset($_POST['fetch_further_information'])) {
111 $fields['fetch_further_information'] = intval($_POST['fetch_further_information']);
114 if (isset($_POST['remote_self'])) {
115 $fields['remote_self'] = intval($_POST['remote_self']);
118 if (isset($_POST['ffi_keyword_denylist'])) {
119 $fields['ffi_keyword_denylist'] = $_POST['ffi_keyword_denylist'];
122 if (isset($_POST['poll'])) {
123 $priority = intval($_POST['poll']);
124 if ($priority > 5 || $priority < 0) {
128 $fields['priority'] = $priority;
131 if (isset($_POST['info'])) {
132 $fields['info'] = $_POST['info'];
135 if (isset($_POST['channel_frequency'])) {
136 Contact\User::setChannelFrequency($cdata['user'], $this->session->getLocalUserId(), $_POST['channel_frequency']);
139 if (!Contact::update($fields, ['id' => $cdata['user'], 'uid' => $this->session->getLocalUserId()])) {
140 $this->systemMessages->addNotice($this->t('Failed to update contact record.'));
144 protected function content(array $request = []): string
146 if (!$this->session->getLocalUserId()) {
147 return Module\Security\Login::form($_SERVER['REQUEST_URI']);
150 // Backward compatibility: Ensure to use the public contact when the user contact is provided
151 // Remove by version 2022.03
152 $data = Contact::getPublicAndUserContactID(intval($this->parameters['id']), $this->session->getLocalUserId());
154 throw new HTTPException\NotFoundException($this->t('Contact not found.'));
157 $contact = Contact::getById($data['public']);
158 if (!$this->db->isResult($contact)) {
159 throw new HTTPException\NotFoundException($this->t('Contact not found.'));
162 // Don't display contacts that are about to be deleted
163 if ($this->db->isResult($contact) && (!empty($contact['deleted']) || !empty($contact['network']) && $contact['network'] == Protocol::PHANTOM)) {
164 throw new HTTPException\NotFoundException($this->t('Contact not found.'));
167 $localRelationship = $this->localRelationship->getForUserContact($this->session->getLocalUserId(), $contact['id']);
169 if ($localRelationship->rel === Contact::SELF) {
170 $this->baseUrl->redirect('profile/' . $contact['nick'] . '/profile');
173 if (isset($this->parameters['action'])) {
174 self::checkFormSecurityTokenRedirectOnError('contact/' . $contact['id'], 'contact_action', 't');
176 $cmd = $this->parameters['action'];
177 if ($cmd === 'update' && $localRelationship->rel !== Contact::NOTHING) {
178 Module\Contact::updateContactFromPoll($contact['id']);
181 if ($cmd === 'updateprofile') {
182 $this->updateContactFromProbe($contact['id']);
185 if ($cmd === 'block') {
186 if ($localRelationship->blocked) {
187 // @TODO Backward compatibility, replace with $localRelationship->unblock()
188 Contact\User::setBlocked($contact['id'], $this->session->getLocalUserId(), false);
190 $message = $this->t('Contact has been unblocked');
192 // @TODO Backward compatibility, replace with $localRelationship->block()
193 Contact\User::setBlocked($contact['id'], $this->session->getLocalUserId(), true);
194 $message = $this->t('Contact has been blocked');
197 // @TODO: add $this->localRelationship->save($localRelationship);
198 $this->systemMessages->addInfo($message);
201 if ($cmd === 'ignore') {
202 if ($localRelationship->ignored) {
203 // @TODO Backward compatibility, replace with $localRelationship->unblock()
204 Contact\User::setIgnored($contact['id'], $this->session->getLocalUserId(), false);
206 $message = $this->t('Contact has been unignored');
208 // @TODO Backward compatibility, replace with $localRelationship->block()
209 Contact\User::setIgnored($contact['id'], $this->session->getLocalUserId(), true);
210 $message = $this->t('Contact has been ignored');
213 // @TODO: add $this->localRelationship->save($localRelationship);
214 $this->systemMessages->addInfo($message);
217 if ($cmd === 'collapse') {
218 if ($localRelationship->collapsed) {
219 // @TODO Backward compatibility, replace with $localRelationship->unblock()
220 Contact\User::setCollapsed($contact['id'], $this->session->getLocalUserId(), false);
222 $message = $this->t('Contact has been uncollapsed');
224 // @TODO Backward compatibility, replace with $localRelationship->block()
225 Contact\User::setCollapsed($contact['id'], $this->session->getLocalUserId(), true);
226 $message = $this->t('Contact has been collapsed');
229 // @TODO: add $this->localRelationship->save($localRelationship);
230 $this->systemMessages->addInfo($message);
233 $this->baseUrl->redirect('contact/' . $contact['id']);
236 $vcard_widget = Widget\VCard::getHTML($contact);
237 $circles_widget = '';
239 if (!in_array($localRelationship->rel, [Contact::NOTHING, Contact::SELF])) {
240 $circles_widget = Circle::sidebarWidget('contact', 'circle', 'full', 'everyone', $data['user']);
243 $this->page['aside'] .= $vcard_widget . $circles_widget;
246 Nav::setSelected('contact');
248 $_SESSION['return_path'] = $this->args->getQueryString();
250 $this->page['htmlhead'] .= Renderer::replaceMacros(Renderer::getMarkupTemplate('contact_head.tpl'), [
253 switch ($localRelationship->rel) {
254 case Contact::FRIEND: $relation_text = $this->t('You are mutual friends with %s', $contact['name']); break;
255 case Contact::FOLLOWER: $relation_text = $this->t('You are sharing with %s', $contact['name']); break;
256 case Contact::SHARING: $relation_text = $this->t('%s is sharing with you', $contact['name']); break;
261 if (!Protocol::supportsFollow($contact['network'])) {
265 $url = Contact::magicLinkByContact($contact);
266 if (strpos($url, 'contact/redir/') === 0) {
267 $sparkle = ' class="sparkle" ';
272 $insecure = $this->t('Private communications are not available for this contact.');
274 // @TODO: Figure out why gsid can be empty
275 if (empty($contact['gsid'])) {
276 $this->logger->notice('Empty gsid for contact', ['contact' => $contact]);
281 $this->userGServer->isIgnoredByUser($this->session->getLocalUserId(), $contact['gsid']) ?
282 $this->t('This contact is on a server you ignored.')
285 $last_update = (($contact['last-update'] <= DBA::NULL_DATETIME) ? $this->t('Never') : DateTimeFormat::local($contact['last-update'], 'D, j M Y, g:i A'));
287 if ($contact['last-update'] > DBA::NULL_DATETIME) {
288 $last_update .= ' ' . ($contact['failed'] ? $this->t('(Update was not successful)') : $this->t('(Update was successful)'));
290 $lblsuggest = (($contact['network'] === Protocol::DFRN) ? $this->t('Suggest friends') : '');
292 $poll_enabled = in_array($contact['network'], [Protocol::DFRN, Protocol::OSTATUS, Protocol::FEED, Protocol::MAIL]);
294 $nettype = $this->t('Network type: %s', ContactSelector::networkToName($contact['network'], $contact['url'], $contact['protocol'], $contact['gsid']));
297 $tab_str = Module\Contact::getTabsHTML($contact, Module\Contact::TAB_PROFILE);
299 $lost_contact = (($contact['archive'] && $contact['term-date'] > DBA::NULL_DATETIME && $contact['term-date'] < DateTimeFormat::utcNow()) ? $this->t('Communications lost with this contact!') : '');
301 $fetch_further_information = null;
302 if ($contact['network'] == Protocol::FEED) {
303 $fetch_further_information = [
304 'fetch_further_information',
305 $this->t('Fetch further information for feeds'),
306 $localRelationship->fetchFurtherInformation,
307 $this->t('Fetch information like preview pictures, title and teaser from the feed item. You can activate this if the feed doesn\'t contain much text. Keywords are taken from the meta header in the feed item and are posted as hash tags.'),
309 LocalRelationship\Entity\LocalRelationship::FFI_NONE => $this->t('Disabled'),
310 LocalRelationship\Entity\LocalRelationship::FFI_INFORMATION => $this->t('Fetch information'),
311 LocalRelationship\Entity\LocalRelationship::FFI_KEYWORD => $this->t('Fetch keywords'),
312 LocalRelationship\Entity\LocalRelationship::FFI_BOTH => $this->t('Fetch information and keywords')
317 $allow_remote_self = in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::FEED, Protocol::DFRN, Protocol::DIASPORA, Protocol::TWITTER])
318 && $this->config->get('system', 'allow_users_remote_self');
320 if ($contact['network'] == Protocol::FEED) {
321 $remote_self_options = [
322 Contact::MIRROR_DEACTIVATED => $this->t('No mirroring'),
323 Contact::MIRROR_OWN_POST => $this->t('Mirror as my own posting')
325 } elseif ($contact['network'] == Protocol::ACTIVITYPUB) {
326 $remote_self_options = [
327 Contact::MIRROR_DEACTIVATED => $this->t('No mirroring'),
328 Contact::MIRROR_NATIVE_RESHARE => $this->t('Native reshare')
330 } elseif ($contact['network'] == Protocol::DFRN) {
331 $remote_self_options = [
332 Contact::MIRROR_DEACTIVATED => $this->t('No mirroring'),
333 Contact::MIRROR_OWN_POST => $this->t('Mirror as my own posting'),
334 Contact::MIRROR_NATIVE_RESHARE => $this->t('Native reshare')
337 $remote_self_options = [
338 Contact::MIRROR_DEACTIVATED => $this->t('No mirroring'),
339 Contact::MIRROR_OWN_POST => $this->t('Mirror as my own posting')
343 $channel_frequency = Contact\User::getChannelFrequency($contact['id'], $this->session->getLocalUserId());
345 $poll_interval = null;
346 if ((($contact['network'] == Protocol::FEED) && !$this->config->get('system', 'adjust_poll_frequency')) || ($contact['network'] == Protocol::MAIL)) {
347 $poll_interval = ContactSelector::pollInterval($localRelationship->priority, !$poll_enabled);
350 $contact_actions = $this->getContactActions($contact, $localRelationship);
352 if ($localRelationship->rel !== Contact::NOTHING) {
353 $lbl_info1 = $this->t('Contact Information / Notes');
354 $contact_settings_label = $this->t('Contact Settings');
357 $contact_settings_label = null;
360 $tpl = Renderer::getMarkupTemplate('contact_edit.tpl');
361 $o .= Renderer::replaceMacros($tpl, [
362 '$header' => $this->t('Contact'),
363 '$tab_str' => $tab_str,
364 '$submit' => $this->t('Submit'),
365 '$lbl_info1' => $lbl_info1,
366 '$lbl_info2' => $this->t('Their personal note'),
367 '$reason' => trim($contact['reason'] ?? ''),
368 '$infedit' => $this->t('Edit contact notes'),
369 '$common_link' => 'contact/' . $contact['id'] . '/contacts/common',
370 '$relation_text' => $relation_text,
371 '$visit' => $this->t('Visit %s\'s profile [%s]', $contact['name'], $contact['url']),
372 '$blockunblock' => $this->t('Block/Unblock contact'),
373 '$ignorecont' => $this->t('Ignore contact'),
374 '$lblrecent' => $this->t('View conversations'),
375 '$lblsuggest' => $lblsuggest,
376 '$nettype' => $nettype,
377 '$poll_interval' => $poll_interval,
378 '$poll_enabled' => $poll_enabled,
379 '$lastupdtext' => $this->t('Last update:'),
380 '$lost_contact' => $lost_contact,
381 '$updpub' => $this->t('Update public posts'),
382 '$last_update' => $last_update,
383 '$udnow' => $this->t('Update now'),
384 '$contact_id' => $contact['id'],
385 '$pending' => $localRelationship->pending ? $this->t('Awaiting connection acknowledge') : '',
386 '$blocked' => $localRelationship->blocked ? $this->t('Currently blocked') : '',
387 '$ignored' => $localRelationship->ignored ? $this->t('Currently ignored') : '',
388 '$collapsed' => $localRelationship->collapsed ? $this->t('Currently collapsed') : '',
389 '$archived' => ($contact['archive'] ? $this->t('Currently archived') : ''),
390 '$insecure' => (in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::MAIL, Protocol::DIASPORA]) ? '' : $insecure),
391 '$serverIgnored' => $serverIgnored,
392 '$manageServers' => $this->t('Manage remote servers'),
393 '$cinfo' => ['info', '', $localRelationship->info, ''],
394 '$hidden' => ['hidden', $this->t('Hide this contact from others'), $localRelationship->hidden, $this->t('Replies/likes to your public posts <strong>may</strong> still be visible')],
395 '$notify_new_posts' => ['notify_new_posts', $this->t('Notification for new posts'), ($localRelationship->notifyNewPosts), $this->t('Send a notification of every new post of this contact')],
396 '$fetch_further_information' => $fetch_further_information,
397 '$ffi_keyword_denylist' => ['ffi_keyword_denylist', $this->t('Keyword Deny List'), $localRelationship->ffiKeywordDenylist, $this->t('Comma separated list of keywords that should not be converted to hashtags, when "Fetch information and keywords" is selected')],
398 '$photo' => Contact::getPhoto($contact),
399 '$name' => $contact['name'],
400 '$sparkle' => $sparkle,
402 '$profileurllabel' => $this->t('Profile URL'),
403 '$profileurl' => $contact['url'],
404 '$account_type' => Contact::getAccountType($contact['contact-type']),
405 '$location' => BBCode::convertForUriId($contact['uri-id'] ?? 0, $contact['location']),
406 '$location_label' => $this->t('Location:'),
407 '$xmpp' => BBCode::convertForUriId($contact['uri-id'] ?? 0, $contact['xmpp']),
408 '$xmpp_label' => $this->t('XMPP:'),
409 '$matrix' => BBCode::convertForUriId($contact['uri-id'] ?? 0, $contact['matrix']),
410 '$matrix_label' => $this->t('Matrix:'),
411 '$about' => BBCode::convertForUriId($contact['uri-id'] ?? 0, $contact['about'], BBCode::EXTERNAL),
412 '$about_label' => $this->t('About:'),
413 '$keywords' => $contact['keywords'],
414 '$keywords_label' => $this->t('Tags:'),
415 '$contact_action_button' => $this->t('Actions'),
416 '$contact_actions' => $contact_actions,
417 '$contact_status' => $this->t('Status'),
418 '$contact_settings_label' => $contact_settings_label,
419 '$contact_profile_label' => $this->t('Profile'),
420 '$allow_remote_self' => $allow_remote_self,
423 $this->t('Mirror postings from this contact'),
424 $localRelationship->remoteSelf,
425 $this->t('Mark this contact as remote_self, this will cause friendica to repost new entries from this contact.'),
428 '$channel_settings_label' => $this->t('Channel Settings'),
429 '$frequency_label' => $this->t('Frequency of this contact in relevant channels'),
430 '$frequency_description' => $this->t("Depending on the type of the channel not all posts from this contact are displayed. By default, posts need to have a minimum amount of interactions (comments, likes) to show in your channels. On the other hand there can be contacts who flood the channel, so you might want to see only some of their posts. Or you don't want to see their content at all, but you don't want to block or hide the contact completely."),
431 '$frequency_default' => ['channel_frequency', $this->t('Default frequency'), Contact\User::FREQUENCY_DEFAULT, $this->t('Posts by this contact are displayed in the "for you" channel if you interact often with this contact or if a post reached some level of interaction.'), $channel_frequency == Contact\User::FREQUENCY_DEFAULT],
432 '$frequency_always' => ['channel_frequency', $this->t('Display all posts of this contact'), Contact\User::FREQUENCY_ALWAYS, $this->t('All posts from this contact will appear on the "for you" channel'), $channel_frequency == Contact\User::FREQUENCY_ALWAYS],
433 '$frequency_reduced' => ['channel_frequency', $this->t('Display only few posts'), Contact\User::FREQUENCY_REDUCED, $this->t('When a contact creates a lot of posts in a short period, this setting reduces the number of displayed posts in every channel.'), $channel_frequency == Contact\User::FREQUENCY_REDUCED],
434 '$frequency_never' => ['channel_frequency', $this->t('Never display posts'), Contact\User::FREQUENCY_NEVER, $this->t('Posts from this contact will never be displayed in any channel'), $channel_frequency == Contact\User::FREQUENCY_NEVER],
437 $arr = ['contact' => $contact, 'output' => $o];
439 Hook::callAll('contact_edit', $arr);
441 return $arr['output'];
445 * Returns the list of available actions that can performed on the provided contact
447 * This includes actions like e.g. 'block', 'hide', 'delete' and others
449 * @param array $contact Public contact row
450 * @param LocalRelationship\Entity\LocalRelationship $localRelationship
451 * @return array with contact related actions
452 * @throws HTTPException\InternalServerErrorException
454 private function getContactActions(array $contact, LocalRelationship\Entity\LocalRelationship $localRelationship): array
456 $poll_enabled = in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::OSTATUS, Protocol::FEED, Protocol::MAIL]);
457 $contact_actions = [];
459 $formSecurityToken = self::getFormSecurityToken('contact_action');
461 if ($localRelationship->rel & Contact::SHARING) {
462 $contact_actions['unfollow'] = [
463 'label' => $this->t('Unfollow'),
464 'url' => 'contact/unfollow?url=' . urlencode($contact['url']) . '&auto=1',
470 $contact_actions['follow'] = [
471 'label' => $this->t('Follow'),
472 'url' => 'contact/follow?url=' . urlencode($contact['url']) . '&auto=1',
479 // Provide friend suggestion only for Friendica contacts
480 if ($contact['network'] === Protocol::DFRN) {
481 $contact_actions['suggest'] = [
482 'label' => $this->t('Suggest friends'),
483 'url' => 'fsuggest/' . $contact['id'],
491 $contact_actions['update'] = [
492 'label' => $this->t('Update now'),
493 'url' => 'contact/' . $contact['id'] . '/update?t=' . $formSecurityToken,
500 if (Protocol::supportsProbe($contact['network'])) {
501 $contact_actions['updateprofile'] = [
502 'label' => $this->t('Refetch contact data'),
503 'url' => 'contact/' . $contact['id'] . '/updateprofile?t=' . $formSecurityToken,
506 'id' => 'updateprofile',
510 $contact_actions['block'] = [
511 'label' => $localRelationship->blocked ? $this->t('Unblock') : $this->t('Block'),
512 'url' => 'contact/' . $contact['id'] . '/block?t=' . $formSecurityToken,
513 'title' => $this->t('Toggle Blocked status'),
514 'sel' => $localRelationship->blocked ? 'active' : '',
515 'id' => 'toggle-block',
518 $contact_actions['ignore'] = [
519 'label' => $localRelationship->ignored ? $this->t('Unignore') : $this->t('Ignore'),
520 'url' => 'contact/' . $contact['id'] . '/ignore?t=' . $formSecurityToken,
521 'title' => $this->t('Toggle Ignored status'),
522 'sel' => $localRelationship->ignored ? 'active' : '',
523 'id' => 'toggle-ignore',
526 $contact_actions['collapse'] = [
527 'label' => $localRelationship->collapsed ? $this->t('Uncollapse') : $this->t('Collapse'),
528 'url' => 'contact/' . $contact['id'] . '/collapse?t=' . $formSecurityToken,
529 'title' => $this->t('Toggle Collapsed status'),
530 'sel' => $localRelationship->collapsed ? 'active' : '',
531 'id' => 'toggle-collapse',
534 if (Protocol::supportsRevokeFollow($contact['network']) && in_array($localRelationship->rel, [Contact::FOLLOWER, Contact::FRIEND])) {
535 $contact_actions['revoke_follow'] = [
536 'label' => $this->t('Revoke Follow'),
537 'url' => 'contact/' . $contact['id'] . '/revoke',
538 'title' => $this->t('Revoke the follow from this contact'),
540 'id' => 'revoke_follow',
544 return $contact_actions;
548 * Updates contact from probing
550 * @param int $contact_id Id of the contact with uid != 0
552 * @throws HTTPException\InternalServerErrorException
553 * @throws \ImagickException
555 private function updateContactFromProbe(int $contact_id)
557 if (!$this->db->exists('contact', ['id' => $contact_id, 'uid' => [0, $this->session->getLocalUserId()], 'deleted' => false])) {
561 // Update the entry in the contact table
562 Contact::updateFromProbe($contact_id);