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]);
211 // On Diaspora only toplevel posts can be reshared
212 if ($announceable && ($item['network'] == Protocol::DIASPORA) && ($item['gravity'] != Item::GRAVITY_PARENT)) {
213 $announceable = false;
218 if (DI::userSession()->getLocalUserId()) {
219 if (Strings::compareLink(DI::session()->get('my_url'), $item['author-link'])) {
220 if ($item['event-id'] != 0) {
221 $edpost = ['calendar/event/edit/' . $item['event-id'], DI::l10n()->t('Edit')];
223 $edpost = [sprintf('post/%s/edit', $item['id']), DI::l10n()->t('Edit')];
226 $dropping = in_array($item['uid'], [0, DI::userSession()->getLocalUserId()]);
229 // Editing on items of not subscribed users isn't currently possible
230 // There are some issues on editing that prevent this.
231 // But also it is an issue of the supported protocols that doesn't allow editing at all.
232 if ($item['uid'] == 0) {
236 if (($this->getDataValue('uid') == DI::userSession()->getLocalUserId()) || $this->isVisiting()) {
240 $origin = $item['origin'] || $item['parent-origin'];
242 if (!empty($item['featured'])) {
243 $pinned = DI::l10n()->t('Pinned item');
246 // Showing the one or the other text, depending upon if we can only hide it or really delete it.
247 $delete = $origin ? DI::l10n()->t('Delete globally') : DI::l10n()->t('Remove locally');
252 if (DI::userSession()->getLocalUserId()) {
254 'dropping' => $dropping,
255 'pagedrop' => $item['pagedrop'],
256 'select' => DI::l10n()->t('Select'),
261 if (!$item['self'] && DI::userSession()->getLocalUserId()) {
264 'block' => DI::l10n()->t('Block %s', $item['author-name']),
265 'author_id' => $item['author-id'],
269 'ignore' => DI::l10n()->t('Ignore %s', $item['author-name']),
270 'author_id' => $item['author-id'],
274 $filer = DI::userSession()->getLocalUserId() ? DI::l10n()->t('Save to folder') : false;
276 $profile_name = $item['author-name'];
277 if (!empty($item['author-link']) && empty($item['author-name'])) {
278 $profile_name = $item['author-link'];
281 if (DI::userSession()->isAuthenticated()) {
282 $author = ['uid' => 0, 'id' => $item['author-id'],
283 'network' => $item['author-network'], 'url' => $item['author-link']];
284 $profile_link = Contact::magicLinkByContact($author);
286 $profile_link = $item['author-link'];
289 if (strpos($profile_link, 'contact/redir/') === 0) {
290 $sparkle = ' sparkle';
293 $locate = ['location' => $item['location'], 'coord' => $item['coord'], 'html' => ''];
294 Hook::callAll('render_location', $locate);
295 $location_html = $locate['html'] ?: Strings::escapeHtml($locate['location'] ?: $locate['coord'] ?: '');
297 // process action responses - e.g. like/dislike/attend/agree/whatever
298 $response_verbs = ['like', 'dislike', 'announce'];
302 if ($item['object-type'] === Activity\ObjectType::EVENT) {
303 $response_verbs[] = 'attendyes';
304 $response_verbs[] = 'attendno';
305 $response_verbs[] = 'attendmaybe';
307 if ($conv->isWritable()) {
309 $attend = [DI::l10n()->t('I will attend'), DI::l10n()->t('I will not attend'), DI::l10n()->t('I might attend')];
314 foreach ($response_verbs as $value => $verb) {
315 $responses[$verb] = [
316 'self' => $conv_responses[$verb][$item['uri-id']]['self'] ?? 0,
317 'output' => !empty($conv_responses[$verb][$item['uri-id']]) ? DI::conversation()->formatActivity($conv_responses[$verb][$item['uri-id']]['links'], $verb, $item['uri-id']) : '',
322 * We should avoid doing this all the time, but it depends on the conversation mode
323 * And the conv mode may change when we change the conv, or it changes its mode
324 * Maybe we should establish a way to be notified about conversation changes
326 $this->checkWallToWall();
328 if ($this->isWallToWall() && ($this->getOwnerUrl() == $this->getRedirectUrl())) {
329 $osparkle = ' sparkle';
334 if ($this->isToplevel()) {
335 if (DI::userSession()->getLocalUserId()) {
336 $ignored_thread = PostModel\ThreadUser::getIgnored($item['uri-id'], DI::userSession()->getLocalUserId());
337 if ($item['mention'] || $ignored_thread) {
339 'do' => DI::l10n()->t('Ignore thread'),
340 'undo' => DI::l10n()->t('Unignore thread'),
341 'toggle' => DI::l10n()->t('Toggle ignore status'),
342 'classdo' => $ignored_thread ? 'hidden' : '',
343 'classundo' => $ignored_thread ? '' : 'hidden',
344 'ignored' => DI::l10n()->t('Ignored'),
348 $isstarred = (($item['starred']) ? 'starred' : 'unstarred');
351 'do' => DI::l10n()->t('Add star'),
352 'undo' => DI::l10n()->t('Remove star'),
353 'toggle' => DI::l10n()->t('Toggle star status'),
354 'classdo' => $item['starred'] ? 'hidden' : '',
355 'classundo' => $item['starred'] ? '' : 'hidden',
356 'starred' => DI::l10n()->t('Starred'),
359 if ($conv->getProfileOwner() == DI::userSession()->getLocalUserId() && ($item['uid'] != 0)) {
360 if ($origin && in_array($item['private'], [Item::PUBLIC, Item::UNLISTED])) {
361 $ispinned = ($item['featured'] ? 'pinned' : 'unpinned');
364 'do' => DI::l10n()->t('Pin'),
365 'undo' => DI::l10n()->t('Unpin'),
366 'toggle' => DI::l10n()->t('Toggle pin status'),
367 'classdo' => $item['featured'] ? 'hidden' : '',
368 'classundo' => $item['featured'] ? '' : 'hidden',
369 'pinned' => DI::l10n()->t('Pinned'),
374 'add' => DI::l10n()->t('Add tag'),
383 if ($conv->isWritable()) {
384 $buttons['like'] = [DI::l10n()->t("I like this \x28toggle\x29") , DI::l10n()->t('Like')];
385 $buttons['dislike'] = [DI::l10n()->t("I don't like this \x28toggle\x29"), DI::l10n()->t('Dislike')];
387 $buttons['share'] = [DI::l10n()->t('Quote share this'), DI::l10n()->t('Quote Share')];
390 $buttons['announce'] = [DI::l10n()->t('Reshare this'), DI::l10n()->t('Reshare')];
391 $buttons['unannounce'] = [DI::l10n()->t('Cancel your Reshare'), DI::l10n()->t('Unshare')];
395 $comment_html = $this->getCommentBox($indent);
397 if (strcmp(DateTimeFormat::utc($item['created']), DateTimeFormat::utc('now - 12 hours')) > 0) {
401 DI::contentItem()->localize($item);
403 $body_html = Item::prepareBody($item, true);
405 list($categories, $folders) = DI::contentItem()->determineCategoriesTerms($item, DI::userSession()->getLocalUserId());
407 if (!empty($item['title'])) {
408 $title = $item['title'];
409 } elseif (!empty($item['content-warning']) && DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'disable_cw', false)) {
410 $title = ucfirst($item['content-warning']);
415 if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'hide_dislike')) {
416 $buttons['dislike'] = false;
419 // Disable features that aren't available in several networks
420 if (!in_array($item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA])) {
421 if ($buttons['dislike']) {
422 $buttons['dislike'] = false;
429 if ($buttons['like'] && in_array($item['network'], [Protocol::FEED, Protocol::MAIL])) {
430 $buttons['like'] = false;
433 $tags = Tag::populateFromItem($item);
435 $ago = Temporal::getRelativeDate($item['created']);
436 $ago_received = Temporal::getRelativeDate($item['received']);
437 if (DI::config()->get('system', 'show_received') && (abs(strtotime($item['created']) - strtotime($item['received'])) > DI::config()->get('system', 'show_received_seconds')) && ($ago != $ago_received)) {
438 $ago = DI::l10n()->t('%s (Received %s)', $ago, $ago_received);
441 // Fetching of Diaspora posts doesn't always work. There are issues with reshares and possibly comments
442 if (!DI::userSession()->getLocalUserId() && ($item['network'] != Protocol::DIASPORA) && !empty(DI::session()->get('remote_comment'))) {
443 $remote_comment = [DI::l10n()->t('Comment this item on your system'), DI::l10n()->t('Remote comment'),
444 str_replace('{uri}', urlencode($item['uri']), DI::session()->get('remote_comment'))];
446 // Ensure to either display the remote comment or the local activities
450 $remote_comment = '';
454 if (!empty($item['direction'])) {
455 $direction = $item['direction'];
459 if (!empty($item['language'])) {
460 $languages = [DI::l10n()->t('Languages'), Item::getLanguageMessage($item)];
463 if (in_array($item['private'], [Item::PUBLIC, Item::UNLISTED]) && in_array($item['network'], Protocol::FEDERATED)) {
464 $browsershare = [DI::l10n()->t('Share via ...'), DI::l10n()->t('Share via external services')];
466 $browsershare = null;
470 'template' => $this->getTemplate(),
471 'type' => implode('', array_slice(explode('/', $item['verb']), -1)),
472 'comment_firstcollapsed' => false,
473 'comment_lastcollapsed' => false,
474 'suppress_tags' => DI::config()->get('system', 'suppress_tags'),
475 'tags' => $tags['tags'],
476 'hashtags' => $tags['hashtags'],
477 'mentions' => $tags['mentions'],
478 'implicit_mentions' => $tags['implicit_mentions'],
479 'txt_cats' => DI::l10n()->t('Categories:'),
480 'txt_folders' => DI::l10n()->t('Filed under:'),
481 'has_cats' => ((count($categories)) ? 'true' : ''),
482 'has_folders' => ((count($folders)) ? 'true' : ''),
483 'categories' => $categories,
484 'folders' => $folders,
485 'body_html' => $body_html,
486 'text' => strip_tags($body_html),
487 'id' => $this->getId(),
488 'guid' => urlencode($item['guid']),
489 'isevent' => $isevent,
491 'linktitle' => DI::l10n()->t('View %s\'s profile @ %s', $profile_name, $item['author-link']),
492 'olinktitle' => DI::l10n()->t('View %s\'s profile @ %s', $this->getOwnerName(), $item['owner-link']),
493 'to' => DI::l10n()->t('to'),
494 'via' => DI::l10n()->t('via'),
495 'wall' => DI::l10n()->t('Wall-to-Wall'),
496 'vwall' => DI::l10n()->t('via Wall-To-Wall:'),
497 'profile_url' => $profile_link,
498 'name' => $profile_name,
499 'item_photo_menu_html' => DI::contentItem()->photoMenu($item, $formSecurityToken),
500 'thumb' => DI::baseUrl()->remove(DI::contentItem()->getAuthorAvatar($item)),
501 'osparkle' => $osparkle,
502 'sparkle' => $sparkle,
504 'localtime' => DateTimeFormat::local($item['created'], 'r'),
505 'ago' => $item['app'] ? DI::l10n()->t('%s from %s', $ago, $item['app']) : $ago,
506 'app' => $item['app'],
509 'private' => $item['private'],
510 'privacy' => $privacy,
511 'connector' => $connector,
512 'location_html' => $location_html,
515 'owner_self' => $item['author-link'] == DI::session()->get('my_url'),
516 'owner_url' => $this->getOwnerUrl(),
517 'owner_photo' => DI::baseUrl()->remove(DI::contentItem()->getOwnerAvatar($item)),
518 'owner_name' => $this->getOwnerName(),
519 'plink' => Item::getPlink($item),
520 'browsershare' => $browsershare,
522 'ispinned' => $ispinned,
525 'isstarred' => $isstarred,
527 'ignore' => $ignore_thread,
530 'language' => $languages,
533 'ignore_author' => $ignore,
535 'like_html' => $responses['like']['output'],
536 'dislike_html' => $responses['dislike']['output'],
537 'emojis' => $this->getEmojis($item),
538 'responses' => $responses,
539 'switchcomment' => DI::l10n()->t('Comment'),
540 'reply_label' => DI::l10n()->t('Reply to %s', $profile_name),
541 'comment_html' => $comment_html,
542 'remote_comment' => $remote_comment,
543 'menu' => DI::l10n()->t('More'),
544 'previewing' => $conv->isPreview() ? ' preview ' : '',
545 'wait' => DI::l10n()->t('Please wait'),
546 'thread_level' => $thread_level,
548 'network' => $item['network'],
549 'network_name' => ContactSelector::networkToName($item['author-network'], $item['author-link'], $item['network'], $item['author-gsid']),
550 'network_icon' => ContactSelector::networkToIcon($item['network'], $item['author-link'], $item['author-gsid']),
551 'received' => $item['received'],
552 'commented' => $item['commented'],
553 'created_date' => $item['created'],
554 'uriid' => $item['uri-id'],
555 'return' => (DI::args()->getCommand()) ? bin2hex(DI::args()->getCommand()) : '',
556 'direction' => $direction,
557 'reshared' => $item['reshared'] ?? '',
559 'queue_count' => $item['delivery_queue_count'],
560 'queue_done' => $item['delivery_queue_done'] + $item['delivery_queue_failed'], /// @todo Possibly display it separately in the future
561 'notifier_pending' => DI::l10n()->t('Notifier task is pending'),
562 'delivery_pending' => DI::l10n()->t('Delivery to remote servers is pending'),
563 'delivery_underway' => DI::l10n()->t('Delivery to remote servers is underway'),
564 'delivery_almost' => DI::l10n()->t('Delivery to remote servers is mostly done'),
565 'delivery_done' => DI::l10n()->t('Delivery to remote servers is done'),
569 $arr = ['item' => $item, 'output' => $tmp_item];
570 Hook::callAll('display_item', $arr);
572 $result = $arr['output'];
574 $result['children'] = [];
575 $children = $this->getChildren();
576 $nb_children = count($children);
577 if ($nb_children > 0) {
578 foreach ($children as $child) {
579 $result['children'][] = $child->getTemplateData($conv_responses, $formSecurityToken, $thread_level + 1);
583 if (($nb_children > 2) || ($thread_level > 1)) {
584 $result['children'][0]['comment_firstcollapsed'] = true;
585 $result['children'][0]['num_comments'] = DI::l10n()->tt('%d comment', '%d comments', $total_children);
586 $result['children'][0]['show_text'] = DI::l10n()->t('Show more');
587 $result['children'][0]['hide_text'] = DI::l10n()->t('Show fewer');
588 if ($thread_level > 1) {
589 $result['children'][$nb_children - 1]['comment_lastcollapsed'] = true;
591 $result['children'][$nb_children - 3]['comment_lastcollapsed'] = true;
596 // Copy values/set defaults
597 $result['total_comments_num'] = $this->isToplevel() ? $total_children : 0;
598 $result['private'] = $item['private'];
599 $result['toplevel'] = ($this->isToplevel() ? 'toplevel_item' : '');
600 $result['flatten'] = !$this->isThreaded();
601 $result['threaded'] = $this->isThreaded();
612 private function getEmojis(array $item): array
614 if (empty($item['emojis'])) {
619 foreach ($item['emojis'] as $index => $element) {
620 $actors = implode(', ', $element['title']);
621 switch ($element['verb']) {
622 case Activity::ANNOUNCE:
623 $title = DI::l10n()->t('Reshared by: %s', $actors);
624 $icon = ['fa' => 'fa-retweet', 'icon' => 'icon-retweet'];
628 $title = DI::l10n()->t('Viewed by: %s', $actors);
629 $icon = ['fa' => 'fa-eye', 'icon' => 'icon-eye-open'];
633 $title = DI::l10n()->t('Liked by: %s', $actors);
634 $icon = ['fa' => 'fa-thumbs-up', 'icon' => 'icon-thumbs-up'];
637 case Activity::DISLIKE:
638 $title = DI::l10n()->t('Disliked by: %s', $actors);
639 $icon = ['fa' => 'fa-thumbs-down', 'icon' => 'icon-thumbs-down'];
642 case Activity::ATTEND:
643 $title = DI::l10n()->t('Attended by: %s', $actors);
644 $icon = ['fa' => 'fa-check', 'icon' => 'icon-ok'];
647 case Activity::ATTENDMAYBE:
648 $title = DI::l10n()->t('Maybe attended by: %s', $actors);
649 $icon = ['fa' => 'fa-question', 'icon' => 'icon-question'];
652 case Activity::ATTENDNO:
653 $title = DI::l10n()->t('Not attended by: %s', $actors);
654 $icon = ['fa' => 'fa-times', 'icon' => 'icon-remove'];
658 $title = DI::l10n()->t('Reacted with %s by: %s', $element['emoji'], $actors);
663 $emojis[$index] = ['emoji' => $element['emoji'], 'total' => $element['total'], 'title' => $title, 'icon' => $icon];
673 public function getId(): int
675 return $this->getDataValue('id');
681 public function isThreaded(): bool
683 return $this->threaded;
689 * @param Post $item The child post to add
691 * @return Post|bool Last Post object or bool on any error
694 public function addChild(Post $item)
696 if (!$item->getId()) {
697 Logger::error('Post object has no id', ['post' => $item]);
699 } elseif ($this->getChild($item->getId())) {
700 Logger::warning('Post object already exists', ['post' => $item]);
705 * Only add what will be displayed
707 if ($item->getDataValue('network') === Protocol::MAIL && DI::userSession()->getLocalUserId() != $item->getDataValue('uid')) {
708 Logger::warning('Post object does not belong to local user', ['post' => $item, 'local_user' => DI::userSession()->getLocalUserId()]);
710 } elseif (DI::activity()->match($item->getDataValue('verb'), Activity::LIKE) ||
711 DI::activity()->match($item->getDataValue('verb'), Activity::DISLIKE)) {
712 Logger::warning('Post objects is a like/dislike', ['post' => $item]);
716 $item->setParent($this);
717 $this->children[] = $item;
719 return end($this->children);
723 * Get a child by its ID
725 * @param integer $id The child id
726 * @return Thread|null Thread or NULL if not found
728 public function getChild(int $id)
730 foreach ($this->getChildren() as $child) {
731 if ($child->getId() == $id) {
740 * Get all our children
744 public function getChildren(): array
746 return $this->children;
752 * @param Post $item The item to set as parent
755 protected function setParent(Post $item)
757 $parent = $this->getParent();
759 $parent->removeChild($this);
762 $this->parent = $item;
763 $this->setThread($item->getThread());
771 protected function removeParent()
773 $this->parent = null;
774 $this->thread = null;
780 * @param Post $item The child to be removed
781 * @return boolean Success or failure
784 public function removeChild(Post $item): bool
786 $id = $item->getId();
787 foreach ($this->getChildren() as $key => $child) {
788 if ($child->getId() == $id) {
789 $child->removeParent();
790 unset($this->children[$key]);
791 // Reindex the array, in order to make sure there won't be any trouble on loops using count()
792 $this->children = array_values($this->children);
797 Logger::info('[WARN] Item::removeChild : Item is not a child (' . $id . ').');
806 protected function getParent()
808 return $this->parent;
812 * Set conversation thread
814 * @param Thread|null $thread
818 public function setThread(Thread $thread = null)
820 $this->thread = $thread;
822 // Set it on our children too
823 foreach ($this->getChildren() as $child) {
824 $child->setThread($thread);
831 * @return Thread|null
833 public function getThread()
835 return $this->thread;
841 * We shouldn't need this
845 public function getData(): array
853 * @param string $name key
855 * @return mixed value on success, false on failure
857 public function getDataValue(string $name)
859 if (!isset($this->data[$name])) {
860 // Logger::info('[ERROR] Item::getDataValue : Item has no value name "'. $name .'".');
864 return $this->data[$name];
868 * Set template by name
870 * @param string $name Template name
873 * @throws InvalidArgumentException
875 private function setTemplate(string $name)
877 if (empty($this->available_templates[$name])) {
879 throw new InvalidArgumentException('[ERROR] Item::setTemplate : Template not available ("' . $name . '").');
882 $this->template = $this->available_templates[$name];
890 private function getTemplate()
892 return $this->template;
896 * Check if this is a toplevel post
900 private function isToplevel(): bool
902 return $this->toplevel;
906 * Check if this is writable
910 private function isWritable(): bool
912 $conv = $this->getThread();
915 // This will allow us to comment on wall-to-wall items owned by our friends
916 // and community forums even if somebody else wrote the post.
917 // bug #517 - this fixes for conversation owner
918 if ($conv->getMode() == 'profile' && $conv->getProfileOwner() == DI::userSession()->getLocalUserId()) {
922 // this fixes for visitors
923 return ($this->writable || ($this->isVisiting() && $conv->getMode() == 'profile'));
925 return $this->writable;
929 * Count the total of our descendants
933 private function countDescendants(): int
935 $children = $this->getChildren();
936 $total = count($children);
938 foreach ($children as $child) {
939 $total += $child->countDescendants();
947 * Get the template for the comment box
951 private function getCommentBoxTemplate(): string
953 return $this->comment_box_template;
957 * Get default text for the comment box
960 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
962 private function getDefaultText(): string
966 if (!DI::userSession()->getLocalUserId()) {
970 $owner = User::getOwnerDataById($a->getLoggedInUserId());
971 $item = $this->getData();
973 if (!empty($item['content-warning']) && Feature::isEnabled(DI::userSession()->getLocalUserId(), 'add_abstract')) {
974 $text = '[abstract=' . Protocol::ACTIVITYPUB . ']' . $item['content-warning'] . "[/abstract]\n";
979 if (!Feature::isEnabled(DI::userSession()->getLocalUserId(), 'explicit_mentions')) {
983 if (($item['author-addr'] != $owner['addr']) && (($item['gravity'] != Item::GRAVITY_PARENT) || !in_array($item['network'], [Protocol::DIASPORA]))) {
984 $text .= '@' . $item['author-addr'] . ' ';
987 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
988 foreach ($terms as $term) {
990 DI::logger()->warning('Mention term with no URL', ['term' => $term]);
994 $profile = Contact::getByURL($term['url'], false, ['addr', 'contact-type']);
995 if (!empty($profile['addr']) && (($profile['contact-type'] ?? Contact::TYPE_UNKNOWN) != Contact::TYPE_COMMUNITY) &&
996 ($profile['addr'] != $owner['addr']) && !strstr($text, $profile['addr'])) {
997 $text .= '@' . $profile['addr'] . ' ';
1005 * Get the comment box
1007 * @param string $indent Indent value
1009 * @return mixed The comment box string (empty if no comment box), false on failure
1010 * @throws \Exception
1011 * @todo return false is nowhere in this method?
1013 private function getCommentBox(string $indent)
1018 $conv = $this->getThread();
1020 if ($conv->isWritable() && $this->isWritable()) {
1022 * Hmmm, code depending on the presence of a particular addon?
1023 * This should be better if done by a hook
1026 if (Addon::isEnabled('qcomment')) {
1027 $words = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'qcomment', 'words');
1028 $qcomment = $words ? explode("\n", $words) : [];
1031 // Fetch the user id from the parent when the owner user is empty
1032 $uid = $conv->getProfileOwner();
1033 $parent_uid = $this->getDataValue('uid');
1035 $owner = User::getOwnerDataById($a->getLoggedInUserId());
1037 $default_text = $this->getDefaultText();
1039 if (!is_null($parent_uid) && ($uid != $parent_uid)) {
1043 $template = Renderer::getMarkupTemplate($this->getCommentBoxTemplate());
1044 $comment_box = Renderer::replaceMacros($template, [
1045 '$return_path' => DI::args()->getQueryString(),
1046 '$threaded' => $this->isThreaded(),
1048 '$wall' => ($conv->getMode() === 'profile'),
1049 '$id' => $this->getId(),
1050 '$parent' => $this->getId(),
1051 '$qcomment' => $qcomment,
1052 '$default' => $default_text,
1053 '$profile_uid' => $uid,
1054 '$mylink' => DI::baseUrl()->remove($owner['url'] ?? ''),
1055 '$mytitle' => DI::l10n()->t('This is you'),
1056 '$myphoto' => DI::baseUrl()->remove($owner['thumb'] ?? ''),
1057 '$comment' => DI::l10n()->t('Comment'),
1058 '$submit' => DI::l10n()->t('Submit'),
1059 '$loading' => DI::l10n()->t('Loading...'),
1060 '$edbold' => DI::l10n()->t('Bold'),
1061 '$editalic' => DI::l10n()->t('Italic'),
1062 '$eduline' => DI::l10n()->t('Underline'),
1063 '$edquote' => DI::l10n()->t('Quote'),
1064 '$edcode' => DI::l10n()->t('Code'),
1065 '$edimg' => DI::l10n()->t('Image'),
1066 '$edurl' => DI::l10n()->t('Link'),
1067 '$edattach' => DI::l10n()->t('Link or Media'),
1068 '$prompttext' => DI::l10n()->t('Please enter a image/video/audio/webpage URL:'),
1069 '$preview' => DI::l10n()->t('Preview'),
1070 '$indent' => $indent,
1071 '$rand_num' => Crypto::randomDigits(12)
1075 return $comment_box;
1081 private function getRedirectUrl(): string
1083 return $this->redirect_url;
1087 * Check if we are a wall to wall item and set the relevant properties
1090 * @throws \Exception
1092 protected function checkWallToWall()
1095 $conv = $this->getThread();
1096 $this->wall_to_wall = false;
1098 if ($this->isToplevel()) {
1099 if ($conv->getMode() !== 'profile') {
1100 if ($this->getDataValue('owner-link')) {
1101 $owner_linkmatch = (($this->getDataValue('owner-link')) && Strings::compareLink($this->getDataValue('owner-link'), $this->getDataValue('author-link')));
1102 $alias_linkmatch = (($this->getDataValue('alias')) && Strings::compareLink($this->getDataValue('alias'), $this->getDataValue('author-link')));
1103 $owner_namematch = (($this->getDataValue('owner-name')) && $this->getDataValue('owner-name') == $this->getDataValue('author-name'));
1105 if (!$owner_linkmatch && !$alias_linkmatch && !$owner_namematch) {
1107 * The author url doesn't match the owner (typically the contact)
1108 * and also doesn't match the contact alias.
1109 * The name match is a hack to catch several weird cases where URLs are
1110 * all over the park. It can be tricked, but this prevents you from
1111 * seeing "Bob Smith to Bob Smith via Wall-to-wall" and you know darn
1112 * well that it's the same Bob Smith.
1113 * But it could be somebody else with the same name. It just isn't highly likely.
1115 $this->owner_name = $this->getDataValue('owner-name');
1116 $this->wall_to_wall = true;
1120 'id' => $this->getDataValue('owner-id'),
1121 'network' => $this->getDataValue('owner-network'),
1122 'url' => $this->getDataValue('owner-link'),
1124 $this->owner_url = Contact::magicLinkByContact($owner);
1130 if (!$this->wall_to_wall) {
1131 $this->setTemplate('wall');
1132 $this->owner_url = '';
1133 $this->owner_name = '';
1140 private function isWallToWall(): bool
1142 return $this->wall_to_wall;
1148 private function getOwnerUrl(): string
1150 return $this->owner_url;
1156 private function getOwnerName(): string
1158 return $this->owner_name;
1164 private function isVisiting(): bool
1166 return $this->visiting;