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

Complexity

Conditions	25
Paths	614

Size

Total Lines	120
Code Lines	64

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

<?php
    public function mainAction(): ResponseInterface
    {
        $listViewSearch = false;
        // Quit without doing anything if required variables are not set.
        if (empty($this->settings['solrcore'])) {
            $this->logger->warning('Incomplete plugin configuration');
            return $this->htmlResponse();
        }

        // if search was triggered, get search parameters from POST variables
        $this->searchParams = $this->getParametersSafely('searchParameter');

It seems like $this->getParametersSafely('searchParameter') can also be of type string. However, the property $searchParams is declared as type array. Maybe add an additional type check?

        // if search was triggered by the ListView plugin, get the parameters from GET variables
        // replace with $this->request->getQueryParams() when dropping support for Typo3 v11, see Deprecation-100596
        $listRequestData = GeneralUtility::_GPmerged('tx_dlf_listview');
        // Quit without doing anything if no search parameters.
        if (empty($this->searchParams) && empty($listRequestData)) {
            $this->logger->warning('Missing search parameters');
            return $this->htmlResponse();
        }

        if (isset($listRequestData['searchParameter']) && is_array($listRequestData['searchParameter'])) {
            $this->searchParams = array_merge($this->searchParams ?: [], $listRequestData['searchParameter']);
            $listViewSearch = true;
            $GLOBALS['TSFE']->fe_user->setKey('ses', 'search', $this->searchParams);
        }

        // sanitize date search input
        if (!empty($this->searchParams['dateFrom']) || !empty($this->searchParams['dateTo'])) {
            if (empty($this->searchParams['dateFrom']) && !empty($this->searchParams['dateTo'])) {
                $this->searchParams['dateFrom'] = '*';
            }

            if (empty($this->searchParams['dateTo']) && !empty($this->searchParams['dateFrom'])) {
                $this->searchParams['dateTo'] = 'NOW';
            }

            if ($this->searchParams['dateFrom'] > $this->searchParams['dateTo']) {
                $tmpDate = $this->searchParams['dateFrom'];
                $this->searchParams['dateFrom'] = $this->searchParams['dateTo'];
                $this->searchParams['dateTo'] = $tmpDate;
            }
        }

        // Pagination of Results: Pass the currentPage to the fluid template to calculate current index of search result.
        $currentPage = $this->getParametersSafely('page');
        if (empty($currentPage)) {
            $currentPage = 1;
        }

        // If a targetPid is given, the results will be shown by ListView on the target page.
        if (!empty($this->settings['targetPid']) && !empty($this->searchParams) && !$listViewSearch) {
            return $this->redirect(
                'main',
                'ListView',
                null,
                [
                    'searchParameter' => $this->searchParams,
                    'page' => $currentPage
                ], $this->settings['targetPid']
            );
        }

        // If no search has been executed, no variables have to be prepared.
        // An empty form will be shown.
        if (is_array($this->searchParams) && !empty($this->searchParams)) {
            // get all sortable metadata records
            $sortableMetadata = $this->metadataRepository->findByIsSortable(true);

The method findByIsSortable() does not exist on Kitodo\Dlf\Domain\Repository\MetadataRepository. Since you implemented __call, consider adding a @method annotation.

            // get all metadata records to be shown in results
            $listedMetadata = $this->metadataRepository->findByIsListed(true);

The method findByIsListed() does not exist on Kitodo\Dlf\Domain\Repository\MetadataRepository. Since you implemented __call, consider adding a @method annotation.

            // get all indexed metadata fields
            $indexedMetadata = $this->metadataRepository->findByIndexIndexed(true);

The method findByIndexIndexed() does not exist on Kitodo\Dlf\Domain\Repository\MetadataRepository. Since you implemented __call, consider adding a @method annotation.

            $solrResults = null;
            $numResults = 0;
            // Do not execute the Solr search if used together with ListView plugin.
            if (!$listViewSearch) {
                $solrResults = $this->documentRepository->findSolrWithoutCollection($this->settings, $this->searchParams, $listedMetadata, $indexedMetadata);
                $numResults = $solrResults->getNumFound();

                $itemsPerPage = $this->settings['list']['paginate']['itemsPerPage'];
                if (empty($itemsPerPage)) {
                    $itemsPerPage = 25;
                }
                $solrPaginator = new SolrPaginator($solrResults, $currentPage, $itemsPerPage);
                $simplePagination = new SimplePagination($solrPaginator);

                $pagination = $this->buildSimplePagination($simplePagination, $solrPaginator);
                $this->view->assignMultiple([ 'pagination' => $pagination, 'paginator' => $solrPaginator ]);
            }

            $this->view->assign('documents', !empty($solrResults) ? $solrResults : []);
            $this->view->assign('numResults', $numResults);
            $this->view->assign('page', $currentPage);
            $this->view->assign('lastSearch', $this->searchParams);
            $this->view->assign('listedMetadata', $listedMetadata);
            $this->view->assign('sortableMetadata', $sortableMetadata);

            // Add the facets menu
            $this->addFacetsMenu();
        }

        // Get additional fields for extended search.
        $this->addExtendedSearch();

        // Add the current document if present to fluid. This way, we can limit further searches to this document.
        if (isset($this->requestData['id'])) {
            $currentDocument = $this->documentRepository->findByUid($this->requestData['id']);
            $this->view->assign('currentDocument', $currentDocument);
        }

        // Add uHash parameter to suggest parameter to make a basic protection of this form.
        if ($this->settings['suggest']) {
            $this->view->assign('uHash', GeneralUtility::hmac((string) (new Typo3Version()) . Environment::getExtensionsPath(), 'SearchSuggest'));
        }

        $this->view->assign('viewData', $this->viewData);

        return $this->htmlResponse();
    }