3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Content;
24 use Friendica\Content\Text\BBCode;
25 use Friendica\Core\Hook;
26 use Friendica\Core\L10n;
27 use Friendica\Core\Logger;
28 use Friendica\Core\Protocol;
29 use Friendica\Database\DBA;
30 use Friendica\Model\Contact;
31 use Friendica\Model\Group;
32 use Friendica\Model\Item as ModelItem;
33 use Friendica\Model\Photo;
34 use Friendica\Model\Tag;
35 use Friendica\Model\Post;
36 use Friendica\Protocol\Activity;
37 use Friendica\Util\Profiler;
38 use Friendica\Util\Proxy;
39 use Friendica\Util\XML;
42 * A content helper class for displaying items
53 public function __construct(Profiler $profiler, Activity $activity, L10n $l10n)
55 $this->profiler = $profiler;
56 $this->activity = $activity;
61 * Return array with details for categories and folders for an item
65 * @return [array, array]
68 * [ // categories array
70 * 'name': 'category name',
71 * 'removeurl': 'url to remove this category',
72 * 'first': 'is the first in this array? true/false',
73 * 'last': 'is the last in this array? true/false',
79 * 'name': 'folder name',
80 * 'removeurl': 'url to remove this folder',
81 * 'first': 'is the first in this array? true/false',
82 * 'last': 'is the last in this array? true/false',
88 public function determineCategoriesTerms(array $item, int $uid = 0): array
94 $uid = $item['uid'] ?: $uid;
96 if (empty($item['has-categories'])) {
97 return [$categories, $folders];
100 foreach (Post\Category::getArrayByURIId($item['uri-id'], $uid, Post\Category::CATEGORY) as $savedFolderName) {
101 if (!empty($item['author-link'])) {
102 $url = $item['author-link'] . "?category=" . rawurlencode($savedFolderName);
107 'name' => $savedFolderName,
109 'removeurl' => local_user() == $uid ? 'filerm/' . $item['id'] . '?cat=' . rawurlencode($savedFolderName) : '',
116 if (count($categories)) {
117 $categories[count($categories) - 1]['last'] = true;
120 if (local_user() == $uid) {
121 foreach (Post\Category::getArrayByURIId($item['uri-id'], $uid, Post\Category::FILE) as $savedFolderName) {
123 'name' => $savedFolderName,
125 'removeurl' => local_user() == $uid ? 'filerm/' . $item['id'] . '?term=' . rawurlencode($savedFolderName) : '',
133 if (count($folders)) {
134 $folders[count($folders) - 1]['last'] = true;
137 return [$categories, $folders];
141 * This function removes the tag $tag from the text $body and replaces it with
142 * the appropriate link.
144 * @param string $body the text to replace the tag in
145 * @param int $profile_uid the user id to replace the tag for (0 = anyone)
146 * @param string $tag the tag to replace
147 * @param string $network The network of the post
149 * @return array|bool ['replaced' => $replaced, 'contact' => $contact] or "false" on if already replaced
150 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
151 * @throws \ImagickException
153 public static function replaceTag(string &$body, int $profile_uid, string $tag, string $network = '')
157 //is it a person tag?
158 if (Tag::isType($tag, Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION)) {
159 $tag_type = substr($tag, 0, 1);
160 //is it already replaced?
161 if (strpos($tag, '[url=')) {
165 //get the person's name
166 $name = substr($tag, 1);
168 // Sometimes the tag detection doesn't seem to work right
169 // This is some workaround
170 $nameparts = explode(' ', $name);
171 $name = $nameparts[0];
173 // Try to detect the contact in various ways
174 if (strpos($name, 'http://') || strpos($name, '@')) {
175 $contact = Contact::getByURLForUser($name, $profile_uid);
178 $fields = ['id', 'url', 'nick', 'name', 'alias', 'network', 'forum', 'prv'];
180 if (strrpos($name, '+')) {
181 // Is it in format @nick+number?
182 $tagcid = intval(substr($name, strrpos($name, '+') + 1));
183 $contact = DBA::selectFirst('contact', $fields, ['id' => $tagcid, 'uid' => $profile_uid]);
186 // select someone by nick in the current network
187 if (!DBA::isResult($contact) && ($network != '')) {
188 $condition = ["`nick` = ? AND `network` = ? AND `uid` = ?",
189 $name, $network, $profile_uid];
190 $contact = DBA::selectFirst('contact', $fields, $condition);
193 // select someone by attag in the current network
194 if (!DBA::isResult($contact) && ($network != '')) {
195 $condition = ["`attag` = ? AND `network` = ? AND `uid` = ?",
196 $name, $network, $profile_uid];
197 $contact = DBA::selectFirst('contact', $fields, $condition);
200 //select someone by name in the current network
201 if (!DBA::isResult($contact) && ($network != '')) {
202 $condition = ['name' => $name, 'network' => $network, 'uid' => $profile_uid];
203 $contact = DBA::selectFirst('contact', $fields, $condition);
206 // select someone by nick in any network
207 if (!DBA::isResult($contact)) {
208 $condition = ["`nick` = ? AND `uid` = ?", $name, $profile_uid];
209 $contact = DBA::selectFirst('contact', $fields, $condition);
212 // select someone by attag in any network
213 if (!DBA::isResult($contact)) {
214 $condition = ["`attag` = ? AND `uid` = ?", $name, $profile_uid];
215 $contact = DBA::selectFirst('contact', $fields, $condition);
218 // select someone by name in any network
219 if (!DBA::isResult($contact)) {
220 $condition = ['name' => $name, 'uid' => $profile_uid];
221 $contact = DBA::selectFirst('contact', $fields, $condition);
225 // Check if $contact has been successfully loaded
226 if (DBA::isResult($contact)) {
227 $profile = $contact['url'];
228 $newname = ($contact['name'] ?? '') ?: $contact['nick'];
231 //if there is an url for this persons profile
232 if (isset($profile) && ($newname != '')) {
234 // create profile link
235 $profile = str_replace(',', '%2c', $profile);
236 $newtag = $tag_type.'[url=' . $profile . ']' . $newname . '[/url]';
237 $body = str_replace($tag_type . $name, $newtag, $body);
241 return ['replaced' => $replaced, 'contact' => $contact];
245 * Render actions localized
249 * @throws ImagickException
250 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
252 public function localize(array &$item)
254 $this->profiler->startRecording('rendering');
255 /// @todo The following functionality needs to be cleaned up.
256 if (!empty($item['verb'])) {
257 $xmlhead = '<?xml version="1.0" encoding="UTF-8" ?>';
259 if (stristr($item['verb'], Activity::POKE)) {
260 $verb = urldecode(substr($item['verb'], strpos($item['verb'],'#') + 1));
262 $this->profiler->stopRecording();
265 if ($item['object-type'] == '' || $item['object-type'] !== Activity\ObjectType::PERSON) {
266 $this->profiler->stopRecording();
270 $obj = XML::parseString($xmlhead . $item['object']);
272 $Bname = $obj->title;
276 foreach ($obj->link as $l) {
277 $atts = $l->attributes();
278 switch ($atts['rel']) {
279 case 'alternate': $Blink = $atts['href'];
280 case 'photo': $Bphoto = $atts['href'];
286 'id' => $item['author-id'],
287 'network' => $item['author-network'],
288 'url' => $item['author-link'],
290 $A = '[url=' . Contact::magicLinkByContact($author) . ']' . $item['author-name'] . '[/url]';
292 if (!empty($Blink)) {
293 $B = '[url=' . Contact::magicLink($Blink) . ']' . $Bname . '[/url]';
298 if ($Bphoto != '' && !empty($Blink)) {
299 $Bphoto = '[url=' . Contact::magicLink($Blink) . '][img=80x80]' . $Bphoto . '[/img][/url]';
303 * we can't have a translation string with three positions but no distinguishable text
304 * So here is the translate string.
306 $txt = $this->l10n->t('%1$s poked %2$s');
308 // now translate the verb
309 $poked_t = trim(sprintf($txt, '', ''));
310 $txt = str_replace($poked_t, $this->l10n->t($verb), $txt);
312 // then do the sprintf on the translation string
313 $item['body'] = sprintf($txt, $A, $B) . "\n\n\n" . $Bphoto;
316 if ($this->activity->match($item['verb'], Activity::TAG)) {
317 $fields = ['author-id', 'author-link', 'author-name', 'author-network',
318 'verb', 'object-type', 'resource-id', 'body', 'plink'];
319 $obj = Post::selectFirst($fields, ['uri' => $item['parent-uri']]);
320 if (!DBA::isResult($obj)) {
321 $this->profiler->stopRecording();
327 'id' => $item['author-id'],
328 'network' => $item['author-network'],
329 'url' => $item['author-link'],
331 $author = '[url=' . Contact::magicLinkByContact($author_arr) . ']' . $item['author-name'] . '[/url]';
335 'id' => $obj['author-id'],
336 'network' => $obj['author-network'],
337 'url' => $obj['author-link'],
339 $objauthor = '[url=' . Contact::magicLinkByContact($author_arr) . ']' . $obj['author-name'] . '[/url]';
341 switch ($obj['verb']) {
343 switch ($obj['object-type']) {
344 case Activity\ObjectType::EVENT:
345 $post_type = $this->l10n->t('event');
348 $post_type = $this->l10n->t('status');
353 if ($obj['resource-id']) {
354 $post_type = $this->l10n->t('photo');
355 $m=[]; preg_match("/\[url=([^]]*)\]/", $obj['body'], $m);
356 $rr['plink'] = $m[1];
358 $post_type = $this->l10n->t('status');
360 // Let's break everthing ... ;-)
363 $plink = '[url=' . $obj['plink'] . ']' . $post_type . '[/url]';
365 $parsedobj = XML::parseString($xmlhead . $item['object']);
367 $tag = sprintf('#[url=%s]%s[/url]', $parsedobj->id, $parsedobj->content);
368 $item['body'] = $this->l10n->t('%1$s tagged %2$s\'s %3$s with %4$s', $author, $objauthor, $plink, $tag);
372 $this->profiler->stopRecording();
376 * Renders photo menu based on item
379 * @param string $formSecurityToken
382 public function photoMenu(array $item, string $formSecurityToken): string
384 $this->profiler->startRecording('rendering');
385 $sub_link = $poke_link = $contact_url = $pm_url = $status_link = '';
386 $photos_link = $posts_link = $block_link = $ignore_link = '';
388 if (local_user() && local_user() == $item['uid'] && $item['gravity'] == GRAVITY_PARENT && !$item['self'] && !$item['mention']) {
389 $sub_link = 'javascript:doFollowThread(' . $item['id'] . '); return false;';
394 'id' => $item['author-id'],
395 'network' => $item['author-network'],
396 'url' => $item['author-link'],
398 $profile_link = Contact::magicLinkByContact($author, $item['author-link']);
399 $sparkle = (strpos($profile_link, 'redir/') === 0);
402 $pcid = $item['author-id'];
405 $condition = ['uid' => local_user(), 'uri-id' => $item['author-uri-id']];
406 $contact = DBA::selectFirst('contact', ['id', 'network', 'rel'], $condition);
407 if (DBA::isResult($contact)) {
408 $cid = $contact['id'];
409 $network = $contact['network'];
410 $rel = $contact['rel'];
414 $status_link = $profile_link . '/status';
415 $photos_link = str_replace('/profile/', '/photos/', $profile_link);
416 $profile_link = $profile_link . '/profile';
420 $contact_url = 'contact/' . $pcid;
421 $posts_link = $contact_url . '/posts';
422 $block_link = $item['self'] ? '' : $contact_url . '/block?t=' . $formSecurityToken;
423 $ignore_link = $item['self'] ? '' : $contact_url . '/ignore?t=' . $formSecurityToken;
426 if ($cid && !$item['self']) {
427 $contact_url = 'contact/' . $cid;
428 $poke_link = $contact_url . '/poke';
429 $posts_link = $contact_url . '/posts';
431 if (in_array($network, [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA])) {
432 $pm_url = 'message/new/' . $cid;
438 $this->l10n->t('Follow Thread') => $sub_link,
439 $this->l10n->t('View Status') => $status_link,
440 $this->l10n->t('View Profile') => $profile_link,
441 $this->l10n->t('View Photos') => $photos_link,
442 $this->l10n->t('Network Posts') => $posts_link,
443 $this->l10n->t('View Contact') => $contact_url,
444 $this->l10n->t('Send PM') => $pm_url,
445 $this->l10n->t('Block') => $block_link,
446 $this->l10n->t('Ignore') => $ignore_link
449 if (!empty($item['language'])) {
450 $menu[$this->l10n->t('Languages')] = 'javascript:alert(\'' . ModelItem::getLanguageMessage($item) . '\');';
453 if ($network == Protocol::DFRN) {
454 $menu[$this->l10n->t('Poke')] = $poke_link;
457 if ((($cid == 0) || ($rel == Contact::FOLLOWER)) &&
458 in_array($item['network'], Protocol::FEDERATED)) {
459 $menu[$this->l10n->t('Connect/Follow')] = 'follow?url=' . urlencode($item['author-link']) . '&auto=1';
462 $menu = [$this->l10n->t('View Profile') => $item['author-link']];
465 $args = ['item' => $item, 'menu' => $menu];
467 Hook::callAll('item_photo_menu', $args);
469 $menu = $args['menu'];
472 foreach ($menu as $k => $v) {
473 if (strpos($v, 'javascript:') === 0) {
475 $o .= '<li role="menuitem"><a onclick="' . $v . '">' . $k . '</a></li>' . PHP_EOL;
477 $o .= '<li role="menuitem"><a href="' . $v . '">' . $k . '</a></li>' . PHP_EOL;
480 $this->profiler->stopRecording();
485 * Checks if the activity is visible to current user
487 * @param array $item Activity item
488 * @return bool Whether the item is visible to the user
490 public function isVisibleActivity(array $item): bool
492 // Empty verb or hidden?
493 if (empty($item['verb']) || $this->activity->isHidden($item['verb'])) {
498 return (!($this->activity->match($item['verb'], Activity::FOLLOW) &&
499 $item['object-type'] === Activity\ObjectType::NOTE &&
500 empty($item['self']) &&
501 $item['uid'] == local_user())
505 public function expandTags(array $item, bool $setPermissions = false): array
507 // Look for any tags and linkify them
508 $item['inform'] = '';
509 $private_forum = false;
511 $only_to_forum = false;
515 // Convert mentions in the body to a unified format
516 $item['body'] = BBCode::setMentions($item['body'], $item['uid'], $item['network']);
518 // Search for forum mentions
519 foreach (Tag::getFromBody($item['body'], Tag::TAG_CHARACTER[Tag::MENTION] . Tag::TAG_CHARACTER[Tag::EXCLUSIVE_MENTION]) as $tag) {
520 $contact = Contact::getByURLForUser($tag[2], $item['uid']);
521 if (empty($contact)) {
525 $receivers[] = $contact['id'];
527 if (!empty($item['inform'])) {
528 $item['inform'] .= ',';
530 $item['inform'] .= 'cid:' . $contact['id'];
532 if (($item['gravity'] == GRAVITY_COMMENT) || empty($contact['cid']) || ($contact['contact-type'] != Contact::TYPE_COMMUNITY)) {
536 if (!empty($contact['prv']) || ($tag[1] == Tag::TAG_CHARACTER[Tag::EXCLUSIVE_MENTION])) {
537 $private_forum = $contact['prv'];
538 $only_to_forum = ($tag[1] == Tag::TAG_CHARACTER[Tag::EXCLUSIVE_MENTION]);
539 $private_id = $contact['id'];
540 $forum_contact = $contact;
541 Logger::info('Private forum or exclusive mention', ['url' => $tag[2], 'mention' => $tag[1]]);
542 } elseif ($item['allow_cid'] == '<' . $contact['id'] . '>') {
543 $private_forum = false;
544 $only_to_forum = true;
545 $private_id = $contact['id'];
546 $forum_contact = $contact;
547 Logger::info('Public forum', ['url' => $tag[2], 'mention' => $tag[1]]);
549 Logger::info('Post with forum mention will not be converted to a forum post', ['url' => $tag[2], 'mention' => $tag[1]]);
552 Logger::info('Got inform', ['inform' => $item['inform']]);
554 if (($item['gravity'] == GRAVITY_PARENT) && !empty($forum_contact) && ($private_forum || $only_to_forum)) {
555 // we tagged a forum in a top level post. Now we change the post
556 $item['private'] = $private_forum ? ModelItem::PRIVATE : ModelItem::UNLISTED;
558 if ($only_to_forum) {
559 $item['postopts'] = '';
562 $item['deny_cid'] = '';
563 $item['deny_gid'] = '';
565 if ($private_forum) {
566 $item['allow_cid'] = '<' . $private_id . '>';
567 $item['allow_gid'] = '<' . Group::getIdForForum($forum_contact['id']) . '>';
569 $item['allow_cid'] = '';
570 $item['allow_gid'] = '';
572 } elseif ($setPermissions && ($item['gravity'] == GRAVITY_PARENT)) {
573 if (empty($receivers)) {
574 // For security reasons direct posts without any receiver will be posts to yourself
575 $self = Contact::selectFirst(['id'], ['uid' => $item['uid'], 'self' => true]);
576 $receivers[] = $self['id'];
579 $item['private'] = ModelItem::PRIVATE;
580 $item['allow_cid'] = '';
581 $item['allow_gid'] = '';
582 $item['deny_cid'] = '';
583 $item['deny_gid'] = '';
585 foreach ($receivers as $receiver) {
586 $item['allow_cid'] .= '<' . $receiver . '>';
592 public function getAuthorAvatar(array $item): string
594 if (in_array($item['network'], [Protocol::FEED, Protocol::MAIL])) {
595 $author_avatar = $item['contact-id'];
596 $author_updated = '';
597 $author_thumb = $item['contact-avatar'];
599 $author_avatar = $item['author-id'];
600 $author_updated = $item['author-updated'];
601 $author_thumb = $item['author-avatar'];
605 if (empty($author_thumb) || Photo::isPhotoURI($author_thumb)) {
606 $author_thumb = Contact::getAvatarUrlForId($author_avatar, Proxy::SIZE_THUMB, $author_updated);
609 return $author_thumb;
612 public function getOwnerAvatar(array $item): string
614 if (in_array($item['network'], [Protocol::FEED, Protocol::MAIL])) {
615 $owner_avatar = $item['contact-id'];
617 $owner_thumb = $item['contact-avatar'];
619 $owner_avatar = $item['owner-id'];
620 $owner_updated = $item['owner-updated'];
621 $owner_thumb = $item['owner-avatar'];
624 if (empty($owner_thumb) || Photo::isPhotoURI($owner_thumb)) {
625 $owner_thumb = Contact::getAvatarUrlForId($owner_avatar, Proxy::SIZE_THUMB, $owner_updated);