class.ilMailFolderTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\HTTP\GlobalHttpState;

class ilMailFolderTableGUI extends ilTable2GUI
{
    private GlobalHttpState $http;
    protected array $_folderNode = [];
    protected ilMailFolderGUI $_parentObject;
    protected int $_currentFolderId = 0;
    protected int $_number_of_mails = 0;
    protected array $_selectedItems = [];
    protected bool $_isTrashFolder = false;
    protected bool $_isDraftsFolder = false;
    protected bool $_isSentFolder = false;
    protected ilObjUser $user;
    protected array $filter = [];
    protected array $sub_filter = [];
    protected array $visibleOptionalColumns = [];
    protected array $optionalColumns = [];
    protected array $optional_filter = [];
    private Factory $uiFactory;
    private Renderer $uiRenderer;
    private ?array $column_definition = null;

    public function __construct(
        ilMailFolderGUI $a_parent_obj,
        int $a_current_folder_id,
        string $a_parent_cmd,
        bool $isTrashFolder,
        bool $isSentFolder,
        bool $isDraftsFolder,
        Factory $uiFactory = null,
        Renderer $uiRenderer = null
    ) {
        global $DIC;
        $this->user = $DIC->user();
        $this->uiFactory = $uiFactory ?? $DIC->ui()->factory();
        $this->uiRenderer = $uiRenderer ?? $DIC->ui()->renderer();
        $this->http = $DIC->http();

        $this->_currentFolderId = $a_current_folder_id;
        $this->_parentObject = $a_parent_obj;

        $this->_isTrashFolder = $isTrashFolder;
        $this->_isSentFolder = $isSentFolder;
        $this->_isDraftsFolder = $isDraftsFolder;

        $this->setId('mail_folder_tbl_' . $a_current_folder_id);
        $this->setPrefix('mtable');

        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setDefaultOrderField('send_time');
        $this->setDefaultOrderDirection('desc');

        parent::__construct($a_parent_obj, $a_parent_cmd);

        $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
        $this->setFormAction($this->ctrl->getFormAction($this->getParentObject(), 'showFolder'));
        $this->ctrl->clearParameters($this->getParentObject());

        $this->setEnableTitle(true);
        $this->setSelectAllCheckbox('mail_id[]');
        $this->setRowTemplate('tpl.mail_folder_row.html', 'Services/Mail');

        $this->setFilterCommand('applyFilter');
        $this->setResetCommand('resetFilter');
    }

    public function getSelectableColumns(): array
    {
        $optionalColumns = array_filter($this->getColumnDefinition(), static function (array $column): bool {
            return isset($column['optional']) && $column['optional'];
        });

        $columns = [];
        foreach ($optionalColumns as $column) {
            $columns[$column['field']] = $column;
        }

        return $columns;
    }

    protected function isColumnVisible(int $index): bool
    {
        $columnDefinition = $this->getColumnDefinition();
        if (array_key_exists($index, $columnDefinition)) {
            $column = $columnDefinition[$index];
            if (isset($column['optional']) && !$column['optional']) {
                return true;
            }
            if (array_key_exists($column['field'], $this->visibleOptionalColumns)) {
                return true;
            }
        }

        return false;
    }

    final protected function fillRow(array $a_set): void
    {
        foreach ($this->removeInvisibleFields($a_set) as $key => $value) {
            $this->tpl->setVariable(strtoupper($key), $value);
        }
    }

    protected function removeInvisibleFields(array $row): array
    {
        if (!array_key_exists('attachments', $this->visibleOptionalColumns)) {
            unset($row['attachment_indicator']);
        }

        if (!array_key_exists('personal_picture', $this->visibleOptionalColumns)) {
            unset($row['img_sender'], $row['alt_sender']);
        }

        return $row;
    }

