SearchResultSetService::getInitialSearchIsConfigured() - Code Metrics - Inspection of "[TASK] Add faq about faceting.minimumCount (#1752)" - dkd-kaehm/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 07d864...5919d7 )

by Rafael

created 2017-11-28 09:40 UTC

getInitialSearchIsConfigured() A

↳ Parent: SearchResultSetService

Complexity

Conditions	4
Paths	4

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	1
cts	1
cp	1
rs	9.2
c	0
b	0
f	0
cc	4
eloc	2
nc	4
nop	0
crap	4

<?php

namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2015-2016 Timo Schmidt <[email protected]>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder\QueryFields;
use ApacheSolrForTypo3\Solr\Domain\Search\Query\QueryBuilder;
use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result\Parser\ResultParserRegistry;
use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequest;
use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequestAware;
use ApacheSolrForTypo3\Solr\Domain\Variants\VariantsProcessor;
use ApacheSolrForTypo3\Solr\Query;
use ApacheSolrForTypo3\Solr\Query\Modifier\Modifier;
use ApacheSolrForTypo3\Solr\Search;
use ApacheSolrForTypo3\Solr\Search\QueryAware;
use ApacheSolrForTypo3\Solr\Search\SearchAware;
use ApacheSolrForTypo3\Solr\Search\SearchComponentManager;
use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
use ApacheSolrForTypo3\Solr\System\Solr\SolrIncompleteResponseException;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result\SearchResultBuilder;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

/**
 * The SearchResultSetService is responsible to build a SearchResultSet from a SearchRequest.
 * It encapsulates the logic to trigger a search in order to be able to reuse it in multiple places.
 *
 * @author Timo Schmidt <[email protected]>
 */
class SearchResultSetService
{

    /**
     * Track, if the number of results per page has been changed by the current request
     *
     * @var bool
     */
    protected $resultsPerPageChanged = false;

    /**
     * @var Search
     */
    protected $search;

    /**
     * @var SearchResultSet
     */
    protected $lastResultSet = null;

    /**
     * @var boolean
     */
    protected $isSolrAvailable = false;

    /**
     * @var TypoScriptConfiguration
     */
    protected $typoScriptConfiguration;

    /**
     * @var SolrLogManager;
     */
    protected $logger = null;

    /**
     * @var SearchResultBuilder
     */
    protected $searchResultBuilder;

    /**
     * @var QueryBuilder
     */
    protected $queryBuilder;

    /**
     * @param TypoScriptConfiguration $configuration
     * @param Search $search
     * @param SolrLogManager $solrLogManager
     * @param SearchResultBuilder $resultBuilder
     * @param QueryBuilder $queryBuilder
     */
    public function __construct(TypoScriptConfiguration $configuration, Search $search, SolrLogManager $solrLogManager = null, SearchResultBuilder $resultBuilder = null, QueryBuilder $queryBuilder = null)
    {
        $this->search = $search;
        $this->typoScriptConfiguration = $configuration;
        $this->logger = is_null($solrLogManager) ? GeneralUtility::makeInstance(SolrLogManager::class, __CLASS__) : $solrLogManager;
        $this->searchResultBuilder = is_null($resultBuilder) ? GeneralUtility::makeInstance(SearchResultBuilder::class) : $resultBuilder;
        $this->queryBuilder = is_null($queryBuilder) ? GeneralUtility::makeInstance(QueryBuilder::class, $configuration, $solrLogManager) : $queryBuilder;
    }

    /**
     * @param bool $useCache
     * @return bool
     */
    public function getIsSolrAvailable($useCache = true)
    {
        $this->isSolrAvailable = $this->search->ping($useCache);
        return $this->isSolrAvailable;
    }

    /**
     * @return bool
     */
    public function getHasSearched()
    {
        return $this->search->hasSearched();
    }

    /**
     * Retrieves the used search instance.
     *
     * @return Search
     */
    public function getSearch()
    {
        return $this->search;
    }

