<?php

/**
 * Kunena Component
 *
 * @package       Kunena.Site
 * @subpackage    Views
 *
 * @copyright     Copyright (C) 2008 - 2026 Kunena Team. All rights reserved.
 * @license       https://www.gnu.org/copyleft/gpl.html GNU/GPL
 * @link          https://www.kunena.org
 **/

namespace Kunena\Forum\Site\View\Topic;

\defined('_JEXEC') or die();

use Exception;
use Joomla\CMS\Factory;
use Joomla\CMS\Cache\CacheControllerFactoryInterface;
use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Session\Session;
use Joomla\CMS\Uri\Uri;
use Joomla\Input\Input;
use Joomla\Registry\Registry;
use Joomla\String\StringHelper;
use Kunena\Forum\Libraries\Attachment\KunenaAttachmentHelper;
use Kunena\Forum\Libraries\Controller\KunenaControllerDisplay;
use Kunena\Forum\Libraries\Date\KunenaDate;
use Kunena\Forum\Libraries\Event\KunenaDisplayEvent;
use Kunena\Forum\Libraries\Event\KunenaPrepareEvent;
use Kunena\Forum\Libraries\Factory\KunenaFactory;
use Kunena\Forum\Libraries\Forum\Category\KunenaCategoryHelper;
use Kunena\Forum\Libraries\Forum\Message\KunenaMessage;
use Kunena\Forum\Libraries\Forum\Message\KunenaMessageHelper;
use Kunena\Forum\Libraries\Forum\Topic\KunenaTopicHelper;
use Kunena\Forum\Libraries\Html\KunenaParser;
use Kunena\Forum\Libraries\Layout\KunenaLayout;
use Kunena\Forum\Libraries\Pagination\KunenaPagination;
use Kunena\Forum\Libraries\Request\KunenaRequest;
use Kunena\Forum\Libraries\Route\KunenaRoute;
use Kunena\Forum\Libraries\User\KunenaUserHelper;
use Kunena\Forum\Libraries\View\KunenaView;
use LogicException;

/**
 * Topic View
 *
 * @since   Kunena 6.0
 */
class HtmlView extends KunenaView
{
    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $topicButtons = null;

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $messageButtons = null;

    /**
     * @var     array
     * @since   Kunena 6.0
     */
    public $inline_attachments = [];

    /**
     * @var     null
     * @since   Kunena 6.0
     */
    public $poll = null;

    /**
     * @var     integer
     * @since   Kunena 6.0
     */
    public $mmm = 0;

    /**
     * @var     integer
     * @since   Kunena 6.0
     */
    public $k = 0;

    /**
     * @var     boolean
     * @since   Kunena 6.0
     */
    public $cache = true;

    public $ktemplate;

    public $app;

    public $config;

    public $inLayout;

    public $me;

    public $state;

    public $topic;

    public $total;

    /**
     * @var boolean|mixed
     * @since version
     */
    public $subscriptionsChecked;

    /**
     * @var boolean|mixed
     * @since version
     */
    public $postAnonymous;

    /**
     * @var array|boolean
     * @since version
     */
    public $allowedExtensions;

    /**
     * @var \Kunena\Forum\Libraries\Attachment\KunenaAttachment[]
     * @since version
     */
    public $attachments;

    /**
     * @var string
     * @since version
     */
    public $action;

    public $topicIcons;

    /**
     * @var \Kunena\Forum\Libraries\Forum\Category\KunenaCategory
     * @since version
     */
    public $category;

    /**
     * @var KunenaMessage
     * @since version
     */
    public $message;

    public $catid;

    /**
     * @var string
     * @since version
     */
    public $numLink;

    public $messages;

    public $replynum;

    /**
     * @var \Kunena\Forum\Libraries\User\KunenaUser
     * @since version
     */
    public $profile;

    public $quickReply;

    public $layout;

    public $usertopic;

    public $headerText;

