931d04526d5ae48b5d3aaf47cc9ff9245f7c06ea
[moodle.git] / mod / forum / search.php
1 <?php
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/>.
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  */
24 require_once('../../config.php');
25 require_once('lib.php');
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
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
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
48 if ($timefromrestrict) {
49     $calendartype = \core_calendar\type_factory::get_calendar_instance();
50     $gregorianfrom = $calendartype->convert_to_gregorian($fromyear, $frommonth, $fromday);
51     $datefrom = make_timestamp($gregorianfrom['year'], $gregorianfrom['month'], $gregorianfrom['day'], $fromhour, $fromminute);
52 } else {
53     $datefrom = optional_param('datefrom', 0, PARAM_INT);      // Starting date
54 }
56 $timetorestrict = optional_param('timetorestrict', 0, PARAM_INT); // Use ending date
57 $today = optional_param('today', 0, PARAM_INT);      // Ending date
58 $tomonth = optional_param('tomonth', 0, PARAM_INT);      // Ending date
59 $toyear = optional_param('toyear', 0, PARAM_INT);      // Ending date
60 $tohour = optional_param('tohour', 0, PARAM_INT);      // Ending date
61 $tominute = optional_param('tominute', 0, PARAM_INT);      // Ending date
62 if ($timetorestrict) {
63     $calendartype = \core_calendar\type_factory::get_calendar_instance();
64     $gregorianto = $calendartype->convert_to_gregorian($toyear, $tomonth, $today);
65     $dateto = make_timestamp($gregorianto['year'], $gregorianto['month'], $gregorianto['day'], $tohour, $tominute);
66 } else {
67     $dateto = optional_param('dateto', 0, PARAM_INT);      // Ending date
68 }
70 $PAGE->set_pagelayout('standard');
71 $PAGE->set_url($FULLME); //TODO: this is very sloppy --skodak
73 if (empty($search)) {   // Check the other parameters instead
74     if (!empty($words)) {
75         $search .= ' '.$words;
76     }
77     if (!empty($userid)) {
78         $search .= ' userid:'.$userid;
79     }
80     if (!empty($forumid)) {
81         $search .= ' forumid:'.$forumid;
82     }
83     if (!empty($user)) {
84         $search .= ' '.forum_clean_search_terms($user, 'user:');
85     }
86     if (!empty($subject)) {
87         $search .= ' '.forum_clean_search_terms($subject, 'subject:');
88     }
89     if (!empty($fullwords)) {
90         $search .= ' '.forum_clean_search_terms($fullwords, '+');
91     }
92     if (!empty($notwords)) {
93         $search .= ' '.forum_clean_search_terms($notwords, '-');
94     }
95     if (!empty($phrase)) {
96         $search .= ' "'.$phrase.'"';
97     }
98     if (!empty($datefrom)) {
99         $search .= ' datefrom:'.$datefrom;
100     }
101     if (!empty($dateto)) {
102         $search .= ' dateto:'.$dateto;
103     }
104     $individualparams = true;
105 } else {
106     $individualparams = false;
109 if ($search) {
110     $search = forum_clean_search_terms($search);
113 if (!$course = $DB->get_record('course', array('id'=>$id))) {
114     print_error('invalidcourseid');
117 require_course_login($course);
119 $params = array(
120     'context' => $PAGE->context,
121     'other' => array('searchterm' => $search)
122 );
124 $event = \mod_forum\event\course_searched::create($params);
125 $event->trigger();
127 $strforums = get_string("modulenameplural", "forum");
128 $strsearch = get_string("search", "forum");
129 $strsearchresults = get_string("searchresults", "forum");
130 $strpage = get_string("page");
132 if (!$search || $showform) {
134     $PAGE->navbar->add($strforums, new moodle_url('/mod/forum/index.php', array('id'=>$course->id)));
135     $PAGE->navbar->add(get_string('advancedsearch', 'forum'));
137     $PAGE->set_title($strsearch);
138     $PAGE->set_heading($course->fullname);
139     echo $OUTPUT->header();
141     forum_print_big_search_form($course);
142     echo $OUTPUT->footer();
143     exit;
146 /// We need to do a search now and print results
148 $searchterms = str_replace('forumid:', 'instance:', $search);
149 $searchterms = explode(' ', $searchterms);
151 $searchform = forum_search_form($course, $search);
153 $PAGE->navbar->add($strsearch, new moodle_url('/mod/forum/search.php', array('id'=>$course->id)));
154 $PAGE->navbar->add($strsearchresults);
155 if (!$posts = forum_search_posts($searchterms, $course->id, $page*$perpage, $perpage, $totalcount)) {
156     $PAGE->set_title($strsearchresults);
157     $PAGE->set_heading($course->fullname);
158     echo $OUTPUT->header();
159     echo $OUTPUT->heading($strforums, 2);
160     echo $OUTPUT->heading($strsearchresults, 3);
161     echo $OUTPUT->heading(get_string("noposts", "forum"), 4);
163     if (!$individualparams) {
164         $words = $search;
165     }
167     forum_print_big_search_form($course);
169     echo $OUTPUT->footer();
170     exit;
173 //including this here to prevent it being included if there are no search results
174 require_once($CFG->dirroot.'/rating/lib.php');
176 //set up the ratings information that will be the same for all posts
177 $ratingoptions = new stdClass();
178 $ratingoptions->component = 'mod_forum';
179 $ratingoptions->ratingarea = 'post';
180 $ratingoptions->userid = $USER->id;
181 $ratingoptions->returnurl = $PAGE->url->out(false);
182 $rm = new rating_manager();
184 $PAGE->set_title($strsearchresults);
185 $PAGE->set_heading($course->fullname);
186 $PAGE->set_button($searchform);
187 echo $OUTPUT->header();
188 echo '<div class="reportlink">';
189 echo '<a href="search.php?id='.$course->id.
190                          '&amp;user='.urlencode($user).
191                          '&amp;userid='.$userid.
192                          '&amp;forumid='.$forumid.
193                          '&amp;subject='.urlencode($subject).
194                          '&amp;phrase='.urlencode($phrase).
195                          '&amp;words='.urlencode($words).
196                          '&amp;fullwords='.urlencode($fullwords).
197                          '&amp;notwords='.urlencode($notwords).
198                          '&amp;dateto='.$dateto.
199                          '&amp;datefrom='.$datefrom.
200                          '&amp;showform=1'.
201                          '">'.get_string('advancedsearch','forum').'...</a>';
202 echo '</div>';
204 echo $OUTPUT->heading($strforums, 2);
205 echo $OUTPUT->heading("$strsearchresults: $totalcount", 3);
207 $url = new moodle_url('search.php', array('search' => $search, 'id' => $course->id, 'perpage' => $perpage));
208 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url);
210 //added to implement highlighting of search terms found only in HTML markup
211 //fiedorow - 9/2/2005
212 $strippedsearch = str_replace('user:','',$search);
213 $strippedsearch = str_replace('subject:','',$strippedsearch);
214 $strippedsearch = str_replace('&quot;','',$strippedsearch);
215 $searchterms = explode(' ', $strippedsearch);    // Search for words independently
216 foreach ($searchterms as $key => $searchterm) {
217     if (preg_match('/^\-/',$searchterm)) {
218         unset($searchterms[$key]);
219     } else {
220         $searchterms[$key] = preg_replace('/^\+/','',$searchterm);
221     }
223 $strippedsearch = implode(' ', $searchterms);    // Rebuild the string
225 foreach ($posts as $post) {
227     // Replace the simple subject with the three items forum name -> thread name -> subject
228     // (if all three are appropriate) each as a link.
229     if (! $discussion = $DB->get_record('forum_discussions', array('id' => $post->discussion))) {
230         print_error('invaliddiscussionid', 'forum');
231     }
232     if (! $forum = $DB->get_record('forum', array('id' => "$discussion->forum"))) {
233         print_error('invalidforumid', 'forum');
234     }
236     if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
237         print_error('invalidcoursemodule');
238     }
240     $post->subject = highlight($strippedsearch, $post->subject);
241     $discussion->name = highlight($strippedsearch, $discussion->name);
243     $fullsubject = "<a href=\"view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
244     if ($forum->type != 'single') {
245         $fullsubject .= " -> <a href=\"discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a>";
246         if ($post->parent != 0) {
247             $fullsubject .= " -> <a href=\"discuss.php?d=$post->discussion&amp;parent=$post->id\">".format_string($post->subject,true)."</a>";
248         }
249     }
251     $post->subject = $fullsubject;
252     $post->subjectnoformat = true;
254     //add the ratings information to the post
255     //Unfortunately seem to have do this individually as posts may be from different forums
256     if ($forum->assessed != RATING_AGGREGATE_NONE) {
257         $modcontext = context_module::instance($cm->id);
258         $ratingoptions->context = $modcontext;
259         $ratingoptions->items = array($post);
260         $ratingoptions->aggregate = $forum->assessed;//the aggregation method
261         $ratingoptions->scaleid = $forum->scale;
262         $ratingoptions->assesstimestart = $forum->assesstimestart;
263         $ratingoptions->assesstimefinish = $forum->assesstimefinish;
264         $postswithratings = $rm->get_ratings($ratingoptions);
266         if ($postswithratings && count($postswithratings)==1) {
267             $post = $postswithratings[0];
268         }
269     }
271     // Identify search terms only found in HTML markup, and add a warning about them to
272     // the start of the message text. However, do not do the highlighting here. forum_print_post
273     // will do it for us later.
274     $missing_terms = "";
276     $options = new stdClass();
277     $options->trusted = $post->messagetrust;
278     $post->message = highlight($strippedsearch,
279                     format_text($post->message, $post->messageformat, $options, $course->id),
280                     0, '<fgw9sdpq4>', '</fgw9sdpq4>');
282     foreach ($searchterms as $searchterm) {
283         if (preg_match("/$searchterm/i",$post->message) && !preg_match('/<fgw9sdpq4>'.$searchterm.'<\/fgw9sdpq4>/i',$post->message)) {
284             $missing_terms .= " $searchterm";
285         }
286     }
288     $post->message = str_replace('<fgw9sdpq4>', '<span class="highlight">', $post->message);
289     $post->message = str_replace('</fgw9sdpq4>', '</span>', $post->message);
291     if ($missing_terms) {
292         $strmissingsearchterms = get_string('missingsearchterms','forum');
293         $post->message = '<p class="highlight2">'.$strmissingsearchterms.' '.$missing_terms.'</p>'.$post->message;
294     }
296     // Prepare a link to the post in context, to be displayed after the forum post.
297     $fulllink = "<a href=\"discuss.php?d=$post->discussion#p$post->id\">".get_string("postincontext", "forum")."</a>";
299     // Message is now html format.
300     if ($post->messageformat != FORMAT_HTML) {
301         $post->messageformat = FORMAT_HTML;
302     }
304     // Now pring the post.
305     forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false,
306             $fulllink, '', -99, false);
309 echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url);
311 echo $OUTPUT->footer();
314  /**
315   * Print a full-sized search form for the specified course.
316   *
317   * @param stdClass $course The Course that will be searched.
318   * @return void The function prints the form.
319   */
320 function forum_print_big_search_form($course) {
321     global $PAGE, $words, $subject, $phrase, $user, $userid, $fullwords, $notwords, $datefrom, $dateto, $OUTPUT;
323     $renderable = new \mod_forum\output\big_search_form($course, $user);
324     $renderable->set_words($words);
325     $renderable->set_phrase($phrase);
326     $renderable->set_notwords($notwords);
327     $renderable->set_fullwords($fullwords);
328     $renderable->set_datefrom($datefrom);
329     $renderable->set_dateto($dateto);
330     $renderable->set_subject($subject);
331     $renderable->set_user($user);
333     $output = $PAGE->get_renderer('mod_forum');
334     echo $output->render($renderable);
337 /**
338  * This function takes each word out of the search string, makes sure they are at least
339  * two characters long and returns an string of the space-separated search
340  * terms.
341  *
342  * @param string $words String containing space-separated strings to search for.
343  * @param string $prefix String to prepend to the each token taken out of $words.
344  * @return string The filtered search terms, separated by spaces.
345  * @todo Take the hardcoded limit out of this function and put it into a user-specified parameter.
346  */
347 function forum_clean_search_terms($words, $prefix='') {
348     $searchterms = explode(' ', $words);
349     foreach ($searchterms as $key => $searchterm) {
350         if (strlen($searchterm) < 2) {
351             unset($searchterms[$key]);
352         } else if ($prefix) {
353             $searchterms[$key] = $prefix.$searchterm;
354         }
355     }
356     return trim(implode(' ', $searchterms));
359  /**
360   * Retrieve a list of the forums that this user can view.
361   *
362   * @param stdClass $course The Course to use.
363   * @return array A set of formatted forum names stored against the forum id.
364   */
365 function forum_menu_list($course)  {
366     $menu = array();
368     $modinfo = get_fast_modinfo($course);
369     if (empty($modinfo->instances['forum'])) {
370         return $menu;
371     }
373     foreach ($modinfo->instances['forum'] as $cm) {
374         if (!$cm->uservisible) {
375             continue;
376         }
377         $context = context_module::instance($cm->id);
378         if (!has_capability('mod/forum:viewdiscussion', $context)) {
379             continue;
380         }
381         $menu[$cm->instance] = format_string($cm->name);
382     }
384     return $menu;