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

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;
  18. /**
  19.  * Front end module "news reader".
  20.  *
  21.  * @property Comments $Comments
  22.  * @property string   $com_template
  23.  * @property array    $news_archives
  24.  */
  25. class ModuleNewsReader extends ModuleNews
  26. {
  27.     /**
  28.      * Template
  29.      * @var string
  30.      */
  31.     protected $strTemplate = 'mod_newsreader';
  33.     /**
  34.      * Display a wildcard in the back end
  35.      *
  36.      * @throws InternalServerErrorException
  37.      *
  38.      * @return string
  39.      */
  40.     public function generate()
  41.     {
  42.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  44.         if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  45.         {
  46.             $objTemplate = new BackendTemplate('be_wildcard');
  47.             $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['newsreader'][0] . ' ###';
  48.             $objTemplate->title = $this->headline;
  49.             $objTemplate->id = $this->id;
  50.             $objTemplate->link = $this->name;
  51.             $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
  53.             return $objTemplate->parse();
  54.         }
  56.         // Set the item from the auto_item parameter
  57.         if (!isset($_GET['items']) && isset($_GET['auto_item']) && Config::get('useAutoItem'))
  58.         {
  59.             Input::setGet('items', Input::get('auto_item'));
  60.         }
  62.         // Return an empty string if "items" is not set (to combine list and reader on same page)
  63.         if (!Input::get('items'))
  64.         {
  65.             return '';
  66.         }
  68.         $this->news_archives = $this->sortOutProtected(StringUtil::deserialize($this->news_archives));
  70.         if (empty($this->news_archives) || !\is_array($this->news_archives))
  71.         {
  72.             throw new InternalServerErrorException('The news reader ID ' . $this->id . ' has no archives specified.');
  73.         }
  75.         return parent::generate();
  76.     }
  78.     /**
  79.      * Generate the module
  80.      */
  81.     protected function compile()
  82.     {
  83.         $this->Template->articles = '';
  85.         if ($this->overviewPage)
  86.         {
  87.             $this->Template->referer = PageModel::findById($this->overviewPage)->getFrontendUrl();
  88.             $this->Template->back = $this->customLabel ?: $GLOBALS['TL_LANG']['MSC']['newsOverview'];
  89.         }
  90.         else
  91.         {
  92.             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.');
  94.             $this->Template->referer = 'javascript:history.go(-1)';
  95.             $this->Template->back = $GLOBALS['TL_LANG']['MSC']['goBack'];
  96.         }
  98.         // Get the news item
  99.         $objArticle = NewsModel::findPublishedByParentAndIdOrAlias(Input::get('items'), $this->news_archives);
  101.         // The news item does not exist (see #33)
  102.         if ($objArticle === null)
  103.         {
  104.             throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  105.         }
  107.         // Redirect if the news item has a target URL (see #1498)
  108.         switch ($objArticle->source) {
  109.             case 'internal':
  110.                 if ($page = PageModel::findPublishedById($objArticle->jumpTo))
  111.                 {
  112.                     throw new RedirectResponseException($page->getAbsoluteUrl(), 301);
  113.                 }
  115.                 throw new InternalServerErrorException('Invalid "jumpTo" value or target page not public');
  117.             case 'article':
  118.                 if (($article = ArticleModel::findByPk($objArticle->articleId)) && ($page = PageModel::findPublishedById($article->pid)))
  119.                 {
  120.                     throw new RedirectResponseException($page->getAbsoluteUrl('/articles/' . ($article->alias ?: $article->id)), 301);
  121.                 }
  123.                 throw new InternalServerErrorException('Invalid "articleId" value or target page not public');
  125.             case 'external':
  126.                 if ($objArticle->url)
  127.                 {
  128.                     throw new RedirectResponseException($objArticle->url, 301);
  129.                 }
  131.                 throw new InternalServerErrorException('Empty target URL');
  132.         }
  134.         // Set the default template
  135.         if (!$this->news_template)
  136.         {
  137.             $this->news_template = 'news_full';
  138.         }
  140.         $arrArticle = $this->parseArticle($objArticle);
  141.         $this->Template->articles = $arrArticle;
  143.         // Overwrite the page metadata (see #2853, #4955 and #87)
  144.         $responseContext = System::getContainer()->get('contao.routing.response_context_accessor')->getResponseContext();
  146.         if ($responseContext && $responseContext->has(HtmlHeadBag::class))
  147.         {
  148.             /** @var HtmlHeadBag $htmlHeadBag */
  149.             $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  150.             $htmlDecoder = System::getContainer()->get('contao.string.html_decoder');
  152.             if ($objArticle->pageTitle)
  153.             {
  154.                 $htmlHeadBag->setTitle($objArticle->pageTitle); // Already stored decoded
  155.             }
  156.             elseif ($objArticle->headline)
  157.             {
  158.                 $htmlHeadBag->setTitle($htmlDecoder->inputEncodedToPlainText($objArticle->headline));
  159.             }
  161.             if ($objArticle->description)
  162.             {
  163.                 $htmlHeadBag->setMetaDescription($htmlDecoder->inputEncodedToPlainText($objArticle->description));
  164.             }
  165.             elseif ($objArticle->teaser)
  166.             {
  167.                 $htmlHeadBag->setMetaDescription($htmlDecoder->htmlToPlainText($objArticle->teaser));
  168.             }
  170.             if ($objArticle->robots)
  171.             {
  172.                 $htmlHeadBag->setMetaRobots($objArticle->robots);
  173.             }
  174.         }
  176.         $bundles = System::getContainer()->getParameter('kernel.bundles');
  178.         // HOOK: comments extension required
  179.         if ($objArticle->noComments || !isset($bundles['ContaoCommentsBundle']))
  180.         {
  181.             $this->Template->allowComments = false;
  183.             return;
  184.         }
  186.         /** @var NewsArchiveModel $objArchive */
  187.         $objArchive = $objArticle->getRelated('pid');
  188.         $this->Template->allowComments = $objArchive->allowComments;
  190.         // Comments are not allowed
  191.         if (!$objArchive->allowComments)
  192.         {
  193.             return;
  194.         }
  196.         // Adjust the comments headline level
  197.         $intHl = min((int) str_replace('h', '', $this->hl), 5);
  198.         $this->Template->hlc = 'h' . ($intHl + 1);
  200.         $this->import(Comments::class, 'Comments');
  201.         $arrNotifies = array();
  203.         // Notify the system administrator
  204.         if ($objArchive->notify != 'notify_author')
  205.         {
  206.             $arrNotifies[] = $GLOBALS['TL_ADMIN_EMAIL'];
  207.         }
  209.         /** @var UserModel $objAuthor */
  210.         if ($objArchive->notify != 'notify_admin' && ($objAuthor = $objArticle->getRelated('author')) instanceof UserModel && $objAuthor->email)
  211.         {
  212.             $arrNotifies[] = $objAuthor->email;
  213.         }
  215.         $objConfig = new \stdClass();
  217.         $objConfig->perPage = $objArchive->perPage;
  218.         $objConfig->order = $objArchive->sortOrder;
  219.         $objConfig->template = $this->com_template;
  220.         $objConfig->requireLogin = $objArchive->requireLogin;
  221.         $objConfig->disableCaptcha = $objArchive->disableCaptcha;
  222.         $objConfig->bbcode = $objArchive->bbcode;
  223.         $objConfig->moderate = $objArchive->moderate;
  225.         $this->Comments->addCommentsToTemplate($this->Template, $objConfig, 'tl_news', $objArticle->id, $arrNotifies);
  226.     }
  227. }
  229. class_alias(ModuleNewsReader::class, 'ModuleNewsReader');