midcom_helper_search_handler_search

Complexity

Total Complexity

40

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Test Coverage

Coverage

75.21%

Importance

Changes	2
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	_handler_searchform()	0	5	1
A	prepare_formdata()	0	15	2
A	append_terms_recursive()	0	11	4
A	process_results()	0	30	4
A	_handler_opensearchdescription()	0	7	1
B	do_advanced_query()	0	32	8
B	_handler_result()	0	35	9
A	search_nodes()	0	13	4
A	populate_toolbar()	0	18	4
A	fetch()	0	13	3

<?php
/**
 * @package midcom.helper.search
 * @author CONTENT CONTROL http://www.contentcontrol-berlin.de/
 * @copyright CONTENT CONTROL http://www.contentcontrol-berlin.de/
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License
 */

use Symfony\Component\HttpFoundation\Request;

/**
 * Search handler
 *
 * @package midcom.helper.search
 */
class midcom_helper_search_handler_search extends midcom_baseclasses_components_handler
{
    /**
     * Search form handler, nothing to do here.
     *
     * It uses the handler ID to distinguish between basic and advanced search forms.
     */
    public function _handler_searchform(Request $request, string $handler_id)
    {
        $this->prepare_formdata($handler_id, $request);
        $this->populate_toolbar($request);
        return $this->show('search_form');
    }

    private function prepare_formdata(string $handler_id, Request $request)
    {
        $this->_request_data['query'] = $this->fetch($request, 'query', '');
        if ($handler_id === 'advanced') {
            $this->_request_data['request_topic'] = trim($this->fetch($request, 'topic', ''));
            $this->_request_data['component'] = trim($this->fetch($request, 'component', ''));
            $this->_request_data['lastmodified'] = (int) trim($this->fetch($request, 'lastmodified', '0'));

            $this->_request_data['topics'] = ['' => $this->_l10n->get('search anywhere')];
            $this->_request_data['components'] = ['' => $this->_l10n->get('search all content types')];

            $nap = new midcom_helper_nav();
            $this->search_nodes($nap->get_node($nap->get_root_node()), $nap, '');

It seems like $nap->get_node($nap->get_root_node()) can also be of type null; however, parameter $node of midcom_helper_search_handler_search::search_nodes() does only seem to accept array, maybe add an additional type check?

        }
        $this->_request_data['type'] = $handler_id;
    }

    private function fetch(Request $request, string $field, $default = null, bool $is_array = false)
    {
        if ($is_array) {
            $method = 'all';
            $default ??= [];
        } else {
            $method = 'get';
        }

        if ($request->request->has($field)) {
            return $request->request->$method($field);
        }
        return $request->query->$method($field, $default);
    }

    /**
     * Prepare the topic and component listings, this is a bit work intensive though,
     * we need to traverse everything.
     */
    private function search_nodes(array $node, midcom_helper_nav $nap, string $prefix)
    {
        if (   !array_key_exists($node[MIDCOM_NAV_COMPONENT], $this->_request_data['components'])
            && $node[MIDCOM_NAV_COMPONENT] != 'midcom.helper.search') {
            $l10n = $this->_i18n->get_l10n($node[MIDCOM_NAV_COMPONENT]);
            $this->_request_data['components'][$node[MIDCOM_NAV_COMPONENT]] = $l10n->get($node[MIDCOM_NAV_COMPONENT]);
        }
        $this->_request_data['topics'][$node[MIDCOM_NAV_FULLURL]] = "{$prefix}{$node[MIDCOM_NAV_NAME]}";

        // Recurse
        $prefix .= "{$node[MIDCOM_NAV_NAME]} › ";
        foreach ($nap->get_nodes($node[MIDCOM_NAV_ID]) as $sub_node) {
            $this->search_nodes($sub_node, $nap, $prefix);
        }
    }

    /**
     * Expand arrays of custom rules to end of query
     *
     * @param string $final_query reference to the query string to be passed on to the indexer.
     * @param mixed $terms array or string to append
     */
    private function append_terms_recursive(string &$final_query, $terms)
    {
        if (is_array($terms)) {
            foreach ($terms as $term) {
                $this->append_terms_recursive($final_query, $term);
            }
        } elseif (is_string($terms)) {
            $final_query .= $terms;
        } else {
            debug_add('Don\'t know how to handle terms of type: ' . gettype($terms), MIDCOM_LOG_ERROR);
            debug_print_r('$terms', $terms);
        }
    }

