vendor/contao/core-bundle/src/Resources/contao/library/Contao/Controller.php line 1359

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\Asset\ContaoContext;
  14. use Contao\CoreBundle\Exception\AccessDeniedException;
  15. use Contao\CoreBundle\Exception\AjaxRedirectResponseException;
  16. use Contao\CoreBundle\Exception\PageNotFoundException;
  17. use Contao\CoreBundle\Exception\RedirectResponseException;
  18. use Contao\Database\Result;
  19. use Contao\Image\PictureConfiguration;
  20. use Contao\Model\Collection;
  21. use League\Uri\Components\Query;
  22. use Symfony\Component\Finder\Finder;
  23. use Symfony\Component\Finder\Glob;
  25. /**
  26.  * Abstract parent class for Controllers
  27.  *
  28.  * Some of the methods have been made static in Contao 3 and can be used in
  29.  * non-object context as well.
  30.  *
  31.  * Usage:
  32.  *
  33.  *     echo Controller::getTheme();
  34.  *
  35.  * Inside a controller:
  36.  *
  37.  *     public function generate()
  38.  *     {
  39.  *         return $this->getArticle(2);
  40.  *     }
  41.  *
  42.  * @author Leo Feyer <https://github.com/leofeyer>
  43.  */
  44. abstract class Controller extends System
  45. {
  46.     /**
  47.      * Find a particular template file and return its path
  48.      *
  49.      * @param string $strTemplate The name of the template
  50.      *
  51.      * @return string The path to the template file
  52.      *
  53.      * @throws \RuntimeException If the template group folder is insecure
  54.      */
  55.     public static function getTemplate($strTemplate)
  56.     {
  57.         $strTemplate = basename($strTemplate);
  59.         // Check for a theme folder
  60.         if (\defined('TL_MODE') && TL_MODE == 'FE')
  61.         {
  62.             /** @var PageModel $objPage */
  63.             global $objPage;
  65.             if ($objPage->templateGroup)
  66.             {
  67.                 if (Validator::isInsecurePath($objPage->templateGroup))
  68.                 {
  69.                     throw new \RuntimeException('Invalid path ' . $objPage->templateGroup);
  70.                 }
  72.                 return TemplateLoader::getPath($strTemplate, 'html5', $objPage->templateGroup);
  73.             }
  74.         }
  76.         return TemplateLoader::getPath($strTemplate, 'html5');
  77.     }
  79.     /**
  80.      * Return all template files of a particular group as array
  81.      *
  82.      * @param string $strPrefix           The template name prefix (e.g. "ce_")
  83.      * @param array  $arrAdditionalMapper An additional mapper array
  84.      * @param string $strDefaultTemplate  An optional default template
  85.      *
  86.      * @return array An array of template names
  87.      */
  88.     public static function getTemplateGroup($strPrefix, array $arrAdditionalMapper=array(), $strDefaultTemplate='')
  89.     {
  90.         $arrTemplates = array();
  91.         $arrBundleTemplates = array();
  93.         $arrMapper = array_merge
  94.         (
  95.             $arrAdditionalMapper,
  96.             array
  97.             (
  98.                 'ce' => array_keys(array_merge(...array_values($GLOBALS['TL_CTE']))),
  99.                 'form' => array_keys($GLOBALS['TL_FFL']),
  100.                 'mod' => array_keys(array_merge(...array_values($GLOBALS['FE_MOD']))),
  101.             )
  102.         );
  104.         // Add templates that are not directly associated with a form field
  105.         $arrMapper['form'][] = 'row';
  106.         $arrMapper['form'][] = 'row_double';
  107.         $arrMapper['form'][] = 'xml';
  108.         $arrMapper['form'][] = 'wrapper';
  109.         $arrMapper['form'][] = 'message';
  110.         $arrMapper['form'][] = 'textfield'; // TODO: remove in Contao 5.0
  112.         // Add templates that are not directly associated with a module
  113.         $arrMapper['mod'][] = 'article';
  114.         $arrMapper['mod'][] = 'message';
  115.         $arrMapper['mod'][] = 'password'; // TODO: remove in Contao 5.0
  116.         $arrMapper['mod'][] = 'comment_form'; // TODO: remove in Contao 5.0
  117.         $arrMapper['mod'][] = 'newsletter'; // TODO: remove in Contao 5.0
  119.         // Get the default templates
  120.         foreach (TemplateLoader::getPrefixedFiles($strPrefix) as $strTemplate)
  121.         {
  122.             if ($strTemplate != $strPrefix)
  123.             {
  124.                 list($k, $strKey) = explode('_', $strTemplate, 2);
  126.                 if (isset($arrMapper[$k]) && \in_array($strKey, $arrMapper[$k]))
  127.                 {
  128.                     $arrBundleTemplates[] = $strTemplate;
  129.                     continue;
  130.                 }
  131.             }
  133.             $arrTemplates[$strTemplate][] = 'root';
  134.         }
  136.         $strGlobPrefix = $strPrefix;
  138.         // Backwards compatibility (see #725)
  139.         if (substr($strGlobPrefix, -1) == '_')
  140.         {
  141.             $strGlobPrefix = substr($strGlobPrefix, 0, -1) . '[_-]';
  142.         }
  144.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  145.         $arrCustomized = self::braceGlob($projectDir . '/templates/' . $strGlobPrefix . '*.html5');
  147.         // Add the customized templates
  148.         if (!empty($arrCustomized) && \is_array($arrCustomized))
  149.         {
  150.             $blnIsGroupPrefix = preg_match('/^[a-z]+_$/', $strPrefix);
  152.             foreach ($arrCustomized as $strFile)
  153.             {
  154.                 $strTemplate = basename($strFile, strrchr($strFile, '.'));
  156.                 if (strpos($strTemplate, '-') !== false)
  157.                 {
  158.                     @trigger_error('Using hyphens in the template name "' . $strTemplate . '.html5" has been deprecated and will no longer work in Contao 5.0. Use snake_case instead.', E_USER_DEPRECATED);
  159.                 }
  161.                 // Ignore bundle templates, e.g. mod_article and mod_article_list
  162.                 if (\in_array($strTemplate, $arrBundleTemplates))
  163.                 {
  164.                     continue;
  165.                 }
  167.                 // Also ignore custom templates belonging to a different bundle template,
  168.                 // e.g. mod_article and mod_article_list_custom
  169.                 if (!$blnIsGroupPrefix)
  170.                 {
  171.                     foreach ($arrBundleTemplates as $strKey)
  172.                     {
  173.                         if (strpos($strTemplate, $strKey . '_') === 0)
  174.                         {
  175.                             continue 2;
  176.                         }
  177.                     }
  178.                 }
  180.                 $arrTemplates[$strTemplate][] = $GLOBALS['TL_LANG']['MSC']['global'];
  181.             }
  182.         }
  184.         $arrDefaultPlaces = array();
  186.         if ($strDefaultTemplate)
  187.         {
  188.             $arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['default'];
  190.             if (file_exists($projectDir . '/templates/' . $strDefaultTemplate . '.html5'))
  191.             {
  192.                 $arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['global'];
  193.             }
  194.         }
  196.         // Do not look for back end templates in theme folders (see #5379)
  197.         if ($strPrefix != 'be_' && $strPrefix != 'mail_')
  198.         {
  199.             // Try to select the themes (see #5210)
  200.             try
  201.             {
  202.                 $objTheme = ThemeModel::findAll(array('order'=>'name'));
  203.             }
  204.             catch (\Exception $e)
  205.             {
  206.                 $objTheme = null;
  207.             }
  209.             // Add the theme templates
  210.             if ($objTheme !== null)
  211.             {
  212.                 while ($objTheme->next())
  213.                 {
  214.                     if (!$objTheme->templates)
  215.                     {
  216.                         continue;
  217.                     }
  219.                     if ($strDefaultTemplate && file_exists($projectDir . '/' . $objTheme->templates . '/' . $strDefaultTemplate . '.html5'))
  220.                     {
  221.                         $arrDefaultPlaces[] = $objTheme->name;
  222.                     }
  224.                     $arrThemeTemplates = self::braceGlob($projectDir . '/' . $objTheme->templates . '/' . $strGlobPrefix . '*.html5');
  226.                     if (!empty($arrThemeTemplates) && \is_array($arrThemeTemplates))
  227.                     {
  228.                         foreach ($arrThemeTemplates as $strFile)
  229.                         {
  230.                             $strTemplate = basename($strFile, strrchr($strFile, '.'));
  231.                             $arrTemplates[$strTemplate][] = $objTheme->name;
  232.                         }
  233.                     }
  234.                 }
  235.             }
  236.         }
  238.         // Show the template sources (see #6875)
  239.         foreach ($arrTemplates as $k=>$v)
  240.         {
  241.             $v = array_filter($v, static function ($a)
  242.             {
  243.                 return $a != 'root';
  244.             });
  246.             if (empty($v))
  247.             {
  248.                 $arrTemplates[$k] = $k;
  249.             }
  250.             else
  251.             {
  252.                 $arrTemplates[$k] = $k . ' (' . implode(', ', $v) . ')';
  253.             }
  254.         }
  256.         // Sort the template names
  257.         ksort($arrTemplates);
  259.         if ($strDefaultTemplate)
  260.         {
  261.             if (!empty($arrDefaultPlaces))
  262.             {
  263.                 $strDefaultTemplate .= ' (' . implode(', ', $arrDefaultPlaces) . ')';
  264.             }
  266.             $arrTemplates = array('' => $strDefaultTemplate) + $arrTemplates;
  267.         }
  269.         return $arrTemplates;
  270.     }
  272.     /**
  273.      * Generate a front end module and return it as string
  274.      *
  275.      * @param mixed  $intId     A module ID or a Model object
  276.      * @param string $strColumn The name of the column
  277.      *
  278.      * @return string The module HTML markup
  279.      */
  280.     public static function getFrontendModule($intId, $strColumn='main')
  281.     {
  282.         if (!\is_object($intId) && !\strlen($intId))
  283.         {
  284.             return '';
  285.         }
  287.         /** @var PageModel $objPage */
  288.         global $objPage;
  290.         // Articles
  291.         if (!\is_object($intId) && $intId == 0)
  292.         {
  293.             // Show a particular article only
  294.             if ($objPage->type == 'regular' && Input::get('articles'))
  295.             {
  296.                 list($strSection, $strArticle) = explode(':', Input::get('articles'));
  298.                 if ($strArticle === null)
  299.                 {
  300.                     $strArticle = $strSection;
  301.                     $strSection = 'main';
  302.                 }
  304.                 if ($strSection == $strColumn)
  305.                 {
  306.                     $objArticle = ArticleModel::findPublishedByIdOrAliasAndPid($strArticle, $objPage->id);
  308.                     // Send a 404 header if there is no published article
  309.                     if (null === $objArticle)
  310.                     {
  311.                         throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  312.                     }
  314.                     // Send a 403 header if the article cannot be accessed
  315.                     if (!static::isVisibleElement($objArticle))
  316.                     {
  317.                         throw new AccessDeniedException('Access denied: ' . Environment::get('uri'));
  318.                     }
  320.                     // Add the "first" and "last" classes (see #2583)
  321.                     $objArticle->classes = array('first', 'last');
  323.                     return static::getArticle($objArticle);
  324.                 }
  325.             }
  327.             // HOOK: add custom logic
  328.             if (isset($GLOBALS['TL_HOOKS']['getArticles']) && \is_array($GLOBALS['TL_HOOKS']['getArticles']))
  329.             {
  330.                 foreach ($GLOBALS['TL_HOOKS']['getArticles'] as $callback)
  331.                 {
  332.                     $return = static::importStatic($callback[0])->{$callback[1]}($objPage->id, $strColumn);
  334.                     if (\is_string($return))
  335.                     {
  336.                         return $return;
  337.                     }
  338.                 }
  339.             }
  341.             // Show all articles (no else block here, see #4740)
  342.             $objArticles = ArticleModel::findPublishedByPidAndColumn($objPage->id, $strColumn);
  344.             if ($objArticles === null)
  345.             {
  346.                 return '';
  347.             }
  349.             $return = '';
  350.             $intCount = 0;
  351.             $blnMultiMode = ($objArticles->count() > 1);
  352.             $intLast = $objArticles->count() - 1;
  354.             while ($objArticles->next())
  355.             {
  356.                 /** @var ArticleModel $objRow */
  357.                 $objRow = $objArticles->current();
  359.                 // Add the "first" and "last" classes (see #2583)
  360.                 if ($intCount == 0 || $intCount == $intLast)
  361.                 {
  362.                     $arrCss = array();
  364.                     if ($intCount == 0)
  365.                     {
  366.                         $arrCss[] = 'first';
  367.                     }
  369.                     if ($intCount == $intLast)
  370.                     {
  371.                         $arrCss[] = 'last';
  372.                     }
  374.                     $objRow->classes = $arrCss;
  375.                 }
  377.                 $return .= static::getArticle($objRow, $blnMultiMode, false, $strColumn);
  378.                 ++$intCount;
  379.             }
  381.             return $return;
  382.         }
  384.         // Other modules
  385.         if (\is_object($intId))
  386.         {
  387.             $objRow = $intId;
  388.         }
  389.         else
  390.         {
  391.             $objRow = ModuleModel::findByPk($intId);
  393.             if ($objRow === null)
  394.             {
  395.                 return '';
  396.             }
  397.         }
  399.         // Check the visibility (see #6311)
  400.         if (!static::isVisibleElement($objRow))
  401.         {
  402.             return '';
  403.         }
  405.         $strClass = Module::findClass($objRow->type);
  407.         // Return if the class does not exist
  408.         if (!class_exists($strClass))
  409.         {
  410.             static::log('Module class "' . $strClass . '" (module "' . $objRow->type . '") does not exist', __METHOD__, TL_ERROR);
  412.             return '';
  413.         }
  415.         $objRow->typePrefix = 'mod_';
  417.         /** @var Module $objModule */
  418.         $objModule = new $strClass($objRow, $strColumn);
  419.         $strBuffer = $objModule->generate();
  421.         // HOOK: add custom logic
  422.         if (isset($GLOBALS['TL_HOOKS']['getFrontendModule']) && \is_array($GLOBALS['TL_HOOKS']['getFrontendModule']))
  423.         {
  424.             foreach ($GLOBALS['TL_HOOKS']['getFrontendModule'] as $callback)
  425.             {
  426.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objModule);
  427.             }
  428.         }
  430.         // Disable indexing if protected
  431.         if ($objModule->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  432.         {
  433.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  434.         }
  436.         return $strBuffer;
  437.     }
  439.     /**
  440.      * Generate an article and return it as string
  441.      *
  442.      * @param mixed   $varId          The article ID or a Model object
  443.      * @param boolean $blnMultiMode   If true, only teasers will be shown
  444.      * @param boolean $blnIsInsertTag If true, there will be no page relation
  445.      * @param string  $strColumn      The name of the column
  446.      *
  447.      * @return string|boolean The article HTML markup or false
  448.      */
  449.     public static function getArticle($varId, $blnMultiMode=false, $blnIsInsertTag=false, $strColumn='main')
  450.     {
  451.         /** @var PageModel $objPage */
  452.         global $objPage;
  454.         if (\is_object($varId))
  455.         {
  456.             $objRow = $varId;
  457.         }
  458.         else
  459.         {
  460.             if (!$varId)
  461.             {
  462.                 return '';
  463.             }
  465.             $objRow = ArticleModel::findByIdOrAliasAndPid($varId, (!$blnIsInsertTag ? $objPage->id : null));
  467.             if ($objRow === null)
  468.             {
  469.                 return false;
  470.             }
  471.         }
  473.         // Check the visibility (see #6311)
  474.         if (!static::isVisibleElement($objRow))
  475.         {
  476.             return '';
  477.         }
  479.         // Print the article as PDF
  480.         if (isset($_GET['pdf']) && Input::get('pdf') == $objRow->id)
  481.         {
  482.             // Deprecated since Contao 4.0, to be removed in Contao 5.0
  483.             if ($objRow->printable == 1)
  484.             {
  485.                 @trigger_error('Setting tl_article.printable to "1" has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  487.                 $objArticle = new ModuleArticle($objRow);
  488.                 $objArticle->generatePdf();
  489.             }
  490.             elseif ($objRow->printable)
  491.             {
  492.                 $options = StringUtil::deserialize($objRow->printable);
  494.                 if (\is_array($options) && \in_array('pdf', $options))
  495.                 {
  496.                     $objArticle = new ModuleArticle($objRow);
  497.                     $objArticle->generatePdf();
  498.                 }
  499.             }
  500.         }
  502.         $objRow->headline = $objRow->title;
  503.         $objRow->multiMode = $blnMultiMode;
  505.         // HOOK: add custom logic
  506.         if (isset($GLOBALS['TL_HOOKS']['getArticle']) && \is_array($GLOBALS['TL_HOOKS']['getArticle']))
  507.         {
  508.             foreach ($GLOBALS['TL_HOOKS']['getArticle'] as $callback)
  509.             {
  510.                 static::importStatic($callback[0])->{$callback[1]}($objRow);
  511.             }
  512.         }
  514.         $objArticle = new ModuleArticle($objRow, $strColumn);
  515.         $strBuffer = $objArticle->generate($blnIsInsertTag);
  517.         // Disable indexing if protected
  518.         if ($objArticle->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  519.         {
  520.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  521.         }
  523.         return $strBuffer;
  524.     }
  526.     /**
  527.      * Generate a content element and return it as string
  528.      *
  529.      * @param mixed  $intId     A content element ID or a Model object
  530.      * @param string $strColumn The column the element is in
  531.      *
  532.      * @return string The content element HTML markup
  533.      */
  534.     public static function getContentElement($intId, $strColumn='main')
  535.     {
  536.         if (\is_object($intId))
  537.         {
  538.             $objRow = $intId;
  539.         }
  540.         else
  541.         {
  542.             if ($intId < 1 || !\strlen($intId))
  543.             {
  544.                 return '';
  545.             }
  547.             $objRow = ContentModel::findByPk($intId);
  549.             if ($objRow === null)
  550.             {
  551.                 return '';
  552.             }
  553.         }
  555.         // Check the visibility (see #6311)
  556.         if (!static::isVisibleElement($objRow))
  557.         {
  558.             return '';
  559.         }
  561.         $strClass = ContentElement::findClass($objRow->type);
  563.         // Return if the class does not exist
  564.         if (!class_exists($strClass))
  565.         {
  566.             static::log('Content element class "' . $strClass . '" (content element "' . $objRow->type . '") does not exist', __METHOD__, TL_ERROR);
  568.             return '';
  569.         }
  571.         $objRow->typePrefix = 'ce_';
  573.         /** @var ContentElement $objElement */
  574.         $objElement = new $strClass($objRow, $strColumn);
  575.         $strBuffer = $objElement->generate();
  577.         // HOOK: add custom logic
  578.         if (isset($GLOBALS['TL_HOOKS']['getContentElement']) && \is_array($GLOBALS['TL_HOOKS']['getContentElement']))
  579.         {
  580.             foreach ($GLOBALS['TL_HOOKS']['getContentElement'] as $callback)
  581.             {
  582.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
  583.             }
  584.         }
  586.         // Disable indexing if protected
  587.         if ($objElement->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  588.         {
  589.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  590.         }
  592.         return $strBuffer;
  593.     }
  595.     /**
  596.      * Generate a form and return it as string
  597.      *
  598.      * @param mixed   $varId     A form ID or a Model object
  599.      * @param string  $strColumn The column the form is in
  600.      * @param boolean $blnModule Render the form as module
  601.      *
  602.      * @return string The form HTML markup
  603.      */
  604.     public static function getForm($varId, $strColumn='main', $blnModule=false)
  605.     {
  606.         if (\is_object($varId))
  607.         {
  608.             $objRow = $varId;
  609.         }
  610.         else
  611.         {
  612.             if (!$varId)
  613.             {
  614.                 return '';
  615.             }
  617.             $objRow = FormModel::findByIdOrAlias($varId);
  619.             if ($objRow === null)
  620.             {
  621.                 return '';
  622.             }
  623.         }
  625.         $strClass = $blnModule ? Module::findClass('form') : ContentElement::findClass('form');
  627.         if (!class_exists($strClass))
  628.         {
  629.             static::log('Form class "' . $strClass . '" does not exist', __METHOD__, TL_ERROR);
  631.             return '';
  632.         }
  634.         $objRow->typePrefix = $blnModule ? 'mod_' : 'ce_';
  635.         $objRow->form = $objRow->id;
  637.         /** @var Form $objElement */
  638.         $objElement = new $strClass($objRow, $strColumn);
  639.         $strBuffer = $objElement->generate();
  641.         // HOOK: add custom logic
  642.         if (isset($GLOBALS['TL_HOOKS']['getForm']) && \is_array($GLOBALS['TL_HOOKS']['getForm']))
  643.         {
  644.             foreach ($GLOBALS['TL_HOOKS']['getForm'] as $callback)
  645.             {
  646.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
  647.             }
  648.         }
  650.         return $strBuffer;
  651.     }
  653.     /**
  654.      * Return the languages for the TinyMCE spellchecker
  655.      *
  656.      * @return string The TinyMCE spellchecker language string
  657.      */
  658.     protected function getSpellcheckerString()
  659.     {
  660.         System::loadLanguageFile('languages');
  662.         $return = array();
  663.         $langs = scan(__DIR__ . '/../../languages');
  664.         array_unshift($langs, $GLOBALS['TL_LANGUAGE']);
  666.         foreach ($langs as $lang)
  667.         {
  668.             $lang = substr($lang, 0, 2);
  670.             if (isset($GLOBALS['TL_LANG']['LNG'][$lang]))
  671.             {
  672.                 $return[$lang] = $GLOBALS['TL_LANG']['LNG'][$lang] . '=' . $lang;
  673.             }
  674.         }
  676.         return '+' . implode(',', array_unique($return));
  677.     }
  679.     /**
  680.      * Calculate the page status icon name based on the page parameters
  681.      *
  682.      * @param PageModel|Result|\stdClass $objPage The page object
  683.      *
  684.      * @return string The status icon name
  685.      */
  686.     public static function getPageStatusIcon($objPage)
  687.     {
  688.         $sub = 0;
  689.         $image = $objPage->type . '.svg';
  691.         // Page not published or not active
  692.         if (!$objPage->published || ($objPage->start && $objPage->start > time()) || ($objPage->stop && $objPage->stop <= time()))
  693.         {
  694.             ++$sub;
  695.         }
  697.         // Page hidden from menu
  698.         if ($objPage->hide && !\in_array($objPage->type, array('root', 'error_401', 'error_403', 'error_404')))
  699.         {
  700.             $sub += 2;
  701.         }
  703.         // Page protected
  704.         if ($objPage->protected && !\in_array($objPage->type, array('root', 'error_401', 'error_403', 'error_404')))
  705.         {
  706.             $sub += 4;
  707.         }
  709.         // Get the image name
  710.         if ($sub > 0)
  711.         {
  712.             $image = $objPage->type . '_' . $sub . '.svg';
  713.         }
  715.         // HOOK: add custom logic
  716.         if (isset($GLOBALS['TL_HOOKS']['getPageStatusIcon']) && \is_array($GLOBALS['TL_HOOKS']['getPageStatusIcon']))
  717.         {
  718.             foreach ($GLOBALS['TL_HOOKS']['getPageStatusIcon'] as $callback)
  719.             {
  720.                 $image = static::importStatic($callback[0])->{$callback[1]}($objPage, $image);
  721.             }
  722.         }
  724.         return $image;
  725.     }
  727.     /**
  728.      * Check whether an element is visible in the front end
  729.      *
  730.      * @param Model|ContentModel|ModuleModel $objElement The element model
  731.      *
  732.      * @return boolean True if the element is visible
  733.      */
  734.     public static function isVisibleElement(Model $objElement)
  735.     {
  736.         $blnReturn = true;
  738.         // Only apply the restrictions in the front end
  739.         if (TL_MODE == 'FE')
  740.         {
  741.             $blnFeUserLoggedIn = System::getContainer()->get('contao.security.token_checker')->hasFrontendUser();
  743.             // Protected element
  744.             if ($objElement->protected)
  745.             {
  746.                 if (!$blnFeUserLoggedIn)
  747.                 {
  748.                     $blnReturn = false;
  749.                 }
  750.                 else
  751.                 {
  752.                     $objUser = FrontendUser::getInstance();
  754.                     if (!\is_array($objUser->groups))
  755.                     {
  756.                         $blnReturn = false;
  757.                     }
  758.                     else
  759.                     {
  760.                         $groups = StringUtil::deserialize($objElement->groups);
  762.                         if (empty($groups) || !\is_array($groups) || !\count(array_intersect($groups, $objUser->groups)))
  763.                         {
  764.                             $blnReturn = false;
  765.                         }
  766.                     }
  767.                 }
  768.             }
  770.             // Show to guests only
  771.             elseif ($objElement->guests && $blnFeUserLoggedIn)
  772.             {
  773.                 $blnReturn = false;
  774.             }
  775.         }
  777.         // HOOK: add custom logic
  778.         if (isset($GLOBALS['TL_HOOKS']['isVisibleElement']) && \is_array($GLOBALS['TL_HOOKS']['isVisibleElement']))
  779.         {
  780.             foreach ($GLOBALS['TL_HOOKS']['isVisibleElement'] as $callback)
  781.             {
  782.                 $blnReturn = static::importStatic($callback[0])->{$callback[1]}($objElement, $blnReturn);
  783.             }
  784.         }
  786.         return $blnReturn;
  787.     }
  789.     /**
  790.      * Replace insert tags with their values
  791.      *
  792.      * @param string  $strBuffer The text with the tags to be replaced
  793.      * @param boolean $blnCache  If false, non-cacheable tags will be replaced
  794.      *
  795.      * @return string The text with the replaced tags
  796.      */
  797.     public static function replaceInsertTags($strBuffer, $blnCache=true)
  798.     {
  799.         $objIt = new InsertTags();
  801.         return $objIt->replace($strBuffer, $blnCache);
  802.     }
  804.     /**
  805.      * Replace the dynamic script tags (see #4203)
  806.      *
  807.      * @param string $strBuffer The string with the tags to be replaced
  808.      *
  809.      * @return string The string with the replaced tags
  810.      */
  811.     public static function replaceDynamicScriptTags($strBuffer)
  812.     {
  813.         // HOOK: add custom logic
  814.         if (isset($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']) && \is_array($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']))
  815.         {
  816.             foreach ($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags'] as $callback)
  817.             {
  818.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($strBuffer);
  819.             }
  820.         }
  822.         $arrReplace = array();
  823.         $strScripts = '';
  825.         // Add the internal jQuery scripts
  826.         if (!empty($GLOBALS['TL_JQUERY']) && \is_array($GLOBALS['TL_JQUERY']))
  827.         {
  828.             foreach (array_unique($GLOBALS['TL_JQUERY']) as $script)
  829.             {
  830.                 $strScripts .= $script;
  831.             }
  832.         }
  834.         $arrReplace['[[TL_JQUERY]]'] = $strScripts;
  835.         $strScripts = '';
  837.         // Add the internal MooTools scripts
  838.         if (!empty($GLOBALS['TL_MOOTOOLS']) && \is_array($GLOBALS['TL_MOOTOOLS']))
  839.         {
  840.             foreach (array_unique($GLOBALS['TL_MOOTOOLS']) as $script)
  841.             {
  842.                 $strScripts .= $script;
  843.             }
  844.         }
  846.         $arrReplace['[[TL_MOOTOOLS]]'] = $strScripts;
  847.         $strScripts = '';
  849.         // Add the internal <body> tags
  850.         if (!empty($GLOBALS['TL_BODY']) && \is_array($GLOBALS['TL_BODY']))
  851.         {
  852.             foreach (array_unique($GLOBALS['TL_BODY']) as $script)
  853.             {
  854.                 $strScripts .= $script;
  855.             }
  856.         }
  858.         global $objPage;
  860.         $objLayout = LayoutModel::findByPk($objPage->layoutId);
  861.         $blnCombineScripts = ($objLayout === null) ? false : $objLayout->combineScripts;
  863.         $arrReplace['[[TL_BODY]]'] = $strScripts;
  864.         $strScripts = '';
  866.         $objCombiner = new Combiner();
  868.         // Add the CSS framework style sheets
  869.         if (!empty($GLOBALS['TL_FRAMEWORK_CSS']) && \is_array($GLOBALS['TL_FRAMEWORK_CSS']))
  870.         {
  871.             foreach (array_unique($GLOBALS['TL_FRAMEWORK_CSS']) as $stylesheet)
  872.             {
  873.                 $objCombiner->add($stylesheet);
  874.             }
  875.         }
  877.         // Add the internal style sheets
  878.         if (!empty($GLOBALS['TL_CSS']) && \is_array($GLOBALS['TL_CSS']))
  879.         {
  880.             foreach (array_unique($GLOBALS['TL_CSS']) as $stylesheet)
  881.             {
  882.                 $options = StringUtil::resolveFlaggedUrl($stylesheet);
  884.                 if ($options->static)
  885.                 {
  886.                     $objCombiner->add($stylesheet, $options->mtime, $options->media);
  887.                 }
  888.                 else
  889.                 {
  890.                     $strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
  891.                 }
  892.             }
  893.         }
  895.         // Add the user style sheets
  896.         if (!empty($GLOBALS['TL_USER_CSS']) && \is_array($GLOBALS['TL_USER_CSS']))
  897.         {
  898.             foreach (array_unique($GLOBALS['TL_USER_CSS']) as $stylesheet)
  899.             {
  900.                 $options = StringUtil::resolveFlaggedUrl($stylesheet);
  902.                 if ($options->static)
  903.                 {
  904.                     $objCombiner->add($stylesheet, $options->mtime, $options->media);
  905.                 }
  906.                 else
  907.                 {
  908.                     $strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
  909.                 }
  910.             }
  911.         }
  913.         // Create the aggregated style sheet
  914.         if ($objCombiner->hasEntries())
  915.         {
  916.             if ($blnCombineScripts)
  917.             {
  918.                 $strScripts .= Template::generateStyleTag($objCombiner->getCombinedFile(), 'all');
  919.             }
  920.             else
  921.             {
  922.                 foreach ($objCombiner->getFileUrls() as $strUrl)
  923.                 {
  924.                     $options = StringUtil::resolveFlaggedUrl($strUrl);
  925.                     $strScripts .= Template::generateStyleTag($strUrl, $options->media, $options->mtime);
  926.                 }
  927.             }
  928.         }
  930.         $arrReplace['[[TL_CSS]]'] = $strScripts;
  931.         $strScripts = '';
  933.         // Add the internal scripts
  934.         if (!empty($GLOBALS['TL_JAVASCRIPT']) && \is_array($GLOBALS['TL_JAVASCRIPT']))
  935.         {
  936.             $objCombiner = new Combiner();
  937.             $objCombinerAsync = new Combiner();
  939.             foreach (array_unique($GLOBALS['TL_JAVASCRIPT']) as $javascript)
  940.             {
  941.                 $options = StringUtil::resolveFlaggedUrl($javascript);
  943.                 if ($options->static)
  944.                 {
  945.                     $options->async ? $objCombinerAsync->add($javascript, $options->mtime) : $objCombiner->add($javascript, $options->mtime);
  946.                 }
  947.                 else
  948.                 {
  949.                     $strScripts .= Template::generateScriptTag(static::addAssetsUrlTo($javascript), $options->async, $options->mtime);
  950.                 }
  951.             }
  953.             // Create the aggregated script and add it before the non-static scripts (see #4890)
  954.             if ($objCombiner->hasEntries())
  955.             {
  956.                 if ($blnCombineScripts)
  957.                 {
  958.                     $strScripts = Template::generateScriptTag($objCombiner->getCombinedFile()) . $strScripts;
  959.                 }
  960.                 else
  961.                 {
  962.                     $arrReversed = array_reverse($objCombiner->getFileUrls());
  964.                     foreach ($arrReversed as $strUrl)
  965.                     {
  966.                         $options = StringUtil::resolveFlaggedUrl($strUrl);
  967.                         $strScripts = Template::generateScriptTag($strUrl, false, $options->mtime) . $strScripts;
  968.                     }
  969.                 }
  970.             }
  972.             if ($objCombinerAsync->hasEntries())
  973.             {
  974.                 if ($blnCombineScripts)
  975.                 {
  976.                     $strScripts = Template::generateScriptTag($objCombinerAsync->getCombinedFile(), true) . $strScripts;
  977.                 }
  978.                 else
  979.                 {
  980.                     $arrReversed = array_reverse($objCombinerAsync->getFileUrls());
  982.                     foreach ($arrReversed as $strUrl)
  983.                     {
  984.                         $options = StringUtil::resolveFlaggedUrl($strUrl);
  985.                         $strScripts = Template::generateScriptTag($strUrl, true, $options->mtime) . $strScripts;
  986.                     }
  987.                 }
  988.             }
  989.         }
  991.         // Add the internal <head> tags
  992.         if (!empty($GLOBALS['TL_HEAD']) && \is_array($GLOBALS['TL_HEAD']))
  993.         {
  994.             foreach (array_unique($GLOBALS['TL_HEAD']) as $head)
  995.             {
  996.                 $strScripts .= $head;
  997.             }
  998.         }
  1000.         $arrReplace['[[TL_HEAD]]'] = $strScripts;
  1002.         return str_replace(array_keys($arrReplace), $arrReplace, $strBuffer);
  1003.     }
  1005.     /**
  1006.      * Compile the margin format definition based on an array of values
  1007.      *
  1008.      * @param array  $arrValues An array of four values and a unit
  1009.      * @param string $strType   Either "margin" or "padding"
  1010.      *
  1011.      * @return string The CSS markup
  1012.      */
  1013.     public static function generateMargin($arrValues, $strType='margin')
  1014.     {
  1015.         // Initialize an empty array (see #5217)
  1016.         if (!\is_array($arrValues))
  1017.         {
  1018.             $arrValues = array('top'=>'', 'right'=>'', 'bottom'=>'', 'left'=>'', 'unit'=>'');
  1019.         }
  1021.         $top = $arrValues['top'];
  1022.         $right = $arrValues['right'];
  1023.         $bottom = $arrValues['bottom'];
  1024.         $left = $arrValues['left'];
  1026.         // Try to shorten the definition
  1027.         if ($top && $right  && $bottom  && $left)
  1028.         {
  1029.             if ($top == $right && $top == $bottom && $top == $left)
  1030.             {
  1031.                 return $strType . ':' . $top . $arrValues['unit'] . ';';
  1032.             }
  1034.             if ($top == $bottom && $right == $left)
  1035.             {
  1036.                 return $strType . ':' . $top . $arrValues['unit'] . ' ' . $left . $arrValues['unit'] . ';';
  1037.             }
  1039.             if ($top != $bottom && $right == $left)
  1040.             {
  1041.                 return $strType . ':' . $top . $arrValues['unit'] . ' ' . $right . $arrValues['unit'] . ' ' . $bottom . $arrValues['unit'] . ';';
  1042.             }
  1044.             return $strType . ':' . $top . $arrValues['unit'] . ' ' . $right . $arrValues['unit'] . ' ' . $bottom . $arrValues['unit'] . ' ' . $left . $arrValues['unit'] . ';';
  1045.         }
  1047.         $return = array();
  1048.         $arrDir = compact('top', 'right', 'bottom', 'left');
  1050.         foreach ($arrDir as $k=>$v)
  1051.         {
  1052.             if ($v)
  1053.             {
  1054.                 $return[] = $strType . '-' . $k . ':' . $v . $arrValues['unit'] . ';';
  1055.             }
  1056.         }
  1058.         return implode('', $return);
  1059.     }
  1061.     /**
  1062.      * Add a request string to the current URL
  1063.      *
  1064.      * @param string  $strRequest The string to be added
  1065.      * @param boolean $blnAddRef  Add the referer ID
  1066.      * @param array   $arrUnset   An optional array of keys to unset
  1067.      *
  1068.      * @return string The new URL
  1069.      */
  1070.     public static function addToUrl($strRequest, $blnAddRef=true, $arrUnset=array())
  1071.     {
  1072.         $query = new Query(Environment::get('queryString'));
  1074.         // Remove the request token and referer ID
  1075.         $query = $query->withoutPairs(array_merge(array('rt', 'ref'), $arrUnset));
  1077.         // Merge the request string to be added
  1078.         $query = $query->merge(str_replace('&amp;', '&', $strRequest));
  1080.         // Add the referer ID
  1081.         if (isset($_GET['ref']) || ($strRequest && $blnAddRef))
  1082.         {
  1083.             $query = $query->merge('ref=' . System::getContainer()->get('request_stack')->getCurrentRequest()->attributes->get('_contao_referer_id'));
  1084.         }
  1086.         $uri = $query->getUriComponent();
  1088.         // The query parser automatically converts %2B to +, so re-convert it here
  1089.         if (strpos($strRequest, '%2B') !== false)
  1090.         {
  1091.             $uri = str_replace('+', '%2B', $uri);
  1092.         }
  1094.         return TL_SCRIPT . ampersand($uri);
  1095.     }
  1097.     /**
  1098.      * Reload the current page
  1099.      */
  1100.     public static function reload()
  1101.     {
  1102.         static::redirect(Environment::get('uri'));
  1103.     }
  1105.     /**
  1106.      * Redirect to another page
  1107.      *
  1108.      * @param string  $strLocation The target URL
  1109.      * @param integer $intStatus   The HTTP status code (defaults to 303)
  1110.      */
  1111.     public static function redirect($strLocation, $intStatus=303)
  1112.     {
  1113.         $strLocation = str_replace('&amp;', '&', $strLocation);
  1114.         $strLocation = static::replaceOldBePaths($strLocation);
  1116.         // Make the location an absolute URL
  1117.         if (!preg_match('@^https?://@i', $strLocation))
  1118.         {
  1119.             $strLocation = Environment::get('base') . ltrim($strLocation, '/');
  1120.         }
  1122.         // Ajax request
  1123.         if (Environment::get('isAjaxRequest'))
  1124.         {
  1125.             throw new AjaxRedirectResponseException($strLocation);
  1126.         }
  1128.         throw new RedirectResponseException($strLocation, $intStatus);
  1129.     }
  1131.     /**
  1132.      * Replace the old back end paths
  1133.      *
  1134.      * @param string $strContext The context
  1135.      *
  1136.      * @return string The modified context
  1137.      */
  1138.     protected static function replaceOldBePaths($strContext)
  1139.     {
  1140.         $router = System::getContainer()->get('router');
  1142.         $generate = static function ($route) use ($router)
  1143.         {
  1144.             return substr($router->generate($route), \strlen(Environment::get('path')) + 1);
  1145.         };
  1147.         $arrMapper = array
  1148.         (
  1149.             'contao/confirm.php'   => $generate('contao_backend_confirm'),
  1150.             'contao/file.php'      => $generate('contao_backend_file'),
  1151.             'contao/help.php'      => $generate('contao_backend_help'),
  1152.             'contao/index.php'     => $generate('contao_backend_login'),
  1153.             'contao/main.php'      => $generate('contao_backend'),
  1154.             'contao/page.php'      => $generate('contao_backend_page'),
  1155.             'contao/password.php'  => $generate('contao_backend_password'),
  1156.             'contao/popup.php'     => $generate('contao_backend_popup'),
  1157.             'contao/preview.php'   => $generate('contao_backend_preview'),
  1158.         );
  1160.         return str_replace(array_keys($arrMapper), $arrMapper, $strContext);
  1161.     }
  1163.     /**
  1164.      * Generate a front end URL
  1165.      *
  1166.      * @param array   $arrRow       An array of page parameters
  1167.      * @param string  $strParams    An optional string of URL parameters
  1168.      * @param string  $strForceLang Force a certain language
  1169.      * @param boolean $blnFixDomain Check the domain of the target page and append it if necessary
  1170.      *
  1171.      * @return string An URL that can be used in the front end
  1172.      *
  1173.      * @deprecated Deprecated since Contao 4.2, to be removed in Contao 5.0.
  1174.      *             Use the contao.routing.url_generator service or PageModel::getFrontendUrl() instead.
  1175.      */
  1176.     public static function generateFrontendUrl(array $arrRow, $strParams=null, $strForceLang=null, $blnFixDomain=false)
  1177.     {
  1178.         @trigger_error('Using Controller::generateFrontendUrl() has been deprecated and will no longer work in Contao 5.0. Use the contao.routing.url_generator service or PageModel::getFrontendUrl() instead.', E_USER_DEPRECATED);
  1180.         if (!isset($arrRow['rootId']))
  1181.         {
  1182.             $row = PageModel::findWithDetails($arrRow['id']);
  1184.             $arrRow['rootId'] = $row->rootId;
  1186.             foreach (array('domain', 'rootLanguage', 'rootUseSSL') as $key)
  1187.             {
  1188.                 if (!isset($arrRow[$key]))
  1189.                 {
  1190.                     $arrRow[$key] = $row->$key;
  1191.                 }
  1192.             }
  1193.         }
  1195.         $arrParams = array();
  1197.         // Set the language
  1198.         if ($strForceLang)
  1199.         {
  1200.             $arrParams['_locale'] = $strForceLang;
  1201.         }
  1202.         elseif (isset($arrRow['rootLanguage']))
  1203.         {
  1204.             $arrParams['_locale'] = $arrRow['rootLanguage'];
  1205.         }
  1206.         elseif (isset($arrRow['language']) && $arrRow['type'] == 'root')
  1207.         {
  1208.             $arrParams['_locale'] = $arrRow['language'];
  1209.         }
  1210.         elseif (TL_MODE == 'FE')
  1211.         {
  1212.             /** @var PageModel $objPage */
  1213.             global $objPage;
  1215.             $arrParams['_locale'] = $objPage->rootLanguage;
  1216.         }
  1218.         // Add the domain if it differs from the current one (see #3765 and #6927)
  1219.         if ($blnFixDomain)
  1220.         {
  1221.             $arrParams['_domain'] = $arrRow['domain'];
  1222.             $arrParams['_ssl'] = (bool) $arrRow['rootUseSSL'];
  1223.         }
  1225.         $objUrlGenerator = System::getContainer()->get('contao.routing.url_generator');
  1226.         $strUrl = $objUrlGenerator->generate(($arrRow['alias'] ?: $arrRow['id']) . $strParams, $arrParams);
  1228.         // Remove path from absolute URLs
  1229.         if (0 === strncmp($strUrl, '/', 1))
  1230.         {
  1231.             $strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
  1232.         }
  1234.         // Decode sprintf placeholders
  1235.         if (strpos($strParams, '%') !== false)
  1236.         {
  1237.             $arrMatches = array();
  1238.             preg_match_all('/%([sducoxXbgGeEfF])/', $strParams, $arrMatches);
  1240.             foreach (array_unique($arrMatches[1]) as $v)
  1241.             {
  1242.                 $strUrl = str_replace('%25' . $v, '%' . $v, $strUrl);
  1243.             }
  1244.         }
  1246.         // HOOK: add custom logic
  1247.         if (isset($GLOBALS['TL_HOOKS']['generateFrontendUrl']) && \is_array($GLOBALS['TL_HOOKS']['generateFrontendUrl']))
  1248.         {
  1249.             foreach ($GLOBALS['TL_HOOKS']['generateFrontendUrl'] as $callback)
  1250.             {
  1251.                 $strUrl = static::importStatic($callback[0])->{$callback[1]}($arrRow, $strParams, $strUrl);
  1252.             }
  1253.         }
  1255.         return $strUrl;
  1256.     }
  1258.     /**
  1259.      * Convert relative URLs in href and src attributes to absolute URLs
  1260.      *
  1261.      * @param string  $strContent  The text with the URLs to be converted
  1262.      * @param string  $strBase     An optional base URL
  1263.      * @param boolean $blnHrefOnly If true, only href attributes will be converted
  1264.      *
  1265.      * @return string The text with the replaced URLs
  1266.      */
  1267.     public static function convertRelativeUrls($strContent, $strBase='', $blnHrefOnly=false)
  1268.     {
  1269.         if (!$strBase)
  1270.         {
  1271.             $strBase = Environment::get('base');
  1272.         }
  1274.         $search = $blnHrefOnly ? 'href' : 'href|src';
  1275.         $arrUrls = preg_split('/((' . $search . ')="([^"]+)")/i', $strContent, -1, PREG_SPLIT_DELIM_CAPTURE);
  1276.         $strContent = '';
  1278.         for ($i=0, $c=\count($arrUrls); $i<$c; $i+=4)
  1279.         {
  1280.             $strContent .= $arrUrls[$i];
  1282.             if (!isset($arrUrls[$i+2]))
  1283.             {
  1284.                 continue;
  1285.             }
  1287.             $strAttribute = $arrUrls[$i+2];
  1288.             $strUrl = $arrUrls[$i+3];
  1290.             if (!preg_match('@^(?:[a-z0-9]+:|#)@i', $strUrl))
  1291.             {
  1292.                 $strUrl = $strBase . (($strUrl != '/') ? $strUrl : '');
  1293.             }
  1295.             $strContent .= $strAttribute . '="' . $strUrl . '"';
  1296.         }
  1298.         return $strContent;
  1299.     }
  1301.     /**
  1302.      * Send a file to the browser so the "save as …" dialogue opens
  1303.      *
  1304.      * @param string  $strFile The file path
  1305.      * @param boolean $inline  Show the file in the browser instead of opening the download dialog
  1306.      *
  1307.      * @throws AccessDeniedException
  1308.      */
  1309.     public static function sendFileToBrowser($strFile, $inline=false)
  1310.     {
  1311.         // Make sure there are no attempts to hack the file system
  1312.         if (preg_match('@^\.+@', $strFile) || preg_match('@\.+/@', $strFile) || preg_match('@(://)+@', $strFile))
  1313.         {
  1314.             throw new PageNotFoundException('Invalid file name');
  1315.         }
  1317.         // Limit downloads to the files directory
  1318.         if (!preg_match('@^' . preg_quote(Config::get('uploadPath'), '@') . '@i', $strFile))
  1319.         {
  1320.             throw new PageNotFoundException('Invalid path');
  1321.         }
  1323.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  1325.         // Check whether the file exists
  1326.         if (!file_exists($projectDir . '/' . $strFile))
  1327.         {
  1328.             throw new PageNotFoundException('File not found');
  1329.         }
  1331.         $objFile = new File($strFile);
  1332.         $arrAllowedTypes = StringUtil::trimsplit(',', strtolower(Config::get('allowedDownload')));
  1334.         // Check whether the file type is allowed to be downloaded
  1335.         if (!\in_array($objFile->extension, $arrAllowedTypes))
  1336.         {
  1337.             throw new AccessDeniedException(sprintf('File type "%s" is not allowed', $objFile->extension));
  1338.         }
  1340.         // HOOK: post download callback
  1341.         if (isset($GLOBALS['TL_HOOKS']['postDownload']) && \is_array($GLOBALS['TL_HOOKS']['postDownload']))
  1342.         {
  1343.             foreach ($GLOBALS['TL_HOOKS']['postDownload'] as $callback)
  1344.             {
  1345.                 static::importStatic($callback[0])->{$callback[1]}($strFile);
  1346.             }
  1347.         }
  1349.         // Send the file (will stop the script execution)
  1350.         $objFile->sendToBrowser('', $inline);
  1351.     }
  1353.     /**
  1354.      * Load a set of DCA files
  1355.      *
  1356.      * @param string  $strTable   The table name
  1357.      * @param boolean $blnNoCache If true, the cache will be bypassed
  1358.      */
  1359.     public static function loadDataContainer($strTable, $blnNoCache=false)
  1360.     {
  1361.         $loader = new DcaLoader($strTable);
  1362.         $loader->load($blnNoCache);
  1363.     }
  1365.     /**
  1366.      * Redirect to a front end page
  1367.      *
  1368.      * @param integer $intPage    The page ID
  1369.      * @param string  $strArticle An optional article alias
  1370.      * @param boolean $blnReturn  If true, return the URL and don't redirect
  1371.      *
  1372.      * @return string The URL of the target page
  1373.      */
  1374.     protected function redirectToFrontendPage($intPage, $strArticle=null, $blnReturn=false)
  1375.     {
  1376.         if (($intPage = (int) $intPage) <= 0)
  1377.         {
  1378.             return '';
  1379.         }
  1381.         $objPage = PageModel::findWithDetails($intPage);
  1383.         if ($objPage === null)
  1384.         {
  1385.             return '';
  1386.         }
  1388.         $strParams = null;
  1390.         // Add the /article/ fragment (see #673)
  1391.         if ($strArticle !== null && ($objArticle = ArticleModel::findByAlias($strArticle)) !== null)
  1392.         {
  1393.             $strParams = '/articles/' . (($objArticle->inColumn != 'main') ? $objArticle->inColumn . ':' : '') . $strArticle;
  1394.         }
  1396.         $strUrl = $objPage->getPreviewUrl($strParams);
  1398.         if (!$blnReturn)
  1399.         {
  1400.             $this->redirect($strUrl);
  1401.         }
  1403.         return $strUrl;
  1404.     }
  1406.     /**
  1407.      * Get the parent records of an entry and return them as string which can
  1408.      * be used in a log message
  1409.      *
  1410.      * @param string  $strTable The table name
  1411.      * @param integer $intId    The record ID
  1412.      *
  1413.      * @return string A string that can be used in a log message
  1414.      */
  1415.     protected function getParentEntries($strTable, $intId)
  1416.     {
  1417.         // No parent table
  1418.         if (!isset($GLOBALS['TL_DCA'][$strTable]['config']['ptable']))
  1419.         {
  1420.             return '';
  1421.         }
  1423.         $arrParent = array();
  1425.         do
  1426.         {
  1427.             // Get the pid
  1428.             $objParent = $this->Database->prepare("SELECT pid FROM " . $strTable . " WHERE id=?")
  1429.                                         ->limit(1)
  1430.                                         ->execute($intId);
  1432.             if ($objParent->numRows < 1)
  1433.             {
  1434.                 break;
  1435.             }
  1437.             // Store the parent table information
  1438.             $strTable = $GLOBALS['TL_DCA'][$strTable]['config']['ptable'];
  1439.             $intId = $objParent->pid;
  1441.             // Add the log entry
  1442.             $arrParent[] = $strTable . '.id=' . $intId;
  1444.             // Load the data container of the parent table
  1445.             $this->loadDataContainer($strTable);
  1446.         } while ($intId && isset($GLOBALS['TL_DCA'][$strTable]['config']['ptable']));
  1448.         if (empty($arrParent))
  1449.         {
  1450.             return '';
  1451.         }
  1453.         return ' (parent records: ' . implode(', ', $arrParent) . ')';
  1454.     }
  1456.     /**
  1457.      * Take an array of file paths and eliminate the nested ones
  1458.      *
  1459.      * @param array $arrPaths The array of file paths
  1460.      *
  1461.      * @return array The file paths array without the nested paths
  1462.      */
  1463.     protected function eliminateNestedPaths($arrPaths)
  1464.     {
  1465.         $arrPaths = array_filter($arrPaths);
  1467.         if (empty($arrPaths) || !\is_array($arrPaths))
  1468.         {
  1469.             return array();
  1470.         }
  1472.         $nested = array();
  1474.         foreach ($arrPaths as $path)
  1475.         {
  1476.             $nested[] = preg_grep('/^' . preg_quote($path, '/') . '\/.+/', $arrPaths);
  1477.         }
  1479.         if (!empty($nested))
  1480.         {
  1481.             $nested = array_merge(...$nested);
  1482.         }
  1484.         return array_values(array_diff($arrPaths, $nested));
  1485.     }
  1487.     /**
  1488.      * Take an array of pages and eliminate the nested ones
  1489.      *
  1490.      * @param array   $arrPages   The array of page IDs
  1491.      * @param string  $strTable   The table name
  1492.      * @param boolean $blnSorting True if the table has a sorting field
  1493.      *
  1494.      * @return array The page IDs array without the nested IDs
  1495.      */
  1496.     protected function eliminateNestedPages($arrPages, $strTable=null, $blnSorting=false)
  1497.     {
  1498.         if (empty($arrPages) || !\is_array($arrPages))
  1499.         {
  1500.             return array();
  1501.         }
  1503.         if (!$strTable)
  1504.         {
  1505.             $strTable = 'tl_page';
  1506.         }
  1508.         // Thanks to Andreas Schempp (see #2475 and #3423)
  1509.         $arrPages = array_intersect($arrPages, $this->Database->getChildRecords(0, $strTable, $blnSorting));
  1510.         $arrPages = array_values(array_diff($arrPages, $this->Database->getChildRecords($arrPages, $strTable, $blnSorting)));
  1512.         return $arrPages;
  1513.     }
  1515.     /**
  1516.      * Add an image to a template
  1517.      *
  1518.      * @param object     $objTemplate   The template object to add the image to
  1519.      * @param array      $arrItem       The element or module as array
  1520.      * @param integer    $intMaxWidth   An optional maximum width of the image
  1521.      * @param string     $strLightboxId An optional lightbox ID
  1522.      * @param FilesModel $objModel      An optional files model
  1523.      */
  1524.     public static function addImageToTemplate($objTemplate, $arrItem, $intMaxWidth=null, $strLightboxId=null, FilesModel $objModel=null)
  1525.     {
  1526.         try
  1527.         {
  1528.             $objFile = new File($arrItem['singleSRC']);
  1529.         }
  1530.         catch (\Exception $e)
  1531.         {
  1532.             $objFile = null;
  1533.         }
  1535.         $imgSize = $objFile->imageSize ?? array();
  1536.         $size = StringUtil::deserialize($arrItem['size']);
  1538.         if (is_numeric($size))
  1539.         {
  1540.             $size = array(0, 0, (int) $size);
  1541.         }
  1542.         elseif (!$size instanceof PictureConfiguration)
  1543.         {
  1544.             if (!\is_array($size))
  1545.             {
  1546.                 $size = array();
  1547.             }
  1549.             $size += array(0, 0, 'crop');
  1550.         }
  1552.         if ($intMaxWidth === null)
  1553.         {
  1554.             $intMaxWidth = Config::get('maxImageWidth');
  1555.         }
  1557.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  1559.         if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  1560.         {
  1561.             $arrMargin = array();
  1562.         }
  1563.         else
  1564.         {
  1565.             $arrMargin = StringUtil::deserialize($arrItem['imagemargin']);
  1566.         }
  1568.         // Store the original dimensions
  1569.         $objTemplate->width = $imgSize[0];
  1570.         $objTemplate->height = $imgSize[1];
  1572.         // Adjust the image size
  1573.         if ($intMaxWidth > 0)
  1574.         {
  1575.             @trigger_error('Using a maximum front end width has been deprecated and will no longer work in Contao 5.0. Remove the "maxImageWidth" configuration and use responsive images instead.', E_USER_DEPRECATED);
  1577.             // Subtract the margins before deciding whether to resize (see #6018)
  1578.             if (\is_array($arrMargin) && $arrMargin['unit'] == 'px')
  1579.             {
  1580.                 $intMargin = (int) $arrMargin['left'] + (int) $arrMargin['right'];
  1582.                 // Reset the margin if it exceeds the maximum width (see #7245)
  1583.                 if ($intMaxWidth - $intMargin < 1)
  1584.                 {
  1585.                     $arrMargin['left'] = '';
  1586.                     $arrMargin['right'] = '';
  1587.                 }
  1588.                 else
  1589.                 {
  1590.                     $intMaxWidth -= $intMargin;
  1591.                 }
  1592.             }
  1594.             if (\is_array($size) && ($size[0] > $intMaxWidth || (!$size[0] && !$size[1] && (!$imgSize[0] || $imgSize[0] > $intMaxWidth))))
  1595.             {
  1596.                 // See #2268 (thanks to Thyon)
  1597.                 $ratio = ($size[0] && $size[1]) ? $size[1] / $size[0] : (($imgSize[0] && $imgSize[1]) ? $imgSize[1] / $imgSize[0] : 0);
  1599.                 $size[0] = $intMaxWidth;
  1600.                 $size[1] = floor($intMaxWidth * $ratio);
  1601.             }
  1602.         }
  1604.         $container = System::getContainer();
  1606.         try
  1607.         {
  1608.             $projectDir = $container->getParameter('kernel.project_dir');
  1609.             $staticUrl = $container->get('contao.assets.files_context')->getStaticUrl();
  1610.             $picture = $container->get('contao.image.picture_factory')->create($projectDir . '/' . $arrItem['singleSRC'], $size);
  1612.             $picture = array
  1613.             (
  1614.                 'img' => $picture->getImg($projectDir, $staticUrl),
  1615.                 'sources' => $picture->getSources($projectDir, $staticUrl)
  1616.             );
  1618.             $src = $picture['img']['src'];
  1620.             if ($src !== $arrItem['singleSRC'])
  1621.             {
  1622.                 $objFile = new File(rawurldecode($src));
  1623.             }
  1624.         }
  1625.         catch (\Exception $e)
  1626.         {
  1627.             System::log('Image "' . $arrItem['singleSRC'] . '" could not be processed: ' . $e->getMessage(), __METHOD__, TL_ERROR);
  1629.             $src = '';
  1630.             $picture = array('img'=>array('src'=>'', 'srcset'=>''), 'sources'=>array());
  1631.         }
  1633.         // Image dimensions
  1634.         if ($objFile && ($imgSize = $objFile->imageSize) !== false)
  1635.         {
  1636.             $objTemplate->arrSize = $imgSize;
  1637.             $objTemplate->imgSize = ' width="' . $imgSize[0] . '" height="' . $imgSize[1] . '"';
  1638.         }
  1640.         $arrMeta = array();
  1642.         // Load the meta data
  1643.         if ($objModel instanceof FilesModel)
  1644.         {
  1645.             if (TL_MODE == 'FE')
  1646.             {
  1647.                 global $objPage;
  1649.                 $arrMeta = Frontend::getMetaData($objModel->meta, $objPage->language);
  1651.                 if (empty($arrMeta) && $objPage->rootFallbackLanguage !== null)
  1652.                 {
  1653.                     $arrMeta = Frontend::getMetaData($objModel->meta, $objPage->rootFallbackLanguage);
  1654.                 }
  1655.             }
  1656.             else
  1657.             {
  1658.                 $arrMeta = Frontend::getMetaData($objModel->meta, $GLOBALS['TL_LANGUAGE']);
  1659.             }
  1661.             self::loadDataContainer('tl_files');
  1663.             // Add any missing fields
  1664.             foreach (array_keys($GLOBALS['TL_DCA']['tl_files']['fields']['meta']['eval']['metaFields']) as $k)
  1665.             {
  1666.                 if (!isset($arrMeta[$k]))
  1667.                 {
  1668.                     $arrMeta[$k] = '';
  1669.                 }
  1670.             }
  1672.             $arrMeta['imageTitle'] = $arrMeta['title'];
  1673.             $arrMeta['imageUrl'] = $arrMeta['link'];
  1674.             unset($arrMeta['title'], $arrMeta['link']);
  1676.             // Add the meta data to the item
  1677.             if (!$arrItem['overwriteMeta'])
  1678.             {
  1679.                 foreach ($arrMeta as $k=>$v)
  1680.                 {
  1681.                     switch ($k)
  1682.                     {
  1683.                         case 'alt':
  1684.                         case 'imageTitle':
  1685.                             $arrItem[$k] = StringUtil::specialchars($v);
  1686.                             break;
  1688.                         default:
  1689.                             $arrItem[$k] = $v;
  1690.                             break;
  1691.                     }
  1692.                 }
  1693.             }
  1694.         }
  1696.         $picture['alt'] = StringUtil::specialchars($arrItem['alt']);
  1698.         // Move the title to the link tag so it is shown in the lightbox
  1699.         if ($arrItem['imageTitle'] && !$arrItem['linkTitle'] && ($arrItem['fullsize'] || $arrItem['imageUrl']))
  1700.         {
  1701.             $arrItem['linkTitle'] = $arrItem['imageTitle'];
  1702.             unset($arrItem['imageTitle']);
  1703.         }
  1705.         if (isset($arrItem['imageTitle']))
  1706.         {
  1707.             $picture['title'] = StringUtil::specialchars($arrItem['imageTitle']);
  1708.         }
  1710.         $objTemplate->picture = $picture;
  1712.         // Provide an ID for single lightbox images in HTML5 (see #3742)
  1713.         if ($strLightboxId === null && $arrItem['fullsize'] && $objTemplate instanceof Template && !empty($arrItem['id']))
  1714.         {
  1715.             $strLightboxId = substr(md5($objTemplate->getName() . '_' . $arrItem['id']), 0, 6);
  1716.         }
  1718.         // Float image
  1719.         if ($arrItem['floating'])
  1720.         {
  1721.             $objTemplate->floatClass = ' float_' . $arrItem['floating'];
  1722.         }
  1724.         // Do not override the "href" key (see #6468)
  1725.         $strHrefKey = $objTemplate->href ? 'imageHref' : 'href';
  1726.         $lightboxSize = StringUtil::deserialize($arrItem['lightboxSize'] ?? null, true);
  1728.         if (!$lightboxSize && $arrItem['fullsize'] && isset($GLOBALS['objPage']->layoutId))
  1729.         {
  1730.             $lightboxSize = StringUtil::deserialize(LayoutModel::findByPk($GLOBALS['objPage']->layoutId)->lightboxSize ?? null, true);
  1731.         }
  1733.         // Image link
  1734.         if (TL_MODE == 'FE' && $arrItem['imageUrl'])
  1735.         {
  1736.             $objTemplate->$strHrefKey = $arrItem['imageUrl'];
  1737.             $objTemplate->attributes = '';
  1739.             if ($arrItem['fullsize'])
  1740.             {
  1741.                 $blnIsExternal = strncmp($arrItem['imageUrl'], 'http://', 7) === 0 || strncmp($arrItem['imageUrl'], 'https://', 8) === 0;
  1743.                 // Open images in the lightbox
  1744.                 if (preg_match('/\.(' . strtr(preg_quote(Config::get('validImageTypes'), '/'), ',', '|') . ')$/i', $arrItem['imageUrl']))
  1745.                 {
  1746.                     // Do not add the TL_FILES_URL to external URLs (see #4923)
  1747.                     if (!$blnIsExternal)
  1748.                     {
  1749.                         try
  1750.                         {
  1751.                             $projectDir = $container->getParameter('kernel.project_dir');
  1752.                             $staticUrl = $container->get('contao.assets.files_context')->getStaticUrl();
  1753.                             $picture = $container->get('contao.image.picture_factory')->create($projectDir . '/' . $arrItem['imageUrl'], $lightboxSize);
  1755.                             $objTemplate->lightboxPicture = array
  1756.                             (
  1757.                                 'img' => $picture->getImg($projectDir, $staticUrl),
  1758.                                 'sources' => $picture->getSources($projectDir, $staticUrl)
  1759.                             );
  1761.                             $objTemplate->$strHrefKey = $objTemplate->lightboxPicture['img']['src'];
  1762.                         }
  1763.                         catch (\Exception $e)
  1764.                         {
  1765.                             $objTemplate->$strHrefKey = static::addFilesUrlTo(System::urlEncode($arrItem['imageUrl']));
  1766.                             $objTemplate->lightboxPicture = array('img'=>array('src'=>$objTemplate->$strHrefKey, 'srcset'=>$objTemplate->$strHrefKey), 'sources'=>array());
  1767.                         }
  1768.                     }
  1770.                     $objTemplate->attributes = ' data-lightbox="' . $strLightboxId . '"';
  1771.                 }
  1772.                 else
  1773.                 {
  1774.                     $objTemplate->attributes = ' target="_blank"';
  1776.                     if ($blnIsExternal)
  1777.                     {
  1778.                         $objTemplate->attributes .= ' rel="noreferrer noopener"';
  1779.                     }
  1780.                 }
  1781.             }
  1782.         }
  1784.         // Fullsize view
  1785.         elseif (TL_MODE == 'FE' && $arrItem['fullsize'])
  1786.         {
  1787.             try
  1788.             {
  1789.                 $projectDir = $container->getParameter('kernel.project_dir');
  1790.                 $staticUrl = $container->get('contao.assets.files_context')->getStaticUrl();
  1791.                 $picture = $container->get('contao.image.picture_factory')->create($projectDir . '/' . $arrItem['singleSRC'], $lightboxSize);
  1793.                 $objTemplate->lightboxPicture = array
  1794.                 (
  1795.                     'img' => $picture->getImg($projectDir, $staticUrl),
  1796.                     'sources' => $picture->getSources($projectDir, $staticUrl)
  1797.                 );
  1799.                 $objTemplate->$strHrefKey = $objTemplate->lightboxPicture['img']['src'];
  1800.             }
  1801.             catch (\Exception $e)
  1802.             {
  1803.                 $objTemplate->$strHrefKey = static::addFilesUrlTo(System::urlEncode($arrItem['singleSRC']));
  1804.                 $objTemplate->lightboxPicture = array('img'=>array('src'=>$objTemplate->$strHrefKey, 'srcset'=>$objTemplate->$strHrefKey), 'sources'=>array());
  1805.             }
  1807.             $objTemplate->attributes = ' data-lightbox="' . $strLightboxId . '"';
  1808.         }
  1810.         // Add the meta data to the template
  1811.         foreach (array_keys($arrMeta) as $k)
  1812.         {
  1813.             $objTemplate->$k = $arrItem[$k];
  1814.         }
  1816.         // Do not urlEncode() here because getImage() already does (see #3817)
  1817.         $objTemplate->src = static::addFilesUrlTo($src);
  1818.         $objTemplate->singleSRC = $arrItem['singleSRC'];
  1819.         $objTemplate->linkTitle = StringUtil::specialchars($arrItem['linkTitle'] ?: $arrItem['title']);
  1820.         $objTemplate->fullsize = $arrItem['fullsize'] ? true : false;
  1821.         $objTemplate->addBefore = ($arrItem['floating'] != 'below');
  1822.         $objTemplate->margin = static::generateMargin($arrMargin);
  1823.         $objTemplate->addImage = true;
  1824.     }
  1826.     /**
  1827.      * Add enclosures to a template
  1828.      *
  1829.      * @param object $objTemplate The template object to add the enclosures to
  1830.      * @param array  $arrItem     The element or module as array
  1831.      * @param string $strKey      The name of the enclosures field in $arrItem
  1832.      */
  1833.     public static function addEnclosuresToTemplate($objTemplate, $arrItem, $strKey='enclosure')
  1834.     {
  1835.         $arrEnclosures = StringUtil::deserialize($arrItem[$strKey]);
  1837.         if (empty($arrEnclosures) || !\is_array($arrEnclosures))
  1838.         {
  1839.             return;
  1840.         }
  1842.         $objFiles = FilesModel::findMultipleByUuids($arrEnclosures);
  1844.         if ($objFiles === null)
  1845.         {
  1846.             return;
  1847.         }
  1849.         $file = Input::get('file', true);
  1851.         // Send the file to the browser and do not send a 404 header (see #5178)
  1852.         if ($file)
  1853.         {
  1854.             while ($objFiles->next())
  1855.             {
  1856.                 if ($file == $objFiles->path)
  1857.                 {
  1858.                     static::sendFileToBrowser($file);
  1859.                 }
  1860.             }
  1862.             $objFiles->reset();
  1863.         }
  1865.         /** @var PageModel $objPage */
  1866.         global $objPage;
  1868.         $arrEnclosures = array();
  1869.         $allowedDownload = StringUtil::trimsplit(',', strtolower(Config::get('allowedDownload')));
  1871.         // Add download links
  1872.         while ($objFiles->next())
  1873.         {
  1874.             if ($objFiles->type == 'file')
  1875.             {
  1876.                 $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  1878.                 if (!\in_array($objFiles->extension, $allowedDownload) || !is_file($projectDir . '/' . $objFiles->path))
  1879.                 {
  1880.                     continue;
  1881.                 }
  1883.                 $objFile = new File($objFiles->path);
  1884.                 $strHref = Environment::get('request');
  1886.                 // Remove an existing file parameter (see #5683)
  1887.                 if (preg_match('/(&(amp;)?|\?)file=/', $strHref))
  1888.                 {
  1889.                     $strHref = preg_replace('/(&(amp;)?|\?)file=[^&]+/', '', $strHref);
  1890.                 }
  1892.                 $strHref .= ((strpos($strHref, '?') !== false) ? '&amp;' : '?') . 'file=' . System::urlEncode($objFiles->path);
  1894.                 $arrMeta = Frontend::getMetaData($objFiles->meta, $objPage->language);
  1896.                 if (empty($arrMeta) && $objPage->rootFallbackLanguage !== null)
  1897.                 {
  1898.                     $arrMeta = Frontend::getMetaData($objFiles->meta, $objPage->rootFallbackLanguage);
  1899.                 }
  1901.                 // Use the file name as title if none is given
  1902.                 if (!$arrMeta['title'])
  1903.                 {
  1904.                     $arrMeta['title'] = StringUtil::specialchars($objFile->basename);
  1905.                 }
  1907.                 $arrEnclosures[] = array
  1908.                 (
  1909.                     'id'        => $objFiles->id,
  1910.                     'uuid'      => $objFiles->uuid,
  1911.                     'name'      => $objFile->basename,
  1912.                     'title'     => StringUtil::specialchars(sprintf($GLOBALS['TL_LANG']['MSC']['download'], $objFile->basename)),
  1913.                     'link'      => $arrMeta['title'],
  1914.                     'caption'   => $arrMeta['caption'],
  1915.                     'href'      => $strHref,
  1916.                     'filesize'  => static::getReadableSize($objFile->filesize),
  1917.                     'icon'      => Image::getPath($objFile->icon),
  1918.                     'mime'      => $objFile->mime,
  1919.                     'meta'      => $arrMeta,
  1920.                     'extension' => $objFile->extension,
  1921.                     'path'      => $objFile->dirname,
  1922.                     'enclosure' => $objFiles->path // backwards compatibility
  1923.                 );
  1924.             }
  1925.         }
  1927.         // Order the enclosures
  1928.         if (!empty($arrItem['orderEnclosure']))
  1929.         {
  1930.             $tmp = StringUtil::deserialize($arrItem['orderEnclosure']);
  1932.             if (!empty($tmp) && \is_array($tmp))
  1933.             {
  1934.                 // Remove all values
  1935.                 $arrOrder = array_map(static function () {}, array_flip($tmp));
  1937.                 // Move the matching elements to their position in $arrOrder
  1938.                 foreach ($arrEnclosures as $k=>$v)
  1939.                 {
  1940.                     if (\array_key_exists($v['uuid'], $arrOrder))
  1941.                     {
  1942.                         $arrOrder[$v['uuid']] = $v;
  1943.                         unset($arrEnclosures[$k]);
  1944.                     }
  1945.                 }
  1947.                 // Append the left-over enclosures at the end
  1948.                 if (!empty($arrEnclosures))
  1949.                 {
  1950.                     $arrOrder = array_merge($arrOrder, array_values($arrEnclosures));
  1951.                 }
  1953.                 // Remove empty (unreplaced) entries
  1954.                 $arrEnclosures = array_values(array_filter($arrOrder));
  1955.                 unset($arrOrder);
  1956.             }
  1957.         }
  1959.         $objTemplate->enclosure = $arrEnclosures;
  1960.     }
  1962.     /**
  1963.      * Set the static URL constants
  1964.      */
  1965.     public static function setStaticUrls()
  1966.     {
  1967.         if (\defined('TL_FILES_URL'))
  1968.         {
  1969.             return;
  1970.         }
  1972.         if (\func_num_args() > 0)
  1973.         {
  1974.             @trigger_error('Using Controller::setStaticUrls() has been deprecated and will no longer work in Contao 5.0. Use the asset contexts instead.', E_USER_DEPRECATED);
  1976.             if (!isset($GLOBALS['objPage']))
  1977.             {
  1978.                 $GLOBALS['objPage'] = func_get_arg(0);
  1979.             }
  1980.         }
  1982.         \define('TL_ASSETS_URL', System::getContainer()->get('contao.assets.assets_context')->getStaticUrl());
  1983.         \define('TL_FILES_URL', System::getContainer()->get('contao.assets.files_context')->getStaticUrl());
  1985.         // Deprecated since Contao 4.0, to be removed in Contao 5.0
  1986.         \define('TL_SCRIPT_URL', TL_ASSETS_URL);
  1987.         \define('TL_PLUGINS_URL', TL_ASSETS_URL);
  1988.     }
  1990.     /**
  1991.      * Add a static URL to a script
  1992.      *
  1993.      * @param string             $script  The script path
  1994.      * @param ContaoContext|null $context
  1995.      *
  1996.      * @return string The script path with the static URL
  1997.      */
  1998.     public static function addStaticUrlTo($script, ContaoContext $context = null)
  1999.     {
  2000.         // Absolute URLs
  2001.         if (preg_match('@^https?://@', $script))
  2002.         {
  2003.             return $script;
  2004.         }
  2006.         if ($context === null)
  2007.         {
  2008.             $context = System::getContainer()->get('contao.assets.assets_context');
  2009.         }
  2011.         if ($strStaticUrl = $context->getStaticUrl())
  2012.         {
  2013.             return $strStaticUrl . $script;
  2014.         }
  2016.         return $script;
  2017.     }
  2019.     /**
  2020.      * Add the assets URL to a script
  2021.      *
  2022.      * @param string $script The script path
  2023.      *
  2024.      * @return string The script path with the assets URL
  2025.      */
  2026.     public static function addAssetsUrlTo($script)
  2027.     {
  2028.         return static::addStaticUrlTo($script, System::getContainer()->get('contao.assets.assets_context'));
  2029.     }
  2031.     /**
  2032.      * Add the files URL to a script
  2033.      *
  2034.      * @param string $script The script path
  2035.      *
  2036.      * @return string The script path with the files URL
  2037.      */
  2038.     public static function addFilesUrlTo($script)
  2039.     {
  2040.         return static::addStaticUrlTo($script, System::getContainer()->get('contao.assets.files_context'));
  2041.     }
  2043.     /**
  2044.      * Return the current theme as string
  2045.      *
  2046.      * @return string The name of the theme
  2047.      *
  2048.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2049.      *             Use Backend::getTheme() instead.
  2050.      */
  2051.     public static function getTheme()
  2052.     {
  2053.         @trigger_error('Using Controller::getTheme() has been deprecated and will no longer work in Contao 5.0. Use Backend::getTheme() instead.', E_USER_DEPRECATED);
  2055.         return Backend::getTheme();
  2056.     }
  2058.     /**
  2059.      * Return the back end themes as array
  2060.      *
  2061.      * @return array An array of available back end themes
  2062.      *
  2063.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2064.      *             Use Backend::getThemes() instead.
  2065.      */
  2066.     public static function getBackendThemes()
  2067.     {
  2068.         @trigger_error('Using Controller::getBackendThemes() has been deprecated and will no longer work in Contao 5.0. Use Backend::getThemes() instead.', E_USER_DEPRECATED);
  2070.         return Backend::getThemes();
  2071.     }
  2073.     /**
  2074.      * Get the details of a page including inherited parameters
  2075.      *
  2076.      * @param mixed $intId A page ID or a Model object
  2077.      *
  2078.      * @return PageModel The page model or null
  2079.      *
  2080.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2081.      *             Use PageModel::findWithDetails() or PageModel->loadDetails() instead.
  2082.      */
  2083.     public static function getPageDetails($intId)
  2084.     {
  2085.         @trigger_error('Using Controller::getPageDetails() has been deprecated and will no longer work in Contao 5.0. Use PageModel::findWithDetails() or PageModel->loadDetails() instead.', E_USER_DEPRECATED);
  2087.         if ($intId instanceof PageModel)
  2088.         {
  2089.             return $intId->loadDetails();
  2090.         }
  2092.         if ($intId instanceof Collection)
  2093.         {
  2094.             /** @var PageModel $objPage */
  2095.             $objPage = $intId->current();
  2097.             return $objPage->loadDetails();
  2098.         }
  2100.         if (\is_object($intId))
  2101.         {
  2102.             $strKey = __METHOD__ . '-' . $intId->id;
  2104.             // Try to load from cache
  2105.             if (Cache::has($strKey))
  2106.             {
  2107.                 return Cache::get($strKey);
  2108.             }
  2110.             // Create a model from the database result
  2111.             $objPage = new PageModel();
  2112.             $objPage->setRow($intId->row());
  2113.             $objPage->loadDetails();
  2115.             Cache::set($strKey, $objPage);
  2117.             return $objPage;
  2118.         }
  2120.         // Invalid ID
  2121.         if ($intId < 1 || !\strlen($intId))
  2122.         {
  2123.             return null;
  2124.         }
  2126.         $strKey = __METHOD__ . '-' . $intId;
  2128.         // Try to load from cache
  2129.         if (Cache::has($strKey))
  2130.         {
  2131.             return Cache::get($strKey);
  2132.         }
  2134.         $objPage = PageModel::findWithDetails($intId);
  2136.         Cache::set($strKey, $objPage);
  2138.         return $objPage;
  2139.     }
  2141.     /**
  2142.      * Remove old XML files from the share directory
  2143.      *
  2144.      * @param boolean $blnReturn If true, only return the finds and don't delete
  2145.      *
  2146.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2147.      *             Use Automator::purgeXmlFiles() instead.
  2148.      */
  2149.     protected function removeOldFeeds($blnReturn=false)
  2150.     {
  2151.         @trigger_error('Using Controller::removeOldFeeds() has been deprecated and will no longer work in Contao 5.0. Use Automator::purgeXmlFiles() instead.', E_USER_DEPRECATED);
  2153.         $this->import(Automator::class, 'Automator');
  2154.         $this->Automator->purgeXmlFiles($blnReturn);
  2155.     }
  2157.     /**
  2158.      * Return true if a class exists (tries to autoload the class)
  2159.      *
  2160.      * @param string $strClass The class name
  2161.      *
  2162.      * @return boolean True if the class exists
  2163.      *
  2164.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2165.      *             Use the PHP function class_exists() instead.
  2166.      */
  2167.     protected function classFileExists($strClass)
  2168.     {
  2169.         @trigger_error('Using Controller::classFileExists() has been deprecated and will no longer work in Contao 5.0. Use the PHP function class_exists() instead.', E_USER_DEPRECATED);
  2171.         return class_exists($strClass);
  2172.     }
  2174.     /**
  2175.      * Restore basic entities
  2176.      *
  2177.      * @param string $strBuffer The string with the tags to be replaced
  2178.      *
  2179.      * @return string The string with the original entities
  2180.      *
  2181.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2182.      *             Use StringUtil::restoreBasicEntities() instead.
  2183.      */
  2184.     public static function restoreBasicEntities($strBuffer)
  2185.     {
  2186.         @trigger_error('Using Controller::restoreBasicEntities() has been deprecated and will no longer work in Contao 5.0. Use StringUtil::restoreBasicEntities() instead.', E_USER_DEPRECATED);
  2188.         return StringUtil::restoreBasicEntities($strBuffer);
  2189.     }
  2191.     /**
  2192.      * Resize an image and crop it if necessary
  2193.      *
  2194.      * @param string  $image  The image path
  2195.      * @param integer $width  The target width
  2196.      * @param integer $height The target height
  2197.      * @param string  $mode   An optional resize mode
  2198.      *
  2199.      * @return boolean True if the image has been resized correctly
  2200.      *
  2201.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2202.      *             Use Image::resize() instead.
  2203.      */
  2204.     protected function resizeImage($image, $width, $height, $mode='')
  2205.     {
  2206.         @trigger_error('Using Controller::resizeImage() has been deprecated and will no longer work in Contao 5.0. Use Image::resize() instead.', E_USER_DEPRECATED);
  2208.         return Image::resize($image, $width, $height, $mode);
  2209.     }
  2211.     /**
  2212.      * Resize an image and crop it if necessary
  2213.      *
  2214.      * @param string  $image  The image path
  2215.      * @param integer $width  The target width
  2216.      * @param integer $height The target height
  2217.      * @param string  $mode   An optional resize mode
  2218.      * @param string  $target An optional target to be replaced
  2219.      * @param boolean $force  Override existing target images
  2220.      *
  2221.      * @return string|null The image path or null
  2222.      *
  2223.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2224.      *             Use Image::get() instead.
  2225.      */
  2226.     protected function getImage($image, $width, $height, $mode='', $target=null, $force=false)
  2227.     {
  2228.         @trigger_error('Using Controller::getImage() has been deprecated and will no longer work in Contao 5.0. Use Image::get() instead.', E_USER_DEPRECATED);
  2230.         return Image::get($image, $width, $height, $mode, $target, $force);
  2231.     }
  2233.     /**
  2234.      * Generate an image tag and return it as string
  2235.      *
  2236.      * @param string $src        The image path
  2237.      * @param string $alt        An optional alt attribute
  2238.      * @param string $attributes A string of other attributes
  2239.      *
  2240.      * @return string The image HTML tag
  2241.      *
  2242.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2243.      *             Use Image::getHtml() instead.
  2244.      */
  2245.     public static function generateImage($src, $alt='', $attributes='')
  2246.     {
  2247.         @trigger_error('Using Controller::generateImage() has been deprecated and will no longer work in Contao 5.0. Use Image::getHtml() instead.', E_USER_DEPRECATED);
  2249.         return Image::getHtml($src, $alt, $attributes);
  2250.     }
  2252.     /**
  2253.      * Return the date picker string (see #3218)
  2254.      *
  2255.      * @return boolean
  2256.      *
  2257.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2258.      *             Specify "datepicker"=>true in your DCA file instead.
  2259.      */
  2260.     protected function getDatePickerString()
  2261.     {
  2262.         @trigger_error('Using Controller::getDatePickerString() has been deprecated and will no longer work in Contao 5.0. Specify "datepicker"=>true in your DCA file instead.', E_USER_DEPRECATED);
  2264.         return true;
  2265.     }
  2267.     /**
  2268.      * Return the installed back end languages as array
  2269.      *
  2270.      * @return array An array of available back end languages
  2271.      *
  2272.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2273.      *             Use System::getLanguages(true) instead.
  2274.      */
  2275.     protected function getBackendLanguages()
  2276.     {
  2277.         @trigger_error('Using Controller::getBackendLanguages() has been deprecated and will no longer work in Contao 5.0. Use System::getLanguages(true) instead.', E_USER_DEPRECATED);
  2279.         return $this->getLanguages(true);
  2280.     }
  2282.     /**
  2283.      * Parse simple tokens that can be used to personalize newsletters
  2284.      *
  2285.      * @param string $strBuffer The text with the tokens to be replaced
  2286.      * @param array  $arrData   The replacement data as array
  2287.      *
  2288.      * @return string The text with the replaced tokens
  2289.      *
  2290.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2291.      *             Use StringUtil::parseSimpleTokens() instead.
  2292.      */
  2293.     protected function parseSimpleTokens($strBuffer, $arrData)
  2294.     {
  2295.         @trigger_error('Using Controller::parseSimpleTokens() has been deprecated and will no longer work in Contao 5.0. Use StringUtil::parseSimpleTokens() instead.', E_USER_DEPRECATED);
  2297.         return StringUtil::parseSimpleTokens($strBuffer, $arrData);
  2298.     }
  2300.     /**
  2301.      * Convert a DCA file configuration to be used with widgets
  2302.      *
  2303.      * @param array  $arrData  The field configuration array
  2304.      * @param string $strName  The field name in the form
  2305.      * @param mixed  $varValue The field value
  2306.      * @param string $strField The field name in the database
  2307.      * @param string $strTable The table name
  2308.      *
  2309.      * @return array An array that can be passed to a widget
  2310.      *
  2311.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2312.      *             Use Widget::getAttributesFromDca() instead.
  2313.      */
  2314.     protected function prepareForWidget($arrData, $strName, $varValue=null, $strField='', $strTable='')
  2315.     {
  2316.         @trigger_error('Using Controller::prepareForWidget() has been deprecated and will no longer work in Contao 5.0. Use Widget::getAttributesFromDca() instead.', E_USER_DEPRECATED);
  2318.         return Widget::getAttributesFromDca($arrData, $strName, $varValue, $strField, $strTable);
  2319.     }
  2321.     /**
  2322.      * Return the IDs of all child records of a particular record (see #2475)
  2323.      *
  2324.      * @author Andreas Schempp
  2325.      *
  2326.      * @param mixed   $arrParentIds An array of parent IDs
  2327.      * @param string  $strTable     The table name
  2328.      * @param boolean $blnSorting   True if the table has a sorting field
  2329.      * @param array   $arrReturn    The array to be returned
  2330.      * @param string  $strWhere     Additional WHERE condition
  2331.      *
  2332.      * @return array An array of child record IDs
  2333.      *
  2334.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2335.      *             Use Database::getChildRecords() instead.
  2336.      */
  2337.     protected function getChildRecords($arrParentIds, $strTable, $blnSorting=false, $arrReturn=array(), $strWhere='')
  2338.     {
  2339.         @trigger_error('Using Controller::getChildRecords() has been deprecated and will no longer work in Contao 5.0. Use Database::getChildRecords() instead.', E_USER_DEPRECATED);
  2341.         return $this->Database->getChildRecords($arrParentIds, $strTable, $blnSorting, $arrReturn, $strWhere);
  2342.     }
  2344.     /**
  2345.      * Return the IDs of all parent records of a particular record
  2346.      *
  2347.      * @param integer $intId    The ID of the record
  2348.      * @param string  $strTable The table name
  2349.      *
  2350.      * @return array An array of parent record IDs
  2351.      *
  2352.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2353.      *             Use Database::getParentRecords() instead.
  2354.      */
  2355.     protected function getParentRecords($intId, $strTable)
  2356.     {
  2357.         @trigger_error('Using Controller::getParentRecords() has been deprecated and will no longer work in Contao 5.0. Use Database::getParentRecords() instead.', E_USER_DEPRECATED);
  2359.         return $this->Database->getParentRecords($intId, $strTable);
  2360.     }
  2362.     /**
  2363.      * Print an article as PDF and stream it to the browser
  2364.      *
  2365.      * @param ModuleModel $objArticle An article object
  2366.      *
  2367.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2368.      *             Use ModuleArticle->generatePdf() instead.
  2369.      */
  2370.     protected function printArticleAsPdf($objArticle)
  2371.     {
  2372.         @trigger_error('Using Controller::printArticleAsPdf() has been deprecated and will no longer work in Contao 5.0. Use ModuleArticle->generatePdf() instead.', E_USER_DEPRECATED);
  2374.         $objArticle = new ModuleArticle($objArticle);
  2375.         $objArticle->generatePdf();
  2376.     }
  2378.     /**
  2379.      * Return all page sections as array
  2380.      *
  2381.      * @return array An array of active page sections
  2382.      *
  2383.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2384.      *             See https://github.com/contao/core/issues/4693.
  2385.      */
  2386.     public static function getPageSections()
  2387.     {
  2388.         @trigger_error('Using Controller::getPageSections() has been deprecated and will no longer work in Contao 5.0.', E_USER_DEPRECATED);
  2390.         return array('header', 'left', 'right', 'main', 'footer');
  2391.     }
  2393.     /**
  2394.      * Return a "selected" attribute if the option is selected
  2395.      *
  2396.      * @param string $strOption The option to check
  2397.      * @param mixed  $varValues One or more values to check against
  2398.      *
  2399.      * @return string The attribute or an empty string
  2400.      *
  2401.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2402.      *             Use Widget::optionSelected() instead.
  2403.      */
  2404.     public static function optionSelected($strOption, $varValues)
  2405.     {
  2406.         @trigger_error('Using Controller::optionSelected() has been deprecated and will no longer work in Contao 5.0. Use Widget::optionSelected() instead.', E_USER_DEPRECATED);
  2408.         return Widget::optionSelected($strOption, $varValues);
  2409.     }
  2411.     /**
  2412.      * Return a "checked" attribute if the option is checked
  2413.      *
  2414.      * @param string $strOption The option to check
  2415.      * @param mixed  $varValues One or more values to check against
  2416.      *
  2417.      * @return string The attribute or an empty string
  2418.      *
  2419.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2420.      *             Use Widget::optionChecked() instead.
  2421.      */
  2422.     public static function optionChecked($strOption, $varValues)
  2423.     {
  2424.         @trigger_error('Using Controller::optionChecked() has been deprecated and will no longer work in Contao 5.0. Use Widget::optionChecked() instead.', E_USER_DEPRECATED);
  2426.         return Widget::optionChecked($strOption, $varValues);
  2427.     }
  2429.     /**
  2430.      * Find a content element in the TL_CTE array and return the class name
  2431.      *
  2432.      * @param string $strName The content element name
  2433.      *
  2434.      * @return string The class name
  2435.      *
  2436.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2437.      *             Use ContentElement::findClass() instead.
  2438.      */
  2439.     public static function findContentElement($strName)
  2440.     {
  2441.         @trigger_error('Using Controller::findContentElement() has been deprecated and will no longer work in Contao 5.0. Use ContentElement::findClass() instead.', E_USER_DEPRECATED);
  2443.         return ContentElement::findClass($strName);
  2444.     }
  2446.     /**
  2447.      * Find a front end module in the FE_MOD array and return the class name
  2448.      *
  2449.      * @param string $strName The front end module name
  2450.      *
  2451.      * @return string The class name
  2452.      *
  2453.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2454.      *             Use Module::findClass() instead.
  2455.      */
  2456.     public static function findFrontendModule($strName)
  2457.     {
  2458.         @trigger_error('Using Controller::findFrontendModule() has been deprecated and will no longer work in Contao 5.0. Use Module::findClass() instead.', E_USER_DEPRECATED);
  2460.         return Module::findClass($strName);
  2461.     }
  2463.     /**
  2464.      * Create an initial version of a record
  2465.      *
  2466.      * @param string  $strTable The table name
  2467.      * @param integer $intId    The ID of the element to be versioned
  2468.      *
  2469.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2470.      *             Use Versions->initialize() instead.
  2471.      */
  2472.     protected function createInitialVersion($strTable, $intId)
  2473.     {
  2474.         @trigger_error('Using Controller::createInitialVersion() has been deprecated and will no longer work in Contao 5.0. Use Versions->initialize() instead.', E_USER_DEPRECATED);
  2476.         $objVersions = new Versions($strTable, $intId);
  2477.         $objVersions->initialize();
  2478.     }
  2480.     /**
  2481.      * Create a new version of a record
  2482.      *
  2483.      * @param string  $strTable The table name
  2484.      * @param integer $intId    The ID of the element to be versioned
  2485.      *
  2486.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2487.      *             Use Versions->create() instead.
  2488.      */
  2489.     protected function createNewVersion($strTable, $intId)
  2490.     {
  2491.         @trigger_error('Using Controller::createNewVersion() has been deprecated and will no longer work in Contao 5.0. Use Versions->create() instead.', E_USER_DEPRECATED);
  2493.         $objVersions = new Versions($strTable, $intId);
  2494.         $objVersions->create();
  2495.     }
  2497.     /**
  2498.      * Return the files matching a GLOB pattern
  2499.      *
  2500.      * @param string $pattern
  2501.      *
  2502.      * @return array|false
  2503.      */
  2504.     protected static function braceGlob($pattern)
  2505.     {
  2506.         // Use glob() if possible
  2507.         if (false === strpos($pattern, '/**/') && (\defined('GLOB_BRACE') || false === strpos($pattern, '{')))
  2508.         {
  2509.             return glob($pattern, \defined('GLOB_BRACE') ? GLOB_BRACE : 0);
  2510.         }
  2512.         $finder = new Finder();
  2513.         $regex = Glob::toRegex($pattern);
  2515.         // All files in the given template folder
  2516.         $filesIterator = $finder
  2517.             ->files()
  2518.             ->followLinks()
  2519.             ->sortByName()
  2520.             ->in(\dirname($pattern))
  2521.         ;
  2523.         // Match the actual regex and filter the files
  2524.         $filesIterator = $filesIterator->filter(static function (\SplFileInfo $info) use ($regex)
  2525.         {
  2526.             $path = $info->getPathname();
  2528.             return preg_match($regex, $path) && $info->isFile();
  2529.         });
  2531.         $files = iterator_to_array($filesIterator);
  2533.         return array_keys($files);
  2534.     }
  2535. }
  2537. class_alias(Controller::class, 'Controller');