class.ilRTE.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Agent\AgentDetermination;
use ILIAS\Language\Language;

class ilRTE
{
    protected ilGlobalTemplateInterface $tpl;
    protected ilCtrlInterface $ctrl;
    protected ilObjUser $user;
    protected ilLanguage $lng;
    protected AgentDetermination $browser;
    protected ilIniFile $client_init;
    protected ?int $initialWidth = null;

    protected ?string $root_block_element = null;

    protected array $plugins = [];

    protected array $buttons = [];

    protected array $disabled_buttons = [];

    public function __construct()
    {
        global $DIC;

        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->browser = $DIC->http()->agent();
        $this->client_init = $DIC['ilClientIniFile'];
        $this->user = $DIC['ilUser'];
    }

    public function addPlugin(string $a_plugin_name): void
    {
        $this->plugins[] = $a_plugin_name;
    }

    public function addButton(string $a_button_name): void
    {
        $this->buttons[] = $a_button_name;
    }

    public function removePlugin(string $a_plugin_name): void
    {
        $key = array_search($a_plugin_name, $this->plugins, true);
        if ($key !== false) {
            unset($this->plugins[$key]);
        }
    }

    public function removeAllPlugins(): void
    {
        foreach ($this->plugins as $plugin) {
            $this->removePlugin($plugin);
        }
    }

    public function removeButton(string $a_button_name): void
    {
        $key = array_search($a_button_name, $this->buttons, true);
        if ($key !== false) {
            unset($this->buttons[$key]);
        }
    }

    public function addRTESupport(
        Language $lng,
        ilObjUser $user,
        int $obj_id,
        string $obj_type,
        string $a_module = '',
        bool $allowFormElements = false,
        ?string $cfg_template = null
    ): void {
    }

    public function addUserTextEditor(string $editor_selector): void
    {
    }

    public function addCustomRTESupport(int $obj_id, string $obj_type, array $tags): void
    {
    }

    public static function _getRTEClassname(): string
    {
        global $DIC;
        $editor = (new ilRTESettings($DIC['lng'], $DIC['ilUser']))->getRichTextEditor();
        if (strtolower($editor) === 'tinymce') {
            return ilTinyMCE::class;
        }

        return self::class;
    }

    public static function _cleanupMediaObjectUsage(string $a_text, string $a_usage_type, int $a_usage_id): void
    {
        $mobs = ilObjMediaObject::_getMobsOfObject($a_usage_type, $a_usage_id);
        while (preg_match('/src=".*" data-id="([0-9]+)"/', $a_text, $found)) {
            $a_text = str_replace($found[0], '', $a_text);
            $found_mob_id = (int) $found[1];

            if (!in_array($found_mob_id, $mobs, true) && ilObjMediaObject::_exists($found_mob_id)) {
                // save usage if missing
                ilObjMediaObject::_saveUsage($found_mob_id, $a_usage_type, $a_usage_id);
            } else {
                // if already saved everything ok -> take mob out of mobs array
                unset($mobs[$found_mob_id]);
            }
        }
        // remaining usages are not in text anymore -> delete them
        // and media objects (note: delete method of ilObjMediaObject
        // checks whether object is used in another context; if yes,
        // the object is not deleted!)
        foreach ($mobs as $mob) {
            ilObjMediaObject::_removeUsage($mob, $a_usage_type, $a_usage_id);
            $mob_obj = new ilObjMediaObject($mob);
            $mob_obj->delete();
        }
    }

    public static function replaceLatexSpan(string $text): string
    {
        $start = '<span class="latex">';
        $end = '</span>';
        $start_len = ilStr::strLen($start);
        $end_len = ilStr::strLen($end);

        // current position to start the search for delimiters
        $cpos = 0;

        // find position of start delimiter
        while (is_int($spos = ilStr::strIPos($text, $start, $cpos))) {

            // find position of end delimiter
            $epos = ilStr::strIPos($text, $end, $spos + $start_len);
            if (!is_int($epos)) {
                break;
            }

            // extract the tex code inside the delimiters
            $tex = ilStr::subStr($text, $spos + $start_len, $epos - $spos - $start_len);

            // wrap the tex code in new delimiters
            $replace = '[tex]' . $tex . '[/tex]';

            // replace the span
            $text = ilStr::subStr($text, 0, $spos) . $replace . ilStr::subStr($text, $epos + $end_len);

            // continue search behind the replacement
            $cpos = $spos + ilStr::strLen($replace);

            if ($cpos >= ilStr::strlen($text)) {
                // current position at the end => stop search
                break;
            }
        }

        return $text;
    }

    public static function _replaceMediaObjectImageSrc(
        string $a_text,
        int $a_direction = 0,
        string $nic = ''
    ): string {
        if ($a_text === '') {
            return '';
        }

        if ($nic === '' && defined('IL_INST_ID')) {
            $nic = (string) IL_INST_ID;
        }

        if ($a_direction === 0) {
            $a_text = preg_replace(
                '/src=".*" data-id="([0-9]+)"/',
                'src="il_' . $nic . '_mob_\\1"',
                $a_text
            );
        } else {
            $resulttext = $a_text;
            if (preg_match_all('/src="(il_[0-9]+_mob_([0-9]+))"/', $a_text, $matches)) {
                foreach ($matches[2] as $idx => $mob) {
                    if (ilObject::_lookupType((int) $mob) === 'mob') {
                        $mob_obj = new ilObjMediaObject((int) $mob);
                        $path_to_file = $mob_obj->getStandardSrc();
                        $resulttext = str_replace("src=\"{$matches[1][$idx]}\"", "src=\"{$path_to_file}\" data-id=\"{$matches[2][$idx]}\"", $resulttext);
                    }
                }
            }
            $a_text = $resulttext;
        }

        return $a_text;
    }

    public static function _getMediaObjects(string $a_text, int $a_direction = 0): array
    {
        if ($a_text === '') {
            return [];
        }

        $mediaObjects = [];
        if ($a_direction === 0) {
            $is_matching = preg_match_all('/src=".*" data-id="([0-9]+)"/', $a_text, $matches);
        } else {
            $is_matching = preg_match_all('/src="il_[0-9]+_mob_([0-9]+)"/', $a_text, $matches);
        }

        if ($is_matching) {
            foreach ($matches[1] as $mob) {
                $mob = (int) $mob;

                if (ilObjMediaObject::_exists($mob) && !in_array($mob, $mediaObjects, true)) {
                    $mediaObjects[] = $mob;
                }
            }
        }

        return $mediaObjects;
    }

    public function setRTERootBlockElement(?string $a_root_block_element): self
    {
        $this->root_block_element = $a_root_block_element;
        return $this;
    }

    public function getRTERootBlockElement(): ?string
    {
        return $this->root_block_element;
    }

    public function disableButtons($a_button): self
    {
        if (is_array($a_button)) {
            $this->disabled_buttons = array_unique(array_merge($this->disabled_buttons, $a_button));
        } else {
            $this->disabled_buttons = array_unique(array_merge($this->disabled_buttons, [$a_button]));
        }

        return $this;
    }

    public function getDisabledButtons(bool $as_list = true)
    {
        if (!$as_list) {
            return implode(',', $this->disabled_buttons);
        }

        return $this->disabled_buttons;
    }

    public function getInitialWidth(): ?int
    {
        return $this->initialWidth;
    }

    public function setInitialWidth(?int $initialWidth): void
    {
        $this->initialWidth = $initialWidth;
    }
}