Kitodo\Dlf\Controller\SearchController::searchAction()

Complexity

Conditions	38
Paths	> 20000

Size

Total Lines	149
Code Lines	94

Duplication

Lines	0
Ratio	0 %

Importance

Changes	8
Bugs	0	Features	0

<?php
    public function searchAction()
    {
        $requestData = GeneralUtility::_GPmerged('tx_dlf');
        unset($requestData['__referrer'], $requestData['__trustedProperties']);

        $this->extConf = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get($this->extKey);

        // Build label for result list.
        $label = htmlspecialchars(LocalizationUtility::translate('search.search', 'dlf'));

It seems like TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate('search.search', 'dlf') can also be of type null; however, parameter $string of htmlspecialchars() does only seem to accept string, maybe add an additional type check?

        if (!empty($requestData['query'])) {
            $label .= ' ' . htmlspecialchars(sprintf(LocalizationUtility::translate('search.for', 'dlf'), trim($requestData['query'])));

It seems like TYPO3\CMS\Extbase\Utility\LocalizationUtility::translate('search.for', 'dlf') can also be of type null; however, parameter $format of sprintf() does only seem to accept string, maybe add an additional type check?

        }
        // Prepare query parameters.
        $params = [];
        $matches = [];
        // Set search query.
        if (
            (!empty($this->settings['fulltext']) && !empty($requestData['fulltext']))
            || preg_match('/fulltext:\((.*)\)/', trim($requestData['query']), $matches)
        ) {
            // If the query already is a fulltext query e.g using the facets
            $requestData['query'] = empty($matches[1]) ? $requestData['query'] : $matches[1];
            // Search in fulltext field if applicable. Query must not be empty!
            if (!empty($requestData['query'])) {
                $query = 'fulltext:(' . Solr::escapeQuery(trim($requestData['query'])) . ')';
            }
        } else {
            // Retain given search field if valid.
            $query = Solr::escapeQueryKeepField(trim($requestData['query']), $this->settings['pages']);
        }
        // Add extended search query.
        if (
            !empty($requestData['extQuery'])
            && is_array($requestData['extQuery'])
        ) {
            $allowedOperators = ['AND', 'OR', 'NOT'];
            $allowedFields = GeneralUtility::trimExplode(',', $this->settings['extendedFields'], true);
            $numberOfExtQueries = count($requestData['extQuery']);
            for ($i = 0; $i < $numberOfExtQueries; $i++) {
                if (!empty($requestData['extQuery'][$i])) {
                    if (
                        in_array($requestData['extOperator'][$i], $allowedOperators)
                        && in_array($requestData['extField'][$i], $allowedFields)
                    ) {
                        if (!empty($query)) {
                            $query .= ' ' . $requestData['extOperator'][$i] . ' ';
                        }
                        $query .= Indexer::getIndexFieldName($requestData['extField'][$i], $this->settings['pages']) . ':(' . Solr::escapeQuery($requestData['extQuery'][$i]) . ')';

The variable $query does not seem to be defined for all execution paths leading up to this point.

                    }
                }
            }
        }
        // Add filter query for faceting.
        if (!empty($requestData['fq'])) {
            foreach ($requestData['fq'] as $filterQuery) {
                $params['filterquery'][]['query'] = $filterQuery;
            }
        }

        // Add filter query for in-document searching.
        if (
            $this->settings['searchIn'] == 'document'
            || $this->settings['searchIn'] == 'all'
        ) {
            if (
                !empty($requestData['id'])
                && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($requestData['id'])
            ) {
                // Search in document and all subordinates (valid for up to three levels of hierarchy).
                $params['filterquery'][]['query'] = '_query_:"{!join from=uid to=partof}uid:{!join from=uid to=partof}uid:' . $requestData['id'] . '"' .
                    ' OR {!join from=uid to=partof}uid:' . $requestData['id'] .
                    ' OR uid:' . $requestData['id'];
                $label .= ' ' . htmlspecialchars(sprintf(LocalizationUtility::translate('search.in', 'dlf'), Document::getTitle($requestData['id'])));
            }
        }
        // Add filter query for in-collection searching.
        if (
            $this->settings['searchIn'] == 'collection'
            || $this->settings['searchIn'] == 'all'
        ) {
            if (
                !empty($requestData['collection'])
                && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($requestData['collection'])
            ) {
                $index_name = Helper::getIndexNameFromUid($requestData['collection'], 'tx_dlf_collections', $this->settings['pages']);
                $params['filterquery'][]['query'] = 'collection_faceting:("' . Solr::escapeQuery($index_name) . '")';
                $label .= ' ' . sprintf(LocalizationUtility::translate('search.in', 'dlf'), Helper::translate($index_name, 'tx_dlf_collections', $this->settings['pages']));
            }
        }
        // Add filter query for collection restrictions.
        if ($this->settings['collections']) {
            $collIds = explode(',', $this->settings['collections']);
            $collIndexNames = [];
            foreach ($collIds as $collId) {
                $collIndexNames[] = Solr::escapeQuery(Helper::getIndexNameFromUid(intval($collId), 'tx_dlf_collections', $this->settings['pages']));
            }
            // Last value is fake and used for distinction in $this->addCurrentCollection()
            $params['filterquery'][]['query'] = 'collection_faceting:("' . implode('" OR "', $collIndexNames) . '" OR "FakeValueForDistinction")';
        }
        // Set some query parameters.
        $params['query'] = !empty($query) ? $query : '*';
        $params['start'] = 0;
        $params['rows'] = 0;
        $params['sort'] = ['score' => 'desc'];
        // Instantiate search object.
        $solr = Solr::getInstance($this->settings['solrcore']);
        if (!$solr->ready) {
            $this->logger->error('Apache Solr not available');

The method error() does not exist on null.

            $this->redirect('main', 'Search', null);
            //return $this->responseFactory->createHtmlResponse($this->view->render());
        }
        // Set search parameters.
        $solr->cPid = $this->settings['pages'];
        $solr->params = $params;
        // Perform search.
        $list = $solr->search();
        $list->metadata = [
            'label' => $label,
            'thumbnail' => '',
            'searchString' => $requestData['query'],
            'fulltextSearch' => (!empty($requestData['fulltext']) ? '1' : '0'),
            'options' => $list->metadata['options']
        ];
        $list->save();
        // Clean output buffer.
        ob_end_clean();
        $additionalParams = [];
        if (!empty($requestData['logicalPage'])) {
            $additionalParams['logicalPage'] = $requestData['logicalPage'];
        }
        // Jump directly to the page view, if there is only one result and it is configured
        if ($list->metadata['options']['numberOfHits'] == 1 && !empty($this->settings['showSingleResult'])) {
            $linkConf['parameter'] = $this->settings['targetPidPageView'];
            $additionalParams['id'] = $list->current()['uid'];
            $additionalParams['highlight_word'] = preg_replace('/\s\s+/', ';', $list->metadata['searchString']);
            $additionalParams['page'] = count($list[0]['subparts']) == 1 ? $list[0]['subparts'][0]['page'] : 1;
        } else {
            // Keep some plugin variables.
            $linkConf['parameter'] = $this->settings['targetPid'];
            if (!empty($requestData['order'])) {
                $additionalParams['order'] = $requestData['order'];
                $additionalParams['asc'] = !empty($requestData['asc']) ? '1' : '0';
            }
        }
        $linkConf['forceAbsoluteUrl'] = !empty($this->settings['forceAbsoluteUrl']) ? 1 : 0;
        $linkConf['forceAbsoluteUrl.']['scheme'] = !empty($this->settings['forceAbsoluteUrl']) && !empty($this->settings['forceAbsoluteUrlHttps']) ? 'https' : 'http';
        $linkConf['additionalParams'] = GeneralUtility::implodeArrayForUrl($this->prefixId, $additionalParams, '', true, false);

        $this->redirect('main', 'Search', null, null);
    }