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');
94 $author = ['uid' => 0, 'id' => $this->getDataValue('author-id'),
95 'network' => $this->getDataValue('author-network'),
96 'url' => $this->getDataValue('author-link')];
97 $this->redirect_url = Contact::magicLinkByContact($author);
98 if (!$this->isToplevel()) {
99 $this->threaded = true;
102 // Prepare the children
103 if (!empty($data['children'])) {
104 foreach ($data['children'] as $item) {
105 // Only add will be displayed
106 if ($item['network'] === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item['uid']) {
108 } elseif (!DI::contentItem()->isVisibleActivity($item)) {
112 // You can always comment on Diaspora and OStatus items
113 if (in_array($item['network'], [Protocol::OSTATUS, Protocol::DIASPORA]) && (DI::userSession()->getLocalUserId() == $item['uid'])) {
114 $item['writable'] = true;
117 $item['pagedrop'] = $data['pagedrop'];
118 $child = new Post($item);
119 $this->addChild($child);
125 * Fetch the privacy of the post
127 * @param array $item Item record
128 * @return string Item privacy message
129 * @throws InvalidArgumentException If $item['private'] is unknown
131 private function fetchPrivacy(array $item): string
133 switch ($item['private']) {
135 $output = DI::l10n()->t('Private Message');
139 $output = DI::l10n()->t('Public Message');
143 $output = DI::l10n()->t('Unlisted Message');
147 throw new InvalidArgumentException('Item privacy ' . $item['privacy'] . ' is unsupported');
154 * Get data in a form usable by a conversation template
156 * @param array $conv_responses conversation responses
157 * @param string $formSecurityToken A security Token to avoid CSF attacks
158 * @param integer $thread_level default = 1
160 * @return mixed The data requested on success, false on failure
161 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
162 * @throws \ImagickException
164 public function getTemplateData(array $conv_responses, string $formSecurityToken, int $thread_level = 1)
166 $item = $this->getData();
170 * If the time between "created" and "edited" differs we add
171 * a notice that the post was edited.
172 * Note: In some networks reshared items seem to have (sometimes) a difference
173 * between creation time and edit time of a second. Thats why we add the notice
174 * only if the difference is more than 1 second.
176 if (strtotime($item['edited']) - strtotime($item['created']) > 1) {
178 'label' => DI::l10n()->t('This entry was edited'),
179 'date' => DateTimeFormat::local($item['edited'], 'r'),
180 'relative' => Temporal::getRelativeDate($item['edited']),
194 $ignore_thread = false;
195 $ispinned = 'unpinned';
196 $isstarred = 'unstarred';
200 $total_children = $this->countDescendants();
202 $conv = $this->getThread();
204 $privacy = $this->fetchPrivacy($item);
205 $lock = ($item['private'] == Item::PRIVATE) ? $privacy : false;
206 $connector = !in_array($item['network'], Protocol::NATIVE_SUPPORT) ? DI::l10n()->t('Connector Message') : false;
208 $shareable = in_array($conv->getProfileOwner(), [0, DI::userSession()->getLocalUserId()]) && $item['private'] != Item::PRIVATE;
209 $announceable = $shareable && in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::TWITTER, Protocol::TUMBLR]);
210 $commentable = ($item['network'] != Protocol::TUMBLR);
212 // On Diaspora only toplevel posts can be reshared
213 if ($announceable && ($item['network'] == Protocol::DIASPORA) && ($item['gravity'] != Item::GRAVITY_PARENT)) {
214 $announceable = false;
219 if (DI::userSession()->getLocalUserId()) {
220 if (Strings::compareLink(DI::session()->get('my_url'), $item['author-link'])) {
221 if ($item['event-id'] != 0) {
222 $edpost = ['calendar/event/edit/' . $item['event-id'], DI::l10n()->t('Edit')];
224 $edpost = [sprintf('post/%s/edit', $item['id']), DI::l10n()->t('Edit')];
227 $dropping = in_array($item['uid'], [0, DI::userSession()->getLocalUserId()]);
230 // Editing on items of not subscribed users isn't currently possible
231 // There are some issues on editing that prevent this.
232 // But also it is an issue of the supported protocols that doesn't allow editing at all.
233 if ($item['uid'] == 0) {
237 if (($this->getDataValue('uid') == DI::userSession()->getLocalUserId()) || $this->isVisiting()) {
241 $origin = $item['origin'] || $item['parent-origin'];
243 if (!empty($item['featured'])) {
244 $pinned = DI::l10n()->t('Pinned item');
247 // Showing the one or the other text, depending upon if we can only hide it or really delete it.
248 $delete = $origin ? DI::l10n()->t('Delete globally') : DI::l10n()->t('Remove locally');
254 if (DI::userSession()->getLocalUserId()) {
256 'dropping' => $dropping,
257 'pagedrop' => $item['pagedrop'],
258 'select' => DI::l10n()->t('Select'),
263 if (!$item['self'] && DI::userSession()->getLocalUserId()) {
266 'block' => DI::l10n()->t('Block %s', $item['author-name']),
267 'author_id' => $item['author-id'],
271 'ignore' => DI::l10n()->t('Ignore %s', $item['author-name']),
272 'author_id' => $item['author-id'],
275 'collapsing' => true,
276 'collapse' => DI::l10n()->t('Collapse %s', $item['author-name']),
277 'author_id' => $item['author-id'],
281 $filer = DI::userSession()->getLocalUserId() ? DI::l10n()->t('Save to folder') : false;
283 $profile_name = $item['author-name'];
284 if (!empty($item['author-link']) && empty($item['author-name'])) {
285 $profile_name = $item['author-link'];
288 if (DI::userSession()->isAuthenticated()) {
289 $author = ['uid' => 0, 'id' => $item['author-id'],
290 'network' => $item['author-network'], 'url' => $item['author-link']];
291 $profile_link = Contact::magicLinkByContact($author);
293 $profile_link = $item['author-link'];
296 if (strpos($profile_link, 'contact/redir/') === 0) {
297 $sparkle = ' sparkle';
300 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
301 Hook::callAll('render_location', $locate);
302 $location_html = $locate['html'] ?: Strings::escapeHtml($locate['location'] ?: $locate['coord'] ?: '');
304 // process action responses - e.g. like/dislike/attend/agree/whatever
305 $response_verbs = ['like', 'dislike', 'announce'];
309 if ($item['object-type'] === Activity\ObjectType::EVENT) {
310 $response_verbs[] = 'attendyes';
311 $response_verbs[] = 'attendno';
312 $response_verbs[] = 'attendmaybe';
314 if ($conv->isWritable()) {
316 $attend = [DI::l10n()->t('I will attend'), DI::l10n()->t('I will not attend'), DI::l10n()->t('I might attend')];
321 foreach ($response_verbs as $value => $verb) {
322 $responses[$verb] = [
323 'self' => $conv_responses[$verb][$item['uri-id']]['self'] ?? 0,
324 'output' => !empty($conv_responses[$verb][$item['uri-id']]) ? DI::conversation()->formatActivity($conv_responses[$verb][$item['uri-id']]['links'], $verb, $item['uri-id']) : '',
329 * We should avoid doing this all the time, but it depends on the conversation mode
330 * And the conv mode may change when we change the conv, or it changes its mode
331 * Maybe we should establish a way to be notified about conversation changes
333 $this->checkWallToWall();
335 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
336 $osparkle = ' sparkle';
341 if ($this->isToplevel()) {
342 if (DI::userSession()->getLocalUserId()) {
343 $ignored_thread = PostModel\ThreadUser::getIgnored($item['uri-id'], DI::userSession()->getLocalUserId());
344 if ($item['mention'] || $ignored_thread) {
346 'do' => DI::l10n()->t('Ignore thread'),
347 'undo' => DI::l10n()->t('Unignore thread'),
348 'toggle' => DI::l10n()->t('Toggle ignore status'),
349 'classdo' => $ignored_thread ? 'hidden' : '',
350 'classundo' => $ignored_thread ? '' : 'hidden',
351 'ignored' => DI::l10n()->t('Ignored'),
355 $isstarred = (($item['starred']) ? 'starred' : 'unstarred');
358 'do' => DI::l10n()->t('Add star'),
359 'undo' => DI::l10n()->t('Remove star'),
360 'toggle' => DI::l10n()->t('Toggle star status'),
361 'classdo' => $item['starred'] ? 'hidden' : '',
362 'classundo' => $item['starred'] ? '' : 'hidden',
363 'starred' => DI::l10n()->t('Starred'),
366 if ($conv->getProfileOwner() == DI::userSession()->getLocalUserId() && ($item['uid'] != 0)) {
367 if ($origin && in_array($item['private'], [Item::PUBLIC, Item::UNLISTED])) {
368 $ispinned = ($item['featured'] ? 'pinned' : 'unpinned');
371 'do' => DI::l10n()->t('Pin'),
372 'undo' => DI::l10n()->t('Unpin'),
373 'toggle' => DI::l10n()->t('Toggle pin status'),
374 'classdo' => $item['featured'] ? 'hidden' : '',
375 'classundo' => $item['featured'] ? '' : 'hidden',
376 'pinned' => DI::l10n()->t('Pinned'),
381 'add' => DI::l10n()->t('Add tag'),
390 if ($conv->isWritable()) {
391 $buttons['like'] = [DI::l10n()->t("I like this \x28toggle\x29") , DI::l10n()->t('Like')];
392 $buttons['dislike'] = [DI::l10n()->t("I don't like this \x28toggle\x29"), DI::l10n()->t('Dislike')];
394 $buttons['share'] = [DI::l10n()->t('Quote share this'), DI::l10n()->t('Quote Share')];
397 $buttons['announce'] = [DI::l10n()->t('Reshare this'), DI::l10n()->t('Reshare')];
398 $buttons['unannounce'] = [DI::l10n()->t('Cancel your Reshare'), DI::l10n()->t('Unshare')];
403 $comment_html = $this->getCommentBox($indent);
408 if (strcmp(DateTimeFormat::utc($item['created']), DateTimeFormat::utc('now - 12 hours')) > 0) {
412 DI::contentItem()->localize($item);
414 $body_html = Item::prepareBody($item, true);
416 list($categories, $folders) = DI::contentItem()->determineCategoriesTerms($item, DI::userSession()->getLocalUserId());
418 if (!empty($item['title'])) {
419 $title = $item['title'];
420 } elseif (!empty($item['content-warning']) && DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'disable_cw', false)) {
421 $title = ucfirst($item['content-warning']);
426 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'hide_dislike')) {
427 $buttons['dislike'] = false;
430 // Disable features that aren't available in several networks
431 if (!in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA])) {
432 if ($buttons['dislike']) {
433 $buttons['dislike'] = false;
440 if ($buttons['like'] && in_array($item['network'], [Protocol::FEED, Protocol::MAIL])) {
441 $buttons['like'] = false;
444 $tags = Tag::populateFromItem($item);
446 $ago = Temporal::getRelativeDate($item['created']);
447 $ago_received = Temporal::getRelativeDate($item['received']);
448 if (DI::config()->get('system', 'show_received') && (abs(strtotime($item['created']) - strtotime($item['received'])) > DI::config()->get('system', 'show_received_seconds')) && ($ago != $ago_received)) {
449 $ago = DI::l10n()->t('%s (Received %s)', $ago, $ago_received);
452 // Fetching of Diaspora posts doesn't always work. There are issues with reshares and possibly comments
453 if (!DI::userSession()->getLocalUserId() && ($item['network'] != Protocol::DIASPORA) && !empty(DI::session()->get('remote_comment'))) {
454 $remote_comment = [DI::l10n()->t('Comment this item on your system'), DI::l10n()->t('Remote comment'),
455 str_replace('{uri}', urlencode($item['uri']), DI::session()->get('remote_comment'))];
457 // Ensure to either display the remote comment or the local activities
461 $remote_comment = '';
465 if (!empty($item['direction'])) {
466 $direction = $item['direction'];
470 if (!empty($item['language'])) {
471 $languages = [DI::l10n()->t('Languages'), Item::getLanguageMessage($item)];
474 if (in_array($item['private'], [Item::PUBLIC, Item::UNLISTED]) && in_array($item['network'], Protocol::FEDERATED)) {
475 $browsershare = [DI::l10n()->t('Share via ...'), DI::l10n()->t('Share via external services')];
477 $browsershare = null;
481 'template' => $this->getTemplate(),
482 'type' => implode('', array_slice(explode('/', $item['verb']), -1)),
483 'comment_firstcollapsed' => false,
484 'comment_lastcollapsed' => false,
485 'suppress_tags' => DI::config()->get('system', 'suppress_tags'),
486 'tags' => $tags['tags'],
487 'hashtags' => $tags['hashtags'],
488 'mentions' => $tags['mentions'],
489 'implicit_mentions' => $tags['implicit_mentions'],
490 'txt_cats' => DI::l10n()->t('Categories:'),
491 'txt_folders' => DI::l10n()->t('Filed under:'),
492 'has_cats' => ((count($categories)) ? 'true' : ''),
493 'has_folders' => ((count($folders)) ? 'true' : ''),
494 'categories' => $categories,
495 'folders' => $folders,
496 'body_html' => $body_html,
497 'text' => strip_tags($body_html),
498 'id' => $this->getId(),
499 'guid' => urlencode($item['guid']),
500 'isevent' => $isevent,
502 'linktitle' => DI::l10n()->t('View %s\'s profile @ %s', $profile_name, $item['author-link']),
503 'olinktitle' => DI::l10n()->t('View %s\'s profile @ %s', $this->getOwnerName(), $item['owner-link']),
504 'to' => DI::l10n()->t('to'),
505 'via' => DI::l10n()->t('via'),
506 'wall' => DI::l10n()->t('Wall-to-Wall'),
507 'vwall' => DI::l10n()->t('via Wall-To-Wall:'),
508 'profile_url' => $profile_link,
509 'name' => $profile_name,
510 'item_photo_menu_html' => DI::contentItem()->photoMenu($item, $formSecurityToken),
511 'thumb' => DI::baseUrl()->remove(DI::contentItem()->getAuthorAvatar($item)),
512 'osparkle' => $osparkle,
513 'sparkle' => $sparkle,
515 'localtime' => DateTimeFormat::local($item['created'], 'r'),
516 'ago' => $item['app'] ? DI::l10n()->t('%s from %s', $ago, $item['app']) : $ago,
517 'app' => $item['app'],
520 'private' => $item['private'],
521 'privacy' => $privacy,
522 'connector' => $connector,
523 'location_html' => $location_html,
526 'owner_self' => $item['author-link'] == DI::session()->get('my_url'),
527 'owner_url' => $this->getOwnerUrl(),
528 'owner_photo' => DI::baseUrl()->remove(DI::contentItem()->getOwnerAvatar($item)),
529 'owner_name' => $this->getOwnerName(),
530 'plink' => Item::getPlink($item),
531 'browsershare' => $browsershare,
533 'ispinned' => $ispinned,
536 'isstarred' => $isstarred,
538 'ignore' => $ignore_thread,
541 'language' => $languages,
544 'ignore_author' => $ignore,
545 'collapse' => $collapse,
547 'like_html' => $responses['like']['output'],
548 'dislike_html' => $responses['dislike']['output'],
549 'emojis' => $this->getEmojis($item),
550 'responses' => $responses,
551 'switchcomment' => DI::l10n()->t('Comment'),
552 'reply_label' => DI::l10n()->t('Reply to %s', $profile_name),
553 'comment_html' => $comment_html,
554 'remote_comment' => $remote_comment,
555 'menu' => DI::l10n()->t('More'),
556 'previewing' => $conv->isPreview() ? ' preview ' : '',
557 'wait' => DI::l10n()->t('Please wait'),
558 'thread_level' => $thread_level,
560 'network' => $item['network'],
561 'network_name' => ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network'], $item['author-gsid']),
562 'network_icon' => ContactSelector::networkToIcon($item['network'], $item['author-link'], $item['author-gsid']),
563 'received' => $item['received'],
564 'commented' => $item['commented'],
565 'created_date' => $item['created'],
566 'uriid' => $item['uri-id'],
567 'return' => (DI::args()->getCommand()) ? bin2hex(DI::args()->getCommand()) : '',
568 'direction' => $direction,
569 'reshared' => $item['reshared'] ?? '',
571 'queue_count' => $item['delivery_queue_count'],
572 'queue_done' => $item['delivery_queue_done'] + $item['delivery_queue_failed'], /// @todo Possibly display it separately in the future
573 'notifier_pending' => DI::l10n()->t('Notifier task is pending'),
574 'delivery_pending' => DI::l10n()->t('Delivery to remote servers is pending'),
575 'delivery_underway' => DI::l10n()->t('Delivery to remote servers is underway'),
576 'delivery_almost' => DI::l10n()->t('Delivery to remote servers is mostly done'),
577 'delivery_done' => DI::l10n()->t('Delivery to remote servers is done'),
581 $arr = ['item' => $item, 'output' => $tmp_item];
582 Hook::callAll('display_item', $arr);
584 $result = $arr['output'];
586 $result['children'] = [];
587 $children = $this->getChildren();
588 $nb_children = count($children);
589 if ($nb_children > 0) {
590 foreach ($children as $child) {
591 $result['children'][] = $child->getTemplateData($conv_responses, $formSecurityToken, $thread_level + 1);
595 if (($nb_children > 2) || ($thread_level > 1)) {
596 $result['children'][0]['comment_firstcollapsed'] = true;
597 $result['children'][0]['num_comments'] = DI::l10n()->tt('%d comment', '%d comments', $total_children);
598 $result['children'][0]['show_text'] = DI::l10n()->t('Show more');
599 $result['children'][0]['hide_text'] = DI::l10n()->t('Show fewer');
600 if ($thread_level > 1) {
601 $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
603 $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
608 // Copy values/set defaults
609 $result['total_comments_num'] = $this->isToplevel() ? $total_children : 0;
610 $result['private'] = $item['private'];
611 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
612 $result['flatten'] = !$this->isThreaded();
613 $result['threaded'] = $this->isThreaded();
624 private function getEmojis(array $item): array
626 if (empty($item['emojis'])) {
631 foreach ($item['emojis'] as $index => $element) {
632 $actors = implode(', ', $element['title']);
633 switch ($element['verb']) {
634 case Activity::ANNOUNCE:
635 $title = DI::l10n()->t('Reshared by: %s', $actors);
636 $icon = ['fa' => 'fa-retweet', 'icon' => 'icon-retweet'];
640 $title = DI::l10n()->t('Viewed by: %s', $actors);
641 $icon = ['fa' => 'fa-eye', 'icon' => 'icon-eye-open'];
645 $title = DI::l10n()->t('Liked by: %s', $actors);
646 $icon = ['fa' => 'fa-thumbs-up', 'icon' => 'icon-thumbs-up'];
649 case Activity::DISLIKE:
650 $title = DI::l10n()->t('Disliked by: %s', $actors);
651 $icon = ['fa' => 'fa-thumbs-down', 'icon' => 'icon-thumbs-down'];
654 case Activity::ATTEND:
655 $title = DI::l10n()->t('Attended by: %s', $actors);
656 $icon = ['fa' => 'fa-check', 'icon' => 'icon-ok'];
659 case Activity::ATTENDMAYBE:
660 $title = DI::l10n()->t('Maybe attended by: %s', $actors);
661 $icon = ['fa' => 'fa-question', 'icon' => 'icon-question'];
664 case Activity::ATTENDNO:
665 $title = DI::l10n()->t('Not attended by: %s', $actors);
666 $icon = ['fa' => 'fa-times', 'icon' => 'icon-remove'];
670 $title = DI::l10n()->t('Reacted with %s by: %s', $element['emoji'], $actors);
675 $emojis[$index] = ['emoji' => $element['emoji'], 'total' => $element['total'], 'title' => $title, 'icon' => $icon];
685 public function getId(): int
687 return $this->getDataValue('id');
693 public function isThreaded(): bool
695 return $this->threaded;
701 * @param Post $item The child post to add
703 * @return Post|bool Last Post object or bool on any error
706 public function addChild(Post $item)
708 if (!$item->getId()) {
709 Logger::error('Post object has no id', ['post' => $item]);
711 } elseif ($this->getChild($item->getId())) {
712 Logger::warning('Post object already exists', ['post' => $item]);
717 * Only add what will be displayed
719 if ($item->getDataValue('network') === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item->getDataValue('uid')) {
720 Logger::warning('Post object does not belong to local user', ['post' => $item, 'local_user' => DI::userSession()->getLocalUserId()]);
722 } elseif (DI::activity()->match($item->getDataValue('verb'), Activity::LIKE) ||
723 DI::activity()->match($item->getDataValue('verb'), Activity::DISLIKE)) {
724 Logger::warning('Post objects is a like/dislike', ['post' => $item]);
728 $item->setParent($this);
729 $this->children[] = $item;
731 return end($this->children);
735 * Get a child by its ID
737 * @param integer $id The child id
738 * @return Thread|null Thread or NULL if not found
740 public function getChild(int $id)
742 foreach ($this->getChildren() as $child) {
743 if ($child->getId() == $id) {
752 * Get all our children
756 public function getChildren(): array
758 return $this->children;
764 * @param Post $item The item to set as parent
767 protected function setParent(Post $item)
769 $parent = $this->getParent();
771 $parent->removeChild($this);
774 $this->parent = $item;
775 $this->setThread($item->getThread());
783 protected function removeParent()
785 $this->parent = null;
786 $this->thread = null;
792 * @param Post $item The child to be removed
793 * @return boolean Success or failure
796 public function removeChild(Post $item): bool
798 $id = $item->getId();
799 foreach ($this->getChildren() as $key => $child) {
800 if ($child->getId() == $id) {
801 $child->removeParent();
802 unset($this->children[$key]);
803 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
804 $this->children = array_values($this->children);
809 Logger::info('[WARN] Item::removeChild : Item is not a child (' . $id . ').');
818 protected function getParent()
820 return $this->parent;
824 * Set conversation thread
826 * @param Thread|null $thread
830 public function setThread(Thread $thread = null)
832 $this->thread = $thread;
834 // Set it on our children too
835 foreach ($this->getChildren() as $child) {
836 $child->setThread($thread);
843 * @return Thread|null
845 public function getThread()
847 return $this->thread;
853 * We shouldn't need this
857 public function getData(): array
865 * @param string $name key
867 * @return mixed value on success, false on failure
869 public function getDataValue(string $name)
871 if (!isset($this->data[$name])) {
872 // Logger::info('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".');
876 return $this->data[$name];
880 * Set template by name
882 * @param string $name Template name
885 * @throws InvalidArgumentException
887 private function setTemplate(string $name)
889 if (empty($this->available_templates[$name])) {
891 throw new InvalidArgumentException('[ERROR] Item::setTemplate : Template not available ("' . $name . '").');
894 $this->template = $this->available_templates[$name];
902 private function getTemplate()
904 return $this->template;
908 * Check if this is a toplevel post
912 private function isToplevel(): bool
914 return $this->toplevel;
918 * Check if this is writable
922 private function isWritable(): bool
924 $conv = $this->getThread();
927 // This will allow us to comment on wall-to-wall items owned by our friends
928 // and community forums even if somebody else wrote the post.
929 // bug #517 - this fixes for conversation owner
930 if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == DI::userSession()->getLocalUserId()) {
934 // this fixes for visitors
935 return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
937 return $this->writable;
941 * Count the total of our descendants
945 private function countDescendants(): int
947 $children = $this->getChildren();
948 $total = count($children);
950 foreach ($children as $child) {
951 $total += $child->countDescendants();
959 * Get the template for the comment box
963 private function getCommentBoxTemplate(): string
965 return $this->comment_box_template;
969 * Get default text for the comment box
972 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
974 private function getDefaultText(): string
978 if (!DI::userSession()->getLocalUserId()) {
982 $owner = User::getOwnerDataById($a->getLoggedInUserId());
983 $item = $this->getData();
985 if (!empty($item['content-warning']) && Feature::isEnabled(DI::userSession()->getLocalUserId(), 'add_abstract')) {
986 $text = '[abstract=' . Protocol::ACTIVITYPUB . ']' . $item['content-warning'] . "[/abstract]\n";
991 if (!Feature::isEnabled(DI::userSession()->getLocalUserId(), 'explicit_mentions')) {
995 if (($item['author-addr'] != $owner['addr']) && (($item['gravity'] != Item::GRAVITY_PARENT) || !in_array($item['network'], [Protocol::DIASPORA]))) {
996 $text .= '@' . $item['author-addr'] . ' ';
999 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
1000 foreach ($terms as $term) {
1001 if (!$term['url']) {
1002 DI::logger()->warning('Mention term with no URL', ['term' => $term]);
1006 $profile = Contact::getByURL($term['url'], false, ['addr', 'contact-type']);
1007 if (!empty($profile['addr']) && (($profile['contact-type'] ?? Contact::TYPE_UNKNOWN) != Contact::TYPE_COMMUNITY) &&
1008 ($profile['addr'] != $owner['addr']) && !strstr($text, $profile['addr'])) {
1009 $text .= '@' . $profile['addr'] . ' ';
1017 * Get the comment box
1019 * @param string $indent Indent value
1021 * @return mixed The comment box string (empty if no comment box), false on failure
1022 * @throws \Exception
1023 * @todo return false is nowhere in this method?
1025 private function getCommentBox(string $indent)
1030 $conv = $this->getThread();
1032 if ($conv->isWritable() && $this->isWritable()) {
1034 * Hmmm, code depending on the presence of a particular addon?
1035 * This should be better if done by a hook
1038 if (Addon::isEnabled('qcomment')) {
1039 $words = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'qcomment', 'words');
1040 $qcomment = $words ? explode("\n", $words) : [];
1043 // Fetch the user id from the parent when the owner user is empty
1044 $uid = $conv->getProfileOwner();
1045 $parent_uid = $this->getDataValue('uid');
1047 $owner = User::getOwnerDataById($a->getLoggedInUserId());
1049 $default_text = $this->getDefaultText();
1051 if (!is_null($parent_uid) && ($uid != $parent_uid)) {
1055 $template = Renderer::getMarkupTemplate($this->getCommentBoxTemplate());
1056 $comment_box = Renderer::replaceMacros($template, [
1057 '$return_path' => DI::args()->getQueryString(),
1058 '$threaded' => $this->isThreaded(),
1060 '$wall' => ($conv->getMode() === 'profile'),
1061 '$id' => $this->getId(),
1062 '$parent' => $this->getId(),
1063 '$qcomment' => $qcomment,
1064 '$default' => $default_text,
1065 '$profile_uid' => $uid,
1066 '$mylink' => DI::baseUrl()->remove($owner['url'] ?? ''),
1067 '$mytitle' => DI::l10n()->t('This is you'),
1068 '$myphoto' => DI::baseUrl()->remove($owner['thumb'] ?? ''),
1069 '$comment' => DI::l10n()->t('Comment'),
1070 '$submit' => DI::l10n()->t('Submit'),
1071 '$loading' => DI::l10n()->t('Loading...'),
1072 '$edbold' => DI::l10n()->t('Bold'),
1073 '$editalic' => DI::l10n()->t('Italic'),
1074 '$eduline' => DI::l10n()->t('Underline'),
1075 '$edquote' => DI::l10n()->t('Quote'),
1076 '$edemojis' => DI::l10n()->t('Add emojis'),
1077 '$edcode' => DI::l10n()->t('Code'),
1078 '$edimg' => DI::l10n()->t('Image'),
1079 '$edurl' => DI::l10n()->t('Link'),
1080 '$edattach' => DI::l10n()->t('Link or Media'),
1081 '$prompttext' => DI::l10n()->t('Please enter a image/video/audio/webpage URL:'),
1082 '$preview' => DI::l10n()->t('Preview'),
1083 '$indent' => $indent,
1084 '$rand_num' => Crypto::randomDigits(12)
1088 return $comment_box;
1094 private function getRedirectUrl(): string
1096 return $this->redirect_url;
1100 * Check if we are a wall to wall item and set the relevant properties
1103 * @throws \Exception
1105 protected function checkWallToWall()
1108 $conv = $this->getThread();
1109 $this->wall_to_wall = false;
1111 if ($this->isToplevel()) {
1112 if ($conv->getMode() !== 'profile') {
1113 if ($this->getDataValue('owner-link')) {
1114 $owner_linkmatch = (($this->getDataValue('owner-link')) && Strings::compareLink($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
1115 $alias_linkmatch = (($this->getDataValue('alias')) && Strings::compareLink($this->getDataValue('alias'), $this->getDataValue('author-link')));
1116 $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
1118 if (!$owner_linkmatch && !$alias_linkmatch && !$owner_namematch) {
1120 * The author url doesn't match the owner (typically the contact)
1121 * and also doesn't match the contact alias.
1122 * The name match is a hack to catch several weird cases where URLs are
1123 * all over the park. It can be tricked, but this prevents you from
1124 * seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
1125 * well that it's the same Bob Smith.
1126 * But it could be somebody else with the same name. It just isn't highly likely.
1128 $this->owner_name = $this->getDataValue('owner-name');
1129 $this->wall_to_wall = true;
1133 'id' => $this->getDataValue('owner-id'),
1134 'network' => $this->getDataValue('owner-network'),
1135 'url' => $this->getDataValue('owner-link'),
1137 $this->owner_url = Contact::magicLinkByContact($owner);
1143 if (!$this->wall_to_wall) {
1144 $this->setTemplate('wall');
1145 $this->owner_url = '';
1146 $this->owner_name = '';
1153 private function isWallToWall(): bool
1155 return $this->wall_to_wall;
1161 private function getOwnerUrl(): string
1163 return $this->owner_url;
1169 private function getOwnerName(): string
1171 return $this->owner_name;
1177 private function isVisiting(): bool
1179 return $this->visiting;