/**
* Returns RichTextElement as class name if RTE widget should be rendered.
*
* @return string|void New class name or void if this resolver does not change current class name.
*/
public function resolve() {
$table = $this->globalOptions['table'];
$fieldName = $this->globalOptions['fieldName'];
$row = $this->globalOptions['databaseRow'];
$parameterArray = $this->globalOptions['parameterArray'];
$backendUser = $this->getBackendUserAuthentication();
if (
// Whole thing is not read only
empty($this->globalOptions['renderReadonly'])
// This field is not read only
&& !$parameterArray['fieldConf']['config']['readOnly']
// If RTE is generally enabled by user settings and RTE object registry can return something valid
&& $backendUser->isRTE()
) {
$specialConfiguration = BackendUtility::getSpecConfParts($parameterArray['fieldConf']['defaultExtras']);
// $parameters is a key=>value array from "defaultExtras" pipe separated rte_transform string
$parameters = BackendUtility::getSpecConfParametersFromArray($specialConfiguration['rte_transform']['parameters']);
if (
// If "richtext" is within defaultExtras
isset($specialConfiguration['richtext'])
// rte_transform[flag=foo] means RTE should only be rendered if the value of db row field "foo" can be interpreted as TRUE
&& (!$parameters['flag'] || !$row[$parameters['flag']])
) {
// Operates by reference on $row! 'pid' is changed ...
BackendUtility::fixVersioningPid($table, $row);
list($recordPid, $tsConfigPid) = BackendUtility::getTSCpidCached($table, $row['uid'], $row['pid']);
// If the pid-value is not negative (that is, a pid could NOT be fetched)
if ($tsConfigPid >= 0) {
// Fetch page ts config and do some magic with it to find out if RTE is disabled on TS level.
$rteSetup = $backendUser->getTSConfig('RTE', BackendUtility::getPagesTSconfig($recordPid));
$rteTcaTypeValue = BackendUtility::getTCAtypeValue($table, $row);
$rteSetupConfiguration = BackendUtility::RTEsetup($rteSetup['properties'], $table, $fieldName, $rteTcaTypeValue);
if (!$rteSetupConfiguration['disabled']) {
// Finally, we're sure the editor should really be rendered ...
return RichtextElement::class;
}
}
}
}
return NULL;
}
/**
* Performs transformation of content to/from RTE. The keyword $dirRTE determines the direction.
* This function is called in two situations:
* a) Right before content from database is sent to the RTE (see ->drawRTE()) it might need transformation
* b) When content is sent from the RTE and into the database it might need transformation back again (going on in TCEmain class; You can't affect that.)
*
* @param string $dirRTE Keyword: "rte" means direction from db to rte, "db" means direction from Rte to DB
* @param string $value Value to transform.
* @param string $table The table name
* @param string $field The field name
* @param array $row The current row from which field is being rendered
* @param array $specConf "special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
* @param array $thisConfig Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
* @param string $RTErelPath Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
* @param integer $pid PID value of record (true parent page id)
* @return string Transformed content
* @todo Define visibility
*/
public function transformContent($dirRTE, $value, $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $pid)
{
if ($specConf['rte_transform']) {
$p = \TYPO3\CMS\Backend\Utility\BackendUtility::getSpecConfParametersFromArray($specConf['rte_transform']['parameters']);
// There must be a mode set for transformation
if ($p['mode']) {
// Initialize transformation:
$parseHTML = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Html\\RteHtmlParser');
$parseHTML->init($table . ':' . $field, $pid);
$parseHTML->setRelPath($RTErelPath);
// Perform transformation:
$value = $parseHTML->RTE_transform($value, $specConf, $dirRTE, $thisConfig);
}
}
return $value;
}
/**
* Performs transformation of content from database to richtext editor
*
* @param string $value Value to transform.
* @return string Transformed content
*/
protected function transformDatabaseContentToEditor($value)
{
// change <strong> to <b>
$value = preg_replace('/<(\\/?)strong/i', '<$1b', $value);
// change <em> to <i>
$value = preg_replace('/<(\\/?)em([^b>]*>)/i', '<$1i$2', $value);
if ($this->defaultExtras['rte_transform']) {
$parameters = BackendUtility::getSpecConfParametersFromArray($this->defaultExtras['rte_transform']['parameters']);
// There must be a mode set for transformation
if ($parameters['mode']) {
/** @var RteHtmlParser $parseHTML */
$parseHTML = GeneralUtility::makeInstance(RteHtmlParser::class);
$parseHTML->init($this->data['table'] . ':' . $this->data['fieldName'], $this->pidOfVersionedMotherRecord);
$parseHTML->setRelPath('');
$value = $parseHTML->RTE_transform($value, $this->defaultExtras, 'rte', $this->processedRteConfiguration);
}
}
return $value;
}
/**
* Transform value for RTE based on specConf in the direction specified by $direction (rte/db)
* This is the main function called from tcemain and transfer data classes
*
* @param string Input value
* @param array Special configuration for a field; This is coming from the types-configuration of the field in the TCA. In the types-configuration you can setup features for the field rendering and in particular the RTE takes al its major configuration options from there!
* @param string Direction of the transformation. Two keywords are allowed; "db" or "rte". If "db" it means the transformation will clean up content coming from the Rich Text Editor and goes into the database. The other direction, "rte", is of course when content is coming from database and must be transformed to fit the RTE.
* @param array Parsed TypoScript content configuring the RTE, probably coming from Page TSconfig.
* @return string Output value
*/
public function RTE_transform($value, $specConf, $direction = 'rte', $thisConfig = array())
{
// Init:
$this->tsConfig = $thisConfig;
$this->procOptions = (array) $thisConfig['proc.'];
$this->preserveTags = strtoupper(implode(',', GeneralUtility::trimExplode(',', $this->procOptions['preserveTags'])));
// dynamic configuration of blockElementList
if ($this->procOptions['blockElementList']) {
$this->blockElementList = $this->procOptions['blockElementList'];
}
// Get parameters for rte_transformation:
$p = $this->rte_p = BackendUtility::getSpecConfParametersFromArray($specConf['rte_transform']['parameters']);
// Setting modes:
if ((string) $this->procOptions['overruleMode'] !== '') {
$modes = array_unique(GeneralUtility::trimExplode(',', $this->procOptions['overruleMode']));
} else {
$modes = array_unique(GeneralUtility::trimExplode('-', $p['mode']));
}
$revmodes = array_flip($modes);
// Find special modes and extract them:
if (isset($revmodes['ts'])) {
$modes[$revmodes['ts']] = 'ts_transform,ts_preserve,ts_images,ts_links';
}
// Find special modes and extract them:
if (isset($revmodes['ts_css'])) {
$modes[$revmodes['ts_css']] = 'css_transform,ts_images,ts_links';
}
// Make list unique
$modes = array_unique(GeneralUtility::trimExplode(',', implode(',', $modes), true));
// Reverse order if direction is "rte"
if ($direction == 'rte') {
$modes = array_reverse($modes);
}
// Getting additional HTML cleaner configuration. These are applied either before or after the main transformation is done and is thus totally independent processing options you can set up:
$entry_HTMLparser = $this->procOptions['entryHTMLparser_' . $direction] ? $this->HTMLparserConfig($this->procOptions['entryHTMLparser_' . $direction . '.']) : '';
$exit_HTMLparser = $this->procOptions['exitHTMLparser_' . $direction] ? $this->HTMLparserConfig($this->procOptions['exitHTMLparser_' . $direction . '.']) : '';
// Line breaks of content is unified into char-10 only (removing char 13)
if (!$this->procOptions['disableUnifyLineBreaks']) {
$value = str_replace(CRLF, LF, $value);
}
// In an entry-cleaner was configured, pass value through the HTMLcleaner with that:
if (is_array($entry_HTMLparser)) {
$value = $this->HTMLcleaner($value, $entry_HTMLparser[0], $entry_HTMLparser[1], $entry_HTMLparser[2], $entry_HTMLparser[3]);
}
// Traverse modes:
foreach ($modes as $cmd) {
// ->DB
if ($direction == 'db') {
// Checking for user defined transformation:
if ($_classRef = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_parsehtml_proc.php']['transformation'][$cmd]) {
$_procObj = GeneralUtility::getUserObj($_classRef);
$_procObj->pObj = $this;
$_procObj->transformationKey = $cmd;
$value = $_procObj->transform_db($value, $this);
} else {
// ... else use defaults:
switch ($cmd) {
case 'ts_images':
$value = $this->TS_images_db($value);
break;
case 'ts_reglinks':
$value = $this->TS_reglinks($value, 'db');
break;
case 'ts_links':
$value = $this->TS_links_db($value);
break;
case 'ts_preserve':
$value = $this->TS_preserve_db($value);
break;
case 'ts_transform':
case 'css_transform':
$this->allowedClasses = GeneralUtility::trimExplode(',', $this->procOptions['allowedClasses'], true);
// CR has a very disturbing effect, so just remove all CR and rely on LF
$value = str_replace(CR, '', $value);
// Transform empty paragraphs into spacing paragraphs
$value = str_replace('<p></p>', '<p> </p>', $value);
// Double any trailing spacing paragraph so that it does not get removed by divideIntoLines()
$value = preg_replace('/<p> <\\/p>$/', '<p> </p>' . '<p> </p>', $value);
$value = $this->TS_transform_db($value, $cmd == 'css_transform');
break;
case 'ts_strip':
$value = $this->TS_strip_db($value);
break;
default:
// Do nothing
}
}
}
// ->RTE
if ($direction == 'rte') {
// Checking for user defined transformation:
if ($_classRef = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_parsehtml_proc.php']['transformation'][$cmd]) {
$_procObj = GeneralUtility::getUserObj($_classRef);
$_procObj->pObj = $this;
$value = $_procObj->transform_rte($value, $this);
} else {
// ... else use defaults:
switch ($cmd) {
case 'ts_images':
$value = $this->TS_images_rte($value);
break;
case 'ts_reglinks':
$value = $this->TS_reglinks($value, 'rte');
break;
case 'ts_links':
$value = $this->TS_links_rte($value);
break;
case 'ts_preserve':
$value = $this->TS_preserve_rte($value);
break;
case 'ts_transform':
case 'css_transform':
// Has a very disturbing effect, so just remove all '13' - depend on '10'
$value = str_replace(CR, '', $value);
$value = $this->TS_transform_rte($value, $cmd == 'css_transform');
break;
default:
// Do nothing
}
}
}
}
// In an exit-cleaner was configured, pass value through the HTMLcleaner with that:
if (is_array($exit_HTMLparser)) {
$value = $this->HTMLcleaner($value, $exit_HTMLparser[0], $exit_HTMLparser[1], $exit_HTMLparser[2], $exit_HTMLparser[3]);
}
// Final clean up of linebreaks:
if (!$this->procOptions['disableUnifyLineBreaks']) {
// Make sure no \r\n sequences has entered in the meantime...
$value = str_replace(CRLF, LF, $value);
// ... and then change all \n into \r\n
$value = str_replace(LF, CRLF, $value);
}
// Return value:
return $value;
}
/**
* Performs transformation of content from richtext element to database.
*
* @param string $value Value to transform.
* @param string $table The table name
* @param string $field The field name
* @param array $defaultExtras Default extras configuration of this field - typically "richtext:rte_transform[mode=ts_css]"
* @param array $thisConfig Configuration for RTEs; A mix between TSconfig and others. Configuration for additional transformation information
* @param int $pid PID value of record (true parent page id)
* @return string Transformed content
*/
protected function transformRichtextContentToDatabase($value, $table, $field, $defaultExtras, $thisConfig, $pid)
{
if ($defaultExtras['rte_transform']) {
$parameters = BackendUtility::getSpecConfParametersFromArray($defaultExtras['rte_transform']['parameters']);
// There must be a mode set for transformation, this is typically 'ts_css'
if ($parameters['mode']) {
// Initialize transformation:
$parseHTML = GeneralUtility::makeInstance(RteHtmlParser::class);
$parseHTML->init($table . ':' . $field, $pid);
$parseHTML->setRelPath('');
// Perform transformation:
$value = $parseHTML->RTE_transform($value, $defaultExtras, 'db', $thisConfig);
}
}
return $value;
}
/**
* Checking if the RTE is available/enabled for a certain table/field and if so, it returns TRUE.
* Used to determine if the RTE button should be displayed.
*
* @param string $table Table name
* @param array $row Record row (needed, if there are RTE dependencies based on other fields in the record)
* @param string $field Field name
* @return boolean Returns TRUE if the rich text editor would be enabled/available for the field name specified.
* @todo Define visibility
*/
public function isRTEforField($table, $row, $field)
{
$specConf = $this->getSpecConfForField($table, $row, $field);
if (!count($specConf)) {
return FALSE;
}
$p = BackendUtility::getSpecConfParametersFromArray($specConf['rte_transform']['parameters']);
if (isset($specConf['richtext']) && (!$p['flag'] || !$row[$p['flag']])) {
BackendUtility::fixVersioningPid($table, $row);
list($tscPID, $thePidValue) = BackendUtility::getTSCpid($table, $row['uid'], $row['pid']);
// If the pid-value is not negative (that is, a pid could NOT be fetched)
if ($thePidValue >= 0) {
if (!isset($this->rteSetup[$tscPID])) {
$this->rteSetup[$tscPID] = $this->getBackendUser()->getTSConfig('RTE', BackendUtility::getPagesTSconfig($tscPID));
}
$RTEtypeVal = BackendUtility::getTCAtypeValue($table, $row);
$thisConfig = BackendUtility::RTEsetup($this->rteSetup[$tscPID]['properties'], $table, $field, $RTEtypeVal);
if (!$thisConfig['disabled']) {
return TRUE;
}
}
}
return FALSE;
}
/**
* Generation of TCEform elements of the type "text"
* This will render a <textarea> OR RTE area form field, possibly with various control/validation features
*
* @param string $table The table name of the record
* @param string $field The field name which this element is supposed to edit
* @param array $row The record data array where the value(s) for the field can be found
* @param array $PA An array with additional configuration options.
* @return string The HTML code for the TCEform field
* @todo Define visibility
*/
public function getSingleField_typeText($table, $field, $row, &$PA)
{
// Init config:
$config = $PA['fieldConf']['config'];
$evalList = GeneralUtility::trimExplode(',', $config['eval'], TRUE);
if ($this->renderReadonly || $config['readOnly']) {
return $this->getSingleField_typeNone_render($config, $PA['itemFormElValue']);
}
// Setting columns number:
$cols = MathUtility::forceIntegerInRange($config['cols'] ? $config['cols'] : 30, 5, $this->maxTextareaWidth);
// Setting number of rows:
$origRows = $rows = MathUtility::forceIntegerInRange($config['rows'] ? $config['rows'] : 5, 1, 20);
if (strlen($PA['itemFormElValue']) > $this->charsPerRow * 2) {
$cols = $this->maxTextareaWidth;
$rows = MathUtility::forceIntegerInRange(round(strlen($PA['itemFormElValue']) / $this->charsPerRow), count(explode(LF, $PA['itemFormElValue'])), 20);
if ($rows < $origRows) {
$rows = $origRows;
}
}
if (in_array('required', $evalList)) {
$this->requiredFields[$table . '_' . $row['uid'] . '_' . $field] = $PA['itemFormElName'];
}
// Init RTE vars:
// Set TRUE, if the RTE is loaded; If not a normal textarea is shown.
$RTEwasLoaded = 0;
// Set TRUE, if the RTE would have been loaded if it wasn't for the disable-RTE flag in the bottom of the page...
$RTEwouldHaveBeenLoaded = 0;
// "Extra" configuration; Returns configuration for the field based on settings found in the "types" fieldlist. Traditionally, this is where RTE configuration has been found.
$specConf = $this->getSpecConfFromString($PA['extra'], $PA['fieldConf']['defaultExtras']);
// Setting up the altItem form field, which is a hidden field containing the value
$altItem = '<input type="hidden" name="' . htmlspecialchars($PA['itemFormElName']) . '" value="' . htmlspecialchars($PA['itemFormElValue']) . '" />';
$item = '';
// If RTE is generally enabled (TYPO3_CONF_VARS and user settings)
if ($this->RTEenabled) {
$p = BackendUtility::getSpecConfParametersFromArray($specConf['rte_transform']['parameters']);
// If the field is configured for RTE and if any flag-field is not set to disable it.
if (isset($specConf['richtext']) && (!$p['flag'] || !$row[$p['flag']])) {
BackendUtility::fixVersioningPid($table, $row);
list($tscPID, $thePidValue) = $this->getTSCpid($table, $row['uid'], $row['pid']);
// If the pid-value is not negative (that is, a pid could NOT be fetched)
if ($thePidValue >= 0) {
$RTEsetup = $this->getBackendUserAuthentication()->getTSConfig('RTE', BackendUtility::getPagesTSconfig($tscPID));
$RTEtypeVal = BackendUtility::getTCAtypeValue($table, $row);
$thisConfig = BackendUtility::RTEsetup($RTEsetup['properties'], $table, $field, $RTEtypeVal);
if (!$thisConfig['disabled']) {
if (!$this->disableRTE) {
$this->RTEcounter++;
// Find alternative relative path for RTE images/links:
$eFile = RteHtmlParser::evalWriteFile($specConf['static_write'], $row);
$RTErelPath = is_array($eFile) ? dirname($eFile['relEditFile']) : '';
// Get RTE object, draw form and set flag:
$RTEobj = BackendUtility::RTEgetObj();
$item = $RTEobj->drawRTE($this, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue);
// Wizard:
$item = $this->renderWizards(array($item, $altItem), $config['wizards'], $table, $row, $field, $PA, $PA['itemFormElName'], $specConf, 1);
$RTEwasLoaded = 1;
} else {
$RTEwouldHaveBeenLoaded = 1;
$this->commentMessages[] = $PA['itemFormElName'] . ': RTE is disabled by the on-page RTE-flag (probably you can enable it by the check-box in the bottom of this page!)';
}
} else {
$this->commentMessages[] = $PA['itemFormElName'] . ': RTE is disabled by the Page TSconfig, "RTE"-key (eg. by RTE.default.disabled=0 or such)';
}
} else {
$this->commentMessages[] = $PA['itemFormElName'] . ': PID value could NOT be fetched. Rare error, normally with new records.';
}
} else {
if (!isset($specConf['richtext'])) {
$this->commentMessages[] = $PA['itemFormElName'] . ': RTE was not configured for this field in TCA-types';
}
if (!(!$p['flag'] || !$row[$p['flag']])) {
$this->commentMessages[] = $PA['itemFormElName'] . ': Field-flag (' . $PA['flag'] . ') has been set to disable RTE!';
}
}
}
// Display ordinary field if RTE was not loaded.
if (!$RTEwasLoaded) {
// Show message, if no RTE (field can only be edited with RTE!)
if ($specConf['rte_only']) {
$item = '<p><em>' . htmlspecialchars($this->getLL('l_noRTEfound')) . '</em></p>';
} else {
if ($specConf['nowrap']) {
$wrap = 'off';
} else {
$wrap = $config['wrap'] ?: 'virtual';
}
$classes = array();
if ($specConf['fixed-font']) {
$classes[] = 'fixed-font';
}
if ($specConf['enable-tab']) {
$classes[] = 'enable-tab';
}
$formWidthText = $this->formWidthText($cols, $wrap);
// Extract class attributes from $formWidthText (otherwise it would be added twice to the output)
$res = array();
if (preg_match('/ class="(.+?)"/', $formWidthText, $res)) {
$formWidthText = str_replace(' class="' . $res[1] . '"', '', $formWidthText);
$classes = array_merge($classes, explode(' ', $res[1]));
}
if (count($classes)) {
$class = ' class="tceforms-textarea ' . implode(' ', $classes) . '"';
} else {
$class = 'tceforms-textarea';
}
$evalList = GeneralUtility::trimExplode(',', $config['eval'], TRUE);
foreach ($evalList as $func) {
switch ($func) {
case 'required':
$this->registerRequiredProperty('field', $table . '_' . $row['uid'] . '_' . $field, $PA['itemFormElName']);
break;
default:
// Pair hook to the one in \TYPO3\CMS\Core\DataHandling\DataHandler::checkValue_input_Eval()
// and \TYPO3\CMS\Core\DataHandling\DataHandler::checkValue_text_Eval()
$evalObj = GeneralUtility::getUserObj($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tce']['formevals'][$func] . ':&' . $func);
if (is_object($evalObj) && method_exists($evalObj, 'deevaluateFieldValue')) {
$_params = array('value' => $PA['itemFormElValue']);
$PA['itemFormElValue'] = $evalObj->deevaluateFieldValue($_params);
}
}
}
$iOnChange = implode('', $PA['fieldChangeFunc']);
$item .= '
<textarea ' . 'id="' . uniqid('tceforms-textarea-') . '" ' . 'name="' . $PA['itemFormElName'] . '"' . $formWidthText . $class . ' ' . 'rows="' . $rows . '" ' . 'wrap="' . $wrap . '" ' . 'onchange="' . htmlspecialchars($iOnChange) . '"' . $this->getPlaceholderAttribute($table, $field, $config, $row) . $PA['onFocus'] . '>' . GeneralUtility::formatForTextarea($PA['itemFormElValue']) . '</textarea>';
$item = $this->renderWizards(array($item, $altItem), $config['wizards'], $table, $row, $field, $PA, $PA['itemFormElName'], $specConf, $RTEwouldHaveBeenLoaded);
}
}
// Return field HTML:
return $item;
}
/**
* @return [type] ...
* @desc
* @todo Define visibility
*/
public function RTEtsConfigParams()
{
if ($this->is_FE()) {
return '';
} else {
$p = BackendUtility::getSpecConfParametersFromArray($this->specConf['rte_transform']['parameters']);
return $this->elementParts[0] . ':' . $this->elementParts[1] . ':' . $this->elementParts[2] . ':' . $this->thePid . ':' . $this->typeVal . ':' . $this->tscPID . ':' . $p['imgpath'];
}
}
/**
* A list of parameters that is mostly given as GET/POST to other RTE controllers.
*
* @return string
*/
protected function RTEtsConfigParams()
{
$parameters = BackendUtility::getSpecConfParametersFromArray($this->defaultExtras['rte_transform']['parameters']);
$result = array($this->data['tableName'], $this->data['databaseRow']['uid'], $this->data['fieldName'], $this->pidOfVersionedMotherRecord, $this->data['recordTypeValue'], $this->pidOfPageRecord, $parameters['imgpath']);
return implode(':', $result);
}
