mod/forum/lib.php

   1 <?PHP  // $Id$
   2
   3 require_once("$CFG->dirroot/files/mimetypes.php");
   4
   5 /// CONSTANTS ///////////////////////////////////////////////////////////
   6
   7 define("FORUM_MODE_FLATOLDEST", 1);
   8 define("FORUM_MODE_FLATNEWEST", -1);
   9 define("FORUM_MODE_THREADED", 2);
  10 define("FORUM_MODE_NESTED", 3);
  11
  12 $FORUM_LAYOUT_MODES = array ( FORUM_MODE_FLATOLDEST => get_string("modeflatoldestfirst", "forum"),
  13                               FORUM_MODE_FLATNEWEST => get_string("modeflatnewestfirst", "forum"),
  14                               FORUM_MODE_THREADED   => get_string("modethreaded", "forum"),
  15                               FORUM_MODE_NESTED     => get_string("modenested", "forum") );
  16
  17 // These are course content forums that can be added to the course manually
  18 $FORUM_TYPES   = array ("general"    => get_string("generalforum", "forum"),
  19                         "eachuser"   => get_string("eachuserforum", "forum"),
  20                         "single"     => get_string("singleforum", "forum") );
  21
  22 $FORUM_OPEN_MODES   = array ("2" => get_string("openmode2", "forum"),
  23                              "1" => get_string("openmode1", "forum"),
  24                              "0" => get_string("openmode0", "forum") );
  25
  26 if (!isset($CFG->forum_displaymode)) {
  27     set_config("forum_displaymode", FORUM_MODE_NESTED);
  28 }
  29
  30 if (!isset($CFG->forum_shortpost)) {
  31     set_config("forum_shortpost", 300);  // Less non-HTML characters than this is short
  32 }
  33
  34 if (!isset($CFG->forum_longpost)) {
  35     set_config("forum_longpost", 600);  // More non-HTML characters than this is long
  36 }
  37
  38 if (!isset($CFG->forum_manydiscussions)) {
  39     set_config("forum_manydiscussions", 100);  // Number of discussions on a page
  40 }
  41
  42 if (!isset($CFG->forum_maxbytes)) {
  43     set_config("forum_maxbytes", 512000);  // Default maximum size for all forums
  44 }
  45
  46
  47
  48 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
  49
  50 function forum_add_instance($forum) {
  51 // Given an object containing all the necessary data,
  52 // (defined by the form in mod.html) this function
  53 // will create a new instance and return the id number
  54 // of the new instance.
  55
  56     global $CFG;
  57
  58     $forum->timemodified = time();
  59
  60     if (! $forum->id = insert_record("forum", $forum)) {
  61         return false;
  62     }
  63
  64     if (!$forum->userating) {
  65         $forum->assessed = 0;
  66     }
  67
  68     if (!empty($forum->ratingtime)) {
  69         $forum->assesstimestart  = make_timestamp($forum->startyear, $forum->startmonth, $forum->startday,
  70                                                   $forum->starthour, $forum->startminute, 0);
  71         $forum->assesstimefinish = make_timestamp($forum->finishyear, $forum->finishmonth, $forum->finishday,
  72                                                   $forum->finishhour, $forum->finishminute, 0);
  73     } else {
  74         $forum->assesstimestart  = 0;
  75         $forum->assesstimefinish = 0;
  76     }
  77
  78     if ($forum->type == "single") {  // Create related discussion.
  79         $discussion->course   = $forum->course;
  80         $discussion->forum    = $forum->id;
  81         $discussion->name     = $forum->name;
  82         $discussion->intro    = $forum->intro;
  83         $discussion->assessed = $forum->assessed;
  84
  85         if (! forum_add_discussion($discussion)) {
  86             error("Could not add the discussion for this forum");
  87         }
  88     }
  89
  90     return $forum->id;
  91 }
  92
  93
  94 function forum_update_instance($forum) {
  95 // Given an object containing all the necessary data,
  96 // (defined by the form in mod.html) this function
  97 // will update an existing instance with new data.
  98
  99     $forum->timemodified = time();
 100     $forum->id = $forum->instance;
 101
 102     if (!$forum->userating) {
 103         $forum->assessed = 0;
 104     }
 105
 106     if (!empty($forum->ratingtime)) {
 107         $forum->assesstimestart  = make_timestamp($forum->startyear, $forum->startmonth, $forum->startday,
 108                                                   $forum->starthour, $forum->startminute, 0);
 109         $forum->assesstimefinish = make_timestamp($forum->finishyear, $forum->finishmonth, $forum->finishday,
 110                                                   $forum->finishhour, $forum->finishminute, 0);
 111     } else {
 112         $forum->assesstimestart  = 0;
 113         $forum->assesstimefinish = 0;
 114     }
 115
 116     if ($forum->type == "single") {  // Update related discussion and post.
 117         if (! $discussion = get_record("forum_discussions", "forum", $forum->id)) {
 118             if ($discussions = get_records("forum_discussions", "forum", $forum->id, "timemodified ASC")) {
 119                 notify("Warning! There is more than one discussion in this forum - using the most recent");
 120                 $discussion = array_pop($discussions);
 121             } else {
 122                 error("Could not find the discussion in this forum");
 123             }
 124         }
 125         if (! $post = get_record("forum_posts", "id", $discussion->firstpost)) {
 126             error("Could not find the first post in this forum discussion");
 127         }
 128
 129         $post->subject  = $forum->name;
 130         $post->message  = $forum->intro;
 131         $post->modified = $forum->timemodified;
 132
 133         if (! update_record("forum_posts", $post)) {
 134             error("Could not update the first post");
 135         }
 136
 137         $discussion->name = $forum->name;
 138
 139         if (! update_record("forum_discussions", $discussion)) {
 140             error("Could not update the discussion");
 141         }
 142     }
 143
 144     return update_record("forum", $forum);
 145 }
 146
 147
 148 function forum_delete_instance($id) {
 149 // Given an ID of an instance of this module,
 150 // this function will permanently delete the instance
 151 // and any data that depends on it.
 152
 153     if (! $forum = get_record("forum", "id", "$id")) {
 154         return false;
 155     }
 156
 157     $result = true;
 158
 159     if ($discussions = get_records("forum_discussions", "forum", $forum->id)) {
 160         foreach ($discussions as $discussion) {
 161             if (! forum_delete_discussion($discussion)) {
 162                 $result = false;
 163             }
 164         }
 165     }
 166
 167     if (! delete_records("forum_subscriptions", "forum", "$forum->id")) {
 168         $result = false;
 169     }
 170
 171     if (! delete_records("forum", "id", "$forum->id")) {
 172         $result = false;
 173     }
 174
 175     return $result;
 176 }
 177
 178
 179 function forum_cron () {
 180 /// Function to be run periodically according to the moodle cron
 181 /// Finds all posts that have yet to be mailed out, and mails them
 182 /// out to all subscribers
 183
 184     global $CFG, $USER;
 185
 186     if (!empty($USER)) { // Remember real USER account if necessary
 187         $realuser = $USER;
 188     }
 189
 190     $cutofftime = time() - $CFG->maxeditingtime;
 191
 192     if ($posts = forum_get_unmailed_posts($cutofftime)) {
 193
 194         /// Mark them all now as being mailed.  It's unlikely but possible there
 195         /// might be an error later so that a post is NOT actually mailed out,
 196         /// but since mail isn't crucial, we can accept this risk.  Doing it now
 197         /// prevents the risk of duplicated mails, which is a worse problem.
 198
 199         foreach ($posts as $key => $post) {
 200             if (! set_field("forum_posts", "mailed", "1", "id", "$post->id")) {
 201                 echo "Error marking post id post->id as being mailed.  This post will not be mailed.\n";
 202                 unset($posts[$key]);
 203             }
 204         }
 205
 206         $timenow = time();
 207
 208         foreach ($posts as $post) {
 209
 210             echo "\n";
 211             print_string("processingpost", "forum", $post->id);
 212             echo "\n";
 213
 214             if (! $userfrom = get_record("user", "id", "$post->userid")) {
 215                 echo "Could not find user $post->userid\n";
 216                 continue;
 217             }
 218
 219             if (! $discussion = get_record("forum_discussions", "id", "$post->discussion")) {
 220                 echo "Could not find discussion $post->discussion\n";
 221                 continue;
 222             }
 223
 224             if (! $forum = get_record("forum", "id", "$discussion->forum")) {
 225                 echo "Could not find forum $discussion->forum\n";
 226                 continue;
 227             }
 228
 229             if (! $course = get_record("course", "id", "$forum->course")) {
 230                 echo "Could not find course $forum->course\n";
 231                 continue;
 232             }
 233
 234             if (!empty($course->lang)) {
 235                 $CFG->courselang = $course->lang;
 236             } else {
 237                 unset($CFG->courselang);
 238             }
 239
 240             $groupmode = false;
 241             if ($cm = get_coursemodule_from_instance("forum", $forum->id, $course->id)) {
 242                 if ($groupmode = groupmode($course, $cm)) {                  // Groups are being used
 243                     if (!$group = get_record("groups", "id", $discussion->groupid)) {   // Can't find group
 244                         continue;                                            // Be safe and don't send it to anyone
 245                     }
 246                 }
 247             } else {
 248                 $cm->id = 0;
 249             }
 250
 251
 252             if ($users = forum_subscribed_users($course, $forum)) {
 253                 $canunsubscribe = ! forum_is_forcesubscribed($forum->id);
 254
 255                 $mailcount=0;
 256                 $errorcount=0;
 257                 foreach ($users as $userto) {
 258                     if ($groupmode) {    // Look for a reason not to send this email
 259                         if (!isteacheredit($course->id, $userto->id)) {
 260                             if (!ismember($group->id, $userto->id)) {
 261                                 continue;
 262                             }
 263                         }
 264                     }
 265
 266                     /// GWD: reset timelimit so that script does not get timed out when posting to many users
 267                     set_time_limit(10);
 268
 269                     /// Override the language and timezone of the "current" user, so that
 270                     /// mail is customised for the receiver.
 271                     $USER->lang     = $userto->lang;
 272                     $USER->timezone = $userto->timezone;
 273
 274                     $canreply = forum_user_can_post($forum, $userto);
 275
 276                     $by->name = fullname($userfrom, isteacher($course->id, $userto->id));
 277                     $by->date = userdate($post->modified, "", $userto->timezone);
 278                     $strbynameondate = get_string("bynameondate", "forum", $by);
 279
 280                     $strforums = get_string("forums", "forum");
 281
 282                     $postsubject = "$course->shortname: $post->subject";
 283                     $posttext  = "$course->shortname -> $strforums -> $forum->name";
 284
 285                     if ($discussion->name == $forum->name) {
 286                         $posttext  .= "\n";
 287                     } else {
 288                         $posttext  .= " -> $discussion->name\n";
 289                     }
 290                     $posttext .= "---------------------------------------------------------------------\n";
 291                     $posttext .= "$post->subject\n";
 292                     $posttext .= $strbynameondate."\n";
 293                     $posttext .= "---------------------------------------------------------------------\n";
 294                     $posttext .= format_text_email($post->message, $post->format);
 295                     $posttext .= "\n\n";
 296                     if ($post->attachment) {
 297                         $post->course = $course->id;
 298                         $post->forum = $forum->id;
 299                         $posttext .= forum_print_attachments($post, "text");
 300                     }
 301                     if ($canreply) {
 302                         $posttext .= "---------------------------------------------------------------------\n";
 303                         $posttext .= get_string("postmailinfo", "forum", $course->shortname)."\n";
 304                         $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
 305                     }
 306                     if ($canunsubscribe) {
 307                         $posttext .= "\n---------------------------------------------------------------------\n";
 308                         $posttext .= get_string("unsubscribe", "forum");
 309                         $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
 310                     }
 311
 312                     if ($userto->mailformat == 1) {  // HTML
 313                         $posthtml = "<p><font face=\"sans-serif\">".
 314                         "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> -> ".
 315                         "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
 316                         "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">$forum->name</a>";
 317                         if ($discussion->name == $forum->name) {
 318                             $posthtml .= "</font></p>";
 319                         } else {
 320                             $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">$discussion->name</a></font></p>";
 321                         }
 322                         $posthtml .= forum_make_mail_post($post, $userfrom, $userto, $course, false, $canreply, false, false);
 323
 324                         if ($canunsubscribe) {
 325                             $posthtml .= "\n<br /><hr size=\"1\" noshade /><p align=\"right\"><font size=\"1\"><a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">".get_string("unsubscribe", "forum")."</a></font></p>";
 326                         }
 327
 328                     } else {
 329                       $posthtml = "";
 330                     }
 331
 332                     if (! email_to_user($userto, $userfrom, $postsubject, $posttext, $posthtml)) {
 333                         echo "Error: mod/forum/cron.php: Could not send out mail for id $post->id to user $userto->id ($userto->email) .. not trying again.\n";
 334                         add_to_log($course->id, 'forum', 'mail error', "discuss.php?d=$discussion->id#$post->id", substr($post->subject,0,15), $cm->id, $userto->id);
 335                         $errorcount++;
 336                     } else {
 337                         $mailcount++;
 338                     }
 339                 }
 340
 341                 echo ".... mailed to $mailcount users.\n";
 342                 if ($errorcount) {
 343                     set_field("forum_posts", "mailed", "2", "id", "$post->id");
 344                 }
 345             }
 346         }
 347     }
 348
 349     if (!empty($realuser)) {   // Restore real USER if necessary
 350         $USER = $realuser;
 351     }
 352
 353     return true;
 354 }
 355
 356 function forum_user_outline($course, $user, $mod, $forum) {
 357
 358     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
 359         $result->info = get_string("numposts", "forum", count($posts));
 360
 361         $lastpost = array_pop($posts);
 362         $result->time = $lastpost->modified;
 363         return $result;
 364     }
 365     return NULL;
 366 }
 367
 368
 369 function forum_user_complete($course, $user, $mod, $forum) {
 370     global $CFG;
 371
 372     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
 373         foreach ($posts as $post) {
 374             forum_print_post($post, $course->id, $ownpost=false, $reply=false, $link=false, $rate=false);
 375         }
 376
 377     } else {
 378         echo "<P>".get_string("noposts", "forum")."</P>";
 379     }
 380 }
 381
 382 function forum_print_recent_activity($course, $isteacher, $timestart) {
 383 /// Given a course and a date, prints a summary of all the new
 384 /// messages posted in the course since that date
 385
 386     global $CFG;
 387
 388     $heading = false;
 389     $content = false;
 390
 391     if (!$logs = get_records_select("log", "time > '$timestart' AND ".
 392                                            "course = '$course->id' AND ".
 393                                            "module = 'forum' AND ".
 394                                            "action LIKE 'add %' ", "time ASC")){
 395         return false;
 396     }
 397
 398     $strftimerecent = get_string("strftimerecent");
 399
 400     $isteacheredit = isteacheredit($course->id);
 401     $mygroupid     = mygroupid($course->id);
 402
 403     $groupmode = array();   /// To cache group modes
 404
 405     foreach ($logs as $log) {
 406         //Get post info, I'll need it later
 407         $post = forum_get_post_from_log($log);
 408
 409         //Create a temp valid module structure (course,id)
 410         $tempmod->course = $log->course;
 411         $tempmod->id = $post->forum;
 412         //Obtain the visible property from the instance
 413         $modvisible = instance_is_visible($log->module, $tempmod);
 414
 415         //Only if the mod is visible
 416         if ($modvisible) {
 417             if ($post) {
 418                 /// Check whether this is for teachers only
 419                 $teacheronly = "";
 420                 if ($forum = get_record("forum", "id", $post->forum)) {
 421                     if ($forum->type == "teacher") {
 422                         if ($isteacher) {
 423                             $teacheronly = "class=\"teacheronly\"";
 424                         } else {
 425                             continue;
 426                         }
 427                     }
 428                 }
 429                 /// Check whether this is belongs to a discussion in a group that
 430                 /// should NOT be accessible to the current user
 431
 432                 if (!$isteacheredit) {   /// Because editing teachers can see everything anyway
 433                     if (!isset($cm[$post->forum])) {
 434                         $cm[$forum->id] = get_coursemodule_from_instance("forum", $forum->id, $course->id);
 435                         $groupmode[$forum->id] = groupmode($course, $cm[$forum->id]);
 436                     }
 437                     if ($groupmode[$forum->id]) {
 438                         if ($mygroupid != $post->groupid) {
 439                             continue;
 440                         }
 441                     }
 442                 }
 443
 444                 if (! $heading) {
 445                     print_headline(get_string("newforumposts", "forum").":");
 446                     $heading = true;
 447                     $content = true;
 448                 }
 449                 $date = userdate($post->modified, $strftimerecent);
 450                 $fullname = fullname($post, $isteacher);
 451                 echo "<p $teacheronly><font size=1>$date - $fullname<br>";
 452                 echo "\"<a href=\"$CFG->wwwroot/mod/forum/$log->url\">";
 453                 if (!empty($CFG->filterall)) {
 454                     $post->subject = filter_text($post->subject, $course->id);
 455                 }
 456                 if ($log->action == "add discussion") {
 457                     echo "<b>$post->subject</b>";
 458                 } else {
 459                     echo "$post->subject";
 460                 }
 461                 echo "</a>\"</font></p>";
 462             }
 463         }
 464     }
 465
 466     return $content;
 467 }
 468
 469
 470 function forum_grades($forumid) {
 471 /// Must return an array of grades, indexed by user, and a max grade.
 472
 473     if (!$forum = get_record("forum", "id", $forumid)) {
 474         return false;
 475     }
 476     if (!$forum->assessed) {
 477         return false;
 478     }
 479     $scalemenu = make_grades_menu($forum->scale);
 480
 481     $currentuser = 0;
 482     $ratingsuser = array();
 483
 484     if ($ratings = forum_get_user_grades($forumid)) {
 485         foreach ($ratings as $rating) {     // Ordered by user
 486             if ($currentuser and $rating->userid != $currentuser) {
 487                 if (!empty($ratingsuser)) {
 488                     if ($forum->scale < 0) {
 489                         $return->grades[$currentuser] = forum_get_ratings_mean(0, $scalemenu, $ratingsuser);
 490                         $return->grades[$currentuser] .= "<br />".forum_get_ratings_summary(0, $scalemenu, $ratingsuser);
 491                     } else {
 492                         $total = 0;
 493                         $count = 0;
 494                         foreach ($ratingsuser as $ra) {
 495                             $total += $ra;
 496                             $count ++;
 497                         }
 498                         $return->grades[$currentuser] = format_float($total/$count, 2);
 499                     }
 500                 } else {
 501                     $return->grades[$currentuser] = "";
 502                 }
 503                 $ratingsuser = array();
 504             }
 505             $ratingsuser[] = $rating->rating;
 506             $currentuser = $rating->userid;
 507         }
 508         if (!empty($ratingsuser)) {
 509             if ($forum->scale < 0) {
 510                 $return->grades[$currentuser] = forum_get_ratings_mean(0, $scalemenu, $ratingsuser);
 511                 $return->grades[$currentuser] .= "<br />".forum_get_ratings_summary(0, $scalemenu, $ratingsuser);
 512             } else {
 513                 $total = 0;
 514                 $count = 0;
 515                 foreach ($ratingsuser as $ra) {
 516                     $total += $ra;
 517                     $count ++;
 518                 }
 519                 $return->grades[$currentuser] = format_float((float)$total/(float)$count, 2);
 520             }
 521         } else {
 522             $return->grades[$currentuser] = "";
 523         }
 524     } else {
 525         $return->grades = array();
 526     }
 527
 528     if ($forum->scale < 0) {
 529         $return->maxgrade = "";
 530     } else {
 531         $return->maxgrade = $forum->scale;
 532     }
 533     return $return;
 534 }
 535
 536 function forum_get_participants($forumid) {
 537 //Returns the users with data in one forum
 538 //(users with records in forum_subscriptions, forum_posts and forum_ratings, students)
 539
 540     global $CFG;
 541
 542     //Get students from forum_subscriptions
 543     $st_subscriptions = get_records_sql("SELECT DISTINCT u.*
 544                                          FROM {$CFG->prefix}user u,
 545                                               {$CFG->prefix}forum_subscriptions s
 546                                          WHERE s.forum = '$forumid' and
 547                                                u.id = s.userid");
 548     //Get students from forum_posts
 549     $st_posts = get_records_sql("SELECT DISTINCT u.*
 550                                  FROM {$CFG->prefix}user u,
 551                                       {$CFG->prefix}forum_discussions d,
 552                                       {$CFG->prefix}forum_posts p
 553                                  WHERE d.forum = '$forumid' and
 554                                        p.discussion = d.id and
 555                                        u.id = p.userid");
 556
 557     //Get students from forum_ratings
 558     $st_ratings = get_records_sql("SELECT DISTINCT u.*
 559                                    FROM {$CFG->prefix}user u,
 560                                         {$CFG->prefix}forum_discussions d,
 561                                         {$CFG->prefix}forum_posts p,
 562                                         {$CFG->prefix}forum_ratings r
 563                                    WHERE d.forum = '$forumid' and
 564                                          p.discussion = d.id and
 565                                          r.post = p.id and
 566                                          u.id = r.userid");
 567
 568     //Add st_posts to st_subscriptions
 569     if ($st_posts) {
 570         foreach ($st_posts as $st_post) {
 571             $st_subscriptions[$st_post->id] = $st_post;
 572         }
 573     }
 574     //Add st_ratings to st_subscriptions
 575     if ($st_ratings) {
 576         foreach ($st_ratings as $st_rating) {
 577             $st_subscriptions[$st_rating->id] = $st_rating;
 578         }
 579     }
 580     //Return st_subscriptions array (it contains an array of unique users)
 581     return ($st_subscriptions);
 582 }
 583
 584 /// SQL FUNCTIONS ///////////////////////////////////////////////////////////
 585
 586 function forum_get_post_full($postid) {
 587 /// Gets a post with all info ready for forum_print_post
 588     global $CFG;
 589
 590     return get_record_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture
 591                             FROM {$CFG->prefix}forum_posts p,
 592                                  {$CFG->prefix}user u
 593                            WHERE p.id = '$postid'
 594                              AND p.userid = u.id");
 595 }
 596
 597 function forum_get_discussion_posts($discussion, $sort) {
 598 /// Gets posts with all info ready for forum_print_post
 599     global $CFG;
 600
 601     return get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture
 602                               FROM {$CFG->prefix}forum_posts p,
 603                                    {$CFG->prefix}user u
 604                              WHERE p.discussion = $discussion
 605                                AND p.parent > 0
 606                                AND p.userid = u.id $sort");
 607 }
 608
 609 function forum_get_child_posts($parent) {
 610 /// Gets posts with all info ready for forum_print_post
 611     global $CFG;
 612
 613     return get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture
 614                               FROM {$CFG->prefix}forum_posts p,
 615                                    {$CFG->prefix}user u
 616                              WHERE p.parent = '$parent'
 617                                AND p.userid = u.id
 618                           ORDER BY p.created ASC");
 619 }
 620
 621
 622 function forum_search_posts($searchterms, $courseid, $page=0, $recordsperpage=50, &$totalcount) {
 623 /// Returns a list of posts found using an array of search terms
 624 /// eg   word  +word -word
 625 ///
 626
 627     global $CFG;
 628
 629     if (!isteacher($courseid)) {
 630         $notteacherforum = "AND f.type <> 'teacher'";
 631
 632         $forummodule = get_record("modules", "name", "forum");
 633         $onlyvisible = " AND f.id = cm.instance AND cm.visible = 1 AND cm.module = $forummodule->id";
 634         $onlyvisibletable = ", {$CFG->prefix}course_modules cm";
 635     } else {
 636         $notteacherforum = "";
 637
 638         $onlyvisible = "";
 639         $onlyvisibletable = "";
 640     }
 641
 642     switch ($CFG->dbtype) {
 643         case "mysql":
 644              $limit = "LIMIT $page,$recordsperpage";
 645              break;
 646         case "postgres7":
 647              $limit = "LIMIT $recordsperpage OFFSET ".($page * $recordsperpage);
 648              break;
 649         default:
 650              $limit = "LIMIT $recordsperpage,$page";
 651     }
 652
 653     /// Some differences in syntax for PostgreSQL
 654     if ($CFG->dbtype == "postgres7") {
 655         $LIKE = "ILIKE";   // case-insensitive
 656         $NOTLIKE = "NOT ILIKE";   // case-insensitive
 657         $REGEXP = "~*";
 658         $NOTREGEXP = "!~*";
 659     } else {
 660         $LIKE = "LIKE";
 661         $NOTLIKE = "NOT LIKE";
 662         $REGEXP = "REGEXP";
 663         $NOTREGEXP = "NOT REGEXP";
 664     }
 665
 666     $messagesearch = "";
 667     $subjectsearch = "";
 668
 669
 670     foreach ($searchterms as $searchterm) {
 671         if (strlen($searchterm) < 2) {
 672             continue;
 673         }
 674         if ($messagesearch) {
 675             $messagesearch .= " AND ";
 676         }
 677         if ($subjectsearch) {
 678             $subjectsearch .= " AND ";
 679         }
 680
 681         if (substr($searchterm,0,1) == "+") {
 682             $searchterm = substr($searchterm,1);
 683             $messagesearch .= " p.message $REGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
 684             $subjectsearch .= " p.subject $REGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
 685         } else if (substr($searchterm,0,1) == "-") {
 686             $searchterm = substr($searchterm,1);
 687             $messagesearch .= " p.message $NOTREGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
 688             $subjectsearch .= " p.subject $NOTREGEXP '(^|[^a-zA-Z0-9])$searchterm([^a-zA-Z0-9]|$)' ";
 689         } else {
 690             $messagesearch .= " p.message $LIKE '%$searchterm%' ";
 691             $subjectsearch .= " p.subject $LIKE '%$searchterm%' ";
 692         }
 693     }
 694
 695     $selectsql = "{$CFG->prefix}forum_posts p,
 696                   {$CFG->prefix}forum_discussions d,
 697                   {$CFG->prefix}user u,
 698                   {$CFG->prefix}forum f $onlyvisibletable
 699              WHERE ($messagesearch OR $subjectsearch)
 700                AND p.userid = u.id
 701                AND p.discussion = d.id
 702                AND d.course = '$courseid'
 703                AND d.forum = f.id $notteacherforum $onlyvisible";
 704
 705     $totalcount = count_records_sql("SELECT COUNT(*) FROM $selectsql");
 706
 707     return get_records_sql("SELECT p.*,u.firstname,u.lastname,u.email,u.picture FROM
 708                             $selectsql ORDER BY p.modified DESC $limit");
 709 }
 710
 711
 712 function forum_get_ratings($postid, $sort="u.firstname ASC") {
 713 /// Returns a list of ratings for a particular post - sorted.
 714     global $CFG;
 715     return get_records_sql("SELECT u.*, r.rating, r.time
 716                               FROM {$CFG->prefix}forum_ratings r,
 717                                    {$CFG->prefix}user u
 718                              WHERE r.post = '$postid'
 719                                AND r.userid = u.id
 720                              ORDER BY $sort");
 721 }
 722
 723 function forum_get_unmailed_posts($cutofftime) {
 724 /// Returns a list of all new posts that have not been mailed yet
 725     global $CFG;
 726     return get_records_sql("SELECT p.*, d.course
 727                               FROM {$CFG->prefix}forum_posts p,
 728                                    {$CFG->prefix}forum_discussions d
 729                              WHERE p.mailed = 0
 730                                AND p.created < '$cutofftime'
 731                                AND p.discussion = d.id");
 732 }
 733
 734 function forum_get_user_posts($forumid, $userid) {
 735 /// Get all the posts for a user in a forum suitable for forum_print_post
 736     global $CFG;
 737
 738     return get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture
 739                               FROM {$CFG->prefix}forum f,
 740                                    {$CFG->prefix}forum_discussions d,
 741                                    {$CFG->prefix}forum_posts p,
 742                                    {$CFG->prefix}user u
 743                              WHERE f.id = '$forumid'
 744                                AND d.forum = f.id
 745                                AND p.discussion = d.id
 746                                AND p.userid = '$userid'
 747                                AND p.userid = u.id
 748                           ORDER BY p.modified ASC");
 749 }
 750
 751 function forum_get_post_from_log($log) {
 752 /// Given a log entry, return the forum post details for it.
 753     global $CFG;
 754
 755     if ($log->action == "add post") {
 756
 757         return get_record_sql("SELECT p.*, d.forum, d.groupid, u.firstname, u.lastname, u.email, u.picture
 758                                  FROM {$CFG->prefix}forum_discussions d,
 759                                       {$CFG->prefix}forum_posts p,
 760                                       {$CFG->prefix}user u
 761                                 WHERE p.id = '$log->info'
 762                                   AND d.id = p.discussion
 763                                   AND p.userid = u.id
 764                                   AND u.deleted <> '1'");
 765
 766
 767     } else if ($log->action == "add discussion") {
 768
 769         return get_record_sql("SELECT p.*, d.forum, d.groupid, u.firstname, u.lastname, u.email, u.picture
 770                                  FROM {$CFG->prefix}forum_discussions d,
 771                                       {$CFG->prefix}forum_posts p,
 772                                       {$CFG->prefix}user u
 773                                 WHERE d.id = '$log->info'
 774                                   AND d.firstpost = p.id
 775                                   AND p.userid = u.id
 776                                   AND u.deleted <> '1'");
 777     }
 778     return NULL;
 779 }
 780
 781 function forum_get_firstpost_from_discussion($discussionid) {
 782 /// Given a discussion id, return the first post from the discussion
 783     global $CFG;
 784
 785     return get_record_sql("SELECT p.*
 786                              FROM {$CFG->prefix}forum_discussions d,
 787                                   {$CFG->prefix}forum_posts p
 788                             WHERE d.id = '$discussionid'
 789                               AND d.firstpost = p.id ");
 790 }
 791
 792
 793 function forum_get_user_grades($forumid) {
 794 /// Get all user grades for a forum
 795     global $CFG;
 796
 797     return get_records_sql("SELECT r.id, p.userid, r.rating
 798                               FROM {$CFG->prefix}forum_discussions d,
 799                                    {$CFG->prefix}forum_posts p,
 800                                    {$CFG->prefix}forum_ratings r
 801                              WHERE d.forum = '$forumid'
 802                                AND p.discussion = d.id
 803                                AND r.post = p.id
 804                              ORDER by p.userid ");
 805 }
 806
 807
 808 function forum_count_discussion_replies($forum="0") {
 809 // Returns an array of counts of replies to each discussion (optionally in one forum)
 810     global $CFG;
 811
 812     if ($forum) {
 813         $forumselect = " AND d.forum = '$forum'";
 814     }
 815     return get_records_sql("SELECT p.discussion, (count(*)) as replies
 816                               FROM {$CFG->prefix}forum_posts p,
 817                                    {$CFG->prefix}forum_discussions d
 818                              WHERE p.parent > 0
 819                                AND p.discussion = d.id
 820                           GROUP BY p.discussion");
 821 }
 822
 823 function forum_count_unrated_posts($discussionid, $userid) {
 824 // How many unrated posts are in the given discussion for a given user?
 825     global $CFG;
 826     if ($posts = get_record_sql("SELECT count(*) as num
 827                                    FROM {$CFG->prefix}forum_posts
 828                                   WHERE parent > 0
 829                                     AND discussion = '$discussionid'
 830                                     AND userid <> '$userid' ")) {
 831
 832         if ($rated = get_record_sql("SELECT count(*) as num
 833                                        FROM {$CFG->prefix}forum_posts p,
 834                                             {$CFG->prefix}forum_ratings r
 835                                       WHERE p.discussion = '$discussionid'
 836                                         AND p.id = r.post
 837                                         AND r.userid = '$userid'")) {
 838             $difference = $posts->num - $rated->num;
 839             if ($difference > 0) {
 840                 return $difference;
 841             } else {
 842                 return 0;    // Just in case there was a counting error
 843             }
 844         } else {
 845             return $posts->num;
 846         }
 847     } else {
 848         return 0;
 849     }
 850 }
 851
 852 function forum_get_discussions($forum="0", $forumsort="d.timemodified DESC",
 853                                $user=0, $fullpost=true, $currentgroup=0) {
 854 /// Get all discussions in a forum
 855     global $CFG;
 856
 857     if ($user) {
 858         $userselect = " AND u.id = '$user' ";
 859     } else {
 860         $userselect = "";
 861     }
 862     if ($currentgroup) {
 863         $groupselect = " AND d.groupid = '$currentgroup' ";
 864     } else  {
 865         $groupselect = "";
 866     }
 867     if (empty($forumsort)) {
 868         $forumsort = "d.timemodified DESC";
 869     }
 870     if (empty($fullpost)) {
 871         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
 872     } else {
 873         $postdata = "p.*";
 874     }
 875
 876     return get_records_sql("SELECT $postdata, d.timemodified, d.usermodified,
 877                                    u.firstname, u.lastname, u.email, u.picture
 878                               FROM {$CFG->prefix}forum_discussions d,
 879                                    {$CFG->prefix}forum_posts p,
 880                                    {$CFG->prefix}user u
 881                              WHERE d.forum = '$forum'
 882                                AND p.discussion = d.id
 883                                AND p.parent = 0
 884                                AND p.userid = u.id $groupselect $userselect
 885                           ORDER BY $forumsort");
 886 }
 887
 888
 889
 890 function forum_get_user_discussions($courseid, $userid) {
 891 /// Get all discussions started by a particular user in a course
 892     global $CFG;
 893
 894     return get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture,
 895                                    f.type as forumtype, f.name as forumname, f.id as forumid
 896                               FROM {$CFG->prefix}forum_discussions d,
 897                                    {$CFG->prefix}forum_posts p,
 898                                    {$CFG->prefix}user u,
 899                                    {$CFG->prefix}forum f
 900                              WHERE d.course = '$courseid'
 901                                AND p.discussion = d.id
 902                                AND p.parent = 0
 903                                AND p.userid = u.id
 904                                AND u.id = '$userid'
 905                                AND d.forum = f.id
 906                           ORDER BY p.created DESC");
 907 }
 908
 909
 910 function forum_subscribed_users($course, $forum) {
 911 /// Returns list of user objects that are subscribed to this forum
 912     global $CFG;
 913
 914     if ($forum->forcesubscribe) {
 915         if ($course->category) {
 916             if ($forum->type == "teacher") {
 917                 return get_course_teachers($course->id);  // Only teachers can be subscribed to teacher forums
 918             } else {
 919                 return get_course_users($course->id);     // Otherwise get everyone in the course
 920             }
 921         } else {
 922             return get_site_users();
 923         }
 924     }
 925     return get_records_sql("SELECT u.id, u.username, u.firstname, u.lastname, u.maildisplay, u.mailformat, u.emailstop,
 926                                    u.email, u.city, u.country, u.lastaccess, u.lastlogin, u.picture, u.timezone, u.lang
 927                               FROM {$CFG->prefix}user u,
 928                                    {$CFG->prefix}forum_subscriptions s
 929                              WHERE s.forum = '$forum->id'
 930                                AND s.userid = u.id
 931                                AND u.deleted <> 1
 932                           ORDER BY u.email ASC");
 933 }
 934
 935 /// OTHER FUNCTIONS ///////////////////////////////////////////////////////////
 936
 937
 938 function forum_get_course_forum($courseid, $type) {
 939 // How to set up special 1-per-course forums
 940     global $CFG;
 941
 942     if ($forums = get_records_select("forum", "course = '$courseid' AND type = '$type'", "id ASC")) {
 943         // There should always only be ONE, but with the right combination of
 944         // errors there might be more.  In this case, just return the oldest one (lowest ID).
 945         foreach ($forums as $forum) {
 946             return $forum;   // ie the first one
 947         }
 948     }
 949
 950     // Doesn't exist, so create one now.
 951     $forum->course = $courseid;
 952     $forum->type = "$type";
 953     switch ($forum->type) {
 954         case "news":
 955             $forum->name  = addslashes(get_string("namenews", "forum"));
 956             $forum->intro = addslashes(get_string("intronews", "forum"));
 957             $forum->forcesubscribe = 1;
 958             $forum->open = 1;   // 0 - no, 1 - posts only, 2 - discuss and post
 959             $forum->assessed = 0;
 960             if ($site = get_site()) {
 961                 if ($courseid == $site->id) {
 962                     $forum->name  = get_string("sitenews");
 963                     $forum->forcesubscribe = 0;
 964                 }
 965             }
 966             break;
 967         case "social":
 968             $forum->name  = addslashes(get_string("namesocial", "forum"));
 969             $forum->intro = addslashes(get_string("introsocial", "forum"));
 970             $forum->open = 2;   // 0 - no, 1 - posts only, 2 - discuss and post
 971             $forum->assessed = 0;
 972             $forum->forcesubscribe = 0;
 973             break;
 974         case "teacher":
 975             $forum->name  = addslashes(get_string("nameteacher", "forum"));
 976             $forum->intro = addslashes(get_string("introteacher", "forum"));
 977             $forum->open = 0;   // 0 - no, 1 - posts only, 2 - discuss and post
 978             $forum->assessed = 0;
 979             $forum->forcesubscribe = 0;
 980             break;
 981         default:
 982             notify("That forum type doesn't exist!");
 983             return false;
 984             break;
 985     }
 986
 987     $forum->timemodified = time();
 988     $forum->id = insert_record("forum", $forum);
 989
 990     if ($forum->type != "teacher") {
 991         if (! $module = get_record("modules", "name", "forum")) {
 992             notify("Could not find forum module!!");
 993             return false;
 994         }
 995         $mod->course = $courseid;
 996         $mod->module = $module->id;
 997         $mod->instance = $forum->id;
 998         $mod->section = 0;
 999         if (! $mod->coursemodule = add_course_module($mod) ) {   // assumes course/lib.php is loaded
1000             notify("Could not add a new course module to the course '$course->fullname'");
1001             return false;
1002         }
1003         if (! $sectionid = add_mod_to_section($mod) ) {   // assumes course/lib.php is loaded
1004             notify("Could not add the new course module to that section");
1005             return false;
1006         }
1007         if (! set_field("course_modules", "section", $sectionid, "id", $mod->coursemodule)) {
1008             notify("Could not update the course module with the correct section");
1009             return false;
1010         }
1011         include_once("$CFG->dirroot/course/lib.php");
1012         rebuild_course_cache($courseid);
1013     }
1014
1015     return get_record("forum", "id", "$forum->id");
1016 }
1017
1018
1019 function forum_make_mail_post(&$post, $user, $touser, $course,
1020                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
1021 // Given the data about a posting, builds up the HTML to display it and
1022 // returns the HTML in a string.  This is designed for sending via HTML email.
1023
1024     global $THEME, $CFG;
1025
1026     static $formattedtext;        // Cached version of formatted text for a post
1027     static $formattedtextid;      // The ID number of the post
1028
1029     if (empty($formattedtextid) or $formattedtextid != $post->id) {    // Recalculate the formatting
1030         $formattedtext = format_text($post->message, $post->format, NULL, $course->id);
1031         $formattedtextid = $post->id;
1032     }
1033
1034     $output = "";
1035
1036     $output .= "<style> <!--";       /// Styles for autolinks
1037     $output .= "a.autolink:link {text-decoration: none; color: black; background-color: $THEME->autolink}\n";
1038     $output .= "a.autolink:visited {text-decoration: none; color: black; background-color: $THEME->autolink}\n";
1039     $output .= "a.autolink:hover {text-decoration: underline; color: red}\n";
1040     $output .= "--> </style>\n\n";
1041
1042     if ($post->parent) {
1043         $output .= '<table border="0" cellpadding="1" cellspacing="1"><tr><td bgcolor="#888888">';
1044         $output .= '<table border="0" cellpadding="3" cellspacing="0">';
1045     } else {
1046         $output .= '<table border="0" cellpadding="1" cellspacing="1" width="100%"><tr><td bgcolor="#888888">';
1047         $output .= '<table border="0" cellpadding="3" cellspacing="0" width="100%">';
1048     }
1049
1050     $output .= "<tr><td bgcolor=\"$THEME->cellcontent2\" width=\"35\" valign=\"top\">";
1051     $output .= print_user_picture($user->id, $course->id, $user->picture, false, true);
1052     $output .= "</td>";
1053
1054     if ($post->parent) {
1055         $output .= "<td nowrap bgcolor=\"$THEME->cellheading\">";
1056     } else {
1057         $output .= "<td nowrap bgcolor=\"$THEME->cellheading2\">";
1058     }
1059     $output .= "<p>";
1060     $output .= "<font size=3><b>$post->subject</b></font><br />";
1061     $output .= "<font size=2>";
1062
1063     $fullname = fullname($user, isteacher($course->id));
1064     $by->name = "<a href=\"$CFG->wwwroot/user/view.php?id=$user->id&course=$course->id\">$fullname</a>";
1065     $by->date = userdate($post->modified, "", $touser->timezone);
1066     $output .= get_string("bynameondate", "forum", $by);
1067
1068     $output .= "</font></p></td></tr>";
1069     $output .= "<tr><td bgcolor=\"$THEME->cellcontent2\" width=10>";
1070     $output .= "&nbsp;";
1071     $output .= "</td><td bgcolor=\"$THEME->cellcontent\">\n";
1072
1073     if ($post->attachment) {
1074         $post->course = $course->id;
1075         $post->forum = get_field("forum_discussions", "forum", "id", $post->discussion);
1076         $output .= "<div align=right>";
1077         $output .= forum_print_attachments($post, "html");
1078         $output .= "</div>";
1079     }
1080
1081     $output .= $formattedtext;
1082
1083     $output .= "<p align=right><font size=-1>";
1084
1085     if ($post->parent) {
1086         $output .= "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion&parent=$post->parent\">".get_string("parent", "forum")."</a> | ";
1087     }
1088
1089     $age = time() - $post->created;
1090     if ($ownpost) {
1091         $output .= "<a href=\"$CFG->wwwroot/mod/forum/post.php?delete=$post->id\">".get_string("delete", "forum")."</a>";
1092         if ($reply) {
1093             $output .= " | <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/post.php?reply=$post->id\">".get_string("replyforum", "forum")."</a>";
1094         }
1095         $output .= "&nbsp;&nbsp;";
1096     } else {
1097         if ($reply) {
1098             $output .= "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/post.php?reply=$post->id\">".get_string("replyforum", "forum")."</a>&nbsp;&nbsp;";
1099         }
1100     }
1101
1102     $output .= "</p>";
1103     $output .= "<div align=right><p align=right>";
1104
1105     if ($link) {
1106         if ($post->replies == 1) {
1107             $replystring = get_string("repliesone", "forum", $post->replies);
1108         } else {
1109             $replystring = get_string("repliesmany", "forum", $post->replies);
1110         }
1111         $output .= "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion\"><B>".get_string("discussthistopic", "forum")."</b></a> ($replystring)&nbsp;&nbsp;";
1112     }
1113     $output .= "</p></div>";
1114     if ($footer) {
1115         $output .= "<p>$footer</p>";
1116     }
1117     $output .= "</td></tr></table>\n";
1118     $output .= "</td></tr></table>\n\n";
1119
1120     return $output;
1121 }
1122
1123
1124 function forum_print_post(&$post, $courseid, $ownpost=false, $reply=false, $link=false,
1125                           $ratings=NULL, $footer="", $highlight="") {
1126
1127     global $THEME, $USER, $CFG;
1128
1129     static $stredit, $strdelete, $strreply, $strparent, $threadedmode, $isteacher, $adminedit;
1130
1131     if (empty($stredit)) {
1132         $stredit = get_string("edit", "forum");
1133         $strdelete = get_string("delete", "forum");
1134         $strreply = get_string("reply", "forum");
1135         $strparent = get_string("parent", "forum");
1136         $threadedmode = (!empty($USER->mode) and ($USER->mode == FORUM_MODE_THREADED));
1137         $isteacher = isteacher($courseid);
1138         $adminedit = (isadmin() and !empty($CFG->admineditalways));
1139     }
1140
1141     echo "<a name=\"$post->id\"></a>";
1142     if ($post->parent) {
1143         echo '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
1144     } else {
1145         echo '<table border="0" cellpadding="3" cellspacing="0" class="forumpost" width="100%">';
1146     }
1147
1148     echo "<tr><td bgcolor=\"$THEME->cellcontent2\" class=\"forumpostpicture\" width=\"35\" valign=\"top\">";
1149     print_user_picture($post->userid, $courseid, $post->picture);
1150     echo "</td>";
1151
1152     if ($post->parent) {
1153         echo "<td bgcolor=\"$THEME->cellheading\" class=\"forumpostheader\" width=\"100%\">";
1154     } else {
1155         echo "<td bgcolor=\"$THEME->cellheading2\" class=\"forumpostheadertopic\" width=\"100%\">";
1156     }
1157
1158     if (!empty($CFG->filterall)) {      /// Put the subject through the filters
1159         $post->subject = filter_text($post->subject, $courseid);
1160     }
1161     echo "<p>";
1162     echo "<font size=3><b>$post->subject</b></font><br />";
1163     echo "<font size=2>";
1164
1165     $fullname = fullname($post, $isteacher);
1166     $by->name = "<a href=\"$CFG->wwwroot/user/view.php?id=$post->userid&course=$courseid\">$fullname</a>";
1167     $by->date = userdate($post->modified);
1168     print_string("bynameondate", "forum", $by);
1169
1170     echo "</font></p></td></tr>";
1171     echo "<tr><td bgcolor=\"$THEME->cellcontent2\" valign=\"top\" class=\"forumpostside\" width=\"10\">";
1172     if ($group = user_group($courseid, $post->userid)) {
1173         print_group_picture($group, $courseid, false, false, false);
1174     } else {
1175         echo "&nbsp;";
1176     }
1177     echo "</td><td bgcolor=\"$THEME->cellcontent\" class=\"forumpostmessage\">\n";
1178
1179     if ($post->attachment) {
1180         $post->course = $courseid;
1181         $post->forum = get_field("forum_discussions", "forum", "id", $post->discussion);
1182         echo "<div align=\"right\">";
1183         $attachedimages = forum_print_attachments($post);
1184         echo "</div>";
1185     } else {
1186         $attachedimages = "";
1187     }
1188
1189     if ($link and (strlen(strip_tags($post->message)) > $CFG->forum_longpost)) {
1190         // Print shortened version
1191         echo format_text(forum_shorten_post($post->message), $post->format, NULL, $courseid);
1192         $numwords = count_words(strip_tags($post->message));
1193         echo "<p><a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion\">";
1194         echo get_string("readtherest", "forum");
1195         echo "</a> (".get_string("numwords", "", $numwords).")...</p>";
1196     } else {
1197         // Print whole message
1198         if ($highlight) {
1199             echo highlight($highlight, format_text($post->message, $post->format, NULL, $courseid));
1200         } else {
1201             echo format_text($post->message, $post->format, NULL, $courseid);
1202         }
1203         echo $attachedimages;
1204     }
1205
1206     echo "<p align=right><font size=-1>";
1207
1208     if ($post->parent) {
1209         if ($threadedmode) {
1210             echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion&parent=$post->parent\">$strparent</a> | ";
1211         } else {
1212             echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion#$post->parent\">$strparent</a> | ";
1213         }
1214     }
1215
1216     $age = time() - $post->created;
1217     if ($ownpost or $adminedit) {
1218         if (($age < $CFG->maxeditingtime) or $adminedit) {
1219             echo "<a href=\"$CFG->wwwroot/mod/forum/post.php?edit=$post->id\">$stredit</a> | ";
1220         }
1221     }
1222     if ($ownpost or $isteacher) {
1223         echo "<a href=\"$CFG->wwwroot/mod/forum/post.php?delete=$post->id\">$strdelete</a>";
1224         if ($reply) {
1225             echo "| ";
1226         } else {
1227             echo "&nbsp;&nbsp;";
1228         }
1229     }
1230     if ($reply) {
1231         echo "<a href=\"$CFG->wwwroot/mod/forum/post.php?reply=$post->id\">$strreply</a>";
1232         echo "&nbsp;&nbsp;";
1233     }
1234     echo "</p>";
1235
1236     echo "<div align=right><p align=right>";
1237
1238     $ratingsmenuused = false;
1239     if (!empty($ratings) and !empty($USER->id)) {
1240         $useratings = true;
1241         if ($ratings->assesstimestart and $ratings->assesstimefinish) {
1242             if ($post->created < $ratings->assesstimestart or $post->created > $ratings->assesstimefinish) {
1243                 $useratings = false;
1244             }
1245         }
1246         if ($useratings) {
1247             $mypost = ($USER->id == $post->userid);
1248
1249             if (($isteacher or $ratings->assesspublic) and !$mypost) {
1250                 forum_print_ratings_mean($post->id, $ratings->scale, $isteacher);
1251                 forum_print_rating_menu($post->id, $USER->id, $ratings->scale);
1252                 $ratingsmenuused = true;
1253
1254             } else if ($mypost) {
1255                 forum_print_ratings_mean($post->id, $ratings->scale, true);
1256
1257             } else if (!empty($ratings->allow) ) {
1258                 forum_print_rating_menu($post->id, $USER->id, $ratings->scale);
1259                 $ratingsmenuused = true;
1260             }
1261         }
1262     }
1263
1264     if ($link) {
1265         if ($post->replies == 1) {
1266             $replystring = get_string("repliesone", "forum", $post->replies);
1267         } else {
1268             $replystring = get_string("repliesmany", "forum", $post->replies);
1269         }
1270         echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion\"><b>".
1271              get_string("discussthistopic", "forum")."</b></a> ($replystring)&nbsp;&nbsp;";
1272     }
1273     echo "</p>";
1274     if ($footer) {
1275         echo "<p>$footer</p>";
1276     }
1277     echo "</div>";
1278     echo "</td></tr>\n</table>\n\n";
1279
1280     return $ratingsmenuused;
1281 }
1282
1283
1284 function forum_print_discussion_header(&$post, $courseid, $datestring="") {
1285     global $THEME, $USER, $CFG;
1286
1287     if (!empty($CFG->filterall)) {
1288         $post->subject = filter_text($post->subject, $courseid);
1289     }
1290
1291     echo "<tr class=\"forumpostheader\">";
1292
1293     // Topic
1294     echo "<td bgcolor=\"$THEME->cellheading2\" class=\"forumpostheadertopic\" width=\"100%\">";
1295     echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion\">$post->subject</a>";
1296     echo "</td>\n";
1297
1298     // Picture
1299     echo "<td bgcolor=\"$THEME->cellcontent2\" class=\"forumpostheaderpicture\" width=35>";
1300     print_user_picture($post->userid, $courseid, $post->picture);
1301     echo "</td>\n";
1302
1303     // User name
1304     $fullname = fullname($post, isteacher($courseid));
1305     echo "<td bgcolor=\"$THEME->cellcontent2\" class=\"forumpostheadername\" align=left nowrap>";
1306     echo "<a href=\"$CFG->wwwroot/user/view.php?id=$post->userid&course=$courseid\">$fullname</a>";
1307     echo "</td>\n";
1308
1309     // Replies
1310     echo "<td bgcolor=\"$THEME->cellcontent2\" class=\"forumpostheaderreplies\" align=center nowrap>";
1311     echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$post->discussion\">$post->replies</a>";
1312     echo "</td>\n";
1313
1314     echo "<td bgcolor=\"$THEME->cellcontent2\" class=\"forumpostheaderdate\" align=right nowrap>";
1315     if (!empty($post->timemodified)) {
1316         echo userdate($post->timemodified, $datestring);
1317     } else {
1318         echo userdate($post->modified, $datestring);
1319     }
1320     echo "</td>\n";
1321
1322     echo "</tr>\n";
1323
1324 }
1325
1326
1327 function forum_shorten_post($message) {
1328 // Given a post object that we already know has a long message
1329 // this function truncates the message nicely to the first
1330 // sane place between $CFG->forum_longpost and $CFG->forum_shortpost
1331
1332    global $CFG;
1333
1334    $i = 0;
1335    $tag = false;
1336    $length = strlen($message);
1337    $count = 0;
1338    $stopzone = false;
1339    $truncate = 0;
1340
1341    for ($i=0; $i<$length; $i++) {
1342        $char = $message[$i];
1343
1344        switch ($char) {
1345            case "<":
1346                $tag = true;
1347                break;
1348            case ">":
1349                $tag = false;
1350                break;
1351            default:
1352                if (!$tag) {
1353                    if ($stopzone) {
1354                        if ($char == ".") {
1355                            $truncate = $i+1;
1356                            break 2;
1357                        }
1358                    }
1359                    $count++;
1360                }
1361                break;
1362        }
1363        if (!$stopzone) {
1364            if ($count > $CFG->forum_shortpost) {
1365                $stopzone = true;
1366            }
1367        }
1368    }
1369
1370    if (!$truncate) {
1371        $truncate = $i;
1372    }
1373
1374    return substr($message, 0, $truncate);
1375 }
1376
1377
1378 function forum_print_ratings_mean($postid, $scale, $link=true) {
1379 /// Print the multiple ratings on a post given to the current user by others.
1380 /// Scale is an array of ratings
1381
1382     static $strrate;
1383
1384     $mean = forum_get_ratings_mean($postid, $scale);
1385
1386     if ($mean !== "") {
1387
1388         if (empty($strratings)) {
1389             $strratings = get_string("ratings", "forum");
1390         }
1391
1392         echo "$strratings: ";
1393         if ($link) {
1394             link_to_popup_window ("/mod/forum/report.php?id=$postid", "ratings", $mean, 400, 600);
1395         } else {
1396             echo "$mean ";
1397         }
1398     }
1399 }
1400
1401
1402 function forum_get_ratings_mean($postid, $scale, $ratings=NULL) {
1403 /// Return the mean rating of a post given to the current user by others.
1404 /// Scale is an array of possible ratings in the scale
1405 /// Ratings is an optional simple array of actual ratings (just integers)
1406
1407     if (!$ratings) {
1408         $ratings = array();
1409         if ($rates = get_records("forum_ratings", "post", $postid)) {
1410             foreach ($rates as $rate) {
1411                 $ratings[] = $rate->rating;
1412             }
1413         }
1414     }
1415
1416     $count = count($ratings);
1417
1418     if ($count == 0) {
1419         return "";
1420
1421     } else if ($count == 1) {
1422         return $scale[$ratings[0]];
1423
1424     } else {
1425         $total = 0;
1426         foreach ($ratings as $rating) {
1427             $total += $rating;
1428         }
1429         $mean = round( ((float)$total/(float)$count) + 0.001);  // Little fudge factor so that 0.5 goes UP
1430
1431         if (isset($scale[$mean])) {
1432             return $scale[$mean]." ($count)";
1433         } else {
1434             return "$mean ($count)";    // Should never happen, hopefully
1435         }
1436     }
1437 }
1438
1439 function forum_get_ratings_summary($postid, $scale, $ratings=NULL) {
1440 /// Return a summary of post ratings given to the current user by others.
1441 /// Scale is an array of possible ratings in the scale
1442 /// Ratings is an optional simple array of actual ratings (just integers)
1443
1444     if (!$ratings) {
1445         $ratings = array();
1446         if ($rates = get_records("forum_ratings", "post", $postid)) {
1447             foreach ($rates as $rate) {
1448                 $rating[] = $rate->rating;
1449             }
1450         }
1451     }
1452
1453
1454     if (!$count = count($ratings)) {
1455         return "";
1456     }
1457
1458
1459     foreach ($scale as $key => $scaleitem) {
1460         $sumrating[$key] = 0;
1461     }
1462
1463     foreach ($ratings as $rating) {
1464         $sumrating[$rating]++;
1465     }
1466
1467     $summary = "";
1468     foreach ($scale as $key => $scaleitem) {
1469         $summary = $sumrating[$key].$summary;
1470         if ($key > 1) {
1471             $summary = "/$summary";
1472         }
1473     }
1474     return $summary;
1475 }
1476
1477 function forum_print_rating_menu($postid, $userid, $scale) {
1478 /// Print the menu of ratings as part of a larger form.
1479 /// If the post has already been - set that value.
1480 /// Scale is an array of ratings
1481
1482     static $strrate;
1483
1484     if (!$rating = get_record("forum_ratings", "userid", $userid, "post", $postid)) {
1485         $rating->rating = 0;
1486     }
1487
1488     if (empty($strrate)) {
1489         $strrate = get_string("rate", "forum");
1490     }
1491
1492     choose_from_menu($scale, $postid, $rating->rating, "$strrate...");
1493 }
1494
1495 function forum_print_mode_form($discussion, $mode) {
1496     GLOBAL $FORUM_LAYOUT_MODES;
1497
1498     echo "<center><p>";
1499     popup_form("discuss.php?d=$discussion&mode=", $FORUM_LAYOUT_MODES, "mode", $mode, "");
1500     echo "</p></center>\n";
1501 }
1502
1503 function forum_print_search_form($course, $search="", $return=false, $type="") {
1504     global $CFG;
1505
1506     if ($type == "plain") {
1507         $output = "<table border=0 cellpadding=0 cellspacing=0><tr><td nowrap>";
1508         $output .= "<form name=search action=\"$CFG->wwwroot/mod/forum/search.php\">";
1509         $output .= "<font size=\"-1\">";
1510         $output .= "<input name=search type=text size=20 value=\"$search\">";
1511         $output .= "<input value=\"".get_string("searchforums", "forum")."\" type=submit>";
1512         $output .= "</font>";
1513         $output .= "<input name=id type=hidden value=\"$course->id\">";
1514         $output .= "</form>";
1515         $output .= "</td></tr></table>";
1516     } else {
1517         $output = "<table border=0 cellpadding=10 cellspacing=0><tr><td align=center>";
1518         $output .= "<form name=search action=\"$CFG->wwwroot/mod/forum/search.php\">";
1519         $output .= "<font size=\"-1\">";
1520         $output .= "<input name=search type=text size=20 value=\"$search\"><br>";
1521         $output .= "<input value=\"".get_string("searchforums", "forum")."\" type=submit>";
1522         $output .= "</font>";
1523         $output .= "<input name=id type=hidden value=\"$course->id\">";
1524         $output .= "</form>";
1525         $output .= "</td></tr></table>";
1526     }
1527
1528     if ($return) {
1529         return $output;
1530     }
1531     echo $output;
1532 }
1533
1534
1535 function forum_set_return() {
1536     global $CFG, $SESSION;
1537
1538     if (! isset($SESSION->fromdiscussion)) {
1539         if (!empty($_SERVER['HTTP_REFERER'])) {
1540             $referer = $_SERVER['HTTP_REFERER'];
1541         } else {
1542             $referer = "";
1543         }
1544         // If the referer is NOT a login screen then save it.
1545         if (! strncasecmp("$CFG->wwwroot/login", $referer, 300)) {
1546             $SESSION->fromdiscussion = $_SERVER["HTTP_REFERER"];
1547         }
1548     }
1549 }
1550
1551
1552 function forum_go_back_to($default) {
1553     global $SESSION;
1554
1555     if (!empty($SESSION->fromdiscussion)) {
1556         $returnto = $SESSION->fromdiscussion;
1557         unset($SESSION->fromdiscussion);
1558         return $returnto;
1559     } else {
1560         return $default;
1561     }
1562 }
1563
1564 function forum_file_area_name($post) {
1565 //  Creates a directory file name, suitable for make_upload_directory()
1566     global $CFG;
1567
1568     return "$post->course/$CFG->moddata/forum/$post->forum/$post->id";
1569 }
1570
1571 function forum_file_area($post) {
1572     return make_upload_directory( forum_file_area_name($post) );
1573 }
1574
1575 function forum_delete_old_attachments($post, $exception="") {
1576 // Deletes all the user files in the attachments area for a post
1577 // EXCEPT for any file named $exception
1578
1579     if ($basedir = forum_file_area($post)) {
1580         if ($files = get_directory_list($basedir)) {
1581             foreach ($files as $file) {
1582                 if ($file != $exception) {
1583                     unlink("$basedir/$file");
1584                     notify("Existing file '$file' has been deleted!");
1585                 }
1586             }
1587         }
1588         if (!$exception) {  // Delete directory as well, if empty
1589             rmdir("$basedir");
1590         }
1591     }
1592 }
1593
1594 function forum_move_attachments($discussion, $forumid) {
1595 /// Given a discussion object that is being moved to forumid,
1596 /// this function checks all posts in that discussion
1597 /// for attachments, and if any are found, these are
1598 /// moved to the new forum directory.
1599
1600     global $CFG;
1601
1602     $return = true;
1603
1604     if ($posts = get_records_select("forum_posts", "discussion = '$discussion->id' AND attachment <> ''")) {
1605         foreach ($posts as $oldpost) {
1606             $oldpost->course = $discussion->course;
1607             $oldpost->forum = $discussion->forum;
1608             $oldpostdir = "$CFG->dataroot/".forum_file_area_name($oldpost);
1609             if (is_dir($oldpostdir)) {
1610                 $newpost = $oldpost;
1611                 $newpost->forum = $forumid;
1612                 $newpostdir = forum_file_area($newpost);
1613                 if (! @rename($oldpostdir, $newpostdir)) {
1614                     $return = false;
1615                 }
1616             }
1617         }
1618     }
1619     return $return;
1620 }
1621
1622 function forum_print_attachments($post, $return=NULL) {
1623 // if return=html, then return a html string.
1624 // if return=text, then return a text-only string.
1625 // otherwise, print HTML for non-images, and return image HTML
1626
1627     global $CFG;
1628
1629     $filearea = forum_file_area_name($post);
1630
1631     $imagereturn = "";
1632     $output = "";
1633
1634     if ($basedir = forum_file_area($post)) {
1635         if ($files = get_directory_list($basedir)) {
1636             $strattachment = get_string("attachment", "forum");
1637             $strpopupwindow = get_string("popupwindow");
1638             foreach ($files as $file) {
1639                 $icon = mimeinfo("icon", $file);
1640                 if ($CFG->slasharguments) {
1641                     $ffurl = "file.php/$filearea/$file";
1642                 } else {
1643                     $ffurl = "file.php?file=/$filearea/$file";
1644                 }
1645                 $image = "<img border=\"0\" src=\"$CFG->pixpath/f/$icon\" height=\"16\" width=\"16\" alt=\"$strpopupwindow\">";
1646
1647                 if ($return == "html") {
1648                     $output .= "<a href=\"$CFG->wwwroot/$ffurl\">$image</a> ";
1649                     $output .= "<a href=\"$CFG->wwwroot/$ffurl\">$file</a><br />";
1650
1651                 } else if ($return == "text") {
1652                     $output .= "$strattachment $file:\n$CFG->wwwroot/$ffurl\n";
1653
1654                 } else {
1655                     if ($icon == "image.gif") {    // Image attachments don't get printed as links
1656                         $imagereturn .= "<br /><img src=\"$CFG->wwwroot/$ffurl\">";
1657                     } else {
1658                         link_to_popup_window("/$ffurl", "attachment", $image, 500, 500, $strattachment);
1659                         echo "<a href=\"$CFG->wwwroot/$ffurl\">$file</a>";
1660                         echo "<br />";
1661                     }
1662                 }
1663             }
1664         }
1665     }
1666
1667     if ($return) {
1668         return $output;
1669     }
1670
1671     return $imagereturn;
1672 }
1673
1674 function forum_add_attachment($post, $newfile) {
1675 // $post is a full post record, including course and forum
1676 // $newfile is a full upload array from $_FILES
1677 // If successful, this function returns the name of the file
1678
1679     global $CFG;
1680
1681     if (empty($newfile['name'])) {
1682         return "";
1683     }
1684
1685     if (!$forum = get_record("forum", "id", $post->forum)) {
1686         return "";
1687     }
1688
1689     if (!$course = get_record("course", "id", $forum->course)) {
1690         return "";
1691     }
1692
1693     $maxbytes = get_max_upload_file_size($CFG->maxbytes, $course->maxbytes, $forum->maxbytes);
1694
1695     $newfile_name = clean_filename($newfile['name']);
1696
1697     if (valid_uploaded_file($newfile)) {
1698         if ($maxbytes and $newfile['size'] > $maxbytes) {
1699             return "";
1700         }
1701         if (! $newfile_name) {
1702             notify("This file had a wierd filename and couldn't be uploaded");
1703
1704         } else if (! $dir = forum_file_area($post)) {
1705             notify("Attachment could not be stored");
1706             $newfile_name = "";
1707
1708         } else {
1709             if (move_uploaded_file($newfile['tmp_name'], "$dir/$newfile_name")) {
1710                 chmod("$dir/$newfile_name", $CFG->directorypermissions);
1711                 forum_delete_old_attachments($post, $newfile_name);
1712             } else {
1713                 notify("An error happened while saving the file on the server");
1714                 $newfile_name = "";
1715             }
1716         }
1717     } else {
1718         $newfile_name = "";
1719     }
1720
1721     return $newfile_name;
1722 }
1723
1724 function forum_add_new_post($post) {
1725
1726     $post->created = $post->modified = time();
1727     $post->mailed = "0";
1728
1729     $newfile = $post->attachment;
1730     $post->attachment = "";
1731
1732     if (! $post->id = insert_record("forum_posts", $post)) {
1733         return false;
1734     }
1735
1736     if ($post->attachment = forum_add_attachment($post, $newfile)) {
1737         set_field("forum_posts", "attachment", $post->attachment, "id", $post->id);
1738     }
1739
1740     // Update discussion modified date
1741     set_field("forum_discussions", "timemodified", $post->modified, "id", $post->discussion);
1742     set_field("forum_discussions", "usermodified", $post->userid, "id", $post->discussion);
1743
1744     return $post->id;
1745 }
1746
1747 function forum_update_post($post) {
1748
1749     $post->modified = time();
1750
1751     if (!$post->parent) {   // Post is a discussion starter - update discussion title too
1752         set_field("forum_discussions", "name", $post->subject, "id", $post->discussion);
1753     }
1754
1755     if ($newfilename = forum_add_attachment($post, $post->attachment)) {
1756         $post->attachment = $newfilename;
1757     } else {
1758         unset($post->attachment);
1759     }
1760
1761     // Update discussion modified date
1762     set_field("forum_discussions", "timemodified", $post->modified, "id", $post->discussion);
1763     set_field("forum_discussions", "usermodified", $post->userid, "id", $post->discussion);
1764
1765     return update_record("forum_posts", $post);
1766 }
1767
1768 function forum_add_discussion($discussion) {
1769 // Given an object containing all the necessary data,
1770 // create a new discussion and return the id
1771
1772     GLOBAL $USER;
1773
1774     $timenow = time();
1775
1776     // The first post is stored as a real post, and linked
1777     // to from the discuss entry.
1778
1779     $post->discussion  = 0;
1780     $post->parent      = 0;
1781     $post->userid      = $USER->id;
1782     $post->created     = $timenow;
1783     $post->modified    = $timenow;
1784     $post->mailed      = 0;
1785     $post->subject     = $discussion->name;
1786     $post->message     = $discussion->intro;
1787     $post->attachment  = "";
1788     $post->forum       = $discussion->forum;
1789     $post->course      = $discussion->course;
1790     $post->format      = $discussion->format;
1791
1792     if (! $post->id = insert_record("forum_posts", $post) ) {
1793         return 0;
1794     }
1795
1796     if ($post->attachment = forum_add_attachment($post, $discussion->attachment)) {
1797         set_field("forum_posts", "attachment", $post->attachment, "id", $post->id); //ignore errors
1798     }
1799
1800     // Now do the main entry for the discussion,
1801     // linking to this first post
1802
1803     $discussion->firstpost    = $post->id;
1804     $discussion->timemodified = $timenow;
1805     $discussion->usermodified = $post->userid;
1806
1807     if (! $discussion->id = insert_record("forum_discussions", $discussion) ) {
1808         delete_records("forum_posts", "id", $post->id);
1809         return 0;
1810     }
1811
1812     // Finally, set the pointer on the post.
1813     if (! set_field("forum_posts", "discussion", $discussion->id, "id", $post->id)) {
1814         delete_records("forum_posts", "id", $post->id);
1815         delete_records("forum_discussions", "id", $discussion->id);
1816         return 0;
1817     }
1818
1819     return $discussion->id;
1820 }
1821
1822
1823 function forum_delete_discussion($discussion) {
1824 // $discussion is a discussion record object
1825
1826     $result = true;
1827
1828     if ($posts = get_records("forum_posts", "discussion", $discussion->id)) {
1829         foreach ($posts as $post) {
1830             $post->course = $discussion->course;
1831             $post->forum  = $discussion->forum;
1832             if (! delete_records("forum_ratings", "post", "$post->id")) {
1833                 $result = false;
1834             }
1835             if (! forum_delete_post($post)) {
1836                 $result = false;
1837             }
1838         }
1839     }
1840
1841     if (! delete_records("forum_discussions", "id", "$discussion->id")) {
1842         $result = false;
1843     }
1844
1845     return $result;
1846 }
1847
1848
1849 function forum_delete_post($post) {
1850    if (delete_records("forum_posts", "id", $post->id)) {
1851        delete_records("forum_ratings", "post", $post->id);  // Just in case
1852        if ($post->attachment) {
1853            $discussion = get_record("forum_discussions", "id", $post->discussion);
1854            $post->course = $discussion->course;
1855            $post->forum  = $discussion->forum;
1856            forum_delete_old_attachments($post);
1857        }
1858        return true;
1859    }
1860    return false;
1861 }
1862
1863
1864 function forum_print_user_discussions($courseid, $userid) {
1865     global $CFG, $USER;
1866
1867     $maxdiscussions = 10;
1868     $countdiscussions = 0;
1869
1870
1871     if ($discussions = forum_get_user_discussions($courseid, $userid)) {
1872         $user = get_record("user", "id", $userid);
1873         echo "<HR>";
1874         $fullname = fullname($user, isteacher($courseid));
1875         print_heading( get_string("discussionsstartedbyrecent", "forum", $fullname) );
1876         $replies = forum_count_discussion_replies();
1877         foreach ($discussions as $discussion) {
1878             $countdiscussions++;
1879             if ($countdiscussions > $maxdiscussions) {
1880                 break;
1881             }
1882             if (($discussion->forumtype == "teacher") and !isteacher($courseid)) {
1883                 continue;
1884             }
1885             if (!empty($replies[$discussion->discussion])) {
1886                 $discussion->replies = $replies[$discussion->discussion]->replies;
1887             } else {
1888                 $discussion->replies = 0;
1889             }
1890             $inforum = get_string("inforum", "forum", "<A HREF=\"$CFG->wwwroot/mod/forum/view.php?f=$discussion->forumid\">$discussion->forumname</A>");
1891             $discussion->subject .= " ($inforum)";
1892             if (!empty($USER->id)) {
1893                 $ownpost = ($discussion->userid == $USER->id);
1894             } else {
1895                 $ownpost = false;
1896             }
1897             forum_print_post($discussion, $courseid, $ownpost, $reply=0, $link=1, $assessed=false);
1898             echo "<BR>\n";
1899         }
1900     }
1901 }
1902
1903 function forum_forcesubscribe($forumid, $value=1) {
1904     return set_field("forum", "forcesubscribe", $value, "id", $forumid);
1905 }
1906
1907 function forum_is_forcesubscribed($forumid) {
1908     return get_field("forum", "forcesubscribe", "id", $forumid);
1909 }
1910
1911 function forum_is_subscribed($userid, $forumid) {
1912     if (forum_is_forcesubscribed($forumid)) {
1913         return true;
1914     }
1915     return record_exists("forum_subscriptions", "userid", $userid, "forum", $forumid);
1916 }
1917
1918 function forum_subscribe($userid, $forumid) {
1919 /// Adds user to the subscriber list
1920
1921     $sub->userid  = $userid;
1922     $sub->forum = $forumid;
1923
1924     return insert_record("forum_subscriptions", $sub);
1925 }
1926
1927 function forum_unsubscribe($userid, $forumid) {
1928 /// Removes user from the subscriber list
1929     return delete_records("forum_subscriptions", "userid", $userid, "forum", $forumid);
1930 }
1931
1932 function forum_post_subscription($post) {
1933 /// Given a new post, subscribes or unsubscribes as appropriate.
1934 /// Returns some text which describes what happened.
1935
1936     global $USER;
1937
1938     if (empty($post->subscribe) and empty($post->unsubscribe)) {
1939         return "";
1940     }
1941
1942     if (!$forum = get_record("forum", "id", $post->forum)) {
1943         return "";
1944     }
1945
1946     $info->name  = "$USER->firstname $USER->lastname";
1947     $info->forum = $forum->name;
1948
1949     if (!empty($post->subscribe)) {
1950         forum_subscribe($USER->id, $post->forum);
1951         return "<p>".get_string("nowsubscribed", "forum", $info)."</p>";
1952     }
1953
1954     forum_unsubscribe($USER->id, $post->forum);
1955     return "<p>".get_string("nownotsubscribed", "forum", $info)."</p>";
1956 }
1957
1958
1959 function forum_user_has_posted_discussion($forumid, $userid) {
1960     if ($discussions = forum_get_discussions($forumid, "", $userid)) {
1961         return true;
1962     } else {
1963         return false;
1964     }
1965 }
1966
1967 function forum_user_can_post_discussion($forum, $currentgroup=false) {
1968 // $forum is an object
1969     global $USER;
1970
1971     if ($forum->type == "eachuser") {
1972         return (! forum_user_has_posted_discussion($forum->id, $USER->id));
1973     } else if ($forum->type == "teacher") {
1974         return isteacher($forum->course);
1975     } else if ($currentgroup) {
1976         return (isteacheredit($forum->course) or ismember($currentgroup));
1977     } else if (isteacher($forum->course)) {
1978         return true;
1979     } else {
1980         return ($forum->open == 2);
1981     }
1982 }
1983
1984 function forum_user_can_post($forum, $user=NULL) {
1985 // $forum, $user are objects
1986
1987     if ($user) {
1988         $isteacher = isteacher($forum->course, $user->id);
1989     } else {
1990         $isteacher = isteacher($forum->course);
1991     }
1992
1993     if ($forum->type == "teacher") {
1994         return $isteacher;
1995     } else if ($isteacher) {
1996         return true;
1997     } else {
1998         return $forum->open;
1999     }
2000 }
2001
2002
2003 function forum_print_latest_discussions($forum_id=0, $forum_numdiscussions=5,
2004                                         $forum_style="plain", $forum_sort="",
2005                                         $currentgroup=0) {
2006     global $CFG, $USER;
2007
2008     if ($forum_id) {
2009         if (! $forum = get_record("forum", "id", $forum_id)) {
2010             error("Forum ID was incorrect");
2011         }
2012         if (! $course = get_record("course", "id", $forum->course)) {
2013             error("Could not find the course this forum belongs to!");
2014         }
2015
2016         if ($course->category) {
2017             require_login($course->id);
2018         }
2019
2020     } else {
2021         if (! $course = get_record("course", "category", 0)) {
2022             error("Could not find a top-level course!");
2023         }
2024         if (! $forum = forum_get_course_forum($course->id, "news")) {
2025             error("Could not find or create a main forum in this course (id $course->id)");
2026         }
2027     }
2028
2029     if (forum_user_can_post_discussion($forum, $currentgroup)) {
2030         echo "<p align=center>";
2031         echo "<a href=\"$CFG->wwwroot/mod/forum/post.php?forum=$forum->id\">";
2032         if ($forum->type == "news") {
2033             echo get_string("addanewtopic", "forum")."</a>...";
2034         } else {
2035             echo get_string("addanewdiscussion", "forum")."</a>...";
2036         }
2037         echo "</p>\n";
2038     }
2039
2040     if ((!$forum_numdiscussions) && ($forum_style == "plain")) {
2041         $forum_style = "header";  // Abbreviate display by default
2042     }
2043
2044     if ($forum_style == "minimal") {
2045         $forum_sort = "p.modified DESC";
2046     }
2047
2048     $fullpost = false;
2049     if ($forum_style == "plain") {
2050         $fullpost = true;
2051     }
2052
2053     if (! $discussions = forum_get_discussions($forum->id, $forum_sort, 0, $fullpost, $currentgroup) ) {
2054         if ($forum->type == "news") {
2055             echo "<p align=center><b>(".get_string("nonews", "forum").")</b></p>";
2056         } else {
2057             echo "<p align=center><b>(".get_string("nodiscussions", "forum").")</b></p>";
2058         }
2059         return;
2060     }
2061
2062     $replies = forum_count_discussion_replies($forum->id);
2063
2064     $canreply = forum_user_can_post($forum);
2065
2066     $discussioncount = 0;
2067     $olddiscussionlink = false;
2068     $strdatestring = get_string("strftimedaydatetime");
2069
2070     if ($forum_style == "minimal") {
2071         $strftimerecent = get_string("strftimerecent");
2072         $strmore = get_string("more", "forum");
2073     }
2074
2075     if ($forum_style == "header") {
2076         echo "<table width=\"100%\" border=0 cellpadding=3 cellspacing=1 class=\"forumheaderlist\">";
2077         echo "<tr class=\"forumpostheader\">";
2078         echo "<th>".get_string("discussion", "forum")."</th>";
2079         echo "<th colspan=2>".get_string("startedby", "forum")."</th>";
2080         echo "<th>".get_string("replies", "forum")."</th>";
2081         echo "<th>".get_string("lastpost", "forum")."</th>";
2082         echo "</tr>";
2083     }
2084
2085     foreach ($discussions as $discussion) {
2086         $discussioncount++;
2087
2088         if ($forum_numdiscussions && ($discussioncount > $forum_numdiscussions)) {
2089             $olddiscussionlink = true;
2090             break;
2091         }
2092         if (!empty($replies[$discussion->discussion])) {
2093             $discussion->replies = $replies[$discussion->discussion]->replies;
2094         } else {
2095             $discussion->replies = 0;
2096         }
2097         if (!empty($USER->id)) {
2098             $ownpost = ($discussion->userid == $USER->id);
2099         } else {
2100             $ownpost=false;
2101         }
2102         switch ($forum_style) {
2103             case "minimal":
2104                 if (!empty($CFG->filterall)) {
2105                     $discussion->subject = filter_text($discussion->subject, $forum->course);
2106                 }
2107                 echo "<p><span class=\"smallinfohead\">".userdate($discussion->modified, $strftimerecent)." - $discussion->firstname</span><br />";
2108                 echo "<span class=\"smallinfo\">$discussion->subject ";
2109                 echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->discussion\">";
2110                 echo $strmore."...</a></span>";
2111                 echo "</p>\n";
2112             break;
2113             case "header":
2114                 forum_print_discussion_header($discussion, $forum->course, $strdatestring);
2115             break;
2116             default:
2117                 if ($canreply or $discussion->replies) {
2118                     $link = true;
2119                 } else {
2120                     $link = false;
2121                 }
2122                 forum_print_post($discussion, $forum->course, $ownpost, $reply=0, $link, $assessed=false);
2123                 echo "<br>\n";
2124             break;
2125         }
2126     }
2127
2128     if ($forum_style == "header") {
2129         echo "</table>";
2130     }
2131
2132     if ($olddiscussionlink) {
2133         echo "<p align=right><a href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id&showall=1\">";
2134         echo get_string("olderdiscussions", "forum")."</a> ...</p>";
2135     }
2136 }
2137
2138 function forum_print_discussion($course, $forum, $discussion, $post, $mode, $canreply=NULL) {
2139
2140     global $USER;
2141
2142     if (!empty($USER->id)) {
2143         $ownpost = ($USER->id == $post->userid);
2144     } else {
2145         $ownpost = false;
2146     }
2147     if ($canreply === NULL) {
2148         $reply = forum_user_can_post($forum);
2149     } else {
2150         $reply = $canreply;
2151     }
2152
2153     $ratings = NULL;
2154     $ratingsmenuused = false;
2155     if ($forum->assessed and !empty($USER->id)) {
2156         if ($ratings->scale = make_grades_menu($forum->scale)) {
2157             $ratings->assesspublic = $forum->assesspublic;
2158             $ratings->assesstimestart = $forum->assesstimestart;
2159             $ratings->assesstimefinish = $forum->assesstimefinish;
2160             $ratings->allow = ($forum->assessed != 2 or isteacher($course->id));
2161
2162             echo "<form name=form method=post action=rate.php>";
2163             echo "<input type=hidden name=id value=\"$course->id\">";
2164         }
2165     }
2166
2167     if (forum_print_post($post, $course->id, $ownpost, $reply, $link=false, $ratings)) {
2168         $ratingsmenuused = true;
2169     }
2170
2171     switch ($mode) {
2172         case FORUM_MODE_FLATOLDEST :
2173         case FORUM_MODE_FLATNEWEST :
2174         default:
2175             echo "<ul>";
2176             if (forum_print_posts_flat($post->discussion, $course->id, $mode, $ratings, $reply)) {
2177                 $ratingsmenuused = true;
2178             }
2179             echo "</ul>";
2180             break;
2181
2182         case FORUM_MODE_THREADED :
2183             if (forum_print_posts_threaded($post->id, $course->id, 0, $ratings, $reply)) {
2184                 $ratingsmenuused = true;
2185             }
2186             break;
2187
2188         case FORUM_MODE_NESTED :
2189             if (forum_print_posts_nested($post->id, $course->id, $ratings, $reply)) {
2190                 $ratingsmenuused = true;
2191             }
2192             break;
2193     }
2194
2195     if ($ratingsmenuused) {
2196         echo "<center><input type=\"submit\" value=\"".get_string("sendinratings", "forum")."\">";
2197         if ($forum->scale < 0) {
2198             if ($scale = get_record("scale", "id", abs($forum->scale))) {
2199                 print_scale_menu_helpbutton($course->id, $scale );
2200             }
2201         }
2202         echo "</center>";
2203         echo "</form>";
2204     }
2205 }
2206
2207 function forum_print_posts_flat($discussion, $course, $direction, $ratings, $reply) {
2208     global $USER;
2209
2210     $link  = false;
2211     $ratingsmenuused = false;
2212
2213     if ($direction < 0) {
2214         $sort = "ORDER BY created DESC";
2215     } else {
2216         $sort = "ORDER BY created ASC";
2217     }
2218
2219     if ($posts = forum_get_discussion_posts($discussion, $sort)) {
2220         foreach ($posts as $post) {
2221             $ownpost = ($USER->id == $post->userid);
2222             if (forum_print_post($post, $course, $ownpost, $reply, $link, $ratings)) {
2223                 $ratingsmenuused = true;
2224             }
2225         }
2226     }
2227
2228     return $ratingsmenuused;
2229 }
2230
2231 function forum_print_posts_threaded($parent, $course, $depth, $ratings, $reply) {
2232     global $USER;
2233
2234     $link  = false;
2235     $ratingsmenuused = false;
2236
2237     if ($posts = forum_get_child_posts($parent)) {
2238         foreach ($posts as $post) {
2239
2240             echo "<ul>";
2241             if ($depth > 0) {
2242                 $ownpost = ($USER->id == $post->userid);
2243                 if (forum_print_post($post, $course, $ownpost, $reply, $link, $ratings)) {
2244                     $ratingsmenuused = true;
2245                 }
2246                 echo "<br />";
2247             } else {
2248                 $by->name = fullname($post, isteacher($course->id));
2249                 $by->date = userdate($post->modified);
2250                 echo "<li><p><a name=\"$post->id\"></a><font size=-1><b><a href=\"discuss.php?d=$post->discussion&parent=$post->id\">$post->subject</a></b> ";
2251                 print_string("bynameondate", "forum", $by);
2252                 echo "</font></p></li>";
2253             }
2254
2255             if (forum_print_posts_threaded($post->id, $course, $depth-1, $ratings, $reply)) {
2256                 $ratingsmenuused = true;
2257             }
2258             echo "</ul>\n";
2259         }
2260     }
2261     return $ratingsmenuused;
2262 }
2263
2264 function forum_print_posts_nested($parent, $course, $ratings, $reply) {
2265     global $USER;
2266
2267     $link  = false;
2268     $ratingsmenuused = false;
2269
2270     if ($posts = forum_get_child_posts($parent)) {
2271         foreach ($posts as $post) {
2272
2273             if (empty($USER->id)) {
2274                 $ownpost = false;
2275             } else {
2276                 $ownpost = ($USER->id == $post->userid);
2277             }
2278
2279             echo "<ul>";
2280             if (forum_print_post($post, $course, $ownpost, $reply, $link, $ratings)) {
2281                 $ratingsmenuused = true;
2282             }
2283             echo "<br />";
2284             if (forum_print_posts_nested($post->id, $course, $ratings, $reply)) {
2285                 $ratingsmenuused = true;
2286             }
2287             echo "</ul>\n";
2288         }
2289     }
2290     return $ratingsmenuused;
2291 }
2292
2293 function forum_get_recent_mod_activity(&$activities, &$index, $sincetime, $courseid, $forum="0", $user="", $groupid="") {
2294 // Returns all forum posts since a given time.  If forum is specified then
2295 // this restricts the results
2296
2297     global $CFG;
2298
2299     if ($forum) {
2300         $forumselect = " AND cm.id = '$forum'";
2301     } else {
2302         $forumselect = "";
2303     }
2304
2305     if ($user) {
2306         $userselect = " AND u.id = '$user'";
2307     } else {
2308         $userselect = "";
2309     }
2310
2311     $posts = get_records_sql("SELECT p.*, d.name, u.firstname, u.lastname,
2312                                      u.picture, d.groupid, cm.instance, f.name, cm.section
2313                                FROM {$CFG->prefix}forum_posts p,
2314                                     {$CFG->prefix}forum_discussions d,
2315                                     {$CFG->prefix}user u,
2316                                     {$CFG->prefix}course_modules cm,
2317                                     {$CFG->prefix}forum f
2318                               WHERE p.modified > '$sincetime' $forumselect
2319                                 AND p.userid = u.id $userselect
2320                                 AND d.course = '$courseid'
2321                                 AND p.discussion = d.id $groupselect
2322                                 AND cm.instance = f.id
2323                                 AND cm.course = d.course
2324                                 AND cm.course = f.course
2325                                 AND f.id = d.forum
2326                               ORDER BY d.id");
2327
2328     if (empty($posts))
2329       return;
2330
2331     foreach ($posts as $post) {
2332
2333         if (empty($groupid) || ismember($groupid, $post->userid)) {
2334             $tmpactivity->type = "forum";
2335             $tmpactivity->defaultindex = $index;
2336             $tmpactivity->instance = $post->instance;
2337             $tmpactivity->name = $post->name;
2338             $tmpactivity->section = $post->section;
2339
2340             $tmpactivity->content->id = $post->id;
2341             $tmpactivity->content->discussion = $post->discussion;
2342             $tmpactivity->content->subject = $post->subject;
2343             $tmpactivity->content->parent = $post->parent;
2344
2345             $tmpactivity->user->userid = $post->userid;
2346             $tmpactivity->user->fullname = fullname($post);
2347             $tmpactivity->user->picture = $post->picture;
2348
2349             $tmpactivity->timestamp = $post->modified;
2350             $activities[] = $tmpactivity;
2351
2352             $index++;
2353         }
2354     }
2355
2356     return;
2357 }
2358
2359 function forum_print_recent_mod_activity($activity, $course, $detail=false) {
2360
2361     global $CFG;
2362
2363     echo '<table border="0" cellpadding="3" cellspacing="0">';
2364
2365     if ($activity->content->parent) {
2366         $openformat = "<font size=\"2\"><i>";
2367         $closeformat = "</i></font>";
2368     } else {
2369         $openformat = "<b>";
2370         $closeformat = "</b>";
2371     }
2372
2373     echo "<tr><td bgcolor=\"$THEME->cellcontent2\" class=\"forumpostpicture\" width=\"35\" valign=\"top\">";
2374     print_user_picture($activity->user->userid, $course, $activity->user->picture);
2375     echo "</td><td>$openformat";
2376
2377     if ($detail) {
2378         echo "<img src=\"$CFG->modpixpath/$activity->type/icon.gif\" ".
2379              "height=16 width=16 alt=\"$activity->name\">  ";
2380     }
2381     echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d=" . $activity->content->discussion
2382          . "#" . $activity->content->id . "\">";
2383
2384     echo $activity->content->subject;
2385     echo "</a>$closeformat";
2386
2387     echo "<br><font size=\"2\">";
2388     echo "<a href=\"$CFG->wwwroot/user/view.php?id=" . $activity->user->userid . "&course=" . "$course\">"
2389          . $activity->user->fullname . "</a>";
2390     echo " - " . userdate($activity->timestamp) . "</font></td></tr>";
2391     echo "</table>";
2392
2393     return;
2394 }
2395
2396 ?>