8602d85bff685a6bf39d1a38de3b958450724e8e
[moodle.git] / mod / forum / lib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package mod-forum
20  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
21  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 /** Include required files */
25 require_once($CFG->libdir.'/filelib.php');
26 require_once($CFG->libdir.'/eventslib.php');
27 require_once($CFG->dirroot.'/user/selector/lib.php');
29 /// CONSTANTS ///////////////////////////////////////////////////////////
31 define('FORUM_MODE_FLATOLDEST', 1);
32 define('FORUM_MODE_FLATNEWEST', -1);
33 define('FORUM_MODE_THREADED', 2);
34 define('FORUM_MODE_NESTED', 3);
36 define('FORUM_CHOOSESUBSCRIBE', 0);
37 define('FORUM_FORCESUBSCRIBE', 1);
38 define('FORUM_INITIALSUBSCRIBE', 2);
39 define('FORUM_DISALLOWSUBSCRIBE',3);
41 define('FORUM_TRACKING_OFF', 0);
42 define('FORUM_TRACKING_OPTIONAL', 1);
43 define('FORUM_TRACKING_ON', 2);
45 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
47 /**
48  * Given an object containing all the necessary data,
49  * (defined by the form in mod_form.php) this function
50  * will create a new instance and return the id number
51  * of the new instance.
52  *
53  * @global object
54  * @global object
55  * @param object $forum add forum instance (with magic quotes)
56  * @return int intance id
57  */
58 function forum_add_instance($forum, $mform) {
59     global $CFG, $DB;
61     $forum->timemodified = time();
63     if (empty($forum->assessed)) {
64         $forum->assessed = 0;
65     }
67     if (empty($forum->ratingtime) or empty($forum->assessed)) {
68         $forum->assesstimestart  = 0;
69         $forum->assesstimefinish = 0;
70     }
72     $forum->id = $DB->insert_record('forum', $forum);
73     $modcontext = get_context_instance(CONTEXT_MODULE, $forum->coursemodule);
75     if ($forum->type == 'single') {  // Create related discussion.
76         $discussion = new stdClass();
77         $discussion->course        = $forum->course;
78         $discussion->forum         = $forum->id;
79         $discussion->name          = $forum->name;
80         $discussion->assessed      = $forum->assessed;
81         $discussion->message       = $forum->intro;
82         $discussion->messageformat = $forum->introformat;
83         $discussion->messagetrust  = trusttext_trusted(get_context_instance(CONTEXT_COURSE, $forum->course));
84         $discussion->mailnow       = false;
85         $discussion->groupid       = -1;
87         $message = '';
89         $discussion->id = forum_add_discussion($discussion, null, $message);
91         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
92             // ugly hack - we need to copy the files somehow
93             $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
94             $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
96             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, array('subdirs'=>true), $post->message);
97             $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
98         }
99     }
101     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
102     /// all users should be subscribed initially
103     /// Note: forum_get_potential_subscribers should take the forum context,
104     /// but that does not exist yet, becuase the forum is only half build at this
105     /// stage. However, because the forum is brand new, we know that there are
106     /// no role assignments or overrides in the forum context, so using the
107     /// course context gives the same list of users.
108         $users = forum_get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
109         foreach ($users as $user) {
110             forum_subscribe($user->id, $forum->id);
111         }
112     }
114     forum_grade_item_update($forum);
116     return $forum->id;
120 /**
121  * Given an object containing all the necessary data,
122  * (defined by the form in mod_form.php) this function
123  * will update an existing instance with new data.
124  *
125  * @global object
126  * @param object $forum forum instance (with magic quotes)
127  * @return bool success
128  */
129 function forum_update_instance($forum, $mform) {
130     global $DB, $OUTPUT, $USER;
132     $forum->timemodified = time();
133     $forum->id           = $forum->instance;
135     if (empty($forum->assessed)) {
136         $forum->assessed = 0;
137     }
139     if (empty($forum->ratingtime) or empty($forum->assessed)) {
140         $forum->assesstimestart  = 0;
141         $forum->assesstimefinish = 0;
142     }
144     $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
146     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
147     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
148     // 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
149     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
150         forum_update_grades($forum); // recalculate grades for the forum
151     }
153     if ($forum->type == 'single') {  // Update related discussion and post.
154         if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
155             if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC')) {
156                 echo $OUTPUT->notification('Warning! There is more than one discussion in this forum - using the most recent');
157                 $discussion = array_pop($discussions);
158             } else {
159                 // try to recover by creating initial discussion - MDL-16262
160                 $discussion = new stdClass();
161                 $discussion->course          = $forum->course;
162                 $discussion->forum           = $forum->id;
163                 $discussion->name            = $forum->name;
164                 $discussion->assessed        = $forum->assessed;
165                 $discussion->message         = $forum->intro;
166                 $discussion->messageformat   = $forum->introformat;
167                 $discussion->messagetrust    = true;
168                 $discussion->mailnow         = false;
169                 $discussion->groupid         = -1;
171                 $message = '';
173                 forum_add_discussion($discussion, null, $message);
175                 if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
176                     print_error('cannotadd', 'forum');
177                 }
178             }
179         }
180         if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
181             print_error('cannotfindfirstpost', 'forum');
182         }
184         $cm         = get_coursemodule_from_instance('forum', $forum->id);
185         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
187         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
188             // ugly hack - we need to copy the files somehow
189             $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
190             $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
192             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, array('subdirs'=>true), $post->message);
193         }
195         $post->subject       = $forum->name;
196         $post->message       = $forum->intro;
197         $post->messageformat = $forum->introformat;
198         $post->messagetrust  = trusttext_trusted($modcontext);
199         $post->modified      = $forum->timemodified;
200         $post->userid        = $USER->id;    // MDL-18599, so that current teacher can take ownership of activities
202         $DB->update_record('forum_posts', $post);
203         $discussion->name = $forum->name;
204         $DB->update_record('forum_discussions', $discussion);
205     }
207     $DB->update_record('forum', $forum);
209     forum_grade_item_update($forum);
211     return true;
215 /**
216  * Given an ID of an instance of this module,
217  * this function will permanently delete the instance
218  * and any data that depends on it.
219  *
220  * @global object
221  * @param int $id forum instance id
222  * @return bool success
223  */
224 function forum_delete_instance($id) {
225     global $DB;
227     if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
228         return false;
229     }
230     if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
231         return false;
232     }
233     if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
234         return false;
235     }
237     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
239     // now get rid of all files
240     $fs = get_file_storage();
241     $fs->delete_area_files($context->id);
243     $result = true;
245     if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
246         foreach ($discussions as $discussion) {
247             if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
248                 $result = false;
249             }
250         }
251     }
253     if (!$DB->delete_records('forum_subscriptions', array('forum'=>$forum->id))) {
254         $result = false;
255     }
257     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
259     if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
260         $result = false;
261     }
263     forum_grade_item_delete($forum);
265     return $result;
269 /**
270  * Indicates API features that the forum supports.
271  *
272  * @uses FEATURE_GROUPS
273  * @uses FEATURE_GROUPINGS
274  * @uses FEATURE_GROUPMEMBERSONLY
275  * @uses FEATURE_MOD_INTRO
276  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
277  * @uses FEATURE_COMPLETION_HAS_RULES
278  * @uses FEATURE_GRADE_HAS_GRADE
279  * @uses FEATURE_GRADE_OUTCOMES
280  * @param string $feature
281  * @return mixed True if yes (some features may use other values)
282  */
283 function forum_supports($feature) {
284     switch($feature) {
285         case FEATURE_GROUPS:                  return true;
286         case FEATURE_GROUPINGS:               return true;
287         case FEATURE_GROUPMEMBERSONLY:        return true;
288         case FEATURE_MOD_INTRO:               return true;
289         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
290         case FEATURE_COMPLETION_HAS_RULES:    return true;
291         case FEATURE_GRADE_HAS_GRADE:         return true;
292         case FEATURE_GRADE_OUTCOMES:          return true;
293         case FEATURE_RATE:                    return true;
294         case FEATURE_BACKUP_MOODLE2:          return true;
296         default: return null;
297     }
301 /**
302  * Obtains the automatic completion state for this forum based on any conditions
303  * in forum settings.
304  *
305  * @global object
306  * @global object
307  * @param object $course Course
308  * @param object $cm Course-module
309  * @param int $userid User ID
310  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
311  * @return bool True if completed, false if not. (If no conditions, then return
312  *   value depends on comparison type)
313  */
314 function forum_get_completion_state($course,$cm,$userid,$type) {
315     global $CFG,$DB;
317     // Get forum details
318     if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
319         throw new Exception("Can't find forum {$cm->instance}");
320     }
322     $result=$type; // Default return value
324     $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
325     $postcountsql="
326 SELECT
327     COUNT(1)
328 FROM
329     {forum_posts} fp
330     INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
331 WHERE
332     fp.userid=:userid AND fd.forum=:forumid";
334     if ($forum->completiondiscussions) {
335         $value = $forum->completiondiscussions <=
336                  $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
337         if ($type == COMPLETION_AND) {
338             $result = $result && $value;
339         } else {
340             $result = $result || $value;
341         }
342     }
343     if ($forum->completionreplies) {
344         $value = $forum->completionreplies <=
345                  $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
346         if ($type==COMPLETION_AND) {
347             $result = $result && $value;
348         } else {
349             $result = $result || $value;
350         }
351     }
352     if ($forum->completionposts) {
353         $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
354         if ($type == COMPLETION_AND) {
355             $result = $result && $value;
356         } else {
357             $result = $result || $value;
358         }
359     }
361     return $result;
365 /**
366  * Function to be run periodically according to the moodle cron
367  * Finds all posts that have yet to be mailed out, and mails them
368  * out to all subscribers
369  *
370  * @global object
371  * @global object
372  * @global object
373  * @uses CONTEXT_MODULE
374  * @uses CONTEXT_COURSE
375  * @uses SITEID
376  * @uses FORMAT_PLAIN
377  * @return void
378  */
379 function forum_cron() {
380     global $CFG, $USER, $DB;
382     $site = get_site();
384     // all users that are subscribed to any post that needs sending
385     $users = array();
387     // status arrays
388     $mailcount  = array();
389     $errorcount = array();
391     // caches
392     $discussions     = array();
393     $forums          = array();
394     $courses         = array();
395     $coursemodules   = array();
396     $subscribedusers = array();
399     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
400     // cron has not been running for a long time, and then suddenly people are flooded
401     // with mail from the past few weeks or months
402     $timenow   = time();
403     $endtime   = $timenow - $CFG->maxeditingtime;
404     $starttime = $endtime - 48 * 3600;   // Two days earlier
406     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
407         // Mark them all now as being mailed.  It's unlikely but possible there
408         // might be an error later so that a post is NOT actually mailed out,
409         // but since mail isn't crucial, we can accept this risk.  Doing it now
410         // prevents the risk of duplicated mails, which is a worse problem.
412         if (!forum_mark_old_posts_as_mailed($endtime)) {
413             mtrace('Errors occurred while trying to mark some posts as being mailed.');
414             return false;  // Don't continue trying to mail them, in case we are in a cron loop
415         }
417         // checking post validity, and adding users to loop through later
418         foreach ($posts as $pid => $post) {
420             $discussionid = $post->discussion;
421             if (!isset($discussions[$discussionid])) {
422                 if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
423                     $discussions[$discussionid] = $discussion;
424                 } else {
425                     mtrace('Could not find discussion '.$discussionid);
426                     unset($posts[$pid]);
427                     continue;
428                 }
429             }
430             $forumid = $discussions[$discussionid]->forum;
431             if (!isset($forums[$forumid])) {
432                 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
433                     $forums[$forumid] = $forum;
434                 } else {
435                     mtrace('Could not find forum '.$forumid);
436                     unset($posts[$pid]);
437                     continue;
438                 }
439             }
440             $courseid = $forums[$forumid]->course;
441             if (!isset($courses[$courseid])) {
442                 if ($course = $DB->get_record('course', array('id' => $courseid))) {
443                     $courses[$courseid] = $course;
444                 } else {
445                     mtrace('Could not find course '.$courseid);
446                     unset($posts[$pid]);
447                     continue;
448                 }
449             }
450             if (!isset($coursemodules[$forumid])) {
451                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
452                     $coursemodules[$forumid] = $cm;
453                 } else {
454                     mtrace('Could not find course module for forum '.$forumid);
455                     unset($posts[$pid]);
456                     continue;
457                 }
458             }
461             // caching subscribed users of each forum
462             if (!isset($subscribedusers[$forumid])) {
463                 $modcontext = get_context_instance(CONTEXT_MODULE, $coursemodules[$forumid]->id);
464                 if ($subusers = forum_subscribed_users($courses[$courseid], $forums[$forumid], 0, $modcontext, "u.*")) {
465                     foreach ($subusers as $postuser) {
466                         unset($postuser->description); // not necessary
467                         // this user is subscribed to this forum
468                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
469                         // this user is a user we have to process later
470                         $users[$postuser->id] = $postuser;
471                     }
472                     unset($subusers); // release memory
473                 }
474             }
476             $mailcount[$pid] = 0;
477             $errorcount[$pid] = 0;
478         }
479     }
481     if ($users && $posts) {
483         $urlinfo = parse_url($CFG->wwwroot);
484         $hostname = $urlinfo['host'];
486         foreach ($users as $userto) {
488             @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
490             // set this so that the capabilities are cached, and environment matches receiving user
491             cron_setup_user($userto);
493             mtrace('Processing user '.$userto->id);
495             // init caches
496             $userto->viewfullnames = array();
497             $userto->canpost       = array();
498             $userto->markposts     = array();
499             $userto->enrolledin    = array();
501             // reset the caches
502             foreach ($coursemodules as $forumid=>$unused) {
503                 $coursemodules[$forumid]->cache       = new stdClass();
504                 $coursemodules[$forumid]->cache->caps = array();
505                 unset($coursemodules[$forumid]->uservisible);
506             }
508             foreach ($posts as $pid => $post) {
510                 // Set up the environment for the post, discussion, forum, course
511                 $discussion = $discussions[$post->discussion];
512                 $forum      = $forums[$discussion->forum];
513                 $course     = $courses[$forum->course];
514                 $cm         =& $coursemodules[$forum->id];
516                 // Do some checks  to see if we can bail out now
517                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
518                     continue; // user does not subscribe to this forum
519                 }
521                 // Verify user is enrollend in course - if not do not send any email
522                 if (!isset($userto->enrolledin[$course->id])) {
523                     $userto->enrolledin[$course->id] = is_enrolled(get_context_instance(CONTEXT_COURSE, $course->id));
524                 }
525                 if (!$userto->enrolledin[$course->id]) {
526                     // oops - this user should not receive anything from this course
527                     continue;
528                 }
530                 // Get info about the sending user
531                 if (array_key_exists($post->userid, $users)) { // we might know him/her already
532                     $userfrom = $users[$post->userid];
533                 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
534                     unset($userfrom->description); // not necessary
535                     $users[$userfrom->id] = $userfrom; // fetch only once, we can add it to user list, it will be skipped anyway
536                 } else {
537                     mtrace('Could not find user '.$post->userid);
538                     continue;
539                 }
541                 //if we want to check that userto and userfrom are not the same person this is probably the spot to do it
543                 // setup global $COURSE properly - needed for roles and languages
544                 cron_setup_user($userto, $course);
546                 // Fill caches
547                 if (!isset($userto->viewfullnames[$forum->id])) {
548                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
549                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
550                 }
551                 if (!isset($userto->canpost[$discussion->id])) {
552                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
553                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
554                 }
555                 if (!isset($userfrom->groups[$forum->id])) {
556                     if (!isset($userfrom->groups)) {
557                         $userfrom->groups = array();
558                         $users[$userfrom->id]->groups = array();
559                     }
560                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
561                     $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
562                 }
564                 // Make sure groups allow this user to see this email
565                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
566                     if (!groups_group_exists($discussion->groupid)) { // Can't find group
567                         continue;                           // Be safe and don't send it to anyone
568                     }
570                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
571                         // do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
572                         continue;
573                     }
574                 }
576                 // Make sure we're allowed to see it...
577                 if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
578                     mtrace('user '.$userto->id. ' can not see '.$post->id);
579                     continue;
580                 }
582                 // OK so we need to send the email.
584                 // Does the user want this post in a digest?  If so postpone it for now.
585                 if ($userto->maildigest > 0) {
586                     // This user wants the mails to be in digest form
587                     $queue = new stdClass();
588                     $queue->userid       = $userto->id;
589                     $queue->discussionid = $discussion->id;
590                     $queue->postid       = $post->id;
591                     $queue->timemodified = $post->created;
592                     $DB->insert_record('forum_queue', $queue);
593                     continue;
594                 }
597                 // Prepare to actually send the post now, and build up the content
599                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
601                 $userfrom->customheaders = array (  // Headers to make emails easier to track
602                            'Precedence: Bulk',
603                            'List-Id: "'.$cleanforumname.'" <moodleforum'.$forum->id.'@'.$hostname.'>',
604                            'List-Help: '.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id,
605                            'Message-ID: <moodlepost'.$post->id.'@'.$hostname.'>',
606                            'X-Course-Id: '.$course->id,
607                            'X-Course-Name: '.format_string($course->fullname, true)
608                 );
610                 if ($post->parent) {  // This post is a reply, so add headers for threading (see MDL-22551)
611                     $userfrom->customheaders[] = 'In-Reply-To: <moodlepost'.$post->parent.'@'.$hostname.'>';
612                     $userfrom->customheaders[] = 'References: <moodlepost'.$post->parent.'@'.$hostname.'>';
613                 }
615                 $postsubject = "$course->shortname: ".format_string($post->subject,true);
616                 $posttext = forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto);
617                 $posthtml = forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto);
619                 // Send the post now!
621                 mtrace('Sending ', '');
623                 $eventdata = new stdClass();
624                 $eventdata->component        = 'mod_forum';
625                 $eventdata->name             = 'posts';
626                 $eventdata->userfrom         = $userfrom;
627                 $eventdata->userto           = $userto;
628                 $eventdata->subject          = $postsubject;
629                 $eventdata->fullmessage      = $posttext;
630                 $eventdata->fullmessageformat = FORMAT_PLAIN;
631                 $eventdata->fullmessagehtml  = $posthtml;
632                 $eventdata->notification = 1;
634                 $smallmessagestrings = new stdClass();
635                 $smallmessagestrings->user = fullname($userfrom);
636                 $smallmessagestrings->forumname = "{$course->shortname}: ".format_string($forum->name,true).": ".$discussion->name;
637                 $smallmessagestrings->message = $post->message;
638                 //make sure strings are in message recipients language
639                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
641                 $eventdata->contexturl = "{$CFG->wwwroot}/mod/forum/discuss.php?d={$discussion->id}#p{$post->id}";
642                 $eventdata->contexturlname = $discussion->name;
644                 $mailresult = message_send($eventdata);
645                 if (!$mailresult){
646                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
647                          " ($userto->email) .. not trying again.");
648                     add_to_log($course->id, 'forum', 'mail error', "discuss.php?d=$discussion->id#p$post->id",
649                                substr(format_string($post->subject,true),0,30), $cm->id, $userto->id);
650                     $errorcount[$post->id]++;
651                 } else {
652                     $mailcount[$post->id]++;
654                 // Mark post as read if forum_usermarksread is set off
655                     if (!$CFG->forum_usermarksread) {
656                         $userto->markposts[$post->id] = $post->id;
657                     }
658                 }
660                 mtrace('post '.$post->id. ': '.$post->subject);
661             }
663             // mark processed posts as read
664             forum_tp_mark_posts_read($userto, $userto->markposts);
665         }
666     }
668     if ($posts) {
669         foreach ($posts as $post) {
670             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
671             if ($errorcount[$post->id]) {
672                 $DB->set_field("forum_posts", "mailed", "2", array("id" => "$post->id"));
673             }
674         }
675     }
677     // release some memory
678     unset($subscribedusers);
679     unset($mailcount);
680     unset($errorcount);
682     cron_setup_user();
684     $sitetimezone = $CFG->timezone;
686     // Now see if there are any digest mails waiting to be sent, and if we should send them
688     mtrace('Starting digest processing...');
690     @set_time_limit(300); // terminate if not able to fetch all digests in 5 minutes
692     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
693         set_config('digestmailtimelast', 0);
694     }
696     $timenow = time();
697     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
699     // Delete any really old ones (normally there shouldn't be any)
700     $weekago = $timenow - (7 * 24 * 3600);
701     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
702     mtrace ('Cleaned old digest records');
704     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
706         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
708         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
710         if ($digestposts_rs->valid()) {
712             // We have work to do
713             $usermailcount = 0;
715             //caches - reuse the those filled before too
716             $discussionposts = array();
717             $userdiscussions = array();
719             foreach ($digestposts_rs as $digestpost) {
720                 if (!isset($users[$digestpost->userid])) {
721                     if ($user = $DB->get_record('user', array('id' => $digestpost->userid))) {
722                         $users[$digestpost->userid] = $user;
723                     } else {
724                         continue;
725                     }
726                 }
727                 $postuser = $users[$digestpost->userid];
729                 if (!isset($posts[$digestpost->postid])) {
730                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
731                         $posts[$digestpost->postid] = $post;
732                     } else {
733                         continue;
734                     }
735                 }
736                 $discussionid = $digestpost->discussionid;
737                 if (!isset($discussions[$discussionid])) {
738                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
739                         $discussions[$discussionid] = $discussion;
740                     } else {
741                         continue;
742                     }
743                 }
744                 $forumid = $discussions[$discussionid]->forum;
745                 if (!isset($forums[$forumid])) {
746                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
747                         $forums[$forumid] = $forum;
748                     } else {
749                         continue;
750                     }
751                 }
753                 $courseid = $forums[$forumid]->course;
754                 if (!isset($courses[$courseid])) {
755                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
756                         $courses[$courseid] = $course;
757                     } else {
758                         continue;
759                     }
760                 }
762                 if (!isset($coursemodules[$forumid])) {
763                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
764                         $coursemodules[$forumid] = $cm;
765                     } else {
766                         continue;
767                     }
768                 }
769                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
770                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
771             }
772             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
774             // Data collected, start sending out emails to each user
775             foreach ($userdiscussions as $userid => $thesediscussions) {
777                 @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
779                 cron_setup_user();
781                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
783                 // First of all delete all the queue entries for this user
784                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
785                 $userto = $users[$userid];
787                 // Override the language and timezone of the "current" user, so that
788                 // mail is customised for the receiver.
789                 cron_setup_user($userto);
791                 // init caches
792                 $userto->viewfullnames = array();
793                 $userto->canpost       = array();
794                 $userto->markposts     = array();
796                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
798                 $headerdata = new stdClass();
799                 $headerdata->sitename = format_string($site->fullname, true);
800                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
802                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
803                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
805                 $posthtml = "<head>";
806 /*                foreach ($CFG->stylesheets as $stylesheet) {
807                     //TODO: MDL-21120
808                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
809                 }*/
810                 $posthtml .= "</head>\n<body id=\"email\">\n";
811                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
813                 foreach ($thesediscussions as $discussionid) {
815                     @set_time_limit(120);   // to be reset for each post
817                     $discussion = $discussions[$discussionid];
818                     $forum      = $forums[$discussion->forum];
819                     $course     = $courses[$forum->course];
820                     $cm         = $coursemodules[$forum->id];
822                     //override language
823                     cron_setup_user($userto, $course);
825                     // Fill caches
826                     if (!isset($userto->viewfullnames[$forum->id])) {
827                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
828                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
829                     }
830                     if (!isset($userto->canpost[$discussion->id])) {
831                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
832                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
833                     }
835                     $strforums      = get_string('forums', 'forum');
836                     $canunsubscribe = ! forum_is_forcesubscribed($forum);
837                     $canreply       = $userto->canpost[$discussion->id];
839                     $posttext .= "\n \n";
840                     $posttext .= '=====================================================================';
841                     $posttext .= "\n \n";
842                     $posttext .= "$course->shortname -> $strforums -> ".format_string($forum->name,true);
843                     if ($discussion->name != $forum->name) {
844                         $posttext  .= " -> ".format_string($discussion->name,true);
845                     }
846                     $posttext .= "\n";
848                     $posthtml .= "<p><font face=\"sans-serif\">".
849                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$course->shortname</a> -> ".
850                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
851                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
852                     if ($discussion->name == $forum->name) {
853                         $posthtml .= "</font></p>";
854                     } else {
855                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
856                     }
857                     $posthtml .= '<p>';
859                     $postsarray = $discussionposts[$discussionid];
860                     sort($postsarray);
862                     foreach ($postsarray as $postid) {
863                         $post = $posts[$postid];
865                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
866                             $userfrom = $users[$post->userid];
867                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
868                             $users[$userfrom->id] = $userfrom; // fetch only once, we can add it to user list, it will be skipped anyway
869                         } else {
870                             mtrace('Could not find user '.$post->userid);
871                             continue;
872                         }
874                         if (!isset($userfrom->groups[$forum->id])) {
875                             if (!isset($userfrom->groups)) {
876                                 $userfrom->groups = array();
877                                 $users[$userfrom->id]->groups = array();
878                             }
879                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
880                             $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
881                         }
883                         $userfrom->customheaders = array ("Precedence: Bulk");
885                         if ($userto->maildigest == 2) {
886                             // Subjects only
887                             $by = new stdClass();
888                             $by->name = fullname($userfrom);
889                             $by->date = userdate($post->modified);
890                             $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
891                             $posttext .= "\n---------------------------------------------------------------------";
893                             $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&amp;course=$course->id\">$by->name</a>";
894                             $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>';
896                         } else {
897                             // The full treatment
898                             $posttext .= forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, true);
899                             $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
901                         // Create an array of postid's for this user to mark as read.
902                             if (!$CFG->forum_usermarksread) {
903                                 $userto->markposts[$post->id] = $post->id;
904                             }
905                         }
906                     }
907                     if ($canunsubscribe) {
908                         $posthtml .= "\n<div class='mdl-right'><font size=\"1\"><a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">".get_string("unsubscribe", "forum")."</a></font></div>";
909                     } else {
910                         $posthtml .= "\n<div class='mdl-right'><font size=\"1\">".get_string("everyoneissubscribed", "forum")."</font></div>";
911                     }
912                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
913                 }
914                 $posthtml .= '</body>';
916                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
917                     // This user DOESN'T want to receive HTML
918                     $posthtml = '';
919                 }
921                 $attachment = $attachname='';
922                 $usetrueaddress = true;
923                 //directly email forum digests rather than sending them via messaging
924                 $mailresult = email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml, $attachment, $attachname, $usetrueaddress, $CFG->forum_replytouser);
926                 if (!$mailresult) {
927                     mtrace("ERROR!");
928                     echo "Error: mod/forum/cron.php: Could not send out digest mail to user $userto->id ($userto->email)... not trying again.\n";
929                     add_to_log($course->id, 'forum', 'mail digest error', '', '', $cm->id, $userto->id);
930                 } else {
931                     mtrace("success.");
932                     $usermailcount++;
934                     // Mark post as read if forum_usermarksread is set off
935                     forum_tp_mark_posts_read($userto, $userto->markposts);
936                 }
937             }
938         }
939     /// We have finishied all digest emails, update $CFG->digestmailtimelast
940         set_config('digestmailtimelast', $timenow);
941     }
943     cron_setup_user();
945     if (!empty($usermailcount)) {
946         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
947     }
949     if (!empty($CFG->forum_lastreadclean)) {
950         $timenow = time();
951         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
952             set_config('forum_lastreadclean', $timenow);
953             mtrace('Removing old forum read tracking info...');
954             forum_tp_clean_read_records();
955         }
956     } else {
957         set_config('forum_lastreadclean', time());
958     }
961     return true;
964 /**
965  * Builds and returns the body of the email notification in plain text.
966  *
967  * @global object
968  * @global object
969  * @uses CONTEXT_MODULE
970  * @param object $course
971  * @param object $cm
972  * @param object $forum
973  * @param object $discussion
974  * @param object $post
975  * @param object $userfrom
976  * @param object $userto
977  * @param boolean $bare
978  * @return string The email body in plain text format.
979  */
980 function forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $bare = false) {
981     global $CFG, $USER;
983     if (!isset($userto->viewfullnames[$forum->id])) {
984         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
985         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
986     } else {
987         $viewfullnames = $userto->viewfullnames[$forum->id];
988     }
990     if (!isset($userto->canpost[$discussion->id])) {
991         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
992         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
993     } else {
994         $canreply = $userto->canpost[$discussion->id];
995     }
997     $by = New stdClass;
998     $by->name = fullname($userfrom, $viewfullnames);
999     $by->date = userdate($post->modified, "", $userto->timezone);
1001     $strbynameondate = get_string('bynameondate', 'forum', $by);
1003     $strforums = get_string('forums', 'forum');
1005     $canunsubscribe = ! forum_is_forcesubscribed($forum);
1007     $posttext = '';
1009     if (!$bare) {
1010         $posttext  = "$course->shortname -> $strforums -> ".format_string($forum->name,true);
1012         if ($discussion->name != $forum->name) {
1013             $posttext  .= " -> ".format_string($discussion->name,true);
1014         }
1015     }
1017     $posttext .= "\n---------------------------------------------------------------------\n";
1018     $posttext .= format_string($post->subject,true);
1019     if ($bare) {
1020         $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
1021     }
1022     $posttext .= "\n".$strbynameondate."\n";
1023     $posttext .= "---------------------------------------------------------------------\n";
1024     $posttext .= format_text_email($post->message, $post->messageformat);
1025     $posttext .= "\n\n";
1026     $posttext .= forum_print_attachments($post, $cm, "text");
1028     if (!$bare && $canreply) {
1029         $posttext .= "---------------------------------------------------------------------\n";
1030         $posttext .= get_string("postmailinfo", "forum", $course->shortname)."\n";
1031         $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
1032     }
1033     if (!$bare && $canunsubscribe) {
1034         $posttext .= "\n---------------------------------------------------------------------\n";
1035         $posttext .= get_string("unsubscribe", "forum");
1036         $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
1037     }
1039     return $posttext;
1042 /**
1043  * Builds and returns the body of the email notification in html format.
1044  *
1045  * @global object
1046  * @param object $course
1047  * @param object $cm
1048  * @param object $forum
1049  * @param object $discussion
1050  * @param object $post
1051  * @param object $userfrom
1052  * @param object $userto
1053  * @return string The email text in HTML format
1054  */
1055 function forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto) {
1056     global $CFG;
1058     if ($userto->mailformat != 1) {  // Needs to be HTML
1059         return '';
1060     }
1062     if (!isset($userto->canpost[$discussion->id])) {
1063         $canreply = forum_user_can_post($forum, $discussion, $userto);
1064     } else {
1065         $canreply = $userto->canpost[$discussion->id];
1066     }
1068     $strforums = get_string('forums', 'forum');
1069     $canunsubscribe = ! forum_is_forcesubscribed($forum);
1071     $posthtml = '<head>';
1072 /*    foreach ($CFG->stylesheets as $stylesheet) {
1073         //TODO: MDL-21120
1074         $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
1075     }*/
1076     $posthtml .= '</head>';
1077     $posthtml .= "\n<body id=\"email\">\n\n";
1079     $posthtml .= '<div class="navbar">'.
1080     '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$course->shortname.'</a> &raquo; '.
1081     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> &raquo; '.
1082     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
1083     if ($discussion->name == $forum->name) {
1084         $posthtml .= '</div>';
1085     } else {
1086         $posthtml .= ' &raquo; <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
1087                      format_string($discussion->name,true).'</a></div>';
1088     }
1089     $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1091     if ($canunsubscribe) {
1092         $posthtml .= '<hr /><div class="mdl-align unsubscribelink">
1093                       <a href="'.$CFG->wwwroot.'/mod/forum/subscribe.php?id='.$forum->id.'">'.get_string('unsubscribe', 'forum').'</a>&nbsp;
1094                       <a href="'.$CFG->wwwroot.'/mod/forum/unsubscribeall.php">'.get_string('unsubscribeall', 'forum').'</a></div>';
1095     }
1097     $posthtml .= '</body>';
1099     return $posthtml;
1103 /**
1104  *
1105  * @param object $course
1106  * @param object $user
1107  * @param object $mod TODO this is not used in this function, refactor
1108  * @param object $forum
1109  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
1110  */
1111 function forum_user_outline($course, $user, $mod, $forum) {
1112     global $CFG;
1113     require_once("$CFG->libdir/gradelib.php");
1114     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1115     if (empty($grades->items[0]->grades)) {
1116         $grade = false;
1117     } else {
1118         $grade = reset($grades->items[0]->grades);
1119     }
1121     $count = forum_count_user_posts($forum->id, $user->id);
1123     if ($count && $count->postcount > 0) {
1124         $result = new stdClass();
1125         $result->info = get_string("numposts", "forum", $count->postcount);
1126         $result->time = $count->lastpost;
1127         if ($grade) {
1128             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1129         }
1130         return $result;
1131     } else if ($grade) {
1132         $result = new stdClass();
1133         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1134         $result->time = $grade->dategraded;
1135         return $result;
1136     }
1137     return NULL;
1141 /**
1142  * @global object
1143  * @global object
1144  * @param object $coure
1145  * @param object $user
1146  * @param object $mod
1147  * @param object $forum
1148  */
1149 function forum_user_complete($course, $user, $mod, $forum) {
1150     global $CFG,$USER, $OUTPUT;
1151     require_once("$CFG->libdir/gradelib.php");
1153     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1154     if (!empty($grades->items[0]->grades)) {
1155         $grade = reset($grades->items[0]->grades);
1156         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1157         if ($grade->str_feedback) {
1158             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1159         }
1160     }
1162     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
1164         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
1165             print_error('invalidcoursemodule');
1166         }
1167         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1169         foreach ($posts as $post) {
1170             if (!isset($discussions[$post->discussion])) {
1171                 continue;
1172             }
1173             $discussion = $discussions[$post->discussion];
1175             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
1176         }
1177     } else {
1178         echo "<p>".get_string("noposts", "forum")."</p>";
1179     }
1187 /**
1188  * @global object
1189  * @global object
1190  * @global object
1191  * @param array $courses
1192  * @param array $htmlarray
1193  */
1194 function forum_print_overview($courses,&$htmlarray) {
1195     global $USER, $CFG, $DB, $SESSION;
1197     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1198         return array();
1199     }
1201     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1202         return;
1203     }
1206     // get all forum logs in ONE query (much better!)
1207     $params = array();
1208     $sql = "SELECT instance,cmid,l.course,COUNT(l.id) as count FROM {log} l "
1209         ." JOIN {course_modules} cm ON cm.id = cmid "
1210         ." WHERE (";
1211     foreach ($courses as $course) {
1212         $sql .= '(l.course = ? AND l.time > ?) OR ';
1213         $params[] = $course->id;
1214         $params[] = $course->lastaccess;
1215     }
1216     $sql = substr($sql,0,-3); // take off the last OR
1218     $sql .= ") AND l.module = 'forum' AND action = 'add post' "
1219         ." AND userid != ? GROUP BY cmid,l.course,instance";
1221     $params[] = $USER->id;
1223     if (!$new = $DB->get_records_sql($sql, $params)) {
1224         $new = array(); // avoid warnings
1225     }
1227     // also get all forum tracking stuff ONCE.
1228     $trackingforums = array();
1229     foreach ($forums as $forum) {
1230         if (forum_tp_can_track_forums($forum)) {
1231             $trackingforums[$forum->id] = $forum;
1232         }
1233     }
1235     if (count($trackingforums) > 0) {
1236         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1237         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1238             ' FROM {forum_posts} p '.
1239             ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1240             ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
1241         $params = array($USER->id);
1243         foreach ($trackingforums as $track) {
1244             $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1245             $params[] = $track->id;
1246             if (isset($SESSION->currentgroup[$track->course])) {
1247                 $groupid =  $SESSION->currentgroup[$track->course];
1248             } else {
1249                 $groupid = groups_get_all_groups($track->course, $USER->id);
1250                 if (is_array($groupid)) {
1251                     $groupid = array_shift(array_keys($groupid));
1252                     $SESSION->currentgroup[$track->course] = $groupid;
1253                 } else {
1254                     $groupid = 0;
1255                 }
1256             }
1257             $params[] = $groupid;
1258         }
1259         $sql = substr($sql,0,-3); // take off the last OR
1260         $sql .= ') AND p.modified >= ? AND r.id is NULL GROUP BY d.forum,d.course';
1261         $params[] = $cutoffdate;
1263         if (!$unread = $DB->get_records_sql($sql, $params)) {
1264             $unread = array();
1265         }
1266     } else {
1267         $unread = array();
1268     }
1270     if (empty($unread) and empty($new)) {
1271         return;
1272     }
1274     $strforum = get_string('modulename','forum');
1275     $strnumunread = get_string('overviewnumunread','forum');
1276     $strnumpostssince = get_string('overviewnumpostssince','forum');
1278     foreach ($forums as $forum) {
1279         $str = '';
1280         $count = 0;
1281         $thisunread = 0;
1282         $showunread = false;
1283         // either we have something from logs, or trackposts, or nothing.
1284         if (array_key_exists($forum->id, $new) && !empty($new[$forum->id])) {
1285             $count = $new[$forum->id]->count;
1286         }
1287         if (array_key_exists($forum->id,$unread)) {
1288             $thisunread = $unread[$forum->id]->count;
1289             $showunread = true;
1290         }
1291         if ($count > 0 || $thisunread > 0) {
1292             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1293                 $forum->name.'</a></div>';
1294             $str .= '<div class="info">';
1295             $str .= $count.' '.$strnumpostssince;
1296             if (!empty($showunread)) {
1297                 $str .= '<br />'.$thisunread .' '.$strnumunread;
1298             }
1299             $str .= '</div></div>';
1300         }
1301         if (!empty($str)) {
1302             if (!array_key_exists($forum->course,$htmlarray)) {
1303                 $htmlarray[$forum->course] = array();
1304             }
1305             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1306                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1307             }
1308             $htmlarray[$forum->course]['forum'] .= $str;
1309         }
1310     }
1313 /**
1314  * Given a course and a date, prints a summary of all the new
1315  * messages posted in the course since that date
1316  *
1317  * @global object
1318  * @global object
1319  * @global object
1320  * @uses CONTEXT_MODULE
1321  * @uses VISIBLEGROUPS
1322  * @param object $course
1323  * @param bool $viewfullnames capability
1324  * @param int $timestart
1325  * @return bool success
1326  */
1327 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1328     global $CFG, $USER, $DB, $OUTPUT;
1330     // do not use log table if possible, it may be huge and is expensive to join with other tables
1332     if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1333                                               d.timestart, d.timeend, d.userid AS duserid,
1334                                               u.firstname, u.lastname, u.email, u.picture
1335                                          FROM {forum_posts} p
1336                                               JOIN {forum_discussions} d ON d.id = p.discussion
1337                                               JOIN {forum} f             ON f.id = d.forum
1338                                               JOIN {user} u              ON u.id = p.userid
1339                                         WHERE p.created > ? AND f.course = ?
1340                                      ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
1341          return false;
1342     }
1344     $modinfo =& get_fast_modinfo($course);
1346     $groupmodes = array();
1347     $cms    = array();
1349     $strftimerecent = get_string('strftimerecent');
1351     $printposts = array();
1352     foreach ($posts as $post) {
1353         if (!isset($modinfo->instances['forum'][$post->forum])) {
1354             // not visible
1355             continue;
1356         }
1357         $cm = $modinfo->instances['forum'][$post->forum];
1358         if (!$cm->uservisible) {
1359             continue;
1360         }
1361         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1363         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1364             continue;
1365         }
1367         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1368           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1369             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1370                 continue;
1371             }
1372         }
1374         $groupmode = groups_get_activity_groupmode($cm, $course);
1376         if ($groupmode) {
1377             if ($post->groupid == -1 or $groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context)) {
1378                 // oki (Open discussions have groupid -1)
1379             } else {
1380                 // separate mode
1381                 if (isguestuser()) {
1382                     // shortcut
1383                     continue;
1384                 }
1386                 if (is_null($modinfo->groups)) {
1387                     $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
1388                 }
1390                 if (!array_key_exists($post->groupid, $modinfo->groups[0])) {
1391                     continue;
1392                 }
1393             }
1394         }
1396         $printposts[] = $post;
1397     }
1398     unset($posts);
1400     if (!$printposts) {
1401         return false;
1402     }
1404     echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
1405     echo "\n<ul class='unlist'>\n";
1407     foreach ($printposts as $post) {
1408         $subjectclass = empty($post->parent) ? ' bold' : '';
1410         echo '<li><div class="head">'.
1411                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1412                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1413              '</div>';
1414         echo '<div class="info'.$subjectclass.'">';
1415         if (empty($post->parent)) {
1416             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1417         } else {
1418             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1419         }
1420         $post->subject = break_up_long_words(format_string($post->subject, true));
1421         echo $post->subject;
1422         echo "</a>\"</div></li>\n";
1423     }
1425     echo "</ul>\n";
1427     return true;
1430 /**
1431  * Return grade for given user or all users.
1432  *
1433  * @global object
1434  * @global object
1435  * @param object $forum
1436  * @param int $userid optional user id, 0 means all users
1437  * @return array array of grades, false if none
1438  */
1439 function forum_get_user_grades($forum, $userid=0) {
1440     global $CFG;
1442     require_once($CFG->dirroot.'/rating/lib.php');
1443     $rm = new rating_manager();
1445     $ratingoptions = new stdclass();
1447     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1448     $ratingoptions->modulename = 'forum';
1449     $ratingoptions->moduleid   = $forum->id;
1450     //$ratingoptions->cmidnumber = $forum->cmidnumber;
1452     $ratingoptions->userid = $userid;
1453     $ratingoptions->aggregationmethod = $forum->assessed;
1454     $ratingoptions->scaleid = $forum->scale;
1455     $ratingoptions->itemtable = 'forum_posts';
1456     $ratingoptions->itemtableusercolumn = 'userid';
1458     return $rm->get_user_grades($ratingoptions);
1461 /**
1462  * Update activity grades
1463  *
1464  * @global object
1465  * @global object
1466  * @param object $forum
1467  * @param int $userid specific user only, 0 means all
1468  * @param boolean $nullifnone return null if grade does not exist
1469  * @return void
1470  */
1471 function forum_update_grades($forum, $userid=0, $nullifnone=true) {
1472     global $CFG, $DB;
1473     require_once($CFG->libdir.'/gradelib.php');
1475     if (!$forum->assessed) {
1476         forum_grade_item_update($forum);
1478     } else if ($grades = forum_get_user_grades($forum, $userid)) {
1479         forum_grade_item_update($forum, $grades);
1481     } else if ($userid and $nullifnone) {
1482         $grade = new stdClass();
1483         $grade->userid   = $userid;
1484         $grade->rawgrade = NULL;
1485         forum_grade_item_update($forum, $grade);
1487     } else {
1488         forum_grade_item_update($forum);
1489     }
1492 /**
1493  * Update all grades in gradebook.
1494  * @global object
1495  */
1496 function forum_upgrade_grades() {
1497     global $DB;
1499     $sql = "SELECT COUNT('x')
1500               FROM {forum} f, {course_modules} cm, {modules} m
1501              WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
1502     $count = $DB->count_records_sql($sql);
1504     $sql = "SELECT f.*, cm.idnumber AS cmidnumber, f.course AS courseid
1505               FROM {forum} f, {course_modules} cm, {modules} m
1506              WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
1507     if ($rs = $DB->get_recordset_sql($sql)) {
1508         $pbar = new progress_bar('forumupgradegrades', 500, true);
1509         $i=0;
1510         foreach ($rs as $forum) {
1511             $i++;
1512             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
1513             forum_update_grades($forum, 0, false);
1514             $pbar->update($i, $count, "Updating Forum grades ($i/$count).");
1515         }
1516         $rs->close();
1517     }
1520 /**
1521  * Create/update grade item for given forum
1522  *
1523  * @global object
1524  * @uses GRADE_TYPE_NONE
1525  * @uses GRADE_TYPE_VALUE
1526  * @uses GRADE_TYPE_SCALE
1527  * @param object $forum object with extra cmidnumber
1528  * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
1529  * @return int 0 if ok
1530  */
1531 function forum_grade_item_update($forum, $grades=NULL) {
1532     global $CFG;
1533     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1534         require_once($CFG->libdir.'/gradelib.php');
1535     }
1537     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1539     if (!$forum->assessed or $forum->scale == 0) {
1540         $params['gradetype'] = GRADE_TYPE_NONE;
1542     } else if ($forum->scale > 0) {
1543         $params['gradetype'] = GRADE_TYPE_VALUE;
1544         $params['grademax']  = $forum->scale;
1545         $params['grademin']  = 0;
1547     } else if ($forum->scale < 0) {
1548         $params['gradetype'] = GRADE_TYPE_SCALE;
1549         $params['scaleid']   = -$forum->scale;
1550     }
1552     if ($grades  === 'reset') {
1553         $params['reset'] = true;
1554         $grades = NULL;
1555     }
1557     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1560 /**
1561  * Delete grade item for given forum
1562  *
1563  * @global object
1564  * @param object $forum object
1565  * @return object grade_item
1566  */
1567 function forum_grade_item_delete($forum) {
1568     global $CFG;
1569     require_once($CFG->libdir.'/gradelib.php');
1571     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1575 /**
1576  * Returns the users with data in one forum
1577  * (users with records in forum_subscriptions, forum_posts, students)
1578  *
1579  * @global object
1580  * @global object
1581  * @param int $forumid
1582  * @return mixed array or false if none
1583  */
1584 function forum_get_participants($forumid) {
1586     global $CFG, $DB;
1588     //Get students from forum_subscriptions
1589     $st_subscriptions = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1590                                          FROM {user} u,
1591                                               {forum_subscriptions} s
1592                                          WHERE s.forum = ? AND
1593                                                u.id = s.userid", array($forumid));
1594     //Get students from forum_posts
1595     $st_posts = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1596                                  FROM {user} u,
1597                                       {forum_discussions} d,
1598                                       {forum_posts} p
1599                                  WHERE d.forum = ? AND
1600                                        p.discussion = d.id AND
1601                                        u.id = p.userid", array($forumid));
1603     //Get students from the ratings table
1604     $st_ratings = $DB->get_records_sql("SELECT DISTINCT u.id, u.id
1605                                    FROM {user} u,
1606                                         {forum_discussions} d,
1607                                         {forum_posts} p,
1608                                         {ratings} r
1609                                    WHERE d.forum = ? AND
1610                                          p.discussion = d.id AND
1611                                          r.post = p.id AND
1612                                          u.id = r.userid", array($forumid));
1614     //Add st_posts to st_subscriptions
1615     if ($st_posts) {
1616         foreach ($st_posts as $st_post) {
1617             $st_subscriptions[$st_post->id] = $st_post;
1618         }
1619     }
1620     //Add st_ratings to st_subscriptions
1621     if ($st_ratings) {
1622         foreach ($st_ratings as $st_rating) {
1623             $st_subscriptions[$st_rating->id] = $st_rating;
1624         }
1625     }
1626     //Return st_subscriptions array (it contains an array of unique users)
1627     return ($st_subscriptions);
1630 /**
1631  * This function returns if a scale is being used by one forum
1632  *
1633  * @global object
1634  * @param int $forumid
1635  * @param int $scaleid negative number
1636  * @return bool
1637  */
1638 function forum_scale_used ($forumid,$scaleid) {
1639     global $DB;
1640     $return = false;
1642     $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
1644     if (!empty($rec) && !empty($scaleid)) {
1645         $return = true;
1646     }
1648     return $return;
1651 /**
1652  * Checks if scale is being used by any instance of forum
1653  *
1654  * This is used to find out if scale used anywhere
1655  *
1656  * @global object
1657  * @param $scaleid int
1658  * @return boolean True if the scale is used by any forum
1659  */
1660 function forum_scale_used_anywhere($scaleid) {
1661     global $DB;
1662     if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
1663         return true;
1664     } else {
1665         return false;
1666     }
1669 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1671 /**
1672  * Gets a post with all info ready for forum_print_post
1673  * Most of these joins are just to get the forum id
1674  *
1675  * @global object
1676  * @global object
1677  * @param int $postid
1678  * @return mixed array of posts or false
1679  */
1680 function forum_get_post_full($postid) {
1681     global $CFG, $DB;
1683     return $DB->get_record_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1684                              FROM {forum_posts} p
1685                                   JOIN {forum_discussions} d ON p.discussion = d.id
1686                                   LEFT JOIN {user} u ON p.userid = u.id
1687                             WHERE p.id = ?", array($postid));
1690 /**
1691  * Gets posts with all info ready for forum_print_post
1692  * We pass forumid in because we always know it so no need to make a
1693  * complicated join to find it out.
1694  *
1695  * @global object
1696  * @global object
1697  * @return mixed array of posts or false
1698  */
1699 function forum_get_discussion_posts($discussion, $sort, $forumid) {
1700     global $CFG, $DB;
1702     return $DB->get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1703                               FROM {forum_posts} p
1704                          LEFT JOIN {user} u ON p.userid = u.id
1705                              WHERE p.discussion = ?
1706                                AND p.parent > 0 $sort", array($discussion));
1709 /**
1710  * Gets all posts in discussion including top parent.
1711  *
1712  * @global object
1713  * @global object
1714  * @global object
1715  * @param int $discussionid
1716  * @param string $sort
1717  * @param bool $tracking does user track the forum?
1718  * @return array of posts
1719  */
1720 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1721     global $CFG, $DB, $USER;
1723     $tr_sel  = "";
1724     $tr_join = "";
1725     $params = array();
1727     if ($tracking) {
1728         $now = time();
1729         $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
1730         $tr_sel  = ", fr.id AS postread";
1731         $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1732         $params[] = $USER->id;
1733     }
1735     $params[] = $discussionid;
1736     if (!$posts = $DB->get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture, u.imagealt $tr_sel
1737                                      FROM {forum_posts} p
1738                                           LEFT JOIN {user} u ON p.userid = u.id
1739                                           $tr_join
1740                                     WHERE p.discussion = ?
1741                                  ORDER BY $sort", $params)) {
1742         return array();
1743     }
1745     foreach ($posts as $pid=>$p) {
1746         if ($tracking) {
1747             if (forum_tp_is_post_old($p)) {
1748                  $posts[$pid]->postread = true;
1749             }
1750         }
1751         if (!$p->parent) {
1752             continue;
1753         }
1754         if (!isset($posts[$p->parent])) {
1755             continue; // parent does not exist??
1756         }
1757         if (!isset($posts[$p->parent]->children)) {
1758             $posts[$p->parent]->children = array();
1759         }
1760         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1761     }
1763     return $posts;
1766 /**
1767  * Gets posts with all info ready for forum_print_post
1768  * We pass forumid in because we always know it so no need to make a
1769  * complicated join to find it out.
1770  *
1771  * @global object
1772  * @global object
1773  * @param int $parent
1774  * @param int $forumid
1775  * @return array
1776  */
1777 function forum_get_child_posts($parent, $forumid) {
1778     global $CFG, $DB;
1780     return $DB->get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1781                               FROM {forum_posts} p
1782                          LEFT JOIN {user} u ON p.userid = u.id
1783                              WHERE p.parent = ?
1784                           ORDER BY p.created ASC", array($parent));
1787 /**
1788  * An array of forum objects that the user is allowed to read/search through.
1789  *
1790  * @global object
1791  * @global object
1792  * @global object
1793  * @param int $userid
1794  * @param int $courseid if 0, we look for forums throughout the whole site.
1795  * @return array of forum objects, or false if no matches
1796  *         Forum objects have the following attributes:
1797  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1798  *         viewhiddentimedposts
1799  */
1800 function forum_get_readable_forums($userid, $courseid=0) {
1802     global $CFG, $DB, $USER;
1803     require_once($CFG->dirroot.'/course/lib.php');
1805     if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
1806         print_error('notinstalled', 'forum');
1807     }
1809     if ($courseid) {
1810         $courses = $DB->get_records('course', array('id' => $courseid));
1811     } else {
1812         // If no course is specified, then the user can see SITE + his courses.
1813         $courses1 = $DB->get_records('course', array('id' => SITEID));
1814         $courses2 = enrol_get_users_courses($userid, true);
1815         $courses = array_merge($courses1, $courses2);
1816     }
1817     if (!$courses) {
1818         return array();
1819     }
1821     $readableforums = array();
1823     foreach ($courses as $course) {
1825         $modinfo =& get_fast_modinfo($course);
1826         if (is_null($modinfo->groups)) {
1827             $modinfo->groups = groups_get_user_groups($course->id, $userid);
1828         }
1830         if (empty($modinfo->instances['forum'])) {
1831             // hmm, no forums?
1832             continue;
1833         }
1835         $courseforums = $DB->get_records('forum', array('course' => $course->id));
1837         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1838             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1839                 continue;
1840             }
1841             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1842             $forum = $courseforums[$forumid];
1843             $forum->context = $context;
1844             $forum->cm = $cm;
1846             if (!has_capability('mod/forum:viewdiscussion', $context)) {
1847                 continue;
1848             }
1850          /// group access
1851             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
1852                 if (is_null($modinfo->groups)) {
1853                     $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
1854                 }
1855                 if (isset($modinfo->groups[$cm->groupingid])) {
1856                     $forum->onlygroups = $modinfo->groups[$cm->groupingid];
1857                     $forum->onlygroups[] = -1;
1858                 } else {
1859                     $forum->onlygroups = array(-1);
1860                 }
1861             }
1863         /// hidden timed discussions
1864             $forum->viewhiddentimedposts = true;
1865             if (!empty($CFG->forum_enabletimedposts)) {
1866                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1867                     $forum->viewhiddentimedposts = false;
1868                 }
1869             }
1871         /// qanda access
1872             if ($forum->type == 'qanda'
1873                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1875                 // We need to check whether the user has posted in the qanda forum.
1876                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
1877                                                     // the user is allowed to see in this forum.
1878                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1879                     foreach ($discussionspostedin as $d) {
1880                         $forum->onlydiscussions[] = $d->id;
1881                     }
1882                 }
1883             }
1885             $readableforums[$forum->id] = $forum;
1886         }
1888         unset($modinfo);
1890     } // End foreach $courses
1892     return $readableforums;
1895 /**
1896  * Returns a list of posts found using an array of search terms.
1897  *
1898  * @global object
1899  * @global object
1900  * @global object
1901  * @param array $searchterms array of search terms, e.g. word +word -word
1902  * @param int $courseid if 0, we search through the whole site
1903  * @param int $limitfrom
1904  * @param int $limitnum
1905  * @param int &$totalcount
1906  * @param string $extrasql
1907  * @return array|bool Array of posts found or false
1908  */
1909 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
1910                             &$totalcount, $extrasql='') {
1911     global $CFG, $DB, $USER;
1912     require_once($CFG->libdir.'/searchlib.php');
1914     $forums = forum_get_readable_forums($USER->id, $courseid);
1916     if (count($forums) == 0) {
1917         $totalcount = 0;
1918         return false;
1919     }
1921     $now = round(time(), -2); // db friendly
1923     $fullaccess = array();
1924     $where = array();
1925     $params = array();
1927     foreach ($forums as $forumid => $forum) {
1928         $select = array();
1930         if (!$forum->viewhiddentimedposts) {
1931             $select[] = "(d.userid = :userid OR (d.timestart < : AND (d.timeend = 0 OR d.timeend > :timeend)))";
1932             $params = array('userid'=>$USER->id, 'timestart'=>$now, 'timeend'=>$now);
1933         }
1935         $cm = $forum->cm;
1936         $context = $forum->context;
1938         if ($forum->type == 'qanda'
1939             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1940             if (!empty($forum->onlydiscussions)) {
1941                 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda0');
1942                 $params = array_merge($params, $discussionid_params);
1943                 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
1944             } else {
1945                 $select[] = "p.parent = 0";
1946             }
1947         }
1949         if (!empty($forum->onlygroups)) {
1950             list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps0');
1951             $params = array_merge($params, $groupid_params);
1952             $select[] = "d.groupid $groupid_sql";
1953         }
1955         if ($select) {
1956             $selects = implode(" AND ", $select);
1957             $where[] = "(d.forum = :forum AND $selects)";
1958             $params['forum'] = $forumid;
1959         } else {
1960             $fullaccess[] = $forumid;
1961         }
1962     }
1964     if ($fullaccess) {
1965         list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula0');
1966         $params = array_merge($params, $fullid_params);
1967         $where[] = "(d.forum $fullid_sql)";
1968     }
1970     $selectdiscussion = "(".implode(" OR ", $where).")";
1972     $messagesearch = '';
1973     $searchstring = '';
1975     // Need to concat these back together for parser to work.
1976     foreach($searchterms as $searchterm){
1977         if ($searchstring != '') {
1978             $searchstring .= ' ';
1979         }
1980         $searchstring .= $searchterm;
1981     }
1983     // We need to allow quoted strings for the search. The quotes *should* be stripped
1984     // by the parser, but this should be examined carefully for security implications.
1985     $searchstring = str_replace("\\\"","\"",$searchstring);
1986     $parser = new search_parser();
1987     $lexer = new search_lexer($parser);
1989     if ($lexer->parse($searchstring)) {
1990         $parsearray = $parser->get_parsed_array();
1991     // Experimental feature under 1.8! MDL-8830
1992     // Use alternative text searches if defined
1993     // This feature only works under mysql until properly implemented for other DBs
1994     // Requires manual creation of text index for forum_posts before enabling it:
1995     // CREATE FULLTEXT INDEX foru_post_tix ON [prefix]forum_posts (subject, message)
1996     // Experimental feature under 1.8! MDL-8830
1997         if (!empty($CFG->forum_usetextsearches)) {
1998             list($messagesearch, $msparams) = search_generate_text_SQL($parsearray, 'p.message', 'p.subject',
1999                                                  'p.userid', 'u.id', 'u.firstname',
2000                                                  'u.lastname', 'p.modified', 'd.forum');
2001         } else {
2002             list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2003                                                  'p.userid', 'u.id', 'u.firstname',
2004                                                  'u.lastname', 'p.modified', 'd.forum');
2005         }
2006         $params = array_merge($params, $msparams);
2007     }
2009     $fromsql = "{forum_posts} p,
2010                   {forum_discussions} d,
2011                   {user} u";
2013     $selectsql = " $messagesearch
2014                AND p.discussion = d.id
2015                AND p.userid = u.id
2016                AND $selectdiscussion
2017                    $extrasql";
2019     $countsql = "SELECT COUNT(*)
2020                    FROM $fromsql
2021                   WHERE $selectsql";
2023     $searchsql = "SELECT p.*,
2024                          d.forum,
2025                          u.firstname,
2026                          u.lastname,
2027                          u.email,
2028                          u.picture,
2029                          u.imagealt,
2030                          u.email
2031                     FROM $fromsql
2032                    WHERE $selectsql
2033                 ORDER BY p.modified DESC";
2035     $totalcount = $DB->count_records_sql($countsql, $params);
2037     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2040 /**
2041  * Returns a list of ratings for a particular post - sorted.
2042  *
2043  * @global object
2044  * @global object
2045  * @param int $postid
2046  * @param string $sort
2047  * @return array Array of ratings or false
2048  */
2049 function forum_get_ratings($context, $postid, $sort="u.firstname ASC") {
2050     global $PAGE;
2052     $options = new stdclass();
2053     $options->context = $PAGE->context;
2054     $options->itemid = $postid;
2055     $options->sort = "ORDER BY $sort";
2057     $rm = new rating_manager();
2058     $rm->get_all_ratings_for_item($options);
2061 /**
2062  * Returns a list of all new posts that have not been mailed yet
2063  *
2064  * @global object
2065  * @global object
2066  * @param int $starttime posts created after this time
2067  * @param int $endtime posts created before this
2068  * @param int $now used for timed discussions only
2069  * @return array
2070  */
2071 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2072     global $CFG, $DB;
2074     $params = array($starttime, $endtime);
2075     if (!empty($CFG->forum_enabletimedposts)) {
2076         if (empty($now)) {
2077             $now = time();
2078         }
2079         $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2080         $params[] = $now;
2081         $params[] = $now;
2082     } else {
2083         $timedsql = "";
2084     }
2086     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2087                               FROM {forum_posts} p
2088                                    JOIN {forum_discussions} d ON d.id = p.discussion
2089                              WHERE p.mailed = 0
2090                                    AND p.created >= ?
2091                                    AND (p.created < ? OR p.mailnow = 1)
2092                                    $timedsql
2093                           ORDER BY p.modified ASC", $params);
2096 /**
2097  * Marks posts before a certain time as being mailed already
2098  *
2099  * @global object
2100  * @global object
2101  * @param int $endtime
2102  * @param int $now Defaults to time()
2103  * @return bool
2104  */
2105 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2106     global $CFG, $DB;
2107     if (empty($now)) {
2108         $now = time();
2109     }
2111     if (empty($CFG->forum_enabletimedposts)) {
2112         return $DB->execute("UPDATE {forum_posts}
2113                                SET mailed = '1'
2114                              WHERE (created < ? OR mailnow = 1)
2115                                    AND mailed = 0", array($endtime));
2117     } else {
2118         return $DB->execute("UPDATE {forum_posts}
2119                                SET mailed = '1'
2120                              WHERE discussion NOT IN (SELECT d.id
2121                                                         FROM {forum_discussions} d
2122                                                        WHERE d.timestart > ?)
2123                                    AND (created < ? OR mailnow = 1)
2124                                    AND mailed = 0", array($now, $endtime));
2125     }
2128 /**
2129  * Get all the posts for a user in a forum suitable for forum_print_post
2130  *
2131  * @global object
2132  * @global object
2133  * @uses CONTEXT_MODULE
2134  * @return array
2135  */
2136 function forum_get_user_posts($forumid, $userid) {
2137     global $CFG, $DB;
2139     $timedsql = "";
2140     $params = array($forumid, $userid);
2142     if (!empty($CFG->forum_enabletimedposts)) {
2143         $cm = get_coursemodule_from_instance('forum', $forumid);
2144         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2145             $now = time();
2146             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2147             $params[] = $now;
2148             $params[] = $now;
2149         }
2150     }
2152     return $DB->get_records_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
2153                               FROM {forum} f
2154                                    JOIN {forum_discussions} d ON d.forum = f.id
2155                                    JOIN {forum_posts} p       ON p.discussion = d.id
2156                                    JOIN {user} u              ON u.id = p.userid
2157                              WHERE f.id = ?
2158                                    AND p.userid = ?
2159                                    $timedsql
2160                           ORDER BY p.modified ASC", $params);
2163 /**
2164  * Get all the discussions user participated in
2165  *
2166  * @global object
2167  * @global object
2168  * @uses CONTEXT_MODULE
2169  * @param int $forumid
2170  * @param int $userid
2171  * @return array Array or false
2172  */
2173 function forum_get_user_involved_discussions($forumid, $userid) {
2174     global $CFG, $DB;
2176     $timedsql = "";
2177     $params = array($forumid, $userid);
2178     if (!empty($CFG->forum_enabletimedposts)) {
2179         $cm = get_coursemodule_from_instance('forum', $forumid);
2180         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2181             $now = time();
2182             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2183             $params[] = $now;
2184             $params[] = $now;
2185         }
2186     }
2188     return $DB->get_records_sql("SELECT DISTINCT d.*
2189                               FROM {forum} f
2190                                    JOIN {forum_discussions} d ON d.forum = f.id
2191                                    JOIN {forum_posts} p       ON p.discussion = d.id
2192                              WHERE f.id = ?
2193                                    AND p.userid = ?
2194                                    $timedsql", $params);
2197 /**
2198  * Get all the posts for a user in a forum suitable for forum_print_post
2199  *
2200  * @global object
2201  * @global object
2202  * @param int $forumid
2203  * @param int $userid
2204  * @return array of counts or false
2205  */
2206 function forum_count_user_posts($forumid, $userid) {
2207     global $CFG, $DB;
2209     $timedsql = "";
2210     $params = array($forumid, $userid);
2211     if (!empty($CFG->forum_enabletimedposts)) {
2212         $cm = get_coursemodule_from_instance('forum', $forumid);
2213         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2214             $now = time();
2215             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2216             $params[] = $now;
2217             $params[] = $now;
2218         }
2219     }
2221     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2222                              FROM {forum} f
2223                                   JOIN {forum_discussions} d ON d.forum = f.id
2224                                   JOIN {forum_posts} p       ON p.discussion = d.id
2225                                   JOIN {user} u              ON u.id = p.userid
2226                             WHERE f.id = ?
2227                                   AND p.userid = ?
2228                                   $timedsql", $params);
2231 /**
2232  * Given a log entry, return the forum post details for it.
2233  *
2234  * @global object
2235  * @global object
2236  * @param object $log
2237  * @return array|null
2238  */
2239 function forum_get_post_from_log($log) {
2240     global $CFG, $DB;
2242     if ($log->action == "add post") {
2244         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
2245                                            u.firstname, u.lastname, u.email, u.picture
2246                                  FROM {forum_discussions} d,
2247                                       {forum_posts} p,
2248                                       {forum} f,
2249                                       {user} u
2250                                 WHERE p.id = ?
2251                                   AND d.id = p.discussion
2252                                   AND p.userid = u.id
2253                                   AND u.deleted <> '1'
2254                                   AND f.id = d.forum", array($log->info));
2257     } else if ($log->action == "add discussion") {
2259         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
2260                                            u.firstname, u.lastname, u.email, u.picture
2261                                  FROM {forum_discussions} d,
2262                                       {forum_posts} p,
2263                                       {forum} f,
2264                                       {user} u
2265                                 WHERE d.id = ?
2266                                   AND d.firstpost = p.id
2267                                   AND p.userid = u.id
2268                                   AND u.deleted <> '1'
2269                                   AND f.id = d.forum", array($log->info));
2270     }
2271     return NULL;
2274 /**
2275  * Given a discussion id, return the first post from the discussion
2276  *
2277  * @global object
2278  * @global object
2279  * @param int $dicsussionid
2280  * @return array
2281  */
2282 function forum_get_firstpost_from_discussion($discussionid) {
2283     global $CFG, $DB;
2285     return $DB->get_record_sql("SELECT p.*
2286                              FROM {forum_discussions} d,
2287                                   {forum_posts} p
2288                             WHERE d.id = ?
2289                               AND d.firstpost = p.id ", array($discussionid));
2292 /**
2293  * Returns an array of counts of replies to each discussion
2294  *
2295  * @global object
2296  * @global object
2297  * @param int $forumid
2298  * @param string $forumsort
2299  * @param int $limit
2300  * @param int $page
2301  * @param int $perpage
2302  * @return array
2303  */
2304 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2305     global $CFG, $DB;
2307     if ($limit > 0) {
2308         $limitfrom = 0;
2309         $limitnum  = $limit;
2310     } else if ($page != -1) {
2311         $limitfrom = $page*$perpage;
2312         $limitnum  = $perpage;
2313     } else {
2314         $limitfrom = 0;
2315         $limitnum  = 0;
2316     }
2318     if ($forumsort == "") {
2319         $orderby = "";
2320         $groupby = "";
2322     } else {
2323         $orderby = "ORDER BY $forumsort";
2324         $groupby = ", ".strtolower($forumsort);
2325         $groupby = str_replace('desc', '', $groupby);
2326         $groupby = str_replace('asc', '', $groupby);
2327     }
2329     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2330         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2331                   FROM {forum_posts} p
2332                        JOIN {forum_discussions} d ON p.discussion = d.id
2333                  WHERE p.parent > 0 AND d.forum = ?
2334               GROUP BY p.discussion";
2335         return $DB->get_records_sql($sql, array($forumid));
2337     } else {
2338         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2339                   FROM {forum_posts} p
2340                        JOIN {forum_discussions} d ON p.discussion = d.id
2341                  WHERE d.forum = ?
2342               GROUP BY p.discussion $groupby
2343               $orderby";
2344         return $DB->get_records_sql("SELECT * FROM ($sql) sq", array($forumid), $limitfrom, $limitnum);
2345     }
2348 /**
2349  * @global object
2350  * @global object
2351  * @global object
2352  * @staticvar array $cache
2353  * @param object $forum
2354  * @param object $cm
2355  * @param object $course
2356  * @return mixed
2357  */
2358 function forum_count_discussions($forum, $cm, $course) {
2359     global $CFG, $DB, $USER;
2361     static $cache = array();
2363     $now = round(time(), -2); // db cache friendliness
2365     $params = array($course->id);
2367     if (!isset($cache[$course->id])) {
2368         if (!empty($CFG->forum_enabletimedposts)) {
2369             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2370             $params[] = $now;
2371             $params[] = $now;
2372         } else {
2373             $timedsql = "";
2374         }
2376         $sql = "SELECT f.id, COUNT(d.id) as dcount
2377                   FROM {forum} f
2378                        JOIN {forum_discussions} d ON d.forum = f.id
2379                  WHERE f.course = ?
2380                        $timedsql
2381               GROUP BY f.id";
2383         if ($counts = $DB->get_records_sql($sql, $params)) {
2384             foreach ($counts as $count) {
2385                 $counts[$count->id] = $count->dcount;
2386             }
2387             $cache[$course->id] = $counts;
2388         } else {
2389             $cache[$course->id] = array();
2390         }
2391     }
2393     if (empty($cache[$course->id][$forum->id])) {
2394         return 0;
2395     }
2397     $groupmode = groups_get_activity_groupmode($cm, $course);
2399     if ($groupmode != SEPARATEGROUPS) {
2400         return $cache[$course->id][$forum->id];
2401     }
2403     if (has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2404         return $cache[$course->id][$forum->id];
2405     }
2407     require_once($CFG->dirroot.'/course/lib.php');
2409     $modinfo =& get_fast_modinfo($course);
2410     if (is_null($modinfo->groups)) {
2411         $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
2412     }
2414     if (array_key_exists($cm->groupingid, $modinfo->groups)) {
2415         $mygroups = $modinfo->groups[$cm->groupingid];
2416     } else {
2417         $mygroups = false; // Will be set below
2418     }
2420     // add all groups posts
2421     if (empty($mygroups)) {
2422         $mygroups = array(-1=>-1);
2423     } else {
2424         $mygroups[-1] = -1;
2425     }
2427     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2428     $params[] = $forum->id;
2430     if (!empty($CFG->forum_enabletimedposts)) {
2431         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2432         $params[] = $now;
2433         $params[] = $now;
2434     } else {
2435         $timedsql = "";
2436     }
2438     $sql = "SELECT COUNT(d.id)
2439               FROM {forum_discussions} d
2440              WHERE d.groupid $mygroups_sql AND d.forum = ?
2441                    $timedsql";
2443     return $DB->get_field_sql($sql, $params);
2446 /**
2447  * How many posts by other users are unrated by a given user in the given discussion?
2448  *
2449  * @global object
2450  * @global object
2451  * @param int $discussionid
2452  * @param int $userid
2453  * @return mixed
2454  */
2455 function forum_count_unrated_posts($discussionid, $userid) {
2456     global $CFG, $DB;
2457     if ($posts = $DB->get_record_sql("SELECT count(*) as num
2458                                    FROM {forum_posts}
2459                                   WHERE parent > 0
2460                                     AND discussion = ?
2461                                     AND userid <> ? ", array($discussionid, $userid))) {
2463         if ($rated = $DB->get_record_sql("SELECT count(*) as num
2464                                        FROM {forum_posts} p,
2465                                             {rating} r
2466                                       WHERE p.discussion = ?
2467                                         AND p.id = r.itemid
2468                                         AND r.userid = ?", array($discussionid, $userid))) {
2469             $difference = $posts->num - $rated->num;
2470             if ($difference > 0) {
2471                 return $difference;
2472             } else {
2473                 return 0;    // Just in case there was a counting error
2474             }
2475         } else {
2476             return $posts->num;
2477         }
2478     } else {
2479         return 0;
2480     }
2483 /**
2484  * Get all discussions in a forum
2485  *
2486  * @global object
2487  * @global object
2488  * @global object
2489  * @uses CONTEXT_MODULE
2490  * @uses VISIBLEGROUPS
2491  * @param object $cm
2492  * @param string $forumsort
2493  * @param bool $fullpost
2494  * @param int $unused
2495  * @param int $limit
2496  * @param bool $userlastmodified
2497  * @param int $page
2498  * @param int $perpage
2499  * @return array
2500  */
2501 function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
2502     global $CFG, $DB, $USER;
2504     $timelimit = '';
2506     $now = round(time(), -2);
2507     $params = array($cm->instance);
2509     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2511     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2512         return array();
2513     }
2515     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2517         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2518             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2519             $params[] = $now;
2520             $params[] = $now;
2521             if (isloggedin()) {
2522                 $timelimit .= " OR d.userid = ?";
2523                 $params[] = $USER->id;
2524             }
2525             $timelimit .= ")";
2526         }
2527     }
2529     if ($limit > 0) {
2530         $limitfrom = 0;
2531         $limitnum  = $limit;
2532     } else if ($page != -1) {
2533         $limitfrom = $page*$perpage;
2534         $limitnum  = $perpage;
2535     } else {
2536         $limitfrom = 0;
2537         $limitnum  = 0;
2538     }
2540     $groupmode    = groups_get_activity_groupmode($cm);
2541     $currentgroup = groups_get_activity_group($cm);
2543     if ($groupmode) {
2544         if (empty($modcontext)) {
2545             $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2546         }
2548         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2549             if ($currentgroup) {
2550                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2551                 $params[] = $currentgroup;
2552             } else {
2553                 $groupselect = "";
2554             }
2556         } else {
2557             //seprate groups without access all
2558             if ($currentgroup) {
2559                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2560                 $params[] = $currentgroup;
2561             } else {
2562                 $groupselect = "AND d.groupid = -1";
2563             }
2564         }
2565     } else {
2566         $groupselect = "";
2567     }
2570     if (empty($forumsort)) {
2571         $forumsort = "d.timemodified DESC";
2572     }
2573     if (empty($fullpost)) {
2574         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2575     } else {
2576         $postdata = "p.*";
2577     }
2579     if (empty($userlastmodified)) {  // We don't need to know this
2580         $umfields = "";
2581         $umtable  = "";
2582     } else {
2583         $umfields = ", um.firstname AS umfirstname, um.lastname AS umlastname";
2584         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2585     }
2587     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend,
2588                    u.firstname, u.lastname, u.email, u.picture, u.imagealt $umfields
2589               FROM {forum_discussions} d
2590                    JOIN {forum_posts} p ON p.discussion = d.id
2591                    JOIN {user} u ON p.userid = u.id
2592                    $umtable
2593              WHERE d.forum = ? AND p.parent = 0
2594                    $timelimit $groupselect
2595           ORDER BY $forumsort";
2596     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2599 /**
2600  *
2601  * @global object
2602  * @global object
2603  * @global object
2604  * @uses CONTEXT_MODULE
2605  * @uses VISIBLEGROUPS
2606  * @param object $cm
2607  * @return array
2608  */
2609 function forum_get_discussions_unread($cm) {
2610     global $CFG, $DB, $USER;
2612     $now = round(time(), -2);
2613     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2615     $params = array();
2616     $groupmode    = groups_get_activity_groupmode($cm);
2617     $currentgroup = groups_get_activity_group($cm);
2619     if ($groupmode) {
2620         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2622         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2623             if ($currentgroup) {
2624                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2625                 $params['currentgroup'] = $currentgroup;
2626             } else {
2627                 $groupselect = "";
2628             }
2630         } else {
2631             //separate groups without access all
2632             if ($currentgroup) {
2633                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2634                 $params['currentgroup'] = $currentgroup;
2635             } else {
2636                 $groupselect = "AND d.groupid = -1";
2637             }
2638         }
2639     } else {
2640         $groupselect = "";
2641     }
2643     if (!empty($CFG->forum_enabletimedposts)) {
2644         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2645         $params['now1'] = $now;
2646         $params['now2'] = $now;
2647     } else {
2648         $timedsql = "";
2649     }
2651     $sql = "SELECT d.id, COUNT(p.id) AS unread
2652               FROM {forum_discussions} d
2653                    JOIN {forum_posts} p     ON p.discussion = d.id
2654                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2655              WHERE d.forum = {$cm->instance}
2656                    AND p.modified >= :cutoffdate AND r.id is NULL
2657                    $groupselect
2658                    $timedsql
2659           GROUP BY d.id";
2660     $params['cutoffdate'] = $cutoffdate;
2662     if ($unreads = $DB->get_records_sql($sql, $params)) {
2663         foreach ($unreads as $unread) {
2664             $unreads[$unread->id] = $unread->unread;
2665         }
2666         return $unreads;
2667     } else {
2668         return array();
2669     }
2672 /**
2673  * @global object
2674  * @global object
2675  * @global object
2676  * @uses CONEXT_MODULE
2677  * @uses VISIBLEGROUPS
2678  * @param object $cm
2679  * @return array
2680  */
2681 function forum_get_discussions_count($cm) {
2682     global $CFG, $DB, $USER;
2684     $now = round(time(), -2);
2685     $params = array($cm->instance);
2686     $groupmode    = groups_get_activity_groupmode($cm);
2687     $currentgroup = groups_get_activity_group($cm);
2689     if ($groupmode) {
2690         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2692         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2693             if ($currentgroup) {
2694                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2695                 $params[] = $currentgroup;
2696             } else {
2697                 $groupselect = "";
2698             }
2700         } else {
2701             //seprate groups without access all
2702             if ($currentgroup) {
2703                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2704                 $params[] = $currentgroup;
2705             } else {
2706                 $groupselect = "AND d.groupid = -1";
2707             }
2708         }
2709     } else {
2710         $groupselect = "";
2711     }
2713     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2715     $timelimit = "";
2717     if (!empty($CFG->forum_enabletimedposts)) {
2719         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2721         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2722             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2723             $params[] = $now;
2724             $params[] = $now;
2725             if (isloggedin()) {
2726                 $timelimit .= " OR d.userid = ?";
2727                 $params[] = $USER->id;
2728             }
2729             $timelimit .= ")";
2730         }
2731     }
2733     $sql = "SELECT COUNT(d.id)
2734               FROM {forum_discussions} d
2735                    JOIN {forum_posts} p ON p.discussion = d.id
2736              WHERE d.forum = ? AND p.parent = 0
2737                    $groupselect $timelimit";
2739     return $DB->get_field_sql($sql, $params);
2743 /**
2744  * Get all discussions started by a particular user in a course (or group)
2745  * This function no longer used ...
2746  *
2747  * @todo Remove this function if no longer used
2748  * @global object
2749  * @global object
2750  * @param int $courseid
2751  * @param int $userid
2752  * @param int $groupid
2753  * @return array
2754  */
2755 function forum_get_user_discussions($courseid, $userid, $groupid=0) {
2756     global $CFG, $DB;
2757     $params = array($courseid, $userid);
2758     if ($groupid) {
2759         $groupselect = " AND d.groupid = ? ";
2760         $params[] = $groupid;
2761     } else  {
2762         $groupselect = "";
2763     }
2765     return $DB->get_records_sql("SELECT p.*, d.groupid, u.firstname, u.lastname, u.email, u.picture, u.imagealt,
2766                                    f.type as forumtype, f.name as forumname, f.id as forumid
2767                               FROM {forum_discussions} d,
2768                                    {forum_posts} p,
2769                                    {user} u,
2770                                    {forum} f
2771                              WHERE d.course = ?
2772                                AND p.discussion = d.id
2773                                AND p.parent = 0
2774                                AND p.userid = u.id
2775                                AND u.id = ?
2776                                AND d.forum = f.id $groupselect
2777                           ORDER BY p.created DESC", $params);
2780 /**
2781  * Get the list of potential subscribers to a forum.
2782  *
2783  * @param object $forumcontext the forum context.
2784  * @param integer $groupid the id of a group, or 0 for all groups.
2785  * @param string $fields the list of fields to return for each user. As for get_users_by_capability.
2786  * @param string $sort sort order. As for get_users_by_capability.
2787  * @return array list of users.
2788  */
2789 function forum_get_potential_subscribers($forumcontext, $groupid, $fields, $sort) {
2790     return get_users_by_capability($forumcontext, 'mod/forum:initialsubscriptions', $fields, $sort, '', '', $groupid, '', false, true);
2793 /**
2794  * Returns list of user objects that are subscribed to this forum
2795  *
2796  * @global object
2797  * @global object
2798  * @param object $course the course
2799  * @param forum $forum the forum
2800  * @param integer $groupid group id, or 0 for all.
2801  * @param object $context the forum context, to save re-fetching it where possible.
2802  * @param string $fields requested user fields (with "u." table prefix)
2803  * @return array list of users.
2804  */
2805 function forum_subscribed_users($course, $forum, $groupid=0, $context = null, $fields = null) {
2806     global $CFG, $DB;
2807     $params = array($forum->id);
2809     if ($groupid) {
2810         $grouptables = ", {groups_members} gm ";
2811         $groupselect = "AND gm.groupid = ? AND u.id = gm.userid";
2812         $params[] = $groupid;
2813     } else  {
2814         $grouptables = '';
2815         $groupselect = '';
2816     }
2818     if (empty($fields)) {
2819         $fields ="u.id,
2820                   u.username,
2821                   u.firstname,
2822                   u.lastname,
2823                   u.maildisplay,
2824                   u.mailformat,
2825                   u.maildigest,
2826                   u.imagealt,
2827                   u.email,
2828                   u.city,
2829                   u.country,
2830                   u.lastaccess,
2831                   u.lastlogin,
2832                   u.picture,
2833                   u.timezone,
2834                   u.theme,
2835                   u.lang,
2836                   u.trackforums,
2837                   u.mnethostid";
2838     }
2840     if (forum_is_forcesubscribed($forum)) {
2841         if (empty($context)) {
2842             $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id);
2843             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2844         }
2845         $sort = "u.email ASC";
2846         $results = forum_get_potential_subscribers($context, $groupid, $fields, $sort);
2847     } else {
2848         $results = $DB->get_records_sql("SELECT $fields
2849                               FROM {user} u,
2850                                    {forum_subscriptions} s $grouptables
2851                              WHERE s.forum = ?
2852                                AND s.userid = u.id
2853                                AND u.deleted = 0  $groupselect
2854                           ORDER BY u.email ASC", $params);
2855     }
2857     static $guestid = null;
2859     if (is_null($guestid)) {
2860         if ($guest = guest_user()) {
2861             $guestid = $guest->id;
2862         } else {
2863             $guestid = 0;
2864         }
2865     }
2867     // Guest user should never be subscribed to a forum.
2868     unset($results[$guestid]);
2870     return $results;
2875 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2878 /**
2879  * @global object
2880  * @global object
2881  * @param int $courseid
2882  * @param string $type
2883  */
2884 function forum_get_course_forum($courseid, $type) {
2885 // How to set up special 1-per-course forums
2886     global $CFG, $DB, $OUTPUT;
2888     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
2889         // There should always only be ONE, but with the right combination of
2890         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2891         foreach ($forums as $forum) {
2892             return $forum;   // ie the first one
2893         }
2894     }
2896     // Doesn't exist, so create one now.
2897     $forum->course = $courseid;
2898     $forum->type = "$type";
2899     switch ($forum->type) {
2900         case "news":
2901             $forum->name  = get_string("namenews", "forum");
2902             $forum->intro = get_string("intronews", "forum");
2903             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2904             $forum->assessed = 0;
2905             if ($courseid == SITEID) {
2906                 $forum->name  = get_string("sitenews");
2907                 $forum->forcesubscribe = 0;
2908             }
2909             break;
2910         case "social":
2911             $forum->name  = get_string("namesocial", "forum");
2912             $forum->intro = get_string("introsocial", "forum");
2913             $forum->assessed = 0;
2914             $forum->forcesubscribe = 0;
2915             break;
2916         case "blog":
2917             $forum->name = get_string('blogforum', 'forum');
2918             $forum->intro = get_string('introblog', 'forum');
2919             $forum->assessed = 0;
2920             $forum->forcesubscribe = 0;
2921             break;
2922         default:
2923             echo $OUTPUT->notification("That forum type doesn't exist!");
2924             return false;
2925             break;
2926     }
2928     $forum->timemodified = time();
2929     $forum->id = $DB->insert_record("forum", $forum);
2931     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
2932         echo $OUTPUT->notification("Could not find forum module!!");
2933         return false;
2934     }
2935     $mod = new stdClass();
2936     $mod->course = $courseid;
2937     $mod->module = $module->id;
2938     $mod->instance = $forum->id;
2939     $mod->section = 0;
2940     if (! $mod->coursemodule = add_course_module($mod) ) {   // assumes course/lib.php is loaded
2941         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
2942         return false;
2943     }
2944     if (! $sectionid = add_mod_to_section($mod) ) {   // assumes course/lib.php is loaded
2945         echo $OUTPUT->notification("Could not add the new course module to that section");
2946         return false;
2947     }
2948     $DB->set_field("course_modules", "section", $sectionid, array("id" => $mod->coursemodule));
2950     include_once("$CFG->dirroot/course/lib.php");
2951     rebuild_course_cache($courseid);
2953     return $DB->get_record("forum", array("id" => "$forum->id"));
2957 /**
2958  * Given the data about a posting, builds up the HTML to display it and
2959  * returns the HTML in a string.  This is designed for sending via HTML email.
2960  *
2961  * @global object
2962  * @param object $course
2963  * @param object $cm
2964  * @param object $forum
2965  * @param object $discussion
2966  * @param object $post
2967  * @param object $userform
2968  * @param object $userto
2969  * @param bool $ownpost
2970  * @param bool $reply
2971  * @param bool $link
2972  * @param bool $rate
2973  * @param string $footer
2974  * @return string
2975  */
2976 function forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
2977                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
2979     global $CFG, $OUTPUT;
2981     if (!isset($userto->viewfullnames[$forum->id])) {
2982         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
2983             print_error('invalidcoursemodule');
2984         }
2985         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2986         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
2987     } else {
2988         $viewfullnames = $userto->viewfullnames[$forum->id];
2989     }
2991     // format the post body
2992     $options = new stdClass();
2993     $options->para = true;
2994     $formattedtext = format_text($post->message, $post->messageformat, $options, $course->id);
2996     $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
2998     $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
2999     $output .= $OUTPUT->user_picture($userfrom, array('courseid'=>$course->id));
3000     $output .= '</td>';
3002     if ($post->parent) {
3003         $output .= '<td class="topic">';
3004     } else {
3005         $output .= '<td class="topic starter">';
3006     }
3007     $output .= '<div class="subject">'.format_string($post->subject).'</div>';
3009     $fullname = fullname($userfrom, $viewfullnames);
3010     $by = new stdClass();
3011     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
3012     $by->date = userdate($post->modified, '', $userto->timezone);
3013     $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
3015     $output .= '</td></tr>';
3017     $output .= '<tr><td class="left side" valign="top">';
3019     if (isset($userfrom->groups)) {
3020         $groups = $userfrom->groups[$forum->id];
3021     } else {
3022         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
3023             print_error('invalidcoursemodule');
3024         }
3025         $group = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
3026     }
3028     if ($groups) {
3029         $output .= print_group_picture($groups, $course->id, false, true, true);
3030     } else {
3031         $output .= '&nbsp;';
3032     }
3034     $output .= '</td><td class="content">';
3036     $attachments = forum_print_attachments($post, $cm, 'html');
3037     if ($attachments !== '') {
3038         $output .= '<div class="attachments">';
3039         $output .= $attachments;
3040         $output .= '</div>';
3041     }
3043     $output .= $formattedtext;
3045 // Commands
3046     $commands = array();
3048     if ($post->parent) {
3049         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
3050                       $post->discussion.'&amp;parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
3051     }
3053     if ($reply) {
3054         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
3055                       get_string('reply', 'forum').'</a>';
3056     }
3058     $output .= '<div class="commands">';
3059     $output .= implode(' | ', $commands);
3060     $output .= '</div>';
3062 // Context link to post if required
3063     if ($link) {
3064         $output .= '<div class="link">';
3065         $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
3066                      get_string('postincontext', 'forum').'</a>';
3067         $output .= '</div>';
3068     }
3070     if ($footer) {
3071         $output .= '<div class="footer">'.$footer.'</div>';
3072     }
3073     $output .= '</td></tr></table>'."\n\n";
3075     return $output;
3078 /**
3079  * Print a forum post
3080  *
3081  * @global object
3082  * @global object
3083  * @uses FORUM_MODE_THREADED
3084  * @uses PORTFOLIO_FORMAT_PLAINHTML
3085  * @uses PORTFOLIO_FORMAT_FILE
3086  * @uses PORTFOLIO_FORMAT_RICHHTML
3087  * @uses PORTFOLIO_ADD_TEXT_LINK
3088  * @uses CONTEXT_MODULE
3089  * @param object $post The post to print.
3090  * @param object $discussion
3091  * @param object $forum
3092  * @param object $cm
3093  * @param object $course
3094  * @param boolean $ownpost Whether this post belongs to the current user.
3095  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3096  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3097  * @param string $footer Extra stuff to print after the message.
3098  * @param string $highlight Space-separated list of terms to highlight.
3099  * @param int $post_read true, false or -99. If we already know whether this user
3100  *          has read this post, pass that in, otherwise, pass in -99, and this
3101  *          function will work it out.
3102  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3103  *          the current user can't see this post, if this argument is true
3104  *          (the default) then print a dummy 'you can't see this post' post.
3105  *          If false, don't output anything at all.
3106  * @param bool|null $istracked
3107  * @return void
3108  */
3109 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3110                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3111     global $USER, $CFG, $OUTPUT;
3113     // String cache
3114     static $str;
3116     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
3118     $post->course = $course->id;
3119     $post->forum  = $forum->id;
3120     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3122     // caching
3123     if (!isset($cm->cache)) {
3124         $cm->cache = new stdClass;
3125     }
3127     if (!isset($cm->cache->caps)) {
3128         $cm->cache->caps = array();
3129         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3130         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3131         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3132         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3133         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3134         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3135         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3136         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3137         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3138     }
3140     if (!isset($cm->uservisible)) {
3141         $cm->uservisible = coursemodule_visible_for_user($cm);
3142     }
3144     if ($istracked && is_null($postisread)) {
3145         $postisread = forum_tp_is_post_read($USER->id, $post);
3146     }
3148     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
3149         $output = '';
3150         if (!$dummyifcantsee) {
3151             if ($return) {
3152                 return $output;
3153             }
3154             echo $output;
3155             return;
3156         }
3157         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3158         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'));
3159         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3160         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3161         if ($post->parent) {
3162             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3163         } else {
3164             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3165         }
3166         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class'=>'subject')); // Subject
3167         $output .= html_writer::tag('div', get_string('forumauthorhidden','forum'), array('class'=>'author')); // author
3168         $output .= html_writer::end_tag('div'); // row
3169         $output .= html_writer::start_tag('div', array('class'=>'row'));
3170         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3171         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3172         $output .= html_writer::end_tag('div'); // row
3173         $output .= html_writer::end_tag('div'); // forumpost
3175         if ($return) {
3176             return $output;
3177         }
3178         echo $output;
3179         return;
3180     }
3182     if (empty($str)) {
3183         $str = new stdClass;
3184         $str->edit         = get_string('edit', 'forum');
3185         $str->delete       = get_string('delete', 'forum');
3186         $str->reply        = get_string('reply', 'forum');
3187         $str->parent       = get_string('parent', 'forum');
3188         $str->pruneheading = get_string('pruneheading', 'forum');
3189         $str->prune        = get_string('prune', 'forum');
3190         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3191         $str->markread     = get_string('markread', 'forum');
3192         $str->markunread   = get_string('markunread', 'forum');
3193     }
3195     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3197     // Build an object that represents the posting user
3198     $postuser = new stdClass;
3199     $postuser->id        = $post->userid;
3200     $postuser->firstname = $post->firstname;
3201     $postuser->lastname  = $post->lastname;
3202     $postuser->imagealt  = $post->imagealt;
3203     $postuser->picture   = $post->picture;
3204     $postuser->email     = $post->email;
3205     // Some handy things for later on
3206     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3207     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3209     // Prepare the groups the posting user belongs to
3210     if (isset($cm->cache->usersgroups)) {
3211         $groups = array();
3212         if (isset($cm->cache->usersgroups[$post->userid])) {
3213             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3214                 $groups[$gid] = $cm->cache->groups[$gid];
3215             }
3216         }
3217     } else {
3218         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3219     }
3221     // Prepare the attachements for the post, files then images
3222     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3224     // Determine if we need to shorten this post
3225     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3228     // Prepare an array of commands
3229     $commands = array();
3231     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3232     // Don't display the mark read / unread controls in this case.
3233     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3234         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3235         $text = $str->markunread;
3236         if (!$postisread) {
3237             $url->param('mark', 'read');
3238             $text = $str->markread;
3239         }
3240         if ($str->displaymode == FORUM_MODE_THREADED) {
3241             $url->param('parent', $post->parent);
3242         } else {
3243             $url->set_anchor('p'.$post->id);
3244         }
3245         $commands[] = array('url'=>$url, 'text'=>$text);
3246     }
3248     // Zoom in to the parent specifically
3249     if ($post->parent) {
3250         $url = new moodle_url($discussionlink);
3251         if ($str->displaymode == FORUM_MODE_THREADED) {
3252             $url->param('parent', $post->parent);
3253         } else {
3254             $url->set_anchor('p'.$post->parent);
3255         }
3256         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3257     }
3259     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3260     $age = time() - $post->created;
3261     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3262         $age = 0;
3263     }
3264     if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3265         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3266     }
3268     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3269         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3270     }
3272     if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3273         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3274     }
3276     if ($reply) {
3277         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('reply'=>$post->id)), 'text'=>$str->reply);
3278     }
3280     if ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost'])) {
3281         $p = array('postid' => $post->id);
3282         require_once($CFG->libdir.'/portfoliolib.php');
3283         $button = new portfolio_add_button();
3284         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), '/mod/forum/locallib.php');
3285         if (empty($attachments)) {
3286             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3287         } else {
3288             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3289         }
3291         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3292         if (!empty($porfoliohtml)) {
3293             $commands[] = $porfoliohtml;
3294         }
3295     }
3296     // Finished building commands
3299     // Begin output
3301     $output  = '';
3303     if ($istracked) {
3304         if ($postisread) {
3305             $forumpostclass = ' read';
3306         } else {
3307             $forumpostclass = ' unread';
3308             $output .= html_writer::tag('a', '', array('name'=>'unread'));
3309         }
3310     } else {
3311         // ignore trackign status if not tracked or tracked param missing
3312         $forumpostclass = '';
3313     }
3315     $topicclass = '';
3316     if (empty($post->parent)) {
3317         $topicclass = ' firstpost starter';
3318     }
3320     $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3321     $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass));
3322     $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
3323     $output .= html_writer::start_tag('div', array('class'=>'left picture'));
3324     $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
3325     $output .= html_writer::end_tag('div');
3328     $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
3330     $postsubject = $post->subject;
3331     if (empty($post->subjectnoformat)) {
3332         $postsubject = format_string($postsubject);
3333     }
3334     $output .= html_writer::tag('div', $postsubject, array('class'=>'subject'));
3336     $by = new stdClass();
3337     $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
3338     $by->date = userdate($post->modified);
3339     $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author'));
3341     $output .= html_writer::end_tag('div'); //topic
3342     $output .= html_writer::end_tag('div'); //row
3344     $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
3345     $output .= html_writer::start_tag('div', array('class'=>'left'));
3347     $groupoutput = '';
3348     if ($groups) {
3349         $groupoutput = print_group_picture($groups, $course->id, false, true, true);
3350     }
3351     if (empty($groupoutput)) {
3352         $groupoutput = '&nbsp;';
3353     }
3354     $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
3356     $output .= html_writer::end_tag('div'); //left side
3357     $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
3358     $output .= html_writer::start_tag('div', array('class'=>'content'));
3359     if (!empty($attachments)) {
3360         $output .= html_writer::tag('div', $attachments, array('class'=>'attachments'));
3361     }
3363     $options = new stdClass;
3364     $options->para    = false;
3365     $options->trusted = $post->messagetrust;
3366     $options->context = $modcontext;
3367     if ($shortenpost) {
3368         // Prepare shortened version
3369         $postclass    = 'shortenedpost';
3370         $postcontent  = format_text(forum_shorten_post($post->message), $post->messageformat, $options, $course->id);
3371         $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
3372         $postcontent .= html_writer::tag('span', '('.get_string('numwords', 'moodle', count_words(strip_tags($post->message))).')...', array('class'=>'post-word-count'));
3373     } else {
3374         // Prepare whole post
3375         $postclass    = 'fullpost';
3376         $postcontent  = format_text($post->message, $post->messageformat, $options, $course->id);
3377         if (!empty($highlight)) {
3378             $postcontent = highlight($highlight, $postcontent);
3379         }
3380         $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
3381     }
3382     // Output the post content
3383     $output .= html_writer::tag('div', $postcontent, array('class'=>'posting '.$postclass));
3384     $output .= html_writer::end_tag('div'); // Content
3385     $output .= html_writer::end_tag('div'); // Content mask
3386     $output .= html_writer::end_tag('div'); // Row
3388     $output .= html_writer::start_tag('div', array('class'=>'row side'));
3389     $output .= html_writer::tag('div','&nbsp;', array('class'=>'left'));
3390     $output .= html_writer::start_tag('div', array('class'=>'options clearfix'));
3392     // Output ratings
3393     if (!empty($post->rating)) {
3394         $output .= html_writer::tag('div', $OUTPUT->render($post->rating), array('class'=>'forum-post-rating'));
3395     }
3397     // Output the commands
3398     $commandhtml = array();
3399     foreach ($commands as $command) {
3400         if (is_array($command)) {
3401             $commandhtml[] = html_writer::link($command['url'], $command['text']);
3402         } else {
3403             $commandhtml[] = $command;
3404         }
3405     }
3406     $output .= html_writer::tag('div', implode(' | ', $commandhtml), array('class'=>'commands'));
3408     // Output link to post if required
3409     if ($link) {
3410         if ($post->replies == 1) {
3411             $replystring = get_string('repliesone', 'forum', $post->replies);
3412         } else {
3413             $replystring = get_string('repliesmany', 'forum', $post->replies);
3414         }
3416         $output .= html_writer::start_tag('div', array('class'=>'link'));
3417         $output .= html_writer::link($discussionlink, get_string('discussthistopic', 'forum'));
3418         $output .= '&nbsp;('.$replystring.')';
3419         $output .= html_writer::end_tag('div'); // link
3420     }
3422     // Output footer if required
3423     if ($footer) {
3424         $output .= html_writer::tag('div', $footer, array('class'=>'footer'));
3425     }
3427     // Close remaining open divs
3428     $output .= html_writer::end_tag('div'); // content
3429     $output .= html_writer::end_tag('div'); // row
3430     $output .= html_writer::end_tag('div'); // forumpost
3432     // Mark the forum post as read if required
3433     if ($istracked && !$CFG->forum_usermarksread && !$postisread) {
3434         forum_tp_mark_post_read($USER->id, $post, $forum->id);
3435     }
3437     if ($return) {
3438         return $output;
3439     }
3440     echo $output;
3441     return;
3444 /**
3445  * Return rating related permissions
3446  * @param string $options the context id
3447  * @return array an associative array of the user's rating permissions
3448  */
3449 function forum_rating_permissions($contextid) {
3450     $context = get_context_instance_by_id($contextid);
3452     if (!$context) {
3453         print_error('invalidcontext');
3454         return null;
3455     } else {
3456         return array('view'=>has_capability('mod/forum:viewrating',$context), 'viewany'=>has_capability('mod/forum:viewanyrating',$context), 'viewall'=>has_capability('mod/forum:viewallratings',$context), 'rate'=>has_capability('mod/forum:rate',$context));
3457     }
3460 /**
3461  * Returns the names of the table and columns necessary to check items for ratings
3462  * @return array an array containing the item table, item id and user id columns
3463  */
3464 function forum_rating_item_check_info() {
3465     return array('forum_posts','id','userid');
3469 /**
3470  * This function prints the overview of a discussion in the forum listing.
3471  * It needs some discussion information and some post information, these
3472  * happen to be combined for efficiency in the $post parameter by the function
3473  * that calls this one: forum_print_latest_discussions()
3474  *
3475  * @global object
3476  * @global object
3477  * @param object $post The post object (passed by reference for speed).
3478  * @param object $forum The forum object.
3479  * @param int $group Current group.
3480  * @param string $datestring Format to use for the dates.
3481  * @param boolean $cantrack Is tracking enabled for this forum.
3482  * @param boolean $forumtracked Is the user tracking this forum.
3483  * @param boolean $canviewparticipants True if user has the viewparticipants permission for this course
3484  */
3485 function forum_print_discussion_header(&$post, $forum, $group=-1, $datestring="",
3486                                         $cantrack=true, $forumtracked=true, $canviewparticipants=true, $modcontext=NULL) {
3488     global $USER, $CFG, $OUTPUT;
3490     static $rowcount;
3491     static $strmarkalldread;
3493     if (empty($modcontext)) {
3494         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
3495             print_error('invalidcoursemodule');
3496         }
3497         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
3498     }
3500     if (!isset($rowcount)) {
3501         $rowcount = 0;
3502         $strmarkalldread = get_string('markalldread', 'forum');
3503     } else {
3504         $rowcount = ($rowcount + 1) % 2;
3505   &nb