T3editor.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\T3editor;

class T3editor implements \TYPO3\CMS\Core\SingletonInterface {

    const MODE_TYPOSCRIPT = 'typoscript';
    const MODE_JAVASCRIPT = 'javascript';
    const MODE_CSS = 'css';
    const MODE_XML = 'xml';
    const MODE_HTML = 'html';
    const MODE_PHP = 'php';
    const MODE_SPARQL = 'sparql';
    const MODE_MIXED = 'mixed';
    protected $mode = '';

    protected $ajaxSaveType = '';

    protected $editorCounter = 0;

    protected $_isEnabled = TRUE;

    public function setMode($mode) {
        $this->mode = $mode;
        return $this;
    }

    public function setAjaxSaveType($ajaxSaveType) {
        $this->ajaxSaveType = $ajaxSaveType;
        return $this;
    }

    public function setModeByFile($file) {
        $fileInfo = \TYPO3\CMS\Core\Utility\GeneralUtility::split_fileref($file);
        return $this->setModeByType($fileInfo['fileext']);
    }

    public function setModeByType($type) {
        switch ($type) {
            case 'html':

            case 'htm':

            case 'tmpl':
                $mode = self::MODE_HTML;
                break;
            case 'js':
                $mode = self::MODE_JAVASCRIPT;
                break;
            case 'xml':

            case 'svg':
                $mode = self::MODE_XML;
                break;
            case 'css':
                $mode = self::MODE_CSS;
                break;
            case 'ts':
                $mode = self::MODE_TYPOSCRIPT;
                break;
            case 'sparql':
                $mode = self::MODE_SPARQL;
                break;
            case 'php':

            case 'phpsh':

            case 'inc':
                $mode = self::MODE_PHP;
                break;
            default:
                $mode = self::MODE_MIXED;
        }
        $this->setMode($mode);
    }

    public function getMode() {
        return $this->mode;
    }

    public function isEnabled() {
        return $this->_isEnabled;
    }

    public function __construct() {
        $GLOBALS['LANG']->includeLLFile('EXT:t3editor/locallang.xlf');
        // Disable pmktextarea to avoid conflicts (thanks Peter Klein for this suggestion)
        $GLOBALS['BE_USER']->uc['disablePMKTextarea'] = 1;
    }

