Passed
Push — master ( e5e90f...34c53e )
by Andreas
27:38
created

_handler_result()   B

Complexity

Conditions 9
Paths 11

Size

Total Lines 34
Code Lines 22

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 17
CRAP Score 9.9512

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 9
eloc 22
c 1
b 0
f 0
nc 11
nop 2
dl 0
loc 34
ccs 17
cts 22
cp 0.7727
crap 9.9512
rs 8.0555
1
<?php
2
/**
3
 * @package midcom.helper.search
4
 * @author CONTENT CONTROL http://www.contentcontrol-berlin.de/
5
 * @copyright CONTENT CONTROL http://www.contentcontrol-berlin.de/
6
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License
7
 */
8
9
use Symfony\Component\HttpFoundation\Request;
10
11
/**
12
 * Search handler
13
 *
14
 * @package midcom.helper.search
15
 */
16
class midcom_helper_search_handler_search extends midcom_baseclasses_components_handler
17
{
18
    /**
19
     * Search form handler, nothing to do here.
20
     *
21
     * It uses the handler ID to distinguish between basic and advanced search forms.
22
     */
23 2
    public function _handler_searchform(Request $request, string $handler_id)
24
    {
25 2
        $this->prepare_formdata($handler_id, $request);
26 2
        $this->populate_toolbar($request);
27 2
        return $this->show('search_form');
28
    }
29
30 4
    private function prepare_formdata(string $handler_id, Request $request)
31
    {
32 4
        $this->_request_data['query'] = $this->fetch($request, 'query', '');
33 4
        if ($handler_id === 'advanced') {
34 2
            $this->_request_data['request_topic'] = trim($this->fetch($request, 'topic', ''));
35 2
            $this->_request_data['component'] = trim($this->fetch($request, 'component', ''));
36 2
            $this->_request_data['lastmodified'] = (int) trim($this->fetch($request, 'lastmodified', '0'));
37
38 2
            $this->_request_data['topics'] = ['' => $this->_l10n->get('search anywhere')];
39 2
            $this->_request_data['components'] = ['' => $this->_l10n->get('search all content types')];
40
41 2
            $nap = new midcom_helper_nav();
42 2
            $this->search_nodes($nap->get_node($nap->get_root_node()), $nap, '');
0 ignored issues
show
Bug introduced by
It seems like $nap->get_node($nap->get_root_node()) can also be of type null; however, parameter $node of midcom_helper_search_han..._search::search_nodes() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

42
            $this->search_nodes(/** @scrutinizer ignore-type */ $nap->get_node($nap->get_root_node()), $nap, '');
Loading history...
43
        }
44 4
        $this->_request_data['type'] = $handler_id;
45
    }
46
47 4
    private function fetch(Request $request, string $field, $default = null, bool $is_array = false)
48
    {
49 4
        if ($is_array) {
50 1
            $method = 'all';
51 1
            $default ??= [];
52
        } else {
53 4
            $method = 'get';
54
        }
55
56 4
        if ($request->request->has($field)) {
57
            return $request->request->$method($field);
58
        }
59 4
        return $request->query->$method($field, $default);
60
    }
61
62
    /**
63
     * Prepare the topic and component listings, this is a bit work intensive though,
64
     * we need to traverse everything.
65
     */
66 2
    private function search_nodes(array $node, midcom_helper_nav $nap, string $prefix)
67
    {
68 2
        if (   !array_key_exists($node[MIDCOM_NAV_COMPONENT], $this->_request_data['components'])
69 2
            && $node[MIDCOM_NAV_COMPONENT] != 'midcom.helper.search') {
70
            $l10n = $this->_i18n->get_l10n($node[MIDCOM_NAV_COMPONENT]);
71
            $this->_request_data['components'][$node[MIDCOM_NAV_COMPONENT]] = $l10n->get($node[MIDCOM_NAV_COMPONENT]);
72
        }
73 2
        $this->_request_data['topics'][$node[MIDCOM_NAV_FULLURL]] = "{$prefix}{$node[MIDCOM_NAV_NAME]}";
74
75
        // Recurse
76 2
        $prefix .= "{$node[MIDCOM_NAV_NAME]} &rsaquo; ";
77 2
        foreach ($nap->get_nodes($node[MIDCOM_NAV_ID]) as $sub_node) {
78
            $this->search_nodes($sub_node, $nap, $prefix);
79
        }
80
    }
81
82
    /**
83
     * Expand arrays of custom rules to end of query
84
     *
85
     * @param string $final_query reference to the query string to be passed on to the indexer.
86
     * @param mixed $terms array or string to append
87
     */
88 1
    private function append_terms_recursive(string &$final_query, $terms)
89
    {
90 1
        if (is_array($terms)) {
91 1
            foreach ($terms as $term) {
92 1
                $this->append_terms_recursive($final_query, $term);
93
            }
94 1
        } elseif (is_string($terms)) {
95 1
            $final_query .= $terms;
96
        } else {
97
            debug_add('Don\'t know how to handle terms of type: ' . gettype($terms), MIDCOM_LOG_ERROR);
98
            debug_print_r('$terms', $terms);
99
        }
100
    }
101
102
    /**
103
     * Queries the information from the index and prepares to display the result page.
104
     */
105 2
    public function _handler_result(Request $request, array &$data)
106
    {
107 2
        $type = $this->fetch($request, 'type', 'basic');
108
        // If we don't have a query string, relocate to empty search form
109 2
        if (!$request->request->has('query') && !$request->query->has('query')) {
110
            debug_add('$_REQUEST["query"] is not set, relocating back to form', MIDCOM_LOG_INFO);
111
            return new midcom_response_relocate($this->router->generate($type));
112
        }
113 2
        $this->prepare_formdata($type, $request);
114
115 2
        if (   count(explode(' ', $data['query'])) == 1
116 2
            && !str_contains($data['query'], '*')
117 2
            && $this->_config->get('single_term_auto_wildcard')) {
118
            //If there is only one search term append * to the query if auto_wildcard is enabled
119
            $data['query'] .= '*';
120
        }
121
122 2
        if ($type == 'basic') {
123 1
            $final_query = $data['query'];
124 1
            debug_add("Final query: {$final_query}");
125 1
            $result = midcom::get()->indexer->query($final_query);
126 1
        } elseif ($type == 'advanced') {
127 1
            $result = $this->do_advanced_query($data, $this->fetch($request, 'append_terms', is_array: true));
128
        } else {
129
            throw new midcom_error_notfound('unknown query type');
130
        }
131
132 2
        $this->process_results($result, (int) $this->fetch($request, 'page', 1));
133 2
        $this->populate_toolbar($request);
134
135 2
        if ($data['document_count'] > 0) {
136
            return $this->show('results');
137
        }
138 2
        return $this->show('no_match');
139
    }
140
141 4
    private function populate_toolbar(Request $request)
142
    {
143 4
        $other_type = ($this->_request_data['type'] == 'advanced') ? 'basic' : 'advanced';
144 4
        $this->_request_data['params'] = '';
145 4
        if ($request->query->count() > 0) {
146 2
            $request->query->set('type', $other_type);
147 2
            $this->_request_data['params'] = '?' . $request->getQueryString();
148
        }
149
150 4
        $url = '';
151 4
        if ($this->_request_data['type'] == 'basic') {
152 2
            $url = 'advanced/';
153
        }
154
155 4
        $this->_view_toolbar->add_item([
156 4
            MIDCOM_TOOLBAR_URL => $url . $this->_request_data['params'],
157 4
            MIDCOM_TOOLBAR_LABEL => $this->_l10n->get($other_type . ' search'),
158 4
            MIDCOM_TOOLBAR_GLYPHICON => 'search',
159 4
        ]);
160
    }
161
162 2
    private function process_results(array $result, int $page)
163
    {
164 2
        $count = count($result);
165 2
        $this->_request_data['document_count'] = $count;
166
167 2
        if ($count == 0) {
168 2
            midcom::get()->cache->content->uncached();
169
        } else {
170
            $results_per_page = $this->_config->get('results_per_page');
171
            $max_pages = ceil($count / $results_per_page);
172
            $page = min($page, $max_pages);
173
            $first_document_id = ($page - 1) * $results_per_page;
174
            $last_document_id = min(($count - 1), (($page * $results_per_page) - 1));
175
176
            $this->_request_data['page'] = $page;
177
            $this->_request_data['max_pages'] = $max_pages;
178
            $this->_request_data['first_document_number'] = $first_document_id + 1;
179
            $this->_request_data['last_document_number'] = $last_document_id + 1;
180
            $this->_request_data['shown_documents'] = $last_document_id - $first_document_id + 1;
181
            $this->_request_data['result'] = array_slice($result, $first_document_id, $results_per_page);
0 ignored issues
show
Bug introduced by
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? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

181
            $this->_request_data['result'] = array_slice($result, $first_document_id, /** @scrutinizer ignore-type */ $results_per_page);
Loading history...
182
183
            // Register GUIDs for cache engine
184
            foreach ($this->_request_data['result'] as $doc) {
185
                if (!mgd_is_guid($doc->source)) {
186
                    // Non-Midgard results don't need to go through cache registration
187
                    continue;
188
                }
189
                midcom::get()->cache->content->register($doc->source);
190
            }
191
            reset($this->_request_data['result']);
192
        }
193
    }
194
195 1
    private function do_advanced_query(array &$data, $append_terms) : array
196
    {
197 1
        $filter = new midcom_services_indexer_filter_chained;
198 1
        if ($data['lastmodified'] > 0) {
199 1
            $filter->add_filter(new midcom_services_indexer_filter_date('__EDITED', $data['lastmodified'], 0));
200
        }
201
202 1
        $final_query = '';
203 1
        if ($data['query'] != '') {
204 1
            $final_query = (midcom::get()->config->get('indexer_backend') == 'solr') ? $data['query'] : "({$data['query']})";
205
        }
206
207 1
        if ($data['request_topic'] != '') {
208
            $filter->add_filter(new midcom_services_indexer_filter_string('__TOPIC_URL', '"' . $data['request_topic'] . '*"'));
209
        }
210
211 1
        if ($data['component'] != '') {
212
            $filter->add_filter(new midcom_services_indexer_filter_string('__COMPONENT', $data['component']));
213
        }
214
215
        // Way to add very custom terms
216 1
        if ($append_terms) {
217 1
            $this->append_terms_recursive($final_query, $append_terms);
218
        }
219
220 1
        debug_add("Final query: {$final_query}");
221
222 1
        if ($filter->count() == 0) {
223
            $filter = null;
224
        }
225 1
        return midcom::get()->indexer->query($final_query, $filter);
226
    }
227
228
    /**
229
     * Prepare OpenSearch data file for browser search bar integration.
230
     */
231 1
    public function _handler_opensearchdescription(array &$data)
232
    {
233 1
        midcom::get()->cache->content->content_type("application/opensearchdescription+xml; charset=UTF-8");
234 1
        midcom::get()->skip_page_style = true;
235
236 1
        $data['node'] = $this->_topic;
237 1
        return $this->show('opensearch_description');
238
    }
239
}
240