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\Photo;
35 use Friendica\Model\Post as PostModel;
36 use Friendica\Model\Tag;
37 use Friendica\Model\User;
38 use Friendica\Protocol\Activity;
39 use Friendica\Util\Crypto;
40 use Friendica\Util\DateTimeFormat;
41 use Friendica\Util\Proxy;
42 use Friendica\Util\Strings;
43 use Friendica\Util\Temporal;
44 use InvalidArgumentException;
52 private $template = null;
53 private $available_templates = [
54 'wall' => 'wall_thread.tpl',
55 'wall2wall' => 'wallwall_thread.tpl'
57 private $comment_box_template = 'comment_item.tpl';
58 private $toplevel = false;
59 private $writable = false;
63 private $children = [];
64 private $parent = null;
69 private $thread = null;
70 private $redirect_url = null;
71 private $owner_url = '';
72 private $owner_name = '';
73 private $wall_to_wall = false;
74 private $threaded = false;
75 private $visiting = false;
80 * @param array $data data array
83 public function __construct(array $data)
86 $this->setTemplate('wall');
87 $this->toplevel = $this->getId() == $this->getDataValue('parent');
89 if (!empty(DI::userSession()->getUserIDForVisitorContactID($this->getDataValue('contact-id')))) {
90 $this->visiting = true;
93 $this->writable = $this->getDataValue('writable') || $this->getDataValue('self');
96 'id' => $this->getDataValue('author-id'),
97 'network' => $this->getDataValue('author-network'),
98 'url' => $this->getDataValue('author-link'),
99 'alias' => $this->getDataValue('author-alias')
101 $this->redirect_url = Contact::magicLinkByContact($author);
102 if (!$this->isToplevel()) {
103 $this->threaded = true;
106 // Prepare the children
107 if (!empty($data['children'])) {
108 foreach ($data['children'] as $item) {
109 // Only add will be displayed
110 if ($item['network'] === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item['uid']) {
112 } elseif (!DI::contentItem()->isVisibleActivity($item)) {
116 // You can always comment on Diaspora and OStatus items
117 if (in_array($item['network'], [Protocol::OSTATUS, Protocol::DIASPORA]) && (DI::userSession()->getLocalUserId() == $item['uid'])) {
118 $item['writable'] = true;
121 $item['pagedrop'] = $data['pagedrop'];
122 $child = new Post($item);
123 $this->addChild($child);
129 * Fetch the privacy of the post
131 * @param array $item Item record
132 * @return string Item privacy message
133 * @throws InvalidArgumentException If $item['private'] is unknown
135 private function fetchPrivacy(array $item): string
137 switch ($item['private']) {
139 $output = DI::l10n()->t('Private Message');
143 $output = DI::l10n()->t('Public Message');
147 $output = DI::l10n()->t('Unlisted Message');
151 throw new InvalidArgumentException('Item privacy ' . $item['privacy'] . ' is unsupported');
158 * Get data in a form usable by a conversation template
160 * @param array $conv_responses conversation responses
161 * @param string $formSecurityToken A security Token to avoid CSF attacks
162 * @param integer $thread_level default = 1
164 * @return mixed The data requested on success, false on failure
165 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
166 * @throws \ImagickException
168 public function getTemplateData(array $conv_responses, string $formSecurityToken, int $thread_level = 1)
170 $item = $this->getData();
174 * If the time between "created" and "edited" differs we add
175 * a notice that the post was edited.
176 * Note: In some networks reshared items seem to have (sometimes) a difference
177 * between creation time and edit time of a second. Thats why we add the notice
178 * only if the difference is more than 1 second.
180 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
182 'label' => DI::l10n()->t('This entry was edited'),
183 'date' => DateTimeFormat::local($item['edited'], 'r'),
184 'relative' => Temporal::getRelativeDate($item['edited']),
198 $ignore_thread = false;
199 $ispinned = 'unpinned';
200 $isstarred = 'unstarred';
204 $total_children = $this->countDescendants();
206 $conv = $this->getThread();
208 $privacy = $this->fetchPrivacy($item);
209 $lock = ($item['private'] == Item::PRIVATE) ? $privacy : false;
210 $connector = !in_array($item['network'], Protocol::NATIVE_SUPPORT) ? DI::l10n()->t('Connector Message') : false;
212 $shareable = in_array($conv->getProfileOwner(), [0, DI::userSession()->getLocalUserId()]) && $item['private'] != Item::PRIVATE;
213 $announceable = $shareable && in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::TWITTER, Protocol::TUMBLR, Protocol::BLUESKY]);
214 $commentable = ($item['network'] != Protocol::TUMBLR);
216 // On Diaspora only toplevel posts can be reshared
217 if ($announceable && ($item['network'] == Protocol::DIASPORA) && ($item['gravity'] != Item::GRAVITY_PARENT)) {
218 $announceable = false;
223 if (DI::userSession()->getLocalUserId()) {
224 if (Strings::compareLink(DI::session()->get('my_url'), $item['author-link'])) {
225 if ($item['event-id'] != 0) {
226 $edpost = ['calendar/event/edit/' . $item['event-id'], DI::l10n()->t('Edit')];
228 $edpost = [sprintf('post/%s/edit', $item['id']), DI::l10n()->t('Edit')];
231 $dropping = in_array($item['uid'], [0, DI::userSession()->getLocalUserId()]);
234 // Editing on items of not subscribed users isn't currently possible
235 // There are some issues on editing that prevent this.
236 // But also it is an issue of the supported protocols that doesn't allow editing at all.
237 if ($item['uid'] == 0) {
241 if (($this->getDataValue('uid') == DI::userSession()->getLocalUserId()) || $this->isVisiting()) {
245 $origin = $item['origin'] || $item['parent-origin'];
247 if (!empty($item['featured'])) {
248 $pinned = DI::l10n()->t('Pinned item');
251 // Showing the one or the other text, depending upon if we can only hide it or really delete it.
252 $delete = $origin ? DI::l10n()->t('Delete globally') : DI::l10n()->t('Remove locally');
259 if (DI::userSession()->getLocalUserId()) {
261 'dropping' => $dropping,
262 'pagedrop' => $item['pagedrop'],
263 'select' => DI::l10n()->t('Select'),
268 if (!$item['self'] && DI::userSession()->getLocalUserId()) {
271 'block' => DI::l10n()->t('Block %s', $item['author-name']),
272 'author_id' => $item['author-id'],
276 'ignore' => DI::l10n()->t('Ignore %s', $item['author-name']),
277 'author_id' => $item['author-id'],
280 'collapsing' => true,
281 'collapse' => DI::l10n()->t('Collapse %s', $item['author-name']),
282 'author_id' => $item['author-id'],
285 'label' => DI::l10n()->t('Report post'),
286 'href' => 'moderation/report/create?' . http_build_query(['cid' => $item['author-id'], 'uri-ids' => [$item['uri-id']]]),
290 $filer = DI::userSession()->getLocalUserId() ? DI::l10n()->t('Save to folder') : false;
292 $profile_name = $item['author-name'];
293 if (!empty($item['author-link']) && empty($item['author-name'])) {
294 $profile_name = $item['author-link'];
297 if (DI::userSession()->isAuthenticated()) {
300 'id' => $item['author-id'],
301 'network' => $item['author-network'],
302 'url' => $item['author-link'],
303 'alias' => $item['author-alias'],
305 $profile_link = Contact::magicLinkByContact($author);
307 $profile_link = $item['author-link'];
310 if (strpos($profile_link, 'contact/redir/') === 0) {
311 $sparkle = ' sparkle';
314 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
315 Hook::callAll('render_location', $locate);
316 $location_html = $locate['html'] ?: Strings::escapeHtml($locate['location'] ?: $locate['coord'] ?: '');
318 // process action responses - e.g. like/dislike/attend/agree/whatever
319 $response_verbs = ['like', 'dislike', 'announce'];
323 if ($item['object-type'] === Activity\ObjectType::EVENT) {
324 $response_verbs[] = 'attendyes';
325 $response_verbs[] = 'attendno';
326 $response_verbs[] = 'attendmaybe';
328 if ($conv->isWritable()) {
330 $attend = [DI::l10n()->t('I will attend'), DI::l10n()->t('I will not attend'), DI::l10n()->t('I might attend')];
335 foreach ($response_verbs as $value => $verb) {
336 $responses[$verb] = [
337 'self' => $conv_responses[$verb][$item['uri-id']]['self'] ?? 0,
338 'output' => !empty($conv_responses[$verb][$item['uri-id']]) ? DI::conversation()->formatActivity($conv_responses[$verb][$item['uri-id']]['links'], $verb, $item['uri-id']) : '',
343 * We should avoid doing this all the time, but it depends on the conversation mode
344 * And the conv mode may change when we change the conv, or it changes its mode
345 * Maybe we should establish a way to be notified about conversation changes
347 $this->checkWallToWall();
349 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
350 $osparkle = ' sparkle';
355 if ($this->isToplevel()) {
356 if (DI::userSession()->getLocalUserId()) {
357 $ignored_thread = PostModel\ThreadUser::getIgnored($item['uri-id'], DI::userSession()->getLocalUserId());
358 if ($item['mention'] || $ignored_thread) {
360 'do' => DI::l10n()->t('Ignore thread'),
361 'undo' => DI::l10n()->t('Unignore thread'),
362 'toggle' => DI::l10n()->t('Toggle ignore status'),
363 'classdo' => $ignored_thread ? 'hidden' : '',
364 'classundo' => $ignored_thread ? '' : 'hidden',
365 'ignored' => DI::l10n()->t('Ignored'),
369 $isstarred = (($item['starred']) ? 'starred' : 'unstarred');
372 'do' => DI::l10n()->t('Add star'),
373 'undo' => DI::l10n()->t('Remove star'),
374 'toggle' => DI::l10n()->t('Toggle star status'),
375 'classdo' => $item['starred'] ? 'hidden' : '',
376 'classundo' => $item['starred'] ? '' : 'hidden',
377 'starred' => DI::l10n()->t('Starred'),
380 if ($conv->getProfileOwner() == DI::userSession()->getLocalUserId() && ($item['uid'] != 0)) {
381 if ($origin && in_array($item['private'], [Item::PUBLIC, Item::UNLISTED])) {
382 $ispinned = ($item['featured'] ? 'pinned' : 'unpinned');
385 'do' => DI::l10n()->t('Pin'),
386 'undo' => DI::l10n()->t('Unpin'),
387 'toggle' => DI::l10n()->t('Toggle pin status'),
388 'classdo' => $item['featured'] ? 'hidden' : '',
389 'classundo' => $item['featured'] ? '' : 'hidden',
390 'pinned' => DI::l10n()->t('Pinned'),
395 'add' => DI::l10n()->t('Add tag'),
404 if ($conv->isWritable()) {
405 $buttons['like'] = [DI::l10n()->t("I like this \x28toggle\x29"), DI::l10n()->t('Like')];
406 $buttons['dislike'] = [DI::l10n()->t("I don't like this \x28toggle\x29"), DI::l10n()->t('Dislike')];
408 $buttons['share'] = [DI::l10n()->t('Quote share this'), DI::l10n()->t('Quote Share')];
411 $buttons['announce'] = [DI::l10n()->t('Reshare this'), DI::l10n()->t('Reshare')];
412 $buttons['unannounce'] = [DI::l10n()->t('Cancel your Reshare'), DI::l10n()->t('Unshare')];
417 $comment_html = $this->getCommentBox($indent);
422 if (strcmp(DateTimeFormat::utc($item['created']), DateTimeFormat::utc('now - 12 hours')) > 0) {
426 DI::contentItem()->localize($item);
428 $body_html = Item::prepareBody($item, true);
430 list($categories, $folders) = DI::contentItem()->determineCategoriesTerms($item, DI::userSession()->getLocalUserId());
432 if (!empty($item['title'])) {
433 $title = $item['title'];
434 } elseif (!empty($item['content-warning']) && DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'disable_cw', false)) {
435 $title = ucfirst($item['content-warning']);
440 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'hide_dislike')) {
441 $buttons['dislike'] = false;
444 // Disable features that aren't available in several networks
445 if (!in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA])) {
446 if ($buttons['dislike']) {
447 $buttons['dislike'] = false;
454 if ($buttons['like'] && in_array($item['network'], [Protocol::FEED, Protocol::MAIL])) {
455 $buttons['like'] = false;
458 $tags = Tag::populateFromItem($item);
460 $ago = Temporal::getRelativeDate($item['created']);
461 $ago_received = Temporal::getRelativeDate($item['received']);
462 if (DI::config()->get('system', 'show_received') && (abs(strtotime($item['created']) - strtotime($item['received'])) > DI::config()->get('system', 'show_received_seconds')) && ($ago != $ago_received)) {
463 $ago = DI::l10n()->t('%s (Received %s)', $ago, $ago_received);
466 // Fetching of Diaspora posts doesn't always work. There are issues with reshares and possibly comments
467 if (!DI::userSession()->getLocalUserId() && ($item['network'] != Protocol::DIASPORA) && !empty(DI::session()->get('remote_comment'))) {
469 DI::l10n()->t('Comment this item on your system'), DI::l10n()->t('Remote comment'),
470 str_replace('{uri}', urlencode($item['uri']), DI::session()->get('remote_comment'))
473 // Ensure to either display the remote comment or the local activities
477 $remote_comment = '';
481 if (!empty($item['direction'])) {
482 $direction = $item['direction'];
486 if (!empty($item['language'])) {
487 $languages = [DI::l10n()->t('Languages'), Item::getLanguageMessage($item)];
490 if (in_array($item['private'], [Item::PUBLIC, Item::UNLISTED]) && in_array($item['network'], Protocol::FEDERATED)) {
491 $browsershare = [DI::l10n()->t('Share via ...'), DI::l10n()->t('Share via external services')];
493 $browsershare = null;
497 'template' => $this->getTemplate(),
498 'type' => implode('', array_slice(explode('/', $item['verb']), -1)),
499 'comment_firstcollapsed' => false,
500 'comment_lastcollapsed' => false,
501 'suppress_tags' => DI::config()->get('system', 'suppress_tags'),
502 'tags' => $tags['tags'],
503 'hashtags' => $tags['hashtags'],
504 'mentions' => $tags['mentions'],
505 'implicit_mentions' => $tags['implicit_mentions'],
506 'txt_cats' => DI::l10n()->t('Categories:'),
507 'txt_folders' => DI::l10n()->t('Filed under:'),
508 'has_cats' => ((count($categories)) ? 'true' : ''),
509 'has_folders' => ((count($folders)) ? 'true' : ''),
510 'categories' => $categories,
511 'folders' => $folders,
512 'body_html' => $body_html,
513 'text' => strip_tags($body_html),
514 'id' => $this->getId(),
515 'guid' => urlencode($item['guid']),
516 'isevent' => $isevent,
518 'linktitle' => DI::l10n()->t('View %s\'s profile @ %s', $profile_name, $item['author-link']),
519 'olinktitle' => DI::l10n()->t('View %s\'s profile @ %s', $this->getOwnerName(), $item['owner-link']),
520 'to' => DI::l10n()->t('to'),
521 'via' => DI::l10n()->t('via'),
522 'wall' => DI::l10n()->t('Wall-to-Wall'),
523 'vwall' => DI::l10n()->t('via Wall-To-Wall:'),
524 'profile_url' => $profile_link,
525 'name' => $profile_name,
526 'item_photo_menu_html' => DI::contentItem()->photoMenu($item, $formSecurityToken),
527 'thumb' => DI::baseUrl()->remove(DI::contentItem()->getAuthorAvatar($item)),
528 'osparkle' => $osparkle,
529 'sparkle' => $sparkle,
531 'localtime' => DateTimeFormat::local($item['created'], 'r'),
532 'ago' => $item['app'] ? DI::l10n()->t('%s from %s', $ago, $item['app']) : $ago,
533 'app' => $item['app'],
536 'private' => $item['private'],
537 'privacy' => $privacy,
538 'connector' => $connector,
539 'location_html' => $location_html,
542 'owner_self' => $item['author-link'] == DI::session()->get('my_url'),
543 'owner_url' => $this->getOwnerUrl(),
544 'owner_photo' => DI::baseUrl()->remove(DI::contentItem()->getOwnerAvatar($item)),
545 'owner_name' => $this->getOwnerName(),
546 'plink' => Item::getPlink($item),
547 'browsershare' => $browsershare,
549 'ispinned' => $ispinned,
552 'isstarred' => $isstarred,
554 'ignore' => $ignore_thread,
557 'language' => $languages,
560 'ignore_author' => $ignore,
561 'collapse' => $collapse,
564 'like_html' => $responses['like']['output'],
565 'dislike_html' => $responses['dislike']['output'],
566 'emojis' => $this->getEmojis($item),
567 'responses' => $responses,
568 'switchcomment' => DI::l10n()->t('Comment'),
569 'reply_label' => DI::l10n()->t('Reply to %s', $profile_name),
570 'comment_html' => $comment_html,
571 'remote_comment' => $remote_comment,
572 'menu' => DI::l10n()->t('More'),
573 'previewing' => $conv->isPreview() ? ' preview ' : '',
574 'wait' => DI::l10n()->t('Please wait'),
575 'thread_level' => $thread_level,
577 'network' => $item['network'],
578 'network_name' => ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network'], $item['author-gsid']),
579 'network_icon' => ContactSelector::networkToIcon($item['network'], $item['author-link'], $item['author-gsid']),
580 'received' => $item['received'],
581 'commented' => $item['commented'],
582 'created_date' => $item['created'],
583 'uriid' => $item['uri-id'],
584 'return' => (DI::args()->getCommand()) ? bin2hex(DI::args()->getCommand()) : '',
585 'direction' => $direction,
586 'reshared' => $item['reshared'] ?? '',
588 'queue_count' => $item['delivery_queue_count'],
589 'queue_done' => $item['delivery_queue_done'] + $item['delivery_queue_failed'], /// @todo Possibly display it separately in the future
590 'notifier_pending' => DI::l10n()->t('Notifier task is pending'),
591 'delivery_pending' => DI::l10n()->t('Delivery to remote servers is pending'),
592 'delivery_underway' => DI::l10n()->t('Delivery to remote servers is underway'),
593 'delivery_almost' => DI::l10n()->t('Delivery to remote servers is mostly done'),
594 'delivery_done' => DI::l10n()->t('Delivery to remote servers is done'),
598 $arr = ['item' => $item, 'output' => $tmp_item];
599 Hook::callAll('display_item', $arr);
601 $result = $arr['output'];
603 $result['children'] = [];
604 $children = $this->getChildren();
605 $nb_children = count($children);
606 if ($nb_children > 0) {
607 foreach ($children as $child) {
608 $result['children'][] = $child->getTemplateData($conv_responses, $formSecurityToken, $thread_level + 1);
612 if (($nb_children > 2) || ($thread_level > 1)) {
613 $result['children'][0]['comment_firstcollapsed'] = true;
614 $result['children'][0]['num_comments'] = DI::l10n()->tt('%d comment', '%d comments', $total_children);
615 $result['children'][0]['show_text'] = DI::l10n()->t('Show more');
616 $result['children'][0]['hide_text'] = DI::l10n()->t('Show fewer');
617 if ($thread_level > 1) {
618 $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
620 $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
625 // Copy values/set defaults
626 $result['total_comments_num'] = $this->isToplevel() ? $total_children : 0;
627 $result['private'] = $item['private'];
628 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
629 $result['flatten'] = !$this->isThreaded();
630 $result['threaded'] = $this->isThreaded();
641 private function getEmojis(array $item): array
643 if (empty($item['emojis'])) {
648 foreach ($item['emojis'] as $index => $element) {
649 $actors = implode(', ', $element['title']);
650 switch ($element['verb']) {
651 case Activity::ANNOUNCE:
652 $title = DI::l10n()->t('Reshared by: %s', $actors);
653 $icon = ['fa' => 'fa-retweet', 'icon' => 'icon-retweet'];
657 $title = DI::l10n()->t('Viewed by: %s', $actors);
658 $icon = ['fa' => 'fa-eye', 'icon' => 'icon-eye-open'];
662 $title = DI::l10n()->t('Liked by: %s', $actors);
663 $icon = ['fa' => 'fa-thumbs-up', 'icon' => 'icon-thumbs-up'];
666 case Activity::DISLIKE:
667 $title = DI::l10n()->t('Disliked by: %s', $actors);
668 $icon = ['fa' => 'fa-thumbs-down', 'icon' => 'icon-thumbs-down'];
671 case Activity::ATTEND:
672 $title = DI::l10n()->t('Attended by: %s', $actors);
673 $icon = ['fa' => 'fa-check', 'icon' => 'icon-ok'];
676 case Activity::ATTENDMAYBE:
677 $title = DI::l10n()->t('Maybe attended by: %s', $actors);
678 $icon = ['fa' => 'fa-question', 'icon' => 'icon-question'];
681 case Activity::ATTENDNO:
682 $title = DI::l10n()->t('Not attended by: %s', $actors);
683 $icon = ['fa' => 'fa-times', 'icon' => 'icon-remove'];
687 $title = DI::l10n()->t('Reacted with %s by: %s', $element['emoji'], $actors);
691 $emojis[$index] = ['emoji' => $element['emoji'], 'total' => $element['total'], 'title' => $title, 'icon' => $icon];
701 public function getId(): int
703 return $this->getDataValue('id');
709 public function isThreaded(): bool
711 return $this->threaded;
717 * @param Post $item The child post to add
719 * @return Post|bool Last Post object or bool on any error
722 public function addChild(Post $item)
724 if (!$item->getId()) {
725 Logger::error('Post object has no id', ['post' => $item]);
727 } elseif ($this->getChild($item->getId())) {
728 Logger::warning('Post object already exists', ['post' => $item]);
733 * Only add what will be displayed
735 if ($item->getDataValue('network') === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item->getDataValue('uid')) {
736 Logger::warning('Post object does not belong to local user', ['post' => $item, 'local_user' => DI::userSession()->getLocalUserId()]);
739 DI::activity()->match($item->getDataValue('verb'), Activity::LIKE) ||
740 DI::activity()->match($item->getDataValue('verb'), Activity::DISLIKE)
742 Logger::warning('Post objects is a like/dislike', ['post' => $item]);
746 $item->setParent($this);
747 $this->children[] = $item;
749 return end($this->children);
753 * Get a child by its ID
755 * @param integer $id The child id
756 * @return Thread|null Thread or NULL if not found
758 public function getChild(int $id)
760 foreach ($this->getChildren() as $child) {
761 if ($child->getId() == $id) {
770 * Get all our children
774 public function getChildren(): array
776 return $this->children;
782 * @param Post $item The item to set as parent
785 protected function setParent(Post $item)
787 $parent = $this->getParent();
789 $parent->removeChild($this);
792 $this->parent = $item;
793 $this->setThread($item->getThread());
801 protected function removeParent()
803 $this->parent = null;
804 $this->thread = null;
810 * @param Post $item The child to be removed
811 * @return boolean Success or failure
814 public function removeChild(Post $item): bool
816 $id = $item->getId();
817 foreach ($this->getChildren() as $key => $child) {
818 if ($child->getId() == $id) {
819 $child->removeParent();
820 unset($this->children[$key]);
821 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
822 $this->children = array_values($this->children);
827 Logger::info('[WARN] Item::removeChild : Item is not a child (' . $id . ').');
836 protected function getParent()
838 return $this->parent;
842 * Set conversation thread
844 * @param Thread|null $thread
848 public function setThread(Thread $thread = null)
850 $this->thread = $thread;
852 // Set it on our children too
853 foreach ($this->getChildren() as $child) {
854 $child->setThread($thread);
861 * @return Thread|null
863 public function getThread()
865 return $this->thread;
871 * We shouldn't need this
875 public function getData(): array
883 * @param string $name key
885 * @return mixed value on success, false on failure
887 public function getDataValue(string $name)
889 if (!isset($this->data[$name])) {
890 // Logger::info('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".');
894 return $this->data[$name];
898 * Set template by name
900 * @param string $name Template name
903 * @throws InvalidArgumentException
905 private function setTemplate(string $name)
907 if (empty($this->available_templates[$name])) {
909 throw new InvalidArgumentException('[ERROR] Item::setTemplate : Template not available ("' . $name . '").');
912 $this->template = $this->available_templates[$name];
920 private function getTemplate()
922 return $this->template;
926 * Check if this is a toplevel post
930 private function isToplevel(): bool
932 return $this->toplevel;
936 * Check if this is writable
940 private function isWritable(): bool
942 $conv = $this->getThread();
945 // This will allow us to comment on wall-to-wall items owned by our friends
946 // and community groups even if somebody else wrote the post.
947 // bug #517 - this fixes for conversation owner
948 if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == DI::userSession()->getLocalUserId()) {
952 // this fixes for visitors
953 return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
955 return $this->writable;
959 * Count the total of our descendants
963 private function countDescendants(): int
965 $children = $this->getChildren();
966 $total = count($children);
968 foreach ($children as $child) {
969 $total += $child->countDescendants();
977 * Get the template for the comment box
981 private function getCommentBoxTemplate(): string
983 return $this->comment_box_template;
987 * Get default text for the comment box
990 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
992 private function getDefaultText(): string
996 if (!DI::userSession()->getLocalUserId()) {
1000 $owner = User::getOwnerDataById($a->getLoggedInUserId());
1001 $item = $this->getData();
1003 if (!empty($item['content-warning']) && Feature::isEnabled(DI::userSession()->getLocalUserId(), 'add_abstract')) {
1004 $text = '[abstract=' . Protocol::ACTIVITYPUB . ']' . $item['content-warning'] . "[/abstract]\n";
1009 if (!Feature::isEnabled(DI::userSession()->getLocalUserId(), 'explicit_mentions')) {
1013 if (($item['author-addr'] != $owner['addr']) && (($item['gravity'] != Item::GRAVITY_PARENT) || !in_array($item['network'], [Protocol::DIASPORA]))) {
1014 $text .= '@' . $item['author-addr'] . ' ';
1017 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
1018 foreach ($terms as $term) {
1019 if (!$term['url']) {
1020 DI::logger()->warning('Mention term with no URL', ['term' => $term]);
1024 $profile = Contact::getByURL($term['url'], false, ['addr', 'contact-type']);
1026 !empty($profile['addr']) && (($profile['contact-type'] ?? Contact::TYPE_UNKNOWN) != Contact::TYPE_COMMUNITY) &&
1027 ($profile['addr'] != $owner['addr']) && !strstr($text, $profile['addr'])
1029 $text .= '@' . $profile['addr'] . ' ';
1037 * Get the comment box
1039 * @param string $indent Indent value
1041 * @return mixed The comment box string (empty if no comment box), false on failure
1042 * @throws \Exception
1043 * @todo return false is nowhere in this method?
1045 private function getCommentBox(string $indent)
1050 $conv = $this->getThread();
1052 if ($conv->isWritable() && $this->isWritable()) {
1054 * Hmmm, code depending on the presence of a particular addon?
1055 * This should be better if done by a hook
1058 if (Addon::isEnabled('qcomment')) {
1059 $words = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'qcomment', 'words');
1060 $qcomment = $words ? explode("\n", $words) : [];
1063 // Fetch the user id from the parent when the owner user is empty
1064 $uid = $conv->getProfileOwner();
1065 $parent_uid = $this->getDataValue('uid');
1067 $owner = User::getOwnerDataById($a->getLoggedInUserId());
1069 $default_text = $this->getDefaultText();
1071 if (!is_null($parent_uid) && ($uid != $parent_uid)) {
1075 $template = Renderer::getMarkupTemplate($this->getCommentBoxTemplate());
1076 $comment_box = Renderer::replaceMacros($template, [
1077 '$return_path' => DI::args()->getQueryString(),
1078 '$threaded' => $this->isThreaded(),
1080 '$wall' => ($conv->getMode() === 'profile'),
1081 '$id' => $this->getId(),
1082 '$parent' => $this->getId(),
1083 '$qcomment' => $qcomment,
1084 '$default' => $default_text,
1085 '$profile_uid' => $uid,
1086 '$mylink' => DI::baseUrl()->remove($owner['url'] ?? ''),
1087 '$mytitle' => DI::l10n()->t('This is you'),
1088 '$myphoto' => DI::baseUrl()->remove($owner['thumb'] ?? ''),
1089 '$comment' => DI::l10n()->t('Comment'),
1090 '$submit' => DI::l10n()->t('Submit'),
1091 '$loading' => DI::l10n()->t('Loading...'),
1092 '$edbold' => DI::l10n()->t('Bold'),
1093 '$editalic' => DI::l10n()->t('Italic'),
1094 '$eduline' => DI::l10n()->t('Underline'),
1095 '$contentwarn' => DI::l10n()->t('Content Warning'),
1096 '$edquote' => DI::l10n()->t('Quote'),
1097 '$edemojis' => DI::l10n()->t('Add emojis'),
1098 '$edcode' => DI::l10n()->t('Code'),
1099 '$edimg' => DI::l10n()->t('Image'),
1100 '$edurl' => DI::l10n()->t('Link'),
1101 '$edattach' => DI::l10n()->t('Link or Media'),
1102 '$prompttext' => DI::l10n()->t('Please enter a image/video/audio/webpage URL:'),
1103 '$preview' => DI::l10n()->t('Preview'),
1104 '$indent' => $indent,
1105 '$rand_num' => Crypto::randomDigits(12)
1109 return $comment_box;
1115 private function getRedirectUrl(): string
1117 return $this->redirect_url;
1121 * Check if we are a wall to wall item and set the relevant properties
1124 * @throws \Exception
1126 protected function checkWallToWall()
1129 $conv = $this->getThread();
1130 $this->wall_to_wall = false;
1132 if ($this->isToplevel()) {
1133 if ($conv->getMode() !== 'profile') {
1134 if ($this->getDataValue('owner-link')) {
1135 $owner_linkmatch = (($this->getDataValue('owner-link')) && Strings::compareLink($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
1136 $alias_linkmatch = (($this->getDataValue('alias')) && Strings::compareLink($this->getDataValue('alias'), $this->getDataValue('author-link')));
1137 $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
1139 if (!$owner_linkmatch && !$alias_linkmatch && !$owner_namematch) {
1141 * The author url doesn't match the owner (typically the contact)
1142 * and also doesn't match the contact alias.
1143 * The name match is a hack to catch several weird cases where URLs are
1144 * all over the park. It can be tricked, but this prevents you from
1145 * seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
1146 * well that it's the same Bob Smith.
1147 * But it could be somebody else with the same name. It just isn't highly likely.
1149 $this->owner_name = $this->getDataValue('owner-name');
1150 $this->wall_to_wall = true;
1154 'id' => $this->getDataValue('owner-id'),
1155 'network' => $this->getDataValue('owner-network'),
1156 'url' => $this->getDataValue('owner-link'),
1157 'alias' => $this->getDataValue('owner-alias'),
1159 $this->owner_url = Contact::magicLinkByContact($owner);
1165 if (!$this->wall_to_wall) {
1166 $this->setTemplate('wall');
1167 $this->owner_url = '';
1168 $this->owner_name = '';
1175 private function isWallToWall(): bool
1177 return $this->wall_to_wall;
1183 private function getOwnerUrl(): string
1185 return $this->owner_url;
1191 private function getOwnerName(): string
1193 return $this->owner_name;
1199 private function isVisiting(): bool
1201 return $this->visiting;