class.ilRTE.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilRTE
{
        const ILIAS_IMG_MANAGER_PLUGIN = 'ilias_image_manager_plugin';

        protected $plugins = array();

        protected $buttons = array();

        protected $tpl;

        protected $ctrl;

        protected $user;

        protected $lng;

        protected $browser;

        protected $client_init;

        protected $initialWidth = null;

        protected $root_block_element = null;

        protected $disabled_buttons = array();

        public function __construct($a_version = '')
        {
                global $DIC;

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

        public function addPlugin($a_plugin_name)
        {
                array_push($this->plugins, $a_plugin_name);
        }

        public function addButton($a_button_name)
        {
                array_push($this->buttons, $a_button_name);
        }

        public function removePlugin($a_plugin_name)
        {
                $key = array_search($a_plugin_name, $this->plugins);
                if($key !== FALSE)
                {
                        unset($this->plugins[$key]);
                }
        }

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

        public function removeButton($a_button_name)
        {
                $key = array_search($a_button_name, $this->buttons);
                if($key !== FALSE)
                {
                        unset($this->buttons[$key]);
                }
        }

        public function addRTESupport($obj_id, $obj_type, $a_module = "", $allowFormElements = FALSE, $cfg_template = null, $hide_switch = false)
        {
        }

        public function addUserTextEditor($editor_selector)
        {
        }

        public function addCustomRTESupport($obj_id, $obj_type, array $tags)
        {
        }

        public static function _getRTEClassname()
        {
                require_once 'Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php';
                switch(ilObjAdvancedEditing::_getRichTextEditor())
                {
                        case 'tinymce':
                                return 'ilTinyMCE';
                                break;

                        default:
                                return 'ilRTE';
                                break;
                }
        }

        public static function _cleanupMediaObjectUsage($a_text, $a_usage_type, $a_usage_id)
        {
                require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';

                $mobs = ilObjMediaObject::_getMobsOfObject($a_usage_type, $a_usage_id);
                while(preg_match("/data\/" . CLIENT_ID . "\/mobs\/mm_([0-9]+)/i", $a_text, $found))
                {
                        $a_text = str_replace($found[0], "", $a_text);
                        if(!in_array($found[1], $mobs))
                        {
                                // save usage if missing
                                ilObjMediaObject::_saveUsage($found[1], $a_usage_type, $a_usage_id);
                        }
                        else
                        {
                                // if already saved everything ok -> take mob out of mobs array
                                unset($mobs[$found[1]]);
                        }
                }
                // 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 _replaceMediaObjectImageSrc($a_text, $a_direction = 0, $nic = IL_INST_ID)
        {
                if(!strlen($a_text)) return '';

                switch($a_direction)
                {
                        case 0:
                                $a_text = preg_replace('/src="([^"]*?\/mobs\/mm_([0-9]+)\/.*?)\"/', 'src="il_' . IL_INST_ID . '_mob_\\2"', $a_text);
                                break;

                        default:
                                require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';
                                $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($mob) == "mob")
                                                {
                                                        $mob_obj    = new ilObjMediaObject($mob);
                                                        $replace    = "il_" . $matches[1][$idx] . "_mob_" . $mob;
                                                        require_once('./Services/WebAccessChecker/classes/class.ilWACSignedPath.php');
                                                        $path_to_file = ilWACSignedPath::signFile(ILIAS_HTTP_PATH . "/data/" . CLIENT_ID . "/mobs/mm_" . $mob . "/" . $mob_obj->getTitle());
                                                        $resulttext = str_replace("src=\"$replace\"", "src=\"" . $path_to_file . "\"", $resulttext);
                                                }
                                        }
                                }
                                $a_text = $resulttext;
                                break;
                }

                return $a_text;
        }

        public static function _getMediaObjects($a_text, $a_direction = 0)
        {
                if(!strlen($a_text)) return array();

                require_once 'Services/MediaObjects/classes/class.ilObjMediaObject.php';

                $mediaObjects = array();
                switch($a_direction)
                {
                        case 0:
                                if(preg_match_all('/src="([^"]*?\/mobs\/mm_([0-9]+)\/.*?)\"/', $a_text, $matches))
                                {
                                        foreach($matches[2] as $idx => $mob)
                                        {
                                                if(ilObjMediaObject::_exists($mob) && !in_array($mob, $mediaObjects))
                                                {
                                                        $mediaObjects[] = $mob;
                                                }
                                        }
                                }
                                break;

                        default:
                                if(preg_match_all('/src="il_([0-9]+)_mob_([0-9]+)"/', $a_text, $matches))
                                {
                                        foreach($matches[2] as $idx => $mob)
                                        {
                                                if(ilObjMediaObject::_exists($mob) && !in_array($mob, $mediaObjects))
                                                {
                                                        $mediaObjects[] = $mob;
                                                }
                                        }
                                }
                                break;
                }

                return $mediaObjects;
        }

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

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

        public function disableButtons($a_button)
        {
                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, array($a_button)));
                }

                return $this;
        }

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

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

        public function setInitialWidth($initialWidth)
        {
                $this->initialWidth = $initialWidth;
        }
}