[BUGFIX] RTE LinkHandler handle required classes
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Classes / Controller / BrowseLinksController.php
1 <?php
2 namespace TYPO3\CMS\Rtehtmlarea\Controller;
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 Psr\Http\Message\ServerRequestInterface;
18 use TYPO3\CMS\Backend\Utility\BackendUtility;
19 use TYPO3\CMS\Core\Page\PageRenderer;
20 use TYPO3\CMS\Core\Utility\GeneralUtility;
21 use TYPO3\CMS\Lang\LanguageService;
22 use TYPO3\CMS\Recordlist\Controller\AbstractLinkBrowserController;
23
24 /**
25 * Extended controller for link browser
26 */
27 class BrowseLinksController extends AbstractLinkBrowserController
28 {
29 /**
30 * Active with TYPO3 Element Browser: Contains the name of the form field for which this window
31 * opens - thus allows us to make references back to the main window in which the form is.
32 * Example value: "data[pages][39][bodytext]|||tt_content|"
33 * or "data[tt_content][NEW3fba56fde763d][image]|||gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai|"
34 *
35 * Values:
36 * 0: form field name reference, eg. "data[tt_content][123][image]"
37 * 1: htmlArea RTE parameters: editorNo:contentTypo3Language
38 * 2: RTE config parameters: RTEtsConfigParams
39 * 3: allowed types. Eg. "tt_content" or "gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai"
40 *
41 * $pArr = explode('|', $this->bparams);
42 * $formFieldName = $pArr[0];
43 * $allowedTablesOrFileTypes = $pArr[3];
44 *
45 * @var string
46 */
47 protected $bparams;
48
49 /**
50 * @var int
51 */
52 protected $editorNo;
53
54 /**
55 * TYPO3 language code of the content language
56 *
57 * @var int
58 */
59 protected $contentTypo3Language;
60
61 /**
62 * Language service object for localization to the content language
63 *
64 * @var LanguageService
65 */
66 protected $contentLanguageService;
67
68 /**
69 * @var array
70 */
71 protected $buttonConfig = [];
72
73 /**
74 * @var array
75 */
76 protected $thisConfig = [];
77
78 /**
79 * RTE configuration
80 *
81 * @var array
82 */
83 protected $RTEProperties = [];
84
85 /**
86 * Used with the Rich Text Editor.
87 * Example value: "tt_content:NEW3fba58c969f5c:bodytext:23:text:23:"
88 *
89 * @var string
90 */
91 protected $RTEtsConfigParams;
92
93 /**
94 * @var array
95 */
96 protected $classesAnchorDefault = array();
97
98 /**
99 * @var array
100 */
101 protected $classesAnchorDefaultTitle = array();
102
103 /**
104 * @var array
105 */
106 protected $classesAnchorClassTitle = array();
107
108 /**
109 * @var array
110 */
111 protected $classesAnchorDefaultTarget = array();
112
113 /**
114 * @var array
115 */
116 protected $classesAnchorJSOptions = array();
117
118 /**
119 * @var string
120 */
121 protected $defaultLinkTarget = '';
122
123 /**
124 * @var array
125 */
126 protected $additionalAttributes = array();
127
128 /**
129 * @var string
130 */
131 protected $siteUrl = '';
132
133 /**
134 * Initialize controller
135 */
136 protected function init()
137 {
138 parent::init();
139
140 $lang = $this->getLanguageService();
141 $lang->includeLLFile('EXT:rtehtmlarea/Resources/Private/Language/locallang_browselinkscontroller.xlf');
142 $lang->includeLLFile('EXT:rtehtmlarea/Resources/Private/Language/locallang_dialogs.xlf');
143
144 $this->contentLanguageService = GeneralUtility::makeInstance(LanguageService::class);
145 }
146
147 /**
148 * @param ServerRequestInterface $request
149 */
150 protected function initVariables(ServerRequestInterface $request)
151 {
152 parent::initVariables($request);
153
154 $queryParameters = $request->getQueryParams();
155 $this->bparams = isset($queryParameters['bparams']) ? $queryParameters['bparams'] : '';
156
157 $this->siteUrl = GeneralUtility::getIndpEnv('TYPO3_SITE_URL');
158
159 $currentLinkParts = isset($queryParameters['curUrl']) ? $queryParameters['curUrl'] : [];
160 if (isset($currentLinkParts['all'])) {
161 $currentLinkParts = GeneralUtility::get_tag_attributes($queryParameters['curUrl']['all']);
162 $currentLinkParts['url'] = htmlspecialchars_decode($currentLinkParts['href']);
163 unset($currentLinkParts['href']);
164 }
165 $this->currentLinkParts = $currentLinkParts;
166
167 // Process bparams
168 $pArr = explode('|', $this->bparams);
169 $pRteArr = explode(':', $pArr[1]);
170 $this->editorNo = $pRteArr[0];
171 $this->contentTypo3Language = $pRteArr[1];
172 $this->RTEtsConfigParams = $pArr[2];
173 if (!$this->editorNo) {
174 $this->editorNo = GeneralUtility::_GP('editorNo');
175 $this->contentTypo3Language = GeneralUtility::_GP('contentTypo3Language');
176 $this->RTEtsConfigParams = GeneralUtility::_GP('RTEtsConfigParams');
177 }
178 $pArr[1] = implode(':', array($this->editorNo, $this->contentTypo3Language));
179 $pArr[2] = $this->RTEtsConfigParams;
180 $this->bparams = implode('|', $pArr);
181
182 $this->contentLanguageService->init($this->contentTypo3Language);
183
184 $RTEtsConfigParts = explode(':', $this->RTEtsConfigParams);
185 $RTEsetup = $this->getBackendUser()->getTSConfig('RTE', BackendUtility::getPagesTSconfig($RTEtsConfigParts[5]));
186 $this->RTEProperties = $RTEsetup['properties'];
187
188 $this->thisConfig = BackendUtility::RTEsetup($this->RTEProperties, $RTEtsConfigParts[0], $RTEtsConfigParts[2], $RTEtsConfigParts[4]);
189 $this->buttonConfig = isset($this->thisConfig['buttons.']['link.'])
190 ? $this->thisConfig['buttons.']['link.']
191 : [];
192 }
193
194 /**
195 * Initialize document template object
196 *
197 * @return void
198 */
199 protected function initDocumentTemplate()
200 {
201 parent::initDocumentTemplate();
202
203 $pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
204 $pageRenderer->loadRequireJsModule('TYPO3/CMS/Rtehtmlarea/RteLinkBrowser');
205 }
206
207 /**
208 * Initialize $this->currentLink and $this->currentLinkHandler
209 *
210 * @return void
211 */
212 protected function initCurrentUrl()
213 {
214 if (empty($this->currentLinkParts)) {
215 return;
216 }
217
218 if (!empty($this->currentLinkParts['class'])) {
219 // remove required classes
220 $currentClasses = GeneralUtility::trimExplode(' ', $this->currentLinkParts['class'], true);
221 if (count($currentClasses) > 1) {
222 $this->currentLinkParts['class'] = end($currentClasses);
223 }
224 }
225
226 if (empty($this->currentLinkParts['data-htmlarea-external'])) {
227 // strip siteUrl prefix except for external and mail links
228 if (strpos($this->currentLinkParts['url'], 'mailto:') === false) {
229 $paramsPosition = strpos($this->currentLinkParts['url'], '?');
230 if ($paramsPosition !== false) {
231 $this->currentLinkParts['url'] = substr($this->currentLinkParts['url'], $paramsPosition + 1);
232 }
233 }
234 // special treatment for page links, remove the id= part
235 $idPosition = strpos($this->currentLinkParts['url'], 'id=');
236 if ($idPosition !== false) {
237 $this->currentLinkParts['url'] = substr($this->currentLinkParts['url'], $idPosition + 3);
238 }
239
240 // in RTE the additional params are encoded directly at the end of the href part
241 // we need to split this again into dedicated fields
242 $additionalParamsPosition = strpos($this->currentLinkParts['url'], '?');
243 if ($additionalParamsPosition === false) {
244 $additionalParamsPosition = strpos($this->currentLinkParts['url'], '&');
245 }
246 if ($additionalParamsPosition !== false) {
247 $this->currentLinkParts['params'] = substr($this->currentLinkParts['url'], $additionalParamsPosition);
248 $this->currentLinkParts['url'] = substr($this->currentLinkParts['url'], 0, $additionalParamsPosition);
249 // in case the first sign was an ? override it with &
250 $this->currentLinkParts['params'][0] = '&';
251 }
252 }
253
254 parent::initCurrentUrl();
255 }
256
257 /**
258 * Renders the link attributes for the selected link handler
259 *
260 * @return string
261 */
262 public function renderLinkAttributeFields()
263 {
264 // Processing the classes configuration
265 if (!empty($this->buttonConfig['properties.']['class.']['allowedClasses'])) {
266 $classesAnchorArray = GeneralUtility::trimExplode(',', $this->buttonConfig['properties.']['class.']['allowedClasses'], true);
267 // Collecting allowed classes and configured default values
268 $classesAnchor = [
269 'all' => []
270 ];
271 $titleReadOnly = $this->buttonConfig['properties.']['title.']['readOnly']
272 || $this->buttonConfig[$this->displayedLinkHandlerId . '.']['properties.']['title.']['readOnly'];
273 if (is_array($this->RTEProperties['classesAnchor.'])) {
274 foreach ($this->RTEProperties['classesAnchor.'] as $label => $conf) {
275 if (in_array($conf['class'], $classesAnchorArray)) {
276 $classesAnchor['all'][] = $conf['class'];
277 if ($conf['type'] === $this->displayedLinkHandlerId) {
278 $classesAnchor[$conf['type']][] = $conf['class'];
279 if ($this->buttonConfig[$conf['type'] . '.']['properties.']['class.']['default'] == $conf['class']) {
280 $this->classesAnchorDefault[$conf['type']] = $conf['class'];
281 if ($conf['titleText']) {
282 $this->classesAnchorDefaultTitle[$conf['type']] = $this->contentLanguageService->sL(trim($conf['titleText']));
283 }
284 if (isset($conf['target'])) {
285 $this->classesAnchorDefaultTarget[$conf['type']] = trim($conf['target']);
286 }
287 }
288 }
289 if ($titleReadOnly && $conf['titleText']) {
290 $this->classesAnchorClassTitle[$conf['class']] = ($this->classesAnchorDefaultTitle[$conf['type']] = $this->contentLanguageService->sL(trim($conf['titleText'])));
291 }
292 }
293 }
294 }
295 // Constructing the class selector options
296 foreach ($classesAnchorArray as $class) {
297 if (!in_array($class, $classesAnchor['all']) || in_array($class, $classesAnchor['all']) && is_array($classesAnchor[$this->displayedLinkHandlerId]) && in_array($class, $classesAnchor[$this->displayedLinkHandlerId])) {
298 $selected = '';
299 if ($this->linkAttributeValues['class'] === $class || !$this->linkAttributeValues['class'] && $this->classesAnchorDefault[$this->displayedLinkHandlerId] == $class) {
300 $selected = 'selected="selected"';
301 }
302 $classLabel = !empty($this->RTEProperties['classes.'][$class . '.']['name'])
303 ? $this->getPageConfigLabel($this->RTEProperties['classes.'][$class . '.']['name'], 0)
304 : $class;
305 $classStyle = !empty($this->RTEProperties['classes.'][$class . '.']['value'])
306 ? $this->RTEProperties['classes.'][$class . '.']['value']
307 : '';
308 $this->classesAnchorJSOptions[$this->displayedLinkHandlerId] .= '<option ' . $selected . ' value="' . $class . '"' . ($classStyle ? ' style="' . $classStyle . '"' : '') . '>' . $classLabel . '</option>';
309 }
310 }
311 if ($this->classesAnchorJSOptions[$this->displayedLinkHandlerId] && !($this->buttonConfig['properties.']['class.']['required'] || $this->buttonConfig[$this->displayedLinkHandlerId . '.']['properties.']['class.']['required'])) {
312 $selected = '';
313 if (!$this->linkAttributeValues['class'] && !$this->classesAnchorDefault[$this->displayedLinkHandlerId]) {
314 $selected = 'selected="selected"';
315 }
316 $this->classesAnchorJSOptions[$this->displayedLinkHandlerId] = '<option ' . $selected . ' value=""></option>' . $this->classesAnchorJSOptions[$this->displayedLinkHandlerId];
317 }
318 }
319 // Default target
320 $this->defaultLinkTarget = $this->classesAnchorDefault[$this->displayedLinkHandlerId] && $this->classesAnchorDefaultTarget[$this->displayedLinkHandlerId]
321 ? $this->classesAnchorDefaultTarget[$this->displayedLinkHandlerId]
322 : (isset($this->buttonConfig[$this->displayedLinkHandlerId . '.']['properties.']['target.']['default'])
323 ? $this->buttonConfig[$this->displayedLinkHandlerId . '.']['properties.']['target.']['default']
324 : (isset($this->buttonConfig['properties.']['target.']['default'])
325 ? $this->buttonConfig['properties.']['target.']['default']
326 : ''));
327 // Initializing additional attributes
328 if ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rtehtmlarea']['plugins']['TYPO3Link']['additionalAttributes']) {
329 $addAttributes = GeneralUtility::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['rtehtmlarea']['plugins']['TYPO3Link']['additionalAttributes'], true);
330 foreach ($addAttributes as $attribute) {
331 $this->additionalAttributes[$attribute] = isset($this->linkAttributeValues[$attribute]) ? $this->linkAttributeValues[$attribute] : '';
332 }
333 }
334 return parent::renderLinkAttributeFields();
335 }
336
337 /**
338 * Localize a label obtained from Page TSConfig
339 *
340 * @param string $string The label to be localized
341 * @param bool $JScharCode If needs to be converted to an array of char numbers
342 * @return string Localized string
343 */
344 public function getPageConfigLabel($string, $JScharCode = true)
345 {
346 if (substr($string, 0, 4) !== 'LLL:') {
347 $label = $string;
348 } else {
349 $label = $this->getLanguageService()->sL(trim($string));
350 }
351 $label = str_replace('"', '\\"', str_replace('\\\'', '\'', $label));
352 return $JScharCode ? GeneralUtility::quoteJSvalue($label) : $label;
353 }
354
355 /**
356 * @return string
357 */
358 protected function renderCurrentUrl()
359 {
360 $removeLink = '<a href="#" class="btn btn-default t3js-removeCurrentLink">' . $this->getLanguageService()->getLL('removeLink', true) . '</a>';
361 return '
362 <table border="0" cellpadding="0" cellspacing="0" id="typo3-curUrl">
363 <tr>
364 <td>' . $this->getLanguageService()->getLL('currentLink', true) . ': ' . htmlspecialchars($this->currentLinkHandler->formatCurrentUrl()) . $removeLink . '</td>
365 </tr>
366 </table>';
367 }
368
369 /**
370 * Get the allowed items or tabs
371 *
372 * @return string[]
373 */
374 protected function getAllowedItems()
375 {
376 $allowedItems = parent::getAllowedItems();
377
378 $blindLinkOptions = isset($this->thisConfig['blindLinkOptions'])
379 ? GeneralUtility::trimExplode(',', $this->thisConfig['blindLinkOptions'], true)
380 : [];
381 $allowedItems = array_diff($allowedItems, $blindLinkOptions);
382
383 if (is_array($this->buttonConfig['options.']) && $this->buttonConfig['options.']['removeItems']) {
384 $allowedItems = array_diff($allowedItems, GeneralUtility::trimExplode(',', $this->buttonConfig['options.']['removeItems'], true));
385 }
386
387 return $allowedItems;
388 }
389
390 /**
391 * Get the allowed link attributes
392 *
393 * @return string[]
394 */
395 protected function getAllowedLinkAttributes()
396 {
397 $allowedLinkAttributes = parent::getAllowedLinkAttributes();
398
399 $blindLinkFields = isset($this->thisConfig['blindLinkFields'])
400 ? GeneralUtility::trimExplode(',', $this->thisConfig['blindLinkFields'], true)
401 : [];
402 $allowedLinkAttributes = array_diff($allowedLinkAttributes, $blindLinkFields);
403
404 return $allowedLinkAttributes;
405 }
406
407 /**
408 * Create an array of link attribute field rendering definitions
409 *
410 * @return string[]
411 */
412 protected function getLinkAttributeFieldDefinitions()
413 {
414 $fieldRenderingDefinitions = parent::getLinkAttributeFieldDefinitions();
415 $fieldRenderingDefinitions['title'] = $this->getTitleField();
416 $fieldRenderingDefinitions['class'] = $this->getClassField();
417 $fieldRenderingDefinitions['target'] = $this->getTargetField();
418 $fieldRenderingDefinitions['rel'] = $this->getRelField();
419 if (empty($this->buttonConfig['queryParametersSelector.']['enabled'])) {
420 unset($fieldRenderingDefinitions['params']);
421 }
422 return $fieldRenderingDefinitions;
423 }
424
425 /**
426 * Add rel field
427 *
428 * @return string
429 */
430 protected function getRelField()
431 {
432 if (empty($this->buttonConfig['relAttribute.']['enabled'])) {
433 return '';
434 }
435 // @todo add rel to attributes
436 $currentRel = $this->displayedLinkHandler === $this->currentLinkHandler && !empty($this->currentLinkParts)
437 ? $this->linkAttributeValues['rel']
438 : '';
439 // @todo define label "linkRelationship" below in xlf
440 return '
441 <form action="" name="lrelform" id="lrelform" class="t3js-dummyform">
442 <table border="0" cellpadding="2" cellspacing="1" id="typo3-linkRel">
443 <tr>
444 <td><label>' . $this->getLanguageService()->getLL('linkRelationship', true) . ':</label></td>
445 <td colspan="3"><input type="text" name="lrel" value="' . $currentRel . '" /></td>
446 </tr>
447 </table>
448 </form>
449 ';
450 }
451
452 /**
453 * Add target selector
454 *
455 * @return string
456 */
457 protected function getTargetField()
458 {
459 $targetSelectorConfig = array();
460 if (is_array($this->buttonConfig['targetSelector.'])) {
461 $targetSelectorConfig = $this->buttonConfig['targetSelector.'];
462 }
463 $target = $this->linkAttributeValues['target'] ?: $this->defaultLinkTarget;
464 $lang = $this->getLanguageService();
465 $targetSelector = '';
466
467 if (!$targetSelectorConfig['disabled']) {
468 $targetSelector = '
469 <select name="ltarget_type" class="t3js-targetPreselect">
470 <option value=""></option>
471 <option value="_top">' . $lang->getLL('top', true) . '</option>
472 <option value="_blank">' . $lang->getLL('newWindow', true) . '</option>
473 </select>
474 ';
475 }
476
477 return '
478 <form action="" name="ltargetform" id="ltargetform" class="t3js-dummyform">
479 <table border="0" cellpadding="2" cellspacing="1" id="typo3-linkTarget">
480 <tr' . ($targetSelectorConfig['disabled'] ? ' style="display: none;"' : '') . '>
481 <td style="width: 96px;">' . $lang->getLL('target', true) . ':</td>
482 <td>
483 <input type="text" name="ltarget" class="t3js-linkTarget" value="' . htmlspecialchars($target) . '" />
484 ' . $targetSelector . '
485 </td>
486 </tr>
487 </table>
488 </form>
489 ';
490 }
491
492 /**
493 * Add title selector
494 *
495 * @return string
496 */
497 protected function getTitleField()
498 {
499 if ($this->linkAttributeValues['title']) {
500 $title = $this->linkAttributeValues['title'];
501 } else {
502 $title = !$this->classesAnchorDefault[$this->displayedLinkHandlerId] ? '' : $this->classesAnchorDefaultTitle[$this->displayedLinkHandlerId];
503 }
504 if (isset($this->buttonConfig[$this->displayedLinkHandlerId . '.']['properties.']['title.']['readOnly'])) {
505 $readOnly = (bool)$this->buttonConfig[$this->displayedLinkHandlerId . '.']['properties.']['title.']['readOnly'];
506 } else {
507 $readOnly = isset($this->buttonConfig['properties.']['title.']['readOnly'])
508 ? (bool)$this->buttonConfig['properties.']['title.']['readOnly']
509 : false;
510 }
511
512 if ($readOnly) {
513 $currentClass = $this->linkAttributeFields['class'];
514 if (!$currentClass) {
515 $currentClass = empty($this->classesAnchorDefault[$this->displayedLinkHandlerId]) ? '' : $this->classesAnchorDefault[$this->displayedLinkHandlerId];
516 }
517 $title = $currentClass
518 ? $this->classesAnchorClassTitle[$currentClass]
519 : $this->classesAnchorDefaultTitle[$this->displayedLinkHandlerId];
520 }
521 return '
522 <form action="" name="ltitleform" id="ltitleform" class="t3js-dummyform">
523 <table border="0" cellpadding="2" cellspacing="1" id="typo3-linkTitle">
524 <tr>
525 <td style="width: 96px;"><label for="rtehtmlarea-browse-links-anchor_title" id="rtehtmlarea-browse-links-title-label">' . $this->getLanguageService()->getLL('anchor_title', true) . '</label></td>
526 <td>
527 <span id="rtehtmlarea-browse-links-title-input" style="display: ' . ($readOnly ? 'none' : 'inline') . ';">
528 <input type="text" id="rtehtmlarea-browse-links-anchor_title" name="ltitle" value="' . htmlspecialchars($title) . '" />
529 </span>
530 <span id="rtehtmlarea-browse-links-title-readonly" style="display: ' . ($readOnly ? 'inline' : 'none') . ';">' . htmlspecialchars($title) . '</span>
531 </td>
532 </tr>
533 </table>
534 </form>
535 ';
536 }
537
538 /**
539 * Return html code for the class selector
540 *
541 * @return string the html code to be added to the form
542 */
543 protected function getClassField()
544 {
545 $selectClass = '';
546 if ($this->classesAnchorJSOptions[$this->displayedLinkHandlerId]) {
547 $selectClass = '
548 <form action="" name="lclassform" id="lclassform" class="t3js-dummyform">
549 <table border="0" cellpadding="2" cellspacing="1" id="typo3-linkClass">
550 <tr>
551 <td style="width: 96px;">' . $this->getLanguageService()->getLL('anchor_class', true) . '</td>
552 <td><select name="lclass" class="t3js-class-selector">
553 ' . $this->classesAnchorJSOptions[$this->displayedLinkHandlerId] . '
554 </select></td>
555 </tr>
556 </table>
557 </form>
558 ';
559 }
560 return $selectClass;
561 }
562
563 /**
564 * Return the ID of current page
565 *
566 * @return int
567 */
568 protected function getCurrentPageId()
569 {
570 return explode(':', $this->RTEtsConfigParams)[5];
571 }
572
573 /**
574 * Retrieve the configuration
575 *
576 * This is only used by RTE currently.
577 *
578 * @return array
579 */
580 public function getConfiguration()
581 {
582 return $this->buttonConfig;
583 }
584
585 /**
586 * Get attributes for the body tag
587 *
588 * @return string[] Array of body-tag attributes
589 */
590 protected function getBodyTagAttributes()
591 {
592 $parameters = parent::getBodyTagAttributes();
593 $parameters['data-site-url'] = $this->siteUrl;
594 return $parameters;
595 }
596
597 /**
598 * @param array $overrides
599 *
600 * @return array Array of parameters which have to be added to URLs
601 */
602 public function getUrlParameters(array $overrides = null)
603 {
604 return [
605 'act' => isset($overrides['act']) ? $overrides['act'] : $this->displayedLinkHandlerId,
606 'bparams' => $this->bparams,
607 'editorNo' => $this->editorNo,
608 'contentTypo3Language' => $this->contentTypo3Language
609 ];
610 }
611 }