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

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;
  319.         }
  321.         return parent::__get($strKey);
  322.     }
  324.     /**
  325.      * Render a row of a box and return it as HTML string
  326.      *
  327.      * @param string|array|null $strPalette
  328.      *
  329.      * @return string
  330.      *
  331.      * @throws AccessDeniedException
  332.      * @throws \Exception
  333.      */
  334.     protected function row($strPalette=null)
  335.     {
  336.         $arrData = $GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField] ?? array();
  338.         // Check if the field is excluded
  339.         if ($arrData['exclude'] ?? null)
  340.         {
  341.             throw new AccessDeniedException('Field "' . $this->strTable . '.' . $this->strField . '" is excluded from being edited.');
  342.         }
  344.         $xlabel = '';
  346.         // Toggle line wrap (textarea)
  347.         if (($arrData['inputType'] ?? null) == 'textarea' && !isset($arrData['eval']['rte']))
  348.         {
  349.             $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 . '\')"');
  350.         }
  352.         // Add the help wizard
  353.         if ($arrData['eval']['helpwizard'] ?? null)
  354.         {
  355.             $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>';
  356.         }
  358.         // Add a custom xlabel
  359.         if (\is_array($arrData['xlabel'] ?? null))
  360.         {
  361.             foreach ($arrData['xlabel'] as $callback)
  362.             {
  363.                 if (\is_array($callback))
  364.                 {
  365.                     $this->import($callback[0]);
  366.                     $xlabel .= $this->{$callback[0]}->{$callback[1]}($this);
  367.                 }
  368.                 elseif (\is_callable($callback))
  369.                 {
  370.                     $xlabel .= $callback($this);
  371.                 }
  372.             }
  373.         }
  375.         // Input field callback
  376.         if (\is_array($arrData['input_field_callback'] ?? null))
  377.         {
  378.             $this->import($arrData['input_field_callback'][0]);
  380.             return $this->{$arrData['input_field_callback'][0]}->{$arrData['input_field_callback'][1]}($this, $xlabel);
  381.         }
  383.         if (\is_callable($arrData['input_field_callback'] ?? null))
  384.         {
  385.             return $arrData['input_field_callback']($this, $xlabel);
  386.         }
  388.         $strClass = $GLOBALS['BE_FFL'][($arrData['inputType'] ?? null)] ?? null;
  390.         // Return if the widget class does not exist
  391.         if (!class_exists($strClass))
  392.         {
  393.             return '';
  394.         }
  396.         $arrData['eval']['required'] = false;
  398.         if ($arrData['eval']['mandatory'] ?? null)
  399.         {
  400.             if (\is_array($this->varValue))
  401.             {
  402.                 if (empty($this->varValue))
  403.                 {
  404.                     $arrData['eval']['required'] = true;
  405.                 }
  406.             }
  407.             // Use strlen() here (see #3277)
  408.             elseif (!\strlen($this->varValue))
  409.             {
  410.                 $arrData['eval']['required'] = true;
  411.             }
  412.         }
  414.         // Convert insert tags in src attributes (see #5965)
  415.         if (isset($arrData['eval']['rte']) && strncmp($arrData['eval']['rte'], 'tiny', 4) === 0)
  416.         {
  417.             $this->varValue = StringUtil::insertTagToSrc($this->varValue);
  418.         }
  420.         // Use raw request if set globally but allow opting out setting useRawRequestData to false explicitly
  421.         $useRawGlobally = isset($GLOBALS['TL_DCA'][$this->strTable]['config']['useRawRequestData']) && $GLOBALS['TL_DCA'][$this->strTable]['config']['useRawRequestData'] === true;
  422.         $notRawForField = isset($arrData['eval']['useRawRequestData']) && $arrData['eval']['useRawRequestData'] === false;
  424.         if ($useRawGlobally && !$notRawForField)
  425.         {
  426.             $arrData['eval']['useRawRequestData'] = true;
  427.         }
  429.         /** @var Widget $objWidget */
  430.         $objWidget = new $strClass($strClass::getAttributesFromDca($arrData, $this->strInputName, $this->varValue, $this->strField, $this->strTable, $this));
  432.         $objWidget->xlabel = $xlabel;
  433.         $objWidget->currentRecord = $this->intId;
  435.         // Validate the field
  436.         if (Input::post('FORM_SUBMIT') == $this->strTable)
  437.         {
  438.             $suffix = $this->getFormFieldSuffix();
  439.             $key = (Input::get('act') == 'editAll') ? 'FORM_FIELDS_' . $suffix : 'FORM_FIELDS';
  441.             // Calculate the current palette
  442.             $postPaletteFields = implode(',', Input::post($key));
  443.             $postPaletteFields = array_unique(StringUtil::trimsplit('[,;]', $postPaletteFields));
  445.             // Compile the palette if there is none
  446.             if ($strPalette === null)
  447.             {
  448.                 $newPaletteFields = StringUtil::trimsplit('[,;]', $this->getPalette());
  449.             }
  450.             else
  451.             {
  452.                 // Use the given palette ($strPalette is an array in editAll mode)
  453.                 $newPaletteFields = \is_array($strPalette) ? $strPalette : StringUtil::trimsplit('[,;]', $strPalette);
  455.                 // Recompile the palette if the current field is a selector field and the value has changed
  456.                 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__']))
  457.                 {
  458.                     $newPaletteFields = StringUtil::trimsplit('[,;]', $this->getPalette());
  459.                 }
  460.             }
  462.             // Adjust the names in editAll mode
  463.             if (Input::get('act') == 'editAll')
  464.             {
  465.                 foreach ($newPaletteFields as $k=>$v)
  466.                 {
  467.                     $newPaletteFields[$k] = $v . '_' . $suffix;
  468.                 }
  470.                 if ($this->User->isAdmin)
  471.                 {
  472.                     $newPaletteFields['pid'] = 'pid_' . $suffix;
  473.                     $newPaletteFields['sorting'] = 'sorting_' . $suffix;
  474.                 }
  475.             }
  477.             $paletteFields = array_intersect($postPaletteFields, $newPaletteFields);
  479.             // Deprecated since Contao 4.2, to be removed in Contao 5.0
  480.             if (!isset($_POST[$this->strInputName]) && \in_array($this->strInputName, $paletteFields))
  481.             {
  482.                 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.');
  483.             }
  485.             // Validate and save the field
  486.             if ($objWidget->submitInput() && (\in_array($this->strInputName, $paletteFields) || Input::get('act') == 'overrideAll'))
  487.             {
  488.                 $objWidget->validate();
  490.                 if ($objWidget->hasErrors())
  491.                 {
  492.                     // Skip mandatory fields on auto-submit (see #4077)
  493.                     if (!$objWidget->mandatory || $objWidget->value || Input::post('SUBMIT_TYPE') != 'auto')
  494.                     {
  495.                         $this->noReload = true;
  496.                     }
  497.                 }
  498.                 // The return value of submitInput() might have changed, therefore check it again here (see #2383)
  499.                 elseif ($objWidget->submitInput())
  500.                 {
  501.                     $varValue = $objWidget->value;
  503.                     // Sort array by key (fix for JavaScript wizards)
  504.                     if (\is_array($varValue))
  505.                     {
  506.                         ksort($varValue);
  507.                         $varValue = serialize($varValue);
  508.                     }
  510.                     // Convert file paths in src attributes (see #5965)
  511.                     if ($varValue && isset($arrData['eval']['rte']) && strncmp($arrData['eval']['rte'], 'tiny', 4) === 0)
  512.                     {
  513.                         $varValue = StringUtil::srcToInsertTag($varValue);
  514.                     }
  516.                     // Save the current value
  517.                     try
  518.                     {
  519.                         $this->save($varValue);
  520.                     }
  521.                     catch (ResponseException $e)
  522.                     {
  523.                         throw $e;
  524.                     }
  525.                     catch (\Exception $e)
  526.                     {
  527.                         $this->noReload = true;
  528.                         $objWidget->addError($e->getMessage());
  529.                     }
  530.                 }
  531.             }
  532.         }
  534.         $wizard = '';
  535.         $strHelpClass = '';
  537.         // Date picker
  538.         if ($arrData['eval']['datepicker'] ?? null)
  539.         {
  540.             $rgxp = $arrData['eval']['rgxp'] ?? 'date';
  541.             $format = Date::formatToJs(Config::get($rgxp . 'Format'));
  543.             switch ($rgxp)
  544.             {
  545.                 case 'datim':
  546.                     $time = ",\n        timePicker: true";
  547.                     break;
  549.                 case 'time':
  550.                     $time = ",\n        pickOnly: \"time\"";
  551.                     break;
  553.                 default:
  554.                     $time = '';
  555.                     break;
  556.             }
  558.             $strOnSelect = '';
  560.             // Trigger the auto-submit function (see #8603)
  561.             if ($arrData['eval']['submitOnChange'] ?? null)
  562.             {
  563.                 $strOnSelect = ",\n        onSelect: function() { Backend.autoSubmit(\"" . $this->strTable . "\"); }";
  564.             }
  566.             $wizard .= ' ' . Image::getHtml('assets/datepicker/images/icon.svg', '', 'title="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['datepicker']) . '" id="toggle_' . $objWidget->id . '" style="cursor:pointer"') . '
  567.   <script>
  568.     window.addEvent("domready", function() {
  569.       new Picker.Date($("ctrl_' . $objWidget->id . '"), {
  570.         draggable: false,
  571.         toggle: $("toggle_' . $objWidget->id . '"),
  572.         format: "' . $format . '",
  573.         positionOffset: {x:-211,y:-209}' . $time . ',
  574.         pickerClass: "datepicker_bootstrap",
  575.         useFadeInOut: !Browser.ie' . $strOnSelect . ',
  576.         startDay: ' . $GLOBALS['TL_LANG']['MSC']['weekOffset'] . ',
  577.         titleFormat: "' . $GLOBALS['TL_LANG']['MSC']['titleFormat'] . '"
  578.       });
  579.     });
  580.   </script>';
  581.         }
  583.         // Color picker
  584.         if ($arrData['eval']['colorpicker'] ?? null)
  585.         {
  586.             // Support single fields as well (see #5240)
  587.             $strKey = ($arrData['eval']['multiple'] ?? null) ? $this->strField . '_0' : $this->strField;
  589.             $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"') . '
  590.   <script>
  591.     window.addEvent("domready", function() {
  592.       var cl = $("ctrl_' . $strKey . '").value.hexToRgb(true) || [255, 0, 0];
  593.       new MooRainbow("moo_' . $this->strField . '", {
  594.         id: "ctrl_' . $strKey . '",
  595.         startColor: cl,
  596.         imgPath: "assets/colorpicker/images/",
  597.         onComplete: function(color) {
  598.           $("ctrl_' . $strKey . '").value = color.hex.replace("#", "");
  599.         }
  600.       });
  601.     });
  602.   </script>';
  603.         }
  605.         $arrClasses = StringUtil::trimsplit(' ', $arrData['eval']['tl_class'] ?? '');
  607.         // DCA picker
  608.         if (isset($arrData['eval']['dcaPicker']) && (\is_array($arrData['eval']['dcaPicker']) || $arrData['eval']['dcaPicker'] === true))
  609.         {
  610.             $arrClasses[] = 'dcapicker';
  611.             $wizard .= Backend::getDcaPickerWizard($arrData['eval']['dcaPicker'], $this->strTable, $this->strField, $this->strInputName);
  612.         }
  614.         if (($arrData['inputType'] ?? null) == 'password')
  615.         {
  616.             $wizard .= Backend::getTogglePasswordWizard($this->strInputName);
  617.         }
  619.         // Add a custom wizard
  620.         if (\is_array($arrData['wizard'] ?? null))
  621.         {
  622.             foreach ($arrData['wizard'] as $callback)
  623.             {
  624.                 if (\is_array($callback))
  625.                 {
  626.                     $this->import($callback[0]);
  627.                     $wizard .= $this->{$callback[0]}->{$callback[1]}($this);
  628.                 }
  629.                 elseif (\is_callable($callback))
  630.                 {
  631.                     $wizard .= $callback($this);
  632.                 }
  633.             }
  634.         }
  636.         $hasWizardClass = \in_array('wizard', $arrClasses);
  638.         if ($wizard && !($arrData['eval']['disabled'] ?? false) && !($arrData['eval']['readonly'] ?? false))
  639.         {
  640.             $objWidget->wizard = $wizard;
  642.             if (!$hasWizardClass)
  643.             {
  644.                 $arrClasses[] = 'wizard';
  645.             }
  646.         }
  647.         elseif ($hasWizardClass)
  648.         {
  649.             unset($arrClasses[array_search('wizard', $arrClasses)]);
  650.         }
  652.         // Set correct form enctype
  653.         if ($objWidget instanceof UploadableWidgetInterface)
  654.         {
  655.             $this->blnUploadable = true;
  656.         }
  658.         $arrClasses[] = 'widget';
  660.         // Mark floated single checkboxes
  661.         if (($arrData['inputType'] ?? null) == 'checkbox' && !($arrData['eval']['multiple'] ?? null) && \in_array('w50', $arrClasses))
  662.         {
  663.             $arrClasses[] = 'cbx';
  664.         }
  665.         elseif (($arrData['inputType'] ?? null) == 'text' && ($arrData['eval']['multiple'] ?? null) && \in_array('wizard', $arrClasses))
  666.         {
  667.             $arrClasses[] = 'inline';
  668.         }
  670.         if (!empty($arrClasses))
  671.         {
  672.             $arrData['eval']['tl_class'] = implode(' ', array_unique($arrClasses));
  673.         }
  675.         $updateMode = '';
  677.         // Replace the textarea with an RTE instance
  678.         if (!empty($arrData['eval']['rte']))
  679.         {
  680.             list($file, $type) = explode('|', $arrData['eval']['rte'], 2) + array(null, null);
  682.             $fileBrowserTypes = array();
  683.             $pickerBuilder = System::getContainer()->get('contao.picker.builder');
  685.             foreach (array('file' => 'image', 'link' => 'file') as $context => $fileBrowserType)
  686.             {
  687.                 if ($pickerBuilder->supportsContext($context))
  688.                 {
  689.                     $fileBrowserTypes[] = $fileBrowserType;
  690.                 }
  691.             }
  693.             $objTemplate = new BackendTemplate('be_' . $file);
  694.             $objTemplate->selector = 'ctrl_' . $this->strInputName;
  695.             $objTemplate->type = $type;
  696.             $objTemplate->fileBrowserTypes = $fileBrowserTypes;
  697.             $objTemplate->source = $this->strTable . '.' . $this->intId;
  699.             // Deprecated since Contao 4.0, to be removed in Contao 5.0
  700.             $objTemplate->language = Backend::getTinyMceLanguage();
  702.             $updateMode = $objTemplate->parse();
  704.             unset($file, $type, $pickerBuilder, $fileBrowserTypes, $fileBrowserType);
  705.         }
  707.         // Handle multi-select fields in "override all" mode
  708.         elseif ((($arrData['inputType'] ?? null) == 'checkbox' || ($arrData['inputType'] ?? null) == 'checkboxWizard') && ($arrData['eval']['multiple'] ?? null) && Input::get('act') == 'overrideAll')
  709.         {
  710.             $updateMode = '
  711. </div>
  712. <div class="widget">
  713.   <fieldset class="tl_radio_container">
  714.   <legend>' . $GLOBALS['TL_LANG']['MSC']['updateMode'] . '</legend>
  715.     <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>
  716.     <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>
  717.     <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>
  718.   </fieldset>';
  719.         }
  721.         $strPreview = '';
  723.         // Show a preview image (see #4948)
  724.         if ($this->strTable == 'tl_files' && $this->strField == 'name' && $this->objActiveRecord !== null && $this->objActiveRecord->type == 'file')
  725.         {
  726.             $objFile = new File($this->objActiveRecord->path);
  728.             if ($objFile->isImage)
  729.             {
  730.                 $blnCanResize = true;
  732.                 if ($objFile->isSvgImage)
  733.                 {
  734.                     // SVG images with undefined sizes cannot be resized
  735.                     if (!$objFile->viewWidth || !$objFile->viewHeight)
  736.                     {
  737.                         $blnCanResize= false;
  738.                     }
  739.                 }
  740.                 elseif (System::getContainer()->get('contao.image.imagine') instanceof Imagine)
  741.                 {
  742.                     // Check the maximum width and height if the GDlib is used to resize images
  743.                     if ($objFile->height > Config::get('gdMaxImgHeight') || $objFile->width > Config::get('gdMaxImgWidth'))
  744.                     {
  745.                         $blnCanResize = false;
  746.                     }
  747.                 }
  749.                 if ($blnCanResize)
  750.                 {
  751.                     $container = System::getContainer();
  752.                     $projectDir = $container->getParameter('kernel.project_dir');
  753.                     $image = rawurldecode($container->get('contao.image.factory')->create($projectDir . '/' . $objFile->path, array(699, 524, ResizeConfiguration::MODE_BOX))->getUrl($projectDir));
  754.                 }
  755.                 else
  756.                 {
  757.                     $image = Image::getPath('placeholder.svg');
  758.                 }
  760.                 $objImage = new File($image);
  761.                 $ctrl = 'ctrl_preview_' . substr(md5($image), 0, 8);
  763.                 $strPreview = '
  764. <div id="' . $ctrl . '" class="tl_edit_preview">
  765.   <img src="' . $objImage->dataUri . '" width="' . $objImage->width . '" height="' . $objImage->height . '" alt="">
  766. </div>';
  768.                 // Add the script to mark the important part
  769.                 if (basename($image) !== 'placeholder.svg')
  770.                 {
  771.                     $strPreview .= '<script>Backend.editPreviewWizard($(\'' . $ctrl . '\'));</script>';
  773.                     if (Config::get('showHelp'))
  774.                     {
  775.                         $strPreview .= '<p class="tl_help tl_tip">' . $GLOBALS['TL_LANG'][$this->strTable]['edit_preview_help'] . '</p>';
  776.                     }
  778.                     $strPreview = '<div class="widget">' . $strPreview . '</div>';
  779.                 }
  780.             }
  781.         }
  783.         return $strPreview . '
  784. <div' . (!empty($arrData['eval']['tl_class']) ? ' class="' . trim($arrData['eval']['tl_class']) . '"' : '') . '>' . $objWidget->parse() . $updateMode . (!$objWidget->hasErrors() ? $this->help($strHelpClass) : '') . '
  785. </div>';
  786.     }
  788.     /**
  789.      * Return the field explanation as HTML string
  790.      *
  791.      * @param string $strClass
  792.      *
  793.      * @return string
  794.      */
  795.     public function help($strClass='')
  796.     {
  797.         $return = $GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField]['label'][1] ?? null;
  799.         if (!$return || ($GLOBALS['TL_DCA'][$this->strTable]['fields'][$this->strField]['inputType'] ?? null) == 'password' || !Config::get('showHelp'))
  800.         {
  801.             return '';
  802.         }
  804.         return '
  805.   <p class="tl_help tl_tip' . $strClass . '">' . $return . '</p>';
  806.     }
  808.     /**
  809.      * Generate possible palette names from an array by taking the first value and either adding or not adding the following values
  810.      *
  811.      * @param array $names
  812.      *
  813.      * @return array
  814.      */
  815.     protected function combiner($names)
  816.     {
  817.         $return = array('');
  818.         $names = array_values($names);
  820.         for ($i=0, $c=\count($names); $i<$c; $i++)
  821.         {
  822.             $buffer = array();
  824.             foreach ($return as $k=>$v)
  825.             {
  826.                 $buffer[] = ($k%2 == 0) ? $v : $v . $names[$i];
  827.                 $buffer[] = ($k%2 == 0) ? $v . $names[$i] : $v;
  828.             }
  830.             $return = $buffer;
  831.         }
  833.         return array_filter($return);
  834.     }
  836.     /**
  837.      * Return a query string that switches into edit mode
  838.      *
  839.      * @param integer $id
  840.      *
  841.      * @return string
  842.      */
  843.     protected function switchToEdit($id)
  844.     {
  845.         $arrKeys = array();
  846.         $arrUnset = array('act', 'key', 'id', 'table', 'mode', 'pid');
  848.         foreach (array_keys($_GET) as $strKey)
  849.         {
  850.             if (!\in_array($strKey, $arrUnset))
  851.             {
  852.                 $arrKeys[$strKey] = $strKey . '=' . Input::get($strKey);
  853.             }
  854.         }
  856.         $strUrl = TL_SCRIPT . '?' . implode('&', $arrKeys);
  858.         return $strUrl . (!empty($arrKeys) ? '&' : '') . (Input::get('table') ? 'table=' . Input::get('table') . '&amp;' : '') . 'act=edit&amp;id=' . rawurlencode($id);
  859.     }
  861.     /**
  862.      * Compile buttons from the table configuration array and return them as HTML
  863.      *
  864.      * @param array   $arrRow
  865.      * @param string  $strTable
  866.      * @param array   $arrRootIds
  867.      * @param boolean $blnCircularReference
  868.      * @param array   $arrChildRecordIds
  869.      * @param string  $strPrevious
  870.      * @param string  $strNext
  871.      *
  872.      * @return string
  873.      */
  874.     protected function generateButtons($arrRow, $strTable, $arrRootIds=array(), $blnCircularReference=false, $arrChildRecordIds=null, $strPrevious=null, $strNext=null)
  875.     {
  876.         if (!\is_array($GLOBALS['TL_DCA'][$strTable]['list']['operations'] ?? null))
  877.         {
  878.             return '';
  879.         }
  881.         $return = '';
  883.         foreach ($GLOBALS['TL_DCA'][$strTable]['list']['operations'] as $k=>$v)
  884.         {
  885.             $v = \is_array($v) ? $v : array($v);
  886.             $id = StringUtil::specialchars(rawurldecode($arrRow['id']));
  887.             $label = $title = $k;
  889.             if (isset($v['label']))
  890.             {
  891.                 if (\is_array($v['label']))
  892.                 {
  893.                     $label = $v['label'][0] ?? null;
  894.                     $title = sprintf($v['label'][1] ?? '', $id);
  895.                 }
  896.                 else
  897.                 {
  898.                     $label = $title = sprintf($v['label'], $id);
  899.                 }
  900.             }
  902.             $attributes = !empty($v['attributes']) ? ' ' . ltrim(sprintf($v['attributes'], $id, $id)) : '';
  904.             // Add the key as CSS class
  905.             if (strpos($attributes, 'class="') !== false)
  906.             {
  907.                 $attributes = str_replace('class="', 'class="' . $k . ' ', $attributes);
  908.             }
  909.             else
  910.             {
  911.                 $attributes = ' class="' . $k . '"' . $attributes;
  912.             }
  914.             // Call a custom function instead of using the default button
  915.             if (\is_array($v['button_callback'] ?? null))
  916.             {
  917.                 $this->import($v['button_callback'][0]);
  918.                 $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);
  919.                 continue;
  920.             }
  922.             if (\is_callable($v['button_callback'] ?? null))
  923.             {
  924.                 $return .= $v['button_callback']($arrRow, $v['href'] ?? null, $label, $title, $v['icon'] ?? null, $attributes, $strTable, $arrRootIds, $arrChildRecordIds, $blnCircularReference, $strPrevious, $strNext, $this);
  925.                 continue;
  926.             }
  928.             // Generate all buttons except "move up" and "move down" buttons
  929.             if ($k != 'move' && $v != 'move')
  930.             {
  931.                 if ($k == 'show')
  932.                 {
  933.                     if (!empty($v['route']))
  934.                     {
  935.                         $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id'], 'popup' => '1'));
  936.                     }
  937.                     else
  938.                     {
  939.                         $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . '&amp;popup=1');
  940.                     }
  942.                     $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> ';
  943.                 }
  944.                 else
  945.                 {
  946.                     if (!empty($v['route']))
  947.                     {
  948.                         $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id']));
  949.                     }
  950.                     else
  951.                     {
  952.                         $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . (Input::get('nb') ? '&amp;nc=1' : ''));
  953.                     }
  955.                     parse_str(StringUtil::decodeEntities($v['href'] ?? ''), $params);
  957.                     if (($params['act'] ?? null) == 'toggle' && isset($params['field']))
  958.                     {
  959.                         // Hide the toggle icon if the user does not have access to the field
  960.                         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']))
  961.                         {
  962.                             continue;
  963.                         }
  965.                         $icon = $v['icon'];
  966.                         $_icon = pathinfo($v['icon'], PATHINFO_FILENAME) . '_.' . pathinfo($v['icon'], PATHINFO_EXTENSION);
  968.                         if (false !== strpos($v['icon'], '/'))
  969.                         {
  970.                             $_icon = \dirname($v['icon']) . '/' . $_icon;
  971.                         }
  973.                         if ($icon == 'visible.svg')
  974.                         {
  975.                             $_icon = 'invisible.svg';
  976.                         }
  978.                         $state = $arrRow[$params['field']] ? 1 : 0;
  980.                         if ($v['reverse'] ?? false)
  981.                         {
  982.                             $state = $arrRow[$params['field']] ? 0 : 1;
  983.                         }
  985.                         $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> ';
  986.                     }
  987.                     else
  988.                     {
  989.                         $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  990.                     }
  991.                 }
  993.                 continue;
  994.             }
  996.             trigger_deprecation('contao/core-bundle', '4.13', 'The DCA "move" operation is deprecated and will be removed in Contao 5.');
  998.             $arrDirections = array('up', 'down');
  999.             $arrRootIds = \is_array($arrRootIds) ? $arrRootIds : array($arrRootIds);
  1001.             foreach ($arrDirections as $dir)
  1002.             {
  1003.                 $label = !empty($GLOBALS['TL_LANG'][$strTable][$dir][0]) ? $GLOBALS['TL_LANG'][$strTable][$dir][0] : $dir;
  1004.                 $title = !empty($GLOBALS['TL_LANG'][$strTable][$dir][1]) ? $GLOBALS['TL_LANG'][$strTable][$dir][1] : $dir;
  1006.                 $label = Image::getHtml($dir . '.svg', $label);
  1007.                 $href = !empty($v['href']) ? $v['href'] : '&amp;act=move';
  1009.                 if ($dir == 'up')
  1010.                 {
  1011.                     $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')) . ' ';
  1012.                 }
  1013.                 else
  1014.                 {
  1015.                     $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')) . ' ';
  1016.                 }
  1017.             }
  1018.         }
  1020.         return trim($return);
  1021.     }
  1023.     /**
  1024.      * Compile global buttons from the table configuration array and return them as HTML
  1025.      *
  1026.      * @return string
  1027.      */
  1028.     protected function generateGlobalButtons()
  1029.     {
  1030.         if (!\is_array($GLOBALS['TL_DCA'][$this->strTable]['list']['global_operations'] ?? null))
  1031.         {
  1032.             return '';
  1033.         }
  1035.         $return = '';
  1037.         foreach ($GLOBALS['TL_DCA'][$this->strTable]['list']['global_operations'] as $k=>$v)
  1038.         {
  1039.             if (!($v['showOnSelect'] ?? null) && Input::get('act') == 'select')
  1040.             {
  1041.                 continue;
  1042.             }
  1044.             $v = \is_array($v) ? $v : array($v);
  1045.             $title = $label = $k;
  1047.             if (isset($v['label']))
  1048.             {
  1049.                 $label = \is_array($v['label']) ? $v['label'][0] : $v['label'];
  1050.                 $title = \is_array($v['label']) ? ($v['label'][1] ?? null) : $v['label'];
  1051.             }
  1053.             $attributes = !empty($v['attributes']) ? ' ' . ltrim($v['attributes']) : '';
  1055.             // Custom icon (see #5541)
  1056.             if ($v['icon'] ?? null)
  1057.             {
  1058.                 $v['class'] = trim(($v['class'] ?? '') . ' header_icon');
  1060.                 // Add the theme path if only the file name is given
  1061.                 if (strpos($v['icon'], '/') === false)
  1062.                 {
  1063.                     $v['icon'] = Image::getPath($v['icon']);
  1064.                 }
  1066.                 $attributes = sprintf(' style="background-image:url(\'%s\')"', Controller::addAssetsUrlTo($v['icon'])) . $attributes;
  1067.             }
  1069.             if (!$label)
  1070.             {
  1071.                 $label = $k;
  1072.             }
  1074.             if (!$title)
  1075.             {
  1076.                 $title = $label;
  1077.             }
  1079.             // Call a custom function instead of using the default button
  1080.             if (\is_array($v['button_callback'] ?? null))
  1081.             {
  1082.                 $this->import($v['button_callback'][0]);
  1083.                 $return .= $this->{$v['button_callback'][0]}->{$v['button_callback'][1]}($v['href'], $label, $title, $v['class'], $attributes, $this->strTable, $this->root);
  1084.                 continue;
  1085.             }
  1087.             if (\is_callable($v['button_callback'] ?? null))
  1088.             {
  1089.                 $return .= $v['button_callback']($v['href'] ?? null, $label, $title, $v['class'] ?? null, $attributes, $this->strTable, $this->root);
  1090.                 continue;
  1091.             }
  1093.             if (!empty($v['route']))
  1094.             {
  1095.                 $href = System::getContainer()->get('router')->generate($v['route']);
  1096.             }
  1097.             else
  1098.             {
  1099.                 $href = $this->addToUrl($v['href']);
  1100.             }
  1102.             $return .= '<a href="' . $href . '" class="' . $v['class'] . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . $label . '</a> ';
  1103.         }
  1105.         return $return;
  1106.     }
  1108.     /**
  1109.      * Compile header buttons from the table configuration array and return them as HTML
  1110.      *
  1111.      * @param array  $arrRow
  1112.      * @param string $strPtable
  1113.      *
  1114.      * @return string
  1115.      */
  1116.     protected function generateHeaderButtons($arrRow, $strPtable)
  1117.     {
  1118.         if (!\is_array($GLOBALS['TL_DCA'][$strPtable]['list']['operations'] ?? null))
  1119.         {
  1120.             return '';
  1121.         }
  1123.         $return = '';
  1125.         foreach ($GLOBALS['TL_DCA'][$strPtable]['list']['operations'] as $k=> $v)
  1126.         {
  1127.             if (empty($v['showInHeader']) || (Input::get('act') == 'select' && !($v['showOnSelect'] ?? null)))
  1128.             {
  1129.                 continue;
  1130.             }
  1132.             $v = \is_array($v) ? $v : array($v);
  1133.             $id = StringUtil::specialchars(rawurldecode($arrRow['id']));
  1134.             $label = $title = $k;
  1136.             if (isset($v['label']))
  1137.             {
  1138.                 if (\is_array($v['label']))
  1139.                 {
  1140.                     $label = $v['label'][0];
  1141.                     $title = sprintf($v['label'][1], $id);
  1142.                 }
  1143.                 else
  1144.                 {
  1145.                     $label = $title = sprintf($v['label'], $id);
  1146.                 }
  1147.             }
  1149.             $attributes = !empty($v['attributes']) ? ' ' . ltrim(sprintf($v['attributes'], $id, $id)) : '';
  1151.             // Add the key as CSS class
  1152.             if (strpos($attributes, 'class="') !== false)
  1153.             {
  1154.                 $attributes = str_replace('class="', 'class="' . $k . ' ', $attributes);
  1155.             }
  1156.             else
  1157.             {
  1158.                 $attributes = ' class="' . $k . '"' . $attributes;
  1159.             }
  1161.             // Add the parent table to the href
  1162.             if (isset($v['href']))
  1163.             {
  1164.                 $v['href'] .= '&amp;table=' . $strPtable;
  1165.             }
  1166.             else
  1167.             {
  1168.                 $v['href'] = 'table=' . $strPtable;
  1169.             }
  1171.             // Call a custom function instead of using the default button
  1172.             if (\is_array($v['button_callback'] ?? null))
  1173.             {
  1174.                 $this->import($v['button_callback'][0]);
  1175.                 $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);
  1176.                 continue;
  1177.             }
  1179.             if (\is_callable($v['button_callback'] ?? null))
  1180.             {
  1181.                 $return .= $v['button_callback']($arrRow, $v['href'], $label, $title, $v['icon'], $attributes, $strPtable, array(), null, false, null, null, $this);
  1182.                 continue;
  1183.             }
  1185.             if ($k == 'show')
  1186.             {
  1187.                 if (!empty($v['route']))
  1188.                 {
  1189.                     $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id'], 'popup' => '1'));
  1190.                 }
  1191.                 else
  1192.                 {
  1193.                     $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . '&amp;popup=1');
  1194.                 }
  1196.                 $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> ';
  1197.             }
  1198.             else
  1199.             {
  1200.                 if (!empty($v['route']))
  1201.                 {
  1202.                     $href = System::getContainer()->get('router')->generate($v['route'], array('id' => $arrRow['id']));
  1203.                 }
  1204.                 else
  1205.                 {
  1206.                     $href = $this->addToUrl($v['href'] . '&amp;id=' . $arrRow['id'] . (Input::get('nb') ? '&amp;nc=1' : ''));
  1207.                 }
  1209.                 parse_str(StringUtil::decodeEntities($v['href']), $params);
  1211.                 if (($params['act'] ?? null) == 'toggle' && isset($params['field']))
  1212.                 {
  1213.                     // Hide the toggle icon if the user does not have access to the field
  1214.                     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']))
  1215.                     {
  1216.                         continue;
  1217.                     }
  1219.                     $icon = $v['icon'];
  1220.                     $_icon = pathinfo($v['icon'], PATHINFO_FILENAME) . '_.' . pathinfo($v['icon'], PATHINFO_EXTENSION);
  1222.                     if (false !== strpos($v['icon'], '/'))
  1223.                     {
  1224.                         $_icon = \dirname($v['icon']) . '/' . $_icon;
  1225.                     }
  1227.                     if ($icon == 'visible.svg')
  1228.                     {
  1229.                         $_icon = 'invisible.svg';
  1230.                     }
  1232.                     $state = $arrRow[$params['field']] ? 1 : 0;
  1234.                     if ($v['reverse'] ?? false)
  1235.                     {
  1236.                         $state = $arrRow[$params['field']] ? 0 : 1;
  1237.                     }
  1239.                     $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> ';
  1240.                 }
  1241.                 else
  1242.                 {
  1243.                     $return .= '<a href="' . $href . '" title="' . StringUtil::specialchars($title) . '"' . $attributes . '>' . Image::getHtml($v['icon'], $label) . '</a> ';
  1244.                 }
  1245.             }
  1246.         }
  1248.         return $return;
  1249.     }
  1251.     /**
  1252.      * Initialize the picker
  1253.      *
  1254.      * @param PickerInterface $picker
  1255.      *
  1256.      * @return array|null
  1257.      */
  1258.     public function initPicker(PickerInterface $picker)
  1259.     {
  1260.         $provider = $picker->getCurrentProvider();
  1262.         if (!$provider instanceof DcaPickerProviderInterface || $provider->getDcaTable($picker->getConfig()) != $this->strTable)
  1263.         {
  1264.             return null;
  1265.         }
  1267.         $attributes = $provider->getDcaAttributes($picker->getConfig());
  1269.         $this->objPicker = $picker;
  1270.         $this->strPickerFieldType = $attributes['fieldType'];
  1272.         $this->objPickerCallback = static function ($value) use ($picker, $provider)
  1273.         {
  1274.             return $provider->convertDcaValue($picker->getConfig(), $value);
  1275.         };
  1277.         if (isset($attributes['value']))
  1278.         {
  1279.             $this->arrPickerValue = (array) $attributes['value'];
  1280.         }
  1282.         return $attributes;
  1283.     }
  1285.     /**
  1286.      * Return the picker input field markup
  1287.      *
  1288.      * @param string $value
  1289.      * @param string $attributes
  1290.      *
  1291.      * @return string
  1292.      */
  1293.     protected function getPickerInputField($value, $attributes='')
  1294.     {
  1295.         $id = is_numeric($value) ? $value : md5($value);
  1297.         switch ($this->strPickerFieldType)
  1298.         {
  1299.             case 'checkbox':
  1300.                 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 . '>';
  1302.             case 'radio':
  1303.                 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 . '>';
  1304.         }
  1306.         return '';
  1307.     }
  1309.     /**
  1310.      * Return the data-picker-value attribute with the currently selected picker values (see #1816)
  1311.      *
  1312.      * @return string
  1313.      */
  1314.     protected function getPickerValueAttribute()
  1315.     {
  1316.         // Only load the previously selected values for the checkbox field type (see #2346)
  1317.         if ($this->strPickerFieldType != 'checkbox')
  1318.         {
  1319.             return '';
  1320.         }
  1322.         $values = array_map($this->objPickerCallback, $this->arrPickerValue);
  1323.         $values = array_map('strval', $values);
  1324.         $values = json_encode($values);
  1325.         $values = htmlspecialchars($values);
  1327.         return ' data-picker-value="' . $values . '"';
  1328.     }
  1330.     /**
  1331.      * Build the sort panel and return it as string
  1332.      *
  1333.      * @return string
  1334.      */
  1335.     protected function panel()
  1336.     {
  1337.         if (!($GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panelLayout'] ?? null))
  1338.         {
  1339.             return '';
  1340.         }
  1342.         // Reset all filters
  1343.         if (isset($_POST['filter_reset']) && Input::post('FORM_SUBMIT') == 'tl_filters')
  1344.         {
  1345.             /** @var AttributeBagInterface $objSessionBag */
  1346.             $objSessionBag = System::getContainer()->get('session')->getBag('contao_backend');
  1347.             $data = $objSessionBag->all();
  1349.             unset(
  1350.                 $data['filter'][$this->strTable],
  1351.                 $data['filter'][$this->strTable . '_' . CURRENT_ID],
  1352.                 $data['sorting'][$this->strTable],
  1353.                 $data['search'][$this->strTable]
  1354.             );
  1356.             $objSessionBag->replace($data);
  1358.             $this->reload();
  1359.         }
  1361.         $intFilterPanel = 0;
  1362.         $arrPanels = array();
  1363.         $arrPanes = StringUtil::trimsplit(';', $GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panelLayout'] ?? '');
  1365.         foreach ($arrPanes as $strPanel)
  1366.         {
  1367.             $panels = '';
  1368.             $arrSubPanels = StringUtil::trimsplit(',', $strPanel);
  1370.             foreach ($arrSubPanels as $strSubPanel)
  1371.             {
  1372.                 $panel = '';
  1374.                 switch ($strSubPanel)
  1375.                 {
  1376.                     case 'limit':
  1377.                         // The limit menu depends on other panels that may set a filter query, e.g. search and filter.
  1378.                         // In order to correctly calculate the total row count, the limit menu must be compiled last.
  1379.                         // We insert a placeholder here and compile the limit menu after all other panels.
  1380.                         $panel = '###limit_menu###';
  1381.                         break;
  1383.                     case 'search':
  1384.                         $panel = $this->searchMenu();
  1385.                         break;
  1387.                     case 'sort':
  1388.                         $panel = $this->sortMenu();
  1389.                         break;
  1391.                     case 'filter':
  1392.                         // Multiple filter subpanels can be defined to split the fields across panels
  1393.                         $panel = $this->filterMenu(++$intFilterPanel);
  1394.                         break;
  1396.                     default:
  1397.                         // Call the panel_callback
  1398.                         $arrCallback = $GLOBALS['TL_DCA'][$this->strTable]['list']['sorting']['panel_callback'][$strSubPanel] ?? null;
  1400.                         if (\is_array($arrCallback))
  1401.                         {
  1402.                             $this->import($arrCallback[0]);
  1403.                             $panel = $this->{$arrCallback[0]}->{$arrCallback[1]}($this);
  1404.                         }
  1405.                         elseif (\is_callable($arrCallback))
  1406.                         {
  1407.                             $panel = $arrCallback($this);
  1408.                         }
  1409.                 }
  1411.                 // Add the panel if it is not empty
  1412.                 if ($panel)
  1413.                 {
  1414.                     $panels = $panel . $panels;
  1415.                 }
  1416.             }
  1418.             // Add the group if it is not empty
  1419.             if ($panels)
  1420.             {
  1421.                 $arrPanels[] = $panels;
  1422.             }
  1423.         }
  1425.         if (empty($arrPanels))
  1426.         {
  1427.             return '';
  1428.         }
  1430.         // Compile limit menu if placeholder is present
  1431.         foreach ($arrPanels as $key => $strPanel)
  1432.         {
  1433.             if (strpos($strPanel, '###limit_menu###') === false)
  1434.             {
  1435.                 continue;
  1436.             }
  1438.             $arrPanels[$key] = str_replace('###limit_menu###', $this->limitMenu(), $strPanel);
  1439.         }
  1441.         if (Input::post('FORM_SUBMIT') == 'tl_filters')
  1442.         {
  1443.             $this->reload();
  1444.         }
  1446.         $return = '';
  1447.         $intTotal = \count($arrPanels);
  1448.         $intLast = $intTotal - 1;
  1450.         for ($i=0; $i<$intTotal; $i++)
  1451.         {
  1452.             $submit = '';
  1454.             if ($i == $intLast)
  1455.             {
  1456.                 $submit = '
  1457. <div class="tl_submit_panel tl_subpanel">
  1458.   <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>
  1459.   <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>
  1460. </div>';
  1461.             }
  1463.             $return .= '
  1464. <div class="tl_panel cf">
  1465.   ' . $submit . $arrPanels[$i] . '
  1466. </div>';
  1467.         }
  1469.         $return = '
  1470. <form class="tl_form" method="post" aria-label="' . StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['searchAndFilter']) . '">
  1471. <div class="tl_formbody">
  1472.   <input type="hidden" name="FORM_SUBMIT" value="tl_filters">
  1473.   <input type="hidden" name="REQUEST_TOKEN" value="' . REQUEST_TOKEN . '">
  1474.   ' . $return . '
  1475. </div>
  1476. </form>';
  1478.         return $return;
  1479.     }
  1481.     /**
  1482.      * Invalidate the cache tags associated with a given DC
  1483.      *
  1484.      * Call this whenever an entry is modified (added, updated, deleted).
  1485.      */
  1486.     public function invalidateCacheTags()
  1487.     {
  1488.         if (!System::getContainer()->has('fos_http_cache.cache_manager'))
  1489.         {
  1490.             return;
  1491.         }
  1493.         $tags = array('contao.db.' . $this->table . '.' . $this->id);
  1495.         $this->addPtableTags($this->table, $this->id, $tags);
  1496.         $this->addCtableTags($this->table, $this->id, $tags);
  1498.         // Trigger the oninvalidate_cache_tags_callback
  1499.         if (\is_array($GLOBALS['TL_DCA'][$this->table]['config']['oninvalidate_cache_tags_callback'] ?? null))
  1500.         {
  1501.             foreach ($GLOBALS['TL_DCA'][$this->table]['config']['oninvalidate_cache_tags_callback'] as $callback)
  1502.             {
  1503.                 if (\is_array($callback))
  1504.                 {
  1505.                     $this->import($callback[0]);
  1506.                     $tags = $this->{$callback[0]}->{$callback[1]}($this, $tags);
  1507.                 }
  1508.                 elseif (\is_callable($callback))
  1509.                 {
  1510.                     $tags = $callback($this, $tags);
  1511.                 }
  1512.             }
  1513.         }
  1515.         // Make sure tags are unique and empty ones are removed
  1516.         $tags = array_filter(array_unique($tags));
  1518.         System::getContainer()->get('fos_http_cache.cache_manager')->invalidateTags($tags);
  1519.     }
  1521.     public function addPtableTags($strTable, $intId, &$tags)
  1522.     {
  1523.         if (empty($GLOBALS['TL_DCA'][$strTable]['config']['ptable']))
  1524.         {
  1525.             $tags[] = 'contao.db.' . $strTable;
  1527.             return;
  1528.         }
  1530.         $ptable = $GLOBALS['TL_DCA'][$strTable]['config']['ptable'];
  1532.         Controller::loadDataContainer($ptable);
  1534.         $objPid = $this->Database->prepare('SELECT pid FROM ' . Database::quoteIdentifier($strTable) . ' WHERE id=?')
  1535.                                  ->execute($intId);
  1537.         if (!$objPid->numRows)
  1538.         {
  1539.             return;
  1540.         }
  1542.         $tags[] = 'contao.db.' . $ptable . '.' . $objPid->pid;
  1544.         $this->addPtableTags($ptable, $objPid->pid, $tags);
  1545.     }
  1547.     public function addCtableTags($strTable, $intId, &$tags)
  1548.     {
  1549.         if (empty($GLOBALS['TL_DCA'][$strTable]['config']['ctable']))
  1550.         {
  1551.             return;
  1552.         }
  1554.         foreach ($GLOBALS['TL_DCA'][$strTable]['config']['ctable'] as $ctable)
  1555.         {
  1556.             Controller::loadDataContainer($ctable);
  1558.             if ($GLOBALS['TL_DCA'][$ctable]['config']['dynamicPtable'] ?? null)
  1559.             {
  1560.                 $objIds = $this->Database->prepare('SELECT id FROM ' . Database::quoteIdentifier($ctable) . ' WHERE pid=? AND ptable=?')
  1561.                                          ->execute($intId, $strTable);
  1562.             }
  1563.             else
  1564.             {
  1565.                 $objIds = $this->Database->prepare('SELECT id FROM ' . Database::quoteIdentifier($ctable) . ' WHERE pid=?')
  1566.                                          ->execute($intId);
  1567.             }
  1569.             if (!$objIds->numRows)
  1570.             {
  1571.                 continue;
  1572.             }
  1574.             while ($objIds->next())
  1575.             {
  1576.                 $tags[] = 'contao.db.' . $ctable . '.' . $objIds->id;
  1578.                 $this->addCtableTags($ctable, $objIds->id, $tags);
  1579.             }
  1580.         }
  1581.     }
  1583.     /**
  1584.      * Return the form field suffix
  1585.      *
  1586.      * @return integer|string
  1587.      */
  1588.     protected function getFormFieldSuffix()
  1589.     {
  1590.         return $this->intId;
  1591.     }
  1593.     /**
  1594.      * Return the name of the current palette
  1595.      *
  1596.      * @return string
  1597.      */
  1598.     abstract public function getPalette();
  1600.     /**
  1601.      * Save the current value
  1602.      *
  1603.      * @param mixed $varValue
  1604.      *
  1605.      * @throws \Exception
  1606.      */
  1607.     abstract protected function save($varValue);
  1609.     /**
  1610.      * Return the class name of the DataContainer driver for the given table.
  1611.      *
  1612.      * @param string $table
  1613.      *
  1614.      * @return string
  1615.      *
  1616.      * @todo Change the return type to ?string in Contao 5.0
  1617.      */
  1618.     public static function getDriverForTable(string $table): string
  1619.     {
  1620.         if (!isset($GLOBALS['TL_DCA'][$table]['config']['dataContainer']))
  1621.         {
  1622.             return '';
  1623.         }
  1625.         $dataContainer = $GLOBALS['TL_DCA'][$table]['config']['dataContainer'];
  1627.         if ('' !== $dataContainer && false === strpos($dataContainer, '\\'))
  1628.         {
  1629.             trigger_deprecation('contao/core-bundle', '4.9', 'The usage of a non fully qualified class name 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.');
  1631.             $dataContainer = 'DC_' . $dataContainer;
  1633.             if (class_exists($dataContainer))
  1634.             {
  1635.                 $ref = new \ReflectionClass($dataContainer);
  1637.                 return $ref->getName();
  1638.             }
  1639.         }
  1641.         return $dataContainer;
  1642.     }
  1644.     /**
  1645.      * Generates the label for a given data record according to the DCA configuration.
  1646.      * Returns an array of strings if 'showColumns' is enabled in the DCA configuration.
  1647.      *
  1648.      * @param array  $row   The data record
  1649.      * @param string $table The name of the data container
  1650.      *
  1651.      * @return string|array<string>
  1652.      */
  1653.     public function generateRecordLabel(array $row, string $table = null, bool $protected = false, bool $isVisibleRootTrailPage = false)
  1654.     {
  1655.         $table = $table ?? $this->strTable;
  1656.         $labelConfig = &$GLOBALS['TL_DCA'][$table]['list']['label'];
  1657.         $args = array();
  1659.         foreach ($labelConfig['fields'] as $k=>$v)
  1660.         {
  1661.             // Decrypt the value
  1662.             if ($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['encrypt'] ?? null)
  1663.             {
  1664.                 $row[$v] = Encryption::decrypt(StringUtil::deserialize($row[$v]));
  1665.             }
  1667.             if (strpos($v, ':') !== false)
  1668.             {
  1669.                 list($strKey, $strTable) = explode(':', $v, 2);
  1670.                 list($strTable, $strField) = explode('.', $strTable, 2);
  1672.                 $objRef = Database::getInstance()
  1673.                     ->prepare("SELECT " . Database::quoteIdentifier($strField) . " FROM " . $strTable . " WHERE id=?")
  1674.                     ->limit(1)
  1675.                     ->execute($row[$strKey]);
  1677.                 $args[$k] = $objRef->numRows ? $objRef->$strField : '';
  1678.             }
  1679.             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)))
  1680.             {
  1681.                 if (($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['rgxp'] ?? null) == 'date')
  1682.                 {
  1683.                     $args[$k] = $row[$v] ? Date::parse(Config::get('dateFormat'), $row[$v]) : '-';
  1684.                 }
  1685.                 elseif (($GLOBALS['TL_DCA'][$table]['fields'][$v]['eval']['rgxp'] ?? null) == 'time')
  1686.                 {
  1687.                     $args[$k] = $row[$v] ? Date::parse(Config::get('timeFormat'), $row[$v]) : '-';
  1688.                 }
  1689.                 else
  1690.                 {
  1691.                     $args[$k] = $row[$v] ? Date::parse(Config::get('datimFormat'), $row[$v]) : '-';
  1692.                 }
  1693.             }
  1694.             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)))
  1695.             {
  1696.                 $args[$k] = $row[$v] ? $GLOBALS['TL_LANG']['MSC']['yes'] : $GLOBALS['TL_LANG']['MSC']['no'];
  1697.             }
  1698.             elseif (isset($row[$v]))
  1699.             {
  1700.                 $row_v = StringUtil::deserialize($row[$v]);
  1702.                 if (\is_array($row_v))
  1703.                 {
  1704.                     $args_k = array();
  1706.                     foreach ($row_v as $option)
  1707.                     {
  1708.                         $args_k[] = $GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$option] ?? $option;
  1709.                     }
  1711.                     $args[$k] = implode(', ', $args_k);
  1712.                 }
  1713.                 elseif (isset($GLOBALS['TL_DCA'][$table]['fields'][$v]['reference'][$row[$v]]))
  1714.                 {
  1715.                     $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]];
  1716.                 }
  1717.                 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]]))
  1718.                 {
  1719.                     $args[$k] = $GLOBALS['TL_DCA'][$table]['fields'][$v]['options'][$row[$v]] ?? null;
  1720.                 }
  1721.                 else
  1722.                 {
  1723.                     $args[$k] = $row[$v];
  1724.                 }
  1725.             }
  1726.             else
  1727.             {
  1728.                 $args[$k] = null;
  1729.             }
  1730.         }
  1732.         // Render the label
  1733.         $label = vsprintf($labelConfig['format'] ?? '%s', $args);
  1735.         // Shorten the label it if it is too long
  1736.         if (($labelConfig['maxCharacters'] ?? null) > 0 && $labelConfig['maxCharacters'] < \strlen(strip_tags($label)))
  1737.         {
  1738.             $label = trim(StringUtil::substrHtml($label, $labelConfig['maxCharacters'])) . ' …';
  1739.         }
  1741.         // Remove empty brackets (), [], {}, <> and empty tags from the label
  1742.         $label = preg_replace('/\( *\) ?|\[ *] ?|{ *} ?|< *> ?/', '', $label);
  1743.         $label = preg_replace('/<[^>]+>\s*<\/[^>]+>/', '', $label);
  1745.         $mode = $GLOBALS['TL_DCA'][$table]['list']['sorting']['mode'] ?? self::MODE_SORTED;
  1747.         // Execute label_callback
  1748.         if (\is_array($labelConfig['label_callback'] ?? null) || \is_callable($labelConfig['label_callback'] ?? null))
  1749.         {
  1750.             if (\in_array($mode, array(self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1751.             {
  1752.                 if (\is_array($labelConfig['label_callback'] ?? null))
  1753.                 {
  1754.                     $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this, '', false, $protected, $isVisibleRootTrailPage);
  1755.                 }
  1756.                 else
  1757.                 {
  1758.                     $label = $labelConfig['label_callback']($row, $label, $this, '', false, $protected, $isVisibleRootTrailPage);
  1759.                 }
  1760.             }
  1761.             elseif ($mode === self::MODE_PARENT)
  1762.             {
  1763.                 if (\is_array($labelConfig['label_callback'] ?? null))
  1764.                 {
  1765.                     $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this);
  1766.                 }
  1767.                 else
  1768.                 {
  1769.                     $label = $labelConfig['label_callback']($row, $label, $this);
  1770.                 }
  1771.             }
  1772.             else
  1773.             {
  1774.                 if (\is_array($labelConfig['label_callback'] ?? null))
  1775.                 {
  1776.                     $label = System::importStatic($labelConfig['label_callback'][0])->{$labelConfig['label_callback'][1]}($row, $label, $this, $args);
  1777.                 }
  1778.                 else
  1779.                 {
  1780.                     $label = $labelConfig['label_callback']($row, $label, $this, $args);
  1781.                 }
  1782.             }
  1783.         }
  1784.         elseif (\in_array($mode, array(self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1785.         {
  1786.             $label = Image::getHtml('iconPLAIN.svg') . ' ' . $label;
  1787.         }
  1789.         if (($labelConfig['showColumns'] ?? null) && !\in_array($mode, array(self::MODE_PARENT, self::MODE_TREE, self::MODE_TREE_EXTENDED)))
  1790.         {
  1791.             return \is_array($label) ? $label : $args;
  1792.         }
  1794.         return $label;
  1795.     }
  1796. }
  1798. class_alias(DataContainer::class, 'DataContainer');