    /**
     * @param Query $query
     * @param SearchRequest $searchRequest
     */
    protected function initializeRegisteredSearchComponents(Query $query, SearchRequest $searchRequest)
    {
        $searchComponents = $this->getRegisteredSearchComponents();

        foreach ($searchComponents as $searchComponent) {
            /** @var Search\SearchComponent $searchComponent */
            $searchComponent->setSearchConfiguration($this->typoScriptConfiguration->getSearchConfiguration());

            if ($searchComponent instanceof QueryAware) {
                $searchComponent->setQuery($query);
            }

            if ($searchComponent instanceof SearchRequestAware) {
                $searchComponent->setSearchRequest($searchRequest);
            }

            $searchComponent->initializeSearchComponent();
        }
    }

    /**
     * @return string
     */
    protected function getResultSetClassName()
    {
        return isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultSetClassName ']) ?
            $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultSetClassName '] : SearchResultSet::class;
    }

    /**
     * Performs a search and returns a SearchResultSet.
     *
     * @param SearchRequest $searchRequest
     * @return SearchResultSet
     */
    public function search(SearchRequest $searchRequest)
    {
        /** @var $resultSet SearchResultSet */
        $resultSetClass = $this->getResultSetClassName();
        $resultSet = GeneralUtility::makeInstance($resultSetClass);
        $resultSet->setUsedSearchRequest($searchRequest);
        $this->lastResultSet = $resultSet;

        $resultSet = $this->handleSearchHook('beforeSearch', $resultSet);

        if ($searchRequest->getRawUserQueryIsNull() && !$this->getInitialSearchIsConfigured()) {
            // when no rawQuery was passed or no initialSearch is configured, we pass an empty result set
            return $resultSet;
        }

        if ($searchRequest->getRawUserQueryIsEmptyString() && !$this->typoScriptConfiguration->getSearchQueryAllowEmptyQuery()) {
            // the user entered an empty query string "" or "  " and empty querystring is not allowed
            return $resultSet;
        }

        $rawQuery = $searchRequest->getRawUserQuery();
        $resultsPerPage = (int)$searchRequest->getResultsPerPage();
        $query = $this->queryBuilder->buildSearchQuery($rawQuery, $resultsPerPage);
        $this->initializeRegisteredSearchComponents($query, $searchRequest);
        $resultSet->setUsedQuery($query);

        // the offset mulitplier is page - 1 but not less then zero
        $offsetMultiplier = max(0, $searchRequest->getPage() - 1);
        $offSet = $offsetMultiplier * $resultsPerPage;

        // performing the actual search, sending the query to the Solr server
        $query = $this->modifyQuery($query, $searchRequest, $this->search);
        $response = $this->doASearch($query, $offSet);

        if ($resultsPerPage === 0) {
            // when resultPerPage was forced to 0 we also set the numFound to 0 to hide results, e.g.
            // when results for the initial search should not be shown.
            $response->response->numFound = 0;

        }

        $resultSet->setUsedSearch($this->search);
        $resultSet->setResponse($response);

            /** @var ResultParserRegistry $parserRegistry */
        $parserRegistry = GeneralUtility::makeInstance(ResultParserRegistry::class, $this->typoScriptConfiguration);
        $useRawDocuments = (bool)$this->typoScriptConfiguration->getValueByPathOrDefaultValue('plugin.tx_solr.features.useRawDocuments', false);
        $searchResults = $parserRegistry->getParser($resultSet)->parse($resultSet, $useRawDocuments);
        $resultSet->setSearchResults($searchResults);

        $resultSet->setUsedPage((int)$searchRequest->getPage());
        $resultSet->setUsedResultsPerPage($resultsPerPage);
        $resultSet->setUsedAdditionalFilters($this->queryBuilder->getAdditionalFilters());

        /** @var $variantsProcessor VariantsProcessor */
        $variantsProcessor = GeneralUtility::makeInstance(VariantsProcessor::class, $this->typoScriptConfiguration, $this->searchResultBuilder);
        $variantsProcessor->process($resultSet);

        /** @var $searchResultReconstitutionProcessor ResultSetReconstitutionProcessor */
        $searchResultReconstitutionProcessor = GeneralUtility::makeInstance(ResultSetReconstitutionProcessor::class);
        $searchResultReconstitutionProcessor->process($resultSet);

        $resultSet = $this->getAutoCorrection($resultSet);

        return $this->handleSearchHook('afterSearch', $resultSet);
    }