    /**
     * @param   null  $tpl  tpl
     *
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function displayUnread($tpl = null)
    {
        // Redirect unread layout to the page that contains the first unread message
        $model    = $this->getModel();
        $category = $model->getCategory();
        $topic    = $model->getTopic();
        KunenaTopicHelper::fetchNewStatus([$topic->id => $topic]);

        $message = KunenaMessage::getInstance($topic->lastread ? $topic->lastread : $topic->last_post_id);

        while (@ob_end_clean()) {
        }

        $this->app->redirect($topic->getUrl($category, false, $message));
    }

    /**
     * @param   null  $tpl  tpl
     *
     * @return  void
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function displayFlat($tpl = null)
    {
        $this->state->set('layout', 'default');
        $this->me->setTopicLayout('flat');
        $this->displayDefault($tpl);
    }

    /**
     * @param   null  $tpl  tpl
     *
     * @return  void
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function displayDefault($tpl = null)
    {
        $this->layout = $this->state->get('layout');

        $errors = [];

        if ($this->layout == 'flat') {
            $this->layout = 'default';
        }

        $this->setLayout($this->layout);

        $model          = $this->getModel();
        $this->category = $model->getCategory();
        $this->topic    = $model->getTopic();
        $this->message  = $model->getMessages();
        $channels       = $this->category->getChannels();

        $options            = [];
        $options[]         = HTMLHelper::_('select.option', '0', Text::_('COM_KUNENA_FORUM_TOP'));
        $cat_params         = ['sections' => 1, 'catid' => 0];
        $this->categorylist = HTMLHelper::_('kunenaforum.categorylist', 'catid', 0, $options, $cat_params, 'class="inputbox fbs" size="1" onchange = "this.form.submit()"', 'value', 'text');

        if ($this->category->id && !$this->category->isAuthorised('read')) {
            // User is not allowed to see the category
            $errors[] = $this->category->getError();
        } elseif (!$this->topic) {
            // Moved topic loop detected (1 -> 2 -> 3 -> 2)
            $errors[] = Text::_('COM_KUNENA_VIEW_TOPIC_ERROR_LOOP');
        } elseif (!$this->topic->isAuthorised('read')) {
            // User is not allowed to see the topic
            $errors[] = $this->topic->getError();
        } elseif (
            $this->state->get('item.id') != $this->topic->id
            || ($this->category->id != $this->topic->category_id && !isset($channels[$this->topic->category_id]))
            || ($this->state->get('layout') != 'threaded' && $this->state->get('item.mesid'))
        ) {
            // We need to redirect: message has been moved or we have permalink
            $mesid = $this->state->get('item.mesid');

            if (!$mesid) {
                $mesid = $this->topic->first_post_id;
            }

            $message = KunenaMessageHelper::get($mesid);

            $this->message = $message;

            // Redirect to correct location (no redirect in embedded mode).
            if (empty($this->embedded) && $message->exists()) {
                while (@ob_end_clean()) {
                }

                $this->app->redirect($message->getUrl(null, false));
            }
        }

        if (!KunenaMessageHelper::get($this->topic->first_post_id)->exists()) {
            $this->displayError([Text::_('COM_KUNENA_NO_ACCESS')], 404);

            return;
        }

        if ($errors) {
            $this->displayNoAccess($errors);

            return;
        }

        $this->messages = $model->getMessages();
        $this->total    = model->getTotal();

        // If page does not exist, redirect to the last page (no redirect in embedded mode).
        if (empty($this->embedded) && $this->total && $this->total <= $this->state->get('list.start')) {
            while (@ob_end_clean()) {
            }

            $this->app->redirect($this->topic->getUrl(null, false, (int) (($this->total - 1) / $this->state->get('list.limit'))));
        }

        // Run events
        $params = new Registry();
        $params->set('ksource', 'kunena');
        $params->set('kunena_view', 'topic');
        $params->set('kunena_layout', 'default');

        PluginHelper::importPlugin('kunena');

        $prepareEvent = new KunenaPrepareEvent('onKunenaPrepare', [
            'context' => 'kunena.topic',
            'subject' => $this->topic,
            'params'  => $params,
            'page'    => 0
        ]);
        $this->app->getDispatcher()->dispatch('onKunenaPrepare', $prepareEvent);
        foreach ($this->messages as &$message) {
            $prepareEvent = new KunenaPrepareEvent('onKunenaPrepare', [
                'context' => 'kunena.messages',
                'subject' => $message,
                'params'  => $params,
                'page'    => 0
            ]);
            $this->app->getDispatcher()->dispatch('onKunenaPrepare', $prepareEvent);
        }

        $this->moderators = $model->getModerators();
        $this->usertopic  = $this->topic->getUserTopic();

        $this->pagination = $this->getPagination(5);

        // Mark topic read
        $this->topic->hit();

        $this->keywords = $this->topic->getKeywords(false, ', ');

        $this->_prepareDocument('default');

        $this->render('Topic/Item', $tpl, ['topic' => $this->topic, 'category' => $this->category, 'config' => $this->config, 'pagination' => $this->pagination, 'me' => $this->me, 'messages' => $this->messages, 'categorylist' => $this->categorylist]);
        $this->topic->markRead();
    }

    /**
     * @param   integer  $maxpages  max pages
     *
     * @return  string
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function getPagination($maxpages)
    {
        return $this->getPaginationObject($maxpages)->getPagesLinks();
    }

    /**
     * @param   integer  $maxpages  max pages
     *
     * @return  KunenaPagination
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function getPaginationObject($maxpages)
    {
        $pagination = new KunenaPagination($this->total, $this->state->get('list.start'), $this->state->get('list.limit'));
        $pagination->setDisplayedPages($maxpages);

        $uri = KunenaRoute::normalize(null, true);

        if ($uri) {
            $uri->delVar('mesid');
            $pagination->setUri($uri);
        }

        return $pagination;
    }

    /**
     * @param   string  $type  type
     *
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    protected function _prepareDocument($type)
    {
        $app       = Factory::getApplication();
        $menu_item = $app->getMenu()->getActive(); // Get the active item

        if ($menu_item) {
            $params             = $menu_item->getParams(); // Get the params
            $params_title       = $params->get('page_title');
            $params_description = $params->get('menu-meta_description');

            if ($type == 'default') {
                $this->headerText = Text::_('COM_KUNENA_MENU_LATEST_DESC');
                $this->title1     = Text::_('COM_KUNENA_ALL_DISCUSSIONS');

                $page  = \intval($this->state->get('list.start') / $this->state->get('list.limit')) + 1;
                $pages = \intval(($this->total - 1) / $this->state->get('list.limit')) + 1;

                if (!empty($params_title)) {
                    $title = $params->get('page_title');
                    $this->setTitle($title);
                } else {
                    $title = Text::sprintf($this->topic->subject) . " ({$page}/{$pages})";
                    $this->setTitle($title);
                }

                if (!empty($params_description)) {
                    $description = $params->get('menu-meta_description');
                    $this->setDescription($description);
                } else {
                    // Create Meta Description form the content of the first message
                    // better for search results display but NOT for search ranking!
                    $description = KunenaParser::stripBBCode($this->topic->first_post_message, 182);
                    $description = preg_replace('/\s+/', ' ', $description); // Remove newlines
                    $description = trim($description); // Remove trailing spaces and beginning

                    if ($page) {
                        $description .= " ({$page}/{$pages})";  // Avoid the "duplicate meta description" error in google webmaster tools
                    }

                    $this->setDescription($description);
                }
            } elseif ($type == 'create') {
                if (!empty($params_title)) {
                    $title = $params->get('page_title');
                    $this->setTitle($title);
                } else {
                    $title1 = Text::_('COM_KUNENA_POST_NEW_TOPIC');
                    $this->setTitle($title1);
                }

                if (!empty($params_description)) {
                    $description = $params->get('menu-meta_description');
                    $this->setDescription($description);
                } else {
                    $this->setDescription(Text::_('COM_KUNENA_POST_NEW_TOPIC'));
                }
            } elseif ($type == 'reply') {
                if (!empty($params_title)) {
                    $title = $params->get('page_title');
                    $this->setTitle($title);
                } else {
                    $title1 = Text::_('COM_KUNENA_POST_REPLY_TOPIC') . ' ' . $this->topic->subject;
                    $this->setTitle($title1);
                }

                if (!empty($params_description)) {
                    $description = $params->get('menu-meta_description');
                    $this->setDescription($description);
                } else {
                    $this->setDescription(Text::_('COM_KUNENA_POST_REPLY_TOPIC'));
                }
            } elseif ($type == 'edit') {
                if (!empty($params_title)) {
                    $title = $params->get('page_title');
                    $this->setTitle($title);
                } else {
                    $title1 = Text::_('COM_KUNENA_POST_EDIT') . ' ' . $this->topic->subject;
                    $this->setTitle($title1);
                }

                if (!empty($params_description)) {
                    $description = $params->get('menu-meta_description');
                    $this->setDescription($description);
                } else {
                    $this->setDescription(Text::_('COM_KUNENA_POST_EDIT'));
                }
            }
        }
    }

    /**
     * @param   string  $title  Title name on the browser
     *
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function setTitle(string $title): void
    {
        if ($this->inLayout) {
            throw new LogicException(sprintf('HMVC template should not call %s::%s()', __CLASS__, __FUNCTION__));
        }

        if (!$this->state->get('embedded')) {
            // Check for empty title and add site name if param is set
            $title = strip_tags($title);

            if ($this->app->get('sitename_pagetitles', 0) == 1) {
                $title = Text::sprintf('JPAGETITLE', $this->app->get('sitename'), $this->config->boardTitle . ' - ' . $title);
            } elseif ($this->app->get('sitename_pagetitles', 0) == 2) {
                $title = Text::sprintf('JPAGETITLE', $title . ' - ' . $this->config->boardTitle, $this->app->get('sitename'));
            } else {
                $title = KunenaFactory::getConfig()->boardTitle . ': ' . $title;
            }

            $this->document->setTitle($title);
        }
    }

    /**
     * @param   string  $description  description
     *
     * @return  void
     *
     * @throws Exception
     * @since   Kunena 6.0
     */
    public function setDescription($description)
    {
        if ($this->inLayout) {
            throw new LogicException(sprintf('HMVC template should not call %s::%s()', __CLASS__, __FUNCTION__));
        }

        if (!$this->state->get('embedded')) {
            // TODO: allow translations/overrides
            $lang   = Factory::getApplication()->getLanguage();
            $length = StringHelper::strlen($lang->getName());
            $length = 137 - $length;

            if (StringHelper::strlen($description) > $length) {
                $description = StringHelper::substr($description, 0, $length) . '...';
            }

            $this->document->setMetadata('description', $description);
        }
    }

