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

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\Image\Studio\Studio;
  17. use Contao\CoreBundle\Routing\ResponseContext\HtmlHeadBag\HtmlHeadBag;
  18. use Contao\CoreBundle\Routing\ResponseContext\ResponseContextAccessor;
  19. use Patchwork\Utf8;
  21. /**
  22.  * Front end module "event reader".
  23.  *
  24.  * @property Comments $Comments
  25.  * @property string   $com_template
  26.  * @property string   $cal_template
  27.  * @property array    $cal_calendar
  28.  *
  29.  * @author Leo Feyer <https://github.com/leofeyer>
  30.  */
  31. class ModuleEventReader extends Events
  32. {
  33.     /**
  34.      * Template
  35.      * @var string
  36.      */
  37.     protected $strTemplate = 'mod_eventreader';
  39.     /**
  40.      * Display a wildcard in the back end
  41.      *
  42.      * @throws InternalServerErrorException
  43.      *
  44.      * @return string
  45.      */
  46.     public function generate()
  47.     {
  48.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  50.         if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  51.         {
  52.             $objTemplate = new BackendTemplate('be_wildcard');
  53.             $objTemplate->wildcard = '### ' . Utf8::strtoupper($GLOBALS['TL_LANG']['FMD']['eventreader'][0]) . ' ###';
  54.             $objTemplate->title = $this->headline;
  55.             $objTemplate->id = $this->id;
  56.             $objTemplate->link = $this->name;
  57.             $objTemplate->href = 'contao/main.php?do=themes&amp;table=tl_module&amp;act=edit&amp;id=' . $this->id;
  59.             return $objTemplate->parse();
  60.         }
  62.         // Set the item from the auto_item parameter
  63.         if (!isset($_GET['events']) && isset($_GET['auto_item']) && Config::get('useAutoItem'))
  64.         {
  65.             Input::setGet('events', Input::get('auto_item'));
  66.         }
  68.         // Return an empty string if "events" is not set (to combine list and reader on same page)
  69.         if (!Input::get('events'))
  70.         {
  71.             return '';
  72.         }
  74.         $this->cal_calendar = $this->sortOutProtected(StringUtil::deserialize($this->cal_calendar));
  76.         if (empty($this->cal_calendar) || !\is_array($this->cal_calendar))
  77.         {
  78.             throw new InternalServerErrorException('The event reader ID ' . $this->id . ' has no calendars specified.');
  79.         }
  81.         return parent::generate();
  82.     }
  84.     /**
  85.      * Generate the module
  86.      */
  87.     protected function compile()
  88.     {
  89.         /** @var PageModel $objPage */
  90.         global $objPage;
  92.         $this->Template->event = '';
  93.         $this->Template->referer = 'javascript:history.go(-1)';
  94.         $this->Template->back = $GLOBALS['TL_LANG']['MSC']['goBack'];
  96.         // Get the current event
  97.         $objEvent = CalendarEventsModel::findPublishedByParentAndIdOrAlias(Input::get('events'), $this->cal_calendar);
  99.         // The event does not exist (see #33)
  100.         if ($objEvent === null)
  101.         {
  102.             throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  103.         }
  105.         // Redirect if the event has a target URL (see #1498)
  106.         switch ($objEvent->source) {
  107.             case 'internal':
  108.                 if ($page = PageModel::findPublishedById($objEvent->jumpTo))
  109.                 {
  110.                     throw new RedirectResponseException($page->getAbsoluteUrl(), 301);
  111.                 }
  113.                 throw new InternalServerErrorException('Invalid "jumpTo" value or target page not public');
  115.             case 'article':
  116.                 if (($article = ArticleModel::findByPk($objEvent->articleId)) && ($page = PageModel::findPublishedById($article->pid)))
  117.                 {
  118.                     throw new RedirectResponseException($page->getAbsoluteUrl('/articles/' . ($article->alias ?: $article->id)), 301);
  119.                 }
  121.                 throw new InternalServerErrorException('Invalid "articleId" value or target page not public');
  123.             case 'external':
  124.                 if ($objEvent->url)
  125.                 {
  126.                     throw new RedirectResponseException($objEvent->url, 301);
  127.                 }
  129.                 throw new InternalServerErrorException('Empty target URL');
  130.         }
  132.         // Overwrite the page meta data (see #2853, #4955 and #87)
  133.         $responseContext = System::getContainer()->get(ResponseContextAccessor::class)->getResponseContext();
  135.         if ($responseContext && $responseContext->has(HtmlHeadBag::class))
  136.         {
  137.             /** @var HtmlHeadBag $htmlHeadBag */
  138.             $htmlHeadBag = $responseContext->get(HtmlHeadBag::class);
  140.             if ($objEvent->pageTitle)
  141.             {
  142.                 $htmlHeadBag->setTitle($objEvent->pageTitle); // Already stored decoded
  143.             }
  144.             elseif ($objEvent->title)
  145.             {
  146.                 $htmlHeadBag->setTitle(StringUtil::inputEncodedToPlainText($objEvent->title));
  147.             }
  149.             if ($objEvent->description)
  150.             {
  151.                 $htmlHeadBag->setMetaDescription(StringUtil::inputEncodedToPlainText($objEvent->description));
  152.             }
  153.             elseif ($objEvent->teaser)
  154.             {
  155.                 $htmlHeadBag->setMetaDescription(StringUtil::htmlToPlainText($objEvent->teaser));
  156.             }
  158.             if ($objEvent->robots)
  159.             {
  160.                 $htmlHeadBag->setMetaRobots($objEvent->robots);
  161.             }
  162.         }
  164.         $intStartTime = $objEvent->startTime;
  165.         $intEndTime = $objEvent->endTime;
  166.         $span = Calendar::calculateSpan($intStartTime, $intEndTime);
  168.         // Do not show dates in the past if the event is recurring (see #923)
  169.         if ($objEvent->recurring)
  170.         {
  171.             $arrRange = StringUtil::deserialize($objEvent->repeatEach);
  173.             if (isset($arrRange['unit'], $arrRange['value']))
  174.             {
  175.                 while (($this->cal_hideRunning ? $intStartTime : $intEndTime) < time() && $intEndTime < $objEvent->repeatEnd)
  176.                 {
  177.                     $intStartTime = strtotime('+' . $arrRange['value'] . ' ' . $arrRange['unit'], $intStartTime);
  178.                     $intEndTime = strtotime('+' . $arrRange['value'] . ' ' . $arrRange['unit'], $intEndTime);
  179.                 }
  180.             }
  181.         }
  183.         // Mark past and upcoming events (see #187)
  184.         if ($intEndTime < strtotime('00:00:00'))
  185.         {
  186.             $objEvent->cssClass .= ' bygone';
  187.         }
  188.         elseif ($intStartTime > strtotime('23:59:59'))
  189.         {
  190.             $objEvent->cssClass .= ' upcoming';
  191.         }
  192.         else
  193.         {
  194.             $objEvent->cssClass .= ' current';
  195.         }
  197.         list($strDate, $strTime) = $this->getDateAndTime($objEvent, $objPage, $intStartTime, $intEndTime, $span);
  199.         $until = '';
  200.         $recurring = '';
  201.         $arrRange = array();
  203.         // Recurring event
  204.         if ($objEvent->recurring)
  205.         {
  206.             $arrRange = StringUtil::deserialize($objEvent->repeatEach);
  208.             if (isset($arrRange['unit'], $arrRange['value']))
  209.             {
  210.                 if ($arrRange['value'] == 1)
  211.                 {
  212.                     $repeat = $GLOBALS['TL_LANG']['MSC']['cal_single_' . $arrRange['unit']];
  213.                 }
  214.                 else
  215.                 {
  216.                     $repeat = sprintf($GLOBALS['TL_LANG']['MSC']['cal_multiple_' . $arrRange['unit']], $arrRange['value']);
  217.                 }
  219.                 if ($objEvent->recurrences > 0)
  220.                 {
  221.                     $until = ' ' . sprintf($GLOBALS['TL_LANG']['MSC']['cal_until'], Date::parse($objPage->dateFormat, $objEvent->repeatEnd));
  222.                 }
  224.                 if ($objEvent->recurrences > 0 && $intEndTime <= time())
  225.                 {
  226.                     $recurring = sprintf($GLOBALS['TL_LANG']['MSC']['cal_repeat_ended'], $repeat, $until);
  227.                 }
  228.                 elseif ($objEvent->addTime)
  229.                 {
  230.                     $recurring = sprintf($GLOBALS['TL_LANG']['MSC']['cal_repeat'], $repeat, $until, date('Y-m-d\TH:i:sP', $intStartTime), $strDate . ($strTime ? ' ' . $strTime : ''));
  231.                 }
  232.                 else
  233.                 {
  234.                     $recurring = sprintf($GLOBALS['TL_LANG']['MSC']['cal_repeat'], $repeat, $until, date('Y-m-d', $intStartTime), $strDate);
  235.                 }
  236.             }
  237.         }
  239.         $objTemplate = new FrontendTemplate($this->cal_template ?: 'event_full');
  240.         $objTemplate->setData($objEvent->row());
  241.         $objTemplate->date = $strDate;
  242.         $objTemplate->time = $strTime;
  243.         $objTemplate->datetime = $objEvent->addTime ? date('Y-m-d\TH:i:sP', $intStartTime) : date('Y-m-d', $intStartTime);
  244.         $objTemplate->begin = $intStartTime;
  245.         $objTemplate->end = $intEndTime;
  246.         $objTemplate->class = $objEvent->cssClass ? ' ' . trim($objEvent->cssClass) : '';
  247.         $objTemplate->recurring = $recurring;
  248.         $objTemplate->until = $until;
  249.         $objTemplate->locationLabel = $GLOBALS['TL_LANG']['MSC']['location'];
  250.         $objTemplate->calendar = $objEvent->getRelated('pid');
  251.         $objTemplate->details = '';
  252.         $objTemplate->hasDetails = false;
  253.         $objTemplate->hasTeaser = false;
  254.         $objTemplate->hasReader = true;
  256.         // Clean the RTE output
  257.         if ($objEvent->teaser)
  258.         {
  259.             $objTemplate->hasTeaser = true;
  260.             $objTemplate->teaser = StringUtil::toHtml5($objEvent->teaser);
  261.             $objTemplate->teaser = StringUtil::encodeEmail($objTemplate->teaser);
  262.         }
  264.         // Display the "read more" button for external/article links
  265.         if ($objEvent->source != 'default')
  266.         {
  267.             $objTemplate->hasDetails = true;
  268.             $objTemplate->hasReader = false;
  269.         }
  271.         // Compile the event text
  272.         else
  273.         {
  274.             $id = $objEvent->id;
  276.             $objTemplate->details = function () use ($id)
  277.             {
  278.                 $strDetails = '';
  279.                 $objElement = ContentModel::findPublishedByPidAndTable($id, 'tl_calendar_events');
  281.                 if ($objElement !== null)
  282.                 {
  283.                     while ($objElement->next())
  284.                     {
  285.                         $strDetails .= $this->getContentElement($objElement->current());
  286.                     }
  287.                 }
  289.                 return $strDetails;
  290.             };
  292.             $objTemplate->hasDetails = static function () use ($id)
  293.             {
  294.                 return ContentModel::countPublishedByPidAndTable($id, 'tl_calendar_events') > 0;
  295.             };
  296.         }
  298.         $objTemplate->addImage = false;
  299.         $objTemplate->addBefore = false;
  301.         // Add an image
  302.         if ($objEvent->addImage)
  303.         {
  304.             $imgSize = $objEvent->size ?: null;
  306.             // Override the default image size
  307.             if ($this->imgSize)
  308.             {
  309.                 $size = StringUtil::deserialize($this->imgSize);
  311.                 if ($size[0] > 0 || $size[1] > 0 || is_numeric($size[2]) || ($size[2][0] ?? null) === '_')
  312.                 {
  313.                     $imgSize = $this->imgSize;
  314.                 }
  315.             }
  317.             $figure = System::getContainer()
  318.                 ->get(Studio::class)
  319.                 ->createFigureBuilder()
  320.                 ->from($objEvent->singleSRC)
  321.                 ->setSize($imgSize)
  322.                 ->setMetadata($objEvent->getOverwriteMetadata())
  323.                 ->enableLightbox((bool) $objEvent->fullsize)
  324.                 ->buildIfResourceExists();
  326.             if (null !== $figure)
  327.             {
  328.                 $figure->applyLegacyTemplateData($objTemplate, $objEvent->imagemargin, $objEvent->floating);
  329.             }
  330.         }
  332.         $objTemplate->enclosure = array();
  334.         // Add enclosures
  335.         if ($objEvent->addEnclosure)
  336.         {
  337.             $this->addEnclosuresToTemplate($objTemplate, $objEvent->row());
  338.         }
  340.         // Add a function to retrieve upcoming dates (see #175)
  341.         $objTemplate->getUpcomingDates = function ($recurrences) use ($objEvent, $objPage, $intStartTime, $intEndTime, $arrRange, $span)
  342.         {
  343.             if (!$objEvent->recurring || !isset($arrRange['unit'], $arrRange['value']))
  344.             {
  345.                 return array();
  346.             }
  348.             $dates = array();
  349.             $startTime = $intStartTime;
  350.             $endTime = $intEndTime;
  351.             $strtotime = '+ ' . $arrRange['value'] . ' ' . $arrRange['unit'];
  353.             for ($i=0; $i<$recurrences; $i++)
  354.             {
  355.                 $startTime = strtotime($strtotime, $startTime);
  356.                 $endTime = strtotime($strtotime, $endTime);
  358.                 if ($endTime > $objEvent->repeatEnd)
  359.                 {
  360.                     break;
  361.                 }
  363.                 list($strDate, $strTime) = $this->getDateAndTime($objEvent, $objPage, $startTime, $endTime, $span);
  365.                 $dates[] = array
  366.                 (
  367.                     'date' => $strDate,
  368.                     'time' => $strTime,
  369.                     'datetime' => $objEvent->addTime ? date('Y-m-d\TH:i:sP', $startTime) : date('Y-m-d', $endTime),
  370.                     'begin' => $startTime,
  371.                     'end' => $endTime
  372.                 );
  373.             }
  375.             return $dates;
  376.         };
  378.         // Add a function to retrieve past dates (see #175)
  379.         $objTemplate->getPastDates = function ($recurrences) use ($objEvent, $objPage, $intStartTime, $intEndTime, $arrRange, $span)
  380.         {
  381.             if (!$objEvent->recurring || !isset($arrRange['unit'], $arrRange['value']))
  382.             {
  383.                 return array();
  384.             }
  386.             $dates = array();
  387.             $startTime = $intStartTime;
  388.             $endTime = $intEndTime;
  389.             $strtotime = '- ' . $arrRange['value'] . ' ' . $arrRange['unit'];
  391.             for ($i=0; $i<$recurrences; $i++)
  392.             {
  393.                 $startTime = strtotime($strtotime, $startTime);
  394.                 $endTime = strtotime($strtotime, $endTime);
  396.                 if ($startTime < $objEvent->startDate)
  397.                 {
  398.                     break;
  399.                 }
  401.                 list($strDate, $strTime) = $this->getDateAndTime($objEvent, $objPage, $startTime, $endTime, $span);
  403.                 $dates[] = array
  404.                 (
  405.                     'date' => $strDate,
  406.                     'time' => $strTime,
  407.                     'datetime' => $objEvent->addTime ? date('Y-m-d\TH:i:sP', $startTime) : date('Y-m-d', $endTime),
  408.                     'begin' => $startTime,
  409.                     'end' => $endTime
  410.                 );
  411.             }
  413.             return $dates;
  414.         };
  416.         // schema.org information
  417.         $objTemplate->getSchemaOrgData = static function () use ($objTemplate, $objEvent): array
  418.         {
  419.             $jsonLd = Events::getSchemaOrgData($objEvent);
  421.             if ($objTemplate->addImage && $objTemplate->figure)
  422.             {
  423.                 $jsonLd['image'] = $objTemplate->figure->getSchemaOrgData();
  424.             }
  426.             return $jsonLd;
  427.         };
  429.         $this->Template->event = $objTemplate->parse();
  431.         // Tag the event (see #2137)
  432.         if (System::getContainer()->has('fos_http_cache.http.symfony_response_tagger'))
  433.         {
  434.             $responseTagger = System::getContainer()->get('fos_http_cache.http.symfony_response_tagger');
  435.             $responseTagger->addTags(array('contao.db.tl_calendar_events.' . $objEvent->id));
  436.         }
  438.         $bundles = System::getContainer()->getParameter('kernel.bundles');
  440.         // HOOK: comments extension required
  441.         if ($objEvent->noComments || !isset($bundles['ContaoCommentsBundle']))
  442.         {
  443.             $this->Template->allowComments = false;
  445.             return;
  446.         }
  448.         /** @var CalendarModel $objCalendar */
  449.         $objCalendar = $objEvent->getRelated('pid');
  450.         $this->Template->allowComments = $objCalendar->allowComments;
  452.         // Comments are not allowed
  453.         if (!$objCalendar->allowComments)
  454.         {
  455.             return;
  456.         }
  458.         // Adjust the comments headline level
  459.         $intHl = min((int) str_replace('h', '', $this->hl), 5);
  460.         $this->Template->hlc = 'h' . ($intHl + 1);
  462.         $this->import(Comments::class, 'Comments');
  463.         $arrNotifies = array();
  465.         // Notify the system administrator
  466.         if ($objCalendar->notify != 'notify_author')
  467.         {
  468.             $arrNotifies[] = $GLOBALS['TL_ADMIN_EMAIL'];
  469.         }
  471.         /** @var UserModel $objAuthor */
  472.         if ($objCalendar->notify != 'notify_admin' && ($objAuthor = $objEvent->getRelated('author')) instanceof UserModel && $objAuthor->email)
  473.         {
  474.             $arrNotifies[] = $objAuthor->email;
  475.         }
  477.         $objConfig = new \stdClass();
  479.         $objConfig->perPage = $objCalendar->perPage;
  480.         $objConfig->order = $objCalendar->sortOrder;
  481.         $objConfig->template = $this->com_template;
  482.         $objConfig->requireLogin = $objCalendar->requireLogin;
  483.         $objConfig->disableCaptcha = $objCalendar->disableCaptcha;
  484.         $objConfig->bbcode = $objCalendar->bbcode;
  485.         $objConfig->moderate = $objCalendar->moderate;
  487.         $this->Comments->addCommentsToTemplate($this->Template, $objConfig, 'tl_calendar_events', $objEvent->id, $arrNotifies);
  488.     }
  490.     /**
  491.      * Return the date and time strings
  492.      *
  493.      * @param CalendarEventsModel $objEvent
  494.      * @param PageModel           $objPage
  495.      * @param integer             $intStartTime
  496.      * @param integer             $intEndTime
  497.      * @param integer             $span
  498.      *
  499.      * @return array
  500.      */
  501.     private function getDateAndTime(CalendarEventsModel $objEvent, PageModel $objPage, $intStartTime, $intEndTime, $span)
  502.     {
  503.         $strDate = Date::parse($objPage->dateFormat, $intStartTime);
  505.         if ($span > 0)
  506.         {
  507.             $strDate = Date::parse($objPage->dateFormat, $intStartTime) . $GLOBALS['TL_LANG']['MSC']['cal_timeSeparator'] . Date::parse($objPage->dateFormat, $intEndTime);
  508.         }
  510.         $strTime = '';
  512.         if ($objEvent->addTime)
  513.         {
  514.             if ($span > 0)
  515.             {
  516.                 $strDate = Date::parse($objPage->datimFormat, $intStartTime) . $GLOBALS['TL_LANG']['MSC']['cal_timeSeparator'] . Date::parse($objPage->datimFormat, $intEndTime);
  517.             }
  518.             elseif ($intStartTime == $intEndTime)
  519.             {
  520.                 $strTime = Date::parse($objPage->timeFormat, $intStartTime);
  521.             }
  522.             else
  523.             {
  524.                 $strTime = Date::parse($objPage->timeFormat, $intStartTime) . $GLOBALS['TL_LANG']['MSC']['cal_timeSeparator'] . Date::parse($objPage->timeFormat, $intEndTime);
  525.             }
  526.         }
  528.         return array($strDate, $strTime);
  529.     }
  530. }
  532. class_alias(ModuleEventReader::class, 'ModuleEventReader');