    protected function getColumnDefinition(): array
    {
        if ($this->column_definition !== null) {
            return $this->column_definition;
        }

        $i = 0;

        $columns = [];

        $columns[++$i] = [
            'field' => 'chb',
            'txt' => '',
            'default' => true,
            'optional' => false,
            'sortable' => false,
            'is_checkbox' => true,
            'width' => '1%'
        ];

        $columns[++$i] = [
            'field' => 'attachments',
            'txt' => $this->lng->txt('mail_tbl_head_attachments'),
            'default' => false,
            'optional' => true,
            'sortable' => false,
            'width' => '5%'
        ];

        if (!$this->isDraftFolder() && !$this->isSentFolder()) {
            $columns[++$i] = [
                'field' => 'personal_picture',
                'txt' => $this->lng->txt('personal_picture'),
                'default' => true,
                'optional' => true,
                'sortable' => false,
                'width' => '5%'
            ];
        }

        if ($this->isDraftFolder() || $this->isSentFolder()) {
            $columns[++$i] = [
                'field' => 'rcp_to',
                'txt' => $this->lng->txt('recipient'),
                'default' => true,
                'optional' => false,
                'sortable' => true,
                'width' => '35%'
            ];
        } else {
            $columns[++$i] = [
                'field' => 'from',
                'txt' => $this->lng->txt('sender'),
                'default' => true,
                'optional' => false,
                'sortable' => true,
                'width' => '20%'
            ];
        }

        if ($this->shouldUseLuceneSearch()) {
            $columns[++$i] = [
                'field' => 'search_content',
                'txt' => $this->lng->txt('search_content'),
                'default' => true,
                'optional' => false,
                'sortable' => false,
                'width' => '35%'
            ];
        } else {
            $columns[++$i] = [
                'field' => 'm_subject',
                'txt' => $this->lng->txt('subject'),
                'default' => true,
                'optional' => false,
                'sortable' => true,
                'width' => '35%'
            ];
        }

        $columns[++$i] = [
            'field' => 'send_time',
            'txt' => $this->lng->txt('date'),
            'default' => true,
            'optional' => false,
            'sortable' => true,
            'width' => '20%'
        ];

        $columns[++$i] = [
            'field' => 'actions',
            'txt' => $this->lng->txt('actions'),
            'default' => true,
            'optional' => false,
            'sortable' => false,
            'width' => '5%'
        ];

        $this->column_definition = $columns;
        return $this->column_definition;
    }

    final public function prepareHTML(): self
    {
        $columns = $this->getColumnDefinition();
        $this->optionalColumns = $this->getSelectableColumns();
        $this->visibleOptionalColumns = $this->getSelectedColumns();
        foreach ($columns as $index => $column) {
            if ($this->isColumnVisible($index)) {
                $this->addColumn(
                    $column['txt'],
                    isset($column['sortable']) && $column['sortable'] ? $column['field'] : '',
                    $column['width'] ?? '',
                    isset($column['is_checkbox']) && $column['is_checkbox']
                );
            }
        }

        $mtree = new ilTree($this->user->getId());
        $mtree->setTableNames('mail_tree', 'mail_obj_data');
        $this->_folderNode = $mtree->getNodeData($this->_currentFolderId);

        $this->fetchTableData();

        $this->initCommandButtons();
        $this->initMultiCommands($this->_parentObject->mbox->getActions($this->_currentFolderId));

        return $this;
    }

    public function isDraftFolder(): bool
    {
        return $this->_isDraftsFolder;
    }

    public function isSentFolder(): bool
    {
        return $this->_isSentFolder;
    }

    public function isTrashFolder(): bool
    {
        return $this->_isTrashFolder;
    }

    private function initCommandButtons(): self
    {
        if ($this->_folderNode['m_type'] === 'trash' && $this->getNumberOfMails() > 0) {
            $this->addCommandButton('confirmEmptyTrash', $this->lng->txt('mail_empty_trash'));
        }

        return $this;
    }

    private function initMultiCommands(array $actions): self
    {
        foreach ($actions as $key => $action) {
            if ($key === 'moveMails') {
                $folders = $this->_parentObject->mbox->getSubFolders();
                foreach ($folders as $folder) {
                    if ($folder['type'] !== 'trash' || !$this->isTrashFolder()) {
                        if ($folder['type'] !== 'user_folder') {
                            $label = $action . ' ' . $this->lng->txt('mail_' . $folder['title']) .
                                ($folder['type'] === 'trash' ? ' (' . $this->lng->txt('delete') . ')' : '');
                            $this->addMultiCommand($key . '_' . $folder['obj_id'], $label);
                        } else {
                            $this->addMultiCommand(
                                $key . '_' . $folder['obj_id'],
                                $action . ' ' . $folder['title']
                            );
                        }
                    }
                }
            } elseif ($key !== 'deleteMails' || $this->isTrashFolder()) {
                $this->addMultiCommand($key, $action);
            }
        }

        return $this;
    }