    /**
     * @param   null  $tpl  tpl
     *
     * @return  void
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function displayThreaded($tpl = null)
    {
        $this->state->set('layout', 'threaded');
        $this->me->setTopicLayout('threaded');
        $this->displayDefault($tpl);
    }

    /**
     * @param   null  $tpl  tpl
     *
     * @return  void
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function displayIndented($tpl = null)
    {
        $this->state->set('layout', 'indented');
        $this->me->setTopicLayout('indented');
        $this->displayDefault($tpl);
    }

    /**
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function displayMessageProfile()
    {
        echo $this->getMessageProfileBox();
    }

    /**
     * @return  mixed
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function getMessageProfileBox()
    {
        static $profiles = [];

        $key = $this->profile->userid . '.' . $this->profile->username;

        if (!isset($profiles[$key])) {
            // Run events
            $params = new Registry();

            // Modify profile values by integration
            $params->set('ksource', 'kunena');
            $params->set('kunena_view', 'topic');
            $params->set('kunena_layout', $this->state->get('layout'));

            PluginHelper::importPlugin('kunena');

            $prepareEvent = new KunenaPrepareEvent('onKunenaPrepare', [
                'context' => 'kunena.user',
                'subject' => $this->profile,
                'params'  => $params,
                'page'    => 0
            ]);
            $this->app->getDispatcher()->dispatch('onKunenaPrepare', $prepareEvent);

            // Karma points and buttons
            $userkarma_title = $userkarma_minus = $userkarma_plus = '';

            if ($this->config->showKarma && $this->profile->userid) {
                $userkarma_title = Text::_('COM_KUNENA_KARMA') . ": " . $this->profile->karma;

                if ($this->me->userid && $this->me->userid != $this->profile->userid) {
                    $userkarma_minus = ' ' . HTMLHelper::_('link', 'index.php?option=com_kunena&view=user&task=karmadown&userid=' . $this->profile->userid . '&' . Session::getFormToken() . '=1', '<span class="kkarma-minus" border="0" data-bs-toggle="tooltip" title="' . Text::_('COM_KUNENA_KARMA_SMITE') . '"> </span>');
                    $userkarma_plus  = ' ' . HTMLHelper::_('link', 'index.php?option=com_kunena&view=user&task=karmaup&userid=' . $this->profile->userid . '&' . Session::getFormToken() . '=1', '<span class="kkarma-plus" border="0" data-bs-toggle="tooltip" title="' . Text::_('COM_KUNENA_KARMA_APPLAUD') . '"> </span>');
                }
            }

            if ($this->me->exists() && $this->message->userid == $this->me->userid) {
                $usertype = 'me';
            } else {
                $usertype = $this->profile->getType($this->category->id, true);
            }

            // TODO: add context (options) to caching
            $options = ['defaultgroup' => 'com_kunena'];
            $this->cache = Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController('output', $options);
            $this->cachekey   = "profile.{$this->getTemplateMD5()}.{$this->profile->userid}.{$usertype}";
            $this->cachegroup = 'com_kunena.messages';

            // FIXME: enable caching after fixing the issues
            $contents = false; // $this->cache->get($cachekey, $cachegroup);

            if (!$contents) {
                $this->userkarma = "{$userkarma_title} {$userkarma_minus} {$userkarma_plus}";

                // Use kunena profile
                if ($this->config->showUserStats) {
                    $this->userrankimage = $this->profile->getRank($this->topic->category_id, 'image');
                    $this->userranktitle = $this->profile->getRank($this->topic->category_id, 'title');
                    $this->userposts     = $this->profile->posts;
                    $activityIntegration = KunenaFactory::getActivityIntegration();
                    $this->userthankyou  = $this->profile->thankyou;
                    $this->userpoints    = $activityIntegration->getUserPoints($this->profile->userid);
                    $this->usermedals    = $activityIntegration->getUserMedals($this->profile->userid);
                } else {
                    $this->userrankimage = null;
                    $this->userranktitle = null;
                    $this->userposts     = null;
                    $this->userthankyou  = null;
                    $this->userpoints    = null;
                    $this->usermedals    = null;
                }

                $this->personalText = KunenaParser::parseText($this->profile->personalText);

                $contents = trim(KunenaFactory::getProfile()->showProfile($this, $params));

                if (!$contents) {
                    $contents = (string) $this->loadTemplateFile('profile');
                }

                $displayEvent = new KunenaDisplayEvent('onKunenaDisplay', ['type' => 'topic.profile', 'view' => $this, 'params' => $params]);
                Factory::getApplication()->getDispatcher()->dispatch('onKunenaDisplay', $displayEvent);
                $result = $displayEvent->getArgument('result', []);

                $contents .= \implode(' ', $result);

                // FIXME: enable caching after fixing the issues (also external profile stuff affects this)
                // if ($this->cache) $cache->store($contents, $cachekey, $cachegroup);
            }

            $profiles[$key] = $contents;
        }

        return $profiles[$key];
    }

    /**
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function displayMessageContents()
    {
        echo $this->loadTemplateFile('message');
    }

    /**
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function displayTopicActions()
    {
        echo $this->getTopicActions();
    }

    /**
     * @return  string
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function getTopicActions()
    {
        $catid = $this->state->get('item.catid');
        $id    = $this->state->get('item.id');

        $task   = "index.php?option=com_kunena&view=topic&task=%s&catid={$catid}&id={$id}&" . Session::getFormToken() . '=1';
        $layout = "index.php?option=com_kunena&view=topic&layout=%s&catid={$catid}&id={$id}";

        $this->topicButtons = new Registry();

        // Reply topic
        if ($this->topic->isAuthorised('reply')) {
            // This user is allowed to reply to this topic
            $this->topicButtons->set('reply', $this->getButton(sprintf($layout, 'reply'), 'reply', 'topic', 'communication'));
        }

        // Subscribe topic
        if ($this->usertopic->subscribed) {
            // This user is allowed to unsubscribe
            $this->topicButtons->set('subscribe', $this->getButton(sprintf($task, 'unsubscribe'), 'unsubscribe', 'topic', 'user'));
        } elseif ($this->topic->isAuthorised('subscribe')) {
            // This user is allowed to subscribe
            $this->topicButtons->set('subscribe', $this->getButton(sprintf($task, 'subscribe'), 'subscribe', 'topic', 'user'));
        }

        // Favorite topic
        if ($this->usertopic->favorite) {
            // This user is allowed to unfavorite
            $this->topicButtons->set('favorite', $this->getButton(sprintf($task, 'unfavorite'), 'unfavorite', 'topic', 'user'));
        } elseif ($this->topic->isAuthorised('favorite')) {
            // This user is allowed to add a favorite
            $this->topicButtons->set('favorite', $this->getButton(sprintf($task, 'favorite'), 'favorite', 'topic', 'user'));
        }

        // Moderator specific buttons
        if ($this->category->isAuthorised('moderate')) {
            $sticky = $this->topic->ordering ? 'unsticky' : 'sticky';
            $lock   = $this->topic->locked ? 'unlock' : 'lock';

            $this->topicButtons->set('sticky', $this->getButton(sprintf($task, $sticky), $sticky, 'topic', 'moderation'));
            $this->topicButtons->set('lock', $this->getButton(sprintf($task, $lock), $lock, 'topic', 'moderation'));
            $this->topicButtons->set('moderate', $this->getButton(sprintf($layout, 'moderate'), 'moderate', 'topic', 'moderation'));

            if ($this->topic->hold == 1 || $this->topic->hold == 0) {
                $this->topicButtons->set('delete', $this->getButton(sprintf($task, 'delete'), 'delete', 'topic', 'moderation'));
            } elseif ($this->topic->hold == 2 || $this->topic->hold == 3) {
                $this->topicButtons->set('undelete', $this->getButton(sprintf($task, 'undelete'), 'undelete', 'topic', 'moderation'));
            }
        }

        if ($this->ktemplate->params->get('enableThreadedLayouts', '0')) {
            $url = "index.php?option=com_kunena&view=user&task=change&topicLayout=%s&" . Session::getFormToken() . '=1';

            if ($this->layout != 'default') {
                $this->topicButtons->set('flat', $this->getButton(sprintf($url, 'flat'), 'flat', 'layout', 'user'));
            }

            if ($this->layout != 'threaded') {
                $this->topicButtons->set('threaded', $this->getButton(sprintf($url, 'threaded'), 'threaded', 'layout', 'user'));
            }

            if ($this->layout != 'indented') {
                $this->topicButtons->set('indented', $this->getButton(sprintf($url, 'indented'), 'indented', 'layout', 'user'));
            }
        }

        PluginHelper::importPlugin('kunena');

        Factory::getApplication()->triggerEvent('onKunenaGetButtons', ['topic.action', $this->topicButtons, $this]);

        return (string) $this->loadTemplateFile('actions');
    }

    /**
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function displayMessageActions()
    {
        echo $this->getMessageActions();
    }

    /**
     * @return  string
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function getMessageActions()
    {
        $catid        = $this->state->get('item.catid');
        $id           = $this->topic->id;
        $mesid        = $this->message->id;
        $targetuserid = $this->me->userid;

        $task   = "index.php?option=com_kunena&view=topic&task=%s&catid={$catid}&id={$id}&mesid={$mesid}&userid={$targetuserid}&" . Session::getFormToken() . '=1';
        $layout = "index.php?option=com_kunena&view=topic&layout=%s&catid={$catid}&id={$id}&mesid={$mesid}";

        $this->messageButtons = new Registry();
        $this->message_closed = null;

        // Reply / Quote
        if ($this->message->isAuthorised('reply')) {
            $this->quickReply ? $this->messageButtons->set('quickReply', $this->getButton(sprintf($layout, 'reply'), 'quickReply', 'message', 'communication', "kreply{$mesid}")) : null;
            $this->messageButtons->set('reply', $this->getButton(sprintf($layout, 'reply'), 'reply', 'message', 'communication'));
            $this->messageButtons->set('quote', $this->getButton(sprintf($layout, 'reply&quote=1'), 'quote', 'message', 'communication'));
        } elseif (!$this->me->isModerator($this->topic->getCategory())) {
            // User is not allowed to write a post
            $this->message_closed = $this->topic->locked ? Text::_('COM_KUNENA_POST_LOCK_SET') : ($this->me->exists() ? Text::_('COM_KUNENA_REPLY_USER_REPLY_DISABLED') : Text::_('COM_KUNENA_VIEW_DISABLED'));
        }

        // Thank you
        if ($this->message->isAuthorised('thankyou') && !\array_key_exists($this->me->userid, $this->message->thankyou)) {
            $this->messageButtons->set('thankyou', $this->getButton(sprintf($task, 'thankyou'), 'thankyou', 'message', 'user'));
        }

        // Unthank you
        if ($this->message->isAuthorised('unthankyou') && \array_key_exists($this->me->userid, $this->message->thankyou)) {
            $this->messageButtons->set('unthankyou', $this->getButton(sprintf($task, 'unthankyou'), 'unthankyou', 'message', 'moderation'));
        }

        // Report this
        if ($this->config->reportMsg && $this->me->exists()) {
            $this->messageButtons->set('report', $this->getButton(sprintf($layout, 'report'), 'report', 'message', 'user'));
        }

        // Moderation and own post actions
        $this->message->isAuthorised('edit') ? $this->messageButtons->set('edit', $this->getButton(sprintf($layout, 'edit'), 'edit', 'message', 'moderation')) : null;
        $this->message->isAuthorised('move') ? $this->messageButtons->set('moderate', $this->getButton(sprintf($layout, 'moderate'), 'moderate', 'message', 'moderation')) : null;

        if ($this->message->hold == 1) {
            $this->message->isAuthorised('approve') ? $this->messageButtons->set('publish', $this->getButton(sprintf($task, 'approve'), 'approve', 'message', 'moderation')) : null;
            $this->message->isAuthorised('delete') ? $this->messageButtons->set('delete', $this->getButton(sprintf($task, 'delete'), 'delete', 'message', 'moderation')) : null;
        } elseif ($this->message->hold == 2 || $this->message->hold == 3) {
            $this->message->isAuthorised('undelete') ? $this->messageButtons->set('undelete', $this->getButton(sprintf($task, 'undelete'), 'undelete', 'message', 'moderation')) : null;
            $this->message->isAuthorised('permdelete') ? $this->messageButtons->set('permdelete', $this->getButton(sprintf($task, 'permdelete'), 'permdelete', 'message', 'permanent')) : null;
        } else {
            $this->message->isAuthorised('delete') ? $this->messageButtons->set('delete', $this->getButton(sprintf($task, 'delete'), 'delete', 'message', 'moderation')) : null;
        }

        PluginHelper::importPlugin('kunena');

        Factory::getApplication()->triggerEvent('onKunenaGetButtons', ['message.action', $this->messageButtons, $this]);

        return (string) $this->loadTemplateFile("message_actions");
    }

    /**
     * @param   array  $matches  matches
     *
     * @return  mixed|string|void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function fillMessageInfo($matches)
    {
        switch ($matches[1]) {
            case 'ROW':
                return $this->mmm && 1 ? 'odd' : 'even';
            case 'DATE':
                $date = new KunenaDate($matches[2]);

                return $date->toSpan('config_postDateFormat', 'config_postDateFormatHover');
            case 'NEW':
                return $this->message->isNew() ? 'new' : 'old';
            case 'REPLYNO':
                return $this->replynum;
            case 'MESSAGE_PROFILE':
                return $this->getMessageProfileBox();
            case 'MESSAGE_ACTIONS':
                return $this->getMessageActions();
        }
    }

    /**
     * @param   null  $template  template
     *
     * @return  void
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function displayMessages($template = null)
    {
        foreach ($this->messages as $id => $message) {
            $this->displayMessage($id, $message, $template);
        }
    }

    /**
     * @param   integer  $id        id
     * @param   string   $message   message
     * @param   null     $template  template
     *
     * @return  void
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    public function displayMessage($id, $message, $template = null)
    {
        $layout = $this->getLayout();

        if (!$template) {
            $template = $this->state->get('profile.location');
            $this->setLayout('default');
        }

        $this->mmm++;
        $this->message  = $message;
        $this->profile  = $this->message->getAuthor();
        $this->replynum = $message->replynum;
        $usertype       = $this->me->getType($this->category->id, true);

        if ($usertype == 'user' && $this->message->userid == $this->profile->userid) {
            $usertype = 'owner';
        }

        // Thank you info and buttons
        $thankyou             = [];
        $this->total_thankyou = 0;
        $this->more_thankyou  = 0;

        if (isset($message->thankyou)) {
            if ($this->config->showThankYou && $this->profile->userid) {
                $task = "index.php?option=com_kunena&view=topic&task=%s&catid={$this->category->id}&id={$this->topic->id}&mesid={$this->message->id}&" . Session::getFormToken() . '=1';

                if (\count($message->thankyou) > $this->config->thankYouMax) {
                    $this->more_thankyou = \count($message->thankyou) - $this->config->thankYouMax;
                }

                $this->total_thankyou = \count($message->thankyou);
                $thankyous            = \array_slice($message->thankyou, 0, $this->config->thankYouMax, true);

                if ($this->message->isAuthorised('unthankyou') && $this->me->isModerator($this->message->getCategory())) {
                    $canUnthankyou = true;
                } else {
                    $canUnthankyou = false;
                }

                $userids_thankyous = [];

                foreach ($thankyous as $userid => $time) {
                    $userids_thankyous[] = $userid;
                }

                $loaded_users = KunenaUserHelper::loadUsers($userids_thankyous);

                $this->thankyou_delete = '';

                foreach ($loaded_users as $userid => $user) {
                    $thankyou_delete = $canUnthankyou === true ? ' <a data-bs-toggle="tooltip" title="' . Text::_('COM_KUNENA_BUTTON_THANKYOU_REMOVE_LONG') . '" href="'
                        . KunenaRoute::_(sprintf($task, "unthankyou&userid={$userid}")) . '"><img loading=lazy src="' . $this->ktemplate->getImagePath('icons/publish_x.png') . '" data-bs-toggle="tooltip" title="" alt="" /></a>' : '';
                    $thankyou[]      = $loaded_users[$userid]->getLink() . $thankyou_delete;
                }
            }
        }

        // TODO: add context (options, template) to caching
        $options = ['defaultgroup' => 'com_kunena'];
        $this->cache = Factory::getContainer()->get(CacheControllerFactoryInterface::class)->createCacheController('output', $options);
        $this->cachekey   = "message.{$this->getTemplateMD5()}.{$layout}.{$template}.{$usertype}.c{$this->category->id}.m{$this->message->id}.{$this->message->modified_time}";
        $this->cachegroup = 'com_kunena.messages';

        if ($this->config->reportMsg && $this->me->exists()) {
            if (!$this->config->userReport && $this->me->userid == $this->message->userid && !$this->me->isModerator()) {
                $this->reportMessageLink = null;
            } else {
                $this->reportMessageLink = HTMLHelper::_('link', 'index.php?option=com_kunena&view=topic&layout=report&catid=' . \intval($this->category->id) . '&id=' . \intval($this->message->thread) . '&mesid=' . \intval($this->message->id), Text::_('COM_KUNENA_REPORT'), Text::_('COM_KUNENA_REPORT'));
            }
        }

        // Get number of attachments to display error messages
        $this->attachs = $this->message->getNbAttachments();

        $contents = false; // $this->cache->get($cachekey, $cachegroup);

        if (!$contents) {
            // Show admins the IP address of the user:
            if ($this->category->isAuthorised('admin') || ($this->category->isAuthorised('moderate') && !$this->config->hideIp)) {
                if ($this->message->ip) {
                    if (!empty($this->message->ip)) {
                        $this->ipLink = '<a href="https://dnslytics.com/ip/' . $this->message->ip . '" target="_blank" rel="nofollow noopener noreferrer"> IP: ' . $this->message->ip . '</a>';
                    } else {
                        $this->ipLink = '&nbsp;';
                    }
                } else {
                    $this->ipLink = null;
                }
            }

            $this->signatureHtml = KunenaParser::parseBBCode($this->profile->signature, null, $this->config->maxSig);
            $this->attachments   = $this->message->getAttachments();

            // Link to individual message
            if ($this->config->orderingSystem == 'replyid') {
                $this->numLink = $this->getSamePageAnkerLink($message->id, '#[K=REPLYNO]');
            } else {
                $this->numLink = $this->getSamePageAnkerLink($message->id, '#' . $message->id);
            }

            if ($this->message->hold == 0) {
                $this->class = 'kmsg';
            } elseif ($this->message->hold == 1) {
                $this->class = 'kmsg kunapproved';
            } else {
                if ($this->message->hold == 2 || $this->message->hold == 3) {
                    $this->class = 'kmsg kdeleted';
                }
            }

            // New post suffix for class
            $this->msgsuffix = '';

            if ($this->message->isNew()) {
                $this->msgsuffix = '-new';
            }

            $contents = (string) $this->loadTemplateFile($template);

            if ($usertype == 'guest') {
                $contents = preg_replace_callback('|\[K=(\w+)(?:\:(\w+))?\]|', [$this, 'fillMessageInfo'], $contents);
            }

            // FIXME: enable caching after fixing the issues
            // if ($this->cache) $cache->store($contents, $cachekey, $cachegroup);
        } elseif ($usertype == 'guest') {
            echo $contents;
            $this->setLayout($layout);

            return;
        }

        $contents = preg_replace_callback('|\[K=(\w+)(?:\:(\w+))?\]|', [$this, 'fillMessageInfo'], $contents);
        echo $contents;
        $this->setLayout($layout);
    }

    // Helper functions

    /**
     * @param   integer  $anker  anker
     * @param   string   $name   name
     * @param   string   $rel    rel
     * @param   string   $class  class
     *
     * @return  string
     *
     * @since   Kunena 6.0
     */
    public function getSamePageAnkerLink($anker, $name, $rel = 'nofollow', $class = '')
    {
        return '<a ' . ($class ? 'class="' . $class . '" ' : '') . 'href="#' . $anker . '"' . ($rel ? ' rel="' . $rel . '"' : '') . '>' . $name . '</a>';
    }

