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

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 integer $overviewPage
  40. * @property boolean $redirectBack
  41. * @property string $cols
  42. * @property array $editable
  43. * @property string $memberTpl
  44. * @property integer $form
  45. * @property string $queryType
  46. * @property boolean $fuzzy
  47. * @property string $contextLength
  48. * @property integer $minKeywordLength
  49. * @property integer $perPage
  50. * @property string $searchType
  51. * @property string $searchTpl
  52. * @property string $inColumn
  53. * @property integer $skipFirst
  54. * @property boolean $loadFirst
  55. * @property string $singleSRC
  56. * @property string $url
  57. * @property string $imgSize
  58. * @property boolean $useCaption
  59. * @property boolean $fullsize
  60. * @property string $multiSRC
  61. * @property string $orderSRC
  62. * @property string $html
  63. * @property integer $rss_cache
  64. * @property string $rss_feed
  65. * @property string $rss_template
  66. * @property integer $numberOfItems
  67. * @property boolean $disableCaptcha
  68. * @property string $reg_groups
  69. * @property boolean $reg_allowLogin
  70. * @property boolean $reg_skipName
  71. * @property string $reg_close
  72. * @property boolean $reg_deleteDir
  73. * @property boolean $reg_assignDir
  74. * @property string $reg_homeDir
  75. * @property boolean $reg_activate
  76. * @property integer $reg_jumpTo
  77. * @property string $reg_text
  78. * @property string $reg_password
  79. * @property boolean $protected
  80. * @property string $groups
  81. * @property string $cssID
  82. * @property string $hl
  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. if ($this->objModel === null)
  259. {
  260. return array();
  261. }
  263. return array(System::getContainer()->get('contao.cache.entity_tags')->getTagForModelInstance($this->objModel));
  264. }
  266. /**
  267. * Recursively compile the navigation menu and return it as HTML string
  268. *
  269. * @param integer $pid
  270. * @param integer $level
  271. * @param string $host
  272. * @param string $language
  273. *
  274. * @return string
  275. */
  276. protected function renderNavigation($pid, $level=1, $host=null, $language=null)
  277. {
  278. // Get all active subpages
  279. $arrSubpages = static::getPublishedSubpagesByPid($pid, $this->showHidden, $this instanceof ModuleSitemap);
  281. if ($arrSubpages === null)
  282. {
  283. return '';
  284. }
  286. $items = array();
  287. $security = System::getContainer()->get('security.helper');
  288. $isMember = $security->isGranted('ROLE_MEMBER');
  289. $blnShowUnpublished = System::getContainer()->get('contao.security.token_checker')->isPreviewMode();
  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. $objSubpage->loadDetails();
  312. // Override the domain (see #3765)
  313. if ($host !== null)
  314. {
  315. $objSubpage->domain = $host;
  316. }
  318. if ($objSubpage->tabindex > 0)
  319. {
  320. 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.');
  321. }
  323. // Hide the page if it is not protected and only visible to guests (backwards compatibility)
  324. if ($objSubpage->guests && !$objSubpage->protected && $isMember)
  325. {
  326. 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.');
  327. continue;
  328. }
  330. $subitems = '';
  332. // PageModel->groups is an array after calling loadDetails()
  333. if (!$objSubpage->protected || $this->showProtected || ($this instanceof ModuleSitemap && $objSubpage->sitemap == 'map_always') || $security->isGranted(ContaoCorePermissions::MEMBER_IN_GROUPS, $objSubpage->groups))
  334. {
  335. // Check whether there will be subpages
  336. if ($blnHasSubpages && (!$this->showLevel || $this->showLevel >= $level || (!$this->hardLimit && ($objPage->id == $objSubpage->id || \in_array($objPage->id, $this->Database->getChildRecords($objSubpage->id, 'tl_page'))))))
  337. {
  338. $subitems = $this->renderNavigation($objSubpage->id, $level, $host, $language);
  339. }
  341. // Get href
  342. switch ($objSubpage->type)
  343. {
  344. case 'redirect':
  345. $href = $objSubpage->url;
  347. if (strncasecmp($href, 'mailto:', 7) === 0)
  348. {
  349. $href = StringUtil::encodeEmail($href);
  350. }
  351. break;
  353. case 'forward':
  354. if ($objSubpage->jumpTo)
  355. {
  356. $objNext = PageModel::findPublishedById($objSubpage->jumpTo);
  357. }
  358. else
  359. {
  360. $objNext = PageModel::findFirstPublishedRegularByPid($objSubpage->id);
  361. }
  363. // Hide the link if the target page is invisible
  364. if (!$objNext instanceof PageModel || (!$objNext->loadDetails()->isPublic && !$blnShowUnpublished))
  365. {
  366. continue 2;
  367. }
  369. try
  370. {
  371. $href = $objNext->getFrontendUrl();
  372. }
  373. catch (ExceptionInterface $exception)
  374. {
  375. continue 2;
  376. }
  377. break;
  379. default:
  380. try
  381. {
  382. $href = $objSubpage->getFrontendUrl();
  383. }
  384. catch (ExceptionInterface $exception)
  385. {
  386. continue 2;
  387. }
  388. break;
  389. }
  391. $items[] = $this->compileNavigationRow($objPage, $objSubpage, $subitems, $href);
  392. }
  393. }
  395. // Add classes first and last
  396. if (!empty($items))
  397. {
  398. $last = \count($items) - 1;
  400. $items[0]['class'] = trim($items[0]['class'] . ' first');
  401. $items[$last]['class'] = trim($items[$last]['class'] . ' last');
  402. }
  404. $objTemplate->items = $items;
  406. return !empty($items) ? $objTemplate->parse() : '';
  407. }
  409. /**
  410. * Compile the navigation row and return it as array
  411. *
  412. * @param PageModel $objPage
  413. * @param PageModel $objSubpage
  414. * @param string $subitems
  415. * @param string $href
  416. *
  417. * @return array
  418. */
  419. protected function compileNavigationRow(PageModel $objPage, PageModel $objSubpage, $subitems, $href)
  420. {
  421. $row = $objSubpage->row();
  422. $trail = \in_array($objSubpage->id, $objPage->trail);
  424. // Use the path without query string to check for active pages (see #480)
  425. list($path) = explode('?', Environment::get('request'), 2);
  427. // Active page
  428. if (($objPage->id == $objSubpage->id || ($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo)) && !($this instanceof ModuleSitemap) && $href == $path)
  429. {
  430. // Mark active forward pages (see #4822)
  431. $strClass = (($objSubpage->type == 'forward' && $objPage->id == $objSubpage->jumpTo) ? 'forward' . ($trail ? ' trail' : '') : 'active') . ($subitems ? ' submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
  433. $row['isActive'] = true;
  434. $row['isTrail'] = false;
  435. }
  437. // Regular page
  438. else
  439. {
  440. $strClass = ($subitems ? 'submenu' : '') . ($objSubpage->protected ? ' protected' : '') . ($trail ? ' trail' : '') . ($objSubpage->cssClass ? ' ' . $objSubpage->cssClass : '');
  442. // Mark pages on the same level (see #2419)
  443. if ($objSubpage->pid == $objPage->pid)
  444. {
  445. $strClass .= ' sibling';
  446. }
  448. $row['isActive'] = false;
  449. $row['isTrail'] = $trail;
  450. }
  452. $row['subitems'] = $subitems;
  453. $row['class'] = trim($strClass);
  454. $row['title'] = StringUtil::specialchars($objSubpage->title, true);
  455. $row['pageTitle'] = StringUtil::specialchars($objSubpage->pageTitle, true);
  456. $row['link'] = $objSubpage->title;
  457. $row['href'] = $href;
  458. $row['rel'] = '';
  459. $row['nofollow'] = false; // backwards compatibility
  460. $row['target'] = '';
  461. $row['description'] = str_replace(array("\n", "\r"), array(' ', ''), (string) $objSubpage->description);
  463. $arrRel = array();
  465. // Override the link target
  466. if ($objSubpage->type == 'redirect' && $objSubpage->target)
  467. {
  468. $arrRel[] = 'noreferrer';
  469. $arrRel[] = 'noopener';
  471. $row['target'] = ' target="_blank"';
  472. }
  474. // Set the rel attribute
  475. if (!empty($arrRel))
  476. {
  477. $row['rel'] = ' rel="' . implode(' ', $arrRel) . '"';
  478. }
  480. // Tag the page
  481. if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  482. {
  483. $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  484. $responseTagger->addTags(array('contao.db.tl_page.' . $objSubpage->id));
  485. }
  487. return $row;
  488. }
  490. /**
  491. * Get all published pages by their parent ID and add the "hasSubpages" property
  492. *
  493. * @param integer $intPid The parent page's ID
  494. * @param boolean $blnShowHidden If true, hidden pages will be included
  495. * @param boolean $blnIsSitemap If true, the sitemap settings apply
  496. *
  497. * @return array<array{page:PageModel,hasSubpages:bool}>|null
  498. */
  499. protected static function getPublishedSubpagesByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false): ?array
  500. {
  501. $time = Date::floorToMinute();
  502. $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  503. $blnBeUserLoggedIn = $tokenChecker->isPreviewMode();
  504. $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  506. $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 NOT IN ('" . implode("', '", $unroutableTypes) . "')" . (!$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 NOT IN ('" . implode("', '", $unroutableTypes) . "')" . (!$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")
  507. ->execute($intPid)
  508. ->fetchAllAssoc();
  510. if (\count($arrPages) < 1)
  511. {
  512. return null;
  513. }
  515. // Load models into the registry with a single query
  516. PageModel::findMultipleByIds(array_map(static function ($row) { return $row['id']; }, $arrPages));
  518. return array_map(
  519. static function (array $row): array
  520. {
  521. return array(
  522. 'page' => PageModel::findByPk($row['id']),
  523. 'hasSubpages' => (bool) $row['hasSubpages'],
  524. );
  525. },
  526. $arrPages
  527. );
  528. }
  530. /**
  531. * Get all published pages by their parent ID and exclude pages only visible for guests
  532. *
  533. * @param integer $intPid The parent page's ID
  534. * @param boolean $blnShowHidden If true, hidden pages will be included
  535. * @param boolean $blnIsSitemap If true, the sitemap settings apply
  536. *
  537. * @return array<array{page:PageModel,hasSubpages:bool}>|null
  538. *
  539. * @deprecated Deprecated since Contao 4.12, to be removed in Contao 5.0;
  540. * use Module::getPublishedSubpagesByPid() instead and filter the guests pages yourself.
  541. */
  542. protected static function getPublishedSubpagesWithoutGuestsByPid($intPid, $blnShowHidden=false, $blnIsSitemap=false): ?array
  543. {
  544. trigger_deprecation('contao/core-bundle', '4.9', 'Using Module::getPublishedSubpagesWithoutGuestsByPid() has been deprecated and will no longer work Contao 5.0. Use Module::getPublishedSubpagesByPid() instead and filter the guests pages yourself.');
  546. $time = Date::floorToMinute();
  547. $tokenChecker = System::getContainer()->get('contao.security.token_checker');
  548. $blnFeUserLoggedIn = $tokenChecker->hasFrontendUser();
  549. $blnBeUserLoggedIn = $tokenChecker->isPreviewMode();
  550. $unroutableTypes = System::getContainer()->get('contao.routing.page_registry')->getUnroutableTypes();
  552. $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 NOT IN ('" . implode("', '", $unroutableTypes) . "')" . (!$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 NOT IN ('" . implode("', '", $unroutableTypes) . "')" . (!$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")
  553. ->execute($intPid)
  554. ->fetchAllAssoc();
  556. if (\count($arrPages) < 1)
  557. {
  558. return null;
  559. }
  561. // Load models into the registry with a single query
  562. PageModel::findMultipleByIds(array_map(static function ($row) { return $row['id']; }, $arrPages));
  564. return array_map(
  565. static function (array $row): array
  566. {
  567. return array(
  568. 'page' => PageModel::findByPk($row['id']),
  569. 'hasSubpages' => (bool) $row['hasSubpages'],
  570. );
  571. },
  572. $arrPages
  573. );
  574. }
  576. /**
  577. * Find a front end module in the FE_MOD array and return the class name
  578. *
  579. * @param string $strName The front end module name
  580. *
  581. * @return string The class name
  582. */
  583. public static function findClass($strName)
  584. {
  585. foreach ($GLOBALS['FE_MOD'] as $v)
  586. {
  587. foreach ($v as $kk=>$vv)
  588. {
  589. if ($kk == $strName)
  590. {
  591. return $vv;
  592. }
  593. }
  594. }
  596. return '';
  597. }
  598. }
  600. class_alias(Module::class, 'Module');