    /**
     * Queries the information from the index and prepares to display the result page.
     */
    public function _handler_result(Request $request, array &$data)
    {
        $type = $this->fetch($request, 'type', 'basic');
        // If we don't have a query string, relocate to empty search form
        if (!$request->request->has('query') && !$request->query->has('query')) {
            debug_add('$_REQUEST["query"] is not set, relocating back to form', MIDCOM_LOG_INFO);
            return new midcom_response_relocate($this->router->generate($type));
        }
        $this->prepare_formdata($type, $request);

        if (   count(explode(' ', $data['query'])) == 1
            && !str_contains($data['query'], '*')
            && $this->_config->get('single_term_auto_wildcard')) {
            //If there is only one search term append * to the query if auto_wildcard is enabled
            $data['query'] .= '*';
        }

        if ($type == 'basic') {
            $indexer = midcom::get()->indexer;
            $final_query = $data['query'];
            debug_add("Final query: {$final_query}");
            $result = $indexer->query($final_query);
        } elseif ($type == 'advanced') {
            $result = $this->do_advanced_query($data, $this->fetch($request, 'append_terms', is_array: true));
        } else {
            throw new midcom_error_notfound('unknown query type');
        }

        $this->process_results($result, (int) $this->fetch($request, 'page', 1));
        $this->populate_toolbar($request);

        if ($data['document_count'] > 0) {
            return $this->show('results');
        }
        return $this->show('no_match');
    }

    private function populate_toolbar(Request $request)
    {
        $other_type = ($this->_request_data['type'] == 'advanced') ? 'basic' : 'advanced';
        $this->_request_data['params'] = '';
        if ($request->query->count() > 0) {
            $request->query->set('type', $other_type);
            $this->_request_data['params'] = '?' . $request->getQueryString();
        }

        $url = '';
        if ($this->_request_data['type'] == 'basic') {
            $url = 'advanced/';
        }

        $this->_view_toolbar->add_item([
            MIDCOM_TOOLBAR_URL => $url . $this->_request_data['params'],
            MIDCOM_TOOLBAR_LABEL => $this->_l10n->get($other_type . ' search'),
            MIDCOM_TOOLBAR_GLYPHICON => 'search',
        ]);
    }

    private function process_results(array $result, int $page)
    {
        $count = count($result);
        $this->_request_data['document_count'] = $count;

        if ($count == 0) {
            midcom::get()->cache->content->uncached();
        } else {
            $results_per_page = $this->_config->get('results_per_page');
            $max_pages = ceil($count / $results_per_page);
            $page = min($page, $max_pages);
            $first_document_id = ($page - 1) * $results_per_page;
            $last_document_id = min(($count - 1), (($page * $results_per_page) - 1));

            $this->_request_data['page'] = $page;
            $this->_request_data['max_pages'] = $max_pages;
            $this->_request_data['first_document_number'] = $first_document_id + 1;
            $this->_request_data['last_document_number'] = $last_document_id + 1;
            $this->_request_data['shown_documents'] = $last_document_id - $first_document_id + 1;
            $this->_request_data['result'] = array_slice($result, $first_document_id, $results_per_page);

It seems like $results_per_page can also be of type false; however, parameter $length of array_slice() does only seem to accept integer|null, maybe add an additional type check?

            // Register GUIDs for cache engine
            foreach ($this->_request_data['result'] as $doc) {
                if (!mgd_is_guid($doc->source)) {
                    // Non-Midgard results don't need to go through cache registration
                    continue;
                }
                midcom::get()->cache->content->register($doc->source);
            }
            reset($this->_request_data['result']);
        }
    }

    private function do_advanced_query(array &$data, $append_terms) : array
    {
        $filter = new midcom_services_indexer_filter_chained;
        if ($data['lastmodified'] > 0) {
            $filter->add_filter(new midcom_services_indexer_filter_date('__EDITED', $data['lastmodified'], 0));
        }

        $final_query = '';
        if ($data['query'] != '') {
            $final_query = (midcom::get()->config->get('indexer_backend') == 'solr') ? $data['query'] : "({$data['query']})";
        }

        if ($data['request_topic'] != '') {
            $filter->add_filter(new midcom_services_indexer_filter_string('__TOPIC_URL', '"' . $data['request_topic'] . '*"'));
        }

        if ($data['component'] != '') {
            $filter->add_filter(new midcom_services_indexer_filter_string('__COMPONENT', $data['component']));
        }

        // Way to add very custom terms
        if ($append_terms) {
            $this->append_terms_recursive($final_query, $append_terms);
        }

        debug_add("Final query: {$final_query}");
        $indexer = midcom::get()->indexer;

        if ($filter->count() == 0) {
            $filter = null;
        }
        return $indexer->query($final_query, $filter);
    }

    /**
     * Prepare OpenSearch data file for browser search bar integration.
     */
    public function _handler_opensearchdescription(array &$data)
    {
        midcom::get()->cache->content->content_type("application/opensearchdescription+xml; charset=UTF-8");
        midcom::get()->skip_page_style = true;

        $data['node'] = $this->_topic;
        return $this->show('opensearch_description');
    }
}