    /**
     * @return  void
     *
     * @throws  Exception
     * @since   Kunena 6.0
     */
    public function displayThreadHistory()
    {
        if (!$this->hasThreadHistory()) {
            return;
        }

        $history            = KunenaMessageHelper::getMessagesByTopic($this->topic, 0, (int) $this->config->historyLimit, 'DESC');
        $this->historycount = \count($history);
        $this->replycount   = $this->topic->getReplies();
        KunenaAttachmentHelper::getByMessage($history);
        $userlist = [];

        foreach ($history as $message) {
            $userlist[(int) $message->userid] = (int) $message->userid;
        }

        KunenaUserHelper::loadUsers($userlist);

        // Run events
        $params = new Registry();
        $params->set('ksource', 'kunena');
        $params->set('kunena_view', 'topic');
        $params->set('kunena_layout', 'history');

        PluginHelper::importPlugin('kunena');

        $prepareEvent = new KunenaPrepareEvent('onKunenaPrepare', [
            'context' => 'kunena.messages',
            'subject' => $history,
            'params'  => $params,
            'page'    => 0
        ]);
        $this->app->getDispatcher()->dispatch('onKunenaPrepare', $prepareEvent);

        echo $this->loadTemplateFile('history');
    }

    /**
     * @return  boolean
     *
     * @since   Kunena 6.0
     */
    public function hasThreadHistory()
    {
        if (!$this->config->showHistory || !$this->topic->exists()) {
            return false;
        }

        return true;
    }