    public function setSelectedItems(array $a_selected_items): self
    {
        $this->_selectedItems = $a_selected_items;

        return $this;
    }

    public function getSelectedItems(): array
    {
        return $this->_selectedItems;
    }

    protected function shouldUseLuceneSearch(): bool
    {
        return isset($this->filter['mail_filter']) &&
            is_string($this->filter['mail_filter']) &&
            $this->filter['mail_filter'] !== '' &&
            $this->isLuceneEnabled();
    }

    private function isLuceneEnabled(): bool
    {
        return ilSearchSettings::getInstance()->enabledLucene();
    }

    protected function fetchTableData(): self
    {
        if ($this->_folderNode['m_type'] === 'user_folder') {
            $txt_folder = $this->_folderNode['title'];
            $img_folder = 'icon_user_folder.png';
        } else {
            $txt_folder = $this->lng->txt('mail_' . $this->_folderNode['title']);
            $img_folder = 'icon' . substr($this->_folderNode['title'], 1) . '.png';
        }

        $result = null;

        try {
            if ($this->shouldUseLuceneSearch()) {
                $query_parser = new ilMailLuceneQueryParser($this->filter['mail_filter'] ?? '');
                $query_parser->setFields([
                    'title' => (bool) ($this->filter['mail_filter_subject'] ?? false),
                    'content' => (bool) ($this->filter['mail_filter_body'] ?? false),
                    'mattachment' => (bool) ($this->filter['mail_filter_attach'] ?? false),
                    'msender' => (bool) ($this->filter['mail_filter_sender'] ?? false),
                    'mrcp' => (bool) ($this->filter['mail_filter_recipients'] ?? false)
                ]);
                $query_parser->parse();

                $result = new ilMailSearchResult();
                $searcher = new ilMailLuceneSearcher($query_parser, $result);
                $searcher->search($this->user->getId(), $this->_currentFolderId);

                if (!$result->getIds()) {
                    throw new ilException('mail_search_empty_result');
                }

                ilMailBoxQuery::$filtered_ids = $result->getIds();
                ilMailBoxQuery::$filter = [
                    'mail_filter_only_unread' => $this->filter['mail_filter_only_unread'] ?? false,
                    'mail_filter_only_with_attachments' => $this->filter['mail_filter_only_with_attachments'] ?? false,
                ];
            } else {
                ilMailBoxQuery::$filter = $this->filter;
            }

            if (
                isset(ilMailBoxQuery::$filter['mail_filter_only_unread']) &&
                ($this->isDraftFolder() || $this->isSentFolder())
            ) {
                unset(ilMailBoxQuery::$filter['mail_filter_only_unread']);
            }

            if (isset(ilMailBoxQuery::$filter['mail_filter_only_with_attachments']) && $this->isDraftFolder()) {
                unset(ilMailBoxQuery::$filter['mail_filter_only_with_attachments']);
            }

            $this->determineOffsetAndOrder();

            ilMailBoxQuery::$folderId = $this->_currentFolderId;
            ilMailBoxQuery::$userId = $this->user->getId();
            ilMailBoxQuery::$limit = $this->getLimit();
            ilMailBoxQuery::$offset = $this->getOffset();
            ilMailBoxQuery::$orderDirection = $this->getOrderDirection();
            ilMailBoxQuery::$orderColumn = $this->getOrderField();
            $data = ilMailBoxQuery::_getMailBoxListData();

            if (!count($data['set']) && $this->getOffset() > 0) {
                $this->resetOffset();

                ilMailBoxQuery::$limit = $this->getLimit();
                ilMailBoxQuery::$offset = $this->getOffset();
                $data = ilMailBoxQuery::_getMailBoxListData();
            }
        } catch (Exception $e) {
            if ('mail_search_empty_result' === $e->getMessage()) {
                $data['set'] = [];
                $data['cnt'] = 0;
                $data['cnt_unread'] = 0;
            } else {
                throw $e;
            }
        }

        if (!$this->isDraftFolder() && !$this->isSentFolder()) {
            $user_ids = [];
            foreach ($data['set'] as $mail) {
                if ($mail['sender_id'] && $mail['sender_id'] !== ANONYMOUS_USER_ID) {
                    $user_ids[$mail['sender_id']] = $mail['sender_id'];
                }
            }

            ilMailUserCache::preloadUserObjects($user_ids);
        }


        foreach ($data['set'] as $key => $mail) {
            if (is_array($this->getSelectedItems()) &&
                in_array($mail['mail_id'], $this->getSelectedItems(), false)
            ) {
                $mail['checked'] = ' checked="checked" ';
            }

            $mail['txt_select_mail_with_subject'] = sprintf(
                $this->lng->txt('select_mail_with_subject_x'),
                htmlspecialchars($mail['m_subject'] ?? '')
            );

            if ($this->isDraftFolder() || $this->isSentFolder()) {
                $mail['rcp_to'] = $mail['mail_login'] = ilUtil::htmlencodePlainString(
                    $this->_parentObject->umail->formatNamesForOutput((string) $mail['rcp_to']),
                    false
                );
            } elseif ($mail['sender_id'] === ANONYMOUS_USER_ID) {
                $mail['img_sender'] = ilUtil::getImagePath('HeaderIconAvatar.svg');
                $mail['from'] =
                $mail['mail_login'] =
                $mail['alt_sender'] =
                    htmlspecialchars(ilMail::_getIliasMailerName());
            } else {
                $user = ilMailUserCache::getUserObjectById($mail['sender_id']);

                if ($user) {
                    $mail['img_sender'] = $user->getPersonalPicturePath('xxsmall');
                    $mail['from'] = $mail['mail_login'] = $mail['alt_sender'] = htmlspecialchars(
                        $user->getPublicName()
                    );
                } else {
                    $mail['img_sender'] = '';
                    $mail['from'] = $mail['mail_login'] = trim(($mail['import_name'] ?? '') . ' ('
                        . $this->lng->txt('user_deleted') . ')');
                }
            }

            if ($this->isDraftFolder()) {
                $this->ctrl->setParameterByClass(
                    ilMailFormGUI::class,
                    'mail_id',
                    $mail['mail_id']
                );
                $this->ctrl->setParameterByClass(
                    ilMailFormGUI::class,
                    'mobj_id',
                    $this->_currentFolderId
                );
                $this->ctrl->setParameterByClass(
                    ilMailFormGUI::class,
                    'type',
                    ilMailFormGUI::MAIL_FORM_TYPE_DRAFT
                );
                $link_mark_as_read = $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class);
                $this->ctrl->clearParametersByClass(ilMailFormGUI::class);
            } else {
                $this->ctrl->setParameter($this->getParentObject(), 'mail_id', $mail['mail_id']);
                $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
                $link_mark_as_read = $this->ctrl->getLinkTarget($this->getParentObject(), 'showMail');
                $this->ctrl->clearParameters($this->getParentObject());
            }
            $css_class = $mail['m_status'] === 'read' ? 'mailread' : 'mailunread';

            if ($result instanceof ilMailSearchResult) {
                $search_result = [];
                foreach ($result->getFields($mail['mail_id']) as $content) {
                    if ('title' === $content[0]) {
                        $mail['msr_subject_link_read'] = $link_mark_as_read;
                        $mail['msr_subject_mailclass'] = $css_class;
                        $mail['msr_subject'] = $content[1];
                    } else {
                        $search_result[] = $content[1];
                    }
                }
                $mail['msr_data'] = implode('', array_map(static function ($value): string {
                    return '<p>' . $value . '</p>';
                }, $search_result));

                if (!isset($mail['msr_subject']) || !$mail['msr_subject']) {
                    $mail['msr_subject_link_read'] = $link_mark_as_read;
                    $mail['msr_subject_mailclass'] = $css_class;
                    $mail['msr_subject'] = htmlspecialchars($mail['m_subject'] ?? '');
                }
                $mail['msr_subject_read_unread'] = $mail['m_status'] === 'read' ? $this->lng->txt('mail_is_read') : $this->lng->txt('mail_is_unread');
            } else {
                $mail['mail_link_read'] = $link_mark_as_read;
                $mail['mailclass'] = $css_class;
                if ($mail['m_subject']) {
                    $mail['mail_subject'] = htmlspecialchars($mail['m_subject']);
                } else {
                    $mail['mail_subject'] = $this->lng->txt('mail_no_subject');
                }
                $mail['mail_subject_read_unread'] = $mail['m_status'] === 'read' ? $this->lng->txt('mail_is_read') : $this->lng->txt('mail_is_unread');
            }

            $mail['mail_date'] = ilDatePresentation::formatDate(
                new ilDateTime($mail['send_time'], IL_CAL_DATETIME)
            );

            $mail['attachment_indicator'] = '';
            if (is_array($mail['attachments']) && count($mail['attachments']) > 0) {
                $this->ctrl->setParameter($this->getParentObject(), 'mail_id', (int) $mail['mail_id']);
                if ($this->isDraftFolder()) {
                    $this->ctrl->setParameter($this->getParentObject(), 'type', ilMailFormGUI::MAIL_FORM_TYPE_DRAFT);
                }
                $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
                $mail['attachment_indicator'] = $this->uiRenderer->render(
                    $this->uiFactory->symbol()->glyph()->attachment(
                        $this->ctrl->getLinkTarget($this->getParentObject(), 'deliverAttachments')
                    )
                );
                $this->ctrl->clearParameters($this->getParentObject());
            }

            $mail['actions'] = $this->formatActionsDropDown($mail);

            $data['set'][$key] = $mail;
        }