    public function getJavascriptCode($doc) {
        $content = '';
        if ($this->isEnabled()) {
            $path_t3e = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath('t3editor');
            $path_codemirror = 'contrib/codemirror/js/';
            // Include needed javascript-frameworks
            $pageRenderer = $doc->getPageRenderer();
            $pageRenderer->loadPrototype();
            $pageRenderer->loadScriptaculous();
            // Include editor-css
            $content .= '<link href="' . \TYPO3\CMS\Core\Utility\GeneralUtility::createVersionNumberedFilename(($GLOBALS['BACK_PATH'] . \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath('t3editor') . 'res/css/t3editor.css')) . '" type="text/css" rel="stylesheet" />';
            // Include editor-js-lib
            $doc->loadJavascriptLib($path_codemirror . 'codemirror.js');
            $doc->loadJavascriptLib($path_t3e . 'res/jslib/t3editor.js');

            $content .= \TYPO3\CMS\Core\Utility\GeneralUtility::wrapJS(
                'T3editor = T3editor || {};' .
                'T3editor.lang = ' . json_encode($this->getJavaScriptLabels()) . ';' . LF .
                'T3editor.PATH_t3e = "' . $GLOBALS['BACK_PATH'] . $path_t3e . '"; ' . LF .
                'T3editor.PATH_codemirror = "' . $GLOBALS['BACK_PATH'] . $path_codemirror . '"; ' . LF .
                'T3editor.URL_typo3 = "' . htmlspecialchars(\TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_SITE_URL') . TYPO3_mainDir) . '"; ' . LF .
                'T3editor.template = ' . $this->getPreparedTemplate() . ';' . LF .
                'T3editor.ajaxSavetype = "' . $this->ajaxSaveType . '";' . LF
            );
            $content .= $this->getModeSpecificJavascriptCode();
        }
        return $content;
    }

    public function getModeSpecificJavascriptCode() {
        if (empty($this->mode)) {
            return '';
        }
        $path_t3e = $GLOBALS['BACK_PATH'] . \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath('t3editor');
        $content = '';
        if ($this->mode === self::MODE_TYPOSCRIPT) {
            $content .= '<script type="text/javascript" src="' . $path_t3e . 'res/jslib/ts_codecompletion/tsref.js' . '"></script>';
            $content .= '<script type="text/javascript" src="' . $path_t3e . 'res/jslib/ts_codecompletion/completionresult.js' . '"></script>';
            $content .= '<script type="text/javascript" src="' . $path_t3e . 'res/jslib/ts_codecompletion/tsparser.js' . '"></script>';
            $content .= '<script type="text/javascript" src="' . $path_t3e . 'res/jslib/ts_codecompletion/tscodecompletion.js' . '"></script>';
        }
        $content .= \TYPO3\CMS\Core\Utility\GeneralUtility::wrapJS('T3editor.parserfile = ' . $this->getParserfileByMode($this->mode) . ';' . LF . 'T3editor.stylesheet = ' . $this->getStylesheetByMode($this->mode) . ';');
        return $content;
    }

    protected function getPreparedTemplate() {
        $T3editor_template = \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl(\TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName('EXT:t3editor/res/templates/t3editor.html'));
        $T3editor_template = addslashes($T3editor_template);
        $T3editor_template = str_replace(array(CR, LF), array('', '\' + \''), $T3editor_template);
        return '\'' . $T3editor_template . '\'';
    }

    protected function getParserfileByMode($mode) {
        switch ($mode) {
            case self::MODE_TYPOSCRIPT:
                $relPath = ($GLOBALS['BACK_PATH'] ? $GLOBALS['BACK_PATH'] : '../../../') . \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extRelPath('t3editor') . 'res/jslib/parse_typoscript/';
                $parserfile = '["' . $relPath . 'tokenizetyposcript.js", "' . $relPath . 'parsetyposcript.js"]';
                break;
            case self::MODE_JAVASCRIPT:
                $parserfile = '["tokenizejavascript.js", "parsejavascript.js"]';
                break;
            case self::MODE_CSS:
                $parserfile = '"parsecss.js"';
                break;
            case self::MODE_XML:
                $parserfile = '"parsexml.js"';
                break;
            case self::MODE_SPARQL:
                $parserfile = '"parsesparql.js"';
                break;
            case self::MODE_HTML:
                $parserfile = '["tokenizejavascript.js", "parsejavascript.js", "parsecss.js", "parsexml.js", "parsehtmlmixed.js"]';
                break;
            case self::MODE_PHP:

            case self::MODE_MIXED:
                $parserfile = '[' . '"tokenizejavascript.js", ' . '"parsejavascript.js", ' . '"parsecss.js", ' . '"parsexml.js", ' . '"../contrib/php/js/tokenizephp.js", ' . '"../contrib/php/js/parsephp.js", ' . '"../contrib/php/js/parsephphtmlmixed.js"' . ']';
                break;
        }
        return $parserfile;
    }

    protected function getStylesheetByMode($mode) {
        switch ($mode) {
            case self::MODE_TYPOSCRIPT:
                $stylesheet = 'T3editor.PATH_t3e + "res/css/typoscriptcolors.css"';
                break;
            case self::MODE_JAVASCRIPT:
                $stylesheet = 'T3editor.PATH_codemirror + "../css/jscolors.css"';
                break;
            case self::MODE_CSS:
                $stylesheet = 'T3editor.PATH_codemirror + "../css/csscolors.css"';
                break;
            case self::MODE_XML:
                $stylesheet = 'T3editor.PATH_codemirror + "../css/xmlcolors.css"';
                break;
            case self::MODE_HTML:
                $stylesheet = 'T3editor.PATH_codemirror + "../css/xmlcolors.css", ' . 'T3editor.PATH_codemirror + "../css/jscolors.css", ' . 'T3editor.PATH_codemirror + "../css/csscolors.css"';
                break;
            case self::MODE_SPARQL:
                $stylesheet = 'T3editor.PATH_codemirror + "../css/sparqlcolors.css"';
                break;
            case self::MODE_PHP:
                $stylesheet = 'T3editor.PATH_codemirror + "../contrib/php/css/phpcolors.css"';
                break;
            case self::MODE_MIXED:
                $stylesheet = 'T3editor.PATH_codemirror + "../css/xmlcolors.css", ' . 'T3editor.PATH_codemirror + "../css/jscolors.css", ' . 'T3editor.PATH_codemirror + "../css/csscolors.css", ' . 'T3editor.PATH_codemirror + "../contrib/php/css/phpcolors.css"';
                break;
        }
        if ($stylesheet != '') {
            $stylesheet = '' . $stylesheet . ', ';
        }
        return '[' . $stylesheet . 'T3editor.PATH_t3e + "res/css/t3editor_inner.css"]';
    }

    protected function getJavaScriptLabels() {
        $coreLabels = array();
        $extensionLabels = $this->getJavaScriptLabelsFromLocallang('js.', 'label_');
        return array_merge($coreLabels, $extensionLabels);
    }

    protected function getJavaScriptLabelsFromLocallang($selectionPrefix = 'js.', $stripFromSelectionName = '') {
        $extraction = array();
        $labels = array_merge((array) $GLOBALS['LOCAL_LANG']['default'], (array) $GLOBALS['LOCAL_LANG'][$GLOBALS['LANG']->lang]);
        // Regular expression to strip the selection prefix and possibly something from the label name:
        $labelPattern = '#^' . preg_quote($selectionPrefix, '#') . '(' . preg_quote($stripFromSelectionName, '#') . ')?#';
        // Iterate throuh all locallang lables:
        foreach ($labels as $label => $value) {
            if (strpos($label, $selectionPrefix) === 0) {
                $key = preg_replace($labelPattern, '', $label);
                $extraction[$key] = $value;
            }
        }
        return $extraction;
    }

    public function getCodeEditor($name, $class = '', $content = '', $additionalParams = '', $alt = '', array $hiddenfields = array()) {
        $code = '';
        if ($this->isEnabled()) {
            $this->editorCounter++;
            $class .= ' t3editor';
            $alt = htmlspecialchars($alt);
            if (!empty($alt)) {
                $alt = ' alt="' . $alt . '"';
            }
            $code .= '<div>' . '<textarea id="t3editor_' . $this->editorCounter . '" ' . 'name="' . $name . '" ' . 'class="' . $class . '" ' . $additionalParams . ' ' . $alt . '>' . htmlspecialchars($content) . '</textarea></div>';
            $checked = $GLOBALS['BE_USER']->uc['disableT3Editor'] ? 'checked="checked"' : '';
            $code .= '<br /><br />' . '<input type="checkbox" ' . 'class="checkbox t3editor_disableEditor" ' . 'onclick="T3editor.toggleEditor(this);" ' . 'name="t3editor_disableEditor" ' . 'value="true" ' . 'id="t3editor_disableEditor_' . $this->editorCounter . '_checkbox" ' . $checked . ' />&nbsp;' . '<label for="t3editor_disableEditor_' . $this->editorCounter . '_checkbox">' . $GLOBALS['LANG']->getLL('deactivate') . '</label>' . '<br /><br />';
            if (count($hiddenfields)) {
                foreach ($hiddenfields as $name => $value) {
                    $code .= '<input type="hidden" ' . 'name="' . $name . '" ' . 'value="' . $value . '" />';
                }
            }
        } else {
            // Fallback
            if (!empty($class)) {
                $class = 'class="' . $class . '" ';
            }
            $code .= '<textarea name="' . $name . '" ' . $class . $additionalParams . '>' . $content . '</textarea>';
        }
        return $code;
    }

    public function ajaxSaveCode($params, $ajaxObj) {
        // cancel if its not an Ajax request
        if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) {
            $ajaxObj->setContentFormat('json');
            $codeType = \TYPO3\CMS\Core\Utility\GeneralUtility::_GP('t3editor_savetype');
            $savingsuccess = FALSE;
            try {
                if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/t3editor/classes/class.tx_t3editor.php']['ajaxSaveCode'])) {
                    $_params = array(
                        'pObj' => &$this,
                        'type' => $codeType,
                        'ajaxObj' => &$ajaxObj
                    );
                    foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['ext/t3editor/classes/class.tx_t3editor.php']['ajaxSaveCode'] as $key => $_funcRef) {
                        $savingsuccess = \TYPO3\CMS\Core\Utility\GeneralUtility::callUserFunction($_funcRef, $_params, $this) || $savingsuccess;
                    }
                }
            } catch (\Exception $e) {
                $ajaxObj->setContent(array('result' => FALSE, 'exceptionMessage' => htmlspecialchars($e->getMessage()), 'exceptionCode' => $e->getCode()));
                return;
            }
            $ajaxObj->setContent(array('result' => $savingsuccess));
        }
    }

    public function getPlugins($params, \TYPO3\CMS\Core\Http\AjaxRequestHandler &$ajaxObj) {
        $result = array();
        $plugins = &$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['t3editor']['plugins'];
        if (is_array($plugins)) {
            $result = array_values($plugins);
        }
        $ajaxObj->setContent($result);
        $ajaxObj->setContentFormat('jsonbody');
    }

}