vendor/contao/core-bundle/src/Resources/contao/modules/ModuleSearch.php line 58

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\PageNotFoundException;
  14. use Contao\CoreBundle\File\Metadata;
  15. use Contao\CoreBundle\Security\ContaoCorePermissions;
  16. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  18. /**
  19.  * Front end module "search".
  20.  */
  21. class ModuleSearch extends Module
  22. {
  23.     /**
  24.      * Template
  25.      * @var string
  26.      */
  27.     protected $strTemplate = 'mod_search';
  29.     /**
  30.      * Display a wildcard in the back end
  31.      *
  32.      * @return string
  33.      */
  34.     public function generate()
  35.     {
  36.         $request = System::getContainer()->get('request_stack')->getCurrentRequest();
  38.         if ($request && System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest($request))
  39.         {
  40.             $objTemplate = new BackendTemplate('be_wildcard');
  41.             $objTemplate->wildcard = '### ' . $GLOBALS['TL_LANG']['FMD']['search'][0] . ' ###';
  42.             $objTemplate->title = $this->headline;
  43.             $objTemplate->id = $this->id;
  44.             $objTemplate->link = $this->name;
  45.             $objTemplate->href = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', array('do'=>'themes', 'table'=>'tl_module', 'act'=>'edit', 'id'=>$this->id)));
  47.             return $objTemplate->parse();
  48.         }
  50.         $this->pages = StringUtil::deserialize($this->pages);
  52.         return parent::generate();
  53.     }
  55.     /**
  56.      * Generate the module
  57.      */
  58.     protected function compile()
  59.     {
  60.         // Mark the x and y parameter as used (see #4277)
  61.         if (isset($_GET['x']))
  62.         {
  63.             Input::get('x');
  64.             Input::get('y');
  65.         }
  67.         // Trigger the search module from a custom form
  68.         if (!isset($_GET['keywords']) && Input::post('FORM_SUBMIT') == 'tl_search')
  69.         {
  70.             $_GET['keywords'] = Input::post('keywords');
  71.             $_GET['query_type'] = Input::post('query_type');
  72.             $_GET['per_page'] = Input::post('per_page');
  73.         }
  75.         $blnFuzzy = $this->fuzzy;
  76.         $strQueryType = Input::get('query_type') ?: $this->queryType;
  78.         if (\is_array(Input::get('keywords')))
  79.         {
  80.             throw new BadRequestHttpException('Expected string, got array');
  81.         }
  83.         $strKeywords = trim(Input::get('keywords'));
  85.         $this->Template->uniqueId = $this->id;
  86.         $this->Template->queryType = $strQueryType;
  87.         $this->Template->keyword = StringUtil::specialchars($strKeywords);
  88.         $this->Template->keywordLabel = $GLOBALS['TL_LANG']['MSC']['keywords'];
  89.         $this->Template->optionsLabel = $GLOBALS['TL_LANG']['MSC']['options'];
  90.         $this->Template->search = StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['searchLabel']);
  91.         $this->Template->matchAll = StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['matchAll']);
  92.         $this->Template->matchAny = StringUtil::specialchars($GLOBALS['TL_LANG']['MSC']['matchAny']);
  93.         $this->Template->advanced = ($this->searchType == 'advanced');
  95.         // Redirect page
  96.         if (($objTarget = $this->objModel->getRelated('jumpTo')) instanceof PageModel)
  97.         {
  98.             /** @var PageModel $objTarget */
  99.             $this->Template->action = $objTarget->getFrontendUrl();
  100.         }
  102.         $this->Template->pagination = '';
  103.         $this->Template->results = '';
  105.         // Execute the search if there are keywords
  106.         if ($strKeywords !== '' && $strKeywords != '*' && !$this->jumpTo)
  107.         {
  108.             // Search pages
  109.             if (!empty($this->pages) && \is_array($this->pages))
  110.             {
  111.                 $arrPages = array();
  113.                 foreach ($this->pages as $intPageId)
  114.                 {
  115.                     $arrPages[] = array($intPageId);
  116.                     $arrPages[] = $this->Database->getChildRecords($intPageId, 'tl_page');
  117.                 }
  119.                 if (!empty($arrPages))
  120.                 {
  121.                     $arrPages = array_merge(...$arrPages);
  122.                 }
  124.                 $arrPages = array_unique($arrPages);
  125.             }
  126.             // Website root
  127.             else
  128.             {
  129.                 /** @var PageModel $objPage */
  130.                 global $objPage;
  132.                 $arrPages = $this->Database->getChildRecords($objPage->rootId, 'tl_page');
  133.             }
  135.             // HOOK: add custom logic (see #5223)
  136.             if (isset($GLOBALS['TL_HOOKS']['customizeSearch']) && \is_array($GLOBALS['TL_HOOKS']['customizeSearch']))
  137.             {
  138.                 foreach ($GLOBALS['TL_HOOKS']['customizeSearch'] as $callback)
  139.                 {
  140.                     $this->import($callback[0]);
  141.                     $this->{$callback[0]}->{$callback[1]}($arrPages, $strKeywords, $strQueryType, $blnFuzzy, $this);
  142.                 }
  143.             }
  145.             // Return if there are no pages
  146.             if (empty($arrPages) || !\is_array($arrPages))
  147.             {
  148.                 return;
  149.             }
  151.             $query_starttime = microtime(true);
  153.             try
  154.             {
  155.                 $objResult = Search::query($strKeywords, ($strQueryType == 'or'), $arrPages, $blnFuzzy, $this->minKeywordLength);
  156.             }
  157.             catch (\Exception $e)
  158.             {
  159.                 System::getContainer()->get('monolog.logger.contao.error')->error('Website search failed: ' . $e->getMessage());
  161.                 $objResult = new SearchResult(array());
  162.             }
  164.             $query_endtime = microtime(true);
  166.             // Sort out protected pages
  167.             if (Config::get('indexProtected'))
  168.             {
  169.                 $objResult->applyFilter(static function ($v)
  170.                 {
  171.                     return empty($v['protected']) || System::getContainer()->get('security.helper')->isGranted(ContaoCorePermissions::MEMBER_IN_GROUPS, StringUtil::deserialize($v['groups'] ?? null, true));
  172.                 });
  173.             }
  175.             $count = $objResult->getCount();
  177.             $this->Template->count = $count;
  178.             $this->Template->page = null;
  179.             $this->Template->keywords = $strKeywords;
  181.             if ($this->minKeywordLength > 0)
  182.             {
  183.                 $this->Template->keywordHint = sprintf($GLOBALS['TL_LANG']['MSC']['sKeywordHint'], $this->minKeywordLength);
  184.             }
  186.             // No results
  187.             if ($count < 1)
  188.             {
  189.                 $this->Template->header = sprintf($GLOBALS['TL_LANG']['MSC']['sEmpty'], $strKeywords);
  190.                 $this->Template->duration = System::getFormattedNumber($query_endtime - $query_starttime, 3) . ' ' . $GLOBALS['TL_LANG']['MSC']['seconds'];
  192.                 return;
  193.             }
  195.             $from = 1;
  196.             $to = $count;
  198.             // Pagination
  199.             if ($this->perPage > 0)
  200.             {
  201.                 $id = 'page_s' . $this->id;
  202.                 $page = (int) (Input::get($id) ?? 1);
  203.                 $per_page = (int) Input::get('per_page') ?: $this->perPage;
  205.                 // Do not index or cache the page if the page number is outside the range
  206.                 if ($page < 1 || $page > max(ceil($count/$per_page), 1))
  207.                 {
  208.                     throw new PageNotFoundException('Page not found: ' . Environment::get('uri'));
  209.                 }
  211.                 $from = (($page - 1) * $per_page) + 1;
  212.                 $to = (($from + $per_page) > $count) ? $count : ($from + $per_page - 1);
  214.                 // Pagination menu
  215.                 if ($to < $count || $from > 1)
  216.                 {
  217.                     $objPagination = new Pagination($count, $per_page, Config::get('maxPaginationLinks'), $id);
  218.                     $this->Template->pagination = $objPagination->generate("\n  ");
  219.                 }
  221.                 $this->Template->page = $page;
  222.             }
  224.             $contextLength = 48;
  225.             $totalLength = 360;
  227.             $lengths = StringUtil::deserialize($this->contextLength, true) + array(null, null);
  229.             if ($lengths[0] > 0)
  230.             {
  231.                 $contextLength = $lengths[0];
  232.             }
  234.             if ($lengths[1] > 0)
  235.             {
  236.                 $totalLength = $lengths[1];
  237.             }
  239.             $arrResult = $objResult->getResults($to-$from+1, $from-1);
  241.             // Get the results
  242.             foreach (array_keys($arrResult) as $i)
  243.             {
  244.                 $objTemplate = new FrontendTemplate($this->searchTpl ?: 'search_default');
  245.                 $objTemplate->setData($arrResult[$i]);
  246.                 $objTemplate->href = $arrResult[$i]['url'];
  247.                 $objTemplate->link = $arrResult[$i]['title'];
  248.                 $objTemplate->url = StringUtil::specialchars(urldecode($arrResult[$i]['url']), true, true);
  249.                 $objTemplate->title = StringUtil::specialchars(StringUtil::stripInsertTags($arrResult[$i]['title']));
  250.                 $objTemplate->class = ($i == 0 ? 'first ' : '') . ((empty($arrResult[$i+1])) ? 'last ' : '') . (($i % 2 == 0) ? 'even' : 'odd');
  251.                 $objTemplate->relevance = sprintf($GLOBALS['TL_LANG']['MSC']['relevance'], number_format($arrResult[$i]['relevance'] / $arrResult[0]['relevance'] * 100, 2) . '%');
  252.                 $objTemplate->unit = $GLOBALS['TL_LANG']['UNITS'][1];
  254.                 $arrContext = array();
  255.                 $strText = StringUtil::stripInsertTags(strtok($arrResult[$i]['text'], "\n"));
  256.                 $arrMatches = Search::getMatchVariants(StringUtil::trimsplit(',', $arrResult[$i]['matches']), $strText, $GLOBALS['TL_LANGUAGE']);
  258.                 // Get the context
  259.                 foreach ($arrMatches as $strWord)
  260.                 {
  261.                     $arrChunks = array();
  262.                     preg_match_all('/(^|(?:\b|^).{0,' . $contextLength . '}(?:\PL|\p{Hiragana}|\p{Katakana}|\p{Han}|\p{Myanmar}|\p{Khmer}|\p{Lao}|\p{Thai}|\p{Tibetan}))' . preg_quote($strWord, '/') . '((?:\PL|\p{Hiragana}|\p{Katakana}|\p{Han}|\p{Myanmar}|\p{Khmer}|\p{Lao}|\p{Thai}|\p{Tibetan}).{0,' . $contextLength . '}(?:\b|$)|$)/ui', $strText, $arrChunks);
  264.                     foreach ($arrChunks[0] as $strContext)
  265.                     {
  266.                         $arrContext[] = ' ' . $strContext . ' ';
  267.                     }
  269.                     // Skip other terms if the total length is already reached
  270.                     if (array_sum(array_map('mb_strlen', $arrContext)) >= $totalLength)
  271.                     {
  272.                         break;
  273.                     }
  274.                 }
  276.                 // Shorten the context and highlight all keywords
  277.                 if (!empty($arrContext))
  278.                 {
  279.                     $objTemplate->context = trim(StringUtil::substrHtml(implode('…', $arrContext), $totalLength));
  280.                     $objTemplate->context = preg_replace('((?<=^|\PL|\p{Hiragana}|\p{Katakana}|\p{Han}|\p{Myanmar}|\p{Khmer}|\p{Lao}|\p{Thai}|\p{Tibetan})(' . implode('|', array_map('preg_quote', $arrMatches)) . ')(?=\PL|\p{Hiragana}|\p{Katakana}|\p{Han}|\p{Myanmar}|\p{Khmer}|\p{Lao}|\p{Thai}|\p{Tibetan}|$))ui', '<mark class="highlight">$1</mark>', $objTemplate->context);
  282.                     $objTemplate->hasContext = true;
  283.                 }
  285.                 $this->addImageToTemplateFromSearchResult($arrResult[$i], $objTemplate);
  287.                 $this->Template->results .= $objTemplate->parse();
  288.             }
  290.             $this->Template->header = vsprintf($GLOBALS['TL_LANG']['MSC']['sResults'], array($from, $to, $count, $strKeywords));
  291.             $this->Template->duration = System::getFormattedNumber($query_endtime - $query_starttime, 3) . ' ' . $GLOBALS['TL_LANG']['MSC']['seconds'];
  292.         }
  293.     }
  295.     protected function addImageToTemplateFromSearchResult(array $result, Template $template): void
  296.     {
  297.         $template->hasImage = false;
  299.         if (!isset($result['meta']))
  300.         {
  301.             return;
  302.         }
  304.         $meta = json_decode($result['meta'], true);
  306.         foreach ($meta as $v)
  307.         {
  308.             if (!isset($v['https://schema.org/primaryImageOfPage']['contentUrl']))
  309.             {
  310.                 continue;
  311.             }
  313.             $baseUrls = array_filter(array(Environment::get('base'), System::getContainer()->get('contao.assets.files_context')->getStaticUrl()));
  315.             $figureBuilder = System::getContainer()->get('contao.image.studio')->createFigureBuilder();
  316.             $figureBuilder->fromUrl($v['https://schema.org/primaryImageOfPage']['contentUrl'], $baseUrls);
  318.             $figureMeta = new Metadata(array_filter(array(
  319.                 Metadata::VALUE_CAPTION => $v['https://schema.org/primaryImageOfPage']['caption'] ?? null,
  320.                 Metadata::VALUE_TITLE => $v['https://schema.org/primaryImageOfPage']['name'] ?? null,
  321.                 Metadata::VALUE_ALT => $v['https://schema.org/primaryImageOfPage']['alternateName'] ?? null,
  322.             )));
  324.             $figure = $figureBuilder
  325.                 ->setSize($this->imgSize)
  326.                 ->setMetadata($figureMeta)
  327.                 ->setLinkHref($result['url'])
  328.                 ->buildIfResourceExists();
  330.             if (null === $figure)
  331.             {
  332.                 continue;
  333.             }
  335.             $template->hasImage = true;
  336.             $template->figure = $figure;
  337.             $template->image = (object) $figure->getLegacyTemplateData();
  339.             return;
  340.         }
  341.     }
  342. }
  344. class_alias(ModuleSearch::class, 'ModuleSearch');