1 |
efrain |
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/>.
|
|
|
16 |
|
|
|
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 |
*/
|
|
|
24 |
|
|
|
25 |
require_once(__DIR__ . '/../config.php');
|
|
|
26 |
|
|
|
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);
|
|
|
32 |
$mycoursesonly = optional_param('mycoursesonly', 0, PARAM_INT);
|
|
|
33 |
|
|
|
34 |
if (\core_search\manager::is_search_area_categories_enabled()) {
|
|
|
35 |
$cat = \core_search\manager::get_search_area_category_by_name($cat);
|
|
|
36 |
}
|
|
|
37 |
|
|
|
38 |
// Moving areaids, courseids, timestart, and timeend further down as they might come as an array if they come from the form.
|
|
|
39 |
|
|
|
40 |
$context = context_system::instance();
|
|
|
41 |
$pagetitle = get_string('globalsearch', 'search');
|
|
|
42 |
$PAGE->set_context($context);
|
|
|
43 |
$PAGE->set_pagelayout('standard');
|
|
|
44 |
$PAGE->set_title($pagetitle);
|
|
|
45 |
$PAGE->set_heading($pagetitle);
|
|
|
46 |
|
|
|
47 |
if (!empty($CFG->forcelogin)) {
|
|
|
48 |
require_login();
|
|
|
49 |
}
|
|
|
50 |
|
|
|
51 |
require_capability('moodle/search:query', $context);
|
|
|
52 |
|
|
|
53 |
$searchrenderer = $PAGE->get_renderer('core_search');
|
|
|
54 |
|
|
|
55 |
if (\core_search\manager::is_global_search_enabled() === false) {
|
|
|
56 |
$PAGE->set_url(new moodle_url('/search/index.php'));
|
|
|
57 |
echo $OUTPUT->header();
|
|
|
58 |
echo $searchrenderer->render_search_disabled();
|
|
|
59 |
echo $OUTPUT->footer();
|
|
|
60 |
exit;
|
|
|
61 |
}
|
|
|
62 |
|
|
|
63 |
$search = \core_search\manager::instance(true, true);
|
|
|
64 |
|
|
|
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 |
}
|
|
|
84 |
|
|
|
85 |
}
|
|
|
86 |
// Get available ordering options from search engine.
|
|
|
87 |
$customdata['orderoptions'] = $search->get_engine()->get_supported_orders($context);
|
|
|
88 |
|
|
|
89 |
if ($cat instanceof \core_search\area_category) {
|
|
|
90 |
$customdata['cat'] = $cat->get_name();
|
|
|
91 |
}
|
|
|
92 |
|
|
|
93 |
$mform = new \core_search\output\form\search(null, $customdata);
|
|
|
94 |
|
|
|
95 |
$data = $mform->get_data();
|
|
|
96 |
if (!$data && $q) {
|
|
|
97 |
// Data can also come from the URL.
|
|
|
98 |
|
|
|
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);
|
|
|
114 |
|
|
|
115 |
$data->context = $contextid;
|
|
|
116 |
$data->mycoursesonly = $mycoursesonly;
|
|
|
117 |
|
|
|
118 |
$mform->set_data($data);
|
|
|
119 |
}
|
|
|
120 |
|
|
|
121 |
// Convert the 'search within' option, if used, to course or context restrictions.
|
|
|
122 |
if ($data && !empty($data->searchwithin)) {
|
|
|
123 |
switch ($data->searchwithin) {
|
|
|
124 |
case 'course':
|
|
|
125 |
$data->courseids = [$coursecontext->instanceid];
|
|
|
126 |
break;
|
|
|
127 |
case 'context':
|
|
|
128 |
$data->courseids = [$coursecontext->instanceid];
|
|
|
129 |
$data->contextids = [$context->id];
|
|
|
130 |
break;
|
|
|
131 |
}
|
|
|
132 |
}
|
|
|
133 |
|
|
|
134 |
// Inform search engine about source context.
|
|
|
135 |
if (!empty($context) && $data) {
|
|
|
136 |
$data->context = $context;
|
|
|
137 |
}
|
|
|
138 |
|
|
|
139 |
if ($data && $cat instanceof \core_search\area_category) {
|
|
|
140 |
$data->cat = $cat->get_name();
|
|
|
141 |
}
|
|
|
142 |
|
|
|
143 |
// Set the page URL.
|
|
|
144 |
$urlparams = array('page' => $page);
|
|
|
145 |
if ($data) {
|
|
|
146 |
$urlparams['q'] = $data->q;
|
|
|
147 |
$urlparams['title'] = $data->title;
|
|
|
148 |
if (!empty($data->areaids)) {
|
|
|
149 |
$urlparams['areaids'] = implode(',', $data->areaids);
|
|
|
150 |
}
|
|
|
151 |
if (!empty($data->courseids)) {
|
|
|
152 |
$urlparams['courseids'] = implode(',', $data->courseids);
|
|
|
153 |
}
|
|
|
154 |
$urlparams['timestart'] = $data->timestart;
|
|
|
155 |
$urlparams['timeend'] = $data->timeend;
|
|
|
156 |
$urlparams['mycoursesonly'] = isset($data->mycoursesonly) ? $data->mycoursesonly : 0;
|
|
|
157 |
}
|
|
|
158 |
|
|
|
159 |
if ($cat instanceof \core_search\area_category) {
|
|
|
160 |
$urlparams['cat'] = $cat->get_name();
|
|
|
161 |
}
|
|
|
162 |
|
|
|
163 |
$url = new moodle_url('/search/index.php', $urlparams);
|
|
|
164 |
$PAGE->set_url($url);
|
|
|
165 |
|
|
|
166 |
// We are ready to render.
|
|
|
167 |
echo $OUTPUT->header();
|
|
|
168 |
|
|
|
169 |
// Unlock the session only after outputting the header as this modifies the session cachestore.
|
|
|
170 |
\core\session\manager::write_close();
|
|
|
171 |
|
|
|
172 |
// Get the results.
|
|
|
173 |
if ($data) {
|
|
|
174 |
$results = $search->paged_search($data, $page);
|
|
|
175 |
}
|
|
|
176 |
|
|
|
177 |
// Show search information if configured by system administrator.
|
|
|
178 |
if ($CFG->searchbannerenable && $CFG->searchbanner) {
|
|
|
179 |
echo $OUTPUT->notification(format_text($CFG->searchbanner, FORMAT_HTML), 'notifywarning');
|
|
|
180 |
}
|
|
|
181 |
|
|
|
182 |
if ($errorstr = $search->get_engine()->get_query_error()) {
|
|
|
183 |
echo $OUTPUT->notification(get_string('queryerror', 'search', $errorstr), 'notifyproblem');
|
|
|
184 |
} else if (empty($results->totalcount) && !empty($data)) {
|
|
|
185 |
echo $OUTPUT->notification(get_string('noresults', 'search'), 'notifymessage');
|
|
|
186 |
}
|
|
|
187 |
|
|
|
188 |
$mform->display();
|
|
|
189 |
|
|
|
190 |
if (!empty($results)) {
|
|
|
191 |
$topresults = $search->search_top($data);
|
|
|
192 |
if (!empty($topresults)) {
|
|
|
193 |
echo $searchrenderer->render_top_results($topresults);
|
|
|
194 |
}
|
|
|
195 |
echo $searchrenderer->render_results($results->results, $results->actualpage, $results->totalcount, $url, $cat);
|
|
|
196 |
|
|
|
197 |
\core_search\manager::trigger_search_results_viewed([
|
|
|
198 |
'q' => $data->q,
|
|
|
199 |
'page' => $page,
|
|
|
200 |
'title' => $data->title,
|
|
|
201 |
'areaids' => !empty($data->areaids) ? $data->areaids : array(),
|
|
|
202 |
'courseids' => !empty($data->courseids) ? $data->courseids : array(),
|
|
|
203 |
'timestart' => isset($data->timestart) ? $data->timestart : 0,
|
|
|
204 |
'timeend' => isset($data->timeend) ? $data->timeend : 0
|
|
|
205 |
]);
|
|
|
206 |
|
|
|
207 |
}
|
|
|
208 |
|
|
|
209 |
echo $OUTPUT->footer();
|