vendor/contao/news-bundle/src/Resources/contao/modules/ModuleNewsReader.php line 144

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\Exception\InternalServerErrorException;
  14. use Contao\CoreBundle\Exception\PageNotFoundException;
  15. use Contao\CoreBundle\Exception\RedirectResponseException;
  16. use Contao\CoreBundle\Routing\ResponseContext\HtmlHeadBag\HtmlHeadBag;
  17. use Contao\CoreBundle\Util\UrlUtil;
  19. /**
  20. * Front end module "news reader".
  21. *
  22. * @property Comments $Comments
  23. * @property string $com_template
  24. * @property array $news_archives
  25. */
  26. class ModuleNewsReader extends ModuleNews
  27. {
  28. /**
  29. * Template
  30. * @var string
  31. */
  32. protected $strTemplate = 'mod_newsreader';
  34. /**
  35. * Display a wildcard in the back end
  36. *
  37. * @throws InternalServerErrorException
  38. *
  39. * @return string
  40. */
  41. public function generate()
  42. {
  43. $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  45. if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  46. {
  47. $objTemplate = new BackendTemplate('be_wildcard');
  48. $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['newsreader'][0] . ' ###';
  49. $objTemplate->title = $this->headline;
  50. $objTemplate->id = $this->id;
  51. $objTemplate->link = $this->name;
  52. $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
  54. return $objTemplate->parse();
  55. }
  57. // Set the item from the auto_item parameter
  58. if (!isset($_GET['items']) && isset($_GET['auto_item']) && Config::get('useAutoItem'))
  59. {
  60. Input::setGet('items', Input::get('auto_item'));
  61. }
  63. // Return an empty string if "items" is not set (to combine list and reader on same page)
  64. if (!Input::get('items'))
  65. {
  66. return '';
  67. }
  69. $this->news_archives = $this->sortOutProtected(StringUtil::deserialize($this->news_archives));
  71. if (empty($this->news_archives) || !\is_array($this->news_archives))
  72. {
  73. throw new InternalServerErrorException('The news reader ID ' . $this->id . ' has no archives specified.');
  74. }
  76. return parent::generate();
  77. }
  79. /**
  80. * Generate the module
  81. */
  82. protected function compile()
  83. {
  84. $this->Template->articles = '';
  86. if ($this->overviewPage)
  87. {
  88. $this->Template->referer = PageModel::findById($this->overviewPage)->getFrontendUrl();
  89. $this->Template->back = $this->customLabel ?: $GLOBALS['TL_LANG']['MSC']['newsOverview'];
  90. }
  91. else
  92. {
  93. trigger_deprecation('contao/news-bundle', '4.13', 'If you do not select an overview page in the news reader module, the "go back" link will no longer be shown in Contao 5.0.');
  95. $this->Template->referer = 'javascript:history.go(-1)';
  96. $this->Template->back = $GLOBALS['TL_LANG']['MSC']['goBack'];
  97. }
  99. // Get the news item
  100. $objArticle = NewsModel::findPublishedByParentAndIdOrAlias(Input::get('items'), $this->news_archives);
  102. // The news item does not exist (see #33)
  103. if ($objArticle === null)
  104. {
  105. throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  106. }
  108. // Redirect if the news item has a target URL (see #1498)
  109. switch ($objArticle->source) {
  110. case 'internal':
  111. if ($page = PageModel::findPublishedById($objArticle->jumpTo))
  112. {
  113. throw new RedirectResponseException($page->getAbsoluteUrl(), 301);
  114. }
  116. throw new InternalServerErrorException('Invalid "jumpTo" value or target page not public');
  118. case 'article':
  119. if (($article = ArticleModel::findByPk($objArticle->articleId)) && ($page = PageModel::findPublishedById($article->pid)))
  120. {
  121. throw new RedirectResponseException($page->getAbsoluteUrl('/articles/' . ($article->alias ?: $article->id)), 301);
  122. }
  124. throw new InternalServerErrorException('Invalid "articleId" value or target page not public');
  126. case 'external':
  127. if ($objArticle->url)
  128. {
  129. $url = System::getContainer()->get('contao.insert_tag.parser')->replaceInline($objArticle->url);
  130. $url = UrlUtil::makeAbsolute($url, Environment::get('base'));
  132. throw new RedirectResponseException($url, 301);
  133. }
  135. throw new InternalServerErrorException('Empty target URL');
  136. }
  138. // Set the default template
  139. if (!$this->news_template)
  140. {
  141. $this->news_template = 'news_full';
  142. }
  144. $arrArticle = $this->parseArticle($objArticle);
  145. $this->Template->articles = $arrArticle;
  147. // Overwrite the page metadata (see #2853, #4955 and #87)
  148. $responseContext = System::getContainer()->get('contao.routing.response_context_accessor')->getResponseContext();
  150. if ($responseContext && $responseContext->has(HtmlHeadBag::class))
  151. {
  152. /** @var HtmlHeadBag $htmlHeadBag */
  153. $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  154. $htmlDecoder = System::getContainer()->get('contao.string.html_decoder');
  156. if ($objArticle->pageTitle)
  157. {
  158. $htmlHeadBag->setTitle($objArticle->pageTitle); // Already stored decoded
  159. }
  160. elseif ($objArticle->headline)
  161. {
  162. $htmlHeadBag->setTitle($htmlDecoder->inputEncodedToPlainText($objArticle->headline));
  163. }
  165. if ($objArticle->description)
  166. {
  167. $htmlHeadBag->setMetaDescription($htmlDecoder->inputEncodedToPlainText($objArticle->description));
  168. }
  169. elseif ($objArticle->teaser)
  170. {
  171. $htmlHeadBag->setMetaDescription($htmlDecoder->htmlToPlainText($objArticle->teaser));
  172. }
  174. if ($objArticle->robots)
  175. {
  176. $htmlHeadBag->setMetaRobots($objArticle->robots);
  177. }
  178. }
  180. $bundles = System::getContainer()->getParameter('kernel.bundles');
  182. // HOOK: comments extension required
  183. if ($objArticle->noComments || !isset($bundles['ContaoCommentsBundle']))
  184. {
  185. $this->Template->allowComments = false;
  187. return;
  188. }
  190. /** @var NewsArchiveModel $objArchive */
  191. $objArchive = $objArticle->getRelated('pid');
  192. $this->Template->allowComments = $objArchive->allowComments;
  194. // Comments are not allowed
  195. if (!$objArchive->allowComments)
  196. {
  197. return;
  198. }
  200. // Adjust the comments headline level
  201. $intHl = min((int) str_replace('h', '', $this->hl), 5);
  202. $this->Template->hlc = 'h' . ($intHl + 1);
  204. $this->import(Comments::class, 'Comments');
  205. $arrNotifies = array();
  207. // Notify the system administrator
  208. if ($objArchive->notify != 'notify_author' && isset($GLOBALS['TL_ADMIN_EMAIL']))
  209. {
  210. $arrNotifies[] = $GLOBALS['TL_ADMIN_EMAIL'];
  211. }
  213. /** @var UserModel $objAuthor */
  214. if ($objArchive->notify != 'notify_admin' && ($objAuthor = $objArticle->getRelated('author')) instanceof UserModel && $objAuthor->email)
  215. {
  216. $arrNotifies[] = $objAuthor->email;
  217. }
  219. $objConfig = new \stdClass();
  221. $objConfig->perPage = $objArchive->perPage;
  222. $objConfig->order = $objArchive->sortOrder;
  223. $objConfig->template = $this->com_template;
  224. $objConfig->requireLogin = $objArchive->requireLogin;
  225. $objConfig->disableCaptcha = $objArchive->disableCaptcha;
  226. $objConfig->bbcode = $objArchive->bbcode;
  227. $objConfig->moderate = $objArchive->moderate;
  229. $this->Comments->addCommentsToTemplate($this->Template, $objConfig, 'tl_news', $objArticle->id, $arrNotifies);
  230. }
  231. }
  233. class_alias(ModuleNewsReader::class, 'ModuleNewsReader');