vendor/contao/core-bundle/src/Resources/contao/classes/DataContainer.php line 1651

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Contao.
  5. *
  6. * (c) Leo Feyer
  7. *
  8. * @license LGPL-3.0-or-later
  9. */
  11. namespace Contao;
  13. use Contao\CoreBundle\Exception\AccessDeniedException;
  14. use Contao\CoreBundle\Exception\ResponseException;
  15. use Contao\CoreBundle\Picker\DcaPickerProviderInterface;
  16. use Contao\CoreBundle\Picker\PickerInterface;
  17. use Contao\CoreBundle\Security\ContaoCorePermissions;
  18. use Contao\Image\ResizeConfiguration;
  19. use Imagine\Gd\Imagine;
  20. use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
  22. /**
  23. * Provide methods to handle data container arrays.
  24. *
  25. * @property string|integer $id
  26. * @property string $table
  27. * @property mixed $value
  28. * @property string $field
  29. * @property string $inputName
  30. * @property string $palette
  31. * @property object|null $activeRecord
  32. * @property array $rootIds
  33. */
  34. abstract class DataContainer extends Backend
  35. {
  36. /**
  37. * Records are not sorted
  38. */
  39. public const MODE_UNSORTED = 0;
  41. /**
  42. * Records are sorted by a fixed field
  43. */
  44. public const MODE_SORTED = 1;
  46. /**
  47. * Records are sorted by a switchable field
  48. */
  49. public const MODE_SORTABLE = 2;
  51. /**
  52. * Records are sorted by the parent table
  53. */
  54. public const MODE_SORTED_PARENT = 3;
  56. /**
  57. * Displays the child records of a parent record (see content elements)
  58. */
  59. public const MODE_PARENT = 4;
  61. /**
  62. * Records are displayed as tree (see site structure)
  63. */
  64. public const MODE_TREE = 5;
  66. /**
  67. * Displays the child records within a tree structure (see articles module)
  68. */
  69. public const MODE_TREE_EXTENDED = 6;
  71. /**
  72. * Sort by initial letter ascending
  73. */
  74. public const SORT_INITIAL_LETTER_ASC = 1;
  76. /**
  77. * Sort by initial letter descending
  78. */
  79. public const SORT_INITIAL_LETTER_DESC = 2;
  81. /**
  82. * Sort by initial two letters ascending
  83. */
  84. public const SORT_INITIAL_LETTERS_ASC = 3;
  86. /**
  87. * Sort by initial two letters descending
  88. */
  89. public const SORT_INITIAL_LETTERS_DESC = 4;
  91. /**
  92. * Sort by day ascending
  93. */
  94. public const SORT_DAY_ASC = 5;
  96. /**
  97. * Sort by day descending
  98. */
  99. public const SORT_DAY_DESC = 6;
  101. /**
  102. * Sort by month ascending
  103. */
  104. public const SORT_MONTH_ASC = 7;
  106. /**
  107. * Sort by month descending
  108. */
  109. public const SORT_MONTH_DESC = 8;
  111. /**
  112. * Sort by year ascending
  113. */
  114. public const SORT_YEAR_ASC = 9;
  116. /**
  117. * Sort by year descending
  118. */
  119. public const SORT_YEAR_DESC = 10;
  121. /**
  122. * Sort ascending
  123. */
  124. public const SORT_ASC = 11;
  126. /**
  127. * Sort descending
  128. */
  129. public const SORT_DESC = 12;
  131. /**
  132. * Current ID
  133. * @var integer|string
  134. */
  135. protected $intId;
  137. /**
  138. * Name of the current table
  139. * @var string
  140. */
  141. protected $strTable;
  143. /**
  144. * Name of the current field
  145. * @var string
  146. */
  147. protected $strField;
  149. /**
  150. * Name attribute of the current input field
  151. * @var string
  152. */
  153. protected $strInputName;
  155. /**
  156. * Value of the current field
  157. * @var mixed
  158. */
  159. protected $varValue;
  161. /**
  162. * Name of the current palette
  163. * @var string
  164. */
  165. protected $strPalette;
  167. /**
  168. * IDs of all root records (permissions)
  169. * @var array
  170. */
  171. protected $root = array();
  173. /**
  174. * IDs of children of root records (permissions)
  175. * @var array
  176. */
  177. protected $rootChildren = array();
  179. /**
  180. * IDs of visible parents of the root records
  181. * @var array
  182. */
  183. protected $visibleRootTrails = array();
  185. /**
  186. * If pasting at root level is allowed (permissions)
  187. * @var bool
  188. */
  189. protected $rootPaste = false;
  191. /**
  192. * WHERE clause of the database query
  193. * @var array
  194. */
  195. protected $procedure = array();
  197. /**
  198. * Values for the WHERE clause of the database query
  199. * @var array
  200. */
  201. protected $values = array();
  203. /**
  204. * Form attribute "onsubmit"
  205. * @var array
  206. */
  207. protected $onsubmit = array();
  209. /**
  210. * Reload the page after the form has been submitted
  211. * @var boolean
  212. */
  213. protected $noReload = false;
  215. /**
  216. * Active record
  217. * @var Model|FilesModel
  218. */
  219. protected $objActiveRecord;
  221. /**
  222. * True if one of the form fields is uploadable
  223. * @var boolean
  224. */
  225. protected $blnUploadable = false;
  227. /**
  228. * DCA Picker instance
  229. * @var PickerInterface
  230. */
  231. protected $objPicker;
  233. /**
  234. * Callback to convert DCA value to picker value
  235. * @var callable
  236. */
  237. protected $objPickerCallback;
  239. /**
  240. * The picker value
  241. * @var array
  242. */
  243. protected $arrPickerValue = array();
  245. /**
  246. * The picker field type
  247. * @var string
  248. */
  249. protected $strPickerFieldType;
  251. /**
  252. * True if a new version has to be created
  253. * @var boolean
  254. */
  255. protected $blnCreateNewVersion = false;
  257. /**
  258. * Set an object property
  259. *
  260. * @param string $strKey
  261. * @param mixed $varValue
  262. */
  263. public function __set($strKey, $varValue)
  264. {
  265. switch ($strKey)
  266. {
  267. case 'activeRecord':
  268. $this->objActiveRecord = $varValue;
  269. break;
  271. case 'createNewVersion':
  272. $this->blnCreateNewVersion = (bool) $varValue;
  273. break;
  275. case 'id':
  276. $this->intId = $varValue;
  277. break;
  279. case 'field':
  280. $this->strField = $varValue;
  281. break;
  283. case 'inputName':
  284. $this->strInputName = $varValue;
  285. break;
  287. default:
  288. $this->$strKey = $varValue; // backwards compatibility
  289. break;
  290. }
  291. }
  293. /**
  294. * Return an object property
  295. *
  296. * @param string $strKey
  297. *
  298. * @return mixed
  299. */
  300. public function __get($strKey)
  301. {
  302. switch ($strKey)
  303. {
  304. case 'id':
  305. return $this->intId;
  307. case 'table':
  308. return $this->strTable;
  310. case 'value':
  311. return $this->varValue;
  313. case 'field':
  314. return $this->strField;
  316. case 'inputName':
  317. return $this->strInputName;
  319. case 'palette':
  320. return $this->strPalette;
  322. case 'activeRecord':
  323. return $this->objActiveRecord;
  325. case 'createNewVersion':
  326. return $this->blnCreateNewVersion;
  328. // Forward compatibility with Contao 5.0
  329. case 'currentPid':
  330. return ((int) (\defined('CURRENT_ID') ? CURRENT_ID : 0)) ?: null;
  331. }
  333. return parent::__get($strKey);
  334. }
  336. /**
  337. * Render a row of a box and return it as HTML string
  338. *
  339. * @param string|array|null $strPalette
  340. *
  341. * @return string
  342. *
  343. * @throws AccessDeniedException
  344. * @throws \Exception
  345. */
  346. protected function row($strPalette=null)
  347. {
  348. $arrData = $GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField] ?? array();
  350. // Check if the field is excluded
  351. if ($arrData['exclude'] ?? null)
  352. {
  353. throw new AccessDeniedException('Field "' . $this->strTable . '.' . $this->strField . '" is excluded from being edited.');
  354. }
  356. $xlabel = '';
  358. // Toggle line wrap (textarea)
  359. if (($arrData['inputType'] ?? null) == 'textarea' && !isset($arrData['eval']['rte']))
  360. {
  361. $xlabel .= ' ' . Image::getHtml('wrap.svg', $GLOBALS['TL_LANG']['MSC']['wordWrap'], 'title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['wordWrap']) . '" class="toggleWrap" onclick="Backend.toggleWrap(\'ctrl_' . $this->strInputName . '\')"');
  362. }
  364. // Add the help wizard
  365. if ($arrData['eval']['helpwizard'] ?? null)
  366. {
  367. $xlabel .= ' <a href="' . StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend_help', array('table' => $this->strTable, 'field' => $this->strField))) . '" title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['helpWizard']) . '" onclick="Backend.openModalIframe({\'title\':\'' . StringUtil::specialchars(str_replace("'", "\\'", $arrData['label'][0] ?? '')) . '\',\'url\':this.href});return false">' . Image::getHtml('about.svg', $GLOBALS['TL_LANG']['MSC']['helpWizard']) . '</a>';
  368. }
  370. // Add a custom xlabel
  371. if (\is_array($arrData['xlabel'] ?? null))
  372. {
  373. foreach ($arrData['xlabel'] as $callback)
  374. {
  375. if (\is_array($callback))
  376. {
  377. $this->import($callback[0]);
  378. $xlabel .= $this->{$callback[0]}->{$callback[1]}($this);
  379. }
  380. elseif (\is_callable($callback))
  381. {
  382. $xlabel .= $callback($this);
  383. }
  384. }
  385. }
  387. // Input field callback
  388. if (\is_array($arrData['input_field_callback'] ?? null))
  389. {
  390. $this->import($arrData['input_field_callback'][0]);
  392. return $this->{$arrData['input_field_callback'][0]}->{$arrData['input_field_callback'][1]}($this, $xlabel);
  393. }
  395. if (\is_callable($arrData['input_field_callback'] ?? null))
  396. {
  397. return $arrData['input_field_callback']($this, $xlabel);
  398. }
  400. $strClass = $GLOBALS['BE_FFL'][($arrData['inputType'] ?? null)] ?? null;
  402. // Return if the widget class does not exist
  403. if (!class_exists($strClass))
  404. {
  405. return '';
  406. }
  408. $arrData['eval']['required'] = false;
  410. if ($arrData['eval']['mandatory'] ?? null)
  411. {
  412. if (\is_array($this->varValue))
  413. {
  414. if (empty($this->varValue))
  415. {
  416. $arrData['eval']['required'] = true;
  417. }
  418. }
  419. elseif ('' === (string) $this->varValue)
  420. {
  421. $arrData['eval']['required'] = true;
  422. }
  423. }
  425. // Convert insert tags in src attributes (see #5965)
  426. if (isset($arrData['eval']['rte']) && strncmp($arrData['eval']['rte'], 'tiny', 4) === 0 && \is_string($this->varValue))
  427. {
  428. $this->varValue = StringUtil::insertTagToSrc($this->varValue);
  429. }
  431. // Use raw request if set globally but allow opting out setting useRawRequestData to false explicitly
  432. $useRawGlobally = isset($GLOBALS['TL_DCA'][$this->strTable]['config']['useRawRequestData']) && $GLOBALS['TL_DCA'][$this->strTable]['config']['useRawRequestData'] === true;
  433. $notRawForField = isset($arrData['eval']['useRawRequestData']) && $arrData['eval']['useRawRequestData'] === false;
  435. if ($useRawGlobally && !$notRawForField)
  436. {
  437. $arrData['eval']['useRawRequestData'] = true;
  438. }
  440. /** @var Widget $objWidget */
  441. $objWidget = new $strClass($strClass::getAttributesFromDca($arrData, $this->strInputName, $this->varValue, $this->strField, $this->strTable, $this));
  442. $objWidget->xlabel = $xlabel;
  443. $objWidget->currentRecord = $this->intId;
  445. // Validate the field
  446. if (Input::post('FORM_SUBMIT') == $this->strTable)
  447. {
  448. $suffix = $this->getFormFieldSuffix();
  449. $key = (Input::get('act') == 'editAll') ? 'FORM_FIELDS_' . $suffix : 'FORM_FIELDS';
  451. // Calculate the current palette
  452. $postPaletteFields = implode(',', Input::post($key));
  453. $postPaletteFields = array_unique(StringUtil::trimsplit('[,;]', $postPaletteFields));
  455. // Compile the palette if there is none
  456. if ($strPalette === null)
  457. {
  458. $newPaletteFields = StringUtil::trimsplit('[,;]', $this->getPalette());
  459. }
  460. else
  461. {
  462. // Use the given palette ($strPalette is an array in editAll mode)
  463. $newPaletteFields = \is_array($strPalette) ? $strPalette : StringUtil::trimsplit('[,;]', $strPalette);
  465. // Recompile the palette if the current field is a selector field and the value has changed
  466. if (isset($GLOBALS['TL_DCA'][$this->strTable]['palettes']['__selector__']) && $this->varValue != Input::post($this->strInputName) && \in_array($this->strField, $GLOBALS['TL_DCA'][$this->strTable]['palettes']['__selector__']))
  467. {
  468. $newPaletteFields = StringUtil::trimsplit('[,;]', $this->getPalette());
  469. }
  470. }
  472. // Adjust the names in editAll mode
  473. if (Input::get('act') == 'editAll')
  474. {
  475. foreach ($newPaletteFields as $k=>$v)
  476. {
  477. $newPaletteFields[$k] = $v . '_' . $suffix;
  478. }
  479. }
  481. $paletteFields = array_intersect($postPaletteFields, $newPaletteFields);
  483. // Deprecated since Contao 4.2, to be removed in Contao 5.0
  484. if (!isset($_POST[$this->strInputName]) && \in_array($this->strInputName, $paletteFields))
  485. {
  486. trigger_deprecation('contao/core-bundle', '4.2', 'Using $_POST[\'FORM_FIELDS\'] has been deprecated and will no longer work in Contao 5.0. Make sure to always submit at least an empty string in your widget.');
  487. }
  489. // Validate and save the field
  490. if ($objWidget->submitInput() && (\in_array($this->strInputName, $paletteFields) || Input::get('act') == 'overrideAll'))
  491. {
  492. $objWidget->validate();
  494. if ($objWidget->hasErrors())
  495. {
  496. // Skip mandatory fields on auto-submit (see #4077)
  497. if (!$objWidget->mandatory || $objWidget->value || Input::post('SUBMIT_TYPE') != 'auto')
  498. {
  499. $this->noReload = true;
  500. }
  501. }
  502. // The return value of submitInput() might have changed, therefore check it again here (see #2383)
  503. elseif ($objWidget->submitInput())
  504. {
  505. $varValue = $objWidget->value;
  507. // Sort array by key (fix for JavaScript wizards)
  508. if (\is_array($varValue))
  509. {
  510. ksort($varValue);
  511. $varValue = serialize($varValue);
  512. }
  514. // Convert file paths in src attributes (see #5965)
  515. if ($varValue && isset($arrData['eval']['rte']) && strncmp($arrData['eval']['rte'], 'tiny', 4) === 0)
  516. {
  517. $varValue = StringUtil::srcToInsertTag($varValue);
  518. }
  520. // Save the current value
  521. try
  522. {
  523. $this->save($varValue);
  525. // Confirm password changes
  526. if ($objWidget instanceof Password)
  527. {
  528. Message::addConfirmation($GLOBALS['TL_LANG']['MSC']['pw_changed']);
  529. }
  530. }
  531. catch (ResponseException $e)
  532. {
  533. throw $e;
  534. }
  535. catch (\Exception $e)
  536. {
  537. $this->noReload = true;
  538. $objWidget->addError($e->getMessage());
  539. }
  540. }
  541. }
  542. }
  544. $wizard = '';
  545. $strHelpClass = '';
  547. // Date picker
  548. if ($arrData['eval']['datepicker'] ?? null)
  549. {
  550. $rgxp = $arrData['eval']['rgxp'] ?? 'date';
  551. $format = Date::formatToJs(Config::get($rgxp . 'Format'));
  553. switch ($rgxp)
  554. {
  555. case 'datim':
  556. $time = ",\n timePicker: true";
  557. break;
  559. case 'time':
  560. $time = ",\n pickOnly: \"time\"";
  561. break;
  563. default:
  564. $time = '';
  565. break;
  566. }
  568. $strOnSelect = '';
  570. // Trigger the auto-submit function (see #8603)
  571. if ($arrData['eval']['submitOnChange'] ?? null)
  572. {
  573. $strOnSelect = ",\n onSelect: function() { Backend.autoSubmit(\"" . $this->strTable . "\"); }";
  574. }
  576. $wizard .= ' ' . Image::getHtml('assets/datepicker/images/icon.svg', '', 'title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['datepicker']) . '" id="toggle_' . $objWidget->id . '" style="cursor:pointer"') . '
  577. <script>
  578. window.addEvent("domready", function() {
  579. new Picker.Date($("ctrl_' . $objWidget->id . '"), {
  580. draggable: false,
  581. toggle: $("toggle_' . $objWidget->id . '"),
  582. format: "' . $format . '",
  583. positionOffset: {x:-211,y:-209}' . $time . ',
  584. pickerClass: "datepicker_bootstrap",
  585. useFadeInOut: !Browser.ie' . $strOnSelect . ',
  586. startDay: ' . $GLOBALS['TL_LANG']['MSC']['weekOffset'] . ',
  587. titleFormat: "' . $GLOBALS['TL_LANG']['MSC']['titleFormat'] . '"
  588. });
  589. });
  590. </script>';
  591. }
  593. // Color picker
  594. if ($arrData['eval']['colorpicker'] ?? null)
  595. {
  596. // Support single fields as well (see #5240)
  597. $strKey = ($arrData['eval']['multiple'] ?? null) ? $this->strField . '_0' : $this->strField;
  599. $wizard .= ' ' . Image::getHtml('pickcolor.svg', $GLOBALS['TL_LANG']['MSC']['colorpicker'], 'title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['colorpicker']) . '" id="moo_' . $this->strField . '" style="cursor:pointer"') . '
  600. <script>
  601. window.addEvent("domready", function() {
  602. var cl = $("ctrl_' . $strKey . '").value.hexToRgb(true) || [255, 0, 0];
  603. new MooRainbow("moo_' . $this->strField . '", {
  604. id: "ctrl_' . $strKey . '",
  605. startColor: cl,
  606. imgPath: "assets/colorpicker/images/",
  607. onComplete: function(color) {
  608. $("ctrl_' . $strKey . '").value = color.hex.replace("#", "");
  609. }
  610. });
  611. });
  612. </script>';
  613. }
  615. $arrClasses = StringUtil::trimsplit(' ', $arrData['eval']['tl_class'] ?? '');
  617. // DCA picker
  618. if (isset($arrData['eval']['dcaPicker']) && (\is_array($arrData['eval']['dcaPicker']) || $arrData['eval']['dcaPicker'] === true))
  619. {
  620. $arrClasses[] = 'dcapicker';
  621. $wizard .= Backend::getDcaPickerWizard($arrData['eval']['dcaPicker'], $this->strTable, $this->strField, $this->strInputName);
  622. }
  624. if (($arrData['inputType'] ?? null) == 'password')
  625. {
  626. $wizard .= Backend::getTogglePasswordWizard($this->strInputName);
  627. }
  629. // Add a custom wizard
  630. if (\is_array($arrData['wizard'] ?? null))
  631. {
  632. foreach ($arrData['wizard'] as $callback)
  633. {
  634. if (\is_array($callback))
  635. {
  636. $this->import($callback[0]);
  637. $wizard .= $this->{$callback[0]}->{$callback[1]}($this);
  638. }
  639. elseif (\is_callable($callback))
  640. {
  641. $wizard .= $callback($this);
  642. }
  643. }
  644. }
  646. $hasWizardClass = \in_array('wizard', $arrClasses);
  648. if ($wizard && !($arrData['eval']['disabled'] ?? false) && !($arrData['eval']['readonly'] ?? false))
  649. {
  650. $objWidget->wizard = $wizard;
  652. if (!$hasWizardClass)
  653. {
  654. $arrClasses[] = 'wizard';
  655. }
  656. }
  657. elseif ($hasWizardClass)
  658. {
  659. unset($arrClasses[array_search('wizard', $arrClasses)]);
  660. }
  662. // Set correct form enctype
  663. if ($objWidget instanceof UploadableWidgetInterface)
  664. {
  665. $this->blnUploadable = true;
  666. }
  668. $arrClasses[] = 'widget';
  670. // Mark floated single checkboxes
  671. if (($arrData['inputType'] ?? null) == 'checkbox' && !($arrData['eval']['multiple'] ?? null) && \in_array('w50', $arrClasses))
  672. {
  673. $arrClasses[] = 'cbx';
  674. }
  675. elseif (($arrData['inputType'] ?? null) == 'text' && ($arrData['eval']['multiple'] ?? null) && \in_array('wizard', $arrClasses))
  676. {
  677. $arrClasses[] = 'inline';
  678. }
  680. if (!empty($arrClasses))
  681. {
  682. $arrData['eval']['tl_class'] = implode(' ', array_unique($arrClasses));
  683. }
  685. $updateMode = '';
  687. // Replace the textarea with an RTE instance
  688. if (!empty($arrData['eval']['rte']))
  689. {
  690. list($file, $type) = explode('|', $arrData['eval']['rte'], 2) + array(null, null);
  692. $fileBrowserTypes = array();
  693. $pickerBuilder = System::getContainer()->get('contao.picker.builder');
  695. foreach (array('file' => 'image', 'link' => 'file') as $context => $fileBrowserType)
  696. {
  697. if ($pickerBuilder->supportsContext($context))
  698. {
  699. $fileBrowserTypes[] = $fileBrowserType;
  700. }
  701. }
  703. $objTemplate = new BackendTemplate('be_' . $file);
  704. $objTemplate->selector = 'ctrl_' . $this->strInputName;
  705. $objTemplate->type = $type;
  706. $objTemplate->fileBrowserTypes = $fileBrowserTypes;
  707. $objTemplate->source = $this->strTable . '.' . $this->intId;
  708. $objTemplate->readonly = (bool) ($arrData['eval']['readonly'] ?? false);
  710. // Deprecated since Contao 4.0, to be removed in Contao 5.0
  711. $objTemplate->language = Backend::getTinyMceLanguage();
  713. $updateMode = $objTemplate->parse();
  715. unset($file, $type, $pickerBuilder, $fileBrowserTypes, $fileBrowserType);
  716. }
  718. // Handle multi-select fields in "override all" mode
  719. elseif ((($arrData['inputType'] ?? null) == 'checkbox' || ($arrData['inputType'] ?? null) == 'checkboxWizard') && ($arrData['eval']['multiple'] ?? null) && Input::get('act') == 'overrideAll')
  720. {
  721. $updateMode = '
  722. </div>
  723. <div class="widget">
  724. <fieldset class="tl_radio_container">
  725. <legend>' . $GLOBALS['TL_LANG']['MSC']['updateMode'] . '</legend>
  726. <input type="radio" name="' . $this->strInputName . '_update" id="opt_' . $this->strInputName . '_update_1" class="tl_radio" value="add" onfocus="Backend.getScrollOffset()"> <label for="opt_' . $this->strInputName . '_update_1">' . $GLOBALS['TL_LANG']['MSC']['updateAdd'] . '</label><br>
  727. <input type="radio" name="' . $this->strInputName . '_update" id="opt_' . $this->strInputName . '_update_2" class="tl_radio" value="remove" onfocus="Backend.getScrollOffset()"> <label for="opt_' . $this->strInputName . '_update_2">' . $GLOBALS['TL_LANG']['MSC']['updateRemove'] . '</label><br>
  728. <input type="radio" name="' . $this->strInputName . '_update" id="opt_' . $this->strInputName . '_update_0" class="tl_radio" value="replace" checked="checked" onfocus="Backend.getScrollOffset()"> <label for="opt_' . $this->strInputName . '_update_0">' . $GLOBALS['TL_LANG']['MSC']['updateReplace'] . '</label>
  729. </fieldset>';
  730. }
  732. $strPreview = '';
  734. // Show a preview image (see #4948)
  735. if ($this->strTable == 'tl_files' && $this->strField == 'name' && $this->objActiveRecord !== null && $this->objActiveRecord->type == 'file')
  736. {
  737. $objFile = new File($this->objActiveRecord->path);
  739. if ($objFile->isImage)
  740. {
  741. $blnCanResize = true;
  743. if ($objFile->isSvgImage)
  744. {
  745. // SVG images with undefined sizes cannot be resized
  746. if (!$objFile->viewWidth || !$objFile->viewHeight)
  747. {
  748. $blnCanResize= false;
  749. }
  750. }
  751. elseif (System::getContainer()->get('contao.image.imagine') instanceof Imagine)
  752. {
  753. // Check the maximum width and height if the GDlib is used to resize images
  754. if ($objFile->height > Config::get('gdMaxImgHeight') || $objFile->width > Config::get('gdMaxImgWidth'))
  755. {
  756. $blnCanResize = false;
  757. }
  758. }
  760. if ($blnCanResize)
  761. {
  762. $container = System::getContainer();
  763. $projectDir = $container->getParameter('kernel.project_dir');
  765. try
  766. {
  767. $image = rawurldecode($container->get('contao.image.factory')->create($projectDir . '/' . $objFile->path, array(699, 524, ResizeConfiguration::MODE_BOX))->getUrl($projectDir));
  768. }
  769. catch (\Exception $e)
  770. {
  771. Message::addError($e->getMessage());
  772. $image = Image::getPath('placeholder.svg');
  773. }
  774. }
  775. else
  776. {
  777. $image = Image::getPath('placeholder.svg');
  778. }
  780. $objImage = new File($image);
  781. $ctrl = 'ctrl_preview_' . substr(md5($image), 0, 8);
  783. $strPreview = '
  784. <div id="' . $ctrl . '" class="tl_edit_preview">
  785. <img src="' . $objImage->dataUri . '" width="' . $objImage->width . '" height="' . $objImage->height . '" alt="">
  786. </div>';
  788. // Add the script to mark the important part
  789. if (basename($image) !== 'placeholder.svg')
  790. {
  791. $strPreview .= '<script>Backend.editPreviewWizard($(\'' . $ctrl . '\'));</script>';
  793. if (Config::get('showHelp'))
  794. {
  795. $strPreview .= '<p class="tl_help tl_tip">' . $GLOBALS['TL_LANG'][$this->strTable]['edit_preview_help'] . '</p>';
  796. }
  798. $strPreview = '<div class="widget">' . $strPreview . '</div>';
  799. }
  800. }
  801. }
  803. return $strPreview . '
  804. <div' . (!empty($arrData['eval']['tl_class']) ? ' class="' . trim($arrData['eval']['tl_class']) . '"' : '') . '>' . $objWidget->parse() . $updateMode . (!$objWidget->hasErrors() ? $this->help($strHelpClass) : '') . '
  805. </div>';
  806. }
  808. /**
  809. * Return the field explanation as HTML string
  810. *
  811. * @param string $strClass
  812. *
  813. * @return string
  814. */
  815. public function help($strClass='')
  816. {
  817. $return = $GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField]['label'][1] ?? null;
  819. if (!$return || ($GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField]['inputType'] ?? null) == 'password' || !Config::get('showHelp'))
  820. {
  821. return '';
  822. }
  824. return '
  825. <p class="tl_help tl_tip' . $strClass . '">' . $return . '</p>';
  826. }
  828. /**
  829. * Generate possible palette names from an array by taking the first value and either adding or not adding the following values
  830. *
  831. * @param array $names
  832. *
  833. * @return array
  834. */
  835. protected function combiner($names)
  836. {
  837. $return = array('');
  838. $names = array_values($names);
  840. for ($i=0, $c=\count($names); $i<$c; $i++)
  841. {
  842. $buffer = array();
  844. foreach ($return as $k=>$v)
  845. {
  846. $buffer[] = ($k%2 == 0) ? $v : $v . $names[$i];
  847. $buffer[] = ($k%2 == 0) ? $v . $names[$i] : $v;
  848. }
  850. $return = $buffer;
  851. }
  853. return array_filter($return);
  854. }
  856. /**
  857. * Return a query string that switches into edit mode
  858. *
  859. * @param integer $id
  860. *
  861. * @return string
  862. */
  863. protected function switchToEdit($id)
  864. {
  865. $arrKeys = array();
  866. $arrUnset = array('act', 'key', 'id', 'table', 'mode', 'pid');
  868. foreach (array_keys($_GET) as $strKey)
  869. {
  870. if (!\in_array($strKey, $arrUnset))
  871. {
  872. $arrKeys[$strKey] = $strKey . '=' . Input::get($strKey);
  873. }
  874. }
  876. $strUrl = TL_SCRIPT . '?' . implode('&', $arrKeys);
  878. return $strUrl . (!empty($arrKeys) ? '&' : '') . (Input::get('table') ? 'table=' . Input::get('table') . '&amp;' : '') . 'act=edit&amp;id=' . rawurlencode($id);
  879. }
  881. /**
  882. * Compile buttons from the table configuration array and return them as HTML
  883. *
  884. * @param array $arrRow
  885. * @param string $strTable
  886. * @param array $arrRootIds
  887. * @param boolean $blnCircularReference
  888. * @param array $arrChildRecordIds
  889. * @param string $strPrevious
  890. * @param string $strNext
  891. *
  892. * @return string
  893. */
  894. protected function generateButtons($arrRow, $strTable, $arrRootIds=array(), $blnCircularReference=false, $arrChildRecordIds=null, $strPrevious=null, $strNext=null)
  895. {
  896. if (!\is_array($GLOBALS['TL_DCA'][$strTable]['list']['operations'] ?? null))
  897. {
  898. return '';
  899. }
  901. $return = '';
  903. foreach ($GLOBALS['TL_DCA'][$strTable]['list']['operations'] as $k=>$v)
  904. {
  905. $v = \is_array($v) ? $v : array($v);
  906. $id = StringUtil::specialchars(rawurldecode($arrRow['id']));
  907. $label = $title = $k;
  909. if (isset($v['label']))
  910. {
  911. if (\is_array($v['label']))
  912. {
  913. $label = $v['label'][0] ?? null;
  914. $title = sprintf($v['label'][1] ?? '', $id);
  915. }
  916. else
  917. {
  918. $label = $title = sprintf($v['label'], $id);
  919. }
  920. }
  922. $attributes = !empty($v['attributes']) ? ' ' . ltrim(sprintf($v['attributes'], $id, $id)) : '';
  924. // Add the key as CSS class
  925. if (strpos($attributes, 'class="') !== false)
  926. {
  927. $attributes = str_replace('class="', 'class="' . $k . ' ', $attributes);
  928. }
  929. else
  930. {
  931. $attributes = ' class="' . $k . '"' . $attributes;
  932. }
  934. // Call a custom function instead of using the default button
  935. if (\is_array($v['button_callback'] ?? null))
  936. {
  937. $this->import($v['button_callback'][0]);
  938. $return .= $this->{$v['button_callback'][0]}->{$v['button_callback'][1]}($arrRow, $v['href'] ?? null, $label, $title, $v['icon'] ?? null, $attributes, $strTable, $arrRootIds, $arrChildRecordIds, $blnCircularReference, $strPrevious, $strNext, $this);
  939. continue;
  940. }
  942. if (\is_callable($v['button_callback'] ?? null))
  943. {
  944. $return .= $v['button_callback']($arrRow, $v['href'] ?? null, $label, $title, $v['icon'] ?? null, $attributes, $strTable, $arrRootIds, $arrChildRecordIds, $blnCircularReference, $strPrevious, $strNext, $this);
  945. continue;
  946. }
  948. // Generate all buttons except "move up" and "move down" buttons
  949. if ($k != 'move' && $v != 'move')
  950. {
  951. if ($k == 'show')
  952. {
  953. if (!empty($v['route']))
  954. {
  955. $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id'], 'popup' => '1'));
  956. }
  957. else
  958. {
  959. $href = $this->addToUrl(($v['href'] ?? '') . '&amp;id=' . $arrRow['id'] . '&amp;popup=1');
  960. }
  962. $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '" onclick="Backend.openModalIframe({\'title\':\'' . StringUtil::specialchars(str_replace("'", "\\'", $label)) . '\',\'url\':this.href});return false"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  963. }
  964. else
  965. {
  966. if (!empty($v['route']))
  967. {
  968. $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id']));
  969. }
  970. else
  971. {
  972. $href = $this->addToUrl(($v['href'] ?? '') . '&amp;id=' . $arrRow['id'] . (Input::get('nb') ? '&amp;nc=1' : ''));
  973. }
  975. parse_str(StringUtil::decodeEntities($v['href'] ?? ''), $params);
  977. if (($params['act'] ?? null) == 'toggle' && isset($params['field']))
  978. {
  979. // Hide the toggle icon if the user does not have access to the field
  980. if (($GLOBALS['TL_DCA'][$strTable]['fields'][$params['field']]['toggle'] ?? false) !== true || (($GLOBALS['TL_DCA'][$strTable]['fields'][$params['field']]['exclude'] ?? false) && !System::getContainer()->get('security.helper')->isGranted(ContaoCorePermissions::USER_CAN_EDIT_FIELD_OF_TABLE, $strTable . '::' . $params['field'])))
  981. {
  982. continue;
  983. }
  985. $icon = $v['icon'];
  986. $_icon = pathinfo($v['icon'], PATHINFO_FILENAME) . '_.' . pathinfo($v['icon'], PATHINFO_EXTENSION);
  988. if (false !== strpos($v['icon'], '/'))
  989. {
  990. $_icon = \dirname($v['icon']) . '/' . $_icon;
  991. }
  993. if ($icon == 'visible.svg')
  994. {
  995. $_icon = 'invisible.svg';
  996. }
  998. $state = $arrRow[$params['field']] ? 1 : 0;
  1000. if ($v['reverse'] ?? false)
  1001. {
  1002. $state = $arrRow[$params['field']] ? 0 : 1;
  1003. }
  1005. $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '" onclick="Backend.getScrollOffset();return AjaxRequest.toggleField(this,' . ($icon == 'visible.svg' ? 'true' : 'false') . ')">' . Image::getHtml($state ? $icon : $_icon, $label, 'data-icon="' . Image::getPath($icon) . '" data-icon-disabled="' . Image::getPath($_icon) . '" data-state="' . $state . '"') . '</a> ';
  1006. }
  1007. else
  1008. {
  1009. $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  1010. }
  1011. }
  1013. continue;
  1014. }
  1016. trigger_deprecation('contao/core-bundle', '4.13', 'The DCA "move" operation is deprecated and will be removed in Contao 5.');
  1018. $arrDirections = array('up', 'down');
  1019. $arrRootIds = \is_array($arrRootIds) ? $arrRootIds : array($arrRootIds);
  1021. foreach ($arrDirections as $dir)
  1022. {
  1023. $label = !empty($GLOBALS['TL_LANG'][$strTable][$dir][0]) ? $GLOBALS['TL_LANG'][$strTable][$dir][0] : $dir;
  1024. $title = !empty($GLOBALS['TL_LANG'][$strTable][$dir][1]) ? $GLOBALS['TL_LANG'][$strTable][$dir][1] : $dir;
  1026. $label = Image::getHtml($dir . '.svg', $label);
  1027. $href = !empty($v['href']) ? $v['href'] : '&amp;act=move';
  1029. if ($dir == 'up')
  1030. {
  1031. $return .= ((is_numeric($strPrevious) && (empty($GLOBALS['TL_DCA'][$strTable]['list']['sorting']['root']) || !\in_array($arrRow['id'], $arrRootIds))) ? '<a href="' . $this->addToUrl($href . '&amp;id=' . $arrRow['id']) . '&amp;sid=' . (int) $strPrevious . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . $label . '</a> ' : Image::getHtml('up_.svg')) . ' ';
  1032. }
  1033. else
  1034. {
  1035. $return .= ((is_numeric($strNext) && (empty($GLOBALS['TL_DCA'][$strTable]['list']['sorting']['root']) || !\in_array($arrRow['id'], $arrRootIds))) ? '<a href="' . $this->addToUrl($href . '&amp;id=' . $arrRow['id']) . '&amp;sid=' . (int) $strNext . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . $label . '</a> ' : Image::getHtml('down_.svg')) . ' ';
  1036. }
  1037. }
  1038. }
  1040. return trim($return);
  1041. }
  1043. /**
  1044. * Compile global buttons from the table configuration array and return them as HTML
  1045. *
  1046. * @return string
  1047. */
  1048. protected function generateGlobalButtons()
  1049. {
  1050. if (!\is_array($GLOBALS['TL_DCA'][$this->strTable]['list']['global_operations'] ?? null))
  1051. {
  1052. return '';
  1053. }
  1055. $return = '';
  1057. foreach ($GLOBALS['TL_DCA'][$this->strTable]['list']['global_operations'] as $k=>$v)
  1058. {
  1059. if (!($v['showOnSelect'] ?? null) && Input::get('act') == 'select')
  1060. {
  1061. continue;
  1062. }
  1064. $v = \is_array($v) ? $v : array($v);
  1065. $title = $label = $k;
  1067. if (isset($v['label']))
  1068. {
  1069. $label = \is_array($v['label']) ? $v['label'][0] : $v['label'];
  1070. $title = \is_array($v['label']) ? ($v['label'][1] ?? null) : $v['label'];
  1071. }
  1073. $attributes = !empty($v['attributes']) ? ' ' . ltrim($v['attributes']) : '';
  1075. // Custom icon (see #5541)
  1076. if ($v['icon'] ?? null)
  1077. {
  1078. $v['class'] = trim(($v['class'] ?? '') . ' header_icon');
  1080. // Add the theme path if only the file name is given
  1081. if (strpos($v['icon'], '/') === false)
  1082. {
  1083. $v['icon'] = Image::getPath($v['icon']);
  1084. }
  1086. $attributes = sprintf(' style="background-image:url(\'%s\')"', Controller::addAssetsUrlTo($v['icon'])) . $attributes;
  1087. }
  1089. if (!$label)
  1090. {
  1091. $label = $k;
  1092. }
  1094. if (!$title)
  1095. {
  1096. $title = $label;
  1097. }
  1099. // Call a custom function instead of using the default button
  1100. if (\is_array($v['button_callback'] ?? null))
  1101. {
  1102. $this->import($v['button_callback'][0]);
  1103. $return .= $this->{$v['button_callback'][0]}->{$v['button_callback'][1]}($v['href'] ?? null, $label, $title, $v['class'] ?? null, $attributes, $this->strTable, $this->root);
  1104. continue;
  1105. }
  1107. if (\is_callable($v['button_callback'] ?? null))
  1108. {
  1109. $return .= $v['button_callback']($v['href'] ?? null, $label, $title, $v['class'] ?? null, $attributes, $this->strTable, $this->root);
  1110. continue;
  1111. }
  1113. if (!empty($v['route']))
  1114. {
  1115. $href = System::getContainer()->get('router')->generate($v['route']);
  1116. }
  1117. else
  1118. {
  1119. $href = $this->addToUrl($v['href'] ?? '');
  1120. }
  1122. $return .= '<a href="' . $href . '"' . (isset($v['class']) ? ' class="' . $v['class'] . '"' : '') . ' title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . $label . '</a> ';
  1123. }
  1125. return $return;
  1126. }
  1128. /**
  1129. * Compile header buttons from the table configuration array and return them as HTML
  1130. *
  1131. * @param array $arrRow
  1132. * @param string $strPtable
  1133. *
  1134. * @return string
  1135. */
  1136. protected function generateHeaderButtons($arrRow, $strPtable)
  1137. {
  1138. if (!\is_array($GLOBALS['TL_DCA'][$strPtable]['list']['operations'] ?? null))
  1139. {
  1140. return '';
  1141. }
  1143. $return = '';
  1145. foreach ($GLOBALS['TL_DCA'][$strPtable]['list']['operations'] as $k=> $v)
  1146. {
  1147. if (empty($v['showInHeader']) || (Input::get('act') == 'select' && !($v['showOnSelect'] ?? null)))
  1148. {
  1149. continue;
  1150. }
  1152. $v = \is_array($v) ? $v : array($v);
  1153. $id = StringUtil::specialchars(rawurldecode($arrRow['id']));
  1154. $label = $title = $k;
  1156. if (isset($v['label']))
  1157. {
  1158. if (\is_array($v['label']))
  1159. {
  1160. $label = $v['label'][0];
  1161. $title = sprintf($v['label'][1], $id);
  1162. }
  1163. else
  1164. {
  1165. $label = $title = sprintf($v['label'], $id);
  1166. }
  1167. }
  1169. $attributes = !empty($v['attributes']) ? ' ' . ltrim(sprintf($v['attributes'], $id, $id)) : '';
  1171. // Add the key as CSS class
  1172. if (strpos($attributes, 'class="') !== false)
  1173. {
  1174. $attributes = str_replace('class="', 'class="' . $k . ' ', $attributes);
  1175. }
  1176. else
  1177. {
  1178. $attributes = ' class="' . $k . '"' . $attributes;
  1179. }
  1181. // Add the parent table to the href
  1182. if (isset($v['href']))
  1183. {
  1184. $v['href'] .= '&amp;table=' . $strPtable;
  1185. }
  1186. else
  1187. {
  1188. $v['href'] = 'table=' . $strPtable;
  1189. }
  1191. // Call a custom function instead of using the default button
  1192. if (\is_array($v['button_callback'] ?? null))
  1193. {
  1194. $this->import($v['button_callback'][0]);
  1195. $return .= $this->{$v['button_callback'][0]}->{$v['button_callback'][1]}($arrRow, $v['href'], $label, $title, $v['icon'], $attributes, $strPtable, array(), null, false, null, null, $this);
  1196. continue;
  1197. }
  1199. if (\is_callable($v['button_callback'] ?? null))
  1200. {
  1201. $return .= $v['button_callback']($arrRow, $v['href'], $label, $title, $v['icon'], $attributes, $strPtable, array(), null, false, null, null, $this);
  1202. continue;
  1203. }
  1205. if ($k == 'show')
  1206. {
  1207. if (!empty($v['route']))
  1208. {
  1209. $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id'], 'popup' => '1'));
  1210. }
  1211. else
  1212. {
  1213. $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . '&amp;popup=1');
  1214. }
  1216. $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '" onclick="Backend.openModalIframe({\'title\':\'' . StringUtil::specialchars(str_replace("'", "\\'", sprintf(\is_array($GLOBALS['TL_LANG'][$strPtable]['show'] ?? null) ? $GLOBALS['TL_LANG'][$strPtable]['show'][1] : ($GLOBALS['TL_LANG'][$strPtable]['show'] ?? ''), $arrRow['id']))) . '\',\'url\':this.href});return false"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  1217. }
  1218. else
  1219. {
  1220. if (!empty($v['route']))
  1221. {
  1222. $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id']));
  1223. }
  1224. else
  1225. {
  1226. $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . (Input::get('nb') ? '&amp;nc=1' : ''));
  1227. }
  1229. parse_str(StringUtil::decodeEntities($v['href']), $params);
  1231. if (($params['act'] ?? null) == 'toggle' && isset($params['field']))
  1232. {
  1233. // Hide the toggle icon if the user does not have access to the field
  1234. if (($GLOBALS['TL_DCA'][$strPtable]['fields'][$params['field']]['toggle'] ?? false) !== true || (($GLOBALS['TL_DCA'][$strPtable]['fields'][$params['field']]['exclude'] ?? false) && !System::getContainer()->get('security.helper')->isGranted(ContaoCorePermissions::USER_CAN_EDIT_FIELD_OF_TABLE, $strPtable . '::' . $params['field'])))
  1235. {
  1236. continue;
  1237. }
  1239. $icon = $v['icon'];
  1240. $_icon = pathinfo($v['icon'], PATHINFO_FILENAME) . '_.' . pathinfo($v['icon'], PATHINFO_EXTENSION);
  1242. if (false !== strpos($v['icon'], '/'))
  1243. {
  1244. $_icon = \dirname($v['icon']) . '/' . $_icon;
  1245. }
  1247. if ($icon == 'visible.svg')
  1248. {
  1249. $_icon = 'invisible.svg';
  1250. }
  1252. $state = $arrRow[$params['field']] ? 1 : 0;
  1254. if ($v['reverse'] ?? false)
  1255. {
  1256. $state = $arrRow[$params['field']] ? 0 : 1;
  1257. }
  1259. $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '" onclick="Backend.getScrollOffset();return AjaxRequest.toggleField(this)">' . Image::getHtml($state ? $icon : $_icon, $label, 'data-icon="' . Image::getPath($icon) . '" data-icon-disabled="' . Image::getPath($_icon) . '" data-state="' . $state . '"') . '</a> ';
  1260. }
  1261. else
  1262. {
  1263. $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  1264. }
  1265. }
  1266. }
  1268. return $return;
  1269. }
  1271. /**
  1272. * Initialize the picker
  1273. *
  1274. * @param PickerInterface $picker
  1275. *
  1276. * @return array|null
  1277. */
  1278. public function initPicker(PickerInterface $picker)
  1279. {
  1280. $provider = $picker->getCurrentProvider();
  1282. if (!$provider instanceof DcaPickerProviderInterface || $provider->getDcaTable($picker->getConfig()) != $this->strTable)
  1283. {
  1284. return null;
  1285. }
  1287. $attributes = $provider->getDcaAttributes($picker->getConfig());
  1289. $this->objPicker = $picker;
  1290. $this->strPickerFieldType = $attributes['fieldType'];
  1292. $this->objPickerCallback = static function ($value) use ($picker, $provider)
  1293. {
  1294. return $provider->convertDcaValue($picker->getConfig(), $value);
  1295. };
  1297. if (isset($attributes['value']))
  1298. {
  1299. $this->arrPickerValue = (array) $attributes['value'];
  1300. }
  1302. return $attributes;
  1303. }
  1305. /**
  1306. * Return the picker input field markup
  1307. *
  1308. * @param string $value
  1309. * @param string $attributes
  1310. *
  1311. * @return string
  1312. */
  1313. protected function getPickerInputField($value, $attributes='')
  1314. {
  1315. $id = is_numeric($value) ? $value : md5($value);
  1317. switch ($this->strPickerFieldType)
  1318. {
  1319. case 'checkbox':
  1320. return ' <input type="checkbox" name="picker[]" id="picker_' . $id . '" class="tl_tree_checkbox" value="' . StringUtil::specialchars(($this->objPickerCallback)($value)) . '" onfocus="Backend.getScrollOffset()"' . Widget::optionChecked($value, $this->arrPickerValue) . $attributes . '>';
  1322. case 'radio':
  1323. return ' <input type="radio" name="picker" id="picker_' . $id . '" class="tl_tree_radio" value="' . StringUtil::specialchars(($this->objPickerCallback)($value)) . '" onfocus="Backend.getScrollOffset()"' . Widget::optionChecked($value, $this->arrPickerValue) . $attributes . '>';
  1324. }
  1326. return '';
  1327. }
  1329. /**
  1330. * Return the data-picker-value attribute with the currently selected picker values (see #1816)
  1331. *
  1332. * @return string
  1333. */
  1334. protected function getPickerValueAttribute()
  1335. {
  1336. // Only load the previously selected values for the checkbox field type (see #2346)
  1337. if ($this->strPickerFieldType != 'checkbox')
  1338. {
  1339. return '';
  1340. }
  1342. $values = array_map($this->objPickerCallback, $this->arrPickerValue);
  1343. $values = array_map('strval', $values);
  1344. $values = json_encode($values);
  1345. $values = htmlspecialchars($values, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML5);
  1347. return ' data-picker-value="' . $values . '"';
  1348. }
  1350. /**
  1351. * Build the sort panel and return it as string
  1352. *
  1353. * @return string
  1354. */
  1355. protected function panel()
  1356. {
  1357. if (!($GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panelLayout'] ?? null))
  1358. {
  1359. return '';
  1360. }
  1362. // Reset all filters
  1363. if (isset($_POST['filter_reset']) && Input::post('FORM_SUBMIT') == 'tl_filters')
  1364. {
  1365. /** @var AttributeBagInterface $objSessionBag */
  1366. $objSessionBag = System::getContainer()->get('session')->getBag('contao_backend');
  1367. $data = $objSessionBag->all();
  1369. unset(
  1370. $data['filter'][$this->strTable],
  1371. $data['filter'][$this->strTable . '_' . CURRENT_ID],
  1372. $data['sorting'][$this->strTable],
  1373. $data['search'][$this->strTable]
  1374. );
  1376. $objSessionBag->replace($data);
  1378. $this->reload();
  1379. }
  1381. $intFilterPanel = 0;
  1382. $arrPanels = array();
  1383. $arrPanes = StringUtil::trimsplit(';', $GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panelLayout'] ?? '');
  1385. foreach ($arrPanes as $strPanel)
  1386. {
  1387. $panels = '';
  1388. $arrSubPanels = StringUtil::trimsplit(',', $strPanel);
  1390. foreach ($arrSubPanels as $strSubPanel)
  1391. {
  1392. $panel = '';
  1394. switch ($strSubPanel)
  1395. {
  1396. case 'limit':
  1397. // The limit menu depends on other panels that may set a filter query, e.g. search and filter.
  1398. // In order to correctly calculate the total row count, the limit menu must be compiled last.
  1399. // We insert a placeholder here and compile the limit menu after all other panels.
  1400. $panel = '###limit_menu###';
  1401. break;
  1403. case 'search':
  1404. $panel = $this->searchMenu();
  1405. break;
  1407. case 'sort':
  1408. $panel = $this->sortMenu();
  1409. break;
  1411. case 'filter':
  1412. // Multiple filter subpanels can be defined to split the fields across panels
  1413. $panel = $this->filterMenu(++$intFilterPanel);
  1414. break;
  1416. default:
  1417. // Call the panel_callback
  1418. $arrCallback = $GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panel_callback'][$strSubPanel] ?? null;
  1420. if (\is_array($arrCallback))
  1421. {
  1422. $this->import($arrCallback[0]);
  1423. $panel = $this->{$arrCallback[0]}->{$arrCallback[1]}($this);
  1424. }
  1425. elseif (\is_callable($arrCallback))
  1426. {
  1427. $panel = $arrCallback($this);
  1428. }
  1429. }
  1431. // Add the panel if it is not empty
  1432. if ($panel)
  1433. {
  1434. $panels = $panel . $panels;
  1435. }
  1436. }
  1438. // Add the group if it is not empty
  1439. if ($panels)
  1440. {
  1441. $arrPanels[] = $panels;
  1442. }
  1443. }
  1445. if (empty($arrPanels))
  1446. {
  1447. return '';
  1448. }
  1450. // Compile limit menu if placeholder is present
  1451. foreach ($arrPanels as $key => $strPanel)
  1452. {
  1453. if (strpos($strPanel, '###limit_menu###') === false)
  1454. {
  1455. continue;
  1456. }
  1458. $arrPanels[$key] = str_replace('###limit_menu###', $this->limitMenu(), $strPanel);
  1459. }
  1461. if (Input::post('FORM_SUBMIT') == 'tl_filters')
  1462. {
  1463. $this->reload();
  1464. }
  1466. $return = '';
  1467. $intTotal = \count($arrPanels);
  1468. $intLast = $intTotal - 1;
  1470. for ($i=0; $i<$intTotal; $i++)
  1471. {
  1472. $submit = '';
  1474. if ($i == $intLast)
  1475. {
  1476. $submit = '
  1477. <div class="tl_submit_panel tl_subpanel">
  1478. <button name="filter" id="filter" class="tl_img_submit filter_apply" title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['applyTitle']) . '">' . $GLOBALS['TL_LANG']['MSC']['apply'] . '</button>
  1479. <button name="filter_reset" id="filter_reset" value="1" class="tl_img_submit filter_reset" title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['resetTitle']) . '">' . $GLOBALS['TL_LANG']['MSC']['reset'] . '</button>
  1480. </div>';
  1481. }
  1483. $return .= '
  1484. <div class="tl_panel cf">
  1485. ' . $submit . $arrPanels[$i] . '
  1486. </div>';
  1487. }
  1489. $return = '
  1490. <form class="tl_form" method="post" aria-label="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['searchAndFilter']) . '">
  1491. <div class="tl_formbody">
  1492. <input type="hidden" name="FORM_SUBMIT" value="tl_filters">
  1493. <input type="hidden" name="REQUEST_TOKEN" value="' . REQUEST_TOKEN . '">
  1494. ' . $return . '
  1495. </div>
  1496. </form>';
  1498. return $return;
  1499. }
  1501. /**
  1502. * Invalidate the cache tags associated with a given DC
  1503. *
  1504. * Call this whenever an entry is modified (added, updated, deleted).
  1505. */
  1506. public function invalidateCacheTags()
  1507. {
  1508. if (!System::getContainer()->has('fos_http_cache.cache_manager'))
  1509. {
  1510. return;
  1511. }
  1513. $tags = array('contao.db.' . $this->table . '.' . $this->id);
  1515. $this->addPtableTags($this->table, $this->id, $tags);
  1517. // Trigger the oninvalidate_cache_tags_callback
  1518. if (\is_array($GLOBALS['TL_DCA'][$this->table]['config']['oninvalidate_cache_tags_callback'] ?? null))
  1519. {
  1520. foreach ($GLOBALS['TL_DCA'][$this->table]['config']['oninvalidate_cache_tags_callback'] as $callback)
  1521. {
  1522. if (\is_array($callback))
  1523. {
  1524. $this->import($callback[0]);
  1525. $tags = $this->{$callback[0]}->{$callback[1]}($this, $tags);
  1526. }
  1527. elseif (\is_callable($callback))
  1528. {
  1529. $tags = $callback($this, $tags);
  1530. }
  1531. }
  1532. }
  1534. // Make sure tags are unique and empty ones are removed
  1535. $tags = array_filter(array_unique($tags));
  1537. System::getContainer()->get('fos_http_cache.cache_manager')->invalidateTags($tags);
  1538. }
  1540. public function addPtableTags($strTable, $intId, &$tags)
  1541. {
  1542. $ptable = $GLOBALS['TL_DCA'][$strTable]['list']['sorting']['mode'] == 5 ? $strTable : ($GLOBALS['TL_DCA'][$strTable]['config']['ptable'] ?? null);
  1544. if (!$ptable)
  1545. {
  1546. $tags[] = 'contao.db.' . $strTable;
  1548. return;
  1549. }
  1551. Controller::loadDataContainer($ptable);
  1553. $objPid = $this->Database->prepare('SELECT pid FROM ' . Database::quoteIdentifier($strTable) . ' WHERE id=?')
  1554. ->execute($intId);
  1556. if (!$objPid->numRows || $objPid->pid == 0)
  1557. {
  1558. $tags[] = 'contao.db.' . $strTable;
  1560. return;
  1561. }
  1563. $tags[] = 'contao.db.' . $ptable . '.' . $objPid->pid;
  1565. // Do not call recursively (see #4777)
  1566. }
  1568. /**
  1569. * @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0
  1570. */
  1571. public function addCtableTags($strTable, $intId, &$tags)
  1572. {
  1573. trigger_deprecation('contao/core-bundle', '4.9', 'Calling "%s()" has been deprecated and will no longer work in Contao 5.0.', __METHOD__);
  1575. $ctables = $GLOBALS['TL_DCA'][$strTable]['config']['ctable'] ?? array();
  1577. if (($GLOBALS['TL_DCA'][$strTable]['list']['sorting']['mode'] ?? null) == 5)
  1578. {
  1579. $ctables[] = $strTable;
  1580. }
  1582. if (!$ctables)
  1583. {
  1584. return;
  1585. }
  1587. foreach ($ctables as $ctable)
  1588. {
  1589. Controller::loadDataContainer($ctable);
  1591. if ($GLOBALS['TL_DCA'][$ctable]['config']['dynamicPtable'] ?? null)
  1592. {
  1593. $objIds = $this->Database->prepare('SELECT id FROM ' . Database::quoteIdentifier($ctable) . ' WHERE pid=? AND ptable=?')
  1594. ->execute($intId, $strTable);
  1595. }
  1596. else
  1597. {
  1598. $objIds = $this->Database->prepare('SELECT id FROM ' . Database::quoteIdentifier($ctable) . ' WHERE pid=?')
  1599. ->execute($intId);
  1600. }
  1602. if (!$objIds->numRows)
  1603. {
  1604. continue;
  1605. }
  1607. while ($objIds->next())
  1608. {
  1609. $tags[] = 'contao.db.' . $ctable . '.' . $objIds->id;
  1611. $this->addCtableTags($ctable, $objIds->id, $tags);
  1612. }
  1613. }
  1614. }
  1616. /**
  1617. * Return the form field suffix
  1618. *
  1619. * @return integer|string
  1620. */
  1621. protected function getFormFieldSuffix()
  1622. {
  1623. return $this->intId;
  1624. }
  1626. /**
  1627. * Return the name of the current palette
  1628. *
  1629. * @return string
  1630. */
  1631. abstract public function getPalette();
  1633. /**
  1634. * Save the current value
  1635. *
  1636. * @param mixed $varValue
  1637. *
  1638. * @throws \Exception
  1639. */
  1640. abstract protected function save($varValue);
  1642. /**
  1643. * Return the class name of the DataContainer driver for the given table.
  1644. *
  1645. * @param string $table
  1646. *
  1647. * @return string
  1648. *
  1649. * @todo Change the return type to ?string in Contao 5.0
  1650. */
  1651. public static function getDriverForTable(string $table): string
  1652. {
  1653. if (!isset($GLOBALS['TL_DCA'][$table]['config']['dataContainer']))
  1654. {
  1655. return '';
  1656. }
  1658. $dataContainer = $GLOBALS['TL_DCA'][$table]['config']['dataContainer'];
  1660. if ('' !== $dataContainer && false === strpos($dataContainer, '\\'))
  1661. {
  1662. trigger_deprecation('contao/core-bundle', '4.9', 'The usage of a non fully qualified class name "%s" for table "%s" as DataContainer name has been deprecated and will no longer work in Contao 5.0. Use the fully qualified class name instead, e.g. Contao\DC_Table::class.', $dataContainer, $table);
  1664. $dataContainer = 'DC_' . $dataContainer;
  1666. if (class_exists($dataContainer))
  1667. {
  1668. $ref = new \ReflectionClass($dataContainer);
  1670. return $ref->getName();
  1671. }
  1672. }
  1674. return $dataContainer;
  1675. }
  1677. /**
  1678. * Generates the label for a given data record according to the DCA configuration.
  1679. * Returns an array of strings if 'showColumns' is enabled in the DCA configuration.
  1680. *
  1681. * @param array $row The data record
  1682. * @param string $table The name of the data container
  1683. *
  1684. * @return string|array<string>
  1685. */
  1686. public function generateRecordLabel(array $row, ?string $table = null, bool $protected = false, bool $isVisibleRootTrailPage = false)
  1687. {
  1688. $table = $table ?? $this->strTable;
  1689. $labelConfig = &$GLOBALS['TL_DCA'][$table]['list']['label'];
  1690. $args = array();
  1692. foreach ($labelConfig['fields'] as $k=>$v)
  1693. {
  1694. // Decrypt the value
  1695. if ($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['encrypt'] ?? null)
  1696. {
  1697. $row[$v] = Encryption::decrypt(StringUtil::deserialize($row[$v]));
  1698. }
  1700. if (strpos($v, ':') !== false)
  1701. {
  1702. list($strKey, $strTable) = explode(':', $v, 2);
  1703. list($strTable, $strField) = explode('.', $strTable, 2);
  1705. $objRef = Database::getInstance()
  1706. ->prepare("SELECT " . Database::quoteIdentifier($strField) . " FROM " . $strTable . " WHERE id=?")
  1707. ->limit(1)
  1708. ->execute($row[$strKey]);
  1710. $args[$k] = $objRef->numRows ? $objRef->$strField : '';
  1711. }
  1712. elseif (isset($row[$v], $GLOBALS['TL_DCA'][$table]['fields'][$v]['foreignKey']))
  1713. {
  1714. $key = explode('.', $GLOBALS['TL_DCA'][$table]['fields'][$v]['foreignKey'], 2);
  1716. $objRef = Database::getInstance()
  1717. ->prepare("SELECT " . Database::quoteIdentifier($key[1]) . " AS value FROM " . $key[0] . " WHERE id=?")
  1718. ->limit(1)
  1719. ->execute($row[$v]);
  1721. $args[$k] = $objRef->numRows ? $objRef->value : '';
  1722. }
  1723. elseif (\in_array($GLOBALS['TL_DCA'][$table]['fields'][$v]['flag'] ?? null, array(self::SORT_DAY_ASC, self::SORT_DAY_DESC, self::SORT_MONTH_ASC, self::SORT_MONTH_DESC, self::SORT_YEAR_ASC, self::SORT_YEAR_DESC)))
  1724. {
  1725. if (($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['rgxp'] ?? null) == 'date')
  1726. {
  1727. $args[$k] = $row[$v] ? Date::parse(Config::get('dateFormat'), $row[$v]) : '-';
  1728. }
  1729. elseif (($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['rgxp'] ?? null) == 'time')
  1730. {
  1731. $args[$k] = $row[$v] ? Date::parse(Config::get('timeFormat'), $row[$v]) : '-';
  1732. }
  1733. else
  1734. {
  1735. $args[$k] = $row[$v] ? Date::parse(Config::get('datimFormat'), $row[$v]) : '-';
  1736. }
  1737. }
  1738. elseif (($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['isBoolean'] ?? null) || (($GLOBALS['TL_DCA'][$table]['fields'][$v]['inputType'] ?? null) == 'checkbox' && !($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['multiple'] ?? null)))
  1739. {
  1740. $args[$k] = ($row[$v] ?? null) ? $GLOBALS['TL_LANG']['MSC']['yes'] : $GLOBALS['TL_LANG']['MSC']['no'];
  1741. }
  1742. elseif (isset($row[$v]))
  1743. {
  1744. $row_v = StringUtil::deserialize($row[$v]);
  1746. if (\is_array($row_v))
  1747. {
  1748. $args_k = array();
  1750. foreach ($row_v as $option)
  1751. {
  1752. $args_k[] = $GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$option] ?? $option;
  1753. }
  1755. $args[$k] = implode(', ', iterator_to_array(new \RecursiveIteratorIterator(new \RecursiveArrayIterator($args_k)), false));
  1756. }
  1757. elseif (isset($GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$row[$v]]))
  1758. {
  1759. $args[$k] = \is_array($GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$row[$v]]) ? $GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$row[$v]][0] : $GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$row[$v]];
  1760. }
  1761. elseif ((($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['isAssociative'] ?? null) || ArrayUtil::isAssoc($GLOBALS['TL_DCA'][$table]['fields'][$v]['options'] ?? null)) && isset($GLOBALS['TL_DCA'][$table]['fields'][$v]['options'][$row[$v]]))
  1762. {
  1763. $args[$k] = $GLOBALS['TL_DCA'][$table]['fields'][$v]['options'][$row[$v]] ?? null;
  1764. }
  1765. else
  1766. {
  1767. $args[$k] = $row[$v];
  1768. }
  1769. }
  1770. else
  1771. {
  1772. $args[$k] = null;
  1773. }
  1774. }
  1776. // Render the label
  1777. $label = vsprintf($labelConfig['format'] ?? '%s', $args);
  1779. // Shorten the label it if it is too long
  1780. if (($labelConfig['maxCharacters'] ?? null) > 0 && $labelConfig['maxCharacters'] < \strlen(strip_tags($label)))
  1781. {
  1782. $label = trim(StringUtil::substrHtml($label, $labelConfig['maxCharacters'])) . ' …';
  1783. }
  1785. // Remove empty brackets (), [], {}, <> and empty tags from the label
  1786. $label = preg_replace('/\( *\) ?|\[ *] ?|{ *} ?|< *> ?/', '', $label);
  1787. $label = preg_replace('/<[^\/!][^>]+>\s*<\/[^>]+>/', '', $label);
  1789. $mode = $GLOBALS['TL_DCA'][$table]['list']['sorting']['mode'] ?? self::MODE_SORTED;
  1791. // Execute label_callback
  1792. if (\is_array($labelConfig['label_callback'] ?? null) || \is_callable($labelConfig['label_callback'] ?? null))
  1793. {
  1794. if (\in_array($mode, array(self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1795. {
  1796. if (\is_array($labelConfig['label_callback'] ?? null))
  1797. {
  1798. $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this, '', false, $protected, $isVisibleRootTrailPage);
  1799. }
  1800. else
  1801. {
  1802. $label = $labelConfig['label_callback']($row, $label, $this, '', false, $protected, $isVisibleRootTrailPage);
  1803. }
  1804. }
  1805. elseif ($mode === self::MODE_PARENT)
  1806. {
  1807. if (\is_array($labelConfig['label_callback'] ?? null))
  1808. {
  1809. $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this);
  1810. }
  1811. else
  1812. {
  1813. $label = $labelConfig['label_callback']($row, $label, $this);
  1814. }
  1815. }
  1816. else
  1817. {
  1818. if (\is_array($labelConfig['label_callback'] ?? null))
  1819. {
  1820. $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this, $args);
  1821. }
  1822. else
  1823. {
  1824. $label = $labelConfig['label_callback']($row, $label, $this, $args);
  1825. }
  1826. }
  1827. }
  1828. elseif (\in_array($mode, array(self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1829. {
  1830. $label = Image::getHtml('iconPLAIN.svg') . ' ' . $label;
  1831. }
  1833. if (($labelConfig['showColumns'] ?? null) && !\in_array($mode, array(self::MODE_PARENT, self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1834. {
  1835. return \is_array($label) ? $label : $args;
  1836. }
  1838. return $label;
  1839. }
  1841. protected function markAsCopy(string $label, string $value): string
  1842. {
  1843. // Do not mark as copy more than once (see #6058)
  1844. if (preg_match('/' . preg_quote(sprintf($label, ''), '/') . '/', StringUtil::decodeEntities($value)))
  1845. {
  1846. return $value;
  1847. }
  1849. return sprintf($label, $value);
  1850. }
  1851. }
  1853. class_alias(DataContainer::class, 'DataContainer');