    /**
     * @param   integer  $mesid     mesid
     * @param   integer  $replycnt  reply count
     *
     * @return  string
     *
     * @since   Kunena 6.0
     */
    public function getNumLink($mesid, $replycnt)
    {
        if ($this->config->orderingSystem == 'replyid') {
            $this->numLink = $this->getSamePageAnkerLink($mesid, '#' . $replycnt);
        } else {
            $this->numLink = $this->getSamePageAnkerLink($mesid, '#' . $mesid);
        }

        return $this->numLink;
    }

    /**
     * @param   string  $name  name
     *
     * @return  integer|string
     *
     * @throws Exception
     * @since   Kunena 6.0
     */
    public function displayMessageField($name)
    {
        return $this->message->displayField($name);
    }

    /**
     * @param   string  $name  name
     *
     * @return  mixed
     *
     * @since   Kunena 6.0
     */
    public function displayTopicField($name)
    {
        return $this->topic->displayField($name);
    }

    /**
     * @param   string  $name  name
     *
     * @return  integer|string
     *
     * @throws Exception
     * @since   Kunena 6.0
     */
    public function displayCategoryField($name)
    {
        return $this->category->displayField($name);
    }

    /**
     * @return  boolean
     *
     * @since   Kunena 6.0
     */
    public function canSubscribe()
    {
        if (!$this->me->userid || !$this->config->allowSubscriptions || $this->config->topicSubscriptions == 'disabled') {
            return false;
        }

        return !$this->topic->getUserTopic()->subscribed;
    }

