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

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.             default:
  280.                 $this->$strKey = $varValue; // backwards compatibility
  281.                 break;
  282.         }
  283.     }
  285.     /**
  286.      * Return an object property
  287.      *
  288.      * @param string $strKey
  289.      *
  290.      * @return mixed
  291.      */
  292.     public function __get($strKey)
  293.     {
  294.         switch ($strKey)
  295.         {
  296.             case 'id':
  297.                 return $this->intId;
  299.             case 'table':
  300.                 return $this->strTable;
  302.             case 'value':
  303.                 return $this->varValue;
  305.             case 'field':
  306.                 return $this->strField;
  308.             case 'inputName':
  309.                 return $this->strInputName;
  311.             case 'palette':
  312.                 return $this->strPalette;
  314.             case 'activeRecord':
  315.                 return $this->objActiveRecord;
  317.             case 'createNewVersion':
  318.                 return $this->blnCreateNewVersion;
  320.             // Forward compatibility with Contao 5.0
  321.             case 'currentPid':
  322.                 return ((int) (\defined('CURRENT_ID') ? CURRENT_ID : 0)) ?: null;
  323.         }
  325.         return parent::__get($strKey);
  326.     }
  328.     /**
  329.      * Render a row of a box and return it as HTML string
  330.      *
  331.      * @param string|array|null $strPalette
  332.      *
  333.      * @return string
  334.      *
  335.      * @throws AccessDeniedException
  336.      * @throws \Exception
  337.      */
  338.     protected function row($strPalette=null)
  339.     {
  340.         $arrData = $GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField] ?? array();
  342.         // Check if the field is excluded
  343.         if ($arrData['exclude'] ?? null)
  344.         {
  345.             throw new AccessDeniedException('Field "' . $this->strTable . '.' . $this->strField . '" is excluded from being edited.');
  346.         }
  348.         $xlabel = '';
  350.         // Toggle line wrap (textarea)
  351.         if (($arrData['inputType'] ?? null) == 'textarea' && !isset($arrData['eval']['rte']))
  352.         {
  353.             $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 . '\')"');
  354.         }
  356.         // Add the help wizard
  357.         if ($arrData['eval']['helpwizard'] ?? null)
  358.         {
  359.             $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>';
  360.         }
  362.         // Add a custom xlabel
  363.         if (\is_array($arrData['xlabel'] ?? null))
  364.         {
  365.             foreach ($arrData['xlabel'] as $callback)
  366.             {
  367.                 if (\is_array($callback))
  368.                 {
  369.                     $this->import($callback[0]);
  370.                     $xlabel .= $this->{$callback[0]}->{$callback[1]}($this);
  371.                 }
  372.                 elseif (\is_callable($callback))
  373.                 {
  374.                     $xlabel .= $callback($this);
  375.                 }
  376.             }
  377.         }
  379.         // Input field callback
  380.         if (\is_array($arrData['input_field_callback'] ?? null))
  381.         {
  382.             $this->import($arrData['input_field_callback'][0]);
  384.             return $this->{$arrData['input_field_callback'][0]}->{$arrData['input_field_callback'][1]}($this, $xlabel);
  385.         }
  387.         if (\is_callable($arrData['input_field_callback'] ?? null))
  388.         {
  389.             return $arrData['input_field_callback']($this, $xlabel);
  390.         }
  392.         $strClass = $GLOBALS['BE_FFL'][($arrData['inputType'] ?? null)] ?? null;
  394.         // Return if the widget class does not exist
  395.         if (!class_exists($strClass))
  396.         {
  397.             return '';
  398.         }
  400.         $arrData['eval']['required'] = false;
  402.         if ($arrData['eval']['mandatory'] ?? null)
  403.         {
  404.             if (\is_array($this->varValue))
  405.             {
  406.                 if (empty($this->varValue))
  407.                 {
  408.                     $arrData['eval']['required'] = true;
  409.                 }
  410.             }
  411.             elseif ('' === (string) $this->varValue)
  412.             {
  413.                 $arrData['eval']['required'] = true;
  414.             }
  415.         }
  417.         // Convert insert tags in src attributes (see #5965)
  418.         if (isset($arrData['eval']['rte']) && strncmp($arrData['eval']['rte'], 'tiny', 4) === 0 && \is_string($this->varValue))
  419.         {
  420.             $this->varValue = StringUtil::insertTagToSrc($this->varValue);
  421.         }
  423.         // Use raw request if set globally but allow opting out setting useRawRequestData to false explicitly
  424.         $useRawGlobally = isset($GLOBALS['TL_DCA'][$this->strTable]['config']['useRawRequestData']) && $GLOBALS['TL_DCA'][$this->strTable]['config']['useRawRequestData'] === true;
  425.         $notRawForField = isset($arrData['eval']['useRawRequestData']) && $arrData['eval']['useRawRequestData'] === false;
  427.         if ($useRawGlobally && !$notRawForField)
  428.         {
  429.             $arrData['eval']['useRawRequestData'] = true;
  430.         }
  432.         /** @var Widget $objWidget */
  433.         $objWidget = new $strClass($strClass::getAttributesFromDca($arrData, $this->strInputName, $this->varValue, $this->strField, $this->strTable, $this));
  434.         $objWidget->xlabel = $xlabel;
  435.         $objWidget->currentRecord = $this->intId;
  437.         // Validate the field
  438.         if (Input::post('FORM_SUBMIT') == $this->strTable)
  439.         {
  440.             $suffix = $this->getFormFieldSuffix();
  441.             $key = (Input::get('act') == 'editAll') ? 'FORM_FIELDS_' . $suffix : 'FORM_FIELDS';
  443.             // Calculate the current palette
  444.             $postPaletteFields = implode(',', Input::post($key));
  445.             $postPaletteFields = array_unique(StringUtil::trimsplit('[,;]', $postPaletteFields));
  447.             // Compile the palette if there is none
  448.             if ($strPalette === null)
  449.             {
  450.                 $newPaletteFields = StringUtil::trimsplit('[,;]', $this->getPalette());
  451.             }
  452.             else
  453.             {
  454.                 // Use the given palette ($strPalette is an array in editAll mode)
  455.                 $newPaletteFields = \is_array($strPalette) ? $strPalette : StringUtil::trimsplit('[,;]', $strPalette);
  457.                 // Recompile the palette if the current field is a selector field and the value has changed
  458.                 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__']))
  459.                 {
  460.                     $newPaletteFields = StringUtil::trimsplit('[,;]', $this->getPalette());
  461.                 }
  462.             }
  464.             // Adjust the names in editAll mode
  465.             if (Input::get('act') == 'editAll')
  466.             {
  467.                 foreach ($newPaletteFields as $k=>$v)
  468.                 {
  469.                     $newPaletteFields[$k] = $v . '_' . $suffix;
  470.                 }
  471.             }
  473.             $paletteFields = array_intersect($postPaletteFields, $newPaletteFields);
  475.             // Deprecated since Contao 4.2, to be removed in Contao 5.0
  476.             if (!isset($_POST[$this->strInputName]) && \in_array($this->strInputName, $paletteFields))
  477.             {
  478.                 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.');
  479.             }
  481.             // Validate and save the field
  482.             if ($objWidget->submitInput() && (\in_array($this->strInputName, $paletteFields) || Input::get('act') == 'overrideAll'))
  483.             {
  484.                 $objWidget->validate();
  486.                 if ($objWidget->hasErrors())
  487.                 {
  488.                     // Skip mandatory fields on auto-submit (see #4077)
  489.                     if (!$objWidget->mandatory || $objWidget->value || Input::post('SUBMIT_TYPE') != 'auto')
  490.                     {
  491.                         $this->noReload = true;
  492.                     }
  493.                 }
  494.                 // The return value of submitInput() might have changed, therefore check it again here (see #2383)
  495.                 elseif ($objWidget->submitInput())
  496.                 {
  497.                     $varValue = $objWidget->value;
  499.                     // Sort array by key (fix for JavaScript wizards)
  500.                     if (\is_array($varValue))
  501.                     {
  502.                         ksort($varValue);
  503.                         $varValue = serialize($varValue);
  504.                     }
  506.                     // Convert file paths in src attributes (see #5965)
  507.                     if ($varValue && isset($arrData['eval']['rte']) && strncmp($arrData['eval']['rte'], 'tiny', 4) === 0)
  508.                     {
  509.                         $varValue = StringUtil::srcToInsertTag($varValue);
  510.                     }
  512.                     // Save the current value
  513.                     try
  514.                     {
  515.                         $this->save($varValue);
  517.                         // Confirm password changes
  518.                         if ($objWidget instanceof Password)
  519.                         {
  520.                             Message::addConfirmation($GLOBALS['TL_LANG']['MSC']['pw_changed']);
  521.                         }
  522.                     }
  523.                     catch (ResponseException $e)
  524.                     {
  525.                         throw $e;
  526.                     }
  527.                     catch (\Exception $e)
  528.                     {
  529.                         $this->noReload = true;
  530.                         $objWidget->addError($e->getMessage());
  531.                     }
  532.                 }
  533.             }
  534.         }
  536.         $wizard = '';
  537.         $strHelpClass = '';
  539.         // Date picker
  540.         if ($arrData['eval']['datepicker'] ?? null)
  541.         {
  542.             $rgxp = $arrData['eval']['rgxp'] ?? 'date';
  543.             $format = Date::formatToJs(Config::get($rgxp . 'Format'));
  545.             switch ($rgxp)
  546.             {
  547.                 case 'datim':
  548.                     $time = ",\n        timePicker: true";
  549.                     break;
  551.                 case 'time':
  552.                     $time = ",\n        pickOnly: \"time\"";
  553.                     break;
  555.                 default:
  556.                     $time = '';
  557.                     break;
  558.             }
  560.             $strOnSelect = '';
  562.             // Trigger the auto-submit function (see #8603)
  563.             if ($arrData['eval']['submitOnChange'] ?? null)
  564.             {
  565.                 $strOnSelect = ",\n        onSelect: function() { Backend.autoSubmit(\"" . $this->strTable . "\"); }";
  566.             }
  568.             $wizard .= ' ' . Image::getHtml('assets/datepicker/images/icon.svg', '', 'title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['datepicker']) . '" id="toggle_' . $objWidget->id . '" style="cursor:pointer"') . '
  569.   <script>
  570.     window.addEvent("domready", function() {
  571.       new Picker.Date($("ctrl_' . $objWidget->id . '"), {
  572.         draggable: false,
  573.         toggle: $("toggle_' . $objWidget->id . '"),
  574.         format: "' . $format . '",
  575.         positionOffset: {x:-211,y:-209}' . $time . ',
  576.         pickerClass: "datepicker_bootstrap",
  577.         useFadeInOut: !Browser.ie' . $strOnSelect . ',
  578.         startDay: ' . $GLOBALS['TL_LANG']['MSC']['weekOffset'] . ',
  579.         titleFormat: "' . $GLOBALS['TL_LANG']['MSC']['titleFormat'] . '"
  580.       });
  581.     });
  582.   </script>';
  583.         }
  585.         // Color picker
  586.         if ($arrData['eval']['colorpicker'] ?? null)
  587.         {
  588.             // Support single fields as well (see #5240)
  589.             $strKey = ($arrData['eval']['multiple'] ?? null) ? $this->strField . '_0' : $this->strField;
  591.             $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"') . '
  592.   <script>
  593.     window.addEvent("domready", function() {
  594.       var cl = $("ctrl_' . $strKey . '").value.hexToRgb(true) || [255, 0, 0];
  595.       new MooRainbow("moo_' . $this->strField . '", {
  596.         id: "ctrl_' . $strKey . '",
  597.         startColor: cl,
  598.         imgPath: "assets/colorpicker/images/",
  599.         onComplete: function(color) {
  600.           $("ctrl_' . $strKey . '").value = color.hex.replace("#", "");
  601.         }
  602.       });
  603.     });
  604.   </script>';
  605.         }
  607.         $arrClasses = StringUtil::trimsplit(' ', $arrData['eval']['tl_class'] ?? '');
  609.         // DCA picker
  610.         if (isset($arrData['eval']['dcaPicker']) && (\is_array($arrData['eval']['dcaPicker']) || $arrData['eval']['dcaPicker'] === true))
  611.         {
  612.             $arrClasses[] = 'dcapicker';
  613.             $wizard .= Backend::getDcaPickerWizard($arrData['eval']['dcaPicker'], $this->strTable, $this->strField, $this->strInputName);
  614.         }
  616.         if (($arrData['inputType'] ?? null) == 'password')
  617.         {
  618.             $wizard .= Backend::getTogglePasswordWizard($this->strInputName);
  619.         }
  621.         // Add a custom wizard
  622.         if (\is_array($arrData['wizard'] ?? null))
  623.         {
  624.             foreach ($arrData['wizard'] as $callback)
  625.             {
  626.                 if (\is_array($callback))
  627.                 {
  628.                     $this->import($callback[0]);
  629.                     $wizard .= $this->{$callback[0]}->{$callback[1]}($this);
  630.                 }
  631.                 elseif (\is_callable($callback))
  632.                 {
  633.                     $wizard .= $callback($this);
  634.                 }
  635.             }
  636.         }
  638.         $hasWizardClass = \in_array('wizard', $arrClasses);
  640.         if ($wizard && !($arrData['eval']['disabled'] ?? false) && !($arrData['eval']['readonly'] ?? false))
  641.         {
  642.             $objWidget->wizard = $wizard;
  644.             if (!$hasWizardClass)
  645.             {
  646.                 $arrClasses[] = 'wizard';
  647.             }
  648.         }
  649.         elseif ($hasWizardClass)
  650.         {
  651.             unset($arrClasses[array_search('wizard', $arrClasses)]);
  652.         }
  654.         // Set correct form enctype
  655.         if ($objWidget instanceof UploadableWidgetInterface)
  656.         {
  657.             $this->blnUploadable = true;
  658.         }
  660.         $arrClasses[] = 'widget';
  662.         // Mark floated single checkboxes
  663.         if (($arrData['inputType'] ?? null) == 'checkbox' && !($arrData['eval']['multiple'] ?? null) && \in_array('w50', $arrClasses))
  664.         {
  665.             $arrClasses[] = 'cbx';
  666.         }
  667.         elseif (($arrData['inputType'] ?? null) == 'text' && ($arrData['eval']['multiple'] ?? null) && \in_array('wizard', $arrClasses))
  668.         {
  669.             $arrClasses[] = 'inline';
  670.         }
  672.         if (!empty($arrClasses))
  673.         {
  674.             $arrData['eval']['tl_class'] = implode(' ', array_unique($arrClasses));
  675.         }
  677.         $updateMode = '';
  679.         // Replace the textarea with an RTE instance
  680.         if (!empty($arrData['eval']['rte']))
  681.         {
  682.             list($file, $type) = explode('|', $arrData['eval']['rte'], 2) + array(null, null);
  684.             $fileBrowserTypes = array();
  685.             $pickerBuilder = System::getContainer()->get('contao.picker.builder');
  687.             foreach (array('file' => 'image', 'link' => 'file') as $context => $fileBrowserType)
  688.             {
  689.                 if ($pickerBuilder->supportsContext($context))
  690.                 {
  691.                     $fileBrowserTypes[] = $fileBrowserType;
  692.                 }
  693.             }
  695.             $objTemplate = new BackendTemplate('be_' . $file);
  696.             $objTemplate->selector = 'ctrl_' . $this->strInputName;
  697.             $objTemplate->type = $type;
  698.             $objTemplate->fileBrowserTypes = $fileBrowserTypes;
  699.             $objTemplate->source = $this->strTable . '.' . $this->intId;
  701.             // Deprecated since Contao 4.0, to be removed in Contao 5.0
  702.             $objTemplate->language = Backend::getTinyMceLanguage();
  704.             $updateMode = $objTemplate->parse();
  706.             unset($file, $type, $pickerBuilder, $fileBrowserTypes, $fileBrowserType);
  707.         }
  709.         // Handle multi-select fields in "override all" mode
  710.         elseif ((($arrData['inputType'] ?? null) == 'checkbox' || ($arrData['inputType'] ?? null) == 'checkboxWizard') && ($arrData['eval']['multiple'] ?? null) && Input::get('act') == 'overrideAll')
  711.         {
  712.             $updateMode = '
  713. </div>
  714. <div class="widget">
  715.   <fieldset class="tl_radio_container">
  716.   <legend>' . $GLOBALS['TL_LANG']['MSC']['updateMode'] . '</legend>
  717.     <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>
  718.     <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>
  719.     <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>
  720.   </fieldset>';
  721.         }
  723.         $strPreview = '';
  725.         // Show a preview image (see #4948)
  726.         if ($this->strTable == 'tl_files' && $this->strField == 'name' && $this->objActiveRecord !== null && $this->objActiveRecord->type == 'file')
  727.         {
  728.             $objFile = new File($this->objActiveRecord->path);
  730.             if ($objFile->isImage)
  731.             {
  732.                 $blnCanResize = true;
  734.                 if ($objFile->isSvgImage)
  735.                 {
  736.                     // SVG images with undefined sizes cannot be resized
  737.                     if (!$objFile->viewWidth || !$objFile->viewHeight)
  738.                     {
  739.                         $blnCanResize= false;
  740.                     }
  741.                 }
  742.                 elseif (System::getContainer()->get('contao.image.imagine') instanceof Imagine)
  743.                 {
  744.                     // Check the maximum width and height if the GDlib is used to resize images
  745.                     if ($objFile->height > Config::get('gdMaxImgHeight') || $objFile->width > Config::get('gdMaxImgWidth'))
  746.                     {
  747.                         $blnCanResize = false;
  748.                     }
  749.                 }
  751.                 if ($blnCanResize)
  752.                 {
  753.                     $container = System::getContainer();
  754.                     $projectDir = $container->getParameter('kernel.project_dir');
  756.                     try
  757.                     {
  758.                         $image = rawurldecode($container->get('contao.image.factory')->create($projectDir . '/' . $objFile->path, array(699, 524, ResizeConfiguration::MODE_BOX))->getUrl($projectDir));
  759.                     }
  760.                     catch (\Exception $e)
  761.                     {
  762.                         Message::addError($e->getMessage());
  763.                         $image = Image::getPath('placeholder.svg');
  764.                     }
  765.                 }
  766.                 else
  767.                 {
  768.                     $image = Image::getPath('placeholder.svg');
  769.                 }
  771.                 $objImage = new File($image);
  772.                 $ctrl = 'ctrl_preview_' . substr(md5($image), 0, 8);
  774.                 $strPreview = '
  775. <div id="' . $ctrl . '" class="tl_edit_preview">
  776.   <img src="' . $objImage->dataUri . '" width="' . $objImage->width . '" height="' . $objImage->height . '" alt="">
  777. </div>';
  779.                 // Add the script to mark the important part
  780.                 if (basename($image) !== 'placeholder.svg')
  781.                 {
  782.                     $strPreview .= '<script>Backend.editPreviewWizard($(\'' . $ctrl . '\'));</script>';
  784.                     if (Config::get('showHelp'))
  785.                     {
  786.                         $strPreview .= '<p class="tl_help tl_tip">' . $GLOBALS['TL_LANG'][$this->strTable]['edit_preview_help'] . '</p>';
  787.                     }
  789.                     $strPreview = '<div class="widget">' . $strPreview . '</div>';
  790.                 }
  791.             }
  792.         }
  794.         return $strPreview . '
  795. <div' . (!empty($arrData['eval']['tl_class']) ? ' class="' . trim($arrData['eval']['tl_class']) . '"' : '') . '>' . $objWidget->parse() . $updateMode . (!$objWidget->hasErrors() ? $this->help($strHelpClass) : '') . '
  796. </div>';
  797.     }
  799.     /**
  800.      * Return the field explanation as HTML string
  801.      *
  802.      * @param string $strClass
  803.      *
  804.      * @return string
  805.      */
  806.     public function help($strClass='')
  807.     {
  808.         $return = $GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField]['label'][1] ?? null;
  810.         if (!$return || ($GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField]['inputType'] ?? null) == 'password' || !Config::get('showHelp'))
  811.         {
  812.             return '';
  813.         }
  815.         return '
  816.   <p class="tl_help tl_tip' . $strClass . '">' . $return . '</p>';
  817.     }
  819.     /**
  820.      * Generate possible palette names from an array by taking the first value and either adding or not adding the following values
  821.      *
  822.      * @param array $names
  823.      *
  824.      * @return array
  825.      */
  826.     protected function combiner($names)
  827.     {
  828.         $return = array('');
  829.         $names = array_values($names);
  831.         for ($i=0, $c=\count($names); $i<$c; $i++)
  832.         {
  833.             $buffer = array();
  835.             foreach ($return as $k=>$v)
  836.             {
  837.                 $buffer[] = ($k%2 == 0) ? $v : $v . $names[$i];
  838.                 $buffer[] = ($k%2 == 0) ? $v . $names[$i] : $v;
  839.             }
  841.             $return = $buffer;
  842.         }
  844.         return array_filter($return);
  845.     }
  847.     /**
  848.      * Return a query string that switches into edit mode
  849.      *
  850.      * @param integer $id
  851.      *
  852.      * @return string
  853.      */
  854.     protected function switchToEdit($id)
  855.     {
  856.         $arrKeys = array();
  857.         $arrUnset = array('act', 'key', 'id', 'table', 'mode', 'pid');
  859.         foreach (array_keys($_GET) as $strKey)
  860.         {
  861.             if (!\in_array($strKey, $arrUnset))
  862.             {
  863.                 $arrKeys[$strKey] = $strKey . '=' . Input::get($strKey);
  864.             }
  865.         }
  867.         $strUrl = TL_SCRIPT . '?' . implode('&', $arrKeys);
  869.         return $strUrl . (!empty($arrKeys) ? '&' : '') . (Input::get('table') ? 'table=' . Input::get('table') . '&amp;' : '') . 'act=edit&amp;id=' . rawurlencode($id);
  870.     }
  872.     /**
  873.      * Compile buttons from the table configuration array and return them as HTML
  874.      *
  875.      * @param array   $arrRow
  876.      * @param string  $strTable
  877.      * @param array   $arrRootIds
  878.      * @param boolean $blnCircularReference
  879.      * @param array   $arrChildRecordIds
  880.      * @param string  $strPrevious
  881.      * @param string  $strNext
  882.      *
  883.      * @return string
  884.      */
  885.     protected function generateButtons($arrRow, $strTable, $arrRootIds=array(), $blnCircularReference=false, $arrChildRecordIds=null, $strPrevious=null, $strNext=null)
  886.     {
  887.         if (!\is_array($GLOBALS['TL_DCA'][$strTable]['list']['operations'] ?? null))
  888.         {
  889.             return '';
  890.         }
  892.         $return = '';
  894.         foreach ($GLOBALS['TL_DCA'][$strTable]['list']['operations'] as $k=>$v)
  895.         {
  896.             $v = \is_array($v) ? $v : array($v);
  897.             $id = StringUtil::specialchars(rawurldecode($arrRow['id']));
  898.             $label = $title = $k;
  900.             if (isset($v['label']))
  901.             {
  902.                 if (\is_array($v['label']))
  903.                 {
  904.                     $label = $v['label'][0] ?? null;
  905.                     $title = sprintf($v['label'][1] ?? '', $id);
  906.                 }
  907.                 else
  908.                 {
  909.                     $label = $title = sprintf($v['label'], $id);
  910.                 }
  911.             }
  913.             $attributes = !empty($v['attributes']) ? ' ' . ltrim(sprintf($v['attributes'], $id, $id)) : '';
  915.             // Add the key as CSS class
  916.             if (strpos($attributes, 'class="') !== false)
  917.             {
  918.                 $attributes = str_replace('class="', 'class="' . $k . ' ', $attributes);
  919.             }
  920.             else
  921.             {
  922.                 $attributes = ' class="' . $k . '"' . $attributes;
  923.             }
  925.             // Call a custom function instead of using the default button
  926.             if (\is_array($v['button_callback'] ?? null))
  927.             {
  928.                 $this->import($v['button_callback'][0]);
  929.                 $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);
  930.                 continue;
  931.             }
  933.             if (\is_callable($v['button_callback'] ?? null))
  934.             {
  935.                 $return .= $v['button_callback']($arrRow, $v['href'] ?? null, $label, $title, $v['icon'] ?? null, $attributes, $strTable, $arrRootIds, $arrChildRecordIds, $blnCircularReference, $strPrevious, $strNext, $this);
  936.                 continue;
  937.             }
  939.             // Generate all buttons except "move up" and "move down" buttons
  940.             if ($k != 'move' && $v != 'move')
  941.             {
  942.                 if ($k == 'show')
  943.                 {
  944.                     if (!empty($v['route']))
  945.                     {
  946.                         $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id'], 'popup' => '1'));
  947.                     }
  948.                     else
  949.                     {
  950.                         $href = $this->addToUrl(($v['href'] ?? '') . '&amp;id=' . $arrRow['id'] . '&amp;popup=1');
  951.                     }
  953.                     $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> ';
  954.                 }
  955.                 else
  956.                 {
  957.                     if (!empty($v['route']))
  958.                     {
  959.                         $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id']));
  960.                     }
  961.                     else
  962.                     {
  963.                         $href = $this->addToUrl(($v['href'] ?? '') . '&amp;id=' . $arrRow['id'] . (Input::get('nb') ? '&amp;nc=1' : ''));
  964.                     }
  966.                     parse_str(StringUtil::decodeEntities($v['href'] ?? ''), $params);
  968.                     if (($params['act'] ?? null) == 'toggle' && isset($params['field']))
  969.                     {
  970.                         // Hide the toggle icon if the user does not have access to the field
  971.                         if (($GLOBALS['TL_DCA'][$strTable]['fields'][$params['field']]['toggle'] ?? false) !== true || !System::getContainer()->get('security.helper')->isGranted(ContaoCorePermissions::USER_CAN_EDIT_FIELD_OF_TABLE, $strTable . '::' . $params['field']))
  972.                         {
  973.                             continue;
  974.                         }
  976.                         $icon = $v['icon'];
  977.                         $_icon = pathinfo($v['icon'], PATHINFO_FILENAME) . '_.' . pathinfo($v['icon'], PATHINFO_EXTENSION);
  979.                         if (false !== strpos($v['icon'], '/'))
  980.                         {
  981.                             $_icon = \dirname($v['icon']) . '/' . $_icon;
  982.                         }
  984.                         if ($icon == 'visible.svg')
  985.                         {
  986.                             $_icon = 'invisible.svg';
  987.                         }
  989.                         $state = $arrRow[$params['field']] ? 1 : 0;
  991.                         if ($v['reverse'] ?? false)
  992.                         {
  993.                             $state = $arrRow[$params['field']] ? 0 : 1;
  994.                         }
  996.                         $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> ';
  997.                     }
  998.                     else
  999.                     {
  1000.                         $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  1001.                     }
  1002.                 }
  1004.                 continue;
  1005.             }
  1007.             trigger_deprecation('contao/core-bundle', '4.13', 'The DCA "move" operation is deprecated and will be removed in Contao 5.');
  1009.             $arrDirections = array('up', 'down');
  1010.             $arrRootIds = \is_array($arrRootIds) ? $arrRootIds : array($arrRootIds);
  1012.             foreach ($arrDirections as $dir)
  1013.             {
  1014.                 $label = !empty($GLOBALS['TL_LANG'][$strTable][$dir][0]) ? $GLOBALS['TL_LANG'][$strTable][$dir][0] : $dir;
  1015.                 $title = !empty($GLOBALS['TL_LANG'][$strTable][$dir][1]) ? $GLOBALS['TL_LANG'][$strTable][$dir][1] : $dir;
  1017.                 $label = Image::getHtml($dir . '.svg', $label);
  1018.                 $href = !empty($v['href']) ? $v['href'] : '&amp;act=move';
  1020.                 if ($dir == 'up')
  1021.                 {
  1022.                     $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')) . ' ';
  1023.                 }
  1024.                 else
  1025.                 {
  1026.                     $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')) . ' ';
  1027.                 }
  1028.             }
  1029.         }
  1031.         return trim($return);
  1032.     }
  1034.     /**
  1035.      * Compile global buttons from the table configuration array and return them as HTML
  1036.      *
  1037.      * @return string
  1038.      */
  1039.     protected function generateGlobalButtons()
  1040.     {
  1041.         if (!\is_array($GLOBALS['TL_DCA'][$this->strTable]['list']['global_operations'] ?? null))
  1042.         {
  1043.             return '';
  1044.         }
  1046.         $return = '';
  1048.         foreach ($GLOBALS['TL_DCA'][$this->strTable]['list']['global_operations'] as $k=>$v)
  1049.         {
  1050.             if (!($v['showOnSelect'] ?? null) && Input::get('act') == 'select')
  1051.             {
  1052.                 continue;
  1053.             }
  1055.             $v = \is_array($v) ? $v : array($v);
  1056.             $title = $label = $k;
  1058.             if (isset($v['label']))
  1059.             {
  1060.                 $label = \is_array($v['label']) ? $v['label'][0] : $v['label'];
  1061.                 $title = \is_array($v['label']) ? ($v['label'][1] ?? null) : $v['label'];
  1062.             }
  1064.             $attributes = !empty($v['attributes']) ? ' ' . ltrim($v['attributes']) : '';
  1066.             // Custom icon (see #5541)
  1067.             if ($v['icon'] ?? null)
  1068.             {
  1069.                 $v['class'] = trim(($v['class'] ?? '') . ' header_icon');
  1071.                 // Add the theme path if only the file name is given
  1072.                 if (strpos($v['icon'], '/') === false)
  1073.                 {
  1074.                     $v['icon'] = Image::getPath($v['icon']);
  1075.                 }
  1077.                 $attributes = sprintf(' style="background-image:url(\'%s\')"', Controller::addAssetsUrlTo($v['icon'])) . $attributes;
  1078.             }
  1080.             if (!$label)
  1081.             {
  1082.                 $label = $k;
  1083.             }
  1085.             if (!$title)
  1086.             {
  1087.                 $title = $label;
  1088.             }
  1090.             // Call a custom function instead of using the default button
  1091.             if (\is_array($v['button_callback'] ?? null))
  1092.             {
  1093.                 $this->import($v['button_callback'][0]);
  1094.                 $return .= $this->{$v['button_callback'][0]}->{$v['button_callback'][1]}($v['href'] ?? '', $label, $title, $v['class'], $attributes, $this->strTable, $this->root);
  1095.                 continue;
  1096.             }
  1098.             if (\is_callable($v['button_callback'] ?? null))
  1099.             {
  1100.                 $return .= $v['button_callback']($v['href'] ?? null, $label, $title, $v['class'] ?? null, $attributes, $this->strTable, $this->root);
  1101.                 continue;
  1102.             }
  1104.             if (!empty($v['route']))
  1105.             {
  1106.                 $href = System::getContainer()->get('router')->generate($v['route']);
  1107.             }
  1108.             else
  1109.             {
  1110.                 $href = $this->addToUrl($v['href'] ?? '');
  1111.             }
  1113.             $return .= '<a href="' . $href . '" class="' . $v['class'] . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . $label . '</a> ';
  1114.         }
  1116.         return $return;
  1117.     }
  1119.     /**
  1120.      * Compile header buttons from the table configuration array and return them as HTML
  1121.      *
  1122.      * @param array  $arrRow
  1123.      * @param string $strPtable
  1124.      *
  1125.      * @return string
  1126.      */
  1127.     protected function generateHeaderButtons($arrRow, $strPtable)
  1128.     {
  1129.         if (!\is_array($GLOBALS['TL_DCA'][$strPtable]['list']['operations'] ?? null))
  1130.         {
  1131.             return '';
  1132.         }
  1134.         $return = '';
  1136.         foreach ($GLOBALS['TL_DCA'][$strPtable]['list']['operations'] as $k=> $v)
  1137.         {
  1138.             if (empty($v['showInHeader']) || (Input::get('act') == 'select' && !($v['showOnSelect'] ?? null)))
  1139.             {
  1140.                 continue;
  1141.             }
  1143.             $v = \is_array($v) ? $v : array($v);
  1144.             $id = StringUtil::specialchars(rawurldecode($arrRow['id']));
  1145.             $label = $title = $k;
  1147.             if (isset($v['label']))
  1148.             {
  1149.                 if (\is_array($v['label']))
  1150.                 {
  1151.                     $label = $v['label'][0];
  1152.                     $title = sprintf($v['label'][1], $id);
  1153.                 }
  1154.                 else
  1155.                 {
  1156.                     $label = $title = sprintf($v['label'], $id);
  1157.                 }
  1158.             }
  1160.             $attributes = !empty($v['attributes']) ? ' ' . ltrim(sprintf($v['attributes'], $id, $id)) : '';
  1162.             // Add the key as CSS class
  1163.             if (strpos($attributes, 'class="') !== false)
  1164.             {
  1165.                 $attributes = str_replace('class="', 'class="' . $k . ' ', $attributes);
  1166.             }
  1167.             else
  1168.             {
  1169.                 $attributes = ' class="' . $k . '"' . $attributes;
  1170.             }
  1172.             // Add the parent table to the href
  1173.             if (isset($v['href']))
  1174.             {
  1175.                 $v['href'] .= '&amp;table=' . $strPtable;
  1176.             }
  1177.             else
  1178.             {
  1179.                 $v['href'] = 'table=' . $strPtable;
  1180.             }
  1182.             // Call a custom function instead of using the default button
  1183.             if (\is_array($v['button_callback'] ?? null))
  1184.             {
  1185.                 $this->import($v['button_callback'][0]);
  1186.                 $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);
  1187.                 continue;
  1188.             }
  1190.             if (\is_callable($v['button_callback'] ?? null))
  1191.             {
  1192.                 $return .= $v['button_callback']($arrRow, $v['href'], $label, $title, $v['icon'], $attributes, $strPtable, array(), null, false, null, null, $this);
  1193.                 continue;
  1194.             }
  1196.             if ($k == 'show')
  1197.             {
  1198.                 if (!empty($v['route']))
  1199.                 {
  1200.                     $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id'], 'popup' => '1'));
  1201.                 }
  1202.                 else
  1203.                 {
  1204.                     $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . '&amp;popup=1');
  1205.                 }
  1207.                 $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> ';
  1208.             }
  1209.             else
  1210.             {
  1211.                 if (!empty($v['route']))
  1212.                 {
  1213.                     $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id']));
  1214.                 }
  1215.                 else
  1216.                 {
  1217.                     $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . (Input::get('nb') ? '&amp;nc=1' : ''));
  1218.                 }
  1220.                 parse_str(StringUtil::decodeEntities($v['href']), $params);
  1222.                 if (($params['act'] ?? null) == 'toggle' && isset($params['field']))
  1223.                 {
  1224.                     // Hide the toggle icon if the user does not have access to the field
  1225.                     if (($GLOBALS['TL_DCA'][$strPtable]['fields'][$params['field']]['toggle'] ?? false) !== true || !System::getContainer()->get('security.helper')->isGranted(ContaoCorePermissions::USER_CAN_EDIT_FIELD_OF_TABLE, $strPtable . '::' . $params['field']))
  1226.                     {
  1227.                         continue;
  1228.                     }
  1230.                     $icon = $v['icon'];
  1231.                     $_icon = pathinfo($v['icon'], PATHINFO_FILENAME) . '_.' . pathinfo($v['icon'], PATHINFO_EXTENSION);
  1233.                     if (false !== strpos($v['icon'], '/'))
  1234.                     {
  1235.                         $_icon = \dirname($v['icon']) . '/' . $_icon;
  1236.                     }
  1238.                     if ($icon == 'visible.svg')
  1239.                     {
  1240.                         $_icon = 'invisible.svg';
  1241.                     }
  1243.                     $state = $arrRow[$params['field']] ? 1 : 0;
  1245.                     if ($v['reverse'] ?? false)
  1246.                     {
  1247.                         $state = $arrRow[$params['field']] ? 0 : 1;
  1248.                     }
  1250.                     $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> ';
  1251.                 }
  1252.                 else
  1253.                 {
  1254.                     $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  1255.                 }
  1256.             }
  1257.         }
  1259.         return $return;
  1260.     }
  1262.     /**
  1263.      * Initialize the picker
  1264.      *
  1265.      * @param PickerInterface $picker
  1266.      *
  1267.      * @return array|null
  1268.      */
  1269.     public function initPicker(PickerInterface $picker)
  1270.     {
  1271.         $provider = $picker->getCurrentProvider();
  1273.         if (!$provider instanceof DcaPickerProviderInterface || $provider->getDcaTable($picker->getConfig()) != $this->strTable)
  1274.         {
  1275.             return null;
  1276.         }
  1278.         $attributes = $provider->getDcaAttributes($picker->getConfig());
  1280.         $this->objPicker = $picker;
  1281.         $this->strPickerFieldType = $attributes['fieldType'];
  1283.         $this->objPickerCallback = static function ($value) use ($picker, $provider)
  1284.         {
  1285.             return $provider->convertDcaValue($picker->getConfig(), $value);
  1286.         };
  1288.         if (isset($attributes['value']))
  1289.         {
  1290.             $this->arrPickerValue = (array) $attributes['value'];
  1291.         }
  1293.         return $attributes;
  1294.     }
  1296.     /**
  1297.      * Return the picker input field markup
  1298.      *
  1299.      * @param string $value
  1300.      * @param string $attributes
  1301.      *
  1302.      * @return string
  1303.      */
  1304.     protected function getPickerInputField($value, $attributes='')
  1305.     {
  1306.         $id = is_numeric($value) ? $value : md5($value);
  1308.         switch ($this->strPickerFieldType)
  1309.         {
  1310.             case 'checkbox':
  1311.                 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 . '>';
  1313.             case 'radio':
  1314.                 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 . '>';
  1315.         }
  1317.         return '';
  1318.     }
  1320.     /**
  1321.      * Return the data-picker-value attribute with the currently selected picker values (see #1816)
  1322.      *
  1323.      * @return string
  1324.      */
  1325.     protected function getPickerValueAttribute()
  1326.     {
  1327.         // Only load the previously selected values for the checkbox field type (see #2346)
  1328.         if ($this->strPickerFieldType != 'checkbox')
  1329.         {
  1330.             return '';
  1331.         }
  1333.         $values = array_map($this->objPickerCallback, $this->arrPickerValue);
  1334.         $values = array_map('strval', $values);
  1335.         $values = json_encode($values);
  1336.         $values = htmlspecialchars($values);
  1338.         return ' data-picker-value="' . $values . '"';
  1339.     }
  1341.     /**
  1342.      * Build the sort panel and return it as string
  1343.      *
  1344.      * @return string
  1345.      */
  1346.     protected function panel()
  1347.     {
  1348.         if (!($GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panelLayout'] ?? null))
  1349.         {
  1350.             return '';
  1351.         }
  1353.         // Reset all filters
  1354.         if (isset($_POST['filter_reset']) && Input::post('FORM_SUBMIT') == 'tl_filters')
  1355.         {
  1356.             /** @var AttributeBagInterface $objSessionBag */
  1357.             $objSessionBag = System::getContainer()->get('session')->getBag('contao_backend');
  1358.             $data = $objSessionBag->all();
  1360.             unset(
  1361.                 $data['filter'][$this->strTable],
  1362.                 $data['filter'][$this->strTable . '_' . CURRENT_ID],
  1363.                 $data['sorting'][$this->strTable],
  1364.                 $data['search'][$this->strTable]
  1365.             );
  1367.             $objSessionBag->replace($data);
  1369.             $this->reload();
  1370.         }
  1372.         $intFilterPanel = 0;
  1373.         $arrPanels = array();
  1374.         $arrPanes = StringUtil::trimsplit(';', $GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panelLayout'] ?? '');
  1376.         foreach ($arrPanes as $strPanel)
  1377.         {
  1378.             $panels = '';
  1379.             $arrSubPanels = StringUtil::trimsplit(',', $strPanel);
  1381.             foreach ($arrSubPanels as $strSubPanel)
  1382.             {
  1383.                 $panel = '';
  1385.                 switch ($strSubPanel)
  1386.                 {
  1387.                     case 'limit':
  1388.                         // The limit menu depends on other panels that may set a filter query, e.g. search and filter.
  1389.                         // In order to correctly calculate the total row count, the limit menu must be compiled last.
  1390.                         // We insert a placeholder here and compile the limit menu after all other panels.
  1391.                         $panel = '###limit_menu###';
  1392.                         break;
  1394.                     case 'search':
  1395.                         $panel = $this->searchMenu();
  1396.                         break;
  1398.                     case 'sort':
  1399.                         $panel = $this->sortMenu();
  1400.                         break;
  1402.                     case 'filter':
  1403.                         // Multiple filter subpanels can be defined to split the fields across panels
  1404.                         $panel = $this->filterMenu(++$intFilterPanel);
  1405.                         break;
  1407.                     default:
  1408.                         // Call the panel_callback
  1409.                         $arrCallback = $GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panel_callback'][$strSubPanel] ?? null;
  1411.                         if (\is_array($arrCallback))
  1412.                         {
  1413.                             $this->import($arrCallback[0]);
  1414.                             $panel = $this->{$arrCallback[0]}->{$arrCallback[1]}($this);
  1415.                         }
  1416.                         elseif (\is_callable($arrCallback))
  1417.                         {
  1418.                             $panel = $arrCallback($this);
  1419.                         }
  1420.                 }
  1422.                 // Add the panel if it is not empty
  1423.                 if ($panel)
  1424.                 {
  1425.                     $panels = $panel . $panels;
  1426.                 }
  1427.             }
  1429.             // Add the group if it is not empty
  1430.             if ($panels)
  1431.             {
  1432.                 $arrPanels[] = $panels;
  1433.             }
  1434.         }
  1436.         if (empty($arrPanels))
  1437.         {
  1438.             return '';
  1439.         }
  1441.         // Compile limit menu if placeholder is present
  1442.         foreach ($arrPanels as $key => $strPanel)
  1443.         {
  1444.             if (strpos($strPanel, '###limit_menu###') === false)
  1445.             {
  1446.                 continue;
  1447.             }
  1449.             $arrPanels[$key] = str_replace('###limit_menu###', $this->limitMenu(), $strPanel);
  1450.         }
  1452.         if (Input::post('FORM_SUBMIT') == 'tl_filters')
  1453.         {
  1454.             $this->reload();
  1455.         }
  1457.         $return = '';
  1458.         $intTotal = \count($arrPanels);
  1459.         $intLast = $intTotal - 1;
  1461.         for ($i=0; $i<$intTotal; $i++)
  1462.         {
  1463.             $submit = '';
  1465.             if ($i == $intLast)
  1466.             {
  1467.                 $submit = '
  1468. <div class="tl_submit_panel tl_subpanel">
  1469.   <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>
  1470.   <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>
  1471. </div>';
  1472.             }
  1474.             $return .= '
  1475. <div class="tl_panel cf">
  1476.   ' . $submit . $arrPanels[$i] . '
  1477. </div>';
  1478.         }
  1480.         $return = '
  1481. <form class="tl_form" method="post" aria-label="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['searchAndFilter']) . '">
  1482. <div class="tl_formbody">
  1483.   <input type="hidden" name="FORM_SUBMIT" value="tl_filters">
  1484.   <input type="hidden" name="REQUEST_TOKEN" value="' . REQUEST_TOKEN . '">
  1485.   ' . $return . '
  1486. </div>
  1487. </form>';
  1489.         return $return;
  1490.     }
  1492.     /**
  1493.      * Invalidate the cache tags associated with a given DC
  1494.      *
  1495.      * Call this whenever an entry is modified (added, updated, deleted).
  1496.      */
  1497.     public function invalidateCacheTags()
  1498.     {
  1499.         if (!System::getContainer()->has('fos_http_cache.cache_manager'))
  1500.         {
  1501.             return;
  1502.         }
  1504.         $tags = array('contao.db.' . $this->table . '.' . $this->id);
  1506.         $this->addPtableTags($this->table, $this->id, $tags);
  1508.         // Trigger the oninvalidate_cache_tags_callback
  1509.         if (\is_array($GLOBALS['TL_DCA'][$this->table]['config']['oninvalidate_cache_tags_callback'] ?? null))
  1510.         {
  1511.             foreach ($GLOBALS['TL_DCA'][$this->table]['config']['oninvalidate_cache_tags_callback'] as $callback)
  1512.             {
  1513.                 if (\is_array($callback))
  1514.                 {
  1515.                     $this->import($callback[0]);
  1516.                     $tags = $this->{$callback[0]}->{$callback[1]}($this, $tags);
  1517.                 }
  1518.                 elseif (\is_callable($callback))
  1519.                 {
  1520.                     $tags = $callback($this, $tags);
  1521.                 }
  1522.             }
  1523.         }
  1525.         // Make sure tags are unique and empty ones are removed
  1526.         $tags = array_filter(array_unique($tags));
  1528.         System::getContainer()->get('fos_http_cache.cache_manager')->invalidateTags($tags);
  1529.     }
  1531.     public function addPtableTags($strTable, $intId, &$tags)
  1532.     {
  1533.         $ptable = $GLOBALS['TL_DCA'][$strTable]['list']['sorting']['mode'] == 5 ? $strTable : ($GLOBALS['TL_DCA'][$strTable]['config']['ptable'] ?? null);
  1535.         if (!$ptable)
  1536.         {
  1537.             $tags[] = 'contao.db.' . $strTable;
  1539.             return;
  1540.         }
  1542.         Controller::loadDataContainer($ptable);
  1544.         $objPid = $this->Database->prepare('SELECT pid FROM ' . Database::quoteIdentifier($strTable) . ' WHERE id=?')
  1545.                                  ->execute($intId);
  1547.         if (!$objPid->numRows || $objPid->pid == 0)
  1548.         {
  1549.             $tags[] = 'contao.db.' . $strTable;
  1551.             return;
  1552.         }
  1554.         $tags[] = 'contao.db.' . $ptable . '.' . $objPid->pid;
  1556.         // Do not call recursively (see #4777)
  1557.     }
  1559.     /**
  1560.      * @deprecated Deprecated since Contao 4.9, to be removed in Contao 5.0
  1561.      */
  1562.     public function addCtableTags($strTable, $intId, &$tags)
  1563.     {
  1564.         trigger_deprecation('contao/core-bundle', '4.9', 'Calling "%s()" has been deprecated and will no longer work in Contao 5.0.', __METHOD__);
  1566.         $ctables = $GLOBALS['TL_DCA'][$strTable]['config']['ctable'] ?? array();
  1568.         if (($GLOBALS['TL_DCA'][$strTable]['list']['sorting']['mode'] ?? null) == 5)
  1569.         {
  1570.             $ctables[] = $strTable;
  1571.         }
  1573.         if (!$ctables)
  1574.         {
  1575.             return;
  1576.         }
  1578.         foreach ($ctables as $ctable)
  1579.         {
  1580.             Controller::loadDataContainer($ctable);
  1582.             if ($GLOBALS['TL_DCA'][$ctable]['config']['dynamicPtable'] ?? null)
  1583.             {
  1584.                 $objIds = $this->Database->prepare('SELECT id FROM ' . Database::quoteIdentifier($ctable) . ' WHERE pid=? AND ptable=?')
  1585.                                          ->execute($intId, $strTable);
  1586.             }
  1587.             else
  1588.             {
  1589.                 $objIds = $this->Database->prepare('SELECT id FROM ' . Database::quoteIdentifier($ctable) . ' WHERE pid=?')
  1590.                                          ->execute($intId);
  1591.             }
  1593.             if (!$objIds->numRows)
  1594.             {
  1595.                 continue;
  1596.             }
  1598.             while ($objIds->next())
  1599.             {
  1600.                 $tags[] = 'contao.db.' . $ctable . '.' . $objIds->id;
  1602.                 $this->addCtableTags($ctable, $objIds->id, $tags);
  1603.             }
  1604.         }
  1605.     }
  1607.     /**
  1608.      * Return the form field suffix
  1609.      *
  1610.      * @return integer|string
  1611.      */
  1612.     protected function getFormFieldSuffix()
  1613.     {
  1614.         return $this->intId;
  1615.     }
  1617.     /**
  1618.      * Return the name of the current palette
  1619.      *
  1620.      * @return string
  1621.      */
  1622.     abstract public function getPalette();
  1624.     /**
  1625.      * Save the current value
  1626.      *
  1627.      * @param mixed $varValue
  1628.      *
  1629.      * @throws \Exception
  1630.      */
  1631.     abstract protected function save($varValue);
  1633.     /**
  1634.      * Return the class name of the DataContainer driver for the given table.
  1635.      *
  1636.      * @param string $table
  1637.      *
  1638.      * @return string
  1639.      *
  1640.      * @todo Change the return type to ?string in Contao 5.0
  1641.      */
  1642.     public static function getDriverForTable(string $table): string
  1643.     {
  1644.         if (!isset($GLOBALS['TL_DCA'][$table]['config']['dataContainer']))
  1645.         {
  1646.             return '';
  1647.         }
  1649.         $dataContainer = $GLOBALS['TL_DCA'][$table]['config']['dataContainer'];
  1651.         if ('' !== $dataContainer && false === strpos($dataContainer, '\\'))
  1652.         {
  1653.             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);
  1655.             $dataContainer = 'DC_' . $dataContainer;
  1657.             if (class_exists($dataContainer))
  1658.             {
  1659.                 $ref = new \ReflectionClass($dataContainer);
  1661.                 return $ref->getName();
  1662.             }
  1663.         }
  1665.         return $dataContainer;
  1666.     }
  1668.     /**
  1669.      * Generates the label for a given data record according to the DCA configuration.
  1670.      * Returns an array of strings if 'showColumns' is enabled in the DCA configuration.
  1671.      *
  1672.      * @param array  $row   The data record
  1673.      * @param string $table The name of the data container
  1674.      *
  1675.      * @return string|array<string>
  1676.      */
  1677.     public function generateRecordLabel(array $row, string $table = null, bool $protected = false, bool $isVisibleRootTrailPage = false)
  1678.     {
  1679.         $table = $table ?? $this->strTable;
  1680.         $labelConfig = &$GLOBALS['TL_DCA'][$table]['list']['label'];
  1681.         $args = array();
  1683.         foreach ($labelConfig['fields'] as $k=>$v)
  1684.         {
  1685.             // Decrypt the value
  1686.             if ($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['encrypt'] ?? null)
  1687.             {
  1688.                 $row[$v] = Encryption::decrypt(StringUtil::deserialize($row[$v]));
  1689.             }
  1691.             if (strpos($v, ':') !== false)
  1692.             {
  1693.                 list($strKey, $strTable) = explode(':', $v, 2);
  1694.                 list($strTable, $strField) = explode('.', $strTable, 2);
  1696.                 $objRef = Database::getInstance()
  1697.                     ->prepare("SELECT " . Database::quoteIdentifier($strField) . " FROM " . $strTable . " WHERE id=?")
  1698.                     ->limit(1)
  1699.                     ->execute($row[$strKey]);
  1701.                 $args[$k] = $objRef->numRows ? $objRef->$strField : '';
  1702.             }
  1703.             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)))
  1704.             {
  1705.                 if (($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['rgxp'] ?? null) == 'date')
  1706.                 {
  1707.                     $args[$k] = $row[$v] ? Date::parse(Config::get('dateFormat'), $row[$v]) : '-';
  1708.                 }
  1709.                 elseif (($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['rgxp'] ?? null) == 'time')
  1710.                 {
  1711.                     $args[$k] = $row[$v] ? Date::parse(Config::get('timeFormat'), $row[$v]) : '-';
  1712.                 }
  1713.                 else
  1714.                 {
  1715.                     $args[$k] = $row[$v] ? Date::parse(Config::get('datimFormat'), $row[$v]) : '-';
  1716.                 }
  1717.             }
  1718.             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)))
  1719.             {
  1720.                 $args[$k] = $row[$v] ? $GLOBALS['TL_LANG']['MSC']['yes'] : $GLOBALS['TL_LANG']['MSC']['no'];
  1721.             }
  1722.             elseif (isset($row[$v]))
  1723.             {
  1724.                 $row_v = StringUtil::deserialize($row[$v]);
  1726.                 if (\is_array($row_v))
  1727.                 {
  1728.                     $args_k = array();
  1730.                     foreach ($row_v as $option)
  1731.                     {
  1732.                         $args_k[] = $GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$option] ?? $option;
  1733.                     }
  1735.                     $args[$k] = implode(', ', $args_k);
  1736.                 }
  1737.                 elseif (isset($GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$row[$v]]))
  1738.                 {
  1739.                     $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]];
  1740.                 }
  1741.                 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]]))
  1742.                 {
  1743.                     $args[$k] = $GLOBALS['TL_DCA'][$table]['fields'][$v]['options'][$row[$v]] ?? null;
  1744.                 }
  1745.                 else
  1746.                 {
  1747.                     $args[$k] = $row[$v];
  1748.                 }
  1749.             }
  1750.             else
  1751.             {
  1752.                 $args[$k] = null;
  1753.             }
  1754.         }
  1756.         // Render the label
  1757.         $label = vsprintf($labelConfig['format'] ?? '%s', $args);
  1759.         // Shorten the label it if it is too long
  1760.         if (($labelConfig['maxCharacters'] ?? null) > 0 && $labelConfig['maxCharacters'] < \strlen(strip_tags($label)))
  1761.         {
  1762.             $label = trim(StringUtil::substrHtml($label, $labelConfig['maxCharacters'])) . ' …';
  1763.         }
  1765.         // Remove empty brackets (), [], {}, <> and empty tags from the label
  1766.         $label = preg_replace('/\( *\) ?|\[ *] ?|{ *} ?|< *> ?/', '', $label);
  1767.         $label = preg_replace('/<[^>]+>\s*<\/[^>]+>/', '', $label);
  1769.         $mode = $GLOBALS['TL_DCA'][$table]['list']['sorting']['mode'] ?? self::MODE_SORTED;
  1771.         // Execute label_callback
  1772.         if (\is_array($labelConfig['label_callback'] ?? null) || \is_callable($labelConfig['label_callback'] ?? null))
  1773.         {
  1774.             if (\in_array($mode, array(self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1775.             {
  1776.                 if (\is_array($labelConfig['label_callback'] ?? null))
  1777.                 {
  1778.                     $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this, '', false, $protected, $isVisibleRootTrailPage);
  1779.                 }
  1780.                 else
  1781.                 {
  1782.                     $label = $labelConfig['label_callback']($row, $label, $this, '', false, $protected, $isVisibleRootTrailPage);
  1783.                 }
  1784.             }
  1785.             elseif ($mode === self::MODE_PARENT)
  1786.             {
  1787.                 if (\is_array($labelConfig['label_callback'] ?? null))
  1788.                 {
  1789.                     $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this);
  1790.                 }
  1791.                 else
  1792.                 {
  1793.                     $label = $labelConfig['label_callback']($row, $label, $this);
  1794.                 }
  1795.             }
  1796.             else
  1797.             {
  1798.                 if (\is_array($labelConfig['label_callback'] ?? null))
  1799.                 {
  1800.                     $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this, $args);
  1801.                 }
  1802.                 else
  1803.                 {
  1804.                     $label = $labelConfig['label_callback']($row, $label, $this, $args);
  1805.                 }
  1806.             }
  1807.         }
  1808.         elseif (\in_array($mode, array(self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1809.         {
  1810.             $label = Image::getHtml('iconPLAIN.svg') . ' ' . $label;
  1811.         }
  1813.         if (($labelConfig['showColumns'] ?? null) && !\in_array($mode, array(self::MODE_PARENT, self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1814.         {
  1815.             return \is_array($label) ? $label : $args;
  1816.         }
  1818.         return $label;
  1819.     }
  1820. }
  1822. class_alias(DataContainer::class, 'DataContainer');