weekly on-sync release 2.8dev
[moodle.git] / mod / forum / search.php
CommitLineData
cd4e6b17 1<?php
2
8f685009
SH
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
01030f1b 19 * @package mod_forum
8f685009
SH
20 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 */
23
cd4e6b17 24require_once('../../config.php');
25require_once('lib.php');
26
27$id = required_param('id', PARAM_INT); // course id
28$search = trim(optional_param('search', '', PARAM_NOTAGS)); // search string
29$page = optional_param('page', 0, PARAM_INT); // which page to show
30$perpage = optional_param('perpage', 10, PARAM_INT); // how many per page
31$showform = optional_param('showform', 0, PARAM_INT); // Just show the form
32
33$user = trim(optional_param('user', '', PARAM_NOTAGS)); // Names to search for
34$userid = trim(optional_param('userid', 0, PARAM_INT)); // UserID to search for
35$forumid = trim(optional_param('forumid', 0, PARAM_INT)); // ForumID to search for
36$subject = trim(optional_param('subject', '', PARAM_NOTAGS)); // Subject
37$phrase = trim(optional_param('phrase', '', PARAM_NOTAGS)); // Phrase
38$words = trim(optional_param('words', '', PARAM_NOTAGS)); // Words
39$fullwords = trim(optional_param('fullwords', '', PARAM_NOTAGS)); // Whole words
40$notwords = trim(optional_param('notwords', '', PARAM_NOTAGS)); // Words we don't want
41
42$timefromrestrict = optional_param('timefromrestrict', 0, PARAM_INT); // Use starting date
43$fromday = optional_param('fromday', 0, PARAM_INT); // Starting date
44$frommonth = optional_param('frommonth', 0, PARAM_INT); // Starting date
45$fromyear = optional_param('fromyear', 0, PARAM_INT); // Starting date
46$fromhour = optional_param('fromhour', 0, PARAM_INT); // Starting date
47$fromminute = optional_param('fromminute', 0, PARAM_INT); // Starting date
48if ($timefromrestrict) {
49 $datefrom = make_timestamp($fromyear, $frommonth, $fromday, $fromhour, $fromminute);
50} else {
51 $datefrom = optional_param('datefrom', 0, PARAM_INT); // Starting date
52}
4e471fc6 53
cd4e6b17 54$timetorestrict = optional_param('timetorestrict', 0, PARAM_INT); // Use ending date
55$today = optional_param('today', 0, PARAM_INT); // Ending date
56$tomonth = optional_param('tomonth', 0, PARAM_INT); // Ending date
57$toyear = optional_param('toyear', 0, PARAM_INT); // Ending date
58$tohour = optional_param('tohour', 0, PARAM_INT); // Ending date
59$tominute = optional_param('tominute', 0, PARAM_INT); // Ending date
60if ($timetorestrict) {
61 $dateto = make_timestamp($toyear, $tomonth, $today, $tohour, $tominute);
62} else {
63 $dateto = optional_param('dateto', 0, PARAM_INT); // Ending date
64}
4e471fc6 65
267aff7f 66$PAGE->set_pagelayout('standard');
f0202ae9 67$PAGE->set_url($FULLME); //TODO: this is very sloppy --skodak
e6ae4dc8 68
cd4e6b17 69if (empty($search)) { // Check the other parameters instead
70 if (!empty($words)) {
71 $search .= ' '.$words;
e6ae4dc8 72 }
cd4e6b17 73 if (!empty($userid)) {
74 $search .= ' userid:'.$userid;
8b9c7aa0 75 }
cd4e6b17 76 if (!empty($forumid)) {
77 $search .= ' forumid:'.$forumid;
78 }
79 if (!empty($user)) {
80 $search .= ' '.forum_clean_search_terms($user, 'user:');
81 }
82 if (!empty($subject)) {
83 $search .= ' '.forum_clean_search_terms($subject, 'subject:');
84 }
85 if (!empty($fullwords)) {
86 $search .= ' '.forum_clean_search_terms($fullwords, '+');
87 }
88 if (!empty($notwords)) {
89 $search .= ' '.forum_clean_search_terms($notwords, '-');
501cdbd8 90 }
cd4e6b17 91 if (!empty($phrase)) {
92 $search .= ' "'.$phrase.'"';
93 }
94 if (!empty($datefrom)) {
95 $search .= ' datefrom:'.$datefrom;
96 }
97 if (!empty($dateto)) {
98 $search .= ' dateto:'.$dateto;
99 }
100 $individualparams = true;
101} else {
102 $individualparams = false;
103}
501cdbd8 104
cd4e6b17 105if ($search) {
106 $search = forum_clean_search_terms($search);
107}
501cdbd8 108
cd4e6b17 109if (!$course = $DB->get_record('course', array('id'=>$id))) {
110 print_error('invalidcourseid');
111}
501cdbd8 112
cd4e6b17 113require_course_login($course);
97485d07 114
22881392
DP
115$params = array(
116 'context' => $PAGE->context,
117 'other' => array('searchterm' => $search)
118);
119
120$event = \mod_forum\event\course_searched::create($params);
121$event->trigger();
65bcf17b 122
cd4e6b17 123$strforums = get_string("modulenameplural", "forum");
124$strsearch = get_string("search", "forum");
125$strsearchresults = get_string("searchresults", "forum");
126$strpage = get_string("page");
65bcf17b 127
cd4e6b17 128if (!$search || $showform) {
680afe2e 129
a6855934 130 $PAGE->navbar->add($strforums, new moodle_url('/mod/forum/index.php', array('id'=>$course->id)));
b4c07395 131 $PAGE->navbar->add(get_string('advancedsearch', 'forum'));
501cdbd8 132
cd4e6b17 133 $PAGE->set_title($strsearch);
39790bd8 134 $PAGE->set_heading($course->fullname);
cd4e6b17 135 echo $OUTPUT->header();
e6ae4dc8 136
cd4e6b17 137 forum_print_big_search_form($course);
138 echo $OUTPUT->footer();
139 exit;
140}
e6ae4dc8 141
cd4e6b17 142/// We need to do a search now and print results
e6ae4dc8 143
cd4e6b17 144$searchterms = str_replace('forumid:', 'instance:', $search);
145$searchterms = explode(' ', $searchterms);
e6ae4dc8 146
cd4e6b17 147$searchform = forum_search_form($course, $search);
e6ae4dc8 148
a6855934 149$PAGE->navbar->add($strsearch, new moodle_url('/mod/forum/search.php', array('id'=>$course->id)));
b74c9a9f 150$PAGE->navbar->add($strsearchresults);
cd4e6b17 151if (!$posts = forum_search_posts($searchterms, $course->id, $page*$perpage, $perpage, $totalcount)) {
152 $PAGE->set_title($strsearchresults);
39790bd8 153 $PAGE->set_heading($course->fullname);
cd4e6b17 154 echo $OUTPUT->header();
66e2b9f8
AD
155 echo $OUTPUT->heading($strforums, 2);
156 echo $OUTPUT->heading($strsearchresults, 3);
157 echo $OUTPUT->heading(get_string("noposts", "forum"), 4);
77ffdf4b 158
cd4e6b17 159 if (!$individualparams) {
160 $words = $search;
e6ae4dc8 161 }
65bcf17b 162
cd4e6b17 163 forum_print_big_search_form($course);
164
165 echo $OUTPUT->footer();
166 exit;
167}
168
667f63fe
AD
169//including this here to prevent it being included if there are no search results
170require_once($CFG->dirroot.'/rating/lib.php');
171
172//set up the ratings information that will be the same for all posts
173$ratingoptions = new stdClass();
174$ratingoptions->component = 'mod_forum';
175$ratingoptions->ratingarea = 'post';
176$ratingoptions->userid = $USER->id;
177$ratingoptions->returnurl = $PAGE->url->out(false);
178$rm = new rating_manager();
179
cd4e6b17 180$PAGE->set_title($strsearchresults);
b4c07395 181$PAGE->set_heading($course->fullname);
cd4e6b17 182$PAGE->set_button($searchform);
183echo $OUTPUT->header();
184echo '<div class="reportlink">';
185echo '<a href="search.php?id='.$course->id.
186 '&amp;user='.urlencode($user).
187 '&amp;userid='.$userid.
188 '&amp;forumid='.$forumid.
189 '&amp;subject='.urlencode($subject).
190 '&amp;phrase='.urlencode($phrase).
191 '&amp;words='.urlencode($words).
192 '&amp;fullwords='.urlencode($fullwords).
193 '&amp;notwords='.urlencode($notwords).
194 '&amp;dateto='.$dateto.
195 '&amp;datefrom='.$datefrom.
196 '&amp;showform=1'.
197 '">'.get_string('advancedsearch','forum').'...</a>';
198echo '</div>';
199
66e2b9f8
AD
200echo $OUTPUT->heading($strforums, 2);
201echo $OUTPUT->heading("$strsearchresults: $totalcount", 3);
cd4e6b17 202
1d67258e 203$url = new moodle_url('search.php', array('search' => $search, 'id' => $course->id, 'perpage' => $perpage));
929d7a83 204echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url);
cd4e6b17 205
206//added to implement highlighting of search terms found only in HTML markup
207//fiedorow - 9/2/2005
208$strippedsearch = str_replace('user:','',$search);
209$strippedsearch = str_replace('subject:','',$strippedsearch);
210$strippedsearch = str_replace('&quot;','',$strippedsearch);
211$searchterms = explode(' ', $strippedsearch); // Search for words independently
212foreach ($searchterms as $key => $searchterm) {
213 if (preg_match('/^\-/',$searchterm)) {
214 unset($searchterms[$key]);
215 } else {
216 $searchterms[$key] = preg_replace('/^\+/','',$searchterm);
e6ae4dc8 217 }
cd4e6b17 218}
219$strippedsearch = implode(' ', $searchterms); // Rebuild the string
501cdbd8 220
cd4e6b17 221foreach ($posts as $post) {
e6ae4dc8 222
cd4e6b17 223 // Replace the simple subject with the three items forum name -> thread name -> subject
224 // (if all three are appropriate) each as a link.
225 if (! $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion))) {
226 print_error('invaliddiscussionid', 'forum');
227 }
228 if (! $forum = $DB->get_record('forum', array('id' => "$discussion->forum"))) {
229 print_error('invalidforumid', 'forum');
230 }
cdea3a53 231
cd4e6b17 232 if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
233 print_error('invalidcoursemodule');
234 }
65bcf17b 235
cd4e6b17 236 $post->subject = highlight($strippedsearch, $post->subject);
237 $discussion->name = highlight($strippedsearch, $discussion->name);
b800ac5a 238
cd4e6b17 239 $fullsubject = "<a href=\"view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
240 if ($forum->type != 'single') {
241 $fullsubject .= " -> <a href=\"discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a>";
242 if ($post->parent != 0) {
243 $fullsubject .= " -> <a href=\"discuss.php?d=$post->discussion&amp;parent=$post->id\">".format_string($post->subject,true)."</a>";
e6ae4dc8 244 }
cd4e6b17 245 }
501cdbd8 246
cd4e6b17 247 $post->subject = $fullsubject;
248 $post->subjectnoformat = true;
048ccc47 249
667f63fe
AD
250 //add the ratings information to the post
251 //Unfortunately seem to have do this individually as posts may be from different forums
252 if ($forum->assessed != RATING_AGGREGATE_NONE) {
bf0f06b1 253 $modcontext = context_module::instance($cm->id);
667f63fe
AD
254 $ratingoptions->context = $modcontext;
255 $ratingoptions->items = array($post);
256 $ratingoptions->aggregate = $forum->assessed;//the aggregation method
257 $ratingoptions->scaleid = $forum->scale;
258 $ratingoptions->assesstimestart = $forum->assesstimestart;
259 $ratingoptions->assesstimefinish = $forum->assesstimefinish;
260 $postswithratings = $rm->get_ratings($ratingoptions);
261
262 if ($postswithratings && count($postswithratings)==1) {
263 $post = $postswithratings[0];
264 }
265 }
266
cd4e6b17 267 // Identify search terms only found in HTML markup, and add a warning about them to
268 // the start of the message text. However, do not do the highlighting here. forum_print_post
269 // will do it for us later.
270 $missing_terms = "";
b343df86 271
39790bd8 272 $options = new stdClass();
cd4e6b17 273 $options->trusted = $post->messagetrust;
5da8e7d5 274 $post->message = highlight($strippedsearch,
cd4e6b17 275 format_text($post->message, $post->messageformat, $options, $course->id),
276 0, '<fgw9sdpq4>', '</fgw9sdpq4>');
9044a387 277
cd4e6b17 278 foreach ($searchterms as $searchterm) {
5da8e7d5 279 if (preg_match("/$searchterm/i",$post->message) && !preg_match('/<fgw9sdpq4>'.$searchterm.'<\/fgw9sdpq4>/i',$post->message)) {
cd4e6b17 280 $missing_terms .= " $searchterm";
e6ae4dc8 281 }
cd4e6b17 282 }
501cdbd8 283
5da8e7d5
SH
284 $post->message = str_replace('<fgw9sdpq4>', '<span class="highlight">', $post->message);
285 $post->message = str_replace('</fgw9sdpq4>', '</span>', $post->message);
286
cd4e6b17 287 if ($missing_terms) {
288 $strmissingsearchterms = get_string('missingsearchterms','forum');
289 $post->message = '<p class="highlight2">'.$strmissingsearchterms.' '.$missing_terms.'</p>'.$post->message;
290 }
b800ac5a 291
cd4e6b17 292 // Prepare a link to the post in context, to be displayed after the forum post.
293 $fulllink = "<a href=\"discuss.php?d=$post->discussion#p$post->id\">".get_string("postincontext", "forum")."</a>";
f2b5d7e3 294
cd4e6b17 295 // Now pring the post.
5da8e7d5
SH
296 forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false,
297 $fulllink, '', -99, false);
cd4e6b17 298}
501cdbd8 299
929d7a83 300echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url);
e6ae4dc8 301
cd4e6b17 302echo $OUTPUT->footer();
501cdbd8 303
e6ae4dc8 304
305
e9ff8e10 306/**
307 * @todo Document this function
308 */
e6ae4dc8 309function forum_print_big_search_form($course) {
85ed1699 310 global $CFG, $DB, $words, $subject, $phrase, $user, $userid, $fullwords, $notwords, $datefrom, $dateto, $PAGE, $OUTPUT;
e6ae4dc8 311
9146b979 312 echo $OUTPUT->box(get_string('searchforumintro', 'forum'), 'searchbox boxaligncenter', 'intro');
e6ae4dc8 313
9146b979 314 echo $OUTPUT->box_start('generalbox boxaligncenter');
ab00aa12 315
c17f05fb 316 echo html_writer::script('', $CFG->wwwroot.'/mod/forum/forum.js');
ab00aa12 317
d2ce367f 318 echo '<form id="searchform" action="search.php" method="get">';
e6ae4dc8 319 echo '<table cellpadding="10" class="searchbox" id="form">';
320
321 echo '<tr>';
debd3d62 322 echo '<td class="c0"><label for="words">'.get_string('searchwords', 'forum').'</label>';
e9ff8e10 323 echo '<input type="hidden" value="'.$course->id.'" name="id" alt="" /></td>';
debd3d62 324 echo '<td class="c1"><input type="text" size="35" name="words" id="words"value="'.s($words, true).'" alt="" /></td>';
e6ae4dc8 325 echo '</tr>';
326
327 echo '<tr>';
debd3d62 328 echo '<td class="c0"><label for="phrase">'.get_string('searchphrase', 'forum').'</label></td>';
329 echo '<td class="c1"><input type="text" size="35" name="phrase" id="phrase" value="'.s($phrase, true).'" alt="" /></td>';
e6ae4dc8 330 echo '</tr>';
331
332 echo '<tr>';
debd3d62 333 echo '<td class="c0"><label for="notwords">'.get_string('searchnotwords', 'forum').'</label></td>';
334 echo '<td class="c1"><input type="text" size="35" name="notwords" id="notwords" value="'.s($notwords, true).'" alt="" /></td>';
e6ae4dc8 335 echo '</tr>';
336
68533e53 337 if ($DB->get_dbfamily() == 'mysql' || $DB->get_dbfamily() == 'postgres') {
428aa337 338 echo '<tr>';
debd3d62 339 echo '<td class="c0"><label for="fullwords">'.get_string('searchfullwords', 'forum').'</label></td>';
340 echo '<td class="c1"><input type="text" size="35" name="fullwords" id="fullwords" value="'.s($fullwords, true).'" alt="" /></td>';
428aa337 341 echo '</tr>';
342 }
4e471fc6 343
344 echo '<tr>';
debd3d62 345 echo '<td class="c0">'.get_string('searchdatefrom', 'forum').'</td>';
4e471fc6 346 echo '<td class="c1">';
2c3f3e77 347 if (empty($datefrom)) {
348 $datefromchecked = '';
4e471fc6 349 $datefrom = make_timestamp(2000, 1, 1, 0, 0, 0);
2c3f3e77 350 }else{
351 $datefromchecked = 'checked="checked"';
4e471fc6 352 }
2c3f3e77 353
354 echo '<input name="timefromrestrict" type="checkbox" value="1" alt="'.get_string('searchdatefrom', 'forum').'" onclick="return lockoptions(\'searchform\', \'timefromrestrict\', timefromitems)" '. $datefromchecked . ' /> ';
38befbef 355 $selectors = html_writer::select_time('days', 'fromday', $datefrom)
f83b9b63
PS
356 . html_writer::select_time('months', 'frommonth', $datefrom)
357 . html_writer::select_time('years', 'fromyear', $datefrom)
358 . html_writer::select_time('hours', 'fromhour', $datefrom)
359 . html_writer::select_time('minutes', 'fromminute', $datefrom);
360 echo $selectors;
ab00aa12 361 echo '<input type="hidden" name="hfromday" value="0" />';
362 echo '<input type="hidden" name="hfrommonth" value="0" />';
363 echo '<input type="hidden" name="hfromyear" value="0" />';
364 echo '<input type="hidden" name="hfromhour" value="0" />';
365 echo '<input type="hidden" name="hfromminute" value="0" />';
366
4e471fc6 367 echo '</td>';
368 echo '</tr>';
369
370 echo '<tr>';
debd3d62 371 echo '<td class="c0">'.get_string('searchdateto', 'forum').'</td>';
4e471fc6 372 echo '<td class="c1">';
373 if (empty($dateto)) {
2c3f3e77 374 $datetochecked = '';
4e471fc6 375 $dateto = time()+3600;
2c3f3e77 376 }else{
377 $datetochecked = 'checked="checked"';
4e471fc6 378 }
2c3f3e77 379
380 echo '<input name="timetorestrict" type="checkbox" value="1" alt="'.get_string('searchdateto', 'forum').'" onclick="return lockoptions(\'searchform\', \'timetorestrict\', timetoitems)" ' .$datetochecked. ' /> ';
38befbef 381 $selectors = html_writer::select_time('days', 'today', $dateto)
70df945d
KG
382 . html_writer::select_time('months', 'tomonth', $dateto)
383 . html_writer::select_time('years', 'toyear', $dateto)
384 . html_writer::select_time('hours', 'tohour', $dateto)
385 . html_writer::select_time('minutes', 'tominute', $dateto);
f83b9b63 386 echo $selectors;
ab00aa12 387
388 echo '<input type="hidden" name="htoday" value="0" />';
389 echo '<input type="hidden" name="htomonth" value="0" />';
390 echo '<input type="hidden" name="htoyear" value="0" />';
391 echo '<input type="hidden" name="htohour" value="0" />';
392 echo '<input type="hidden" name="htominute" value="0" />';
393
4e471fc6 394 echo '</td>';
e6ae4dc8 395 echo '</tr>';
396
77ffdf4b 397 echo '<tr>';
debd3d62 398 echo '<td class="c0"><label for="menuforumid">'.get_string('searchwhichforums', 'forum').'</label></td>';
77ffdf4b 399 echo '<td class="c1">';
d776d59e 400 echo html_writer::select(forum_menu_list($course), 'forumid', '', array(''=>get_string('allforums', 'forum')));
77ffdf4b 401 echo '</td>';
402 echo '</tr>';
403
e6ae4dc8 404 echo '<tr>';
debd3d62 405 echo '<td class="c0"><label for="subject">'.get_string('searchsubject', 'forum').'</label></td>';
406 echo '<td class="c1"><input type="text" size="35" name="subject" id="subject" value="'.s($subject, true).'" alt="" /></td>';
e6ae4dc8 407 echo '</tr>';
408
409 echo '<tr>';
debd3d62 410 echo '<td class="c0"><label for="user">'.get_string('searchuser', 'forum').'</label></td>';
411 echo '<td class="c1"><input type="text" size="35" name="user" id="user" value="'.s($user, true).'" alt="" /></td>';
e6ae4dc8 412 echo '</tr>';
413
414 echo '<tr>';
415 echo '<td class="submit" colspan="2" align="center">';
76b1f3c7 416 echo '<input type="submit" value="'.get_string('searchforums', 'forum').'" alt="" /></td>';
e6ae4dc8 417 echo '</tr>';
418
419 echo '</table>';
420 echo '</form>';
ab00aa12 421
c17f05fb
PS
422 echo html_writer::script(js_writer::function_call('lockoptions_timetoitems'));
423 echo html_writer::script(js_writer::function_call('lockoptions_timefromitems'));
ab00aa12 424
9146b979 425 echo $OUTPUT->box_end();
e6ae4dc8 426}
427
e9ff8e10 428/**
65bcf17b 429 * This function takes each word out of the search string, makes sure they are at least
5cce2e75 430 * two characters long and returns an array containing every good word.
65bcf17b 431 *
5cce2e75 432 * @param string $words String containing space-separated strings to search for
433 * @param string $prefix String to prepend to the each token taken out of $words
2ef8ff9e 434 * @return array
5cce2e75 435 * @todo Take the hardcoded limit out of this function and put it into a user-specified parameter
e9ff8e10 436 */
e6ae4dc8 437function forum_clean_search_terms($words, $prefix='') {
438 $searchterms = explode(' ', $words);
439 foreach ($searchterms as $key => $searchterm) {
440 if (strlen($searchterm) < 2) {
441 unset($searchterms[$key]);
442 } else if ($prefix) {
443 $searchterms[$key] = $prefix.$searchterm;
444 }
445 }
446 return trim(implode(' ', $searchterms));
447}
448
e9ff8e10 449/**
450 * @todo Document this function
451 */
77ffdf4b 452function forum_menu_list($course) {
453
454 $menu = array();
77ffdf4b 455
debd3d62 456 $modinfo = get_fast_modinfo($course);
77ffdf4b 457
debd3d62 458 if (empty($modinfo->instances['forum'])) {
459 return $menu;
460 }
461
462 foreach ($modinfo->instances['forum'] as $cm) {
463 if (!$cm->uservisible) {
464 continue;
465 }
bf0f06b1 466 $context = context_module::instance($cm->id);
debd3d62 467 if (!has_capability('mod/forum:viewdiscussion', $context)) {
468 continue;
77ffdf4b 469 }
debd3d62 470 $menu[$cm->instance] = format_string($cm->name);
77ffdf4b 471 }
472
473 return $menu;
474}
475