    /**
     * Display layout from current layout.
     *
     * By using $this->subLayout() instead of KunenaLayout::factory() you can make your template files both
     * easier to read and gain some context awareness -- for example possibility to use setLayout().
     *
     * @param   string  $path  path
     *
     * @return  KunenaLayout
     *
     * @since   Kunena 4.0
     */
    public function subLayout($path)
    {
        return self::factory($path)
            ->setLayout($this->getLayout())
            ->setOptions($this->getOptions());
    }

    /**
     * Display arbitrary MVC triad from current layout.
     *
     * By using $this->subRequest() instead of KunenaRequest::factory() you can make your template files both
     * easier to read and gain some context awareness.
     *
     * @param   string      $path     path
     * @param   Input|null  $input    input
     * @param   null        $options  options
     *
     * @return  KunenaControllerDisplay
     *
     * @throws Exception
     * @since   Kunena 4.0
     */
    public function subRequest($path, Input $input = null, $options = null)
    {
        return KunenaRequest::factory($path . '/Display', $input, $options)
            ->setLayout($this->getLayout());
    }

    /**
     * @param   null  $tpl  tpl
     *
     * @return  boolean|false
     *
     * @throws  null
     * @throws  Exception
     * @since   Kunena 6.0
     */
    protected function DisplayCreate($tpl = null)
    {
        $this->setLayout('edit');

        // Get saved message
        $saved = $this->app->getUserState('com_kunena.postfields');

        // Get topic icons if allowed
        if ($this->config->topicIcons) {
            $this->topicIcons = $this->ktemplate->getTopicIcons(false, $saved ? $saved['icon_id'] : 0);
        }

        $categories        = KunenaCategoryHelper::getCategories();
        $arrayanynomousbox = [];
        $arraypollcatid    = [];

        foreach ($categories as $category) {
            if (!$category->isSection() && $category->allowAnonymous) {
                $arrayanynomousbox[] = '"' . $category->id . '":' . $category->postAnonymous;
            }

            if (!$category->isSection() && $category->allowPolls) {
                $arraypollcatid[] = '"' . $category->id . '":1';
            }
        }

        $arrayanynomousbox = implode(',', $arrayanynomousbox);
        $arraypollcatid    = implode(',', $arraypollcatid);
        $this->document->getWebAssetManager()->addInlineScript('var arrayanynomousbox={' . $arrayanynomousbox . '}');
        $this->document->getWebAssetManager()->addInlineScript('var pollcategoriesid = {' . $arraypollcatid . '};');

        $catParams = [
            'ordering'    => 'ordering',
            'toplevel'    => 0,
            'sections'    => 0,
            'direction'   => 1,
            'hide_lonely' => 1,
            'action'      => 'topic.create',
        ];

        $this->catid    = $this->state->get('item.catid');
        $this->category = KunenaCategoryHelper::get($this->catid);
        list($this->topic, $this->message) = $this->category->newTopic($saved);

        if (!$this->topic->category_id) {
            $this->app->enqueueMessage(Text::_('COM_KUNENA_POST_NEW_TOPIC_NO_PERMISSIONS'), 'error');

            return false;
        }

        $options  = [];
        $selected = $this->topic->category_id;

        if ($this->config->pickupCategory) {
            $options[] = HTMLHelper::_('select.option', '', Text::_('COM_KUNENA_SELECT_CATEGORY'), 'value', 'text');
            $selected  = '';
        }

        if ($saved) {
            $selected = $saved['catid'];
        }

        $this->selectcatlist = HTMLHelper::_('select.list', 'catid', $this->catid, $options, $catParams, 'class="inputbox required"', 'value', 'text', $selected, 'postcatid');

        $this->_prepareDocument('create');

        $this->action = 'post';

        $this->allowedExtensions = KunenaAttachmentHelper::getExtensions($this->category);

        if ($arraypollcatid) {
            $this->poll = $this->topic->getPoll();
        }

        $this->postAnonymous        = $saved ? $saved['anonymous'] : !empty($this->category->postAnonymous);
        $this->subscriptionsChecked = $saved ? $saved['subscribe'] : $this->config->subscriptionsChecked == 1;
        $this->app->setUserState('com_kunena.postfields', null);

        $this->render('Topic/Edit', $tpl);

        return true;
    }