        $this->setData($data['set']);
        $this->setMaxCount((int) $data['cnt']);
        $this->setNumberOfMails((int) $data['cnt']);

        $this->setTitleData($txt_folder, (int) $data['cnt'], (int) $data['cnt_unread'], $img_folder);

        return $this;
    }

    protected function setTitleData(string $folderLabel, int $mailCount, int $unreadCount, string $imgFolder): self
    {
        $titleTemplate = new ilTemplate(
            'tpl.mail_folder_title.html',
            true,
            true,
            'Services/Mail'
        );
        $titleTemplate->setVariable('TXT_FOLDER', $folderLabel);
        $titleTemplate->setVariable('MAIL_COUNT', $mailCount);
        $titleTemplate->setVariable('TXT_MAIL_S', $this->lng->txt('mail_s'));
        $titleTemplate->setVariable('MAIL_COUNT_UNREAD', $unreadCount);
        $titleTemplate->setVariable('TXT_UNREAD', $this->lng->txt('unread'));

        $this->setTitle($titleTemplate->get(), $imgFolder);

        return $this;
    }

    public function setNumberOfMails(int $a_number_of_mails): self
    {
        $this->_number_of_mails = $a_number_of_mails;

        return $this;
    }

    public function getNumberOfMails(): int
    {
        return $this->_number_of_mails;
    }

    public function initFilter(): void
    {
        $this->filter = [];

        $quickFilter = new ilMailQuickFilterInputGUI($this->lng->txt('mail_filter'), 'mail_filter');
        $quickFilter->setSubmitFormOnEnter(false);
        $this->addFilterItem($quickFilter);
        $quickFilter->readFromSession();
        $this->filter['mail_filter'] = $quickFilter->getValue();

        if ($this->isDraftFolder() || $this->isSentFolder()) {
            $this->sub_filter[] = $subFilterInRecipients = new ilCheckboxInputGUI(
                $this->lng->txt('mail_filter_recipients'),
                'mail_filter_recipients'
            );
            $subFilterInRecipients->setOptionTitle($this->lng->txt('mail_filter_recipients'));
            $subFilterInRecipients->setValue('1');
            $quickFilter->addSubItem($subFilterInRecipients);
            $subFilterInRecipients->setParentTable($this);
            $subFilterInRecipients->readFromSession();
            $this->filter['mail_filter_recipients'] = (int) $subFilterInRecipients->getChecked();
        } else {
            $this->sub_filter[] = $subFilterInSender = new ilCheckboxInputGUI(
                $this->lng->txt('mail_filter_sender'),
                'mail_filter_sender'
            );
            $subFilterInSender->setOptionTitle($this->lng->txt('mail_filter_sender'));
            $subFilterInSender->setValue('1');
            $quickFilter->addSubItem($subFilterInSender);
            $subFilterInSender->setParentTable($this);
            $subFilterInSender->readFromSession();
            $this->filter['mail_filter_sender'] = (int) $subFilterInSender->getChecked();
        }

        $this->sub_filter[] = $subFilterInSubject = new ilCheckboxInputGUI(
            $this->lng->txt('mail_filter_subject'),
            'mail_filter_subject'
        );
        $subFilterInSubject->setOptionTitle($this->lng->txt('mail_filter_subject'));
        $subFilterInSubject->setValue('1');
        $quickFilter->addSubItem($subFilterInSubject);
        $subFilterInSubject->setParentTable($this);
        $subFilterInSubject->readFromSession();
        $this->filter['mail_filter_subject'] = (int) $subFilterInSubject->getChecked();

        $this->sub_filter[] = $subFilterInBody = new ilCheckboxInputGUI(
            $this->lng->txt('mail_filter_body'),
            'mail_filter_body'
        );
        $subFilterInBody->setOptionTitle($this->lng->txt('mail_filter_body'));
        $subFilterInBody->setValue('1');
        $quickFilter->addSubItem($subFilterInBody);
        $subFilterInBody->setParentTable($this);
        $subFilterInBody->readFromSession();
        $this->filter['mail_filter_body'] = (int) $subFilterInBody->getChecked();

        if ($this->isLuceneEnabled()) {
            $this->sub_filter[] = $subFilterInAttachments = new ilCheckboxInputGUI(
                $this->lng->txt('mail_filter_attach'),
                'mail_filter_attach'
            );
            $subFilterInAttachments->setOptionTitle($this->lng->txt('mail_filter_attach'));
            $subFilterInAttachments->setValue('1');
            $quickFilter->addSubItem($subFilterInAttachments);
            $subFilterInAttachments->setParentTable($this);
            $subFilterInAttachments->readFromSession();
            $this->filter['mail_filter_attach'] = (int) $subFilterInAttachments->getChecked();
        }

        if (!$this->isDraftFolder() && !$this->isSentFolder()) {
            $onlyUnread = new ilCheckboxInputGUI(
                $this->lng->txt('mail_filter_only_unread'),
                'mail_filter_only_unread'
            );
            $onlyUnread->setValue('1');
            $this->addFilterItem($onlyUnread);
            $onlyUnread->readFromSession();
            $this->filter['mail_filter_only_unread'] = (int) $onlyUnread->getChecked();

            $onlyUserMails = new ilCheckboxInputGUI(
                $this->lng->txt('mail_filter_only_user_mails'),
                'mail_filter_only_user_mails'
            );
            $onlyUserMails->setValue('1');
            $this->addFilterItem($onlyUserMails);
            $onlyUserMails->readFromSession();
            $this->filter['mail_filter_only_user_mails'] = (int) $onlyUserMails->getChecked();
        }

        if (!$this->isDraftFolder()) {
            $onlyWithAttachments = new ilCheckboxInputGUI(
                $this->lng->txt('mail_filter_only_with_attachments'),
                'mail_filter_only_with_attachments'
            );
            $onlyWithAttachments->setValue('1');
            $this->addFilterItem($onlyWithAttachments);
            $onlyWithAttachments->readFromSession();
            $this->filter['mail_filter_only_with_attachments'] = (int) $onlyWithAttachments->getChecked();
        }

        $duration = new ilDateDurationInputGUI($this->lng->txt('mail_filter_period'), 'period');
        $duration->setAllowOpenIntervals(true);
        $duration->setStartText($this->lng->txt('mail_filter_period_from'));
        $duration->setEndText($this->lng->txt('mail_filter_period_until'));
        $duration->setStart(new ilDateTime(null, IL_CAL_UNIX));
        $duration->setEnd(new ilDateTime(null, IL_CAL_UNIX));
        $duration->setShowTime(false);
        $this->addFilterItem($duration);
        $duration->readFromSession();
        $this->filter['period'] = $duration->getValue();
    }

    public function writeFilterToSession(): void
    {
        parent::writeFilterToSession();

        foreach ($this->sub_filter as $item) {
            if ($item->checkInput()) {
                $item->setValueByArray($this->http->request()->getParsedBody());
                $item->writeToSession();
            }
        }
    }

    public function resetFilter(): void
    {
        parent::resetFilter();

        foreach ($this->sub_filter as $item) {
            if ($item->checkInput()) {
                $item->setValueByArray($this->http->request()->getParsedBody());
                $item->clearFromSession();
            }
        }
    }

    protected function formatActionsDropDown(array $mail): string
    {
        $buttons = [];

        $this->addViewRowAction($mail, $buttons);
        $this->addReplyRowAction($mail, $buttons);
        $this->addForwardRowAction($mail, $buttons);
        $this->addPrintRowAction($mail, $buttons);

        $dropDown = $this->uiFactory
            ->dropdown()
            ->standard($buttons)
            ->withLabel($this->lng->txt('actions'));

        return $this->uiRenderer->render([$dropDown]);
    }

    protected function addViewRowAction(array $mail, array &$buttons): void
    {
        if ($this->isDraftFolder()) {
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'mail_id',
                (int) $mail['mail_id']
            );
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'mobj_id',
                $this->_currentFolderId
            );
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'type',
                ilMailFormGUI::MAIL_FORM_TYPE_DRAFT
            );
            $viewButton = $this->uiFactory
                ->link()
                ->standard(
                    $this->lng->txt('view'),
                    $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class)
                );
            $this->ctrl->clearParametersByClass(ilMailFormGUI::class);
        } else {
            $this->ctrl->setParameter($this->getParentObject(), 'mail_id', (int) $mail['mail_id']);
            $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
            $viewButton = $this->uiFactory
                ->link()
                ->standard(
                    $this->lng->txt('view'),
                    $this->ctrl->getLinkTarget($this->getParentObject(), 'showMail')
                );
            $this->ctrl->clearParameters($this->getParentObject());
        }

        $buttons[] = $viewButton;
    }

    protected function addReplyRowAction(array $mail, array &$buttons): void
    {
        if (
            isset($mail['sender_id']) && $mail['sender_id'] > 0 && $mail['sender_id'] !== ANONYMOUS_USER_ID &&
            !$this->isDraftFolder()
        ) {
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'mobj_id',
                $this->_currentFolderId
            );
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'mail_id',
                (int) $mail['mail_id']
            );
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'type',
                ilMailFormGUI::MAIL_FORM_TYPE_REPLY
            );
            $replyButton = $this->uiFactory
                ->link()
                ->standard(
                    $this->lng->txt('reply'),
                    $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class)
                );
            $this->ctrl->clearParametersByClass(ilMailFormGUI::class);

            $buttons[] = $replyButton;
        }
    }

    protected function addForwardRowAction(array $mail, array &$buttons): void
    {
        if (!$this->isDraftFolder()) {
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'mobj_id',
                $this->_currentFolderId
            );
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'mail_id',
                (int) $mail['mail_id']
            );
            $this->ctrl->setParameterByClass(
                ilMailFormGUI::class,
                'type',
                ilMailFormGUI::MAIL_FORM_TYPE_FORWARD
            );
            $forwardButton = $this->uiFactory
                ->link()
                ->standard(
                    $this->lng->txt('forward'),
                    $this->ctrl->getLinkTargetByClass(ilMailFormGUI::class)
                );
            $this->ctrl->clearParametersByClass(ilMailFormGUI::class);

            $buttons[] = $forwardButton;
        }
    }

    protected function addPrintRowAction(array $mail, array &$buttons): void
    {
        if (!$this->isDraftFolder()) {
            $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
            $this->ctrl->setParameter($this->getParentObject(), 'mail_id', (int) $mail['mail_id']);
            $printButton = $this->uiFactory
                ->link()
                ->standard(
                    $this->lng->txt('print'),
                    $this->ctrl->getLinkTarget($this->getParentObject(), 'printMail')
                )->withOpenInNewViewport(true);
            $this->ctrl->clearParameters($this->getParentObject());

            $buttons[] = $printButton;
        }
    }

    public function getHTML(): string
    {
        $this->ctrl->setParameter($this->getParentObject(), 'mobj_id', $this->_currentFolderId);
        $html = parent::getHTML();
        $this->ctrl->clearParameters($this->getParentObject());

        return $html;
    }
}