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\Object;
24 use Friendica\Content\ContactSelector;
25 use Friendica\Content\Feature;
26 use Friendica\Core\Addon;
27 use Friendica\Core\Hook;
28 use Friendica\Core\Logger;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\Renderer;
32 use Friendica\Model\Contact;
33 use Friendica\Model\Item;
34 use Friendica\Model\Post as PostModel;
35 use Friendica\Model\Tag;
36 use Friendica\Model\User;
37 use Friendica\Protocol\Activity;
38 use Friendica\Util\Crypto;
39 use Friendica\Util\DateTimeFormat;
40 use Friendica\Util\Strings;
41 use Friendica\Util\Temporal;
42 use GuzzleHttp\Psr7\Uri;
43 use InvalidArgumentException;
51 private $template = null;
52 private $available_templates = [
53 'wall' => 'wall_thread.tpl',
54 'wall2wall' => 'wallwall_thread.tpl'
56 private $comment_box_template = 'comment_item.tpl';
57 private $toplevel = false;
58 private $writable = false;
62 private $children = [];
63 private $parent = null;
68 private $thread = null;
69 private $redirect_url = null;
70 private $owner_url = '';
71 private $owner_name = '';
72 private $wall_to_wall = false;
73 private $threaded = false;
74 private $visiting = false;
79 * @param array $data data array
82 public function __construct(array $data)
85 $this->setTemplate('wall');
86 $this->toplevel = $this->getId() == $this->getDataValue('parent');
88 if (!empty(DI::userSession()->getUserIDForVisitorContactID($this->getDataValue('contact-id')))) {
89 $this->visiting = true;
92 $this->writable = $this->getDataValue('writable') || $this->getDataValue('self');
95 'id' => $this->getDataValue('author-id'),
96 'network' => $this->getDataValue('author-network'),
97 'url' => $this->getDataValue('author-link'),
98 'alias' => $this->getDataValue('author-alias')
100 $this->redirect_url = Contact::magicLinkByContact($author);
101 if (!$this->isToplevel()) {
102 $this->threaded = true;
105 // Prepare the children
106 if (!empty($data['children'])) {
107 foreach ($data['children'] as $item) {
108 // Only add will be displayed
109 if ($item['network'] === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item['uid']) {
111 } elseif (!DI::contentItem()->isVisibleActivity($item)) {
115 // You can always comment on Diaspora and OStatus items
116 if (in_array($item['network'], [Protocol::OSTATUS, Protocol::DIASPORA]) && (DI::userSession()->getLocalUserId() == $item['uid'])) {
117 $item['writable'] = true;
120 $item['pagedrop'] = $data['pagedrop'];
121 $child = new Post($item);
122 $this->addChild($child);
128 * Fetch the privacy of the post
130 * @param array $item Item record
131 * @return string Item privacy message
132 * @throws InvalidArgumentException If $item['private'] is unknown
134 private function fetchPrivacy(array $item): string
136 switch ($item['private']) {
138 $output = DI::l10n()->t('Private Message');
142 $output = DI::l10n()->t('Public Message');
146 $output = DI::l10n()->t('Unlisted Message');
150 throw new InvalidArgumentException('Item privacy ' . $item['privacy'] . ' is unsupported');
157 * Get data in a form usable by a conversation template
159 * @param array $conv_responses conversation responses
160 * @param string $formSecurityToken A security Token to avoid CSF attacks
161 * @param integer $thread_level default = 1
163 * @return mixed The data requested on success, false on failure
164 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
165 * @throws \ImagickException
167 public function getTemplateData(array $conv_responses, string $formSecurityToken, int $thread_level = 1)
169 $item = $this->getData();
173 * If the time between "created" and "edited" differs we add
174 * a notice that the post was edited.
175 * Note: In some networks reshared items seem to have (sometimes) a difference
176 * between creation time and edit time of a second. Thats why we add the notice
177 * only if the difference is more than 1 second.
179 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
181 'label' => DI::l10n()->t('This entry was edited'),
182 'date' => DateTimeFormat::local($item['edited'], 'r'),
183 'relative' => Temporal::getRelativeDate($item['edited']),
197 $ignore_thread = false;
198 $ispinned = 'unpinned';
199 $isstarred = 'unstarred';
203 $total_children = $this->countDescendants();
205 $conv = $this->getThread();
207 $privacy = $this->fetchPrivacy($item);
208 $lock = ($item['private'] == Item::PRIVATE) ? $privacy : false;
209 $connector = !in_array($item['network'], Protocol::NATIVE_SUPPORT) ? DI::l10n()->t('Connector Message') : false;
211 $shareable = in_array($conv->getProfileOwner(), [0, DI::userSession()->getLocalUserId()]) && $item['private'] != Item::PRIVATE;
212 $announceable = $shareable && in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::TWITTER, Protocol::TUMBLR, Protocol::BLUESKY]);
213 $commentable = ($item['network'] != Protocol::TUMBLR);
215 // On Diaspora only toplevel posts can be reshared
216 if ($announceable && ($item['network'] == Protocol::DIASPORA) && ($item['gravity'] != Item::GRAVITY_PARENT)) {
217 $announceable = false;
222 if (DI::userSession()->getLocalUserId()) {
223 if (Strings::compareLink(DI::session()->get('my_url'), $item['author-link'])) {
224 if ($item['event-id'] != 0) {
225 $edpost = ['calendar/event/edit/' . $item['event-id'], DI::l10n()->t('Edit')];
227 $edpost = [sprintf('post/%s/edit', $item['id']), DI::l10n()->t('Edit')];
230 $dropping = in_array($item['uid'], [0, DI::userSession()->getLocalUserId()]);
233 // Editing on items of not subscribed users isn't currently possible
234 // There are some issues on editing that prevent this.
235 // But also it is an issue of the supported protocols that doesn't allow editing at all.
236 if ($item['uid'] == 0) {
240 if (($this->getDataValue('uid') == DI::userSession()->getLocalUserId()) || $this->isVisiting()) {
244 $origin = $item['origin'] || $item['parent-origin'];
246 if (!empty($item['featured'])) {
247 $pinned = DI::l10n()->t('Pinned item');
255 $ignoreServer = false;
256 if (DI::userSession()->getLocalUserId()) {
258 'dropping' => $dropping,
259 'pagedrop' => $item['pagedrop'],
260 'select' => DI::l10n()->t('Select'),
261 'label' => $origin ? DI::l10n()->t('Delete globally') : DI::l10n()->t('Remove locally'),
265 if (!$item['self'] && DI::userSession()->getLocalUserId()) {
268 'label' => DI::l10n()->t('Block %s', $item['author-name']),
269 'author_id' => $item['author-id'],
273 'label' => DI::l10n()->t('Ignore %s', $item['author-name']),
274 'author_id' => $item['author-id'],
277 'collapsing' => true,
278 'label' => DI::l10n()->t('Collapse %s', $item['author-name']),
279 'author_id' => $item['author-id'],
282 'label' => DI::l10n()->t('Report post'),
283 'href' => 'moderation/report/create?' . http_build_query(['cid' => $item['author-id'], 'uri-ids' => [$item['uri-id']]]),
285 $authorBaseUri = new Uri($item['author-baseurl'] ?? '');
286 if ($authorBaseUri->getHost() && !DI::baseUrl()->isLocalUrl($authorBaseUri)) {
288 'label' => DI::l10n()->t("Ignore %s server", $authorBaseUri->getHost()),
293 $filer = DI::userSession()->getLocalUserId() ? DI::l10n()->t('Save to folder') : false;
295 $profile_name = $item['author-name'];
296 if (!empty($item['author-link']) && empty($item['author-name'])) {
297 $profile_name = $item['author-link'];
300 if (DI::userSession()->isAuthenticated()) {
303 'id' => $item['author-id'],
304 'network' => $item['author-network'],
305 'url' => $item['author-link'],
306 'alias' => $item['author-alias'],
308 $profile_link = Contact::magicLinkByContact($author);
310 $profile_link = $item['author-link'];
313 if (strpos($profile_link, 'contact/redir/') === 0) {
314 $sparkle = ' sparkle';
317 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
318 Hook::callAll('render_location', $locate);
319 $location_html = $locate['html'] ?: Strings::escapeHtml($locate['location'] ?: $locate['coord'] ?: '');
321 // process action responses - e.g. like/dislike/attend/agree/whatever
322 $response_verbs = ['like', 'dislike', 'announce'];
326 if ($item['object-type'] === Activity\ObjectType::EVENT) {
327 $response_verbs[] = 'attendyes';
328 $response_verbs[] = 'attendno';
329 $response_verbs[] = 'attendmaybe';
331 if ($conv->isWritable()) {
333 $attend = [DI::l10n()->t('I will attend'), DI::l10n()->t('I will not attend'), DI::l10n()->t('I might attend')];
338 foreach ($response_verbs as $value => $verb) {
339 $responses[$verb] = [
340 'self' => $conv_responses[$verb][$item['uri-id']]['self'] ?? 0,
341 'output' => !empty($conv_responses[$verb][$item['uri-id']]) ? DI::conversation()->formatActivity($conv_responses[$verb][$item['uri-id']]['links'], $verb, $item['uri-id']) : '',
346 * We should avoid doing this all the time, but it depends on the conversation mode
347 * And the conv mode may change when we change the conv, or it changes its mode
348 * Maybe we should establish a way to be notified about conversation changes
350 $this->checkWallToWall();
352 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
353 $osparkle = ' sparkle';
358 if ($this->isToplevel()) {
359 if (DI::userSession()->getLocalUserId()) {
360 $ignored_thread = PostModel\ThreadUser::getIgnored($item['uri-id'], DI::userSession()->getLocalUserId());
361 if ($item['mention'] || $ignored_thread) {
363 'do' => DI::l10n()->t('Ignore thread'),
364 'undo' => DI::l10n()->t('Unignore thread'),
365 'toggle' => DI::l10n()->t('Toggle ignore status'),
366 'classdo' => $ignored_thread ? 'hidden' : '',
367 'classundo' => $ignored_thread ? '' : 'hidden',
368 'ignored' => DI::l10n()->t('Ignored'),
372 $isstarred = (($item['starred']) ? 'starred' : 'unstarred');
375 'do' => DI::l10n()->t('Add star'),
376 'undo' => DI::l10n()->t('Remove star'),
377 'toggle' => DI::l10n()->t('Toggle star status'),
378 'classdo' => $item['starred'] ? 'hidden' : '',
379 'classundo' => $item['starred'] ? '' : 'hidden',
380 'starred' => DI::l10n()->t('Starred'),
383 if ($conv->getProfileOwner() == DI::userSession()->getLocalUserId() && ($item['uid'] != 0)) {
384 if ($origin && in_array($item['private'], [Item::PUBLIC, Item::UNLISTED])) {
385 $ispinned = ($item['featured'] ? 'pinned' : 'unpinned');
388 'do' => DI::l10n()->t('Pin'),
389 'undo' => DI::l10n()->t('Unpin'),
390 'toggle' => DI::l10n()->t('Toggle pin status'),
391 'classdo' => $item['featured'] ? 'hidden' : '',
392 'classundo' => $item['featured'] ? '' : 'hidden',
393 'pinned' => DI::l10n()->t('Pinned'),
398 'add' => DI::l10n()->t('Add tag'),
407 if ($conv->isWritable()) {
408 $buttons['like'] = [DI::l10n()->t("I like this \x28toggle\x29"), DI::l10n()->t('Like')];
409 $buttons['dislike'] = [DI::l10n()->t("I don't like this \x28toggle\x29"), DI::l10n()->t('Dislike')];
411 $buttons['share'] = [DI::l10n()->t('Quote share this'), DI::l10n()->t('Quote Share')];
414 $buttons['announce'] = [DI::l10n()->t('Reshare this'), DI::l10n()->t('Reshare')];
415 $buttons['unannounce'] = [DI::l10n()->t('Cancel your Reshare'), DI::l10n()->t('Unshare')];
420 $comment_html = $this->getCommentBox($indent);
425 if (strcmp(DateTimeFormat::utc($item['created']), DateTimeFormat::utc('now - 12 hours')) > 0) {
429 DI::contentItem()->localize($item);
431 $body_html = Item::prepareBody($item, true);
433 list($categories, $folders) = DI::contentItem()->determineCategoriesTerms($item, DI::userSession()->getLocalUserId());
435 if (!empty($item['title'])) {
436 $title = $item['title'];
437 } elseif (!empty($item['content-warning']) && DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'disable_cw', false)) {
438 $title = ucfirst($item['content-warning']);
443 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'hide_dislike')) {
444 $buttons['dislike'] = false;
447 // Disable features that aren't available in several networks
448 if (!in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA])) {
449 if ($buttons['dislike']) {
450 $buttons['dislike'] = false;
457 if ($buttons['like'] && in_array($item['network'], [Protocol::FEED, Protocol::MAIL])) {
458 $buttons['like'] = false;
461 $tags = Tag::populateFromItem($item);
463 $ago = Temporal::getRelativeDate($item['created']);
464 $ago_received = Temporal::getRelativeDate($item['received']);
465 if (DI::config()->get('system', 'show_received') && (abs(strtotime($item['created']) - strtotime($item['received'])) > DI::config()->get('system', 'show_received_seconds')) && ($ago != $ago_received)) {
466 $ago = DI::l10n()->t('%s (Received %s)', $ago, $ago_received);
469 // Fetching of Diaspora posts doesn't always work. There are issues with reshares and possibly comments
470 if (!DI::userSession()->getLocalUserId() && ($item['network'] != Protocol::DIASPORA) && !empty(DI::session()->get('remote_comment'))) {
472 DI::l10n()->t('Comment this item on your system'), DI::l10n()->t('Remote comment'),
473 str_replace('{uri}', urlencode($item['uri']), DI::session()->get('remote_comment'))
476 // Ensure to either display the remote comment or the local activities
480 $remote_comment = '';
484 if (!empty($item['direction'])) {
485 $direction = $item['direction'];
489 if (!empty($item['language'])) {
490 $languages = [DI::l10n()->t('Languages'), Item::getLanguageMessage($item)];
493 if (in_array($item['private'], [Item::PUBLIC, Item::UNLISTED]) && in_array($item['network'], Protocol::FEDERATED)) {
494 $browsershare = [DI::l10n()->t('Share via ...'), DI::l10n()->t('Share via external services')];
496 $browsershare = null;
500 'template' => $this->getTemplate(),
501 'type' => implode('', array_slice(explode('/', $item['verb']), -1)),
502 'comment_firstcollapsed' => false,
503 'comment_lastcollapsed' => false,
504 'suppress_tags' => DI::config()->get('system', 'suppress_tags'),
505 'tags' => $tags['tags'],
506 'hashtags' => $tags['hashtags'],
507 'mentions' => $tags['mentions'],
508 'implicit_mentions' => $tags['implicit_mentions'],
509 'txt_cats' => DI::l10n()->t('Categories:'),
510 'txt_folders' => DI::l10n()->t('Filed under:'),
511 'has_cats' => ((count($categories)) ? 'true' : ''),
512 'has_folders' => ((count($folders)) ? 'true' : ''),
513 'categories' => $categories,
514 'folders' => $folders,
515 'body_html' => $body_html,
516 'text' => strip_tags($body_html),
517 'id' => $this->getId(),
518 'guid' => urlencode($item['guid']),
519 'isevent' => $isevent,
521 'linktitle' => DI::l10n()->t('View %s\'s profile @ %s', $profile_name, $item['author-link']),
522 'olinktitle' => DI::l10n()->t('View %s\'s profile @ %s', $this->getOwnerName(), $item['owner-link']),
523 'to' => DI::l10n()->t('to'),
524 'via' => DI::l10n()->t('via'),
525 'wall' => DI::l10n()->t('Wall-to-Wall'),
526 'vwall' => DI::l10n()->t('via Wall-To-Wall:'),
527 'profile_url' => $profile_link,
528 'name' => $profile_name,
529 'item_photo_menu_html' => DI::contentItem()->photoMenu($item, $formSecurityToken),
530 'thumb' => DI::baseUrl()->remove(DI::contentItem()->getAuthorAvatar($item)),
531 'osparkle' => $osparkle,
532 'sparkle' => $sparkle,
534 'localtime' => DateTimeFormat::local($item['created'], 'r'),
535 'ago' => $item['app'] ? DI::l10n()->t('%s from %s', $ago, $item['app']) : $ago,
536 'app' => $item['app'],
539 'private' => $item['private'],
540 'privacy' => $privacy,
541 'connector' => $connector,
542 'location_html' => $location_html,
545 'owner_self' => $item['author-link'] == DI::session()->get('my_url'),
546 'owner_url' => $this->getOwnerUrl(),
547 'owner_photo' => DI::baseUrl()->remove(DI::contentItem()->getOwnerAvatar($item)),
548 'owner_name' => $this->getOwnerName(),
549 'plink' => Item::getPlink($item),
550 'browsershare' => $browsershare,
552 'ispinned' => $ispinned,
555 'isstarred' => $isstarred,
557 'ignore' => $ignore_thread,
560 'language' => $languages,
563 'ignore_author' => $ignore,
564 'collapse' => $collapse,
566 'ignore_server' => $ignoreServer,
568 'like_html' => $responses['like']['output'],
569 'dislike_html' => $responses['dislike']['output'],
570 'emojis' => $this->getEmojis($item),
571 'responses' => $responses,
572 'switchcomment' => DI::l10n()->t('Comment'),
573 'reply_label' => DI::l10n()->t('Reply to %s', $profile_name),
574 'comment_html' => $comment_html,
575 'remote_comment' => $remote_comment,
576 'menu' => DI::l10n()->t('More'),
577 'previewing' => $conv->isPreview() ? ' preview ' : '',
578 'wait' => DI::l10n()->t('Please wait'),
579 'thread_level' => $thread_level,
581 'author_gsid' => $item['author-gsid'],
582 'network' => $item['network'],
583 'network_name' => ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network'], $item['author-gsid']),
584 'network_icon' => ContactSelector::networkToIcon($item['network'], $item['author-link'], $item['author-gsid']),
585 'received' => $item['received'],
586 'commented' => $item['commented'],
587 'created_date' => $item['created'],
588 'uriid' => $item['uri-id'],
589 'return' => (DI::args()->getCommand()) ? bin2hex(DI::args()->getCommand()) : '',
590 'direction' => $direction,
591 'reshared' => $item['reshared'] ?? '',
593 'queue_count' => $item['delivery_queue_count'],
594 'queue_done' => $item['delivery_queue_done'] + $item['delivery_queue_failed'], /// @todo Possibly display it separately in the future
595 'notifier_pending' => DI::l10n()->t('Notifier task is pending'),
596 'delivery_pending' => DI::l10n()->t('Delivery to remote servers is pending'),
597 'delivery_underway' => DI::l10n()->t('Delivery to remote servers is underway'),
598 'delivery_almost' => DI::l10n()->t('Delivery to remote servers is mostly done'),
599 'delivery_done' => DI::l10n()->t('Delivery to remote servers is done'),
603 $arr = ['item' => $item, 'output' => $tmp_item];
604 Hook::callAll('display_item', $arr);
606 $result = $arr['output'];
608 $result['children'] = [];
609 $children = $this->getChildren();
610 $nb_children = count($children);
611 if ($nb_children > 0) {
612 foreach ($children as $child) {
613 $result['children'][] = $child->getTemplateData($conv_responses, $formSecurityToken, $thread_level + 1);
617 if (($nb_children > 2) || ($thread_level > 1)) {
618 $result['children'][0]['comment_firstcollapsed'] = true;
619 $result['children'][0]['num_comments'] = DI::l10n()->tt('%d comment', '%d comments', $total_children);
620 $result['children'][0]['show_text'] = DI::l10n()->t('Show more');
621 $result['children'][0]['hide_text'] = DI::l10n()->t('Show fewer');
622 if ($thread_level > 1) {
623 $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
625 $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
630 // Copy values/set defaults
631 $result['total_comments_num'] = $this->isToplevel() ? $total_children : 0;
632 $result['private'] = $item['private'];
633 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
634 $result['flatten'] = !$this->isThreaded();
635 $result['threaded'] = $this->isThreaded();
646 private function getEmojis(array $item): array
648 if (empty($item['emojis'])) {
653 foreach ($item['emojis'] as $index => $element) {
654 $actors = implode(', ', $element['title']);
655 switch ($element['verb']) {
656 case Activity::ANNOUNCE:
657 $title = DI::l10n()->t('Reshared by: %s', $actors);
658 $icon = ['fa' => 'fa-retweet', 'icon' => 'icon-retweet'];
662 $title = DI::l10n()->t('Viewed by: %s', $actors);
663 $icon = ['fa' => 'fa-eye', 'icon' => 'icon-eye-open'];
667 $title = DI::l10n()->t('Liked by: %s', $actors);
668 $icon = ['fa' => 'fa-thumbs-up', 'icon' => 'icon-thumbs-up'];
671 case Activity::DISLIKE:
672 $title = DI::l10n()->t('Disliked by: %s', $actors);
673 $icon = ['fa' => 'fa-thumbs-down', 'icon' => 'icon-thumbs-down'];
676 case Activity::ATTEND:
677 $title = DI::l10n()->t('Attended by: %s', $actors);
678 $icon = ['fa' => 'fa-check', 'icon' => 'icon-ok'];
681 case Activity::ATTENDMAYBE:
682 $title = DI::l10n()->t('Maybe attended by: %s', $actors);
683 $icon = ['fa' => 'fa-question', 'icon' => 'icon-question'];
686 case Activity::ATTENDNO:
687 $title = DI::l10n()->t('Not attended by: %s', $actors);
688 $icon = ['fa' => 'fa-times', 'icon' => 'icon-remove'];
692 $title = DI::l10n()->t('Reacted with %s by: %s', $element['emoji'], $actors);
696 $emojis[$index] = ['emoji' => $element['emoji'], 'total' => $element['total'], 'title' => $title, 'icon' => $icon];
706 public function getId(): int
708 return $this->getDataValue('id');
714 public function isThreaded(): bool
716 return $this->threaded;
722 * @param Post $item The child post to add
724 * @return Post|bool Last Post object or bool on any error
727 public function addChild(Post $item)
729 if (!$item->getId()) {
730 Logger::error('Post object has no id', ['post' => $item]);
732 } elseif ($this->getChild($item->getId())) {
733 Logger::warning('Post object already exists', ['post' => $item]);
738 * Only add what will be displayed
740 if ($item->getDataValue('network') === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item->getDataValue('uid')) {
741 Logger::warning('Post object does not belong to local user', ['post' => $item, 'local_user' => DI::userSession()->getLocalUserId()]);
744 DI::activity()->match($item->getDataValue('verb'), Activity::LIKE) ||
745 DI::activity()->match($item->getDataValue('verb'), Activity::DISLIKE)
747 Logger::warning('Post objects is a like/dislike', ['post' => $item]);
751 $item->setParent($this);
752 $this->children[] = $item;
754 return end($this->children);
758 * Get a child by its ID
760 * @param integer $id The child id
761 * @return Thread|null Thread or NULL if not found
763 public function getChild(int $id)
765 foreach ($this->getChildren() as $child) {
766 if ($child->getId() == $id) {
775 * Get all our children
779 public function getChildren(): array
781 return $this->children;
787 * @param Post $item The item to set as parent
790 protected function setParent(Post $item)
792 $parent = $this->getParent();
794 $parent->removeChild($this);
797 $this->parent = $item;
798 $this->setThread($item->getThread());
806 protected function removeParent()
808 $this->parent = null;
809 $this->thread = null;
815 * @param Post $item The child to be removed
816 * @return boolean Success or failure
819 public function removeChild(Post $item): bool
821 $id = $item->getId();
822 foreach ($this->getChildren() as $key => $child) {
823 if ($child->getId() == $id) {
824 $child->removeParent();
825 unset($this->children[$key]);
826 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
827 $this->children = array_values($this->children);
832 Logger::info('[WARN] Item::removeChild : Item is not a child (' . $id . ').');
841 protected function getParent()
843 return $this->parent;
847 * Set conversation thread
849 * @param Thread|null $thread
853 public function setThread(Thread $thread = null)
855 $this->thread = $thread;
857 // Set it on our children too
858 foreach ($this->getChildren() as $child) {
859 $child->setThread($thread);
866 * @return Thread|null
868 public function getThread()
870 return $this->thread;
876 * We shouldn't need this
880 public function getData(): array
888 * @param string $name key
890 * @return mixed value on success, false on failure
892 public function getDataValue(string $name)
894 if (!isset($this->data[$name])) {
895 // Logger::info('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".');
899 return $this->data[$name];
903 * Set template by name
905 * @param string $name Template name
908 * @throws InvalidArgumentException
910 private function setTemplate(string $name)
912 if (empty($this->available_templates[$name])) {
914 throw new InvalidArgumentException('[ERROR] Item::setTemplate : Template not available ("' . $name . '").');
917 $this->template = $this->available_templates[$name];
925 private function getTemplate()
927 return $this->template;
931 * Check if this is a toplevel post
935 private function isToplevel(): bool
937 return $this->toplevel;
941 * Check if this is writable
945 private function isWritable(): bool
947 $conv = $this->getThread();
950 // This will allow us to comment on wall-to-wall items owned by our friends
951 // and community groups even if somebody else wrote the post.
952 // bug #517 - this fixes for conversation owner
953 if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == DI::userSession()->getLocalUserId()) {
957 // this fixes for visitors
958 return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
960 return $this->writable;
964 * Count the total of our descendants
968 private function countDescendants(): int
970 $children = $this->getChildren();
971 $total = count($children);
973 foreach ($children as $child) {
974 $total += $child->countDescendants();
982 * Get the template for the comment box
986 private function getCommentBoxTemplate(): string
988 return $this->comment_box_template;
992 * Get default text for the comment box
995 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
997 private function getDefaultText(): string
1001 if (!DI::userSession()->getLocalUserId()) {
1005 $owner = User::getOwnerDataById($a->getLoggedInUserId());
1006 $item = $this->getData();
1008 if (!empty($item['content-warning']) && Feature::isEnabled(DI::userSession()->getLocalUserId(), 'add_abstract')) {
1009 $text = '[abstract=' . Protocol::ACTIVITYPUB . ']' . $item['content-warning'] . "[/abstract]\n";
1014 if (!Feature::isEnabled(DI::userSession()->getLocalUserId(), 'explicit_mentions')) {
1018 if (($item['author-addr'] != $owner['addr']) && (($item['gravity'] != Item::GRAVITY_PARENT) || !in_array($item['network'], [Protocol::DIASPORA]))) {
1019 $text .= '@' . $item['author-addr'] . ' ';
1022 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
1023 foreach ($terms as $term) {
1024 if (!$term['url']) {
1025 DI::logger()->warning('Mention term with no URL', ['term' => $term]);
1029 $profile = Contact::getByURL($term['url'], false, ['addr', 'contact-type']);
1031 !empty($profile['addr']) && (($profile['contact-type'] ?? Contact::TYPE_UNKNOWN) != Contact::TYPE_COMMUNITY) &&
1032 ($profile['addr'] != $owner['addr']) && !strstr($text, $profile['addr'])
1034 $text .= '@' . $profile['addr'] . ' ';
1042 * Get the comment box
1044 * @param string $indent Indent value
1046 * @return mixed The comment box string (empty if no comment box), false on failure
1047 * @throws \Exception
1048 * @todo return false is nowhere in this method?
1050 private function getCommentBox(string $indent)
1055 $conv = $this->getThread();
1057 if ($conv->isWritable() && $this->isWritable()) {
1059 * Hmmm, code depending on the presence of a particular addon?
1060 * This should be better if done by a hook
1063 if (Addon::isEnabled('qcomment')) {
1064 $words = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'qcomment', 'words');
1065 $qcomment = $words ? explode("\n", $words) : [];
1068 // Fetch the user id from the parent when the owner user is empty
1069 $uid = $conv->getProfileOwner();
1070 $parent_uid = $this->getDataValue('uid');
1072 $owner = User::getOwnerDataById($a->getLoggedInUserId());
1074 $default_text = $this->getDefaultText();
1076 if (!is_null($parent_uid) && ($uid != $parent_uid)) {
1080 $template = Renderer::getMarkupTemplate($this->getCommentBoxTemplate());
1081 $comment_box = Renderer::replaceMacros($template, [
1082 '$return_path' => DI::args()->getQueryString(),
1083 '$threaded' => $this->isThreaded(),
1085 '$wall' => ($conv->getMode() === 'profile'),
1086 '$id' => $this->getId(),
1087 '$parent' => $this->getId(),
1088 '$qcomment' => $qcomment,
1089 '$default' => $default_text,
1090 '$profile_uid' => $uid,
1091 '$mylink' => DI::baseUrl()->remove($owner['url'] ?? ''),
1092 '$mytitle' => DI::l10n()->t('This is you'),
1093 '$myphoto' => DI::baseUrl()->remove($owner['thumb'] ?? ''),
1094 '$comment' => DI::l10n()->t('Comment'),
1095 '$submit' => DI::l10n()->t('Submit'),
1096 '$loading' => DI::l10n()->t('Loading...'),
1097 '$edbold' => DI::l10n()->t('Bold'),
1098 '$editalic' => DI::l10n()->t('Italic'),
1099 '$eduline' => DI::l10n()->t('Underline'),
1100 '$contentwarn' => DI::l10n()->t('Content Warning'),
1101 '$edquote' => DI::l10n()->t('Quote'),
1102 '$edemojis' => DI::l10n()->t('Add emojis'),
1103 '$edcode' => DI::l10n()->t('Code'),
1104 '$edimg' => DI::l10n()->t('Image'),
1105 '$edurl' => DI::l10n()->t('Link'),
1106 '$edattach' => DI::l10n()->t('Link or Media'),
1107 '$prompttext' => DI::l10n()->t('Please enter a image/video/audio/webpage URL:'),
1108 '$preview' => DI::l10n()->t('Preview'),
1109 '$indent' => $indent,
1110 '$rand_num' => Crypto::randomDigits(12)
1114 return $comment_box;
1120 private function getRedirectUrl(): string
1122 return $this->redirect_url;
1126 * Check if we are a wall to wall item and set the relevant properties
1129 * @throws \Exception
1131 protected function checkWallToWall()
1134 $conv = $this->getThread();
1135 $this->wall_to_wall = false;
1137 if ($this->isToplevel()) {
1138 if ($conv->getMode() !== 'profile') {
1139 if ($this->getDataValue('owner-link')) {
1140 $owner_linkmatch = (($this->getDataValue('owner-link')) && Strings::compareLink($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
1141 $alias_linkmatch = (($this->getDataValue('alias')) && Strings::compareLink($this->getDataValue('alias'), $this->getDataValue('author-link')));
1142 $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
1144 if (!$owner_linkmatch && !$alias_linkmatch && !$owner_namematch) {
1146 * The author url doesn't match the owner (typically the contact)
1147 * and also doesn't match the contact alias.
1148 * The name match is a hack to catch several weird cases where URLs are
1149 * all over the park. It can be tricked, but this prevents you from
1150 * seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
1151 * well that it's the same Bob Smith.
1152 * But it could be somebody else with the same name. It just isn't highly likely.
1154 $this->owner_name = $this->getDataValue('owner-name');
1155 $this->wall_to_wall = true;
1159 'id' => $this->getDataValue('owner-id'),
1160 'network' => $this->getDataValue('owner-network'),
1161 'url' => $this->getDataValue('owner-link'),
1162 'alias' => $this->getDataValue('owner-alias'),
1164 $this->owner_url = Contact::magicLinkByContact($owner);
1170 if (!$this->wall_to_wall) {
1171 $this->setTemplate('wall');
1172 $this->owner_url = '';
1173 $this->owner_name = '';
1180 private function isWallToWall(): bool
1182 return $this->wall_to_wall;
1188 private function getOwnerUrl(): string
1190 return $this->owner_url;
1196 private function getOwnerName(): string
1198 return $this->owner_name;
1204 private function isVisiting(): bool
1206 return $this->visiting;