    /**
     * Retrieves the configuration filters from the TypoScript configuration, except the __pageSections filter.
     *
     * @return array
     */
    public function getAdditionalFilters()
    {
        return $this->queryBuilder->getAdditionalFilters();
    }

    /**
     * Executes the search and builds a fake response for a current bug in Apache Solr 6.3
     *
     * @param Query $query
     * @param int $offSet
     * @return \Apache_Solr_Response
     */
    protected function doASearch($query, $offSet)
    {
        $response = $this->search->search($query, $offSet, null);
        if($response === null) {
            throw new SolrIncompleteResponseException('The response retrieved from solr was incomplete', 1505989678);
        }

        return $response;
    }

    /**
     * @param SearchResultSet $searchResultSet
     * @return SearchResultSet
     */
    protected function getAutoCorrection(SearchResultSet $searchResultSet)
    {
        // no secondary search configured
        if (!$this->typoScriptConfiguration->getSearchSpellcheckingSearchUsingSpellCheckerSuggestion()) {
            return $searchResultSet;
        }

        // more then zero results
        if ($searchResultSet->getAllResultCount() > 0) {
            return $searchResultSet;
        }

        // no corrections present
        if (!$searchResultSet->getHasSpellCheckingSuggestions()) {
            return $searchResultSet;
        }

        $searchResultSet = $this->peformAutoCorrection($searchResultSet);

        return $searchResultSet;
    }

    /**
     * @param SearchResultSet $searchResultSet
     * @return SearchResultSet
     */
    protected function peformAutoCorrection(SearchResultSet $searchResultSet)
    {
        $searchRequest = $searchResultSet->getUsedSearchRequest();
        $suggestions = $searchResultSet->getSpellCheckingSuggestions();

        $maximumRuns = $this->typoScriptConfiguration->getSearchSpellcheckingNumberOfSuggestionsToTry(1);
        $runs = 0;

        foreach ($suggestions as $suggestion) {
            $runs++;

            $correction = $suggestion->getSuggestion();
            $initialQuery = $searchRequest->getRawUserQuery();

            $searchRequest->setRawQueryString($correction);
            $searchResultSet = $this->search($searchRequest);
            if ($searchResultSet->getAllResultCount() > 0) {
                $searchResultSet->setIsAutoCorrected(true);
                $searchResultSet->setCorrectedQueryString($correction);
                $searchResultSet->setInitialQueryString($initialQuery);
                break;
            }

            if ($runs > $maximumRuns) {
                break;
            }
        }
        return $searchResultSet;
    }

