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

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\Model\Collection;
  15. /**
  16.  * Parent class for front end modules.
  17.  *
  18.  * @property integer $id
  19.  * @property integer $pid
  20.  * @property integer $tstamp
  21.  * @property string  $name
  22.  * @property string  $headline
  23.  * @property string  $type
  24.  * @property integer $levelOffset
  25.  * @property integer $showLevel
  26.  * @property boolean $hardLimit
  27.  * @property boolean $showProtected
  28.  * @property boolean $defineRoot
  29.  * @property integer $rootPage
  30.  * @property string  $navigationTpl
  31.  * @property string  $customTpl
  32.  * @property array   $pages
  33.  * @property string  $orderPages
  34.  * @property boolean $showHidden
  35.  * @property string  $customLabel
  36.  * @property boolean $autologin
  37.  * @property integer $jumpTo
  38.  * @property boolean $redirectBack
  39.  * @property string  $cols
  40.  * @property array   $editable
  41.  * @property string  $memberTpl
  42.  * @property integer $form
  43.  * @property string  $queryType
  44.  * @property boolean $fuzzy
  45.  * @property string  $contextLength
  46.  * @property integer $minKeywordLength
  47.  * @property integer $perPage
  48.  * @property string  $searchType
  49.  * @property string  $searchTpl
  50.  * @property string  $inColumn
  51.  * @property integer $skipFirst
  52.  * @property boolean $loadFirst
  53.  * @property string  $singleSRC
  54.  * @property string  $url
  55.  * @property string  $imgSize
  56.  * @property boolean $useCaption
  57.  * @property boolean $fullsize
  58.  * @property string  $multiSRC
  59.  * @property string  $orderSRC
  60.  * @property string  $html
  61.  * @property integer $rss_cache
  62.  * @property string  $rss_feed
  63.  * @property string  $rss_template
  64.  * @property integer $numberOfItems
  65.  * @property boolean $disableCaptcha
  66.  * @property string  $reg_groups
  67.  * @property boolean $reg_allowLogin
  68.  * @property boolean $reg_skipName
  69.  * @property string  $reg_close
  70.  * @property boolean $reg_assignDir
  71.  * @property string  $reg_homeDir
  72.  * @property boolean $reg_activate
  73.  * @property integer $reg_jumpTo
  74.  * @property string  $reg_text
  75.  * @property string  $reg_password
  76.  * @property boolean $protected
  77.  * @property string  $groups
  78.  * @property boolean $guests
  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 = $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::getPublishedSubpagesWithoutGuestsByPid($pid, $this->showHidden, $this instanceof ModuleSitemap);
  276.         if ($arrSubpages === null)
  277.         {
  278.             return '';
  279.         }
  281.         $items = array();
  282.         $groups = array();
  284.         // Get all groups of the current front end user
  285.         if (System::getContainer()->get('contao.security.token_checker')->hasFrontendUser())
  286.         {
  287.             $this->import(FrontendUser::class, 'User');
  288.             $groups = $this->User->groups;
  289.         }
  291.         $objTemplate = new FrontendTemplate($this->navigationTpl ?: 'nav_default');
  292.         $objTemplate->pid = $pid;
  293.         $objTemplate->type = static::class;
  294.         $objTemplate->cssID = $this->cssID; // see #4897
  295.         $objTemplate->level = 'level_' . $level++;
  296.         $objTemplate->module = $this; // see #155
  298.         /** @var PageModel $objPage */
  299.         global $objPage;
  301.         // Browse subpages
  302.         foreach ($arrSubpages as list('page' => $objSubpage, 'hasSubpages' => $blnHasSubpages))
  303.         {
  304.             // Skip hidden sitemap pages
  305.             if ($this instanceof ModuleSitemap && $objSubpage->sitemap == 'map_never')
  306.             {
  307.                 continue;
  308.             }
  310.             $subitems = '';
  311.             $_groups = StringUtil::deserialize($objSubpage->groups);
  313.             // Override the domain (see #3765)
  314.             if ($host !== null)
  315.             {
  316.                 $objSubpage->domain = $host;
  317.             }
  319.             // Do not show protected pages unless a front end user is logged in
  320.             if (!$objSubpage->protected || $this->showProtected || ($this instanceof ModuleSitemap && $objSubpage->sitemap == 'map_always') || (\is_array($_groups) && \is_array($groups) && \count(array_intersect($_groups, $groups))))
  321.             {
  322.                 // Check whether there will be subpages
  323.                 if ($blnHasSubpages && (!$this->showLevel || $this->showLevel >= $level || (!$this->hardLimit && ($objPage->id == $objSubpage->id || \in_array($objPage->id, $this->Database->getChildRecords($objSubpage->id, 'tl_page'))))))
  324.                 {
  325.                     $subitems = $this->renderNavigation($objSubpage->id, $level, $host, $language);
  326.                 }
  328.                 // Get href
  329.                 switch ($objSubpage->type)
  330.                 {
  331.                     case 'redirect':
  332.                         $href = $objSubpage->url;
  334.                         if (strncasecmp($href, 'mailto:', 7) === 0)
  335.                         {
  336.                             $href = StringUtil::encodeEmail($href);
  337.                         }
  338.                         break;
  340.                     case 'forward':
  341.                         if ($objSubpage->jumpTo)
  342.                         {
  343.                             $objNext = PageModel::findPublishedById($objSubpage->jumpTo);
  344.                         }
  345.                         else
  346.                         {
  347.                             $objNext = PageModel::findFirstPublishedRegularByPid($objSubpage->id);
  348.                         }
  350.                         // Hide the link if the target page is invisible
  351.                         if (!$objNext instanceof PageModel || (!$objNext->loadDetails()->isPublic && !BE_USER_LOGGED_IN))
  352.                         {
  353.                             continue 2;
  354.                         }
  356.                         $href = $objNext->getFrontendUrl();
  357.                         break;
  359.                     default:
  360.                         $href = $objSubpage->getFrontendUrl();
  361.                         break;
  362.                 }
  364.                 $items[] = $this->compileNavigationRow($objPage, $objSubpage, $subitems, $href);
  365.             }
  366.         }
  368.         // Add classes first and last
  369.         if (!empty($items))
  370.         {
  371.             $last = \count($items) - 1;
  373.             $items[0]['class'] = trim($items[0]['class'] . ' first');
  374.             $items[$last]['class'] = trim($items[$last]['class'] . ' last');
  375.         }
  377.         $objTemplate->items = $items;
  379.         return !empty($items) ? $objTemplate->parse() : '';
  380.     }
  382.     /**
  383.      * Compile the navigation row and return it as array
  384.      *
  385.      * @param PageModel $objPage
  386.      * @param PageModel $objSubpage
  387.      * @param string    $subitems
  388.      * @param string    $href
  389.      *
  390.      * @return array
  391.      */
  392.     protected function compileNavigationRow(PageModel $objPage, PageModel $objSubpage, $subitems, $href)
  393.     {
  394.         $row = $objSubpage->row();
  395.         $trail = \in_array($objSubpage->id, $objPage->trail);
  397.         // Use the path without query string to check for active pages (see #480)
  398.         list($path) = explode('?', Environment::get('request'), 2);
  400.         // Active page
  401.         if (($objPage->id == $objSubpage->id || ($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo)) && !($this instanceof ModuleSitemap) && $href == $path)
  402.         {
  403.             // Mark active forward pages (see #4822)
  404.             $strClass = (($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo) ? 'forward' . ($trail ? ' trail' : '') : 'active') . ($subitems ? ' submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
  406.             $row['isActive'] = true;
  407.             $row['isTrail'] = false;
  408.         }
  410.         // Regular page
  411.         else
  412.         {
  413.             $strClass = ($subitems ? 'submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($trail ? ' trail' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
  415.             // Mark pages on the same level (see #2419)
  416.             if ($objSubpage->pid == $objPage->pid)
  417.             {
  418.                 $strClass .= ' sibling';
  419.             }
  421.             $row['isActive'] = false;
  422.             $row['isTrail'] = $trail;
  423.         }
  425.         $row['subitems'] = $subitems;
  426.         $row['class'] = trim($strClass);
  427.         $row['title'] = StringUtil::specialchars($objSubpage->title, true);
  428.         $row['pageTitle'] = StringUtil::specialchars($objSubpage->pageTitle, true);
  429.         $row['link'] = $objSubpage->title;
  430.         $row['href'] = $href;
  431.         $row['rel'] = '';
  432.         $row['nofollow'] = false; // backwards compatibility
  433.         $row['target'] = '';
  434.         $row['description'] = str_replace(array("\n", "\r"), array(' ', ''), $objSubpage->description);
  436.         $arrRel = array();
  438.         // Override the link target
  439.         if ($objSubpage->type == 'redirect' && $objSubpage->target)
  440.         {
  441.             $arrRel[] = 'noreferrer';
  442.             $arrRel[] = 'noopener';
  444.             $row['target'] = ' target="_blank"';
  445.         }
  447.         // Set the rel attribute
  448.         if (!empty($arrRel))
  449.         {
  450.             $row['rel'] = ' rel="' . implode(' ', $arrRel) . '"';
  451.         }
  453.         return $row;
  454.     }
  456.     /**
  457.      * Get all published pages by their parent ID and exclude pages only visible for guests
  458.      *
  459.      * @param integer $intPid        The parent page's ID
  460.      * @param boolean $blnShowHidden If true, hidden pages will be included
  461.      * @param boolean $blnIsSitemap  If true, the sitemap settings apply
  462.      *
  463.      * @return array<array{page:PageModel,hasSubpages:bool}>|null
  464.      */
  465.     protected static function getPublishedSubpagesWithoutGuestsByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false): ?array
  466.     {
  467.         $time = Date::floorToMinute();
  468.         $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  469.         $blnFeUserLoggedIn = $tokenChecker->hasFrontendUser();
  470.         $blnBeUserLoggedIn = $tokenChecker->hasBackendUser() && $tokenChecker->isPreviewMode();
  472.         $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")
  473.                                            ->execute($intPid)
  474.                                            ->fetchAllAssoc();
  476.         if (\count($arrPages) < 1)
  477.         {
  478.             return null;
  479.         }
  481.         // Load models into the registry with a single query
  482.         PageModel::findMultipleByIds(array_map(static function ($row) { return $row['id']; }, $arrPages));
  484.         return array_map(
  485.             static function (array $row): array
  486.             {
  487.                 return array(
  488.                     'page' => PageModel::findByPk($row['id']),
  489.                     'hasSubpages' => (bool) $row['hasSubpages'],
  490.                 );
  491.             },
  492.             $arrPages
  493.         );
  494.     }
  496.     /**
  497.      * Find a front end module in the FE_MOD array and return the class name
  498.      *
  499.      * @param string $strName The front end module name
  500.      *
  501.      * @return string The class name
  502.      */
  503.     public static function findClass($strName)
  504.     {
  505.         foreach ($GLOBALS['FE_MOD'] as $v)
  506.         {
  507.             foreach ($v as $kk=>$vv)
  508.             {
  509.                 if ($kk == $strName)
  510.                 {
  511.                     return $vv;
  512.                 }
  513.             }
  514.         }
  516.         return '';
  517.     }
  518. }
  520. class_alias(Module::class, 'Module');