    /**
     * @param   null  $tpl  tpl
     *
     * @return  boolean|false
     *
     * @throws  null
     * @throws  Exception
     * @since   Kunena 6.0
     */
    protected function DisplayReply($tpl = null)
    {
        $this->setLayout('edit');

        $saved = $this->app->getUserState('com_kunena.postfields');

        $this->catid = $this->state->get('item.catid');
        $mesid       = $this->state->get('item.mesid');

        if (!$mesid) {
            $this->topic = KunenaTopicHelper::get($this->state->get('item.id'));
            $parent      = KunenaMessageHelper::get($this->topic->first_post_id);
        } else {
            $parent      = KunenaMessageHelper::get($mesid);
            $this->topic = $parent->getTopic();
        }

        try {
            $parent->isAuthorised('reply');
        } catch (Exception $e) {
            $this->app->enqueueMessage($e->getMessage(), 'error');

            return false;
        }

        // Run events
        $params = new Registry();
        $params->set('ksource', 'kunena');
        $params->set('kunena_view', 'topic');
        $params->set('kunena_layout', 'reply');

        PluginHelper::importPlugin('kunena');

        $prepareEvent = new KunenaPrepareEvent('onKunenaPrepare', [
            'context' => 'kunena.topic',
            'subject' => $this->topic,
            'params'  => $params,
            'page'    => 0
        ]);
        $this->app->getDispatcher()->dispatch('onKunenaPrepare', $prepareEvent);

        $quote          = (bool) $this->app->getInput()->getBool('quote', false);
        $this->category = $this->topic->getCategory();

        if ($this->config->topicIcons && $this->topic->isAuthorised('edit', null)) {
            $this->topicIcons = $this->ktemplate->getTopicIcons(false, $saved ? $saved['icon_id'] : $this->topic->icon_id);
        }

        list($this->topic, $this->message) = $parent->newReply($saved ? $saved : $quote);
        $this->_prepareDocument('reply');
        $this->action = 'post';

        $this->allowedExtensions = KunenaAttachmentHelper::getExtensions($this->category);

        $this->postAnonymous        = $saved ? $saved['anonymous'] : !empty($this->category->postAnonymous);
        $this->subscriptionsChecked = $saved ? $saved['subscribe'] : $this->config->subscriptionsChecked == 1;
        $this->app->setUserState('com_kunena.postfields', null);

        $this->render('Topic/Edit', $tpl);

        return true;
    }

