232e7af3cfbee45139de85e5bc143da7f127855b
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Classes / Form / Element / RichTextElement.php
1 <?php
2 namespace TYPO3\CMS\Rtehtmlarea\Form\Element;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Backend\Form\Element\AbstractFormElement;
18 use TYPO3\CMS\Backend\Form\InlineStackProcessor;
19 use TYPO3\CMS\Backend\Utility\BackendUtility;
20 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
21 use TYPO3\CMS\Core\Database\ConnectionPool;
22 use TYPO3\CMS\Core\FrontendEditing\FrontendEditingController;
23 use TYPO3\CMS\Core\Html\RteHtmlParser;
24 use TYPO3\CMS\Core\Localization\Locales;
25 use TYPO3\CMS\Core\Localization\LocalizationFactory;
26 use TYPO3\CMS\Core\Utility\ArrayUtility;
27 use TYPO3\CMS\Core\Utility\ClientUtility;
28 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
29 use TYPO3\CMS\Core\Utility\GeneralUtility;
30 use TYPO3\CMS\Lang\LanguageService;
31 use TYPO3\CMS\Rtehtmlarea\RteHtmlAreaApi;
32
33 /**
34 * Render rich text editor in FormEngine
35 */
36 class RichTextElement extends AbstractFormElement
37 {
38 /**
39 * Main result array as defined in initializeResultArray() of AbstractNode
40 *
41 * @var array
42 */
43 protected $resultArray;
44
45 /**
46 * pid of page record the TSconfig is located at.
47 * This is pid of record if table is not pages, or uid if table is pages
48 *
49 * @var int
50 */
51 protected $pidOfPageRecord;
52
53 /**
54 * pid of fixed versioned record.
55 * This is the pid of the record in normal cases, but is changed to the pid
56 * of the "mother" record in case the handled record is a versioned overlay
57 * and "mother" is located at a different pid.
58 *
59 * @var int
60 */
61 protected $pidOfVersionedMotherRecord;
62
63 /**
64 * Native, not further processed TsConfig of RTE section for this record on given pid.
65 *
66 * Example:
67 *
68 * RTE = foo
69 * RTE.bar = xy
70 *
71 * array(
72 * 'value' => 'foo',
73 * 'properties' => array(
74 * 'bar' => 'xy',
75 * ),
76 * );
77 *
78 * @var array
79 */
80 protected $vanillaRteTsConfig;
81
82 /**
83 * Based on $vanillaRteTsConfig, this property contains "processed" configuration
84 * where table and type specific RTE setup is merged into 'default.' array.
85 *
86 * @var array
87 */
88 protected $processedRteConfiguration;
89
90 /**
91 * An unique identifier based on field name to have id attributes in HTML referenced in javascript.
92 *
93 * @var string
94 */
95 protected $domIdentifier;
96
97 /**
98 * Parsed "defaultExtras" TCA
99 *
100 * @var array
101 */
102 protected $defaultExtras;
103
104 /**
105 * Some client info containing "user agent", "browser", "version", "system"
106 *
107 * @var array
108 */
109 protected $client;
110
111 /**
112 * Selected language
113 *
114 * @var string
115 */
116 protected $language;
117
118 /**
119 * TYPO3 language code of the content language
120 *
121 * @var string
122 */
123 protected $contentTypo3Language;
124
125 /**
126 * ISO language code of the content language
127 *
128 * @var string
129 */
130 protected $contentISOLanguage;
131
132 /**
133 * Uid of chosen content language
134 *
135 * @var int
136 */
137 protected $contentLanguageUid;
138
139 /**
140 * The order of the toolbar: the name is the TYPO3-button name
141 *
142 * @var string
143 */
144 protected $defaultToolbarOrder;
145
146 /**
147 * Conversion array: TYPO3 button names to htmlArea button names
148 *
149 * @var array
150 */
151 protected $convertToolbarForHtmlAreaArray = [
152 'space' => 'space',
153 'bar' => 'separator',
154 'linebreak' => 'linebreak'
155 ];
156
157 /**
158 * Final toolbar array
159 *
160 * @var array
161 */
162 protected $toolbar = [];
163
164 /**
165 * Save the buttons for the toolbar
166 *
167 * @var array
168 */
169 protected $toolbarOrderArray = [];
170
171 /**
172 * Plugin buttons
173 *
174 * @var array
175 */
176 protected $pluginButton = [];
177
178 /**
179 * Plugin labels
180 *
181 * @var array
182 */
183 protected $pluginLabel = [];
184
185 /**
186 * Array of plugin id's enabled in the current RTE editing area
187 *
188 * @var array
189 */
190 protected $pluginEnabledArray = [];
191
192 /**
193 * Cumulative array of plugin id's enabled so far in any of the RTE editing areas of the form
194 *
195 * @var array
196 */
197 protected $pluginEnabledCumulativeArray = [];
198
199 /**
200 * Array of registered plugins indexed by their plugin Id's
201 *
202 * @var array
203 */
204 protected $registeredPlugins = [];
205
206 /**
207 * This will render a <textarea> OR RTE area form field,
208 * possibly with various control/validation features
209 *
210 * @return array As defined in initializeResultArray() of AbstractNode
211 */
212 public function render()
213 {
214 $table = $this->data['tableName'];
215 $fieldName = $this->data['fieldName'];
216 $row = $this->data['databaseRow'];
217 $parameterArray = $this->data['parameterArray'];
218
219 $backendUser = $this->getBackendUserAuthentication();
220
221 $this->resultArray = $this->initializeResultArray();
222 $this->defaultExtras = BackendUtility::getSpecConfParts($parameterArray['fieldConf']['defaultExtras']);
223 $this->pidOfPageRecord = $this->data['effectivePid'];
224 BackendUtility::fixVersioningPid($table, $row);
225 $this->pidOfVersionedMotherRecord = (int)$row['pid'];
226 $this->vanillaRteTsConfig = $backendUser->getTSConfig('RTE', BackendUtility::getPagesTSconfig($this->pidOfPageRecord));
227 $this->processedRteConfiguration = BackendUtility::RTEsetup(
228 $this->vanillaRteTsConfig['properties'],
229 $table,
230 $fieldName,
231 $this->data['recordTypeValue']
232 );
233 $this->client = $this->clientInfo();
234 $this->domIdentifier = preg_replace('/[^a-zA-Z0-9_:.-]/', '_', $parameterArray['itemFormElName']);
235 $this->domIdentifier = htmlspecialchars(preg_replace('/^[^a-zA-Z]/', 'x', $this->domIdentifier));
236
237 $this->initializeLanguageRelatedProperties();
238
239 // Get skin file name from Page TSConfig if any
240 $skinFilename = trim($this->processedRteConfiguration['skin']) ?: 'EXT:rtehtmlarea/Resources/Public/Css/Skin/htmlarea.css';
241 $skinFilename = $this->getFullFileName($skinFilename);
242 $skinDirectory = dirname($skinFilename);
243
244 // jQuery UI Resizable style sheet and main skin stylesheet
245 $this->resultArray['stylesheetFiles'][] = $skinDirectory . '/jquery-ui-resizable.css';
246 $this->resultArray['stylesheetFiles'][] = $skinFilename;
247
248 $this->enableRegisteredPlugins();
249
250 // Configure toolbar
251 $this->setToolbar();
252
253 // Check if some plugins need to be disabled
254 $this->setPlugins();
255
256 // Merge the list of enabled plugins with the lists from the previous RTE editing areas on the same form
257 $this->pluginEnabledCumulativeArray = $this->pluginEnabledArray;
258
259 $this->addInstanceJavaScriptRegistration();
260
261 $this->addOnSubmitJavaScriptCode();
262
263 // Add RTE JavaScript
264 $this->loadRequireModulesForRTE();
265
266 // Create language labels
267 $this->createJavaScriptLanguageLabelsFromFiles();
268
269 // Get RTE init JS code
270 $this->resultArray['additionalJavaScriptPost'][] = $this->getRteInitJsCode();
271
272 $html = $this->getMainHtml();
273
274 $this->resultArray['html'] = $this->renderWizards(
275 [$html],
276 $parameterArray['fieldConf']['config']['wizards'],
277 $table,
278 $row,
279 $fieldName,
280 $parameterArray,
281 $parameterArray['itemFormElName'],
282 $this->defaultExtras,
283 true
284 );
285
286 return $this->resultArray;
287 }
288
289 /**
290 * Create main HTML elements
291 *
292 * @return string Main RTE html
293 */
294 protected function getMainHtml()
295 {
296 $backendUser = $this->getBackendUserAuthentication();
297
298 if ($this->isInFullScreenMode()) {
299 $width = '100%';
300 $height = '100%';
301 $paddingRight = '0px';
302 $editorWrapWidth = '100%';
303 } else {
304 $options = $backendUser->userTS['options.'];
305 $width = 530 + (isset($options['RTELargeWidthIncrement']) ? (int)$options['RTELargeWidthIncrement'] : 150);
306 /** @var InlineStackProcessor $inlineStackProcessor */
307 $inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
308 $inlineStackProcessor->initializeByGivenStructure($this->data['inlineStructure']);
309 $inlineStructureDepth = $inlineStackProcessor->getStructureDepth();
310 $width -= $inlineStructureDepth > 0 ? ($inlineStructureDepth + 1) * 12 : 0;
311 $widthOverride = isset($backendUser->uc['rteWidth']) && trim($backendUser->uc['rteWidth']) ? trim($backendUser->uc['rteWidth']) : trim($this->processedRteConfiguration['RTEWidthOverride']);
312 if ($widthOverride) {
313 if (strstr($widthOverride, '%')) {
314 if ($this->client['browser'] !== 'msie') {
315 $width = (int)$widthOverride > 0 ? (int)$widthOverride : '100%';
316 }
317 } else {
318 $width = (int)$widthOverride > 0 ? (int)$widthOverride : $width;
319 }
320 }
321 $width = strstr($width, '%') ? $width : $width . 'px';
322 $height = 380 + (isset($options['RTELargeHeightIncrement']) ? (int)$options['RTELargeHeightIncrement'] : 0);
323 $heightOverride = isset($backendUser->uc['rteHeight']) && (int)$backendUser->uc['rteHeight'] ? (int)$backendUser->uc['rteHeight'] : (int)$this->processedRteConfiguration['RTEHeightOverride'];
324 $height = $heightOverride > 0 ? $heightOverride . 'px' : $height . 'px';
325 $paddingRight = '2';
326 $editorWrapWidth = '99%';
327 }
328 $rteDivStyle = 'position:relative; left:0px; top:0px; height:' . $height . '; width:' . $width . '; border: 1px solid black; padding: 2 ' . $paddingRight . ' 2 2;';
329
330 $itemFormElementName = $this->data['parameterArray']['itemFormElName'];
331
332 // This seems to result in:
333 // _TRANSFORM_bodytext (the handled field name) in case the field is a direct DB field
334 // _TRANSFORM_vDEF (constant string) in case the RTE is within a flex form
335 $triggerFieldName = preg_replace('/\\[([^]]+)\\]$/', '[_TRANSFORM_\\1]', $itemFormElementName);
336
337 $value = $this->transformDatabaseContentToEditor($this->data['parameterArray']['itemFormElValue']);
338
339 $result = [];
340 // The hidden field tells the DataHandler that processing should be done on this value.
341 $result[] = '<input type="hidden" name="' . htmlspecialchars($triggerFieldName) . '" value="RTE" />';
342 $result[] = '<div id="pleasewait' . $this->domIdentifier . '" class="pleasewait" style="display: block;" >';
343 $result[] = $this->getLanguageService()->sL('LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang.xlf:Please wait');
344 $result[] = '</div>';
345 $result[] = '<div id="editorWrap' . $this->domIdentifier . '" class="editorWrap" style="visibility: hidden; width:' . $editorWrapWidth . '; height:100%;">';
346 $result[] = '<textarea ' . $this->getValidationDataAsDataAttribute($this->data['parameterArray']['fieldConf']['config']) . ' id="RTEarea' . $this->domIdentifier . '" name="' . htmlspecialchars($itemFormElementName) . '" rows="0" cols="0" style="' . htmlspecialchars($rteDivStyle) . '">';
347 $result[] = htmlspecialchars($value);
348 $result[] = '</textarea>';
349 $result[] = '</div>';
350
351 return implode(LF, $result);
352 }
353
354 /**
355 * Add registered plugins to the array of enabled plugins
356 *
357 * @return void
358 */
359 protected function enableRegisteredPlugins()
360 {
361 // Traverse registered plugins
362 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rtehtmlarea']['plugins'])) {
363 foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rtehtmlarea']['plugins'] as $pluginId => $pluginObjectConfiguration) {
364 if (is_array($pluginObjectConfiguration) && isset($pluginObjectConfiguration['objectReference'])) {
365 /** @var RteHtmlAreaApi $plugin */
366 $plugin = GeneralUtility::makeInstance($pluginObjectConfiguration['objectReference']);
367 $configuration = [
368 'language' => $this->language,
369 'contentTypo3Language' => $this->contentTypo3Language,
370 'contentISOLanguage' => $this->contentISOLanguage,
371 'contentLanguageUid' => $this->contentLanguageUid,
372 'RTEsetup' => $this->vanillaRteTsConfig,
373 'client' => $this->client,
374 'thisConfig' => $this->processedRteConfiguration,
375 'specConf' => $this->defaultExtras,
376 ];
377 if ($plugin->main($configuration)) {
378 $this->registeredPlugins[$pluginId] = $plugin;
379 // Override buttons from previously registered plugins
380 $pluginButtons = GeneralUtility::trimExplode(',', $plugin->getPluginButtons(), true);
381 foreach ($this->pluginButton as $previousPluginId => $buttonList) {
382 $this->pluginButton[$previousPluginId] = implode(',', array_diff(GeneralUtility::trimExplode(',', $this->pluginButton[$previousPluginId], true), $pluginButtons));
383 }
384 $this->pluginButton[$pluginId] = $plugin->getPluginButtons();
385 $pluginLabels = GeneralUtility::trimExplode(',', $plugin->getPluginLabels(), true);
386 foreach ($this->pluginLabel as $previousPluginId => $labelList) {
387 $this->pluginLabel[$previousPluginId] = implode(',', array_diff(GeneralUtility::trimExplode(',', $this->pluginLabel[$previousPluginId], true), $pluginLabels));
388 }
389 $this->pluginLabel[$pluginId] = $plugin->getPluginLabels();
390 $this->pluginEnabledArray[] = $pluginId;
391 }
392 }
393 }
394 }
395 // Process overrides
396 $hidePlugins = [];
397 foreach ($this->registeredPlugins as $pluginId => $plugin) {
398 /** @var RteHtmlAreaApi $plugin */
399 if ($plugin->addsButtons() && !$this->pluginButton[$pluginId]) {
400 $hidePlugins[] = $pluginId;
401 }
402 }
403 $this->pluginEnabledArray = array_unique(array_diff($this->pluginEnabledArray, $hidePlugins));
404 }
405
406 /**
407 * Set the toolbar config (only in this PHP-Object, not in JS):
408 *
409 * @return void
410 */
411 protected function setToolbar()
412 {
413 $backendUser = $this->getBackendUserAuthentication();
414
415 if ($this->client['browser'] === 'msie' || $this->client['browser'] === 'opera') {
416 $this->processedRteConfiguration['keepButtonGroupTogether'] = 0;
417 }
418 $this->defaultToolbarOrder = 'bar, blockstylelabel, blockstyle, textstylelabel, textstyle, linebreak,
419 bar, formattext, bold, strong, italic, emphasis, big, small, insertedtext, deletedtext, citation, code,'
420 . 'definition, keyboard, monospaced, quotation, sample, variable, bidioverride, strikethrough, subscript, superscript, underline, span,
421 bar, fontstyle, fontsize, bar, formatblock, insertparagraphbefore, insertparagraphafter, blockquote, line,
422 bar, left, center, right, justifyfull,
423 bar, orderedlist, unorderedlist, definitionlist, definitionitem, outdent, indent,
424 bar, language, showlanguagemarks,lefttoright, righttoleft,
425 bar, textcolor, bgcolor, textindicator,
426 bar, editelement, showmicrodata,
427 bar, image, emoticon, insertcharacter, insertsofthyphen, abbreviation, user,
428 bar, link, unlink,
429 bar, table,'
430 . ($this->processedRteConfiguration['hideTableOperationsInToolbar']
431 && is_array($this->processedRteConfiguration['buttons.'])
432 && is_array($this->processedRteConfiguration['buttons.']['toggleborders.'])
433 && $this->processedRteConfiguration['buttons.']['toggleborders.']['keepInToolbar'] ? ' toggleborders,' : '')
434 . 'bar, findreplace, spellcheck,
435 bar, chMode, inserttag, removeformat, bar, copy, cut, paste, pastetoggle, pastebehaviour, bar, undo, redo, bar, about, linebreak,'
436 . ($this->processedRteConfiguration['hideTableOperationsInToolbar'] ? '' : 'bar, toggleborders,')
437 . ' bar, tableproperties, tablerestyle, bar, rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit, bar,
438 columnproperties, columninsertbefore, columninsertafter, columndelete, columnsplit, bar,
439 cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge';
440
441 // Additional buttons from registered plugins
442 foreach ($this->registeredPlugins as $pluginId => $plugin) {
443 /** @var RteHtmlAreaApi $plugin */
444 if ($this->isPluginEnabled($pluginId)) {
445 $pluginButtons = $plugin->getPluginButtons();
446 //Add only buttons not yet in the default toolbar order
447 $addButtons = implode(
448 ',',
449 array_diff(
450 GeneralUtility::trimExplode(',', $pluginButtons, true),
451 GeneralUtility::trimExplode(',', $this->defaultToolbarOrder, true)
452 )
453 );
454 $this->defaultToolbarOrder = ($addButtons ? 'bar,' . $addButtons . ',linebreak,' : '') . $this->defaultToolbarOrder;
455 }
456 }
457 $toolbarOrder = $this->processedRteConfiguration['toolbarOrder'] ?: $this->defaultToolbarOrder;
458 // Getting rid of undefined buttons
459 $this->toolbarOrderArray = array_intersect(GeneralUtility::trimExplode(',', $toolbarOrder, true), GeneralUtility::trimExplode(',', $this->defaultToolbarOrder, true));
460 $toolbarOrder = array_unique(array_values($this->toolbarOrderArray));
461 // Fetching specConf for field from backend
462 $pList = is_array($this->defaultExtras['richtext']['parameters']) ? implode(',', $this->defaultExtras['richtext']['parameters']) : '';
463 if ($pList !== '*') {
464 // If not all
465 $show = is_array($this->defaultExtras['richtext']['parameters']) ? $this->defaultExtras['richtext']['parameters'] : [];
466 if ($this->processedRteConfiguration['showButtons']) {
467 if (!GeneralUtility::inList($this->processedRteConfiguration['showButtons'], '*')) {
468 $show = array_unique(array_merge($show, GeneralUtility::trimExplode(',', $this->processedRteConfiguration['showButtons'], true)));
469 } else {
470 $show = array_unique(array_merge($show, $toolbarOrder));
471 }
472 }
473 if (is_array($this->processedRteConfiguration['showButtons.'])) {
474 foreach ($this->processedRteConfiguration['showButtons.'] as $buttonId => $value) {
475 if ($value) {
476 $show[] = $buttonId;
477 }
478 }
479 $show = array_unique($show);
480 }
481 } else {
482 $show = $toolbarOrder;
483 }
484 $RTEkeyList = isset($backendUser->userTS['options.']['RTEkeyList']) ? $backendUser->userTS['options.']['RTEkeyList'] : '*';
485 if ($RTEkeyList !== '*') {
486 // If not all
487 $show = array_intersect($show, GeneralUtility::trimExplode(',', $RTEkeyList, true));
488 }
489 // Hiding buttons of disabled plugins
490 $hideButtons = ['space', 'bar', 'linebreak'];
491 foreach ($this->pluginButton as $pluginId => $buttonList) {
492 if (!$this->isPluginEnabled($pluginId)) {
493 $buttonArray = GeneralUtility::trimExplode(',', $buttonList, true);
494 foreach ($buttonArray as $button) {
495 $hideButtons[] = $button;
496 }
497 }
498 }
499 // Hiding labels of disabled plugins
500 foreach ($this->pluginLabel as $pluginId => $label) {
501 if (!$this->isPluginEnabled($pluginId)) {
502 $hideButtons[] = $label;
503 }
504 }
505 // Hiding buttons
506 $show = array_diff($show, GeneralUtility::trimExplode(',', $this->processedRteConfiguration['hideButtons'], true));
507 // Apply toolbar constraints from registered plugins
508 foreach ($this->registeredPlugins as $pluginId => $plugin) {
509 if ($this->isPluginEnabled($pluginId) && method_exists($plugin, 'applyToolbarConstraints')) {
510 $show = $plugin->applyToolbarConstraints($show);
511 }
512 }
513 // Getting rid of the buttons for which we have no position
514 $show = array_intersect($show, $toolbarOrder);
515 foreach ($this->registeredPlugins as $pluginId => $plugin) {
516 /** @var RteHtmlAreaApi $plugin */
517 $plugin->setToolbar($show);
518 }
519 $this->toolbar = $show;
520 }
521
522 /**
523 * Disable some plugins
524 *
525 * @return void
526 */
527 protected function setPlugins()
528 {
529 // Disabling a plugin that adds buttons if none of its buttons is in the toolbar
530 $hidePlugins = [];
531 foreach ($this->pluginButton as $pluginId => $buttonList) {
532 /** @var RteHtmlAreaApi $plugin */
533 $plugin = $this->registeredPlugins[$pluginId];
534 if ($plugin->addsButtons()) {
535 $showPlugin = false;
536 $buttonArray = GeneralUtility::trimExplode(',', $buttonList, true);
537 foreach ($buttonArray as $button) {
538 if (in_array($button, $this->toolbar)) {
539 $showPlugin = true;
540 }
541 }
542 if (!$showPlugin) {
543 $hidePlugins[] = $pluginId;
544 }
545 }
546 }
547 $this->pluginEnabledArray = array_diff($this->pluginEnabledArray, $hidePlugins);
548 // Hiding labels of disabled plugins
549 $hideLabels = [];
550 foreach ($this->pluginLabel as $pluginId => $label) {
551 if (!$this->isPluginEnabled($pluginId)) {
552 $hideLabels[] = $label;
553 }
554 }
555 $this->toolbar = array_diff($this->toolbar, $hideLabels);
556 // Adding plugins declared as prerequisites by enabled plugins
557 $requiredPlugins = [];
558 foreach ($this->registeredPlugins as $pluginId => $plugin) {
559 /** @var RteHtmlAreaApi $plugin */
560 if ($this->isPluginEnabled($pluginId)) {
561 $requiredPlugins = array_merge($requiredPlugins, GeneralUtility::trimExplode(',', $plugin->getRequiredPlugins(), true));
562 }
563 }
564 $requiredPlugins = array_unique($requiredPlugins);
565 foreach ($requiredPlugins as $pluginId) {
566 if (is_object($this->registeredPlugins[$pluginId]) && !$this->isPluginEnabled($pluginId)) {
567 $this->pluginEnabledArray[] = $pluginId;
568 }
569 }
570 $this->pluginEnabledArray = array_unique($this->pluginEnabledArray);
571 // Completing the toolbar conversion array for htmlArea
572 foreach ($this->registeredPlugins as $pluginId => $plugin) {
573 /** @var RteHtmlAreaApi $plugin */
574 if ($this->isPluginEnabled($pluginId)) {
575 $this->convertToolbarForHtmlAreaArray = array_unique(array_merge($this->convertToolbarForHtmlAreaArray, $plugin->getConvertToolbarForHtmlAreaArray()));
576 }
577 }
578 }
579
580 /**
581 * Add RTE main scripts and plugin scripts
582 *
583 * @return void
584 */
585 protected function loadRequireModulesForRTE()
586 {
587 $this->resultArray['requireJsModules'] = [];
588 $this->resultArray['requireJsModules'][] = 'TYPO3/CMS/Rtehtmlarea/HTMLArea/HTMLArea';
589 foreach ($this->pluginEnabledCumulativeArray as $pluginId) {
590 /** @var RteHtmlAreaApi $plugin */
591 $plugin = $this->registeredPlugins[$pluginId];
592 $extensionKey = is_object($plugin) ? $plugin->getExtensionKey() : 'rtehtmlarea';
593 $requirePath = 'TYPO3/CMS/' . GeneralUtility::underscoredToUpperCamelCase($extensionKey);
594 $this->resultArray['requireJsModules'][] = $requirePath . '/Plugins/' . $pluginId;
595 }
596 }
597
598 /**
599 * Return RTE initialization inline JavaScript code
600 *
601 * @return string RTE initialization inline JavaScript code
602 */
603 protected function getRteInitJsCode()
604 {
605 $skinFilename = trim($this->processedRteConfiguration['skin']) ?: 'EXT:rtehtmlarea/Resources/Public/Css/Skin/htmlarea.css';
606 $skinFilename = $this->getFullFileName($skinFilename);
607 $skinDirectory = dirname($skinFilename);
608 // Editing area style sheet
609 $editedContentCSS = GeneralUtility::createVersionNumberedFilename($skinDirectory . '/htmlarea-edited-content.css');
610
611 return 'require(["TYPO3/CMS/Rtehtmlarea/HTMLArea/HTMLArea"], function (HTMLArea) {
612 if (typeof RTEarea === "undefined") {
613 RTEarea = new Object();
614 RTEarea[0] = new Object();
615 RTEarea[0].version = "' . TYPO3_version . '";
616 RTEarea[0].editorUrl = "' . ExtensionManagementUtility::extRelPath('rtehtmlarea') . '";
617 RTEarea[0].editorSkin = "' . $skinDirectory . '/";
618 RTEarea[0].editedContentCSS = "' . $editedContentCSS . '";
619 RTEarea.init = function() {
620 HTMLArea.init();
621 };
622 RTEarea.initEditor = function(editorNumber) {
623 if (typeof HTMLArea === "undefined" || !HTMLArea.isReady) {
624 window.setTimeout(function () {
625 RTEarea.initEditor(editorNumber);
626 }, 40);
627 } else {
628 HTMLArea.initEditor(editorNumber);
629 }
630 };
631 }
632 RTEarea.init();
633 });';
634 }
635
636 /**
637 * Return the Javascript code for configuring the RTE
638 *
639 * @return void
640 */
641 protected function addInstanceJavaScriptRegistration()
642 {
643 $backendUser = $this->getBackendUserAuthentication();
644
645 $jsArray = [];
646 $jsArray[] = 'var HTMLArea = HTMLArea || {};';
647 $jsArray[] = 'if (typeof configureEditorInstance === "undefined") {';
648 $jsArray[] = ' configureEditorInstance = new Object();';
649 $jsArray[] = '}';
650 $jsArray[] = 'configureEditorInstance[' . GeneralUtility::quoteJSvalue($this->domIdentifier) . '] = function() {';
651 $jsArray[] = 'if (typeof RTEarea === "undefined") {';
652 $jsArray[] = ' window.setTimeout("configureEditorInstance[' . GeneralUtility::quoteJSvalue($this->domIdentifier) . ']();", 40);';
653 $jsArray[] = '} else {';
654 $jsArray[] = 'editornumber = ' . GeneralUtility::quoteJSvalue($this->domIdentifier) . ';';
655 $jsArray[] = 'RTEarea[editornumber] = new Object();';
656 $jsArray[] = 'RTEarea[editornumber].RTEtsConfigParams = "&RTEtsConfigParams=' . rawurlencode($this->RTEtsConfigParams()) . '";';
657 $jsArray[] = 'RTEarea[editornumber].number = editornumber;';
658 $jsArray[] = 'RTEarea[editornumber].deleted = false;';
659 $jsArray[] = 'RTEarea[editornumber].textAreaId = ' . GeneralUtility::quoteJSvalue($this->domIdentifier) . ';';
660 $jsArray[] = 'RTEarea[editornumber].id = "RTEarea" + editornumber;';
661 $jsArray[] = 'RTEarea[editornumber].RTEWidthOverride = "'
662 . (isset($backendUser->uc['rteWidth']) && trim($backendUser->uc['rteWidth'])
663 ? trim($backendUser->uc['rteWidth'])
664 : trim($this->processedRteConfiguration['RTEWidthOverride'])) . '";';
665 $jsArray[] = 'RTEarea[editornumber].RTEHeightOverride = "'
666 . (isset($backendUser->uc['rteHeight']) && (int)$backendUser->uc['rteHeight']
667 ? (int)$backendUser->uc['rteHeight']
668 : (int)$this->processedRteConfiguration['RTEHeightOverride']) . '";';
669 $jsArray[] = 'RTEarea[editornumber].resizable = '
670 . (isset($backendUser->uc['rteResize']) && $backendUser->uc['rteResize']
671 ? 'true;'
672 : (trim($this->processedRteConfiguration['rteResize']) ? 'true;' : 'false;'));
673 $jsArray[] = 'RTEarea[editornumber].maxHeight = "'
674 . (isset($backendUser->uc['rteMaxHeight']) && (int)$backendUser->uc['rteMaxHeight']
675 ? trim($backendUser->uc['rteMaxHeight'])
676 : ((int)$this->processedRteConfiguration['rteMaxHeight'] ?: '2000')) . '";';
677 $jsArray[] = 'RTEarea[editornumber].fullScreen = ' . ($this->isInFullScreenMode() ? 'true;' : 'false;');
678 $jsArray[] = 'RTEarea[editornumber].showStatusBar = ' . (trim($this->processedRteConfiguration['showStatusBar']) ? 'true;' : 'false;');
679 $jsArray[] = 'RTEarea[editornumber].enableWordClean = ' . (trim($this->processedRteConfiguration['enableWordClean']) ? 'true;' : 'false;');
680 $jsArray[] = 'RTEarea[editornumber].htmlRemoveComments = ' . (trim($this->processedRteConfiguration['removeComments']) ? 'true;' : 'false;');
681 $jsArray[] = 'RTEarea[editornumber].disableEnterParagraphs = ' . (trim($this->processedRteConfiguration['disableEnterParagraphs']) ? 'true;' : 'false;');
682 $jsArray[] = 'RTEarea[editornumber].disableObjectResizing = ' . (trim($this->processedRteConfiguration['disableObjectResizing']) ? 'true;' : 'false;');
683 $jsArray[] = 'RTEarea[editornumber].removeTrailingBR = ' . (trim($this->processedRteConfiguration['removeTrailingBR']) ? 'true;' : 'false;');
684 $jsArray[] = 'RTEarea[editornumber].useCSS = ' . (trim($this->processedRteConfiguration['useCSS']) ? 'true' : 'false') . ';';
685 $jsArray[] = 'RTEarea[editornumber].keepButtonGroupTogether = ' . (trim($this->processedRteConfiguration['keepButtonGroupTogether']) ? 'true;' : 'false;');
686 $jsArray[] = 'RTEarea[editornumber].disablePCexamples = ' . (trim($this->processedRteConfiguration['disablePCexamples']) ? 'true;' : 'false;');
687 $jsArray[] = 'RTEarea[editornumber].showTagFreeClasses = ' . (trim($this->processedRteConfiguration['showTagFreeClasses']) ? 'true;' : 'false;');
688 $jsArray[] = 'RTEarea[editornumber].tceformsNested = ' . (!empty($this->data) ? json_encode($this->data['tabAndInlineStack']) : '[]') . ';';
689 $jsArray[] = 'RTEarea[editornumber].dialogueWindows = new Object();';
690 if (isset($this->processedRteConfiguration['dialogueWindows.']['defaultPositionFromTop'])) {
691 $jsArray[] = 'RTEarea[editornumber].dialogueWindows.positionFromTop = ' . (int)$this->processedRteConfiguration['dialogueWindows.']['defaultPositionFromTop'] . ';';
692 }
693 if (isset($this->processedRteConfiguration['dialogueWindows.']['defaultPositionFromLeft'])) {
694 $jsArray[] = 'RTEarea[editornumber].dialogueWindows.positionFromLeft = ' . (int)$this->processedRteConfiguration['dialogueWindows.']['defaultPositionFromLeft'] . ';';
695 }
696 $jsArray[] = 'RTEarea[editornumber].sys_language_content = "' . $this->contentLanguageUid . '";';
697 $jsArray[] = 'RTEarea[editornumber].typo3ContentLanguage = "' . $this->contentTypo3Language . '";';
698 $jsArray[] = 'RTEarea[editornumber].userUid = "' . 'BE_' . $backendUser->user['uid'] . '";';
699
700 // Setting the plugin flags
701 $jsArray[] = 'RTEarea[editornumber].plugin = new Object();';
702 foreach ($this->pluginEnabledArray as $pluginId) {
703 $jsArray[] = 'RTEarea[editornumber].plugin.' . $pluginId . ' = true;';
704 }
705
706 // Setting the buttons configuration
707 $jsArray[] = 'RTEarea[editornumber].buttons = new Object();';
708 if (is_array($this->processedRteConfiguration['buttons.'])) {
709 foreach ($this->processedRteConfiguration['buttons.'] as $buttonIndex => $conf) {
710 $button = substr($buttonIndex, 0, -1);
711 if (is_array($conf)) {
712 $jsArray[] = 'RTEarea[editornumber].buttons.' . $button . ' = ' . $this->buildNestedJSArray($conf) . ';';
713 }
714 }
715 }
716
717 // Setting the list of tags to be removed if specified in the RTE config
718 if (trim($this->processedRteConfiguration['removeTags'])) {
719 $jsArray[] = 'RTEarea[editornumber].htmlRemoveTags = /^(' . implode('|', GeneralUtility::trimExplode(',', $this->processedRteConfiguration['removeTags'], true)) . ')$/i;';
720 }
721
722 // Setting the list of tags to be removed with their contents if specified in the RTE config
723 if (trim($this->processedRteConfiguration['removeTagsAndContents'])) {
724 $jsArray[] = 'RTEarea[editornumber].htmlRemoveTagsAndContents = /^(' . implode('|', GeneralUtility::trimExplode(',', $this->processedRteConfiguration['removeTagsAndContents'], true)) . ')$/i;';
725 }
726
727 // Setting array of custom tags if specified in the RTE config
728 if (!empty($this->processedRteConfiguration['customTags'])) {
729 $customTags = GeneralUtility::trimExplode(',', $this->processedRteConfiguration['customTags'], true);
730 if (!empty($customTags)) {
731 $jsArray[] = 'RTEarea[editornumber].customTags= ' . json_encode($customTags) . ';';
732 }
733 }
734
735 // Setting array of content css files if specified in the RTE config
736 $versionNumberedFileNames = [];
737 $contentCssFileNames = $this->getContentCssFileNames();
738 foreach ($contentCssFileNames as $contentCssFileName) {
739 $versionNumberedFileNames[] = GeneralUtility::createVersionNumberedFilename($contentCssFileName);
740 }
741 $jsArray[] = 'RTEarea[editornumber].pageStyle = ["' . implode('","', $versionNumberedFileNames) . '"];';
742
743 $jsArray[] = 'RTEarea[editornumber].classesUrl = "' . $this->writeTemporaryFile(('classes_' . $this->language), 'js', $this->buildJSClassesArray()) . '";';
744
745 // Add Javascript configuration for registered plugins
746 foreach ($this->registeredPlugins as $pluginId => $plugin) {
747 /** @var RteHtmlAreaApi $plugin */
748 if ($this->isPluginEnabled($pluginId)) {
749 $jsPluginString = $plugin->buildJavascriptConfiguration();
750 if ($jsPluginString) {
751 $jsArray[] = $plugin->buildJavascriptConfiguration();
752 }
753 }
754 }
755
756 // Avoid premature reference to HTMLArea when being initially loaded by IRRE Ajax call
757 $jsArray[] = 'RTEarea[editornumber].toolbar = ' . $this->getJSToolbarArray() . ';';
758 $jsArray[] = 'RTEarea[editornumber].convertButtonId = ' . json_encode(array_flip($this->convertToolbarForHtmlAreaArray)) . ';';
759 $jsArray[] = 'RTEarea.initEditor(editornumber);';
760 $jsArray[] = '}';
761 $jsArray[] = '}';
762 $jsArray[] = 'configureEditorInstance[' . GeneralUtility::quoteJSvalue($this->domIdentifier) . ']();';
763
764 $this->resultArray['additionalJavaScriptPost'][] = implode(LF, $jsArray);
765 }
766
767 /**
768 * Get the name of the contentCSS files to use
769 *
770 * @return array An array of full file name of the content css files to use
771 */
772 protected function getContentCssFileNames()
773 {
774 $contentCss = is_array($this->processedRteConfiguration['contentCSS.']) ? $this->processedRteConfiguration['contentCSS.'] : [];
775 if (isset($this->processedRteConfiguration['contentCSS'])) {
776 $contentCss[] = trim($this->processedRteConfiguration['contentCSS']);
777 }
778 $contentCssFiles = [];
779 if (!empty($contentCss)) {
780 foreach ($contentCss as $contentCssKey => $contentCssfile) {
781 $fileName = trim($contentCssfile);
782 $absolutePath = GeneralUtility::getFileAbsFileName($fileName);
783 if (file_exists($absolutePath) && filesize($absolutePath)) {
784 $contentCssFiles[$contentCssKey] = $this->getFullFileName($fileName);
785 }
786 }
787 } else {
788 // Fallback to default content css file if none of the configured files exists and is not empty
789 $contentCssFiles['default'] = $this->getFullFileName('EXT:rtehtmlarea/Resources/Public/Css/ContentCss/Default.css');
790 }
791 return array_unique($contentCssFiles);
792 }
793
794 /**
795 * Return TRUE, if the plugin can be loaded
796 *
797 * @param string $pluginId: The identification string of the plugin
798 * @return bool TRUE if the plugin can be loaded
799 */
800 protected function isPluginEnabled($pluginId)
801 {
802 return in_array($pluginId, $this->pluginEnabledArray);
803 }
804
805 /**
806 * Return JS arrays of classes configuration
807 *
808 * @return string JS classes arrays
809 */
810 protected function buildJSClassesArray()
811 {
812 $RTEProperties = $this->vanillaRteTsConfig['properties'];
813 // Declare sub-arrays
814 $classesArray = [
815 'labels' => [],
816 'values' => [],
817 'noShow' => [],
818 'alternating' => [],
819 'counting' => [],
820 'selectable' => [],
821 'requires' => [],
822 'requiredBy' => [],
823 'XOR' => []
824 ];
825 $JSClassesArray = '';
826 // Scanning the list of classes if specified in the RTE config
827 if (is_array($RTEProperties['classes.'])) {
828 foreach ($RTEProperties['classes.'] as $className => $conf) {
829 $className = rtrim($className, '.');
830
831 $label = '';
832 if (!empty($conf['name'])) {
833 $label = $this->getLanguageService()->sL(trim($conf['name']));
834 $label = str_replace('"', '\\"', str_replace('\\\'', '\'', $label));
835 }
836 $classesArray['labels'][$className] = $label;
837 $classesArray['values'][$className] = str_replace('\\\'', '\'', $conf['value']);
838 if (isset($conf['noShow'])) {
839 $classesArray['noShow'][$className] = $conf['noShow'];
840 }
841 if (is_array($conf['alternating.'])) {
842 $classesArray['alternating'][$className] = $conf['alternating.'];
843 }
844 if (is_array($conf['counting.'])) {
845 $classesArray['counting'][$className] = $conf['counting.'];
846 }
847 if (isset($conf['selectable'])) {
848 $classesArray['selectable'][$className] = $conf['selectable'];
849 }
850 if (isset($conf['requires'])) {
851 $classesArray['requires'][$className] = explode(',', GeneralUtility::rmFromList($className, $this->cleanList($conf['requires'])));
852 }
853 }
854 // Remove circularities from classes dependencies
855 $requiringClasses = array_keys($classesArray['requires']);
856 foreach ($requiringClasses as $requiringClass) {
857 if ($this->hasCircularDependency($classesArray, $requiringClass, $requiringClass)) {
858 unset($classesArray['requires'][$requiringClass]);
859 }
860 }
861 // Reverse relationship for the dependency checks when removing styles
862 $requiringClasses = array_keys($classesArray['requires']);
863 foreach ($requiringClasses as $className) {
864 foreach ($classesArray['requires'][$className] as $requiredClass) {
865 if (!is_array($classesArray['requiredBy'][$requiredClass])) {
866 $classesArray['requiredBy'][$requiredClass] = [];
867 }
868 if (!in_array($className, $classesArray['requiredBy'][$requiredClass])) {
869 $classesArray['requiredBy'][$requiredClass][] = $className;
870 }
871 }
872 }
873 }
874 // Scanning the list of sets of mutually exclusives classes if specified in the RTE config
875 if (is_array($RTEProperties['mutuallyExclusiveClasses.'])) {
876 foreach ($RTEProperties['mutuallyExclusiveClasses.'] as $listName => $conf) {
877 $classSet = GeneralUtility::trimExplode(',', $conf, true);
878 $classList = implode(',', $classSet);
879 foreach ($classSet as $className) {
880 $classesArray['XOR'][$className] = '/^(' . implode('|', GeneralUtility::trimExplode(',', GeneralUtility::rmFromList($className, $classList), true)) . ')$/';
881 }
882 }
883 }
884 foreach ($classesArray as $key => $subArray) {
885 $JSClassesArray .= 'HTMLArea.classes' . ucfirst($key) . ' = ' . $this->buildNestedJSArray($subArray) . ';' . LF;
886 }
887 return $JSClassesArray;
888 }
889
890 /**
891 * Check for possible circularity in classes dependencies
892 *
893 * @param array $classesArray: reference to the array of classes dependencies
894 * @param string $requiringClass: class requiring at some iteration level from the initial requiring class
895 * @param string $initialClass: initial class from which a circular relationship is being searched
896 * @param int $recursionLevel: depth of recursive call
897 * @return bool TRUE, if a circular relationship is found
898 */
899 protected function hasCircularDependency(&$classesArray, $requiringClass, $initialClass, $recursionLevel = 0)
900 {
901 if (is_array($classesArray['requires'][$requiringClass])) {
902 if (in_array($initialClass, $classesArray['requires'][$requiringClass])) {
903 return true;
904 } else {
905 if ($recursionLevel++ < 20) {
906 foreach ($classesArray['requires'][$requiringClass] as $requiringClass2) {
907 if ($this->hasCircularDependency($classesArray, $requiringClass2, $initialClass, $recursionLevel)) {
908 return true;
909 }
910 }
911 }
912 return false;
913 }
914 } else {
915 return false;
916 }
917 }
918
919 /**
920 * Translate Page TS Config array in JS nested array definition
921 * Replace 0 values with false
922 * Unquote regular expression values
923 * Replace empty arrays with empty objects
924 *
925 * @param array $conf: Page TSConfig configuration array
926 * @return string nested JS array definition
927 */
928 protected function buildNestedJSArray($conf)
929 {
930 $convertedConf = GeneralUtility::removeDotsFromTS($conf);
931 return str_replace(
932 [':"0"', ':"\\/^(', ')$\\/i"', ':"\\/^(', ')$\\/"', '[]'],
933 [':false', ':/^(', ')$/i', ':/^(', ')$/', '{}'], json_encode($convertedConf)
934 );
935 }
936
937 /**
938 * Writes contents in a file in typo3temp and returns the file name
939 *
940 * @param string $label: A label to insert at the beginning of the name of the file
941 * @param string $fileExtension: The file extension of the file, defaulting to 'js'
942 * @param string $contents: The contents to write into the file
943 * @return string The name of the file written to typo3temp
944 * @throws \RuntimeException If writing to file failed
945 */
946 protected function writeTemporaryFile($label, $fileExtension = 'js', $contents = '')
947 {
948 $relativeFilename = 'typo3temp/assets/js/rte_' . str_replace('-', '_', $label) . '_' . GeneralUtility::shortMD5($contents, 20) . '.' . $fileExtension;
949 $destination = PATH_site . $relativeFilename;
950 if (!file_exists($destination)) {
951 $minifiedJavaScript = '';
952 if ($fileExtension === 'js' && $contents !== '') {
953 $minifiedJavaScript = GeneralUtility::minifyJavaScript($contents);
954 }
955 $failure = GeneralUtility::writeFileToTypo3tempDir($destination, $minifiedJavaScript ? $minifiedJavaScript : $contents);
956 if ($failure) {
957 throw new \RuntimeException($failure, 1460975840);
958 }
959 }
960 if (isset($GLOBALS['TSFE'])) {
961 $fileName = $relativeFilename;
962 } else {
963 $fileName = '../' . $relativeFilename;
964 }
965 return GeneralUtility::resolveBackPath($fileName);
966 }
967
968 /**
969 * Both rte framework and rte plugins can have label files that are
970 * used in JS. The methods gathers those and creates a JS object from
971 * file labels.
972 *
973 * @return string
974 */
975 protected function createJavaScriptLanguageLabelsFromFiles()
976 {
977 $labelArray = [];
978 // Load labels of 3 base files into JS
979 foreach (['tooltips', 'msg', 'dialogs'] as $identifier) {
980 $fileName = 'EXT:rtehtmlarea/Resources/Private/Language/locallang_' . $identifier . '.xlf';
981 $newLabels = $this->getMergedLabelsFromFile($fileName);
982 if (!empty($newLabels)) {
983 $labelArray[$identifier] = $newLabels;
984 }
985 }
986 // Load labels of plugins into JS
987 foreach ($this->pluginEnabledCumulativeArray as $pluginId) {
988 /** @var RteHtmlAreaApi $plugin */
989 $plugin = $this->registeredPlugins[$pluginId];
990 $extensionKey = is_object($plugin) ? $plugin->getExtensionKey() : 'rtehtmlarea';
991 $fileName = 'EXT:' . $extensionKey . '/Resources/Private/Language/Plugins/' . $pluginId . '/locallang_js.xlf';
992 $newLabels = $this->getMergedLabelsFromFile($fileName);
993 if (!empty($newLabels)) {
994 $labelArray[$pluginId] = $newLabels;
995 }
996 }
997 $this->resultArray['additionalJavaScriptPost'][] = 'HTMLArea.I18N = ' . json_encode($labelArray);
998 }
999
1000 /**
1001 * Get all labels from a specific label file, merge default
1002 * labels and target language labels.
1003 *
1004 * @param string $fileName The file to merge labels from
1005 * @return array Label keys and values
1006 */
1007 protected function getMergedLabelsFromFile($fileName)
1008 {
1009 /** @var $languageFactory LocalizationFactory */
1010 $languageFactory = GeneralUtility::makeInstance(LocalizationFactory::class);
1011 $localizationArray = $languageFactory->getParsedData($fileName, $this->language, 'utf-8', 1);
1012 if (is_array($localizationArray) && !empty($localizationArray)) {
1013 if (!empty($localizationArray[$this->language])) {
1014 $finalLocalLang = $localizationArray['default'];
1015 ArrayUtility::mergeRecursiveWithOverrule($finalLocalLang, $localizationArray[$this->language], true, false);
1016 $localizationArray[$this->language] = $finalLocalLang;
1017 } else {
1018 $localizationArray[$this->language] = $localizationArray['default'];
1019 }
1020 } else {
1021 $localizationArray = [];
1022 }
1023 return $localizationArray[$this->language];
1024 }
1025
1026 /**
1027 * Return the JS code of the toolbar configuration for the HTMLArea editor
1028 *
1029 * @return string The JS code as nested JS arrays
1030 */
1031 protected function getJSToolbarArray()
1032 {
1033 // The toolbar array
1034 $toolbar = [];
1035 // The current row; a "linebreak" ends the current row
1036 $row = [];
1037 // The current group; each group is between "bar"s; a "linebreak" ends the current group
1038 $group = [];
1039 // Process each toolbar item in the toolbar order list
1040 foreach ($this->toolbarOrderArray as $item) {
1041 switch ($item) {
1042 case 'linebreak':
1043 // Add row to toolbar if not empty
1044 if (!empty($group)) {
1045 $row[] = $group;
1046 $group = [];
1047 }
1048 if (!empty($row)) {
1049 $toolbar[] = $row;
1050 $row = [];
1051 }
1052 break;
1053 case 'bar':
1054 // Add group to row if not empty
1055 if (!empty($group)) {
1056 $row[] = $group;
1057 $group = [];
1058 }
1059 break;
1060 case 'space':
1061 if (end($group) != $this->convertToolbarForHtmlAreaArray[$item]) {
1062 $group[] = $this->convertToolbarForHtmlAreaArray[$item];
1063 }
1064 break;
1065 default:
1066 if (in_array($item, $this->toolbar)) {
1067 // Add the item to the group
1068 $convertedItem = $this->convertToolbarForHtmlAreaArray[$item];
1069 if ($convertedItem) {
1070 $group[] = $convertedItem;
1071 }
1072 }
1073 }
1074 }
1075 // Add the last group and last line, if not empty
1076 if (!empty($group)) {
1077 $row[] = $group;
1078 }
1079 if (!empty($row)) {
1080 $toolbar[] = $row;
1081 }
1082 return json_encode($toolbar);
1083 }
1084
1085 /**
1086 * Make a file name relative to the PATH_site or to the PATH_typo3
1087 *
1088 * @param string $filename: a file name of the form EXT:.... or relative to the PATH_site
1089 * @return string the file name relative to the PATH_site if in frontend or relative to the PATH_typo3 if in backend
1090 */
1091 protected function getFullFileName($filename)
1092 {
1093 if (substr($filename, 0, 4) === 'EXT:') {
1094 // extension
1095 list($extKey, $local) = explode('/', substr($filename, 4), 2);
1096 $newFilename = '';
1097 if ((string)$extKey !== '' && ExtensionManagementUtility::isLoaded($extKey) && (string)$local !== '') {
1098 $newFilename = ($this->isFrontendEditActive()
1099 ? ExtensionManagementUtility::siteRelPath($extKey)
1100 : ExtensionManagementUtility::extRelPath($extKey))
1101 . $local;
1102 }
1103 } else {
1104 $path = ($this->isFrontendEditActive() ? '' : '../');
1105 $newFilename = $path . ($filename[0] === '/' ? substr($filename, 1) : $filename);
1106 }
1107 return GeneralUtility::resolveBackPath($newFilename);
1108 }
1109
1110 /**
1111 * Return the Javascript code for copying the HTML code from the editor into the hidden input field.
1112 *
1113 * @return void
1114 */
1115 protected function addOnSubmitJavaScriptCode()
1116 {
1117 $onSubmitCode = [];
1118 $onSubmitCode[] = 'if (RTEarea[' . GeneralUtility::quoteJSvalue($this->domIdentifier) . ']) {';
1119 $onSubmitCode[] = 'document.editform[' . GeneralUtility::quoteJSvalue($this->data['parameterArray']['itemFormElName']) . '].value = RTEarea[' . GeneralUtility::quoteJSvalue($this->domIdentifier) . '].editor.getHTML();';
1120 $onSubmitCode[] = '} else {';
1121 $onSubmitCode[] = 'OK = 0;';
1122 $onSubmitCode[] = '};';
1123 $this->resultArray['additionalJavaScriptSubmit'][] = implode(LF, $onSubmitCode);
1124 }
1125
1126 /**
1127 * Checks if frontend editing is active.
1128 *
1129 * @return bool TRUE if frontend editing is active
1130 */
1131 protected function isFrontendEditActive()
1132 {
1133 return is_object($GLOBALS['TSFE']) && $GLOBALS['TSFE']->beUserLogin && $GLOBALS['BE_USER']->frontendEdit instanceof FrontendEditingController;
1134 }
1135
1136 /**
1137 * Client Browser Information
1138 *
1139 * @return array Contains keys "user agent", "browser", "version", "system"
1140 */
1141 protected function clientInfo()
1142 {
1143 $userAgent = GeneralUtility::getIndpEnv('HTTP_USER_AGENT');
1144 $browserInfo = ClientUtility::getBrowserInfo($userAgent);
1145 // Known engines: order is not irrelevant!
1146 $knownEngines = ['opera', 'msie', 'gecko', 'webkit'];
1147 if (is_array($browserInfo['all'])) {
1148 foreach ($knownEngines as $engine) {
1149 if ($browserInfo['all'][$engine]) {
1150 $browserInfo['browser'] = $engine;
1151 $browserInfo['version'] = ClientUtility::getVersion($browserInfo['all'][$engine]);
1152 break;
1153 }
1154 }
1155 }
1156 return $browserInfo;
1157 }
1158
1159 /**
1160 * Initialize a couple of language related local properties
1161 *
1162 * @return void
1163 */
1164 public function initializeLanguageRelatedProperties()
1165 {
1166 $this->language = $GLOBALS['LANG']->lang;
1167 if ($this->language === 'default' || !$this->language) {
1168 $this->language = 'en';
1169 }
1170 $currentLanguageUid = $this->data['databaseRow']['sys_language_uid'];
1171 if (is_array($currentLanguageUid)) {
1172 $currentLanguageUid = $currentLanguageUid[0];
1173 }
1174 $this->contentLanguageUid = (int)max($currentLanguageUid, 0);
1175 if ($this->contentLanguageUid) {
1176 $this->contentISOLanguage = $this->language;
1177 if (ExtensionManagementUtility::isLoaded('static_info_tables')) {
1178 $tableA = 'sys_language';
1179 $tableB = 'static_languages';
1180
1181 $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
1182 ->getQueryBuilderForTable($tableA);
1183
1184 $result = $queryBuilder
1185 ->select('a.uid', 'b.lg_iso_2', 'b.lg_country_iso_2')
1186 ->from($tableA)
1187 ->where('a.uid', (int)$this->contentLanguageUid)
1188 ->leftJoin(
1189 'a',
1190 $tableB,
1191 'b',
1192 $queryBuilder->expr()->eq('a.static_lang_isocode', $queryBuilder->quoteIdentifier('b.uid'))
1193 )
1194 ->execute();
1195
1196 while ($languageRow = $result->fetch()) {
1197 $this->contentISOLanguage = strtolower(trim($languageRow['lg_iso_2']) . (trim($languageRow['lg_country_iso_2']) ? '_' . trim($languageRow['lg_country_iso_2']) : ''));
1198 }
1199 }
1200 } else {
1201 $this->contentISOLanguage = trim($this->processedRteConfiguration['defaultContentLanguage']) ?: 'en';
1202 $languageCodeParts = explode('_', $this->contentISOLanguage);
1203 $this->contentISOLanguage = strtolower($languageCodeParts[0]) . ($languageCodeParts[1] ? '_' . strtoupper($languageCodeParts[1]) : '');
1204 // Find the configured language in the list of localization locales
1205 /** @var $locales Locales */
1206 $locales = GeneralUtility::makeInstance(Locales::class);
1207 // If not found, default to 'en'
1208 if (!in_array($this->contentISOLanguage, $locales->getLocales())) {
1209 $this->contentISOLanguage = 'en';
1210 }
1211 }
1212 $this->contentTypo3Language = $this->contentISOLanguage === 'en' ? 'default' : $this->contentISOLanguage;
1213 }
1214
1215 /**
1216 * Log usage of deprecated Page TS Config Property
1217 *
1218 * @param string $deprecatedProperty: Name of deprecated property
1219 * @param string $useProperty: Name of property to use instead
1220 * @param string $version: Version of TYPO3 in which the property will be removed
1221 * @return void
1222 */
1223 protected function logDeprecatedProperty($deprecatedProperty, $useProperty, $version)
1224 {
1225 $backendUser = $this->getBackendUserAuthentication();
1226 if (!$this->processedRteConfiguration['logDeprecatedProperties.']['disabled']) {
1227 $message = sprintf(
1228 'RTE Page TSConfig property "%1$s" used on page id #%4$s is DEPRECATED and will be removed in TYPO3 %3$s. Use "%2$s" instead.',
1229 $deprecatedProperty,
1230 $useProperty,
1231 $version,
1232 $this->data['databaseRow']['pid']
1233 );
1234 GeneralUtility::deprecationLog($message);
1235 if ($this->processedRteConfiguration['logDeprecatedProperties.']['logAlsoToBELog']) {
1236 $message = sprintf(
1237 $this->getLanguageService()->sL('LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang.xlf:deprecatedPropertyMessage'),
1238 $deprecatedProperty,
1239 $useProperty,
1240 $version,
1241 $this->data['databaseRow']['pid']
1242 );
1243 $backendUser->simplelog($message, 'rtehtmlarea');
1244 }
1245 }
1246 }
1247
1248 /**
1249 * A list of parameters that is mostly given as GET/POST to other RTE controllers.
1250 *
1251 * @return string
1252 */
1253 protected function RTEtsConfigParams()
1254 {
1255 $parameters = BackendUtility::getSpecConfParametersFromArray($this->defaultExtras['rte_transform']['parameters']);
1256 $result = [
1257 $this->data['tableName'],
1258 $this->data['databaseRow']['uid'],
1259 $this->data['fieldName'],
1260 $this->pidOfVersionedMotherRecord,
1261 $this->data['recordTypeValue'],
1262 $this->pidOfPageRecord,
1263 $parameters['imgpath'],
1264 ];
1265 return implode(':', $result);
1266 }
1267
1268 /**
1269 * Clean list
1270 *
1271 * @param string $str String to clean
1272 * @return string Cleaned string
1273 */
1274 protected function cleanList($str)
1275 {
1276 if (strstr($str, '*')) {
1277 $str = '*';
1278 } else {
1279 $str = implode(',', array_unique(GeneralUtility::trimExplode(',', $str, true)));
1280 }
1281 return $str;
1282 }
1283
1284 /**
1285 * Performs transformation of content from database to richtext editor
1286 *
1287 * @param string $value Value to transform.
1288 * @return string Transformed content
1289 */
1290 protected function transformDatabaseContentToEditor($value)
1291 {
1292 // change <strong> to <b>
1293 $value = preg_replace('/<(\\/?)strong/i', '<$1b', $value);
1294 // change <em> to <i>
1295 $value = preg_replace('/<(\\/?)em([^b>]*>)/i', '<$1i$2', $value);
1296
1297 if ($this->defaultExtras['rte_transform']) {
1298 /** @var RteHtmlParser $parseHTML */
1299 $parseHTML = GeneralUtility::makeInstance(RteHtmlParser::class);
1300 $parseHTML->init($this->data['table'] . ':' . $this->data['fieldName'], $this->pidOfVersionedMotherRecord);
1301 $value = $parseHTML->RTE_transform($value, $this->defaultExtras, 'rte', $this->processedRteConfiguration);
1302 }
1303 return $value;
1304 }
1305
1306 /**
1307 * True if RTE is in full screen mode / called via wizard controller
1308 *
1309 * @return bool
1310 */
1311 protected function isInFullScreenMode()
1312 {
1313 return GeneralUtility::_GP('M') === 'wizard_rte';
1314 }
1315
1316 /**
1317 * @return LanguageService
1318 */
1319 protected function getLanguageService()
1320 {
1321 return $GLOBALS['LANG'];
1322 }
1323
1324 /**
1325 * @return BackendUserAuthentication
1326 */
1327 protected function getBackendUserAuthentication()
1328 {
1329 return $GLOBALS['BE_USER'];
1330 }
1331 }