class.ilMailExplorer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Tree\Node\Factory;
use ILIAS\UI\Component\Tree\Node\Node;
use ILIAS\UI\Component\Tree\Tree;
use ILIAS\HTTP\GlobalHttpState;
use ILIAS\Refinery\Factory as Refinery;

class ilMailExplorer extends ilTreeExplorerGUI
{
    private readonly GlobalHttpState $http;
    private readonly Refinery $refinery;
    private int $currentFolderId = 0;
    private readonly int $root_folder_id;
    private int $root_node_id;

    public function __construct(ilMailGUI $parentObject, int $userId)
    {
        global $DIC;

        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $this->tree = new ilTree($userId);
        $this->tree->setTableNames('mail_tree', 'mail_obj_data');

        $this->root_folder_id = (new ilMailbox($userId))->getRooFolder();
        $this->root_node_id = $this->tree->readRootId();

        if ($this->root_folder_id !== $this->root_node_id) {
            $DIC->logger()->mail()->error(
                'Root folder id {root_folder_id} does not match root node id {root_node_id} for user {usr_id}',
                [
                    'root_folder_id' => $this->root_folder_id,
                    'root_node_id' => $this->root_node_id,
                    'usr_id' => $userId,
                ]
            );
        }

        parent::__construct('mail_exp', $parentObject, '', $this->tree);

        $this->initFolder();

        $this->setSkipRootNode(true);
        $this->setAjax(false);
        $this->setOrderField('title,m_type');
    }

    protected function initFolder(): void
    {
        if ($this->http->wrapper()->post()->has('mobj_id')) {
            $folderId = $this->http->wrapper()->post()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        } elseif ($this->http->wrapper()->query()->has('mobj_id')) {
            $folderId = $this->http->wrapper()->query()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        } else {
            $folderId = $this->refinery->byTrying([
                $this->refinery->kindlyTo()->int(),
                $this->refinery->always($this->currentFolderId),
            ])->transform(ilSession::get('mobj_id'));
        }

        $this->currentFolderId = $folderId;
    }

    private function repairRootNode(array $root): array
    {
        if (!isset($root['child']) && $this->root_node_id !== $this->root_folder_id) {
            $root['child'] = $this->root_node_id;
            $root['obj_id'] = $this->root_node_id;
            $root['parent'] = 0;
            $root['depth'] = 1;
            $root['title'] = 'a_root';
            $root['m_type'] = 'root';
            $root['lft'] = 1;
            $root['rgt'] = PHP_INT_MAX;
            $root['user_id'] = $this->tree->getTreeId();
        }

        return $root;
    }

    public function getTreeLabel(): string
    {
        return $this->lng->txt("mail_folders");
    }

    public function getTreeComponent(): Tree
    {
        $f = $this->ui->factory();

        return $f->tree()
                 ->expandable($this->getTreeLabel(), $this)
                 ->withData($this->tree->getChilds($this->root_node_id))
                 ->withHighlightOnNodeClick(false);
    }

    public function build(
        Factory $factory,
        $record,
        $environment = null
    ): Node {
        return parent::build($factory, $record, $environment)
                     ->withHighlighted(
                         $this->currentFolderId === (int) $record['child']
                     );
    }

    protected function getNodeStateToggleCmdClasses($record): array
    {
        return [
            ilMailGUI::class,
        ];
    }

    public function getRootNode(): array
    {
        return $this->repairRootNode(parent::getRootNode());
    }

    public function getNodeContent($a_node): string
    {
        $content = ilLegacyFormElementsUtil::prepareFormOutput($a_node['title']);

        if ((int) $a_node['child'] === (int) $this->getNodeId($this->getRootNode())) {
            $content = $this->lng->txt('mail_folders');
        } elseif ($a_node['depth'] < 3) {
            $content = $this->lng->txt('mail_' . $a_node['title']);
        }

        return $content;
    }

    public function getNodeIconAlt($a_node): string
    {
        return $this->getNodeContent($a_node);
    }

    public function getNodeIcon($a_node): string
    {
        if ((int) $a_node['child'] === (int) $this->getNodeId($this->getRootNode())) {
            $icon = ilUtil::getImagePath('standard/icon_mail.svg');
        } else {
            $iconType = $a_node['m_type'];
            if ($a_node['m_type'] === 'user_folder') {
                $iconType = 'local';
            }

            $icon = ilUtil::getImagePath('standard/icon_' . $iconType . '.svg');
        }

        return $icon;
    }

    public function getNodeHref($a_node): string
    {
        if ((int) $a_node['child'] === (int) $this->getNodeId($this->getRootNode())) {
            $a_node['child'] = 0;
        }

        $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mobj_id', $a_node['child']);
        $href = $this->ctrl->getLinkTargetByClass([ilMailGUI::class, ilMailFolderGUI::class]);
        $this->ctrl->clearParametersByClass(ilMailFolderGUI::class);

        return $href;
    }
}