    /**
     * Allows to modify a query before eventually handing it over to Solr.
     *
     * @param Query $query The current query before it's being handed over to Solr.
     * @param SearchRequest $searchRequest The searchRequest, relevant in the current context
     * @param Search $search The search, relevant in the current context
     * @throws \UnexpectedValueException
     * @return Query The modified query that is actually going to be given to Solr.
     */
    protected function modifyQuery(Query $query, SearchRequest $searchRequest, Search $search)
    {
        // hook to modify the search query
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['modifySearchQuery'])) {
            foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['modifySearchQuery'] as $classReference) {
                $queryModifier = GeneralUtility::getUserObj($classReference);

                if ($queryModifier instanceof Modifier) {
                    if ($queryModifier instanceof SearchAware) {
                        $queryModifier->setSearch($search);
                    }

                    if ($queryModifier instanceof SearchRequestAware) {
                        $queryModifier->setSearchRequest($searchRequest);
                    }

                    $query = $queryModifier->modifyQuery($query);
                } else {
                    throw new \UnexpectedValueException(
                        get_class($queryModifier) . ' must implement interface ' . Modifier::class,
                        1310387414
                    );
                }
            }
        }

        return $query;
    }

    /**
     * Retrieves a single document from solr by document id.
     *
     * @param string $documentId
     * @return SearchResult
     */
    public function getDocumentById($documentId)
    {
        /* @var $query Query */
        $query = GeneralUtility::makeInstance(Query::class, $documentId);
        $query->setQueryFields(QueryFields::fromString('id'));
        $response = $this->search->search($query, 0, 1);
        $parsedData = $response->getParsedData();
        $resultDocument = isset($parsedData->response->docs[0]) ? $parsedData->response->docs[0] : null;

        return $this->searchResultBuilder->fromApacheSolrDocument($resultDocument);
    }

    /**
     * This method is used to call the registered hooks during the search execution.
     *
     * @param string $eventName
     * @param SearchResultSet $resultSet
     * @return SearchResultSet
     */
    private function handleSearchHook($eventName, SearchResultSet $resultSet)
    {
        if (!is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr'][$eventName])) {
            return $resultSet;
        }

        foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr'][$eventName] as $classReference) {
            $afterSearchProcessor = GeneralUtility::getUserObj($classReference);
            if ($afterSearchProcessor instanceof SearchResultSetProcessor) {
                $afterSearchProcessor->process($resultSet);
            }
        }

        return $resultSet;
    }

    /**
     * @return SearchResultSet
     */
    public function getLastResultSet()
    {
        return $this->lastResultSet;
    }

    /**
     * This method returns true when the last search was executed with an empty query
     * string or whitespaces only. When no search was triggered it will return false.
     *
     * @return bool
     */
    public function getLastSearchWasExecutedWithEmptyQueryString()
    {
        $wasEmptyQueryString = false;
        if ($this->lastResultSet != null) {
            $wasEmptyQueryString = $this->lastResultSet->getUsedSearchRequest()->getRawUserQueryIsEmptyString();
        }

        return $wasEmptyQueryString;
    }

    /**
     * @return bool
     */
    protected function getInitialSearchIsConfigured()
    {
        return $this->typoScriptConfiguration->getSearchInitializeWithEmptyQuery() || $this->typoScriptConfiguration->getSearchShowResultsOfInitialEmptyQuery() || $this->typoScriptConfiguration->getSearchInitializeWithQuery() || $this->typoScriptConfiguration->getSearchShowResultsOfInitialQuery();
    }

    /**
     * @return mixed
     */
    protected function getRegisteredSearchComponents()
    {
        return GeneralUtility::makeInstance(SearchComponentManager::class)->getSearchComponents();
    }
}


1		<?php
2
3		namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet;
4
5		/***************************************************************
6		* Copyright notice
7		*
8		* (c) 2015-2016 Timo Schmidt <[email protected]>
9		* All rights reserved
10		*
11		* This script is part of the TYPO3 project. The TYPO3 project is
12		* free software; you can redistribute it and/or modify
13		* it under the terms of the GNU General Public License as published by
14		* the Free Software Foundation; either version 2 of the License, or
15		* (at your option) any later version.
16		*
17		* The GNU General Public License can be found at
18		* http://www.gnu.org/copyleft/gpl.html.
19		*
20		* This script is distributed in the hope that it will be useful,
21		* but WITHOUT ANY WARRANTY; without even the implied warranty of
22		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23		* GNU General Public License for more details.
24		*
25		* This copyright notice MUST APPEAR in all copies of the script!
26		***************************************************************/
27
28		use ApacheSolrForTypo3\Solr\Domain\Search\Query\ParameterBuilder\QueryFields;
29		use ApacheSolrForTypo3\Solr\Domain\Search\Query\QueryBuilder;
30		use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result\Parser\ResultParserRegistry;
31		use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequest;
32		use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequestAware;
33		use ApacheSolrForTypo3\Solr\Domain\Variants\VariantsProcessor;
34		use ApacheSolrForTypo3\Solr\Query;
35		use ApacheSolrForTypo3\Solr\Query\Modifier\Modifier;
36		use ApacheSolrForTypo3\Solr\Search;
37		use ApacheSolrForTypo3\Solr\Search\QueryAware;
38		use ApacheSolrForTypo3\Solr\Search\SearchAware;
39		use ApacheSolrForTypo3\Solr\Search\SearchComponentManager;
40		use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
41		use ApacheSolrForTypo3\Solr\System\Logging\SolrLogManager;
42		use ApacheSolrForTypo3\Solr\System\Solr\SolrIncompleteResponseException;
43		use TYPO3\CMS\Core\Utility\GeneralUtility;
44		use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result\SearchResultBuilder;
		0 ignored issues – show Bug introduced 2017-11-28 09:44 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `ApacheSolrForTypo3\Solr\...Set\SearchResultBuilder`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
