MDL-14679 fixed references to mod.html
[moodle.git] / mod / forum / lib.php
1 <?php  // $Id$
3 require_once($CFG->libdir.'/filelib.php');
5 /// CONSTANTS ///////////////////////////////////////////////////////////
7 define('FORUM_MODE_FLATOLDEST', 1);
8 define('FORUM_MODE_FLATNEWEST', -1);
9 define('FORUM_MODE_THREADED', 2);
10 define('FORUM_MODE_NESTED', 3);
12 define('FORUM_FORCESUBSCRIBE', 1);
13 define('FORUM_INITIALSUBSCRIBE', 2);
14 define('FORUM_DISALLOWSUBSCRIBE',3);
16 define('FORUM_TRACKING_OFF', 0);
17 define('FORUM_TRACKING_OPTIONAL', 1);
18 define('FORUM_TRACKING_ON', 2);
20 define('FORUM_UNSET_POST_RATING', -999);
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);
29 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
31 /**
32  * Given an object containing all the necessary data,
33  * (defined by the form in mod_form.php) 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;
42     $forum->timemodified = time();
44     if (empty($forum->assessed)) {
45         $forum->assessed = 0;
46     }
48     if (empty($forum->ratingtime) or empty($forum->assessed)) {
49         $forum->assesstimestart  = 0;
50         $forum->assesstimefinish = 0;
51     }
53     if (!$forum->id = insert_record('forum', $forum)) {
54         return false;
55     }
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;
68         if (! forum_add_discussion($discussion, $discussion->intro)) {
69             error('Could not add the discussion for this forum');
70         }
71     }
73     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
74         // all users should be subscribed initially
75         $users = get_users_by_capability(get_context_instance(CONTEXT_COURSE, $forum->course),
76                                          'mod/forum:initialsubscriptions', 'u.id', '', '','','',null, false);
77         foreach ($users as $user) {
78             forum_subscribe($user->id, $forum->id);
79         }
80     }
82     $forum = stripslashes_recursive($forum);
83     forum_grade_item_update($forum);
85     return $forum->id;
86 }
89 /**
90  * Given an object containing all the necessary data,
91  * (defined by the form in mod_form.php) this function
92  * will update an existing instance with new data.
93  * @param object $forum forum instance (with magic quotes)
94  * @return bool success
95  */
96 function forum_update_instance($forum) {
97     $forum->timemodified = time();
98     $forum->id           = $forum->instance;
100     if (empty($forum->assessed)) {
101         $forum->assessed = 0;
102     }
104     if (empty($forum->ratingtime) or empty($forum->assessed)) {
105         $forum->assesstimestart  = 0;
106         $forum->assesstimefinish = 0;
107     }
109     $oldforum = get_record('forum', 'id', $forum->id);
111     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
112     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
113     // 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
114     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
115         forum_update_grades($forum); // recalculate grades for the forum
116     }
118     if ($forum->type == 'single') {  // Update related discussion and post.
119         if (! $discussion = get_record('forum_discussions', 'forum', $forum->id)) {
120             if ($discussions = get_records('forum_discussions', 'forum', $forum->id, 'timemodified ASC')) {
121                 notify('Warning! There is more than one discussion in this forum - using the most recent');
122                 $discussion = array_pop($discussions);
123             } else {
124                 error('Could not find the discussion in this forum');
125             }
126         }
127         if (! $post = get_record('forum_posts', 'id', $discussion->firstpost)) {
128             error('Could not find the first post in this forum discussion');
129         }
131         $post->subject  = $forum->name;
132         $post->message  = $forum->intro;
133         $post->modified = $forum->timemodified;
135         if (! update_record('forum_posts', ($post))) {
136             error('Could not update the first post');
137         }
139         $discussion->name = $forum->name;
141         if (! update_record('forum_discussions', ($discussion))) {
142             error('Could not update the discussion');
143         }
144     }
146     if (!update_record('forum', $forum)) {
147         error('Can not update forum');
148     }
150     $forum = stripslashes_recursive($forum);
151     forum_grade_item_update($forum);
153     return true;
157 /**
158  * Given an ID of an instance of this module,
159  * this function will permanently delete the instance
160  * and any data that depends on it.
161  * @param int forum instance id
162  * @return bool success
163  */
164 function forum_delete_instance($id) {
166     if (!$forum = get_record('forum', 'id', $id)) {
167         return false;
168     }
170     $result = true;
172     if ($discussions = get_records('forum_discussions', 'forum', $forum->id)) {
173         foreach ($discussions as $discussion) {
174             if (!forum_delete_discussion($discussion, true)) {
175                 $result = false;
176             }
177         }
178     }
180     if (!delete_records('forum_subscriptions', 'forum', $forum->id)) {
181         $result = false;
182     }
184     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
186     if (!delete_records('forum', 'id', $forum->id)) {
187         $result = false;
188     }
190     forum_grade_item_delete($forum);
192     return $result;
196 /**
197  * Function to be run periodically according to the moodle cron
198  * Finds all posts that have yet to be mailed out, and mails them
199  * out to all subscribers
200  * @return void
201  */
202 function forum_cron() {
203     global $CFG, $USER;
205     $cronuser = clone($USER);
206     $site = get_site();
208     // all users that are subscribed to any post that needs sending
209     $users = array();
211     // status arrays
212     $mailcount  = array();
213     $errorcount = array();
215     // caches
216     $discussions     = array();
217     $forums          = array();
218     $courses         = array();
219     $coursemodules   = array();
220     $subscribedusers = array();
223     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
224     // cron has not been running for a long time, and then suddenly people are flooded
225     // with mail from the past few weeks or months
226     $timenow   = time();
227     $endtime   = $timenow - $CFG->maxeditingtime;
228     $starttime = $endtime - 48 * 3600;   // Two days earlier
230     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
231         // Mark them all now as being mailed.  It's unlikely but possible there
232         // might be an error later so that a post is NOT actually mailed out,
233         // but since mail isn't crucial, we can accept this risk.  Doing it now
234         // prevents the risk of duplicated mails, which is a worse problem.
236         if (!forum_mark_old_posts_as_mailed($endtime)) {
237             mtrace('Errors occurred while trying to mark some posts as being mailed.');
238             return false;  // Don't continue trying to mail them, in case we are in a cron loop
239         }
241         // checking post validity, and adding users to loop through later
242         foreach ($posts as $pid => $post) {
244             $discussionid = $post->discussion;
245             if (!isset($discussions[$discussionid])) {
246                 if ($discussion = get_record('forum_discussions', 'id', $post->discussion)) {
247                     $discussions[$discussionid] = $discussion;
248                 } else {
249                     mtrace('Could not find discussion '.$discussionid);
250                     unset($posts[$pid]);
251                     continue;
252                 }
253             }
254             $forumid = $discussions[$discussionid]->forum;
255             if (!isset($forums[$forumid])) {
256                 if ($forum = get_record('forum', 'id', $forumid)) {
257                     $forums[$forumid] = $forum;
258                 } else {
259                     mtrace('Could not find forum '.$forumid);
260                     unset($posts[$pid]);
261                     continue;
262                 }
263             }
264             $courseid = $forums[$forumid]->course;
265             if (!isset($courses[$courseid])) {
266                 if ($course = get_record('course', 'id', $courseid)) {
267                     $courses[$courseid] = $course;
268                 } else {
269                     mtrace('Could not find course '.$courseid);
270                     unset($posts[$pid]);
271                     continue;
272                 }
273             }
274             if (!isset($coursemodules[$forumid])) {
275                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
276                     $coursemodules[$forumid] = $cm;
277                 } else {
278                     mtrace('Could not course module for forum '.$forumid);
279                     unset($posts[$pid]);
280                     continue;
281                 }
282             }
285             // caching subscribed users of each forum
286             if (!isset($subscribedusers[$forumid])) {
287                 if ($subusers = forum_subscribed_users($courses[$courseid], $forums[$forumid], 0, false)) {
288                     foreach ($subusers as $postuser) {
289                         // do not try to mail users with stopped email
290                         if ($postuser->emailstop) {
291                             if (!empty($CFG->forum_logblocked)) {
292                                 add_to_log(SITEID, 'forum', 'mail blocked', '', '', 0, $postuser->id);
293                             }
294                             continue;
295                         }
296                         // this user is subscribed to this forum
297                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
298                         // this user is a user we have to process later
299                         $users[$postuser->id] = $postuser;
300                     }
301                     unset($subusers); // release memory
302                 }
303             }
305             $mailcount[$pid] = 0;
306             $errorcount[$pid] = 0;
307         }
308     }
310     if ($users && $posts) {
312         $urlinfo = parse_url($CFG->wwwroot);
313         $hostname = $urlinfo['host'];
315         foreach ($users as $userto) {
317             @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
319             // set this so that the capabilities are cached, and environment matches receiving user
320             $USER = $userto;
322             mtrace('Processing user '.$userto->id);
324             // init caches
325             $userto->viewfullnames = array();
326             $userto->canpost       = array();
327             $userto->markposts     = array();
328             $userto->enrolledin    = array();
330             // reset the caches
331             foreach ($coursemodules as $forumid=>$unused) {
332                 $coursemodules[$forumid]->cache       = new object();
333                 $coursemodules[$forumid]->cache->caps = array();
334                 unset($coursemodules[$forumid]->uservisible);
335             }
337             foreach ($posts as $pid => $post) {
339                 // Set up the environment for the post, discussion, forum, course
340                 $discussion = $discussions[$post->discussion];
341                 $forum      = $forums[$discussion->forum];
342                 $course     = $courses[$forum->course];
343                 $cm         =& $coursemodules[$forum->id];
345                 // Do some checks  to see if we can bail out now
346                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
347                     continue; // user does not subscribe to this forum
348                 }
350                 // Verify user is enrollend in course - if not do not send any email
351                 if (!isset($userto->enrolledin[$course->id])) {
352                     $userto->enrolledin[$course->id] = has_capability('moodle/course:view', get_context_instance(CONTEXT_COURSE, $course->id));
353                 }
354                 if (!$userto->enrolledin[$course->id]) {
355                     // oops - this user should not receive anything from this course
356                     continue;
357                 }
359                 // Get info about the sending user
360                 if (array_key_exists($post->userid, $users)) { // we might know him/her already
361                     $userfrom = $users[$post->userid];
362                 } else if ($userfrom = get_record('user', 'id', $post->userid)) {
363                     $users[$userfrom->id] = $userfrom; // fetch only once, we can add it to user list, it will be skipped anyway
364                 } else {
365                     mtrace('Could not find user '.$post->userid);
366                     continue;
367                 }
369                 // setup global $COURSE properly - needed for roles and languages
370                 course_setup($course);   // More environment
372                 // Fill caches
373                 if (!isset($userto->viewfullnames[$forum->id])) {
374                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
375                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
376                 }
377                 if (!isset($userto->canpost[$discussion->id])) {
378                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
379                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
380                 }
381                 if (!isset($userfrom->groups[$forum->id])) {
382                     if (!isset($userfrom->groups)) {
383                         $userfrom->groups = array();
384                         $users[$userfrom->id]->groups = array();
385                     }
386                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
387                     $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
388                 }
390                 // Make sure groups allow this user to see this email
391                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
392                     if (!groups_group_exists($discussion->groupid)) { // Can't find group
393                         continue;                           // Be safe and don't send it to anyone
394                     }
396                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
397                         // do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
398                         continue;
399                     }
400                 }
402                 // Make sure we're allowed to see it...
403                 if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
404                     mtrace('user '.$userto->id. ' can not see '.$post->id);
405                     continue;
406                 }
408                 // OK so we need to send the email.
410                 // Does the user want this post in a digest?  If so postpone it for now.
411                 if ($userto->maildigest > 0) {
412                     // This user wants the mails to be in digest form
413                     $queue = new object();
414                     $queue->userid       = $userto->id;
415                     $queue->discussionid = $discussion->id;
416                     $queue->postid       = $post->id;
417                     $queue->timemodified = $post->created;
418                     if (!insert_record('forum_queue', $queue)) {
419                         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.");
420                     }
421                     continue;
422                 }
425                 // Prepare to actually send the post now, and build up the content
427                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
429                 $userfrom->customheaders = array (  // Headers to make emails easier to track
430                            'Precedence: Bulk',
431                            'List-Id: "'.$cleanforumname.'" <moodleforum'.$forum->id.'@'.$hostname.'>',
432                            'List-Help: '.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id,
433                            'Message-ID: <moodlepost'.$post->id.'@'.$hostname.'>',
434                            'In-Reply-To: <moodlepost'.$post->parent.'@'.$hostname.'>',
435                            'References: <moodlepost'.$post->parent.'@'.$hostname.'>',
436                            'X-Course-Id: '.$course->id,
437                            'X-Course-Name: '.format_string($course->fullname, true)
438                 );
441                 $postsubject = "$course->shortname: ".format_string($post->subject,true);
442                 $posttext = forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $userto);
443                 $posthtml = forum_make_mail_html($course, $forum, $discussion, $post, $userfrom, $userto);
445                 // Send the post now!
447                 mtrace('Sending ', '');
449                 if (!$mailresult = email_to_user($userto, $userfrom, $postsubject, $posttext,
450                                                  $posthtml, '', '', $CFG->forum_replytouser)) {
451                     mtrace("Error: mod/forum/cron.php: Could not send out mail for id $post->id to user $userto->id".
452                          " ($userto->email) .. not trying again.");
453                     add_to_log($course->id, 'forum', 'mail error', "discuss.php?d=$discussion->id#p$post->id",
454                                substr(format_string($post->subject,true),0,30), $cm->id, $userto->id);
455                     $errorcount[$post->id]++;
456                 } else if ($mailresult === 'emailstop') {
457                     // should not be reached anymore - see check above
458                 } else {
459                     $mailcount[$post->id]++;
461                 // Mark post as read if forum_usermarksread is set off
462                     if (!$CFG->forum_usermarksread) {
463                         $userto->markposts[$post->id] = $post->id;
464                     }
465                 }
467                 mtrace('post '.$post->id. ': '.$post->subject);
468             }
470             // mark processed posts as read
471             forum_tp_mark_posts_read($userto, $userto->markposts);
472         }
473     }
475     if ($posts) {
476         foreach ($posts as $post) {
477             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
478             if ($errorcount[$post->id]) {
479                 set_field("forum_posts", "mailed", "2", "id", "$post->id");
480             }
481         }
482     }
484     // release some memory
485     unset($subscribedusers);
486     unset($mailcount);
487     unset($errorcount);
489     $USER = clone($cronuser);
490     course_setup(SITEID);
492     $sitetimezone = $CFG->timezone;
494     // Now see if there are any digest mails waiting to be sent, and if we should send them
496     mtrace('Starting digest processing...');
498     @set_time_limit(300); // terminate if not able to fetch all digests in 5 minutes
500     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
501         set_config('digestmailtimelast', 0);
502     }
504     $timenow = time();
505     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
507     // Delete any really old ones (normally there shouldn't be any)
508     $weekago = $timenow - (7 * 24 * 3600);
509     delete_records_select('forum_queue', "timemodified < $weekago");
510     mtrace ('Cleaned old digest records');
512     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
514         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
516         $digestposts_rs = get_recordset_select('forum_queue', "timemodified < $digesttime");
518         if (!rs_EOF($digestposts_rs)) {
520             // We have work to do
521             $usermailcount = 0;
523             //caches - reuse the those filled before too
524             $discussionposts = array();
525             $userdiscussions = array();
527             while ($digestpost = rs_fetch_next_record($digestposts_rs)) {
528                 if (!isset($users[$digestpost->userid])) {
529                     if ($user = get_record('user', 'id', $digestpost->userid)) {
530                         $users[$digestpost->userid] = $user;
531                     } else {
532                         continue;
533                     }
534                 }
535                 $postuser = $users[$digestpost->userid];
536                 if ($postuser->emailstop) {
537                     if (!empty($CFG->forum_logblocked)) {
538                         add_to_log(SITEID, 'forum', 'mail blocked', '', '', 0, $postuser->id);
539                     }
540                     continue;
541                 }
543                 if (!isset($posts[$digestpost->postid])) {
544                     if ($post = get_record('forum_posts', 'id', $digestpost->postid)) {
545                         $posts[$digestpost->postid] = $post;
546                     } else {
547                         continue;
548                     }
549                 }
550                 $discussionid = $digestpost->discussionid;
551                 if (!isset($discussions[$discussionid])) {
552                     if ($discussion = get_record('forum_discussions', 'id', $discussionid)) {
553                         $discussions[$discussionid] = $discussion;
554                     } else {
555                         continue;
556                     }
557                 }
558                 $forumid = $discussions[$discussionid]->forum;
559                 if (!isset($forums[$forumid])) {
560                     if ($forum = get_record('forum', 'id', $forumid)) {
561                         $forums[$forumid] = $forum;
562                     } else {
563                         continue;
564                     }
565                 }
567                 $courseid = $forums[$forumid]->course;
568                 if (!isset($courses[$courseid])) {
569                     if ($course = get_record('course', 'id', $courseid)) {
570                         $courses[$courseid] = $course;
571                     } else {
572                         continue;
573                     }
574                 }
576                 if (!isset($coursemodules[$forumid])) {
577                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
578                         $coursemodules[$forumid] = $cm;
579                     } else {
580                         continue;
581                     }
582                 }
583                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
584                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
585             }
586             rs_close($digestposts_rs); /// Finished iteration, let's close the resultset
588             // Data collected, start sending out emails to each user
589             foreach ($userdiscussions as $userid => $thesediscussions) {
591                 @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
593                 $USER = $cronuser;
594                 course_setup(SITEID); // reset cron user language, theme and timezone settings
596                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
598                 // First of all delete all the queue entries for this user
599                 delete_records_select('forum_queue', "userid = $userid AND timemodified < $digesttime");
600                 $userto = $users[$userid];
602                 // Override the language and timezone of the "current" user, so that
603                 // mail is customised for the receiver.
604                 $USER = $userto;
605                 course_setup(SITEID);
607                 // init caches
608                 $userto->viewfullnames = array();
609                 $userto->canpost       = array();
610                 $userto->markposts     = array();
612                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
614                 $headerdata = new object();
615                 $headerdata->sitename = format_string($site->fullname, true);
616                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
618                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
619                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
621                 $posthtml = "<head>";
622                 foreach ($CFG->stylesheets as $stylesheet) {
623                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
624                 }
625                 $posthtml .= "</head>\n<body>\n";
626                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
628                 foreach ($thesediscussions as $discussionid) {
630                     @set_time_limit(120);   // to be reset for each post
632                     $discussion = $discussions[$discussionid];
633                     $forum      = $forums[$discussion->forum];
634                     $course     = $courses[$forum->course];
635                     $cm         = $coursemodules[$forum->id];
637                     //override language
638                     course_setup($course);
640                     // Fill caches
641                     if (!isset($userto->viewfullnames[$forum->id])) {
642                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
643                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
644                     }
645                     if (!isset($userto->canpost[$discussion->id])) {
646                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
647                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
648                     }
650                     $strforums      = get_string('forums', 'forum');
651                     $canunsubscribe = ! forum_is_forcesubscribed($forum);
652                     $canreply       = $userto->canpost[$discussion->id];
654                     $posttext .= "\n \n";
655                     $posttext .= '=====================================================================';
656                     $posttext .= "\n \n";
657                     $posttext .= "$course->shortname -> $strforums -> ".format_string($forum->name,true);
658                     if ($discussion->name != $forum->name) {
659                         $posttext  .= " -> ".format_string($discussion->name,true);
660                     }
661                     $posttext .= "\n";
663                     $posthtml .= "<p><font face=\"sans-serif\">".
664                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> -> ".
665                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
666                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
667                     if ($discussion->name == $forum->name) {
668                         $posthtml .= "</font></p>";
669                     } else {
670                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
671                     }
672                     $posthtml .= '<p>';
674                     $postsarray = $discussionposts[$discussionid];
675                     sort($postsarray);
677                     foreach ($postsarray as $postid) {
678                         $post = $posts[$postid];
680                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
681                             $userfrom = $users[$post->userid];
682                         } else if ($userfrom = get_record('user', 'id', $post->userid)) {
683                             $users[$userfrom->id] = $userfrom; // fetch only once, we can add it to user list, it will be skipped anyway
684                         } else {
685                             mtrace('Could not find user '.$post->userid);
686                             continue;
687                         }
689                         if (!isset($userfrom->groups[$forum->id])) {
690                             if (!isset($userfrom->groups)) {
691                                 $userfrom->groups = array();
692                                 $users[$userfrom->id]->groups = array();
693                             }
694                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
695                             $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
696                         }
698                         $userfrom->customheaders = array ("Precedence: Bulk");
700                         if ($userto->maildigest == 2) {
701                             // Subjects only
702                             $by = new object();
703                             $by->name = fullname($userfrom);
704                             $by->date = userdate($post->modified);
705                             $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
706                             $posttext .= "\n---------------------------------------------------------------------";
708                             $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&amp;course=$course->id\">$by->name</a>";
709                             $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>';
711                         } else {
712                             // The full treatment
713                             $posttext .= forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $userto, true);
714                             $posthtml .= forum_make_mail_post($course, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
716                         // Create an array of postid's for this user to mark as read.
717                             if (!$CFG->forum_usermarksread) {
718                                 $userto->markposts[$post->id] = $post->id;
719                             }
720                         }
721                     }
722                     if ($canunsubscribe) {
723                         $posthtml .= "\n<div align=\"right\"><font size=\"1\"><a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">".get_string("unsubscribe", "forum")."</a></font></div>";
724                     } else {
725                         $posthtml .= "\n<div align=\"right\"><font size=\"1\">".get_string("everyoneissubscribed", "forum")."</font></div>";
726                     }
727                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
728                 }
729                 $posthtml .= '</body>';
731                 if ($userto->mailformat != 1) {
732                     // This user DOESN'T want to receive HTML
733                     $posthtml = '';
734                 }
736                 if (!$mailresult =  email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml,
737                                                   '', '', $CFG->forum_replytouser)) {
738                     mtrace("ERROR!");
739                     echo "Error: mod/forum/cron.php: Could not send out digest mail to user $userto->id ($userto->email)... not trying again.\n";
740                     add_to_log($course->id, 'forum', 'mail digest error', '', '', $cm->id, $userto->id);
741                 } else if ($mailresult === 'emailstop') {
742                     // should not happen anymore - see check above
743                 } else {
744                     mtrace("success.");
745                     $usermailcount++;
747                     // Mark post as read if forum_usermarksread is set off
748                     forum_tp_mark_posts_read($userto, $userto->markposts);
749                 }
750             }
751         }
752     /// We have finishied all digest emails, update $CFG->digestmailtimelast
753         set_config('digestmailtimelast', $timenow);
754     }
756     $USER = $cronuser;
757     course_setup(SITEID); // reset cron user language, theme and timezone settings
759     if (!empty($usermailcount)) {
760         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
761     }
763     if (!empty($CFG->forum_lastreadclean)) {
764         $timenow = time();
765         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
766             set_config('forum_lastreadclean', $timenow);
767             mtrace('Removing old forum read tracking info...');
768             forum_tp_clean_read_records();
769         }
770     } else {
771         set_config('forum_lastreadclean', time());
772     }
775     return true;
778 /**
779  * Builds and returns the body of the email notification in plain text.
780  *
781  * @param object $course
782  * @param object $forum
783  * @param object $discussion
784  * @param object $post
785  * @param object $userfrom
786  * @param object $userto
787  * @param boolean $bare
788  * @return string The email body in plain text format.
789  */
790 function forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $userto, $bare = false) {
791     global $CFG, $USER;
793     if (!isset($userto->viewfullnames[$forum->id])) {
794         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
795             error('Course Module ID was incorrect');
796         }
797         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
798         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
799     } else {
800         $viewfullnames = $userto->viewfullnames[$forum->id];
801     }
803     if (!isset($userto->canpost[$discussion->id])) {
804         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
805         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
806     } else {
807         $canreply = $userto->canpost[$discussion->id];
808     }
810     $by = New stdClass;
811     $by->name = fullname($userfrom, $viewfullnames);
812     $by->date = userdate($post->modified, "", $userto->timezone);
814     $strbynameondate = get_string('bynameondate', 'forum', $by);
816     $strforums = get_string('forums', 'forum');
818     $canunsubscribe = ! forum_is_forcesubscribed($forum);
820     $posttext = '';
822     if (!$bare) {
823         $posttext  = "$course->shortname -> $strforums -> ".format_string($forum->name,true);
825         if ($discussion->name != $forum->name) {
826             $posttext  .= " -> ".format_string($discussion->name,true);
827         }
828     }
830     $posttext .= "\n---------------------------------------------------------------------\n";
831     $posttext .= format_string($post->subject,true);
832     if ($bare) {
833         $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
834     }
835     $posttext .= "\n".$strbynameondate."\n";
836     $posttext .= "---------------------------------------------------------------------\n";
837     $posttext .= format_text_email(trusttext_strip($post->message), $post->format);
838     $posttext .= "\n\n";
839     if ($post->attachment) {
840         $post->course = $course->id;
841         $post->forum = $forum->id;
842         $posttext .= forum_print_attachments($post, "text");
843     }
844     if (!$bare && $canreply) {
845         $posttext .= "---------------------------------------------------------------------\n";
846         $posttext .= get_string("postmailinfo", "forum", $course->shortname)."\n";
847         $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
848     }
849     if (!$bare && $canunsubscribe) {
850         $posttext .= "\n---------------------------------------------------------------------\n";
851         $posttext .= get_string("unsubscribe", "forum");
852         $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
853     }
855     return $posttext;
858 /**
859  * Builds and returns the body of the email notification in html format.
860  *
861  * @param object $course
862  * @param object $forum
863  * @param object $discussion
864  * @param object $post
865  * @param object $userfrom
866  * @param object $userto
867  * @return string The email text in HTML format
868  */
869 function forum_make_mail_html($course, $forum, $discussion, $post, $userfrom, $userto) {
870     global $CFG;
872     if ($userto->mailformat != 1) {  // Needs to be HTML
873         return '';
874     }
876     if (!isset($userto->canpost[$discussion->id])) {
877         $canreply = forum_user_can_post($forum, $discussion, $userto);
878     } else {
879         $canreply = $userto->canpost[$discussion->id];
880     }
882     $strforums = get_string('forums', 'forum');
883     $canunsubscribe = ! forum_is_forcesubscribed($forum);
885     $posthtml = '<head>';
886     foreach ($CFG->stylesheets as $stylesheet) {
887         $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
888     }
889     $posthtml .= '</head>';
890     $posthtml .= "\n<body id=\"email\">\n\n";
892     $posthtml .= '<div class="navbar">'.
893     '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$course->shortname.'</a> &raquo; '.
894     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> &raquo; '.
895     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
896     if ($discussion->name == $forum->name) {
897         $posthtml .= '</div>';
898     } else {
899         $posthtml .= ' &raquo; <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
900                      format_string($discussion->name,true).'</a></div>';
901     }
902     $posthtml .= forum_make_mail_post($course, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
904     if ($canunsubscribe) {
905         $posthtml .= '<hr /><div align="center" class="unsubscribelink"><a href="'.$CFG->wwwroot.'/mod/forum/subscribe.php?id='.$forum->id.'">'.
906                      get_string('unsubscribe', 'forum').'</a></div>';
907     }
909     $posthtml .= '</body>';
911     return $posthtml;
915 /**
916  *
917  * @param object $course
918  * @param object $user
919  * @param object $mod TODO this is not used in this function, refactor
920  * @param object $forum
921  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
922  */
923 function forum_user_outline($course, $user, $mod, $forum) {
924     if ($count = forum_count_user_posts($forum->id, $user->id)) {
925         if ($count->postcount > 0) {
926             $result = new object();
927             $result->info = get_string("numposts", "forum", $count->postcount);
928             $result->time = $count->lastpost;
929             return $result;
930         }
931     }
932     return NULL;
936 /**
937  *
938  */
939 function forum_user_complete($course, $user, $mod, $forum) {
940     global $CFG;
942     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
944         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
945             error('Course Module ID was incorrect');
946         }
947         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
949         foreach ($posts as $post) {
950             if (!isset($discussions[$forum->discussion])) {
951                 continue;
952             }
953             $discussion = $discussions[$forum->discussion];
954             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false, false);
955         }
957     } else {
958         echo "<p>".get_string("noposts", "forum")."</p>";
959     }
962 /**
963  *
964  */
965 function forum_print_overview($courses,&$htmlarray) {
966     global $USER, $CFG;
967     $LIKE = sql_ilike();
969     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
970         return array();
971     }
973     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
974         return;
975     }
978     // get all forum logs in ONE query (much better!)
979     $sql = "SELECT instance,cmid,l.course,COUNT(l.id) as count FROM {$CFG->prefix}log l "
980         ." JOIN {$CFG->prefix}course_modules cm ON cm.id = cmid "
981         ." WHERE (";
982     foreach ($courses as $course) {
983         $sql .= '(l.course = '.$course->id.' AND l.time > '.$course->lastaccess.') OR ';
984     }
985     $sql = substr($sql,0,-3); // take off the last OR
987     $sql .= ") AND l.module = 'forum' AND action $LIKE 'add post%' "
988         ." AND userid != ".$USER->id." GROUP BY cmid,l.course,instance";
990     if (!$new = get_records_sql($sql)) {
991         $new = array(); // avoid warnings
992     }
994     // also get all forum tracking stuff ONCE.
995     $trackingforums = array();
996     foreach ($forums as $forum) {
997         if (forum_tp_can_track_forums($forum)) {
998             $trackingforums[$forum->id] = $forum;
999         }
1000     }
1002     if (count($trackingforums) > 0) {
1003         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1004         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1005             ' FROM '.$CFG->prefix.'forum_posts p '.
1006             ' JOIN '.$CFG->prefix.'forum_discussions d ON p.discussion = d.id '.
1007             ' LEFT JOIN '.$CFG->prefix.'forum_read r ON r.postid = p.id AND r.userid = '.$USER->id.' WHERE (';
1008         foreach ($trackingforums as $track) {
1009             $sql .= '(d.forum = '.$track->id.' AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = '.get_current_group($track->course).')) OR ';
1010         }
1011         $sql = substr($sql,0,-3); // take off the last OR
1012         $sql .= ') AND p.modified >= '.$cutoffdate.' AND r.id is NULL GROUP BY d.forum,d.course';
1014         if (!$unread = get_records_sql($sql)) {
1015             $unread = array();
1016         }
1017     } else {
1018         $unread = array();
1019     }
1021     if (empty($unread) and empty($new)) {
1022         return;
1023     }
1025     $strforum = get_string('modulename','forum');
1026     $strnumunread = get_string('overviewnumunread','forum');
1027     $strnumpostssince = get_string('overviewnumpostssince','forum');
1029     foreach ($forums as $forum) {
1030         $str = '';
1031         $count = 0;
1032         $thisunread = 0;
1033         $showunread = false;
1034         // either we have something from logs, or trackposts, or nothing.
1035         if (array_key_exists($forum->id, $new) && !empty($new[$forum->id])) {
1036             $count = $new[$forum->id]->count;
1037         }
1038         if (array_key_exists($forum->id,$unread)) {
1039             $thisunread = $unread[$forum->id]->count;
1040             $showunread = true;
1041         }
1042         if ($count > 0 || $thisunread > 0) {
1043             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1044                 $forum->name.'</a></div>';
1045             $str .= '<div class="info">';
1046             $str .= $count.' '.$strnumpostssince;
1047             if (!empty($showunread)) {
1048                 $str .= '<br />'.$thisunread .' '.$strnumunread;
1049             }
1050             $str .= '</div></div>';
1051         }
1052         if (!empty($str)) {
1053             if (!array_key_exists($forum->course,$htmlarray)) {
1054                 $htmlarray[$forum->course] = array();
1055             }
1056             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1057                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1058             }
1059             $htmlarray[$forum->course]['forum'] .= $str;
1060         }
1061     }
1064 /**
1065  * Given a course and a date, prints a summary of all the new
1066  * messages posted in the course since that date
1067  * @param object $course
1068  * @param bool $viewfullnames capability
1069  * @param int $timestart
1070  * @return bool success
1071  */
1072 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1073     global $CFG, $USER;
1075     // do not use log table if possible, it may be huge and is expensive to join with other tables
1077     if (!$posts = get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1078                                           d.timestart, d.timeend, d.userid AS duserid,
1079                                           u.firstname, u.lastname, u.email, u.picture
1080                                      FROM {$CFG->prefix}forum_posts p
1081                                           JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
1082                                           JOIN {$CFG->prefix}forum f             ON f.id = d.forum
1083                                           JOIN {$CFG->prefix}user u              ON u.id = p.userid
1084                                     WHERE p.created > $timestart AND f.course = {$course->id}
1085                                  ORDER BY p.id ASC")) { // order by initial posting date
1086          return false;
1087     }
1089     $modinfo =& get_fast_modinfo($course);
1091     $groupmodes = array();
1092     $cms    = array();
1094     $strftimerecent = get_string('strftimerecent');
1096     $printposts = array();
1097     foreach ($posts as $post) {
1098         if (!isset($modinfo->instances['forum'][$post->forum])) {
1099             // not visible
1100             continue;
1101         }
1102         $cm = $modinfo->instances['forum'][$post->forum];
1103         if (!$cm->uservisible) {
1104             continue;
1105         }
1106         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1108         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1109             continue;
1110         }
1112         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1113           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1114             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1115                 continue;
1116             }
1117         }
1119         $groupmode = groups_get_activity_groupmode($cm, $course);
1121         if ($groupmode) {
1122             if ($post->groupid == -1 or $groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context)) {
1123                 // oki (Open discussions have groupid -1)
1124             } else {
1125                 // separate mode
1126                 if (isguestuser()) {
1127                     // shortcut
1128                     continue;
1129                 }
1131                 if (is_null($modinfo->groups)) {
1132                     $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
1133                 }
1135                 if (!array_key_exists($post->groupid, $modinfo->groups[0])) {
1136                     continue;
1137                 }
1138             }
1139         }
1141         $printposts[] = $post;
1142     }
1143     unset($posts);
1145     if (!$printposts) {
1146         return false;
1147     }
1149     print_headline(get_string('newforumposts', 'forum').':', 3);
1150     echo "\n<ul class='unlist'>\n";
1152     foreach ($printposts as $post) {
1153         $subjectclass = empty($post->parent) ? ' bold' : '';
1155         echo '<li><div class="head">'.
1156                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1157                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1158              '</div>';
1159         echo '<div class="info'.$subjectclass.'">';
1160         if (empty($post->parent)) {
1161             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1162         } else {
1163             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1164         }
1165         $post->subject = break_up_long_words(format_string($post->subject, true));
1166         echo $post->subject;
1167         echo "</a>\"</div></li>\n";
1168     }
1170     echo "</ul>\n";
1172     return true;
1175 /**
1176  * Return grade for given user or all users.
1177  *
1178  * @param int $forumid id of forum
1179  * @param int $userid optional user id, 0 means all users
1180  * @return array array of grades, false if none
1181  */
1182 function forum_get_user_grades($forum, $userid=0) {
1183     global $CFG;
1185     $user = $userid ? "AND u.id = $userid" : "";
1187     $aggtype = $forum->assessed;
1188     switch ($aggtype) {
1189         case FORUM_AGGREGATE_COUNT :
1190             $sql = "SELECT u.id, u.id AS userid, COUNT(fr.rating) AS rawgrade
1191                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1192                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1193                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1194                            AND fr.userid != u.id AND fd.forum = $forum->id
1195                            $user
1196                   GROUP BY u.id";
1197             break;
1198         case FORUM_AGGREGATE_MAX :
1199             $sql = "SELECT u.id, u.id AS userid, MAX(fr.rating) AS rawgrade
1200                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1201                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1202                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1203                            AND fr.userid != u.id AND fd.forum = $forum->id
1204                            $user
1205                   GROUP BY u.id";
1206             break;
1207         case FORUM_AGGREGATE_MIN :
1208             $sql = "SELECT u.id, u.id AS userid, MIN(fr.rating) AS rawgrade
1209                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1210                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1211                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1212                            AND fr.userid != u.id AND fd.forum = $forum->id
1213                            $user
1214                   GROUP BY u.id";
1215             break;
1216         case FORUM_AGGREGATE_SUM :
1217             $sql = "SELECT u.id, u.id AS userid, SUM(fr.rating) AS rawgrade
1218                      FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1219                           {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1220                     WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1221                           AND fr.userid != u.id AND fd.forum = $forum->id
1222                           $user
1223                  GROUP BY u.id";
1224             break;
1225         default : //avg
1226             $sql = "SELECT u.id, u.id AS userid, AVG(fr.rating) AS rawgrade
1227                       FROM {$CFG->prefix}user u, {$CFG->prefix}forum_posts fp,
1228                            {$CFG->prefix}forum_ratings fr, {$CFG->prefix}forum_discussions fd
1229                      WHERE u.id = fp.userid AND fp.discussion = fd.id AND fr.post = fp.id
1230                            AND fr.userid != u.id AND fd.forum = $forum->id
1231                            $user
1232                   GROUP BY u.id";
1233             break;
1234     }
1236     if ($results = get_records_sql($sql)) {
1237         // it could throw off the grading if count and sum returned a rawgrade higher than scale
1238         // 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)
1239         foreach ($results as $rid=>$result) {
1240             if ($forum->scale >= 0) {
1241                 //numeric
1242                 if ($result->rawgrade > $forum->scale) {
1243                     $results[$rid]->rawgrade = $forum->scale;
1244                 }
1245             } else {
1246                 //scales
1247                 if ($scale = get_record('scale', 'id', -$forum->scale)) {
1248                     $scale = explode(',', $scale->scale);
1249                     $max = count($scale);
1250                     if ($result->rawgrade > $max) {
1251                         $results[$rid]->rawgrade = $max;
1252                     }
1253                 }
1254             }
1255         }
1256     }
1258     return $results;
1261 /**
1262  * Update grades by firing grade_updated event
1263  *
1264  * @param object $forum null means all forums
1265  * @param int $userid specific user only, 0 mean all
1266  * @param boolean $nullifnone return null if grade does not exist
1267  * @return void
1268  */
1269 function forum_update_grades($forum=null, $userid=0, $nullifnone=true) {
1270     global $CFG;
1272     if ($forum != null) {
1273         require_once($CFG->libdir.'/gradelib.php');
1274         if ($grades = forum_get_user_grades($forum, $userid)) {
1275             forum_grade_item_update($forum, $grades);
1277         } else if ($userid and $nullifnone) {
1278             $grade = new object();
1279             $grade->userid   = $userid;
1280             $grade->rawgrade = NULL;
1281             forum_grade_item_update($forum, $grade);
1283         } else {
1284             forum_grade_item_update($forum);
1285         }
1287     } else {
1288         $sql = "SELECT f.*, cm.idnumber as cmidnumber
1289                   FROM {$CFG->prefix}forum f, {$CFG->prefix}course_modules cm, {$CFG->prefix}modules m
1290                  WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
1291         if ($rs = get_recordset_sql($sql)) {
1292             while ($forum = rs_fetch_next_record($rs)) {
1293                 if ($forum->assessed) {
1294                     forum_update_grades($forum, 0, false);
1295                 } else {
1296                     forum_grade_item_update($forum);
1297                 }
1298             }
1299             rs_close($rs);
1300         }
1301     }
1304 /**
1305  * Create/update grade item for given forum
1306  *
1307  * @param object $forum object with extra cmidnumber
1308  * @param mixed optional array/object of grade(s); 'reset' means reset grades in gradebook
1309  * @return int 0 if ok
1310  */
1311 function forum_grade_item_update($forum, $grades=NULL) {
1312     global $CFG;
1313     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1314         require_once($CFG->libdir.'/gradelib.php');
1315     }
1317     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1319     if (!$forum->assessed or $forum->scale == 0) {
1320         $params['gradetype'] = GRADE_TYPE_NONE;
1322     } else if ($forum->scale > 0) {
1323         $params['gradetype'] = GRADE_TYPE_VALUE;
1324         $params['grademax']  = $forum->scale;
1325         $params['grademin']  = 0;
1327     } else if ($forum->scale < 0) {
1328         $params['gradetype'] = GRADE_TYPE_SCALE;
1329         $params['scaleid']   = -$forum->scale;
1330     }
1332     if ($grades  === 'reset') {
1333         $params['reset'] = true;
1334         $grades = NULL;
1335     }
1337     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1340 /**
1341  * Delete grade item for given forum
1342  *
1343  * @param object $forum object
1344  * @return object grade_item
1345  */
1346 function forum_grade_item_delete($forum) {
1347     global $CFG;
1348     require_once($CFG->libdir.'/gradelib.php');
1350     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1354 /**
1355  * Returns the users with data in one forum
1356  * (users with records in forum_subscriptions, forum_posts and forum_ratings, students)
1357  * @param int $forumid
1358  * @return mixed array or false if none
1359  */
1360 function forum_get_participants($forumid) {
1362     global $CFG;
1364     //Get students from forum_subscriptions
1365     $st_subscriptions = get_records_sql("SELECT DISTINCT u.id, u.id
1366                                          FROM {$CFG->prefix}user u,
1367                                               {$CFG->prefix}forum_subscriptions s
1368                                          WHERE s.forum = '$forumid' and
1369                                                u.id = s.userid");
1370     //Get students from forum_posts
1371     $st_posts = get_records_sql("SELECT DISTINCT u.id, u.id
1372                                  FROM {$CFG->prefix}user u,
1373                                       {$CFG->prefix}forum_discussions d,
1374                                       {$CFG->prefix}forum_posts p
1375                                  WHERE d.forum = '$forumid' and
1376                                        p.discussion = d.id and
1377                                        u.id = p.userid");
1379     //Get students from forum_ratings
1380     $st_ratings = get_records_sql("SELECT DISTINCT u.id, u.id
1381                                    FROM {$CFG->prefix}user u,
1382                                         {$CFG->prefix}forum_discussions d,
1383                                         {$CFG->prefix}forum_posts p,
1384                                         {$CFG->prefix}forum_ratings r
1385                                    WHERE d.forum = '$forumid' and
1386                                          p.discussion = d.id and
1387                                          r.post = p.id and
1388                                          u.id = r.userid");
1390     //Add st_posts to st_subscriptions
1391     if ($st_posts) {
1392         foreach ($st_posts as $st_post) {
1393             $st_subscriptions[$st_post->id] = $st_post;
1394         }
1395     }
1396     //Add st_ratings to st_subscriptions
1397     if ($st_ratings) {
1398         foreach ($st_ratings as $st_rating) {
1399             $st_subscriptions[$st_rating->id] = $st_rating;
1400         }
1401     }
1402     //Return st_subscriptions array (it contains an array of unique users)
1403     return ($st_subscriptions);
1406 /**
1407  * This function returns if a scale is being used by one forum
1408  * @param int $forumid
1409  * @param int $scaleid negative number
1410  * @return bool
1411  */
1412 function forum_scale_used ($forumid,$scaleid) {
1414     $return = false;
1416     $rec = get_record("forum","id","$forumid","scale","-$scaleid");
1418     if (!empty($rec) && !empty($scaleid)) {
1419         $return = true;
1420     }
1422     return $return;
1425 /**
1426  * Checks if scale is being used by any instance of forum
1427  *
1428  * This is used to find out if scale used anywhere
1429  * @param $scaleid int
1430  * @return boolean True if the scale is used by any forum
1431  */
1432 function forum_scale_used_anywhere($scaleid) {
1433     if ($scaleid and record_exists('forum', 'scale', -$scaleid)) {
1434         return true;
1435     } else {
1436         return false;
1437     }
1440 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1442 /**
1443  * Gets a post with all info ready for forum_print_post
1444  * Most of these joins are just to get the forum id
1445  * @param int $postid
1446  * @return mixed array of posts or false
1447  */
1448 function forum_get_post_full($postid) {
1449     global $CFG;
1451     return get_record_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1452                              FROM {$CFG->prefix}forum_posts p
1453                                   JOIN {$CFG->prefix}forum_discussions d ON p.discussion = d.id
1454                                   LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1455                             WHERE p.id = '$postid'");
1458 /**
1459  * Gets posts with all info ready for forum_print_post
1460  * We pass forumid in because we always know it so no need to make a
1461  * complicated join to find it out.
1462  * @return mixed array of posts or false
1463  */
1464 function forum_get_discussion_posts($discussion, $sort, $forumid) {
1465     global $CFG;
1467     return get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1468                               FROM {$CFG->prefix}forum_posts p
1469                          LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1470                              WHERE p.discussion = $discussion
1471                                AND p.parent > 0 $sort");
1474 /**
1475  * Gets all posts in discussion including top parent.
1476  * @param int $discussionid
1477  * @param string $sort
1478  * @param bool $tracking does user track the forum?
1479  * @return array of posts
1480  */
1481 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1482     global $CFG, $USER;
1484     $tr_sel  = "";
1485     $tr_join = "";
1487     if ($tracking) {
1488         $now = time();
1489         $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
1490         $tr_sel  = ", fr.id AS postread";
1491         $tr_join = "LEFT JOIN {$CFG->prefix}forum_read fr ON (fr.postid = p.id AND fr.userid = $USER->id)";
1492     }
1494     if (!$posts = get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture, u.imagealt $tr_sel
1495                                      FROM {$CFG->prefix}forum_posts p
1496                                           LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1497                                           $tr_join
1498                                     WHERE p.discussion = $discussionid
1499                                  ORDER BY $sort")) {
1500         return array();
1501     }
1503     foreach ($posts as $pid=>$p) {
1504         if ($tracking) {
1505             if (forum_tp_is_post_old($p)) {
1506                  $posts[$pid]->postread = true;
1507             }
1508         }
1509         if (!$p->parent) {
1510             continue;
1511         }
1512         if (!isset($posts[$p->parent])) {
1513             continue; // parent does not exist??
1514         }
1515         if (!isset($posts[$p->parent]->children)) {
1516             $posts[$p->parent]->children = array();
1517         }
1518         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1519     }
1521     return $posts;
1524 /**
1525  * Gets posts with all info ready for forum_print_post
1526  * We pass forumid in because we always know it so no need to make a
1527  * complicated join to find it out.
1528  */
1529 function forum_get_child_posts($parent, $forumid) {
1530     global $CFG;
1532     return get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1533                               FROM {$CFG->prefix}forum_posts p
1534                          LEFT JOIN {$CFG->prefix}user u ON p.userid = u.id
1535                              WHERE p.parent = '$parent'
1536                           ORDER BY p.created ASC");
1539 /**
1540  * An array of forum objects that the user is allowed to read/search through.
1541  * @param $userid
1542  * @param $courseid - if 0, we look for forums throughout the whole site.
1543  * @return array of forum objects, or false if no matches
1544  *         Forum objects have the following attributes:
1545  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1546  *         viewhiddentimedposts
1547  */
1548 function forum_get_readable_forums($userid, $courseid=0) {
1550     global $CFG, $USER;
1551     require_once($CFG->dirroot.'/course/lib.php');
1553     if (!$forummod = get_record('modules', 'name', 'forum')) {
1554         error('The forum module is not installed');
1555     }
1557     if ($courseid) {
1558         $courses = get_records('course', 'id', $courseid);
1559     } else {
1560         // If no course is specified, then the user can see SITE + his courses.
1561         // And admins can see all courses, so pass the $doanything flag enabled
1562         $courses1 = get_records('course', 'id', SITEID);
1563         $courses2 = get_my_courses($userid, null, null, true);
1564         $courses = array_merge($courses1, $courses2);
1565     }
1566     if (!$courses) {
1567         return array();
1568     }
1570     $readableforums = array();
1572     foreach ($courses as $course) {
1574         $modinfo =& get_fast_modinfo($course);
1575         if (is_null($modinfo->groups)) {
1576             $modinfo->groups = groups_get_user_groups($course->id, $userid);
1577         }
1579         if (empty($modinfo->instances['forum'])) {
1580             // hmm, no forums?
1581             continue;
1582         }
1584         $courseforums = get_records('forum', 'course', $course->id);
1586         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1587             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1588                 continue;
1589             }
1590             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1591             $forum = $courseforums[$forumid];
1593             if (!has_capability('mod/forum:viewdiscussion', $context)) {
1594                 continue;
1595             }
1597          /// group access
1598             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
1599                 if (is_null($modinfo->groups)) {
1600                     $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
1601                 }
1602                 if (empty($CFG->enablegroupings)) {
1603                     $forum->onlygroups = $modinfo->groups[0];
1604                     $forum->onlygroups[] = -1;
1605                 } else if (isset($modinfo->groups[$cm->groupingid])) {
1606                     $forum->onlygroups = $modinfo->groups[$cm->groupingid];
1607                     $forum->onlygroups[] = -1;
1608                 } else {
1609                     $forum->onlygroups = array(-1);
1610                 }
1611             }
1613         /// hidden timed discussions
1614             $forum->viewhiddentimedposts = true;
1615             if (!empty($CFG->forum_enabletimedposts)) {
1616                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1617                     $forum->viewhiddentimedposts = false;
1618                 }
1619             }
1621         /// qanda access
1622             if ($forum->type == 'qanda'
1623                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1625                 // We need to check whether the user has posted in the qanda forum.
1626                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
1627                                                     // the user is allowed to see in this forum.
1628                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1629                     foreach ($discussionspostedin as $d) {
1630                         $forum->onlydiscussions[] = $d->id;
1631                     }
1632                 }
1633             }
1635             $readableforums[$forum->id] = $forum;
1636         }
1638         unset($modinfo);
1640     } // End foreach $courses
1642     //print_object($courses);
1643     //print_object($readableforums);
1645     return $readableforums;
1648 /**
1649  * Returns a list of posts found using an array of search terms.
1650  * @param $searchterms - array of search terms, e.g. word +word -word
1651  * @param $courseid - if 0, we search through the whole site
1652  * @param $page
1653  * @param $recordsperpage=50
1654  * @param &$totalcount
1655  * @param $extrasql
1656  * @return array of posts found
1657  */
1658 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
1659                             &$totalcount, $extrasql='') {
1660     global $CFG, $USER;
1661     require_once($CFG->libdir.'/searchlib.php');
1663     $forums = forum_get_readable_forums($USER->id, $courseid);
1665     if (count($forums) == 0) {
1666         $totalcount = 0;
1667         return false;
1668     }
1670     $now = round(time(), -2); // db friendly
1672     $fullaccess = array();
1673     $where = array();
1675     foreach ($forums as $forumid => $forum) {
1676         $select = array();
1678         if (!$forum->viewhiddentimedposts) {
1679             $select[] = "(d.userid = {$USER->id} OR (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)))";
1680         }
1682         if ($forum->type == 'qanda') {
1683             if (!empty($forum->onlydiscussions)) {
1684                 $discussionsids = implode(',', $forum->onlydiscussions);
1685                 $select[] = "(d.id IN ($discussionsids) OR p.parent = 0)";
1686             } else {
1687                 $select[] = "p.parent = 0";
1688             }
1689         }
1691         if (!empty($forum->onlygroups)) {
1692             $groupids = implode(',', $forum->onlygroups);
1693             $select[] = "d.groupid IN ($groupids)";
1694         }
1696         if ($select) {
1697             $selects = implode(" AND ", $select);
1698             $where[] = "(d.forum = $forumid AND $selects)";
1699         } else {
1700             $fullaccess[] = $forumid;
1701         }
1702     }
1704     if ($fullaccess) {
1705         $fullids = implode(',', $fullaccess);
1706         $where[] = "(d.forum IN ($fullids))";
1707     }
1709     $selectdiscussion = "(".implode(" OR ", $where).")";
1711     // Some differences SQL
1712     $LIKE = sql_ilike();
1713     $NOTLIKE = 'NOT ' . $LIKE;
1714     if ($CFG->dbfamily == 'postgres') {
1715         $REGEXP = '~*';
1716         $NOTREGEXP = '!~*';
1717     } else {
1718         $REGEXP = 'REGEXP';
1719         $NOTREGEXP = 'NOT REGEXP';
1720     }
1722     $messagesearch = '';
1723     $searchstring = '';
1725     // Need to concat these back together for parser to work.
1726     foreach($searchterms as $searchterm){
1727         if ($searchstring != '') {
1728             $searchstring .= ' ';
1729         }
1730         $searchstring .= $searchterm;
1731     }
1733     // We need to allow quoted strings for the search. The quotes *should* be stripped
1734     // by the parser, but this should be examined carefully for security implications.
1735     $searchstring = str_replace("\\\"","\"",$searchstring);
1736     $parser = new search_parser();
1737     $lexer = new search_lexer($parser);
1739     if ($lexer->parse($searchstring)) {
1740         $parsearray = $parser->get_parsed_array();
1741     // Experimental feature under 1.8! MDL-8830
1742     // Use alternative text searches if defined
1743     // This feature only works under mysql until properly implemented for other DBs
1744     // Requires manual creation of text index for forum_posts before enabling it:
1745     // CREATE FULLTEXT INDEX foru_post_tix ON [prefix]forum_posts (subject, message)
1746     // Experimental feature under 1.8! MDL-8830
1747         if (!empty($CFG->forum_usetextsearches)) {
1748             $messagesearch = search_generate_text_SQL($parsearray, 'p.message', 'p.subject',
1749                                                  'p.userid', 'u.id', 'u.firstname',
1750                                                  'u.lastname', 'p.modified', 'd.forum');
1751         } else {
1752             $messagesearch = search_generate_SQL($parsearray, 'p.message', 'p.subject',
1753                                                  'p.userid', 'u.id', 'u.firstname',
1754                                                  'u.lastname', 'p.modified', 'd.forum');
1755         }
1756     }
1758     $fromsql = "{$CFG->prefix}forum_posts p,
1759                   {$CFG->prefix}forum_discussions d,
1760                   {$CFG->prefix}user u";
1762     $selectsql = " $messagesearch
1763                AND p.discussion = d.id
1764                AND p.userid = u.id
1765                AND $selectdiscussion
1766                    $extrasql";
1768     $countsql = "SELECT COUNT(*)
1769                    FROM $fromsql
1770                   WHERE $selectsql";
1772     $searchsql = "SELECT p.*,
1773                          d.forum,
1774                          u.firstname,
1775                          u.lastname,
1776                          u.email,
1777                          u.picture,
1778                          u.imagealt
1779                     FROM $fromsql
1780                    WHERE $selectsql
1781                 ORDER BY p.modified DESC";
1783     $totalcount = count_records_sql($countsql);
1785     return get_records_sql($searchsql, $limitfrom, $limitnum);
1788 /**
1789  * Returns a list of ratings for all posts in discussion
1790  * @param object $discussion
1791  * @return array of ratings or false
1792  */
1793 function forum_get_all_discussion_ratings($discussion) {
1794     global $CFG;
1795     return get_records_sql("SELECT r.id, r.userid, p.id AS postid, r.rating
1796                               FROM {$CFG->prefix}forum_ratings r,
1797                                    {$CFG->prefix}forum_posts p
1798                              WHERE r.post = p.id AND p.discussion = $discussion->id
1799                              ORDER BY p.id ASC");
1802 /**
1803  * Returns a list of ratings for a particular post - sorted.
1804  * @param int $postid
1805  * @param string $sort
1806  * @return array of ratings or false
1807  */
1808 function forum_get_ratings($postid, $sort="u.firstname ASC") {
1809     global $CFG;
1810     return get_records_sql("SELECT u.*, r.rating, r.time
1811                               FROM {$CFG->prefix}forum_ratings r,
1812                                    {$CFG->prefix}user u
1813                              WHERE r.post = '$postid'
1814                                AND r.userid = u.id
1815                              ORDER BY $sort");
1818 /**
1819  * Returns a list of all new posts that have not been mailed yet
1820  * @param int $starttime - posts created after this time
1821  * @param int $endtime - posts created before this
1822  * @param int $now - used for timed discussions only
1823  */
1824 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
1825     global $CFG;
1827     if (!empty($CFG->forum_enabletimedposts)) {
1828         if (empty($now)) {
1829             $now = time();
1830         }
1831         $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
1832     } else {
1833         $timedsql = "";
1834     }
1836     return get_records_sql("SELECT p.*, d.course, d.forum
1837                               FROM {$CFG->prefix}forum_posts p
1838                                    JOIN {$CFG->prefix}forum_discussions d ON d.id = p.discussion
1839                              WHERE p.mailed = 0
1840                                    AND p.created >= $starttime
1841                                    AND (p.created < $endtime OR p.mailnow = 1)
1842                                    $timedsql
1843                           ORDER BY p.modified ASC");
1846 /**
1847  * Marks posts before a certain time as being mailed already
1848  */
1849 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
1850     global $CFG;
1851     if (empty($now)) {
1852         $now = time();
1853     }
1855     if (empty($CFG->forum_enabletimedposts)) {
1856         return execute_sql("UPDATE {$CFG->prefix}forum_posts
1857                                SET mailed = '1'
1858                              WHERE (created < $endtime OR mailnow = 1)
1859                                    AND mailed = 0", false);
1861     } else {
1862         return execute_sql("UPDATE {$CFG->prefix}forum_posts
1863                                SET mailed = '1'
1864                              WHERE discussion NOT IN (SELECT d.id
1865                                                         FROM {$CFG->prefix}forum_discussions d
1866                                                        WHERE d.timestart > $now)
1867                                    AND (created < $endtime OR mailnow = 1)
1868                                    AND mailed = 0", false);
1869     }
1872 /**
1873  * Get all the posts for a user in a forum suitable for forum_print_post
1874  */
1875 function forum_get_user_posts($forumid, $userid) {
1876     global $CFG;
1878     $timedsql = "";
1879     if (!empty($CFG->forum_enabletimedposts)) {
1880         $cm = get_coursemodule_from_instance('forum', $forumid);
1881         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
1882             $now = time();
1883             $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
1884         }
1885     }
1887     return get_records_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1888                               FROM {$CFG->prefix}forum f
1889                                    JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
1890                                    JOIN {$CFG->prefix}forum_posts p       ON p.discussion = d.id
1891                                    JOIN {$CFG->prefix}user u              ON u.id = p.userid
1892                              WHERE f.id = $forumid
1893                                    AND p.userid = $userid
1894                                    $timedsql
1895                           ORDER BY p.modified ASC");
1898 /**
1899  * Get all the discussions user participated in
1900  * @param int $forumid
1901  * @param int $userid
1902  * @return array or false
1903  */
1904 function forum_get_user_involved_discussions($forumid, $userid) {
1905     global $CFG;
1907     $timedsql = "";
1908     if (!empty($CFG->forum_enabletimedposts)) {
1909         $cm = get_coursemodule_from_instance('forum', $forumid);
1910         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
1911             $now = time();
1912             $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
1913         }
1914     }
1916     return get_records_sql("SELECT DISTINCT d.*
1917                               FROM {$CFG->prefix}forum f
1918                                    JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
1919                                    JOIN {$CFG->prefix}forum_posts p       ON p.discussion = d.id
1920                              WHERE f.id = $forumid
1921                                    AND p.userid = $userid
1922                                    $timedsql");
1925 /**
1926  * Get all the posts for a user in a forum suitable for forum_print_post
1927  * @param int $forumid
1928  * @param int $userid
1929  * @return array of counts or false
1930  */
1931 function forum_count_user_posts($forumid, $userid) {
1932     global $CFG;
1934     $timedsql = "";
1935     if (!empty($CFG->forum_enabletimedposts)) {
1936         $cm = get_coursemodule_from_instance('forum', $forumid);
1937         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
1938             $now = time();
1939             $timedsql = "AND (d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now))";
1940         }
1941     }
1943     return get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
1944                              FROM {$CFG->prefix}forum f
1945                                   JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
1946                                   JOIN {$CFG->prefix}forum_posts p       ON p.discussion = d.id
1947                                   JOIN {$CFG->prefix}user u              ON u.id = p.userid
1948                             WHERE f.id = $forumid
1949                                   AND p.userid = $userid
1950                                   $timedsql");
1953 /**
1954  * Given a log entry, return the forum post details for it.
1955  */
1956 function forum_get_post_from_log($log) {
1957     global $CFG;
1959     if ($log->action == "add post") {
1961         return get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1962                                            u.firstname, u.lastname, u.email, u.picture
1963                                  FROM {$CFG->prefix}forum_discussions d,
1964                                       {$CFG->prefix}forum_posts p,
1965                                       {$CFG->prefix}forum f,
1966                                       {$CFG->prefix}user u
1967                                 WHERE p.id = '$log->info'
1968                                   AND d.id = p.discussion
1969                                   AND p.userid = u.id
1970                                   AND u.deleted <> '1'
1971                                   AND f.id = d.forum");
1974     } else if ($log->action == "add discussion") {
1976         return get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1977                                            u.firstname, u.lastname, u.email, u.picture
1978                                  FROM {$CFG->prefix}forum_discussions d,
1979                                       {$CFG->prefix}forum_posts p,
1980                                       {$CFG->prefix}forum f,
1981                                       {$CFG->prefix}user u
1982                                 WHERE d.id = '$log->info'
1983                                   AND d.firstpost = p.id
1984                                   AND p.userid = u.id
1985                                   AND u.deleted <> '1'
1986                                   AND f.id = d.forum");
1987     }
1988     return NULL;
1991 /**
1992  * Given a discussion id, return the first post from the discussion
1993  */
1994 function forum_get_firstpost_from_discussion($discussionid) {
1995     global $CFG;
1997     return get_record_sql("SELECT p.*
1998                              FROM {$CFG->prefix}forum_discussions d,
1999                                   {$CFG->prefix}forum_posts p
2000                             WHERE d.id = '$discussionid'
2001                               AND d.firstpost = p.id ");
2004 /**
2005  * Returns an array of counts of replies to each discussion
2006  */
2007 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2008     global $CFG;
2010     if ($limit > 0) {
2011         $limitfrom = 0;
2012         $limitnum  = $limit;
2013     } else if ($page != -1) {
2014         $limitfrom = $page*$perpage;
2015         $limitnum  = $perpage;
2016     } else {
2017         $limitfrom = 0;
2018         $limitnum  = 0;
2019     }
2021     if ($forumsort == "") {
2022         $orderby = "";
2023         $groupby = "";
2025     } else {
2026         $orderby = "ORDER BY $forumsort";
2027         $groupby = ", ".strtolower($forumsort);
2028         $groupby = str_replace('desc', '', $groupby);
2029         $groupby = str_replace('asc', '', $groupby);
2030     }
2032     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2033         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2034                   FROM {$CFG->prefix}forum_posts p
2035                        JOIN {$CFG->prefix}forum_discussions d ON p.discussion = d.id
2036                  WHERE p.parent > 0 AND d.forum = $forumid
2037               GROUP BY p.discussion";
2038         return get_records_sql($sql);
2040     } else {
2041         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2042                   FROM {$CFG->prefix}forum_posts p
2043                        JOIN {$CFG->prefix}forum_discussions d ON p.discussion = d.id
2044                  WHERE d.forum = $forumid
2045               GROUP BY p.discussion $groupby
2046               $orderby";
2047         return get_records_sql("SELECT * FROM ($sql) sq", $limitfrom, $limitnum);
2048     }
2051 function forum_count_discussions($forum, $cm, $course) {
2052     global $CFG, $USER;
2054     static $cache = array();
2056     $now = round(time(), -2); // db cache friendliness
2058     if (!isset($cache[$course->id])) {
2059         if (!empty($CFG->forum_enabletimedposts)) {
2060             $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2061         } else {
2062             $timedsql = "";
2063         }
2065         $sql = "SELECT f.id, COUNT(d.id) as dcount
2066                   FROM {$CFG->prefix}forum f
2067                        JOIN {$CFG->prefix}forum_discussions d ON d.forum = f.id
2068                  WHERE f.course = $course->id
2069                        $timedsql
2070               GROUP BY f.id";
2072         if ($counts = get_records_sql($sql)) {
2073             foreach ($counts as $count) {
2074                 $counts[$count->id] = $count->dcount;
2075             }
2076             $cache[$course->id] = $counts;
2077         } else {
2078             $cache[$course->id] = array();
2079         }
2080     }
2082     if (empty($cache[$course->id][$forum->id])) {
2083         return 0;
2084     }
2086     $groupmode = groups_get_activity_groupmode($cm, $course);
2088     if ($groupmode != SEPARATEGROUPS) {
2089         return $cache[$course->id][$forum->id];
2090     }
2092     if (has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2093         return $cache[$course->id][$forum->id];
2094     }
2096     require_once($CFG->dirroot.'/course/lib.php');
2098     $modinfo =& get_fast_modinfo($course);
2099     if (is_null($modinfo->groups)) {
2100         $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
2101     }
2103     if (empty($CFG->enablegroupings)) {
2104         $mygroups = $modinfo->groups[0];
2105     } else {
2106         $mygroups = $modinfo->groups[$cm->groupingid];
2107     }
2109     // add all groups posts
2110     if (empty($mygroups)) {
2111         $mygroups = array(-1=>-1);
2112     } else {
2113         $mygroups[-1] = -1;
2114     }
2115     $mygroups = implode(',', $mygroups);
2117     if (!empty($CFG->forum_enabletimedposts)) {
2118         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2119     } else {
2120         $timedsql = "";
2121     }
2123     $sql = "SELECT COUNT(d.id)
2124               FROM {$CFG->prefix}forum_discussions d
2125              WHERE d.forum = $forum->id AND d.groupid IN ($mygroups)
2126                    $timedsql";
2128     return get_field_sql($sql);
2131 /**
2132  * How many unrated posts are in the given discussion for a given user?
2133  */
2134 function forum_count_unrated_posts($discussionid, $userid) {
2135     global $CFG;
2136     if ($posts = get_record_sql("SELECT count(*) as num
2137                                    FROM {$CFG->prefix}forum_posts
2138                                   WHERE parent > 0
2139                                     AND discussion = '$discussionid'
2140                                     AND userid <> '$userid' ")) {
2142         if ($rated = get_record_sql("SELECT count(*) as num
2143                                        FROM {$CFG->prefix}forum_posts p,
2144                                             {$CFG->prefix}forum_ratings r
2145                                       WHERE p.discussion = '$discussionid'
2146                                         AND p.id = r.post
2147                                         AND r.userid = '$userid'")) {
2148             $difference = $posts->num - $rated->num;
2149             if ($difference > 0) {
2150                 return $difference;
2151             } else {
2152                 return 0;    // Just in case there was a counting error
2153             }
2154         } else {
2155             return $posts->num;
2156         }
2157     } else {
2158         return 0;
2159     }
2162 /**
2163  * Get all discussions in a forum
2164  */
2165 function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
2166     global $CFG, $USER;
2168     $timelimit = '';
2170     $modcontext = null;
2172     $now = round(time(), -2);
2174     if (!empty($CFG->forum_enabletimedposts)) {
2176         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2178         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2179             $timelimit = " AND ((d.timestart <= $now AND (d.timeend = 0 OR d.timeend > $now))";
2180             if (isloggedin()) {
2181                 $timelimit .= " OR d.userid = $USER->id";
2182             }
2183             $timelimit .= ")";
2184         }
2185     }
2187     if ($limit > 0) {
2188         $limitfrom = 0;
2189         $limitnum  = $limit;
2190     } else if ($page != -1) {
2191         $limitfrom = $page*$perpage;
2192         $limitnum  = $perpage;
2193     } else {
2194         $limitfrom = 0;
2195         $limitnum  = 0;
2196     }
2198     $groupmode    = groups_get_activity_groupmode($cm);
2199     $currentgroup = groups_get_activity_group($cm);
2201     if ($groupmode) {
2202         if (empty($modcontext)) {
2203             $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2204         }
2206         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2207             if ($currentgroup) {
2208                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2209             } else {
2210                 $groupselect = "";
2211             }
2213         } else {
2214             //seprate groups without access all
2215             if ($currentgroup) {
2216                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2217             } else {
2218                 $groupselect = "AND d.groupid = -1";
2219             }
2220         }
2221     } else {
2222         $groupselect = "";
2223     }
2226     if (empty($forumsort)) {
2227         $forumsort = "d.timemodified DESC";
2228     }
2229     if (empty($fullpost)) {
2230         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2231     } else {
2232         $postdata = "p.*";
2233     }
2235     if (empty($userlastmodified)) {  // We don't need to know this
2236         $umfields = "";
2237         $umtable  = "";
2238     } else {
2239         $umfields = ", um.firstname AS umfirstname, um.lastname AS umlastname";
2240         $umtable  = " LEFT JOIN {$CFG->prefix}user um ON (d.usermodified = um.id)";
2241     }
2243     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend,
2244                    u.firstname, u.lastname, u.email, u.picture, u.imagealt $umfields
2245               FROM {$CFG->prefix}forum_discussions d
2246                    JOIN {$CFG->prefix}forum_posts p ON p.discussion = d.id
2247                    JOIN {$CFG->prefix}user u ON p.userid = u.id
2248                    $umtable
2249              WHERE d.forum = {$cm->instance} AND p.parent = 0
2250                    $timelimit $groupselect
2251           ORDER BY $forumsort";
2252     return get_records_sql($sql, $limitfrom, $limitnum);
2255 function forum_get_discussions_unread($cm) {
2256     global $CFG, $USER;
2258     $now = round(time(), -2);
2260     $groupmode    = groups_get_activity_groupmode($cm);
2261     $currentgroup = groups_get_activity_group($cm);
2263     if ($groupmode) {
2264         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2266         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2267             if ($currentgroup) {
2268                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2269             } else {
2270                 $groupselect = "";
2271             }
2273         } else {
2274             //seprate groups without access all
2275             if ($currentgroup) {
2276                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2277             } else {
2278                 $groupselect = "AND d.groupid = -1";
2279             }
2280         }
2281     } else {
2282         $groupselect = "";
2283     }
2285     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2287     if (!empty($CFG->forum_enabletimedposts)) {
2288         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2289     } else {
2290         $timedsql = "";
2291     }
2293     $sql = "SELECT d.id, COUNT(p.id) AS unread
2294               FROM {$CFG->prefix}forum_discussions d
2295                    JOIN {$CFG->prefix}forum_posts p     ON p.discussion = d.id
2296                    LEFT JOIN {$CFG->prefix}forum_read r ON (r.postid = p.id AND r.userid = $USER->id)
2297              WHERE d.forum = {$cm->instance}
2298                    AND p.modified >= $cutoffdate AND r.id is NULL
2299                    $timedsql
2300                    $groupselect
2301           GROUP BY d.id";
2302     if ($unreads = get_records_sql($sql)) {
2303         foreach ($unreads as $unread) {
2304             $unreads[$unread->id] = $unread->unread;
2305         }
2306         return $unreads;
2307     } else {
2308         return array();
2309     }
2312 function forum_get_discussions_count($cm) {
2313     global $CFG, $USER;
2315     $now = round(time(), -2);
2317     $groupmode    = groups_get_activity_groupmode($cm);
2318     $currentgroup = groups_get_activity_group($cm);
2320     if ($groupmode) {
2321         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2323         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2324             if ($currentgroup) {
2325                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2326             } else {
2327                 $groupselect = "";
2328             }
2330         } else {
2331             //seprate groups without access all
2332             if ($currentgroup) {
2333                 $groupselect = "AND (d.groupid = $currentgroup OR d.groupid = -1)";
2334             } else {
2335                 $groupselect = "AND d.groupid = -1";
2336             }
2337         }
2338     } else {
2339         $groupselect = "";
2340     }
2342     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2344     $timelimit = "";
2346     if (!empty($CFG->forum_enabletimedposts)) {
2348         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2350         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2351             $timelimit = " AND ((d.timestart <= $now AND (d.timeend = 0 OR d.timeend > $now))";
2352             if (isloggedin()) {
2353                 $timelimit .= " OR d.userid = $USER->id";
2354             }
2355             $timelimit .= ")";
2356         }
2357     }
2359     $sql = "SELECT COUNT(d.id)
2360               FROM {$CFG->prefix}forum_discussions d
2361                    JOIN {$CFG->prefix}forum_posts p ON p.discussion = d.id
2362              WHERE d.forum = {$cm->instance} AND p.parent = 0
2363                    $timelimit $groupselect";
2365     return get_field_sql($sql);
2369 /**
2370  * Get all discussions started by a particular user in a course (or group)
2371  * This function no longer used ...
2372  */
2373 function forum_get_user_discussions($courseid, $userid, $groupid=0) {
2374     global $CFG;
2376     if ($groupid) {
2377         $groupselect = " AND d.groupid = '$groupid' ";
2378     } else  {
2379         $groupselect = "";
2380     }
2382     return get_records_sql("SELECT p.*, d.groupid, u.firstname, u.lastname, u.email, u.picture, u.imagealt,
2383                                    f.type as forumtype, f.name as forumname, f.id as forumid
2384                               FROM {$CFG->prefix}forum_discussions d,
2385                                    {$CFG->prefix}forum_posts p,
2386                                    {$CFG->prefix}user u,
2387                                    {$CFG->prefix}forum f
2388                              WHERE d.course = '$courseid'
2389                                AND p.discussion = d.id
2390                                AND p.parent = 0
2391                                AND p.userid = u.id
2392                                AND u.id = '$userid'
2393                                AND d.forum = f.id $groupselect
2394                           ORDER BY p.created DESC");
2397 /**
2398  * Returns list of user objects that are subscribed to this forum
2399  */
2400 function forum_subscribed_users($course, $forum, $groupid=0) {
2402     global $CFG;
2404     if ($groupid) {
2405         $grouptables = ", {$CFG->prefix}groups_members gm ";
2406         $groupselect = "AND gm.groupid = $groupid AND u.id = gm.userid";
2408     } else  {
2409         $grouptables = '';
2410         $groupselect = '';
2411     }
2413     if (forum_is_forcesubscribed($forum)) {
2414         $context = get_context_instance(CONTEXT_COURSE, $course->id);
2415         $sort = "u.email ASC";
2416         $fields ="u.id, u.username, u.firstname, u.lastname, u.maildisplay, u.mailformat, u.maildigest, u.emailstop, u.imagealt,
2417                   u.email, u.city, u.country, u.lastaccess, u.lastlogin, u.picture, u.timezone, u.theme, u.lang, u.trackforums, u.mnethostid";
2418         $results = get_users_by_capability($context, 'mod/forum:initialsubscriptions', $fields, $sort, '','','','', false, true);
2419     } else {
2420         $results = get_records_sql("SELECT u.id, u.username, u.firstname, u.lastname, u.maildisplay, u.mailformat, u.maildigest, u.emailstop, u.imagealt,
2421                                    u.email, u.city, u.country, u.lastaccess, u.lastlogin, u.picture, u.timezone, u.theme, u.lang, u.trackforums, u.mnethostid
2422                               FROM {$CFG->prefix}user u,
2423                                    {$CFG->prefix}forum_subscriptions s $grouptables
2424                              WHERE s.forum = '$forum->id'
2425                                AND s.userid = u.id
2426                                AND u.deleted = 0  $groupselect
2427                           ORDER BY u.email ASC");
2428     }
2430     static $guestid = null;
2432     if (is_null($guestid)) {
2433         if ($guest = guest_user()) {
2434             $guestid = $guest->id;
2435         } else {
2436             $guestid = 0;
2437         }
2438     }
2440     // Guest user should never be subscribed to a forum.
2441     unset($results[$guestid]);
2443     return $results;
2448 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2451 function forum_get_course_forum($courseid, $type) {
2452 // How to set up special 1-per-course forums
2453     global $CFG;
2455     if ($forums = get_records_select("forum", "course = '$courseid' AND type = '$type'", "id ASC")) {
2456         // There should always only be ONE, but with the right combination of
2457         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2458         foreach ($forums as $forum) {
2459             return $forum;   // ie the first one
2460         }
2461     }
2463     // Doesn't exist, so create one now.
2464     $forum->course = $courseid;
2465     $forum->type = "$type";
2466     switch ($forum->type) {
2467         case "news":
2468             $forum->name  = addslashes(get_string("namenews", "forum"));
2469             $forum->intro = addslashes(get_string("intronews", "forum"));
2470             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2471             $forum->assessed = 0;
2472             if ($courseid == SITEID) {
2473                 $forum->name  = get_string("sitenews");
2474                 $forum->forcesubscribe = 0;
2475             }
2476             break;
2477         case "social":
2478             $forum->name  = addslashes(get_string("namesocial", "forum"));
2479             $forum->intro = addslashes(get_string("introsocial", "forum"));
2480             $forum->assessed = 0;
2481             $forum->forcesubscribe = 0;
2482             break;
2483         default:
2484             notify("That forum type doesn't exist!");
2485             return false;
2486             break;
2487     }
2489     $forum->timemodified = time();
2490     $forum->id = insert_record("forum", $forum);
2492     if (! $module = get_record("modules", "name", "forum")) {
2493         notify("Could not find forum module!!");
2494         return false;
2495     }
2496     $mod = new object();
2497     $mod->course = $courseid;
2498     $mod->module = $module->id;
2499     $mod->instance = $forum->id;
2500     $mod->section = 0;
2501     if (! $mod->coursemodule = add_course_module($mod) ) {   // assumes course/lib.php is loaded
2502         notify("Could not add a new course module to the course '" . format_string($course->fullname) . "'");
2503         return false;
2504     }
2505     if (! $sectionid = add_mod_to_section($mod) ) {   // assumes course/lib.php is loaded
2506         notify("Could not add the new course module to that section");
2507         return false;
2508     }
2509     if (! set_field("course_modules", "section", $sectionid, "id", $mod->coursemodule)) {
2510         notify("Could not update the course module with the correct section");
2511         return false;
2512     }
2513     include_once("$CFG->dirroot/course/lib.php");
2514     rebuild_course_cache($courseid);
2516     return get_record("forum", "id", "$forum->id");
2520 /**
2521 * Given the data about a posting, builds up the HTML to display it and
2522 * returns the HTML in a string.  This is designed for sending via HTML email.
2523 */
2524 function forum_make_mail_post($course, $forum, $discussion, $post, $userfrom, $userto,
2525                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
2527     global $CFG;
2529     if (!isset($userto->viewfullnames[$forum->id])) {
2530         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
2531             error('Course Module ID was incorrect');
2532         }
2533         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2534         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
2535     } else {
2536         $viewfullnames = $userto->viewfullnames[$forum->id];
2537     }
2539     // format the post body
2540     $options = new object();
2541     $options->para = true;
2542     $formattedtext = format_text(trusttext_strip($post->message), $post->format, $options, $course->id);
2544     $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
2546     $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
2547     $output .= print_user_picture($userfrom, $course->id, $userfrom->picture, false, true);
2548     $output .= '</td>';
2550     if ($post->parent) {
2551         $output .= '<td class="topic">';
2552     } else {
2553         $output .= '<td class="topic starter">';
2554     }
2555     $output .= '<div class="subject">'.format_string($post->subject).'</div>';
2557     $fullname = fullname($userfrom, $viewfullnames);
2558     $by = new object();
2559     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
2560     $by->date = userdate($post->modified, '', $userto->timezone);
2561     $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
2563     $output .= '</td></tr>';
2565     $output .= '<tr><td class="left side" valign="top">';
2567     if (isset($userfrom->groups)) {
2568         $groups = $userfrom->groups[$forum->id];
2569     } else {
2570         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
2571             error('Course Module ID was incorrect');
2572         }
2573         $group = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
2574     }
2576     if ($groups) {
2577         $output .= print_group_picture($groups, $course->id, false, true, true);
2578     } else {
2579         $output .= '&nbsp;';
2580     }
2582     $output .= '</td><td class="content">';
2584     if ($post->attachment) {
2585         $post->course = $course->id;
2586         $output .= '<div class="attachments">';
2587         $output .= forum_print_attachments($post, 'html');
2588         $output .= "</div>";
2589     }
2591     $output .= $formattedtext;
2593 // Commands
2594     $commands = array();
2596     if ($post->parent) {
2597         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2598                       $post->discussion.'&amp;parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
2599     }
2601     if ($reply) {
2602         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
2603                       get_string('reply', 'forum').'</a>';
2604     }
2606     $output .= '<div class="commands">';
2607     $output .= implode(' | ', $commands);
2608     $output .= '</div>';
2610 // Context link to post if required
2611     if ($link) {
2612         $output .= '<div class="link">';
2613         $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
2614                      get_string('postincontext', 'forum').'</a>';
2615         $output .= '</div>';
2616     }
2618     if ($footer) {
2619         $output .= '<div class="footer">'.$footer.'</div>';
2620     }
2621     $output .= '</td></tr></table>'."\n\n";
2623     return $output;
2626 /**
2627  * Print a forum post
2628  *
2629  * @param object $post The post to print.
2630  * @param integer $courseid The course this post belongs to.
2631  * @param boolean $ownpost Whether this post belongs to the current user.
2632  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
2633  * @param boolean $link Just print a shortened version of the post as a link to the full post.
2634  * @param object $ratings -- I don't really know --
2635  * @param string $footer Extra stuff to print after the message.
2636  * @param string $highlight Space-separated list of terms to highlight.
2637  * @param int $post_read true, false or -99. If we already know whether this user
2638  *          has read this post, pass that in, otherwise, pass in -99, and this
2639  *          function will work it out.
2640  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
2641  *          the current user can't see this post, if this argument is true
2642  *          (the default) then print a dummy 'you can't see this post' post.
2643  *          If false, don't output anything at all.
2644  */
2645 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
2646                           $ratings=NULL, $footer="", $highlight="", $post_read=null, $dummyifcantsee=true, $istracked=null) {
2648     global $USER, $CFG;
2650     static $stredit, $strdelete, $strreply, $strparent, $strprune;
2651     static $strpruneheading, $displaymode;
2652     static $strmarkread, $strmarkunread;
2654     $post->course = $course->id;
2655     $post->forum  = $forum->id;
2657     // caching
2658     if (!isset($cm->cache)) {
2659         $cm->cache = new object();
2660     }
2662     if (!isset($cm->cache->caps)) {
2663         $cm->cache->caps = array();
2664         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2665         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
2666         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
2667         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
2668         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
2669         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
2670         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
2671         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
2672     }
2674     if (!isset($cm->uservisible)) {
2675         $cm->uservisible = coursemodule_visible_for_user($cm);
2676     }
2678     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
2679         if (!$dummyifcantsee) {
2680             return;
2681         }
2682         echo '<a id="p'.$post->id.'"></a>';
2683         echo '<table cellspacing="0" class="forumpost">';
2684         echo '<tr class="header"><td class="picture left">';
2685         //        print_user_picture($post->userid, $courseid, $post->picture);
2686         echo '</td>';
2687         if ($post->parent) {
2688             echo '<td class="topic">';
2689         } else {
2690             echo '<td class="topic starter">';
2691         }
2692         echo '<div class="subject">'.get_string('forumsubjecthidden','forum').'</div>';
2693         echo '<div class="author">';
2694         print_string('forumauthorhidden','forum');
2695         echo '</div></td></tr>';
2697         echo '<tr><td class="left side">';
2698         echo '&nbsp;';
2700         // Actual content
2702         echo '</td><td class="content">'."\n";
2703         echo get_string('forumbodyhidden','forum');
2704         echo '</td></tr></table>';
2705         return;
2706     }
2708     if (empty($stredit)) {
2709         $stredit         = get_string('edit', 'forum');
2710         $strdelete       = get_string('delete', 'forum');
2711         $strreply        = get_string('reply', 'forum');
2712         $strparent       = get_string('parent', 'forum');
2713         $strpruneheading = get_string('pruneheading', 'forum');
2714         $strprune        = get_string('prune', 'forum');
2715         $displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
2716         $strmarkread     = get_string('markread', 'forum');
2717         $strmarkunread   = get_string('markunread', 'forum');
2719     }
2721     $read_style = '';
2722     // ignore trackign status if not tracked or tracked param missing
2723     if ($istracked) {
2724         if (is_null($post_read)) {
2725             debugging('fetching post_read info');
2726             $post_read = forum_tp_is_post_read($USER->id, $post);
2727         }
2729         if ($post_read) {
2730             $read_style = ' read';
2731         } else {
2732             $read_style = ' unread';
2733             echo '<a name="unread"></a>';
2734         }
2735     }
2737     echo '<a id="p'.$post->id.'"></a>';
2738     echo '<table cellspacing="0" class="forumpost'.$read_style.'">';
2740     // Picture
2741     $postuser = new object();
2742     $postuser->id        = $post->userid;
2743     $postuser->firstname = $post->firstname;
2744     $postuser->lastname  = $post->lastname;
2745     $postuser->imagealt  = $post->imagealt;
2746     $postuser->picture   = $post->picture;
2748     echo '<tr class="header"><td class="picture left">';
2749     print_user_picture($postuser, $course->id);
2750     echo '</td>';
2752     if ($post->parent) {
2753         echo '<td class="topic">';
2754     } else {
2755         echo '<td class="topic starter">';
2756     }
2758     if (!empty($post->subjectnoformat)) {
2759         echo '<div class="subject">'.$post->subject.'</div>';
2760     } else {
2761         echo '<div class="subject">'.format_string($post->subject).'</div>';
2762     }
2764     echo '<div class="author">';
2765     $fullname = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
2766     $by = new object();
2767     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.
2768                 $post->userid.'&amp;course='.$course->id.'">'.$fullname.'</a>';
2769     $by->date = userdate($post->modified);
2770     print_string('bynameondate', 'forum', $by);
2771     echo '</div></td></tr>';
2773     echo '<tr><td class="left side">';
2774     if (isset($cm->cache->usersgroups)) {
2775         $groups = array();
2776         if (isset($cm->cache->usersgroups[$post->userid])) {
2777             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
2778                 $groups[$gid] = $cm->cache->groups[$gid];
2779             }
2780         }
2781     } else {
2782         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
2783     }
2785     if ($groups) {
2786         print_group_picture($groups, $course->id, false, false, true);
2787     } else {
2788         echo '&nbsp;';
2789     }
2791 // Actual content
2793     echo '</td><td class="content">'."\n";
2795     if ($post->attachment) {
2796         echo '<div class="attachments">';
2797         $attachedimages = forum_print_attachments($post);
2798         echo '</div>';
2799     } else {
2800         $attachedimages = '';
2801     }
2804     $options = new object();
2805     $options->para      = false;
2806     $options->trusttext = true;
2807     if ($link and (strlen(strip_tags($post->message)) > $CFG->forum_longpost)) {
2808         // Print shortened version
2809         echo format_text(forum_shorten_post($post->message), $post->format, $options, $course->id);
2810         $numwords = count_words(strip_tags($post->message));
2811         echo '<p><a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
2812         echo get_string('readtherest', 'forum');
2813         echo '</a> ('.get_string('numwords', '', $numwords).')...</p>';
2814     } else {
2815         // Print whole message
2816         if ($highlight) {
2817             echo highlight($highlight, format_text($post->message, $post->format, $options, $course->id));
2818         } else {
2819             echo format_text($post->message, $post->format, $options, $course->id);
2820         }
2821         echo $attachedimages;
2822     }
2825 // Commands
2827     $commands = array();
2829     if ($istracked) {
2830         // SPECIAL CASE: The front page can display a news item post to non-logged in users.
2831         // Don't display the mark read / unread controls in this case.
2832         if ($CFG->forum_usermarksread and isloggedin()) {
2833             if ($post_read) {
2834                 $mcmd = '&amp;mark=unread&amp;postid='.$post->id;
2835                 $mtxt = $strmarkunread;
2836             } else {
2837                 $mcmd = '&amp;mark=read&amp;postid='.$post->id;
2838                 $mtxt = $strmarkread;
2839             }
2840             if ($displaymode == FORUM_MODE_THREADED) {
2841                 $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2842                               $post->discussion.'&amp;parent='.$post->id.$mcmd.'">'.$mtxt.'</a>';
2843             } else {
2844                 $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2845                               $post->discussion.$mcmd.'#p'.$post->id.'">'.$mtxt.'</a>';
2846             }
2847         }
2848     }
2850     if ($post->parent) {  // Zoom in to the parent specifically
2851         if ($displaymode == FORUM_MODE_THREADED) {
2852             $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2853                       $post->discussion.'&amp;parent='.$post->parent.'">'.$strparent.'</a>';
2854         } else {
2855             $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
2856                       $post->discussion.'#p'.$post->parent.'">'.$strparent.'</a>';
2857         }
2858     }
2860     $age = time() - $post->created;
2861     // Hack for allow to edit news posts those are not displayed yet until they are displayed
2862     if (!$post->parent and $forum->type == 'news' and $discussion->timestart > time()) {
2863         $age = 0;
2864     }
2865     $editanypost = $cm->cache->caps['mod/forum:editanypost'];
2867     if ($ownpost or $editanypost) {
2868         if (($age < $CFG->maxeditingtime) or $editanypost) {
2869             $commands[] =  '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?edit='.$post->id.'">'.$stredit.'</a>';
2870         }
2871     }
2873     if ($cm->cache->caps['mod/forum:splitdiscussions']
2874                 && $post->parent && $forum->type != 'single') {
2876         $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?prune='.$post->id.
2877                       '" title="'.$strpruneheading.'">'.$strprune.'</a>';
2878     }
2880     if (($ownpost and $age < $CFG->maxeditingtime
2881                 and $cm->cache->caps['mod/forum:deleteownpost'])
2882                 or $cm->cache->caps['mod/forum:deleteanypost']) {
2883         $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?delete='.$post->id.'">'.$strdelete.'</a>';
2884     }
2886     if ($reply) {
2887         $commands[] = '<a href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.$strreply.'</a>';
2888     }
2890     echo '<div class="commands">';
2891     echo implode(' | ', $commands);
2892     echo '</div>';
2895 // Ratings
2897     $ratingsmenuused = false;
2898     if (!empty($ratings) and isloggedin()) {
2899         echo '<div class="ratings">';
2900         $useratings = true;
2901         if ($ratings->assesstimestart and $ratings->assesstimefinish) {
2902             if ($post->created < $ratings->assesstimestart or $post->created > $ratings->assesstimefinish) {
2903                 $useratings = false;
2904             }
2905         }
2906         if ($useratings) {
2907             $mypost = ($USER->id == $post->userid);
2909             $canviewallratings = $cm->cache->caps['mod/forum:viewanyrating'];
2911             if (isset($cm->cache->ratings)) {
2912                 if (isset($cm->cache->ratings[$post->id])) {
2913                     $allratings = $cm->cache->ratings[$post->id];
2914                 } else {
2915                     $allratings = array(); // no reatings present yet
2916                 }
2917             } else {
2918                 $allratings = NULL; // not preloaded
2919             }
2921             if (isset($cm->cache->myratings)) {
2922                 if (isset($cm->cache->myratings[$post->id])) {
2923                     $myrating = $cm->cache->myratings[$post->id];
2924                 } else {
2925                     $myrating = FORUM_UNSET_POST_RATING; // no reatings present yet
2926                 }
2927             } else {
2928                 $myrating = NULL; // not preloaded
2929             }
2931             if ($canviewallratings and !$mypost) {
2932                 forum_print_ratings($post->id, $ratings->scale, $forum->assessed, $canviewallratings, $allratings);
2933                 if (!empty($ratings->allow)) {
2934                     echo '&nbsp;';
2935                     forum_print_rating_menu($post->id, $USER->id, $ratings->scale, $myrating);
2936                     $ratingsmenuused = true;
2937                 }
2939             } else if ($mypost) {
2940                 forum_print_ratings($post->id, $ratings->scale, $forum->assessed, true, $allratings);
2942             } else if (!empty($ratings->allow) ) {
2943                 forum_print_rating_menu($post->id, $USER->id, $ratings->scale, $myrating);
2944                 $ratingsmenuused = true;
2945             }
2946         }
2947         echo '</div>';
2948     }
2950 // Link to post if required
2952     if ($link) {
2953         echo '<div class="link">';
2954         if ($post->replies == 1) {
2955             $replystring = get_string('repliesone', 'forum', $post->replies);
2956         } else {
2957             $replystring = get_string('repliesmany', 'forum', $post->replies);
2958         }
2959         echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">'.
2960              get_string('discussthistopic', 'forum').'</a>&nbsp;('.$replystring.')';
2961         echo '</div>';
2962     }
2964     if ($footer) {
2965         echo '<div class="footer">'.$footer.'</div>';
2966     }
2967     echo '</td></tr></table>'."\n\n";
2969     if ($istracked && !$CFG->forum_usermarksread && !$post_read) {
2970         forum_tp_mark_post_read($USER->id, $post, $forum->id);
2971     }
2973     return $ratingsmenuused;
2977 /**
2978  * This function prints the overview of a discussion in the forum listing.
2979  * It needs some discussion information and some post information, these
2980  * happen to be combined for efficiency in the $post parameter by the function
2981  * that calls this one: forum_print_latest_discussions()
2982  *
2983  * @param object $post The post object (passed by reference for speed).
2984  * @param object $forum The forum object.
2985  * @param int $group Current group.
2986  * @param string $datestring Format to use for the dates.
2987  * @param boolean $cantrack Is tracking enabled for this forum.
2988  * @param boolean $forumtracked Is the user tracking this forum.
2989  * @param boolean $canviewparticipants True if user has the viewparticipants permission for this course
2990  */
2991 function forum_print_discussion_header(&$post, $forum, $group=-1, $datestring="",
2992                                         $cantrack=true, $forumtracked=true, $canviewparticipants=true, $modcontext=NULL) {
2994     global $USER, $CFG;
2996     static $rowcount;
2997     static $strmarkalldread;
2999     if (empty($modcontext)) {
3000         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
3001             error('Course Module ID was incorrect');
3002         }
3003         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
3004     }
3006     if (!isset($rowcount)) {
3007         $rowcount = 0;
3008         $strmarkalldread = get_string('markalldread', 'forum');
3009     } else {
3010         $rowcount = ($rowcount + 1) % 2;
3011     }
3013     $post->subject = format_string($post->subject,true);
3015     echo "\n\n";
3016     echo '<tr class="discussion r'.$rowcount.'">';
3018     // Topic
3019     echo '<td class="topic starter">';
3020     echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">'.$post->subject.'</a>';
3021     echo "</td>\n";
3023     // Picture
3024     $postuser = new object;
3025     $postuser->id = $post->userid;
3026     $postuser->firstname = $post->firstname;
3027     $postuser->lastname = $post->lastname;
3028     $postuser->imagealt = $post->imagealt;
3029     $postuser->picture = $post->picture;
3031     echo '<td class="picture">';
3032     print_user_picture($postuser, $forum->course);
3033     echo "</td>\n";
3035     // User name
3036     $fullname = fullname($post, has_capability('moodle/site:viewfullnames', $modcontext));
3037     echo '<td class="author">';
3038     echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$post->userid.'&amp;course='.$forum->course.'">'.$fullname.'</a>';
3039     echo "</td>\n";
3041     // Group picture
3042     if ($group !== -1) {  // Groups are active - group is a group data object or NULL
3043         echo '<td class="picture group">';
3044         if (!empty($group->picture) and empty($group->hidepicture)) {
3045             print_group_picture($group, $forum->course, false, false, true);
3046         } else if (isset($group->id)) {
3047             if($canviewparticipants) {
3048                 echo '<a href="'.$CFG->wwwroot.'/user/index.php?id='.$forum->course.'&amp;group='.$group->id.'">'.$group->name.'</a>';
3049             } else {
3050                 echo $group->name;
3051             }
3052         }
3053         echo "</td>\n";
3054     }
3056     if (has_capability('mod/forum:viewdiscussion', $modcontext)) {   // Show the column with replies
3057         echo '<td class="replies">';
3058         echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
3059         echo $post->replies.'</a>';
3060         echo "</td>\n";
3062         if ($cantrack) {
3063             echo '<td class="replies">';
3064             if ($forumtracked) {
3065                 if ($post->unread > 0) {
3066                     echo '<span class="unread">';
3067                     echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#unread">';
3068                     echo $post->unread;
3069                     echo '</a>';
3070                     echo '<a title="'.$strmarkalldread.'" href="'.$CFG->wwwroot.'/mod/forum/markposts.php?f='.
3071                          $forum->id.'&amp;d='.$post->discussion.'&amp;mark=read&amp;returnpage=view.php">' .
3072                          '<img src="'.$CFG->pixpath.'/t/clear.gif" class="iconsmall" alt="'.$strmarkalldread.'" /></a>';
3073                     echo '</span>';
3074                 } else {
3075                     echo '<span class="read">';
3076                     echo $post->unread;
3077                     echo '</span>';
3078                 }
3079             } else {
3080                 echo '<span class="read">';
3081                 echo '-';
3082                 echo '</span>';
3083             }
3084             echo "</td>\n";
3085         }
3086     }
3088     echo '<td class="lastpost">';
3089     $usedate = (empty($post->timemodified)) ? $post->modified : $post->timemodified;  // Just in case
3090     $parenturl = (empty($post->lastpostid)) ? '' : '&amp;parent='.$post->lastpostid;
3091     $usermodified = new object();
3092     $usermodified->id        = $post->usermodified;
3093     $usermodified->firstname = $post->umfirstname;
3094     $usermodified->lastname  = $post->umlastname;
3095     echo '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$post->usermodified.'&amp;course='.$forum->course.'">'.
3096          fullname($usermodified).'</a><br />';
3097     echo '<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.$parenturl.'">'.
3098           userdate($usedate, $datestring).'</a>';
3099     echo "</td>\n";
3101     echo "</tr>\n\n";
3106 /**
3107  * Given a post object that we already know has a long message
3108  * this function truncates the message nicely to the first
3109  * sane place between $CFG->forum_longpost and $CFG->forum_shortpost
3110  */
3111 function forum_shorten_post($message) {
3113    global $CFG;
3115    $i = 0;
3116    $tag = false;
3117    $length = strlen($message);
3118    $count = 0;
3119    $stopzone = false;
3120    $truncate = 0;
3122    for ($i=0; $i<$length; $i++) {
3123        $char = $message[$i];
3125        switch ($char) {
3126            case "<":
3127                $tag = true;
3128                break;
3129            case ">":
3130                $tag = false;
3131                break;
3132            default:
3133                if (!$tag) {
3134                    if ($stopzone) {
3135                        if ($char == ".") {
3136                            $truncate = $i+1;
3137                            break 2;
3138                        }
3139                    }
3140                    $count++;
3141                }
3142                break;
3143        }
3144        if (!$stopzone) {
3145            if ($count > $CFG->forum_shortpost) {
3146                $stopzone = true;
3147            }
3148        }
3149    }
3151    if (!$truncate) {
3152        $truncate = $i;
3153    }
3155    return substr($message, 0, $truncate);
3159 /**
3160  * Print the multiple ratings on a post given to the current user by others.
3161  * Forumid prevents the double lookup of the forumid in discussion to determine the aggregate type
3162  * Scale is an array of ratings
3163  */
3164 function forum_print_ratings($postid, $scale, $aggregatetype, $link=true, $ratings=null) {
3166     $strratings = '';
3168     switch ($aggregatetype) {
3169         case FORUM_AGGREGATE_AVG :
3170             $agg        = forum_get_ratings_mean($postid, $scale, $ratings);
3171             $strratings = get_string("aggregateavg", "forum");
3172             break;
3173         case FORUM_AGGREGATE_COUNT :
3174             $agg        = forum_get_ratings_count($postid, $scale, $ratings);
3175             $strratings = get_string("aggregatecount", "forum");
3176             break;
3177         case FORUM_AGGREGATE_MAX :
3178             $agg        = forum_get_ratings_max($postid, $scale, $ratings);
3179             $strratings = get_string("aggregatemax", "forum");
3180             break;
3181         case FORUM_AGGREGATE_MIN :
3182             $agg        = forum_get_ratings_min($postid, $scale, $ratings);
3183             $strratings = get_string("aggregatemin", "forum");
3184             break;
3185         case FORUM_AGGREGATE_SUM :
3186             $agg        = forum_get_ratings_sum($postid, $scale, $ratings);
3187             $strratings = get_string("aggregatesum", "forum");
3188             break;
3189     }
3191     if ($agg !== "") {
3193         if (empty($strratings)) {
3194             $strratings = get_string("ratings", "forum");
3195         }
3197         echo "$strratings: ";
3198         if ($link) {
3199             link_to_popup_window ("/mod/forum/report.php?id=$postid", "ratings", $agg, 400, 600);
3200         } else {
3201             echo "$agg ";
3202         }
3203     }
3207 /**
3208  * Return the mean rating of a post given to the current user by others.
3209  * Scale is an array of possible ratings in the scale
3210  * Ratings is an optional simple array of actual ratings (just integers)
3211  * 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
3212  */
3213 function forum_get_ratings_mean($postid, $scale, $ratings=NULL) {
3215     if (is_null($ratings)) {
3216         $ratings = array();
3217         if ($rates = get_records("forum_ratings", "post", $postid)) {
3218             foreach ($rates as $rate) {
3219                 $ratings[] = $rate->rating;
3220             }
3221         }
3222     }
3224     $count = count($ratings);
3226     if ($count == 0 ) {
3227         return "";
3229     } else if ($count == 1) {
3230         $rating = reset($ratings);
3231         return $scale[$rating];
3233     } else {
3234         $total = 0;
3235         foreach ($ratings as $rating) {
3236             $total += $rating;
3237         }
3238         $mean = round( ((float)$total/(float)$count) + 0.001);  // Little fudge factor so that 0.5 goes UP
3240         if (isset($scale[$mean])) {
3241             return $scale[$mean]." ($count)";
3242         } else {
3243             return "$mean ($count)";    // Should never happen, hopefully
3244         }
3245     }
3248 /**
3249  * Return the count of the ratings of a post given to the current user by others.
3250  * Scale is an array of possible ratings in the scale - the end of the scale is the highest or max grade
3251  * Ratings is an optional simple array of actual ratings (just integers)
3252  */
3253 function forum_get_ratings_count($postid, $scale, $ratings=NULL) {
3255     if (is_null($ratings)) {
3256         $ratings = array();
3257         if ($rates = get_records("forum_ratings", "post", $postid)) {
3258             foreach ($rates as $rate) {
3259                 $ratings[] = $rate->rating;
3260             }
3261         }
3262     }
3264     $count = count($ratings);
3265     $scalecount = count($scale)-1; //this should give us the last element of the scale aka the max grade with  $scale[$scalecount]
3267     if ($count > $scale[$scalecount]) { //if the count exceeds the forum scale (i.e. max grade then set the score to the max grade
3268         $count = $scale[$scalecount];
3269     }
3270     return $scale[$count];
3273 /**
3274  * Return the max rating of a post given to the current user by others.
3275  * Scale is an array of possible ratings in the scale
3276  * Ratings is an optional simple array of actual ratings (just integers)
3277  */
3278 function forum_get_ratings_max($postid, $scale, $ratings=NULL) {
3280     if (is_null($ratings)) {
3281         $ratings = array();
3282         if ($rates = get_records("forum_ratings", "post", $postid)) {
3283             foreach ($rates as $rate) {
3284                 $ratings[] = $rate->rating;
3285             }
3286         }
3287     }
3289     $count = count($ratings);
3290     $max = max($ratings);
3292     if ($count == 0 ) {
3293         return "";
3295     } else if ($count == 1) { //this works for max
3296         $rating = reset($ratings);
3297         return $scale[$rating];
3299     } else {
3301      if (isset($scale[$max])) {
3302             return $scale[$max]." ($count)";
3303         } else {
3304             return "$max ($count)";    // Should never happen, hopefully
3305         }
3306     }
3309 /**
3310  * Return the min rating of a post given to the current user by others.
3311  * Scale is an array of possible ratings in the scale
3312  * Ratings is an optional simple array of actual ratings (just integers)
3313  */
3314 function forum_get_ratings_min($postid, $scale,  $ratings=NULL) {
3316     if (is_null($ratings)) {
3317         $ratings = array();
3318         if ($rates = get_records("forum_ratings", "post", $postid)) {
3319             foreach ($rates as $rate) {
3320                 $ratings[] = $rate->rating;
3321             }
3322         }
3323     }
3325     $count = count($ratings);
3326     $min = min($ratings);
3328     if ($count == 0 ) {
3329         return "";
3331     } else if ($count == 1) {
3332         $rating = reset($ratings);
3333         return $scale[$rating]; //this works for min
3335     } else {
3337         if (isset($scale[$min])) {
3338             return $scale[$min]." ($count)";
3339         } else {
3340             return "$min ($count)";    // Should never happen, hopefully
3341         }
3342     }
3346 /**
3347  * Return the sum or total of ratings of a post given to the current user by others.
3348  * Scale is an array of possible ratings in the scale
3349  * Ratings is an optional simple array of actual ratings (just integers)
3350  */
3351 function forum_get_ratings_sum($postid, $scale, $ratings=NULL) {
3353     if (is_null($ratings)) {
3354         $ratings = array();
3355         if ($rates = get_records("forum_ratings", "post", $postid)) {
3356             foreach ($rates as $rate) {
3357                 $ratings[] = $rate->rating;
3358             }
3359         }
3360     }
3362     $count = count($ratings);
3363     $scalecount = count($scale)-1; //this should give us the last element of the scale aka the max grade with  $scale[$scalecount]
3365     if ($count == 0 ) {
3366         return "";
3368     } else if ($count == 1) { //this works for max.
3369         $rating = reset($ratings);
3370         return $scale[$rating];
3372     } else {
3373         $total = 0;
3374         foreach ($ratings as $rating) {
3375             $total += $rating;
3376         }
3377         if ($total > $scale[$scalecount]) { //if the total exceeds the max grade then set it to the max grade
3378             $total = $scale[$scalecount];
3379         }
3380         if (isset($scale[$total])) {
3381             return $scale[$total]." ($count)";
3382         } else {
3383             return "$total ($count)";    // Should never happen, hopefully
3384         }
3385     }
3388 /**
3389  * Return a summary of post ratings given to the current user by others.
3390  * Scale is an array of possible ratings in the scale
3391  * Ratings is an optional simple array of actual ratings (just integers)
3392  */
3393 function forum_get_ratings_summary($postid, $scale, $ratings=NULL) {
3395     if (is_null($ratings)) {
3396         $ratings = array();
3397         if ($rates = get_records("forum_ratings", "post", $postid)) {
3398             foreach ($rates as $rate) {
3399                 $rating[] = $rate->rating;
3400             }
3401         }
3402     }
3405     if (!$count = count($ratings)) {
3406         return "";
3407     }
3410     foreach ($scale as $key => $scaleitem) {
3411         $sumrating[$key] = 0;
3412     }
3414     foreach ($ratings as $rating) {
3415         $sumrating[$rating]++;
3416     }
3418     $summary = "";
3419     foreach ($scale as $key => $scaleitem) {
3420         $summary = $sumrating[$key].$summary;
3421         if ($key > 1) {
3422             $summary = "/$summary";
3423         }
3424     }
3425     return $summary;
3428 /**
3429  * Print the menu of ratings as part of a larger form.
3430  * If the post has already been - set that value.
3431  * Scale is an array of ratings
3432  */
3433 function forum_print_rating_menu($postid, $userid, $scale, $myrating=NULL) {
3435     static $strrate;
3437     if (is_null($myrating)) {
3438         if (!$rating = get_record("forum_ratings", "userid", $userid, "post", $postid)) {
3439             $myrating = FORUM_UNSET_POST_RATING;
3440         } else {
3441             $myrating = $rating->rating;
3442         }
3443     }
3445     if (empty($strrate)) {
3446         $strrate = get_string("rate", "forum");
3447     }
3448     $scale = array(FORUM_UNSET_POST_RATING => $strrate.'...') + $scale;
3449     choose_from_menu($scale, $postid, $myrating, '');
3452 /**
3453  * Print the drop down that allows the user to select how they want to have
3454  * the discussion displayed.