forked from moodleou/moodle-mod_forumng
/
advancedsearch.php
297 lines (268 loc) · 11.1 KB
/
advancedsearch.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Search that lets you do full-text and/or author and date conditions.
* @package mod
* @subpackage forumng
* @copyright 2011 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once('../../config.php');
require_once($CFG->libdir . '/formslib.php');
require_once('mod_forumng.php');
require_once('advancedsearchlib.php');
class advancedsearch_form extends moodleform {
public function definition() {
global $CFG;
$mform =& $this->_form;
$mform->addElement('header', 'heading', get_string('advancedsearch', 'forumng'));
$mform->addElement('hidden', 'course', $this->_customdata['course']);
$mform->addElement('hidden', 'id', $this->_customdata['id']);
if (isset($this->_customdata['cloneid'])) {
$mform->addElement('hidden', 'clone', $this->_customdata['cloneid']);
}
//words to be searched
$mform->addElement('text', 'query', get_string('words', 'forumng'), 'size="40"');
//author name or OUCU to be filtered
$mform->addElement('text', 'author', get_string('authorname', 'forumng'), 'size="40"');
// Date range_from to be filtered
$mform->addElement('date_time_selector', 'datefrom',
get_string('daterangefrom', 'forumng'),
array('optional' => true, 'startyear' => 2011, 'step' => 1,
'defaulttime' => $this->_customdata['datefrom']));
// Date range_to to be filtered
$mform->addElement('date_time_selector', 'dateto',
get_string('daterangeto', 'forumng'),
array('optional'=>true, 'startyear' => 2011, 'step' => 1,
'defaulttime' => $this->_customdata['dateto']));
// Add help buttons
$mform->addHelpButton('query', 'words', 'forumng');
$mform->addHelpButton('author', 'authorname', 'forumng');
$mform->addHelpButton('datefrom', 'daterangefrom', 'forumng');
// Add "Search all forums"/"Search this forum" and "Cancel" buttons
if ($this->_customdata['course']) {
$this->add_action_buttons(true, get_string('searchallforums', 'forumng'));
} else {
$this->add_action_buttons(true, get_string('searchthisforum', 'forumng'));
}
}
public function validation($data, $files) {
$errors = parent::validation($data, $files);
$datefrom = $data['datefrom'];
$dateto = $data['dateto'];
if ($datefrom > time()) {
$errors['datefrom'] = get_string('inappropriatedateortime', 'forumng');
}
if (($datefrom > $dateto) && $dateto) {
$errors['dateto'] = get_string('daterangemismatch', 'forumng');
}
if (($data['query'] == '') && ($data['author'] == '') && !$datefrom && !$dateto) {
$errors['query'] = get_string('nosearchcriteria', 'forumng');
}
return $errors;
}
}
///////////////////////////////////////////////////////////////////////////////
$url = new Moodle_url('/mod/forumng/advancedsearch.php');
$courseid = optional_param('course', 0, PARAM_INT);
if ($courseid) {
$url->param('course', $courseid);
$cmid = 0;
} else {
$cmid = required_param('id', PARAM_INT);
$url->param('id', $cmid);
}
$query = trim(optional_param('query', '', PARAM_RAW));
if ($query !== '') {
$url->param('query', $query);
}
$author = trim(optional_param('author', '', PARAM_RAW));
if ($author !== '') {
$url->param('author', $author);
}
$cloneid = optional_param('clone', 0, PARAM_INT);
if ($cloneid) {
// clone is used to mark shared forums
$url->param('clone', $cloneid);
}
$datefrom = optional_param_array('datefrom', 0, PARAM_INT);
if (!empty($datefrom)) {
foreach ($datefrom as $key => $value) {
$url->param('datefrom[' . $key . ']', $value);
}
}
$dateto = optional_param_array('dateto', 0, PARAM_INT);
if (!empty($dateto)) {
foreach ($dateto as $key => $value) {
$url->param('dateto[' . $key . ']', $value);
}
}
// The below are necessary to fool the form into thinking it was submitted again
// when further requests are made for multiple pages / changing group. This is
// kind of a horrible way to make the page but it means we can use get_data
// instead of manually interpreting date dropdowns (incorrectly).
$submitbutton = optional_param('submitbutton', '', PARAM_RAW);
if ($submitbutton) {
$url->param('submitbutton', $submitbutton);
}
$sesskey = optional_param('sesskey', '', PARAM_RAW);
if ($sesskey) {
$url->param('sesskey', $sesskey);
}
$form = optional_param('_qf__advancedsearch_form', 0, PARAM_INT);
if ($form) {
$url->param('_qf__advancedsearch_form', $form);
}
// Search in a single forum
if ($cmid) {
$forum = mod_forumng::get_from_cmid($cmid, $cloneid);
$cm = $forum->get_course_module();
$course = $forum->get_course();
$forum->require_view(mod_forumng::NO_GROUPS, 0, true);
mod_forumng::search_installed();
$allforums = false;
}
if ($courseid) {
$course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
require_login($course);
$coursecontext = context_course::instance($courseid);
mod_forumng::search_installed();
$allforums = true;
}
// Set up page
$PAGE->set_url($url);
$PAGE->set_heading($course->fullname);
if ($allforums) {
$PAGE->set_context($coursecontext);
$PAGE->set_title($course->shortname . ': ' . get_string('searchallforums', 'forumng'));
} else {
$PAGE->set_context($forum->get_context());
$PAGE->set_cm($cm, $course);
$PAGE->set_title($course->shortname . ': ' . format_string($forum->get_name()));
}
$PAGE->set_pagelayout('base');
$PAGE->navbar->add(get_string('advancedsearch', 'forumng'));
//set up the form
$now = date('Y-m-d');
$defaultdatefrom = empty($datefrom) ? date_parse($now . ' 0:0') : $datefrom;
$defaultdateto = empty($dateto) ? date_parse($now . ' 23:59') : $dateto;
if ($allforums) {
$editform = new advancedsearch_form('advancedsearch.php',
array('course'=> $courseid, 'id'=> $cmid, 'datefrom' => $defaultdatefrom,
'dateto' => $defaultdateto), 'get');
} else {
$editform = new advancedsearch_form('advancedsearch.php',
array('course'=> $courseid, 'id'=> $cmid, 'cloneid' => $cloneid,
'datefrom' => $defaultdatefrom, 'dateto' => $defaultdateto), 'get');
}
$inputdata = new stdClass;
$inputdata->query = $query;
$inputdata->author = $author;
$editform->set_data($inputdata);
if ($editform->is_cancelled()) {
if (isset($forum) ) {
$returnurl = $forum->get_url(mod_forumng::PARAM_PLAIN);
} else {
$returnurl = $CFG->wwwroot . '/course/view.php?id=' . $course->id;
}
redirect($returnurl, '', 0);
}
// Process form data.
$data = $editform->get_data();
// Display header
$out = mod_forumng_utils::get_renderer();
print $out->header();
$searchtitle = forumng_get_search_results_title($query, $data ? $data->author : '',
$data ? $data->datefrom : 0, $data ? $data->dateto : 0);
if (!$allforums) {
// Display group selector if required
groups_print_activity_menu($cm, $url);
$groupid = mod_forumng::get_activity_group($cm, true);
$forum->require_view($groupid, 0, true);
print '<br/><br/>';
}
$editform->display();
if ($data) {
// Searching for free text with or without filtering author and date range.
if ($query) {
$result = new local_ousearch_search($query);
if ($allforums) {
// Search all forums.
// NOTE: I think this code branch is no longer used as we removed
// the 'all forums' facility to the resources_search block, but
// perhaps it may be used in standard Moodle installs somehow.
$result->set_plugin('mod/forumng');
$result->set_course_id($courseid);
$result->set_visible_modules_in_course($COURSE);
// Restrict them to the groups they belong to.
if (!isset($USER->groupmember[$courseid])) {
$result->set_group_ids(array());
} else {
$result->set_group_ids($USER->groupmember[$courseid]);
}
// Add exceptions where they can see other groups.
$result->set_group_exceptions(local_ousearch_search::get_group_exceptions($courseid));
$result->set_user_id($USER->id);
} else {
// Search this forum.
$result->set_coursemodule($forum->get_course_module(true));
if ($groupid && $groupid!=mod_forumng::NO_GROUPS) {
$result->set_group_id($groupid);
}
}
// Pass necessary data to filter function using ugly global.
global $forumngfilteroptions;
$forumngfilteroptions = (object)array('author' => trim($data->author),
'datefrom' => $data->datefrom, 'dateto' => $data->dateto);
$result->set_filter('forumng_exclude_words_filter');
print $result->display_results($url, $searchtitle);
} else {
// Searching without free text using author and/or date range.
$page = optional_param('page', 0, PARAM_INT);
$prevpage = $page-FORUMNG_SEARCH_RESULTSPERPAGE;
$prevrange = ($page-FORUMNG_SEARCH_RESULTSPERPAGE+1) . ' - ' . $page;
// Get result from database query.
if ($allforums) {
$results = forumng_get_results_for_all_forums($course, trim($data->author),
$data->datefrom, $data->dateto, $page);
} else {
$results = forumng_get_results_for_this_forum($forum, $groupid, trim($data->author),
$data->datefrom, $data->dateto, $page);
}
$nextpage = $page + FORUMNG_SEARCH_RESULTSPERPAGE;
$linknext = null;
$linkprev = null;
if ($results->success) {
if (($page-FORUMNG_SEARCH_RESULTSPERPAGE+1)>0) {
$url->param('page', $prevpage);
$linkprev = $url->out(false);
}
if ($results->numberofentries == FORUMNG_SEARCH_RESULTSPERPAGE) {
$url->param('page', $nextpage);
$linknext = $url->out(false);
}
}
if ($results->done ===1) {
if (($page-FORUMNG_SEARCH_RESULTSPERPAGE+1)>0) {
$url->param('page', $prevpage);
$linkprev = $url->out(false);
}
}
print local_ousearch_search::format_results($results, $searchtitle, $page+1, $linkprev,
$prevrange, $linknext, $results->searchtime);
}
}
print $out->footer();