MDL-40062 mod_forum: remove invalid add_to_log() calls
[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/**
19 * @package mod-forum
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
cd4e6b17 115add_to_log($course->id, "forum", "search", "search.php?id=$course->id&amp;search=".urlencode($search), $search);
65bcf17b 116
cd4e6b17 117$strforums = get_string("modulenameplural", "forum");
118$strsearch = get_string("search", "forum");
119$strsearchresults = get_string("searchresults", "forum");
120$strpage = get_string("page");
65bcf17b 121
cd4e6b17 122if (!$search || $showform) {
680afe2e 123
a6855934 124 $PAGE->navbar->add($strforums, new moodle_url('/mod/forum/index.php', array('id'=>$course->id)));
b4c07395 125 $PAGE->navbar->add(get_string('advancedsearch', 'forum'));
501cdbd8 126
cd4e6b17 127 $PAGE->set_title($strsearch);
39790bd8 128 $PAGE->set_heading($course->fullname);
cd4e6b17 129 echo $OUTPUT->header();
e6ae4dc8 130
cd4e6b17 131 forum_print_big_search_form($course);
132 echo $OUTPUT->footer();
133 exit;
134}
e6ae4dc8 135
cd4e6b17 136/// We need to do a search now and print results
e6ae4dc8 137
cd4e6b17 138$searchterms = str_replace('forumid:', 'instance:', $search);
139$searchterms = explode(' ', $searchterms);
e6ae4dc8 140
cd4e6b17 141$searchform = forum_search_form($course, $search);
e6ae4dc8 142
a6855934 143$PAGE->navbar->add($strsearch, new moodle_url('/mod/forum/search.php', array('id'=>$course->id)));
b74c9a9f 144$PAGE->navbar->add($strsearchresults);
cd4e6b17 145if (!$posts = forum_search_posts($searchterms, $course->id, $page*$perpage, $perpage, $totalcount)) {
146 $PAGE->set_title($strsearchresults);
39790bd8 147 $PAGE->set_heading($course->fullname);
cd4e6b17 148 echo $OUTPUT->header();
66e2b9f8
AD
149 echo $OUTPUT->heading($strforums, 2);
150 echo $OUTPUT->heading($strsearchresults, 3);
151 echo $OUTPUT->heading(get_string("noposts", "forum"), 4);
77ffdf4b 152
cd4e6b17 153 if (!$individualparams) {
154 $words = $search;
e6ae4dc8 155 }
65bcf17b 156
cd4e6b17 157 forum_print_big_search_form($course);
158
159 echo $OUTPUT->footer();
160 exit;
161}
162
667f63fe
AD
163//including this here to prevent it being included if there are no search results
164require_once($CFG->dirroot.'/rating/lib.php');
165
166//set up the ratings information that will be the same for all posts
167$ratingoptions = new stdClass();
168$ratingoptions->component = 'mod_forum';
169$ratingoptions->ratingarea = 'post';
170$ratingoptions->userid = $USER->id;
171$ratingoptions->returnurl = $PAGE->url->out(false);
172$rm = new rating_manager();
173
cd4e6b17 174$PAGE->set_title($strsearchresults);
b4c07395 175$PAGE->set_heading($course->fullname);
cd4e6b17 176$PAGE->set_button($searchform);
177echo $OUTPUT->header();
178echo '<div class="reportlink">';
179echo '<a href="search.php?id='.$course->id.
180 '&amp;user='.urlencode($user).
181 '&amp;userid='.$userid.
182 '&amp;forumid='.$forumid.
183 '&amp;subject='.urlencode($subject).
184 '&amp;phrase='.urlencode($phrase).
185 '&amp;words='.urlencode($words).
186 '&amp;fullwords='.urlencode($fullwords).
187 '&amp;notwords='.urlencode($notwords).
188 '&amp;dateto='.$dateto.
189 '&amp;datefrom='.$datefrom.
190 '&amp;showform=1'.
191 '">'.get_string('advancedsearch','forum').'...</a>';
192echo '</div>';
193
66e2b9f8
AD
194echo $OUTPUT->heading($strforums, 2);
195echo $OUTPUT->heading("$strsearchresults: $totalcount", 3);
cd4e6b17 196
1d67258e 197$url = new moodle_url('search.php', array('search' => $search, 'id' => $course->id, 'perpage' => $perpage));
929d7a83 198echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url);
cd4e6b17 199
200//added to implement highlighting of search terms found only in HTML markup
201//fiedorow - 9/2/2005
202$strippedsearch = str_replace('user:','',$search);
203$strippedsearch = str_replace('subject:','',$strippedsearch);
204$strippedsearch = str_replace('&quot;','',$strippedsearch);
205$searchterms = explode(' ', $strippedsearch); // Search for words independently
206foreach ($searchterms as $key => $searchterm) {
207 if (preg_match('/^\-/',$searchterm)) {
208 unset($searchterms[$key]);
209 } else {
210 $searchterms[$key] = preg_replace('/^\+/','',$searchterm);
e6ae4dc8 211 }
cd4e6b17 212}
213$strippedsearch = implode(' ', $searchterms); // Rebuild the string
501cdbd8 214
cd4e6b17 215foreach ($posts as $post) {
e6ae4dc8 216
cd4e6b17 217 // Replace the simple subject with the three items forum name -> thread name -> subject
218 // (if all three are appropriate) each as a link.
219 if (! $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion))) {
220 print_error('invaliddiscussionid', 'forum');
221 }
222 if (! $forum = $DB->get_record('forum', array('id' => "$discussion->forum"))) {
223 print_error('invalidforumid', 'forum');
224 }
cdea3a53 225
cd4e6b17 226 if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
227 print_error('invalidcoursemodule');
228 }
65bcf17b 229
cd4e6b17 230 $post->subject = highlight($strippedsearch, $post->subject);
231 $discussion->name = highlight($strippedsearch, $discussion->name);
b800ac5a 232
cd4e6b17 233 $fullsubject = "<a href=\"view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
234 if ($forum->type != 'single') {
235 $fullsubject .= " -> <a href=\"discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a>";
236 if ($post->parent != 0) {
237 $fullsubject .= " -> <a href=\"discuss.php?d=$post->discussion&amp;parent=$post->id\">".format_string($post->subject,true)."</a>";
e6ae4dc8 238 }
cd4e6b17 239 }
501cdbd8 240
cd4e6b17 241 $post->subject = $fullsubject;
242 $post->subjectnoformat = true;
048ccc47 243
667f63fe
AD
244 //add the ratings information to the post
245 //Unfortunately seem to have do this individually as posts may be from different forums
246 if ($forum->assessed != RATING_AGGREGATE_NONE) {
bf0f06b1 247 $modcontext = context_module::instance($cm->id);
667f63fe
AD
248 $ratingoptions->context = $modcontext;
249 $ratingoptions->items = array($post);
250 $ratingoptions->aggregate = $forum->assessed;//the aggregation method
251 $ratingoptions->scaleid = $forum->scale;
252 $ratingoptions->assesstimestart = $forum->assesstimestart;
253 $ratingoptions->assesstimefinish = $forum->assesstimefinish;
254 $postswithratings = $rm->get_ratings($ratingoptions);
255
256 if ($postswithratings && count($postswithratings)==1) {
257 $post = $postswithratings[0];
258 }
259 }
260
cd4e6b17 261 // Identify search terms only found in HTML markup, and add a warning about them to
262 // the start of the message text. However, do not do the highlighting here. forum_print_post
263 // will do it for us later.
264 $missing_terms = "";
b343df86 265
39790bd8 266 $options = new stdClass();
cd4e6b17 267 $options->trusted = $post->messagetrust;
5da8e7d5 268 $post->message = highlight($strippedsearch,
cd4e6b17 269 format_text($post->message, $post->messageformat, $options, $course->id),
270 0, '<fgw9sdpq4>', '</fgw9sdpq4>');
9044a387 271
cd4e6b17 272 foreach ($searchterms as $searchterm) {
5da8e7d5 273 if (preg_match("/$searchterm/i",$post->message) && !preg_match('/<fgw9sdpq4>'.$searchterm.'<\/fgw9sdpq4>/i',$post->message)) {
cd4e6b17 274 $missing_terms .= " $searchterm";
e6ae4dc8 275 }
cd4e6b17 276 }
501cdbd8 277
5da8e7d5
SH
278 $post->message = str_replace('<fgw9sdpq4>', '<span class="highlight">', $post->message);
279 $post->message = str_replace('</fgw9sdpq4>', '</span>', $post->message);
280
cd4e6b17 281 if ($missing_terms) {
282 $strmissingsearchterms = get_string('missingsearchterms','forum');
283 $post->message = '<p class="highlight2">'.$strmissingsearchterms.' '.$missing_terms.'</p>'.$post->message;
284 }
b800ac5a 285
cd4e6b17 286 // Prepare a link to the post in context, to be displayed after the forum post.
287 $fulllink = "<a href=\"discuss.php?d=$post->discussion#p$post->id\">".get_string("postincontext", "forum")."</a>";
f2b5d7e3 288
cd4e6b17 289 // Now pring the post.
5da8e7d5
SH
290 forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false,
291 $fulllink, '', -99, false);
cd4e6b17 292}
501cdbd8 293
929d7a83 294echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url);
e6ae4dc8 295
cd4e6b17 296echo $OUTPUT->footer();
501cdbd8 297
e6ae4dc8 298
299
e9ff8e10 300/**
301 * @todo Document this function
302 */
e6ae4dc8 303function forum_print_big_search_form($course) {
85ed1699 304 global $CFG, $DB, $words, $subject, $phrase, $user, $userid, $fullwords, $notwords, $datefrom, $dateto, $PAGE, $OUTPUT;
e6ae4dc8 305
9146b979 306 echo $OUTPUT->box(get_string('searchforumintro', 'forum'), 'searchbox boxaligncenter', 'intro');
e6ae4dc8 307
9146b979 308 echo $OUTPUT->box_start('generalbox boxaligncenter');
ab00aa12 309
c17f05fb 310 echo html_writer::script('', $CFG->wwwroot.'/mod/forum/forum.js');
ab00aa12 311
d2ce367f 312 echo '<form id="searchform" action="search.php" method="get">';
e6ae4dc8 313 echo '<table cellpadding="10" class="searchbox" id="form">';
314
315 echo '<tr>';
debd3d62 316 echo '<td class="c0"><label for="words">'.get_string('searchwords', 'forum').'</label>';
e9ff8e10 317 echo '<input type="hidden" value="'.$course->id.'" name="id" alt="" /></td>';
debd3d62 318 echo '<td class="c1"><input type="text" size="35" name="words" id="words"value="'.s($words, true).'" alt="" /></td>';
e6ae4dc8 319 echo '</tr>';
320
321 echo '<tr>';
debd3d62 322 echo '<td class="c0"><label for="phrase">'.get_string('searchphrase', 'forum').'</label></td>';
323 echo '<td class="c1"><input type="text" size="35" name="phrase" id="phrase" value="'.s($phrase, true).'" alt="" /></td>';
e6ae4dc8 324 echo '</tr>';
325
326 echo '<tr>';
debd3d62 327 echo '<td class="c0"><label for="notwords">'.get_string('searchnotwords', 'forum').'</label></td>';
328 echo '<td class="c1"><input type="text" size="35" name="notwords" id="notwords" value="'.s($notwords, true).'" alt="" /></td>';
e6ae4dc8 329 echo '</tr>';
330
68533e53 331 if ($DB->get_dbfamily() == 'mysql' || $DB->get_dbfamily() == 'postgres') {
428aa337 332 echo '<tr>';
debd3d62 333 echo '<td class="c0"><label for="fullwords">'.get_string('searchfullwords', 'forum').'</label></td>';
334 echo '<td class="c1"><input type="text" size="35" name="fullwords" id="fullwords" value="'.s($fullwords, true).'" alt="" /></td>';
428aa337 335 echo '</tr>';
336 }
4e471fc6 337
338 echo '<tr>';
debd3d62 339 echo '<td class="c0">'.get_string('searchdatefrom', 'forum').'</td>';
4e471fc6 340 echo '<td class="c1">';
2c3f3e77 341 if (empty($datefrom)) {
342 $datefromchecked = '';
4e471fc6 343 $datefrom = make_timestamp(2000, 1, 1, 0, 0, 0);
2c3f3e77 344 }else{
345 $datefromchecked = 'checked="checked"';
4e471fc6 346 }
2c3f3e77 347
348 echo '<input name="timefromrestrict" type="checkbox" value="1" alt="'.get_string('searchdatefrom', 'forum').'" onclick="return lockoptions(\'searchform\', \'timefromrestrict\', timefromitems)" '. $datefromchecked . ' /> ';
38befbef 349 $selectors = html_writer::select_time('days', 'fromday', $datefrom)
f83b9b63
PS
350 . html_writer::select_time('months', 'frommonth', $datefrom)
351 . html_writer::select_time('years', 'fromyear', $datefrom)
352 . html_writer::select_time('hours', 'fromhour', $datefrom)
353 . html_writer::select_time('minutes', 'fromminute', $datefrom);
354 echo $selectors;
ab00aa12 355 echo '<input type="hidden" name="hfromday" value="0" />';
356 echo '<input type="hidden" name="hfrommonth" value="0" />';
357 echo '<input type="hidden" name="hfromyear" value="0" />';
358 echo '<input type="hidden" name="hfromhour" value="0" />';
359 echo '<input type="hidden" name="hfromminute" value="0" />';
360
4e471fc6 361 echo '</td>';
362 echo '</tr>';
363
364 echo '<tr>';
debd3d62 365 echo '<td class="c0">'.get_string('searchdateto', 'forum').'</td>';
4e471fc6 366 echo '<td class="c1">';
367 if (empty($dateto)) {
2c3f3e77 368 $datetochecked = '';
4e471fc6 369 $dateto = time()+3600;
2c3f3e77 370 }else{
371 $datetochecked = 'checked="checked"';
4e471fc6 372 }
2c3f3e77 373
374 echo '<input name="timetorestrict" type="checkbox" value="1" alt="'.get_string('searchdateto', 'forum').'" onclick="return lockoptions(\'searchform\', \'timetorestrict\', timetoitems)" ' .$datetochecked. ' /> ';
38befbef 375 $selectors = html_writer::select_time('days', 'today', $dateto)
70df945d
KG
376 . html_writer::select_time('months', 'tomonth', $dateto)
377 . html_writer::select_time('years', 'toyear', $dateto)
378 . html_writer::select_time('hours', 'tohour', $dateto)
379 . html_writer::select_time('minutes', 'tominute', $dateto);
f83b9b63 380 echo $selectors;
ab00aa12 381
382 echo '<input type="hidden" name="htoday" value="0" />';
383 echo '<input type="hidden" name="htomonth" value="0" />';
384 echo '<input type="hidden" name="htoyear" value="0" />';
385 echo '<input type="hidden" name="htohour" value="0" />';
386 echo '<input type="hidden" name="htominute" value="0" />';
387
4e471fc6 388 echo '</td>';
e6ae4dc8 389 echo '</tr>';
390
77ffdf4b 391 echo '<tr>';
debd3d62 392 echo '<td class="c0"><label for="menuforumid">'.get_string('searchwhichforums', 'forum').'</label></td>';
77ffdf4b 393 echo '<td class="c1">';
d776d59e 394 echo html_writer::select(forum_menu_list($course), 'forumid', '', array(''=>get_string('allforums', 'forum')));
77ffdf4b 395 echo '</td>';
396 echo '</tr>';
397
e6ae4dc8 398 echo '<tr>';
debd3d62 399 echo '<td class="c0"><label for="subject">'.get_string('searchsubject', 'forum').'</label></td>';
400 echo '<td class="c1"><input type="text" size="35" name="subject" id="subject" value="'.s($subject, true).'" alt="" /></td>';
e6ae4dc8 401 echo '</tr>';
402
403 echo '<tr>';
debd3d62 404 echo '<td class="c0"><label for="user">'.get_string('searchuser', 'forum').'</label></td>';
405 echo '<td class="c1"><input type="text" size="35" name="user" id="user" value="'.s($user, true).'" alt="" /></td>';
e6ae4dc8 406 echo '</tr>';
407
408 echo '<tr>';
409 echo '<td class="submit" colspan="2" align="center">';
76b1f3c7 410 echo '<input type="submit" value="'.get_string('searchforums', 'forum').'" alt="" /></td>';
e6ae4dc8 411 echo '</tr>';
412
413 echo '</table>';
414 echo '</form>';
ab00aa12 415
c17f05fb
PS
416 echo html_writer::script(js_writer::function_call('lockoptions_timetoitems'));
417 echo html_writer::script(js_writer::function_call('lockoptions_timefromitems'));
ab00aa12 418
9146b979 419 echo $OUTPUT->box_end();
e6ae4dc8 420}
421
e9ff8e10 422/**
65bcf17b 423 * This function takes each word out of the search string, makes sure they are at least
5cce2e75 424 * two characters long and returns an array containing every good word.
65bcf17b 425 *
5cce2e75 426 * @param string $words String containing space-separated strings to search for
427 * @param string $prefix String to prepend to the each token taken out of $words
65bcf17b 428 * @returns array
5cce2e75 429 * @todo Take the hardcoded limit out of this function and put it into a user-specified parameter
e9ff8e10 430 */
e6ae4dc8 431function forum_clean_search_terms($words, $prefix='') {
432 $searchterms = explode(' ', $words);
433 foreach ($searchterms as $key => $searchterm) {
434 if (strlen($searchterm) < 2) {
435 unset($searchterms[$key]);
436 } else if ($prefix) {
437 $searchterms[$key] = $prefix.$searchterm;
438 }
439 }
440 return trim(implode(' ', $searchterms));
441}
442
e9ff8e10 443/**
444 * @todo Document this function
445 */
77ffdf4b 446function forum_menu_list($course) {
447
448 $menu = array();
77ffdf4b 449
debd3d62 450 $modinfo = get_fast_modinfo($course);
77ffdf4b 451
debd3d62 452 if (empty($modinfo->instances['forum'])) {
453 return $menu;
454 }
455
456 foreach ($modinfo->instances['forum'] as $cm) {
457 if (!$cm->uservisible) {
458 continue;
459 }
bf0f06b1 460 $context = context_module::instance($cm->id);
debd3d62 461 if (!has_capability('mod/forum:viewdiscussion', $context)) {
462 continue;
77ffdf4b 463 }
debd3d62 464 $menu[$cm->instance] = format_string($cm->name);
77ffdf4b 465 }
466
467 return $menu;
468}
469