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

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