vendor/contao/core-bundle/src/Resources/contao/forms/Form.php line 192

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 Patchwork\Utf8;
  15. /**
  16.  * Provide methods to handle front end forms.
  17.  *
  18.  * @property integer $id
  19.  * @property string  $title
  20.  * @property string  $formID
  21.  * @property string  $method
  22.  * @property boolean $allowTags
  23.  * @property string  $attributes
  24.  * @property boolean $novalidate
  25.  * @property integer $jumpTo
  26.  * @property boolean $sendViaEmail
  27.  * @property boolean $skipEmpty
  28.  * @property string  $format
  29.  * @property string  $recipient
  30.  * @property string  $subject
  31.  * @property boolean $storeValues
  32.  * @property string  $targetTable
  33.  * @property string  $customTpl
  34.  *
  35.  * @author Leo Feyer <https://github.com/leofeyer>
  36.  */
  37. class Form extends Hybrid
  38. {
  39.     /**
  40.      * Model
  41.      * @var FormModel
  42.      */
  43.     protected $objModel;
  45.     /**
  46.      * Key
  47.      * @var string
  48.      */
  49.     protected $strKey = 'form';
  51.     /**
  52.      * Table
  53.      * @var string
  54.      */
  55.     protected $strTable = 'tl_form';
  57.     /**
  58.      * Template
  59.      * @var string
  60.      */
  61.     protected $strTemplate = 'form_wrapper';
  63.     /**
  64.      * Remove name attributes in the back end so the form is not validated
  65.      *
  66.      * @return string
  67.      */
  68.     public function generate()
  69.     {
  70.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  72.         if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  73.         {
  74.             $objTemplate = new BackendTemplate('be_wildcard');
  75.             $objTemplate->wildcard = '### ' . Utf8::strtoupper($GLOBALS['TL_LANG']['CTE']['form'][0]) . ' ###';
  76.             $objTemplate->id = $this->id;
  77.             $objTemplate->link = $this->title;
  78.             $objTemplate->href = 'contao/main.php?do=form&amp;table=tl_form_field&amp;id=' . $this->id;
  80.             return $objTemplate->parse();
  81.         }
  83.         if ($this->customTpl)
  84.         {
  85.             $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  87.             // Use the custom template unless it is a back end request
  88.             if (!$request || !System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  89.             {
  90.                 $this->strTemplate = $this->customTpl;
  91.             }
  92.         }
  94.         return parent::generate();
  95.     }
  97.     /**
  98.      * Generate the form
  99.      */
  100.     protected function compile()
  101.     {
  102.         $hasUpload = false;
  103.         $doNotSubmit = false;
  104.         $arrSubmitted = array();
  106.         $this->loadDataContainer('tl_form_field');
  107.         $formId = $this->formID ? 'auto_' . $this->formID : 'auto_form_' . $this->id;
  109.         $this->Template->fields = '';
  110.         $this->Template->hidden = '';
  111.         $this->Template->formSubmit = $formId;
  112.         $this->Template->method = ($this->method == 'GET') ? 'get' : 'post';
  114.         $this->initializeSession($formId);
  115.         $arrLabels = array();
  117.         // Get all form fields
  118.         $arrFields = array();
  119.         $objFields = FormFieldModel::findPublishedByPid($this->id);
  121.         if ($objFields !== null)
  122.         {
  123.             while ($objFields->next())
  124.             {
  125.                 // Ignore the name of form fields which do not use a name (see #1268)
  126.                 if ($objFields->name && isset($GLOBALS['TL_DCA']['tl_form_field']['palettes'][$objFields->type]) && preg_match('/[,;]name[,;]/', $GLOBALS['TL_DCA']['tl_form_field']['palettes'][$objFields->type]))
  127.                 {
  128.                     $arrFields[$objFields->name] = $objFields->current();
  129.                 }
  130.                 else
  131.                 {
  132.                     $arrFields[] = $objFields->current();
  133.                 }
  134.             }
  135.         }
  137.         // HOOK: compile form fields
  138.         if (isset($GLOBALS['TL_HOOKS']['compileFormFields']) && \is_array($GLOBALS['TL_HOOKS']['compileFormFields']))
  139.         {
  140.             foreach ($GLOBALS['TL_HOOKS']['compileFormFields'] as $callback)
  141.             {
  142.                 $this->import($callback[0]);
  143.                 $arrFields = $this->{$callback[0]}->{$callback[1]}($arrFields, $formId, $this);
  144.             }
  145.         }
  147.         // Process the fields
  148.         if (!empty($arrFields) && \is_array($arrFields))
  149.         {
  150.             $row = 0;
  151.             $max_row = \count($arrFields);
  153.             foreach ($arrFields as $objField)
  154.             {
  155.                 /** @var FormFieldModel $objField */
  156.                 $strClass = $GLOBALS['TL_FFL'][$objField->type] ?? null;
  158.                 // Continue if the class is not defined
  159.                 if (!class_exists($strClass))
  160.                 {
  161.                     continue;
  162.                 }
  164.                 $arrData = $objField->row();
  166.                 $arrData['decodeEntities'] = true;
  167.                 $arrData['allowHtml'] = $this->allowTags;
  168.                 $arrData['rowClass'] = 'row_' . $row . (($row == 0) ? ' row_first' : (($row == ($max_row - 1)) ? ' row_last' : '')) . ((($row % 2) == 0) ? ' even' : ' odd');
  170.                 // Increase the row count if its a password field
  171.                 if ($objField->type == 'password')
  172.                 {
  173.                     ++$row;
  174.                     ++$max_row;
  176.                     $arrData['rowClassConfirm'] = 'row_' . $row . (($row == ($max_row - 1)) ? ' row_last' : '') . ((($row % 2) == 0) ? ' even' : ' odd');
  177.                 }
  179.                 // Submit buttons do not use the name attribute
  180.                 if ($objField->type == 'submit')
  181.                 {
  182.                     $arrData['name'] = '';
  183.                 }
  185.                 // Unset the default value depending on the field type (see #4722)
  186.                 if (!empty($arrData['value']) && !\in_array('value', StringUtil::trimsplit('[,;]', $GLOBALS['TL_DCA']['tl_form_field']['palettes'][$objField->type] ?? '')))
  187.                 {
  188.                     $arrData['value'] = '';
  189.                 }
  191.                 /** @var Widget $objWidget */
  192.                 $objWidget = new $strClass($arrData);
  193.                 $objWidget->required = $objField->mandatory ? true : false;
  195.                 // HOOK: load form field callback
  196.                 if (isset($GLOBALS['TL_HOOKS']['loadFormField']) && \is_array($GLOBALS['TL_HOOKS']['loadFormField']))
  197.                 {
  198.                     foreach ($GLOBALS['TL_HOOKS']['loadFormField'] as $callback)
  199.                     {
  200.                         $this->import($callback[0]);
  201.                         $objWidget = $this->{$callback[0]}->{$callback[1]}($objWidget, $formId, $this->arrData, $this);
  202.                     }
  203.                 }
  205.                 // Validate the input
  206.                 if (Input::post('FORM_SUBMIT') == $formId)
  207.                 {
  208.                     $objWidget->validate();
  210.                     // HOOK: validate form field callback
  211.                     if (isset($GLOBALS['TL_HOOKS']['validateFormField']) && \is_array($GLOBALS['TL_HOOKS']['validateFormField']))
  212.                     {
  213.                         foreach ($GLOBALS['TL_HOOKS']['validateFormField'] as $callback)
  214.                         {
  215.                             $this->import($callback[0]);
  216.                             $objWidget = $this->{$callback[0]}->{$callback[1]}($objWidget, $formId, $this->arrData, $this);
  217.                         }
  218.                     }
  220.                     if ($objWidget->hasErrors())
  221.                     {
  222.                         $doNotSubmit = true;
  223.                     }
  225.                     // Store current value in the session
  226.                     elseif ($objWidget->submitInput())
  227.                     {
  228.                         $arrSubmitted[$objField->name] = $objWidget->value;
  229.                         $_SESSION['FORM_DATA'][$objField->name] = $objWidget->value;
  230.                         unset($_POST[$objField->name]); // see #5474
  231.                     }
  232.                 }
  234.                 if ($objWidget instanceof \uploadable)
  235.                 {
  236.                     $hasUpload = true;
  237.                 }
  239.                 if ($objWidget instanceof FormHidden)
  240.                 {
  241.                     $this->Template->hidden .= $objWidget->parse();
  242.                     --$max_row;
  243.                     continue;
  244.                 }
  246.                 if ($objWidget->name && $objWidget->label)
  247.                 {
  248.                     $arrLabels[$objWidget->name] = $this->replaceInsertTags($objWidget->label); // see #4268
  249.                 }
  251.                 $this->Template->fields .= $objWidget->parse();
  252.                 ++$row;
  253.             }
  254.         }
  256.         // Process the form data
  257.         if (!$doNotSubmit && Input::post('FORM_SUBMIT') == $formId)
  258.         {
  259.             $this->processFormData($arrSubmitted, $arrLabels, $arrFields);
  260.         }
  262.         // Remove any uploads, if form did not validate (#1185)
  263.         if ($doNotSubmit && $hasUpload && !empty($_SESSION['FILES']))
  264.         {
  265.             foreach ($_SESSION['FILES'] as $field => $upload)
  266.             {
  267.                 if (empty($arrFields[$field]))
  268.                 {
  269.                     continue;
  270.                 }
  272.                 if (!empty($upload['uuid']) && null !== ($file = FilesModel::findById($upload['uuid'])))
  273.                 {
  274.                     $file->delete();
  275.                 }
  277.                 if (is_file($upload['tmp_name']))
  278.                 {
  279.                     unlink($upload['tmp_name']);
  280.                 }
  282.                 unset($_SESSION['FILES'][$field]);
  283.             }
  284.         }
  286.         // Add a warning to the page title
  287.         if ($doNotSubmit && !Environment::get('isAjaxRequest'))
  288.         {
  289.             /** @var PageModel $objPage */
  290.             global $objPage;
  292.             $title = $objPage->pageTitle ?: $objPage->title;
  293.             $objPage->pageTitle = $GLOBALS['TL_LANG']['ERR']['form'] . ' - ' . $title;
  294.         }
  296.         $strAttributes = '';
  297.         $arrAttributes = StringUtil::deserialize($this->attributes, true);
  299.         if (!empty($arrAttributes[0]))
  300.         {
  301.             $strAttributes .= ' id="' . $arrAttributes[0] . '"';
  302.         }
  304.         if (!empty($arrAttributes[1]))
  305.         {
  306.             $strAttributes .= ' class="' . $arrAttributes[1] . '"';
  307.         }
  309.         $this->Template->hasError = $doNotSubmit;
  310.         $this->Template->attributes = $strAttributes;
  311.         $this->Template->enctype = $hasUpload ? 'multipart/form-data' : 'application/x-www-form-urlencoded';
  312.         $this->Template->maxFileSize = $hasUpload ? $this->objModel->getMaxUploadFileSize() : false;
  313.         $this->Template->novalidate = $this->novalidate ? ' novalidate' : '';
  315.         // Get the target URL
  316.         if ($this->method == 'GET' && ($objTarget = $this->objModel->getRelated('jumpTo')) instanceof PageModel)
  317.         {
  318.             /** @var PageModel $objTarget */
  319.             $this->Template->action = $objTarget->getFrontendUrl();
  320.         }
  321.     }
  323.     /**
  324.      * Process form data, store it in the session and redirect to the jumpTo page
  325.      *
  326.      * @param array $arrSubmitted
  327.      * @param array $arrLabels
  328.      * @param array $arrFields
  329.      */
  330.     protected function processFormData($arrSubmitted, $arrLabels, $arrFields)
  331.     {
  332.         // HOOK: prepare form data callback
  333.         if (isset($GLOBALS['TL_HOOKS']['prepareFormData']) && \is_array($GLOBALS['TL_HOOKS']['prepareFormData']))
  334.         {
  335.             foreach ($GLOBALS['TL_HOOKS']['prepareFormData'] as $callback)
  336.             {
  337.                 $this->import($callback[0]);
  338.                 $this->{$callback[0]}->{$callback[1]}($arrSubmitted, $arrLabels, $arrFields, $this);
  339.             }
  340.         }
  342.         // Send form data via e-mail
  343.         if ($this->sendViaEmail)
  344.         {
  345.             $keys = array();
  346.             $values = array();
  347.             $fields = array();
  348.             $message = '';
  350.             foreach ($arrSubmitted as $k=>$v)
  351.             {
  352.                 if ($k == 'cc')
  353.                 {
  354.                     continue;
  355.                 }
  357.                 $v = StringUtil::deserialize($v);
  359.                 // Skip empty fields
  360.                 if ($this->skipEmpty && !\is_array($v) && !\strlen($v))
  361.                 {
  362.                     continue;
  363.                 }
  365.                 // Add field to message
  366.                 $message .= ($arrLabels[$k] ?? ucfirst($k)) . ': ' . (\is_array($v) ? implode(', ', $v) : $v) . "\n";
  368.                 // Prepare XML file
  369.                 if ($this->format == 'xml')
  370.                 {
  371.                     $fields[] = array
  372.                     (
  373.                         'name' => $k,
  374.                         'values' => (\is_array($v) ? $v : array($v))
  375.                     );
  376.                 }
  378.                 // Prepare CSV file
  379.                 if ($this->format == 'csv' || $this->format == 'csv_excel')
  380.                 {
  381.                     $keys[] = $k;
  382.                     $values[] = (\is_array($v) ? implode(',', $v) : $v);
  383.                 }
  384.             }
  386.             $recipients = StringUtil::splitCsv($this->recipient);
  388.             // Format recipients
  389.             foreach ($recipients as $k=>$v)
  390.             {
  391.                 $recipients[$k] = str_replace(array('[', ']', '"'), array('<', '>', ''), $v);
  392.             }
  394.             $email = new Email();
  396.             // Get subject and message
  397.             if ($this->format == 'email')
  398.             {
  399.                 $message = $arrSubmitted['message'];
  400.                 $email->subject = $arrSubmitted['subject'];
  401.             }
  403.             // Set the admin e-mail as "from" address
  404.             $email->from = $GLOBALS['TL_ADMIN_EMAIL'];
  405.             $email->fromName = $GLOBALS['TL_ADMIN_NAME'];
  407.             // Get the "reply to" address
  408.             if (!empty(Input::post('email', true)))
  409.             {
  410.                 $replyTo = Input::post('email', true);
  412.                 // Add the name
  413.                 if (!empty(Input::post('name')))
  414.                 {
  415.                     $replyTo = '"' . Input::post('name') . '" <' . $replyTo . '>';
  416.                 }
  417.                 elseif (!empty(Input::post('firstname')) && !empty(Input::post('lastname')))
  418.                 {
  419.                     $replyTo = '"' . Input::post('firstname') . ' ' . Input::post('lastname') . '" <' . $replyTo . '>';
  420.                 }
  422.                 $email->replyTo($replyTo);
  423.             }
  425.             // Fallback to default subject
  426.             if (!$email->subject)
  427.             {
  428.                 $email->subject = html_entity_decode($this->replaceInsertTags($this->subject, false), ENT_QUOTES, 'UTF-8');
  429.             }
  431.             // Send copy to sender
  432.             if (!empty($arrSubmitted['cc']))
  433.             {
  434.                 $email->sendCc(Input::post('email', true));
  435.                 unset($_SESSION['FORM_DATA']['cc']);
  436.             }
  438.             // Attach XML file
  439.             if ($this->format == 'xml')
  440.             {
  441.                 $objTemplate = new FrontendTemplate('form_xml');
  442.                 $objTemplate->fields = $fields;
  443.                 $objTemplate->charset = System::getContainer()->getParameter('kernel.charset');
  445.                 $email->attachFileFromString($objTemplate->parse(), 'form.xml', 'application/xml');
  446.             }
  448.             // Attach CSV file
  449.             if ($this->format == 'csv')
  450.             {
  451.                 $email->attachFileFromString(StringUtil::decodeEntities('"' . implode('";"', $keys) . '"' . "\n" . '"' . implode('";"', $values) . '"'), 'form.csv', 'text/comma-separated-values');
  452.             }
  453.             elseif ($this->format == 'csv_excel')
  454.             {
  455.                 $email->attachFileFromString(mb_convert_encoding("\u{FEFF}sep=;\n" . StringUtil::decodeEntities('"' . implode('";"', $keys) . '"' . "\n" . '"' . implode('";"', $values) . '"'), 'UTF-16LE', 'UTF-8'), 'form.csv', 'text/comma-separated-values');
  456.             }
  458.             $uploaded = '';
  460.             // Attach uploaded files
  461.             if (!empty($_SESSION['FILES']))
  462.             {
  463.                 foreach ($_SESSION['FILES'] as $file)
  464.                 {
  465.                     // Add a link to the uploaded file
  466.                     if ($file['uploaded'])
  467.                     {
  468.                         $uploaded .= "\n" . Environment::get('base') . StringUtil::stripRootDir(\dirname($file['tmp_name'])) . '/' . rawurlencode($file['name']);
  469.                         continue;
  470.                     }
  472.                     $email->attachFileFromString(file_get_contents($file['tmp_name']), $file['name'], $file['type']);
  473.                 }
  474.             }
  476.             $uploaded = trim($uploaded) ? "\n\n---\n" . $uploaded : '';
  477.             $email->text = StringUtil::decodeEntities(trim($message)) . $uploaded . "\n\n";
  479.             // Set the transport
  480.             if (!empty($this->mailerTransport))
  481.             {
  482.                 $email->addHeader('X-Transport', $this->mailerTransport);
  483.             }
  485.             // Send the e-mail
  486.             $email->sendTo($recipients);
  487.         }
  489.         // Store the values in the database
  490.         if ($this->storeValues && $this->targetTable)
  491.         {
  492.             $arrSet = array();
  494.             // Add the timestamp
  495.             if ($this->Database->fieldExists('tstamp', $this->targetTable))
  496.             {
  497.                 $arrSet['tstamp'] = time();
  498.             }
  500.             // Fields
  501.             foreach ($arrSubmitted as $k=>$v)
  502.             {
  503.                 if ($k != 'cc' && $k != 'id')
  504.                 {
  505.                     $arrSet[$k] = $v;
  507.                     // Convert date formats into timestamps (see #6827)
  508.                     if ($arrSet[$k] && \in_array($arrFields[$k]->rgxp, array('date', 'time', 'datim')))
  509.                     {
  510.                         $objDate = new Date($arrSet[$k], Date::getFormatFromRgxp($arrFields[$k]->rgxp));
  511.                         $arrSet[$k] = $objDate->tstamp;
  512.                     }
  513.                 }
  514.             }
  516.             // Files
  517.             if (!empty($_SESSION['FILES']))
  518.             {
  519.                 foreach ($_SESSION['FILES'] as $k=>$v)
  520.                 {
  521.                     if ($v['uploaded'] ?? null)
  522.                     {
  523.                         $arrSet[$k] = StringUtil::stripRootDir($v['tmp_name']);
  524.                     }
  525.                 }
  526.             }
  528.             // HOOK: store form data callback
  529.             if (isset($GLOBALS['TL_HOOKS']['storeFormData']) && \is_array($GLOBALS['TL_HOOKS']['storeFormData']))
  530.             {
  531.                 foreach ($GLOBALS['TL_HOOKS']['storeFormData'] as $callback)
  532.                 {
  533.                     $this->import($callback[0]);
  534.                     $arrSet = $this->{$callback[0]}->{$callback[1]}($arrSet, $this);
  535.                 }
  536.             }
  538.             // Load DataContainer of target table before trying to determine empty value (see #3499)
  539.             Controller::loadDataContainer($this->targetTable);
  541.             // Set the correct empty value (see #6284, #6373)
  542.             foreach ($arrSet as $k=>$v)
  543.             {
  544.                 if ($v === '')
  545.                 {
  546.                     $arrSet[$k] = Widget::getEmptyValueByFieldType($GLOBALS['TL_DCA'][$this->targetTable]['fields'][$k]['sql'] ?? array());
  547.                 }
  548.             }
  550.             // Do not use Models here (backwards compatibility)
  551.             $this->Database->prepare("INSERT INTO " . $this->targetTable . " %s")->set($arrSet)->execute();
  552.         }
  554.         // Store all values in the session
  555.         foreach (array_keys($_POST) as $key)
  556.         {
  557.             $_SESSION['FORM_DATA'][$key] = $this->allowTags ? Input::postHtml($key, true) : Input::post($key, true);
  558.         }
  560.         // Store the submit time to invalidate the session later on
  561.         $_SESSION['FORM_DATA']['SUBMITTED_AT'] = time();
  563.         $arrFiles = $_SESSION['FILES'];
  565.         // HOOK: process form data callback
  566.         if (isset($GLOBALS['TL_HOOKS']['processFormData']) && \is_array($GLOBALS['TL_HOOKS']['processFormData']))
  567.         {
  568.             foreach ($GLOBALS['TL_HOOKS']['processFormData'] as $callback)
  569.             {
  570.                 $this->import($callback[0]);
  571.                 $this->{$callback[0]}->{$callback[1]}($arrSubmitted, $this->arrData, $arrFiles, $arrLabels, $this);
  572.             }
  573.         }
  575.         $_SESSION['FILES'] = array(); // DO NOT CHANGE
  577.         // Add a log entry
  578.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  579.         {
  580.             $this->import(FrontendUser::class, 'User');
  581.             $this->log('Form "' . $this->title . '" has been submitted by "' . $this->User->username . '".', __METHOD__, TL_FORMS);
  582.         }
  583.         else
  584.         {
  585.             $this->log('Form "' . $this->title . '" has been submitted by a guest.', __METHOD__, TL_FORMS);
  586.         }
  588.         // Check whether there is a jumpTo page
  589.         if (($objJumpTo = $this->objModel->getRelated('jumpTo')) instanceof PageModel)
  590.         {
  591.             $this->jumpToOrReload($objJumpTo->row());
  592.         }
  594.         $this->reload();
  595.     }
  597.     /**
  598.      * Get the maximum file size that is allowed for file uploads
  599.      *
  600.      * @return integer
  601.      *
  602.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  603.      *             Use $this->objModel->getMaxUploadFileSize() instead.
  604.      */
  605.     protected function getMaxFileSize()
  606.     {
  607.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Form::getMaxFileSize()" has been deprecated and will no longer work in Contao 5.0. Use "$this->objModel->getMaxUploadFileSize()" instead.');
  609.         return $this->objModel->getMaxUploadFileSize();
  610.     }
  612.     /**
  613.      * Initialize the form in the current session
  614.      *
  615.      * @param string $formId
  616.      */
  617.     protected function initializeSession($formId)
  618.     {
  619.         if (Input::post('FORM_SUBMIT') != $formId)
  620.         {
  621.             return;
  622.         }
  624.         $arrMessageBox = array('TL_ERROR', 'TL_CONFIRM', 'TL_INFO');
  625.         $_SESSION['FORM_DATA'] = \is_array($_SESSION['FORM_DATA'] ?? null) ? $_SESSION['FORM_DATA'] : array();
  627.         foreach ($arrMessageBox as $tl)
  628.         {
  629.             if (\is_array($_SESSION[$formId][$tl] ?? null))
  630.             {
  631.                 $_SESSION[$formId][$tl] = array_unique($_SESSION[$formId][$tl]);
  633.                 foreach ($_SESSION[$formId][$tl] as $message)
  634.                 {
  635.                     $objTemplate = new FrontendTemplate('form_message');
  636.                     $objTemplate->message = $message;
  637.                     $objTemplate->class = strtolower($tl);
  639.                     $this->Template->fields .= $objTemplate->parse() . "\n";
  640.                 }
  642.                 $_SESSION[$formId][$tl] = array();
  643.             }
  644.         }
  645.     }
  646. }
  648. class_alias(Form::class, 'Form');