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

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\CoreBundle\File\Metadata;
  19. use Contao\CoreBundle\Framework\ContaoFramework;
  20. use Contao\CoreBundle\Routing\Page\PageRoute;
  21. use Contao\CoreBundle\Security\ContaoCorePermissions;
  22. use Contao\CoreBundle\Twig\Inheritance\TemplateHierarchyInterface;
  23. use Contao\CoreBundle\Util\LocaleUtil;
  24. use Contao\Database\Result;
  25. use Contao\Image\PictureConfiguration;
  26. use Contao\Model\Collection;
  27. use Imagine\Image\BoxInterface;
  28. use Symfony\Cmf\Component\Routing\RouteObjectInterface;
  29. use Symfony\Component\Finder\Finder;
  30. use Symfony\Component\Finder\Glob;
  32. /**
  33.  * Abstract parent class for Controllers
  34.  *
  35.  * Some of the methods have been made static in Contao 3 and can be used in
  36.  * non-object context as well.
  37.  *
  38.  * Usage:
  39.  *
  40.  *     echo Controller::getTheme();
  41.  *
  42.  * Inside a controller:
  43.  *
  44.  *     public function generate()
  45.  *     {
  46.  *         return $this->getArticle(2);
  47.  *     }
  48.  */
  49. abstract class Controller extends System
  50. {
  51.     /**
  52.      * @var Template
  53.      *
  54.      * @todo: Add in Contao 5.0
  55.      */
  56.     //protected $Template;
  58.     /**
  59.      * @var array
  60.      */
  61.     protected static $arrQueryCache = array();
  63.     /**
  64.      * @var array
  65.      */
  66.     private static $arrOldBePathCache = array();
  68.     /**
  69.      * Find a particular template file and return its path
  70.      *
  71.      * @param string $strTemplate The name of the template
  72.      *
  73.      * @return string The path to the template file
  74.      *
  75.      * @throws \RuntimeException If the template group folder is insecure
  76.      */
  77.     public static function getTemplate($strTemplate)
  78.     {
  79.         $strTemplate = basename($strTemplate);
  80.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  82.         // Check for a theme folder
  83.         if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isFrontendRequest($request))
  84.         {
  85.             /** @var PageModel|null $objPage */
  86.             global $objPage;
  88.             if ($objPage->templateGroup ?? null)
  89.             {
  90.                 if (Validator::isInsecurePath($objPage->templateGroup))
  91.                 {
  92.                     throw new \RuntimeException('Invalid path ' . $objPage->templateGroup);
  93.                 }
  95.                 return TemplateLoader::getPath($strTemplate, 'html5', $objPage->templateGroup);
  96.             }
  97.         }
  99.         return TemplateLoader::getPath($strTemplate, 'html5');
  100.     }
  102.     /**
  103.      * Return all template files of a particular group as array
  104.      *
  105.      * @param string $strPrefix           The template name prefix (e.g. "ce_")
  106.      * @param array  $arrAdditionalMapper An additional mapper array
  107.      * @param string $strDefaultTemplate  An optional default template
  108.      *
  109.      * @return array An array of template names
  110.      */
  111.     public static function getTemplateGroup($strPrefix, array $arrAdditionalMapper=array(), $strDefaultTemplate='')
  112.     {
  113.         if (str_contains($strPrefix, '/') || str_contains($strDefaultTemplate, '/'))
  114.         {
  115.             throw new \InvalidArgumentException(sprintf('Using %s() with modern fragment templates is not supported. Use the "contao.twig.finder_factory" service instead.', __METHOD__));
  116.         }
  118.         $arrTemplates = array();
  119.         $arrBundleTemplates = array();
  121.         $arrMapper = array_merge
  122.         (
  123.             $arrAdditionalMapper,
  124.             array
  125.             (
  126.                 'ce' => array_keys(array_merge(...array_values($GLOBALS['TL_CTE']))),
  127.                 'form' => array_keys($GLOBALS['TL_FFL']),
  128.                 'mod' => array_keys(array_merge(...array_values($GLOBALS['FE_MOD']))),
  129.             )
  130.         );
  132.         // Add templates that are not directly associated with a form field
  133.         $arrMapper['form'][] = 'row';
  134.         $arrMapper['form'][] = 'row_double';
  135.         $arrMapper['form'][] = 'xml';
  136.         $arrMapper['form'][] = 'wrapper';
  137.         $arrMapper['form'][] = 'message';
  138.         $arrMapper['form'][] = 'textfield'; // TODO: remove in Contao 5.0
  140.         // Add templates that are not directly associated with a module
  141.         $arrMapper['mod'][] = 'article';
  142.         $arrMapper['mod'][] = 'message';
  143.         $arrMapper['mod'][] = 'password'; // TODO: remove in Contao 5.0
  144.         $arrMapper['mod'][] = 'comment_form'; // TODO: remove in Contao 5.0
  145.         $arrMapper['mod'][] = 'newsletter'; // TODO: remove in Contao 5.0
  147.         /** @var TemplateHierarchyInterface $templateHierarchy */
  148.         $templateHierarchy = System::getContainer()->get('contao.twig.filesystem_loader');
  149.         $identifierPattern = sprintf('/^%s%s/', preg_quote($strPrefix, '/'), substr($strPrefix, -1) !== '_' ? '($|_)' : '');
  151.         $prefixedFiles = array_merge(
  152.             array_filter(
  153.                 array_keys($templateHierarchy->getInheritanceChains()),
  154.                 static fn (string $identifier): bool => 1 === preg_match($identifierPattern, $identifier),
  155.             ),
  156.             // Merge with the templates from the TemplateLoader for backwards
  157.             // compatibility in case someone has added templates manually
  158.             TemplateLoader::getPrefixedFiles($strPrefix),
  159.         );
  161.         foreach ($prefixedFiles as $strTemplate)
  162.         {
  163.             if ($strTemplate != $strPrefix)
  164.             {
  165.                 list($k, $strKey) = explode('_', $strTemplate, 2);
  167.                 if (isset($arrMapper[$k]) && \in_array($strKey, $arrMapper[$k]))
  168.                 {
  169.                     $arrBundleTemplates[] = $strTemplate;
  170.                     continue;
  171.                 }
  172.             }
  174.             $arrTemplates[$strTemplate][] = 'root';
  175.         }
  177.         $strGlobPrefix = $strPrefix;
  179.         // Backwards compatibility (see #725)
  180.         if (substr($strGlobPrefix, -1) == '_')
  181.         {
  182.             $strGlobPrefix = substr($strGlobPrefix, 0, -1) . '[_-]';
  183.         }
  185.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  186.         $arrCustomized = self::braceGlob($projectDir . '/templates/' . $strGlobPrefix . '*.html5');
  188.         // Add the customized templates
  189.         if (!empty($arrCustomized) && \is_array($arrCustomized))
  190.         {
  191.             $blnIsGroupPrefix = preg_match('/^[a-z]+_$/', $strPrefix);
  193.             foreach ($arrCustomized as $strFile)
  194.             {
  195.                 $strTemplate = basename($strFile, strrchr($strFile, '.'));
  197.                 if (strpos($strTemplate, '-') !== false)
  198.                 {
  199.                     trigger_deprecation('contao/core-bundle', '4.9', 'Using hyphens in the template name "' . $strTemplate . '.html5" has been deprecated and will no longer work in Contao 5.0. Use snake_case instead.');
  200.                 }
  202.                 // Ignore bundle templates, e.g. mod_article and mod_article_list
  203.                 if (\in_array($strTemplate, $arrBundleTemplates))
  204.                 {
  205.                     continue;
  206.                 }
  208.                 // Also ignore custom templates belonging to a different bundle template,
  209.                 // e.g. mod_article and mod_article_list_custom
  210.                 if (!$blnIsGroupPrefix)
  211.                 {
  212.                     foreach ($arrBundleTemplates as $strKey)
  213.                     {
  214.                         if (strpos($strTemplate, $strKey . '_') === 0)
  215.                         {
  216.                             continue 2;
  217.                         }
  218.                     }
  219.                 }
  221.                 $arrTemplates[$strTemplate][] = $GLOBALS['TL_LANG']['MSC']['global'] ?? 'global';
  222.             }
  223.         }
  225.         $arrDefaultPlaces = array();
  227.         if ($strDefaultTemplate)
  228.         {
  229.             $arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['default'];
  231.             if (file_exists($projectDir . '/templates/' . $strDefaultTemplate . '.html5'))
  232.             {
  233.                 $arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['global'];
  234.             }
  235.         }
  237.         // Do not look for back end templates in theme folders (see #5379)
  238.         if ($strPrefix != 'be_' && $strPrefix != 'mail_')
  239.         {
  240.             // Try to select the themes (see #5210)
  241.             try
  242.             {
  243.                 $objTheme = ThemeModel::findAll(array('order'=>'name'));
  244.             }
  245.             catch (\Throwable $e)
  246.             {
  247.                 $objTheme = null;
  248.             }
  250.             // Add the theme templates
  251.             if ($objTheme !== null)
  252.             {
  253.                 while ($objTheme->next())
  254.                 {
  255.                     if (!$objTheme->templates)
  256.                     {
  257.                         continue;
  258.                     }
  260.                     if ($strDefaultTemplate && file_exists($projectDir . '/' . $objTheme->templates . '/' . $strDefaultTemplate . '.html5'))
  261.                     {
  262.                         $arrDefaultPlaces[] = $objTheme->name;
  263.                     }
  265.                     $arrThemeTemplates = self::braceGlob($projectDir . '/' . $objTheme->templates . '/' . $strGlobPrefix . '*.html5');
  267.                     if (!empty($arrThemeTemplates) && \is_array($arrThemeTemplates))
  268.                     {
  269.                         foreach ($arrThemeTemplates as $strFile)
  270.                         {
  271.                             $strTemplate = basename($strFile, strrchr($strFile, '.'));
  272.                             $arrTemplates[$strTemplate][] = $objTheme->name;
  273.                         }
  274.                     }
  275.                 }
  276.             }
  277.         }
  279.         // Show the template sources (see #6875)
  280.         foreach ($arrTemplates as $k=>$v)
  281.         {
  282.             $v = array_filter($v, static function ($a)
  283.             {
  284.                 return $a != 'root';
  285.             });
  287.             if (empty($v))
  288.             {
  289.                 $arrTemplates[$k] = $k;
  290.             }
  291.             else
  292.             {
  293.                 $arrTemplates[$k] = $k . ' (' . implode(', ', $v) . ')';
  294.             }
  295.         }
  297.         // Sort the template names
  298.         ksort($arrTemplates);
  300.         if ($strDefaultTemplate)
  301.         {
  302.             if (!empty($arrDefaultPlaces))
  303.             {
  304.                 $strDefaultTemplate .= ' (' . implode(', ', $arrDefaultPlaces) . ')';
  305.             }
  307.             $arrTemplates = array('' => $strDefaultTemplate) + $arrTemplates;
  308.         }
  310.         return $arrTemplates;
  311.     }
  313.     /**
  314.      * Generate a front end module and return it as string
  315.      *
  316.      * @param mixed  $intId     A module ID or a Model object
  317.      * @param string $strColumn The name of the column
  318.      *
  319.      * @return string The module HTML markup
  320.      */
  321.     public static function getFrontendModule($intId, $strColumn='main')
  322.     {
  323.         if (!\is_object($intId) && !\strlen($intId))
  324.         {
  325.             return '';
  326.         }
  328.         /** @var PageModel $objPage */
  329.         global $objPage;
  331.         // Articles
  332.         if (!\is_object($intId) && $intId == 0)
  333.         {
  334.             // Show a particular article only
  335.             if ($objPage->type == 'regular' && Input::get('articles'))
  336.             {
  337.                 list($strSection, $strArticle) = explode(':', Input::get('articles')) + array(null, null);
  339.                 if ($strArticle === null)
  340.                 {
  341.                     $strArticle = $strSection;
  342.                     $strSection = 'main';
  343.                 }
  345.                 if ($strSection == $strColumn)
  346.                 {
  347.                     $objArticle = ArticleModel::findPublishedByIdOrAliasAndPid($strArticle, $objPage->id);
  349.                     // Send a 404 header if there is no published article
  350.                     if (null === $objArticle)
  351.                     {
  352.                         throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  353.                     }
  355.                     // Send a 403 header if the article cannot be accessed
  356.                     if (!static::isVisibleElement($objArticle))
  357.                     {
  358.                         throw new AccessDeniedException('Access denied: ' . Environment::get('uri'));
  359.                     }
  361.                     return static::getArticle($objArticle);
  362.                 }
  363.             }
  365.             // HOOK: add custom logic
  366.             if (isset($GLOBALS['TL_HOOKS']['getArticles']) && \is_array($GLOBALS['TL_HOOKS']['getArticles']))
  367.             {
  368.                 foreach ($GLOBALS['TL_HOOKS']['getArticles'] as $callback)
  369.                 {
  370.                     $return = static::importStatic($callback[0])->{$callback[1]}($objPage->id, $strColumn);
  372.                     if (\is_string($return))
  373.                     {
  374.                         return $return;
  375.                     }
  376.                 }
  377.             }
  379.             // Show all articles (no else block here, see #4740)
  380.             $objArticles = ArticleModel::findPublishedByPidAndColumn($objPage->id, $strColumn);
  382.             if ($objArticles === null)
  383.             {
  384.                 return '';
  385.             }
  387.             $return = '';
  388.             $blnMultiMode = ($objArticles->count() > 1);
  390.             while ($objArticles->next())
  391.             {
  392.                 $return .= static::getArticle($objArticles->current(), $blnMultiMode, false, $strColumn);
  393.             }
  395.             return $return;
  396.         }
  398.         // Other modules
  399.         if (\is_object($intId))
  400.         {
  401.             $objRow = $intId;
  402.         }
  403.         else
  404.         {
  405.             $objRow = ModuleModel::findByPk($intId);
  407.             if ($objRow === null)
  408.             {
  409.                 return '';
  410.             }
  411.         }
  413.         // Check the visibility (see #6311)
  414.         if (!static::isVisibleElement($objRow))
  415.         {
  416.             return '';
  417.         }
  419.         $strClass = Module::findClass($objRow->type);
  421.         // Return if the class does not exist
  422.         if (!class_exists($strClass))
  423.         {
  424.             System::getContainer()->get('monolog.logger.contao.error')->error('Module class "' . $strClass . '" (module "' . $objRow->type . '") does not exist');
  426.             return '';
  427.         }
  429.         $strStopWatchId = 'contao.frontend_module.' . $objRow->type . ' (ID ' . $objRow->id . ')';
  431.         if (System::getContainer()->getParameter('kernel.debug') && System::getContainer()->has('debug.stopwatch'))
  432.         {
  433.             $objStopwatch = System::getContainer()->get('debug.stopwatch');
  434.             $objStopwatch->start($strStopWatchId, 'contao.layout');
  435.         }
  437.         $objRow->typePrefix = 'mod_';
  439.         /** @var Module $objModule */
  440.         $objModule = new $strClass($objRow, $strColumn);
  441.         $strBuffer = $objModule->generate();
  443.         // HOOK: add custom logic
  444.         if (isset($GLOBALS['TL_HOOKS']['getFrontendModule']) && \is_array($GLOBALS['TL_HOOKS']['getFrontendModule']))
  445.         {
  446.             foreach ($GLOBALS['TL_HOOKS']['getFrontendModule'] as $callback)
  447.             {
  448.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objModule);
  449.             }
  450.         }
  452.         // Disable indexing if protected
  453.         if ($objModule->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  454.         {
  455.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  456.         }
  458.         if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
  459.         {
  460.             $objStopwatch->stop($strStopWatchId);
  461.         }
  463.         return $strBuffer;
  464.     }
  466.     /**
  467.      * Generate an article and return it as string
  468.      *
  469.      * @param mixed   $varId          The article ID or a Model object
  470.      * @param boolean $blnMultiMode   If true, only teasers will be shown
  471.      * @param boolean $blnIsInsertTag If true, there will be no page relation
  472.      * @param string  $strColumn      The name of the column
  473.      *
  474.      * @return string|boolean The article HTML markup or false
  475.      */
  476.     public static function getArticle($varId, $blnMultiMode=false, $blnIsInsertTag=false, $strColumn='main')
  477.     {
  478.         /** @var PageModel $objPage */
  479.         global $objPage;
  481.         if (\is_object($varId))
  482.         {
  483.             $objRow = $varId;
  484.         }
  485.         else
  486.         {
  487.             if (!$varId)
  488.             {
  489.                 return '';
  490.             }
  492.             $objRow = ArticleModel::findByIdOrAliasAndPid($varId, (!$blnIsInsertTag ? $objPage->id : null));
  494.             if ($objRow === null)
  495.             {
  496.                 return false;
  497.             }
  498.         }
  500.         // Check the visibility (see #6311)
  501.         if (!static::isVisibleElement($objRow))
  502.         {
  503.             return '';
  504.         }
  506.         // Print the article as PDF
  507.         if (isset($_GET['pdf']) && Input::get('pdf') == $objRow->id)
  508.         {
  509.             // Deprecated since Contao 4.0, to be removed in Contao 5.0
  510.             if ($objRow->printable == 1)
  511.             {
  512.                 trigger_deprecation('contao/core-bundle', '4.0', 'Setting tl_article.printable to "1" has been deprecated and will no longer work in Contao 5.0.');
  514.                 $objArticle = new ModuleArticle($objRow);
  515.                 $objArticle->generatePdf();
  516.             }
  517.             elseif ($objRow->printable)
  518.             {
  519.                 $options = StringUtil::deserialize($objRow->printable);
  521.                 if (\is_array($options) && \in_array('pdf', $options))
  522.                 {
  523.                     $objArticle = new ModuleArticle($objRow);
  524.                     $objArticle->generatePdf();
  525.                 }
  526.             }
  527.         }
  529.         $objRow->headline = $objRow->title;
  530.         $objRow->multiMode = $blnMultiMode;
  532.         // HOOK: add custom logic
  533.         if (isset($GLOBALS['TL_HOOKS']['getArticle']) && \is_array($GLOBALS['TL_HOOKS']['getArticle']))
  534.         {
  535.             foreach ($GLOBALS['TL_HOOKS']['getArticle'] as $callback)
  536.             {
  537.                 static::importStatic($callback[0])->{$callback[1]}($objRow);
  538.             }
  539.         }
  541.         $strStopWatchId = 'contao.article (ID ' . $objRow->id . ')';
  543.         if (System::getContainer()->getParameter('kernel.debug') && System::getContainer()->has('debug.stopwatch'))
  544.         {
  545.             $objStopwatch = System::getContainer()->get('debug.stopwatch');
  546.             $objStopwatch->start($strStopWatchId, 'contao.layout');
  547.         }
  549.         $objArticle = new ModuleArticle($objRow, $strColumn);
  550.         $strBuffer = $objArticle->generate($blnIsInsertTag);
  552.         // Disable indexing if protected
  553.         if ($objArticle->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  554.         {
  555.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  556.         }
  558.         if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
  559.         {
  560.             $objStopwatch->stop($strStopWatchId);
  561.         }
  563.         return $strBuffer;
  564.     }
  566.     /**
  567.      * Generate a content element and return it as string
  568.      *
  569.      * @param mixed  $intId     A content element ID or a Model object
  570.      * @param string $strColumn The column the element is in
  571.      *
  572.      * @return string The content element HTML markup
  573.      */
  574.     public static function getContentElement($intId, $strColumn='main')
  575.     {
  576.         if (\is_object($intId))
  577.         {
  578.             $objRow = $intId;
  579.         }
  580.         else
  581.         {
  582.             if ($intId < 1 || !\strlen($intId))
  583.             {
  584.                 return '';
  585.             }
  587.             $objRow = ContentModel::findByPk($intId);
  589.             if ($objRow === null)
  590.             {
  591.                 return '';
  592.             }
  593.         }
  595.         // Check the visibility (see #6311)
  596.         if (!static::isVisibleElement($objRow))
  597.         {
  598.             return '';
  599.         }
  601.         $strClass = ContentElement::findClass($objRow->type);
  603.         // Return if the class does not exist
  604.         if (!class_exists($strClass))
  605.         {
  606.             System::getContainer()->get('monolog.logger.contao.error')->error('Content element class "' . $strClass . '" (content element "' . $objRow->type . '") does not exist');
  608.             return '';
  609.         }
  611.         $objRow->typePrefix = 'ce_';
  612.         $strStopWatchId = 'contao.content_element.' . $objRow->type . ' (ID ' . $objRow->id . ')';
  614.         if ($objRow->type != 'module' && System::getContainer()->getParameter('kernel.debug') && System::getContainer()->has('debug.stopwatch'))
  615.         {
  616.             $objStopwatch = System::getContainer()->get('debug.stopwatch');
  617.             $objStopwatch->start($strStopWatchId, 'contao.layout');
  618.         }
  620.         /** @var ContentElement $objElement */
  621.         $objElement = new $strClass($objRow, $strColumn);
  622.         $strBuffer = $objElement->generate();
  624.         // HOOK: add custom logic
  625.         if (isset($GLOBALS['TL_HOOKS']['getContentElement']) && \is_array($GLOBALS['TL_HOOKS']['getContentElement']))
  626.         {
  627.             foreach ($GLOBALS['TL_HOOKS']['getContentElement'] as $callback)
  628.             {
  629.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
  630.             }
  631.         }
  633.         // Disable indexing if protected
  634.         if ($objElement->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  635.         {
  636.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  637.         }
  639.         if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
  640.         {
  641.             $objStopwatch->stop($strStopWatchId);
  642.         }
  644.         return $strBuffer;
  645.     }
  647.     /**
  648.      * Generate a form and return it as string
  649.      *
  650.      * @param mixed   $varId     A form ID or a Model object
  651.      * @param string  $strColumn The column the form is in
  652.      * @param boolean $blnModule Render the form as module
  653.      *
  654.      * @return string The form HTML markup
  655.      */
  656.     public static function getForm($varId, $strColumn='main', $blnModule=false)
  657.     {
  658.         if (\is_object($varId))
  659.         {
  660.             $objRow = $varId;
  661.         }
  662.         else
  663.         {
  664.             if (!$varId)
  665.             {
  666.                 return '';
  667.             }
  669.             $objRow = FormModel::findByIdOrAlias($varId);
  671.             if ($objRow === null)
  672.             {
  673.                 return '';
  674.             }
  675.         }
  677.         $strClass = $blnModule ? Module::findClass('form') : ContentElement::findClass('form');
  679.         if (!class_exists($strClass))
  680.         {
  681.             System::getContainer()->get('monolog.logger.contao.error')->error('Form class "' . $strClass . '" does not exist');
  683.             return '';
  684.         }
  686.         $objRow->typePrefix = $blnModule ? 'mod_' : 'ce_';
  687.         $objRow->form = $objRow->id;
  689.         /** @var Form $objElement */
  690.         $objElement = new $strClass($objRow, $strColumn);
  691.         $strBuffer = $objElement->generate();
  693.         // HOOK: add custom logic
  694.         if (isset($GLOBALS['TL_HOOKS']['getForm']) && \is_array($GLOBALS['TL_HOOKS']['getForm']))
  695.         {
  696.             foreach ($GLOBALS['TL_HOOKS']['getForm'] as $callback)
  697.             {
  698.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
  699.             }
  700.         }
  702.         return $strBuffer;
  703.     }
  705.     /**
  706.      * Return the languages for the TinyMCE spellchecker
  707.      *
  708.      * @return string The TinyMCE spellchecker language string
  709.      *
  710.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  711.      */
  712.     protected function getSpellcheckerString()
  713.     {
  714.         trigger_deprecation('contao/core-bundle', '4.13', 'Using "%s()" has been deprecated and will no longer work in Contao 5.0.', __METHOD__);
  716.         System::loadLanguageFile('languages');
  718.         $return = array();
  719.         $langs = Folder::scan(__DIR__ . '/../../languages');
  720.         array_unshift($langs, $GLOBALS['TL_LANGUAGE']);
  722.         foreach ($langs as $lang)
  723.         {
  724.             $lang = substr($lang, 0, 2);
  726.             if (isset($GLOBALS['TL_LANG']['LNG'][$lang]))
  727.             {
  728.                 $return[$lang] = $GLOBALS['TL_LANG']['LNG'][$lang] . '=' . $lang;
  729.             }
  730.         }
  732.         return '+' . implode(',', array_unique($return));
  733.     }
  735.     /**
  736.      * Calculate the page status icon name based on the page parameters
  737.      *
  738.      * @param PageModel|Result|\stdClass $objPage The page object
  739.      *
  740.      * @return string The status icon name
  741.      */
  742.     public static function getPageStatusIcon($objPage)
  743.     {
  744.         $sub = 0;
  745.         $type = \in_array($objPage->type, array('regular', 'root', 'forward', 'redirect', 'error_401', 'error_403', 'error_404', 'error_503'), true) ? $objPage->type : 'regular';
  746.         $image = $type . '.svg';
  748.         // Page not published or not active
  749.         if (!$objPage->published || ($objPage->start && $objPage->start > time()) || ($objPage->stop && $objPage->stop <= time()))
  750.         {
  751.             ++$sub;
  752.         }
  754.         // Page hidden from menu
  755.         if ($objPage->hide && !\in_array($type, array('root', 'error_401', 'error_403', 'error_404', 'error_503')))
  756.         {
  757.             $sub += 2;
  758.         }
  760.         // Page protected
  761.         if ($objPage->protected && !\in_array($type, array('root', 'error_401', 'error_403', 'error_404', 'error_503')))
  762.         {
  763.             $sub += 4;
  764.         }
  766.         // Change icon if root page is published and in maintenance mode
  767.         if ($sub == 0 && $objPage->type == 'root' && $objPage->maintenanceMode)
  768.         {
  769.             $sub = 2;
  770.         }
  772.         // Get the image name
  773.         if ($sub > 0)
  774.         {
  775.             $image = $type . '_' . $sub . '.svg';
  776.         }
  778.         // HOOK: add custom logic
  779.         if (isset($GLOBALS['TL_HOOKS']['getPageStatusIcon']) && \is_array($GLOBALS['TL_HOOKS']['getPageStatusIcon']))
  780.         {
  781.             foreach ($GLOBALS['TL_HOOKS']['getPageStatusIcon'] as $callback)
  782.             {
  783.                 $image = static::importStatic($callback[0])->{$callback[1]}($objPage, $image);
  784.             }
  785.         }
  787.         return $image;
  788.     }
  790.     /**
  791.      * Check whether an element is visible in the front end
  792.      *
  793.      * @param Model|ContentModel|ModuleModel $objElement The element model
  794.      *
  795.      * @return boolean True if the element is visible
  796.      */
  797.     public static function isVisibleElement(Model $objElement)
  798.     {
  799.         $blnReturn = true;
  801.         // Only apply the restrictions in the front end
  802.         if (TL_MODE == 'FE')
  803.         {
  804.             $security = System::getContainer()->get('security.helper');
  806.             if ($objElement->protected)
  807.             {
  808.                 $groups = StringUtil::deserialize($objElement->groups, true);
  809.                 $blnReturn = $security->isGranted(ContaoCorePermissions::MEMBER_IN_GROUPS, $groups);
  810.             }
  811.             elseif ($objElement->guests)
  812.             {
  813.                 trigger_deprecation('contao/core-bundle', '4.12', 'Using the "show to guests only" feature has been deprecated an will no longer work in Contao 5.0. Use the "protect page" function instead.');
  814.                 $blnReturn = !$security->isGranted('ROLE_MEMBER'); // backwards compatibility
  815.             }
  816.         }
  818.         // HOOK: add custom logic
  819.         if (isset($GLOBALS['TL_HOOKS']['isVisibleElement']) && \is_array($GLOBALS['TL_HOOKS']['isVisibleElement']))
  820.         {
  821.             foreach ($GLOBALS['TL_HOOKS']['isVisibleElement'] as $callback)
  822.             {
  823.                 $blnReturn = static::importStatic($callback[0])->{$callback[1]}($objElement, $blnReturn);
  824.             }
  825.         }
  827.         return $blnReturn;
  828.     }
  830.     /**
  831.      * Replace insert tags with their values
  832.      *
  833.      * @param string  $strBuffer The text with the tags to be replaced
  834.      * @param boolean $blnCache  If false, non-cacheable tags will be replaced
  835.      *
  836.      * @return string The text with the replaced tags
  837.      *
  838.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  839.      *             Use the InsertTagParser service instead.
  840.      */
  841.     public static function replaceInsertTags($strBuffer, $blnCache=true)
  842.     {
  843.         trigger_deprecation('contao/core-bundle', '4.13', 'Using "%s()" has been deprecated and will no longer work in Contao 5.0. Use the InsertTagParser service instead.', __METHOD__);
  845.         $parser = System::getContainer()->get('contao.insert_tag.parser');
  847.         if ($blnCache)
  848.         {
  849.             return $parser->replace((string) $strBuffer);
  850.         }
  852.         return $parser->replaceInline((string) $strBuffer);
  853.     }
  855.     /**
  856.      * Replace the dynamic script tags (see #4203)
  857.      *
  858.      * @param string $strBuffer The string with the tags to be replaced
  859.      *
  860.      * @return string The string with the replaced tags
  861.      */
  862.     public static function replaceDynamicScriptTags($strBuffer)
  863.     {
  864.         // HOOK: add custom logic
  865.         if (isset($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']) && \is_array($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']))
  866.         {
  867.             foreach ($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags'] as $callback)
  868.             {
  869.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($strBuffer);
  870.             }
  871.         }
  873.         $arrReplace = array();
  874.         $strScripts = '';
  876.         // Add the internal jQuery scripts
  877.         if (!empty($GLOBALS['TL_JQUERY']) && \is_array($GLOBALS['TL_JQUERY']))
  878.         {
  879.             $strScripts .= implode('', array_unique($GLOBALS['TL_JQUERY']));
  880.         }
  882.         $nonce = ContaoFramework::getNonce();
  884.         $arrReplace["[[TL_JQUERY_$nonce]]"] = $strScripts;
  885.         $strScripts = '';
  887.         // Add the internal MooTools scripts
  888.         if (!empty($GLOBALS['TL_MOOTOOLS']) && \is_array($GLOBALS['TL_MOOTOOLS']))
  889.         {
  890.             $strScripts .= implode('', array_unique($GLOBALS['TL_MOOTOOLS']));
  891.         }
  893.         $arrReplace["[[TL_MOOTOOLS_$nonce]]"] = $strScripts;
  894.         $strScripts = '';
  896.         // Add the internal <body> tags
  897.         if (!empty($GLOBALS['TL_BODY']) && \is_array($GLOBALS['TL_BODY']))
  898.         {
  899.             $strScripts .= implode('', array_unique($GLOBALS['TL_BODY']));
  900.         }
  902.         /** @var PageModel|null $objPage */
  903.         global $objPage;
  905.         $objLayout = ($objPage !== null) ? LayoutModel::findByPk($objPage->layoutId) : null;
  906.         $blnCombineScripts = $objLayout !== null && $objLayout->combineScripts;
  908.         $arrReplace["[[TL_BODY_$nonce]]"] = $strScripts;
  909.         $strScripts = '';
  911.         $objCombiner = new Combiner();
  913.         // Add the CSS framework style sheets
  914.         if (!empty($GLOBALS['TL_FRAMEWORK_CSS']) && \is_array($GLOBALS['TL_FRAMEWORK_CSS']))
  915.         {
  916.             foreach (array_unique($GLOBALS['TL_FRAMEWORK_CSS']) as $stylesheet)
  917.             {
  918.                 $objCombiner->add($stylesheet);
  919.             }
  920.         }
  922.         // Add the internal style sheets
  923.         if (!empty($GLOBALS['TL_CSS']) && \is_array($GLOBALS['TL_CSS']))
  924.         {
  925.             foreach (array_unique($GLOBALS['TL_CSS']) as $stylesheet)
  926.             {
  927.                 $options = StringUtil::resolveFlaggedUrl($stylesheet);
  929.                 if ($options->static)
  930.                 {
  931.                     $objCombiner->add($stylesheet, $options->mtime, $options->media);
  932.                 }
  933.                 else
  934.                 {
  935.                     $strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
  936.                 }
  937.             }
  938.         }
  940.         // Add the user style sheets
  941.         if (!empty($GLOBALS['TL_USER_CSS']) && \is_array($GLOBALS['TL_USER_CSS']))
  942.         {
  943.             foreach (array_unique($GLOBALS['TL_USER_CSS']) as $stylesheet)
  944.             {
  945.                 $options = StringUtil::resolveFlaggedUrl($stylesheet);
  947.                 if ($options->static)
  948.                 {
  949.                     $objCombiner->add($stylesheet, $options->mtime, $options->media);
  950.                 }
  951.                 else
  952.                 {
  953.                     $strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
  954.                 }
  955.             }
  956.         }
  958.         // Create the aggregated style sheet
  959.         if ($objCombiner->hasEntries())
  960.         {
  961.             if ($blnCombineScripts)
  962.             {
  963.                 $strScripts .= Template::generateStyleTag($objCombiner->getCombinedFile(), 'all');
  964.             }
  965.             else
  966.             {
  967.                 foreach ($objCombiner->getFileUrls() as $strUrl)
  968.                 {
  969.                     $options = StringUtil::resolveFlaggedUrl($strUrl);
  970.                     $strScripts .= Template::generateStyleTag($strUrl, $options->media, $options->mtime);
  971.                 }
  972.             }
  973.         }
  975.         $arrReplace["[[TL_CSS_$nonce]]"] = $strScripts;
  976.         $strScripts = '';
  978.         // Add the internal scripts
  979.         if (!empty($GLOBALS['TL_JAVASCRIPT']) && \is_array($GLOBALS['TL_JAVASCRIPT']))
  980.         {
  981.             $objCombiner = new Combiner();
  982.             $objCombinerAsync = new Combiner();
  984.             foreach (array_unique($GLOBALS['TL_JAVASCRIPT']) as $javascript)
  985.             {
  986.                 $options = StringUtil::resolveFlaggedUrl($javascript);
  988.                 if ($options->static)
  989.                 {
  990.                     $options->async ? $objCombinerAsync->add($javascript, $options->mtime) : $objCombiner->add($javascript, $options->mtime);
  991.                 }
  992.                 else
  993.                 {
  994.                     $strScripts .= Template::generateScriptTag(static::addAssetsUrlTo($javascript), $options->async, $options->mtime);
  995.                 }
  996.             }
  998.             // Create the aggregated script and add it before the non-static scripts (see #4890)
  999.             if ($objCombiner->hasEntries())
  1000.             {
  1001.                 if ($blnCombineScripts)
  1002.                 {
  1003.                     $strScripts = Template::generateScriptTag($objCombiner->getCombinedFile()) . $strScripts;
  1004.                 }
  1005.                 else
  1006.                 {
  1007.                     $arrReversed = array_reverse($objCombiner->getFileUrls());
  1009.                     foreach ($arrReversed as $strUrl)
  1010.                     {
  1011.                         $options = StringUtil::resolveFlaggedUrl($strUrl);
  1012.                         $strScripts = Template::generateScriptTag($strUrl, false, $options->mtime) . $strScripts;
  1013.                     }
  1014.                 }
  1015.             }
  1017.             if ($objCombinerAsync->hasEntries())
  1018.             {
  1019.                 if ($blnCombineScripts)
  1020.                 {
  1021.                     $strScripts = Template::generateScriptTag($objCombinerAsync->getCombinedFile(), true) . $strScripts;
  1022.                 }
  1023.                 else
  1024.                 {
  1025.                     $arrReversed = array_reverse($objCombinerAsync->getFileUrls());
  1027.                     foreach ($arrReversed as $strUrl)
  1028.                     {
  1029.                         $options = StringUtil::resolveFlaggedUrl($strUrl);
  1030.                         $strScripts = Template::generateScriptTag($strUrl, true, $options->mtime) . $strScripts;
  1031.                     }
  1032.                 }
  1033.             }
  1034.         }
  1036.         // Add the internal <head> tags
  1037.         if (!empty($GLOBALS['TL_HEAD']) && \is_array($GLOBALS['TL_HEAD']))
  1038.         {
  1039.             foreach (array_unique($GLOBALS['TL_HEAD']) as $head)
  1040.             {
  1041.                 $strScripts .= $head;
  1042.             }
  1043.         }
  1045.         $arrReplace["[[TL_HEAD_$nonce]]"] = $strScripts;
  1047.         return str_replace(array_keys($arrReplace), $arrReplace, $strBuffer);
  1048.     }
  1050.     /**
  1051.      * Compile the margin format definition based on an array of values
  1052.      *
  1053.      * @param array  $arrValues An array of four values and a unit
  1054.      * @param string $strType   Either "margin" or "padding"
  1055.      *
  1056.      * @return string The CSS markup
  1057.      *
  1058.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  1059.      */
  1060.     public static function generateMargin($arrValues, $strType='margin')
  1061.     {
  1062.         trigger_deprecation('contao/core-bundle', '4.13', 'Using Contao\Controller::generateMargin is deprecated since Contao 4.13 and will be removed in Contao 5.');
  1064.         // Initialize an empty array (see #5217)
  1065.         if (!\is_array($arrValues))
  1066.         {
  1067.             $arrValues = array('top'=>'', 'right'=>'', 'bottom'=>'', 'left'=>'', 'unit'=>'');
  1068.         }
  1070.         $top = $arrValues['top'];
  1071.         $right = $arrValues['right'];
  1072.         $bottom = $arrValues['bottom'];
  1073.         $left = $arrValues['left'];
  1075.         // Try to shorten the definition
  1076.         if ($top && $right && $bottom && $left)
  1077.         {
  1078.             if ($top == $right && $top == $bottom && $top == $left)
  1079.             {
  1080.                 return $strType . ':' . $top . $arrValues['unit'] . ';';
  1081.             }
  1083.             if ($top == $bottom && $right == $left)
  1084.             {
  1085.                 return $strType . ':' . $top . $arrValues['unit'] . ' ' . $left . $arrValues['unit'] . ';';
  1086.             }
  1088.             if ($top != $bottom && $right == $left)
  1089.             {
  1090.                 return $strType . ':' . $top . $arrValues['unit'] . ' ' . $right . $arrValues['unit'] . ' ' . $bottom . $arrValues['unit'] . ';';
  1091.             }
  1093.             return $strType . ':' . $top . $arrValues['unit'] . ' ' . $right . $arrValues['unit'] . ' ' . $bottom . $arrValues['unit'] . ' ' . $left . $arrValues['unit'] . ';';
  1094.         }
  1096.         $return = array();
  1097.         $arrDir = compact('top', 'right', 'bottom', 'left');
  1099.         foreach ($arrDir as $k=>$v)
  1100.         {
  1101.             if ($v)
  1102.             {
  1103.                 $return[] = $strType . '-' . $k . ':' . $v . $arrValues['unit'] . ';';
  1104.             }
  1105.         }
  1107.         return implode('', $return);
  1108.     }
  1110.     /**
  1111.      * Add a request string to the current URL
  1112.      *
  1113.      * @param string  $strRequest The string to be added
  1114.      * @param boolean $blnAddRef  Add the referer ID
  1115.      * @param array   $arrUnset   An optional array of keys to unset
  1116.      *
  1117.      * @return string The new URL
  1118.      */
  1119.     public static function addToUrl($strRequest, $blnAddRef=true, $arrUnset=array())
  1120.     {
  1121.         $pairs = array();
  1122.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  1124.         if ($request->server->has('QUERY_STRING'))
  1125.         {
  1126.             $cacheKey = md5($request->server->get('QUERY_STRING'));
  1128.             if (!isset(static::$arrQueryCache[$cacheKey]))
  1129.             {
  1130.                 parse_str($request->server->get('QUERY_STRING'), $pairs);
  1131.                 ksort($pairs);
  1133.                 static::$arrQueryCache[$cacheKey] = $pairs;
  1134.             }
  1136.             $pairs = static::$arrQueryCache[$cacheKey];
  1137.         }
  1139.         // Remove the request token and referer ID
  1140.         unset($pairs['rt'], $pairs['ref'], $pairs['revise']);
  1142.         foreach ($arrUnset as $key)
  1143.         {
  1144.             unset($pairs[$key]);
  1145.         }
  1147.         // Merge the request string to be added
  1148.         if ($strRequest)
  1149.         {
  1150.             parse_str(str_replace('&amp;', '&', $strRequest), $newPairs);
  1151.             $pairs = array_merge($pairs, $newPairs);
  1152.         }
  1154.         // Add the referer ID
  1155.         if ($request->query->has('ref') || ($strRequest && $blnAddRef))
  1156.         {
  1157.             $pairs['ref'] = $request->attributes->get('_contao_referer_id');
  1158.         }
  1160.         $uri = '';
  1162.         if (!empty($pairs))
  1163.         {
  1164.             $uri = '?' . http_build_query($pairs, '', '&amp;', PHP_QUERY_RFC3986);
  1165.         }
  1167.         return TL_SCRIPT . $uri;
  1168.     }
  1170.     /**
  1171.      * Reload the current page
  1172.      */
  1173.     public static function reload()
  1174.     {
  1175.         static::redirect(Environment::get('uri'));
  1176.     }
  1178.     /**
  1179.      * Redirect to another page
  1180.      *
  1181.      * @param string  $strLocation The target URL
  1182.      * @param integer $intStatus   The HTTP status code (defaults to 303)
  1183.      */
  1184.     public static function redirect($strLocation, $intStatus=303)
  1185.     {
  1186.         $strLocation = str_replace('&amp;', '&', $strLocation);
  1187.         $strLocation = static::replaceOldBePaths($strLocation);
  1189.         // Make the location an absolute URL
  1190.         if (!preg_match('@^https?://@i', $strLocation))
  1191.         {
  1192.             $strLocation = Environment::get('base') . ltrim($strLocation, '/');
  1193.         }
  1195.         // Ajax request
  1196.         if (Environment::get('isAjaxRequest'))
  1197.         {
  1198.             throw new AjaxRedirectResponseException($strLocation);
  1199.         }
  1201.         throw new RedirectResponseException($strLocation, $intStatus);
  1202.     }
  1204.     /**
  1205.      * Replace the old back end paths
  1206.      *
  1207.      * @param string $strContext The context
  1208.      *
  1209.      * @return string The modified context
  1210.      */
  1211.     protected static function replaceOldBePaths($strContext)
  1212.     {
  1213.         $arrCache = &self::$arrOldBePathCache;
  1215.         $arrMapper = array
  1216.         (
  1217.             'contao/confirm.php'   => 'contao_backend_confirm',
  1218.             'contao/file.php'      => 'contao_backend_file',
  1219.             'contao/help.php'      => 'contao_backend_help',
  1220.             'contao/index.php'     => 'contao_backend_login',
  1221.             'contao/main.php'      => 'contao_backend',
  1222.             'contao/page.php'      => 'contao_backend_page',
  1223.             'contao/password.php'  => 'contao_backend_password',
  1224.             'contao/popup.php'     => 'contao_backend_popup',
  1225.             'contao/preview.php'   => 'contao_backend_preview',
  1226.         );
  1228.         $replace = static function ($matches) use ($arrMapper, &$arrCache)
  1229.         {
  1230.             $key = $matches[0];
  1232.             if (!isset($arrCache[$key]))
  1233.             {
  1234.                 trigger_deprecation('contao/core-bundle', '4.0', 'Using old backend paths has been deprecated in Contao 4.0 and will be removed in Contao 5. Use the backend routes instead.');
  1236.                 $router = System::getContainer()->get('router');
  1237.                 $arrCache[$key] = substr($router->generate($arrMapper[$key]), \strlen(Environment::get('path')) + 1);
  1238.             }
  1240.             return $arrCache[$key];
  1241.         };
  1243.         $regex = '(' . implode('|', array_map('preg_quote', array_keys($arrMapper))) . ')';
  1245.         return preg_replace_callback($regex, $replace, $strContext);
  1246.     }
  1248.     /**
  1249.      * Generate a front end URL
  1250.      *
  1251.      * @param array   $arrRow       An array of page parameters
  1252.      * @param string  $strParams    An optional string of URL parameters
  1253.      * @param string  $strForceLang Force a certain language
  1254.      * @param boolean $blnFixDomain Check the domain of the target page and append it if necessary
  1255.      *
  1256.      * @return string A URL that can be used in the front end
  1257.      *
  1258.      * @deprecated Deprecated since Contao 4.2, to be removed in Contao 5.0.
  1259.      *             Use PageModel::getFrontendUrl() instead.
  1260.      */
  1261.     public static function generateFrontendUrl(array $arrRow, $strParams=null, $strForceLang=null, $blnFixDomain=false)
  1262.     {
  1263.         trigger_deprecation('contao/core-bundle', '4.2', 'Using "Contao\Controller::generateFrontendUrl()" has been deprecated and will no longer work in Contao 5.0. Use PageModel::getFrontendUrl() instead.');
  1265.         $page = new PageModel();
  1266.         $page->preventSaving(false);
  1267.         $page->setRow($arrRow);
  1269.         if (!isset($arrRow['rootId']))
  1270.         {
  1271.             $page->loadDetails();
  1273.             foreach (array('domain', 'rootLanguage', 'rootUseSSL') as $key)
  1274.             {
  1275.                 if (isset($arrRow[$key]))
  1276.                 {
  1277.                     $page->$key = $arrRow[$key];
  1278.                 }
  1279.                 else
  1280.                 {
  1281.                     $arrRow[$key] = $page->$key;
  1282.                 }
  1283.             }
  1284.         }
  1286.         // Set the language
  1287.         if ($strForceLang !== null)
  1288.         {
  1289.             $strForceLang = LocaleUtil::formatAsLocale($strForceLang);
  1291.             $page->language = $strForceLang;
  1292.             $page->rootLanguage = $strForceLang;
  1294.             if (System::getContainer()->getParameter('contao.legacy_routing'))
  1295.             {
  1296.                 $page->urlPrefix = System::getContainer()->getParameter('contao.prepend_locale') ? $strForceLang : '';
  1297.             }
  1298.         }
  1300.         // Add the domain if it differs from the current one (see #3765 and #6927)
  1301.         if ($blnFixDomain)
  1302.         {
  1303.             $page->domain = $arrRow['domain'];
  1304.             $page->rootUseSSL = (bool) $arrRow['rootUseSSL'];
  1305.         }
  1307.         $objRouter = System::getContainer()->get('router');
  1308.         $strUrl = $objRouter->generate(PageRoute::PAGE_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $page, 'parameters' => $strParams));
  1310.         // Remove path from absolute URLs
  1311.         if (0 === strncmp($strUrl, '/', 1) && 0 !== strncmp($strUrl, '//', 2))
  1312.         {
  1313.             $strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
  1314.         }
  1316.         // Decode sprintf placeholders
  1317.         if (strpos($strParams, '%') !== false)
  1318.         {
  1319.             $arrMatches = array();
  1320.             preg_match_all('/%([sducoxXbgGeEfF])/', $strParams, $arrMatches);
  1322.             foreach (array_unique($arrMatches[1]) as $v)
  1323.             {
  1324.                 $strUrl = str_replace('%25' . $v, '%' . $v, $strUrl);
  1325.             }
  1326.         }
  1328.         // HOOK: add custom logic
  1329.         if (isset($GLOBALS['TL_HOOKS']['generateFrontendUrl']) && \is_array($GLOBALS['TL_HOOKS']['generateFrontendUrl']))
  1330.         {
  1331.             foreach ($GLOBALS['TL_HOOKS']['generateFrontendUrl'] as $callback)
  1332.             {
  1333.                 $strUrl = static::importStatic($callback[0])->{$callback[1]}($arrRow, $strParams, $strUrl);
  1334.             }
  1335.         }
  1337.         return $strUrl;
  1338.     }
  1340.     /**
  1341.      * Convert relative URLs in href and src attributes to absolute URLs
  1342.      *
  1343.      * @param string  $strContent  The text with the URLs to be converted
  1344.      * @param string  $strBase     An optional base URL
  1345.      * @param boolean $blnHrefOnly If true, only href attributes will be converted
  1346.      *
  1347.      * @return string The text with the replaced URLs
  1348.      */
  1349.     public static function convertRelativeUrls($strContent, $strBase='', $blnHrefOnly=false)
  1350.     {
  1351.         if (!$strBase)
  1352.         {
  1353.             $strBase = Environment::get('base');
  1354.         }
  1356.         $search = $blnHrefOnly ? 'href' : 'href|src';
  1357.         $arrUrls = preg_split('/((' . $search . ')="([^"]+)")/i', $strContent, -1, PREG_SPLIT_DELIM_CAPTURE);
  1358.         $strContent = '';
  1360.         for ($i=0, $c=\count($arrUrls); $i<$c; $i+=4)
  1361.         {
  1362.             $strContent .= $arrUrls[$i];
  1364.             if (!isset($arrUrls[$i+2]))
  1365.             {
  1366.                 continue;
  1367.             }
  1369.             $strAttribute = $arrUrls[$i+2];
  1370.             $strUrl = $arrUrls[$i+3];
  1372.             if (!preg_match('@^(?:[a-z0-9]+:|#)@i', $strUrl))
  1373.             {
  1374.                 $strUrl = $strBase . (($strUrl != '/') ? $strUrl : '');
  1375.             }
  1377.             $strContent .= $strAttribute . '="' . $strUrl . '"';
  1378.         }
  1380.         return $strContent;
  1381.     }
  1383.     /**
  1384.      * Send a file to the browser so the "save as …" dialogue opens
  1385.      *
  1386.      * @param string  $strFile The file path
  1387.      * @param boolean $inline  Show the file in the browser instead of opening the download dialog
  1388.      *
  1389.      * @throws AccessDeniedException
  1390.      */
  1391.     public static function sendFileToBrowser($strFile, $inline=false)
  1392.     {
  1393.         // Make sure there are no attempts to hack the file system
  1394.         if (preg_match('@^\.+@', $strFile) || preg_match('@\.+/@', $strFile) || preg_match('@(://)+@', $strFile))
  1395.         {
  1396.             throw new PageNotFoundException('Invalid file name');
  1397.         }
  1399.         // Limit downloads to the files directory
  1400.         if (!preg_match('@^' . preg_quote(System::getContainer()->getParameter('contao.upload_path'), '@') . '@i', $strFile))
  1401.         {
  1402.             throw new PageNotFoundException('Invalid path');
  1403.         }
  1405.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  1407.         // Check whether the file exists
  1408.         if (!file_exists($projectDir . '/' . $strFile))
  1409.         {
  1410.             throw new PageNotFoundException('File not found');
  1411.         }
  1413.         $objFile = new File($strFile);
  1414.         $arrAllowedTypes = StringUtil::trimsplit(',', strtolower(Config::get('allowedDownload')));
  1416.         // Check whether the file type is allowed to be downloaded
  1417.         if (!\in_array($objFile->extension, $arrAllowedTypes))
  1418.         {
  1419.             throw new AccessDeniedException(sprintf('File type "%s" is not allowed', $objFile->extension));
  1420.         }
  1422.         // HOOK: post download callback
  1423.         if (isset($GLOBALS['TL_HOOKS']['postDownload']) && \is_array($GLOBALS['TL_HOOKS']['postDownload']))
  1424.         {
  1425.             foreach ($GLOBALS['TL_HOOKS']['postDownload'] as $callback)
  1426.             {
  1427.                 static::importStatic($callback[0])->{$callback[1]}($strFile);
  1428.             }
  1429.         }
  1431.         // Send the file (will stop the script execution)
  1432.         $objFile->sendToBrowser('', $inline);
  1433.     }
  1435.     /**
  1436.      * Load a set of DCA files
  1437.      *
  1438.      * @param string  $strTable   The table name
  1439.      * @param boolean $blnNoCache If true, the cache will be bypassed
  1440.      */
  1441.     public static function loadDataContainer($strTable, $blnNoCache=false)
  1442.     {
  1443.         if (\func_num_args() > 1)
  1444.         {
  1445.             trigger_deprecation('contao/core-bundle', '4.13', 'Calling "%s" with the $blnNoCache parameter has been deprecated and will no longer work in Contao 5.0.', __METHOD__);
  1446.         }
  1448.         $loader = new DcaLoader($strTable);
  1449.         $loader->load(...($blnNoCache ? array(true) : array()));
  1450.     }
  1452.     /**
  1453.      * Do not name this "reset" because it might result in conflicts with child classes
  1454.      * @see https://github.com/contao/contao/issues/4257
  1455.      *
  1456.      * @internal
  1457.      */
  1458.     public static function resetControllerCache()
  1459.     {
  1460.         self::$arrQueryCache = array();
  1461.         self::$arrOldBePathCache = array();
  1462.     }
  1464.     /**
  1465.      * Redirect to a front end page
  1466.      *
  1467.      * @param integer $intPage    The page ID
  1468.      * @param string  $strArticle An optional article alias
  1469.      * @param boolean $blnReturn  If true, return the URL and don't redirect
  1470.      *
  1471.      * @return string The URL of the target page
  1472.      */
  1473.     protected function redirectToFrontendPage($intPage, $strArticle=null, $blnReturn=false)
  1474.     {
  1475.         if (($intPage = (int) $intPage) <= 0)
  1476.         {
  1477.             return '';
  1478.         }
  1480.         $objPage = PageModel::findWithDetails($intPage);
  1482.         if ($objPage === null)
  1483.         {
  1484.             return '';
  1485.         }
  1487.         $strParams = null;
  1489.         // Add the /article/ fragment (see #673)
  1490.         if ($strArticle !== null && ($objArticle = ArticleModel::findByAlias($strArticle)) !== null)
  1491.         {
  1492.             $strParams = '/articles/' . (($objArticle->inColumn != 'main') ? $objArticle->inColumn . ':' : '') . $strArticle;
  1493.         }
  1495.         $strUrl = $objPage->getPreviewUrl($strParams);
  1497.         if (!$blnReturn)
  1498.         {
  1499.             $this->redirect($strUrl);
  1500.         }
  1502.         return $strUrl;
  1503.     }
  1505.     /**
  1506.      * Get the parent records of an entry and return them as string which can
  1507.      * be used in a log message
  1508.      *
  1509.      * @param string  $strTable The table name
  1510.      * @param integer $intId    The record ID
  1511.      *
  1512.      * @return string A string that can be used in a log message
  1513.      */
  1514.     protected function getParentEntries($strTable, $intId)
  1515.     {
  1516.         // No parent table
  1517.         if (empty($GLOBALS['TL_DCA'][$strTable]['config']['ptable']))
  1518.         {
  1519.             return '';
  1520.         }
  1522.         $arrParent = array();
  1524.         do
  1525.         {
  1526.             // Get the pid
  1527.             $objParent = $this->Database->prepare("SELECT pid FROM " . $strTable . " WHERE id=?")
  1528.                                         ->limit(1)
  1529.                                         ->execute($intId);
  1531.             if ($objParent->numRows < 1)
  1532.             {
  1533.                 break;
  1534.             }
  1536.             // Store the parent table information
  1537.             $strTable = $GLOBALS['TL_DCA'][$strTable]['config']['ptable'];
  1538.             $intId = $objParent->pid;
  1540.             // Add the log entry
  1541.             $arrParent[] = $strTable . '.id=' . $intId;
  1543.             // Load the data container of the parent table
  1544.             $this->loadDataContainer($strTable);
  1545.         }
  1546.         while ($intId && !empty($GLOBALS['TL_DCA'][$strTable]['config']['ptable']));
  1548.         if (empty($arrParent))
  1549.         {
  1550.             return '';
  1551.         }
  1553.         return ' (parent records: ' . implode(', ', $arrParent) . ')';
  1554.     }
  1556.     /**
  1557.      * Take an array of file paths and eliminate the nested ones
  1558.      *
  1559.      * @param array $arrPaths The array of file paths
  1560.      *
  1561.      * @return array The file paths array without the nested paths
  1562.      */
  1563.     protected function eliminateNestedPaths($arrPaths)
  1564.     {
  1565.         $arrPaths = array_filter($arrPaths);
  1567.         if (empty($arrPaths) || !\is_array($arrPaths))
  1568.         {
  1569.             return array();
  1570.         }
  1572.         $nested = array();
  1574.         foreach ($arrPaths as $path)
  1575.         {
  1576.             $nested[] = preg_grep('/^' . preg_quote($path, '/') . '\/.+/', $arrPaths);
  1577.         }
  1579.         if (!empty($nested))
  1580.         {
  1581.             $nested = array_merge(...$nested);
  1582.         }
  1584.         return array_values(array_diff($arrPaths, $nested));
  1585.     }
  1587.     /**
  1588.      * Take an array of pages and eliminate the nested ones
  1589.      *
  1590.      * @param array   $arrPages   The array of page IDs
  1591.      * @param string  $strTable   The table name
  1592.      * @param boolean $blnSorting True if the table has a sorting field
  1593.      *
  1594.      * @return array The page IDs array without the nested IDs
  1595.      */
  1596.     protected function eliminateNestedPages($arrPages, $strTable=null, $blnSorting=false)
  1597.     {
  1598.         if (empty($arrPages) || !\is_array($arrPages))
  1599.         {
  1600.             return array();
  1601.         }
  1603.         if (!$strTable)
  1604.         {
  1605.             $strTable = 'tl_page';
  1606.         }
  1608.         // Thanks to Andreas Schempp (see #2475 and #3423)
  1609.         $arrPages = array_filter(array_map('intval', $arrPages));
  1610.         $arrPages = array_values(array_diff($arrPages, $this->Database->getChildRecords($arrPages, $strTable, $blnSorting)));
  1612.         return $arrPages;
  1613.     }
  1615.     /**
  1616.      * Add an image to a template
  1617.      *
  1618.      * @param object          $template                The template object to add the image to
  1619.      * @param array           $rowData                 The element or module as array
  1620.      * @param integer|null    $maxWidth                An optional maximum width of the image
  1621.      * @param string|null     $lightboxGroupIdentifier An optional lightbox group identifier
  1622.      * @param FilesModel|null $filesModel              An optional files model
  1623.      *
  1624.      * @deprecated Deprecated since Contao 4.11, to be removed in Contao 5.0;
  1625.      *             use the Contao\CoreBundle\Image\Studio\FigureBuilder instead.
  1626.      */
  1627.     public static function addImageToTemplate($template, array $rowData, $maxWidth = null, $lightboxGroupIdentifier = null, FilesModel $filesModel = null): void
  1628.     {
  1629.         trigger_deprecation('contao/core-bundle', '4.11', 'Using Controller::addImageToTemplate() is deprecated and will no longer work in Contao 5.0. Use the "Contao\CoreBundle\Image\Studio\FigureBuilder" class instead.');
  1631.         // Helper: Create metadata from the specified row data
  1632.         $createMetadataOverwriteFromRowData = static function (bool $interpretAsContentModel) use ($rowData)
  1633.         {
  1634.             if ($interpretAsContentModel)
  1635.             {
  1636.                 // This will be null if "overwriteMeta" is not set
  1637.                 return (new ContentModel())->setRow($rowData)->getOverwriteMetadata();
  1638.             }
  1640.             // Manually create metadata that always contains certain properties (BC)
  1641.             return new Metadata(array(
  1642.                 Metadata::VALUE_ALT => $rowData['alt'] ?? '',
  1643.                 Metadata::VALUE_TITLE => $rowData['imageTitle'] ?? '',
  1644.                 Metadata::VALUE_URL => System::getContainer()->get('contao.insert_tag.parser')->replaceInline($rowData['imageUrl'] ?? ''),
  1645.                 'linkTitle' => (string) ($rowData['linkTitle'] ?? ''),
  1646.             ));
  1647.         };
  1649.         // Helper: Create fallback template data with (mostly) empty fields (used if resource acquisition fails)
  1650.         $createFallBackTemplateData = static function () use ($filesModel, $rowData)
  1651.         {
  1652.             $templateData = array(
  1653.                 'width' => null,
  1654.                 'height' => null,
  1655.                 'picture' => array(
  1656.                     'img' => array(
  1657.                         'src' => '',
  1658.                         'srcset' => '',
  1659.                     ),
  1660.                     'sources' => array(),
  1661.                     'alt' => '',
  1662.                     'title' => '',
  1663.                 ),
  1664.                 'singleSRC' => $rowData['singleSRC'],
  1665.                 'src' => '',
  1666.                 'linkTitle' => '',
  1667.                 'margin' => '',
  1668.                 'addImage' => true,
  1669.                 'addBefore' => true,
  1670.                 'fullsize' => false,
  1671.             );
  1673.             if (null !== $filesModel)
  1674.             {
  1675.                 // Set empty metadata
  1676.                 $templateData = array_replace_recursive(
  1677.                     $templateData,
  1678.                     array(
  1679.                         'alt' => '',
  1680.                         'caption' => '',
  1681.                         'imageTitle' => '',
  1682.                         'imageUrl' => '',
  1683.                     )
  1684.                 );
  1685.             }
  1687.             return $templateData;
  1688.         };
  1690.         // Helper: Get size and margins and handle legacy $maxWidth option
  1691.         $getSizeAndMargin = static function () use ($rowData, $maxWidth)
  1692.         {
  1693.             $size = $rowData['size'] ?? null;
  1694.             $margin = StringUtil::deserialize($rowData['imagemargin'] ?? null);
  1695.             $maxWidth = (int) ($maxWidth ?? Config::get('maxImageWidth'));
  1697.             if (0 === $maxWidth)
  1698.             {
  1699.                 return array($size, $margin);
  1700.             }
  1702.             trigger_deprecation('contao/core-bundle', '4.10', '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.');
  1704.             // Adjust margins if needed
  1705.             if ('px' === ($margin['unit'] ?? null))
  1706.             {
  1707.                 $horizontalMargin = (int) ($margin['left'] ?? 0) + (int) ($margin['right'] ?? 0);
  1709.                 if ($maxWidth - $horizontalMargin < 1)
  1710.                 {
  1711.                     $margin['left'] = '';
  1712.                     $margin['right'] = '';
  1713.                 }
  1714.                 else
  1715.                 {
  1716.                     $maxWidth -= $horizontalMargin;
  1717.                 }
  1718.             }
  1720.             // Normalize size
  1721.             if ($size instanceof PictureConfiguration)
  1722.             {
  1723.                 return array($size, $margin);
  1724.             }
  1726.             $size = StringUtil::deserialize($size);
  1728.             if (is_numeric($size))
  1729.             {
  1730.                 $size = array(0, 0, (int) $size);
  1731.             }
  1732.             else
  1733.             {
  1734.                 $size = (\is_array($size) ? $size : array()) + array(0, 0, 'crop');
  1735.                 $size[0] = (int) $size[0];
  1736.                 $size[1] = (int) $size[1];
  1737.             }
  1739.             // Adjust image size configuration if it exceeds the max width
  1740.             if ($size[0] > 0 && $size[1] > 0)
  1741.             {
  1742.                 list($width, $height) = $size;
  1743.             }
  1744.             else
  1745.             {
  1746.                 $container = System::getContainer();
  1748.                 /** @var BoxInterface $originalSize */
  1749.                 $originalSize = $container
  1750.                     ->get('contao.image.factory')
  1751.                     ->create($container->getParameter('kernel.project_dir') . '/' . $rowData['singleSRC'])
  1752.                     ->getDimensions()
  1753.                     ->getSize();
  1755.                 $width = $originalSize->getWidth();
  1756.                 $height = $originalSize->getHeight();
  1757.             }
  1759.             if ($width <= $maxWidth)
  1760.             {
  1761.                 return array($size, $margin);
  1762.             }
  1764.             $size[0] = $maxWidth;
  1765.             $size[1] = (int) floor($maxWidth * ($height / $width));
  1767.             return array($size, $margin);
  1768.         };
  1770.         $figureBuilder = System::getContainer()->get('contao.image.studio')->createFigureBuilder();
  1772.         // Set image resource
  1773.         if (null !== $filesModel)
  1774.         {
  1775.             // Make sure model points to the same resource (BC)
  1776.             $filesModel = clone $filesModel;
  1777.             $filesModel->path = $rowData['singleSRC'];
  1779.             // Use source + metadata from files model (if not overwritten)
  1780.             $figureBuilder
  1781.                 ->fromFilesModel($filesModel)
  1782.                 ->setMetadata($createMetadataOverwriteFromRowData(true));
  1784.             $includeFullMetadata = true;
  1785.         }
  1786.         else
  1787.         {
  1788.             // Always ignore file metadata when building from path (BC)
  1789.             $figureBuilder
  1790.                 ->fromPath($rowData['singleSRC'], false)
  1791.                 ->setMetadata($createMetadataOverwriteFromRowData(false));
  1793.             $includeFullMetadata = false;
  1794.         }
  1796.         // Set size and lightbox configuration
  1797.         list($size, $margin) = $getSizeAndMargin();
  1799.         $lightboxSize = StringUtil::deserialize($rowData['lightboxSize'] ?? null) ?: null;
  1801.         $figure = $figureBuilder
  1802.             ->setSize($size)
  1803.             ->setLightboxGroupIdentifier($lightboxGroupIdentifier)
  1804.             ->setLightboxSize($lightboxSize)
  1805.             ->enableLightbox((bool) ($rowData['fullsize'] ?? false))
  1806.             ->buildIfResourceExists();
  1808.         if (null === $figure)
  1809.         {
  1810.             System::getContainer()->get('monolog.logger.contao.error')->error('Image "' . $rowData['singleSRC'] . '" could not be processed: ' . $figureBuilder->getLastException()->getMessage());
  1812.             // Fall back to apply a sparse data set instead of failing (BC)
  1813.             foreach ($createFallBackTemplateData() as $key => $value)
  1814.             {
  1815.                 $template->$key = $value;
  1816.             }
  1818.             return;
  1819.         }
  1821.         // Build result and apply it to the template
  1822.         $figure->applyLegacyTemplateData($template, $margin, $rowData['floating'] ?? null, $includeFullMetadata);
  1824.         // Fall back to manually specified link title or empty string if not set (backwards compatibility)
  1825.         $template->linkTitle ??= StringUtil::specialchars($rowData['title'] ?? '');
  1826.     }
  1828.     /**
  1829.      * Add enclosures to a template
  1830.      *
  1831.      * @param object $objTemplate The template object to add the enclosures to
  1832.      * @param array  $arrItem     The element or module as array
  1833.      * @param string $strKey      The name of the enclosures field in $arrItem
  1834.      */
  1835.     public static function addEnclosuresToTemplate($objTemplate, $arrItem, $strKey='enclosure')
  1836.     {
  1837.         $arrEnclosures = StringUtil::deserialize($arrItem[$strKey]);
  1839.         if (empty($arrEnclosures) || !\is_array($arrEnclosures))
  1840.         {
  1841.             return;
  1842.         }
  1844.         $objFiles = FilesModel::findMultipleByUuids($arrEnclosures);
  1846.         if ($objFiles === null)
  1847.         {
  1848.             return;
  1849.         }
  1851.         $file = Input::get('file', true);
  1853.         // Send the file to the browser and do not send a 404 header (see #5178)
  1854.         if ($file)
  1855.         {
  1856.             while ($objFiles->next())
  1857.             {
  1858.                 if ($file == $objFiles->path)
  1859.                 {
  1860.                     static::sendFileToBrowser($file);
  1861.                 }
  1862.             }
  1864.             $objFiles->reset();
  1865.         }
  1867.         /** @var PageModel $objPage */
  1868.         global $objPage;
  1870.         $arrEnclosures = array();
  1871.         $allowedDownload = StringUtil::trimsplit(',', strtolower(Config::get('allowedDownload')));
  1872.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  1874.         // Add download links
  1875.         while ($objFiles->next())
  1876.         {
  1877.             if ($objFiles->type == 'file')
  1878.             {
  1879.                 if (!\in_array($objFiles->extension, $allowedDownload) || !is_file($projectDir . '/' . $objFiles->path))
  1880.                 {
  1881.                     continue;
  1882.                 }
  1884.                 $objFile = new File($objFiles->path);
  1885.                 $strHref = Environment::get('request');
  1887.                 // Remove an existing file parameter (see #5683)
  1888.                 if (preg_match('/(&(amp;)?|\?)file=/', $strHref))
  1889.                 {
  1890.                     $strHref = preg_replace('/(&(amp;)?|\?)file=[^&]+/', '', $strHref);
  1891.                 }
  1893.                 $strHref .= ((strpos($strHref, '?') !== false) ? '&amp;' : '?') . 'file=' . System::urlEncode($objFiles->path);
  1895.                 $arrMeta = Frontend::getMetaData($objFiles->meta, $objPage->language);
  1897.                 if (empty($arrMeta) && $objPage->rootFallbackLanguage !== null)
  1898.                 {
  1899.                     $arrMeta = Frontend::getMetaData($objFiles->meta, $objPage->rootFallbackLanguage);
  1900.                 }
  1902.                 // Use the file name as title if none is given
  1903.                 if (empty($arrMeta['title']))
  1904.                 {
  1905.                     $arrMeta['title'] = StringUtil::specialchars($objFile->basename);
  1906.                 }
  1908.                 $arrEnclosures[] = array
  1909.                 (
  1910.                     'id'        => $objFiles->id,
  1911.                     'uuid'      => $objFiles->uuid,
  1912.                     'name'      => $objFile->basename,
  1913.                     'title'     => StringUtil::specialchars(sprintf($GLOBALS['TL_LANG']['MSC']['download'], $objFile->basename)),
  1914.                     'link'      => $arrMeta['title'],
  1915.                     'caption'   => $arrMeta['caption'] ?? null,
  1916.                     'href'      => $strHref,
  1917.                     'filesize'  => static::getReadableSize($objFile->filesize),
  1918.                     'icon'      => Image::getPath($objFile->icon),
  1919.                     'mime'      => $objFile->mime,
  1920.                     'meta'      => $arrMeta,
  1921.                     'extension' => $objFile->extension,
  1922.                     'path'      => $objFile->dirname,
  1923.                     'enclosure' => $objFiles->path // backwards compatibility
  1924.                 );
  1925.             }
  1926.         }
  1928.         // Order the enclosures
  1929.         if (!empty($arrItem['orderEnclosure']))
  1930.         {
  1931.             trigger_deprecation('contao/core-bundle', '4.10', 'Using "orderEnclosure" has been deprecated and will no longer work in Contao 5.0. Use a file tree with "isSortable" instead.');
  1933.             $arrEnclosures = ArrayUtil::sortByOrderField($arrEnclosures, $arrItem['orderEnclosure']);
  1934.         }
  1936.         $objTemplate->enclosure = $arrEnclosures;
  1937.     }
  1939.     /**
  1940.      * Set the static URL constants
  1941.      *
  1942.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  1943.      */
  1944.     public static function setStaticUrls()
  1945.     {
  1946.         if (\defined('TL_FILES_URL'))
  1947.         {
  1948.             return;
  1949.         }
  1951.         if (\func_num_args() > 0)
  1952.         {
  1953.             trigger_deprecation('contao/core-bundle', '4.9', 'Using "Contao\Controller::setStaticUrls()" has been deprecated and will no longer work in Contao 5.0. Use the asset contexts instead.');
  1955.             if (!isset($GLOBALS['objPage']))
  1956.             {
  1957.                 $GLOBALS['objPage'] = func_get_arg(0);
  1958.             }
  1959.         }
  1961.         \define('TL_ASSETS_URL', System::getContainer()->get('contao.assets.assets_context')->getStaticUrl());
  1962.         \define('TL_FILES_URL', System::getContainer()->get('contao.assets.files_context')->getStaticUrl());
  1964.         // Deprecated since Contao 4.0, to be removed in Contao 5.0
  1965.         \define('TL_SCRIPT_URL', TL_ASSETS_URL);
  1966.         \define('TL_PLUGINS_URL', TL_ASSETS_URL);
  1967.     }
  1969.     /**
  1970.      * Add a static URL to a script
  1971.      *
  1972.      * @param string             $script  The script path
  1973.      * @param ContaoContext|null $context
  1974.      *
  1975.      * @return string The script path with the static URL
  1976.      */
  1977.     public static function addStaticUrlTo($script, ContaoContext $context = null)
  1978.     {
  1979.         // Absolute URLs
  1980.         if (preg_match('@^https?://@', $script))
  1981.         {
  1982.             return $script;
  1983.         }
  1985.         if ($context === null)
  1986.         {
  1987.             $context = System::getContainer()->get('contao.assets.assets_context');
  1988.         }
  1990.         if ($strStaticUrl = $context->getStaticUrl())
  1991.         {
  1992.             return $strStaticUrl . $script;
  1993.         }
  1995.         return $script;
  1996.     }
  1998.     /**
  1999.      * Add the assets URL to a script
  2000.      *
  2001.      * @param string $script The script path
  2002.      *
  2003.      * @return string The script path with the assets URL
  2004.      */
  2005.     public static function addAssetsUrlTo($script)
  2006.     {
  2007.         return static::addStaticUrlTo($script, System::getContainer()->get('contao.assets.assets_context'));
  2008.     }
  2010.     /**
  2011.      * Add the files URL to a script
  2012.      *
  2013.      * @param string $script The script path
  2014.      *
  2015.      * @return string The script path with the files URL
  2016.      */
  2017.     public static function addFilesUrlTo($script)
  2018.     {
  2019.         return static::addStaticUrlTo($script, System::getContainer()->get('contao.assets.files_context'));
  2020.     }
  2022.     /**
  2023.      * Return the current theme as string
  2024.      *
  2025.      * @return string The name of the theme
  2026.      *
  2027.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2028.      *             Use Backend::getTheme() instead.
  2029.      */
  2030.     public static function getTheme()
  2031.     {
  2032.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getTheme()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Backend::getTheme()" instead.');
  2034.         return Backend::getTheme();
  2035.     }
  2037.     /**
  2038.      * Return the back end themes as array
  2039.      *
  2040.      * @return array An array of available back end themes
  2041.      *
  2042.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2043.      *             Use Backend::getThemes() instead.
  2044.      */
  2045.     public static function getBackendThemes()
  2046.     {
  2047.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getBackendThemes()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Backend::getThemes()" instead.');
  2049.         return Backend::getThemes();
  2050.     }
  2052.     /**
  2053.      * Get the details of a page including inherited parameters
  2054.      *
  2055.      * @param mixed $intId A page ID or a Model object
  2056.      *
  2057.      * @return PageModel The page model or null
  2058.      *
  2059.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2060.      *             Use PageModel::findWithDetails() or PageModel->loadDetails() instead.
  2061.      */
  2062.     public static function getPageDetails($intId)
  2063.     {
  2064.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getPageDetails()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\PageModel::findWithDetails()" or "Contao\PageModel->loadDetails()" instead.');
  2066.         if ($intId instanceof PageModel)
  2067.         {
  2068.             return $intId->loadDetails();
  2069.         }
  2071.         if ($intId instanceof Collection)
  2072.         {
  2073.             /** @var PageModel $objPage */
  2074.             $objPage = $intId->current();
  2076.             return $objPage->loadDetails();
  2077.         }
  2079.         if (\is_object($intId))
  2080.         {
  2081.             $strKey = __METHOD__ . '-' . $intId->id;
  2083.             // Try to load from cache
  2084.             if (Cache::has($strKey))
  2085.             {
  2086.                 return Cache::get($strKey);
  2087.             }
  2089.             // Create a model from the database result
  2090.             $objPage = new PageModel();
  2091.             $objPage->setRow($intId->row());
  2092.             $objPage->loadDetails();
  2094.             Cache::set($strKey, $objPage);
  2096.             return $objPage;
  2097.         }
  2099.         // Invalid ID
  2100.         if ($intId < 1 || !\strlen($intId))
  2101.         {
  2102.             return null;
  2103.         }
  2105.         $strKey = __METHOD__ . '-' . $intId;
  2107.         // Try to load from cache
  2108.         if (Cache::has($strKey))
  2109.         {
  2110.             return Cache::get($strKey);
  2111.         }
  2113.         $objPage = PageModel::findWithDetails($intId);
  2115.         Cache::set($strKey, $objPage);
  2117.         return $objPage;
  2118.     }
  2120.     /**
  2121.      * Remove old XML files from the share directory
  2122.      *
  2123.      * @param boolean $blnReturn If true, only return the finds and don't delete
  2124.      *
  2125.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2126.      *             Use Automator::purgeXmlFiles() instead.
  2127.      */
  2128.     protected function removeOldFeeds($blnReturn=false)
  2129.     {
  2130.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::removeOldFeeds()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Automator::purgeXmlFiles()" instead.');
  2132.         $this->import(Automator::class, 'Automator');
  2133.         $this->Automator->purgeXmlFiles($blnReturn);
  2134.     }
  2136.     /**
  2137.      * Return true if a class exists (tries to autoload the class)
  2138.      *
  2139.      * @param string $strClass The class name
  2140.      *
  2141.      * @return boolean True if the class exists
  2142.      *
  2143.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2144.      *             Use the PHP function class_exists() instead.
  2145.      */
  2146.     protected function classFileExists($strClass)
  2147.     {
  2148.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::classFileExists()" has been deprecated and will no longer work in Contao 5.0. Use the PHP function "class_exists()" instead.');
  2150.         return class_exists($strClass);
  2151.     }
  2153.     /**
  2154.      * Restore basic entities
  2155.      *
  2156.      * @param string $strBuffer The string with the tags to be replaced
  2157.      *
  2158.      * @return string The string with the original entities
  2159.      *
  2160.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2161.      *             Use StringUtil::restoreBasicEntities() instead.
  2162.      */
  2163.     public static function restoreBasicEntities($strBuffer)
  2164.     {
  2165.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::restoreBasicEntities()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\StringUtil::restoreBasicEntities()" instead.');
  2167.         return StringUtil::restoreBasicEntities($strBuffer);
  2168.     }
  2170.     /**
  2171.      * Resize an image and crop it if necessary
  2172.      *
  2173.      * @param string  $image  The image path
  2174.      * @param integer $width  The target width
  2175.      * @param integer $height The target height
  2176.      * @param string  $mode   An optional resize mode
  2177.      *
  2178.      * @return boolean True if the image has been resized correctly
  2179.      *
  2180.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2181.      *             Use Image::resize() instead.
  2182.      */
  2183.     protected function resizeImage($image, $width, $height, $mode='')
  2184.     {
  2185.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::resizeImage()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Image::resize()" instead.');
  2187.         return Image::resize($image, $width, $height, $mode);
  2188.     }
  2190.     /**
  2191.      * Resize an image and crop it if necessary
  2192.      *
  2193.      * @param string  $image  The image path
  2194.      * @param integer $width  The target width
  2195.      * @param integer $height The target height
  2196.      * @param string  $mode   An optional resize mode
  2197.      * @param string  $target An optional target to be replaced
  2198.      * @param boolean $force  Override existing target images
  2199.      *
  2200.      * @return string|null The image path or null
  2201.      *
  2202.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2203.      *             Use Image::get() instead.
  2204.      */
  2205.     protected function getImage($image, $width, $height, $mode='', $target=null, $force=false)
  2206.     {
  2207.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getImage()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Image::get()" instead.');
  2209.         return Image::get($image, $width, $height, $mode, $target, $force);
  2210.     }
  2212.     /**
  2213.      * Generate an image tag and return it as string
  2214.      *
  2215.      * @param string $src        The image path
  2216.      * @param string $alt        An optional alt attribute
  2217.      * @param string $attributes A string of other attributes
  2218.      *
  2219.      * @return string The image HTML tag
  2220.      *
  2221.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2222.      *             Use Image::getHtml() instead.
  2223.      */
  2224.     public static function generateImage($src, $alt='', $attributes='')
  2225.     {
  2226.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::generateImage()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Image::getHtml()" instead.');
  2228.         return Image::getHtml($src, $alt, $attributes);
  2229.     }
  2231.     /**
  2232.      * Return the date picker string (see #3218)
  2233.      *
  2234.      * @return boolean
  2235.      *
  2236.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2237.      *             Specify "datepicker"=>true in your DCA file instead.
  2238.      */
  2239.     protected function getDatePickerString()
  2240.     {
  2241.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getDatePickerString()" has been deprecated and will no longer work in Contao 5.0. Specify "\'datepicker\' => true" in your DCA file instead.');
  2243.         return true;
  2244.     }
  2246.     /**
  2247.      * Return the installed back end languages as array
  2248.      *
  2249.      * @return array An array of available back end languages
  2250.      *
  2251.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2252.      *             Use the Contao\CoreBundle\Intl\Locales service instead.
  2253.      */
  2254.     protected function getBackendLanguages()
  2255.     {
  2256.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getBackendLanguages()" has been deprecated and will no longer work in Contao 5.0. Use the Contao\CoreBundle\Intl\Locales service instead.');
  2258.         return $this->getLanguages(true);
  2259.     }
  2261.     /**
  2262.      * Parse simple tokens that can be used to personalize newsletters
  2263.      *
  2264.      * @param string $strBuffer The text with the tokens to be replaced
  2265.      * @param array  $arrData   The replacement data as array
  2266.      *
  2267.      * @return string The text with the replaced tokens
  2268.      *
  2269.      * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0;
  2270.      *             Use the contao.string.simple_token_parser service instead.
  2271.      */
  2272.     protected function parseSimpleTokens($strBuffer, $arrData)
  2273.     {
  2274.         trigger_deprecation('contao/core-bundle', '4.10', 'Using "Contao\Controller::parseSimpleTokens()" has been deprecated and will no longer work in Contao 5.0. Use the "contao.string.simple_token_parser" service instead.');
  2276.         return System::getContainer()->get('contao.string.simple_token_parser')->parse($strBuffer, $arrData);
  2277.     }
  2279.     /**
  2280.      * Convert a DCA file configuration to be used with widgets
  2281.      *
  2282.      * @param array  $arrData  The field configuration array
  2283.      * @param string $strName  The field name in the form
  2284.      * @param mixed  $varValue The field value
  2285.      * @param string $strField The field name in the database
  2286.      * @param string $strTable The table name
  2287.      *
  2288.      * @return array An array that can be passed to a widget
  2289.      *
  2290.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2291.      *             Use Widget::getAttributesFromDca() instead.
  2292.      */
  2293.     protected function prepareForWidget($arrData, $strName, $varValue=null, $strField='', $strTable='')
  2294.     {
  2295.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::prepareForWidget()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Widget::getAttributesFromDca()" instead.');
  2297.         return Widget::getAttributesFromDca($arrData, $strName, $varValue, $strField, $strTable);
  2298.     }
  2300.     /**
  2301.      * Return the IDs of all child records of a particular record (see #2475)
  2302.      *
  2303.      * @param mixed   $arrParentIds An array of parent IDs
  2304.      * @param string  $strTable     The table name
  2305.      * @param boolean $blnSorting   True if the table has a sorting field
  2306.      * @param array   $arrReturn    The array to be returned
  2307.      * @param string  $strWhere     Additional WHERE condition
  2308.      *
  2309.      * @return array An array of child record IDs
  2310.      *
  2311.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2312.      *             Use Database::getChildRecords() instead.
  2313.      */
  2314.     protected function getChildRecords($arrParentIds, $strTable, $blnSorting=false, $arrReturn=array(), $strWhere='')
  2315.     {
  2316.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getChildRecords()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Database::getChildRecords()" instead.');
  2318.         return $this->Database->getChildRecords($arrParentIds, $strTable, $blnSorting, $arrReturn, $strWhere);
  2319.     }
  2321.     /**
  2322.      * Return the IDs of all parent records of a particular record
  2323.      *
  2324.      * @param integer $intId    The ID of the record
  2325.      * @param string  $strTable The table name
  2326.      *
  2327.      * @return array An array of parent record IDs
  2328.      *
  2329.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2330.      *             Use Database::getParentRecords() instead.
  2331.      */
  2332.     protected function getParentRecords($intId, $strTable)
  2333.     {
  2334.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getParentRecords()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Database::getParentRecords()" instead.');
  2336.         return $this->Database->getParentRecords($intId, $strTable);
  2337.     }
  2339.     /**
  2340.      * Print an article as PDF and stream it to the browser
  2341.      *
  2342.      * @param ModuleModel $objArticle An article object
  2343.      *
  2344.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2345.      *             Use ModuleArticle->generatePdf() instead.
  2346.      */
  2347.     protected function printArticleAsPdf($objArticle)
  2348.     {
  2349.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::printArticleAsPdf()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\ModuleArticle->generatePdf()" instead.');
  2351.         $objArticle = new ModuleArticle($objArticle);
  2352.         $objArticle->generatePdf();
  2353.     }
  2355.     /**
  2356.      * Return all page sections as array
  2357.      *
  2358.      * @return array An array of active page sections
  2359.      *
  2360.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2361.      *             See https://github.com/contao/core/issues/4693.
  2362.      */
  2363.     public static function getPageSections()
  2364.     {
  2365.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getPageSections()" has been deprecated and will no longer work in Contao 5.0.');
  2367.         return array('header', 'left', 'right', 'main', 'footer');
  2368.     }
  2370.     /**
  2371.      * Return a "selected" attribute if the option is selected
  2372.      *
  2373.      * @param string $strOption The option to check
  2374.      * @param mixed  $varValues One or more values to check against
  2375.      *
  2376.      * @return string The attribute or an empty string
  2377.      *
  2378.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2379.      *             Use Widget::optionSelected() instead.
  2380.      */
  2381.     public static function optionSelected($strOption, $varValues)
  2382.     {
  2383.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::optionSelected()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Widget::optionSelected()" instead.');
  2385.         return Widget::optionSelected($strOption, $varValues);
  2386.     }
  2388.     /**
  2389.      * Return a "checked" attribute if the option is checked
  2390.      *
  2391.      * @param string $strOption The option to check
  2392.      * @param mixed  $varValues One or more values to check against
  2393.      *
  2394.      * @return string The attribute or an empty string
  2395.      *
  2396.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2397.      *             Use Widget::optionChecked() instead.
  2398.      */
  2399.     public static function optionChecked($strOption, $varValues)
  2400.     {
  2401.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::optionChecked()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Widget::optionChecked()" instead.');
  2403.         return Widget::optionChecked($strOption, $varValues);
  2404.     }
  2406.     /**
  2407.      * Find a content element in the TL_CTE array and return the class name
  2408.      *
  2409.      * @param string $strName The content element name
  2410.      *
  2411.      * @return string The class name
  2412.      *
  2413.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2414.      *             Use ContentElement::findClass() instead.
  2415.      */
  2416.     public static function findContentElement($strName)
  2417.     {
  2418.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::findContentElement()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\ContentElement::findClass()" instead.');
  2420.         return ContentElement::findClass($strName);
  2421.     }
  2423.     /**
  2424.      * Find a front end module in the FE_MOD array and return the class name
  2425.      *
  2426.      * @param string $strName The front end module name
  2427.      *
  2428.      * @return string The class name
  2429.      *
  2430.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2431.      *             Use Module::findClass() instead.
  2432.      */
  2433.     public static function findFrontendModule($strName)
  2434.     {
  2435.         trigger_deprecation('contao/core-bundle', '4.0', 'Using Contao\Controller::findFrontendModule() has been deprecated and will no longer work in Contao 5.0. Use Contao\Module::findClass() instead.');
  2437.         return Module::findClass($strName);
  2438.     }
  2440.     /**
  2441.      * Create an initial version of a record
  2442.      *
  2443.      * @param string  $strTable The table name
  2444.      * @param integer $intId    The ID of the element to be versioned
  2445.      *
  2446.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2447.      *             Use Versions->initialize() instead.
  2448.      */
  2449.     protected function createInitialVersion($strTable, $intId)
  2450.     {
  2451.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::createInitialVersion()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Versions->initialize()" instead.');
  2453.         $objVersions = new Versions($strTable, $intId);
  2454.         $objVersions->initialize();
  2455.     }
  2457.     /**
  2458.      * Create a new version of a record
  2459.      *
  2460.      * @param string  $strTable The table name
  2461.      * @param integer $intId    The ID of the element to be versioned
  2462.      *
  2463.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2464.      *             Use Versions->create() instead.
  2465.      */
  2466.     protected function createNewVersion($strTable, $intId)
  2467.     {
  2468.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::createNewVersion()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\Versions->create()" instead.');
  2470.         $objVersions = new Versions($strTable, $intId);
  2471.         $objVersions->create();
  2472.     }
  2474.     /**
  2475.      * Return the files matching a GLOB pattern
  2476.      *
  2477.      * @param string $pattern
  2478.      *
  2479.      * @return array|false
  2480.      */
  2481.     protected static function braceGlob($pattern)
  2482.     {
  2483.         // Use glob() if possible
  2484.         if (false === strpos($pattern, '/**/') && (\defined('GLOB_BRACE') || false === strpos($pattern, '{')))
  2485.         {
  2486.             return glob($pattern, \defined('GLOB_BRACE') ? GLOB_BRACE : 0);
  2487.         }
  2489.         $finder = new Finder();
  2490.         $regex = Glob::toRegex($pattern);
  2492.         // All files in the given template folder
  2493.         $filesIterator = $finder
  2494.             ->files()
  2495.             ->followLinks()
  2496.             ->sortByName()
  2497.             ->in(\dirname($pattern))
  2498.         ;
  2500.         // Match the actual regex and filter the files
  2501.         $filesIterator = $filesIterator->filter(static function (\SplFileInfo $info) use ($regex)
  2502.         {
  2503.             $path = $info->getPathname();
  2505.             return preg_match($regex, $path) && $info->isFile();
  2506.         });
  2508.         $files = iterator_to_array($filesIterator);
  2510.         return array_keys($files);
  2511.     }
  2512. }
  2514. class_alias(Controller::class, 'Controller');