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

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);
  81.         // Check for a theme folder
  82.         if (\defined('TL_MODE') && TL_MODE == 'FE')
  83.         {
  84.             /** @var PageModel|null $objPage */
  85.             global $objPage;
  87.             if ($objPage->templateGroup ?? null)
  88.             {
  89.                 if (Validator::isInsecurePath($objPage->templateGroup))
  90.                 {
  91.                     throw new \RuntimeException('Invalid path ' . $objPage->templateGroup);
  92.                 }
  94.                 return TemplateLoader::getPath($strTemplate, 'html5', $objPage->templateGroup);
  95.             }
  96.         }
  98.         return TemplateLoader::getPath($strTemplate, 'html5');
  99.     }
  101.     /**
  102.      * Return all template files of a particular group as array
  103.      *
  104.      * @param string $strPrefix           The template name prefix (e.g. "ce_")
  105.      * @param array  $arrAdditionalMapper An additional mapper array
  106.      * @param string $strDefaultTemplate  An optional default template
  107.      *
  108.      * @return array An array of template names
  109.      */
  110.     public static function getTemplateGroup($strPrefix, array $arrAdditionalMapper=array(), $strDefaultTemplate='')
  111.     {
  112.         if (str_contains($strPrefix, '/') || str_contains($strDefaultTemplate, '/'))
  113.         {
  114.             throw new \InvalidArgumentException(sprintf('Using %s() with modern fragment templates is not supported. Use the "contao.twig.finder_factory" service instead.', __METHOD__));
  115.         }
  117.         $arrTemplates = array();
  118.         $arrBundleTemplates = array();
  120.         $arrMapper = array_merge
  121.         (
  122.             $arrAdditionalMapper,
  123.             array
  124.             (
  125.                 'ce' => array_keys(array_merge(...array_values($GLOBALS['TL_CTE']))),
  126.                 'form' => array_keys($GLOBALS['TL_FFL']),
  127.                 'mod' => array_keys(array_merge(...array_values($GLOBALS['FE_MOD']))),
  128.             )
  129.         );
  131.         // Add templates that are not directly associated with a form field
  132.         $arrMapper['form'][] = 'row';
  133.         $arrMapper['form'][] = 'row_double';
  134.         $arrMapper['form'][] = 'xml';
  135.         $arrMapper['form'][] = 'wrapper';
  136.         $arrMapper['form'][] = 'message';
  137.         $arrMapper['form'][] = 'textfield'; // TODO: remove in Contao 5.0
  139.         // Add templates that are not directly associated with a module
  140.         $arrMapper['mod'][] = 'article';
  141.         $arrMapper['mod'][] = 'message';
  142.         $arrMapper['mod'][] = 'password'; // TODO: remove in Contao 5.0
  143.         $arrMapper['mod'][] = 'comment_form'; // TODO: remove in Contao 5.0
  144.         $arrMapper['mod'][] = 'newsletter'; // TODO: remove in Contao 5.0
  146.         /** @var TemplateHierarchyInterface $templateHierarchy */
  147.         $templateHierarchy = System::getContainer()->get('contao.twig.filesystem_loader');
  148.         $identifierPattern = sprintf('/^%s%s/', preg_quote($strPrefix, '/'), substr($strPrefix, -1) !== '_' ? '($|_)' : '');
  150.         $prefixedFiles = array_merge(
  151.             array_filter(
  152.                 array_keys($templateHierarchy->getInheritanceChains()),
  153.                 static fn (string $identifier): bool => 1 === preg_match($identifierPattern, $identifier),
  154.             ),
  155.             // Merge with the templates from the TemplateLoader for backwards
  156.             // compatibility in case someone has added templates manually
  157.             TemplateLoader::getPrefixedFiles($strPrefix),
  158.         );
  160.         foreach ($prefixedFiles as $strTemplate)
  161.         {
  162.             if ($strTemplate != $strPrefix)
  163.             {
  164.                 list($k, $strKey) = explode('_', $strTemplate, 2);
  166.                 if (isset($arrMapper[$k]) && \in_array($strKey, $arrMapper[$k]))
  167.                 {
  168.                     $arrBundleTemplates[] = $strTemplate;
  169.                     continue;
  170.                 }
  171.             }
  173.             $arrTemplates[$strTemplate][] = 'root';
  174.         }
  176.         $strGlobPrefix = $strPrefix;
  178.         // Backwards compatibility (see #725)
  179.         if (substr($strGlobPrefix, -1) == '_')
  180.         {
  181.             $strGlobPrefix = substr($strGlobPrefix, 0, -1) . '[_-]';
  182.         }
  184.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  185.         $arrCustomized = self::braceGlob($projectDir . '/templates/' . $strGlobPrefix . '*.html5');
  187.         // Add the customized templates
  188.         if (!empty($arrCustomized) && \is_array($arrCustomized))
  189.         {
  190.             $blnIsGroupPrefix = preg_match('/^[a-z]+_$/', $strPrefix);
  192.             foreach ($arrCustomized as $strFile)
  193.             {
  194.                 $strTemplate = basename($strFile, strrchr($strFile, '.'));
  196.                 if (strpos($strTemplate, '-') !== false)
  197.                 {
  198.                     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.');
  199.                 }
  201.                 // Ignore bundle templates, e.g. mod_article and mod_article_list
  202.                 if (\in_array($strTemplate, $arrBundleTemplates))
  203.                 {
  204.                     continue;
  205.                 }
  207.                 // Also ignore custom templates belonging to a different bundle template,
  208.                 // e.g. mod_article and mod_article_list_custom
  209.                 if (!$blnIsGroupPrefix)
  210.                 {
  211.                     foreach ($arrBundleTemplates as $strKey)
  212.                     {
  213.                         if (strpos($strTemplate, $strKey . '_') === 0)
  214.                         {
  215.                             continue 2;
  216.                         }
  217.                     }
  218.                 }
  220.                 $arrTemplates[$strTemplate][] = $GLOBALS['TL_LANG']['MSC']['global'] ?? 'global';
  221.             }
  222.         }
  224.         $arrDefaultPlaces = array();
  226.         if ($strDefaultTemplate)
  227.         {
  228.             $arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['default'];
  230.             if (file_exists($projectDir . '/templates/' . $strDefaultTemplate . '.html5'))
  231.             {
  232.                 $arrDefaultPlaces[] = $GLOBALS['TL_LANG']['MSC']['global'];
  233.             }
  234.         }
  236.         // Do not look for back end templates in theme folders (see #5379)
  237.         if ($strPrefix != 'be_' && $strPrefix != 'mail_')
  238.         {
  239.             // Try to select the themes (see #5210)
  240.             try
  241.             {
  242.                 $objTheme = ThemeModel::findAll(array('order'=>'name'));
  243.             }
  244.             catch (\Throwable $e)
  245.             {
  246.                 $objTheme = null;
  247.             }
  249.             // Add the theme templates
  250.             if ($objTheme !== null)
  251.             {
  252.                 while ($objTheme->next())
  253.                 {
  254.                     if (!$objTheme->templates)
  255.                     {
  256.                         continue;
  257.                     }
  259.                     if ($strDefaultTemplate && file_exists($projectDir . '/' . $objTheme->templates . '/' . $strDefaultTemplate . '.html5'))
  260.                     {
  261.                         $arrDefaultPlaces[] = $objTheme->name;
  262.                     }
  264.                     $arrThemeTemplates = self::braceGlob($projectDir . '/' . $objTheme->templates . '/' . $strGlobPrefix . '*.html5');
  266.                     if (!empty($arrThemeTemplates) && \is_array($arrThemeTemplates))
  267.                     {
  268.                         foreach ($arrThemeTemplates as $strFile)
  269.                         {
  270.                             $strTemplate = basename($strFile, strrchr($strFile, '.'));
  271.                             $arrTemplates[$strTemplate][] = $objTheme->name;
  272.                         }
  273.                     }
  274.                 }
  275.             }
  276.         }
  278.         // Show the template sources (see #6875)
  279.         foreach ($arrTemplates as $k=>$v)
  280.         {
  281.             $v = array_filter($v, static function ($a)
  282.             {
  283.                 return $a != 'root';
  284.             });
  286.             if (empty($v))
  287.             {
  288.                 $arrTemplates[$k] = $k;
  289.             }
  290.             else
  291.             {
  292.                 $arrTemplates[$k] = $k . ' (' . implode(', ', $v) . ')';
  293.             }
  294.         }
  296.         // Sort the template names
  297.         ksort($arrTemplates);
  299.         if ($strDefaultTemplate)
  300.         {
  301.             if (!empty($arrDefaultPlaces))
  302.             {
  303.                 $strDefaultTemplate .= ' (' . implode(', ', $arrDefaultPlaces) . ')';
  304.             }
  306.             $arrTemplates = array('' => $strDefaultTemplate) + $arrTemplates;
  307.         }
  309.         return $arrTemplates;
  310.     }
  312.     /**
  313.      * Generate a front end module and return it as string
  314.      *
  315.      * @param mixed  $intId     A module ID or a Model object
  316.      * @param string $strColumn The name of the column
  317.      *
  318.      * @return string The module HTML markup
  319.      */
  320.     public static function getFrontendModule($intId, $strColumn='main')
  321.     {
  322.         if (!\is_object($intId) && !\strlen($intId))
  323.         {
  324.             return '';
  325.         }
  327.         /** @var PageModel $objPage */
  328.         global $objPage;
  330.         // Articles
  331.         if (!\is_object($intId) && $intId == 0)
  332.         {
  333.             // Show a particular article only
  334.             if ($objPage->type == 'regular' && Input::get('articles'))
  335.             {
  336.                 list($strSection, $strArticle) = explode(':', Input::get('articles')) + array(null, null);
  338.                 if ($strArticle === null)
  339.                 {
  340.                     $strArticle = $strSection;
  341.                     $strSection = 'main';
  342.                 }
  344.                 if ($strSection == $strColumn)
  345.                 {
  346.                     $objArticle = ArticleModel::findPublishedByIdOrAliasAndPid($strArticle, $objPage->id);
  348.                     // Send a 404 header if there is no published article
  349.                     if (null === $objArticle)
  350.                     {
  351.                         throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  352.                     }
  354.                     // Send a 403 header if the article cannot be accessed
  355.                     if (!static::isVisibleElement($objArticle))
  356.                     {
  357.                         throw new AccessDeniedException('Access denied: ' . Environment::get('uri'));
  358.                     }
  360.                     return static::getArticle($objArticle);
  361.                 }
  362.             }
  364.             // HOOK: add custom logic
  365.             if (isset($GLOBALS['TL_HOOKS']['getArticles']) && \is_array($GLOBALS['TL_HOOKS']['getArticles']))
  366.             {
  367.                 foreach ($GLOBALS['TL_HOOKS']['getArticles'] as $callback)
  368.                 {
  369.                     $return = static::importStatic($callback[0])->{$callback[1]}($objPage->id, $strColumn);
  371.                     if (\is_string($return))
  372.                     {
  373.                         return $return;
  374.                     }
  375.                 }
  376.             }
  378.             // Show all articles (no else block here, see #4740)
  379.             $objArticles = ArticleModel::findPublishedByPidAndColumn($objPage->id, $strColumn);
  381.             if ($objArticles === null)
  382.             {
  383.                 return '';
  384.             }
  386.             $return = '';
  387.             $blnMultiMode = ($objArticles->count() > 1);
  389.             while ($objArticles->next())
  390.             {
  391.                 $return .= static::getArticle($objArticles->current(), $blnMultiMode, false, $strColumn);
  392.             }
  394.             return $return;
  395.         }
  397.         // Other modules
  398.         if (\is_object($intId))
  399.         {
  400.             $objRow = $intId;
  401.         }
  402.         else
  403.         {
  404.             $objRow = ModuleModel::findByPk($intId);
  406.             if ($objRow === null)
  407.             {
  408.                 return '';
  409.             }
  410.         }
  412.         // Check the visibility (see #6311)
  413.         if (!static::isVisibleElement($objRow))
  414.         {
  415.             return '';
  416.         }
  418.         $strClass = Module::findClass($objRow->type);
  420.         // Return if the class does not exist
  421.         if (!class_exists($strClass))
  422.         {
  423.             System::getContainer()->get('monolog.logger.contao.error')->error('Module class "' . $strClass . '" (module "' . $objRow->type . '") does not exist');
  425.             return '';
  426.         }
  428.         $strStopWatchId = 'contao.frontend_module.' . $objRow->type . ' (ID ' . $objRow->id . ')';
  430.         if (System::getContainer()->getParameter('kernel.debug'))
  431.         {
  432.             $objStopwatch = System::getContainer()->get('debug.stopwatch');
  433.             $objStopwatch->start($strStopWatchId, 'contao.layout');
  434.         }
  436.         $objRow->typePrefix = 'mod_';
  438.         /** @var Module $objModule */
  439.         $objModule = new $strClass($objRow, $strColumn);
  440.         $strBuffer = $objModule->generate();
  442.         // HOOK: add custom logic
  443.         if (isset($GLOBALS['TL_HOOKS']['getFrontendModule']) && \is_array($GLOBALS['TL_HOOKS']['getFrontendModule']))
  444.         {
  445.             foreach ($GLOBALS['TL_HOOKS']['getFrontendModule'] as $callback)
  446.             {
  447.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objModule);
  448.             }
  449.         }
  451.         // Disable indexing if protected
  452.         if ($objModule->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  453.         {
  454.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  455.         }
  457.         if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
  458.         {
  459.             $objStopwatch->stop($strStopWatchId);
  460.         }
  462.         return $strBuffer;
  463.     }
  465.     /**
  466.      * Generate an article and return it as string
  467.      *
  468.      * @param mixed   $varId          The article ID or a Model object
  469.      * @param boolean $blnMultiMode   If true, only teasers will be shown
  470.      * @param boolean $blnIsInsertTag If true, there will be no page relation
  471.      * @param string  $strColumn      The name of the column
  472.      *
  473.      * @return string|boolean The article HTML markup or false
  474.      */
  475.     public static function getArticle($varId, $blnMultiMode=false, $blnIsInsertTag=false, $strColumn='main')
  476.     {
  477.         /** @var PageModel $objPage */
  478.         global $objPage;
  480.         if (\is_object($varId))
  481.         {
  482.             $objRow = $varId;
  483.         }
  484.         else
  485.         {
  486.             if (!$varId)
  487.             {
  488.                 return '';
  489.             }
  491.             $objRow = ArticleModel::findByIdOrAliasAndPid($varId, (!$blnIsInsertTag ? $objPage->id : null));
  493.             if ($objRow === null)
  494.             {
  495.                 return false;
  496.             }
  497.         }
  499.         // Check the visibility (see #6311)
  500.         if (!static::isVisibleElement($objRow))
  501.         {
  502.             return '';
  503.         }
  505.         // Print the article as PDF
  506.         if (isset($_GET['pdf']) && Input::get('pdf') == $objRow->id)
  507.         {
  508.             // Deprecated since Contao 4.0, to be removed in Contao 5.0
  509.             if ($objRow->printable == 1)
  510.             {
  511.                 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.');
  513.                 $objArticle = new ModuleArticle($objRow);
  514.                 $objArticle->generatePdf();
  515.             }
  516.             elseif ($objRow->printable)
  517.             {
  518.                 $options = StringUtil::deserialize($objRow->printable);
  520.                 if (\is_array($options) && \in_array('pdf', $options))
  521.                 {
  522.                     $objArticle = new ModuleArticle($objRow);
  523.                     $objArticle->generatePdf();
  524.                 }
  525.             }
  526.         }
  528.         $objRow->headline = $objRow->title;
  529.         $objRow->multiMode = $blnMultiMode;
  531.         // HOOK: add custom logic
  532.         if (isset($GLOBALS['TL_HOOKS']['getArticle']) && \is_array($GLOBALS['TL_HOOKS']['getArticle']))
  533.         {
  534.             foreach ($GLOBALS['TL_HOOKS']['getArticle'] as $callback)
  535.             {
  536.                 static::importStatic($callback[0])->{$callback[1]}($objRow);
  537.             }
  538.         }
  540.         $strStopWatchId = 'contao.article (ID ' . $objRow->id . ')';
  542.         if (System::getContainer()->getParameter('kernel.debug'))
  543.         {
  544.             $objStopwatch = System::getContainer()->get('debug.stopwatch');
  545.             $objStopwatch->start($strStopWatchId, 'contao.layout');
  546.         }
  548.         $objArticle = new ModuleArticle($objRow, $strColumn);
  549.         $strBuffer = $objArticle->generate($blnIsInsertTag);
  551.         // Disable indexing if protected
  552.         if ($objArticle->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  553.         {
  554.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  555.         }
  557.         if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
  558.         {
  559.             $objStopwatch->stop($strStopWatchId);
  560.         }
  562.         return $strBuffer;
  563.     }
  565.     /**
  566.      * Generate a content element and return it as string
  567.      *
  568.      * @param mixed  $intId     A content element ID or a Model object
  569.      * @param string $strColumn The column the element is in
  570.      *
  571.      * @return string The content element HTML markup
  572.      */
  573.     public static function getContentElement($intId, $strColumn='main')
  574.     {
  575.         if (\is_object($intId))
  576.         {
  577.             $objRow = $intId;
  578.         }
  579.         else
  580.         {
  581.             if ($intId < 1 || !\strlen($intId))
  582.             {
  583.                 return '';
  584.             }
  586.             $objRow = ContentModel::findByPk($intId);
  588.             if ($objRow === null)
  589.             {
  590.                 return '';
  591.             }
  592.         }
  594.         // Check the visibility (see #6311)
  595.         if (!static::isVisibleElement($objRow))
  596.         {
  597.             return '';
  598.         }
  600.         $strClass = ContentElement::findClass($objRow->type);
  602.         // Return if the class does not exist
  603.         if (!class_exists($strClass))
  604.         {
  605.             System::getContainer()->get('monolog.logger.contao.error')->error('Content element class "' . $strClass . '" (content element "' . $objRow->type . '") does not exist');
  607.             return '';
  608.         }
  610.         $objRow->typePrefix = 'ce_';
  611.         $strStopWatchId = 'contao.content_element.' . $objRow->type . ' (ID ' . $objRow->id . ')';
  613.         if ($objRow->type != 'module' && System::getContainer()->getParameter('kernel.debug'))
  614.         {
  615.             $objStopwatch = System::getContainer()->get('debug.stopwatch');
  616.             $objStopwatch->start($strStopWatchId, 'contao.layout');
  617.         }
  619.         /** @var ContentElement $objElement */
  620.         $objElement = new $strClass($objRow, $strColumn);
  621.         $strBuffer = $objElement->generate();
  623.         // HOOK: add custom logic
  624.         if (isset($GLOBALS['TL_HOOKS']['getContentElement']) && \is_array($GLOBALS['TL_HOOKS']['getContentElement']))
  625.         {
  626.             foreach ($GLOBALS['TL_HOOKS']['getContentElement'] as $callback)
  627.             {
  628.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
  629.             }
  630.         }
  632.         // Disable indexing if protected
  633.         if ($objElement->protected && !preg_match('/^\s*<!-- indexer::stop/', $strBuffer))
  634.         {
  635.             $strBuffer = "\n<!-- indexer::stop -->" . $strBuffer . "<!-- indexer::continue -->\n";
  636.         }
  638.         if (isset($objStopwatch) && $objStopwatch->isStarted($strStopWatchId))
  639.         {
  640.             $objStopwatch->stop($strStopWatchId);
  641.         }
  643.         return $strBuffer;
  644.     }
  646.     /**
  647.      * Generate a form and return it as string
  648.      *
  649.      * @param mixed   $varId     A form ID or a Model object
  650.      * @param string  $strColumn The column the form is in
  651.      * @param boolean $blnModule Render the form as module
  652.      *
  653.      * @return string The form HTML markup
  654.      */
  655.     public static function getForm($varId, $strColumn='main', $blnModule=false)
  656.     {
  657.         if (\is_object($varId))
  658.         {
  659.             $objRow = $varId;
  660.         }
  661.         else
  662.         {
  663.             if (!$varId)
  664.             {
  665.                 return '';
  666.             }
  668.             $objRow = FormModel::findByIdOrAlias($varId);
  670.             if ($objRow === null)
  671.             {
  672.                 return '';
  673.             }
  674.         }
  676.         $strClass = $blnModule ? Module::findClass('form') : ContentElement::findClass('form');
  678.         if (!class_exists($strClass))
  679.         {
  680.             System::getContainer()->get('monolog.logger.contao.error')->error('Form class "' . $strClass . '" does not exist');
  682.             return '';
  683.         }
  685.         $objRow->typePrefix = $blnModule ? 'mod_' : 'ce_';
  686.         $objRow->form = $objRow->id;
  688.         /** @var Form $objElement */
  689.         $objElement = new $strClass($objRow, $strColumn);
  690.         $strBuffer = $objElement->generate();
  692.         // HOOK: add custom logic
  693.         if (isset($GLOBALS['TL_HOOKS']['getForm']) && \is_array($GLOBALS['TL_HOOKS']['getForm']))
  694.         {
  695.             foreach ($GLOBALS['TL_HOOKS']['getForm'] as $callback)
  696.             {
  697.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($objRow, $strBuffer, $objElement);
  698.             }
  699.         }
  701.         return $strBuffer;
  702.     }
  704.     /**
  705.      * Return the languages for the TinyMCE spellchecker
  706.      *
  707.      * @return string The TinyMCE spellchecker language string
  708.      *
  709.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  710.      */
  711.     protected function getSpellcheckerString()
  712.     {
  713.         trigger_deprecation('contao/core-bundle', '4.13', 'Using "%s()" has been deprecated and will no longer work in Contao 5.0.', __METHOD__);
  715.         System::loadLanguageFile('languages');
  717.         $return = array();
  718.         $langs = Folder::scan(__DIR__ . '/../../languages');
  719.         array_unshift($langs, $GLOBALS['TL_LANGUAGE']);
  721.         foreach ($langs as $lang)
  722.         {
  723.             $lang = substr($lang, 0, 2);
  725.             if (isset($GLOBALS['TL_LANG']['LNG'][$lang]))
  726.             {
  727.                 $return[$lang] = $GLOBALS['TL_LANG']['LNG'][$lang] . '=' . $lang;
  728.             }
  729.         }
  731.         return '+' . implode(',', array_unique($return));
  732.     }
  734.     /**
  735.      * Calculate the page status icon name based on the page parameters
  736.      *
  737.      * @param PageModel|Result|\stdClass $objPage The page object
  738.      *
  739.      * @return string The status icon name
  740.      */
  741.     public static function getPageStatusIcon($objPage)
  742.     {
  743.         $sub = 0;
  744.         $type = \in_array($objPage->type, array('regular', 'root', 'forward', 'redirect', 'error_401', 'error_403', 'error_404', 'error_503'), true) ? $objPage->type : 'regular';
  745.         $image = $type . '.svg';
  747.         // Page not published or not active
  748.         if (!$objPage->published || ($objPage->start && $objPage->start > time()) || ($objPage->stop && $objPage->stop <= time()))
  749.         {
  750.             ++$sub;
  751.         }
  753.         // Page hidden from menu
  754.         if ($objPage->hide && !\in_array($type, array('root', 'error_401', 'error_403', 'error_404', 'error_503')))
  755.         {
  756.             $sub += 2;
  757.         }
  759.         // Page protected
  760.         if ($objPage->protected && !\in_array($type, array('root', 'error_401', 'error_403', 'error_404', 'error_503')))
  761.         {
  762.             $sub += 4;
  763.         }
  765.         // Change icon if root page is published and in maintenance mode
  766.         if ($sub == 0 && $objPage->type == 'root' && $objPage->maintenanceMode)
  767.         {
  768.             $sub = 2;
  769.         }
  771.         // Get the image name
  772.         if ($sub > 0)
  773.         {
  774.             $image = $type . '_' . $sub . '.svg';
  775.         }
  777.         // HOOK: add custom logic
  778.         if (isset($GLOBALS['TL_HOOKS']['getPageStatusIcon']) && \is_array($GLOBALS['TL_HOOKS']['getPageStatusIcon']))
  779.         {
  780.             foreach ($GLOBALS['TL_HOOKS']['getPageStatusIcon'] as $callback)
  781.             {
  782.                 $image = static::importStatic($callback[0])->{$callback[1]}($objPage, $image);
  783.             }
  784.         }
  786.         return $image;
  787.     }
  789.     /**
  790.      * Check whether an element is visible in the front end
  791.      *
  792.      * @param Model|ContentModel|ModuleModel $objElement The element model
  793.      *
  794.      * @return boolean True if the element is visible
  795.      */
  796.     public static function isVisibleElement(Model $objElement)
  797.     {
  798.         $blnReturn = true;
  800.         // Only apply the restrictions in the front end
  801.         if (TL_MODE == 'FE')
  802.         {
  803.             $security = System::getContainer()->get('security.helper');
  805.             if ($objElement->protected)
  806.             {
  807.                 $groups = StringUtil::deserialize($objElement->groups, true);
  808.                 $blnReturn = $security->isGranted(ContaoCorePermissions::MEMBER_IN_GROUPS, $groups);
  809.             }
  810.             elseif ($objElement->guests)
  811.             {
  812.                 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.');
  813.                 $blnReturn = !$security->isGranted('ROLE_MEMBER'); // backwards compatibility
  814.             }
  815.         }
  817.         // HOOK: add custom logic
  818.         if (isset($GLOBALS['TL_HOOKS']['isVisibleElement']) && \is_array($GLOBALS['TL_HOOKS']['isVisibleElement']))
  819.         {
  820.             foreach ($GLOBALS['TL_HOOKS']['isVisibleElement'] as $callback)
  821.             {
  822.                 $blnReturn = static::importStatic($callback[0])->{$callback[1]}($objElement, $blnReturn);
  823.             }
  824.         }
  826.         return $blnReturn;
  827.     }
  829.     /**
  830.      * Replace insert tags with their values
  831.      *
  832.      * @param string  $strBuffer The text with the tags to be replaced
  833.      * @param boolean $blnCache  If false, non-cacheable tags will be replaced
  834.      *
  835.      * @return string The text with the replaced tags
  836.      *
  837.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  838.      *             Use the InsertTagParser service instead.
  839.      */
  840.     public static function replaceInsertTags($strBuffer, $blnCache=true)
  841.     {
  842.         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__);
  844.         $parser = System::getContainer()->get('contao.insert_tag.parser');
  846.         if ($blnCache)
  847.         {
  848.             return $parser->replace((string) $strBuffer);
  849.         }
  851.         return $parser->replaceInline((string) $strBuffer);
  852.     }
  854.     /**
  855.      * Replace the dynamic script tags (see #4203)
  856.      *
  857.      * @param string $strBuffer The string with the tags to be replaced
  858.      *
  859.      * @return string The string with the replaced tags
  860.      */
  861.     public static function replaceDynamicScriptTags($strBuffer)
  862.     {
  863.         // HOOK: add custom logic
  864.         if (isset($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']) && \is_array($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags']))
  865.         {
  866.             foreach ($GLOBALS['TL_HOOKS']['replaceDynamicScriptTags'] as $callback)
  867.             {
  868.                 $strBuffer = static::importStatic($callback[0])->{$callback[1]}($strBuffer);
  869.             }
  870.         }
  872.         $arrReplace = array();
  873.         $strScripts = '';
  875.         // Add the internal jQuery scripts
  876.         if (!empty($GLOBALS['TL_JQUERY']) && \is_array($GLOBALS['TL_JQUERY']))
  877.         {
  878.             $strScripts .= implode('', array_unique($GLOBALS['TL_JQUERY']));
  879.         }
  881.         $nonce = ContaoFramework::getNonce();
  883.         $arrReplace["[[TL_JQUERY_$nonce]]"] = $strScripts;
  884.         $strScripts = '';
  886.         // Add the internal MooTools scripts
  887.         if (!empty($GLOBALS['TL_MOOTOOLS']) && \is_array($GLOBALS['TL_MOOTOOLS']))
  888.         {
  889.             $strScripts .= implode('', array_unique($GLOBALS['TL_MOOTOOLS']));
  890.         }
  892.         $arrReplace["[[TL_MOOTOOLS_$nonce]]"] = $strScripts;
  893.         $strScripts = '';
  895.         // Add the internal <body> tags
  896.         if (!empty($GLOBALS['TL_BODY']) && \is_array($GLOBALS['TL_BODY']))
  897.         {
  898.             $strScripts .= implode('', array_unique($GLOBALS['TL_BODY']));
  899.         }
  901.         /** @var PageModel|null $objPage */
  902.         global $objPage;
  904.         $objLayout = ($objPage !== null) ? LayoutModel::findByPk($objPage->layoutId) : null;
  905.         $blnCombineScripts = $objLayout !== null && $objLayout->combineScripts;
  907.         $arrReplace["[[TL_BODY_$nonce]]"] = $strScripts;
  908.         $strScripts = '';
  910.         $objCombiner = new Combiner();
  912.         // Add the CSS framework style sheets
  913.         if (!empty($GLOBALS['TL_FRAMEWORK_CSS']) && \is_array($GLOBALS['TL_FRAMEWORK_CSS']))
  914.         {
  915.             foreach (array_unique($GLOBALS['TL_FRAMEWORK_CSS']) as $stylesheet)
  916.             {
  917.                 $objCombiner->add($stylesheet);
  918.             }
  919.         }
  921.         // Add the internal style sheets
  922.         if (!empty($GLOBALS['TL_CSS']) && \is_array($GLOBALS['TL_CSS']))
  923.         {
  924.             foreach (array_unique($GLOBALS['TL_CSS']) as $stylesheet)
  925.             {
  926.                 $options = StringUtil::resolveFlaggedUrl($stylesheet);
  928.                 if ($options->static)
  929.                 {
  930.                     $objCombiner->add($stylesheet, $options->mtime, $options->media);
  931.                 }
  932.                 else
  933.                 {
  934.                     $strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
  935.                 }
  936.             }
  937.         }
  939.         // Add the user style sheets
  940.         if (!empty($GLOBALS['TL_USER_CSS']) && \is_array($GLOBALS['TL_USER_CSS']))
  941.         {
  942.             foreach (array_unique($GLOBALS['TL_USER_CSS']) as $stylesheet)
  943.             {
  944.                 $options = StringUtil::resolveFlaggedUrl($stylesheet);
  946.                 if ($options->static)
  947.                 {
  948.                     $objCombiner->add($stylesheet, $options->mtime, $options->media);
  949.                 }
  950.                 else
  951.                 {
  952.                     $strScripts .= Template::generateStyleTag(static::addAssetsUrlTo($stylesheet), $options->media, $options->mtime);
  953.                 }
  954.             }
  955.         }
  957.         // Create the aggregated style sheet
  958.         if ($objCombiner->hasEntries())
  959.         {
  960.             if ($blnCombineScripts)
  961.             {
  962.                 $strScripts .= Template::generateStyleTag($objCombiner->getCombinedFile(), 'all');
  963.             }
  964.             else
  965.             {
  966.                 foreach ($objCombiner->getFileUrls() as $strUrl)
  967.                 {
  968.                     $options = StringUtil::resolveFlaggedUrl($strUrl);
  969.                     $strScripts .= Template::generateStyleTag($strUrl, $options->media, $options->mtime);
  970.                 }
  971.             }
  972.         }
  974.         $arrReplace["[[TL_CSS_$nonce]]"] = $strScripts;
  975.         $strScripts = '';
  977.         // Add the internal scripts
  978.         if (!empty($GLOBALS['TL_JAVASCRIPT']) && \is_array($GLOBALS['TL_JAVASCRIPT']))
  979.         {
  980.             $objCombiner = new Combiner();
  981.             $objCombinerAsync = new Combiner();
  983.             foreach (array_unique($GLOBALS['TL_JAVASCRIPT']) as $javascript)
  984.             {
  985.                 $options = StringUtil::resolveFlaggedUrl($javascript);
  987.                 if ($options->static)
  988.                 {
  989.                     $options->async ? $objCombinerAsync->add($javascript, $options->mtime) : $objCombiner->add($javascript, $options->mtime);
  990.                 }
  991.                 else
  992.                 {
  993.                     $strScripts .= Template::generateScriptTag(static::addAssetsUrlTo($javascript), $options->async, $options->mtime);
  994.                 }
  995.             }
  997.             // Create the aggregated script and add it before the non-static scripts (see #4890)
  998.             if ($objCombiner->hasEntries())
  999.             {
  1000.                 if ($blnCombineScripts)
  1001.                 {
  1002.                     $strScripts = Template::generateScriptTag($objCombiner->getCombinedFile()) . $strScripts;
  1003.                 }
  1004.                 else
  1005.                 {
  1006.                     $arrReversed = array_reverse($objCombiner->getFileUrls());
  1008.                     foreach ($arrReversed as $strUrl)
  1009.                     {
  1010.                         $options = StringUtil::resolveFlaggedUrl($strUrl);
  1011.                         $strScripts = Template::generateScriptTag($strUrl, false, $options->mtime) . $strScripts;
  1012.                     }
  1013.                 }
  1014.             }
  1016.             if ($objCombinerAsync->hasEntries())
  1017.             {
  1018.                 if ($blnCombineScripts)
  1019.                 {
  1020.                     $strScripts = Template::generateScriptTag($objCombinerAsync->getCombinedFile(), true) . $strScripts;
  1021.                 }
  1022.                 else
  1023.                 {
  1024.                     $arrReversed = array_reverse($objCombinerAsync->getFileUrls());
  1026.                     foreach ($arrReversed as $strUrl)
  1027.                     {
  1028.                         $options = StringUtil::resolveFlaggedUrl($strUrl);
  1029.                         $strScripts = Template::generateScriptTag($strUrl, true, $options->mtime) . $strScripts;
  1030.                     }
  1031.                 }
  1032.             }
  1033.         }
  1035.         // Add the internal <head> tags
  1036.         if (!empty($GLOBALS['TL_HEAD']) && \is_array($GLOBALS['TL_HEAD']))
  1037.         {
  1038.             foreach (array_unique($GLOBALS['TL_HEAD']) as $head)
  1039.             {
  1040.                 $strScripts .= $head;
  1041.             }
  1042.         }
  1044.         $arrReplace["[[TL_HEAD_$nonce]]"] = $strScripts;
  1046.         return str_replace(array_keys($arrReplace), $arrReplace, $strBuffer);
  1047.     }
  1049.     /**
  1050.      * Compile the margin format definition based on an array of values
  1051.      *
  1052.      * @param array  $arrValues An array of four values and a unit
  1053.      * @param string $strType   Either "margin" or "padding"
  1054.      *
  1055.      * @return string The CSS markup
  1056.      *
  1057.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  1058.      */
  1059.     public static function generateMargin($arrValues, $strType='margin')
  1060.     {
  1061.         trigger_deprecation('contao/core-bundle', '4.13', 'Using Contao\Controller::generateMargin is deprecated since Contao 4.13 and will be removed in Contao 5.');
  1063.         // Initialize an empty array (see #5217)
  1064.         if (!\is_array($arrValues))
  1065.         {
  1066.             $arrValues = array('top'=>'', 'right'=>'', 'bottom'=>'', 'left'=>'', 'unit'=>'');
  1067.         }
  1069.         $top = $arrValues['top'];
  1070.         $right = $arrValues['right'];
  1071.         $bottom = $arrValues['bottom'];
  1072.         $left = $arrValues['left'];
  1074.         // Try to shorten the definition
  1075.         if ($top && $right && $bottom && $left)
  1076.         {
  1077.             if ($top == $right && $top == $bottom && $top == $left)
  1078.             {
  1079.                 return $strType . ':' . $top . $arrValues['unit'] . ';';
  1080.             }
  1082.             if ($top == $bottom && $right == $left)
  1083.             {
  1084.                 return $strType . ':' . $top . $arrValues['unit'] . ' ' . $left . $arrValues['unit'] . ';';
  1085.             }
  1087.             if ($top != $bottom && $right == $left)
  1088.             {
  1089.                 return $strType . ':' . $top . $arrValues['unit'] . ' ' . $right . $arrValues['unit'] . ' ' . $bottom . $arrValues['unit'] . ';';
  1090.             }
  1092.             return $strType . ':' . $top . $arrValues['unit'] . ' ' . $right . $arrValues['unit'] . ' ' . $bottom . $arrValues['unit'] . ' ' . $left . $arrValues['unit'] . ';';
  1093.         }
  1095.         $return = array();
  1096.         $arrDir = compact('top', 'right', 'bottom', 'left');
  1098.         foreach ($arrDir as $k=>$v)
  1099.         {
  1100.             if ($v)
  1101.             {
  1102.                 $return[] = $strType . '-' . $k . ':' . $v . $arrValues['unit'] . ';';
  1103.             }
  1104.         }
  1106.         return implode('', $return);
  1107.     }
  1109.     /**
  1110.      * Add a request string to the current URL
  1111.      *
  1112.      * @param string  $strRequest The string to be added
  1113.      * @param boolean $blnAddRef  Add the referer ID
  1114.      * @param array   $arrUnset   An optional array of keys to unset
  1115.      *
  1116.      * @return string The new URL
  1117.      */
  1118.     public static function addToUrl($strRequest, $blnAddRef=true, $arrUnset=array())
  1119.     {
  1120.         $pairs = array();
  1121.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  1123.         if ($request->server->has('QUERY_STRING'))
  1124.         {
  1125.             $cacheKey = md5($request->server->get('QUERY_STRING'));
  1127.             if (!isset(static::$arrQueryCache[$cacheKey]))
  1128.             {
  1129.                 parse_str($request->server->get('QUERY_STRING'), $pairs);
  1130.                 ksort($pairs);
  1132.                 static::$arrQueryCache[$cacheKey] = $pairs;
  1133.             }
  1135.             $pairs = static::$arrQueryCache[$cacheKey];
  1136.         }
  1138.         // Remove the request token and referer ID
  1139.         unset($pairs['rt'], $pairs['ref'], $pairs['revise']);
  1141.         foreach ($arrUnset as $key)
  1142.         {
  1143.             unset($pairs[$key]);
  1144.         }
  1146.         // Merge the request string to be added
  1147.         if ($strRequest)
  1148.         {
  1149.             parse_str(str_replace('&amp;', '&', $strRequest), $newPairs);
  1150.             $pairs = array_merge($pairs, $newPairs);
  1151.         }
  1153.         // Add the referer ID
  1154.         if ($request->query->has('ref') || ($strRequest && $blnAddRef))
  1155.         {
  1156.             $pairs['ref'] = $request->attributes->get('_contao_referer_id');
  1157.         }
  1159.         $uri = '';
  1161.         if (!empty($pairs))
  1162.         {
  1163.             $uri = '?' . http_build_query($pairs, '', '&amp;', PHP_QUERY_RFC3986);
  1164.         }
  1166.         return TL_SCRIPT . $uri;
  1167.     }
  1169.     /**
  1170.      * Reload the current page
  1171.      */
  1172.     public static function reload()
  1173.     {
  1174.         static::redirect(Environment::get('uri'));
  1175.     }
  1177.     /**
  1178.      * Redirect to another page
  1179.      *
  1180.      * @param string  $strLocation The target URL
  1181.      * @param integer $intStatus   The HTTP status code (defaults to 303)
  1182.      */
  1183.     public static function redirect($strLocation, $intStatus=303)
  1184.     {
  1185.         $strLocation = str_replace('&amp;', '&', $strLocation);
  1186.         $strLocation = static::replaceOldBePaths($strLocation);
  1188.         // Make the location an absolute URL
  1189.         if (!preg_match('@^https?://@i', $strLocation))
  1190.         {
  1191.             $strLocation = Environment::get('base') . ltrim($strLocation, '/');
  1192.         }
  1194.         // Ajax request
  1195.         if (Environment::get('isAjaxRequest'))
  1196.         {
  1197.             throw new AjaxRedirectResponseException($strLocation);
  1198.         }
  1200.         throw new RedirectResponseException($strLocation, $intStatus);
  1201.     }
  1203.     /**
  1204.      * Replace the old back end paths
  1205.      *
  1206.      * @param string $strContext The context
  1207.      *
  1208.      * @return string The modified context
  1209.      */
  1210.     protected static function replaceOldBePaths($strContext)
  1211.     {
  1212.         $arrCache = &self::$arrOldBePathCache;
  1214.         $arrMapper = array
  1215.         (
  1216.             'contao/confirm.php'   => 'contao_backend_confirm',
  1217.             'contao/file.php'      => 'contao_backend_file',
  1218.             'contao/help.php'      => 'contao_backend_help',
  1219.             'contao/index.php'     => 'contao_backend_login',
  1220.             'contao/main.php'      => 'contao_backend',
  1221.             'contao/page.php'      => 'contao_backend_page',
  1222.             'contao/password.php'  => 'contao_backend_password',
  1223.             'contao/popup.php'     => 'contao_backend_popup',
  1224.             'contao/preview.php'   => 'contao_backend_preview',
  1225.         );
  1227.         $replace = static function ($matches) use ($arrMapper, &$arrCache)
  1228.         {
  1229.             $key = $matches[0];
  1231.             if (!isset($arrCache[$key]))
  1232.             {
  1233.                 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.');
  1235.                 $router = System::getContainer()->get('router');
  1236.                 $arrCache[$key] = substr($router->generate($arrMapper[$key]), \strlen(Environment::get('path')) + 1);
  1237.             }
  1239.             return $arrCache[$key];
  1240.         };
  1242.         $regex = '(' . implode('|', array_map('preg_quote', array_keys($arrMapper))) . ')';
  1244.         return preg_replace_callback($regex, $replace, $strContext);
  1245.     }
  1247.     /**
  1248.      * Generate a front end URL
  1249.      *
  1250.      * @param array   $arrRow       An array of page parameters
  1251.      * @param string  $strParams    An optional string of URL parameters
  1252.      * @param string  $strForceLang Force a certain language
  1253.      * @param boolean $blnFixDomain Check the domain of the target page and append it if necessary
  1254.      *
  1255.      * @return string A URL that can be used in the front end
  1256.      *
  1257.      * @deprecated Deprecated since Contao 4.2, to be removed in Contao 5.0.
  1258.      *             Use PageModel::getFrontendUrl() instead.
  1259.      */
  1260.     public static function generateFrontendUrl(array $arrRow, $strParams=null, $strForceLang=null, $blnFixDomain=false)
  1261.     {
  1262.         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.');
  1264.         $page = new PageModel();
  1265.         $page->preventSaving(false);
  1266.         $page->setRow($arrRow);
  1268.         if (!isset($arrRow['rootId']))
  1269.         {
  1270.             $page->loadDetails();
  1272.             foreach (array('domain', 'rootLanguage', 'rootUseSSL') as $key)
  1273.             {
  1274.                 if (isset($arrRow[$key]))
  1275.                 {
  1276.                     $page->$key = $arrRow[$key];
  1277.                 }
  1278.                 else
  1279.                 {
  1280.                     $arrRow[$key] = $page->$key;
  1281.                 }
  1282.             }
  1283.         }
  1285.         // Set the language
  1286.         if ($strForceLang !== null)
  1287.         {
  1288.             $strForceLang = LocaleUtil::formatAsLocale($strForceLang);
  1290.             $page->language = $strForceLang;
  1291.             $page->rootLanguage = $strForceLang;
  1293.             if (System::getContainer()->getParameter('contao.legacy_routing'))
  1294.             {
  1295.                 $page->urlPrefix = System::getContainer()->getParameter('contao.prepend_locale') ? $strForceLang : '';
  1296.             }
  1297.         }
  1299.         // Add the domain if it differs from the current one (see #3765 and #6927)
  1300.         if ($blnFixDomain)
  1301.         {
  1302.             $page->domain = $arrRow['domain'];
  1303.             $page->rootUseSSL = (bool) $arrRow['rootUseSSL'];
  1304.         }
  1306.         $objRouter = System::getContainer()->get('router');
  1307.         $strUrl = $objRouter->generate(PageRoute::PAGE_BASED_ROUTE_NAME, array(RouteObjectInterface::CONTENT_OBJECT => $page, 'parameters' => $strParams));
  1309.         // Remove path from absolute URLs
  1310.         if (0 === strncmp($strUrl, '/', 1) && 0 !== strncmp($strUrl, '//', 2))
  1311.         {
  1312.             $strUrl = substr($strUrl, \strlen(Environment::get('path')) + 1);
  1313.         }
  1315.         // Decode sprintf placeholders
  1316.         if (strpos($strParams, '%') !== false)
  1317.         {
  1318.             $arrMatches = array();
  1319.             preg_match_all('/%([sducoxXbgGeEfF])/', $strParams, $arrMatches);
  1321.             foreach (array_unique($arrMatches[1]) as $v)
  1322.             {
  1323.                 $strUrl = str_replace('%25' . $v, '%' . $v, $strUrl);
  1324.             }
  1325.         }
  1327.         // HOOK: add custom logic
  1328.         if (isset($GLOBALS['TL_HOOKS']['generateFrontendUrl']) && \is_array($GLOBALS['TL_HOOKS']['generateFrontendUrl']))
  1329.         {
  1330.             foreach ($GLOBALS['TL_HOOKS']['generateFrontendUrl'] as $callback)
  1331.             {
  1332.                 $strUrl = static::importStatic($callback[0])->{$callback[1]}($arrRow, $strParams, $strUrl);
  1333.             }
  1334.         }
  1336.         return $strUrl;
  1337.     }
  1339.     /**
  1340.      * Convert relative URLs in href and src attributes to absolute URLs
  1341.      *
  1342.      * @param string  $strContent  The text with the URLs to be converted
  1343.      * @param string  $strBase     An optional base URL
  1344.      * @param boolean $blnHrefOnly If true, only href attributes will be converted
  1345.      *
  1346.      * @return string The text with the replaced URLs
  1347.      */
  1348.     public static function convertRelativeUrls($strContent, $strBase='', $blnHrefOnly=false)
  1349.     {
  1350.         if (!$strBase)
  1351.         {
  1352.             $strBase = Environment::get('base');
  1353.         }
  1355.         $search = $blnHrefOnly ? 'href' : 'href|src';
  1356.         $arrUrls = preg_split('/((' . $search . ')="([^"]+)")/i', $strContent, -1, PREG_SPLIT_DELIM_CAPTURE);
  1357.         $strContent = '';
  1359.         for ($i=0, $c=\count($arrUrls); $i<$c; $i+=4)
  1360.         {
  1361.             $strContent .= $arrUrls[$i];
  1363.             if (!isset($arrUrls[$i+2]))
  1364.             {
  1365.                 continue;
  1366.             }
  1368.             $strAttribute = $arrUrls[$i+2];
  1369.             $strUrl = $arrUrls[$i+3];
  1371.             if (!preg_match('@^(?:[a-z0-9]+:|#)@i', $strUrl))
  1372.             {
  1373.                 $strUrl = $strBase . (($strUrl != '/') ? $strUrl : '');
  1374.             }
  1376.             $strContent .= $strAttribute . '="' . $strUrl . '"';
  1377.         }
  1379.         return $strContent;
  1380.     }
  1382.     /**
  1383.      * Send a file to the browser so the "save as …" dialogue opens
  1384.      *
  1385.      * @param string  $strFile The file path
  1386.      * @param boolean $inline  Show the file in the browser instead of opening the download dialog
  1387.      *
  1388.      * @throws AccessDeniedException
  1389.      */
  1390.     public static function sendFileToBrowser($strFile, $inline=false)
  1391.     {
  1392.         // Make sure there are no attempts to hack the file system
  1393.         if (preg_match('@^\.+@', $strFile) || preg_match('@\.+/@', $strFile) || preg_match('@(://)+@', $strFile))
  1394.         {
  1395.             throw new PageNotFoundException('Invalid file name');
  1396.         }
  1398.         // Limit downloads to the files directory
  1399.         if (!preg_match('@^' . preg_quote(System::getContainer()->getParameter('contao.upload_path'), '@') . '@i', $strFile))
  1400.         {
  1401.             throw new PageNotFoundException('Invalid path');
  1402.         }
  1404.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  1406.         // Check whether the file exists
  1407.         if (!file_exists($projectDir . '/' . $strFile))
  1408.         {
  1409.             throw new PageNotFoundException('File not found');
  1410.         }
  1412.         $objFile = new File($strFile);
  1413.         $arrAllowedTypes = StringUtil::trimsplit(',', strtolower(Config::get('allowedDownload')));
  1415.         // Check whether the file type is allowed to be downloaded
  1416.         if (!\in_array($objFile->extension, $arrAllowedTypes))
  1417.         {
  1418.             throw new AccessDeniedException(sprintf('File type "%s" is not allowed', $objFile->extension));
  1419.         }
  1421.         // HOOK: post download callback
  1422.         if (isset($GLOBALS['TL_HOOKS']['postDownload']) && \is_array($GLOBALS['TL_HOOKS']['postDownload']))
  1423.         {
  1424.             foreach ($GLOBALS['TL_HOOKS']['postDownload'] as $callback)
  1425.             {
  1426.                 static::importStatic($callback[0])->{$callback[1]}($strFile);
  1427.             }
  1428.         }
  1430.         // Send the file (will stop the script execution)
  1431.         $objFile->sendToBrowser('', $inline);
  1432.     }
  1434.     /**
  1435.      * Load a set of DCA files
  1436.      *
  1437.      * @param string  $strTable   The table name
  1438.      * @param boolean $blnNoCache If true, the cache will be bypassed
  1439.      */
  1440.     public static function loadDataContainer($strTable, $blnNoCache=false)
  1441.     {
  1442.         if (\func_num_args() > 1)
  1443.         {
  1444.             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__);
  1445.         }
  1447.         $loader = new DcaLoader($strTable);
  1448.         $loader->load(...($blnNoCache ? array(true) : array()));
  1449.     }
  1451.     /**
  1452.      * Do not name this "reset" because it might result in conflicts with child classes
  1453.      * @see https://github.com/contao/contao/issues/4257
  1454.      *
  1455.      * @internal
  1456.      */
  1457.     public static function resetControllerCache()
  1458.     {
  1459.         self::$arrQueryCache = array();
  1460.         self::$arrOldBePathCache = array();
  1461.     }
  1463.     /**
  1464.      * Redirect to a front end page
  1465.      *
  1466.      * @param integer $intPage    The page ID
  1467.      * @param string  $strArticle An optional article alias
  1468.      * @param boolean $blnReturn  If true, return the URL and don't redirect
  1469.      *
  1470.      * @return string The URL of the target page
  1471.      */
  1472.     protected function redirectToFrontendPage($intPage, $strArticle=null, $blnReturn=false)
  1473.     {
  1474.         if (($intPage = (int) $intPage) <= 0)
  1475.         {
  1476.             return '';
  1477.         }
  1479.         $objPage = PageModel::findWithDetails($intPage);
  1481.         if ($objPage === null)
  1482.         {
  1483.             return '';
  1484.         }
  1486.         $strParams = null;
  1488.         // Add the /article/ fragment (see #673)
  1489.         if ($strArticle !== null && ($objArticle = ArticleModel::findByAlias($strArticle)) !== null)
  1490.         {
  1491.             $strParams = '/articles/' . (($objArticle->inColumn != 'main') ? $objArticle->inColumn . ':' : '') . $strArticle;
  1492.         }
  1494.         $strUrl = $objPage->getPreviewUrl($strParams);
  1496.         if (!$blnReturn)
  1497.         {
  1498.             $this->redirect($strUrl);
  1499.         }
  1501.         return $strUrl;
  1502.     }
  1504.     /**
  1505.      * Get the parent records of an entry and return them as string which can
  1506.      * be used in a log message
  1507.      *
  1508.      * @param string  $strTable The table name
  1509.      * @param integer $intId    The record ID
  1510.      *
  1511.      * @return string A string that can be used in a log message
  1512.      */
  1513.     protected function getParentEntries($strTable, $intId)
  1514.     {
  1515.         // No parent table
  1516.         if (empty($GLOBALS['TL_DCA'][$strTable]['config']['ptable']))
  1517.         {
  1518.             return '';
  1519.         }
  1521.         $arrParent = array();
  1523.         do
  1524.         {
  1525.             // Get the pid
  1526.             $objParent = $this->Database->prepare("SELECT pid FROM " . $strTable . " WHERE id=?")
  1527.                                         ->limit(1)
  1528.                                         ->execute($intId);
  1530.             if ($objParent->numRows < 1)
  1531.             {
  1532.                 break;
  1533.             }
  1535.             // Store the parent table information
  1536.             $strTable = $GLOBALS['TL_DCA'][$strTable]['config']['ptable'];
  1537.             $intId = $objParent->pid;
  1539.             // Add the log entry
  1540.             $arrParent[] = $strTable . '.id=' . $intId;
  1542.             // Load the data container of the parent table
  1543.             $this->loadDataContainer($strTable);
  1544.         }
  1545.         while ($intId && !empty($GLOBALS['TL_DCA'][$strTable]['config']['ptable']));
  1547.         if (empty($arrParent))
  1548.         {
  1549.             return '';
  1550.         }
  1552.         return ' (parent records: ' . implode(', ', $arrParent) . ')';
  1553.     }
  1555.     /**
  1556.      * Take an array of file paths and eliminate the nested ones
  1557.      *
  1558.      * @param array $arrPaths The array of file paths
  1559.      *
  1560.      * @return array The file paths array without the nested paths
  1561.      */
  1562.     protected function eliminateNestedPaths($arrPaths)
  1563.     {
  1564.         $arrPaths = array_filter($arrPaths);
  1566.         if (empty($arrPaths) || !\is_array($arrPaths))
  1567.         {
  1568.             return array();
  1569.         }
  1571.         $nested = array();
  1573.         foreach ($arrPaths as $path)
  1574.         {
  1575.             $nested[] = preg_grep('/^' . preg_quote($path, '/') . '\/.+/', $arrPaths);
  1576.         }
  1578.         if (!empty($nested))
  1579.         {
  1580.             $nested = array_merge(...$nested);
  1581.         }
  1583.         return array_values(array_diff($arrPaths, $nested));
  1584.     }
  1586.     /**
  1587.      * Take an array of pages and eliminate the nested ones
  1588.      *
  1589.      * @param array   $arrPages   The array of page IDs
  1590.      * @param string  $strTable   The table name
  1591.      * @param boolean $blnSorting True if the table has a sorting field
  1592.      *
  1593.      * @return array The page IDs array without the nested IDs
  1594.      */
  1595.     protected function eliminateNestedPages($arrPages, $strTable=null, $blnSorting=false)
  1596.     {
  1597.         if (empty($arrPages) || !\is_array($arrPages))
  1598.         {
  1599.             return array();
  1600.         }
  1602.         if (!$strTable)
  1603.         {
  1604.             $strTable = 'tl_page';
  1605.         }
  1607.         // Thanks to Andreas Schempp (see #2475 and #3423)
  1608.         $arrPages = array_intersect($arrPages, $this->Database->getChildRecords(0, $strTable, $blnSorting));
  1609.         $arrPages = array_values(array_diff($arrPages, $this->Database->getChildRecords($arrPages, $strTable, $blnSorting)));
  1611.         return $arrPages;
  1612.     }
  1614.     /**
  1615.      * Add an image to a template
  1616.      *
  1617.      * @param object          $template                The template object to add the image to
  1618.      * @param array           $rowData                 The element or module as array
  1619.      * @param integer|null    $maxWidth                An optional maximum width of the image
  1620.      * @param string|null     $lightboxGroupIdentifier An optional lightbox group identifier
  1621.      * @param FilesModel|null $filesModel              An optional files model
  1622.      *
  1623.      * @deprecated Deprecated since Contao 4.11, to be removed in Contao 5.0;
  1624.      *             use the Contao\CoreBundle\Image\Studio\FigureBuilder instead.
  1625.      */
  1626.     public static function addImageToTemplate($template, array $rowData, $maxWidth = null, $lightboxGroupIdentifier = null, FilesModel $filesModel = null): void
  1627.     {
  1628.         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.');
  1630.         // Helper: Create metadata from the specified row data
  1631.         $createMetadataOverwriteFromRowData = static function (bool $interpretAsContentModel) use ($rowData)
  1632.         {
  1633.             if ($interpretAsContentModel)
  1634.             {
  1635.                 // This will be null if "overwriteMeta" is not set
  1636.                 return (new ContentModel())->setRow($rowData)->getOverwriteMetadata();
  1637.             }
  1639.             // Manually create metadata that always contains certain properties (BC)
  1640.             return new Metadata(array(
  1641.                 Metadata::VALUE_ALT => $rowData['alt'] ?? '',
  1642.                 Metadata::VALUE_TITLE => $rowData['imageTitle'] ?? '',
  1643.                 Metadata::VALUE_URL => System::getContainer()->get('contao.insert_tag.parser')->replaceInline($rowData['imageUrl'] ?? ''),
  1644.                 'linkTitle' => (string) ($rowData['linkTitle'] ?? ''),
  1645.             ));
  1646.         };
  1648.         // Helper: Create fallback template data with (mostly) empty fields (used if resource acquisition fails)
  1649.         $createFallBackTemplateData = static function () use ($filesModel, $rowData)
  1650.         {
  1651.             $templateData = array(
  1652.                 'width' => null,
  1653.                 'height' => null,
  1654.                 'picture' => array(
  1655.                     'img' => array(
  1656.                         'src' => '',
  1657.                         'srcset' => '',
  1658.                     ),
  1659.                     'sources' => array(),
  1660.                     'alt' => '',
  1661.                     'title' => '',
  1662.                 ),
  1663.                 'singleSRC' => $rowData['singleSRC'],
  1664.                 'src' => '',
  1665.                 'linkTitle' => '',
  1666.                 'margin' => '',
  1667.                 'addImage' => true,
  1668.                 'addBefore' => true,
  1669.                 'fullsize' => false,
  1670.             );
  1672.             if (null !== $filesModel)
  1673.             {
  1674.                 // Set empty metadata
  1675.                 $templateData = array_replace_recursive(
  1676.                     $templateData,
  1677.                     array(
  1678.                         'alt' => '',
  1679.                         'caption' => '',
  1680.                         'imageTitle' => '',
  1681.                         'imageUrl' => '',
  1682.                     )
  1683.                 );
  1684.             }
  1686.             return $templateData;
  1687.         };
  1689.         // Helper: Get size and margins and handle legacy $maxWidth option
  1690.         $getSizeAndMargin = static function () use ($rowData, $maxWidth)
  1691.         {
  1692.             $size = $rowData['size'] ?? null;
  1693.             $margin = StringUtil::deserialize($rowData['imagemargin'] ?? null);
  1694.             $maxWidth = (int) ($maxWidth ?? Config::get('maxImageWidth'));
  1696.             if (0 === $maxWidth)
  1697.             {
  1698.                 return array($size, $margin);
  1699.             }
  1701.             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.');
  1703.             // Adjust margins if needed
  1704.             if ('px' === ($margin['unit'] ?? null))
  1705.             {
  1706.                 $horizontalMargin = (int) ($margin['left'] ?? 0) + (int) ($margin['right'] ?? 0);
  1708.                 if ($maxWidth - $horizontalMargin < 1)
  1709.                 {
  1710.                     $margin['left'] = '';
  1711.                     $margin['right'] = '';
  1712.                 }
  1713.                 else
  1714.                 {
  1715.                     $maxWidth -= $horizontalMargin;
  1716.                 }
  1717.             }
  1719.             // Normalize size
  1720.             if ($size instanceof PictureConfiguration)
  1721.             {
  1722.                 return array($size, $margin);
  1723.             }
  1725.             $size = StringUtil::deserialize($size);
  1727.             if (is_numeric($size))
  1728.             {
  1729.                 $size = array(0, 0, (int) $size);
  1730.             }
  1731.             else
  1732.             {
  1733.                 $size = (\is_array($size) ? $size : array()) + array(0, 0, 'crop');
  1734.                 $size[0] = (int) $size[0];
  1735.                 $size[1] = (int) $size[1];
  1736.             }
  1738.             // Adjust image size configuration if it exceeds the max width
  1739.             if ($size[0] > 0 && $size[1] > 0)
  1740.             {
  1741.                 list($width, $height) = $size;
  1742.             }
  1743.             else
  1744.             {
  1745.                 $container = System::getContainer();
  1747.                 /** @var BoxInterface $originalSize */
  1748.                 $originalSize = $container
  1749.                     ->get('contao.image.factory')
  1750.                     ->create($container->getParameter('kernel.project_dir') . '/' . $rowData['singleSRC'])
  1751.                     ->getDimensions()
  1752.                     ->getSize();
  1754.                 $width = $originalSize->getWidth();
  1755.                 $height = $originalSize->getHeight();
  1756.             }
  1758.             if ($width <= $maxWidth)
  1759.             {
  1760.                 return array($size, $margin);
  1761.             }
  1763.             $size[0] = $maxWidth;
  1764.             $size[1] = (int) floor($maxWidth * ($height / $width));
  1766.             return array($size, $margin);
  1767.         };
  1769.         $figureBuilder = System::getContainer()->get('contao.image.studio')->createFigureBuilder();
  1771.         // Set image resource
  1772.         if (null !== $filesModel)
  1773.         {
  1774.             // Make sure model points to the same resource (BC)
  1775.             $filesModel = clone $filesModel;
  1776.             $filesModel->path = $rowData['singleSRC'];
  1778.             // Use source + metadata from files model (if not overwritten)
  1779.             $figureBuilder
  1780.                 ->fromFilesModel($filesModel)
  1781.                 ->setMetadata($createMetadataOverwriteFromRowData(true));
  1783.             $includeFullMetadata = true;
  1784.         }
  1785.         else
  1786.         {
  1787.             // Always ignore file metadata when building from path (BC)
  1788.             $figureBuilder
  1789.                 ->fromPath($rowData['singleSRC'], false)
  1790.                 ->setMetadata($createMetadataOverwriteFromRowData(false));
  1792.             $includeFullMetadata = false;
  1793.         }
  1795.         // Set size and lightbox configuration
  1796.         list($size, $margin) = $getSizeAndMargin();
  1798.         $lightboxSize = StringUtil::deserialize($rowData['lightboxSize'] ?? null) ?: null;
  1800.         $figure = $figureBuilder
  1801.             ->setSize($size)
  1802.             ->setLightboxGroupIdentifier($lightboxGroupIdentifier)
  1803.             ->setLightboxSize($lightboxSize)
  1804.             ->enableLightbox((bool) ($rowData['fullsize'] ?? false))
  1805.             ->buildIfResourceExists();
  1807.         if (null === $figure)
  1808.         {
  1809.             System::getContainer()->get('monolog.logger.contao.error')->error('Image "' . $rowData['singleSRC'] . '" could not be processed: ' . $figureBuilder->getLastException()->getMessage());
  1811.             // Fall back to apply a sparse data set instead of failing (BC)
  1812.             foreach ($createFallBackTemplateData() as $key => $value)
  1813.             {
  1814.                 $template->$key = $value;
  1815.             }
  1817.             return;
  1818.         }
  1820.         // Build result and apply it to the template
  1821.         $figure->applyLegacyTemplateData($template, $margin, $rowData['floating'] ?? null, $includeFullMetadata);
  1823.         // Fall back to manually specified link title or empty string if not set (backwards compatibility)
  1824.         $template->linkTitle ??= StringUtil::specialchars($rowData['title'] ?? '');
  1825.     }
  1827.     /**
  1828.      * Add enclosures to a template
  1829.      *
  1830.      * @param object $objTemplate The template object to add the enclosures to
  1831.      * @param array  $arrItem     The element or module as array
  1832.      * @param string $strKey      The name of the enclosures field in $arrItem
  1833.      */
  1834.     public static function addEnclosuresToTemplate($objTemplate, $arrItem, $strKey='enclosure')
  1835.     {
  1836.         $arrEnclosures = StringUtil::deserialize($arrItem[$strKey]);
  1838.         if (empty($arrEnclosures) || !\is_array($arrEnclosures))
  1839.         {
  1840.             return;
  1841.         }
  1843.         $objFiles = FilesModel::findMultipleByUuids($arrEnclosures);
  1845.         if ($objFiles === null)
  1846.         {
  1847.             return;
  1848.         }
  1850.         $file = Input::get('file', true);
  1852.         // Send the file to the browser and do not send a 404 header (see #5178)
  1853.         if ($file)
  1854.         {
  1855.             while ($objFiles->next())
  1856.             {
  1857.                 if ($file == $objFiles->path)
  1858.                 {
  1859.                     static::sendFileToBrowser($file);
  1860.                 }
  1861.             }
  1863.             $objFiles->reset();
  1864.         }
  1866.         /** @var PageModel $objPage */
  1867.         global $objPage;
  1869.         $arrEnclosures = array();
  1870.         $allowedDownload = StringUtil::trimsplit(',', strtolower(Config::get('allowedDownload')));
  1871.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  1873.         // Add download links
  1874.         while ($objFiles->next())
  1875.         {
  1876.             if ($objFiles->type == 'file')
  1877.             {
  1878.                 if (!\in_array($objFiles->extension, $allowedDownload) || !is_file($projectDir . '/' . $objFiles->path))
  1879.                 {
  1880.                     continue;
  1881.                 }
  1883.                 $objFile = new File($objFiles->path);
  1884.                 $strHref = Environment::get('request');
  1886.                 // Remove an existing file parameter (see #5683)
  1887.                 if (preg_match('/(&(amp;)?|\?)file=/', $strHref))
  1888.                 {
  1889.                     $strHref = preg_replace('/(&(amp;)?|\?)file=[^&]+/', '', $strHref);
  1890.                 }
  1892.                 $strHref .= ((strpos($strHref, '?') !== false) ? '&amp;' : '?') . 'file=' . System::urlEncode($objFiles->path);
  1894.                 $arrMeta = Frontend::getMetaData($objFiles->meta, $objPage->language);
  1896.                 if (empty($arrMeta) && $objPage->rootFallbackLanguage !== null)
  1897.                 {
  1898.                     $arrMeta = Frontend::getMetaData($objFiles->meta, $objPage->rootFallbackLanguage);
  1899.                 }
  1901.                 // Use the file name as title if none is given
  1902.                 if (empty($arrMeta['title']))
  1903.                 {
  1904.                     $arrMeta['title'] = StringUtil::specialchars($objFile->basename);
  1905.                 }
  1907.                 $arrEnclosures[] = array
  1908.                 (
  1909.                     'id'        => $objFiles->id,
  1910.                     'uuid'      => $objFiles->uuid,
  1911.                     'name'      => $objFile->basename,
  1912.                     'title'     => StringUtil::specialchars(sprintf($GLOBALS['TL_LANG']['MSC']['download'], $objFile->basename)),
  1913.                     'link'      => $arrMeta['title'],
  1914.                     'caption'   => $arrMeta['caption'] ?? null,
  1915.                     'href'      => $strHref,
  1916.                     'filesize'  => static::getReadableSize($objFile->filesize),
  1917.                     'icon'      => Image::getPath($objFile->icon),
  1918.                     'mime'      => $objFile->mime,
  1919.                     'meta'      => $arrMeta,
  1920.                     'extension' => $objFile->extension,
  1921.                     'path'      => $objFile->dirname,
  1922.                     'enclosure' => $objFiles->path // backwards compatibility
  1923.                 );
  1924.             }
  1925.         }
  1927.         // Order the enclosures
  1928.         if (!empty($arrItem['orderEnclosure']))
  1929.         {
  1930.             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.');
  1932.             $arrEnclosures = ArrayUtil::sortByOrderField($arrEnclosures, $arrItem['orderEnclosure']);
  1933.         }
  1935.         $objTemplate->enclosure = $arrEnclosures;
  1936.     }
  1938.     /**
  1939.      * Set the static URL constants
  1940.      *
  1941.      * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
  1942.      */
  1943.     public static function setStaticUrls()
  1944.     {
  1945.         if (\defined('TL_FILES_URL'))
  1946.         {
  1947.             return;
  1948.         }
  1950.         if (\func_num_args() > 0)
  1951.         {
  1952.             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.');
  1954.             if (!isset($GLOBALS['objPage']))
  1955.             {
  1956.                 $GLOBALS['objPage'] = func_get_arg(0);
  1957.             }
  1958.         }
  1960.         \define('TL_ASSETS_URL', System::getContainer()->get('contao.assets.assets_context')->getStaticUrl());
  1961.         \define('TL_FILES_URL', System::getContainer()->get('contao.assets.files_context')->getStaticUrl());
  1963.         // Deprecated since Contao 4.0, to be removed in Contao 5.0
  1964.         \define('TL_SCRIPT_URL', TL_ASSETS_URL);
  1965.         \define('TL_PLUGINS_URL', TL_ASSETS_URL);
  1966.     }
  1968.     /**
  1969.      * Add a static URL to a script
  1970.      *
  1971.      * @param string             $script  The script path
  1972.      * @param ContaoContext|null $context
  1973.      *
  1974.      * @return string The script path with the static URL
  1975.      */
  1976.     public static function addStaticUrlTo($script, ContaoContext $context = null)
  1977.     {
  1978.         // Absolute URLs
  1979.         if (preg_match('@^https?://@', $script))
  1980.         {
  1981.             return $script;
  1982.         }
  1984.         if ($context === null)
  1985.         {
  1986.             $context = System::getContainer()->get('contao.assets.assets_context');
  1987.         }
  1989.         if ($strStaticUrl = $context->getStaticUrl())
  1990.         {
  1991.             return $strStaticUrl . $script;
  1992.         }
  1994.         return $script;
  1995.     }
  1997.     /**
  1998.      * Add the assets URL to a script
  1999.      *
  2000.      * @param string $script The script path
  2001.      *
  2002.      * @return string The script path with the assets URL
  2003.      */
  2004.     public static function addAssetsUrlTo($script)
  2005.     {
  2006.         return static::addStaticUrlTo($script, System::getContainer()->get('contao.assets.assets_context'));
  2007.     }
  2009.     /**
  2010.      * Add the files URL to a script
  2011.      *
  2012.      * @param string $script The script path
  2013.      *
  2014.      * @return string The script path with the files URL
  2015.      */
  2016.     public static function addFilesUrlTo($script)
  2017.     {
  2018.         return static::addStaticUrlTo($script, System::getContainer()->get('contao.assets.files_context'));
  2019.     }
  2021.     /**
  2022.      * Return the current theme as string
  2023.      *
  2024.      * @return string The name of the theme
  2025.      *
  2026.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2027.      *             Use Backend::getTheme() instead.
  2028.      */
  2029.     public static function getTheme()
  2030.     {
  2031.         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.');
  2033.         return Backend::getTheme();
  2034.     }
  2036.     /**
  2037.      * Return the back end themes as array
  2038.      *
  2039.      * @return array An array of available back end themes
  2040.      *
  2041.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2042.      *             Use Backend::getThemes() instead.
  2043.      */
  2044.     public static function getBackendThemes()
  2045.     {
  2046.         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.');
  2048.         return Backend::getThemes();
  2049.     }
  2051.     /**
  2052.      * Get the details of a page including inherited parameters
  2053.      *
  2054.      * @param mixed $intId A page ID or a Model object
  2055.      *
  2056.      * @return PageModel The page model or null
  2057.      *
  2058.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2059.      *             Use PageModel::findWithDetails() or PageModel->loadDetails() instead.
  2060.      */
  2061.     public static function getPageDetails($intId)
  2062.     {
  2063.         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.');
  2065.         if ($intId instanceof PageModel)
  2066.         {
  2067.             return $intId->loadDetails();
  2068.         }
  2070.         if ($intId instanceof Collection)
  2071.         {
  2072.             /** @var PageModel $objPage */
  2073.             $objPage = $intId->current();
  2075.             return $objPage->loadDetails();
  2076.         }
  2078.         if (\is_object($intId))
  2079.         {
  2080.             $strKey = __METHOD__ . '-' . $intId->id;
  2082.             // Try to load from cache
  2083.             if (Cache::has($strKey))
  2084.             {
  2085.                 return Cache::get($strKey);
  2086.             }
  2088.             // Create a model from the database result
  2089.             $objPage = new PageModel();
  2090.             $objPage->setRow($intId->row());
  2091.             $objPage->loadDetails();
  2093.             Cache::set($strKey, $objPage);
  2095.             return $objPage;
  2096.         }
  2098.         // Invalid ID
  2099.         if ($intId < 1 || !\strlen($intId))
  2100.         {
  2101.             return null;
  2102.         }
  2104.         $strKey = __METHOD__ . '-' . $intId;
  2106.         // Try to load from cache
  2107.         if (Cache::has($strKey))
  2108.         {
  2109.             return Cache::get($strKey);
  2110.         }
  2112.         $objPage = PageModel::findWithDetails($intId);
  2114.         Cache::set($strKey, $objPage);
  2116.         return $objPage;
  2117.     }
  2119.     /**
  2120.      * Remove old XML files from the share directory
  2121.      *
  2122.      * @param boolean $blnReturn If true, only return the finds and don't delete
  2123.      *
  2124.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2125.      *             Use Automator::purgeXmlFiles() instead.
  2126.      */
  2127.     protected function removeOldFeeds($blnReturn=false)
  2128.     {
  2129.         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.');
  2131.         $this->import(Automator::class, 'Automator');
  2132.         $this->Automator->purgeXmlFiles($blnReturn);
  2133.     }
  2135.     /**
  2136.      * Return true if a class exists (tries to autoload the class)
  2137.      *
  2138.      * @param string $strClass The class name
  2139.      *
  2140.      * @return boolean True if the class exists
  2141.      *
  2142.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2143.      *             Use the PHP function class_exists() instead.
  2144.      */
  2145.     protected function classFileExists($strClass)
  2146.     {
  2147.         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.');
  2149.         return class_exists($strClass);
  2150.     }
  2152.     /**
  2153.      * Restore basic entities
  2154.      *
  2155.      * @param string $strBuffer The string with the tags to be replaced
  2156.      *
  2157.      * @return string The string with the original entities
  2158.      *
  2159.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2160.      *             Use StringUtil::restoreBasicEntities() instead.
  2161.      */
  2162.     public static function restoreBasicEntities($strBuffer)
  2163.     {
  2164.         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.');
  2166.         return StringUtil::restoreBasicEntities($strBuffer);
  2167.     }
  2169.     /**
  2170.      * Resize an image and crop it if necessary
  2171.      *
  2172.      * @param string  $image  The image path
  2173.      * @param integer $width  The target width
  2174.      * @param integer $height The target height
  2175.      * @param string  $mode   An optional resize mode
  2176.      *
  2177.      * @return boolean True if the image has been resized correctly
  2178.      *
  2179.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2180.      *             Use Image::resize() instead.
  2181.      */
  2182.     protected function resizeImage($image, $width, $height, $mode='')
  2183.     {
  2184.         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.');
  2186.         return Image::resize($image, $width, $height, $mode);
  2187.     }
  2189.     /**
  2190.      * Resize an image and crop it if necessary
  2191.      *
  2192.      * @param string  $image  The image path
  2193.      * @param integer $width  The target width
  2194.      * @param integer $height The target height
  2195.      * @param string  $mode   An optional resize mode
  2196.      * @param string  $target An optional target to be replaced
  2197.      * @param boolean $force  Override existing target images
  2198.      *
  2199.      * @return string|null The image path or null
  2200.      *
  2201.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2202.      *             Use Image::get() instead.
  2203.      */
  2204.     protected function getImage($image, $width, $height, $mode='', $target=null, $force=false)
  2205.     {
  2206.         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.');
  2208.         return Image::get($image, $width, $height, $mode, $target, $force);
  2209.     }
  2211.     /**
  2212.      * Generate an image tag and return it as string
  2213.      *
  2214.      * @param string $src        The image path
  2215.      * @param string $alt        An optional alt attribute
  2216.      * @param string $attributes A string of other attributes
  2217.      *
  2218.      * @return string The image HTML tag
  2219.      *
  2220.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2221.      *             Use Image::getHtml() instead.
  2222.      */
  2223.     public static function generateImage($src, $alt='', $attributes='')
  2224.     {
  2225.         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.');
  2227.         return Image::getHtml($src, $alt, $attributes);
  2228.     }
  2230.     /**
  2231.      * Return the date picker string (see #3218)
  2232.      *
  2233.      * @return boolean
  2234.      *
  2235.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2236.      *             Specify "datepicker"=>true in your DCA file instead.
  2237.      */
  2238.     protected function getDatePickerString()
  2239.     {
  2240.         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.');
  2242.         return true;
  2243.     }
  2245.     /**
  2246.      * Return the installed back end languages as array
  2247.      *
  2248.      * @return array An array of available back end languages
  2249.      *
  2250.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2251.      *             Use the Contao\CoreBundle\Intl\Locales service instead.
  2252.      */
  2253.     protected function getBackendLanguages()
  2254.     {
  2255.         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.');
  2257.         return $this->getLanguages(true);
  2258.     }
  2260.     /**
  2261.      * Parse simple tokens that can be used to personalize newsletters
  2262.      *
  2263.      * @param string $strBuffer The text with the tokens to be replaced
  2264.      * @param array  $arrData   The replacement data as array
  2265.      *
  2266.      * @return string The text with the replaced tokens
  2267.      *
  2268.      * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0;
  2269.      *             Use the contao.string.simple_token_parser service instead.
  2270.      */
  2271.     protected function parseSimpleTokens($strBuffer, $arrData)
  2272.     {
  2273.         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.');
  2275.         return System::getContainer()->get('contao.string.simple_token_parser')->parse($strBuffer, $arrData);
  2276.     }
  2278.     /**
  2279.      * Convert a DCA file configuration to be used with widgets
  2280.      *
  2281.      * @param array  $arrData  The field configuration array
  2282.      * @param string $strName  The field name in the form
  2283.      * @param mixed  $varValue The field value
  2284.      * @param string $strField The field name in the database
  2285.      * @param string $strTable The table name
  2286.      *
  2287.      * @return array An array that can be passed to a widget
  2288.      *
  2289.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2290.      *             Use Widget::getAttributesFromDca() instead.
  2291.      */
  2292.     protected function prepareForWidget($arrData, $strName, $varValue=null, $strField='', $strTable='')
  2293.     {
  2294.         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.');
  2296.         return Widget::getAttributesFromDca($arrData, $strName, $varValue, $strField, $strTable);
  2297.     }
  2299.     /**
  2300.      * Return the IDs of all child records of a particular record (see #2475)
  2301.      *
  2302.      * @param mixed   $arrParentIds An array of parent IDs
  2303.      * @param string  $strTable     The table name
  2304.      * @param boolean $blnSorting   True if the table has a sorting field
  2305.      * @param array   $arrReturn    The array to be returned
  2306.      * @param string  $strWhere     Additional WHERE condition
  2307.      *
  2308.      * @return array An array of child record IDs
  2309.      *
  2310.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2311.      *             Use Database::getChildRecords() instead.
  2312.      */
  2313.     protected function getChildRecords($arrParentIds, $strTable, $blnSorting=false, $arrReturn=array(), $strWhere='')
  2314.     {
  2315.         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.');
  2317.         return $this->Database->getChildRecords($arrParentIds, $strTable, $blnSorting, $arrReturn, $strWhere);
  2318.     }
  2320.     /**
  2321.      * Return the IDs of all parent records of a particular record
  2322.      *
  2323.      * @param integer $intId    The ID of the record
  2324.      * @param string  $strTable The table name
  2325.      *
  2326.      * @return array An array of parent record IDs
  2327.      *
  2328.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2329.      *             Use Database::getParentRecords() instead.
  2330.      */
  2331.     protected function getParentRecords($intId, $strTable)
  2332.     {
  2333.         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.');
  2335.         return $this->Database->getParentRecords($intId, $strTable);
  2336.     }
  2338.     /**
  2339.      * Print an article as PDF and stream it to the browser
  2340.      *
  2341.      * @param ModuleModel $objArticle An article object
  2342.      *
  2343.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2344.      *             Use ModuleArticle->generatePdf() instead.
  2345.      */
  2346.     protected function printArticleAsPdf($objArticle)
  2347.     {
  2348.         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.');
  2350.         $objArticle = new ModuleArticle($objArticle);
  2351.         $objArticle->generatePdf();
  2352.     }
  2354.     /**
  2355.      * Return all page sections as array
  2356.      *
  2357.      * @return array An array of active page sections
  2358.      *
  2359.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2360.      *             See https://github.com/contao/core/issues/4693.
  2361.      */
  2362.     public static function getPageSections()
  2363.     {
  2364.         trigger_deprecation('contao/core-bundle', '4.0', 'Using "Contao\Controller::getPageSections()" has been deprecated and will no longer work in Contao 5.0.');
  2366.         return array('header', 'left', 'right', 'main', 'footer');
  2367.     }
  2369.     /**
  2370.      * Return a "selected" attribute if the option is selected
  2371.      *
  2372.      * @param string $strOption The option to check
  2373.      * @param mixed  $varValues One or more values to check against
  2374.      *
  2375.      * @return string The attribute or an empty string
  2376.      *
  2377.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2378.      *             Use Widget::optionSelected() instead.
  2379.      */
  2380.     public static function optionSelected($strOption, $varValues)
  2381.     {
  2382.         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.');
  2384.         return Widget::optionSelected($strOption, $varValues);
  2385.     }
  2387.     /**
  2388.      * Return a "checked" attribute if the option is checked
  2389.      *
  2390.      * @param string $strOption The option to check
  2391.      * @param mixed  $varValues One or more values to check against
  2392.      *
  2393.      * @return string The attribute or an empty string
  2394.      *
  2395.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2396.      *             Use Widget::optionChecked() instead.
  2397.      */
  2398.     public static function optionChecked($strOption, $varValues)
  2399.     {
  2400.         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.');
  2402.         return Widget::optionChecked($strOption, $varValues);
  2403.     }
  2405.     /**
  2406.      * Find a content element in the TL_CTE array and return the class name
  2407.      *
  2408.      * @param string $strName The content element name
  2409.      *
  2410.      * @return string The class name
  2411.      *
  2412.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2413.      *             Use ContentElement::findClass() instead.
  2414.      */
  2415.     public static function findContentElement($strName)
  2416.     {
  2417.         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.');
  2419.         return ContentElement::findClass($strName);
  2420.     }
  2422.     /**
  2423.      * Find a front end module in the FE_MOD array and return the class name
  2424.      *
  2425.      * @param string $strName The front end module name
  2426.      *
  2427.      * @return string The class name
  2428.      *
  2429.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2430.      *             Use Module::findClass() instead.
  2431.      */
  2432.     public static function findFrontendModule($strName)
  2433.     {
  2434.         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.');
  2436.         return Module::findClass($strName);
  2437.     }
  2439.     /**
  2440.      * Create an initial version of a record
  2441.      *
  2442.      * @param string  $strTable The table name
  2443.      * @param integer $intId    The ID of the element to be versioned
  2444.      *
  2445.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2446.      *             Use Versions->initialize() instead.
  2447.      */
  2448.     protected function createInitialVersion($strTable, $intId)
  2449.     {
  2450.         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.');
  2452.         $objVersions = new Versions($strTable, $intId);
  2453.         $objVersions->initialize();
  2454.     }
  2456.     /**
  2457.      * Create a new version of a record
  2458.      *
  2459.      * @param string  $strTable The table name
  2460.      * @param integer $intId    The ID of the element to be versioned
  2461.      *
  2462.      * @deprecated Deprecated since Contao 4.0, to be removed in Contao 5.0.
  2463.      *             Use Versions->create() instead.
  2464.      */
  2465.     protected function createNewVersion($strTable, $intId)
  2466.     {
  2467.         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.');
  2469.         $objVersions = new Versions($strTable, $intId);
  2470.         $objVersions->create();
  2471.     }
  2473.     /**
  2474.      * Return the files matching a GLOB pattern
  2475.      *
  2476.      * @param string $pattern
  2477.      *
  2478.      * @return array|false
  2479.      */
  2480.     protected static function braceGlob($pattern)
  2481.     {
  2482.         // Use glob() if possible
  2483.         if (false === strpos($pattern, '/**/') && (\defined('GLOB_BRACE') || false === strpos($pattern, '{')))
  2484.         {
  2485.             return glob($pattern, \defined('GLOB_BRACE') ? GLOB_BRACE : 0);
  2486.         }
  2488.         $finder = new Finder();
  2489.         $regex = Glob::toRegex($pattern);
  2491.         // All files in the given template folder
  2492.         $filesIterator = $finder
  2493.             ->files()
  2494.             ->followLinks()
  2495.             ->sortByName()
  2496.             ->in(\dirname($pattern))
  2497.         ;
  2499.         // Match the actual regex and filter the files
  2500.         $filesIterator = $filesIterator->filter(static function (\SplFileInfo $info) use ($regex)
  2501.         {
  2502.             $path = $info->getPathname();
  2504.             return preg_match($regex, $path) && $info->isFile();
  2505.         });
  2507.         $files = iterator_to_array($filesIterator);
  2509.         return array_keys($files);
  2510.     }
  2511. }
  2513. class_alias(Controller::class, 'Controller');