mod/forum/lib.php

   1 <?php  // $Id$
   2
   3 require_once($CFG->libdir.'/filelib.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 define('FORUM_FORCESUBSCRIBE', 1);
  13 define('FORUM_INITIALSUBSCRIBE', 2);
  14 define('FORUM_DISALLOWSUBSCRIBE',3);
  15
  16 define('FORUM_TRACKING_OFF', 0);
  17 define('FORUM_TRACKING_OPTIONAL', 1);
  18 define('FORUM_TRACKING_ON', 2);
  19
  20 define('FORUM_UNSET_POST_RATING', -999);
  21
  22 define ('FORUM_AGGREGATE_NONE', 0); //no ratings
  23 define ('FORUM_AGGREGATE_AVG', 1);
  24 define ('FORUM_AGGREGATE_COUNT', 2);
  25 define ('FORUM_AGGREGATE_MAX', 3);
  26 define ('FORUM_AGGREGATE_MIN', 4);
  27 define ('FORUM_AGGREGATE_SUM', 5);
  28
  29 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
  30
  31 /**
  32  * Given an object containing all the necessary data,
  33  * (defined by the form in mod.html) this function
  34  * will create a new instance and return the id number
  35  * of the new instance.
  36  * @param object $forum add forum instance (with magic quotes)
  37  * @return int intance id
  38  */
  39 function forum_add_instance($forum) {
  40     global $CFG;
  41
  42     $forum->timemodified = time();
  43
  44     if (empty($forum->assessed)) {
  45         $forum->assessed = 0;
  46     }
  47
  48     if (empty($forum->ratingtime) or empty($forum->assessed)) {
  49         $forum->assesstimestart  = 0;
  50         $forum->assesstimefinish = 0;
  51     }
  52
  53     if (!$forum->id = insert_record('forum', $forum)) {
  54         return false;
  55     }
  56
  57     if ($forum->type == 'single') {  // Create related discussion.
  58         $discussion = new object();
  59         $discussion->course   = $forum->course;
  60         $discussion->forum    = $forum->id;
  61         $discussion->name     = $forum->name;
  62         $discussion->intro    = $forum->intro;
  63         $discussion->assessed = $forum->assessed;
  64         $discussion->format   = $forum->type;
  65         $discussion->mailnow  = false;
  66         $discussion->groupid  = -1;
  67
  68         if (! forum_add_discussion($discussion, $discussion->intro)) {
  69             error('Could not add the discussion for this forum');
  70         }
  71     }
  72
  73     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
  74     /// all users should be subscribed initially
  75     /// Note: forum_get_potential_subscribers should take the forum context,
  76     /// but that does not exist yet, becuase the forum is only half build at this
  77     /// stage. However, because the forum is brand new, we know that there are
  78     /// no role assignments or overrides in the forum context, so using the
  79     /// course context gives the same list of users.
  80         $users = forum_get_potential_subscribers(get_context_instance(CONTEXT_COURSE, $forum->course), 0, 'u.id, u.email', '');
  81         foreach ($users as $user) {
  82             forum_subscribe($user->id, $forum->id);
  83         }
  84     }
  85
  86     $forum = stripslashes_recursive($forum);
  87     forum_grade_item_update($forum);
  88
  89     return $forum->id;
  90 }
  91
  92
  93 /**
  94  * Given an object containing all the necessary data,
  95  * (defined by the form in mod.html) this function
  96  * will update an existing instance with new data.
  97  * @param object $forum forum instance (with magic quotes)
  98  * @return bool success
  99  */
 100 function forum_update_instance($forum) {
 101     global $USER;
 102
 103     $forum->timemodified = time();
 104     $forum->id           = $forum->instance;
 105
 106     if (empty($forum->assessed)) {
 107         $forum->assessed = 0;
 108     }
 109
 110     if (empty($forum->ratingtime) or empty($forum->assessed)) {
 111         $forum->assesstimestart  = 0;
 112         $forum->assesstimefinish = 0;
 113     }
 114
 115     $oldforum = get_record('forum', 'id', $forum->id);
 116
 117     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
 118     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
 119     // for count and sum aggregation types the grade we check to make sure they do not exceed the scale (i.e. max score) when calculating the grade
 120     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
 121         forum_update_grades($forum); // recalculate grades for the forum
 122     }
 123
 124     if ($forum->type == 'single') {  // Update related discussion and post.
 125         if (! $discussion = get_record('forum_discussions', 'forum', $forum->id)) {
 126             if ($discussions = get_records('forum_discussions', 'forum', $forum->id, 'timemodified ASC')) {
 127                 notify('Warning! There is more than one discussion in this forum - using the most recent');
 128                 $discussion = array_pop($discussions);
 129             } else {
 130                 // try to recover by creating initial discussion - MDL-16262
 131                 $discussion = new object();
 132                 $discussion->course   = $forum->course;
 133                 $discussion->forum    = $forum->id;
 134                 $discussion->name     = $forum->name;
 135                 $discussion->intro    = $forum->intro;
 136                 $discussion->assessed = $forum->assessed;
 137                 $discussion->format   = $forum->type;
 138                 $discussion->mailnow  = false;
 139                 $discussion->groupid  = -1;
 140
 141                 forum_add_discussion($discussion, $discussion->intro);
 142
 143                 if (! $discussion = get_record('forum_discussions', 'forum', $forum->id)) {
 144                     error('Could not add the discussion for this forum');
 145                 }
 146
 147             }
 148         }
 149         if (! $post = get_record('forum_posts', 'id', $discussion->firstpost)) {
 150             error('Could not find the first post in this forum discussion');
 151         }
 152
 153         $post->subject  = $forum->name;
 154         $post->message  = $forum->intro;
 155         $post->modified = $forum->timemodified;
 156         $post->userid   = $USER->id;    // MDL-18599, so that current teacher can take ownership of activities
 157
 158         if (! update_record('forum_posts', ($post))) {
 159             error('Could not update the first post');
 160         }
 161
 162         $discussion->name = $forum->name;
 163
 164         if (! update_record('forum_discussions', ($discussion))) {
 165             error('Could not update the discussion');
 166         }
 167     }
 168
 169     if (!update_record('forum', $forum)) {
 170         error('Can not update forum');
 171     }
 172
 173     $forum = stripslashes_recursive($forum);
 174     forum_grade_item_update($forum);
 175
 176     return true;
 177 }
 178
 179
 180 /**
 181  * Given an ID of an instance of this module,
 182  * this function will permanently delete the instance
 183  * and any data that depends on it.
 184  * @param int forum instance id
 185  * @return bool success
 186  */
 187 function forum_delete_instance($id) {
 188
 189     if (!$forum = get_record('forum', 'id', $id)) {
 190         return false;
 191     }
 192
 193     $result = true;
 194
 195     if ($discussions = get_records('forum_discussions', 'forum', $forum->id)) {
 196         foreach ($discussions as $discussion) {
 197             if (!forum_delete_discussion($discussion, true)) {
 198                 $result = false;
 199             }
 200         }
 201     }
 202
 203     if (!delete_records('forum_subscriptions', 'forum', $forum->id)) {
 204         $result = false;
 205     }
 206
 207     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
 208
 209     if (!delete_records('forum', 'id', $forum->id)) {
 210         $result = false;
 211     }
 212
 213     forum_grade_item_delete($forum);
 214
 215     return $result;
 216 }
 217
 218
 219 /**
 220  * Function to be run periodically according to the moodle cron
 221  * Finds all posts that have yet to be mailed out, and mails them
 222  * out to all subscribers
 223  * @return void
 224  */
 225 function forum_cron() {
 226     global $CFG, $USER;
 227
 228     $cronuser = clone($USER);
 229     $site = get_site();
 230
 231     // all users that are subscribed to any post that needs sending
 232     $users = array();
 233
 234     // status arrays
 235     $mailcount  = array();
 236     $errorcount = array();
 237
 238     // caches
 239     $discussions     = array();
 240     $forums          = array();
 241     $courses         = array();
 242     $coursemodules   = array();
 243     $subscribedusers = array();
 244
 245
 246     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
 247     // cron has not been running for a long time, and then suddenly people are flooded
 248     // with mail from the past few weeks or months
 249     $timenow   = time();
 250     $endtime   = $timenow - $CFG->maxeditingtime;
 251     $starttime = $endtime - 48 * 3600;   // Two days earlier
 252
 253     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
 254         // Mark them all now as being mailed.  It's unlikely but possible there
 255         // might be an error later so that a post is NOT actually mailed out,
 256         // but since mail isn't crucial, we can accept this risk.  Doing it now
 257         // prevents the risk of duplicated mails, which is a worse problem.
 258
 259         if (!forum_mark_old_posts_as_mailed($endtime)) {
 260             mtrace('Errors occurred while trying to mark some posts as being mailed.');
 261             return false;  // Don't continue trying to mail them, in case we are in a cron loop
 262         }
 263
 264         // checking post validity, and adding users to loop through later
 265         foreach ($posts as $pid => $post) {
 266
 267             $discussionid = $post->discussion;
 268             if (!isset($discussions[$discussionid])) {
 269                 if ($discussion = get_record('forum_discussions', 'id', $post->discussion)) {
 270                     $discussions[$discussionid] = $discussion;
 271                 } else {
 272                     mtrace('Could not find discussion '.$discussionid);
 273                     unset($posts[$pid]);
 274                     continue;
 275                 }
 276             }
 277             $forumid = $discussions[$discussionid]->forum;
 278             if (!isset($forums[$forumid])) {
 279                 if ($forum = get_record('forum', 'id', $forumid)) {
 280                     $forums[$forumid] = $forum;
 281                 } else {
 282                     mtrace('Could not find forum '.$forumid);
 283                     unset($posts[$pid]);
 284                     continue;
 285                 }
 286             }
 287             $courseid = $forums[$forumid]->course;
 288             if (!isset($courses[$courseid])) {
 289                 if ($course = get_record('course', 'id', $courseid)) {
 290                     $courses[$courseid] = $course;
 291                 } else {
 292                     mtrace('Could not find course '.$courseid);
 293                     unset($posts[$pid]);
 294                     continue;
 295                 }
 296             }
 297             if (!isset($coursemodules[$forumid])) {
 298                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
 299                     $coursemodules[$forumid] = $cm;
 300                 } else {
 301                     mtrace('Could not course module for forum '.$forumid);
 302                     unset($posts[$pid]);
 303                     continue;
 304                 }
 305             }
 306
 307
 308             // caching subscribed users of each forum
 309             if (!isset($subscribedusers[$forumid])) {
 310                 $modcontext = get_context_instance(CONTEXT_MODULE, $coursemodules[$forumid]->id);
 311                 if ($subusers = forum_subscribed_users($courses[$courseid], $forums[$forumid], 0, $modcontext)) {
 312                     foreach ($subusers as $postuser) {
 313                         // do not try to mail users with stopped email
 314                         if ($postuser->emailstop) {
 315                             if (!empty($CFG->forum_logblocked)) {
 316                                 add_to_log(SITEID, 'forum', 'mail blocked', '', '', 0, $postuser->id);
 317                             }
 318                             continue;
 319                         }
 320                         // this user is subscribed to this forum
 321                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
 322                         // this user is a user we have to process later
 323                         $users[$postuser->id] = $postuser;
 324                     }
 325                     unset($subusers); // release memory
 326                 }
 327             }
 328
 329             $mailcount[$pid] = 0;
 330             $errorcount[$pid] = 0;
 331         }
 332     }
 333
 334     if ($users && $posts) {
 335
 336         $urlinfo = parse_url($CFG->wwwroot);
 337         $hostname = $urlinfo['host'];
 338
 339         foreach ($users as $userto) {
 340
 341             @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
 342
 343             // set this so that the capabilities are cached, and environment matches receiving user
 344             $USER = $userto;
 345
 346             mtrace('Processing user '.$userto->id);
 347
 348             // init caches
 349             $userto->viewfullnames = array();
 350             $userto->canpost       = array();
 351             $userto->markposts     = array();
 352             $userto->enrolledin    = array();
 353
 354             // reset the caches
 355             foreach ($coursemodules as $forumid=>$unused) {
 356                 $coursemodules[$forumid]->cache       = new object();
 357                 $coursemodules[$forumid]->cache->caps = array();
 358                 unset($coursemodules[$forumid]->uservisible);
 359             }
 360
 361             foreach ($posts as $pid => $post) {
 362
 363                 // Set up the environment for the post, discussion, forum, course
 364                 $discussion = $discussions[$post->discussion];
 365                 $forum      = $forums[$discussion->forum];
 366                 $course     = $courses[$forum->course];
 367                 $cm         =& $coursemodules[$forum->id];
 368
 369                 // Do some checks  to see if we can bail out now
 370                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
 371                     continue; // user does not subscribe to this forum
 372                 }
 373
 374                 // Verify user is enrollend in course - if not do not send any email
 375                 if (!isset($userto->enrolledin[$course->id])) {
 376                     $userto->enrolledin[$course->id] = has_capability('moodle/course:view', get_context_instance(CONTEXT_COURSE, $course->id));
 377                 }
 378                 if (!$userto->enrolledin[$course->id]) {
 379                     // oops - this user should not receive anything from this course
 380                     continue;
 381                 }
 382
 383                 // Get info about the sending user
 384                 if (array_key_exists($post->userid, $users)) { // we might know him/her already
 385                     $userfrom = $users[$post->userid];
 386                 } else if ($userfrom = get_record('user', 'id', $post->userid)) {
 387                     $users[$userfrom->id] = $userfrom; // fetch only once, we can add it to user list, it will be skipped anyway
 388                 } else {
 389                     mtrace('Could not find user '.$post->userid);
 390                     continue;
 391                 }
 392
 393                 // setup global $COURSE properly - needed for roles and languages
 394                 course_setup($course);   // More environment
 395
 396                 // Fill caches
 397                 if (!isset($userto->viewfullnames[$forum->id])) {
 398                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 399                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
 400                 }
 401                 if (!isset($userto->canpost[$discussion->id])) {
 402                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 403                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
 404                 }
 405                 if (!isset($userfrom->groups[$forum->id])) {
 406                     if (!isset($userfrom->groups)) {
 407                         $userfrom->groups = array();
 408                         $users[$userfrom->id]->groups = array();
 409                     }
 410                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
 411                     $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
 412                 }
 413
 414                 // Make sure groups allow this user to see this email
 415                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
 416                     if (!groups_group_exists($discussion->groupid)) { // Can't find group
 417                         continue;                           // Be safe and don't send it to anyone
 418                     }
 419
 420                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
 421                         // do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
 422                         continue;
 423                     }
 424                 }
 425
 426                 // Make sure we're allowed to see it...
 427                 if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
 428                     mtrace('user '.$userto->id. ' can not see '.$post->id);
 429                     continue;
 430                 }
 431
 432                 // OK so we need to send the email.
 433
 434                 // Does the user want this post in a digest?  If so postpone it for now.
 435                 if ($userto->maildigest > 0) {
 436                     // This user wants the mails to be in digest form
 437                     $queue = new object();
 438                     $queue->userid       = $userto->id;
 439                     $queue->discussionid = $discussion->id;
 440                     $queue->postid       = $post->id;
 441                     $queue->timemodified = $post->created;
 442                     if (!insert_record('forum_queue', $queue)) {
 443                         mtrace("Error: mod/forum/cron.php: Could not queue for digest mail for id $post->id to user $userto->id ($userto->email) .. not trying again.");
 444                     }
 445                     continue;
 446                 }
 447
 448
 449                 // Prepare to actually send the post now, and build up the content
 450
 451                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
 452
 453                 $userfrom->customheaders = array (  // Headers to make emails easier to track
 454                            'Precedence: Bulk',
 455                            'List-Id: "'.$cleanforumname.'" <moodleforum'.$forum->id.'@'.$hostname.'>',
 456                            'List-Help: '.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id,
 457                            'Message-ID: <moodlepost'.$post->id.'@'.$hostname.'>',
 458                            'X-Course-Id: '.$course->id,
 459                            'X-Course-Name: '.format_string($course->fullname, true)
 460                 );
 461
 462                 if ($post->parent) {  // This post is a reply, so add headers for threading (see MDL-22551)
 463                     $userfrom->customheaders[] = 'In-Reply-To: <moodlepost'.$post->parent.'@'.$hostname.'>';
 464                     $userfrom->customheaders[] = 'References: <moodlepost'.$post->parent.'@'.$hostname.'>';
 465                 }
 466
 467                 $postsubject = "$course->shortname: ".format_string($post->subject,true);
 468                 $posttext = forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $userto);
 469                 $posthtml = forum_make_mail_html($course, $forum, $discussion, $post, $userfrom, $userto);
 470
 471                 // Send the post now!
 472
 473                 mtrace('Sending ', '');
 474
 475                 if (!$mailresult = email_to_user($userto, $userfrom, $postsubject, $posttext,
 476                                                  $posthtml, '', '', $CFG->forum_replytouser)) {
 477                     mtrace("Error: mod/forum/cron.php: Could not send out mail for id $post->id to user $userto->id".
 478                          " ($userto->email) .. not trying again.");
 479                     add_to_log($course->id, 'forum', 'mail error', "discuss.php?d=$discussion->id#p$post->id",
 480                                substr(format_string($post->subject,true),0,30), $cm->id, $userto->id);
 481                     $errorcount[$post->id]++;
 482                 } else if ($mailresult === 'emailstop') {
 483                     // should not be reached anymore - see check above
 484                 } else {
 485                     $mailcount[$post->id]++;
 486
 487                 // Mark post as read if forum_usermarksread is set off
 488                     if (!$CFG->forum_usermarksread) {
 489                         $userto->markposts[$post->id] = $post->id;
 490                     }
 491                 }
 492
 493                 mtrace('post '.$post->id. ': '.$post->subject);
 494             }
 495
 496             // mark processed posts as read
 497             forum_tp_mark_posts_read($userto, $userto->markposts);
 498         }
 499     }
 500
 501     if ($posts) {
 502         foreach ($posts as $post) {
 503             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
 504             if ($errorcount[$post->id]) {
 505                 set_field("forum_posts", "mailed", "2", "id", "$post->id");
 506             }
 507         }
 508     }
 509
 510     // release some memory
 511     unset($subscribedusers);
 512     unset($mailcount);
 513     unset($errorcount);
 514
 515     $USER = clone($cronuser);
 516     course_setup(SITEID);
 517
 518     $sitetimezone = $CFG->timezone;
 519
 520     // Now see if there are any digest mails waiting to be sent, and if we should send them
 521
 522     mtrace('Starting digest processing...');
 523
 524     @set_time_limit(300); // terminate if not able to fetch all digests in 5 minutes
 525
 526     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
 527         set_config('digestmailtimelast', 0);
 528     }
 529
 530     $timenow = time();
 531     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
 532
 533     // Delete any really old ones (normally there shouldn't be any)
 534     $weekago = $timenow - (7 * 24 * 3600);
 535     delete_records_select('forum_queue', "timemodified < $weekago");
 536     mtrace ('Cleaned old digest records');
 537
 538     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
 539
 540         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
 541
 542         $digestposts_rs = get_recordset_select('forum_queue', "timemodified < $digesttime");
 543
 544         if (!rs_EOF($digestposts_rs)) {
 545
 546             // We have work to do
 547             $usermailcount = 0;
 548
 549             //caches - reuse the those filled before too
 550             $discussionposts = array();
 551             $userdiscussions = array();
 552
 553             while ($digestpost = rs_fetch_next_record($digestposts_rs)) {
 554                 if (!isset($users[$digestpost->userid])) {
 555                     if ($user = get_record('user', 'id', $digestpost->userid)) {
 556                         $users[$digestpost->userid] = $user;
 557                     } else {
 558                         continue;
 559                     }
 560                 }
 561                 $postuser = $users[$digestpost->userid];
 562                 if ($postuser->emailstop) {
 563                     if (!empty($CFG->forum_logblocked)) {
 564                         add_to_log(SITEID, 'forum', 'mail blocked', '', '', 0, $postuser->id);
 565                     }
 566                     continue;
 567                 }
 568
 569                 if (!isset($posts[$digestpost->postid])) {
 570                     if ($post = get_record('forum_posts', 'id', $digestpost->postid)) {
 571                         $posts[$digestpost->postid] = $post;
 572                     } else {
 573                         continue;
 574                     }
 575                 }
 576                 $discussionid = $digestpost->discussionid;
 577                 if (!isset($discussions[$discussionid])) {
 578                     if ($discussion = get_record('forum_discussions', 'id', $discussionid)) {
 579                         $discussions[$discussionid] = $discussion;
 580                     } else {
 581                         continue;
 582                     }
 583                 }
 584                 $forumid = $discussions[$discussionid]->forum;
 585                 if (!isset($forums[$forumid])) {
 586                     if ($forum = get_record('forum', 'id', $forumid)) {
 587                         $forums[$forumid] = $forum;
 588                     } else {
 589                         continue;
 590                     }
 591                 }
 592
 593                 $courseid = $forums[$forumid]->course;
 594                 if (!isset($courses[$courseid])) {
 595                     if ($course = get_record('course', 'id', $courseid)) {
 596                         $courses[$courseid] = $course;
 597                     } else {
 598                         continue;
 599                     }
 600                 }
 601
 602                 if (!isset($coursemodules[$forumid])) {
 603                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
 604                         $coursemodules[$forumid] = $cm;
 605                     } else {
 606                         continue;
 607                     }
 608                 }
 609                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
 610                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
 611             }
 612             rs_close($digestposts_rs); /// Finished iteration, let's close the resultset
 613
 614             // Data collected, start sending out emails to each user
 615             foreach ($userdiscussions as $userid => $thesediscussions) {
 616
 617                 @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
 618
 619                 $USER = $cronuser;
 620                 course_setup(SITEID); // reset cron user language, theme and timezone settings
 621
 622                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
 623
 624                 // First of all delete all the queue entries for this user
 625                 delete_records_select('forum_queue', "userid = $userid AND timemodified < $digesttime");
 626                 $userto = $users[$userid];
 627
 628                 // Override the language and timezone of the "current" user, so that
 629                 // mail is customised for the receiver.
 630                 $USER = $userto;
 631                 course_setup(SITEID);
 632
 633                 // init caches
 634                 $userto->viewfullnames = array();
 635                 $userto->canpost       = array();
 636                 $userto->markposts     = array();
 637
 638                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
 639
 640                 $headerdata = new object();
 641                 $headerdata->sitename = format_string($site->fullname, true);
 642                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
 643
 644                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
 645                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
 646
 647                 $posthtml = "<head>";
 648                 foreach ($CFG->stylesheets as $stylesheet) {
 649                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
 650                 }
 651                 $posthtml .= "</head>\n<body id=\"email\">\n";
 652                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
 653
 654                 foreach ($thesediscussions as $discussionid) {
 655
 656                     @set_time_limit(120);   // to be reset for each post
 657
 658                     $discussion = $discussions[$discussionid];
 659                     $forum      = $forums[$discussion->forum];
 660                     $course     = $courses[$forum->course];
 661                     $cm         = $coursemodules[$forum->id];
 662
 663                     //override language
 664                     course_setup($course);
 665
 666                     // Fill caches
 667                     if (!isset($userto->viewfullnames[$forum->id])) {
 668                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 669                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
 670                     }
 671                     if (!isset($userto->canpost[$discussion->id])) {
 672                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 673                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
 674                     }
 675
 676                     $strforums      = get_string('forums', 'forum');
 677                     $canunsubscribe = ! forum_is_forcesubscribed($forum);
 678                     $canreply       = $userto->canpost[$discussion->id];
 679
 680                     $posttext .= "\n \n";
 681                     $posttext .= '=====================================================================';
 682                     $posttext .= "\n \n";
 683                     $posttext .= "$course->shortname -> $strforums -> ".format_string($forum->name,true);
 684                     if ($discussion->name != $forum->name) {
 685                         $posttext  .= " -> ".format_string($discussion->name,true);
 686                     }
 687                     $posttext .= "\n";
 688
 689                     $posthtml .= "<p><font face=\"sans-serif\">".
 690                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> -> ".
 691                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
 692                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
 693                     if ($discussion->name == $forum->name) {
 694                         $posthtml .= "</font></p>";
 695                     } else {
 696                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
 697                     }
 698                     $posthtml .= '<p>';
 699
 700                     $postsarray = $discussionposts[$discussionid];
 701                     sort($postsarray);
 702
 703                     foreach ($postsarray as $postid) {
 704                         $post = $posts[$postid];
 705
 706                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
 707                             $userfrom = $users[$post->userid];
 708                         } else if ($userfrom = get_record('user', 'id', $post->userid)) {
 709                             $users[$userfrom->id] = $userfrom; // fetch only once, we can add it to user list, it will be skipped anyway
 710                         } else {
 711                             mtrace('Could not find user '.$post->userid);
 712                             continue;
 713                         }
 714
 715                         if (!isset($userfrom->groups[$forum->id])) {
 716                             if (!isset($userfrom->groups)) {
 717                                 $userfrom->groups = array();
 718                                 $users[$userfrom->id]->groups = array();
 719                             }
 720                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
 721                             $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
 722                         }
 723
 724                         $userfrom->customheaders = array ("Precedence: Bulk");
 725
 726                         if ($userto->maildigest == 2) {
 727                             // Subjects only
 728                             $by = new object();
 729                             $by->name = fullname($userfrom);
 730                             $by->date = userdate($post->modified);
 731                             $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
 732                             $posttext .= "\n---------------------------------------------------------------------";
 733
 734                             $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&amp;course=$course->id\">$by->name</a>";
 735                             $posthtml .= '<div><a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'#p'.$post->id.'">'.format_string($post->subject,true).'</a> '.get_string("bynameondate", "forum", $by).'</div>';
 736
 737                         } else {
 738                             // The full treatment
 739                             $posttext .= forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $userto, true);
 740                             $posthtml .= forum_make_mail_post($course, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
 741
 742                         // Create an array of postid's for this user to mark as read.
 743                             if (!$CFG->forum_usermarksread) {
 744                                 $userto->markposts[$post->id] = $post->id;
 745                             }
 746                         }
 747                     }
 748                     if ($canunsubscribe) {
 749                         $posthtml .= "\n<div class='mdl-right'><font size=\"1\"><a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">".get_string("unsubscribe", "forum")."</a></font></div>";
 750                     } else {
 751                         $posthtml .= "\n<div class='mdl-right'><font size=\"1\">".get_string("everyoneissubscribed", "forum")."</font></div>";
 752                     }
 753                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
 754                 }
 755                 $posthtml .= '</body>';
 756
 757                 if ($userto->mailformat != 1) {
 758                     // This user DOESN'T want to receive HTML
 759                     $posthtml = '';
 760                 }
 761
 762                 if (!$mailresult =  email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml,
 763                                                   '', '', $CFG->forum_replytouser)) {
 764                     mtrace("ERROR!");
 765                     echo "Error: mod/forum/cron.php: Could not send out digest mail to user $userto->id ($userto->email)... not trying again.\n";
 766                     add_to_log($course->id, 'forum', 'mail digest error', '', '', $cm->id, $userto->id);
 767                 } else if ($mailresult === 'emailstop') {
 768                     // should not happen anymore - see check above
 769                 } else {
 770                     mtrace("success.");
 771                     $usermailcount++;
 772
 773                     // Mark post as read if forum_usermarksread is set off
 774                     forum_tp_mark_posts_read($userto, $userto->markposts);
 775                 }
 776             }
 777         }
 778     /// We have finishied all digest emails, update $CFG->digestmailtimelast
 779         set_config('digestmailtimelast', $timenow);
 780     }
 781
 782     $USER = $cronuser;
 783     course_setup(SITEID); // reset cron user language, theme and timezone settings
 784
 785     if (!empty($usermailcount)) {
 786         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
 787     }
 788
 789     if (!empty($CFG->forum_lastreadclean)) {
 790         $timenow = time();
 791         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
 792             set_config('forum_lastreadclean', $timenow);
 793             mtrace('Removing old forum read tracking info...');
 794             forum_tp_clean_read_records();
 795         }
 796     } else {
 797         set_config('forum_lastreadclean', time());
 798     }
 799
 800
 801     return true;
 802 }
 803
 804 /**
 805  * Builds and returns the body of the email notification in plain text.
 806  *
 807  * @param object $course
 808  * @param object $forum
 809  * @param object $discussion
 810  * @param object $post
 811  * @param object $userfrom
 812  * @param object $userto
 813  * @param boolean $bare
 814  * @return string The email body in plain text format.
 815  */
 816 function forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $userto, $bare = false) {
 817     global $CFG, $USER;
 818
 819     if (!isset($userto->viewfullnames[$forum->id])) {
 820         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
 821             error('Course Module ID was incorrect');
 822         }
 823         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 824         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
 825     } else {
 826         $viewfullnames = $userto->viewfullnames[$forum->id];
 827     }
 828
 829     if (!isset($userto->canpost[$discussion->id])) {
 830         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
 831         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
 832     } else {
 833         $canreply = $userto->canpost[$discussion->id];
 834     }
 835
 836     $by = New stdClass;
 837     $by->name = fullname($userfrom, $viewfullnames);
 838     $by->date = userdate($post->modified, "", $userto->timezone);
 839
 840     $strbynameondate = get_string('bynameondate', 'forum', $by);
 841
 842     $strforums = get_string('forums', 'forum');
 843
 844     $canunsubscribe = ! forum_is_forcesubscribed($forum);
 845
 846     $posttext = '';
 847
 848     if (!$bare) {
 849         $posttext  = "$course->shortname -> $strforums -> ".format_string($forum->name,true);
 850
 851         if ($discussion->name != $forum->name) {
 852             $posttext  .= " -> ".format_string($discussion->name,true);
 853         }
 854     }
 855
 856     $posttext .= "\n---------------------------------------------------------------------\n";
 857     $posttext .= format_string($post->subject,true);
 858     if ($bare) {
 859         $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
 860     }
 861     $posttext .= "\n".$strbynameondate."\n";
 862     $posttext .= "---------------------------------------------------------------------\n";
 863     $posttext .= format_text_email(trusttext_strip($post->message), $post->format);
 864     $posttext .= "\n\n";
 865     if ($post->attachment) {
 866         $post->course = $course->id;
 867         $post->forum = $forum->id;
 868         $posttext .= forum_print_attachments($post, "text");
 869     }
 870     if (!$bare && $canreply) {
 871         $posttext .= "---------------------------------------------------------------------\n";
 872         $posttext .= get_string("postmailinfo", "forum", $course->shortname)."\n";
 873         $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
 874     }
 875     if (!$bare && $canunsubscribe) {
 876         $posttext .= "\n---------------------------------------------------------------------\n";
 877         $posttext .= get_string("unsubscribe", "forum");
 878         $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
 879     }
 880
 881     return $posttext;
 882 }
 883
 884 /**
 885  * Builds and returns the body of the email notification in html format.
 886  *
 887  * @param object $course
 888  * @param object $forum
 889  * @param object $discussion
 890  * @param object $post
 891  * @param object $userfrom
 892  * @param object $userto
 893  * @return string The email text in HTML format
 894  */
 895 function forum_make_mail_html($course, $forum, $discussion, $post, $userfrom, $userto) {
 896     global $CFG;
 897
 898     if ($userto->mailformat != 1) {  // Needs to be HTML
 899         return '';
 900     }
 901
 902     if (!isset($userto->canpost[$discussion->id])) {
 903         $canreply = forum_user_can_post($forum, $discussion, $userto);
 904     } else {
 905         $canreply = $userto->canpost[$discussion->id];
 906     }
 907
 908     $strforums = get_string('forums', 'forum');
 909     $canunsubscribe = ! forum_is_forcesubscribed($forum);
 910
 911     $posthtml = '<head>';
 912     foreach ($CFG->stylesheets as $stylesheet) {
 913         $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
 914     }
 915     $posthtml .= '</head>';
 916     $posthtml .= "\n<body id=\"email\">\n\n";
 917
 918     $posthtml .= '<div class="navbar">'.
 919     '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$course->shortname.'</a> &raquo; '.
 920     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> &raquo; '.
 921     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
 922     if ($discussion->name == $forum->name) {
 923         $posthtml .= '</div>';
 924     } else {
 925         $posthtml .= ' &raquo; <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
 926                      format_string($discussion->name,true).'</a></div>';
 927     }
 928     $posthtml .= forum_make_mail_post($course, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
 929
 930     if ($canunsubscribe) {
 931         $posthtml .= '<hr /><div class="mdl-align unsubscribelink">
 932                       <a href="'.$CFG->wwwroot.'/mod/forum/subscribe.php?id='.$forum->id.'">'.get_string('unsubscribe', 'forum').'</a>&nbsp;
 933                       <a href="'.$CFG->wwwroot.'/mod/forum/unsubscribeall.php">'.get_string('unsubscribeall', 'forum').'</a></div>';
 934     }
 935
 936     $posthtml .= '</body>';
 937
 938     return $posthtml;
 939 }
 940
 941
 942 /**
 943  *
 944  * @param object $course
 945  * @param object $user
 946  * @param object $mod TODO this is not used in this function, refactor
 947  * @param object $forum
 948  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
 949  */
 950 function forum_user_outline($course, $user, $mod, $forum) {
 951     global $CFG;
 952     require_once("$CFG->libdir/gradelib.php");
 953     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
 954     if (empty($grades->items[0]->grades)) {
 955         $grade = false;
 956     } else {
 957         $grade = reset($grades->items[0]->grades);
 958     }
 959
 960     $count = forum_count_user_posts($forum->id, $user->id);
 961
 962     if ($count && $count->postcount > 0) {
 963         $result = new object();
 964         $result->info = get_string("numposts", "forum", $count->postcount);
 965         $result->time = $count->lastpost;
 966         if ($grade) {
 967             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
 968         }
 969         return $result;
 970     } else if ($grade) {
 971         $result = new object();
 972         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
 973         $result->time = $grade->dategraded;
 974         return $result;
 975     }
 976     return NULL;
 977 }
 978
 979
 980 /**
 981  *
 982  */
 983 function forum_user_complete($course, $user, $mod, $forum) {
 984     global $CFG,$USER;
 985     require_once("$CFG->libdir/gradelib.php");
 986
 987     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
 988     if (!empty($grades->items[0]->grades)) {
 989         $grade = reset($grades->items[0]->grades);
 990         echo '<p>'.get_string('grade').': '.$grade->str_long_grade.'</p>';
 991         if ($grade->str_feedback) {
 992             echo '<p>'.get_string('feedback').': '.$grade->str_feedback.'</p>';
 993         }
 994     }
 995
 996     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
 997
 998         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
 999             error('Course Module ID was incorrect');
1000         }
1001         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1002
1003         // preload all user ratings for these discussions - one query only and minimal memory
1004         $cm->cache->ratings = array();
1005         $cm->cache->myratings = array();
1006         if ($postratings = forum_get_all_user_ratings($user->id, $discussions)) {
1007             foreach ($postratings as $pr) {
1008                 if (!isset($cm->cache->ratings[$pr->postid])) {
1009                     $cm->cache->ratings[$pr->postid] = array();
1010                 }
1011                 $cm->cache->ratings[$pr->postid][$pr->id] = $pr->rating;
1012
1013                 if ($pr->userid == $USER->id) {
1014                     $cm->cache->myratings[$pr->postid] = $pr->rating;
1015                 }
1016             }
1017             unset($postratings);
1018         }
1019
1020         foreach ($posts as $post) {
1021             if (!isset($discussions[$post->discussion])) {
1022                 continue;
1023             }
1024             $discussion = $discussions[$post->discussion];
1025
1026             $ratings = null;
1027
1028             if ($forum->assessed) {
1029                 if ($scale = make_grades_menu($forum->scale)) {
1030                     $ratings =new object();
1031                     $ratings->scale = $scale;
1032                     $ratings->assesstimestart = $forum->assesstimestart;
1033                     $ratings->assesstimefinish = $forum->assesstimefinish;
1034                     $ratings->allow = false;
1035                 }
1036             }
1037
1038             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false, $ratings);
1039
1040         }
1041     } else {
1042         echo "<p>".get_string("noposts", "forum")."</p>";
1043     }
1044 }
1045
1046
1047 /**
1048  *
1049  */
1050 function forum_print_overview($courses,&$htmlarray) {
1051     global $USER, $CFG;
1052     //$LIKE = sql_ilike();//no longer using like in queries. MDL-20578
1053
1054     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1055         return array();
1056     }
1057
1058     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1059         return;
1060     }
1061
1062
1063     // get all forum logs in ONE query (much better!)
1064     $sql = "SELECT instance,cmid,l.course,COUNT(l.id) as count FROM {$CFG->prefix}log l "
1065         ." JOIN {$CFG->prefix}course_modules cm ON cm.id = cmid "
1066         ." WHERE (";
1067     foreach ($courses as $course) {
1068         $sql .= '(l.course = '.$course->id.' AND l.time > '.$course->lastaccess.') OR ';
1069     }
1070     $sql = substr($sql,0,-3); // take off the last OR
1071
1072     $sql .= ") AND l.module = 'forum' AND action = 'add post' "
1073         ." AND userid != ".$USER->id." GROUP BY cmid,l.course,instance";
1074
1075     if (!$new = get_records_sql($sql)) {
1076         $new = array(); // avoid warnings
1077     }
1078
1079     // also get all forum tracking stuff ONCE.
1080     $trackingforums = array();
1081     foreach ($forums as $forum) {
1082         if (forum_tp_can_track_forums($forum)) {
1083             $trackingforums[$forum->id] = $forum;
1084         }
1085     }
1086
1087     if (count($trackingforums) > 0) {
1088         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1089         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1090             ' FROM '.$CFG->prefix.'forum_posts p '.
1091             ' JOIN '.$CFG->prefix.'forum_discussions d ON p.discussion = d.id '.
1092             ' LEFT JOIN '.$CFG->prefix.'forum_read r ON r.postid = p.id AND r.userid = '.$USER->id.' WHERE (';
1093         foreach ($trackingforums as $track) {
1094             $sql .= '(d.forum = '.$track->id.' AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = '.get_current_group($track->course).')) OR ';
1095         }
1096         $sql = substr($sql,0,-3); // take off the last OR
1097         $sql .= ') AND p.modified >= '.$cutoffdate.' AND r.id is NULL GROUP BY d.forum,d.course';
1098
1099         if (!$unread = get_records_sql($sql)) {
1100             $unread = array();
1101         }
1102     } else {
1103         $unread = array();
1104     }
1105
1106     if (empty($unread) and empty($new)) {
1107         return;
1108     }
1109
1110     $strforum = get_string('modulename','forum');
1111     $strnumunread = get_string('overviewnumunread','forum');
1112     $strnumpostssince = get_string('overviewnumpostssince','forum');
1113
1114     foreach ($forums as $forum) {
1115         $str = '';
1116         $count = 0;
1117         $thisunread = 0;
1118         $showunread = false;
1119         // either we have something from logs, or trackposts, or nothing.
1120         if (array_key_exists($forum->id, $new) && !empty($new[$forum->id])) {
1121             $count = $new[$forum->id]->count;
1122         }
1123         if (array_key_exists($forum->id,$unread)) {
1124             $thisunread = $unread[$forum->id]->count;
1125             $showunread = true;
1126         }
1127         if ($count > 0 || $thisunread > 0) {
1128             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1129                 $forum->name.'</a></div>';
1130             $str .= '<div class="info">';
1131             $str .= $count.' '.$strnumpostssince;
1132             if (!empty($showunread)) {
1133                 $str .= '<br />'.$thisunread .' '.$strnumunread;
1134             }
1135             $str .= '</div></div>';
1136         }
1137         if (!empty($str)) {
1138             if (!array_key_exists($forum->course,$htmlarray)) {
1139                 $htmlarray[$forum->course] = array();
1140             }
1141             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1142                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1143             }
1144             $htmlarray[$forum->course]['forum'] .= $str;
1145         }
1146     }
1147 }
1148
1149 /**
1150  * Given a course and a date, prints a summary of all the new
1151  * messages posted in the course since that date
1152  * @param object $course
1153  * @param bool $viewfullnames capability
1154  * @param int $timestart
1155  * @return bool success
1156  */
1157 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1158     global $CFG, $USER;
1159
1160     // do not use log table if possible, it may be huge and is expensive to join with other tables
1161
1162     if (!$posts = get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1163                                           d.timestart, d.timeend, d.userid AS duserid,
1164                                           u.firstname, u.lastname, u.email, u.picture
1165                                      FROM {$CFG->prefix}forum_posts p
1166                                           JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
1167                                           JOIN {$CFG->prefix}forum f             ON f.id = d.forum
1168                                           JOIN {$CFG->prefix}user u              ON u.id = p.userid
1169                                     WHERE p.created > $timestart AND f.course = {$course->id}
1170                                  ORDER BY p.id ASC")) { // order by initial posting date
1171          return false;
1172     }
1173
1174     $modinfo =& get_fast_modinfo($course);
1175
1176     $groupmodes = array();
1177     $cms    = array();
1178
1179     $strftimerecent = get_string('strftimerecent');
1180
1181     $printposts = array();
1182     foreach ($posts as $post) {
1183         if (!isset($modinfo->instances['forum'][$post->forum])) {
1184             // not visible
1185             continue;
1186         }
1187         $cm = $modinfo->instances['forum'][$post->forum];
1188         if (!$cm->uservisible) {
1189             continue;
1190         }
1191         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1192
1193         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1194             continue;
1195         }
1196
1197         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1198           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1199             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1200                 continue;
1201             }
1202         }
1203
1204         $groupmode = groups_get_activity_groupmode($cm, $course);
1205
1206         if ($groupmode) {
1207             if ($post->groupid == -1 or $groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context)) {
1208                 // oki (Open discussions have groupid -1)
1209             } else {
1210                 // separate mode
1211                 if (isguestuser()) {
1212                     // shortcut
1213                     continue;
1214                 }
1215
1216                 if (is_null($modinfo->groups)) {
1217                     $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
1218                 }
1219
1220                 if (!array_key_exists($post->groupid, $modinfo->groups[0])) {
1221                     continue;
1222                 }
1223             }
1224         }
1225
1226         $printposts[] = $post;
1227     }
1228     unset($posts);
1229
1230     if (!$printposts) {
1231         return false;
1232     }
1233
1234     print_headline(get_string('newforumposts', 'forum').':', 3);
1235     echo "\n<ul class='unlist'>\n";
1236
1237     foreach ($printposts as $post) {
1238         $subjectclass = empty($post->parent) ? ' bold' : '';
1239
1240         echo '<li><div class="head">'.
1241                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1242                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1243              '</div>';
1244         echo '<div class="info'.$subjectclass.'">';
1245         if (empty($post->parent)) {
1246             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1247         } else {
1248             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1249         }
1250         $post->subject = break_up_long_words(format_string($post->subject, true));
1251         echo $post->subject;
1252         echo "</a>\"</div></li>\n";
1253     }
1254
1255     echo "</ul>\n";
1256
1257     return true;
1258 }
1259
1260 /**
1261  * Return grade for given user or all users.
1262  *
1263  * @param int $forumid id of forum
1264  * @param int $userid optional user id, 0 means all users
1265  * @return array array of grades, false if none
1266  */
1267 function forum_get_user_grades($forum, $userid=0) {
1268     global $CFG;
1269
1270     $user = $userid ? "AND u.id = $userid" : "";
1271
1272     $aggtype = $forum->assessed;
1273     switch ($aggtype) {
1274         case FORUM_AGGREGATE_COUNT :
1275             $sql = "SELECT u.id, u.id AS userid, COUNT(fr.rating) AS rawgrade
1276                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1277                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1278                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1279                            AND fr.userid != u.id AND fd.forum = $forum->id
1280                            $user
1281                   GROUP BY u.id";
1282             break;
1283         case FORUM_AGGREGATE_MAX :
1284             $sql = "SELECT u.id, u.id AS userid, MAX(fr.rating) AS rawgrade
1285                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1286                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1287                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1288                            AND fr.userid != u.id AND fd.forum = $forum->id
1289                            $user
1290                   GROUP BY u.id";
1291             break;
1292         case FORUM_AGGREGATE_MIN :
1293             $sql = "SELECT u.id, u.id AS userid, MIN(fr.rating) AS rawgrade
1294                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1295                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1296                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1297                            AND fr.userid != u.id AND fd.forum = $forum->id
1298                            $user
1299                   GROUP BY u.id";
1300             break;
1301         case FORUM_AGGREGATE_SUM :
1302             $sql = "SELECT u.id, u.id AS userid, SUM(fr.rating) AS rawgrade
1303                      FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1304                           {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1305                     WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1306                           AND fr.userid != u.id AND fd.forum = $forum->id
1307                           $user
1308                  GROUP BY u.id";
1309             break;
1310         default : //avg
1311             $sql = "SELECT u.id, u.id AS userid, AVG(fr.rating) AS rawgrade
1312                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1313                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1314                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1315                            AND fr.userid != u.id AND fd.forum = $forum->id
1316                            $user
1317                   GROUP BY u.id";
1318             break;
1319     }
1320
1321     if ($results = get_records_sql($sql)) {
1322         // it could throw off the grading if count and sum returned a rawgrade higher than scale
1323         // so to prevent it we review the results and ensure that rawgrade does not exceed the scale, if it does we set rawgrade = scale (i.e. full credit)
1324         foreach ($results as $rid=>$result) {
1325             if ($forum->scale >= 0) {
1326                 //numeric
1327                 if ($result->rawgrade > $forum->scale) {
1328                     $results[$rid]->rawgrade = $forum->scale;
1329                 }
1330             } else {
1331                 //scales
1332                 if ($scale = get_record('scale', 'id', -$forum->scale)) {
1333                     $scale = explode(',', $scale->scale);
1334                     $max = count($scale);
1335                     if ($result->rawgrade > $max) {
1336                         $results[$rid]->rawgrade = $max;
1337                     }
1338                 }
1339             }
1340         }
1341     }
1342
1343     return $results;
1344 }
1345
1346 /**
1347  * Update grades by firing grade_updated event
1348  *
1349  * @param object $forum null means all forums
1350  * @param int $userid specific user only, 0 mean all
1351  * @param boolean $nullifnone return null if grade does not exist
1352  * @return void
1353  */
1354 function forum_update_grades($forum=null, $userid=0, $nullifnone=true) {
1355     global $CFG;
1356
1357     if ($forum != null) {
1358         require_once($CFG->libdir.'/gradelib.php');
1359         if ($grades = forum_get_user_grades($forum, $userid)) {
1360             forum_grade_item_update($forum, $grades);
1361
1362         } else if ($userid and $nullifnone) {
1363             $grade = new object();
1364             $grade->userid   = $userid;
1365             $grade->rawgrade = NULL;
1366             forum_grade_item_update($forum, $grade);
1367
1368         } else {
1369             forum_grade_item_update($forum);
1370         }
1371
1372     } else {
1373         $sql = "SELECT f.*, cm.idnumber as cmidnumber
1374                   FROM {$CFG->prefix}forum f, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m
1375                  WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
1376         if ($rs = get_recordset_sql($sql)) {
1377             while ($forum = rs_fetch_next_record($rs)) {
1378                 if ($forum->assessed) {
1379                     forum_update_grades($forum, 0, false);
1380                 } else {
1381                     forum_grade_item_update($forum);
1382                 }
1383             }
1384             rs_close($rs);
1385         }
1386     }
1387 }
1388
1389 /**
1390  * Create/update grade item for given forum
1391  *
1392  * @param object $forum object with extra cmidnumber
1393  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
1394  * @return int 0 if ok
1395  */
1396 function forum_grade_item_update($forum, $grades=NULL) {
1397     global $CFG;
1398     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1399         require_once($CFG->libdir.'/gradelib.php');
1400     }
1401
1402     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1403
1404     if (!$forum->assessed or $forum->scale == 0) {
1405         $params['gradetype'] = GRADE_TYPE_NONE;
1406
1407     } else if ($forum->scale > 0) {
1408         $params['gradetype'] = GRADE_TYPE_VALUE;
1409         $params['grademax']  = $forum->scale;
1410         $params['grademin']  = 0;
1411
1412     } else if ($forum->scale < 0) {
1413         $params['gradetype'] = GRADE_TYPE_SCALE;
1414         $params['scaleid']   = -$forum->scale;
1415     }
1416
1417     if ($grades  === 'reset') {
1418         $params['reset'] = true;
1419         $grades = NULL;
1420     }
1421
1422     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1423 }
1424
1425 /**
1426  * Delete grade item for given forum
1427  *
1428  * @param object $forum object
1429  * @return object grade_item
1430  */
1431 function forum_grade_item_delete($forum) {
1432     global $CFG;
1433     require_once($CFG->libdir.'/gradelib.php');
1434
1435     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1436 }
1437
1438
1439 /**
1440  * Returns the users with data in one forum
1441  * (users with records in forum_subscriptions, forum_posts and forum_ratings, students)
1442  * @param int $forumid
1443  * @return mixed array or false if none
1444  */
1445 function forum_get_participants($forumid) {
1446
1447     global $CFG;
1448
1449     //Get students from forum_subscriptions
1450     $st_subscriptions = get_records_sql("SELECT DISTINCT u.id, u.id
1451                                          FROM {$CFG->prefix}user u,
1452                                               {$CFG->prefix}forum_subscriptions s
1453                                          WHERE s.forum = '$forumid' and
1454                                                u.id = s.userid");
1455     //Get students from forum_posts
1456     $st_posts = get_records_sql("SELECT DISTINCT u.id, u.id
1457                                  FROM {$CFG->prefix}user u,
1458                                       {$CFG->prefix}forum_discussions d,
1459                                       {$CFG->prefix}forum_posts p
1460                                  WHERE d.forum = '$forumid' and
1461                                        p.discussion = d.id and
1462                                        u.id = p.userid");
1463
1464     //Get students from forum_ratings
1465     $st_ratings = get_records_sql("SELECT DISTINCT u.id, u.id
1466                                    FROM {$CFG->prefix}user u,
1467                                         {$CFG->prefix}forum_discussions d,
1468                                         {$CFG->prefix}forum_posts p,
1469                                         {$CFG->prefix}forum_ratings r
1470                                    WHERE d.forum = '$forumid' and
1471                                          p.discussion = d.id and
1472                                          r.post = p.id and
1473                                          u.id = r.userid");
1474
1475     //Add st_posts to st_subscriptions
1476     if ($st_posts) {
1477         foreach ($st_posts as $st_post) {
1478             $st_subscriptions[$st_post->id] = $st_post;
1479         }
1480     }
1481     //Add st_ratings to st_subscriptions
1482     if ($st_ratings) {
1483         foreach ($st_ratings as $st_rating) {
1484             $st_subscriptions[$st_rating->id] = $st_rating;
1485         }
1486     }
1487     //Return st_subscriptions array (it contains an array of unique users)
1488     return ($st_subscriptions);
1489 }
1490
1491 /**
1492  * This function returns if a scale is being used by one forum
1493  * @param int $forumid
1494  * @param int $scaleid negative number
1495  * @return bool
1496  */
1497 function forum_scale_used ($forumid,$scaleid) {
1498
1499     $return = false;
1500
1501     $rec = get_record("forum","id","$forumid","scale","-$scaleid");
1502
1503     if (!empty($rec) && !empty($scaleid)) {
1504         $return = true;
1505     }
1506
1507     return $return;
1508 }
1509
1510 /**
1511  * Checks if scale is being used by any instance of forum
1512  *
1513  * This is used to find out if scale used anywhere
1514  * @param $scaleid int
1515  * @return boolean True if the scale is used by any forum
1516  */
1517 function forum_scale_used_anywhere($scaleid) {
1518     if ($scaleid and record_exists('forum', 'scale', -$scaleid)) {
1519         return true;
1520     } else {
1521         return false;
1522     }
1523 }
1524
1525 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1526
1527 /**
1528  * Gets a post with all info ready for forum_print_post
1529  * Most of these joins are just to get the forum id
1530  * @param int $postid
1531  * @return mixed array of posts or false
1532  */
1533 function forum_get_post_full($postid) {
1534     global $CFG;
1535
1536     return get_record_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1537                              FROM {$CFG->prefix}forum_posts p
1538                                   JOIN {$CFG->prefix}forum_discussions d ON p.discussion = d.id
1539                                   LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1540                             WHERE p.id = '$postid'");
1541 }
1542
1543 /**
1544  * Gets posts with all info ready for forum_print_post
1545  * We pass forumid in because we always know it so no need to make a
1546  * complicated join to find it out.
1547  * @return mixed array of posts or false
1548  */
1549 function forum_get_discussion_posts($discussion, $sort, $forumid) {
1550     global $CFG;
1551
1552     return get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1553                               FROM {$CFG->prefix}forum_posts p
1554                          LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1555                              WHERE p.discussion = $discussion
1556                                AND p.parent > 0 $sort");
1557 }
1558
1559 /**
1560  * Gets all posts in discussion including top parent.
1561  * @param int $discussionid
1562  * @param string $sort
1563  * @param bool $tracking does user track the forum?
1564  * @return array of posts
1565  */
1566 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1567     global $CFG, $USER;
1568
1569     $tr_sel  = "";
1570     $tr_join = "";
1571
1572     if ($tracking) {
1573         $now = time();
1574         $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
1575         $tr_sel  = ", fr.id AS postread";
1576         $tr_join = "LEFT JOIN {$CFG->prefix}forum_read fr ON (fr.postid = p.id AND fr.userid = $USER->id)";
1577     }
1578
1579     if (!$posts = get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture, u.imagealt $tr_sel
1580                                      FROM {$CFG->prefix}forum_posts p
1581                                           LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1582                                           $tr_join
1583                                     WHERE p.discussion = $discussionid
1584                                  ORDER BY $sort")) {
1585         return array();
1586     }
1587
1588     foreach ($posts as $pid=>$p) {
1589         if ($tracking) {
1590             if (forum_tp_is_post_old($p)) {
1591                  $posts[$pid]->postread = true;
1592             }
1593         }
1594         if (!$p->parent) {
1595             continue;
1596         }
1597         if (!isset($posts[$p->parent])) {
1598             continue; // parent does not exist??
1599         }
1600         if (!isset($posts[$p->parent]->children)) {
1601             $posts[$p->parent]->children = array();
1602         }
1603         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1604     }
1605
1606     return $posts;
1607 }
1608
1609 /**
1610  * Gets posts with all info ready for forum_print_post
1611  * We pass forumid in because we always know it so no need to make a
1612  * complicated join to find it out.
1613  */
1614 function forum_get_child_posts($parent, $forumid) {
1615     global $CFG;
1616
1617     return get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1618                               FROM {$CFG->prefix}forum_posts p
1619                          LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1620                              WHERE p.parent = '$parent'
1621                           ORDER BY p.created ASC");
1622 }
1623
1624 /**
1625  * An array of forum objects that the user is allowed to read/search through.
1626  * @param $userid
1627  * @param $courseid - if 0, we look for forums throughout the whole site.
1628  * @return array of forum objects, or false if no matches
1629  *         Forum objects have the following attributes:
1630  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1631  *         viewhiddentimedposts
1632  */
1633 function forum_get_readable_forums($userid, $courseid=0) {
1634
1635     global $CFG, $USER;
1636     require_once($CFG->dirroot.'/course/lib.php');
1637
1638     if (!$forummod = get_record('modules', 'name', 'forum')) {
1639         error('The forum module is not installed');
1640     }
1641
1642     if ($courseid) {
1643         $courses = get_records('course', 'id', $courseid);
1644     } else {
1645         // If no course is specified, then the user can see SITE + his courses.
1646         // And admins can see all courses, so pass the $doanything flag enabled
1647         $courses1 = get_records('course', 'id', SITEID);
1648         $courses2 = get_my_courses($userid, null, null, true);
1649         $courses = array_merge($courses1, $courses2);
1650     }
1651     if (!$courses) {
1652         return array();
1653     }
1654
1655     $readableforums = array();
1656
1657     foreach ($courses as $course) {
1658
1659         $modinfo =& get_fast_modinfo($course);
1660         if (is_null($modinfo->groups)) {
1661             $modinfo->groups = groups_get_user_groups($course->id, $userid);
1662         }
1663
1664         if (empty($modinfo->instances['forum'])) {
1665             // hmm, no forums?
1666             continue;
1667         }
1668
1669         $courseforums = get_records('forum', 'course', $course->id);
1670
1671         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1672             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1673                 continue;
1674             }
1675             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1676             $forum = $courseforums[$forumid];
1677             $forum->context = $context;
1678             $forum->cm = $cm;
1679
1680             if (!has_capability('mod/forum:viewdiscussion', $context)) {
1681                 continue;
1682             }
1683
1684          /// group access
1685             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
1686                 if (is_null($modinfo->groups)) {
1687                     $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
1688                 }
1689                 if (empty($CFG->enablegroupings)) {
1690                     $forum->onlygroups = $modinfo->groups[0];
1691                     $forum->onlygroups[] = -1;
1692                 } else if (isset($modinfo->groups[$cm->groupingid])) {
1693                     $forum->onlygroups = $modinfo->groups[$cm->groupingid];
1694                     $forum->onlygroups[] = -1;
1695                 } else {
1696                     $forum->onlygroups = array(-1);
1697                 }
1698             }
1699
1700         /// hidden timed discussions
1701             $forum->viewhiddentimedposts = true;
1702             if (!empty($CFG->forum_enabletimedposts)) {
1703                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1704                     $forum->viewhiddentimedposts = false;
1705                 }
1706             }
1707
1708         /// qanda access
1709             if ($forum->type == 'qanda'
1710                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1711
1712                 // We need to check whether the user has posted in the qanda forum.
1713                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
1714                                                     // the user is allowed to see in this forum.
1715                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1716                     foreach ($discussionspostedin as $d) {
1717                         $forum->onlydiscussions[] = $d->id;
1718                     }
1719                 }
1720             }
1721
1722             $readableforums[$forum->id] = $forum;
1723         }
1724
1725         unset($modinfo);
1726
1727     } // End foreach $courses
1728
1729     //print_object($courses);
1730     //print_object($readableforums);
1731
1732     return $readableforums;
1733 }
1734
1735 /**
1736  * Returns a list of posts found using an array of search terms.
1737  * @param $searchterms - array of search terms, e.g. word +word -word
1738  * @param $courseid - if 0, we search through the whole site
1739  * @param $page
1740  * @param $recordsperpage=50
1741  * @param &$totalcount
1742  * @param $extrasql
1743  * @return array of posts found
1744  */
1745 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
1746                             &$totalcount, $extrasql='') {
1747     global $CFG, $USER;
1748     require_once($CFG->libdir.'/searchlib.php');
1749
1750     $forums = forum_get_readable_forums($USER->id, $courseid);
1751
1752     if (count($forums) == 0) {
1753         $totalcount = 0;
1754         return false;
1755     }
1756
1757     $now = round(time(), -2); // db friendly
1758
1759     $fullaccess = array();
1760     $where = array();
1761
1762     foreach ($forums as $forumid => $forum) {
1763         $select = array();
1764
1765         if (!$forum->viewhiddentimedposts) {
1766             $select[] = "(d.userid = {$USER->id} OR (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)))";
1767         }
1768
1769         $cm = $forum->cm;
1770         $context = $forum->context;
1771
1772         if ($forum->type == 'qanda'
1773             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1774             if (!empty($forum->onlydiscussions)) {
1775                 $discussionsids = implode(',', $forum->onlydiscussions);
1776                 $select[] = "(d.id IN ($discussionsids) OR p.parent = 0)";
1777             } else {
1778                 $select[] = "p.parent = 0";
1779             }
1780         }
1781
1782         if (!empty($forum->onlygroups)) {
1783             $groupids = implode(',', $forum->onlygroups);
1784             $select[] = "d.groupid IN ($groupids)";
1785         }
1786
1787         if ($select) {
1788             $selects = implode(" AND ", $select);
1789             $where[] = "(d.forum = $forumid AND $selects)";
1790         } else {
1791             $fullaccess[] = $forumid;
1792         }
1793     }
1794
1795     if ($fullaccess) {
1796         $fullids = implode(',', $fullaccess);
1797         $where[] = "(d.forum IN ($fullids))";
1798     }
1799
1800     $selectdiscussion = "(".implode(" OR ", $where).")";
1801
1802     // Some differences SQL
1803     $LIKE = sql_ilike();
1804     $NOTLIKE = 'NOT ' . $LIKE;
1805     if ($CFG->dbfamily == 'postgres') {
1806         $REGEXP = '~*';
1807         $NOTREGEXP = '!~*';
1808     } else {
1809         $REGEXP = 'REGEXP';
1810         $NOTREGEXP = 'NOT REGEXP';
1811     }
1812
1813     $messagesearch = '';
1814     $searchstring = '';
1815
1816     // Need to concat these back together for parser to work.
1817     foreach($searchterms as $searchterm){
1818         if ($searchstring != '') {
1819             $searchstring .= ' ';
1820         }
1821         $searchstring .= $searchterm;
1822     }
1823
1824     // We need to allow quoted strings for the search. The quotes *should* be stripped
1825     // by the parser, but this should be examined carefully for security implications.
1826     $searchstring = str_replace("\\\"","\"",$searchstring);
1827     $parser = new search_parser();
1828     $lexer = new search_lexer($parser);
1829
1830     if ($lexer->parse($searchstring)) {
1831         $parsearray = $parser->get_parsed_array();
1832     // Experimental feature under 1.8! MDL-8830
1833     // Use alternative text searches if defined
1834     // This feature only works under mysql until properly implemented for other DBs
1835     // Requires manual creation of text index for forum_posts before enabling it:
1836     // CREATE FULLTEXT INDEX foru_post_tix ON [prefix]forum_posts (subject, message)
1837     // Experimental feature under 1.8! MDL-8830
1838         if (!empty($CFG->forum_usetextsearches)) {
1839             $messagesearch = search_generate_text_SQL($parsearray, 'p.message', 'p.subject',
1840                                                  'p.userid', 'u.id', 'u.firstname',
1841                                                  'u.lastname', 'p.modified', 'd.forum');
1842         } else {
1843             $messagesearch = search_generate_SQL($parsearray, 'p.message', 'p.subject',
1844                                                  'p.userid', 'u.id', 'u.firstname',
1845                                                  'u.lastname', 'p.modified', 'd.forum');
1846         }
1847     }
1848
1849     $fromsql = "{$CFG->prefix}forum_posts p,
1850                   {$CFG->prefix}forum_discussions d,
1851                   {$CFG->prefix}user u";
1852
1853     $selectsql = " $messagesearch
1854                AND p.discussion = d.id
1855                AND p.userid = u.id
1856                AND $selectdiscussion
1857                    $extrasql";
1858
1859     $countsql = "SELECT COUNT(*)
1860                    FROM $fromsql
1861                   WHERE $selectsql";
1862
1863     $searchsql = "SELECT p.*,
1864                          d.forum,
1865                          u.firstname,
1866                          u.lastname,
1867                          u.email,
1868                          u.picture,
1869                          u.imagealt
1870                     FROM $fromsql
1871                    WHERE $selectsql
1872                 ORDER BY p.modified DESC";
1873
1874     $totalcount = count_records_sql($countsql);
1875
1876     return get_records_sql($searchsql, $limitfrom, $limitnum);
1877 }
1878
1879 /**
1880  * Returns a list of ratings for all posts in discussion
1881  * @param object $discussion
1882  * @return array of ratings or false
1883  */
1884 function forum_get_all_discussion_ratings($discussion) {
1885     global $CFG;
1886     return get_records_sql("SELECT r.id, r.userid, p.id AS postid, r.rating
1887                               FROM {$CFG->prefix}forum_ratings r,
1888                                    {$CFG->prefix}forum_posts p
1889                              WHERE r.post = p.id AND p.discussion = $discussion->id
1890                              ORDER BY p.id ASC");
1891 }
1892
1893 /**
1894  * Returns a list of ratings for one specific user for all posts in discussion
1895  * @global object $CFG
1896  * @param object $discussions the discussions for which we return all ratings
1897  * @param int $userid the user for who we return all ratings
1898  * @return object
1899  */
1900 function forum_get_all_user_ratings($userid, $discussions) {
1901     global $CFG;
1902
1903
1904     foreach ($discussions as $discussion) {
1905      if (!isset($discussionsid)){
1906          $discussionsid = $discussion->id;
1907      }
1908      else {
1909          $discussionsid .= ",".$discussion->id;
1910      }
1911     }
1912
1913     $sql = "SELECT r.id, r.userid, p.id AS postid, r.rating
1914                               FROM {$CFG->prefix}forum_ratings r,
1915                                    {$CFG->prefix}forum_posts p
1916                              WHERE r.post = p.id AND p.userid = $userid";
1917     //postgres compability
1918     if (!isset($discussionsid)) {
1919        $sql .=" AND p.discussion IN (".$discussionsid.")";
1920     }
1921     $sql .=" ORDER BY p.id ASC";
1922
1923     return get_records_sql($sql);
1924
1925
1926 }
1927
1928 /**
1929  * Returns a list of ratings for a particular post - sorted.
1930  * @param int $postid
1931  * @param string $sort
1932  * @return array of ratings or false
1933  */
1934 function forum_get_ratings($postid, $sort="u.firstname ASC") {
1935     global $CFG;
1936     return get_records_sql("SELECT u.*, r.rating, r.time
1937                               FROM {$CFG->prefix}forum_ratings r,
1938                                    {$CFG->prefix}user u
1939                              WHERE r.post = '$postid'
1940                                AND r.userid = u.id
1941                              ORDER BY $sort");
1942 }
1943
1944 /**
1945  * Returns a list of all new posts that have not been mailed yet
1946  * @param int $starttime - posts created after this time
1947  * @param int $endtime - posts created before this
1948  * @param int $now - used for timed discussions only
1949  */
1950 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
1951     global $CFG;
1952
1953     if (!empty($CFG->forum_enabletimedposts)) {
1954         if (empty($now)) {
1955             $now = time();
1956         }
1957         $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
1958     } else {
1959         $timedsql = "";
1960     }
1961
1962     return get_records_sql("SELECT p.*, d.course, d.forum
1963                               FROM {$CFG->prefix}forum_posts p
1964                                    JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
1965                              WHERE p.mailed = 0
1966                                    AND p.created >= $starttime
1967                                    AND (p.created < $endtime OR p.mailnow = 1)
1968                                    $timedsql
1969                           ORDER BY p.modified ASC");
1970 }
1971
1972 /**
1973  * Marks posts before a certain time as being mailed already
1974  */
1975 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
1976     global $CFG;
1977     if (empty($now)) {
1978         $now = time();
1979     }
1980
1981     if (empty($CFG->forum_enabletimedposts)) {
1982         return execute_sql("UPDATE {$CFG->prefix}forum_posts
1983                                SET mailed = '1'
1984                              WHERE (created < $endtime OR mailnow = 1)
1985                                    AND mailed = 0", false);
1986
1987     } else {
1988         return execute_sql("UPDATE {$CFG->prefix}forum_posts
1989                                SET mailed = '1'
1990                              WHERE discussion NOT IN (SELECT d.id
1991                                                         FROM {$CFG->prefix}forum_discussions d
1992                                                        WHERE d.timestart > $now)
1993                                    AND (created < $endtime OR mailnow = 1)
1994                                    AND mailed = 0", false);
1995     }
1996 }
1997
1998 /**
1999  * Get all the posts for a user in a forum suitable for forum_print_post
2000  */
2001 function forum_get_user_posts($forumid, $userid) {
2002     global $CFG;
2003
2004     $timedsql = "";
2005     if (!empty($CFG->forum_enabletimedposts)) {
2006         $cm = get_coursemodule_from_instance('forum', $forumid);
2007         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2008             $now = time();
2009             $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
2010         }
2011     }
2012
2013     return get_records_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
2014                               FROM {$CFG->prefix}forum f
2015                                    JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
2016                                    JOIN {$CFG->prefix}forum_posts p       ON p.discussion = d.id
2017                                    JOIN {$CFG->prefix}user u              ON u.id = p.userid
2018                              WHERE f.id = $forumid
2019                                    AND p.userid = $userid
2020                                    $timedsql
2021                           ORDER BY p.modified ASC");
2022 }
2023
2024 /**
2025  * Get all the discussions user participated in
2026  * @param int $forumid
2027  * @param int $userid
2028  * @return array or false
2029  */
2030 function forum_get_user_involved_discussions($forumid, $userid) {
2031     global $CFG;
2032
2033     $timedsql = "";
2034     if (!empty($CFG->forum_enabletimedposts)) {
2035         $cm = get_coursemodule_from_instance('forum', $forumid);
2036         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2037             $now = time();
2038             $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
2039         }
2040     }
2041
2042     return get_records_sql("SELECT DISTINCT d.*
2043                               FROM {$CFG->prefix}forum f
2044                                    JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
2045                                    JOIN {$CFG->prefix}forum_posts p       ON p.discussion = d.id
2046                              WHERE f.id = $forumid
2047                                    AND p.userid = $userid
2048                                    $timedsql");
2049 }
2050
2051 /**
2052  * Get all the posts for a user in a forum suitable for forum_print_post
2053  * @param int $forumid
2054  * @param int $userid
2055  * @return array of counts or false
2056  */
2057 function forum_count_user_posts($forumid, $userid) {
2058     global $CFG;
2059
2060     $timedsql = "";
2061     if (!empty($CFG->forum_enabletimedposts)) {
2062         $cm = get_coursemodule_from_instance('forum', $forumid);
2063         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2064             $now = time();
2065             $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
2066         }
2067     }
2068
2069     return get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2070                              FROM {$CFG->prefix}forum f
2071                                   JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
2072                                   JOIN {$CFG->prefix}forum_posts p       ON p.discussion = d.id
2073                                   JOIN {$CFG->prefix}user u              ON u.id = p.userid
2074                             WHERE f.id = $forumid
2075                                   AND p.userid = $userid
2076                                   $timedsql");
2077 }
2078
2079 /**
2080  * Given a log entry, return the forum post details for it.
2081  */
2082 function forum_get_post_from_log($log) {
2083     global $CFG;
2084
2085     if ($log->action == "add post") {
2086
2087         return get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
2088                                            u.firstname, u.lastname, u.email, u.picture
2089                                  FROM {$CFG->prefix}forum_discussions d,
2090                                       {$CFG->prefix}forum_posts p,
2091                                       {$CFG->prefix}forum f,
2092                                       {$CFG->prefix}user u
2093                                 WHERE p.id = '$log->info'
2094                                   AND d.id = p.discussion
2095                                   AND p.userid = u.id
2096                                   AND u.deleted <> '1'
2097                                   AND f.id = d.forum");
2098
2099
2100     } else if ($log->action == "add discussion") {
2101
2102         return get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
2103                                            u.firstname, u.lastname, u.email, u.picture
2104                                  FROM {$CFG->prefix}forum_discussions d,
2105                                       {$CFG->prefix}forum_posts p,
2106                                       {$CFG->prefix}forum f,
2107                                       {$CFG->prefix}user u
2108                                 WHERE d.id = '$log->info'
2109                                   AND d.firstpost = p.id
2110                                   AND p.userid = u.id
2111                                   AND u.deleted <> '1'
2112                                   AND f.id = d.forum");
2113     }
2114     return NULL;
2115 }
2116
2117 /**
2118  * Given a discussion id, return the first post from the discussion
2119  */
2120 function forum_get_firstpost_from_discussion($discussionid) {
2121     global $CFG;
2122
2123     return get_record_sql("SELECT p.*
2124                              FROM {$CFG->prefix}forum_discussions d,
2125                                   {$CFG->prefix}forum_posts p
2126                             WHERE d.id = '$discussionid'
2127                               AND d.firstpost = p.id ");
2128 }
2129
2130 /**
2131  * Returns an array of counts of replies to each discussion
2132  */
2133 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2134     global $CFG;
2135
2136     if ($limit > 0) {
2137         $limitfrom = 0;
2138         $limitnum  = $limit;
2139     } else if ($page != -1) {
2140         $limitfrom = $page*$perpage;
2141         $limitnum  = $perpage;
2142     } else {
2143         $limitfrom = 0;
2144         $limitnum  = 0;
2145     }
2146
2147     if ($forumsort == "") {
2148         $orderby = "";
2149         $groupby = "";
2150
2151     } else {
2152         $orderby = "ORDER BY $forumsort";
2153         $groupby = ", ".strtolower($forumsort);
2154         $groupby = str_replace('desc', '', $groupby);
2155         $groupby = str_replace('asc', '', $groupby);
2156     }
2157
2158     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2159         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2160                   FROM {$CFG->prefix}forum_posts p
2161                        JOIN {$CFG->prefix}forum_discussions d ON p.discussion = d.id
2162                  WHERE p.parent > 0 AND d.forum = $forumid
2163               GROUP BY p.discussion";
2164         return get_records_sql($sql);
2165
2166     } else {
2167         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2168                   FROM {$CFG->prefix}forum_posts p
2169                        JOIN {$CFG->prefix}forum_discussions d ON p.discussion = d.id
2170                  WHERE d.forum = $forumid
2171               GROUP BY p.discussion $groupby
2172               $orderby";
2173         return get_records_sql("SELECT * FROM ($sql) sq", $limitfrom, $limitnum);
2174     }
2175 }
2176
2177 function forum_count_discussions($forum, $cm, $course) {
2178     global $CFG, $USER;
2179
2180     static $cache = array();
2181
2182     $now = round(time(), -2); // db cache friendliness
2183
2184     if (!isset($cache[$course->id])) {
2185         if (!empty($CFG->forum_enabletimedposts)) {
2186             $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2187         } else {
2188             $timedsql = "";
2189         }
2190
2191         $sql = "SELECT f.id, COUNT(d.id) as dcount
2192                   FROM {$CFG->prefix}forum f
2193                        JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
2194                  WHERE f.course = $course->id
2195                        $timedsql
2196               GROUP BY f.id";
2197
2198         if ($counts = get_records_sql($sql)) {
2199             foreach ($counts as $count) {
2200                 $counts[$count->id] = $count->dcount;
2201             }
2202             $cache[$course->id] = $counts;
2203         } else {
2204             $cache[$course->id] = array();
2205         }
2206     }
2207
2208     if (empty($cache[$course->id][$forum->id])) {
2209         return 0;
2210     }
2211
2212     $groupmode = groups_get_activity_groupmode($cm, $course);
2213
2214     if ($groupmode != SEPARATEGROUPS) {
2215         return $cache[$course->id][$forum->id];
2216     }
2217
2218     if (has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2219         return $cache[$course->id][$forum->id];
2220     }
2221
2222     require_once($CFG->dirroot.'/course/lib.php');
2223
2224     $modinfo =& get_fast_modinfo($course);
2225     if (is_null($modinfo->groups)) {
2226         $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
2227     }
2228
2229     if (empty($CFG->enablegroupings)) {
2230         $mygroups = $modinfo->groups[0];
2231     } else {
2232         $mygroups = $modinfo->groups[$cm->groupingid];
2233     }
2234
2235     // add all groups posts
2236     if (empty($mygroups)) {
2237         $mygroups = array(-1=>-1);
2238     } else {
2239         $mygroups[-1] = -1;
2240     }
2241     $mygroups = implode(',', $mygroups);
2242
2243     if (!empty($CFG->forum_enabletimedposts)) {
2244         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2245     } else {
2246         $timedsql = "";
2247     }
2248
2249     $sql = "SELECT COUNT(d.id)
2250               FROM {$CFG->prefix}forum_discussions d
2251              WHERE d.forum = $forum->id AND d.groupid IN ($mygroups)
2252                    $timedsql";
2253
2254     return get_field_sql($sql);
2255 }
2256
2257 /**
2258  * How many unrated posts are in the given discussion for a given user?
2259  */
2260 function forum_count_unrated_posts($discussionid, $userid) {
2261     global $CFG;
2262     if ($posts = get_record_sql("SELECT count(*) as num
2263                                    FROM {$CFG->prefix}forum_posts
2264                                   WHERE parent > 0
2265                                     AND discussion = '$discussionid'
2266                                     AND userid <> '$userid' ")) {
2267
2268         if ($rated = get_record_sql("SELECT count(*) as num
2269                                        FROM {$CFG->prefix}forum_posts p,
2270                                             {$CFG->prefix}forum_ratings r
2271                                       WHERE p.discussion = '$discussionid'
2272                                         AND p.id = r.post
2273                                         AND r.userid = '$userid'")) {
2274             $difference = $posts->num - $rated->num;
2275             if ($difference > 0) {
2276                 return $difference;
2277             } else {
2278                 return 0;    // Just in case there was a counting error
2279             }
2280         } else {
2281             return $posts->num;
2282         }
2283     } else {
2284         return 0;
2285     }
2286 }
2287
2288 /**
2289  * Get all discussions in a forum
2290  */
2291 function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
2292     global $CFG, $USER;
2293
2294     $timelimit = '';
2295
2296     $modcontext = null;
2297
2298     $now = round(time(), -2);
2299
2300     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2301
2302     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2303         return array();
2304     }
2305
2306     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2307
2308         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2309             $timelimit = " AND ((d.timestart <= $now AND (d.timeend = 0 OR d.timeend > $now))";
2310             if (isloggedin()) {
2311                 $timelimit .= " OR d.userid = $USER->id";
2312             }
2313             $timelimit .= ")";
2314         }
2315     }
2316
2317     if ($limit > 0) {
2318         $limitfrom = 0;
2319         $limitnum  = $limit;
2320     } else if ($page != -1) {
2321         $limitfrom = $page*$perpage;
2322         $limitnum  = $perpage;
2323     } else {
2324         $limitfrom = 0;
2325         $limitnum  = 0;
2326     }
2327
2328     $groupmode    = groups_get_activity_groupmode($cm);
2329     $currentgroup = groups_get_activity_group($cm);
2330
2331     if ($groupmode) {
2332         if (empty($modcontext)) {
2333             $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2334         }
2335
2336         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2337             if ($currentgroup) {
2338                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2339             } else {
2340                 $groupselect = "";
2341             }
2342
2343         } else {
2344             //seprate groups without access all
2345             if ($currentgroup) {
2346                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2347             } else {
2348                 $groupselect = "AND d.groupid = -1";
2349             }
2350         }
2351     } else {
2352         $groupselect = "";
2353     }
2354
2355
2356     if (empty($forumsort)) {
2357         $forumsort = "d.timemodified DESC";
2358     }
2359     if (empty($fullpost)) {
2360         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2361     } else {
2362         $postdata = "p.*";
2363     }
2364
2365     if (empty($userlastmodified)) {  // We don't need to know this
2366         $umfields = "";
2367         $umtable  = "";
2368     } else {
2369         $umfields = ", um.firstname AS umfirstname, um.lastname AS umlastname";
2370         $umtable  = " LEFT JOIN {$CFG->prefix}user um ON (d.usermodified = um.id)";
2371     }
2372
2373     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend,
2374                    u.firstname, u.lastname, u.email, u.picture, u.imagealt $umfields
2375               FROM {$CFG->prefix}forum_discussions d
2376                    JOIN {$CFG->prefix}forum_posts p ON p.discussion = d.id
2377                    JOIN {$CFG->prefix}user u ON p.userid = u.id
2378                    $umtable
2379              WHERE d.forum = {$cm->instance} AND p.parent = 0
2380                    $timelimit $groupselect
2381           ORDER BY $forumsort";
2382     return get_records_sql($sql, $limitfrom, $limitnum);
2383 }
2384
2385 function forum_get_discussions_unread($cm) {
2386     global $CFG, $USER;
2387
2388     $now = round(time(), -2);
2389
2390     $groupmode    = groups_get_activity_groupmode($cm);
2391     $currentgroup = groups_get_activity_group($cm);
2392
2393     if ($groupmode) {
2394         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2395
2396         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2397             if ($currentgroup) {
2398                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2399             } else {
2400                 $groupselect = "";
2401             }
2402
2403         } else {
2404             //seprate groups without access all
2405             if ($currentgroup) {
2406                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2407             } else {
2408                 $groupselect = "AND d.groupid = -1";
2409             }
2410         }
2411     } else {
2412         $groupselect = "";
2413     }
2414
2415     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2416
2417     if (!empty($CFG->forum_enabletimedposts)) {
2418         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2419     } else {
2420         $timedsql = "";
2421     }
2422
2423     $sql = "SELECT d.id, COUNT(p.id) AS unread
2424               FROM {$CFG->prefix}forum_discussions d
2425                    JOIN {$CFG->prefix}forum_posts p     ON p.discussion = d.id
2426                    LEFT JOIN {$CFG->prefix}forum_read r ON (r.postid = p.id AND r.userid = $USER->id)
2427              WHERE d.forum = {$cm->instance}
2428                    AND p.modified >= $cutoffdate AND r.id is NULL
2429                    $timedsql
2430                    $groupselect
2431           GROUP BY d.id";
2432     if ($unreads = get_records_sql($sql)) {
2433         foreach ($unreads as $unread) {
2434             $unreads[$unread->id] = $unread->unread;
2435         }
2436         return $unreads;
2437     } else {
2438         return array();
2439     }
2440 }
2441
2442 function forum_get_discussions_count($cm) {
2443     global $CFG, $USER;
2444
2445     $now = round(time(), -2);
2446
2447     $groupmode    = groups_get_activity_groupmode($cm);
2448     $currentgroup = groups_get_activity_group($cm);
2449
2450     if ($groupmode) {
2451         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2452
2453         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2454             if ($currentgroup) {
2455                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2456             } else {
2457                 $groupselect = "";
2458             }
2459
2460         } else {
2461             //seprate groups without access all
2462             if ($currentgroup) {
2463                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2464             } else {
2465                 $groupselect = "AND d.groupid = -1";
2466             }
2467         }
2468     } else {
2469         $groupselect = "";
2470     }
2471
2472     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2473
2474     $timelimit = "";
2475
2476     if (!empty($CFG->forum_enabletimedposts)) {
2477
2478         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2479
2480         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2481             $timelimit = " AND ((d.timestart <= $now AND (d.timeend = 0 OR d.timeend > $now))";
2482             if (isloggedin()) {
2483                 $timelimit .= " OR d.userid = $USER->id";
2484             }
2485             $timelimit .= ")";
2486         }
2487     }
2488
2489     $sql = "SELECT COUNT(d.id)
2490               FROM {$CFG->prefix}forum_discussions d
2491                    JOIN {$CFG->prefix}forum_posts p ON p.discussion = d.id
2492              WHERE d.forum = {$cm->instance} AND p.parent = 0
2493                    $timelimit $groupselect";
2494
2495     return get_field_sql($sql);
2496 }
2497
2498
2499 /**
2500  * Get all discussions started by a particular user in a course (or group)
2501  * This function no longer used ...
2502  */
2503 function forum_get_user_discussions($courseid, $userid, $groupid=0) {
2504     global $CFG;
2505
2506     if ($groupid) {
2507         $groupselect = " AND d.groupid = '$groupid' ";
2508     } else  {
2509         $groupselect = "";
2510     }
2511
2512     return get_records_sql("SELECT p.*, d.groupid, u.firstname, u.lastname, u.email, u.picture, u.imagealt,
2513                                    f.type as forumtype, f.name as forumname, f.id as forumid
2514                               FROM {$CFG->prefix}forum_discussions d,
2515                                    {$CFG->prefix}forum_posts p,
2516                                    {$CFG->prefix}user u,
2517                                    {$CFG->prefix}forum f
2518                              WHERE d.course = '$courseid'
2519                                AND p.discussion = d.id
2520                                AND p.parent = 0
2521                                AND p.userid = u.id
2522                                AND u.id = '$userid'
2523                                AND d.forum = f.id $groupselect
2524                           ORDER BY p.created DESC");
2525 }
2526
2527 /**
2528  * Get the list of potential subscribers to a forum.
2529  *
2530  * @param object $forumcontext the forum context.
2531  * @param integer $groupid the id of a group, or 0 for all groups.
2532  * @param string $fields the list of fields to return for each user. As for get_users_by_capability.
2533  * @param string $sort sort order. As for get_users_by_capability.
2534  * @return array list of users.
2535  */
2536 function forum_get_potential_subscribers($forumcontext, $groupid, $fields, $sort) {
2537     return get_users_by_capability($forumcontext, 'mod/forum:initialsubscriptions', $fields, $sort, '', '', $groupid, '', false, true);
2538 }
2539
2540 /**
2541  * Returns list of user objects that are subscribed to this forum
2542  *
2543  * @param object $course the course
2544  * @param forum $forum the forum
2545  * @param integer $groupid group id, or 0 for all.
2546  * @param object $context the forum context, to save re-fetching it where possible.
2547  * @return array list of users.
2548  */
2549 function forum_subscribed_users($course, $forum, $groupid=0, $context = NULL) {
2550     global $CFG;
2551
2552     if ($groupid) {
2553         $grouptables = ", {$CFG->prefix}groups_members gm ";
2554         $groupselect = "AND gm.groupid = $groupid AND u.id = gm.userid";
2555
2556     } else  {
2557         $grouptables = '';
2558         $groupselect = '';
2559     }
2560
2561     if (forum_is_forcesubscribed($forum)) {
2562         if (empty($context)) {
2563             $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id);
2564             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2565         }
2566         $sort = "u.email ASC";
2567         $fields ="u.id, u.username, u.firstname, u.lastname, u.maildisplay, u.mailformat, u.maildigest, u.emailstop, u.imagealt,
2568                   u.email, u.city, u.country, u.lastaccess, u.lastlogin, u.picture, u.timezone, u.theme, u.lang, u.trackforums, u.mnethostid";
2569         $results = forum_get_potential_subscribers($context, $groupid, $fields, $sort);
2570     } else {
2571         $results = get_records_sql("SELECT u.id, u.username, u.firstname, u.lastname, u.maildisplay, u.mailformat, u.maildigest, u.emailstop, u.imagealt,
2572                                    u.email, u.city, u.country, u.lastaccess, u.lastlogin, u.picture, u.timezone, u.theme, u.lang, u.trackforums, u.mnethostid
2573                               FROM {$CFG->prefix}user u,
2574                                    {$CFG->prefix}forum_subscriptions s $grouptables
2575                              WHERE s.forum = '$forum->id'
2576                                AND s.userid = u.id
2577                                AND u.deleted = 0  $groupselect
2578                           ORDER BY u.email ASC");
2579     }
2580
2581     static $guestid = null;
2582
2583     if (is_null($guestid)) {
2584         if ($guest = guest_user()) {
2585             $guestid = $guest->id;
2586         } else {
2587             $guestid = 0;
2588         }
2589     }
2590
2591     // Guest user should never be subscribed to a forum.
2592     unset($results[$guestid]);
2593
2594     return $results;
2595 }
2596
2597
2598
2599 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2600
2601
2602 function forum_get_course_forum($courseid, $type) {
2603 // How to set up special 1-per-course forums
2604     global $CFG;
2605
2606     if ($forums = get_records_select("forum", "course = '$courseid' AND type = '$type'", "id ASC")) {
2607         // There should always only be ONE, but with the right combination of
2608         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2609         foreach ($forums as $forum) {
2610             return $forum;   // ie the first one
2611         }
2612     }
2613
2614     // Doesn't exist, so create one now.
2615     $forum->course = $courseid;
2616     $forum->type = "$type";
2617     switch ($forum->type) {
2618         case "news":
2619             $forum->name  = addslashes(get_string("namenews", "forum"));
2620             $forum->intro = addslashes(get_string("intronews", "forum"));
2621             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2622             $forum->assessed = 0;
2623             if ($courseid == SITEID) {
2624                 $forum->name  = get_string("sitenews");
2625                 $forum->forcesubscribe = 0;
2626             }
2627             break;
2628         case "social":
2629             $forum->name  = addslashes(get_string("namesocial", "forum"));
2630             $forum->intro = addslashes(get_string("introsocial", "forum"));
2631             $forum->assessed = 0;
2632             $forum->forcesubscribe = 0;
2633             break;
2634         default:
2635             notify("That forum type doesn't exist!");
2636             return false;
2637             break;
2638     }
2639
2640     $forum->timemodified = time();
2641     $forum->id = insert_record("forum", $forum);
2642
2643     if (! $module = get_record("modules", "name", "forum")) {
2644         notify("Could not find forum module!!");
2645         return false;
2646     }
2647     $mod = new object();
2648     $mod->course = $courseid;
2649     $mod->module = $module->id;
2650     $mod->instance = $forum->id;
2651     $mod->section = 0;
2652     if (! $mod->coursemodule = add_course_module($mod) ) {   // assumes course/lib.php is loaded
2653         notify("Could not add a new course module to the course '" . format_string($course->fullname) . "'");
2654         return false;
2655     }
2656     if (! $sectionid = add_mod_to_section($mod) ) {   // assumes course/lib.php is loaded
2657         notify("Could not add the new course module to that section");
2658         return false;
2659     }
2660     if (! set_field("course_modules", "section", $sectionid, "id", $mod->coursemodule)) {
2661         notify("Could not update the course module with the correct section");
2662         return false;
2663     }
2664     include_once("$CFG->dirroot/course/lib.php");
2665     rebuild_course_cache($courseid);
2666
2667     return get_record("forum", "id", "$forum->id");
2668 }
2669
2670
2671 /**
2672 * Given the data about a posting, builds up the HTML to display it and
2673 * returns the HTML in a string.  This is designed for sending via HTML email.
2674 */
2675 function forum_make_mail_post($course, $forum, $discussion, $post, $userfrom, $userto,
2676                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
2677
2678     global $CFG;
2679
2680     if (!isset($userto->viewfullnames[$forum->id])) {
2681         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
2682             error('Course Module ID was incorrect');
2683         }
2684         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2685         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
2686     } else {
2687         $viewfullnames = $userto->viewfullnames[$forum->id];
2688     }
2689
2690     // format the post body
2691     $options = new object();
2692     $options->para = true;
2693     $formattedtext = format_text(trusttext_strip($post->message), $post->format, $options, $course->id);
2694
2695     $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
2696
2697     $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
2698     $output .= print_user_picture($userfrom, $course->id, $userfrom->picture, false, true);
2699     $output .= '</td>';
2700
2701     if ($post->parent) {
2702         $output .= '<td class="topic">';
2703     } else {
2704         $output .= '<td class="topic starter">';
2705     }
2706     $output .= '<div class="subject">'.format_string($post->subject).'</div>';
2707
2708     $fullname = fullname($userfrom, $viewfullnames);
2709     $by = new object();
2710     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
2711     $by->date = userdate($post->modified, '', $userto->timezone);
2712     $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
2713
2714     $output .= '</td></tr>';
2715
2716     $output .= '<tr><td class="left side" valign="top">';
2717
2718     if (isset($userfrom->groups)) {
2719         $groups = $userfrom->groups[$forum->id];
2720     } else {
2721         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
2722             error('Course Module ID was incorrect');
2723         }
2724         $group = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
2725     }
2726
2727     if ($groups) {
2728         $output .= print_group_picture($groups, $course->id, false, true, true);
2729     } else {
2730         $output .= '&nbsp;';
2731     }
2732
2733     $output .= '</td><td class="content">';
2734
2735     if ($post->attachment) {
2736         $post->course = $course->id;
2737         $output .= '<div class="attachments">';
2738         $output .= forum_print_attachments($post, 'html');
2739         $output .= "</div>";
2740     }
2741
2742     $output .= $formattedtext;
2743
2744 // Commands
2745     $commands = array();
2746
2747     if ($post->parent) {
2748         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2749                       $post->discussion.'&amp;parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
2750     }
2751
2752     if ($reply) {
2753         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
2754                       get_string('reply', 'forum').'</a>';
2755     }
2756
2757     $output .= '<div class="commands">';
2758     $output .= implode(' | ', $commands);
2759     $output .= '</div>';
2760
2761 // Context link to post if required
2762     if ($link) {
2763         $output .= '<div class="link">';
2764         $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
2765                      get_string('postincontext', 'forum').'</a>';
2766         $output .= '</div>';
2767     }
2768
2769     if ($footer) {
2770         $output .= '<div class="footer">'.$footer.'</div>';
2771     }
2772     $output .= '</td></tr></table>'."\n\n";
2773
2774     return $output;
2775 }
2776
2777 /**
2778  * Print a forum post
2779  *
2780  * @param object $post The post to print.
2781  * @param integer $courseid The course this post belongs to.
2782  * @param boolean $ownpost Whether this post belongs to the current user.
2783  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
2784  * @param boolean $link Just print a shortened version of the post as a link to the full post.
2785  * @param object $ratings -- I don't really know --
2786  * @param string $footer Extra stuff to print after the message.
2787  * @param string $highlight Space-separated list of terms to highlight.
2788  * @param int $post_read true, false or -99. If we already know whether this user
2789  *          has read this post, pass that in, otherwise, pass in -99, and this
2790  *          function will work it out.
2791  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
2792  *          the current user can't see this post, if this argument is true
2793  *          (the default) then print a dummy 'you can't see this post' post.
2794  *          If false, don't output anything at all.
2795  */
2796 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
2797                           $ratings=NULL, $footer="", $highlight="", $post_read=null, $dummyifcantsee=true, $istracked=null) {
2798
2799     global $USER, $CFG;
2800
2801     static $stredit, $strdelete, $strreply, $strparent, $strprune;
2802     static $strpruneheading, $displaymode;
2803     static $strmarkread, $strmarkunread;
2804
2805     $post->course = $course->id;
2806     $post->forum  = $forum->id;
2807
2808     // caching
2809     if (!isset($cm->cache)) {
2810         $cm->cache = new object();
2811     }
2812
2813     if (!isset($cm->cache->caps)) {
2814         $cm->cache->caps = array();
2815         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2816         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
2817         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
2818         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
2819         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
2820         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
2821         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
2822         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
2823     }
2824
2825     if (!isset($cm->uservisible)) {
2826         $cm->uservisible = coursemodule_visible_for_user($cm);
2827     }
2828
2829     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
2830         if (!$dummyifcantsee) {
2831             return;
2832         }
2833         echo '<a id="p'.$post->id.'"></a>';
2834         echo '<table cellspacing="0" class="forumpost">';
2835         echo '<tr class="header"><td class="picture left">';
2836         //        print_user_picture($post->userid, $courseid, $post->picture);
2837         echo '</td>';
2838         if ($post->parent) {
2839             echo '<td class="topic">';
2840         } else {
2841             echo '<td class="topic starter">';
2842         }
2843         echo '<div class="subject">'.get_string('forumsubjecthidden','forum').'</div>';
2844         echo '<div class="author">';
2845         print_string('forumauthorhidden','forum');
2846         echo '</div></td></tr>';
2847
2848         echo '<tr><td class="left side">';
2849         echo '&nbsp;';
2850
2851         // Actual content
2852
2853         echo '</td><td class="content">'."\n";
2854         echo get_string('forumbodyhidden','forum');
2855         echo '</td></tr></table>';
2856         return;
2857     }
2858
2859     if (empty($stredit)) {
2860         $stredit         = get_string('edit', 'forum');
2861         $strdelete       = get_string('delete', 'forum');
2862         $strreply        = get_string('reply', 'forum');
2863         $strparent       = get_string('parent', 'forum');
2864         $strpruneheading = get_string('pruneheading', 'forum');
2865         $strprune        = get_string('prune', 'forum');
2866         $displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
2867         $strmarkread     = get_string('markread', 'forum');
2868         $strmarkunread   = get_string('markunread', 'forum');
2869
2870     }
2871
2872     $read_style = '';
2873     // ignore trackign status if not tracked or tracked param missing
2874     if ($istracked) {
2875         if (is_null($post_read)) {
2876             debugging('fetching post_read info');
2877             $post_read = forum_tp_is_post_read($USER->id, $post);
2878         }
2879
2880         if ($post_read) {
2881             $read_style = ' read';
2882         } else {
2883             $read_style = ' unread';
2884             echo '<a name="unread"></a>';
2885         }
2886     }
2887
2888     echo '<a id="p'.$post->id.'"></a>';
2889     echo '<table cellspacing="0" class="forumpost'.$read_style.'">';
2890
2891     // Picture
2892     $postuser = new object();
2893     $postuser->id        = $post->userid;
2894     $postuser->firstname = $post->firstname;
2895     $postuser->lastname  = $post->lastname;
2896     $postuser->imagealt  = $post->imagealt;
2897     $postuser->picture   = $post->picture;
2898
2899     echo '<tr class="header"><td class="picture left">';
2900     print_user_picture($postuser, $course->id);
2901     echo '</td>';
2902
2903     if ($post->parent) {
2904         echo '<td class="topic">';
2905     } else {
2906         echo '<td class="topic starter">';
2907     }
2908
2909     if (!empty($post->subjectnoformat)) {
2910         echo '<div class="subject">'.$post->subject.'</div>';
2911     } else {
2912         echo '<div class="subject">'.format_string($post->subject).'</div>';
2913     }
2914
2915     echo '<div class="author">';
2916     $fullname = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
2917     $by = new object();
2918     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.
2919                 $post->userid.'&amp;course='.$course->id.'">'.$fullname.'</a>';
2920     $by->date = userdate($post->modified);
2921     print_string('bynameondate', 'forum', $by);
2922     echo '</div></td></tr>';
2923
2924     echo '<tr><td class="left side">';
2925     if (isset($cm->cache->usersgroups)) {
2926         $groups = array();
2927         if (isset($cm->cache->usersgroups[$post->userid])) {
2928             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
2929                 $groups[$gid] = $cm->cache->groups[$gid];
2930             }
2931         }
2932     } else {
2933         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
2934     }
2935
2936     if ($groups) {
2937         print_group_picture($groups, $course->id, false, false, true);
2938     } else {
2939         echo '&nbsp;';
2940     }
2941
2942 // Actual content
2943
2944     echo '</td><td class="content">'."\n";
2945
2946     if ($post->attachment) {
2947         echo '<div class="attachments">';
2948         $attachedimages = forum_print_attachments($post);
2949         echo '</div>';
2950     } else {
2951         $attachedimages = '';
2952     }
2953
2954
2955     $options = new object();
2956     $options->para      = false;
2957     $options->trusttext = true;
2958     if ($link and (strlen(strip_tags($post->message)) > $CFG->forum_longpost)) {
2959         // Print shortened version
2960         echo format_text(forum_shorten_post($post->message), $post->format, $options, $course->id);
2961         $numwords = count_words(strip_tags($post->message));
2962         echo '<div class="posting"><a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
2963         echo get_string('readtherest', 'forum');
2964         echo '</a> ('.get_string('numwords', '', $numwords).')...</div>';
2965     } else {
2966         // Print whole message
2967         echo '<div class="posting">';
2968         if ($highlight) {
2969             echo highlight($highlight, format_text($post->message, $post->format, $options, $course->id));
2970         } else {
2971             echo format_text($post->message, $post->format, $options, $course->id);
2972         }
2973         echo '</div>';
2974         echo $attachedimages;
2975     }
2976
2977
2978 // Commands
2979
2980     $commands = array();
2981
2982     if ($istracked) {
2983         // SPECIAL CASE: The front page can display a news item post to non-logged in users.
2984         // Don't display the mark read / unread controls in this case.
2985         if ($CFG->forum_usermarksread and isloggedin()) {
2986             if ($post_read) {
2987                 $mcmd = '&amp;mark=unread&amp;postid='.$post->id;
2988                 $mtxt = $strmarkunread;
2989             } else {
2990                 $mcmd = '&amp;mark=read&amp;postid='.$post->id;
2991                 $mtxt = $strmarkread;
2992             }
2993             if ($displaymode == FORUM_MODE_THREADED) {
2994                 $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2995                               $post->discussion.'&amp;parent='.$post->id.$mcmd.'">'.$mtxt.'</a>';
2996             } else {
2997                 $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2998                               $post->discussion.$mcmd.'#p'.$post->id.'">'.$mtxt.'</a>';
2999             }
3000         }
3001     }
3002
3003     if ($post->parent) {  // Zoom in to the parent specifically
3004         if ($displaymode == FORUM_MODE_THREADED) {
3005             $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
3006                       $post->discussion.'&amp;parent='.$post->parent.'">'.$strparent.'</a>';
3007         } else {
3008             $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
3009                       $post->discussion.'#p'.$post->parent.'">'.$strparent.'</a>';
3010         }
3011     }
3012
3013     $age = time() - $post->created;
3014     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3015     if (!$post->parent and $forum->type == 'news' and $discussion->timestart > time()) {
3016         $age = 0;
3017     }
3018     $editanypost = $cm->cache->caps['mod/forum:editanypost'];
3019
3020     if ($ownpost or $editanypost) {
3021         if (($age < $CFG->maxeditingtime) or $editanypost) {
3022             $commands[] =  '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?edit='.$post->id.'">'.$stredit.'</a>';
3023         }
3024     }
3025
3026     if ($cm->cache->caps['mod/forum:splitdiscussions']
3027                 && $post->parent && $forum->type != 'single') {
3028
3029         $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?prune='.$post->id.
3030                       '" title="'.$strpruneheading.'">'.$strprune.'</a>';
3031     }
3032
3033     if (($ownpost and $age < $CFG->maxeditingtime
3034                 and $cm->cache->caps['mod/forum:deleteownpost'])
3035                 or $cm->cache->caps['mod/forum:deleteanypost']) {
3036         $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?delete='.$post->id.'">'.$strdelete.'</a>';
3037     }
3038
3039     if ($reply) {
3040         $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.$strreply.'</a>';
3041     }
3042
3043     echo '<div class="commands">';
3044     echo implode(' | ', $commands);
3045     echo '</div>';
3046
3047
3048 // Ratings
3049
3050     $ratingsmenuused = false;
3051     if (!empty($ratings) and isloggedin()) {
3052         echo '<div class="ratings">';
3053         $useratings = true;
3054         if ($ratings->assesstimestart and $ratings->assesstimefinish) {
3055             if ($post->created < $ratings->assesstimestart or $post->created > $ratings->assesstimefinish) {
3056                 $useratings = false;
3057             }
3058         }
3059         if ($useratings) {
3060             $mypost = ($USER->id == $post->userid);
3061
3062             $canviewallratings = $cm->cache->caps['mod/forum:viewanyrating'];
3063
3064             if (isset($cm->cache->ratings)) {
3065                 if (isset($cm->cache->ratings[$post->id])) {
3066                     $allratings = $cm->cache->ratings[$post->id];
3067                 } else {
3068                     $allratings = array(); // no reatings present yet
3069                 }
3070             } else {
3071                 $allratings = NULL; // not preloaded
3072             }
3073
3074             if (isset($cm->cache->myratings)) {
3075                 if (isset($cm->cache->myratings[$post->id])) {
3076                     $myrating = $cm->cache->myratings[$post->id];
3077                 } else {
3078                     $myrating = FORUM_UNSET_POST_RATING; // no reatings present yet
3079                 }
3080             } else {
3081                 $myrating = NULL; // not preloaded
3082             }
3083
3084             if ($canviewallratings and !$mypost) {
3085                 echo '<span class="forumpostratingtext">' .
3086                      forum_print_ratings($post->id, $ratings->scale, $forum->assessed, $canviewallratings, $allratings, true) .
3087                      '</span>';
3088                 if (!empty($ratings->allow)) {
3089                     echo '&nbsp;';
3090                     forum_print_rating_menu($post->id, $USER->id, $ratings->scale, $myrating);
3091                     $ratingsmenuused = true;
3092                 }
3093
3094             } else if ($mypost) {
3095                 echo '<span class="forumpostratingtext">' .
3096                      forum_print_ratings($post->id, $ratings->scale, $forum->assessed, true, $allratings, true) .
3097                      '</span>';
3098
3099             } else if (!empty($ratings->allow) ) {
3100                 forum_print_rating_menu($post->id, $USER->id, $ratings->scale, $myrating);
3101                 $ratingsmenuused = true;
3102             }
3103         }
3104         echo '</div>';
3105     }
3106
3107 // Link to post if required
3108
3109     if ($link) {
3110         echo '<div class="link">';
3111         if ($post->replies == 1) {
3112             $replystring = get_string('repliesone', 'forum', $post->replies);
3113         } else {
3114             $replystring = get_string('repliesmany', 'forum', $post->replies);
3115         }
3116         echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">'.
3117              get_string('discussthistopic', 'forum').'</a>&nbsp;('.$replystring.')';
3118         echo '</div>';
3119     }
3120
3121     if ($footer) {
3122         echo '<div class="footer">'.$footer.'</div>';
3123     }
3124     echo '</td></tr></table>'."\n\n";
3125
3126     if ($istracked && !$CFG->forum_usermarksread && !$post_read) {
3127         forum_tp_mark_post_read($USER->id, $post, $forum->id);
3128     }
3129
3130     return $ratingsmenuused;
3131 }
3132
3133
3134 /**
3135  * This function prints the overview of a discussion in the forum listing.
3136  * It needs some discussion information and some post information, these
3137  * happen to be combined for efficiency in the $post parameter by the function
3138  * that calls this one: forum_print_latest_discussions()
3139  *
3140  * @param object $post The post object (passed by reference for speed).
3141  * @param object $forum The forum object.
3142  * @param int $group Current group.
3143  * @param string $datestring Format to use for the dates.
3144  * @param boolean $cantrack Is tracking enabled for this forum.
3145  * @param boolean $forumtracked Is the user tracking this forum.
3146  * @param boolean $canviewparticipants True if user has the viewparticipants permission for this course
3147  */
3148 function forum_print_discussion_header(&$post, $forum, $group=-1, $datestring="",
3149                                         $cantrack=true, $forumtracked=true, $canviewparticipants=true, $modcontext=NULL) {
3150
3151     global $USER, $CFG;
3152
3153     static $rowcount;
3154     static $strmarkalldread;
3155
3156     if (empty($modcontext)) {
3157         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
3158             error('Course Module ID was incorrect');
3159         }
3160         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
3161     }
3162
3163     if (!isset($rowcount)) {
3164         $rowcount = 0;
3165         $strmarkalldread = get_string('markalldread', 'forum');
3166     } else {
3167         $rowcount = ($rowcount + 1) % 2;
3168     }
3169
3170     $post->subject = format_string($post->subject,true);
3171
3172     echo "\n\n";
3173     echo '<tr class="discussion r'.$rowcount.'">';
3174
3175     // Topic
3176     echo '<td class="topic starter">';
3177     echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">'.$post->subject.'</a>';
3178     echo "</td>\n";
3179
3180     // Picture
3181     $postuser = new object;
3182     $postuser->id = $post->userid;
3183     $postuser->firstname = $post->firstname;
3184     $postuser->lastname = $post->lastname;
3185     $postuser->imagealt = $post->imagealt;
3186     $postuser->picture = $post->picture;
3187
3188     echo '<td class="picture">';
3189     print_user_picture($postuser, $forum->course);
3190     echo "</td>\n";
3191
3192     // User name
3193     $fullname = fullname($post, has_capability('moodle/site:viewfullnames', $modcontext));
3194     echo '<td class="author">';
3195     echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$post->userid.'&amp;course='.$forum->course.'">'.$fullname.'</a>';
3196     echo "</td>\n";
3197
3198     // Group picture
3199     if ($group !== -1) {  // Groups are active - group is a group data object or NULL
3200         echo '<td class="picture group">';
3201         if (!empty($group->picture) and empty($group->hidepicture)) {
3202             print_group_picture($group, $forum->course, false, false, true);
3203         } else if (isset($group->id)) {
3204             if($canviewparticipants) {
3205                 echo '<a href="'.$CFG->wwwroot.'/user/index.php?id='.$forum->course.'&amp;group='.$group->id.'">'.$group->name.'</a>';
3206             } else {
3207                 echo $group->name;
3208             }
3209         }
3210         echo "</td>\n";
3211     }
3212
3213     if (has_capability('mod/forum:viewdiscussion', $modcontext)) {   // Show the column with replies
3214         echo '<td class="replies">';
3215         echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
3216         echo $post->replies.'</a>';
3217         echo "</td>\n";
3218
3219         if ($cantrack) {
3220             echo '<td class="replies">';
3221             if ($forumtracked) {
3222                 if ($post->unread > 0) {
3223                     echo '<span class="unread">';
3224                     echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#unread">';
3225                     echo $post->unread;
3226                     echo '</a>';
3227                     echo '<a title="'.$strmarkalldread.'" href="'.$CFG->wwwroot.'/mod/forum/markposts.php?f='.
3228                          $forum->id.'&amp;d='.$post->discussion.'&amp;mark=read&amp;returnpage=view.php">' .
3229                          '<img src="'.$CFG->pixpath.'/t/clear.gif" class="iconsmall" alt="'.$strmarkalldread.'" /></a>';
3230                     echo '</span>';
3231                 } else {
3232                     echo '<span class="read">';
3233                     echo $post->unread;
3234                     echo '</span>';
3235                 }
3236             } else {
3237                 echo '<span class="read">';
3238                 echo '-';
3239                 echo '</span>';
3240             }
3241             echo "</td>\n";
3242         }
3243     }
3244
3245     echo '<td class="lastpost">';
3246     $usedate = (empty($post->timemodified)) ? $post->modified : $post->timemodified;  // Just in case
3247     $parenturl = (empty($post->lastpostid)) ? '' : '&amp;parent='.$post->lastpostid;
3248     $usermodified = new object();
3249     $usermodified->id        = $post->usermodified;
3250     $usermodified->firstname = $post->umfirstname;
3251     $usermodified->lastname  = $post->umlastname;
3252     echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$post->usermodified.'&amp;course='.$forum->course.'">'.
3253          fullname($usermodified).'</a><br />';
3254     echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.$parenturl.'">'.
3255           userdate($usedate, $datestring).'</a>';
3256     echo "</td>\n";
3257
3258     echo "</tr>\n\n";
3259
3260 }
3261
3262
3263 /**
3264  * Given a post object that we already know has a long message
3265  * this function truncates the message nicely to the first
3266  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
3267  */
3268 function forum_shorten_post($message) {
3269
3270    global $CFG;
3271
3272    $i = 0;
3273    $tag = false;
3274    $length = strlen($message);
3275    $count = 0;
3276    $stopzone = false;
3277    $truncate = 0;
3278
3279    for ($i=0; $i<$length; $i++) {
3280        $char = $message[$i];
3281
3282        switch ($char) {
3283            case "<":
3284                $tag = true;
3285                break;
3286            case ">":
3287                $tag = false;
3288                break;
3289            default:
3290                if (!$tag) {
3291                    if ($stopzone) {
3292                        if ($char == ".") {
3293                            $truncate = $i+1;
3294                            break 2;
3295                        }
3296                    }
3297                    $count++;
3298                }
3299                break;
3300        }
3301        if (!$stopzone) {
3302            if ($count > $CFG->forum_shortpost) {
3303                $stopzone = true;
3304            }
3305        }
3306    }
3307
3308    if (!$truncate) {
3309        $truncate = $i;
3310    }
3311
3312    return substr($message, 0, $truncate);
3313 }
3314
3315
3316 /**
3317  * Print the multiple ratings on a post given to the current user by others.
3318  * Forumid prevents the double lookup of the forumid in discussion to determine the aggregate type
3319  * Scale is an array of ratings
3320  */
3321 function forum_print_ratings($postid, $scale, $aggregatetype, $link=true, $ratings=null, $return=false) {
3322
3323     $strratings = '';
3324
3325     switch ($aggregatetype) {
3326         case FORUM_AGGREGATE_AVG :
3327             $agg        = forum_get_ratings_mean($postid, $scale, $ratings);
3328             $strratings = get_string("aggregateavg", "forum");
3329             break;
3330         case FORUM_AGGREGATE_COUNT :
3331             $agg        = forum_get_ratings_count($postid, $scale, $ratings);
3332             $strratings = get_string("aggregatecount", "forum");
3333             break;
3334         case FORUM_AGGREGATE_MAX :
3335             $agg        = forum_get_ratings_max($postid, $scale, $ratings);
3336             $strratings = get_string("aggregatemax", "forum");
3337             break;
3338         case FORUM_AGGREGATE_MIN :
3339             $agg        = forum_get_ratings_min($postid, $scale, $ratings);
3340             $strratings = get_string("aggregatemin", "forum");
3341             break;
3342         case FORUM_AGGREGATE_SUM :
3343             $agg        = forum_get_ratings_sum($postid, $scale, $ratings);
3344             $strratings = get_string("aggregatesum", "forum");
3345             break;
3346     }
3347
3348     if ($agg !== "") {
3349
3350         if (empty($strratings)) {
3351             $strratings = get_string("ratings", "forum");
3352         }
3353
3354         $strratings .= ': ';
3355
3356         if ($link) {
3357             $strratings .= link_to_popup_window ("/mod/forum/report.php?id=$postid", "ratings", $agg, 400, 600, null, null, true);
3358         } else {
3359             $strratings .= "$agg ";
3360         }
3361
3362         if ($return) {
3363             return $strratings;
3364         } else {
3365             echo $strratings;
3366         }
3367     }
3368 }
3369
3370
3371 /**
3372  * Return the mean rating of a post given to the current user by others.
3373  * Scale is an array of possible ratings in the scale
3374  * Ratings is an optional simple array of actual ratings (just integers)
3375  * Forumid is the forum id field needed - passing it avoids a double query of lookup up the discusion and then the forum id to get the aggregate type
3376  */
3377 function forum_get_ratings_mean($postid, $scale, $ratings=NULL) {
3378
3379     if (is_null($ratings)) {
3380         $ratings = array();
3381         if ($rates = get_records("forum_ratings", "post", $postid)) {
3382             foreach ($rates as $rate) {
3383                 $ratings[] = $rate->rating;
3384             }
3385         }
3386     }
3387
3388     $count = count($ratings);
3389
3390     if ($count == 0 ) {
3391         return "";
3392
3393     } else if ($count == 1) {
3394         $rating = reset($ratings);
3395         return $scale[$rating];
3396
3397     } else {
3398         $total = 0;
3399         foreach ($ratings as $rating) {
3400             $total += $rating;
3401         }
3402         $mean = round( ((float)$total/(float)$count) + 0.001);  // Little fudge factor so that 0.5 goes UP
3403
3404         if (isset($scale[$mean])) {
3405             return $scale[$mean]." ($count)";
3406         } else {
3407             return "$mean ($count)";    // Should never happen, hopefully
3408         }
3409     }
3410 }
3411
3412 /**
3413  * Return the count of the ratings of a post given to the current user by others.
3414  *
3415  * For numerical grades, the scale index is the same as the real grade value from interval {0..n}
3416  * and $scale looks like Array( 0 => '0/n', 1 => '1/n', ..., n => 'n/n' )
3417  *
3418  * For scales, the index is the order of the scale item {1..n}
3419  * and $scale looks like Array( 1 => 'poor', 2 => 'weak', 3 => 'good' )
3420  * In case of no ratings done yet, we have nothing to display.
3421  *
3422  * @param int $postid
3423  * @param array $scale Possible ratings in the scale - the end of the scale is the highest or max grade
3424  * @param array $ratings An optional simple array of actual ratings (just integers)
3425  */
3426 function forum_get_ratings_count($postid, $scale, $ratings=NULL) {
3427
3428     if (is_null($ratings)) {
3429         $ratings = array();
3430         if ($rates = get_records("forum_ratings", "post", $postid)) {
3431             foreach ($rates as $rate) {
3432                 $ratings[] = $rate->rating;
3433             }
3434         }
3435     }
3436
3437     $count = count($ratings);
3438     if (! array_key_exists(0, $scale)) {
3439         $scaleused = true;
3440     } else {
3441         $scaleused = false;
3442     }
3443
3444     if ($count == 0) {
3445         if ($scaleused) {    // If no rating given yet and we use a scale
3446             return get_string('noratinggiven', 'forum');
3447         } else {
3448             return '';
3449         }
3450     }
3451
3452     $maxgradeidx = max(array_keys($scale)); // For numerical grades, the index is the same as the real grade value {0..n}
3453                                             // and $scale looks like Array( 0 => '0/n', 1 => '1/n', ..., n => 'n/n' )
3454                                             // For scales, the index is the order of the scale item {1..n}
3455                                             // and $scale looks like Array( 1 => 'poor', 2 => 'weak', 3 => 'good' )
3456
3457     if ($count > $maxgradeidx) {      // The count exceeds the max grade
3458         $a = new stdClass();
3459         $a->count = $count;
3460         $a->grade = $scale[$maxgradeidx];
3461         return get_string('aggregatecountformat', 'forum', $a);
3462     } else {                                // Display the count and the aggregated grade for this post
3463         $a = new stdClass();
3464         $a->count = $count;
3465         $a->grade = $scale[$count];
3466         return get_string('aggregatecountformat', 'forum', $a);
3467     }
3468 }
3469
3470 /**
3471  * Return the max rating of a post given to the current user by others.
3472  * Scale is an array of possible ratings in the scale
3473  * Ratings is an optional simple array of actual ratings (just integers)
3474  */
3475 function forum_get_ratings_max($postid, $scale, $ratings=NULL) {
3476
3477     if (is_null($ratings)) {
3478         $ratings = array();
3479         if ($rates = get_records("forum_ratings", "post", $postid)) {
3480             foreach ($rates as $rate) {
3481                 $ratings[] = $rate->rating;
3482             }
3483         }
3484     }
3485
3486     $count = count($ratings);
3487
3488     if ($count == 0 ) {
3489         return "";
3490
3491     } else if ($count == 1) { //this works for max
3492         $rating = reset($ratings);
3493         return $scale[$rating];
3494
3495     } else {
3496         $max = max($ratings);
3497
3498         if (isset($scale[$max])) {
3499             return $scale[$max]." ($count)";
3500         } else {
3501             return "$max ($count)";    // Should never happen, hopefully
3502         }
3503     }
3504 }
3505
3506 /**
3507  * Return the min rating of a post given to the current user by others.
3508  * Scale is an array of possible ratings in the scale
3509  * Ratings is an optional simple array of actual ratings (just integers)
3510  */
3511 function forum_get_ratings_min($postid, $scale,  $ratings=NULL) {
3512
3513     if (is_null($ratings)) {
3514         $ratings = array();
3515         if ($rates = get_records("forum_ratings", "post", $postid)) {
3516             foreach ($rates as $rate) {
3517                 $ratings[] = $rate->rating;
3518             }
3519         }
3520     }
3521
3522     $count = count($ratings);
3523
3524     if ($count == 0 ) {
3525         return "";
3526
3527     } else if ($count == 1) {
3528         $rating = reset($ratings);
3529         return $scale[$rating]; //this works for min
3530
3531     } else {
3532         $min = min($ratings);
3533
3534         if (isset($scale[$min])) {
3535             return $scale[$min]." ($count)";
3536         } else {
3537             return "$min ($count)";    // Should never happen, hopefully
3538         }
3539     }
3540 }
3541
3542
3543 /**
3544  * Return the sum or total of ratings of a post given to the current user by others.
3545  * Scale is an array of possible ratings in the scale
3546  * Ratings is an optional simple array of actual ratings (just integers)
3547  */
3548 function forum_get_ratings_sum($postid, $scale, $ratings=NULL) {
3549
3550     if (is_null($ratings)) {
3551         $ratings = array();
3552         if ($rates = get_records("forum_ratings", "post", $postid)) {
3553             foreach ($rates as $rate) {
3554                 $ratings[] = $rate->rating;
3555             }
3556         }
3557     }
3558
3559     $count = count($ratings);
3560     $scalecount = count($scale)-1; //this should give us the last element of the scale aka the max grade with  $scale[$scalecount]
3561
3562     if ($count == 0 ) {
3563         return "";
3564
3565     } else if ($count == 1) { //this works for max.
3566         $rating = reset($ratings);
3567         return $scale[$rating];
3568
3569     } else {
3570         $total = 0;
3571         foreach ($ratings as $rating) {
3572             $total += $rating;
3573         }
3574         if ($total > $scale[$scalecount]) { //if the total exceeds the max grade then set it to the max grade
3575             $total = $scale[$scalecount];
3576         }
3577         if (isset($scale[$total])) {
3578             return $scale[$total]." ($count)";
3579         } else {
3580             return "$total ($count)";    // Should never happen, hopefully
3581         }
3582     }
3583 }
3584
3585 /**
3586  * Return a summary of post ratings given to the current user by others.
3587  * Scale is an array of possible ratings in the scale
3588  * Ratings is an optional simple array of actual ratings (just integers)
3589  */
3590 function forum_get_ratings_summary($postid, $scale, $ratings=NULL) {
3591
3592     if (is_null($ratings)) {
3593         $ratings = array();
3594         if ($rates = get_records("forum_ratings", "post", $postid)) {
3595             foreach ($rates as $rate) {
3596                 $rating[] = $rate->rating;
3597             }
3598         }
3599     }
3600
3601
3602     if (!$count = count($ratings)) {
3603         return "";
3604     }
3605
3606
3607     foreach ($scale as $key => $scaleitem) {
3608         $sumrating[$key] = 0;
3609     }
3610
3611     foreach ($ratings as $rating) {
3612         $sumrating[$rating]++;
3613     }
3614
3615     $summary = "";
3616     foreach ($scale as $key => $scaleitem) {
3617         $summary = $sumrating[$key].$summary;
3618         if ($key > 1) {
3619             $summary = "/$summary";
3620         }
3621     }
3622     return $summary;
3623 }
3624
3625 /**
3626  * Print the menu of ratings as part of a larger form.
3627  * If the post has already been - set that value.
3628  * Scale is an array of ratings
3629  */
3630 function forum_print_rating_menu($postid, $userid, $scale, $myrating=NULL) {
3631
3632     static $strrate;
3633
3634     if (is_null($myrating)) {
3635         if (!$rating = get_record("forum_ratings", "userid", $userid, "post", $postid)) {
3636             $myrating = FORUM_UNSET_POST_RATING;
3637         } else {
3638             $myrating = $rating->rating;
3639         }
3640     }
3641
3642     if (empty($strrate)) {
3643         $strrate = get_string("rate", "forum");
3644     }
3645     $scale = array(FORUM_UNSET_POST_RATING => $strrate.'...') + $scale;
3646     choose_from_menu($scale, $postid, $myrating, '', '', '0', false, false, 0, '', false, false, 'forumpostratingmenu');
3647 }
3648
3649 /**
3650  * Print the drop down that allows the user to select how they want to have
3651  * the discussion displayed.
3652  * @param $id - forum id if $forumtype is 'single',
3653  *              discussion id for any other forum type
3654  * @param $mode - forum layout mode
3655  * @param $forumtype - optional
3656  */
3657 function forum_print_mode_form($id, $mode, $forumtype='') {
3658     if ($forumtype == 'single') {
3659         echo '<div class="forummode">';
3660         popup_form("view.php?f=$id&amp;mode=", forum_get_layout_modes(), "mode", $mode, "");
3661         echo '</div>';
3662     } else {
3663         popup_form("discuss.php?d=$id&amp;mode=", forum_get_layout_modes(), "mode", $mode, "");
3664     }
3665 }
3666
3667 /**
3668  *
3669  */
3670 function forum_search_form($course, $search='') {
3671     global $CFG;
3672
3673     $output  = '<div class="forumsearch">';
3674     $output .= '<form action="'.$CFG->wwwroot.'/mod/forum/search.php" style="display:inline">';
3675     $output .= '<fieldset class="invisiblefieldset">';
3676     $output .= helpbutton('search', get_string('search'), 'moodle', true, false, '', true);
3677     $output .= '<input name="search" type="text" size="18" value="'.s($search, true).'" alt="search" />';
3678     $output .= '<input value="'.get_string('searchforums', 'forum').'" type="submit" />';
3679     $output .= '<input name="id" type="hidden" value="'.$course->id.'" />';
3680     $output .= '</fieldset>';
3681     $output .= '</form>';
3682     $output .= '</div>';
3683
3684     return $output;
3685 }
3686
3687
3688 /**
3689  *
3690  */
3691 function forum_set_return() {
3692     global $CFG, $SESSION;
3693
3694     if (! isset($SESSION->fromdiscussion)) {
3695         if (!empty($_SERVER['HTTP_REFERER'])) {
3696             $referer = $_SERVER['HTTP_REFERER'];
3697         } else {
3698             $referer = "";
3699         }
3700         // If the referer is NOT a login screen then save it.
3701         if (! strncasecmp("$CFG->wwwroot/login", $referer, 300)) {
3702             $SESSION->fromdiscussion = $_SERVER["HTTP_REFERER"];
3703         }
3704     }
3705 }
3706
3707
3708 /**
3709  *
3710  */
3711 function forum_go_back_to($default) {
3712     global $SESSION;
3713
3714     if (!empty($SESSION->fromdiscussion)) {
3715         $returnto = $SESSION->fromdiscussion;
3716         unset($SESSION->fromdiscussion);
3717         return $returnto;
3718     } else {
3719         return $default;
3720     }
3721 }
3722
3723 /**
3724  * Creates a directory file name, suitable for make_upload_directory()
3725  */
3726 function forum_file_area_name($post) {
3727     global $CFG;
3728
3729     if (!isset($post->forum) or !isset($post->course)) {
3730         debugging('missing forum or course', DEBUG_DEVELOPER);
3731         if (!$discussion = get_record('forum_discussions', 'id', $post->discussion)) {
3732             return false;
3733         }
3734         if (!$forum = get_record('forum', 'id', $discussion->forum)) {
3735             return false;
3736         }
3737         $forumid  = $forum->id;
3738         $courseid = $forum->course;
3739     } else {
3740         $forumid  = $post->forum;
3741         $courseid = $post->course;
3742     }
3743
3744     return "$courseid/$CFG->moddata/forum/$forumid/$post->id";
3745 }
3746
3747 /**
3748  *
3749  */
3750 function forum_file_area($post) {
3751     $path = forum_file_area_name($post);
3752     if ($path) {
3753         return make_upload_directory($path);
3754     } else {
3755         return false;
3756     }
3757 }
3758
3759 /**
3760  *
3761  */
3762 function forum_delete_old_attachments($post, $exception="") {
3763
3764 /**
3765  * Deletes all the user files in the attachments area for a post
3766  * EXCEPT for any file named $exception
3767  */
3768     if ($basedir = forum_file_area($post)) {
3769         if ($files = get_directory_list($basedir)) {
3770             foreach ($files as $file) {
3771                 if ($file != $exception) {
3772                     unlink("$basedir/$file");
3773                     notify("Existing file '$file' has been deleted!");
3774                 }
3775             }
3776         }
3777         if (!$exception) {  // Delete directory as well, if empty
3778             rmdir("$basedir");
3779         }
3780     }
3781 }
3782
3783 /**
3784  * Given a discussion object that is being moved to forumid,
3785  * this function checks all posts in that discussion
3786  * for attachments, and if any are found, these are
3787  * moved to the new forum directory.
3788  */
3789 function forum_move_attachments($discussion, $forumid) {
3790
3791     global $CFG;
3792
3793     require_once($CFG->dirroot.'/lib/uploadlib.php');
3794
3795     $return = true;
3796
3797     if ($posts = get_records_select("forum_posts", "discussion = '$discussion->id' AND attachment <> ''")) {
3798         foreach ($posts as $oldpost) {
3799             $oldpost->course = $discussion->course;
3800             $oldpost->forum = $discussion->forum;
3801             $oldpostdir = "$CFG->dataroot/".forum_file_area_name($oldpost);
3802             if (is_dir($oldpostdir)) {
3803                 $newpost = $oldpost;
3804                 $newpost->forum = $forumid;
3805                 $newpostdir = forum_file_area_name($newpost);
3806                 // take off the last directory because otherwise we're renaming to a directory that already exists
3807                 // and this is unhappy in certain situations, eg over an nfs mount and potentially on windows too.
3808                 make_upload_directory(substr($newpostdir,0,strrpos($newpostdir,'/')));
3809                 $newpostdir = $CFG->dataroot.'/'.forum_file_area_name($newpost);
3810                 $files = get_directory_list($oldpostdir); // get it before we rename it.
3811                 if (! @rename($oldpostdir, $newpostdir)) {
3812                     $return = false;
3813                 }
3814                 foreach ($files as $file) {
3815                     clam_change_log($oldpostdir.'/'.$file,$newpostdir.'/'.$file);
3816                 }
3817             }
3818         }
3819     }
3820     return $return;
3821 }
3822
3823 /**
3824  * if return=html, then return a html string.
3825  * if return=text, then return a text-only string.
3826  * otherwise, print HTML for non-images, and return image HTML
3827  */
3828 function forum_print_attachments($post, $return=NULL) {
3829
3830     global $CFG;
3831
3832     $filearea = forum_file_area_name($post);
3833
3834     $imagereturn = "";
3835     $output = "";
3836
3837     if ($basedir = forum_file_area($post)) {
3838         if ($files = get_directory_list($basedir)) {
3839             $strattachment = get_string("attachment", "forum");
3840             foreach ($files as $file) {
3841                 $icon = mimeinfo("icon", $file);
3842                 $type = mimeinfo("type", $file);
3843                 $ffurl = get_file_url("$filearea/$file");
3844                 $image = "<img src=\"$CFG->pixpath/f/$icon\" class=\"icon\" alt=\"\" />";
3845
3846                 if ($return == "html") {
3847                     $output .= "<a href=\"$ffurl\">$image</a> ";
3848                     $output .= "<a href=\"$ffurl\">$file</a><br />";
3849
3850                 } else if ($return == "text") {
3851                     $output .= "$strattachment $file:\n$ffurl\n";
3852
3853                 } else {
3854                     if (in_array($type, array('image/gif', 'image/jpeg', 'image/png'))) {    // Image attachments don't get printed as links
3855                         $imagereturn .= "<br /><img src=\"$ffurl\" alt=\"\" />";
3856                     } else {
3857                         echo "<a href=\"$ffurl\">$image</a> ";
3858                         echo filter_text("<a href=\"$ffurl\">$file</a><br />");
3859                     }
3860                 }
3861             }
3862         }
3863     }
3864
3865     if ($return) {
3866         return $output;
3867     }
3868
3869     return $imagereturn;
3870 }
3871 /**
3872  * If successful, this function returns the name of the file
3873  * @param $post is a full post record, including course and forum
3874  * @param $newfile is a full upload array from $_FILES
3875  * @param $message is a string to hold the messages.
3876  */
3877
3878 /**
3879  *
3880  */
3881 function forum_add_attachment($post, $inputname,&$message) {
3882
3883     global $CFG;
3884
3885     if (!$forum = get_record("forum", "id", $post->forum)) {
3886         return "";
3887     }
3888
3889     if (!$course = get_record("course", "id", $forum->course)) {
3890         return "";
3891     }
3892
3893     require_once($CFG->dirroot.'/lib/uploadlib.php');
3894     $um = new upload_manager($inputname,true,false,$course,false,$forum->maxbytes,true,true);
3895     $dir = forum_file_area_name($post);
3896     if ($um->process_file_uploads($dir)) {
3897         $message .= $um->get_errors();
3898         return $um->get_new_filename();
3899     }
3900     $message .= $um->get_errors();
3901     return null;
3902 }
3903
3904 /**
3905  *
3906  */
3907 function forum_add_new_post($post,&$message) {
3908
3909     global $USER, $CFG;
3910
3911     $discussion = get_record('forum_discussions', 'id', $post->discussion);
3912     $forum      = get_record('forum', 'id', $discussion->forum);
3913
3914     $post->created    = $post->modified = time();
3915     $post->mailed     = "0";
3916     $post->userid     = $USER->id;
3917     $post->attachment = "";
3918     $post->forum      = $forum->id;     // speedup
3919     $post->course     = $forum->course; // speedup
3920
3921     if (! $post->id = insert_record("forum_posts", $post)) {
3922         return false;
3923     }
3924
3925     if ($post->attachment = forum_add_attachment($post, 'attachment',$message)) {
3926         set_field("forum_posts", "attachment", $post->attachment, "id", $post->id);
3927     }
3928
3929     // Update discussion modified date
3930     set_field("forum_discussions", "timemodified", $post->modified, "id", $post->discussion);
3931     set_field("forum_discussions", "usermodified", $post->userid, "id", $post->discussion);
3932
3933     if (forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
3934         forum_tp_mark_post_read($post->userid, $post, $post->forum);
3935     }
3936
3937     return $post->id;
3938 }
3939
3940 /**
3941  *
3942  */
3943 function forum_update_post($post,&$message) {
3944
3945     global $USER, $CFG;
3946
3947     $forum = get_record('forum', 'id', $post->forum);
3948
3949     $post->modified = time();
3950
3951     $updatediscussion = new object();
3952     $updatediscussion->id           = $post->discussion;
3953     $updatediscussion->timemodified = $post->modified; // last modified tracking
3954     $updatediscussion->usermodified = $post->userid;   // last modified tracking
3955
3956     if (!$post->parent) {   // Post is a discussion starter - update discussion title and times too
3957         $updatediscussion->name      = $post->subject;
3958         $updatediscussion->timestart = $post->timestart;
3959         $updatediscussion->timeend   = $post->timeend;
3960     }
3961
3962     if (!update_record('forum_discussions', $updatediscussion)) {
3963         return false;
3964     }
3965
3966     if ($newfilename = forum_add_attachment($post, 'attachment',$message)) {
3967         $post->attachment = $newfilename;
3968     } else {
3969         unset($post->attachment);
3970     }
3971
3972     if (forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
3973         forum_tp_mark_post_read($post->userid, $post, $post->forum);
3974     }
3975
3976     return update_record('forum_posts', $post);
3977 }
3978
3979 /**
3980  * Given an object containing all the necessary data,
3981  * create a new discussion and return the id
3982  */
3983 function forum_add_discussion($discussion,&$message) {
3984
3985     global $USER, $CFG;
3986
3987     $timenow = time();
3988
3989     // The first post is stored as a real post, and linked
3990     // to from the discuss entry.
3991
3992     $forum = get_record('forum', 'id', $discussion->forum);
3993
3994     $post = new object();
3995     $post->discussion  = 0;
3996     $post->parent      = 0;
3997     $post->userid      = $USER->id;
3998     $post->created     = $timenow;
3999     $post->modified    = $timenow;
4000     $post->mailed      = 0;
4001     $post->subject     = $discussion->name;
4002     $post->message     = $discussion->intro;
4003     $post->attachment  = "";
4004     $post->forum       = $forum->id;     // speedup
4005     $post->course      = $forum->course; // speedup
4006     $post->format      = $discussion->format;
4007     $post->mailnow     = $discussion->mailnow;
4008
4009     if (! $post->id = insert_record("forum_posts", $post) ) {
4010         return 0;
4011     }
4012
4013     if ($post->attachment = forum_add_attachment($post, 'attachment',$message)) {
4014         set_field("forum_posts", "attachment", $post->attachment, "id", $post->id); //ignore errors
4015     }
4016
4017     // Now do the main entry for the discussion,
4018     // linking to this first post
4019
4020     $discussion->firstpost    = $post->id;
4021     $discussion->timemodified = $timenow;
4022     $discussion->usermodified = $post->userid;
4023     $discussion->userid = $USER->id;
4024
4025     if (! $post->discussion = insert_record("forum_discussions", $discussion) ) {
4026         delete_records("forum_posts", "id", $post->id);
4027         return 0;
4028     }
4029
4030     // Finally, set the pointer on the post.
4031     if (! set_field("forum_posts", "discussion", $post->discussion, "id", $post->id)) {
4032         delete_records("forum_posts", "id", $post->id);
4033         delete_records("forum_discussions", "id", $post->discussion);
4034         return 0;
4035     }
4036
4037     if (forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
4038         forum_tp_mark_post_read($post->userid, $post, $post->forum);
4039     }
4040
4041     return $post->discussion;
4042 }
4043
4044
4045 /**
4046  *
4047  */
4048 function forum_delete_discussion($discussion, $fulldelete=false) {
4049 // $discussion is a discussion record object
4050
4051     $result = true;
4052
4053     if ($posts = get_records("forum_posts", "discussion", $discussion->id)) {
4054         foreach ($posts as $post) {
4055             $post->course = $discussion->course;
4056             $post->forum  = $discussion->forum;
4057             if (! delete_records("forum_ratings", "post", "$post->id")) {
4058                 $result = false;
4059             }
4060             if (! forum_delete_post($post, $fulldelete)) {
4061                 $result = false;
4062             }
4063         }
4064     }
4065
4066     forum_tp_delete_read_records(-1, -1, $discussion->id);
4067
4068     if (! delete_records("forum_discussions", "id", "$discussion->id")) {
4069         $result = false;
4070     }
4071
4072     return $result;
4073 }
4074
4075
4076 /**
4077  *
4078  */
4079 function forum_delete_post($post, $children=false) {
4080    if ($childposts = get_records('forum_posts', 'parent', $post->id)) {
4081        if ($children) {
4082            foreach ($childposts as $childpost) {
4083                forum_delete_post($childpost, true);
4084            }
4085        } else {
4086            return false;
4087        }
4088    }
4089    if (delete_records("forum_posts", "id", $post->id)) {
4090        delete_records("forum_ratings", "post", $post->id);  // Just in case
4091
4092        forum_tp_delete_read_records(-1, $post->id);
4093
4094        if ($post->attachment) {
4095            $discussion = get_record("forum_discussions", "id", $post->discussion);
4096            $post->course = $discussion->course;
4097            $post->forum  = $discussion->forum;
4098            forum_delete_old_attachments($post);
4099        }
4100
4101    // Just in case we are deleting the last post
4102        forum_discussion_update_last_post($post->discussion);
4103
4104        return true;
4105    }
4106    return false;
4107 }
4108
4109 /**
4110  *
4111  */
4112 function forum_count_replies($post, $children=true) {
4113     $count = 0;
4114
4115     if ($children) {
4116         if ($childposts = get_records('forum_posts', 'parent', $post->id)) {
4117            foreach ($childposts as $childpost) {
4118                $count ++;                   // For this child
4119                $count += forum_count_replies($childpost, true);
4120            }
4121         }
4122     } else {
4123         $count += count_records('forum_posts', 'parent', $post->id);
4124     }
4125
4126     return $count;
4127 }
4128
4129
4130 /**
4131  *
4132  */
4133 function forum_forcesubscribe($forumid, $value=1) {
4134     return set_field("forum", "forcesubscribe", $value, "id", $forumid);
4135 }
4136
4137 /**
4138  *
4139  */
4140 function forum_is_forcesubscribed($forum) {
4141     if (isset($forum->forcesubscribe)) {    // then we use that
4142         return ($forum->forcesubscribe == FORUM_FORCESUBSCRIBE);
4143     } else {   // Check the database
4144        return (get_field('forum', 'forcesubscribe', 'id', $forum) == FORUM_FORCESUBSCRIBE);
4145     }
4146 }
4147
4148 /**
4149  *
4150  */
4151 function forum_is_subscribed($userid, $forum) {
4152     if (is_numeric($forum)) {
4153         $forum = get_record('forum', 'id', $forum);
4154     }
4155     if (forum_is_forcesubscribed($forum)) {
4156         return true;
4157     }
4158     return record_exists("forum_subscriptions", "userid", $userid, "forum", $forum->id);
4159 }
4160
4161 function forum_get_subscribed_forums($course) {
4162     global $USER, $CFG;
4163     $sql = "SELECT f.id
4164               FROM {$CFG->prefix}forum f
4165                    LEFT JOIN {$CFG->prefix}forum_subscriptions fs ON (fs.forum = f.id AND fs.userid = $USER->id)
4166              WHERE f.forcesubscribe <> ".FORUM_DISALLOWSUBSCRIBE."
4167                    AND (f.forcesubscribe = ".FORUM_FORCESUBSCRIBE." OR fs.id IS NOT NULL)";
4168     if ($subscribed = get_records_sql($sql)) {
4169         foreach ($subscribed as $s) {
4170             $subscribed[$s->id] = $s->id;
4171         }
4172         return $subscribed;
4173     } else {
4174         return array();
4175     }
4176 }
4177
4178 /**
4179  * Adds user to the subscriber list
4180  */
4181 function forum_subscribe($userid, $forumid) {
4182
4183     if (record_exists("forum_subscriptions", "userid", $userid, "forum", $forumid)) {
4184         return true;
4185     }
4186
4187     $sub = new object();
4188     $sub->userid  = $userid;
4189     $sub->forum = $forumid;
4190
4191     return insert_record("forum_subscriptions", $sub);
4192 }
4193
4194 /**
4195  * Removes user from the subscriber list
4196  */
4197 function forum_unsubscribe($userid, $forumid) {
4198     return delete_records("forum_subscriptions", "userid", $userid, "forum", $forumid);
4199 }
4200
4201 /**
4202  * Given a new post, subscribes or unsubscribes as appropriate.
4203  * Returns some text which describes what happened.
4204  */
4205 function forum_post_subscription($post, $forum) {
4206
4207     global $USER;
4208
4209     $action = '';
4210     $subscribed = forum_is_subscribed($USER->id, $forum);
4211
4212     if ($forum->forcesubscribe == FORUM_FORCESUBSCRIBE) { // database ignored
4213         return "";
4214
4215     } elseif (($forum->forcesubscribe == FORUM_DISALLOWSUBSCRIBE)
4216         && !has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_COURSE, $forum->course), $USER->id)) {
4217         if ($subscribed) {
4218             $action = 'unsubscribe'; // sanity check, following MDL-14558
4219         } else {
4220             return "";
4221         }
4222
4223     } else { // go with the user's choice
4224         if (isset($post->subscribe)) {
4225             // no change
4226             if ((!empty($post->subscribe) && $subscribed)
4227                 || (empty($post->subscribe) && !$subscribed)) {
4228                 return "";
4229
4230             } elseif (!empty($post->subscribe) && !$subscribed) {
4231                 $action = 'subscribe';
4232
4233             } elseif (empty($post->subscribe) && $subscribed) {
4234                 $action = 'unsubscribe';
4235             }
4236         }
4237     }
4238
4239     $info = new object();
4240     $info->name  = fullname($USER);
4241     $info->forum = format_string($forum->name);
4242
4243     switch ($action) {
4244         case 'subscribe':
4245             forum_subscribe($USER->id, $post->forum);
4246             return "<p>".get_string("nowsubscribed", "forum", $info)."</p>";
4247         case 'unsubscribe':
4248             forum_unsubscribe($USER->id, $post->forum);
4249             return "<p>".get_string("nownotsubscribed", "forum", $info)."</p>";
4250     }
4251 }
4252
4253 /**
4254  * Generate and return the subscribe or unsubscribe link for a forum.
4255  * @param object $forum the forum. Fields used are $forum->id and $forum->forcesubscribe.
4256  * @param object $context the context object for this forum.
4257  * @param array $messages text used for the link in its various states
4258  *      (subscribed, unsubscribed, forcesubscribed or cantsubscribe).
4259  *      Any strings not passed in are taken from the $defaultmessages array
4260  *      at the top of the function.
4261  * @param
4262  */
4263 function forum_get_subscribe_link($forum, $context, $messages = array(), $cantaccessagroup = false, $fakelink=true, $backtoindex=false, $subscribed_forums=null) {
4264     global $CFG, $USER;
4265     $defaultmessages = array(
4266         'subscribed' => get_string('unsubscribe', 'forum'),
4267         'unsubscribed' => get_string('subscribe', 'forum'),
4268         'cantaccessgroup' => get_string('no'),
4269         'forcesubscribed' => get_string('everyoneissubscribed', 'forum'),
4270         'cantsubscribe' => get_string('disallowsubscribe','forum')
4271     );
4272     $messages = $messages + $defaultmessages;
4273
4274     if (forum_is_forcesubscribed($forum)) {
4275         return $messages['forcesubscribed'];
4276     } else if ($forum->forcesubscribe == FORUM_DISALLOWSUBSCRIBE && !has_capability('mod/forum:managesubscriptions', $context)) {
4277         return $messages['cantsubscribe'];
4278     } else if ($cantaccessagroup) {
4279         return $messages['cantaccessgroup'];
4280     } else {
4281         if (is_null($subscribed_forums)) {
4282             $subscribed = forum_is_subscribed($USER->id, $forum);
4283         } else {
4284             $subscribed = !empty($subscribed_forums[$forum->id]);
4285         }
4286         if ($subscribed) {
4287             $linktext = $messages['subscribed'];
4288             $linktitle = get_string('subscribestop', 'forum');
4289         } else {
4290             $linktext = $messages['unsubscribed'];
4291             $linktitle = get_string('subscribestart', 'forum');
4292         }
4293
4294         $options = array();
4295         if ($backtoindex) {
4296             $backtoindexlink = '&amp;backtoindex=1';
4297             $options['backtoindex'] = 1;
4298         } else {
4299             $backtoindexlink = '';
4300         }
4301         $link = '';
4302
4303         if ($fakelink) {
4304             $link .= <<<EOD
4305 <script type="text/javascript">
4306 //<![CDATA[
4307 var subs_link = document.getElementById("subscriptionlink");
4308 if(subs_link){
4309     subs_link.innerHTML = "<a title=\"$linktitle\" href='$CFG->wwwroot/mod/forum/subscribe.php?id={$forum->id}{$backtoindexlink}'>$linktext<\/a>";
4310 }
4311 //]]>
4312 </script>
4313 <noscript>
4314 EOD;
4315         }
4316         $options ['id'] = $forum->id;
4317         $link .= print_single_button($CFG->wwwroot . '/mod/forum/subscribe.php',
4318                 $options, $linktext, 'post', '_self', true, $linktitle);
4319         if ($fakelink) {
4320             $link .= '</noscript>';
4321         }
4322
4323         return $link;
4324     }
4325 }
4326
4327
4328 /**
4329  * Generate and return the track or no track link for a forum.
4330  * @param object $forum the forum. Fields used are $forum->id and $forum->forcesubscribe.
4331  */
4332 function forum_get_tracking_link($forum, $messages=array(), $fakelink=true) {
4333     global $CFG, $USER;
4334
4335     static $strnotrackforum, $strtrackforum;
4336
4337     if (isset($messages['trackforum'])) {
4338          $strtrackforum = $messages['trackforum'];
4339     }
4340     if (isset($messages['notrackforum'])) {
4341          $strnotrackforum = $messages['notrackforum'];
4342     }
4343     if (empty($strtrackforum)) {
4344         $strtrackforum = get_string('trackforum', 'forum');
4345     }
4346     if (empty($strnotrackforum)) {
4347         $strnotrackforum = get_string('notrackforum', 'forum');
4348     }
4349
4350     if (forum_tp_is_tracked($forum)) {
4351         $linktitle = $strnotrackforum;
4352         $linktext = $strnotrackforum;
4353     } else {
4354         $linktitle = $strtrackforum;
4355         $linktext = $strtrackforum;
4356     }
4357
4358     $link = '';
4359     if ($fakelink) {
4360         $link .= '<script type="text/javascript">';
4361         $link .= '//<![CDATA['."\n";
4362         $link .= 'document.getElementById("trackinglink").innerHTML = "<a title=\"' . $linktitle . '\" href=\"' . $CFG->wwwroot .
4363            '/mod/forum/settracking.php?id=' . $forum->id . '\">' . $linktext . '<\/a>";'."\n";
4364         $link .= '//]]>'."\n";
4365         $link .= '</script>';
4366         // use <noscript> to print button in case javascript is not enabled
4367         $link .= '<noscript>';
4368     }
4369     $link .= print_single_button($CFG->wwwroot . '/mod/forum/settracking.php?id=' . $forum->id,
4370             '', $linktext, 'post', '_self', true, $linktitle);
4371     if ($fakelink) {
4372         $link .= '</noscript>';
4373     }
4374
4375     return $link;
4376 }
4377
4378
4379
4380 /**
4381  * Returns true if user created new discussion already
4382  * @param int $forumid
4383  * @param int $userid
4384  * @return bool
4385  */
4386 function forum_user_has_posted_discussion($forumid, $userid) {
4387     global $CFG;
4388
4389     $sql = "SELECT 'x'
4390               FROM {$CFG->prefix}forum_discussions d, {$CFG->prefix}forum_posts p
4391              WHERE d.forum = $forumid AND p.discussion = d.id AND p.parent = 0 and p.userid = $userid";
4392
4393     return record_exists_sql($sql);
4394 }
4395
4396 /**
4397  *
4398  */
4399 function forum_discussions_user_has_posted_in($forumid, $userid) {
4400     global $CFG;
4401
4402     $haspostedsql = "SELECT d.id AS id,
4403                             d.*
4404                        FROM {$CFG->prefix}forum_posts p,
4405                             {$CFG->prefix}forum_discussions d
4406                       WHERE p.discussion = d.id
4407                         AND d.forum = $forumid
4408                         AND p.userid = $userid";
4409
4410     return get_records_sql($haspostedsql);
4411 }
4412
4413 /**
4414  *
4415  */
4416 function forum_user_has_posted($forumid, $did, $userid) {
4417     global $CFG;
4418
4419     if (empty($did)) {
4420         // posted in any forum discussion?
4421         $sql = "SELECT 'x'
4422                   FROM {$CFG->prefix}forum_posts p
4423                   JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
4424                  WHERE p.userid = $userid AND d.forum = $forumid";
4425         return record_exists_sql($sql);
4426     } else {
4427         // started discussion?
4428         return record_exists('forum_posts','discussion',$did,'userid',$userid);
4429     }
4430 }
4431
4432 /**
4433  *
4434  */
4435 function forum_user_can_post_discussion($forum, $currentgroup=null, $unused=-1, $cm=NULL, $context=NULL) {
4436 // $forum is an object
4437     global $USER;
4438
4439     // shortcut - guest and not-logged-in users can not post
4440     if (isguestuser() or !isloggedin()) {
4441         return false;
4442     }
4443
4444     if (!$cm) {
4445         debugging('missing cm', DEBUG_DEVELOPER);
4446         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
4447             error('Course Module ID was incorrect');
4448         }
4449     }
4450
4451     if (!$context) {
4452         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
4453     }
4454
4455     if ($currentgroup === null) {
4456         $currentgroup = groups_get_activity_group($cm);
4457     }
4458
4459     $groupmode = groups_get_activity_groupmode($cm);
4460
4461     if ($forum->type == 'news') {
4462         $capname = 'mod/forum:addnews';
4463     } else {
4464         $capname = 'mod/forum:startdiscussion';
4465     }
4466
4467     if (!has_capability($capname, $context)) {
4468         return false;
4469     }
4470
4471     if ($forum->type == 'eachuser') {
4472         if (forum_user_has_posted_discussion($forum->id, $USER->id)) {
4473             return false;
4474         }
4475     }
4476
4477     if (!$groupmode or has_capability('moodle/site:accessallgroups', $context)) {
4478         return true;
4479     }
4480
4481     if ($currentgroup) {
4482         return groups_is_member($currentgroup);
4483     } else {
4484         // no group membership and no accessallgroups means no new discussions
4485         // reverted to 1.7 behaviour in 1.9+,  buggy in 1.8.0-1.9.0
4486         return false;
4487     }
4488 }
4489
4490 /**
4491  * This function checks whether the user can reply to posts in a forum
4492  * discussion. Use forum_user_can_post_discussion() to check whether the user
4493  * can start dicussions.
4494  * @param $forum - forum object
4495  * @param $user - user object
4496  */
4497 function forum_user_can_post($forum, $discussion, $user=NULL, $cm=NULL, $course=NULL, $context=NULL) {
4498     global $USER;
4499     if (empty($user)) {
4500         $user = $USER;
4501     }
4502
4503     // shortcut - guest and not-logged-in users can not post
4504     if (isguestuser($user) or empty($user->id)) {
4505         return false;
4506     }
4507
4508     if (!isset($discussion->groupid)) {
4509         debugging('incorrect discussion parameter', DEBUG_DEVELOPER);
4510         return false;
4511     }
4512
4513     if (!$cm) {
4514         debugging('missing cm', DEBUG_DEVELOPER);
4515         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
4516             error('Course Module ID was incorrect');
4517         }
4518     }
4519
4520     if (!$course) {
4521         debugging('missing course', DEBUG_DEVELOPER);
4522         if (!$course = get_record('course', 'id', $forum->course)) {
4523             error('Incorrect course id');
4524         }
4525     }
4526
4527     if (!$context) {
4528         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
4529     }
4530
4531     // normal users with temporary guest access can not post
4532     if (has_capability('moodle/legacy:guest', $context, $user->id, false)) {
4533         return false;
4534     }
4535
4536     if ($forum->type == 'news') {
4537         $capname = 'mod/forum:replynews';
4538     } else {
4539         $capname = 'mod/forum:replypost';
4540     }
4541
4542     if (!has_capability($capname, $context, $user->id, false)) {
4543         return false;
4544     }
4545
4546     if (!$groupmode = groups_get_activity_groupmode($cm, $course)) {
4547         return true;
4548     }
4549
4550     if (has_capability('moodle/site:accessallgroups', $context)) {
4551         return true;
4552     }
4553
4554     if ($groupmode == VISIBLEGROUPS) {
4555         if ($discussion->groupid == -1) {
4556             // allow students to reply to all participants discussions - this was not possible in Moodle <1.8
4557             return true;
4558         }
4559         return groups_is_member($discussion->groupid);
4560
4561     } else {
4562         //separate groups
4563         if ($discussion->groupid == -1) {
4564             return false;
4565         }
4566         return groups_is_member($discussion->groupid);
4567     }
4568 }
4569
4570
4571 //checks to see if a user can view a particular post
4572 function forum_user_can_view_post($post, $course, $cm, $forum, $discussion, $user=NULL){
4573
4574     global $CFG, $USER;
4575
4576     if (!$user){
4577         $user = $USER;
4578     }
4579
4580     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
4581     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) {
4582         return false;
4583     }
4584
4585 // If it's a grouped discussion, make sure the user is a member
4586     if ($discussion->groupid > 0) {
4587         $groupmode = groups_get_activity_groupmode($cm);
4588         if ($groupmode == SEPARATEGROUPS) {
4589             return groups_is_member($discussion->groupid) || has_capability('moodle/site:accessallgroups', $modcontext);
4590         }
4591     }
4592     return true;
4593 }
4594
4595
4596 /**
4597  *
4598  */
4599 function forum_user_can_see_discussion($forum, $discussion, $context, $user=NULL) {
4600     global $USER;
4601
4602     if (empty($user) || empty($user->id)) {
4603         $user = $USER;
4604     }
4605
4606     // retrieve objects (yuk)
4607     if (is_numeric($forum)) {
4608         debugging('missing full forum', DEBUG_DEVELOPER);
4609         if (!$forum = get_record('forum','id',$forum)) {
4610             return false;
4611         }
4612     }
4613     if (is_numeric($discussion)) {
4614         debugging('missing full discussion', DEBUG_DEVELOPER);
4615         if (!$discussion = get_record('forum_discussions','id',$discussion)) {
4616             return false;
4617         }
4618     }
4619
4620     if (!has_capability('mod/forum:viewdiscussion', $context)) {
4621         return false;
4622     }
4623
4624     if ($forum->type == 'qanda' &&
4625             !forum_user_has_posted($forum->id, $discussion->id, $user->id) &&
4626             !has_capability('mod/forum:viewqandawithoutposting', $context)) {
4627         return false;
4628     }
4629     return true;
4630 }
4631
4632
4633 /**
4634  *
4635  */
4636 function forum_user_can_see_post($forum, $discussion, $post, $user=NULL, $cm=NULL) {
4637     global $USER;
4638
4639     // retrieve objects (yuk)
4640     if (is_numeric($forum)) {
4641         debugging('missing full forum', DEBUG_DEVELOPER);
4642         if (!$forum = get_record('forum','id',$forum)) {
4643             return false;
4644         }
4645     }
4646
4647     if (is_numeric($discussion)) {
4648         debugging('missing full discussion', DEBUG_DEVELOPER);
4649         if (!$discussion = get_record('forum_discussions','id',$discussion)) {
4650             return false;
4651         }
4652     }
4653     if (is_numeric($post)) {
4654         debugging('missing full post', DEBUG_DEVELOPER);
4655         if (!$post = get_record('forum_posts','id',$post)) {
4656             return false;
4657         }
4658     }
4659     if (!isset($post->id) && isset($post->parent)) {
4660         $post->id = $post->parent;
4661     }
4662
4663     if (!$cm) {
4664         debugging('missing cm', DEBUG_DEVELOPER);
4665         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
4666             error('Course Module ID was incorrect');
4667         }
4668     }
4669
4670     if (empty($user) || empty($user->id)) {
4671         $user = $USER;
4672     }
4673
4674     if (isset($cm->cache->caps['mod/forum:viewdiscussion'])) {
4675         if (!$cm->cache->caps['mod/forum:viewdiscussion']) {
4676             return false;
4677         }
4678     } else {
4679         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
4680         if (!has_capability('mod/forum:viewdiscussion', $modcontext, $user->id)) {
4681             return false;
4682         }
4683     }
4684
4685     if (isset($cm->uservisible)) {
4686         if (!$cm->uservisible) {
4687             return false;
4688         }
4689     } else {
4690         if (!coursemodule_visible_for_user($cm, $user->id)) {
4691             return false;
4692         }
4693     }
4694
4695     if ($forum->type == 'qanda') {
4696         $firstpost = forum_get_firstpost_from_discussion($discussion->id);
4697         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
4698
4699         return (forum_user_has_posted($forum->id,$discussion->id,$user->id) ||
4700                 $firstpost->id == $post->id ||
4701                 has_capability('mod/forum:viewqandawithoutposting', $modcontext, $user->id, false));
4702     }
4703     return true;
4704 }
4705
4706
4707 /**
4708  * Prints the discussion view screen for a forum.
4709  *
4710  * @param object $course The current course object.
4711  * @param object $forum Forum to be printed.
4712  * @param int $maxdiscussions .
4713  * @param string $displayformat The display format to use (optional).
4714  * @param string $sort Sort arguments for database query (optional).
4715  * @param int $groupmode Group mode of the forum (optional).
4716  * @param void $unused (originally current group)
4717  * @param int $page Page mode, page to display (optional).
4718  * @param int perpage The maximum number of discussions per page(optional)
4719  *
4720  */
4721 function forum_print_latest_discussions($course, $forum, $maxdiscussions=-1, $displayformat='plain', $sort='',
4722                                         $currentgroup=-1, $groupmode=-1, $page=-1, $perpage=100, $cm=NULL) {
4723     global $CFG, $USER;
4724
4725     if (!$cm) {
4726         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
4727             error('Course Module ID was incorrect');
4728         }
4729     }
4730     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
4731
4732     if (empty($sort)) {
4733         $sort = "d.timemodified DESC";
4734     }
4735
4736     $olddiscussionlink = false;
4737
4738  // Sort out some defaults
4739     if ($perpage <= 0) {
4740         $perpage = 0;
4741         $page    = -1;
4742     }
4743
4744     if ($maxdiscussions == 0) {
4745         // all discussions - backwards compatibility
4746         $page    = -1;
4747         $perpage = 0;
4748         if ($displayformat == 'plain') {
4749             $displayformat = 'header';  // Abbreviate display by default
4750         }
4751
4752     } else if ($maxdiscussions > 0) {
4753         $page    = -1;
4754         $perpage = $maxdiscussions;
4755     }
4756
4757     $fullpost = false;
4758     if ($displayformat == 'plain') {
4759         $fullpost = true;
4760     }
4761
4762
4763 // Decide if current user is allowed to see ALL the current discussions or not
4764
4765 // First check the group stuff
4766     if ($currentgroup == -1 or $groupmode == -1) {
4767         $groupmode    = groups_get_activity_groupmode($cm, $course);
4768         $currentgroup = groups_get_activity_group($cm);
4769     }
4770
4771 // If the user can post discussions, then this is a good place to put the
4772 // button for it. We do not show the button if we are showing site news
4773 // and the current user is a guest.
4774
4775     if (forum_user_can_post_discussion($forum, $currentgroup, $groupmode, $cm, $context) ||
4776         ($forum->type != 'news'
4777          and (isguestuser() or !isloggedin() or has_capability('moodle/legacy:guest', $context, NULL, false))) ) {
4778
4779         echo '<div class="singlebutton forumaddnew">';
4780         echo "<form id=\"newdiscussionform\" method=\"get\" action=\"$CFG->wwwroot/mod/forum/post.php\">";
4781         echo '<div>';
4782         echo "<input type=\"hidden\" name=\"forum\" value=\"$forum->id\" />";
4783         echo '<input type="submit" value="';
4784         echo ($forum->type == 'news') ? get_string('addanewtopic', 'forum')
4785             : (($forum->type == 'qanda')
4786                ? get_string('addanewquestion','forum')
4787                : get_string('addanewdiscussion', 'forum'));
4788         echo '" />';
4789         echo '</div>';
4790         echo '</form>';
4791         echo "</div>\n";
4792
4793     } else if (isguestuser() or !isloggedin() or $forum->type == 'news') {
4794         // no button and no info
4795
4796     } else if ($groupmode and has_capability('mod/forum:startdiscussion', $context)) {
4797         // inform users why they can not post new discussion
4798         if ($currentgroup) {
4799             notify(get_string('cannotadddiscussion', 'forum'));
4800         } else {
4801             notify(get_string('cannotadddiscussionall', 'forum'));
4802         }
4803     }
4804
4805 // Get all the recent discussions we're allowed to see
4806
4807     $getuserlastmodified = ($displayformat == 'header');
4808
4809     if (! $discussions = forum_get_discussions($cm, $sort, $fullpost, null, $maxdiscussions, $getuserlastmodified, $page, $perpage) ) {
4810         echo '<div class="forumnodiscuss">';
4811         if ($forum->type == 'news') {
4812             echo '('.get_string('nonews', 'forum').')';
4813         } else if ($forum->type == 'qanda') {
4814             echo '('.get_string('noquestions','forum').')';
4815         } else {
4816             echo '('.get_string('nodiscussions', 'forum').')';
4817         }
4818         echo "</div>\n";
4819         return;
4820     }
4821
4822 // If we want paging
4823     if ($page != -1) {
4824         ///Get the number of discussions found
4825         $numdiscussions = forum_get_discussions_count($cm);
4826
4827         ///Show the paging bar
4828         print_paging_bar($numdiscussions, $page, $perpage, "view.php?f=$forum->id&amp;");
4829         if ($numdiscussions > 1000) {
4830             // saves some memory on sites with very large forums
4831             $replies = forum_count_discussion_replies($forum->id, $sort, $maxdiscussions, $page, $perpage);
4832         } else {
4833             $replies = forum_count_discussion_replies($forum->id);
4834         }
4835
4836     } else {
4837         $replies = forum_count_discussion_replies($forum->id);
4838
4839         if ($maxdiscussions > 0 and $maxdiscussions <= count($discussions)) {
4840             $olddiscussionlink = true;
4841         }
4842     }
4843
4844     $canviewparticipants = has_capability('moodle/course:viewparticipants',$context);
4845
4846     $strdatestring = get_string('strftimerecentfull');
4847
4848     // Check if the forum is tracked.
4849     if ($cantrack = forum_tp_can_track_forums($forum)) {
4850         $forumtracked = forum_tp_is_tracked($forum);
4851     } else {
4852         $forumtracked = false;
4853     }
4854
4855     if ($forumtracked) {
4856         $unreads = forum_get_discussions_unread($cm);
4857     } else {
4858         $unreads = array();
4859     }
4860
4861     if ($displayformat == 'header') {
4862         echo '<table cellspacing="0" class="forumheaderlist">';
4863         echo '<thead>';
4864         echo '<tr>';
4865         echo '<th class="header topic" scope="col">'.get_string('discussion', 'forum').'</th>';
4866         echo '<th class="header author" colspan="2" scope="col">'.get_string('startedby', 'forum').'</th>';
4867         if ($groupmode > 0) {
4868             echo '<th class="header group" scope="col">'.get_string('group').'</th>';
4869         }
4870         if (has_capability('mod/forum:viewdiscussion', $context)) {
4871             echo '<th class="header replies" scope="col">'.get_string('replies', 'forum').'</th>';
4872             // If the forum can be tracked, display the unread column.
4873             if ($cantrack) {
4874                 echo '<th class="header replies" scope="col">'.get_string('unread', 'forum');
4875                 if ($forumtracked) {
4876                     echo '&nbsp;<a title="'.get_string('markallread', 'forum').
4877                          '" href="'.$CFG->wwwroot.'/mod/forum/markposts.php?f='.
4878                          $forum->id.'&amp;mark=read&amp;returnpage=view.php">'.
4879                          '<img src="'.$CFG->pixpath.'/t/clear.gif" class="iconsmall" alt="'.get_string('markallread', 'forum').'" /></a>';
4880                 }
4881                 echo '</th>';
4882             }
4883         }
4884         echo '<th class="header lastpost" scope="col">'.get_string('lastpost', 'forum').'</th>';
4885         echo '</tr>';
4886         echo '</thead>';
4887         echo '<tbody>';
4888     }
4889
4890     foreach ($discussions as $discussion) {
4891         if (!empty($replies[$discussion->discussion])) {
4892             $discussion->replies = $replies[$discussion->discussion]->replies;
4893             $discussion->lastpostid = $replies[$discussion->discussion]->lastpostid;
4894         } else {
4895             $discussion->replies = 0;
4896         }
4897
4898         // SPECIAL CASE: The front page can display a news item post to non-logged in users.
4899         // All posts are read in this case.
4900         if (!$forumtracked) {
4901             $discussion->unread = '-';
4902         } else if (empty($USER)) {
4903             $discussion->unread = 0;
4904         } else {
4905             if (empty($unreads[$discussion->discussion])) {
4906                 $discussion->unread = 0;
4907             } else {
4908                 $discussion->unread = $unreads[$discussion->discussion];
4909             }
4910         }
4911
4912         if (!empty($USER->id)) {
4913             $ownpost = ($discussion->userid == $USER->id);
4914         } else {
4915             $ownpost=false;
4916         }
4917         // Use discussion name instead of subject of first post
4918         $discussion->subject = $discussion->name;
4919
4920         switch ($displayformat) {
4921             case 'header':
4922                 if ($groupmode > 0) {
4923                     if (isset($groups[$discussion->groupid])) {
4924                         $group = $groups[$discussion->groupid];
4925                     } else {
4926                         $group = $groups[$discussion->groupid] = groups_get_group($discussion->groupid);
4927                     }
4928                 } else {
4929                     $group = -1;
4930                 }
4931                 forum_print_discussion_header($discussion, $forum, $group, $strdatestring, $cantrack, $forumtracked,
4932                     $canviewparticipants, $context);
4933             break;
4934             default:
4935                 $link = false;
4936
4937                 if ($discussion->replies) {
4938                     $link = true;
4939                 } else {
4940                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
4941                     $link = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
4942                 }
4943
4944                 $discussion->forum = $forum->id;
4945
4946                 forum_print_post($discussion, $discussion, $forum, $cm, $course, $ownpost, 0, $link, false);
4947             break;
4948         }
4949     }
4950
4951     if ($displayformat == "header") {
4952         echo '</tbody>';
4953         echo '</table>';
4954     }
4955
4956     if ($olddiscussionlink) {
4957         if ($forum->type == 'news') {
4958             $strolder = get_string('oldertopics', 'forum');
4959         } else {
4960             $strolder = get_string('olderdiscussions', 'forum');
4961         }
4962         echo '<div class="forumolddiscuss">';
4963         echo '<a href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'&amp;showall=1">';
4964         echo $strolder.'</a> ...</div>';
4965     }
4966
4967     if ($page != -1) { ///Show the paging bar
4968         print_paging_bar($numdiscussions, $page, $perpage, "view.php?f=$forum->id&amp;");
4969     }
4970 }
4971
4972
4973 /**
4974  *
4975  */
4976 function forum_print_discussion($course, $cm, $forum, $discussion, $post, $mode, $canreply=NULL, $canrate=false) {
4977
4978     global $USER, $CFG;
4979
4980     if (!empty($USER->id)) {
4981         $ownpost = ($USER->id == $post->userid);
4982     } else {
4983         $ownpost = false;
4984     }
4985     if ($canreply === NULL) {
4986         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
4987         $reply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
4988     } else {
4989         $reply = $canreply;
4990     }
4991
4992     // $cm holds general cache for forum functions
4993     $cm->cache = new object();
4994     $cm->cache->groups      = groups_get_all_groups($course->id, 0, $cm->groupingid);
4995     $cm->cache->usersgroups = array();
4996
4997     $posters = array();
4998
4999     // preload all posts - TODO: improve...
5000     if ($mode == FORUM_MODE_FLATNEWEST) {
5001         $sort = "p.created DESC";
5002     } else {
5003         $sort = "p.created ASC";
5004     }
5005
5006     $forumtracked = forum_tp_is_tracked($forum);
5007     $posts = forum_get_all_discussion_posts($discussion->id, $sort, $forumtracked);
5008     $post = $posts[$post->id];
5009
5010     foreach ($posts as $pid=>$p) {
5011         $posters[$p->userid] = $p->userid;
5012     }
5013
5014     // preload all groups of ppl that posted in this discussion
5015     if ($postersgroups = groups_get_all_groups($course->id, $posters, $cm->groupingid, 'gm.id, gm.groupid, gm.userid')) {
5016         foreach($postersgroups as $pg) {
5017             if (!isset($cm->cache->usersgroups[$pg->userid])) {
5018                 $cm->cache->usersgroups[$pg->userid] = array();
5019             }
5020             $cm->cache->usersgroups[$pg->userid][$pg->groupid] = $pg->groupid;
5021         }
5022         unset($postersgroups);
5023     }
5024
5025     $ratings = NULL;
5026     $ratingsmenuused = false;
5027     $ratingsformused = false;
5028     if ($forum->assessed and isloggedin()) {
5029         if ($scale = make_grades_menu($forum->scale)) {
5030             $ratings =new object();
5031             $ratings->scale = $scale;
5032             $ratings->assesstimestart = $forum->assesstimestart;
5033             $ratings->assesstimefinish = $forum->assesstimefinish;
5034             $ratings->allow = $canrate;
5035
5036             if ($ratings->allow) {
5037                 echo '<form id="form" method="post" action="rate.php">';
5038                 echo '<div class="ratingform">';
5039                 echo '<input type="hidden" name="forumid" value="'.$forum->id.'" />';
5040                 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
5041                 $ratingsformused = true;
5042             }
5043
5044             // preload all ratings - one query only and minimal memory
5045             $cm->cache->ratings = array();
5046             $cm->cache->myratings = array();
5047             if ($postratings = forum_get_all_discussion_ratings($discussion)) {
5048                 foreach ($postratings as $pr) {
5049                     if (!isset($cm->cache->ratings[$pr->postid])) {
5050                         $cm->cache->ratings[$pr->postid] = array();
5051                     }
5052                     $cm->cache->ratings[$pr->postid][$pr->id] = $pr->rating;
5053                     if ($pr->userid == $USER->id) {
5054                         $cm->cache->myratings[$pr->postid] = $pr->rating;
5055                     }
5056                 }
5057                 unset($postratings);
5058             }
5059         }
5060
5061     }
5062
5063     $post->forum = $forum->id;   // Add the forum id to the post object, later used by forum_print_post
5064     $post->forumtype = $forum->type;
5065
5066     $post->subject = format_string($post->subject);
5067
5068     $postread = !empty($post->postread);
5069
5070     if (forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, false, $ratings,
5071                          '', '', $postread, true, $forumtracked)) {
5072         $ratingsmenuused = true;
5073     }
5074
5075     switch ($mode) {
5076         case FORUM_MODE_FLATOLDEST :
5077         case FORUM_MODE_FLATNEWEST :
5078         default:
5079             if (forum_print_posts_flat($course, $cm, $forum, $discussion, $post, $mode, $ratings, $reply, $forumtracked, $posts)) {
5080                 $ratingsmenuused = true;
5081             }
5082             break;
5083
5084         case FORUM_MODE_THREADED :
5085             if (forum_print_posts_threaded($course, $cm, $forum, $discussion, $post, 0, $ratings, $reply, $forumtracked, $posts)) {
5086                 $ratingsmenuused = true;
5087             }
5088             break;
5089
5090         case FORUM_MODE_NESTED :
5091             if (forum_print_posts_nested($course, $cm, $forum, $discussion, $post, $ratings, $reply, $forumtracked, $posts)) {
5092                 $ratingsmenuused = true;
5093             }
5094             break;
5095     }
5096
5097     if ($ratingsformused) {
5098         if ($ratingsmenuused) {
5099             echo '<div class="ratingsubmit">';
5100             echo '<input type="submit" id="forumpostratingsubmit" value="'.get_string('sendinratings', 'forum').'" />';
5101             if (ajaxenabled() && !empty($CFG->forum_ajaxrating)) { /// AJAX enabled, standard submission form
5102                 $rate_ajax_config_settings = array("pixpath"=>$CFG->pixpath, "wwwroot"=>$CFG->wwwroot, "sesskey"=>sesskey());
5103                 echo "<script type=\"text/javascript\">//<![CDATA[\n".
5104                      "var rate_ajax_config = " . json_encode($rate_ajax_config_settings) . ";\n".
5105                      "init_rate_ajax();\n".
5106                      "//]]></script>\n";
5107             }
5108             if ($forum->scale < 0) {
5109                 if ($scale = get_record("scale", "id", abs($forum->scale))) {
5110                     print_scale_menu_helpbutton($course->id, $scale );
5111                 }
5112             }
5113             echo '</div>';
5114         }
5115
5116         echo '</div>';
5117         echo '</form>';
5118     }
5119 }
5120
5121
5122 /**
5123  *
5124  */
5125 function forum_print_posts_flat($course, &$cm, $forum, $discussion, $post, $mode, $ratings, $reply, $forumtracked, $posts) {
5126     global $USER, $CFG;
5127
5128     $link  = false;
5129     $ratingsmenuused = false;
5130
5131     if ($mode == FORUM_MODE_FLATNEWEST) {
5132         $sort = "ORDER BY created DESC";
5133     } else {
5134         $sort = "ORDER BY created ASC";
5135     }
5136
5137     foreach ($posts as $post) {
5138         if (!$post->parent) {
5139             continue;
5140         }
5141         $post->subject = format_string($post->subject);
5142         $ownpost = ($USER->id == $post->userid);
5143
5144         $postread = !empty($post->postread);
5145
5146         if (forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link, $ratings,
5147                              '', '', $postread, true, $forumtracked)) {
5148             $ratingsmenuused = true;
5149         }
5150     }
5151
5152     return $ratingsmenuused;
5153 }
5154
5155
5156 /**
5157  * TODO document
5158  */
5159 function forum_print_posts_threaded($course, &$cm, $forum, $discussion, $parent, $depth, $ratings, $reply, $forumtracked, $posts) {
5160     global $USER, $CFG;
5161
5162     $link  = false;
5163     $ratingsmenuused = false;
5164
5165     if (!empty($posts[$parent->id]->children)) {
5166         $posts = $posts[$parent->id]->children;
5167
5168         $modcontext       = get_context_instance(CONTEXT_MODULE, $cm->id);
5169         $canviewfullnames = has_capability('moodle/site:viewfullnames', $modcontext);
5170
5171         foreach ($posts as $post) {
5172
5173             echo '<div class="indent">';
5174             if ($depth > 0) {
5175                 $ownpost = ($USER->id == $post->userid);
5176                 $post->subject = format_string($post->subject);
5177
5178                 $postread = !empty($post->postread);
5179
5180                 if (forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link, $ratings,
5181                                      '', '', $postread, true, $forumtracked)) {
5182                     $ratingsmenuused = true;
5183                 }
5184             } else {
5185                 if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
5186                     echo "</div>\n";
5187                     continue;
5188                 }
5189                 $by = new object();
5190                 $by->name = fullname($post, $canviewfullnames);
5191                 $by->date = userdate($post->modified);
5192
5193                 if ($forumtracked) {
5194                     if (!empty($post->postread)) {
5195                         $style = '<span class="forumthread read">';
5196                     } else {
5197                         $style = '<span class="forumthread unread">';
5198                     }
5199                 } else {
5200                     $style = '<span class="forumthread">';
5201                 }
5202                 echo $style."<a name=\"$post->id\"></a>".
5203                      "<a href=\"discuss.php?d=$post->discussion&amp;parent=$post->id\">".format_string($post->subject,true)."</a> ";
5204                 print_string("bynameondate", "forum", $by);
5205                 echo "</span>";
5206             }
5207
5208             if (forum_print_posts_threaded($course, $cm, $forum, $discussion, $post, $depth-1, $ratings, $reply, $forumtracked, $posts)) {
5209                 $ratingsmenuused = true;
5210             }
5211             echo "</div>\n";
5212         }
5213     }
5214     return $ratingsmenuused;
5215 }
5216
5217 /**
5218  *
5219  */
5220 function forum_print_posts_nested($course, &$cm, $forum, $discussion, $parent, $ratings, $reply, $forumtracked, $posts) {
5221     global $USER, $CFG;
5222
5223     $link  = false;
5224     $ratingsmenuused = false;
5225
5226     if (!empty($posts[$parent->id]->children)) {
5227         $posts = $posts[$parent->id]->children;
5228
5229         foreach ($posts as $post) {
5230
5231             echo '<div class="indent">';
5232             if (empty($USER->id)) {
5233                 $ownpost = false;
5234             } else {
5235                 $ownpost = ($USER->id == $post->userid);
5236             }
5237
5238             $post->subject = format_string($post->subject);
5239             $postread = !empty($post->postread);
5240
5241             if (forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link, $ratings,
5242                                  '', '', $postread, true, $forumtracked)) {
5243                 $ratingsmenuused = true;
5244             }
5245             if (forum_print_posts_nested($course, $cm, $forum, $discussion, $post, $ratings, $reply, $forumtracked, $posts)) {
5246                 $ratingsmenuused = true;
5247             }
5248             echo "</div>\n";
5249         }
5250     }
5251     return $ratingsmenuused;
5252 }
5253
5254 /**
5255  * Returns all forum posts since a given time in specified forum.
5256  */
5257 function forum_get_recent_mod_activity(&$activities, &$index, $timestart, $courseid, $cmid, $userid=0, $groupid=0)  {
5258     global $CFG, $COURSE, $USER;
5259
5260     if ($COURSE->id == $courseid) {
5261         $course = $COURSE;
5262     } else {
5263         $course = get_record('course', 'id', $courseid);
5264     }
5265
5266     $modinfo =& get_fast_modinfo($course);
5267
5268     $cm = $modinfo->cms[$cmid];
5269
5270     if ($userid) {
5271         $userselect = "AND u.id = $userid";
5272     } else {
5273         $userselect = "";
5274     }
5275
5276     if ($groupid) {
5277         $groupselect = "AND gm.groupid = $groupid";
5278         $groupjoin   = "JOIN {$CFG->prefix}groups_members gm ON  gm.userid=u.id";
5279     } else {
5280         $groupselect = "";
5281         $groupjoin   = "";
5282     }
5283
5284     if (!$posts = get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
5285                                           d.timestart, d.timeend, d.userid AS duserid,
5286                                           u.firstname, u.lastname, u.email, u.picture, u.imagealt
5287                                      FROM {$CFG->prefix}forum_posts p
5288                                           JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
5289                                           JOIN {$CFG->prefix}forum f             ON f.id = d.forum
5290                                           JOIN {$CFG->prefix}user u              ON u.id = p.userid
5291                                           $groupjoin
5292                                     WHERE p.created > $timestart AND f.id = $cm->instance
5293                                           $userselect $groupselect
5294                                  ORDER BY p.id ASC")) { // order by initial posting date
5295          return;
5296     }
5297
5298     $groupmode       = groups_get_activity_groupmode($cm, $course);
5299     $cm_context      = get_context_instance(CONTEXT_MODULE, $cm->id);
5300     $viewhiddentimed = has_capability('mod/forum:viewhiddentimedposts', $cm_context);
5301     $accessallgroups = has_capability('moodle/site:accessallgroups', $cm_context);
5302
5303     if (is_null($modinfo->groups)) {
5304         $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
5305     }
5306
5307     $printposts = array();
5308     foreach ($posts as $post) {
5309
5310         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
5311           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
5312             if (!$viewhiddentimed) {
5313                 continue;
5314             }
5315         }
5316
5317         if ($groupmode) {
5318             if ($post->groupid == -1 or $groupmode == VISIBLEGROUPS or $accessallgroups) {
5319                 // oki (Open discussions have groupid -1)
5320             } else {
5321                 // separate mode
5322                 if (isguestuser()) {
5323                     // shortcut
5324                     continue;
5325                 }
5326
5327                 if (!array_key_exists($post->groupid, $modinfo->groups[0])) {
5328                     continue;
5329                 }
5330             }
5331         }
5332
5333         $printposts[] = $post;
5334     }
5335
5336     if (!$printposts) {
5337         return;
5338     }
5339
5340     $aname = format_string($cm->name,true);
5341
5342     foreach ($printposts as $post) {
5343         $tmpactivity = new object();
5344
5345         $tmpactivity->type         = 'forum';
5346         $tmpactivity->cmid         = $cm->id;
5347         $tmpactivity->name         = $aname;
5348         $tmpactivity->sectionnum   = $cm->sectionnum;
5349         $tmpactivity->timestamp    = $post->modified;
5350
5351         $tmpactivity->content = new object();
5352         $tmpactivity->content->id         = $post->id;
5353         $tmpactivity->content->discussion = $post->discussion;
5354         $tmpactivity->content->subject    = format_string($post->subject);
5355         $tmpactivity->content->parent     = $post->parent;
5356
5357         $tmpactivity->user = new object();
5358         $tmpactivity->user->id        = $post->userid;
5359         $tmpactivity->user->firstname = $post->firstname;
5360         $tmpactivity->user->lastname  = $post->lastname;
5361         $tmpactivity->user->picture   = $post->picture;
5362         $tmpactivity->user->imagealt  = $post->imagealt;
5363         $tmpactivity->user->email     = $post->email;
5364
5365         $activities[$index++] = $tmpactivity;
5366     }
5367
5368     return;
5369 }
5370
5371 /**
5372  *
5373  */
5374 function forum_print_recent_mod_activity($activity, $courseid, $detail, $modnames, $viewfullnames) {
5375     global $CFG;
5376
5377     if ($activity->content->parent) {
5378         $class = 'reply';
5379     } else {
5380         $class = 'discussion';
5381     }
5382
5383     echo '<table border="0" cellpadding="3" cellspacing="0" class="forum-recent">';
5384
5385     echo "<tr><td class=\"userpicture\" valign=\"top\">";
5386     print_user_picture($activity->user, $courseid);
5387     echo "</td><td class=\"$class\">";
5388
5389     echo '<div class="title">';
5390     if ($detail) {
5391         $aname = s($activity->name);
5392         echo "<img src=\"$CFG->modpixpath/$activity->type/icon.gif\" ".
5393              "class=\"icon\" alt=\"{$aname}\" />";
5394     }
5395     echo "<a href=\"$CFG->wwwroot/mod/forum/discuss.php?d={$activity->content->discussion}"
5396          ."#p{$activity->content->id}\">{$activity->content->subject}</a>";
5397     echo '</div>';
5398
5399     echo '<div class="user">';
5400     $fullname = fullname($activity->user, $viewfullnames);
5401     echo "<a href=\"$CFG->wwwroot/user/view.php?id={$activity->user->id}&amp;course=$courseid\">"
5402          ."{$fullname}</a> - ".userdate($activity->timestamp);
5403     echo '</div>';
5404       echo "</td></tr></table>";
5405
5406     return;
5407 }
5408
5409 /**
5410  * recursively sets the discussion field to $discussionid on $postid and all its children
5411  * used when pruning a post
5412  */
5413 function forum_change_discussionid($postid, $discussionid) {
5414     set_field('forum_posts', 'discussion', $discussionid, 'id', $postid);
5415     if ($posts = get_records('forum_posts', 'parent', $postid)) {
5416         foreach ($posts as $post) {
5417             forum_change_discussionid($post->id, $discussionid);
5418         }
5419     }
5420     return true;
5421 }
5422
5423 /**
5424  * Prints the editing button on subscribers page
5425  */
5426 function forum_update_subscriptions_button($courseid, $forumid) {
5427     global $CFG, $USER;
5428
5429     if (!empty($USER->subscriptionsediting)) {
5430         $string = get_string('turneditingoff');
5431         $edit = "off";
5432     } else {
5433         $string = get_string('turneditingon');
5434         $edit = "on";
5435     }
5436
5437     return "<form $CFG->frametarget method=\"get\" action=\"$CFG->wwwroot/mod/forum/subscribers.php\">".
5438            "<input type=\"hidden\" name=\"id\" value=\"$forumid\" />".
5439            "<input type=\"hidden\" name=\"edit\" value=\"$edit\" />".
5440            "<input type=\"submit\" value=\"$string\" /></form>";
5441 }
5442
5443 /*
5444  * This function gets run whenever a role is assigned to a user in a context
5445  *
5446  * @param integer $userid
5447  * @param object $context
5448  * @return bool
5449  */
5450 function forum_role_assign($userid, $context, $roleid) {
5451     // check to see if this role comes with mod/forum:initialsubscriptions
5452     $cap = role_context_capabilities($roleid, $context, 'mod/forum:initialsubscriptions');
5453     $cap1 = role_context_capabilities($roleid, $context, 'moodle/course:view');
5454     // we are checking the role because has_capability() will pull this capability out
5455     // from other roles this user might have and resolve them, which is no good
5456     // the role needs course view to
5457     if (isset($cap['mod/forum:initialsubscriptions']) && $cap['mod/forum:initialsubscriptions'] == CAP_ALLOW &&
5458         isset($cap1['moodle/course:view']) && $cap1['moodle/course:view'] == CAP_ALLOW) {
5459         return forum_add_user_default_subscriptions($userid, $context);
5460     } else {
5461         // MDL-8981, do not subscribe to forum
5462         return true;
5463     }
5464 }
5465
5466
5467 /**
5468  * This function gets run whenever a role is assigned to a user in a context
5469  *
5470  * @param integer $userid
5471  * @param object $context
5472  * @return bool
5473  */
5474 function forum_role_unassign($userid, $context) {
5475     if (empty($context->contextlevel)) {
5476         return false;
5477     }
5478
5479     forum_remove_user_subscriptions($userid, $context);
5480     forum_remove_user_tracking($userid, $context);
5481
5482     return true;
5483 }
5484
5485
5486 /**
5487  * Add subscriptions for new users
5488  */
5489 function forum_add_user_default_subscriptions($userid, $context) {
5490
5491     if (empty($context->contextlevel)) {
5492         return false;
5493     }
5494
5495     switch ($context->contextlevel) {
5496
5497         case CONTEXT_SYSTEM:   // For the whole site
5498              $rs = get_recordset('course', '', '', '', 'id');
5499              while ($course = rs_fetch_next_record($rs)) {
5500                  $subcontext = get_context_instance(CONTEXT_COURSE, $course->id);
5501                  forum_add_user_default_subscriptions($userid, $subcontext);
5502              }
5503              rs_close($rs);
5504              break;
5505
5506         case CONTEXT_COURSECAT:   // For a whole category
5507             $rs = get_recordset('course', 'category', $context->instanceid, '', 'id');
5508             while ($course = rs_fetch_next_record($rs)) {
5509                 $subcontext = get_context_instance(CONTEXT_COURSE, $course->id);
5510                 forum_add_user_default_subscriptions($userid, $subcontext);
5511             }
5512             rs_close($rs);
5513              if ($categories = get_records('course_categories', 'parent', $context->instanceid)) {
5514                  foreach ($categories as $category) {
5515                      $subcontext = get_context_instance(CONTEXT_COURSECAT, $category->id);
5516                      forum_add_user_default_subscriptions($userid, $subcontext);
5517                  }
5518              }
5519              break;
5520
5521
5522         case CONTEXT_COURSE:   // For a whole course
5523              if ($course = get_record('course', 'id', $context->instanceid)) {
5524                  if ($forums = get_all_instances_in_course('forum', $course, $userid, false)) {
5525                      foreach ($forums as $forum) {
5526                          if ($forum->forcesubscribe != FORUM_INITIALSUBSCRIBE) {
5527                              continue;
5528                          }
5529                          if ($modcontext = get_context_instance(CONTEXT_MODULE, $forum->coursemodule)) {
5530                              if (has_capability('mod/forum:viewdiscussion', $modcontext, $userid)) {
5531                                  forum_subscribe($userid, $forum->id);
5532                              }
5533                          }
5534                      }
5535                  }
5536              }
5537              break;
5538
5539         case CONTEXT_MODULE:   // Just one forum
5540              if ($cm = get_coursemodule_from_id('forum', $context->instanceid)) {
5541                  if ($forum = get_record('forum', 'id', $cm->instance)) {
5542                      if ($forum->forcesubscribe != FORUM_INITIALSUBSCRIBE) {
5543                          continue;
5544                      }
5545                      if (has_capability('mod/forum:viewdiscussion', $context, $userid)) {
5546                          forum_subscribe($userid, $forum->id);
5547                      }
5548                  }
5549              }
5550              break;
5551     }
5552
5553     return true;
5554 }
5555
5556
5557 /**
5558  * Remove subscriptions for a user in a context
5559  */
5560 function forum_remove_user_subscriptions($userid, $context) {
5561
5562     global $CFG;
5563
5564     if (empty($context->contextlevel)) {
5565         return false;
5566     }
5567
5568     switch ($context->contextlevel) {
5569
5570         case CONTEXT_SYSTEM:   // For the whole site
5571             //if ($courses = get_my_courses($userid)) {
5572             // find all courses in which this user has a forum subscription
5573             if ($courses = get_records_sql("SELECT c.id
5574                                               FROM {$CFG->prefix}course c,
5575                                                    {$CFG->prefix}forum_subscriptions fs,
5576                                                    {$CFG->prefix}forum f
5577                                                    WHERE c.id = f.course AND f.id = fs.forum AND fs.userid = $userid
5578                                                    GROUP BY c.id")) {
5579
5580                 foreach ($courses as $course) {
5581                     $subcontext = get_context_instance(CONTEXT_COURSE, $course->id);
5582                     forum_remove_user_subscriptions($userid, $subcontext);
5583                 }
5584             }
5585             break;
5586
5587         case CONTEXT_COURSECAT:   // For a whole category
5588              if ($courses = get_records('course', 'category', $context->instanceid, '', 'id')) {
5589                  foreach ($courses as $course) {
5590                      $subcontext = get_context_instance(CONTEXT_COURSE, $course->id);
5591                      forum_remove_user_subscriptions($userid, $subcontext);
5592                  }
5593              }
5594              if ($categories = get_records('course_categories', 'parent', $context->instanceid, '', 'id')) {
5595                  foreach ($categories as $category) {
5596                      $subcontext = get_context_instance(CONTEXT_COURSECAT, $category->id);
5597                      forum_remove_user_subscriptions($userid, $subcontext);
5598                  }
5599              }
5600              break;
5601
5602         case CONTEXT_COURSE:   // For a whole course
5603              if ($course = get_record('course', 'id', $context->instanceid, '', '', '', '', 'id')) {
5604                 // find all forums in which this user has a subscription, and its coursemodule id
5605                 if ($forums = get_records_sql("SELECT f.id, cm.id as coursemodule
5606                                                  FROM {$CFG->prefix}forum f,
5607                                                       {$CFG->prefix}modules m,
5608                                                       {$CFG->prefix}course_modules cm,
5609                                                       {$CFG->prefix}forum_subscriptions fs
5610                                                 WHERE fs.userid = $userid AND f.course = $context->instanceid
5611                                                       AND fs.forum = f.id AND cm.instance = f.id
5612                                                       AND cm.module = m.id AND m.name = 'forum'")) {
5613
5614                      foreach ($forums as $forum) {
5615                          if ($modcontext = get_context_instance(CONTEXT_MODULE, $forum->coursemodule)) {
5616                              if (!has_capability('mod/forum:viewdiscussion', $modcontext, $userid)) {
5617                                  forum_unsubscribe($userid, $forum->id);
5618                              }
5619                          }
5620                      }
5621                  }
5622              }
5623              break;
5624
5625         case CONTEXT_MODULE:   // Just one forum
5626              if ($cm = get_coursemodule_from_id('forum', $context->instanceid)) {
5627                  if ($forum = get_record('forum', 'id', $cm->instance)) {
5628                      if (!has_capability('mod/forum:viewdiscussion', $context, $userid)) {
5629                          forum_unsubscribe($userid, $forum->id);
5630                      }
5631                  }
5632              }
5633              break;
5634     }
5635
5636     return true;
5637 }
5638
5639 // Functions to do with read tracking.
5640
5641 /**
5642  * Remove post tracking for a user in a context
5643  */
5644 function forum_remove_user_tracking($userid, $context) {
5645
5646     global $CFG;
5647
5648     if (empty($context->contextlevel)) {
5649         return false;
5650     }
5651
5652     switch ($context->contextlevel) {
5653
5654         case CONTEXT_SYSTEM:   // For the whole site
5655             // find all courses in which this user has tracking info
5656             $allcourses = array();
5657             if ($courses = get_records_sql("SELECT c.id
5658                                               FROM {$CFG->prefix}course c,
5659                                                    {$CFG->prefix}forum_read fr,
5660                                                    {$CFG->prefix}forum f
5661                                                    WHERE c.id = f.course AND f.id = fr.forumid AND fr.userid = $userid
5662                                                    GROUP BY c.id")) {
5663
5664                 $allcourses = $allcourses + $courses;
5665             }
5666             if ($courses = get_records_sql("SELECT c.id
5667                                               FROM {$CFG->prefix}course c,
5668                                                    {$CFG->prefix}forum_track_prefs ft,
5669                                                    {$CFG->prefix}forum f
5670                                              WHERE c.id = f.course AND f.id = ft.forumid AND ft.userid = $userid")) {
5671
5672                 $allcourses = $allcourses + $courses;
5673             }
5674             foreach ($allcourses as $course) {
5675                 $subcontext = get_context_instance(CONTEXT_COURSE, $course->id);
5676                 forum_remove_user_tracking($userid, $subcontext);
5677             }
5678             break;
5679
5680         case CONTEXT_COURSECAT:   // For a whole category
5681              if ($courses = get_records('course', 'category', $context->instanceid, '', 'id')) {
5682                  foreach ($courses as $course) {
5683                      $subcontext = get_context_instance(CONTEXT_COURSE, $course->id);
5684                      forum_remove_user_tracking($userid, $subcontext);
5685                  }
5686              }
5687              if ($categories = get_records('course_categories', 'parent', $context->instanceid, '', 'id')) {
5688                  foreach ($categories as $category) {
5689                      $subcontext = get_context_instance(CONTEXT_COURSECAT, $category->id);
5690                      forum_remove_user_tracking($userid, $subcontext);
5691                  }
5692              }
5693              break;
5694
5695         case CONTEXT_COURSE:   // For a whole course
5696              if ($course = get_record('course', 'id', $context->instanceid, '', '', '', '', 'id')) {
5697                 // find all forums in which this user has reading tracked
5698                 if ($forums = get_records_sql("SELECT f.id, cm.id as coursemodule
5699                                                  FROM {$CFG->prefix}forum f,
5700                                                       {$CFG->prefix}modules m,
5701                                                       {$CFG->prefix}course_modules cm,
5702                                                       {$CFG->prefix}forum_read fr
5703                                                 WHERE fr.userid = $userid AND f.course = $context->instanceid
5704                                                       AND fr.forumid = f.id AND cm.instance = f.id
5705                                                       AND cm.module = m.id AND m.name = 'forum'")) {
5706
5707                      foreach ($forums as $forum) {
5708                          if ($modcontext = get_context_instance(CONTEXT_MODULE, $forum->coursemodule)) {
5709                              if (!has_capability('mod/forum:viewdiscussion', $modcontext, $userid)) {
5710                                 forum_tp_delete_read_records($userid, -1, -1, $forum->id);
5711                              }
5712                          }
5713                      }
5714                  }
5715
5716                 // find all forums in which this user has a disabled tracking
5717                 if ($forums = get_records_sql("SELECT f.id, cm.id as coursemodule
5718                                                  FROM {$CFG->prefix}forum f,
5719                                                       {$CFG->prefix}modules m,
5720                                                       {$CFG->prefix}course_modules cm,
5721                                                       {$CFG->prefix}forum_track_prefs ft
5722                                                 WHERE ft.userid = $userid AND f.course = $context->instanceid
5723                                                       AND ft.forumid = f.id AND cm.instance = f.id
5724                                                       AND cm.module = m.id AND m.name = 'forum'")) {
5725
5726                      foreach ($forums as $forum) {
5727                          if ($modcontext = get_context_instance(CONTEXT_MODULE, $forum->coursemodule)) {
5728                              if (!has_capability('mod/forum:viewdiscussion', $modcontext, $userid)) {
5729                                 delete_records('forum_track_prefs', 'userid', $userid, 'forumid', $forum->id);
5730                              }
5731                          }
5732                      }
5733                  }
5734              }
5735              break;
5736
5737         case CONTEXT_MODULE:   // Just one forum
5738              if ($cm = get_coursemodule_from_id('forum', $context->instanceid)) {
5739                  if ($forum = get_record('forum', 'id', $cm->instance)) {
5740                      if (!has_capability('mod/forum:viewdiscussion', $context, $userid)) {
5741                         delete_records('forum_track_prefs', 'userid', $userid, 'forumid', $forum->id);
5742                         forum_tp_delete_read_records($userid, -1, -1, $forum->id);
5743                      }
5744                  }
5745              }
5746              break;
5747     }
5748
5749     return true;
5750 }
5751
5752 /**
5753  * Mark posts as read.
5754  * @param object $user object
5755  * @param array $postids array of post ids
5756  * @return boolean success
5757  */
5758 function forum_tp_mark_posts_read($user, $postids) {
5759     global $CFG;
5760
5761     if (!forum_tp_can_track_forums(false, $user)) {
5762         return true;
5763     }
5764
5765     $status = true;
5766
5767     $now = time();
5768     $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
5769
5770     if (empty($postids)) {
5771         return true;
5772
5773     } else if (count($postids) > 200) {
5774         while ($part = array_splice($postids, 0, 200)) {
5775             $status = forum_tp_mark_posts_read($user, $part) && $status;
5776         }
5777         return $status;
5778     }
5779
5780     $sql = "SELECT id
5781               FROM {$CFG->prefix}forum_read
5782              WHERE userid = $user->id AND postid IN (".implode(',', $postids).")";
5783     if ($existing = get_records_sql($sql)) {
5784         $existing = array_keys($existing);
5785     } else {
5786         $existing = array();
5787     }
5788
5789     $new = array_diff($postids, $existing);
5790
5791     if ($new) {
5792         $sql = "INSERT INTO {$CFG->prefix}forum_read (userid, postid, discussionid, forumid, firstread, lastread)
5793
5794                 SELECT $user->id, p.id, p.discussion, d.forum, $now, $now
5795                   FROM {$CFG->prefix}forum_posts p
5796                        JOIN {$CFG->prefix}forum_discussions d       ON d.id = p.discussion
5797                        JOIN {$CFG->prefix}forum f                   ON f.id = d.forum
5798                        LEFT JOIN {$CFG->prefix}forum_track_prefs tf ON (tf.userid = $user->id AND tf.forumid = f.id)
5799                  WHERE p.id IN (".implode(',', $new).")
5800                        AND p.modified >= $cutoffdate
5801                        AND (f.trackingtype = ".FORUM_TRACKING_ON."
5802                             OR (f.trackingtype = ".FORUM_TRACKING_OPTIONAL." AND tf.id IS NULL))";
5803         $status = execute_sql($sql, false) && $status;
5804     }
5805
5806     if ($existing) {
5807         $sql = "UPDATE {$CFG->prefix}forum_read
5808                    SET lastread = $now
5809                  WHERE userid = $user->id AND postid IN (".implode(',', $existing).")";
5810         $status = execute_sql($sql, false) && $status;
5811     }
5812
5813     return $status;
5814 }
5815
5816 /**
5817  * Mark post as read.
5818  */
5819 function forum_tp_add_read_record($userid, $postid) {
5820     global $CFG;
5821
5822     $now = time();
5823     $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
5824
5825     if (!record_exists('forum_read', 'userid', $userid, 'postid', $postid)) {
5826         $sql = "INSERT INTO {$CFG->prefix}forum_read (userid, postid, discussionid, forumid, firstread, lastread)
5827
5828                 SELECT $userid, p.id, p.discussion, d.forum, $now, $now
5829                   FROM {$CFG->prefix}forum_posts p
5830                        JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
5831                  WHERE p.id = $postid AND p.modified >= $cutoffdate";
5832         return execute_sql($sql, false);
5833
5834     } else {
5835         $sql = "UPDATE {$CFG->prefix}forum_read
5836                    SET lastread = $now
5837                  WHERE userid = $userid AND postid = $userid";
5838         return execute_sql($sql, false);
5839     }
5840 }
5841
5842 /**
5843  * Returns all records in the 'forum_read' table matching the passed keys, indexed
5844  * by userid.
5845  */
5846 function forum_tp_get_read_records($userid=-1, $postid=-1, $discussionid=-1, $forumid=-1) {
5847     $select = '';
5848     if ($userid > -1) {
5849         if ($select != '') $select .= ' AND ';
5850         $select .= 'userid = \''.$userid.'\'';
5851     }
5852     if ($postid > -1) {
5853         if ($select != '') $select .= ' AND ';
5854         $select .= 'postid = \''.$postid.'\'';
5855     }
5856     if ($discussionid > -1) {
5857         if ($select != '') $select .= ' AND ';
5858         $select .= 'discussionid = \''.$discussionid.'\'';
5859     }
5860     if ($forumid > -1) {
5861         if ($select != '') $select .= ' AND ';
5862         $select .= 'forumid = \''.$forumid.'\'';
5863     }
5864
5865     return get_records_select('forum_read', $select);
5866 }
5867
5868 /**
5869  * Returns all read records for the provided user and discussion, indexed by postid.
5870  */
5871 function forum_tp_get_discussion_read_records($userid, $discussionid) {
5872     $select = 'userid = \''.$userid.'\' AND discussionid = \''.$discussionid.'\'';
5873     $fields = 'postid, firstread, lastread';
5874     return get_records_select('forum_read', $select, '', $fields);
5875 }
5876
5877 /**
5878  * If its an old post, do nothing. If the record exists, the maintenance will clear it up later.
5879  */
5880 function forum_tp_mark_post_read($userid, $post, $forumid) {
5881     if (!forum_tp_is_post_old($post)) {
5882         return forum_tp_add_read_record($userid, $post->id);
5883     } else {
5884         return true;
5885     }
5886 }
5887
5888 /**
5889  * Marks a whole forum as read, for a given user
5890  */
5891 function forum_tp_mark_forum_read($user, $forumid, $groupid=false) {
5892     global $CFG;
5893
5894     $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
5895
5896     $groupsel = "";
5897     if ($groupid !== false) {
5898         $groupsel = " AND (d.groupid = $groupid OR d.groupid = -1)";
5899     }
5900
5901     $sql = "SELECT p.id
5902               FROM {$CFG->prefix}forum_posts p
5903                    LEFT JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
5904                    LEFT JOIN {$CFG->prefix}forum_read r        ON (r.postid = p.id AND r.userid = $user->id)
5905              WHERE d.forum = $forumid
5906                    AND p.modified >= $cutoffdate AND r.id is NULL
5907                    $groupsel";
5908
5909     if ($posts = get_records_sql($sql)) {
5910         $postids = array_keys($posts);
5911         return forum_tp_mark_posts_read($user, $postids);
5912     }
5913
5914     return true;
5915 }
5916
5917 /**
5918  * Marks a whole discussion as read, for a given user
5919  */
5920 function forum_tp_mark_discussion_read($user, $discussionid) {
5921     global $CFG;
5922
5923     $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
5924
5925     $sql = "SELECT p.id
5926               FROM {$CFG->prefix}forum_posts p
5927                    LEFT JOIN {$CFG->prefix}forum_read r ON (r.postid = p.id AND r.userid = $user->id)
5928              WHERE p.discussion = $discussionid
5929                    AND p.modified >= $cutoffdate AND r.id is NULL";
5930
5931     if ($posts = get_records_sql($sql)) {
5932         $postids = array_keys($posts);
5933         return forum_tp_mark_posts_read($user, $postids);
5934     }
5935
5936     return true;
5937 }
5938
5939 /**
5940  *
5941  */
5942 function forum_tp_is_post_read($userid, $post) {
5943     return (forum_tp_is_post_old($post) ||
5944             record_exists('forum_read', 'userid', $userid, 'postid', $post->id));
5945 }
5946
5947 /**
5948  *
5949  */
5950 function forum_tp_is_post_old($post, $time=null) {
5951     global $CFG;
5952
5953     if (is_null($time)) {
5954         $time = time();
5955     }
5956     return ($post->modified < ($time - ($CFG->forum_oldpostdays * 24 * 3600)));
5957 }
5958
5959 /**
5960  * Returns the count of records for the provided user and discussion.
5961  */
5962 function forum_tp_count_discussion_read_records($userid, $discussionid) {
5963     global $CFG;
5964
5965     $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
5966
5967     $sql = 'SELECT COUNT(DISTINCT p.id) '.
5968            'FROM '.$CFG->prefix.'forum_discussions d '.
5969            'LEFT JOIN '.$CFG->prefix.'forum_read r ON d.id = r.discussionid AND r.userid = '.$userid.' '.
5970            'LEFT JOIN '.$CFG->prefix.'forum_posts p ON p.discussion = d.id '.
5971                 'AND (p.modified < '.$cutoffdate.' OR p.id = r.postid) '.
5972            'WHERE d.id = '.$discussionid;
5973
5974     return (count_records_sql($sql));
5975 }
5976
5977 /**
5978  * Returns the count of records for the provided user and discussion.
5979  */
5980 function forum_tp_count_discussion_unread_posts($userid, $discussionid) {
5981     global $CFG;
5982
5983     $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
5984
5985     $sql = 'SELECT COUNT(p.id) '.
5986            'FROM '.$CFG->prefix.'forum_posts p '.
5987            'LEFT JOIN '.$CFG->prefix.'forum_read r ON r.postid = p.id AND r.userid = '.$userid.' '.
5988            'WHERE p.discussion = '.$discussionid.' '.
5989                 'AND p.modified >= '.$cutoffdate.' AND r.id is NULL';
5990
5991     return (count_records_sql($sql));
5992 }
5993
5994 /**
5995  * Returns the count of posts for the provided forum and [optionally] group.
5996  */
5997 function forum_tp_count_forum_posts($forumid, $groupid=false) {
5998     global $CFG;
5999
6000     $sql = 'SELECT COUNT(*) '.
6001            'FROM '.$CFG->prefix.'forum_posts fp,'.$CFG->prefix.'forum_discussions fd '.
6002            'WHERE fd.forum = '.$forumid.' AND fp.discussion = fd.id';
6003     if ($groupid !== false) {
6004         $sql .= ' AND (fd.groupid = '.$groupid.' OR fd.groupid = -1)';
6005     }
6006     $count = count_records_sql($sql);
6007
6008
6009     return $count;
6010 }
6011
6012 /**
6013  * Returns the count of records for the provided user and forum and [optionally] group.
6014  */
6015 function forum_tp_count_forum_read_records($userid, $forumid, $groupid=false) {
6016     global $CFG;
6017
6018     $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
6019
6020     $groupsel = '';
6021     if ($groupid !== false) {
6022         $groupsel = "AND (d.groupid = $groupid OR d.groupid = -1)";
6023     }
6024
6025     $sql = "SELECT COUNT(p.id)
6026               FROM  {$CFG->prefix}forum_posts p
6027                     JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
6028                     LEFT JOIN {$CFG->prefix}forum_read r   ON (r.postid = p.id AND r.userid= $userid)
6029               WHERE d.forum = $forumid
6030                     AND (p.modified < $cutoffdate OR (p.modified >= $cutoffdate AND r.id IS NOT NULL))
6031                     $groupsel";
6032
6033     return get_field_sql($sql);
6034 }
6035
6036 /**
6037  * Returns the count of records for the provided user and course.
6038  * Please note that group access is ignored!
6039  */
6040 function forum_tp_get_course_unread_posts($userid, $courseid) {
6041     global $CFG;
6042
6043     $now = round(time(), -2); // db cache friendliness
6044     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
6045
6046     if (!empty($CFG->forum_enabletimedposts)) {
6047         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
6048     } else {
6049         $timedsql = "";
6050     }
6051
6052     $sql = "SELECT f.id, COUNT(p.id) AS unread
6053               FROM {$CFG->prefix}forum_posts p
6054                    JOIN {$CFG->prefix}forum_discussions d       ON d.id = p.discussion
6055                    JOIN {$CFG->prefix}forum f                   ON f.id = d.forum
6056                    JOIN {$CFG->prefix}course c                  ON c.id = f.course
6057                    LEFT JOIN {$CFG->prefix}forum_read r         ON (r.postid = p.id AND r.userid = $userid)
6058                    LEFT JOIN {$CFG->prefix}forum_track_prefs tf ON (tf.userid = $userid AND tf.forumid = f.id)
6059              WHERE f.course = $courseid
6060                    AND p.modified >= $cutoffdate AND r.id is NULL
6061                    AND (f.trackingtype = ".FORUM_TRACKING_ON."
6062                         OR (f.trackingtype = ".FORUM_TRACKING_OPTIONAL." AND tf.id IS NULL))
6063                    $timedsql
6064           GROUP BY f.id";
6065
6066     if ($return = get_records_sql($sql)) {
6067         return $return;
6068     }
6069
6070     return array();
6071 }
6072
6073 /**
6074  * Returns the count of records for the provided user and forum and [optionally] group.
6075  */
6076 function forum_tp_count_forum_unread_posts($cm, $course) {
6077     global $CFG, $USER;
6078
6079     static $readcache = array();
6080
6081     $forumid = $cm->instance;
6082
6083     if (!isset($readcache[$course->id])) {
6084         $readcache[$course->id] = array();
6085         if ($counts = forum_tp_get_course_unread_posts($USER->id, $course->id)) {
6086             foreach ($counts as $count) {
6087                 $readcache[$course->id][$count->id] = $count->unread;
6088             }
6089         }
6090     }
6091
6092     if (empty($readcache[$course->id][$forumid])) {
6093         // no need to check group mode ;-)
6094         return 0;
6095     }
6096
6097     $groupmode = groups_get_activity_groupmode($cm, $course);
6098
6099     if ($groupmode != SEPARATEGROUPS) {
6100         return $readcache[$course->id][$forumid];
6101     }
6102
6103     if (has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
6104         return $readcache[$course->id][$forumid];
6105     }
6106
6107     require_once($CFG->dirroot.'/course/lib.php');
6108
6109     $modinfo =& get_fast_modinfo($course);
6110     if (is_null($modinfo->groups)) {
6111         $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
6112     }
6113
6114     if (empty($CFG->enablegroupings)) {
6115         $mygroups = $modinfo->groups[0];
6116     } else {
6117         if (array_key_exists($cm->groupingid, $modinfo->groups)) {
6118             $mygroups = $modinfo->groups[$cm->groupingid];
6119         } else {
6120             $mygroups = false; // Will be set below
6121         }
6122     }
6123
6124     // add all groups posts
6125     if (empty($mygroups)) {
6126         $mygroups = array(-1=>-1);
6127     } else {
6128         $mygroups[-1] = -1;
6129     }
6130     $mygroups = implode(',', $mygroups);
6131
6132
6133     $now = round(time(), -2); // db cache friendliness
6134     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
6135
6136     if (!empty($CFG->forum_enabletimedposts)) {
6137         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
6138     } else {
6139         $timedsql = "";
6140     }
6141
6142     $sql = "SELECT COUNT(p.id)
6143               FROM {$CFG->prefix}forum_posts p
6144                    JOIN {$CFG->prefix}forum_discussions d ON p.discussion = d.id
6145                    LEFT JOIN {$CFG->prefix}forum_read r   ON (r.postid = p.id AND r.userid = $USER->id)
6146              WHERE d.forum = $forumid
6147                    AND p.modified >= $cutoffdate AND r.id is NULL
6148                    $timedsql
6149                    AND d.groupid IN ($mygroups)";
6150
6151     return get_field_sql($sql);
6152 }
6153
6154 /**
6155  * Deletes read records for the specified index. At least one parameter must be specified.
6156  */
6157 function forum_tp_delete_read_records($userid=-1, $postid=-1, $discussionid=-1, $forumid=-1) {
6158     $select = '';
6159     if ($userid > -1) {
6160         if ($select != '') $select .= ' AND ';
6161         $select .= 'userid = \''.$userid.'\'';
6162     }
6163     if ($postid > -1) {
6164         if ($select != '') $select .= ' AND ';
6165         $select .= 'postid = \''.$postid.'\'';
6166     }
6167     if ($discussionid > -1) {
6168         if ($select != '') $select .= ' AND ';
6169         $select .= 'discussionid = \''.$discussionid.'\'';
6170     }
6171     if ($forumid > -1) {
6172         if ($select != '') $select .= ' AND ';
6173         $select .= 'forumid = \''.$forumid.'\'';
6174     }
6175     if ($select == '') {
6176         return false;
6177     }
6178     else {
6179         return delete_records_select('forum_read', $select);
6180     }
6181 }
6182 /**
6183  * Get a list of forums not tracked by the user.
6184  *
6185  * @param int $userid The id of the user to use.
6186  * @param int $courseid The id of the course being checked.
6187  * @return mixed An array indexed by forum id, or false.
6188  */
6189 function forum_tp_get_untracked_forums($userid, $courseid) {
6190     global $CFG;
6191
6192     $sql = "SELECT f.id
6193               FROM {$CFG->prefix}forum f
6194                    LEFT JOIN {$CFG->prefix}forum_track_prefs ft ON (ft.forumid = f.id AND ft.userid = $userid)
6195              WHERE f.course = $courseid
6196                    AND (f.trackingtype = ".FORUM_TRACKING_OFF."
6197                         OR (f.trackingtype = ".FORUM_TRACKING_OPTIONAL." AND ft.id IS NOT NULL))";
6198
6199     if ($forums = get_records_sql($sql)) {
6200         foreach ($forums as $forum) {
6201             $forums[$forum->id] = $forum;
6202         }
6203         return $forums;
6204
6205     } else {
6206         return array();
6207     }
6208 }
6209
6210 /**
6211  * Determine if a user can track forums and optionally a particular forum.
6212  * Checks the site settings, the user settings and the forum settings (if
6213  * requested).
6214  *
6215  * @param mixed $forum The forum object to test, or the int id (optional).
6216  * @param mixed $userid The user object to check for (optional).
6217  * @return boolean
6218  */
6219 function forum_tp_can_track_forums($forum=false, $user=false) {
6220     global $USER, $CFG;
6221
6222     // if possible, avoid expensive
6223     // queries
6224     if (empty($CFG->forum_trackreadposts)) {
6225         return false;
6226     }
6227
6228     if ($user === false) {
6229         $user = $USER;
6230     }
6231
6232     if (isguestuser($user) or empty($user->id)) {
6233         return false;
6234     }
6235
6236     if ($forum === false) {
6237         // general abitily to track forums
6238         return (bool)$user->trackforums;
6239     }
6240
6241
6242     // Work toward always passing an object...
6243     if (is_numeric($forum)) {
6244         debugging('Better use proper forum object.', DEBUG_DEVELOPER);
6245         $forum = get_record('forum', 'id', $forum, '','','','', 'id,trackingtype');
6246     }
6247
6248     $forumallows = ($forum->trackingtype == FORUM_TRACKING_OPTIONAL);
6249     $forumforced = ($forum->trackingtype == FORUM_TRACKING_ON);
6250
6251     return ($forumforced || $forumallows)  && !empty($user->trackforums);
6252 }
6253
6254 /**
6255  * Tells whether a specific forum is tracked by the user. A user can optionally
6256  * be specified. If not specified, the current user is assumed.
6257  *
6258  * @param mixed $forum If int, the id of the forum being checked; if object, the forum object
6259  * @param int $userid The id of the user being checked (optional).
6260  * @return boolean
6261  */
6262 function forum_tp_is_tracked($forum, $user=false) {
6263     global $USER, $CFG;
6264
6265     if ($user === false) {
6266         $user = $USER;
6267     }
6268
6269     if (isguestuser($user) or empty($user->id)) {
6270         return false;
6271     }
6272
6273     // Work toward always passing an object...
6274     if (is_numeric($forum)) {
6275         debugging('Better use proper forum object.', DEBUG_DEVELOPER);
6276         $forum = get_record('forum', 'id', $forum);
6277     }
6278
6279     if (!forum_tp_can_track_forums($forum, $user)) {
6280         return false;
6281     }
6282
6283     $forumallows = ($forum->trackingtype == FORUM_TRACKING_OPTIONAL);
6284     $forumforced = ($forum->trackingtype == FORUM_TRACKING_ON);
6285
6286     return $forumforced ||
6287            ($forumallows && get_record('forum_track_prefs', 'userid', $user->id, 'forumid', $forum->id) === false);
6288 }
6289
6290 /**
6291  *
6292  */
6293 function forum_tp_start_tracking($forumid, $userid=false) {
6294     global $USER;
6295
6296     if ($userid === false) {
6297         $userid = $USER->id;
6298     }
6299
6300     return delete_records('forum_track_prefs', 'userid', $userid, 'forumid', $forumid);
6301 }
6302
6303 /**
6304  *
6305  */
6306 function forum_tp_stop_tracking($forumid, $userid=false) {
6307     global $USER;
6308
6309     if ($userid === false) {
6310         $userid = $USER->id;
6311     }
6312
6313     if (!record_exists('forum_track_prefs', 'userid', $userid, 'forumid', $forumid)) {
6314         $track_prefs = new object();
6315         $track_prefs->userid = $userid;
6316         $track_prefs->forumid = $forumid;
6317         insert_record('forum_track_prefs', $track_prefs);
6318     }
6319
6320     return forum_tp_delete_read_records($userid, -1, -1, $forumid);
6321 }
6322
6323
6324 /**
6325  * Clean old records from the forum_read table.
6326  */
6327 function forum_tp_clean_read_records() {
6328     global $CFG;
6329
6330     if (!isset($CFG->forum_oldpostdays)) {
6331         return;
6332     }
6333 // Look for records older than the cutoffdate that are still in the forum_read table.
6334     $cutoffdate = time() - ($CFG->forum_oldpostdays*24*60*60);
6335
6336     //first get the oldest tracking present - we need tis to speedup the next delete query
6337     $sql = "SELECT MIN(fp.modified) AS first
6338               FROM {$CFG->prefix}forum_posts fp
6339                    JOIN {$CFG->prefix}forum_read fr ON fr.postid=fp.id";
6340     if (!$first = get_field_sql($sql)) {
6341         // nothing to delete;
6342         return;
6343     }
6344
6345     // now delete old tracking info
6346     $sql = "DELETE
6347               FROM {$CFG->prefix}forum_read
6348              WHERE postid IN (SELECT fp.id
6349                                 FROM {$CFG->prefix}forum_posts fp
6350                                WHERE fp.modified >= $first AND fp.modified < $cutoffdate)";
6351     execute_sql($sql, false);
6352 }
6353
6354 /**
6355  * Sets the last post for a given discussion
6356  **/
6357 function forum_discussion_update_last_post($discussionid) {
6358     global $CFG, $db;
6359
6360 // Check the given discussion exists
6361     if (!record_exists('forum_discussions', 'id', $discussionid)) {
6362         return false;
6363     }
6364
6365 // Use SQL to find the last post for this discussion
6366     $sql = 'SELECT id, userid, modified '.
6367            'FROM '.$CFG->prefix.'forum_posts '.
6368            'WHERE discussion='.$discussionid.' '.
6369            'ORDER BY modified DESC ';
6370
6371 // Lets go find the last post
6372     if (($lastpost = get_record_sql($sql, true))) {
6373         $discussionobject = new Object;
6374         $discussionobject->id = $discussionid;
6375         $discussionobject->usermodified = $lastpost->userid;
6376         $discussionobject->timemodified = $lastpost->modified;
6377         if (update_record('forum_discussions', $discussionobject)) {
6378             return $lastpost->id;
6379         }
6380     }
6381
6382 // To get here either we couldn't find a post for the discussion (weird)
6383 // or we couldn't update the discussion record (weird x2)
6384     return false;
6385 }
6386
6387
6388 /**
6389  *
6390  */
6391 function forum_get_view_actions() {
6392     return array('view discussion','search','forum','forums','subscribers');
6393 }
6394
6395 /**
6396  *
6397  */
6398 function forum_get_post_actions() {
6399     return array('add discussion','add post','delete discussion','delete post','move discussion','prune post','update post');
6400 }
6401
6402 /**
6403  * this function returns all the separate forum ids, given a courseid
6404  * @param int $courseid
6405  * @return array
6406  */
6407 function forum_get_separate_modules($courseid) {
6408
6409     global $CFG,$db;
6410     $forummodule = get_record("modules", "name", "forum");
6411
6412     $sql = 'SELECT f.id, f.id FROM '.$CFG->prefix.'forum f, '.$CFG->prefix.'course_modules cm WHERE
6413            f.id = cm.instance AND cm.module ='.$forummodule->id.' AND cm.visible = 1 AND cm.course = '.$courseid.'
6414            AND cm.groupmode ='.SEPARATEGROUPS;
6415
6416     return get_records_sql($sql);
6417
6418 }
6419
6420 /**
6421  *
6422  */
6423 function forum_check_throttling($forum, $cm=null) {
6424     global $USER, $CFG;
6425
6426     if (is_numeric($forum)) {
6427         $forum = get_record('forum','id',$forum);
6428     }
6429     if (!is_object($forum)) {
6430         return false;  // this is broken.
6431     }
6432
6433     if (empty($forum->blockafter)) {
6434         return true;
6435     }
6436
6437     if (empty($forum->blockperiod)) {
6438         return true;
6439     }
6440
6441     if (!$cm) {
6442         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
6443             error('Course Module ID was incorrect');
6444         }
6445     }
6446
6447     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
6448     if(!has_capability('mod/forum:throttlingapplies', $modcontext)) {
6449         return true;
6450     }
6451
6452     // get the number of posts in the last period we care about
6453     $timenow = time();
6454     $timeafter = $timenow - $forum->blockperiod;
6455
6456     $numposts = count_records_sql('SELECT COUNT(p.id) FROM '.$CFG->prefix.'forum_posts p'
6457                                   .' JOIN '.$CFG->prefix.'forum_discussions d'
6458                                   .' ON p.discussion = d.id WHERE d.forum = '.$forum->id
6459                                   .' AND p.userid = '.$USER->id.' AND p.created > '.$timeafter);
6460
6461     $a = new object();
6462     $a->blockafter = $forum->blockafter;
6463     $a->numposts = $numposts;
6464     $a->blockperiod = get_string('secondstotime'.$forum->blockperiod);
6465
6466     if ($forum->blockafter <= $numposts) {
6467         print_error('forumblockingtoomanyposts', 'error', $CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id, $a);
6468     }
6469     if ($forum->warnafter <= $numposts) {
6470         notify(get_string('forumblockingalmosttoomanyposts','forum',$a));
6471     }
6472
6473
6474 }
6475
6476
6477 /**
6478  * Removes all grades from gradebook
6479  * @param int $courseid
6480  * @param string optional type
6481  */
6482 function forum_reset_gradebook($courseid, $type='') {
6483     global $CFG;
6484
6485     $type = $type ? "AND f.type='$type'" : '';
6486
6487     $sql = "SELECT f.*, cm.idnumber as cmidnumber, f.course as courseid
6488               FROM {$CFG->prefix}forum f, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m
6489              WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id AND f.course=$courseid $type";
6490
6491     if ($forums = get_records_sql($sql)) {
6492         foreach ($forums as $forum) {
6493             forum_grade_item_update($forum, 'reset');
6494         }
6495     }
6496 }
6497
6498 /**
6499  * This function is used by the reset_course_userdata function in moodlelib.
6500  * This function will remove all posts from the specified forum
6501  * and clean up any related data.
6502  * @param $data the data submitted from the reset course.
6503  * @return array status array
6504  */
6505 function forum_reset_userdata($data) {
6506     global $CFG;
6507     require_once($CFG->libdir.'/filelib.php');
6508
6509     $componentstr = get_string('modulenameplural', 'forum');
6510     $status = array();
6511
6512     $removeposts = false;
6513     if (!empty($data->reset_forum_all)) {
6514         $removeposts = true;
6515         $typesql     = "";
6516         $typesstr    = get_string('resetforumsall', 'forum');
6517         $types       = array();
6518
6519     } else if (!empty($data->reset_forum_types)){
6520         $removeposts = true;
6521         $typesql     = "";
6522         $types       = array();
6523         $forum_types_all = forum_get_forum_types_all();
6524         foreach ($data->reset_forum_types as $type) {
6525             if (!array_key_exists($type, $forum_types_all)) {
6526                 continue;
6527             }
6528             $typesql .= " AND f.type='$type'";
6529             $types[] = $forum_types_all[$type];
6530         }
6531         $typesstr = get_string('resetforums', 'forum').': '.implode(', ', $types);
6532
6533     }
6534
6535     $alldiscussionssql = "SELECT fd.id
6536                             FROM {$CFG->prefix}forum_discussions fd, {$CFG->prefix}forum f
6537                            WHERE f.course={$data->courseid} AND f.id=fd.forum";
6538
6539     $allforumssql      = "SELECT f.id
6540                             FROM {$CFG->prefix}forum f
6541                            WHERE f.course={$data->courseid}";
6542
6543     $allpostssql       = "SELECT fp.id
6544                             FROM {$CFG->prefix}forum_posts fp, {$CFG->prefix}forum_discussions fd, {$CFG->prefix}forum f
6545                            WHERE f.course={$data->courseid} AND f.id=fd.forum AND fd.id=fp.discussion";
6546
6547     if ($removeposts) {
6548         $discussionssql = "$alldiscussionssql $typesql";
6549         $forumssql      = "$allforumssql $typesql";
6550         $postssql       = "$allpostssql $typesql";
6551
6552         // first delete all read flags
6553         delete_records_select('forum_read', "forumid IN ($forumssql)");
6554
6555         // remove tracking prefs
6556         delete_records_select('forum_track_prefs', "forumid IN ($forumssql)");
6557
6558         // remove posts from queue
6559         delete_records_select('forum_queue', "discussionid IN ($discussionssql)");
6560
6561         // remove ratings
6562         delete_records_select('forum_ratings', "post IN ($postssql)");
6563
6564         // all posts - initial posts must be kept in single simple discussion forums
6565         delete_records_select('forum_posts', "discussion IN ($discussionssql) AND parent <> 0"); // first all children
6566         delete_records_select('forum_posts', "discussion IN ($discussionssql AND f.type <> 'single') AND parent = 0"); // now the initial posts for non single simple
6567
6568         // finally all discussions except single simple forums
6569         delete_records_select('forum_discussions', "forum IN ($forumssql AND f.type <> 'single')");
6570
6571         // now get rid of all attachments
6572         if ($forums = get_records_sql($forumssql)) {
6573             foreach ($forums as $forumid=>$unused) {
6574                 fulldelete($CFG->dataroot.'/'.$data->courseid.'/moddata/forum/'.$forumid);
6575             }
6576         }
6577
6578         // remove all grades from gradebook
6579         if (empty($data->reset_gradebook_grades)) {
6580             if (empty($types)) {
6581                 forum_reset_gradebook($data->courseid);
6582             } else {
6583                 foreach ($types as $type) {
6584                     forum_reset_gradebook($data->courseid, $type);
6585                 }
6586             }
6587         }
6588
6589         $status[] = array('component'=>$componentstr, 'item'=>$typesstr, 'error'=>false);
6590     }
6591
6592     // remove all ratings
6593     if (!empty($data->reset_forum_ratings)) {
6594         delete_records_select('forum_ratings', "post IN ($allpostssql)");
6595         // remove all grades from gradebook
6596         if (empty($data->reset_gradebook_grades)) {
6597             forum_reset_gradebook($data->courseid);
6598         }
6599     }
6600
6601     // remove all subscriptions unconditionally - even for users still enrolled in course
6602     if (!empty($data->reset_forum_subscriptions)) {
6603         delete_records_select('forum_subscriptions', "forum IN ($allforumssql)");
6604         $status[] = array('component'=>$componentstr, 'item'=>get_string('resetsubscriptions','forum'), 'error'=>false);
6605     }
6606
6607     // remove all tracking prefs unconditionally - even for users still enrolled in course
6608     if (!empty($data->reset_forum_track_prefs)) {
6609         delete_records_select('forum_track_prefs', "forumid IN ($allforumssql)");
6610         $status[] = array('component'=>$componentstr, 'item'=>get_string('resettrackprefs','forum'), 'error'=>false);
6611     }
6612
6613     /// updating dates - shift may be negative too
6614     if ($data->timeshift) {
6615         shift_course_mod_dates('forum', array('assesstimestart', 'assesstimefinish'), $data->timeshift, $data->courseid);
6616         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
6617     }
6618
6619     return $status;
6620 }
6621
6622 /**
6623  * Called by course/reset.php
6624  * @param $mform form passed by reference
6625  */
6626 function forum_reset_course_form_definition(&$mform) {
6627     $mform->addElement('header', 'forumheader', get_string('modulenameplural', 'forum'));
6628
6629     $mform->addElement('checkbox', 'reset_forum_all', get_string('resetforumsall','forum'));
6630
6631     $mform->addElement('select', 'reset_forum_types', get_string('resetforums', 'forum'), forum_get_forum_types_all(), array('multiple' => 'multiple'));
6632     $mform->setAdvanced('reset_forum_types');
6633     $mform->disabledIf('reset_forum_types', 'reset_forum_all', 'checked');
6634
6635     $mform->addElement('checkbox', 'reset_forum_subscriptions', get_string('resetsubscriptions','forum'));
6636     $mform->setAdvanced('reset_forum_subscriptions');
6637
6638     $mform->addElement('checkbox', 'reset_forum_track_prefs', get_string('resettrackprefs','forum'));
6639     $mform->setAdvanced('reset_forum_track_prefs');
6640     $mform->disabledIf('reset_forum_track_prefs', 'reset_forum_all', 'checked');
6641
6642     $mform->addElement('checkbox', 'reset_forum_ratings', get_string('deleteallratings'));
6643     $mform->disabledIf('reset_forum_ratings', 'reset_forum_all', 'checked');
6644 }
6645
6646 /**
6647  * Course reset form defaults.
6648  */
6649 function forum_reset_course_form_defaults($course) {
6650     return array('reset_forum_all'=>1, 'reset_forum_subscriptions'=>0, 'reset_forum_track_prefs'=>0, 'reset_forum_ratings'=>1);
6651 }
6652
6653 /**
6654  * Converts a forum to use the Roles System
6655  * @param $forum        - a forum object with the same attributes as a record
6656  *                        from the forum database table
6657  * @param $forummodid   - the id of the forum module, from the modules table
6658  * @param $teacherroles - array of roles that have moodle/legacy:teacher
6659  * @param $studentroles - array of roles that have moodle/legacy:student
6660  * @param $guestroles   - array of roles that have moodle/legacy:guest
6661  * @param $cmid         - the course_module id for this forum instance
6662  * @return boolean      - forum was converted or not
6663  */
6664 function forum_convert_to_roles($forum, $forummodid, $teacherroles=array(),
6665                                 $studentroles=array(), $guestroles=array(), $cmid=NULL) {
6666
6667     global $CFG;
6668
6669     if (!isset($forum->open) && !isset($forum->assesspublic)) {
6670         // We assume that this forum has already been converted to use the
6671         // Roles System. Columns forum.open and forum.assesspublic get dropped
6672         // once the forum module has been upgraded to use Roles.
6673         return false;
6674     }
6675
6676     if ($forum->type == 'teacher') {
6677
6678         // Teacher forums should be converted to normal forums that
6679         // use the Roles System to implement the old behavior.
6680         // Note:
6681         //   Seems that teacher forums were never backed up in 1.6 since they
6682         //   didn't have an entry in the course_modules table.
6683         require_once($CFG->dirroot.'/course/lib.php');
6684
6685         if (count_records('forum_discussions', 'forum', $forum->id) == 0) {
6686             // Delete empty teacher forums.
6687             delete_records('forum', 'id', $forum->id);
6688         } else {
6689             // Create a course module for the forum and assign it to
6690             // section 0 in the course.
6691             $mod = new object;
6692             $mod->course = $forum->course;
6693             $mod->module = $forummodid;
6694             $mod->instance = $forum->id;
6695             $mod->section = 0;
6696             $mod->visible = 0;     // Hide the forum
6697             $mod->visibleold = 0;  // Hide the forum
6698             $mod->groupmode = 0;
6699
6700             if (!$cmid = add_course_module($mod)) {
6701                 error('Could not create new course module instance for the teacher forum');
6702             } else {
6703                 $mod->coursemodule = $cmid;
6704                 if (!$sectionid = add_mod_to_section($mod)) {
6705                     error('Could not add converted teacher forum instance to section 0 in the course');
6706                 } else {
6707                     if (!set_field('course_modules', 'section', $sectionid, 'id', $cmid)) {
6708                         error('Could not update course module with section id');
6709                     }
6710                 }
6711             }
6712
6713             // Change the forum type to general.
6714             $forum->type = 'general';
6715             if (!update_record('forum', $forum)) {
6716                 error('Could not change forum from type teacher to type general');
6717             }
6718
6719             $context = get_context_instance(CONTEXT_MODULE, $cmid);
6720
6721             // Create overrides for default student and guest roles (prevent).
6722             foreach ($studentroles as $studentrole) {
6723                 assign_capability('mod/forum:viewdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
6724                 assign_capability('mod/forum:viewhiddentimedposts', CAP_PREVENT, $studentrole->id, $context->id);
6725                 assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
6726                 assign_capability('mod/forum:replypost', CAP_PREVENT, $studentrole->id, $context->id);
6727                 assign_capability('mod/forum:viewrating', CAP_PREVENT, $studentrole->id, $context->id);
6728                 assign_capability('mod/forum:viewanyrating', CAP_PREVENT, $studentrole->id, $context->id);
6729                 assign_capability('mod/forum:rate', CAP_PREVENT, $studentrole->id, $context->id);
6730                 assign_capability('mod/forum:createattachment', CAP_PREVENT, $studentrole->id, $context->id);
6731                 assign_capability('mod/forum:deleteownpost', CAP_PREVENT, $studentrole->id, $context->id);
6732                 assign_capability('mod/forum:deleteanypost', CAP_PREVENT, $studentrole->id, $context->id);
6733                 assign_capability('mod/forum:splitdiscussions', CAP_PREVENT, $studentrole->id, $context->id);
6734                 assign_capability('mod/forum:movediscussions', CAP_PREVENT, $studentrole->id, $context->id);
6735                 assign_capability('mod/forum:editanypost', CAP_PREVENT, $studentrole->id, $context->id);
6736                 assign_capability('mod/forum:viewqandawithoutposting', CAP_PREVENT, $studentrole->id, $context->id);
6737                 assign_capability('mod/forum:viewsubscribers', CAP_PREVENT, $studentrole->id, $context->id);
6738                 assign_capability('mod/forum:managesubscriptions', CAP_PREVENT, $studentrole->id, $context->id);
6739                 assign_capability('mod/forum:throttlingapplies', CAP_PREVENT, $studentrole->id, $context->id);
6740             }
6741             foreach ($guestroles as $guestrole) {
6742                 assign_capability('mod/forum:viewdiscussion', CAP_PREVENT, $guestrole->id, $context->id);
6743                 assign_capability('mod/forum:viewhiddentimedposts', CAP_PREVENT, $guestrole->id, $context->id);
6744                 assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $guestrole->id, $context->id);
6745                 assign_capability('mod/forum:replypost', CAP_PREVENT, $guestrole->id, $context->id);
6746                 assign_capability('mod/forum:viewrating', CAP_PREVENT, $guestrole->id, $context->id);
6747                 assign_capability('mod/forum:viewanyrating', CAP_PREVENT, $guestrole->id, $context->id);
6748                 assign_capability('mod/forum:rate', CAP_PREVENT, $guestrole->id, $context->id);
6749                 assign_capability('mod/forum:createattachment', CAP_PREVENT, $guestrole->id, $context->id);
6750                 assign_capability('mod/forum:deleteownpost', CAP_PREVENT, $guestrole->id, $context->id);
6751                 assign_capability('mod/forum:deleteanypost', CAP_PREVENT, $guestrole->id, $context->id);
6752                 assign_capability('mod/forum:splitdiscussions', CAP_PREVENT, $guestrole->id, $context->id);
6753                 assign_capability('mod/forum:movediscussions', CAP_PREVENT, $guestrole->id, $context->id);
6754                 assign_capability('mod/forum:editanypost', CAP_PREVENT, $guestrole->id, $context->id);
6755                 assign_capability('mod/forum:viewqandawithoutposting', CAP_PREVENT, $guestrole->id, $context->id);
6756                 assign_capability('mod/forum:viewsubscribers', CAP_PREVENT, $guestrole->id, $context->id);
6757                 assign_capability('mod/forum:managesubscriptions', CAP_PREVENT, $guestrole->id, $context->id);
6758                 assign_capability('mod/forum:throttlingapplies', CAP_PREVENT, $guestrole->id, $context->id);
6759             }
6760         }
6761     } else {
6762         // Non-teacher forum.
6763
6764         if (empty($cmid)) {
6765             // We were not given the course_module id. Try to find it.
6766             if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
6767                 notify('Could not get the course module for the forum');
6768                 return false;
6769             } else {
6770                 $cmid = $cm->id;
6771             }
6772         }
6773         $context = get_context_instance(CONTEXT_MODULE, $cmid);
6774
6775         // $forum->open defines what students can do:
6776         //   0 = No discussions, no replies
6777         //   1 = No discussions, but replies are allowed
6778         //   2 = Discussions and replies are allowed
6779         switch ($forum->open) {
6780             case 0:
6781                 foreach ($studentroles as $studentrole) {
6782                     assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
6783                     assign_capability('mod/forum:replypost', CAP_PREVENT, $studentrole->id, $context->id);
6784                 }
6785                 break;
6786             case 1:
6787                 foreach ($studentroles as $studentrole) {
6788                     assign_capability('mod/forum:startdiscussion', CAP_PREVENT, $studentrole->id, $context->id);
6789                     assign_capability('mod/forum:replypost', CAP_ALLOW, $studentrole->id, $context->id);
6790                 }
6791                 break;
6792             case 2:
6793                 foreach ($studentroles as $studentrole) {
6794                     assign_capability('mod/forum:startdiscussion', CAP_ALLOW, $studentrole->id, $context->id);
6795                     assign_capability('mod/forum:replypost', CAP_ALLOW, $studentrole->id, $context->id);
6796                 }
6797                 break;
6798         }
6799
6800         // $forum->assessed defines whether forum rating is turned
6801         // on (1 or 2) and who can rate posts:
6802         //   1 = Everyone can rate posts
6803         //   2 = Only teachers can rate posts
6804         switch ($forum->assessed) {
6805             case 1:
6806                 foreach ($studentroles as $studentrole) {
6807                     assign_capability('mod/forum:rate', CAP_ALLOW, $studentrole->id, $context->id);
6808                 }
6809                 foreach ($teacherroles as $teacherrole) {
6810                     assign_capability('mod/forum:rate', CAP_ALLOW, $teacherrole->id, $context->id);
6811                 }
6812                 break;
6813             case 2:
6814                 foreach ($studentroles as $studentrole) {
6815                     assign_capability('mod/forum:rate', CAP_PREVENT, $studentrole->id, $context->id);
6816                 }
6817                 foreach ($teacherroles as $teacherrole) {
6818                     assign_capability('mod/forum:rate', CAP_ALLOW, $teacherrole->id, $context->id);
6819                 }
6820                 break;
6821         }
6822
6823         // $forum->assesspublic defines whether students can see
6824         // everybody's ratings:
6825         //   0 = Students can only see their own ratings
6826         //   1 = Students can see everyone's ratings
6827         switch ($forum->assesspublic) {
6828             case 0:
6829                 foreach ($studentroles as $studentrole) {
6830                     assign_capability('mod/forum:viewanyrating', CAP_PREVENT, $studentrole->id, $context->id);
6831                 }
6832                 foreach ($teacherroles as $teacherrole) {
6833                     assign_capability('mod/forum:viewanyrating', CAP_ALLOW, $teacherrole->id, $context->id);
6834                 }
6835                 break;
6836             case 1:
6837                 foreach ($studentroles as $studentrole) {
6838                     assign_capability('mod/forum:viewanyrating', CAP_ALLOW, $studentrole->id, $context->id);
6839                 }
6840                 foreach ($teacherroles as $teacherrole) {
6841                     assign_capability('mod/forum:viewanyrating', CAP_ALLOW, $teacherrole->id, $context->id);
6842                 }
6843                 break;
6844         }
6845
6846         if (empty($cm)) {
6847             $cm = get_record('course_modules', 'id', $cmid);
6848         }
6849
6850         // $cm->groupmode:
6851         // 0 - No groups
6852         // 1 - Separate groups
6853         // 2 - Visible groups
6854         switch ($cm->groupmode) {
6855             case 0:
6856                 break;
6857             case 1:
6858                 foreach ($studentroles as $studentrole) {
6859                     assign_capability('moodle/site:accessallgroups', CAP_PREVENT, $studentrole->id, $context->id);
6860                 }
6861                 foreach ($teacherroles as $teacherrole) {
6862                     assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
6863                 }
6864                 break;
6865             case 2:
6866                 foreach ($studentroles as $studentrole) {
6867                     assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $studentrole->id, $context->id);
6868                 }
6869                 foreach ($teacherroles as $teacherrole) {
6870                     assign_capability('moodle/site:accessallgroups', CAP_ALLOW, $teacherrole->id, $context->id);
6871                 }
6872                 break;
6873         }
6874     }
6875     return true;
6876 }
6877
6878 /**
6879  * Returns array of forum aggregate types
6880  */
6881 function forum_get_aggregate_types() {
6882     return array (FORUM_AGGREGATE_NONE  => get_string('aggregatenone', 'forum'),
6883                   FORUM_AGGREGATE_AVG   => get_string('aggregateavg', 'forum'),
6884                   FORUM_AGGREGATE_COUNT => get_string('aggregatecount', 'forum'),
6885                   FORUM_AGGREGATE_MAX   => get_string('aggregatemax', 'forum'),
6886                   FORUM_AGGREGATE_MIN   => get_string('aggregatemin', 'forum'),
6887                   FORUM_AGGREGATE_SUM   => get_string('aggregatesum', 'forum'));
6888 }
6889
6890 /**
6891  * Returns array of forum layout modes
6892  */
6893 function forum_get_layout_modes() {
6894     return array (FORUM_MODE_FLATOLDEST => get_string('modeflatoldestfirst', 'forum'),
6895                   FORUM_MODE_FLATNEWEST => get_string('modeflatnewestfirst', 'forum'),
6896                   FORUM_MODE_THREADED   => get_string('modethreaded', 'forum'),
6897                   FORUM_MODE_NESTED     => get_string('modenested', 'forum'));
6898 }
6899
6900 /**
6901  * Returns array of forum types
6902  */
6903 function forum_get_forum_types() {
6904     return array ('general'  => get_string('generalforum', 'forum'),
6905                   'eachuser' => get_string('eachuserforum', 'forum'),
6906                   'single'   => get_string('singleforum', 'forum'),
6907                   'qanda'    => get_string('qandaforum', 'forum'));
6908 }
6909
6910 /**
6911  * Returns array of all forum layout modes
6912  */
6913 function forum_get_forum_types_all() {
6914     return array ('news'     => get_string('namenews','forum'),
6915                   'social'   => get_string('namesocial','forum'),
6916                   'general'  => get_string('generalforum', 'forum'),
6917                   'eachuser' => get_string('eachuserforum', 'forum'),
6918                   'single'   => get_string('singleforum', 'forum'),
6919                   'qanda'    => get_string('qandaforum', 'forum'));
6920 }
6921
6922 /**
6923  * Returns array of forum open modes
6924  */
6925 function forum_get_open_modes() {
6926     return array ('2' => get_string('openmode2', 'forum'),
6927                   '1' => get_string('openmode1', 'forum'),
6928                   '0' => get_string('openmode0', 'forum') );
6929 }
6930
6931 /**
6932  * Returns all other caps used in module
6933  */
6934 function forum_get_extra_capabilities() {
6935     return array('moodle/site:accessallgroups', 'moodle/site:viewfullnames', 'moodle/site:trustcontent');
6936 }
6937
6938 ?>