vendor/contao/core-bundle/src/Resources/contao/modules/Module.php line 209

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\Security\ContaoCorePermissions;
  14. use Contao\Model\Collection;
  15. use Symfony\Component\Routing\Exception\ExceptionInterface;
  17. /**
  18.  * Parent class for front end modules.
  19.  *
  20.  * @property integer $id
  21.  * @property integer $pid
  22.  * @property integer $tstamp
  23.  * @property string  $name
  24.  * @property string  $headline
  25.  * @property string  $type
  26.  * @property integer $levelOffset
  27.  * @property integer $showLevel
  28.  * @property boolean $hardLimit
  29.  * @property boolean $showProtected
  30.  * @property boolean $defineRoot
  31.  * @property integer $rootPage
  32.  * @property string  $navigationTpl
  33.  * @property string  $customTpl
  34.  * @property array   $pages
  35.  * @property boolean $showHidden
  36.  * @property string  $customLabel
  37.  * @property boolean $autologin
  38.  * @property integer $jumpTo
  39.  * @property boolean $redirectBack
  40.  * @property string  $cols
  41.  * @property array   $editable
  42.  * @property string  $memberTpl
  43.  * @property integer $form
  44.  * @property string  $queryType
  45.  * @property boolean $fuzzy
  46.  * @property string  $contextLength
  47.  * @property integer $minKeywordLength
  48.  * @property integer $perPage
  49.  * @property string  $searchType
  50.  * @property string  $searchTpl
  51.  * @property string  $inColumn
  52.  * @property integer $skipFirst
  53.  * @property boolean $loadFirst
  54.  * @property string  $singleSRC
  55.  * @property string  $url
  56.  * @property string  $imgSize
  57.  * @property boolean $useCaption
  58.  * @property boolean $fullsize
  59.  * @property string  $multiSRC
  60.  * @property string  $orderSRC
  61.  * @property string  $html
  62.  * @property integer $rss_cache
  63.  * @property string  $rss_feed
  64.  * @property string  $rss_template
  65.  * @property integer $numberOfItems
  66.  * @property boolean $disableCaptcha
  67.  * @property string  $reg_groups
  68.  * @property boolean $reg_allowLogin
  69.  * @property boolean $reg_skipName
  70.  * @property string  $reg_close
  71.  * @property boolean $reg_assignDir
  72.  * @property string  $reg_homeDir
  73.  * @property boolean $reg_activate
  74.  * @property integer $reg_jumpTo
  75.  * @property string  $reg_text
  76.  * @property string  $reg_password
  77.  * @property boolean $protected
  78.  * @property string  $groups
  79.  * @property string  $cssID
  80.  * @property string  $hl
  81.  *
  82.  * @author Leo Feyer <https://github.com/leofeyer>
  83.  */
  84. abstract class Module extends Frontend
  85. {
  86.     /**
  87.      * Template
  88.      * @var string
  89.      */
  90.     protected $strTemplate;
  92.     /**
  93.      * Column
  94.      * @var string
  95.      */
  96.     protected $strColumn;
  98.     /**
  99.      * Model
  100.      * @var ModuleModel
  101.      */
  102.     protected $objModel;
  104.     /**
  105.      * Current record
  106.      * @var array
  107.      */
  108.     protected $arrData = array();
  110.     /**
  111.      * Style array
  112.      * @var array
  113.      */
  114.     protected $arrStyle = array();
  116.     /**
  117.      * Initialize the object
  118.      *
  119.      * @param ModuleModel $objModule
  120.      * @param string      $strColumn
  121.      */
  122.     public function __construct($objModule, $strColumn='main')
  123.     {
  124.         if ($objModule instanceof Model || $objModule instanceof Collection)
  125.         {
  126.             /** @var ModuleModel $objModel */
  127.             $objModel = $objModule;
  129.             if ($objModel instanceof Collection)
  130.             {
  131.                 $objModel = $objModel->current();
  132.             }
  134.             $this->objModel = $objModel;
  135.         }
  137.         parent::__construct();
  139.         $this->arrData = $objModule->row();
  140.         $this->cssID = StringUtil::deserialize($objModule->cssID, true);
  142.         if ($this->customTpl)
  143.         {
  144.             $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  146.             // Use the custom template unless it is a back end request
  147.             if (!$request || !System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  148.             {
  149.                 $this->strTemplate = $this->customTpl;
  150.             }
  151.         }
  153.         $arrHeadline = StringUtil::deserialize($objModule->headline);
  154.         $this->headline = \is_array($arrHeadline) ? $arrHeadline['value'] : $arrHeadline;
  155.         $this->hl = \is_array($arrHeadline) ? $arrHeadline['unit'] : 'h1';
  156.         $this->strColumn = $strColumn;
  157.     }
  159.     /**
  160.      * Set an object property
  161.      *
  162.      * @param string $strKey
  163.      * @param mixed  $varValue
  164.      */
  165.     public function __set($strKey, $varValue)
  166.     {
  167.         $this->arrData[$strKey] = $varValue;
  168.     }
  170.     /**
  171.      * Return an object property
  172.      *
  173.      * @param string $strKey
  174.      *
  175.      * @return mixed
  176.      */
  177.     public function __get($strKey)
  178.     {
  179.         return $this->arrData[$strKey] ?? parent::__get($strKey);
  180.     }
  182.     /**
  183.      * Check whether a property is set
  184.      *
  185.      * @param string $strKey
  186.      *
  187.      * @return boolean
  188.      */
  189.     public function __isset($strKey)
  190.     {
  191.         return isset($this->arrData[$strKey]);
  192.     }
  194.     /**
  195.      * Return the model
  196.      *
  197.      * @return Model
  198.      */
  199.     public function getModel()
  200.     {
  201.         return $this->objModel;
  202.     }
  204.     /**
  205.      * Parse the template
  206.      *
  207.      * @return string
  208.      */
  209.     public function generate()
  210.     {
  211.         $this->Template = new FrontendTemplate($this->strTemplate);
  212.         $this->Template->setData($this->arrData);
  214.         $this->compile();
  216.         // Do not change this order (see #6191)
  217.         $this->Template->style = !empty($this->arrStyle) ? implode(' ', $this->arrStyle) : '';
  218.         $this->Template->class = trim('mod_' . $this->type . ' ' . ($this->cssID[1] ?? ''));
  219.         $this->Template->cssID = !empty($this->cssID[0]) ? ' id="' . $this->cssID[0] . '"' : '';
  221.         $this->Template->inColumn = $this->strColumn;
  223.         if (!$this->Template->headline)
  224.         {
  225.             $this->Template->headline = $this->headline;
  226.         }
  228.         if (!$this->Template->hl)
  229.         {
  230.             $this->Template->hl = $this->hl;
  231.         }
  233.         if (!empty($this->objModel->classes) && \is_array($this->objModel->classes))
  234.         {
  235.             $this->Template->class .= ' ' . implode(' ', $this->objModel->classes);
  236.         }
  238.         // Tag the module (see #2137)
  239.         if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger') && !empty($tags = $this->getResponseCacheTags()))
  240.         {
  241.             $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  242.             $responseTagger->addTags($tags);
  243.         }
  245.         return $this->Template->parse();
  246.     }
  248.     /**
  249.      * Compile the current element
  250.      */
  251.     abstract protected function compile();
  253.     /**
  254.      * Get a list of tags that should be applied to the response when calling generate().
  255.      */
  256.     protected function getResponseCacheTags(): array
  257.     {
  258.         return array('contao.db.tl_module.' . $this->id);
  259.     }
  261.     /**
  262.      * Recursively compile the navigation menu and return it as HTML string
  263.      *
  264.      * @param integer $pid
  265.      * @param integer $level
  266.      * @param string  $host
  267.      * @param string  $language
  268.      *
  269.      * @return string
  270.      */
  271.     protected function renderNavigation($pid, $level=1, $host=null, $language=null)
  272.     {
  273.         // Get all active subpages
  274.         $arrSubpages = static::getPublishedSubpagesByPid($pid, $this->showHidden, $this instanceof ModuleSitemap);
  276.         if ($arrSubpages === null)
  277.         {
  278.             return '';
  279.         }
  281.         $items = array();
  282.         $security = System::getContainer()->get('security.helper');
  283.         $isMember = $security->isGranted('ROLE_MEMBER');
  285.         $objTemplate = new FrontendTemplate($this->navigationTpl ?: 'nav_default');
  286.         $objTemplate->pid = $pid;
  287.         $objTemplate->type = static::class;
  288.         $objTemplate->cssID = $this->cssID; // see #4897
  289.         $objTemplate->level = 'level_' . $level++;
  290.         $objTemplate->module = $this; // see #155
  292.         /** @var PageModel $objPage */
  293.         global $objPage;
  295.         // Browse subpages
  296.         foreach ($arrSubpages as list('page' => $objSubpage, 'hasSubpages' => $blnHasSubpages))
  297.         {
  298.             // Skip hidden sitemap pages
  299.             if ($this instanceof ModuleSitemap && $objSubpage->sitemap == 'map_never')
  300.             {
  301.                 continue;
  302.             }
  304.             $objSubpage->loadDetails();
  306.             // Override the domain (see #3765)
  307.             if ($host !== null)
  308.             {
  309.                 $objSubpage->domain = $host;
  310.             }
  312.             if ($objSubpage->tabindex > 0)
  313.             {
  314.                 trigger_deprecation('contao/core-bundle', '4.12', 'Using a tabindex value greater than 0 has been deprecated and will no longer work in Contao 5.0.');
  315.             }
  317.             // Hide the page if it is not protected and only visible to guests (backwards compatibility)
  318.             if ($objSubpage->guests && !$objSubpage->protected && $isMember)
  319.             {
  320.                 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.');
  321.                 continue;
  322.             }
  324.             $subitems = '';
  326.             // PageModel->groups is an array after calling loadDetails()
  327.             if (!$objSubpage->protected || $this->showProtected || ($this instanceof ModuleSitemap && $objSubpage->sitemap == 'map_always') || $security->isGranted(ContaoCorePermissions::MEMBER_IN_GROUPS, $objSubpage->groups))
  328.             {
  329.                 // Check whether there will be subpages
  330.                 if ($blnHasSubpages && (!$this->showLevel || $this->showLevel >= $level || (!$this->hardLimit && ($objPage->id == $objSubpage->id || \in_array($objPage->id, $this->Database->getChildRecords($objSubpage->id, 'tl_page'))))))
  331.                 {
  332.                     $subitems = $this->renderNavigation($objSubpage->id, $level, $host, $language);
  333.                 }
  335.                 // Get href
  336.                 switch ($objSubpage->type)
  337.                 {
  338.                     case 'redirect':
  339.                         $href = $objSubpage->url;
  341.                         if (strncasecmp($href, 'mailto:', 7) === 0)
  342.                         {
  343.                             $href = StringUtil::encodeEmail($href);
  344.                         }
  345.                         break;
  347.                     case 'forward':
  348.                         if ($objSubpage->jumpTo)
  349.                         {
  350.                             $objNext = PageModel::findPublishedById($objSubpage->jumpTo);
  351.                         }
  352.                         else
  353.                         {
  354.                             $objNext = PageModel::findFirstPublishedRegularByPid($objSubpage->id);
  355.                         }
  357.                         // Hide the link if the target page is invisible
  358.                         if (!$objNext instanceof PageModel || (!$objNext->loadDetails()->isPublic && !BE_USER_LOGGED_IN))
  359.                         {
  360.                             continue 2;
  361.                         }
  363.                         try
  364.                         {
  365.                             $href = $objNext->getFrontendUrl();
  366.                         }
  367.                         catch (ExceptionInterface $exception)
  368.                         {
  369.                             System::log('Unable to generate URL for page ID ' . $objSubpage->id . ': ' . $exception->getMessage(), __METHOD__, TL_ERROR);
  371.                             continue 2;
  372.                         }
  373.                         break;
  375.                     default:
  376.                         try
  377.                         {
  378.                             $href = $objSubpage->getFrontendUrl();
  379.                         }
  380.                         catch (ExceptionInterface $exception)
  381.                         {
  382.                             System::log('Unable to generate URL for page ID ' . $objSubpage->id . ': ' . $exception->getMessage(), __METHOD__, TL_ERROR);
  384.                             continue 2;
  385.                         }
  386.                         break;
  387.                 }
  389.                 $items[] = $this->compileNavigationRow($objPage, $objSubpage, $subitems, $href);
  390.             }
  391.         }
  393.         // Add classes first and last
  394.         if (!empty($items))
  395.         {
  396.             $last = \count($items) - 1;
  398.             $items[0]['class'] = trim($items[0]['class'] . ' first');
  399.             $items[$last]['class'] = trim($items[$last]['class'] . ' last');
  400.         }
  402.         $objTemplate->items = $items;
  404.         return !empty($items) ? $objTemplate->parse() : '';
  405.     }
  407.     /**
  408.      * Compile the navigation row and return it as array
  409.      *
  410.      * @param PageModel $objPage
  411.      * @param PageModel $objSubpage
  412.      * @param string    $subitems
  413.      * @param string    $href
  414.      *
  415.      * @return array
  416.      */
  417.     protected function compileNavigationRow(PageModel $objPage, PageModel $objSubpage, $subitems, $href)
  418.     {
  419.         $row = $objSubpage->row();
  420.         $trail = \in_array($objSubpage->id, $objPage->trail);
  422.         // Use the path without query string to check for active pages (see #480)
  423.         list($path) = explode('?', Environment::get('request'), 2);
  425.         // Active page
  426.         if (($objPage->id == $objSubpage->id || ($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo)) && !($this instanceof ModuleSitemap) && $href == $path)
  427.         {
  428.             // Mark active forward pages (see #4822)
  429.             $strClass = (($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo) ? 'forward' . ($trail ? ' trail' : '') : 'active') . ($subitems ? ' submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
  431.             $row['isActive'] = true;
  432.             $row['isTrail'] = false;
  433.         }
  435.         // Regular page
  436.         else
  437.         {
  438.             $strClass = ($subitems ? 'submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($trail ? ' trail' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
  440.             // Mark pages on the same level (see #2419)
  441.             if ($objSubpage->pid == $objPage->pid)
  442.             {
  443.                 $strClass .= ' sibling';
  444.             }
  446.             $row['isActive'] = false;
  447.             $row['isTrail'] = $trail;
  448.         }
  450.         $row['subitems'] = $subitems;
  451.         $row['class'] = trim($strClass);
  452.         $row['title'] = StringUtil::specialchars($objSubpage->title, true);
  453.         $row['pageTitle'] = StringUtil::specialchars($objSubpage->pageTitle, true);
  454.         $row['link'] = $objSubpage->title;
  455.         $row['href'] = $href;
  456.         $row['rel'] = '';
  457.         $row['nofollow'] = (strncmp($objSubpage->robots, 'noindex,nofollow', 16) === 0); // backwards compatibility
  458.         $row['target'] = '';
  459.         $row['description'] = str_replace(array("\n", "\r"), array(' ', ''), $objSubpage->description);
  461.         $arrRel = array();
  463.         if (strncmp($objSubpage->robots, 'noindex,nofollow', 16) === 0)
  464.         {
  465.             $arrRel[] = 'nofollow';
  466.         }
  468.         // Override the link target
  469.         if ($objSubpage->type == 'redirect' && $objSubpage->target)
  470.         {
  471.             $arrRel[] = 'noreferrer';
  472.             $arrRel[] = 'noopener';
  474.             $row['target'] = ' target="_blank"';
  475.         }
  477.         // Set the rel attribute
  478.         if (!empty($arrRel))
  479.         {
  480.             $row['rel'] = ' rel="' . implode(' ', $arrRel) . '"';
  481.         }
  483.         return $row;
  484.     }
  486.     /**
  487.      * Get all published pages by their parent ID and add the "hasSubpages" property
  488.      *
  489.      * @param integer $intPid        The parent page's ID
  490.      * @param boolean $blnShowHidden If true, hidden pages will be included
  491.      * @param boolean $blnIsSitemap  If true, the sitemap settings apply
  492.      *
  493.      * @return array<array{page:PageModel,hasSubpages:bool}>|null
  494.      */
  495.     protected static function getPublishedSubpagesByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false): ?array
  496.     {
  497.         $time = Date::floorToMinute();
  498.         $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  499.         $blnBeUserLoggedIn = $tokenChecker->hasBackendUser() && $tokenChecker->isPreviewMode();
  501.         $arrPages = Database::getInstance()->prepare("SELECT p1.id, EXISTS(SELECT * FROM tl_page p2 WHERE p2.pid=p1.id AND p2.type!='root' AND p2.type!='error_401' AND p2.type!='error_403' AND p2.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p2.hide='' OR sitemap='map_always')" : " AND p2.hide=''") : "") . (!$blnBeUserLoggedIn ? " AND p2.published='1' AND (p2.start='' OR p2.start<='$time') AND (p2.stop='' OR p2.stop>'$time')" : "") . ") AS hasSubpages FROM tl_page p1 WHERE p1.pid=? AND p1.type!='root' AND p1.type!='error_401' AND p1.type!='error_403' AND p1.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p1.hide='' OR sitemap='map_always')" : " AND p1.hide=''") : "") . (!$blnBeUserLoggedIn ? " AND p1.published='1' AND (p1.start='' OR p1.start<='$time') AND (p1.stop='' OR p1.stop>'$time')" : "") . " ORDER BY p1.sorting")
  502.                                            ->execute($intPid)
  503.                                            ->fetchAllAssoc();
  505.         if (\count($arrPages) < 1)
  506.         {
  507.             return null;
  508.         }
  510.         // Load models into the registry with a single query
  511.         PageModel::findMultipleByIds(array_map(static function ($row) { return $row['id']; }, $arrPages));
  513.         return array_map(
  514.             static function (array $row): array
  515.             {
  516.                 return array(
  517.                     'page' => PageModel::findByPk($row['id']),
  518.                     'hasSubpages' => (bool) $row['hasSubpages'],
  519.                 );
  520.             },
  521.             $arrPages
  522.         );
  523.     }
  525.     /**
  526.      * Get all published pages by their parent ID and exclude pages only visible for guests
  527.      *
  528.      * @param integer $intPid        The parent page's ID
  529.      * @param boolean $blnShowHidden If true, hidden pages will be included
  530.      * @param boolean $blnIsSitemap  If true, the sitemap settings apply
  531.      *
  532.      * @return array<array{page:PageModel,hasSubpages:bool}>|null
  533.      *
  534.      * @deprecated Deprecated since Contao 4.12, to be removed in Contao 5.0;
  535.      *             use Module::getPublishedSubpagesByPid() instead and filter the guests pages yourself.
  536.      */
  537.     protected static function getPublishedSubpagesWithoutGuestsByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false): ?array
  538.     {
  539.         @trigger_error('Using Module::getPublishedSubpagesWithoutGuestsByPid() has been deprecated and will no longer work Contao 5.0. Use Module::getPublishedSubpagesByPid() instead and filter the guests pages yourself.', E_USER_DEPRECATED);
  541.         $time = Date::floorToMinute();
  542.         $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  543.         $blnFeUserLoggedIn = $tokenChecker->hasFrontendUser();
  544.         $blnBeUserLoggedIn = $tokenChecker->hasBackendUser() && $tokenChecker->isPreviewMode();
  546.         $arrPages = Database::getInstance()->prepare("SELECT p1.id, EXISTS(SELECT * FROM tl_page p2 WHERE p2.pid=p1.id AND p2.type!='root' AND p2.type!='error_401' AND p2.type!='error_403' AND p2.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p2.hide='' OR sitemap='map_always')" : " AND p2.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p2.guests=''" : "") . (!$blnBeUserLoggedIn ? " AND p2.published='1' AND (p2.start='' OR p2.start<='$time') AND (p2.stop='' OR p2.stop>'$time')" : "") . ") AS hasSubpages FROM tl_page p1 WHERE p1.pid=? AND p1.type!='root' AND p1.type!='error_401' AND p1.type!='error_403' AND p1.type!='error_404'" . (!$blnShowHidden ? ($blnIsSitemap ? " AND (p1.hide='' OR sitemap='map_always')" : " AND p1.hide=''") : "") . ($blnFeUserLoggedIn ? " AND p1.guests=''" : "") . (!$blnBeUserLoggedIn ? " AND p1.published='1' AND (p1.start='' OR p1.start<='$time') AND (p1.stop='' OR p1.stop>'$time')" : "") . " ORDER BY p1.sorting")
  547.                                            ->execute($intPid)
  548.                                            ->fetchAllAssoc();
  550.         if (\count($arrPages) < 1)
  551.         {
  552.             return null;
  553.         }
  555.         // Load models into the registry with a single query
  556.         PageModel::findMultipleByIds(array_map(static function ($row) { return $row['id']; }, $arrPages));
  558.         return array_map(
  559.             static function (array $row): array
  560.             {
  561.                 return array(
  562.                     'page' => PageModel::findByPk($row['id']),
  563.                     'hasSubpages' => (bool) $row['hasSubpages'],
  564.                 );
  565.             },
  566.             $arrPages
  567.         );
  568.     }
  570.     /**
  571.      * Find a front end module in the FE_MOD array and return the class name
  572.      *
  573.      * @param string $strName The front end module name
  574.      *
  575.      * @return string The class name
  576.      */
  577.     public static function findClass($strName)
  578.     {
  579.         foreach ($GLOBALS['FE_MOD'] as $v)
  580.         {
  581.             foreach ($v as $kk=>$vv)
  582.             {
  583.                 if ($kk == $strName)
  584.                 {
  585.                     return $vv;
  586.                 }
  587.             }
  588.         }
  590.         return '';
  591.     }
  592. }
  594. class_alias(Module::class, 'Module');