mod/forum/search.php

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