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

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