MDL-29534 Forum: If forum_replytouser is not set then don't display from user email"
[moodle.git] / mod / forum / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * @package    mod
19  * @subpackage 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 defined('MOODLE_INTERNAL') || die();
26 /** Include required files */
27 require_once($CFG->libdir.'/filelib.php');
28 require_once($CFG->libdir.'/eventslib.php');
29 require_once($CFG->dirroot.'/user/selector/lib.php');
30 require_once($CFG->dirroot.'/mod/forum/post_form.php');
32 /// CONSTANTS ///////////////////////////////////////////////////////////
34 define('FORUM_MODE_FLATOLDEST', 1);
35 define('FORUM_MODE_FLATNEWEST', -1);
36 define('FORUM_MODE_THREADED', 2);
37 define('FORUM_MODE_NESTED', 3);
39 define('FORUM_CHOOSESUBSCRIBE', 0);
40 define('FORUM_FORCESUBSCRIBE', 1);
41 define('FORUM_INITIALSUBSCRIBE', 2);
42 define('FORUM_DISALLOWSUBSCRIBE',3);
44 define('FORUM_TRACKING_OFF', 0);
45 define('FORUM_TRACKING_OPTIONAL', 1);
46 define('FORUM_TRACKING_ON', 2);
48 if (!defined('FORUM_CRON_USER_CACHE')) {
49     /** Defines how many full user records are cached in forum cron. */
50     define('FORUM_CRON_USER_CACHE', 5000);
51 }
53 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
55 /**
56  * Given an object containing all the necessary data,
57  * (defined by the form in mod_form.php) this function
58  * will create a new instance and return the id number
59  * of the new instance.
60  *
61  * @param stdClass $forum add forum instance
62  * @param mod_forum_mod_form $mform
63  * @return int intance id
64  */
65 function forum_add_instance($forum, $mform = null) {
66     global $CFG, $DB;
68     $forum->timemodified = time();
70     if (empty($forum->assessed)) {
71         $forum->assessed = 0;
72     }
74     if (empty($forum->ratingtime) or empty($forum->assessed)) {
75         $forum->assesstimestart  = 0;
76         $forum->assesstimefinish = 0;
77     }
79     $forum->id = $DB->insert_record('forum', $forum);
80     $modcontext = get_context_instance(CONTEXT_MODULE, $forum->coursemodule);
82     if ($forum->type == 'single') {  // Create related discussion.
83         $discussion = new stdClass();
84         $discussion->course        = $forum->course;
85         $discussion->forum         = $forum->id;
86         $discussion->name          = $forum->name;
87         $discussion->assessed      = $forum->assessed;
88         $discussion->message       = $forum->intro;
89         $discussion->messageformat = $forum->introformat;
90         $discussion->messagetrust  = trusttext_trusted(get_context_instance(CONTEXT_COURSE, $forum->course));
91         $discussion->mailnow       = false;
92         $discussion->groupid       = -1;
94         $message = '';
96         $discussion->id = forum_add_discussion($discussion, null, $message);
98         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
99             // Ugly hack - we need to copy the files somehow.
100             $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
101             $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
103             $options = array('subdirs'=>true); // Use the same options as intro field!
104             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
105             $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
106         }
107     }
109     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
110     /// all users should be subscribed initially
111     /// Note: forum_get_potential_subscribers should take the forum context,
112     /// but that does not exist yet, becuase the forum is only half build at this
113     /// stage. However, because the forum is brand new, we know that there are
114     /// no role assignments or overrides in the forum context, so using the
115     /// course context gives the same list of users.
116         $users = forum_get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
117         foreach ($users as $user) {
118             forum_subscribe($user->id, $forum->id);
119         }
120     }
122     forum_grade_item_update($forum);
124     return $forum->id;
128 /**
129  * Given an object containing all the necessary data,
130  * (defined by the form in mod_form.php) this function
131  * will update an existing instance with new data.
132  *
133  * @global object
134  * @param object $forum forum instance (with magic quotes)
135  * @return bool success
136  */
137 function forum_update_instance($forum, $mform) {
138     global $DB, $OUTPUT, $USER;
140     $forum->timemodified = time();
141     $forum->id           = $forum->instance;
143     if (empty($forum->assessed)) {
144         $forum->assessed = 0;
145     }
147     if (empty($forum->ratingtime) or empty($forum->assessed)) {
148         $forum->assesstimestart  = 0;
149         $forum->assesstimefinish = 0;
150     }
152     $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
154     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
155     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
156     // 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
157     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
158         forum_update_grades($forum); // recalculate grades for the forum
159     }
161     if ($forum->type == 'single') {  // Update related discussion and post.
162         $discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC');
163         if (!empty($discussions)) {
164             if (count($discussions) > 1) {
165                 echo $OUTPUT->notification(get_string('warnformorepost', 'forum'));
166             }
167             $discussion = array_pop($discussions);
168         } else {
169             // try to recover by creating initial discussion - MDL-16262
170             $discussion = new stdClass();
171             $discussion->course          = $forum->course;
172             $discussion->forum           = $forum->id;
173             $discussion->name            = $forum->name;
174             $discussion->assessed        = $forum->assessed;
175             $discussion->message         = $forum->intro;
176             $discussion->messageformat   = $forum->introformat;
177             $discussion->messagetrust    = true;
178             $discussion->mailnow         = false;
179             $discussion->groupid         = -1;
181             $message = '';
183             forum_add_discussion($discussion, null, $message);
185             if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
186                 print_error('cannotadd', 'forum');
187             }
188         }
189         if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
190             print_error('cannotfindfirstpost', 'forum');
191         }
193         $cm         = get_coursemodule_from_instance('forum', $forum->id);
194         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
196         $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
197         $post->subject       = $forum->name;
198         $post->message       = $forum->intro;
199         $post->messageformat = $forum->introformat;
200         $post->messagetrust  = trusttext_trusted($modcontext);
201         $post->modified      = $forum->timemodified;
202         $post->userid        = $USER->id;    // MDL-18599, so that current teacher can take ownership of activities.
204         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
205             // Ugly hack - we need to copy the files somehow.
206             $options = array('subdirs'=>true); // Use the same options as intro field!
207             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
208         }
210         $DB->update_record('forum_posts', $post);
211         $discussion->name = $forum->name;
212         $DB->update_record('forum_discussions', $discussion);
213     }
215     $DB->update_record('forum', $forum);
217     forum_grade_item_update($forum);
219     return true;
223 /**
224  * Given an ID of an instance of this module,
225  * this function will permanently delete the instance
226  * and any data that depends on it.
227  *
228  * @global object
229  * @param int $id forum instance id
230  * @return bool success
231  */
232 function forum_delete_instance($id) {
233     global $DB;
235     if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
236         return false;
237     }
238     if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
239         return false;
240     }
241     if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
242         return false;
243     }
245     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
247     // now get rid of all files
248     $fs = get_file_storage();
249     $fs->delete_area_files($context->id);
251     $result = true;
253     if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
254         foreach ($discussions as $discussion) {
255             if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
256                 $result = false;
257             }
258         }
259     }
261     if (!$DB->delete_records('forum_subscriptions', array('forum'=>$forum->id))) {
262         $result = false;
263     }
265     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
267     if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
268         $result = false;
269     }
271     forum_grade_item_delete($forum);
273     return $result;
277 /**
278  * Indicates API features that the forum supports.
279  *
280  * @uses FEATURE_GROUPS
281  * @uses FEATURE_GROUPINGS
282  * @uses FEATURE_GROUPMEMBERSONLY
283  * @uses FEATURE_MOD_INTRO
284  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
285  * @uses FEATURE_COMPLETION_HAS_RULES
286  * @uses FEATURE_GRADE_HAS_GRADE
287  * @uses FEATURE_GRADE_OUTCOMES
288  * @param string $feature
289  * @return mixed True if yes (some features may use other values)
290  */
291 function forum_supports($feature) {
292     switch($feature) {
293         case FEATURE_GROUPS:                  return true;
294         case FEATURE_GROUPINGS:               return true;
295         case FEATURE_GROUPMEMBERSONLY:        return true;
296         case FEATURE_MOD_INTRO:               return true;
297         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
298         case FEATURE_COMPLETION_HAS_RULES:    return true;
299         case FEATURE_GRADE_HAS_GRADE:         return true;
300         case FEATURE_GRADE_OUTCOMES:          return true;
301         case FEATURE_RATE:                    return true;
302         case FEATURE_BACKUP_MOODLE2:          return true;
303         case FEATURE_SHOW_DESCRIPTION:        return true;
305         default: return null;
306     }
310 /**
311  * Obtains the automatic completion state for this forum based on any conditions
312  * in forum settings.
313  *
314  * @global object
315  * @global object
316  * @param object $course Course
317  * @param object $cm Course-module
318  * @param int $userid User ID
319  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
320  * @return bool True if completed, false if not. (If no conditions, then return
321  *   value depends on comparison type)
322  */
323 function forum_get_completion_state($course,$cm,$userid,$type) {
324     global $CFG,$DB;
326     // Get forum details
327     if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
328         throw new Exception("Can't find forum {$cm->instance}");
329     }
331     $result=$type; // Default return value
333     $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
334     $postcountsql="
335 SELECT
336     COUNT(1)
337 FROM
338     {forum_posts} fp
339     INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
340 WHERE
341     fp.userid=:userid AND fd.forum=:forumid";
343     if ($forum->completiondiscussions) {
344         $value = $forum->completiondiscussions <=
345                  $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
346         if ($type == COMPLETION_AND) {
347             $result = $result && $value;
348         } else {
349             $result = $result || $value;
350         }
351     }
352     if ($forum->completionreplies) {
353         $value = $forum->completionreplies <=
354                  $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
355         if ($type==COMPLETION_AND) {
356             $result = $result && $value;
357         } else {
358             $result = $result || $value;
359         }
360     }
361     if ($forum->completionposts) {
362         $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
363         if ($type == COMPLETION_AND) {
364             $result = $result && $value;
365         } else {
366             $result = $result || $value;
367         }
368     }
370     return $result;
373 /**
374  * Create a message-id string to use in the custom headers of forum notification emails
375  *
376  * message-id is used by email clients to identify emails and to nest conversations
377  *
378  * @param int $postid The ID of the forum post we are notifying the user about
379  * @param int $usertoid The ID of the user being notified
380  * @param string $hostname The server's hostname
381  * @return string A unique message-id
382  */
383 function forum_get_email_message_id($postid, $usertoid, $hostname) {
384     return '<'.hash('sha256',$postid.'to'.$usertoid).'@'.$hostname.'>';
387 /**
388  * Removes properties from user record that are not necessary
389  * for sending post notifications.
390  * @param stdClass $user
391  * @return void, $user parameter is modified
392  */
393 function forum_cron_minimise_user_record(stdClass $user) {
395     // We store large amount of users in one huge array,
396     // make sure we do not store info there we do not actually need
397     // in mail generation code or messaging.
399     unset($user->institution);
400     unset($user->department);
401     unset($user->address);
402     unset($user->city);
403     unset($user->url);
404     unset($user->currentlogin);
405     unset($user->description);
406     unset($user->descriptionformat);
409 /**
410  * Function to be run periodically according to the moodle cron
411  * Finds all posts that have yet to be mailed out, and mails them
412  * out to all subscribers
413  *
414  * @global object
415  * @global object
416  * @global object
417  * @uses CONTEXT_MODULE
418  * @uses CONTEXT_COURSE
419  * @uses SITEID
420  * @uses FORMAT_PLAIN
421  * @return void
422  */
423 function forum_cron() {
424     global $CFG, $USER, $DB;
426     $site = get_site();
428     // All users that are subscribed to any post that needs sending,
429     // please increase $CFG->extramemorylimit on large sites that
430     // send notifications to a large number of users.
431     $users = array();
432     $userscount = 0; // Cached user counter - count($users) in PHP is horribly slow!!!
434     // status arrays
435     $mailcount  = array();
436     $errorcount = array();
438     // caches
439     $discussions     = array();
440     $forums          = array();
441     $courses         = array();
442     $coursemodules   = array();
443     $subscribedusers = array();
446     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
447     // cron has not been running for a long time, and then suddenly people are flooded
448     // with mail from the past few weeks or months
449     $timenow   = time();
450     $endtime   = $timenow - $CFG->maxeditingtime;
451     $starttime = $endtime - 48 * 3600;   // Two days earlier
453     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
454         // Mark them all now as being mailed.  It's unlikely but possible there
455         // might be an error later so that a post is NOT actually mailed out,
456         // but since mail isn't crucial, we can accept this risk.  Doing it now
457         // prevents the risk of duplicated mails, which is a worse problem.
459         if (!forum_mark_old_posts_as_mailed($endtime)) {
460             mtrace('Errors occurred while trying to mark some posts as being mailed.');
461             return false;  // Don't continue trying to mail them, in case we are in a cron loop
462         }
464         // checking post validity, and adding users to loop through later
465         foreach ($posts as $pid => $post) {
467             $discussionid = $post->discussion;
468             if (!isset($discussions[$discussionid])) {
469                 if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
470                     $discussions[$discussionid] = $discussion;
471                 } else {
472                     mtrace('Could not find discussion '.$discussionid);
473                     unset($posts[$pid]);
474                     continue;
475                 }
476             }
477             $forumid = $discussions[$discussionid]->forum;
478             if (!isset($forums[$forumid])) {
479                 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
480                     $forums[$forumid] = $forum;
481                 } else {
482                     mtrace('Could not find forum '.$forumid);
483                     unset($posts[$pid]);
484                     continue;
485                 }
486             }
487             $courseid = $forums[$forumid]->course;
488             if (!isset($courses[$courseid])) {
489                 if ($course = $DB->get_record('course', array('id' => $courseid))) {
490                     $courses[$courseid] = $course;
491                 } else {
492                     mtrace('Could not find course '.$courseid);
493                     unset($posts[$pid]);
494                     continue;
495                 }
496             }
497             if (!isset($coursemodules[$forumid])) {
498                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
499                     $coursemodules[$forumid] = $cm;
500                 } else {
501                     mtrace('Could not find course module for forum '.$forumid);
502                     unset($posts[$pid]);
503                     continue;
504                 }
505             }
508             // caching subscribed users of each forum
509             if (!isset($subscribedusers[$forumid])) {
510                 $modcontext = get_context_instance(CONTEXT_MODULE, $coursemodules[$forumid]->id);
511                 if ($subusers = forum_subscribed_users($courses[$courseid], $forums[$forumid], 0, $modcontext, "u.*")) {
512                     foreach ($subusers as $postuser) {
513                         // this user is subscribed to this forum
514                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
515                         $userscount++;
516                         if ($userscount > FORUM_CRON_USER_CACHE) {
517                             // Store minimal user info.
518                             $minuser = new stdClass();
519                             $minuser->id = $postuser->id;
520                             $users[$postuser->id] = $minuser;
521                         } else {
522                             // Cache full user record.
523                             forum_cron_minimise_user_record($postuser);
524                             $users[$postuser->id] = $postuser;
525                         }
526                     }
527                     // Release memory.
528                     unset($subusers);
529                     unset($postuser);
530                 }
531             }
533             $mailcount[$pid] = 0;
534             $errorcount[$pid] = 0;
535         }
536     }
538     if ($users && $posts) {
540         $urlinfo = parse_url($CFG->wwwroot);
541         $hostname = $urlinfo['host'];
543         foreach ($users as $userto) {
545             @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
547             mtrace('Processing user '.$userto->id);
549             // Init user caches - we keep the cache for one cycle only,
550             // otherwise it could consume too much memory.
551             if (isset($userto->username)) {
552                 $userto = clone($userto);
553             } else {
554                 $userto = $DB->get_record('user', array('id' => $userto->id));
555                 forum_cron_minimise_user_record($userto);
556             }
557             $userto->viewfullnames = array();
558             $userto->canpost       = array();
559             $userto->markposts     = array();
561             // set this so that the capabilities are cached, and environment matches receiving user
562             cron_setup_user($userto);
564             // reset the caches
565             foreach ($coursemodules as $forumid=>$unused) {
566                 $coursemodules[$forumid]->cache       = new stdClass();
567                 $coursemodules[$forumid]->cache->caps = array();
568                 unset($coursemodules[$forumid]->uservisible);
569             }
571             foreach ($posts as $pid => $post) {
573                 // Set up the environment for the post, discussion, forum, course
574                 $discussion = $discussions[$post->discussion];
575                 $forum      = $forums[$discussion->forum];
576                 $course     = $courses[$forum->course];
577                 $cm         =& $coursemodules[$forum->id];
579                 // Do some checks  to see if we can bail out now
580                 // Only active enrolled users are in the list of subscribers
581                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
582                     continue; // user does not subscribe to this forum
583                 }
585                 // Don't send email if the forum is Q&A and the user has not posted
586                 // Initial topics are still mailed
587                 if ($forum->type == 'qanda' && !forum_get_user_posted_time($discussion->id, $userto->id) && $pid != $discussion->firstpost) {
588                     mtrace('Did not email '.$userto->id.' because user has not posted in discussion');
589                     continue;
590                 }
592                 // Get info about the sending user
593                 if (array_key_exists($post->userid, $users)) { // we might know him/her already
594                     $userfrom = $users[$post->userid];
595                     if (!isset($userfrom->idnumber)) {
596                         // Minimalised user info, fetch full record.
597                         $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
598                         forum_cron_minimise_user_record($userfrom);
599                     }
601                 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
602                     forum_cron_minimise_user_record($userfrom);
603                     // Fetch only once if possible, we can add it to user list, it will be skipped anyway.
604                     if ($userscount <= FORUM_CRON_USER_CACHE) {
605                         $userscount++;
606                         $users[$userfrom->id] = $userfrom;
607                     }
609                 } else {
610                     mtrace('Could not find user '.$post->userid);
611                     continue;
612                 }
614                 //if we want to check that userto and userfrom are not the same person this is probably the spot to do it
616                 // setup global $COURSE properly - needed for roles and languages
617                 cron_setup_user($userto, $course);
619                 // Fill caches
620                 if (!isset($userto->viewfullnames[$forum->id])) {
621                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
622                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
623                 }
624                 if (!isset($userto->canpost[$discussion->id])) {
625                     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
626                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
627                 }
628                 if (!isset($userfrom->groups[$forum->id])) {
629                     if (!isset($userfrom->groups)) {
630                         $userfrom->groups = array();
631                         if (isset($users[$userfrom->id])) {
632                             $users[$userfrom->id]->groups = array();
633                         }
634                     }
635                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
636                     if (isset($users[$userfrom->id])) {
637                         $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
638                     }
639                 }
641                 // Make sure groups allow this user to see this email
642                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {   // Groups are being used
643                     if (!groups_group_exists($discussion->groupid)) { // Can't find group
644                         continue;                           // Be safe and don't send it to anyone
645                     }
647                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
648                         // do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS
649                         continue;
650                     }
651                 }
653                 // Make sure we're allowed to see it...
654                 if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
655                     mtrace('user '.$userto->id. ' can not see '.$post->id);
656                     continue;
657                 }
659                 // OK so we need to send the email.
661                 // Does the user want this post in a digest?  If so postpone it for now.
662                 if ($userto->maildigest > 0) {
663                     // This user wants the mails to be in digest form
664                     $queue = new stdClass();
665                     $queue->userid       = $userto->id;
666                     $queue->discussionid = $discussion->id;
667                     $queue->postid       = $post->id;
668                     $queue->timemodified = $post->created;
669                     $DB->insert_record('forum_queue', $queue);
670                     continue;
671                 }
674                 // Prepare to actually send the post now, and build up the content
676                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
678                 $userfrom->customheaders = array (  // Headers to make emails easier to track
679                            'Precedence: Bulk',
680                            'List-Id: "'.$cleanforumname.'" <moodleforum'.$forum->id.'@'.$hostname.'>',
681                            'List-Help: '.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id,
682                            'Message-ID: '.forum_get_email_message_id($post->id, $userto->id, $hostname),
683                            'X-Course-Id: '.$course->id,
684                            'X-Course-Name: '.format_string($course->fullname, true)
685                 );
687                 if ($post->parent) {  // This post is a reply, so add headers for threading (see MDL-22551)
688                     $userfrom->customheaders[] = 'In-Reply-To: '.forum_get_email_message_id($post->parent, $userto->id, $hostname);
689                     $userfrom->customheaders[] = 'References: '.forum_get_email_message_id($post->parent, $userto->id, $hostname);
690                 }
692                 $shortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
694                 $postsubject = html_to_text("$shortname: ".format_string($post->subject, true));
695                 $posttext = forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto);
696                 $posthtml = forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto);
698                 // Send the post now!
700                 mtrace('Sending ', '');
702                 $eventdata = new stdClass();
703                 $eventdata->component        = 'mod_forum';
704                 $eventdata->name             = 'posts';
705                 $eventdata->userfrom         = $userfrom;
706                 $eventdata->userto           = $userto;
707                 $eventdata->subject          = $postsubject;
708                 $eventdata->fullmessage      = $posttext;
709                 $eventdata->fullmessageformat = FORMAT_PLAIN;
710                 $eventdata->fullmessagehtml  = $posthtml;
711                 $eventdata->notification = 1;
713                 $smallmessagestrings = new stdClass();
714                 $smallmessagestrings->user = fullname($userfrom);
715                 $smallmessagestrings->forumname = "$shortname: ".format_string($forum->name,true).": ".$discussion->name;
716                 $smallmessagestrings->message = $post->message;
717                 //make sure strings are in message recipients language
718                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
720                 $eventdata->contexturl = "{$CFG->wwwroot}/mod/forum/discuss.php?d={$discussion->id}#p{$post->id}";
721                 $eventdata->contexturlname = $discussion->name;
723                 // If forum_replytouser is not set then set mail display to 0.
724                 if (!$CFG->forum_replytouser) {
725                     $eventdata->userfrom->maildisplay = 0;
726                 }
728                 $mailresult = message_send($eventdata);
729                 if (!$mailresult){
730                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
731                          " ($userto->email) .. not trying again.");
732                     add_to_log($course->id, 'forum', 'mail error', "discuss.php?d=$discussion->id#p$post->id",
733                                substr(format_string($post->subject,true),0,30), $cm->id, $userto->id);
734                     $errorcount[$post->id]++;
735                 } else {
736                     $mailcount[$post->id]++;
738                 // Mark post as read if forum_usermarksread is set off
739                     if (!$CFG->forum_usermarksread) {
740                         $userto->markposts[$post->id] = $post->id;
741                     }
742                 }
744                 mtrace('post '.$post->id. ': '.$post->subject);
745             }
747             // mark processed posts as read
748             forum_tp_mark_posts_read($userto, $userto->markposts);
749             unset($userto);
750         }
751     }
753     if ($posts) {
754         foreach ($posts as $post) {
755             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
756             if ($errorcount[$post->id]) {
757                 $DB->set_field("forum_posts", "mailed", "2", array("id" => "$post->id"));
758             }
759         }
760     }
762     // release some memory
763     unset($subscribedusers);
764     unset($mailcount);
765     unset($errorcount);
767     cron_setup_user();
769     $sitetimezone = $CFG->timezone;
771     // Now see if there are any digest mails waiting to be sent, and if we should send them
773     mtrace('Starting digest processing...');
775     @set_time_limit(300); // terminate if not able to fetch all digests in 5 minutes
777     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
778         set_config('digestmailtimelast', 0);
779     }
781     $timenow = time();
782     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
784     // Delete any really old ones (normally there shouldn't be any)
785     $weekago = $timenow - (7 * 24 * 3600);
786     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
787     mtrace ('Cleaned old digest records');
789     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
791         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
793         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
795         if ($digestposts_rs->valid()) {
797             // We have work to do
798             $usermailcount = 0;
800             //caches - reuse the those filled before too
801             $discussionposts = array();
802             $userdiscussions = array();
804             foreach ($digestposts_rs as $digestpost) {
805                 if (!isset($posts[$digestpost->postid])) {
806                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
807                         $posts[$digestpost->postid] = $post;
808                     } else {
809                         continue;
810                     }
811                 }
812                 $discussionid = $digestpost->discussionid;
813                 if (!isset($discussions[$discussionid])) {
814                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
815                         $discussions[$discussionid] = $discussion;
816                     } else {
817                         continue;
818                     }
819                 }
820                 $forumid = $discussions[$discussionid]->forum;
821                 if (!isset($forums[$forumid])) {
822                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
823                         $forums[$forumid] = $forum;
824                     } else {
825                         continue;
826                     }
827                 }
829                 $courseid = $forums[$forumid]->course;
830                 if (!isset($courses[$courseid])) {
831                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
832                         $courses[$courseid] = $course;
833                     } else {
834                         continue;
835                     }
836                 }
838                 if (!isset($coursemodules[$forumid])) {
839                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
840                         $coursemodules[$forumid] = $cm;
841                     } else {
842                         continue;
843                     }
844                 }
845                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
846                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
847             }
848             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
850             // Data collected, start sending out emails to each user
851             foreach ($userdiscussions as $userid => $thesediscussions) {
853                 @set_time_limit(120); // terminate if processing of any account takes longer than 2 minutes
855                 cron_setup_user();
857                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
859                 // First of all delete all the queue entries for this user
860                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
862                 // Init user caches - we keep the cache for one cycle only,
863                 // otherwise it would unnecessarily consume memory.
864                 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
865                     $userto = clone($users[$userid]);
866                 } else {
867                     $userto = $DB->get_record('user', array('id' => $userid));
868                     forum_cron_minimise_user_record($userto);
869                 }
870                 $userto->viewfullnames = array();
871                 $userto->canpost       = array();
872                 $userto->markposts     = array();
874                 // Override the language and timezone of the "current" user, so that
875                 // mail is customised for the receiver.
876                 cron_setup_user($userto);
878                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
880                 $headerdata = new stdClass();
881                 $headerdata->sitename = format_string($site->fullname, true);
882                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
884                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
885                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
887                 $posthtml = "<head>";
888 /*                foreach ($CFG->stylesheets as $stylesheet) {
889                     //TODO: MDL-21120
890                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
891                 }*/
892                 $posthtml .= "</head>\n<body id=\"email\">\n";
893                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
895                 foreach ($thesediscussions as $discussionid) {
897                     @set_time_limit(120);   // to be reset for each post
899                     $discussion = $discussions[$discussionid];
900                     $forum      = $forums[$discussion->forum];
901                     $course     = $courses[$forum->course];
902                     $cm         = $coursemodules[$forum->id];
904                     //override language
905                     cron_setup_user($userto, $course);
907                     // Fill caches
908                     if (!isset($userto->viewfullnames[$forum->id])) {
909                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
910                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
911                     }
912                     if (!isset($userto->canpost[$discussion->id])) {
913                         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
914                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
915                     }
917                     $strforums      = get_string('forums', 'forum');
918                     $canunsubscribe = ! forum_is_forcesubscribed($forum);
919                     $canreply       = $userto->canpost[$discussion->id];
920                     $shortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
922                     $posttext .= "\n \n";
923                     $posttext .= '=====================================================================';
924                     $posttext .= "\n \n";
925                     $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
926                     if ($discussion->name != $forum->name) {
927                         $posttext  .= " -> ".format_string($discussion->name,true);
928                     }
929                     $posttext .= "\n";
931                     $posthtml .= "<p><font face=\"sans-serif\">".
932                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
933                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
934                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
935                     if ($discussion->name == $forum->name) {
936                         $posthtml .= "</font></p>";
937                     } else {
938                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
939                     }
940                     $posthtml .= '<p>';
942                     $postsarray = $discussionposts[$discussionid];
943                     sort($postsarray);
945                     foreach ($postsarray as $postid) {
946                         $post = $posts[$postid];
948                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
949                             $userfrom = $users[$post->userid];
950                             if (!isset($userfrom->idnumber)) {
951                                 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
952                                 forum_cron_minimise_user_record($userfrom);
953                             }
955                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
956                             forum_cron_minimise_user_record($userfrom);
957                             if ($userscount <= FORUM_CRON_USER_CACHE) {
958                                 $userscount++;
959                                 $users[$userfrom->id] = $userfrom;
960                             }
962                         } else {
963                             mtrace('Could not find user '.$post->userid);
964                             continue;
965                         }
967                         if (!isset($userfrom->groups[$forum->id])) {
968                             if (!isset($userfrom->groups)) {
969                                 $userfrom->groups = array();
970                                 if (isset($users[$userfrom->id])) {
971                                     $users[$userfrom->id]->groups = array();
972                                 }
973                             }
974                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
975                             if (isset($users[$userfrom->id])) {
976                                 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
977                             }
978                         }
980                         $userfrom->customheaders = array ("Precedence: Bulk");
982                         if ($userto->maildigest == 2) {
983                             // Subjects only
984                             $by = new stdClass();
985                             $by->name = fullname($userfrom);
986                             $by->date = userdate($post->modified);
987                             $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
988                             $posttext .= "\n---------------------------------------------------------------------";
990                             $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&amp;course=$course->id\">$by->name</a>";
991                             $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>';
993                         } else {
994                             // The full treatment
995                             $posttext .= forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, true);
996                             $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
998                         // Create an array of postid's for this user to mark as read.
999                             if (!$CFG->forum_usermarksread) {
1000                                 $userto->markposts[$post->id] = $post->id;
1001                             }
1002                         }
1003                     }
1004                     if ($canunsubscribe) {
1005                         $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>";
1006                     } else {
1007                         $posthtml .= "\n<div class='mdl-right'><font size=\"1\">".get_string("everyoneissubscribed", "forum")."</font></div>";
1008                     }
1009                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
1010                 }
1011                 $posthtml .= '</body>';
1013                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
1014                     // This user DOESN'T want to receive HTML
1015                     $posthtml = '';
1016                 }
1018                 $attachment = $attachname='';
1019                 $usetrueaddress = true;
1020                 // Directly email forum digests rather than sending them via messaging, use the
1021                 // site shortname as 'from name', the noreply address will be used by email_to_user.
1022                 $mailresult = email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml, $attachment, $attachname, $usetrueaddress);
1024                 if (!$mailresult) {
1025                     mtrace("ERROR!");
1026                     echo "Error: mod/forum/cron.php: Could not send out digest mail to user $userto->id ($userto->email)... not trying again.\n";
1027                     add_to_log($course->id, 'forum', 'mail digest error', '', '', $cm->id, $userto->id);
1028                 } else {
1029                     mtrace("success.");
1030                     $usermailcount++;
1032                     // Mark post as read if forum_usermarksread is set off
1033                     forum_tp_mark_posts_read($userto, $userto->markposts);
1034                 }
1035             }
1036         }
1037     /// We have finishied all digest emails, update $CFG->digestmailtimelast
1038         set_config('digestmailtimelast', $timenow);
1039     }
1041     cron_setup_user();
1043     if (!empty($usermailcount)) {
1044         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
1045     }
1047     if (!empty($CFG->forum_lastreadclean)) {
1048         $timenow = time();
1049         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1050             set_config('forum_lastreadclean', $timenow);
1051             mtrace('Removing old forum read tracking info...');
1052             forum_tp_clean_read_records();
1053         }
1054     } else {
1055         set_config('forum_lastreadclean', time());
1056     }
1059     return true;
1062 /**
1063  * Builds and returns the body of the email notification in plain text.
1064  *
1065  * @global object
1066  * @global object
1067  * @uses CONTEXT_MODULE
1068  * @param object $course
1069  * @param object $cm
1070  * @param object $forum
1071  * @param object $discussion
1072  * @param object $post
1073  * @param object $userfrom
1074  * @param object $userto
1075  * @param boolean $bare
1076  * @return string The email body in plain text format.
1077  */
1078 function forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $bare = false) {
1079     global $CFG, $USER;
1081     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
1083     if (!isset($userto->viewfullnames[$forum->id])) {
1084         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1085     } else {
1086         $viewfullnames = $userto->viewfullnames[$forum->id];
1087     }
1089     if (!isset($userto->canpost[$discussion->id])) {
1090         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1091     } else {
1092         $canreply = $userto->canpost[$discussion->id];
1093     }
1095     $by = New stdClass;
1096     $by->name = fullname($userfrom, $viewfullnames);
1097     $by->date = userdate($post->modified, "", $userto->timezone);
1099     $strbynameondate = get_string('bynameondate', 'forum', $by);
1101     $strforums = get_string('forums', 'forum');
1103     $canunsubscribe = ! forum_is_forcesubscribed($forum);
1105     $posttext = '';
1107     if (!$bare) {
1108         $shortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
1109         $posttext  = "$shortname -> $strforums -> ".format_string($forum->name,true);
1111         if ($discussion->name != $forum->name) {
1112             $posttext  .= " -> ".format_string($discussion->name,true);
1113         }
1114     }
1116     // add absolute file links
1117     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
1119     $posttext .= "\n---------------------------------------------------------------------\n";
1120     $posttext .= format_string($post->subject,true);
1121     if ($bare) {
1122         $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
1123     }
1124     $posttext .= "\n".$strbynameondate."\n";
1125     $posttext .= "---------------------------------------------------------------------\n";
1126     $posttext .= format_text_email($post->message, $post->messageformat);
1127     $posttext .= "\n\n";
1128     $posttext .= forum_print_attachments($post, $cm, "text");
1130     if (!$bare && $canreply) {
1131         $posttext .= "---------------------------------------------------------------------\n";
1132         $posttext .= get_string("postmailinfo", "forum", $shortname)."\n";
1133         $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
1134     }
1135     if (!$bare && $canunsubscribe) {
1136         $posttext .= "\n---------------------------------------------------------------------\n";
1137         $posttext .= get_string("unsubscribe", "forum");
1138         $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
1139     }
1141     return $posttext;
1144 /**
1145  * Builds and returns the body of the email notification in html format.
1146  *
1147  * @global object
1148  * @param object $course
1149  * @param object $cm
1150  * @param object $forum
1151  * @param object $discussion
1152  * @param object $post
1153  * @param object $userfrom
1154  * @param object $userto
1155  * @return string The email text in HTML format
1156  */
1157 function forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto) {
1158     global $CFG;
1160     if ($userto->mailformat != 1) {  // Needs to be HTML
1161         return '';
1162     }
1164     if (!isset($userto->canpost[$discussion->id])) {
1165         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course);
1166     } else {
1167         $canreply = $userto->canpost[$discussion->id];
1168     }
1170     $strforums = get_string('forums', 'forum');
1171     $canunsubscribe = ! forum_is_forcesubscribed($forum);
1172     $shortname = format_string($course->shortname, true, array('context' => get_context_instance(CONTEXT_COURSE, $course->id)));
1174     $posthtml = '<head>';
1175 /*    foreach ($CFG->stylesheets as $stylesheet) {
1176         //TODO: MDL-21120
1177         $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
1178     }*/
1179     $posthtml .= '</head>';
1180     $posthtml .= "\n<body id=\"email\">\n\n";
1182     $posthtml .= '<div class="navbar">'.
1183     '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$shortname.'</a> &raquo; '.
1184     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> &raquo; '.
1185     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
1186     if ($discussion->name == $forum->name) {
1187         $posthtml .= '</div>';
1188     } else {
1189         $posthtml .= ' &raquo; <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
1190                      format_string($discussion->name,true).'</a></div>';
1191     }
1192     $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1194     if ($canunsubscribe) {
1195         $posthtml .= '<hr /><div class="mdl-align unsubscribelink">
1196                       <a href="'.$CFG->wwwroot.'/mod/forum/subscribe.php?id='.$forum->id.'">'.get_string('unsubscribe', 'forum').'</a>&nbsp;
1197                       <a href="'.$CFG->wwwroot.'/mod/forum/unsubscribeall.php">'.get_string('unsubscribeall', 'forum').'</a></div>';
1198     }
1200     $posthtml .= '</body>';
1202     return $posthtml;
1206 /**
1207  *
1208  * @param object $course
1209  * @param object $user
1210  * @param object $mod TODO this is not used in this function, refactor
1211  * @param object $forum
1212  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
1213  */
1214 function forum_user_outline($course, $user, $mod, $forum) {
1215     global $CFG;
1216     require_once("$CFG->libdir/gradelib.php");
1217     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1218     if (empty($grades->items[0]->grades)) {
1219         $grade = false;
1220     } else {
1221         $grade = reset($grades->items[0]->grades);
1222     }
1224     $count = forum_count_user_posts($forum->id, $user->id);
1226     if ($count && $count->postcount > 0) {
1227         $result = new stdClass();
1228         $result->info = get_string("numposts", "forum", $count->postcount);
1229         $result->time = $count->lastpost;
1230         if ($grade) {
1231             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1232         }
1233         return $result;
1234     } else if ($grade) {
1235         $result = new stdClass();
1236         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1238         //datesubmitted == time created. dategraded == time modified or time overridden
1239         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1240         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1241         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1242             $result->time = $grade->dategraded;
1243         } else {
1244             $result->time = $grade->datesubmitted;
1245         }
1247         return $result;
1248     }
1249     return NULL;
1253 /**
1254  * @global object
1255  * @global object
1256  * @param object $coure
1257  * @param object $user
1258  * @param object $mod
1259  * @param object $forum
1260  */
1261 function forum_user_complete($course, $user, $mod, $forum) {
1262     global $CFG,$USER, $OUTPUT;
1263     require_once("$CFG->libdir/gradelib.php");
1265     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1266     if (!empty($grades->items[0]->grades)) {
1267         $grade = reset($grades->items[0]->grades);
1268         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1269         if ($grade->str_feedback) {
1270             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1271         }
1272     }
1274     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
1276         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
1277             print_error('invalidcoursemodule');
1278         }
1279         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1281         foreach ($posts as $post) {
1282             if (!isset($discussions[$post->discussion])) {
1283                 continue;
1284             }
1285             $discussion = $discussions[$post->discussion];
1287             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
1288         }
1289     } else {
1290         echo "<p>".get_string("noposts", "forum")."</p>";
1291     }
1299 /**
1300  * @global object
1301  * @global object
1302  * @global object
1303  * @param array $courses
1304  * @param array $htmlarray
1305  */
1306 function forum_print_overview($courses,&$htmlarray) {
1307     global $USER, $CFG, $DB, $SESSION;
1309     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1310         return array();
1311     }
1313     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1314         return;
1315     }
1317     // Courses to search for new posts
1318     $coursessqls = array();
1319     $params = array();
1320     foreach ($courses as $course) {
1322         // If the user has never entered into the course all posts are pending
1323         if ($course->lastaccess == 0) {
1324             $coursessqls[] = '(f.course = ?)';
1325             $params[] = $course->id;
1327         // Only posts created after the course last access
1328         } else {
1329             $coursessqls[] = '(f.course = ? AND p.created > ?)';
1330             $params[] = $course->id;
1331             $params[] = $course->lastaccess;
1332         }
1333     }
1334     $params[] = $USER->id;
1335     $coursessql = implode(' OR ', $coursessqls);
1337     $sql = "SELECT f.id, COUNT(*) as count "
1338                 .'FROM {forum} f '
1339                 .'JOIN {forum_discussions} d ON d.forum  = f.id '
1340                 .'JOIN {forum_posts} p ON p.discussion = d.id '
1341                 ."WHERE ($coursessql) "
1342                 .'AND p.userid != ? '
1343                 .'GROUP BY f.id';
1345     if (!$new = $DB->get_records_sql($sql, $params)) {
1346         $new = array(); // avoid warnings
1347     }
1349     // also get all forum tracking stuff ONCE.
1350     $trackingforums = array();
1351     foreach ($forums as $forum) {
1352         if (forum_tp_can_track_forums($forum)) {
1353             $trackingforums[$forum->id] = $forum;
1354         }
1355     }
1357     if (count($trackingforums) > 0) {
1358         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1359         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1360             ' FROM {forum_posts} p '.
1361             ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1362             ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
1363         $params = array($USER->id);
1365         foreach ($trackingforums as $track) {
1366             $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1367             $params[] = $track->id;
1368             if (isset($SESSION->currentgroup[$track->course])) {
1369                 $groupid =  $SESSION->currentgroup[$track->course];
1370             } else {
1371                 // get first groupid
1372                 $groupids = groups_get_all_groups($track->course, $USER->id);
1373                 if ($groupids) {
1374                     reset($groupids);
1375                     $groupid = key($groupids);
1376                     $SESSION->currentgroup[$track->course] = $groupid;
1377                 } else {
1378                     $groupid = 0;
1379                 }
1380                 unset($groupids);
1381             }
1382             $params[] = $groupid;
1383         }
1384         $sql = substr($sql,0,-3); // take off the last OR
1385         $sql .= ') AND p.modified >= ? AND r.id is NULL GROUP BY d.forum,d.course';
1386         $params[] = $cutoffdate;
1388         if (!$unread = $DB->get_records_sql($sql, $params)) {
1389             $unread = array();
1390         }
1391     } else {
1392         $unread = array();
1393     }
1395     if (empty($unread) and empty($new)) {
1396         return;
1397     }
1399     $strforum = get_string('modulename','forum');
1401     foreach ($forums as $forum) {
1402         $str = '';
1403         $count = 0;
1404         $thisunread = 0;
1405         $showunread = false;
1406         // either we have something from logs, or trackposts, or nothing.
1407         if (array_key_exists($forum->id, $new) && !empty($new[$forum->id])) {
1408             $count = $new[$forum->id]->count;
1409         }
1410         if (array_key_exists($forum->id,$unread)) {
1411             $thisunread = $unread[$forum->id]->count;
1412             $showunread = true;
1413         }
1414         if ($count > 0 || $thisunread > 0) {
1415             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1416                 $forum->name.'</a></div>';
1417             $str .= '<div class="info"><span class="postsincelogin">';
1418             $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
1419             if (!empty($showunread)) {
1420                 $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
1421             }
1422             $str .= '</div></div>';
1423         }
1424         if (!empty($str)) {
1425             if (!array_key_exists($forum->course,$htmlarray)) {
1426                 $htmlarray[$forum->course] = array();
1427             }
1428             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1429                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1430             }
1431             $htmlarray[$forum->course]['forum'] .= $str;
1432         }
1433     }
1436 /**
1437  * Given a course and a date, prints a summary of all the new
1438  * messages posted in the course since that date
1439  *
1440  * @global object
1441  * @global object
1442  * @global object
1443  * @uses CONTEXT_MODULE
1444  * @uses VISIBLEGROUPS
1445  * @param object $course
1446  * @param bool $viewfullnames capability
1447  * @param int $timestart
1448  * @return bool success
1449  */
1450 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1451     global $CFG, $USER, $DB, $OUTPUT;
1453     // do not use log table if possible, it may be huge and is expensive to join with other tables
1455     if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1456                                               d.timestart, d.timeend, d.userid AS duserid,
1457                                               u.firstname, u.lastname, u.email, u.picture
1458                                          FROM {forum_posts} p
1459                                               JOIN {forum_discussions} d ON d.id = p.discussion
1460                                               JOIN {forum} f             ON f.id = d.forum
1461                                               JOIN {user} u              ON u.id = p.userid
1462                                         WHERE p.created > ? AND f.course = ?
1463                                      ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
1464          return false;
1465     }
1467     $modinfo = get_fast_modinfo($course);
1469     $groupmodes = array();
1470     $cms    = array();
1472     $strftimerecent = get_string('strftimerecent');
1474     $printposts = array();
1475     foreach ($posts as $post) {
1476         if (!isset($modinfo->instances['forum'][$post->forum])) {
1477             // not visible
1478             continue;
1479         }
1480         $cm = $modinfo->instances['forum'][$post->forum];
1481         if (!$cm->uservisible) {
1482             continue;
1483         }
1484         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1486         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1487             continue;
1488         }
1490         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1491           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1492             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1493                 continue;
1494             }
1495         }
1497         $groupmode = groups_get_activity_groupmode($cm, $course);
1499         if ($groupmode) {
1500             if ($post->groupid == -1 or $groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $context)) {
1501                 // oki (Open discussions have groupid -1)
1502             } else {
1503                 // separate mode
1504                 if (isguestuser()) {
1505                     // shortcut
1506                     continue;
1507                 }
1509                 if (is_null($modinfo->groups)) {
1510                     $modinfo->groups = groups_get_user_groups($course->id); // load all my groups and cache it in modinfo
1511                 }
1513                 if (!array_key_exists($post->groupid, $modinfo->groups[0])) {
1514                     continue;
1515                 }
1516             }
1517         }
1519         $printposts[] = $post;
1520     }
1521     unset($posts);
1523     if (!$printposts) {
1524         return false;
1525     }
1527     echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
1528     echo "\n<ul class='unlist'>\n";
1530     foreach ($printposts as $post) {
1531         $subjectclass = empty($post->parent) ? ' bold' : '';
1533         echo '<li><div class="head">'.
1534                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1535                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1536              '</div>';
1537         echo '<div class="info'.$subjectclass.'">';
1538         if (empty($post->parent)) {
1539             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1540         } else {
1541             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1542         }
1543         $post->subject = break_up_long_words(format_string($post->subject, true));
1544         echo $post->subject;
1545         echo "</a>\"</div></li>\n";
1546     }
1548     echo "</ul>\n";
1550     return true;
1553 /**
1554  * Return grade for given user or all users.
1555  *
1556  * @global object
1557  * @global object
1558  * @param object $forum
1559  * @param int $userid optional user id, 0 means all users
1560  * @return array array of grades, false if none
1561  */
1562 function forum_get_user_grades($forum, $userid = 0) {
1563     global $CFG;
1565     require_once($CFG->dirroot.'/rating/lib.php');
1567     $ratingoptions = new stdClass;
1568     $ratingoptions->component = 'mod_forum';
1569     $ratingoptions->ratingarea = 'post';
1571     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1572     $ratingoptions->modulename = 'forum';
1573     $ratingoptions->moduleid   = $forum->id;
1574     $ratingoptions->userid = $userid;
1575     $ratingoptions->aggregationmethod = $forum->assessed;
1576     $ratingoptions->scaleid = $forum->scale;
1577     $ratingoptions->itemtable = 'forum_posts';
1578     $ratingoptions->itemtableusercolumn = 'userid';
1580     $rm = new rating_manager();
1581     return $rm->get_user_grades($ratingoptions);
1584 /**
1585  * Update activity grades
1586  *
1587  * @category grade
1588  * @param object $forum
1589  * @param int $userid specific user only, 0 means all
1590  * @param boolean $nullifnone return null if grade does not exist
1591  * @return void
1592  */
1593 function forum_update_grades($forum, $userid=0, $nullifnone=true) {
1594     global $CFG, $DB;
1595     require_once($CFG->libdir.'/gradelib.php');
1597     if (!$forum->assessed) {
1598         forum_grade_item_update($forum);
1600     } else if ($grades = forum_get_user_grades($forum, $userid)) {
1601         forum_grade_item_update($forum, $grades);
1603     } else if ($userid and $nullifnone) {
1604         $grade = new stdClass();
1605         $grade->userid   = $userid;
1606         $grade->rawgrade = NULL;
1607         forum_grade_item_update($forum, $grade);
1609     } else {
1610         forum_grade_item_update($forum);
1611     }
1614 /**
1615  * Update all grades in gradebook.
1616  * @global object
1617  */
1618 function forum_upgrade_grades() {
1619     global $DB;
1621     $sql = "SELECT COUNT('x')
1622               FROM {forum} f, {course_modules} cm, {modules} m
1623              WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
1624     $count = $DB->count_records_sql($sql);
1626     $sql = "SELECT f.*, cm.idnumber AS cmidnumber, f.course AS courseid
1627               FROM {forum} f, {course_modules} cm, {modules} m
1628              WHERE m.name='forum' AND m.id=cm.module AND cm.instance=f.id";
1629     $rs = $DB->get_recordset_sql($sql);
1630     if ($rs->valid()) {
1631         $pbar = new progress_bar('forumupgradegrades', 500, true);
1632         $i=0;
1633         foreach ($rs as $forum) {
1634             $i++;
1635             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
1636             forum_update_grades($forum, 0, false);
1637             $pbar->update($i, $count, "Updating Forum grades ($i/$count).");
1638         }
1639     }
1640     $rs->close();
1643 /**
1644  * Create/update grade item for given forum
1645  *
1646  * @category grade
1647  * @uses GRADE_TYPE_NONE
1648  * @uses GRADE_TYPE_VALUE
1649  * @uses GRADE_TYPE_SCALE
1650  * @param stdClass $forum Forum object with extra cmidnumber
1651  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1652  * @return int 0 if ok
1653  */
1654 function forum_grade_item_update($forum, $grades=NULL) {
1655     global $CFG;
1656     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1657         require_once($CFG->libdir.'/gradelib.php');
1658     }
1660     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1662     if (!$forum->assessed or $forum->scale == 0) {
1663         $params['gradetype'] = GRADE_TYPE_NONE;
1665     } else if ($forum->scale > 0) {
1666         $params['gradetype'] = GRADE_TYPE_VALUE;
1667         $params['grademax']  = $forum->scale;
1668         $params['grademin']  = 0;
1670     } else if ($forum->scale < 0) {
1671         $params['gradetype'] = GRADE_TYPE_SCALE;
1672         $params['scaleid']   = -$forum->scale;
1673     }
1675     if ($grades  === 'reset') {
1676         $params['reset'] = true;
1677         $grades = NULL;
1678     }
1680     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1683 /**
1684  * Delete grade item for given forum
1685  *
1686  * @category grade
1687  * @param stdClass $forum Forum object
1688  * @return grade_item
1689  */
1690 function forum_grade_item_delete($forum) {
1691     global $CFG;
1692     require_once($CFG->libdir.'/gradelib.php');
1694     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1698 /**
1699  * This function returns if a scale is being used by one forum
1700  *
1701  * @global object
1702  * @param int $forumid
1703  * @param int $scaleid negative number
1704  * @return bool
1705  */
1706 function forum_scale_used ($forumid,$scaleid) {
1707     global $DB;
1708     $return = false;
1710     $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
1712     if (!empty($rec) && !empty($scaleid)) {
1713         $return = true;
1714     }
1716     return $return;
1719 /**
1720  * Checks if scale is being used by any instance of forum
1721  *
1722  * This is used to find out if scale used anywhere
1723  *
1724  * @global object
1725  * @param $scaleid int
1726  * @return boolean True if the scale is used by any forum
1727  */
1728 function forum_scale_used_anywhere($scaleid) {
1729     global $DB;
1730     if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
1731         return true;
1732     } else {
1733         return false;
1734     }
1737 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1739 /**
1740  * Gets a post with all info ready for forum_print_post
1741  * Most of these joins are just to get the forum id
1742  *
1743  * @global object
1744  * @global object
1745  * @param int $postid
1746  * @return mixed array of posts or false
1747  */
1748 function forum_get_post_full($postid) {
1749     global $CFG, $DB;
1751     return $DB->get_record_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1752                              FROM {forum_posts} p
1753                                   JOIN {forum_discussions} d ON p.discussion = d.id
1754                                   LEFT JOIN {user} u ON p.userid = u.id
1755                             WHERE p.id = ?", array($postid));
1758 /**
1759  * Gets posts with all info ready for forum_print_post
1760  * We pass forumid in because we always know it so no need to make a
1761  * complicated join to find it out.
1762  *
1763  * @global object
1764  * @global object
1765  * @return mixed array of posts or false
1766  */
1767 function forum_get_discussion_posts($discussion, $sort, $forumid) {
1768     global $CFG, $DB;
1770     return $DB->get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1771                               FROM {forum_posts} p
1772                          LEFT JOIN {user} u ON p.userid = u.id
1773                              WHERE p.discussion = ?
1774                                AND p.parent > 0 $sort", array($discussion));
1777 /**
1778  * Gets all posts in discussion including top parent.
1779  *
1780  * @global object
1781  * @global object
1782  * @global object
1783  * @param int $discussionid
1784  * @param string $sort
1785  * @param bool $tracking does user track the forum?
1786  * @return array of posts
1787  */
1788 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1789     global $CFG, $DB, $USER;
1791     $tr_sel  = "";
1792     $tr_join = "";
1793     $params = array();
1795     if ($tracking) {
1796         $now = time();
1797         $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
1798         $tr_sel  = ", fr.id AS postread";
1799         $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1800         $params[] = $USER->id;
1801     }
1803     $params[] = $discussionid;
1804     if (!$posts = $DB->get_records_sql("SELECT p.*, u.firstname, u.lastname, u.email, u.picture, u.imagealt $tr_sel
1805                                      FROM {forum_posts} p
1806                                           LEFT JOIN {user} u ON p.userid = u.id
1807                                           $tr_join
1808                                     WHERE p.discussion = ?
1809                                  ORDER BY $sort", $params)) {
1810         return array();
1811     }
1813     foreach ($posts as $pid=>$p) {
1814         if ($tracking) {
1815             if (forum_tp_is_post_old($p)) {
1816                  $posts[$pid]->postread = true;
1817             }
1818         }
1819         if (!$p->parent) {
1820             continue;
1821         }
1822         if (!isset($posts[$p->parent])) {
1823             continue; // parent does not exist??
1824         }
1825         if (!isset($posts[$p->parent]->children)) {
1826             $posts[$p->parent]->children = array();
1827         }
1828         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1829     }
1831     return $posts;
1834 /**
1835  * Gets posts with all info ready for forum_print_post
1836  * We pass forumid in because we always know it so no need to make a
1837  * complicated join to find it out.
1838  *
1839  * @global object
1840  * @global object
1841  * @param int $parent
1842  * @param int $forumid
1843  * @return array
1844  */
1845 function forum_get_child_posts($parent, $forumid) {
1846     global $CFG, $DB;
1848     return $DB->get_records_sql("SELECT p.*, $forumid AS forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
1849                               FROM {forum_posts} p
1850                          LEFT JOIN {user} u ON p.userid = u.id
1851                              WHERE p.parent = ?
1852                           ORDER BY p.created ASC", array($parent));
1855 /**
1856  * An array of forum objects that the user is allowed to read/search through.
1857  *
1858  * @global object
1859  * @global object
1860  * @global object
1861  * @param int $userid
1862  * @param int $courseid if 0, we look for forums throughout the whole site.
1863  * @return array of forum objects, or false if no matches
1864  *         Forum objects have the following attributes:
1865  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1866  *         viewhiddentimedposts
1867  */
1868 function forum_get_readable_forums($userid, $courseid=0) {
1870     global $CFG, $DB, $USER;
1871     require_once($CFG->dirroot.'/course/lib.php');
1873     if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
1874         print_error('notinstalled', 'forum');
1875     }
1877     if ($courseid) {
1878         $courses = $DB->get_records('course', array('id' => $courseid));
1879     } else {
1880         // If no course is specified, then the user can see SITE + his courses.
1881         $courses1 = $DB->get_records('course', array('id' => SITEID));
1882         $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
1883         $courses = array_merge($courses1, $courses2);
1884     }
1885     if (!$courses) {
1886         return array();
1887     }
1889     $readableforums = array();
1891     foreach ($courses as $course) {
1893         $modinfo = get_fast_modinfo($course);
1894         if (is_null($modinfo->groups)) {
1895             $modinfo->groups = groups_get_user_groups($course->id, $userid);
1896         }
1898         if (empty($modinfo->instances['forum'])) {
1899             // hmm, no forums?
1900             continue;
1901         }
1903         $courseforums = $DB->get_records('forum', array('course' => $course->id));
1905         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1906             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1907                 continue;
1908             }
1909             $context = get_context_instance(CONTEXT_MODULE, $cm->id);
1910             $forum = $courseforums[$forumid];
1911             $forum->context = $context;
1912             $forum->cm = $cm;
1914             if (!has_capability('mod/forum:viewdiscussion', $context)) {
1915                 continue;
1916             }
1918          /// group access
1919             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
1920                 if (is_null($modinfo->groups)) {
1921                     $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
1922                 }
1923                 if (isset($modinfo->groups[$cm->groupingid])) {
1924                     $forum->onlygroups = $modinfo->groups[$cm->groupingid];
1925                     $forum->onlygroups[] = -1;
1926                 } else {
1927                     $forum->onlygroups = array(-1);
1928                 }
1929             }
1931         /// hidden timed discussions
1932             $forum->viewhiddentimedposts = true;
1933             if (!empty($CFG->forum_enabletimedposts)) {
1934                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1935                     $forum->viewhiddentimedposts = false;
1936                 }
1937             }
1939         /// qanda access
1940             if ($forum->type == 'qanda'
1941                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1943                 // We need to check whether the user has posted in the qanda forum.
1944                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
1945                                                     // the user is allowed to see in this forum.
1946                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1947                     foreach ($discussionspostedin as $d) {
1948                         $forum->onlydiscussions[] = $d->id;
1949                     }
1950                 }
1951             }
1953             $readableforums[$forum->id] = $forum;
1954         }
1956         unset($modinfo);
1958     } // End foreach $courses
1960     return $readableforums;
1963 /**
1964  * Returns a list of posts found using an array of search terms.
1965  *
1966  * @global object
1967  * @global object
1968  * @global object
1969  * @param array $searchterms array of search terms, e.g. word +word -word
1970  * @param int $courseid if 0, we search through the whole site
1971  * @param int $limitfrom
1972  * @param int $limitnum
1973  * @param int &$totalcount
1974  * @param string $extrasql
1975  * @return array|bool Array of posts found or false
1976  */
1977 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
1978                             &$totalcount, $extrasql='') {
1979     global $CFG, $DB, $USER;
1980     require_once($CFG->libdir.'/searchlib.php');
1982     $forums = forum_get_readable_forums($USER->id, $courseid);
1984     if (count($forums) == 0) {
1985         $totalcount = 0;
1986         return false;
1987     }
1989     $now = round(time(), -2); // db friendly
1991     $fullaccess = array();
1992     $where = array();
1993     $params = array();
1995     foreach ($forums as $forumid => $forum) {
1996         $select = array();
1998         if (!$forum->viewhiddentimedposts) {
1999             $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
2000             $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
2001         }
2003         $cm = $forum->cm;
2004         $context = $forum->context;
2006         if ($forum->type == 'qanda'
2007             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2008             if (!empty($forum->onlydiscussions)) {
2009                 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
2010                 $params = array_merge($params, $discussionid_params);
2011                 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
2012             } else {
2013                 $select[] = "p.parent = 0";
2014             }
2015         }
2017         if (!empty($forum->onlygroups)) {
2018             list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
2019             $params = array_merge($params, $groupid_params);
2020             $select[] = "d.groupid $groupid_sql";
2021         }
2023         if ($select) {
2024             $selects = implode(" AND ", $select);
2025             $where[] = "(d.forum = :forum{$forumid} AND $selects)";
2026             $params['forum'.$forumid] = $forumid;
2027         } else {
2028             $fullaccess[] = $forumid;
2029         }
2030     }
2032     if ($fullaccess) {
2033         list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
2034         $params = array_merge($params, $fullid_params);
2035         $where[] = "(d.forum $fullid_sql)";
2036     }
2038     $selectdiscussion = "(".implode(" OR ", $where).")";
2040     $messagesearch = '';
2041     $searchstring = '';
2043     // Need to concat these back together for parser to work.
2044     foreach($searchterms as $searchterm){
2045         if ($searchstring != '') {
2046             $searchstring .= ' ';
2047         }
2048         $searchstring .= $searchterm;
2049     }
2051     // We need to allow quoted strings for the search. The quotes *should* be stripped
2052     // by the parser, but this should be examined carefully for security implications.
2053     $searchstring = str_replace("\\\"","\"",$searchstring);
2054     $parser = new search_parser();
2055     $lexer = new search_lexer($parser);
2057     if ($lexer->parse($searchstring)) {
2058         $parsearray = $parser->get_parsed_array();
2059     // Experimental feature under 1.8! MDL-8830
2060     // Use alternative text searches if defined
2061     // This feature only works under mysql until properly implemented for other DBs
2062     // Requires manual creation of text index for forum_posts before enabling it:
2063     // CREATE FULLTEXT INDEX foru_post_tix ON [prefix]forum_posts (subject, message)
2064     // Experimental feature under 1.8! MDL-8830
2065         if (!empty($CFG->forum_usetextsearches)) {
2066             list($messagesearch, $msparams) = search_generate_text_SQL($parsearray, 'p.message', 'p.subject',
2067                                                  'p.userid', 'u.id', 'u.firstname',
2068                                                  'u.lastname', 'p.modified', 'd.forum');
2069         } else {
2070             list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2071                                                  'p.userid', 'u.id', 'u.firstname',
2072                                                  'u.lastname', 'p.modified', 'd.forum');
2073         }
2074         $params = array_merge($params, $msparams);
2075     }
2077     $fromsql = "{forum_posts} p,
2078                   {forum_discussions} d,
2079                   {user} u";
2081     $selectsql = " $messagesearch
2082                AND p.discussion = d.id
2083                AND p.userid = u.id
2084                AND $selectdiscussion
2085                    $extrasql";
2087     $countsql = "SELECT COUNT(*)
2088                    FROM $fromsql
2089                   WHERE $selectsql";
2091     $searchsql = "SELECT p.*,
2092                          d.forum,
2093                          u.firstname,
2094                          u.lastname,
2095                          u.email,
2096                          u.picture,
2097                          u.imagealt
2098                     FROM $fromsql
2099                    WHERE $selectsql
2100                 ORDER BY p.modified DESC";
2102     $totalcount = $DB->count_records_sql($countsql, $params);
2104     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2107 /**
2108  * Returns a list of ratings for a particular post - sorted.
2109  *
2110  * TODO: Check if this function is actually used anywhere.
2111  * Up until the fix for MDL-27471 this function wasn't even returning.
2112  *
2113  * @param stdClass $context
2114  * @param int $postid
2115  * @param string $sort
2116  * @return array Array of ratings or false
2117  */
2118 function forum_get_ratings($context, $postid, $sort = "u.firstname ASC") {
2119     $options = new stdClass;
2120     $options->context = $context;
2121     $options->component = 'mod_forum';
2122     $options->ratingarea = 'post';
2123     $options->itemid = $postid;
2124     $options->sort = "ORDER BY $sort";
2126     $rm = new rating_manager();
2127     return $rm->get_all_ratings_for_item($options);
2130 /**
2131  * Returns a list of all new posts that have not been mailed yet
2132  *
2133  * @param int $starttime posts created after this time
2134  * @param int $endtime posts created before this
2135  * @param int $now used for timed discussions only
2136  * @return array
2137  */
2138 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2139     global $CFG, $DB;
2141     $params = array($starttime, $endtime);
2142     if (!empty($CFG->forum_enabletimedposts)) {
2143         if (empty($now)) {
2144             $now = time();
2145         }
2146         $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2147         $params[] = $now;
2148         $params[] = $now;
2149     } else {
2150         $timedsql = "";
2151     }
2153     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2154                               FROM {forum_posts} p
2155                                    JOIN {forum_discussions} d ON d.id = p.discussion
2156                              WHERE p.mailed = 0
2157                                    AND p.created >= ?
2158                                    AND (p.created < ? OR p.mailnow = 1)
2159                                    $timedsql
2160                           ORDER BY p.modified ASC", $params);
2163 /**
2164  * Marks posts before a certain time as being mailed already
2165  *
2166  * @global object
2167  * @global object
2168  * @param int $endtime
2169  * @param int $now Defaults to time()
2170  * @return bool
2171  */
2172 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2173     global $CFG, $DB;
2174     if (empty($now)) {
2175         $now = time();
2176     }
2178     if (empty($CFG->forum_enabletimedposts)) {
2179         return $DB->execute("UPDATE {forum_posts}
2180                                SET mailed = '1'
2181                              WHERE (created < ? OR mailnow = 1)
2182                                    AND mailed = 0", array($endtime));
2184     } else {
2185         return $DB->execute("UPDATE {forum_posts}
2186                                SET mailed = '1'
2187                              WHERE discussion NOT IN (SELECT d.id
2188                                                         FROM {forum_discussions} d
2189                                                        WHERE d.timestart > ?)
2190                                    AND (created < ? OR mailnow = 1)
2191                                    AND mailed = 0", array($now, $endtime));
2192     }
2195 /**
2196  * Get all the posts for a user in a forum suitable for forum_print_post
2197  *
2198  * @global object
2199  * @global object
2200  * @uses CONTEXT_MODULE
2201  * @return array
2202  */
2203 function forum_get_user_posts($forumid, $userid) {
2204     global $CFG, $DB;
2206     $timedsql = "";
2207     $params = array($forumid, $userid);
2209     if (!empty($CFG->forum_enabletimedposts)) {
2210         $cm = get_coursemodule_from_instance('forum', $forumid);
2211         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2212             $now = time();
2213             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2214             $params[] = $now;
2215             $params[] = $now;
2216         }
2217     }
2219     return $DB->get_records_sql("SELECT p.*, d.forum, u.firstname, u.lastname, u.email, u.picture, u.imagealt
2220                               FROM {forum} f
2221                                    JOIN {forum_discussions} d ON d.forum = f.id
2222                                    JOIN {forum_posts} p       ON p.discussion = d.id
2223                                    JOIN {user} u              ON u.id = p.userid
2224                              WHERE f.id = ?
2225                                    AND p.userid = ?
2226                                    $timedsql
2227                           ORDER BY p.modified ASC", $params);
2230 /**
2231  * Get all the discussions user participated in
2232  *
2233  * @global object
2234  * @global object
2235  * @uses CONTEXT_MODULE
2236  * @param int $forumid
2237  * @param int $userid
2238  * @return array Array or false
2239  */
2240 function forum_get_user_involved_discussions($forumid, $userid) {
2241     global $CFG, $DB;
2243     $timedsql = "";
2244     $params = array($forumid, $userid);
2245     if (!empty($CFG->forum_enabletimedposts)) {
2246         $cm = get_coursemodule_from_instance('forum', $forumid);
2247         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2248             $now = time();
2249             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2250             $params[] = $now;
2251             $params[] = $now;
2252         }
2253     }
2255     return $DB->get_records_sql("SELECT DISTINCT d.*
2256                               FROM {forum} f
2257                                    JOIN {forum_discussions} d ON d.forum = f.id
2258                                    JOIN {forum_posts} p       ON p.discussion = d.id
2259                              WHERE f.id = ?
2260                                    AND p.userid = ?
2261                                    $timedsql", $params);
2264 /**
2265  * Get all the posts for a user in a forum suitable for forum_print_post
2266  *
2267  * @global object
2268  * @global object
2269  * @param int $forumid
2270  * @param int $userid
2271  * @return array of counts or false
2272  */
2273 function forum_count_user_posts($forumid, $userid) {
2274     global $CFG, $DB;
2276     $timedsql = "";
2277     $params = array($forumid, $userid);
2278     if (!empty($CFG->forum_enabletimedposts)) {
2279         $cm = get_coursemodule_from_instance('forum', $forumid);
2280         if (!has_capability('mod/forum:viewhiddentimedposts' , get_context_instance(CONTEXT_MODULE, $cm->id))) {
2281             $now = time();
2282             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2283             $params[] = $now;
2284             $params[] = $now;
2285         }
2286     }
2288     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2289                              FROM {forum} f
2290                                   JOIN {forum_discussions} d ON d.forum = f.id
2291                                   JOIN {forum_posts} p       ON p.discussion = d.id
2292                                   JOIN {user} u              ON u.id = p.userid
2293                             WHERE f.id = ?
2294                                   AND p.userid = ?
2295                                   $timedsql", $params);
2298 /**
2299  * Given a log entry, return the forum post details for it.
2300  *
2301  * @global object
2302  * @global object
2303  * @param object $log
2304  * @return array|null
2305  */
2306 function forum_get_post_from_log($log) {
2307     global $CFG, $DB;
2309     if ($log->action == "add post") {
2311         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
2312                                            u.firstname, u.lastname, u.email, u.picture
2313                                  FROM {forum_discussions} d,
2314                                       {forum_posts} p,
2315                                       {forum} f,
2316                                       {user} u
2317                                 WHERE p.id = ?
2318                                   AND d.id = p.discussion
2319                                   AND p.userid = u.id
2320                                   AND u.deleted <> '1'
2321                                   AND f.id = d.forum", array($log->info));
2324     } else if ($log->action == "add discussion") {
2326         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
2327                                            u.firstname, u.lastname, u.email, u.picture
2328                                  FROM {forum_discussions} d,
2329                                       {forum_posts} p,
2330                                       {forum} f,
2331                                       {user} u
2332                                 WHERE d.id = ?
2333                                   AND d.firstpost = p.id
2334                                   AND p.userid = u.id
2335                                   AND u.deleted <> '1'
2336                                   AND f.id = d.forum", array($log->info));
2337     }
2338     return NULL;
2341 /**
2342  * Given a discussion id, return the first post from the discussion
2343  *
2344  * @global object
2345  * @global object
2346  * @param int $dicsussionid
2347  * @return array
2348  */
2349 function forum_get_firstpost_from_discussion($discussionid) {
2350     global $CFG, $DB;
2352     return $DB->get_record_sql("SELECT p.*
2353                              FROM {forum_discussions} d,
2354                                   {forum_posts} p
2355                             WHERE d.id = ?
2356                               AND d.firstpost = p.id ", array($discussionid));
2359 /**
2360  * Returns an array of counts of replies to each discussion
2361  *
2362  * @global object
2363  * @global object
2364  * @param int $forumid
2365  * @param string $forumsort
2366  * @param int $limit
2367  * @param int $page
2368  * @param int $perpage
2369  * @return array
2370  */
2371 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2372     global $CFG, $DB;
2374     if ($limit > 0) {
2375         $limitfrom = 0;
2376         $limitnum  = $limit;
2377     } else if ($page != -1) {
2378         $limitfrom = $page*$perpage;
2379         $limitnum  = $perpage;
2380     } else {
2381         $limitfrom = 0;
2382         $limitnum  = 0;
2383     }
2385     if ($forumsort == "") {
2386         $orderby = "";
2387         $groupby = "";
2389     } else {
2390         $orderby = "ORDER BY $forumsort";
2391         $groupby = ", ".strtolower($forumsort);
2392         $groupby = str_replace('desc', '', $groupby);
2393         $groupby = str_replace('asc', '', $groupby);
2394     }
2396     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2397         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2398                   FROM {forum_posts} p
2399                        JOIN {forum_discussions} d ON p.discussion = d.id
2400                  WHERE p.parent > 0 AND d.forum = ?
2401               GROUP BY p.discussion";
2402         return $DB->get_records_sql($sql, array($forumid));
2404     } else {
2405         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2406                   FROM {forum_posts} p
2407                        JOIN {forum_discussions} d ON p.discussion = d.id
2408                  WHERE d.forum = ?
2409               GROUP BY p.discussion $groupby
2410               $orderby";
2411         return $DB->get_records_sql("SELECT * FROM ($sql) sq", array($forumid), $limitfrom, $limitnum);
2412     }
2415 /**
2416  * @global object
2417  * @global object
2418  * @global object
2419  * @staticvar array $cache
2420  * @param object $forum
2421  * @param object $cm
2422  * @param object $course
2423  * @return mixed
2424  */
2425 function forum_count_discussions($forum, $cm, $course) {
2426     global $CFG, $DB, $USER;
2428     static $cache = array();
2430     $now = round(time(), -2); // db cache friendliness
2432     $params = array($course->id);
2434     if (!isset($cache[$course->id])) {
2435         if (!empty($CFG->forum_enabletimedposts)) {
2436             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2437             $params[] = $now;
2438             $params[] = $now;
2439         } else {
2440             $timedsql = "";
2441         }
2443         $sql = "SELECT f.id, COUNT(d.id) as dcount
2444                   FROM {forum} f
2445                        JOIN {forum_discussions} d ON d.forum = f.id
2446                  WHERE f.course = ?
2447                        $timedsql
2448               GROUP BY f.id";
2450         if ($counts = $DB->get_records_sql($sql, $params)) {
2451             foreach ($counts as $count) {
2452                 $counts[$count->id] = $count->dcount;
2453             }
2454             $cache[$course->id] = $counts;
2455         } else {
2456             $cache[$course->id] = array();
2457         }
2458     }
2460     if (empty($cache[$course->id][$forum->id])) {
2461         return 0;
2462     }
2464     $groupmode = groups_get_activity_groupmode($cm, $course);
2466     if ($groupmode != SEPARATEGROUPS) {
2467         return $cache[$course->id][$forum->id];
2468     }
2470     if (has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2471         return $cache[$course->id][$forum->id];
2472     }
2474     require_once($CFG->dirroot.'/course/lib.php');
2476     $modinfo = get_fast_modinfo($course);
2477     if (is_null($modinfo->groups)) {
2478         $modinfo->groups = groups_get_user_groups($course->id, $USER->id);
2479     }
2481     if (array_key_exists($cm->groupingid, $modinfo->groups)) {
2482         $mygroups = $modinfo->groups[$cm->groupingid];
2483     } else {
2484         $mygroups = false; // Will be set below
2485     }
2487     // add all groups posts
2488     if (empty($mygroups)) {
2489         $mygroups = array(-1=>-1);
2490     } else {
2491         $mygroups[-1] = -1;
2492     }
2494     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2495     $params[] = $forum->id;
2497     if (!empty($CFG->forum_enabletimedposts)) {
2498         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2499         $params[] = $now;
2500         $params[] = $now;
2501     } else {
2502         $timedsql = "";
2503     }
2505     $sql = "SELECT COUNT(d.id)
2506               FROM {forum_discussions} d
2507              WHERE d.groupid $mygroups_sql AND d.forum = ?
2508                    $timedsql";
2510     return $DB->get_field_sql($sql, $params);
2513 /**
2514  * How many posts by other users are unrated by a given user in the given discussion?
2515  *
2516  * TODO: Is this function still used anywhere?
2517  *
2518  * @param int $discussionid
2519  * @param int $userid
2520  * @return mixed
2521  */
2522 function forum_count_unrated_posts($discussionid, $userid) {
2523     global $CFG, $DB;
2525     $sql = "SELECT COUNT(*) as num
2526               FROM {forum_posts}
2527              WHERE parent > 0
2528                AND discussion = :discussionid
2529                AND userid <> :userid";
2530     $params = array('discussionid' => $discussionid, 'userid' => $userid);
2531     $posts = $DB->get_record_sql($sql, $params);
2532     if ($posts) {
2533         $sql = "SELECT count(*) as num
2534                   FROM {forum_posts} p,
2535                        {rating} r
2536                  WHERE p.discussion = :discussionid AND
2537                        p.id = r.itemid AND
2538                        r.userid = userid AND
2539                        r.component = 'mod_forum' AND
2540                        r.ratingarea = 'post'";
2541         $rated = $DB->get_record_sql($sql, $params);
2542         if ($rated) {
2543             if ($posts->num > $rated->num) {
2544                 return $posts->num - $rated->num;
2545             } else {
2546                 return 0;    // Just in case there was a counting error
2547             }
2548         } else {
2549             return $posts->num;
2550         }
2551     } else {
2552         return 0;
2553     }
2556 /**
2557  * Get all discussions in a forum
2558  *
2559  * @global object
2560  * @global object
2561  * @global object
2562  * @uses CONTEXT_MODULE
2563  * @uses VISIBLEGROUPS
2564  * @param object $cm
2565  * @param string $forumsort
2566  * @param bool $fullpost
2567  * @param int $unused
2568  * @param int $limit
2569  * @param bool $userlastmodified
2570  * @param int $page
2571  * @param int $perpage
2572  * @return array
2573  */
2574 function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
2575     global $CFG, $DB, $USER;
2577     $timelimit = '';
2579     $now = round(time(), -2);
2580     $params = array($cm->instance);
2582     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2584     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2585         return array();
2586     }
2588     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2590         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2591             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2592             $params[] = $now;
2593             $params[] = $now;
2594             if (isloggedin()) {
2595                 $timelimit .= " OR d.userid = ?";
2596                 $params[] = $USER->id;
2597             }
2598             $timelimit .= ")";
2599         }
2600     }
2602     if ($limit > 0) {
2603         $limitfrom = 0;
2604         $limitnum  = $limit;
2605     } else if ($page != -1) {
2606         $limitfrom = $page*$perpage;
2607         $limitnum  = $perpage;
2608     } else {
2609         $limitfrom = 0;
2610         $limitnum  = 0;
2611     }
2613     $groupmode    = groups_get_activity_groupmode($cm);
2614     $currentgroup = groups_get_activity_group($cm);
2616     if ($groupmode) {
2617         if (empty($modcontext)) {
2618             $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2619         }
2621         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2622             if ($currentgroup) {
2623                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2624                 $params[] = $currentgroup;
2625             } else {
2626                 $groupselect = "";
2627             }
2629         } else {
2630             //seprate groups without access all
2631             if ($currentgroup) {
2632                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2633                 $params[] = $currentgroup;
2634             } else {
2635                 $groupselect = "AND d.groupid = -1";
2636             }
2637         }
2638     } else {
2639         $groupselect = "";
2640     }
2643     if (empty($forumsort)) {
2644         $forumsort = "d.timemodified DESC";
2645     }
2646     if (empty($fullpost)) {
2647         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2648     } else {
2649         $postdata = "p.*";
2650     }
2652     if (empty($userlastmodified)) {  // We don't need to know this
2653         $umfields = "";
2654         $umtable  = "";
2655     } else {
2656         $umfields = ", um.firstname AS umfirstname, um.lastname AS umlastname";
2657         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2658     }
2660     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend,
2661                    u.firstname, u.lastname, u.email, u.picture, u.imagealt $umfields
2662               FROM {forum_discussions} d
2663                    JOIN {forum_posts} p ON p.discussion = d.id
2664                    JOIN {user} u ON p.userid = u.id
2665                    $umtable
2666              WHERE d.forum = ? AND p.parent = 0
2667                    $timelimit $groupselect
2668           ORDER BY $forumsort";
2669     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2672 /**
2673  *
2674  * @global object
2675  * @global object
2676  * @global object
2677  * @uses CONTEXT_MODULE
2678  * @uses VISIBLEGROUPS
2679  * @param object $cm
2680  * @return array
2681  */
2682 function forum_get_discussions_unread($cm) {
2683     global $CFG, $DB, $USER;
2685     $now = round(time(), -2);
2686     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2688     $params = array();
2689     $groupmode    = groups_get_activity_groupmode($cm);
2690     $currentgroup = groups_get_activity_group($cm);
2692     if ($groupmode) {
2693         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2695         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2696             if ($currentgroup) {
2697                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2698                 $params['currentgroup'] = $currentgroup;
2699             } else {
2700                 $groupselect = "";
2701             }
2703         } else {
2704             //separate groups without access all
2705             if ($currentgroup) {
2706                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2707                 $params['currentgroup'] = $currentgroup;
2708             } else {
2709                 $groupselect = "AND d.groupid = -1";
2710             }
2711         }
2712     } else {
2713         $groupselect = "";
2714     }
2716     if (!empty($CFG->forum_enabletimedposts)) {
2717         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2718         $params['now1'] = $now;
2719         $params['now2'] = $now;
2720     } else {
2721         $timedsql = "";
2722     }
2724     $sql = "SELECT d.id, COUNT(p.id) AS unread
2725               FROM {forum_discussions} d
2726                    JOIN {forum_posts} p     ON p.discussion = d.id
2727                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2728              WHERE d.forum = {$cm->instance}
2729                    AND p.modified >= :cutoffdate AND r.id is NULL
2730                    $groupselect
2731                    $timedsql
2732           GROUP BY d.id";
2733     $params['cutoffdate'] = $cutoffdate;
2735     if ($unreads = $DB->get_records_sql($sql, $params)) {
2736         foreach ($unreads as $unread) {
2737             $unreads[$unread->id] = $unread->unread;
2738         }
2739         return $unreads;
2740     } else {
2741         return array();
2742     }
2745 /**
2746  * @global object
2747  * @global object
2748  * @global object
2749  * @uses CONEXT_MODULE
2750  * @uses VISIBLEGROUPS
2751  * @param object $cm
2752  * @return array
2753  */
2754 function forum_get_discussions_count($cm) {
2755     global $CFG, $DB, $USER;
2757     $now = round(time(), -2);
2758     $params = array($cm->instance);
2759     $groupmode    = groups_get_activity_groupmode($cm);
2760     $currentgroup = groups_get_activity_group($cm);
2762     if ($groupmode) {
2763         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2765         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2766             if ($currentgroup) {
2767                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2768                 $params[] = $currentgroup;
2769             } else {
2770                 $groupselect = "";
2771             }
2773         } else {
2774             //seprate groups without access all
2775             if ($currentgroup) {
2776                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2777                 $params[] = $currentgroup;
2778             } else {
2779                 $groupselect = "AND d.groupid = -1";
2780             }
2781         }
2782     } else {
2783         $groupselect = "";
2784     }
2786     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2788     $timelimit = "";
2790     if (!empty($CFG->forum_enabletimedposts)) {
2792         $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
2794         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2795             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2796             $params[] = $now;
2797             $params[] = $now;
2798             if (isloggedin()) {
2799                 $timelimit .= " OR d.userid = ?";
2800                 $params[] = $USER->id;
2801             }
2802             $timelimit .= ")";
2803         }
2804     }
2806     $sql = "SELECT COUNT(d.id)
2807               FROM {forum_discussions} d
2808                    JOIN {forum_posts} p ON p.discussion = d.id
2809              WHERE d.forum = ? AND p.parent = 0
2810                    $groupselect $timelimit";
2812     return $DB->get_field_sql($sql, $params);
2816 /**
2817  * Get all discussions started by a particular user in a course (or group)
2818  * This function no longer used ...
2819  *
2820  * @todo Remove this function if no longer used
2821  * @global object
2822  * @global object
2823  * @param int $courseid
2824  * @param int $userid
2825  * @param int $groupid
2826  * @return array
2827  */
2828 function forum_get_user_discussions($courseid, $userid, $groupid=0) {
2829     global $CFG, $DB;
2830     $params = array($courseid, $userid);
2831     if ($groupid) {
2832         $groupselect = " AND d.groupid = ? ";
2833         $params[] = $groupid;
2834     } else  {
2835         $groupselect = "";
2836     }
2838     return $DB->get_records_sql("SELECT p.*, d.groupid, u.firstname, u.lastname, u.email, u.picture, u.imagealt,
2839                                    f.type as forumtype, f.name as forumname, f.id as forumid
2840                               FROM {forum_discussions} d,
2841                                    {forum_posts} p,
2842                                    {user} u,
2843                                    {forum} f
2844                              WHERE d.course = ?
2845                                AND p.discussion = d.id
2846                                AND p.parent = 0
2847                                AND p.userid = u.id
2848                                AND u.id = ?
2849                                AND d.forum = f.id $groupselect
2850                           ORDER BY p.created DESC", $params);
2853 /**
2854  * Get the list of potential subscribers to a forum.
2855  *
2856  * @param object $forumcontext the forum context.
2857  * @param integer $groupid the id of a group, or 0 for all groups.
2858  * @param string $fields the list of fields to return for each user. As for get_users_by_capability.
2859  * @param string $sort sort order. As for get_users_by_capability.
2860  * @return array list of users.
2861  */
2862 function forum_get_potential_subscribers($forumcontext, $groupid, $fields, $sort) {
2863     global $DB;
2865     // only active enrolled users or everybody on the frontpage
2866     list($esql, $params) = get_enrolled_sql($forumcontext, 'mod/forum:allowforcesubscribe', $groupid, true);
2868     $sql = "SELECT $fields
2869               FROM {user} u
2870               JOIN ($esql) je ON je.id = u.id";
2871     if ($sort) {
2872         $sql = "$sql ORDER BY $sort";
2873     } else {
2874         $sql = "$sql ORDER BY u.lastname ASC, u.firstname ASC";
2875     }
2877     return $DB->get_records_sql($sql, $params);
2880 /**
2881  * Returns list of user objects that are subscribed to this forum
2882  *
2883  * @global object
2884  * @global object
2885  * @param object $course the course
2886  * @param forum $forum the forum
2887  * @param integer $groupid group id, or 0 for all.
2888  * @param object $context the forum context, to save re-fetching it where possible.
2889  * @param string $fields requested user fields (with "u." table prefix)
2890  * @return array list of users.
2891  */
2892 function forum_subscribed_users($course, $forum, $groupid=0, $context = null, $fields = null) {
2893     global $CFG, $DB;
2895     if (empty($fields)) {
2896         $fields ="u.id,
2897                   u.username,
2898                   u.firstname,
2899                   u.lastname,
2900                   u.maildisplay,
2901                   u.mailformat,
2902                   u.maildigest,
2903                   u.imagealt,
2904                   u.email,
2905                   u.emailstop,
2906                   u.city,
2907                   u.country,
2908                   u.lastaccess,
2909                   u.lastlogin,
2910                   u.picture,
2911                   u.timezone,
2912                   u.theme,
2913                   u.lang,
2914                   u.trackforums,
2915                   u.mnethostid";
2916     }
2918     if (empty($context)) {
2919         $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id);
2920         $context = get_context_instance(CONTEXT_MODULE, $cm->id);
2921     }
2923     if (forum_is_forcesubscribed($forum)) {
2924         $results = forum_get_potential_subscribers($context, $groupid, $fields, "u.email ASC");
2926     } else {
2927         // only active enrolled users or everybody on the frontpage
2928         list($esql, $params) = get_enrolled_sql($context, '', $groupid, true);
2929         $params['forumid'] = $forum->id;
2930         $results = $DB->get_records_sql("SELECT $fields
2931                                            FROM {user} u
2932                                            JOIN ($esql) je ON je.id = u.id
2933                                            JOIN {forum_subscriptions} s ON s.userid = u.id
2934                                           WHERE s.forum = :forumid
2935                                        ORDER BY u.email ASC", $params);
2936     }
2938     // Guest user should never be subscribed to a forum.
2939     unset($results[$CFG->siteguest]);
2941     return $results;
2946 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2949 /**
2950  * @global object
2951  * @global object
2952  * @param int $courseid
2953  * @param string $type
2954  */
2955 function forum_get_course_forum($courseid, $type) {
2956 // How to set up special 1-per-course forums
2957     global $CFG, $DB, $OUTPUT;
2959     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
2960         // There should always only be ONE, but with the right combination of
2961         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2962         foreach ($forums as $forum) {
2963             return $forum;   // ie the first one
2964         }
2965     }
2967     // Doesn't exist, so create one now.
2968     $forum = new stdClass();
2969     $forum->course = $courseid;
2970     $forum->type = "$type";
2971     switch ($forum->type) {
2972         case "news":
2973             $forum->name  = get_string("namenews", "forum");
2974             $forum->intro = get_string("intronews", "forum");
2975             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2976             $forum->assessed = 0;
2977             if ($courseid == SITEID) {
2978                 $forum->name  = get_string("sitenews");
2979                 $forum->forcesubscribe = 0;
2980             }
2981             break;
2982         case "social":
2983             $forum->name  = get_string("namesocial", "forum");
2984             $forum->intro = get_string("introsocial", "forum");
2985             $forum->assessed = 0;
2986             $forum->forcesubscribe = 0;
2987             break;
2988         case "blog":
2989             $forum->name = get_string('blogforum', 'forum');
2990             $forum->intro = get_string('introblog', 'forum');
2991             $forum->assessed = 0;
2992             $forum->forcesubscribe = 0;
2993             break;
2994         default:
2995             echo $OUTPUT->notification("That forum type doesn't exist!");
2996             return false;
2997             break;
2998     }
3000     $forum->timemodified = time();
3001     $forum->id = $DB->insert_record("forum", $forum);
3003     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
3004         echo $OUTPUT->notification("Could not find forum module!!");
3005         return false;
3006     }
3007     $mod = new stdClass();
3008     $mod->course = $courseid;
3009     $mod->module = $module->id;
3010     $mod->instance = $forum->id;
3011     $mod->section = 0;
3012     if (! $mod->coursemodule = add_course_module($mod) ) {   // assumes course/lib.php is loaded
3013         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
3014         return false;
3015     }
3016     if (! $sectionid = add_mod_to_section($mod) ) {   // assumes course/lib.php is loaded
3017         echo $OUTPUT->notification("Could not add the new course module to that section");
3018         return false;
3019     }
3020     $DB->set_field("course_modules", "section", $sectionid, array("id" => $mod->coursemodule));
3022     include_once("$CFG->dirroot/course/lib.php");
3023     rebuild_course_cache($courseid);
3025     return $DB->get_record("forum", array("id" => "$forum->id"));
3029 /**
3030  * Given the data about a posting, builds up the HTML to display it and
3031  * returns the HTML in a string.  This is designed for sending via HTML email.
3032  *
3033  * @global object
3034  * @param object $course
3035  * @param object $cm
3036  * @param object $forum
3037  * @param object $discussion
3038  * @param object $post
3039  * @param object $userform
3040  * @param object $userto
3041  * @param bool $ownpost
3042  * @param bool $reply
3043  * @param bool $link
3044  * @param bool $rate
3045  * @param string $footer
3046  * @return string
3047  */
3048 function forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
3049                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
3051     global $CFG, $OUTPUT;
3053     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
3055     if (!isset($userto->viewfullnames[$forum->id])) {
3056         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
3057     } else {
3058         $viewfullnames = $userto->viewfullnames[$forum->id];
3059     }
3061     // add absolute file links
3062     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3064     // format the post body
3065     $options = new stdClass();
3066     $options->para = true;
3067     $formattedtext = format_text($post->message, $post->messageformat, $options, $course->id);
3069     $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
3071     $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
3072     $output .= $OUTPUT->user_picture($userfrom, array('courseid'=>$course->id));
3073     $output .= '</td>';
3075     if ($post->parent) {
3076         $output .= '<td class="topic">';
3077     } else {
3078         $output .= '<td class="topic starter">';
3079     }
3080     $output .= '<div class="subject">'.format_string($post->subject).'</div>';
3082     $fullname = fullname($userfrom, $viewfullnames);
3083     $by = new stdClass();
3084     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
3085     $by->date = userdate($post->modified, '', $userto->timezone);
3086     $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
3088     $output .= '</td></tr>';
3090     $output .= '<tr><td class="left side" valign="top">';
3092     if (isset($userfrom->groups)) {
3093         $groups = $userfrom->groups[$forum->id];
3094     } else {
3095         $groups = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
3096     }
3098     if ($groups) {
3099         $output .= print_group_picture($groups, $course->id, false, true, true);
3100     } else {
3101         $output .= '&nbsp;';
3102     }
3104     $output .= '</td><td class="content">';
3106     $attachments = forum_print_attachments($post, $cm, 'html');
3107     if ($attachments !== '') {
3108         $output .= '<div class="attachments">';
3109         $output .= $attachments;
3110         $output .= '</div>';
3111     }
3113     $output .= $formattedtext;
3115 // Commands
3116     $commands = array();
3118     if ($post->parent) {
3119         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
3120                       $post->discussion.'&amp;parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
3121     }
3123     if ($reply) {
3124         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
3125                       get_string('reply', 'forum').'</a>';
3126     }
3128     $output .= '<div class="commands">';
3129     $output .= implode(' | ', $commands);
3130     $output .= '</div>';
3132 // Context link to post if required
3133     if ($link) {
3134         $output .= '<div class="link">';
3135         $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
3136                      get_string('postincontext', 'forum').'</a>';
3137         $output .= '</div>';
3138     }
3140     if ($footer) {
3141         $output .= '<div class="footer">'.$footer.'</div>';
3142     }
3143     $output .= '</td></tr></table>'."\n\n";
3145     return $output;
3148 /**
3149  * Print a forum post
3150  *
3151  * @global object
3152  * @global object
3153  * @uses FORUM_MODE_THREADED
3154  * @uses PORTFOLIO_FORMAT_PLAINHTML
3155  * @uses PORTFOLIO_FORMAT_FILE
3156  * @uses PORTFOLIO_FORMAT_RICHHTML
3157  * @uses PORTFOLIO_ADD_TEXT_LINK
3158  * @uses CONTEXT_MODULE
3159  * @param object $post The post to print.
3160  * @param object $discussion
3161  * @param object $forum
3162  * @param object $cm
3163  * @param object $course
3164  * @param boolean $ownpost Whether this post belongs to the current user.
3165  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3166  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3167  * @param string $footer Extra stuff to print after the message.
3168  * @param string $highlight Space-separated list of terms to highlight.
3169  * @param int $post_read true, false or -99. If we already know whether this user
3170  *          has read this post, pass that in, otherwise, pass in -99, and this
3171  *          function will work it out.
3172  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3173  *          the current user can't see this post, if this argument is true
3174  *          (the default) then print a dummy 'you can't see this post' post.
3175  *          If false, don't output anything at all.
3176  * @param bool|null $istracked
3177  * @return void
3178  */
3179 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3180                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3181     global $USER, $CFG, $OUTPUT;
3183     require_once($CFG->libdir . '/filelib.php');
3185     // String cache
3186     static $str;
3188     $modcontext = get_context_instance(CONTEXT_MODULE, $cm->id);
3190     $post->course = $course->id;
3191     $post->forum  = $forum->id;
3192     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3194     // caching
3195     if (!isset($cm->cache)) {
3196         $cm->cache = new stdClass;
3197     }
3199     if (!isset($cm->cache->caps)) {
3200         $cm->cache->caps = array();
3201         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3202         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3203         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3204         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3205         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3206         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3207         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3208         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3209         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3210     }
3212     if (!isset($cm->uservisible)) {
3213         $cm->uservisible = coursemodule_visible_for_user($cm);
3214     }
3216     if ($istracked && is_null($postisread)) {
3217         $postisread = forum_tp_is_post_read($USER->id, $post);
3218     }
3220     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
3221         $output = '';
3222         if (!$dummyifcantsee) {
3223             if ($return) {
3224                 return $output;
3225             }
3226             echo $output;
3227             return;
3228         }
3229         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3230         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'));
3231         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3232         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3233         if ($post->parent) {
3234             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3235         } else {
3236             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3237         }
3238         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class'=>'subject')); // Subject
3239         $output .= html_writer::tag('div', get_string('forumauthorhidden','forum'), array('class'=>'author')); // author
3240         $output .= html_writer::end_tag('div');
3241         $output .= html_writer::end_tag('div'); // row
3242         $output .= html_writer::start_tag('div', array('class'=>'row'));
3243         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3244         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3245         $output .= html_writer::end_tag('div'); // row
3246         $output .= html_writer::end_tag('div'); // forumpost
3248         if ($return) {
3249             return $output;
3250         }
3251         echo $output;
3252         return;
3253     }
3255     if (empty($str)) {
3256         $str = new stdClass;
3257         $str->edit         = get_string('edit', 'forum');
3258         $str->delete       = get_string('delete', 'forum');
3259         $str->reply        = get_string('reply', 'forum');
3260         $str->parent       = get_string('parent', 'forum');
3261         $str->pruneheading = get_string('pruneheading', 'forum');
3262         $str->prune        = get_string('prune', 'forum');
3263         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3264         $str->markread     = get_string('markread', 'forum');
3265         $str->markunread   = get_string('markunread', 'forum');
3266     }
3268     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3270     // Build an object that represents the posting user
3271     $postuser = new stdClass;
3272     $postuser->id        = $post->userid;
3273     $postuser->firstname = $post->firstname;
3274     $postuser->lastname  = $post->lastname;
3275     $postuser->imagealt  = $post->imagealt;
3276     $postuser->picture   = $post->picture;
3277     $postuser->email     = $post->email;
3278     // Some handy things for later on
3279     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3280     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3282     // Prepare the groups the posting user belongs to
3283     if (isset($cm->cache->usersgroups)) {
3284         $groups = array();
3285         if (isset($cm->cache->usersgroups[$post->userid])) {
3286             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3287                 $groups[$gid] = $cm->cache->groups[$gid];
3288             }
3289         }
3290     } else {
3291         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3292     }
3294     // Prepare the attachements for the post, files then images
3295     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3297     // Determine if we need to shorten this post
3298     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3301     // Prepare an array of commands
3302     $commands = array();
3304     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3305     // Don't display the mark read / unread controls in this case.
3306     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3307         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3308         $text = $str->markunread;
3309         if (!$postisread) {
3310             $url->param('mark', 'read');
3311             $text = $str->markread;
3312         }
3313         if ($str->displaymode == FORUM_MODE_THREADED) {
3314             $url->param('parent', $post->parent);
3315         } else {
3316             $url->set_anchor('p'.$post->id);
3317         }
3318         $commands[] = array('url'=>$url, 'text'=>$text);
3319     }
3321     // Zoom in to the parent specifically
3322     if ($post->parent) {
3323         $url = new moodle_url($discussionlink);
3324         if ($str->displaymode == FORUM_MODE_THREADED) {
3325             $url->param('parent', $post->parent);
3326         } else {
3327             $url->set_anchor('p'.$post->parent);
3328         }
3329         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3330     }
3332     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3333     $age = time() - $post->created;
3334     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3335         $age = 0;
3336     }
3338     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3339         if (has_capability('moodle/course:manageactivities', $modcontext)) {
3340             // The first post in single simple is the forum description.
3341             $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
3342         }
3343     } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3344         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3345     }
3347     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3348         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3349     }
3351     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3352         // Do not allow deleting of first post in single simple type.
3353     } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3354         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3355     }
3357     if ($reply) {
3358         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mform1', array('reply'=>$post->id)), 'text'=>$str->reply);
3359     }
3361     if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
3362         $p = array('postid' => $post->id);
3363         require_once($CFG->libdir.'/portfoliolib.php');
3364         $button = new portfolio_add_button();
3365         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), '/mod/forum/locallib.php');
3366         if (empty($attachments)) {
3367             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3368         } else {
3369             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3370         }
3372         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3373         if (!empty($porfoliohtml)) {
3374             $commands[] = $porfoliohtml;
3375         }
3376     }
3377     // Finished building commands
3380     // Begin output
3382     $output  = '';
3384     if ($istracked) {
3385         if ($postisread) {
3386             $forumpostclass = ' read';
3387         } else {
3388             $forumpostclass = ' unread';
3389             $output .= html_writer::tag('a', '', array('name'=>'unread'));
3390         }
3391     } else {
3392         // ignore trackign status if not tracked or tracked param missing
3393         $forumpostclass = '';
3394     }
3396     $topicclass = '';
3397     if (empty($post->parent)) {
3398         $topicclass = ' firstpost starter';
3399     }
3401     $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3402     $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass));
3403     $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
3404     $output .= html_writer::start_tag('div', array('class'=>'left picture'));
3405     $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
3406     $output .= html_writer::end_tag('div');
3409     $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
3411     $postsubject = $post->subject;
3412     if (empty($post->subjectnoformat)) {
3413         $postsubject = format_string($postsubject);
3414     }
3415     $output .= html_writer::tag('div', $postsubject, array('class'=>'subject'));
3417     $by = new stdClass();
3418     $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
3419     $by->date = userdate($post->modified);
3420     $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author'));
3422     $output .= html_writer::end_tag('div'); //topic
3423     $output .= html_writer::end_tag('div'); //row
3425     $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
3426     $output .= html_writer::start_tag('div', array('class'=>'left'));
3428     $groupoutput = '';
3429     if ($groups) {
3430         $groupoutput = print_group_picture($groups, $course->id, false, true, true);
3431     }
3432     if (empty($groupoutput)) {
3433         $groupoutput = '&nbsp;';
3434     }
3435     $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
3437     $output .= html_writer::end_tag('div'); //left side
3438     $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
3439     $output .= html_writer::start_tag('div', array('class'=>'content'));
3440     if (!empty($attachments)) {
3441         $output .= html_writer::tag('div', $attachments, array('class'=>'attachments'));
3442     }
3444     $options = new stdClass;
3445     $options->para    = false;
3446     $options->trusted = $post->messagetrust;
3447     $options->context = $modcontext;
3448     if ($shortenpost) {
3449         // Prepare shortened version
3450         $postclass    = 'shortenedpost';
3451         $postcontent  = format_text(forum_shorten_post($post->message), $post->messageformat, $options, $course->id);
3452         $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
3453         $postcontent .= html_writer::tag('span', '('.get_string('numwords', 'moodle', count_words(strip_tags($post->message))).')...', array('class'=>'post-word-count'));
3454     } else {
3455         // Prepare whole post
3456         $postclass    = 'fullpost';
3457         $postcontent  = format_text($post->message, $post->messageformat, $options, $course->id);
3458         if (!empty($highlight)) {
3459             $postcontent = highlight($highlight, $postcontent);
3460         }
3461         $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
3462     }
3463     // Output the post content
3464     $output .= html_writer::tag('div', $postcontent, array('class'=>'posting '.$postclass));
3465     $output .= html_writer::end_tag('div'); // Content
3466     $output .= html_writer::end_tag('div'); // Content mask
3467     $output .= html_writer::end_tag('div'); // Row
3469     $output .= html_writer::start_tag('div', array('class'=>'row side'));
3470     $output .= html_writer::tag('div','&nbsp;', array('class'=>'left'));
3471     $output .= html_writer::start_tag('div', array('class'=>'options clearfix'));
3473     // Output ratings
3474     if (!empty($post->rating)) {
3475         $output .= html_writer::tag('div', $OUTPUT->render($post->rating), array('class'=>'forum-post-rating'));
3476     }
3478     // Output the commands
3479     $commandhtml = array();
3480     foreach ($commands as $command) {
3481         if (is_array($command)) {
3482             $commandhtml[] = html_writer::link($command['url'], $command['text']);
3483         } else {
3484             $commandhtml[] = $command;
3485         }
3486     }
3487     $output .= html_writer::tag('div', implode(' | ', $commandhtml), array('class'=>'commands'));
3489     // Output link to post if required
3490     if ($link) {