    /**
     * @param   null  $tpl  tpl
     *
     * @return  boolean|false
     *
     * @throws  null
     * @throws  Exception
     * @since   Kunena 6.0
     */
    protected function displayEdit($tpl = null)
    {
        $this->catid = $this->state->get('item.catid');
        $mesid       = $this->state->get('item.mesid');

        $saved = $this->app->getUserState('com_kunena.postfields');

        $this->message = KunenaMessageHelper::get($mesid);

        try {
            $this->message->isAuthorised('edit');
        } catch (Exception $e) {
            $this->app->enqueueMessage($e->getMessage(), 'error');

            return false;
        }

        $this->topic    = $this->message->getTopic();
        $this->category = $this->topic->getCategory();

        if ($this->config->topicIcons && $this->topic->isAuthorised('edit', null)) {
            $this->topicIcons = $this->ktemplate->getTopicIcons(false, $saved ? $saved['icon_id'] : $this->topic->icon_id);
        }

        // Run events
        $params = new Registry();
        $params->set('ksource', 'kunena');
        $params->set('kunena_view', 'topic');
        $params->set('kunena_layout', 'reply');

        PluginHelper::importPlugin('kunena');

        $prepareEvent = new KunenaPrepareEvent('onKunenaPrepare', [
            'context' => 'kunena.topic',
            'subject' => $this->topic,
            'params'  => $params,
            'page'    => 0
        ]);
        $this->app->getDispatcher()->dispatch('onKunenaPrepare', $prepareEvent);
        $this->_prepareDocument('edit');

        $this->action = 'edit';

        // Get attachments
        $this->attachments = $this->message->getAttachments();

        // Get poll
        if ($this->message->parent == 0 && ((!$this->topic->poll_id && $this->topic->isAuthorised('poll.create', null)) || ($this->topic->poll_id && $this->topic->isAuthorised('poll.edit', null)))) {
            $this->poll = $this->topic->getPoll();
        }

        $this->allowedExtensions = KunenaAttachmentHelper::getExtensions($this->category);

        if ($saved) {
            // Update message contents
            $this->message->edit($saved);
        }

        $this->postAnonymous        = isset($saved['anonymous']) ? $saved['anonymous'] : !empty($this->category->postAnonymous);
        $this->subscriptionsChecked = isset($saved['subscribe']) ? $saved['subscribe'] : $this->config->subscriptionsChecked == 1;
        $this->modified_reason      = isset($saved['modified_reason']) ? $saved['modified_reason'] : '';
        $this->app->setUserState('com_kunena.postfields', null);

        $this->render('Topic/Edit', $tpl);

        return true;
    }

    /**
     * Redirect back to the referrer page.
     *
     * If there's no referrer or it's external, Kunena will return to forum home page.
     * Also redirects back to tasks are prevented.
     *
     * @param   string  $anchor  anchor
     *
     * @return  void
     *
     * @throws  Exception
     * @throws  null
     * @since   Kunena 6.0
     */
    protected function redirectBack($anchor = '')
    {
        $default  = Uri::base() . ($this->app->isClient('site') ? ltrim(KunenaRoute::_('index.php?option=com_kunena'), '/') : '');
        $referrer = $this->app->getInput()->server->getString('HTTP_REFERER');

        $uri = Uri::getInstance($referrer ? $referrer : $default);

        if (Uri::isInternal($uri->toString())) {
            // Parse route.
            $vars = $this->app->getRouter()->parse($uri);
            $uri  = new Uri('index.php');
            $uri->setQuery($vars);

            // Make sure we do not return into a task.
            $uri->delVar('task');
            $uri->delVar(Session::getFormToken());
        } else {
            $uri = Uri::getInstance($default);
        }

        if ($anchor) {
            $uri->setFragment($anchor);
        }

        $this->app->redirect(Route::_($uri->toString()));
    }
}