MDL-60913 search: add search area categories
[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 $cat = optional_param('cat', '', PARAM_NOTAGS);
33 if (\core_search\manager::is_search_area_categories_enabled()) {
34     $cat = \core_search\manager::get_search_area_category_by_name($cat);
35 }
37 // Moving areaids, courseids, timestart, and timeend further down as they might come as an array if they come from the form.
39 $context = context_system::instance();
40 $pagetitle = get_string('globalsearch', 'search');
41 $PAGE->set_context($context);
42 $PAGE->set_pagelayout('standard');
43 $PAGE->set_title($pagetitle);
44 $PAGE->set_heading($pagetitle);
46 if (!empty($CFG->forcelogin)) {
47     require_login();
48 }
50 require_capability('moodle/search:query', $context);
52 $searchrenderer = $PAGE->get_renderer('core_search');
54 if (\core_search\manager::is_global_search_enabled() === false) {
55     $PAGE->set_url(new moodle_url('/search/index.php'));
56     echo $OUTPUT->header();
57     echo $OUTPUT->heading($pagetitle);
58     echo $searchrenderer->render_search_disabled();
59     echo $OUTPUT->footer();
60     exit;
61 }
63 $search = \core_search\manager::instance(true);
65 // Set up custom data for form.
66 $customdata = ['searchengine' => $search->get_engine()->get_plugin_name()];
67 if ($contextid) {
68     // When a context is supplied, check if it's within course level. If so, show dropdown.
69     $context = context::instance_by_id($contextid);
70     $coursecontext = $context->get_course_context(false);
71     if ($coursecontext) {
72         $searchwithin = [];
73         $searchwithin[''] = get_string('everywhere', 'search');
74         $searchwithin['course'] = $coursecontext->get_context_name();
75         if ($context->contextlevel != CONTEXT_COURSE) {
76             $searchwithin['context'] = $context->get_context_name();
77             if ($context->contextlevel == CONTEXT_MODULE) {
78                 $customdata['withincmid'] = $context->instanceid;
79             }
80         }
81         $customdata['searchwithin'] = $searchwithin;
82         $customdata['withincourseid'] = $coursecontext->instanceid;
83     }
85 }
86 // Get available ordering options from search engine.
87 $customdata['orderoptions'] = $search->get_engine()->get_supported_orders($context);
89 if ($cat instanceof \core_search\area_category) {
90     $customdata['cat'] = $cat->get_name();
91 }
93 $mform = new \core_search\output\form\search(null, $customdata);
95 $data = $mform->get_data();
96 if (!$data && $q) {
97     // Data can also come from the URL.
99     $data = new stdClass();
100     $data->q = $q;
101     $data->title = $title;
102     $areaids = optional_param('areaids', '', PARAM_RAW);
103     if (!empty($areaids)) {
104         $areaids = explode(',', $areaids);
105         $data->areaids = clean_param_array($areaids, PARAM_ALPHANUMEXT);
106     }
107     $courseids = optional_param('courseids', '', PARAM_RAW);
108     if (!empty($courseids)) {
109         $courseids = explode(',', $courseids);
110         $data->courseids = clean_param_array($courseids, PARAM_INT);
111     }
112     $data->timestart = optional_param('timestart', 0, PARAM_INT);
113     $data->timeend = optional_param('timeend', 0, PARAM_INT);
115     $data->context = $contextid;
117     $mform->set_data($data);
120 // Convert the 'search within' option, if used, to course or context restrictions.
121 if ($data && !empty($data->searchwithin)) {
122     switch ($data->searchwithin) {
123         case 'course':
124             $data->courseids = [$coursecontext->instanceid];
125             break;
126         case 'context':
127             $data->courseids = [$coursecontext->instanceid];
128             $data->contextids = [$context->id];
129             break;
130     }
133 // Inform search engine about source context.
134 if (!empty($context) && $data) {
135     $data->context = $context;
138 if ($data && $cat instanceof \core_search\area_category) {
139     $data->cat = $cat->get_name();
142 // Set the page URL.
143 $urlparams = array('page' => $page);
144 if ($data) {
145     $urlparams['q'] = $data->q;
146     $urlparams['title'] = $data->title;
147     if (!empty($data->areaids)) {
148         $urlparams['areaids'] = implode(',', $data->areaids);
149     }
150     if (!empty($data->courseids)) {
151         $urlparams['courseids'] = implode(',', $data->courseids);
152     }
153     $urlparams['timestart'] = $data->timestart;
154     $urlparams['timeend'] = $data->timeend;
157 if ($cat instanceof \core_search\area_category) {
158     $urlparams['cat'] = $cat->get_name();
161 $url = new moodle_url('/search/index.php', $urlparams);
162 $PAGE->set_url($url);
164 // We are ready to render.
165 echo $OUTPUT->header();
166 echo $OUTPUT->heading($pagetitle);
168 // Get the results.
169 if ($data) {
170     $results = $search->paged_search($data, $page);
173 if ($errorstr = $search->get_engine()->get_query_error()) {
174     echo $OUTPUT->notification(get_string('queryerror', 'search', $errorstr), 'notifyproblem');
175 } else if (empty($results->totalcount) && !empty($data)) {
176     echo $OUTPUT->notification(get_string('noresults', 'search'), 'notifymessage');
179 $mform->display();
181 if (!empty($results)) {
182     echo $searchrenderer->render_results($results->results, $results->actualpage, $results->totalcount, $url, $cat);
184     \core_search\manager::trigger_search_results_viewed([
185         'q' => $data->q,
186         'page' => $page,
187         'title' => $data->title,
188         'areaids' => !empty($data->areaids) ? $data->areaids : array(),
189         'courseids' => !empty($data->courseids) ? $data->courseids : array(),
190         'timestart' => isset($data->timestart) ? $data->timestart : 0,
191         'timeend' => isset($data->timeend) ? $data->timeend : 0
192     ]);
196 echo $OUTPUT->footer();