45
46		/**
47		* The SearchResultSetService is responsible to build a SearchResultSet from a SearchRequest.
48		* It encapsulates the logic to trigger a search in order to be able to reuse it in multiple places.
49		*
50		* @author Timo Schmidt <[email protected]>
51		*/
52		class SearchResultSetService
53		{
54
55		/**
56		* Track, if the number of results per page has been changed by the current request
57		*
58		* @var bool
59		*/
60		protected $resultsPerPageChanged = false;
61
62		/**
63		* @var Search
64		*/
65		protected $search;
66
67		/**
68		* @var SearchResultSet
69		*/
70		protected $lastResultSet = null;
71
72		/**
73		* @var boolean
74		*/
75		protected $isSolrAvailable = false;
76
77		/**
78		* @var TypoScriptConfiguration
79		*/
80		protected $typoScriptConfiguration;
81
82		/**
83		* @var SolrLogManager;
84		*/
85		protected $logger = null;
86
87		/**
88		* @var SearchResultBuilder
89		*/
90		protected $searchResultBuilder;
91
92		/**
93		* @var QueryBuilder
94		*/
95		protected $queryBuilder;
96
97		/**
98		* @param TypoScriptConfiguration $configuration
99		* @param Search $search
100		* @param SolrLogManager $solrLogManager
101		* @param SearchResultBuilder $resultBuilder
102		* @param QueryBuilder $queryBuilder
103		*/
104		public function __construct(TypoScriptConfiguration $configuration, Search $search, SolrLogManager $solrLogManager = null, SearchResultBuilder $resultBuilder = null, QueryBuilder $queryBuilder = null)
105	47	{
106		$this->search = $search;
107	47	$this->typoScriptConfiguration = $configuration;
108	47	$this->logger = is_null($solrLogManager) ? GeneralUtility::makeInstance(SolrLogManager::class, __CLASS__) : $solrLogManager;
109	47	$this->searchResultBuilder = is_null($resultBuilder) ? GeneralUtility::makeInstance(SearchResultBuilder::class) : $resultBuilder;
110	47	$this->queryBuilder = is_null($queryBuilder) ? GeneralUtility::makeInstance(QueryBuilder::class, $configuration, $solrLogManager) : $queryBuilder;
111	47	}
112
113		/**
114		* @param bool $useCache
115		* @return bool
116		*/
117		public function getIsSolrAvailable($useCache = true)
118		{
119		$this->isSolrAvailable = $this->search->ping($useCache);
120		return $this->isSolrAvailable;
121		}
122
123		/**
124		* @return bool
125		*/
126	30	public function getHasSearched()
127		{
128	30	return $this->search->hasSearched();
129		}
130
131		/**
132		* Retrieves the used search instance.
133		*
134		* @return Search
135		*/
136	2	public function getSearch()
137		{
138	2	return $this->search;
139		}
140
141		/**
142		* @param Query $query
143		* @param SearchRequest $searchRequest
144		*/
145		protected function initializeRegisteredSearchComponents(Query $query, SearchRequest $searchRequest)
146		{
147		$searchComponents = $this->getRegisteredSearchComponents();
148
149	38	foreach ($searchComponents as $searchComponent) {
150		/** @var Search\SearchComponent $searchComponent */
151		$searchComponent->setSearchConfiguration($this->typoScriptConfiguration->getSearchConfiguration());
152	38
153		if ($searchComponent instanceof QueryAware) {
154	38	$searchComponent->setQuery($query);
155		}
156	38
157		if ($searchComponent instanceof SearchRequestAware) {
158		$searchComponent->setSearchRequest($searchRequest);
159		}
160
161		$searchComponent->initializeSearchComponent();
162		}
163		}
164
165		/**
166	38	* @return string
167		*/
168	38	protected function getResultSetClassName()
169		{
170		return isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultSetClassName ']) ?
171	32	$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['searchResultSetClassName '] : SearchResultSet::class;
172		}
173
174	38	/**
175	3	* Performs a search and returns a SearchResultSet.
176		*
177		* @param SearchRequest $searchRequest
178	38	* @return SearchResultSet
179	2	*/
180		public function search(SearchRequest $searchRequest)
181		{
182	38	/** @var $resultSet SearchResultSet */
183		$resultSetClass = $this->getResultSetClassName();
184		$resultSet = GeneralUtility::makeInstance($resultSetClass);
185		$resultSet->setUsedSearchRequest($searchRequest);
186		$this->lastResultSet = $resultSet;
187
188		$resultSet = $this->handleSearchHook('beforeSearch', $resultSet);
189	38
190		if ($searchRequest->getRawUserQueryIsNull() && !$this->getInitialSearchIsConfigured()) {
191	38	// when no rawQuery was passed or no initialSearch is configured, we pass an empty result set
192		return $resultSet;
193	38	}
194
195	33	if ($searchRequest->getRawUserQueryIsEmptyString() && !$this->typoScriptConfiguration->getSearchQueryAllowEmptyQuery()) {
196		// the user entered an empty query string "" or " " and empty querystring is not allowed
197	33	return $resultSet;
198	33	}
199
200		$rawQuery = $searchRequest->getRawUserQuery();
201	33	$resultsPerPage = (int)$searchRequest->getResultsPerPage();
202	32	$query = $this->queryBuilder->buildSearchQuery($rawQuery, $resultsPerPage);
203		$this->initializeRegisteredSearchComponents($query, $searchRequest);
204		$resultSet->setUsedQuery($query);
205	33
206		// the offset mulitplier is page - 1 but not less then zero
207	38	$offsetMultiplier = max(0, $searchRequest->getPage() - 1);
208		$offSet = $offsetMultiplier * $resultsPerPage;
209
210		// performing the actual search, sending the query to the Solr server
211		$query = $this->modifyQuery($query, $searchRequest, $this->search);
212		$response = $this->doASearch($query, $offSet);
213
214	39	if ($resultsPerPage === 0) {
215		// when resultPerPage was forced to 0 we also set the numFound to 0 to hide results, e.g.
216	39	// when results for the initial search should not be shown.
217	39	$response->response->numFound = 0;
		0 ignored issues – show Bug introduced 2017-08-25 10:57 UTC by Report Bug Copy Issue Report The property `response` does not seem to exist. Did you mean `_response`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
218		}
219
220		$resultSet->setUsedSearch($this->search);
221		$resultSet->setResponse($response);
222
223		/** @var ResultParserRegistry $parserRegistry */
224		$parserRegistry = GeneralUtility::makeInstance(ResultParserRegistry::class, $this->typoScriptConfiguration);
225		$useRawDocuments = (bool)$this->typoScriptConfiguration->getValueByPathOrDefaultValue('plugin.tx_solr.features.useRawDocuments', false);
226		$searchResults = $parserRegistry->getParser($resultSet)->parse($resultSet, $useRawDocuments);
227		$resultSet->setSearchResults($searchResults);
228
229		$resultSet->setUsedPage((int)$searchRequest->getPage());
230		$resultSet->setUsedResultsPerPage($resultsPerPage);
231	39	$resultSet->setUsedAdditionalFilters($this->queryBuilder->getAdditionalFilters());
232
233	39	/** @var $variantsProcessor VariantsProcessor */
234		$variantsProcessor = GeneralUtility::makeInstance(VariantsProcessor::class, $this->typoScriptConfiguration, $this->searchResultBuilder);
235	39	$variantsProcessor->process($resultSet);
236	4
237		/** @var $searchResultReconstitutionProcessor ResultSetReconstitutionProcessor */
238		$searchResultReconstitutionProcessor = GeneralUtility::makeInstance(ResultSetReconstitutionProcessor::class);
239	35	$searchResultReconstitutionProcessor->process($resultSet);
240	35
241	29	$resultSet = $this->getAutoCorrection($resultSet);
242	29
243		return $this->handleSearchHook('afterSearch', $resultSet);
244		}
245	35
246	35	/**
247	35	* Retrieves the configuration filters from the TypoScript configuration, except the __pageSections filter.
248		*
249		* @return array
250		*/
251		public function getAdditionalFilters()
252	40	{
253		return $this->queryBuilder->getAdditionalFilters();
254	40	}
255	40
256		/**
257		* Executes the search and builds a fake response for a current bug in Apache Solr 6.3
258		*
259		* @param Query $query
260		* @param int $offSet
261		* @return \Apache_Solr_Response
262		*/
263		protected function doASearch($query, $offSet)
264		{
265	38	$response = $this->search->search($query, $offSet, null);
266		if($response === null) {
267	38	throw new SolrIncompleteResponseException('The response retrieved from solr was incomplete', 1505989678);
268	38	}
269	36
270		return $response;
271		}
272
273	2	/**
274		* @param SearchResultSet $searchResultSet
275		* @return SearchResultSet
276		*/
277	2	protected function getAutoCorrection(SearchResultSet $searchResultSet)
278		{
279		// no secondary search configured
280		if (!$this->typoScriptConfiguration->getSearchSpellcheckingSearchUsingSpellCheckerSuggestion()) {
281		return $searchResultSet;
282		}
283
284	43	// more then zero results
285		if ($searchResultSet->getAllResultCount() > 0) {
286		return $searchResultSet;
287	43	}
288	2
289		// no corrections present
290		if (!$searchResultSet->getHasSpellCheckingSuggestions()) {
291	43	return $searchResultSet;
292	43	}
293	41
294		$searchResultSet = $this->peformAutoCorrection($searchResultSet);
295
296	2	return $searchResultSet;
297		}
298
299	2	/**
300		* @param SearchResultSet $searchResultSet
301	2	* @return SearchResultSet
302		*/
303		protected function peformAutoCorrection(SearchResultSet $searchResultSet)
304		{
305	2	$searchRequest = $searchResultSet->getUsedSearchRequest();
306	2	$suggestions = $searchResultSet->getSpellCheckingSuggestions();
307
308		$maximumRuns = $this->typoScriptConfiguration->getSearchSpellcheckingNumberOfSuggestionsToTry(1);
309		$runs = 0;
310	2
311	2	foreach ($suggestions as $suggestion) {
312		$runs++;
313
314		$correction = $suggestion->getSuggestion();
315	2	$initialQuery = $searchRequest->getRawUserQuery();
316
317		$searchRequest->setRawQueryString($correction);
318	2	$searchResultSet = $this->search($searchRequest);
319		if ($searchResultSet->getAllResultCount() > 0) {
320		$searchResultSet->setIsAutoCorrected(true);
321		$searchResultSet->setCorrectedQueryString($correction);
322		$searchResultSet->setInitialQueryString($initialQuery);
323		break;
324		}
325
326		if ($runs > $maximumRuns) {
327	40	break;
328		}
329		}
330	40	return $searchResultSet;
331	40	}
332	40
333	40	/**
334		* Allows to modify a query before eventually handing it over to Solr.
335	40	*
336		* @param Query $query The current query before it's being handed over to Solr.
337	40	* @param SearchRequest $searchRequest The searchRequest, relevant in the current context
338		* @param Search $search The search, relevant in the current context
339	2	* @throws \UnexpectedValueException
340		* @return Query The modified query that is actually going to be given to Solr.
341		*/
342	38	protected function modifyQuery(Query $query, SearchRequest $searchRequest, Search $search)
343		{
344		// hook to modify the search query
345		if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['modifySearchQuery'])) {
346		foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr']['modifySearchQuery'] as $classReference) {
347	38	$queryModifier = GeneralUtility::getUserObj($classReference);
348	38
349	38	if ($queryModifier instanceof Modifier) {
350	38	if ($queryModifier instanceof SearchAware) {
351	38	$queryModifier->setSearch($search);
352		}
353
354	38	if ($queryModifier instanceof SearchRequestAware) {
355	38	$queryModifier->setSearchRequest($searchRequest);
356		}
357
358	38	$query = $queryModifier->modifyQuery($query);
359	38	} else {
360		throw new \UnexpectedValueException(
361	37	get_class($queryModifier) . ' must implement interface ' . Modifier::class,
362		1310387414
363		);
364	2	}
365		}
366		}
367	37
368	37	return $query;
369		}
370	37
371	37	/**
372	37	* Retrieves a single document from solr by document id.
373	37	*
374	37	* @param string $documentId
375		* @return SearchResult
376		*/
377	37	public function getDocumentById($documentId)
378	37	{
379		/* @var $query Query */
380		$query = GeneralUtility::makeInstance(Query::class, $documentId);
381	37	$query->setQueryFields(QueryFields::fromString('id'));
382	37	$response = $this->search->search($query, 0, 1);
383		$parsedData = $response->getParsedData();
384	37	$resultDocument = isset($parsedData->response->docs[0]) ? $parsedData->response->docs[0] : null;
385
386	37	return $this->searchResultBuilder->fromApacheSolrDocument($resultDocument);
387		}
388
389		/**
390		* This method is used to call the registered hooks during the search execution.
391		*
392		* @param string $eventName
393		* @param SearchResultSet $resultSet
394		* @return SearchResultSet
395		*/
396		private function handleSearchHook($eventName, SearchResultSet $resultSet)
397	38	{
398		if (!is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr'][$eventName])) {
399		return $resultSet;
400	38	}
401	2
402		foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['solr'][$eventName] as $classReference) {
403		$afterSearchProcessor = GeneralUtility::getUserObj($classReference);
404		if ($afterSearchProcessor instanceof SearchResultSetProcessor) {
405		$afterSearchProcessor->process($resultSet);
406	1	}
407		}
408
409		return $resultSet;
410	1	}
411
412	1	/**
413	1	* @return SearchResultSet
414	1	*/
415	1	public function getLastResultSet()
416	1	{
417	1	return $this->lastResultSet;
418	1	}
419	1
420	1	/**
421		* This method returns true when the last search was executed with an empty query
422		* string or whitespaces only. When no search was triggered it will return false.
423		*
424	37	* @return bool
425		*/
426		public function getLastSearchWasExecutedWithEmptyQueryString()
427		{
428	37	$wasEmptyQueryString = false;
429		if ($this->lastResultSet != null) {
430		$wasEmptyQueryString = $this->lastResultSet->getUsedSearchRequest()->getRawUserQueryIsEmptyString();
431		}
432
433		return $wasEmptyQueryString;
434		}
435	37
436		/**
437		* @return bool
438	37	*/
439	36	protected function getInitialSearchIsConfigured()
440		{
441		return $this->typoScriptConfiguration->getSearchInitializeWithEmptyQuery() \|\| $this->typoScriptConfiguration->getSearchShowResultsOfInitialEmptyQuery() \|\| $this->typoScriptConfiguration->getSearchInitializeWithQuery() \|\| $this->typoScriptConfiguration->getSearchShowResultsOfInitialQuery();
442		}
443	1
444	1	/**
445		* @return mixed
446		*/
447		protected function getRegisteredSearchComponents()
448	1	{
449		return GeneralUtility::makeInstance(SearchComponentManager::class)->getSearchComponents();
450		}
451		}
452

dkd-kaehm / ext-solr

Push — master ( 07d864...5919d7 )

getInitialSearchIsConfigured() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like