SearchController::handleSolrUnavailable() - Code Metrics - Inspection of "[TASK:T12] Remove usages of sys_language" - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — task/3376-TYPO3_12_compatibili... ( 00c9eb...0c91ac )

by Rafael
created 2023-03-03 14:46 UTC
SearchController::handleSolrUnavailable() A

↳ Parent: SearchController
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	2
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
<?php

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace ApacheSolrForTypo3\Solr\Controller;

use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet;
use ApacheSolrForTypo3\Solr\Event\Search\AfterFrequentlySearchedEvent;
use ApacheSolrForTypo3\Solr\Event\Search\AfterSearchEvent;
use ApacheSolrForTypo3\Solr\Event\Search\FormEvent;
use ApacheSolrForTypo3\Solr\Pagination\ResultsPagination;
use ApacheSolrForTypo3\Solr\Pagination\ResultsPaginator;
use ApacheSolrForTypo3\Solr\System\Solr\SolrUnavailableException;
use ApacheSolrForTypo3\Solr\Util;
use Psr\Http\Message\ResponseInterface;
use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Http\ForwardResponse;
use TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentException;
use TYPO3\CMS\Fluid\View\TemplateView;
use TYPO3Fluid\Fluid\View\ViewInterface;

/**
 * Class SearchController
 *
 * @author Frans Saris <[email protected]>
 * @author Timo Hund <[email protected]>
 */
class SearchController extends AbstractBaseController
{
    /**
     * @var TemplateView
     */
    protected $view;

    /**
     * Provide search query in extbase arguments.
     */
    protected function initializeAction()
    {
        parent::initializeAction();
        $this->mapGlobalQueryStringWhenEnabled();
    }

    protected function mapGlobalQueryStringWhenEnabled()
    {
        $query = GeneralUtility::_GET('q');

        $useGlobalQueryString = $query !== null && !$this->typoScriptConfiguration->getSearchIgnoreGlobalQParameter();
        $useGlobalQueryString = $query !== null && !$this->typoScriptConfiguration->/** @scrutinizer ignore-call */ getSearchIgnoreGlobalQParameter();

        if ($useGlobalQueryString) {
            $this->request->setArgument('q', $query);
                            setArgument('q', $query);
        }
    }

    /**
     * @param ViewInterface $view
     */
    public function initializeView($view)
    {
        if ($view instanceof TemplateView) {
            $customTemplate = $this->getCustomTemplateFromConfiguration();
            if ($customTemplate === '') {
                return;
            }

            if (str_contains($customTemplate, 'EXT:')) {
                $view->setTemplatePathAndFilename($customTemplate);
            } else {
                $view->setTemplate($customTemplate);
            }
        }
    }

    /**
     * @return string
     */
    protected function getCustomTemplateFromConfiguration(): string
    {
        $templateKey = str_replace('Action', '', $this->actionMethodName);
        return $this->typoScriptConfiguration->getViewTemplateByFileKey($templateKey);
    }

    /**
     * Results
     * @return ResponseInterface
     * @throws AspectNotFoundException
     * @throws NoSuchArgumentException
     */
    public function resultsAction(): ResponseInterface
    {
        if ($this->searchService === null) {
            return $this->handleSolrUnavailable();
        }

        try {
            $arguments = $this->request->getArguments();
            $pageId = $this->typoScriptFrontendController->getRequestedId();
            $pageId = $this->typoScriptFrontendController->getRequestedId();
            $languageId = Util::getLanguageUid();
            $searchRequest = $this->getSearchRequestBuilder()->buildForSearch($arguments, $pageId, $languageId);

            $searchResultSet = $this->searchService->search($searchRequest);

            // we pass the search result set to the controller context, to have the possibility
            // to access it without passing it from partial to partial
            $this->controllerContext->setSearchResultSet($searchResultSet);

            $currentPage = $this->request->hasArgument('page') ? (int)$this->request->getArgument('page') : 1;

            // prevent currentPage < 1 (i.e for GET request like &tx_solr[page]=0)
            if ($currentPage < 1) {
                $currentPage = 1;
            }

            $itemsPerPage = ($searchResultSet->getUsedResultsPerPage() ?: $this->typoScriptConfiguration->getSearchResultsPerPage(10));
            $paginator = GeneralUtility::makeInstance(ResultsPaginator::class, $searchResultSet, $currentPage, $itemsPerPage);
            $pagination = GeneralUtility::makeInstance(ResultsPagination::class, $paginator);
            $pagination->setMaxPageNumbers((int)$this->typoScriptConfiguration->getMaxPaginatorLinks(0));

            /* @var AfterSearchEvent $afterSearchEvent */
            $afterSearchEvent = $this->eventDispatcher->dispatch(
                new AfterSearchEvent(
                    $searchResultSet,
                    $this->getAdditionalFilters(),
                    $this->typoScriptConfiguration->getSearchPluginNamespace(),
                    $arguments,
                    $pagination,
                    $currentPage
                )
            );

            $values = [
                'additionalFilters' => $afterSearchEvent->getAdditionalFilters(),
                'resultSet' => $afterSearchEvent->getResultSet(),
                'pluginNamespace' => $afterSearchEvent->getPluginNamespace(),
                'arguments' => $afterSearchEvent->getArguments(),
                'pagination' => $afterSearchEvent->getPagination(),
                'currentPage' => $afterSearchEvent->getCurrentPage(),
            ];

            $this->view->assignMultiple($values);
        } catch (SolrUnavailableException $e) {
            return $this->handleSolrUnavailable();
        }
        return $this->htmlResponse();
    }

