MDL-61102 core_search: Improve performance by reducing schema checks
[moodle.git] / search / index.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Global Search index page for entering queries and display of results
19  *
20  * @package   core_search
21  * @copyright Prateek Sachan {@link http://prateeksachan.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once(__DIR__ . '/../config.php');
27 $page = optional_param('page', 0, PARAM_INT);
28 $q = optional_param('q', '', PARAM_NOTAGS);
29 $title = optional_param('title', '', PARAM_NOTAGS);
30 $contextid = optional_param('context', 0, PARAM_INT);
31 // Moving areaids, courseids, timestart, and timeend further down as they might come as an array if they come from the form.
33 $context = context_system::instance();
34 $pagetitle = get_string('globalsearch', 'search');
35 $PAGE->set_context($context);
36 $PAGE->set_pagelayout('standard');
37 $PAGE->set_title($pagetitle);
38 $PAGE->set_heading($pagetitle);
40 if (!empty($CFG->forcelogin)) {
41     require_login();
42 }
44 require_capability('moodle/search:query', $context);
46 $searchrenderer = $PAGE->get_renderer('core_search');
48 if (\core_search\manager::is_global_search_enabled() === false) {
49     $PAGE->set_url(new moodle_url('/search/index.php'));
50     echo $OUTPUT->header();
51     echo $OUTPUT->heading($pagetitle);
52     echo $searchrenderer->render_search_disabled();
53     echo $OUTPUT->footer();
54     exit;
55 }
57 $search = \core_search\manager::instance(true);
59 // Set up custom data for form.
60 $customdata = ['searchengine' => $search->get_engine()->get_plugin_name()];
61 if ($contextid) {
62     // When a context is supplied, check if it's within course level. If so, show dropdown.
63     $context = context::instance_by_id($contextid);
64     $coursecontext = $context->get_course_context(false);
65     if ($coursecontext) {
66         $searchwithin = [];
67         $searchwithin[''] = get_string('everywhere', 'search');
68         $searchwithin['course'] = $coursecontext->get_context_name();
69         if ($context->contextlevel !== CONTEXT_COURSE) {
70             $searchwithin['context'] = $context->get_context_name();
71         }
72         $customdata['searchwithin'] = $searchwithin;
73     }
75     // Get available ordering options from search engine.
76     $customdata['orderoptions'] = $search->get_engine()->get_supported_orders($context);
77 }
78 $mform = new \core_search\output\form\search(null, $customdata);
80 $data = $mform->get_data();
81 if (!$data && $q) {
82     // Data can also come from the URL.
84     $data = new stdClass();
85     $data->q = $q;
86     $data->title = $title;
87     $areaids = optional_param('areaids', '', PARAM_RAW);
88     if (!empty($areaids)) {
89         $areaids = explode(',', $areaids);
90         $data->areaids = clean_param_array($areaids, PARAM_ALPHANUMEXT);
91     }
92     $courseids = optional_param('courseids', '', PARAM_RAW);
93     if (!empty($courseids)) {
94         $courseids = explode(',', $courseids);
95         $data->courseids = clean_param_array($courseids, PARAM_INT);
96     }
97     $data->timestart = optional_param('timestart', 0, PARAM_INT);
98     $data->timeend = optional_param('timeend', 0, PARAM_INT);
100     $data->context = $contextid;
102     $mform->set_data($data);
105 // Convert the 'search within' option, if used, to course or context restrictions.
106 if ($data && !empty($data->searchwithin)) {
107     switch ($data->searchwithin) {
108         case 'course':
109             $data->courseids = [$coursecontext->instanceid];
110             break;
111         case 'context':
112             $data->courseids = [$coursecontext->instanceid];
113             $data->contextids = [$context->id];
114             break;
115     }
118 // Inform search engine about source context.
119 if (!empty($context) && $data) {
120     $data->context = $context;
123 // Set the page URL.
124 $urlparams = array('page' => $page);
125 if ($data) {
126     $urlparams['q'] = $data->q;
127     $urlparams['title'] = $data->title;
128     if (!empty($data->areaids)) {
129         $urlparams['areaids'] = implode(',', $data->areaids);
130     }
131     if (!empty($data->courseids)) {
132         $urlparams['courseids'] = implode(',', $data->courseids);
133     }
134     $urlparams['timestart'] = $data->timestart;
135     $urlparams['timeend'] = $data->timeend;
137 $url = new moodle_url('/search/index.php', $urlparams);
138 $PAGE->set_url($url);
140 // We are ready to render.
141 echo $OUTPUT->header();
142 echo $OUTPUT->heading($pagetitle);
144 // Get the results.
145 if ($data) {
146     $results = $search->paged_search($data, $page);
149 if ($errorstr = $search->get_engine()->get_query_error()) {
150     echo $OUTPUT->notification(get_string('queryerror', 'search', $errorstr), 'notifyproblem');
151 } else if (empty($results->totalcount) && !empty($data)) {
152     echo $OUTPUT->notification(get_string('noresults', 'search'), 'notifymessage');
155 $mform->display();
157 if (!empty($results)) {
158     echo $searchrenderer->render_results($results->results, $results->actualpage, $results->totalcount, $url);
160     \core_search\manager::trigger_search_results_viewed([
161         'q' => $data->q,
162         'page' => $page,
163         'title' => $data->title,
164         'areaids' => !empty($data->areaids) ? $data->areaids : array(),
165         'courseids' => !empty($data->courseids) ? $data->courseids : array(),
166         'timestart' => isset($data->timestart) ? $data->timestart : 0,
167         'timeend' => isset($data->timeend) ? $data->timeend : 0
168     ]);
172 echo $OUTPUT->footer();