vendor/contao/calendar-bundle/src/Resources/contao/modules/ModuleEventReader.php line 41

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 "event reader".
  20.  *
  21.  * @property Comments $Comments
  22.  * @property string   $com_template
  23.  * @property string   $cal_template
  24.  * @property array    $cal_calendar
  25.  */
  26. class ModuleEventReader extends Events
  27. {
  28.     /**
  29.      * Template
  30.      * @var string
  31.      */
  32.     protected $strTemplate = 'mod_eventreader';
  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']['eventreader'][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['events']) && isset($_GET['auto_item']) && Config::get('useAutoItem'))
  59.         {
  60.             Input::setGet('events', Input::get('auto_item'));
  61.         }
  63.         // Return an empty string if "events" is not set (to combine list and reader on same page)
  64.         if (!Input::get('events'))
  65.         {
  66.             return '';
  67.         }
  69.         $this->cal_calendar = $this->sortOutProtected(StringUtil::deserialize($this->cal_calendar));
  71.         if (empty($this->cal_calendar) || !\is_array($this->cal_calendar))
  72.         {
  73.             throw new InternalServerErrorException('The event reader ID ' . $this->id . ' has no calendars specified.');
  74.         }
  76.         return parent::generate();
  77.     }
  79.     /**
  80.      * Generate the module
  81.      */
  82.     protected function compile()
  83.     {
  84.         /** @var PageModel $objPage */
  85.         global $objPage;
  87.         $this->Template->event = '';
  89.         if ($this->overviewPage)
  90.         {
  91.             $this->Template->referer = PageModel::findById($this->overviewPage)->getFrontendUrl();
  92.             $this->Template->back = $this->customLabel ?: $GLOBALS['TL_LANG']['MSC']['eventOverview'];
  93.         }
  94.         else
  95.         {
  96.             trigger_deprecation('contao/calendar-bundle', '4.13', 'If you do not select an overview page in the event reader module, the "go back" link will no longer be shown in Contao 5.0.');
  98.             $this->Template->referer = 'javascript:history.go(-1)';
  99.             $this->Template->back = $GLOBALS['TL_LANG']['MSC']['goBack'];
  100.         }
  102.         // Get the current event
  103.         $objEvent = CalendarEventsModel::findPublishedByParentAndIdOrAlias(Input::get('events'), $this->cal_calendar);
  105.         // The event does not exist (see #33)
  106.         if ($objEvent === null)
  107.         {
  108.             throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  109.         }
  111.         // Redirect if the event has a target URL (see #1498)
  112.         switch ($objEvent->source) {
  113.             case 'internal':
  114.                 if ($page = PageModel::findPublishedById($objEvent->jumpTo))
  115.                 {
  116.                     throw new RedirectResponseException($page->getAbsoluteUrl(), 301);
  117.                 }
  119.                 throw new InternalServerErrorException('Invalid "jumpTo" value or target page not public');
  121.             case 'article':
  122.                 if (($article = ArticleModel::findByPk($objEvent->articleId)) && ($page = PageModel::findPublishedById($article->pid)))
  123.                 {
  124.                     throw new RedirectResponseException($page->getAbsoluteUrl('/articles/' . ($article->alias ?: $article->id)), 301);
  125.                 }
  127.                 throw new InternalServerErrorException('Invalid "articleId" value or target page not public');
  129.             case 'external':
  130.                 if ($objEvent->url)
  131.                 {
  132.                     throw new RedirectResponseException($objEvent->url, 301);
  133.                 }
  135.                 throw new InternalServerErrorException('Empty target URL');
  136.         }
  138.         // Overwrite the page metadata (see #2853, #4955 and #87)
  139.         $responseContext = System::getContainer()->get('contao.routing.response_context_accessor')->getResponseContext();
  141.         if ($responseContext && $responseContext->has(HtmlHeadBag::class))
  142.         {
  143.             /** @var HtmlHeadBag $htmlHeadBag */
  144.             $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  145.             $htmlDecoder = System::getContainer()->get('contao.string.html_decoder');
  147.             if ($objEvent->pageTitle)
  148.             {
  149.                 $htmlHeadBag->setTitle($objEvent->pageTitle); // Already stored decoded
  150.             }
  151.             elseif ($objEvent->title)
  152.             {
  153.                 $htmlHeadBag->setTitle($htmlDecoder->inputEncodedToPlainText($objEvent->title));
  154.             }
  156.             if ($objEvent->description)
  157.             {
  158.                 $htmlHeadBag->setMetaDescription($htmlDecoder->inputEncodedToPlainText($objEvent->description));
  159.             }
  160.             elseif ($objEvent->teaser)
  161.             {
  162.                 $htmlHeadBag->setMetaDescription($htmlDecoder->htmlToPlainText($objEvent->teaser));
  163.             }
  165.             if ($objEvent->robots)
  166.             {
  167.                 $htmlHeadBag->setMetaRobots($objEvent->robots);
  168.             }
  169.         }
  171.         $intStartTime = $objEvent->startTime;
  172.         $intEndTime = $objEvent->endTime;
  173.         $span = Calendar::calculateSpan($intStartTime, $intEndTime);
  175.         // Do not show dates in the past if the event is recurring (see #923)
  176.         if ($objEvent->recurring)
  177.         {
  178.             $arrRange = StringUtil::deserialize($objEvent->repeatEach);
  180.             if (isset($arrRange['unit'], $arrRange['value']))
  181.             {
  182.                 while (($this->cal_hideRunning ? $intStartTime : $intEndTime) < time() && $intEndTime < $objEvent->repeatEnd)
  183.                 {
  184.                     $intStartTime = strtotime('+' . $arrRange['value'] . ' ' . $arrRange['unit'], $intStartTime);
  185.                     $intEndTime = strtotime('+' . $arrRange['value'] . ' ' . $arrRange['unit'], $intEndTime);
  186.                 }
  187.             }
  188.         }
  190.         // Mark past and upcoming events (see #187)
  191.         if ($intEndTime < strtotime('00:00:00'))
  192.         {
  193.             $objEvent->cssClass .= ' bygone';
  194.         }
  195.         elseif ($intStartTime > strtotime('23:59:59'))
  196.         {
  197.             $objEvent->cssClass .= ' upcoming';
  198.         }
  199.         else
  200.         {
  201.             $objEvent->cssClass .= ' current';
  202.         }
  204.         list($strDate, $strTime) = $this->getDateAndTime($objEvent, $objPage, $intStartTime, $intEndTime, $span);
  206.         $until = '';
  207.         $recurring = '';
  208.         $arrRange = array();
  210.         // Recurring event
  211.         if ($objEvent->recurring)
  212.         {
  213.             $arrRange = StringUtil::deserialize($objEvent->repeatEach);
  215.             if (isset($arrRange['unit'], $arrRange['value']))
  216.             {
  217.                 if ($arrRange['value'] == 1)
  218.                 {
  219.                     $repeat = $GLOBALS['TL_LANG']['MSC']['cal_single_' . $arrRange['unit']];
  220.                 }
  221.                 else
  222.                 {
  223.                     $repeat = sprintf($GLOBALS['TL_LANG']['MSC']['cal_multiple_' . $arrRange['unit']], $arrRange['value']);
  224.                 }
  226.                 if ($objEvent->recurrences > 0)
  227.                 {
  228.                     $until = ' ' . sprintf($GLOBALS['TL_LANG']['MSC']['cal_until'], Date::parse($objPage->dateFormat, $objEvent->repeatEnd));
  229.                 }
  231.                 if ($objEvent->recurrences > 0 && $intEndTime <= time())
  232.                 {
  233.                     $recurring = sprintf($GLOBALS['TL_LANG']['MSC']['cal_repeat_ended'], $repeat, $until);
  234.                 }
  235.                 elseif ($objEvent->addTime)
  236.                 {
  237.                     $recurring = sprintf($GLOBALS['TL_LANG']['MSC']['cal_repeat'], $repeat, $until, date('Y-m-d\TH:i:sP', $intStartTime), $strDate . ($strTime ? ' ' . $strTime : ''));
  238.                 }
  239.                 else
  240.                 {
  241.                     $recurring = sprintf($GLOBALS['TL_LANG']['MSC']['cal_repeat'], $repeat, $until, date('Y-m-d', $intStartTime), $strDate);
  242.                 }
  243.             }
  244.         }
  246.         $objTemplate = new FrontendTemplate($this->cal_template ?: 'event_full');
  247.         $objTemplate->setData($objEvent->row());
  248.         $objTemplate->date = $strDate;
  249.         $objTemplate->time = $strTime;
  250.         $objTemplate->datetime = $objEvent->addTime ? date('Y-m-d\TH:i:sP', $intStartTime) : date('Y-m-d', $intStartTime);
  251.         $objTemplate->begin = $intStartTime;
  252.         $objTemplate->end = $intEndTime;
  253.         $objTemplate->class = $objEvent->cssClass ? ' ' . trim($objEvent->cssClass) : '';
  254.         $objTemplate->recurring = $recurring;
  255.         $objTemplate->until = $until;
  256.         $objTemplate->locationLabel = $GLOBALS['TL_LANG']['MSC']['location'];
  257.         $objTemplate->calendar = $objEvent->getRelated('pid');
  258.         $objTemplate->count = 0; // see #74
  259.         $objTemplate->details = '';
  260.         $objTemplate->hasDetails = false;
  261.         $objTemplate->hasTeaser = false;
  262.         $objTemplate->hasReader = true;
  264.         // Clean the RTE output
  265.         if ($objEvent->teaser)
  266.         {
  267.             $objTemplate->hasTeaser = true;
  268.             $objTemplate->teaser = StringUtil::encodeEmail($objEvent->teaser);
  269.         }
  271.         // Display the "read more" button for external/article links
  272.         if ($objEvent->source != 'default')
  273.         {
  274.             $objTemplate->hasDetails = true;
  275.             $objTemplate->hasReader = false;
  276.         }
  278.         // Compile the event text
  279.         else
  280.         {
  281.             $id = $objEvent->id;
  283.             $objTemplate->details = function () use ($id)
  284.             {
  285.                 $strDetails = '';
  286.                 $objElement = ContentModel::findPublishedByPidAndTable($id, 'tl_calendar_events');
  288.                 if ($objElement !== null)
  289.                 {
  290.                     while ($objElement->next())
  291.                     {
  292.                         $strDetails .= $this->getContentElement($objElement->current());
  293.                     }
  294.                 }
  296.                 return $strDetails;
  297.             };
  299.             $objTemplate->hasDetails = static function () use ($id)
  300.             {
  301.                 return ContentModel::countPublishedByPidAndTable($id, 'tl_calendar_events') > 0;
  302.             };
  303.         }
  305.         $objTemplate->addImage = false;
  306.         $objTemplate->addBefore = false;
  308.         // Add an image
  309.         if ($objEvent->addImage)
  310.         {
  311.             $imgSize = $objEvent->size ?: null;
  313.             // Override the default image size
  314.             if ($this->imgSize)
  315.             {
  316.                 $size = StringUtil::deserialize($this->imgSize);
  318.                 if ($size[0] > 0 || $size[1] > 0 || is_numeric($size[2]) || ($size[2][0] ?? null) === '_')
  319.                 {
  320.                     $imgSize = $this->imgSize;
  321.                 }
  322.             }
  324.             $figure = System::getContainer()
  325.                 ->get('contao.image.studio')
  326.                 ->createFigureBuilder()
  327.                 ->from($objEvent->singleSRC)
  328.                 ->setSize($imgSize)
  329.                 ->setMetadata($objEvent->getOverwriteMetadata())
  330.                 ->enableLightbox((bool) $objEvent->fullsize)
  331.                 ->buildIfResourceExists();
  333.             if (null !== $figure)
  334.             {
  335.                 $figure->applyLegacyTemplateData($objTemplate, $objEvent->imagemargin, $objEvent->floating);
  336.             }
  337.         }
  339.         $objTemplate->enclosure = array();
  341.         // Add enclosures
  342.         if ($objEvent->addEnclosure)
  343.         {
  344.             $this->addEnclosuresToTemplate($objTemplate, $objEvent->row());
  345.         }
  347.         // Add a function to retrieve upcoming dates (see #175)
  348.         $objTemplate->getUpcomingDates = function ($recurrences) use ($objEvent, $objPage, $intStartTime, $intEndTime, $arrRange, $span)
  349.         {
  350.             if (!$objEvent->recurring || !isset($arrRange['unit'], $arrRange['value']))
  351.             {
  352.                 return array();
  353.             }
  355.             $dates = array();
  356.             $startTime = $intStartTime;
  357.             $endTime = $intEndTime;
  358.             $strtotime = '+ ' . $arrRange['value'] . ' ' . $arrRange['unit'];
  360.             for ($i=0; $i<$recurrences; $i++)
  361.             {
  362.                 $startTime = strtotime($strtotime, $startTime);
  363.                 $endTime = strtotime($strtotime, $endTime);
  365.                 if ($endTime > $objEvent->repeatEnd)
  366.                 {
  367.                     break;
  368.                 }
  370.                 list($strDate, $strTime) = $this->getDateAndTime($objEvent, $objPage, $startTime, $endTime, $span);
  372.                 $dates[] = array
  373.                 (
  374.                     'date' => $strDate,
  375.                     'time' => $strTime,
  376.                     'datetime' => $objEvent->addTime ? date('Y-m-d\TH:i:sP', $startTime) : date('Y-m-d', $endTime),
  377.                     'begin' => $startTime,
  378.                     'end' => $endTime
  379.                 );
  380.             }
  382.             return $dates;
  383.         };
  385.         // Add a function to retrieve past dates (see #175)
  386.         $objTemplate->getPastDates = function ($recurrences) use ($objEvent, $objPage, $intStartTime, $intEndTime, $arrRange, $span)
  387.         {
  388.             if (!$objEvent->recurring || !isset($arrRange['unit'], $arrRange['value']))
  389.             {
  390.                 return array();
  391.             }
  393.             $dates = array();
  394.             $startTime = $intStartTime;
  395.             $endTime = $intEndTime;
  396.             $strtotime = '- ' . $arrRange['value'] . ' ' . $arrRange['unit'];
  398.             for ($i=0; $i<$recurrences; $i++)
  399.             {
  400.                 $startTime = strtotime($strtotime, $startTime);
  401.                 $endTime = strtotime($strtotime, $endTime);
  403.                 if ($startTime < $objEvent->startDate)
  404.                 {
  405.                     break;
  406.                 }
  408.                 list($strDate, $strTime) = $this->getDateAndTime($objEvent, $objPage, $startTime, $endTime, $span);
  410.                 $dates[] = array
  411.                 (
  412.                     'date' => $strDate,
  413.                     'time' => $strTime,
  414.                     'datetime' => $objEvent->addTime ? date('Y-m-d\TH:i:sP', $startTime) : date('Y-m-d', $endTime),
  415.                     'begin' => $startTime,
  416.                     'end' => $endTime
  417.                 );
  418.             }
  420.             return $dates;
  421.         };
  423.         // schema.org information
  424.         $objTemplate->getSchemaOrgData = static function () use ($objTemplate, $objEvent): array
  425.         {
  426.             $jsonLd = Events::getSchemaOrgData($objEvent);
  428.             if ($objTemplate->addImage && $objTemplate->figure)
  429.             {
  430.                 $jsonLd['image'] = $objTemplate->figure->getSchemaOrgData();
  431.             }
  433.             return $jsonLd;
  434.         };
  436.         $this->Template->event = $objTemplate->parse();
  438.         // Tag the event (see #2137)
  439.         if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  440.         {
  441.             $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  442.             $responseTagger->addTags(array('contao.db.tl_calendar_events.' . $objEvent->id));
  443.         }
  445.         $bundles = System::getContainer()->getParameter('kernel.bundles');
  447.         // HOOK: comments extension required
  448.         if ($objEvent->noComments || !isset($bundles['ContaoCommentsBundle']))
  449.         {
  450.             $this->Template->allowComments = false;
  452.             return;
  453.         }
  455.         /** @var CalendarModel $objCalendar */
  456.         $objCalendar = $objEvent->getRelated('pid');
  457.         $this->Template->allowComments = $objCalendar->allowComments;
  459.         // Comments are not allowed
  460.         if (!$objCalendar->allowComments)
  461.         {
  462.             return;
  463.         }
  465.         // Adjust the comments headline level
  466.         $intHl = min((int) str_replace('h', '', $this->hl), 5);
  467.         $this->Template->hlc = 'h' . ($intHl + 1);
  469.         $this->import(Comments::class, 'Comments');
  470.         $arrNotifies = array();
  472.         // Notify the system administrator
  473.         if ($objCalendar->notify != 'notify_author')
  474.         {
  475.             $arrNotifies[] = $GLOBALS['TL_ADMIN_EMAIL'];
  476.         }
  478.         /** @var UserModel $objAuthor */
  479.         if ($objCalendar->notify != 'notify_admin' && ($objAuthor = $objEvent->getRelated('author')) instanceof UserModel && $objAuthor->email)
  480.         {
  481.             $arrNotifies[] = $objAuthor->email;
  482.         }
  484.         $objConfig = new \stdClass();
  486.         $objConfig->perPage = $objCalendar->perPage;
  487.         $objConfig->order = $objCalendar->sortOrder;
  488.         $objConfig->template = $this->com_template;
  489.         $objConfig->requireLogin = $objCalendar->requireLogin;
  490.         $objConfig->disableCaptcha = $objCalendar->disableCaptcha;
  491.         $objConfig->bbcode = $objCalendar->bbcode;
  492.         $objConfig->moderate = $objCalendar->moderate;
  494.         $this->Comments->addCommentsToTemplate($this->Template, $objConfig, 'tl_calendar_events', $objEvent->id, $arrNotifies);
  495.     }
  497.     /**
  498.      * Return the date and time strings
  499.      *
  500.      * @param CalendarEventsModel $objEvent
  501.      * @param PageModel           $objPage
  502.      * @param integer             $intStartTime
  503.      * @param integer             $intEndTime
  504.      * @param integer             $span
  505.      *
  506.      * @return array
  507.      */
  508.     private function getDateAndTime(CalendarEventsModel $objEvent, PageModel $objPage, $intStartTime, $intEndTime, $span)
  509.     {
  510.         $strDate = Date::parse($objPage->dateFormat, $intStartTime);
  512.         if ($span > 0)
  513.         {
  514.             $strDate = Date::parse($objPage->dateFormat, $intStartTime) . $GLOBALS['TL_LANG']['MSC']['cal_timeSeparator'] . Date::parse($objPage->dateFormat, $intEndTime);
  515.         }
  517.         $strTime = '';
  519.         if ($objEvent->addTime)
  520.         {
  521.             if ($span > 0)
  522.             {
  523.                 $strDate = Date::parse($objPage->datimFormat, $intStartTime) . $GLOBALS['TL_LANG']['MSC']['cal_timeSeparator'] . Date::parse($objPage->datimFormat, $intEndTime);
  524.             }
  525.             elseif ($intStartTime == $intEndTime)
  526.             {
  527.                 $strTime = Date::parse($objPage->timeFormat, $intStartTime);
  528.             }
  529.             else
  530.             {
  531.                 $strTime = Date::parse($objPage->timeFormat, $intStartTime) . $GLOBALS['TL_LANG']['MSC']['cal_timeSeparator'] . Date::parse($objPage->timeFormat, $intEndTime);
  532.             }
  533.         }
  535.         return array($strDate, $strTime);
  536.     }
  537. }
  539. class_alias(ModuleEventReader::class, 'ModuleEventReader');