    /**
     * Form
     */
    public function formAction(): ResponseInterface
    {
        if ($this->searchService === null) {
            return $this->handleSolrUnavailable();
        }

        /* @var FormEvent $formEvent */
        $formEvent = $this->eventDispatcher->dispatch(
            new FormEvent(
                $this->searchService->getSearch(),
                $this->getAdditionalFilters(),
                $this->typoScriptConfiguration->getSearchPluginNamespace()
            )
        );
        $values = [
            'search' => $formEvent->getSearch(),
            'additionalFilters' => $formEvent->getAdditionalFilters(),
            'pluginNamespace' => $formEvent->getPluginNamespace(),
        ];

        $this->view->assignMultiple($values);
        return $this->htmlResponse();
    }

    /**
     * Frequently Searched
     *
     * @return ResponseInterface
     */
    public function frequentlySearchedAction(): ResponseInterface
    {
        /** @var  $searchResultSet SearchResultSet */
        $searchResultSet = GeneralUtility::makeInstance(SearchResultSet::class);

        $pageId = $this->typoScriptFrontendController->getRequestedId();
        $languageId = Util::getLanguageUid();
        $searchRequest = $this->getSearchRequestBuilder()->buildForFrequentSearches($pageId, $languageId);
        $searchResultSet->setUsedSearchRequest($searchRequest);

        $this->controllerContext->setSearchResultSet($searchResultSet);

        /* @var AfterFrequentlySearchedEvent $afterFrequentlySearchedEvent*/
        $afterFrequentlySearchedEvent = $this->eventDispatcher->dispatch(
            new AfterFrequentlySearchedEvent(
                $searchResultSet,
                $this->getAdditionalFilters()
            )
        );
        $values = [
            'additionalFilters' => $afterFrequentlySearchedEvent->getAdditionalFilters(),
            'resultSet' => $afterFrequentlySearchedEvent->getResultSet(),
        ];
        $this->view->assignMultiple($values);
        return $this->htmlResponse();
    }

    /**
     * This action allows to render a detailView with data from solr.
     *
     * @param string $documentId
     * @return ResponseInterface
     */
    public function detailAction(string $documentId = ''): ResponseInterface
    {
        if ($this->searchService === null) {
            return $this->handleSolrUnavailable();
        }

        try {
            $document = $this->searchService->getDocumentById($documentId);
            $this->view->assign('document', $document);
        } catch (SolrUnavailableException $e) {
            return $this->handleSolrUnavailable();
        }
        return $this->htmlResponse();
    }

    /**
     * Rendered when no search is available.
     *
     * @return ResponseInterface
     */
    public function solrNotAvailableAction(): ResponseInterface
    {
        return $this->htmlResponse()
            ->withStatus(503, self::STATUS_503_MESSAGE);
    }

    /**
     * Called when the solr server is unavailable.
     */
    protected function handleSolrUnavailable(): ResponseInterface
    {
        parent::logSolrUnavailable();
        return new ForwardResponse('solrNotAvailable');
    }

    /**
     * This method can be overwritten to add additionalFilters for the autosuggest.
     * By default, suggest controller will apply the configured filters from the typoscript configuration.
     *
     * @return array
     */
    protected function getAdditionalFilters(): array
    {
        return [];
    }
}

TYPO3-Solr / ext-solr

Push — task/3376-TYPO3_12_compatibili... ( 00c9eb...0c91ac )

SearchController::handleSolrUnavailable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
