Merge branch 'MDL-53702_master' of https://github.com/liorgil/moodle
[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_forum
19  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
20  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21  */
23 defined('MOODLE_INTERNAL') || die();
25 /** Include required files */
26 require_once(__DIR__ . '/deprecatedlib.php');
27 require_once($CFG->libdir.'/filelib.php');
28 require_once($CFG->libdir.'/eventslib.php');
30 /// CONSTANTS ///////////////////////////////////////////////////////////
32 define('FORUM_MODE_FLATOLDEST', 1);
33 define('FORUM_MODE_FLATNEWEST', -1);
34 define('FORUM_MODE_THREADED', 2);
35 define('FORUM_MODE_NESTED', 3);
37 define('FORUM_CHOOSESUBSCRIBE', 0);
38 define('FORUM_FORCESUBSCRIBE', 1);
39 define('FORUM_INITIALSUBSCRIBE', 2);
40 define('FORUM_DISALLOWSUBSCRIBE',3);
42 /**
43  * FORUM_TRACKING_OFF - Tracking is not available for this forum.
44  */
45 define('FORUM_TRACKING_OFF', 0);
47 /**
48  * FORUM_TRACKING_OPTIONAL - Tracking is based on user preference.
49  */
50 define('FORUM_TRACKING_OPTIONAL', 1);
52 /**
53  * FORUM_TRACKING_FORCED - Tracking is on, regardless of user setting.
54  * Treated as FORUM_TRACKING_OPTIONAL if $CFG->forum_allowforcedreadtracking is off.
55  */
56 define('FORUM_TRACKING_FORCED', 2);
58 define('FORUM_MAILED_PENDING', 0);
59 define('FORUM_MAILED_SUCCESS', 1);
60 define('FORUM_MAILED_ERROR', 2);
62 if (!defined('FORUM_CRON_USER_CACHE')) {
63     /** Defines how many full user records are cached in forum cron. */
64     define('FORUM_CRON_USER_CACHE', 5000);
65 }
67 /**
68  * FORUM_POSTS_ALL_USER_GROUPS - All the posts in groups where the user is enrolled.
69  */
70 define('FORUM_POSTS_ALL_USER_GROUPS', -2);
72 define('FORUM_DISCUSSION_PINNED', 1);
73 define('FORUM_DISCUSSION_UNPINNED', 0);
75 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
77 /**
78  * Given an object containing all the necessary data,
79  * (defined by the form in mod_form.php) this function
80  * will create a new instance and return the id number
81  * of the new instance.
82  *
83  * @param stdClass $forum add forum instance
84  * @param mod_forum_mod_form $mform
85  * @return int intance id
86  */
87 function forum_add_instance($forum, $mform = null) {
88     global $CFG, $DB;
90     $forum->timemodified = time();
92     if (empty($forum->assessed)) {
93         $forum->assessed = 0;
94     }
96     if (empty($forum->ratingtime) or empty($forum->assessed)) {
97         $forum->assesstimestart  = 0;
98         $forum->assesstimefinish = 0;
99     }
101     $forum->id = $DB->insert_record('forum', $forum);
102     $modcontext = context_module::instance($forum->coursemodule);
104     if ($forum->type == 'single') {  // Create related discussion.
105         $discussion = new stdClass();
106         $discussion->course        = $forum->course;
107         $discussion->forum         = $forum->id;
108         $discussion->name          = $forum->name;
109         $discussion->assessed      = $forum->assessed;
110         $discussion->message       = $forum->intro;
111         $discussion->messageformat = $forum->introformat;
112         $discussion->messagetrust  = trusttext_trusted(context_course::instance($forum->course));
113         $discussion->mailnow       = false;
114         $discussion->groupid       = -1;
116         $message = '';
118         $discussion->id = forum_add_discussion($discussion, null, $message);
120         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
121             // Ugly hack - we need to copy the files somehow.
122             $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
123             $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
125             $options = array('subdirs'=>true); // Use the same options as intro field!
126             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
127             $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
128         }
129     }
131     forum_grade_item_update($forum);
133     return $forum->id;
136 /**
137  * Handle changes following the creation of a forum instance.
138  * This function is typically called by the course_module_created observer.
139  *
140  * @param object $context the forum context
141  * @param stdClass $forum The forum object
142  * @return void
143  */
144 function forum_instance_created($context, $forum) {
145     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
146         $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email');
147         foreach ($users as $user) {
148             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context);
149         }
150     }
153 /**
154  * Given an object containing all the necessary data,
155  * (defined by the form in mod_form.php) this function
156  * will update an existing instance with new data.
157  *
158  * @global object
159  * @param object $forum forum instance (with magic quotes)
160  * @return bool success
161  */
162 function forum_update_instance($forum, $mform) {
163     global $DB, $OUTPUT, $USER;
165     $forum->timemodified = time();
166     $forum->id           = $forum->instance;
168     if (empty($forum->assessed)) {
169         $forum->assessed = 0;
170     }
172     if (empty($forum->ratingtime) or empty($forum->assessed)) {
173         $forum->assesstimestart  = 0;
174         $forum->assesstimefinish = 0;
175     }
177     $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
179     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
180     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
181     // 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
182     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
183         forum_update_grades($forum); // recalculate grades for the forum
184     }
186     if ($forum->type == 'single') {  // Update related discussion and post.
187         $discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC');
188         if (!empty($discussions)) {
189             if (count($discussions) > 1) {
190                 echo $OUTPUT->notification(get_string('warnformorepost', 'forum'));
191             }
192             $discussion = array_pop($discussions);
193         } else {
194             // try to recover by creating initial discussion - MDL-16262
195             $discussion = new stdClass();
196             $discussion->course          = $forum->course;
197             $discussion->forum           = $forum->id;
198             $discussion->name            = $forum->name;
199             $discussion->assessed        = $forum->assessed;
200             $discussion->message         = $forum->intro;
201             $discussion->messageformat   = $forum->introformat;
202             $discussion->messagetrust    = true;
203             $discussion->mailnow         = false;
204             $discussion->groupid         = -1;
206             $message = '';
208             forum_add_discussion($discussion, null, $message);
210             if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
211                 print_error('cannotadd', 'forum');
212             }
213         }
214         if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
215             print_error('cannotfindfirstpost', 'forum');
216         }
218         $cm         = get_coursemodule_from_instance('forum', $forum->id);
219         $modcontext = context_module::instance($cm->id, MUST_EXIST);
221         $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
222         $post->subject       = $forum->name;
223         $post->message       = $forum->intro;
224         $post->messageformat = $forum->introformat;
225         $post->messagetrust  = trusttext_trusted($modcontext);
226         $post->modified      = $forum->timemodified;
227         $post->userid        = $USER->id;    // MDL-18599, so that current teacher can take ownership of activities.
229         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
230             // Ugly hack - we need to copy the files somehow.
231             $options = array('subdirs'=>true); // Use the same options as intro field!
232             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
233         }
235         $DB->update_record('forum_posts', $post);
236         $discussion->name = $forum->name;
237         $DB->update_record('forum_discussions', $discussion);
238     }
240     $DB->update_record('forum', $forum);
242     $modcontext = context_module::instance($forum->coursemodule);
243     if (($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) && ($oldforum->forcesubscribe <> $forum->forcesubscribe)) {
244         $users = \mod_forum\subscriptions::get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
245         foreach ($users as $user) {
246             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $modcontext);
247         }
248     }
250     forum_grade_item_update($forum);
252     return true;
256 /**
257  * Given an ID of an instance of this module,
258  * this function will permanently delete the instance
259  * and any data that depends on it.
260  *
261  * @global object
262  * @param int $id forum instance id
263  * @return bool success
264  */
265 function forum_delete_instance($id) {
266     global $DB;
268     if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
269         return false;
270     }
271     if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
272         return false;
273     }
274     if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
275         return false;
276     }
278     $context = context_module::instance($cm->id);
280     // now get rid of all files
281     $fs = get_file_storage();
282     $fs->delete_area_files($context->id);
284     $result = true;
286     // Delete digest and subscription preferences.
287     $DB->delete_records('forum_digests', array('forum' => $forum->id));
288     $DB->delete_records('forum_subscriptions', array('forum'=>$forum->id));
289     $DB->delete_records('forum_discussion_subs', array('forum' => $forum->id));
291     if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
292         foreach ($discussions as $discussion) {
293             if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
294                 $result = false;
295             }
296         }
297     }
299     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
301     if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
302         $result = false;
303     }
305     forum_grade_item_delete($forum);
307     return $result;
311 /**
312  * Indicates API features that the forum supports.
313  *
314  * @uses FEATURE_GROUPS
315  * @uses FEATURE_GROUPINGS
316  * @uses FEATURE_MOD_INTRO
317  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
318  * @uses FEATURE_COMPLETION_HAS_RULES
319  * @uses FEATURE_GRADE_HAS_GRADE
320  * @uses FEATURE_GRADE_OUTCOMES
321  * @param string $feature
322  * @return mixed True if yes (some features may use other values)
323  */
324 function forum_supports($feature) {
325     switch($feature) {
326         case FEATURE_GROUPS:                  return true;
327         case FEATURE_GROUPINGS:               return true;
328         case FEATURE_MOD_INTRO:               return true;
329         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
330         case FEATURE_COMPLETION_HAS_RULES:    return true;
331         case FEATURE_GRADE_HAS_GRADE:         return true;
332         case FEATURE_GRADE_OUTCOMES:          return true;
333         case FEATURE_RATE:                    return true;
334         case FEATURE_BACKUP_MOODLE2:          return true;
335         case FEATURE_SHOW_DESCRIPTION:        return true;
336         case FEATURE_PLAGIARISM:              return true;
338         default: return null;
339     }
343 /**
344  * Obtains the automatic completion state for this forum based on any conditions
345  * in forum settings.
346  *
347  * @global object
348  * @global object
349  * @param object $course Course
350  * @param object $cm Course-module
351  * @param int $userid User ID
352  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
353  * @return bool True if completed, false if not. (If no conditions, then return
354  *   value depends on comparison type)
355  */
356 function forum_get_completion_state($course,$cm,$userid,$type) {
357     global $CFG,$DB;
359     // Get forum details
360     if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
361         throw new Exception("Can't find forum {$cm->instance}");
362     }
364     $result=$type; // Default return value
366     $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
367     $postcountsql="
368 SELECT
369     COUNT(1)
370 FROM
371     {forum_posts} fp
372     INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
373 WHERE
374     fp.userid=:userid AND fd.forum=:forumid";
376     if ($forum->completiondiscussions) {
377         $value = $forum->completiondiscussions <=
378                  $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
379         if ($type == COMPLETION_AND) {
380             $result = $result && $value;
381         } else {
382             $result = $result || $value;
383         }
384     }
385     if ($forum->completionreplies) {
386         $value = $forum->completionreplies <=
387                  $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
388         if ($type==COMPLETION_AND) {
389             $result = $result && $value;
390         } else {
391             $result = $result || $value;
392         }
393     }
394     if ($forum->completionposts) {
395         $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
396         if ($type == COMPLETION_AND) {
397             $result = $result && $value;
398         } else {
399             $result = $result || $value;
400         }
401     }
403     return $result;
406 /**
407  * Create a message-id string to use in the custom headers of forum notification emails
408  *
409  * message-id is used by email clients to identify emails and to nest conversations
410  *
411  * @param int $postid The ID of the forum post we are notifying the user about
412  * @param int $usertoid The ID of the user being notified
413  * @return string A unique message-id
414  */
415 function forum_get_email_message_id($postid, $usertoid) {
416     return generate_email_messageid(hash('sha256', $postid . 'to' . $usertoid));
419 /**
420  * Removes properties from user record that are not necessary
421  * for sending post notifications.
422  * @param stdClass $user
423  * @return void, $user parameter is modified
424  */
425 function forum_cron_minimise_user_record(stdClass $user) {
427     // We store large amount of users in one huge array,
428     // make sure we do not store info there we do not actually need
429     // in mail generation code or messaging.
431     unset($user->institution);
432     unset($user->department);
433     unset($user->address);
434     unset($user->city);
435     unset($user->url);
436     unset($user->currentlogin);
437     unset($user->description);
438     unset($user->descriptionformat);
441 /**
442  * Function to be run periodically according to the scheduled task.
443  *
444  * Finds all posts that have yet to be mailed out, and mails them
445  * out to all subscribers as well as other maintance tasks.
446  *
447  * NOTE: Since 2.7.2 this function is run by scheduled task rather
448  * than standard cron.
449  *
450  * @todo MDL-44734 The function will be split up into seperate tasks.
451  */
452 function forum_cron() {
453     global $CFG, $USER, $DB, $PAGE;
455     $site = get_site();
457     // The main renderers.
458     $htmlout = $PAGE->get_renderer('mod_forum', 'email', 'htmlemail');
459     $textout = $PAGE->get_renderer('mod_forum', 'email', 'textemail');
460     $htmldigestfullout = $PAGE->get_renderer('mod_forum', 'emaildigestfull', 'htmlemail');
461     $textdigestfullout = $PAGE->get_renderer('mod_forum', 'emaildigestfull', 'textemail');
462     $htmldigestbasicout = $PAGE->get_renderer('mod_forum', 'emaildigestbasic', 'htmlemail');
463     $textdigestbasicout = $PAGE->get_renderer('mod_forum', 'emaildigestbasic', 'textemail');
465     // All users that are subscribed to any post that needs sending,
466     // please increase $CFG->extramemorylimit on large sites that
467     // send notifications to a large number of users.
468     $users = array();
469     $userscount = 0; // Cached user counter - count($users) in PHP is horribly slow!!!
471     // Status arrays.
472     $mailcount  = array();
473     $errorcount = array();
475     // caches
476     $discussions        = array();
477     $forums             = array();
478     $courses            = array();
479     $coursemodules      = array();
480     $subscribedusers    = array();
481     $messageinboundhandlers = array();
483     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
484     // cron has not been running for a long time, and then suddenly people are flooded
485     // with mail from the past few weeks or months
486     $timenow   = time();
487     $endtime   = $timenow - $CFG->maxeditingtime;
488     $starttime = $endtime - 48 * 3600;   // Two days earlier
490     // Get the list of forum subscriptions for per-user per-forum maildigest settings.
491     $digestsset = $DB->get_recordset('forum_digests', null, '', 'id, userid, forum, maildigest');
492     $digests = array();
493     foreach ($digestsset as $thisrow) {
494         if (!isset($digests[$thisrow->forum])) {
495             $digests[$thisrow->forum] = array();
496         }
497         $digests[$thisrow->forum][$thisrow->userid] = $thisrow->maildigest;
498     }
499     $digestsset->close();
501     // Create the generic messageinboundgenerator.
502     $messageinboundgenerator = new \core\message\inbound\address_manager();
503     $messageinboundgenerator->set_handler('\mod_forum\message\inbound\reply_handler');
505     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
506         // Mark them all now as being mailed.  It's unlikely but possible there
507         // might be an error later so that a post is NOT actually mailed out,
508         // but since mail isn't crucial, we can accept this risk.  Doing it now
509         // prevents the risk of duplicated mails, which is a worse problem.
511         if (!forum_mark_old_posts_as_mailed($endtime)) {
512             mtrace('Errors occurred while trying to mark some posts as being mailed.');
513             return false;  // Don't continue trying to mail them, in case we are in a cron loop
514         }
516         // checking post validity, and adding users to loop through later
517         foreach ($posts as $pid => $post) {
519             $discussionid = $post->discussion;
520             if (!isset($discussions[$discussionid])) {
521                 if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
522                     $discussions[$discussionid] = $discussion;
523                     \mod_forum\subscriptions::fill_subscription_cache($discussion->forum);
524                     \mod_forum\subscriptions::fill_discussion_subscription_cache($discussion->forum);
526                 } else {
527                     mtrace('Could not find discussion ' . $discussionid);
528                     unset($posts[$pid]);
529                     continue;
530                 }
531             }
532             $forumid = $discussions[$discussionid]->forum;
533             if (!isset($forums[$forumid])) {
534                 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
535                     $forums[$forumid] = $forum;
536                 } else {
537                     mtrace('Could not find forum '.$forumid);
538                     unset($posts[$pid]);
539                     continue;
540                 }
541             }
542             $courseid = $forums[$forumid]->course;
543             if (!isset($courses[$courseid])) {
544                 if ($course = $DB->get_record('course', array('id' => $courseid))) {
545                     $courses[$courseid] = $course;
546                 } else {
547                     mtrace('Could not find course '.$courseid);
548                     unset($posts[$pid]);
549                     continue;
550                 }
551             }
552             if (!isset($coursemodules[$forumid])) {
553                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
554                     $coursemodules[$forumid] = $cm;
555                 } else {
556                     mtrace('Could not find course module for forum '.$forumid);
557                     unset($posts[$pid]);
558                     continue;
559                 }
560             }
562             // Save the Inbound Message datakey here to reduce DB queries later.
563             $messageinboundgenerator->set_data($pid);
564             $messageinboundhandlers[$pid] = $messageinboundgenerator->fetch_data_key();
566             // Caching subscribed users of each forum.
567             if (!isset($subscribedusers[$forumid])) {
568                 $modcontext = context_module::instance($coursemodules[$forumid]->id);
569                 if ($subusers = \mod_forum\subscriptions::fetch_subscribed_users($forums[$forumid], 0, $modcontext, 'u.*', true)) {
571                     foreach ($subusers as $postuser) {
572                         // this user is subscribed to this forum
573                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
574                         $userscount++;
575                         if ($userscount > FORUM_CRON_USER_CACHE) {
576                             // Store minimal user info.
577                             $minuser = new stdClass();
578                             $minuser->id = $postuser->id;
579                             $users[$postuser->id] = $minuser;
580                         } else {
581                             // Cache full user record.
582                             forum_cron_minimise_user_record($postuser);
583                             $users[$postuser->id] = $postuser;
584                         }
585                     }
586                     // Release memory.
587                     unset($subusers);
588                     unset($postuser);
589                 }
590             }
591             $mailcount[$pid] = 0;
592             $errorcount[$pid] = 0;
593         }
594     }
596     if ($users && $posts) {
598         foreach ($users as $userto) {
599             // Terminate if processing of any account takes longer than 2 minutes.
600             core_php_time_limit::raise(120);
602             mtrace('Processing user ' . $userto->id);
604             // Init user caches - we keep the cache for one cycle only, otherwise it could consume too much memory.
605             if (isset($userto->username)) {
606                 $userto = clone($userto);
607             } else {
608                 $userto = $DB->get_record('user', array('id' => $userto->id));
609                 forum_cron_minimise_user_record($userto);
610             }
611             $userto->viewfullnames = array();
612             $userto->canpost       = array();
613             $userto->markposts     = array();
615             // Setup this user so that the capabilities are cached, and environment matches receiving user.
616             cron_setup_user($userto);
618             // Reset the caches.
619             foreach ($coursemodules as $forumid => $unused) {
620                 $coursemodules[$forumid]->cache       = new stdClass();
621                 $coursemodules[$forumid]->cache->caps = array();
622                 unset($coursemodules[$forumid]->uservisible);
623             }
625             foreach ($posts as $pid => $post) {
626                 $discussion = $discussions[$post->discussion];
627                 $forum      = $forums[$discussion->forum];
628                 $course     = $courses[$forum->course];
629                 $cm         =& $coursemodules[$forum->id];
631                 // Do some checks to see if we can bail out now.
633                 // Only active enrolled users are in the list of subscribers.
634                 // This does not necessarily mean that the user is subscribed to the forum or to the discussion though.
635                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
636                     // The user does not subscribe to this forum.
637                     continue;
638                 }
640                 if (!\mod_forum\subscriptions::is_subscribed($userto->id, $forum, $post->discussion, $coursemodules[$forum->id])) {
641                     // The user does not subscribe to this forum, or to this specific discussion.
642                     continue;
643                 }
645                 if ($subscriptiontime = \mod_forum\subscriptions::fetch_discussion_subscription($forum->id, $userto->id)) {
646                     // Skip posts if the user subscribed to the discussion after it was created.
647                     if (isset($subscriptiontime[$post->discussion]) && ($subscriptiontime[$post->discussion] > $post->created)) {
648                         continue;
649                     }
650                 }
652                 // Don't send email if the forum is Q&A and the user has not posted.
653                 // Initial topics are still mailed.
654                 if ($forum->type == 'qanda' && !forum_get_user_posted_time($discussion->id, $userto->id) && $pid != $discussion->firstpost) {
655                     mtrace('Did not email ' . $userto->id.' because user has not posted in discussion');
656                     continue;
657                 }
659                 // Get info about the sending user.
660                 if (array_key_exists($post->userid, $users)) {
661                     // We might know the user already.
662                     $userfrom = $users[$post->userid];
663                     if (!isset($userfrom->idnumber)) {
664                         // Minimalised user info, fetch full record.
665                         $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
666                         forum_cron_minimise_user_record($userfrom);
667                     }
669                 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
670                     forum_cron_minimise_user_record($userfrom);
671                     // Fetch only once if possible, we can add it to user list, it will be skipped anyway.
672                     if ($userscount <= FORUM_CRON_USER_CACHE) {
673                         $userscount++;
674                         $users[$userfrom->id] = $userfrom;
675                     }
676                 } else {
677                     mtrace('Could not find user ' . $post->userid . ', author of post ' . $post->id . '. Unable to send message.');
678                     continue;
679                 }
681                 // Note: If we want to check that userto and userfrom are not the same person this is probably the spot to do it.
683                 // Setup global $COURSE properly - needed for roles and languages.
684                 cron_setup_user($userto, $course);
686                 // Fill caches.
687                 if (!isset($userto->viewfullnames[$forum->id])) {
688                     $modcontext = context_module::instance($cm->id);
689                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
690                 }
691                 if (!isset($userto->canpost[$discussion->id])) {
692                     $modcontext = context_module::instance($cm->id);
693                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
694                 }
695                 if (!isset($userfrom->groups[$forum->id])) {
696                     if (!isset($userfrom->groups)) {
697                         $userfrom->groups = array();
698                         if (isset($users[$userfrom->id])) {
699                             $users[$userfrom->id]->groups = array();
700                         }
701                     }
702                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
703                     if (isset($users[$userfrom->id])) {
704                         $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
705                     }
706                 }
708                 // Make sure groups allow this user to see this email.
709                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {
710                     // Groups are being used.
711                     if (!groups_group_exists($discussion->groupid)) {
712                         // Can't find group - be safe and don't this message.
713                         continue;
714                     }
716                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
717                         // Do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS.
718                         continue;
719                     }
720                 }
722                 // Make sure we're allowed to see the post.
723                 if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
724                     mtrace('User ' . $userto->id .' can not see ' . $post->id . '. Not sending message.');
725                     continue;
726                 }
728                 // OK so we need to send the email.
730                 // Does the user want this post in a digest?  If so postpone it for now.
731                 $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
733                 if ($maildigest > 0) {
734                     // This user wants the mails to be in digest form.
735                     $queue = new stdClass();
736                     $queue->userid       = $userto->id;
737                     $queue->discussionid = $discussion->id;
738                     $queue->postid       = $post->id;
739                     $queue->timemodified = $post->created;
740                     $DB->insert_record('forum_queue', $queue);
741                     continue;
742                 }
744                 // Prepare to actually send the post now, and build up the content.
746                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
748                 $userfrom->customheaders = array (
749                     // Headers to make emails easier to track.
750                     'List-Id: "'        . $cleanforumname . '" ' . generate_email_messageid('moodleforum' . $forum->id),
751                     'List-Help: '       . $CFG->wwwroot . '/mod/forum/view.php?f=' . $forum->id,
752                     'Message-ID: '      . forum_get_email_message_id($post->id, $userto->id),
753                     'X-Course-Id: '     . $course->id,
754                     'X-Course-Name: '   . format_string($course->fullname, true),
756                     // Headers to help prevent auto-responders.
757                     'Precedence: Bulk',
758                     'X-Auto-Response-Suppress: All',
759                     'Auto-Submitted: auto-generated',
760                 );
762                 $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
764                 // Generate a reply-to address from using the Inbound Message handler.
765                 $replyaddress = null;
766                 if ($userto->canpost[$discussion->id] && array_key_exists($post->id, $messageinboundhandlers)) {
767                     $messageinboundgenerator->set_data($post->id, $messageinboundhandlers[$post->id]);
768                     $replyaddress = $messageinboundgenerator->generate($userto->id);
769                 }
771                 if (!isset($userto->canpost[$discussion->id])) {
772                     $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
773                 } else {
774                     $canreply = $userto->canpost[$discussion->id];
775                 }
777                 $data = new \mod_forum\output\forum_post_email(
778                         $course,
779                         $cm,
780                         $forum,
781                         $discussion,
782                         $post,
783                         $userfrom,
784                         $userto,
785                         $canreply
786                     );
788                 $userfrom->customheaders[] = sprintf('List-Unsubscribe: <%s>',
789                     $data->get_unsubscribediscussionlink());
791                 if (!isset($userto->viewfullnames[$forum->id])) {
792                     $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
793                 } else {
794                     $data->viewfullnames = $userto->viewfullnames[$forum->id];
795                 }
797                 // Not all of these variables are used in the default language
798                 // string but are made available to support custom subjects.
799                 $a = new stdClass();
800                 $a->subject = $data->get_subject();
801                 $a->forumname = $cleanforumname;
802                 $a->sitefullname = format_string($site->fullname);
803                 $a->siteshortname = format_string($site->shortname);
804                 $a->courseidnumber = $data->get_courseidnumber();
805                 $a->coursefullname = $data->get_coursefullname();
806                 $a->courseshortname = $data->get_coursename();
807                 $postsubject = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
809                 $rootid = forum_get_email_message_id($discussion->firstpost, $userto->id);
811                 if ($post->parent) {
812                     // This post is a reply, so add reply header (RFC 2822).
813                     $parentid = forum_get_email_message_id($post->parent, $userto->id);
814                     $userfrom->customheaders[] = "In-Reply-To: $parentid";
816                     // If the post is deeply nested we also reference the parent message id and
817                     // the root message id (if different) to aid threading when parts of the email
818                     // conversation have been deleted (RFC1036).
819                     if ($post->parent != $discussion->firstpost) {
820                         $userfrom->customheaders[] = "References: $rootid $parentid";
821                     } else {
822                         $userfrom->customheaders[] = "References: $parentid";
823                     }
824                 }
826                 // MS Outlook / Office uses poorly documented and non standard headers, including
827                 // Thread-Topic which overrides the Subject and shouldn't contain Re: or Fwd: etc.
828                 $a->subject = $discussion->name;
829                 $threadtopic = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
830                 $userfrom->customheaders[] = "Thread-Topic: $threadtopic";
831                 $userfrom->customheaders[] = "Thread-Index: " . substr($rootid, 1, 28);
833                 // Send the post now!
834                 mtrace('Sending ', '');
836                 $eventdata = new \core\message\message();
837                 $eventdata->component           = 'mod_forum';
838                 $eventdata->name                = 'posts';
839                 $eventdata->userfrom            = $userfrom;
840                 $eventdata->userto              = $userto;
841                 $eventdata->subject             = $postsubject;
842                 $eventdata->fullmessage         = $textout->render($data);
843                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
844                 $eventdata->fullmessagehtml     = $htmlout->render($data);
845                 $eventdata->notification        = 1;
846                 $eventdata->replyto             = $replyaddress;
847                 if (!empty($replyaddress)) {
848                     // Add extra text to email messages if they can reply back.
849                     $textfooter = "\n\n" . get_string('replytopostbyemail', 'mod_forum');
850                     $htmlfooter = html_writer::tag('p', get_string('replytopostbyemail', 'mod_forum'));
851                     $additionalcontent = array('fullmessage' => array('footer' => $textfooter),
852                                      'fullmessagehtml' => array('footer' => $htmlfooter));
853                     $eventdata->set_additional_content('email', $additionalcontent);
854                 }
856                 // If forum_replytouser is not set then send mail using the noreplyaddress.
857                 if (empty($CFG->forum_replytouser)) {
858                     $eventdata->userfrom = core_user::get_noreply_user();
859                 }
861                 $smallmessagestrings = new stdClass();
862                 $smallmessagestrings->user          = fullname($userfrom);
863                 $smallmessagestrings->forumname     = "$shortname: " . format_string($forum->name, true) . ": " . $discussion->name;
864                 $smallmessagestrings->message       = $post->message;
866                 // Make sure strings are in message recipients language.
867                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
869                 $contexturl = new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id), 'p' . $post->id);
870                 $eventdata->contexturl = $contexturl->out();
871                 $eventdata->contexturlname = $discussion->name;
873                 $mailresult = message_send($eventdata);
874                 if (!$mailresult) {
875                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
876                             " ($userto->email) .. not trying again.");
877                     $errorcount[$post->id]++;
878                 } else {
879                     $mailcount[$post->id]++;
881                     // Mark post as read if forum_usermarksread is set off.
882                     if (!$CFG->forum_usermarksread) {
883                         $userto->markposts[$post->id] = $post->id;
884                     }
885                 }
887                 mtrace('post ' . $post->id . ': ' . $post->subject);
888             }
890             // Mark processed posts as read.
891             forum_tp_mark_posts_read($userto, $userto->markposts);
892             unset($userto);
893         }
894     }
896     if ($posts) {
897         foreach ($posts as $post) {
898             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
899             if ($errorcount[$post->id]) {
900                 $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
901             }
902         }
903     }
905     // release some memory
906     unset($subscribedusers);
907     unset($mailcount);
908     unset($errorcount);
910     cron_setup_user();
912     $sitetimezone = core_date::get_server_timezone();
914     // Now see if there are any digest mails waiting to be sent, and if we should send them
916     mtrace('Starting digest processing...');
918     core_php_time_limit::raise(300); // terminate if not able to fetch all digests in 5 minutes
920     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
921         set_config('digestmailtimelast', 0);
922     }
924     $timenow = time();
925     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
927     // Delete any really old ones (normally there shouldn't be any)
928     $weekago = $timenow - (7 * 24 * 3600);
929     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
930     mtrace ('Cleaned old digest records');
932     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
934         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
936         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
938         if ($digestposts_rs->valid()) {
940             // We have work to do
941             $usermailcount = 0;
943             //caches - reuse the those filled before too
944             $discussionposts = array();
945             $userdiscussions = array();
947             foreach ($digestposts_rs as $digestpost) {
948                 if (!isset($posts[$digestpost->postid])) {
949                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
950                         $posts[$digestpost->postid] = $post;
951                     } else {
952                         continue;
953                     }
954                 }
955                 $discussionid = $digestpost->discussionid;
956                 if (!isset($discussions[$discussionid])) {
957                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
958                         $discussions[$discussionid] = $discussion;
959                     } else {
960                         continue;
961                     }
962                 }
963                 $forumid = $discussions[$discussionid]->forum;
964                 if (!isset($forums[$forumid])) {
965                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
966                         $forums[$forumid] = $forum;
967                     } else {
968                         continue;
969                     }
970                 }
972                 $courseid = $forums[$forumid]->course;
973                 if (!isset($courses[$courseid])) {
974                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
975                         $courses[$courseid] = $course;
976                     } else {
977                         continue;
978                     }
979                 }
981                 if (!isset($coursemodules[$forumid])) {
982                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
983                         $coursemodules[$forumid] = $cm;
984                     } else {
985                         continue;
986                     }
987                 }
988                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
989                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
990             }
991             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
993             // Data collected, start sending out emails to each user
994             foreach ($userdiscussions as $userid => $thesediscussions) {
996                 core_php_time_limit::raise(120); // terminate if processing of any account takes longer than 2 minutes
998                 cron_setup_user();
1000                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
1002                 // First of all delete all the queue entries for this user
1003                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
1005                 // Init user caches - we keep the cache for one cycle only,
1006                 // otherwise it would unnecessarily consume memory.
1007                 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
1008                     $userto = clone($users[$userid]);
1009                 } else {
1010                     $userto = $DB->get_record('user', array('id' => $userid));
1011                     forum_cron_minimise_user_record($userto);
1012                 }
1013                 $userto->viewfullnames = array();
1014                 $userto->canpost       = array();
1015                 $userto->markposts     = array();
1017                 // Override the language and timezone of the "current" user, so that
1018                 // mail is customised for the receiver.
1019                 cron_setup_user($userto);
1021                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
1023                 $headerdata = new stdClass();
1024                 $headerdata->sitename = format_string($site->fullname, true);
1025                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
1027                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
1028                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
1030                 $posthtml = '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p>'
1031                     . '<br /><hr size="1" noshade="noshade" />';
1033                 foreach ($thesediscussions as $discussionid) {
1035                     core_php_time_limit::raise(120);   // to be reset for each post
1037                     $discussion = $discussions[$discussionid];
1038                     $forum      = $forums[$discussion->forum];
1039                     $course     = $courses[$forum->course];
1040                     $cm         = $coursemodules[$forum->id];
1042                     //override language
1043                     cron_setup_user($userto, $course);
1045                     // Fill caches
1046                     if (!isset($userto->viewfullnames[$forum->id])) {
1047                         $modcontext = context_module::instance($cm->id);
1048                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
1049                     }
1050                     if (!isset($userto->canpost[$discussion->id])) {
1051                         $modcontext = context_module::instance($cm->id);
1052                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1053                     }
1055                     $strforums      = get_string('forums', 'forum');
1056                     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
1057                     $canreply       = $userto->canpost[$discussion->id];
1058                     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1060                     $posttext .= "\n \n";
1061                     $posttext .= '=====================================================================';
1062                     $posttext .= "\n \n";
1063                     $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1064                     if ($discussion->name != $forum->name) {
1065                         $posttext  .= " -> ".format_string($discussion->name,true);
1066                     }
1067                     $posttext .= "\n";
1068                     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1069                     $posttext .= "\n";
1071                     $posthtml .= "<p><font face=\"sans-serif\">".
1072                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
1073                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
1074                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
1075                     if ($discussion->name == $forum->name) {
1076                         $posthtml .= "</font></p>";
1077                     } else {
1078                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
1079                     }
1080                     $posthtml .= '<p>';
1082                     $postsarray = $discussionposts[$discussionid];
1083                     sort($postsarray);
1084                     $sentcount = 0;
1086                     foreach ($postsarray as $postid) {
1087                         $post = $posts[$postid];
1089                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
1090                             $userfrom = $users[$post->userid];
1091                             if (!isset($userfrom->idnumber)) {
1092                                 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
1093                                 forum_cron_minimise_user_record($userfrom);
1094                             }
1096                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
1097                             forum_cron_minimise_user_record($userfrom);
1098                             if ($userscount <= FORUM_CRON_USER_CACHE) {
1099                                 $userscount++;
1100                                 $users[$userfrom->id] = $userfrom;
1101                             }
1103                         } else {
1104                             mtrace('Could not find user '.$post->userid);
1105                             continue;
1106                         }
1108                         if (!isset($userfrom->groups[$forum->id])) {
1109                             if (!isset($userfrom->groups)) {
1110                                 $userfrom->groups = array();
1111                                 if (isset($users[$userfrom->id])) {
1112                                     $users[$userfrom->id]->groups = array();
1113                                 }
1114                             }
1115                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
1116                             if (isset($users[$userfrom->id])) {
1117                                 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
1118                             }
1119                         }
1121                         // Headers to help prevent auto-responders.
1122                         $userfrom->customheaders = array(
1123                                 "Precedence: Bulk",
1124                                 'X-Auto-Response-Suppress: All',
1125                                 'Auto-Submitted: auto-generated',
1126                             );
1128                         $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
1129                         if (!isset($userto->canpost[$discussion->id])) {
1130                             $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1131                         } else {
1132                             $canreply = $userto->canpost[$discussion->id];
1133                         }
1135                         $data = new \mod_forum\output\forum_post_email(
1136                                 $course,
1137                                 $cm,
1138                                 $forum,
1139                                 $discussion,
1140                                 $post,
1141                                 $userfrom,
1142                                 $userto,
1143                                 $canreply
1144                             );
1146                         if (!isset($userto->viewfullnames[$forum->id])) {
1147                             $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1148                         } else {
1149                             $data->viewfullnames = $userto->viewfullnames[$forum->id];
1150                         }
1152                         if ($maildigest == 2) {
1153                             // Subjects and link only.
1154                             $posttext .= $textdigestbasicout->render($data);
1155                             $posthtml .= $htmldigestbasicout->render($data);
1156                         } else {
1157                             // The full treatment.
1158                             $posttext .= $textdigestfullout->render($data);
1159                             $posthtml .= $htmldigestfullout->render($data);
1161                             // Create an array of postid's for this user to mark as read.
1162                             if (!$CFG->forum_usermarksread) {
1163                                 $userto->markposts[$post->id] = $post->id;
1164                             }
1165                         }
1166                         $sentcount++;
1167                     }
1168                     $footerlinks = array();
1169                     if ($canunsubscribe) {
1170                         $footerlinks[] = "<a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">" . get_string("unsubscribe", "forum") . "</a>";
1171                     } else {
1172                         $footerlinks[] = get_string("everyoneissubscribed", "forum");
1173                     }
1174                     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string("digestmailpost", "forum") . '</a>';
1175                     $posthtml .= "\n<div class='mdl-right'><font size=\"1\">" . implode('&nbsp;', $footerlinks) . '</font></div>';
1176                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
1177                 }
1179                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
1180                     // This user DOESN'T want to receive HTML
1181                     $posthtml = '';
1182                 }
1184                 $eventdata = new \core\message\message();
1185                 $eventdata->component           = 'mod_forum';
1186                 $eventdata->name                = 'digests';
1187                 $eventdata->userfrom            = core_user::get_noreply_user();
1188                 $eventdata->userto              = $userto;
1189                 $eventdata->subject             = $postsubject;
1190                 $eventdata->fullmessage         = $posttext;
1191                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
1192                 $eventdata->fullmessagehtml     = $posthtml;
1193                 $eventdata->notification        = 1;
1194                 $eventdata->smallmessage        = get_string('smallmessagedigest', 'forum', $sentcount);
1195                 $mailresult = message_send($eventdata);
1197                 if (!$mailresult) {
1198                     mtrace("ERROR: mod/forum/cron.php: Could not send out digest mail to user $userto->id ".
1199                         "($userto->email)... not trying again.");
1200                 } else {
1201                     mtrace("success.");
1202                     $usermailcount++;
1204                     // Mark post as read if forum_usermarksread is set off
1205                     forum_tp_mark_posts_read($userto, $userto->markposts);
1206                 }
1207             }
1208         }
1209     /// We have finishied all digest emails, update $CFG->digestmailtimelast
1210         set_config('digestmailtimelast', $timenow);
1211     }
1213     cron_setup_user();
1215     if (!empty($usermailcount)) {
1216         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
1217     }
1219     if (!empty($CFG->forum_lastreadclean)) {
1220         $timenow = time();
1221         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1222             set_config('forum_lastreadclean', $timenow);
1223             mtrace('Removing old forum read tracking info...');
1224             forum_tp_clean_read_records();
1225         }
1226     } else {
1227         set_config('forum_lastreadclean', time());
1228     }
1230     return true;
1233 /**
1234  *
1235  * @param object $course
1236  * @param object $user
1237  * @param object $mod TODO this is not used in this function, refactor
1238  * @param object $forum
1239  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
1240  */
1241 function forum_user_outline($course, $user, $mod, $forum) {
1242     global $CFG;
1243     require_once("$CFG->libdir/gradelib.php");
1244     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1245     if (empty($grades->items[0]->grades)) {
1246         $grade = false;
1247     } else {
1248         $grade = reset($grades->items[0]->grades);
1249     }
1251     $count = forum_count_user_posts($forum->id, $user->id);
1253     if ($count && $count->postcount > 0) {
1254         $result = new stdClass();
1255         $result->info = get_string("numposts", "forum", $count->postcount);
1256         $result->time = $count->lastpost;
1257         if ($grade) {
1258             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1259         }
1260         return $result;
1261     } else if ($grade) {
1262         $result = new stdClass();
1263         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1265         //datesubmitted == time created. dategraded == time modified or time overridden
1266         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1267         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1268         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1269             $result->time = $grade->dategraded;
1270         } else {
1271             $result->time = $grade->datesubmitted;
1272         }
1274         return $result;
1275     }
1276     return NULL;
1280 /**
1281  * @global object
1282  * @global object
1283  * @param object $coure
1284  * @param object $user
1285  * @param object $mod
1286  * @param object $forum
1287  */
1288 function forum_user_complete($course, $user, $mod, $forum) {
1289     global $CFG,$USER, $OUTPUT;
1290     require_once("$CFG->libdir/gradelib.php");
1292     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1293     if (!empty($grades->items[0]->grades)) {
1294         $grade = reset($grades->items[0]->grades);
1295         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1296         if ($grade->str_feedback) {
1297             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1298         }
1299     }
1301     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
1303         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
1304             print_error('invalidcoursemodule');
1305         }
1306         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1308         foreach ($posts as $post) {
1309             if (!isset($discussions[$post->discussion])) {
1310                 continue;
1311             }
1312             $discussion = $discussions[$post->discussion];
1314             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
1315         }
1316     } else {
1317         echo "<p>".get_string("noposts", "forum")."</p>";
1318     }
1321 /**
1322  * Filters the forum discussions according to groups membership and config.
1323  *
1324  * @since  Moodle 2.8, 2.7.1, 2.6.4
1325  * @param  array $discussions Discussions with new posts array
1326  * @return array Forums with the number of new posts
1327  */
1328 function forum_filter_user_groups_discussions($discussions) {
1330     // Group the remaining discussions posts by their forumid.
1331     $filteredforums = array();
1333     // Discard not visible groups.
1334     foreach ($discussions as $discussion) {
1336         // Course data is already cached.
1337         $instances = get_fast_modinfo($discussion->course)->get_instances();
1338         $forum = $instances['forum'][$discussion->forum];
1340         // Continue if the user should not see this discussion.
1341         if (!forum_is_user_group_discussion($forum, $discussion->groupid)) {
1342             continue;
1343         }
1345         // Grouping results by forum.
1346         if (empty($filteredforums[$forum->instance])) {
1347             $filteredforums[$forum->instance] = new stdClass();
1348             $filteredforums[$forum->instance]->id = $forum->id;
1349             $filteredforums[$forum->instance]->count = 0;
1350         }
1351         $filteredforums[$forum->instance]->count += $discussion->count;
1353     }
1355     return $filteredforums;
1358 /**
1359  * Returns whether the discussion group is visible by the current user or not.
1360  *
1361  * @since Moodle 2.8, 2.7.1, 2.6.4
1362  * @param cm_info $cm The discussion course module
1363  * @param int $discussiongroupid The discussion groupid
1364  * @return bool
1365  */
1366 function forum_is_user_group_discussion(cm_info $cm, $discussiongroupid) {
1368     if ($discussiongroupid == -1 || $cm->effectivegroupmode != SEPARATEGROUPS) {
1369         return true;
1370     }
1372     if (isguestuser()) {
1373         return false;
1374     }
1376     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id)) ||
1377             in_array($discussiongroupid, $cm->get_modinfo()->get_groups($cm->groupingid))) {
1378         return true;
1379     }
1381     return false;
1384 /**
1385  * @global object
1386  * @global object
1387  * @global object
1388  * @param array $courses
1389  * @param array $htmlarray
1390  */
1391 function forum_print_overview($courses,&$htmlarray) {
1392     global $USER, $CFG, $DB, $SESSION;
1394     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1395         return array();
1396     }
1398     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1399         return;
1400     }
1402     // Courses to search for new posts
1403     $coursessqls = array();
1404     $params = array();
1405     foreach ($courses as $course) {
1407         // If the user has never entered into the course all posts are pending
1408         if ($course->lastaccess == 0) {
1409             $coursessqls[] = '(d.course = ?)';
1410             $params[] = $course->id;
1412         // Only posts created after the course last access
1413         } else {
1414             $coursessqls[] = '(d.course = ? AND p.created > ?)';
1415             $params[] = $course->id;
1416             $params[] = $course->lastaccess;
1417         }
1418     }
1419     $params[] = $USER->id;
1420     $coursessql = implode(' OR ', $coursessqls);
1422     $sql = "SELECT d.id, d.forum, d.course, d.groupid, COUNT(*) as count "
1423                 .'FROM {forum_discussions} d '
1424                 .'JOIN {forum_posts} p ON p.discussion = d.id '
1425                 ."WHERE ($coursessql) "
1426                 .'AND p.userid != ? '
1427                 .'AND (d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?)) '
1428                 .'GROUP BY d.id, d.forum, d.course, d.groupid '
1429                 .'ORDER BY d.course, d.forum';
1430     $params[] = time();
1431     $params[] = time();
1433     // Avoid warnings.
1434     if (!$discussions = $DB->get_records_sql($sql, $params)) {
1435         $discussions = array();
1436     }
1438     $forumsnewposts = forum_filter_user_groups_discussions($discussions);
1440     // also get all forum tracking stuff ONCE.
1441     $trackingforums = array();
1442     foreach ($forums as $forum) {
1443         if (forum_tp_can_track_forums($forum)) {
1444             $trackingforums[$forum->id] = $forum;
1445         }
1446     }
1448     if (count($trackingforums) > 0) {
1449         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1450         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1451             ' FROM {forum_posts} p '.
1452             ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1453             ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
1454         $params = array($USER->id);
1456         foreach ($trackingforums as $track) {
1457             $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1458             $params[] = $track->id;
1459             if (isset($SESSION->currentgroup[$track->course])) {
1460                 $groupid =  $SESSION->currentgroup[$track->course];
1461             } else {
1462                 // get first groupid
1463                 $groupids = groups_get_all_groups($track->course, $USER->id);
1464                 if ($groupids) {
1465                     reset($groupids);
1466                     $groupid = key($groupids);
1467                     $SESSION->currentgroup[$track->course] = $groupid;
1468                 } else {
1469                     $groupid = 0;
1470                 }
1471                 unset($groupids);
1472             }
1473             $params[] = $groupid;
1474         }
1475         $sql = substr($sql,0,-3); // take off the last OR
1476         $sql .= ') AND p.modified >= ? AND r.id is NULL ';
1477         $sql .= 'AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)) ';
1478         $sql .= 'GROUP BY d.forum,d.course';
1479         $params[] = $cutoffdate;
1480         $params[] = time();
1481         $params[] = time();
1483         if (!$unread = $DB->get_records_sql($sql, $params)) {
1484             $unread = array();
1485         }
1486     } else {
1487         $unread = array();
1488     }
1490     if (empty($unread) and empty($forumsnewposts)) {
1491         return;
1492     }
1494     $strforum = get_string('modulename','forum');
1496     foreach ($forums as $forum) {
1497         $str = '';
1498         $count = 0;
1499         $thisunread = 0;
1500         $showunread = false;
1501         // either we have something from logs, or trackposts, or nothing.
1502         if (array_key_exists($forum->id, $forumsnewposts) && !empty($forumsnewposts[$forum->id])) {
1503             $count = $forumsnewposts[$forum->id]->count;
1504         }
1505         if (array_key_exists($forum->id,$unread)) {
1506             $thisunread = $unread[$forum->id]->count;
1507             $showunread = true;
1508         }
1509         if ($count > 0 || $thisunread > 0) {
1510             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1511                 $forum->name.'</a></div>';
1512             $str .= '<div class="info"><span class="postsincelogin">';
1513             $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
1514             if (!empty($showunread)) {
1515                 $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
1516             }
1517             $str .= '</div></div>';
1518         }
1519         if (!empty($str)) {
1520             if (!array_key_exists($forum->course,$htmlarray)) {
1521                 $htmlarray[$forum->course] = array();
1522             }
1523             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1524                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1525             }
1526             $htmlarray[$forum->course]['forum'] .= $str;
1527         }
1528     }
1531 /**
1532  * Given a course and a date, prints a summary of all the new
1533  * messages posted in the course since that date
1534  *
1535  * @global object
1536  * @global object
1537  * @global object
1538  * @uses CONTEXT_MODULE
1539  * @uses VISIBLEGROUPS
1540  * @param object $course
1541  * @param bool $viewfullnames capability
1542  * @param int $timestart
1543  * @return bool success
1544  */
1545 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1546     global $CFG, $USER, $DB, $OUTPUT;
1548     // do not use log table if possible, it may be huge and is expensive to join with other tables
1550     $allnamefields = user_picture::fields('u', null, 'duserid');
1551     if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1552                                               d.timestart, d.timeend, $allnamefields
1553                                          FROM {forum_posts} p
1554                                               JOIN {forum_discussions} d ON d.id = p.discussion
1555                                               JOIN {forum} f             ON f.id = d.forum
1556                                               JOIN {user} u              ON u.id = p.userid
1557                                         WHERE p.created > ? AND f.course = ?
1558                                      ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
1559          return false;
1560     }
1562     $modinfo = get_fast_modinfo($course);
1564     $groupmodes = array();
1565     $cms    = array();
1567     $strftimerecent = get_string('strftimerecent');
1569     $printposts = array();
1570     foreach ($posts as $post) {
1571         if (!isset($modinfo->instances['forum'][$post->forum])) {
1572             // not visible
1573             continue;
1574         }
1575         $cm = $modinfo->instances['forum'][$post->forum];
1576         if (!$cm->uservisible) {
1577             continue;
1578         }
1579         $context = context_module::instance($cm->id);
1581         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1582             continue;
1583         }
1585         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1586           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1587             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1588                 continue;
1589             }
1590         }
1592         // Check that the user can see the discussion.
1593         if (forum_is_user_group_discussion($cm, $post->groupid)) {
1594             $printposts[] = $post;
1595         }
1597     }
1598     unset($posts);
1600     if (!$printposts) {
1601         return false;
1602     }
1604     echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
1605     echo "\n<ul class='unlist'>\n";
1607     foreach ($printposts as $post) {
1608         $subjectclass = empty($post->parent) ? ' bold' : '';
1610         echo '<li><div class="head">'.
1611                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1612                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1613              '</div>';
1614         echo '<div class="info'.$subjectclass.'">';
1615         if (empty($post->parent)) {
1616             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1617         } else {
1618             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1619         }
1620         $post->subject = break_up_long_words(format_string($post->subject, true));
1621         echo $post->subject;
1622         echo "</a>\"</div></li>\n";
1623     }
1625     echo "</ul>\n";
1627     return true;
1630 /**
1631  * Return grade for given user or all users.
1632  *
1633  * @global object
1634  * @global object
1635  * @param object $forum
1636  * @param int $userid optional user id, 0 means all users
1637  * @return array array of grades, false if none
1638  */
1639 function forum_get_user_grades($forum, $userid = 0) {
1640     global $CFG;
1642     require_once($CFG->dirroot.'/rating/lib.php');
1644     $ratingoptions = new stdClass;
1645     $ratingoptions->component = 'mod_forum';
1646     $ratingoptions->ratingarea = 'post';
1648     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1649     $ratingoptions->modulename = 'forum';
1650     $ratingoptions->moduleid   = $forum->id;
1651     $ratingoptions->userid = $userid;
1652     $ratingoptions->aggregationmethod = $forum->assessed;
1653     $ratingoptions->scaleid = $forum->scale;
1654     $ratingoptions->itemtable = 'forum_posts';
1655     $ratingoptions->itemtableusercolumn = 'userid';
1657     $rm = new rating_manager();
1658     return $rm->get_user_grades($ratingoptions);
1661 /**
1662  * Update activity grades
1663  *
1664  * @category grade
1665  * @param object $forum
1666  * @param int $userid specific user only, 0 means all
1667  * @param boolean $nullifnone return null if grade does not exist
1668  * @return void
1669  */
1670 function forum_update_grades($forum, $userid=0, $nullifnone=true) {
1671     global $CFG, $DB;
1672     require_once($CFG->libdir.'/gradelib.php');
1674     if (!$forum->assessed) {
1675         forum_grade_item_update($forum);
1677     } else if ($grades = forum_get_user_grades($forum, $userid)) {
1678         forum_grade_item_update($forum, $grades);
1680     } else if ($userid and $nullifnone) {
1681         $grade = new stdClass();
1682         $grade->userid   = $userid;
1683         $grade->rawgrade = NULL;
1684         forum_grade_item_update($forum, $grade);
1686     } else {
1687         forum_grade_item_update($forum);
1688     }
1691 /**
1692  * Create/update grade item for given forum
1693  *
1694  * @category grade
1695  * @uses GRADE_TYPE_NONE
1696  * @uses GRADE_TYPE_VALUE
1697  * @uses GRADE_TYPE_SCALE
1698  * @param stdClass $forum Forum object with extra cmidnumber
1699  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1700  * @return int 0 if ok
1701  */
1702 function forum_grade_item_update($forum, $grades=NULL) {
1703     global $CFG;
1704     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1705         require_once($CFG->libdir.'/gradelib.php');
1706     }
1708     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1710     if (!$forum->assessed or $forum->scale == 0) {
1711         $params['gradetype'] = GRADE_TYPE_NONE;
1713     } else if ($forum->scale > 0) {
1714         $params['gradetype'] = GRADE_TYPE_VALUE;
1715         $params['grademax']  = $forum->scale;
1716         $params['grademin']  = 0;
1718     } else if ($forum->scale < 0) {
1719         $params['gradetype'] = GRADE_TYPE_SCALE;
1720         $params['scaleid']   = -$forum->scale;
1721     }
1723     if ($grades  === 'reset') {
1724         $params['reset'] = true;
1725         $grades = NULL;
1726     }
1728     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1731 /**
1732  * Delete grade item for given forum
1733  *
1734  * @category grade
1735  * @param stdClass $forum Forum object
1736  * @return grade_item
1737  */
1738 function forum_grade_item_delete($forum) {
1739     global $CFG;
1740     require_once($CFG->libdir.'/gradelib.php');
1742     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1746 /**
1747  * This function returns if a scale is being used by one forum
1748  *
1749  * @global object
1750  * @param int $forumid
1751  * @param int $scaleid negative number
1752  * @return bool
1753  */
1754 function forum_scale_used ($forumid,$scaleid) {
1755     global $DB;
1756     $return = false;
1758     $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
1760     if (!empty($rec) && !empty($scaleid)) {
1761         $return = true;
1762     }
1764     return $return;
1767 /**
1768  * Checks if scale is being used by any instance of forum
1769  *
1770  * This is used to find out if scale used anywhere
1771  *
1772  * @global object
1773  * @param $scaleid int
1774  * @return boolean True if the scale is used by any forum
1775  */
1776 function forum_scale_used_anywhere($scaleid) {
1777     global $DB;
1778     if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
1779         return true;
1780     } else {
1781         return false;
1782     }
1785 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1787 /**
1788  * Gets a post with all info ready for forum_print_post
1789  * Most of these joins are just to get the forum id
1790  *
1791  * @global object
1792  * @global object
1793  * @param int $postid
1794  * @return mixed array of posts or false
1795  */
1796 function forum_get_post_full($postid) {
1797     global $CFG, $DB;
1799     $allnames = get_all_user_name_fields(true, 'u');
1800     return $DB->get_record_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
1801                              FROM {forum_posts} p
1802                                   JOIN {forum_discussions} d ON p.discussion = d.id
1803                                   LEFT JOIN {user} u ON p.userid = u.id
1804                             WHERE p.id = ?", array($postid));
1807 /**
1808  * Gets all posts in discussion including top parent.
1809  *
1810  * @global object
1811  * @global object
1812  * @global object
1813  * @param int $discussionid
1814  * @param string $sort
1815  * @param bool $tracking does user track the forum?
1816  * @return array of posts
1817  */
1818 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1819     global $CFG, $DB, $USER;
1821     $tr_sel  = "";
1822     $tr_join = "";
1823     $params = array();
1825     if ($tracking) {
1826         $tr_sel  = ", fr.id AS postread";
1827         $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1828         $params[] = $USER->id;
1829     }
1831     $allnames = get_all_user_name_fields(true, 'u');
1832     $params[] = $discussionid;
1833     if (!$posts = $DB->get_records_sql("SELECT p.*, $allnames, u.email, u.picture, u.imagealt $tr_sel
1834                                      FROM {forum_posts} p
1835                                           LEFT JOIN {user} u ON p.userid = u.id
1836                                           $tr_join
1837                                     WHERE p.discussion = ?
1838                                  ORDER BY $sort", $params)) {
1839         return array();
1840     }
1842     foreach ($posts as $pid=>$p) {
1843         if ($tracking) {
1844             if (forum_tp_is_post_old($p)) {
1845                  $posts[$pid]->postread = true;
1846             }
1847         }
1848         if (!$p->parent) {
1849             continue;
1850         }
1851         if (!isset($posts[$p->parent])) {
1852             continue; // parent does not exist??
1853         }
1854         if (!isset($posts[$p->parent]->children)) {
1855             $posts[$p->parent]->children = array();
1856         }
1857         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1858     }
1860     // Start with the last child of the first post.
1861     $post = &$posts[reset($posts)->id];
1863     $lastpost = false;
1864     while (!$lastpost) {
1865         if (!isset($post->children)) {
1866             $post->lastpost = true;
1867             $lastpost = true;
1868         } else {
1869              // Go to the last child of this post.
1870             $post = &$posts[end($post->children)->id];
1871         }
1872     }
1874     return $posts;
1877 /**
1878  * An array of forum objects that the user is allowed to read/search through.
1879  *
1880  * @global object
1881  * @global object
1882  * @global object
1883  * @param int $userid
1884  * @param int $courseid if 0, we look for forums throughout the whole site.
1885  * @return array of forum objects, or false if no matches
1886  *         Forum objects have the following attributes:
1887  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1888  *         viewhiddentimedposts
1889  */
1890 function forum_get_readable_forums($userid, $courseid=0) {
1892     global $CFG, $DB, $USER;
1893     require_once($CFG->dirroot.'/course/lib.php');
1895     if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
1896         print_error('notinstalled', 'forum');
1897     }
1899     if ($courseid) {
1900         $courses = $DB->get_records('course', array('id' => $courseid));
1901     } else {
1902         // If no course is specified, then the user can see SITE + his courses.
1903         $courses1 = $DB->get_records('course', array('id' => SITEID));
1904         $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
1905         $courses = array_merge($courses1, $courses2);
1906     }
1907     if (!$courses) {
1908         return array();
1909     }
1911     $readableforums = array();
1913     foreach ($courses as $course) {
1915         $modinfo = get_fast_modinfo($course);
1917         if (empty($modinfo->instances['forum'])) {
1918             // hmm, no forums?
1919             continue;
1920         }
1922         $courseforums = $DB->get_records('forum', array('course' => $course->id));
1924         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1925             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1926                 continue;
1927             }
1928             $context = context_module::instance($cm->id);
1929             $forum = $courseforums[$forumid];
1930             $forum->context = $context;
1931             $forum->cm = $cm;
1933             if (!has_capability('mod/forum:viewdiscussion', $context)) {
1934                 continue;
1935             }
1937          /// group access
1938             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
1940                 $forum->onlygroups = $modinfo->get_groups($cm->groupingid);
1941                 $forum->onlygroups[] = -1;
1942             }
1944         /// hidden timed discussions
1945             $forum->viewhiddentimedposts = true;
1946             if (!empty($CFG->forum_enabletimedposts)) {
1947                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1948                     $forum->viewhiddentimedposts = false;
1949                 }
1950             }
1952         /// qanda access
1953             if ($forum->type == 'qanda'
1954                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1956                 // We need to check whether the user has posted in the qanda forum.
1957                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
1958                                                     // the user is allowed to see in this forum.
1959                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1960                     foreach ($discussionspostedin as $d) {
1961                         $forum->onlydiscussions[] = $d->id;
1962                     }
1963                 }
1964             }
1966             $readableforums[$forum->id] = $forum;
1967         }
1969         unset($modinfo);
1971     } // End foreach $courses
1973     return $readableforums;
1976 /**
1977  * Returns a list of posts found using an array of search terms.
1978  *
1979  * @global object
1980  * @global object
1981  * @global object
1982  * @param array $searchterms array of search terms, e.g. word +word -word
1983  * @param int $courseid if 0, we search through the whole site
1984  * @param int $limitfrom
1985  * @param int $limitnum
1986  * @param int &$totalcount
1987  * @param string $extrasql
1988  * @return array|bool Array of posts found or false
1989  */
1990 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
1991                             &$totalcount, $extrasql='') {
1992     global $CFG, $DB, $USER;
1993     require_once($CFG->libdir.'/searchlib.php');
1995     $forums = forum_get_readable_forums($USER->id, $courseid);
1997     if (count($forums) == 0) {
1998         $totalcount = 0;
1999         return false;
2000     }
2002     $now = round(time(), -2); // db friendly
2004     $fullaccess = array();
2005     $where = array();
2006     $params = array();
2008     foreach ($forums as $forumid => $forum) {
2009         $select = array();
2011         if (!$forum->viewhiddentimedposts) {
2012             $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
2013             $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
2014         }
2016         $cm = $forum->cm;
2017         $context = $forum->context;
2019         if ($forum->type == 'qanda'
2020             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2021             if (!empty($forum->onlydiscussions)) {
2022                 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
2023                 $params = array_merge($params, $discussionid_params);
2024                 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
2025             } else {
2026                 $select[] = "p.parent = 0";
2027             }
2028         }
2030         if (!empty($forum->onlygroups)) {
2031             list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
2032             $params = array_merge($params, $groupid_params);
2033             $select[] = "d.groupid $groupid_sql";
2034         }
2036         if ($select) {
2037             $selects = implode(" AND ", $select);
2038             $where[] = "(d.forum = :forum{$forumid} AND $selects)";
2039             $params['forum'.$forumid] = $forumid;
2040         } else {
2041             $fullaccess[] = $forumid;
2042         }
2043     }
2045     if ($fullaccess) {
2046         list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
2047         $params = array_merge($params, $fullid_params);
2048         $where[] = "(d.forum $fullid_sql)";
2049     }
2051     $selectdiscussion = "(".implode(" OR ", $where).")";
2053     $messagesearch = '';
2054     $searchstring = '';
2056     // Need to concat these back together for parser to work.
2057     foreach($searchterms as $searchterm){
2058         if ($searchstring != '') {
2059             $searchstring .= ' ';
2060         }
2061         $searchstring .= $searchterm;
2062     }
2064     // We need to allow quoted strings for the search. The quotes *should* be stripped
2065     // by the parser, but this should be examined carefully for security implications.
2066     $searchstring = str_replace("\\\"","\"",$searchstring);
2067     $parser = new search_parser();
2068     $lexer = new search_lexer($parser);
2070     if ($lexer->parse($searchstring)) {
2071         $parsearray = $parser->get_parsed_array();
2072         list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2073                                                               'p.userid', 'u.id', 'u.firstname',
2074                                                               'u.lastname', 'p.modified', 'd.forum');
2075         $params = array_merge($params, $msparams);
2076     }
2078     $fromsql = "{forum_posts} p,
2079                   {forum_discussions} d,
2080                   {user} u";
2082     $selectsql = " $messagesearch
2083                AND p.discussion = d.id
2084                AND p.userid = u.id
2085                AND $selectdiscussion
2086                    $extrasql";
2088     $countsql = "SELECT COUNT(*)
2089                    FROM $fromsql
2090                   WHERE $selectsql";
2092     $allnames = get_all_user_name_fields(true, 'u');
2093     $searchsql = "SELECT p.*,
2094                          d.forum,
2095                          $allnames,
2096                          u.email,
2097                          u.picture,
2098                          u.imagealt
2099                     FROM $fromsql
2100                    WHERE $selectsql
2101                 ORDER BY p.modified DESC";
2103     $totalcount = $DB->count_records_sql($countsql, $params);
2105     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2108 /**
2109  * Returns a list of all new posts that have not been mailed yet
2110  *
2111  * @param int $starttime posts created after this time
2112  * @param int $endtime posts created before this
2113  * @param int $now used for timed discussions only
2114  * @return array
2115  */
2116 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2117     global $CFG, $DB;
2119     $params = array();
2120     $params['mailed'] = FORUM_MAILED_PENDING;
2121     $params['ptimestart'] = $starttime;
2122     $params['ptimeend'] = $endtime;
2123     $params['mailnow'] = 1;
2125     if (!empty($CFG->forum_enabletimedposts)) {
2126         if (empty($now)) {
2127             $now = time();
2128         }
2129         $selectsql = "AND (p.created >= :ptimestart OR d.timestart >= :pptimestart)";
2130         $params['pptimestart'] = $starttime;
2131         $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
2132         $params['dtimestart'] = $now;
2133         $params['dtimeend'] = $now;
2134     } else {
2135         $timedsql = "";
2136         $selectsql = "AND p.created >= :ptimestart";
2137     }
2139     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2140                                  FROM {forum_posts} p
2141                                  JOIN {forum_discussions} d ON d.id = p.discussion
2142                                  WHERE p.mailed = :mailed
2143                                  $selectsql
2144                                  AND (p.created < :ptimeend OR p.mailnow = :mailnow)
2145                                  $timedsql
2146                                  ORDER BY p.modified ASC", $params);
2149 /**
2150  * Marks posts before a certain time as being mailed already
2151  *
2152  * @global object
2153  * @global object
2154  * @param int $endtime
2155  * @param int $now Defaults to time()
2156  * @return bool
2157  */
2158 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2159     global $CFG, $DB;
2161     if (empty($now)) {
2162         $now = time();
2163     }
2165     $params = array();
2166     $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
2167     $params['now'] = $now;
2168     $params['endtime'] = $endtime;
2169     $params['mailnow'] = 1;
2170     $params['mailedpending'] = FORUM_MAILED_PENDING;
2172     if (empty($CFG->forum_enabletimedposts)) {
2173         return $DB->execute("UPDATE {forum_posts}
2174                              SET mailed = :mailedsuccess
2175                              WHERE (created < :endtime OR mailnow = :mailnow)
2176                              AND mailed = :mailedpending", $params);
2177     } else {
2178         return $DB->execute("UPDATE {forum_posts}
2179                              SET mailed = :mailedsuccess
2180                              WHERE discussion NOT IN (SELECT d.id
2181                                                       FROM {forum_discussions} d
2182                                                       WHERE d.timestart > :now)
2183                              AND (created < :endtime OR mailnow = :mailnow)
2184                              AND mailed = :mailedpending", $params);
2185     }
2188 /**
2189  * Get all the posts for a user in a forum suitable for forum_print_post
2190  *
2191  * @global object
2192  * @global object
2193  * @uses CONTEXT_MODULE
2194  * @return array
2195  */
2196 function forum_get_user_posts($forumid, $userid) {
2197     global $CFG, $DB;
2199     $timedsql = "";
2200     $params = array($forumid, $userid);
2202     if (!empty($CFG->forum_enabletimedposts)) {
2203         $cm = get_coursemodule_from_instance('forum', $forumid);
2204         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2205             $now = time();
2206             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2207             $params[] = $now;
2208             $params[] = $now;
2209         }
2210     }
2212     $allnames = get_all_user_name_fields(true, 'u');
2213     return $DB->get_records_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
2214                               FROM {forum} f
2215                                    JOIN {forum_discussions} d ON d.forum = f.id
2216                                    JOIN {forum_posts} p       ON p.discussion = d.id
2217                                    JOIN {user} u              ON u.id = p.userid
2218                              WHERE f.id = ?
2219                                    AND p.userid = ?
2220                                    $timedsql
2221                           ORDER BY p.modified ASC", $params);
2224 /**
2225  * Get all the discussions user participated in
2226  *
2227  * @global object
2228  * @global object
2229  * @uses CONTEXT_MODULE
2230  * @param int $forumid
2231  * @param int $userid
2232  * @return array Array or false
2233  */
2234 function forum_get_user_involved_discussions($forumid, $userid) {
2235     global $CFG, $DB;
2237     $timedsql = "";
2238     $params = array($forumid, $userid);
2239     if (!empty($CFG->forum_enabletimedposts)) {
2240         $cm = get_coursemodule_from_instance('forum', $forumid);
2241         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2242             $now = time();
2243             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2244             $params[] = $now;
2245             $params[] = $now;
2246         }
2247     }
2249     return $DB->get_records_sql("SELECT DISTINCT d.*
2250                               FROM {forum} f
2251                                    JOIN {forum_discussions} d ON d.forum = f.id
2252                                    JOIN {forum_posts} p       ON p.discussion = d.id
2253                              WHERE f.id = ?
2254                                    AND p.userid = ?
2255                                    $timedsql", $params);
2258 /**
2259  * Get all the posts for a user in a forum suitable for forum_print_post
2260  *
2261  * @global object
2262  * @global object
2263  * @param int $forumid
2264  * @param int $userid
2265  * @return array of counts or false
2266  */
2267 function forum_count_user_posts($forumid, $userid) {
2268     global $CFG, $DB;
2270     $timedsql = "";
2271     $params = array($forumid, $userid);
2272     if (!empty($CFG->forum_enabletimedposts)) {
2273         $cm = get_coursemodule_from_instance('forum', $forumid);
2274         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2275             $now = time();
2276             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2277             $params[] = $now;
2278             $params[] = $now;
2279         }
2280     }
2282     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2283                              FROM {forum} f
2284                                   JOIN {forum_discussions} d ON d.forum = f.id
2285                                   JOIN {forum_posts} p       ON p.discussion = d.id
2286                                   JOIN {user} u              ON u.id = p.userid
2287                             WHERE f.id = ?
2288                                   AND p.userid = ?
2289                                   $timedsql", $params);
2292 /**
2293  * Given a log entry, return the forum post details for it.
2294  *
2295  * @global object
2296  * @global object
2297  * @param object $log
2298  * @return array|null
2299  */
2300 function forum_get_post_from_log($log) {
2301     global $CFG, $DB;
2303     $allnames = get_all_user_name_fields(true, 'u');
2304     if ($log->action == "add post") {
2306         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2307                                  FROM {forum_discussions} d,
2308                                       {forum_posts} p,
2309                                       {forum} f,
2310                                       {user} u
2311                                 WHERE p.id = ?
2312                                   AND d.id = p.discussion
2313                                   AND p.userid = u.id
2314                                   AND u.deleted <> '1'
2315                                   AND f.id = d.forum", array($log->info));
2318     } else if ($log->action == "add discussion") {
2320         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2321                                  FROM {forum_discussions} d,
2322                                       {forum_posts} p,
2323                                       {forum} f,
2324                                       {user} u
2325                                 WHERE d.id = ?
2326                                   AND d.firstpost = p.id
2327                                   AND p.userid = u.id
2328                                   AND u.deleted <> '1'
2329                                   AND f.id = d.forum", array($log->info));
2330     }
2331     return NULL;
2334 /**
2335  * Given a discussion id, return the first post from the discussion
2336  *
2337  * @global object
2338  * @global object
2339  * @param int $dicsussionid
2340  * @return array
2341  */
2342 function forum_get_firstpost_from_discussion($discussionid) {
2343     global $CFG, $DB;
2345     return $DB->get_record_sql("SELECT p.*
2346                              FROM {forum_discussions} d,
2347                                   {forum_posts} p
2348                             WHERE d.id = ?
2349                               AND d.firstpost = p.id ", array($discussionid));
2352 /**
2353  * Returns an array of counts of replies to each discussion
2354  *
2355  * @global object
2356  * @global object
2357  * @param int $forumid
2358  * @param string $forumsort
2359  * @param int $limit
2360  * @param int $page
2361  * @param int $perpage
2362  * @return array
2363  */
2364 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2365     global $CFG, $DB;
2367     if ($limit > 0) {
2368         $limitfrom = 0;
2369         $limitnum  = $limit;
2370     } else if ($page != -1) {
2371         $limitfrom = $page*$perpage;
2372         $limitnum  = $perpage;
2373     } else {
2374         $limitfrom = 0;
2375         $limitnum  = 0;
2376     }
2378     if ($forumsort == "") {
2379         $orderby = "";
2380         $groupby = "";
2382     } else {
2383         $orderby = "ORDER BY $forumsort";
2384         $groupby = ", ".strtolower($forumsort);
2385         $groupby = str_replace('desc', '', $groupby);
2386         $groupby = str_replace('asc', '', $groupby);
2387     }
2389     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2390         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2391                   FROM {forum_posts} p
2392                        JOIN {forum_discussions} d ON p.discussion = d.id
2393                  WHERE p.parent > 0 AND d.forum = ?
2394               GROUP BY p.discussion";
2395         return $DB->get_records_sql($sql, array($forumid));
2397     } else {
2398         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2399                   FROM {forum_posts} p
2400                        JOIN {forum_discussions} d ON p.discussion = d.id
2401                  WHERE d.forum = ?
2402               GROUP BY p.discussion $groupby $orderby";
2403         return $DB->get_records_sql($sql, array($forumid), $limitfrom, $limitnum);
2404     }
2407 /**
2408  * @global object
2409  * @global object
2410  * @global object
2411  * @staticvar array $cache
2412  * @param object $forum
2413  * @param object $cm
2414  * @param object $course
2415  * @return mixed
2416  */
2417 function forum_count_discussions($forum, $cm, $course) {
2418     global $CFG, $DB, $USER;
2420     static $cache = array();
2422     $now = round(time(), -2); // db cache friendliness
2424     $params = array($course->id);
2426     if (!isset($cache[$course->id])) {
2427         if (!empty($CFG->forum_enabletimedposts)) {
2428             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2429             $params[] = $now;
2430             $params[] = $now;
2431         } else {
2432             $timedsql = "";
2433         }
2435         $sql = "SELECT f.id, COUNT(d.id) as dcount
2436                   FROM {forum} f
2437                        JOIN {forum_discussions} d ON d.forum = f.id
2438                  WHERE f.course = ?
2439                        $timedsql
2440               GROUP BY f.id";
2442         if ($counts = $DB->get_records_sql($sql, $params)) {
2443             foreach ($counts as $count) {
2444                 $counts[$count->id] = $count->dcount;
2445             }
2446             $cache[$course->id] = $counts;
2447         } else {
2448             $cache[$course->id] = array();
2449         }
2450     }
2452     if (empty($cache[$course->id][$forum->id])) {
2453         return 0;
2454     }
2456     $groupmode = groups_get_activity_groupmode($cm, $course);
2458     if ($groupmode != SEPARATEGROUPS) {
2459         return $cache[$course->id][$forum->id];
2460     }
2462     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
2463         return $cache[$course->id][$forum->id];
2464     }
2466     require_once($CFG->dirroot.'/course/lib.php');
2468     $modinfo = get_fast_modinfo($course);
2470     $mygroups = $modinfo->get_groups($cm->groupingid);
2472     // add all groups posts
2473     $mygroups[-1] = -1;
2475     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2476     $params[] = $forum->id;
2478     if (!empty($CFG->forum_enabletimedposts)) {
2479         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2480         $params[] = $now;
2481         $params[] = $now;
2482     } else {
2483         $timedsql = "";
2484     }
2486     $sql = "SELECT COUNT(d.id)
2487               FROM {forum_discussions} d
2488              WHERE d.groupid $mygroups_sql AND d.forum = ?
2489                    $timedsql";
2491     return $DB->get_field_sql($sql, $params);
2494 /**
2495  * Get all discussions in a forum
2496  *
2497  * @global object
2498  * @global object
2499  * @global object
2500  * @uses CONTEXT_MODULE
2501  * @uses VISIBLEGROUPS
2502  * @param object $cm
2503  * @param string $forumsort
2504  * @param bool $fullpost
2505  * @param int $unused
2506  * @param int $limit
2507  * @param bool $userlastmodified
2508  * @param int $page
2509  * @param int $perpage
2510  * @param int $groupid if groups enabled, get discussions for this group overriding the current group.
2511  *                     Use FORUM_POSTS_ALL_USER_GROUPS for all the user groups
2512  * @return array
2513  */
2514 function forum_get_discussions($cm, $forumsort="", $fullpost=true, $unused=-1, $limit=-1,
2515                                 $userlastmodified=false, $page=-1, $perpage=0, $groupid = -1) {
2516     global $CFG, $DB, $USER;
2518     $timelimit = '';
2520     $now = round(time(), -2);
2521     $params = array($cm->instance);
2523     $modcontext = context_module::instance($cm->id);
2525     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2526         return array();
2527     }
2529     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2531         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2532             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2533             $params[] = $now;
2534             $params[] = $now;
2535             if (isloggedin()) {
2536                 $timelimit .= " OR d.userid = ?";
2537                 $params[] = $USER->id;
2538             }
2539             $timelimit .= ")";
2540         }
2541     }
2543     if ($limit > 0) {
2544         $limitfrom = 0;
2545         $limitnum  = $limit;
2546     } else if ($page != -1) {
2547         $limitfrom = $page*$perpage;
2548         $limitnum  = $perpage;
2549     } else {
2550         $limitfrom = 0;
2551         $limitnum  = 0;
2552     }
2554     $groupmode    = groups_get_activity_groupmode($cm);
2556     if ($groupmode) {
2558         if (empty($modcontext)) {
2559             $modcontext = context_module::instance($cm->id);
2560         }
2562         // Special case, we received a groupid to override currentgroup.
2563         if ($groupid > 0) {
2564             $course = get_course($cm->course);
2565             if (!groups_group_visible($groupid, $course, $cm)) {
2566                 // User doesn't belong to this group, return nothing.
2567                 return array();
2568             }
2569             $currentgroup = $groupid;
2570         } else if ($groupid === -1) {
2571             $currentgroup = groups_get_activity_group($cm);
2572         } else {
2573             // Get discussions for all groups current user can see.
2574             $currentgroup = null;
2575         }
2577         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2578             if ($currentgroup) {
2579                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2580                 $params[] = $currentgroup;
2581             } else {
2582                 $groupselect = "";
2583             }
2585         } else {
2586             // Separate groups.
2588             // Get discussions for all groups current user can see.
2589             if ($currentgroup === null) {
2590                 $mygroups = array_keys(groups_get_all_groups($cm->course, $USER->id, $cm->groupingid, 'g.id'));
2591                 if (empty($mygroups)) {
2592                      $groupselect = "AND d.groupid = -1";
2593                 } else {
2594                     list($insqlgroups, $inparamsgroups) = $DB->get_in_or_equal($mygroups);
2595                     $groupselect = "AND (d.groupid = -1 OR d.groupid $insqlgroups)";
2596                     $params = array_merge($params, $inparamsgroups);
2597                 }
2598             } else if ($currentgroup) {
2599                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2600                 $params[] = $currentgroup;
2601             } else {
2602                 $groupselect = "AND d.groupid = -1";
2603             }
2604         }
2605     } else {
2606         $groupselect = "";
2607     }
2608     if (empty($forumsort)) {
2609         $forumsort = forum_get_default_sort_order();
2610     }
2611     if (empty($fullpost)) {
2612         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2613     } else {
2614         $postdata = "p.*";
2615     }
2617     if (empty($userlastmodified)) {  // We don't need to know this
2618         $umfields = "";
2619         $umtable  = "";
2620     } else {
2621         $umfields = ', ' . get_all_user_name_fields(true, 'um', null, 'um') . ', um.email AS umemail, um.picture AS umpicture,
2622                         um.imagealt AS umimagealt';
2623         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2624     }
2626     $allnames = get_all_user_name_fields(true, 'u');
2627     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend, d.pinned, $allnames,
2628                    u.email, u.picture, u.imagealt $umfields
2629               FROM {forum_discussions} d
2630                    JOIN {forum_posts} p ON p.discussion = d.id
2631                    JOIN {user} u ON p.userid = u.id
2632                    $umtable
2633              WHERE d.forum = ? AND p.parent = 0
2634                    $timelimit $groupselect
2635           ORDER BY $forumsort, d.id DESC";
2636     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2639 /**
2640  * Gets the neighbours (previous and next) of a discussion.
2641  *
2642  * The calculation is based on the timemodified when time modified or time created is identical
2643  * It will revert to using the ID to sort consistently. This is better tha skipping a discussion.
2644  *
2645  * For blog-style forums, the calculation is based on the original creation time of the
2646  * blog post.
2647  *
2648  * Please note that this does not check whether or not the discussion passed is accessible
2649  * by the user, it simply uses it as a reference to find the neighbours. On the other hand,
2650  * the returned neighbours are checked and are accessible to the current user.
2651  *
2652  * @param object $cm The CM record.
2653  * @param object $discussion The discussion record.
2654  * @param object $forum The forum instance record.
2655  * @return array That always contains the keys 'prev' and 'next'. When there is a result
2656  *               they contain the record with minimal information such as 'id' and 'name'.
2657  *               When the neighbour is not found the value is false.
2658  */
2659 function forum_get_discussion_neighbours($cm, $discussion, $forum) {
2660     global $CFG, $DB, $USER;
2662     if ($cm->instance != $discussion->forum or $discussion->forum != $forum->id or $forum->id != $cm->instance) {
2663         throw new coding_exception('Discussion is not part of the same forum.');
2664     }
2666     $neighbours = array('prev' => false, 'next' => false);
2667     $now = round(time(), -2);
2668     $params = array();
2670     $modcontext = context_module::instance($cm->id);
2671     $groupmode    = groups_get_activity_groupmode($cm);
2672     $currentgroup = groups_get_activity_group($cm);
2674     // Users must fulfill timed posts.
2675     $timelimit = '';
2676     if (!empty($CFG->forum_enabletimedposts)) {
2677         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2678             $timelimit = ' AND ((d.timestart <= :tltimestart AND (d.timeend = 0 OR d.timeend > :tltimeend))';
2679             $params['tltimestart'] = $now;
2680             $params['tltimeend'] = $now;
2681             if (isloggedin()) {
2682                 $timelimit .= ' OR d.userid = :tluserid';
2683                 $params['tluserid'] = $USER->id;
2684             }
2685             $timelimit .= ')';
2686         }
2687     }
2689     // Limiting to posts accessible according to groups.
2690     $groupselect = '';
2691     if ($groupmode) {
2692         if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $modcontext)) {
2693             if ($currentgroup) {
2694                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2695                 $params['groupid'] = $currentgroup;
2696             }
2697         } else {
2698             if ($currentgroup) {
2699                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2700                 $params['groupid'] = $currentgroup;
2701             } else {
2702                 $groupselect = 'AND d.groupid = -1';
2703             }
2704         }
2705     }
2707     $params['forumid'] = $cm->instance;
2708     $params['discid1'] = $discussion->id;
2709     $params['discid2'] = $discussion->id;
2710     $params['discid3'] = $discussion->id;
2711     $params['discid4'] = $discussion->id;
2712     $params['disctimecompare1'] = $discussion->timemodified;
2713     $params['disctimecompare2'] = $discussion->timemodified;
2714     $params['pinnedstate1'] = (int) $discussion->pinned;
2715     $params['pinnedstate2'] = (int) $discussion->pinned;
2716     $params['pinnedstate3'] = (int) $discussion->pinned;
2717     $params['pinnedstate4'] = (int) $discussion->pinned;
2719     $sql = "SELECT d.id, d.name, d.timemodified, d.groupid, d.timestart, d.timeend
2720               FROM {forum_discussions} d
2721               JOIN {forum_posts} p ON d.firstpost = p.id
2722              WHERE d.forum = :forumid
2723                AND d.id <> :discid1
2724                    $timelimit
2725                    $groupselect";
2726     $comparefield = "d.timemodified";
2727     $comparevalue = ":disctimecompare1";
2728     $comparevalue2  = ":disctimecompare2";
2729     if (!empty($CFG->forum_enabletimedposts)) {
2730         // Here we need to take into account the release time (timestart)
2731         // if one is set, of the neighbouring posts and compare it to the
2732         // timestart or timemodified of *this* post depending on if the
2733         // release date of this post is in the future or not.
2734         // This stops discussions that appear later because of the
2735         // timestart value from being buried under discussions that were
2736         // made afterwards.
2737         $comparefield = "CASE WHEN d.timemodified < d.timestart
2738                                 THEN d.timestart ELSE d.timemodified END";
2739         if ($discussion->timemodified < $discussion->timestart) {
2740             // Normally we would just use the timemodified for sorting
2741             // discussion posts. However, when timed discussions are enabled,
2742             // then posts need to be sorted base on the later of timemodified
2743             // or the release date of the post (timestart).
2744             $params['disctimecompare1'] = $discussion->timestart;
2745             $params['disctimecompare2'] = $discussion->timestart;
2746         }
2747     }
2748     $orderbydesc = forum_get_default_sort_order(true, $comparefield, 'd', false);
2749     $orderbyasc = forum_get_default_sort_order(false, $comparefield, 'd', false);
2751     if ($forum->type === 'blog') {
2752          $subselect = "SELECT pp.created
2753                    FROM {forum_discussions} dd
2754                    JOIN {forum_posts} pp ON dd.firstpost = pp.id ";
2756          $subselectwhere1 = " WHERE dd.id = :discid3";
2757          $subselectwhere2 = " WHERE dd.id = :discid4";
2759          $comparefield = "p.created";
2761          $sub1 = $subselect.$subselectwhere1;
2762          $comparevalue = "($sub1)";
2764          $sub2 = $subselect.$subselectwhere2;
2765          $comparevalue2 = "($sub2)";
2767          $orderbydesc = "d.pinned, p.created DESC";
2768          $orderbyasc = "d.pinned, p.created ASC";
2769     }
2771     $prevsql = $sql . " AND ( (($comparefield < $comparevalue) AND :pinnedstate1 = d.pinned)
2772                          OR ($comparefield = $comparevalue2 AND (d.pinned = 0 OR d.pinned = :pinnedstate4) AND d.id < :discid2)
2773                          OR (d.pinned = 0 AND d.pinned <> :pinnedstate2))
2774                    ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbydesc, d.id DESC";
2776     $nextsql = $sql . " AND ( (($comparefield > $comparevalue) AND :pinnedstate1 = d.pinned)
2777                          OR ($comparefield = $comparevalue2 AND (d.pinned = 1 OR d.pinned = :pinnedstate4) AND d.id > :discid2)
2778                          OR (d.pinned = 1 AND d.pinned <> :pinnedstate2))
2779                    ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbyasc, d.id ASC";
2781     $neighbours['prev'] = $DB->get_record_sql($prevsql, $params, IGNORE_MULTIPLE);
2782     $neighbours['next'] = $DB->get_record_sql($nextsql, $params, IGNORE_MULTIPLE);
2783     return $neighbours;
2786 /**
2787  * Get the sql to use in the ORDER BY clause for forum discussions.
2788  *
2789  * This has the ordering take timed discussion windows into account.
2790  *
2791  * @param bool $desc True for DESC, False for ASC.
2792  * @param string $compare The field in the SQL to compare to normally sort by.
2793  * @param string $prefix The prefix being used for the discussion table.
2794  * @param bool $pinned sort pinned posts to the top
2795  * @return string
2796  */
2797 function forum_get_default_sort_order($desc = true, $compare = 'd.timemodified', $prefix = 'd', $pinned = true) {
2798     global $CFG;
2800     if (!empty($prefix)) {
2801         $prefix .= '.';
2802     }
2804     $dir = $desc ? 'DESC' : 'ASC';
2806     if ($pinned == true) {
2807         $pinned = "{$prefix}pinned DESC,";
2808     } else {
2809         $pinned = '';
2810     }
2812     $sort = "{$prefix}timemodified";
2813     if (!empty($CFG->forum_enabletimedposts)) {
2814         $sort = "CASE WHEN {$compare} < {$prefix}timestart
2815                  THEN {$prefix}timestart
2816                  ELSE {$compare}
2817                  END";
2818     }
2819     return "$pinned $sort $dir";
2822 /**
2823  *
2824  * @global object
2825  * @global object
2826  * @global object
2827  * @uses CONTEXT_MODULE
2828  * @uses VISIBLEGROUPS
2829  * @param object $cm
2830  * @return array
2831  */
2832 function forum_get_discussions_unread($cm) {
2833     global $CFG, $DB, $USER;
2835     $now = round(time(), -2);
2836     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2838     $params = array();
2839     $groupmode    = groups_get_activity_groupmode($cm);
2840     $currentgroup = groups_get_activity_group($cm);
2842     if ($groupmode) {
2843         $modcontext = context_module::instance($cm->id);
2845         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2846             if ($currentgroup) {
2847                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2848                 $params['currentgroup'] = $currentgroup;
2849             } else {
2850                 $groupselect = "";
2851             }
2853         } else {
2854             //separate groups without access all
2855             if ($currentgroup) {
2856                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2857                 $params['currentgroup'] = $currentgroup;
2858             } else {
2859                 $groupselect = "AND d.groupid = -1";
2860             }
2861         }
2862     } else {
2863         $groupselect = "";
2864     }
2866     if (!empty($CFG->forum_enabletimedposts)) {
2867         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2868         $params['now1'] = $now;
2869         $params['now2'] = $now;
2870     } else {
2871         $timedsql = "";
2872     }
2874     $sql = "SELECT d.id, COUNT(p.id) AS unread
2875               FROM {forum_discussions} d
2876                    JOIN {forum_posts} p     ON p.discussion = d.id
2877                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2878              WHERE d.forum = {$cm->instance}
2879                    AND p.modified >= :cutoffdate AND r.id is NULL
2880                    $groupselect
2881                    $timedsql
2882           GROUP BY d.id";
2883     $params['cutoffdate'] = $cutoffdate;
2885     if ($unreads = $DB->get_records_sql($sql, $params)) {
2886         foreach ($unreads as $unread) {
2887             $unreads[$unread->id] = $unread->unread;
2888         }
2889         return $unreads;
2890     } else {
2891         return array();
2892     }
2895 /**
2896  * @global object
2897  * @global object
2898  * @global object
2899  * @uses CONEXT_MODULE
2900  * @uses VISIBLEGROUPS
2901  * @param object $cm
2902  * @return array
2903  */
2904 function forum_get_discussions_count($cm) {
2905     global $CFG, $DB, $USER;
2907     $now = round(time(), -2);
2908     $params = array($cm->instance);
2909     $groupmode    = groups_get_activity_groupmode($cm);
2910     $currentgroup = groups_get_activity_group($cm);
2912     if ($groupmode) {
2913         $modcontext = context_module::instance($cm->id);
2915         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2916             if ($currentgroup) {
2917                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2918                 $params[] = $currentgroup;
2919             } else {
2920                 $groupselect = "";
2921             }
2923         } else {
2924             //seprate groups without access all
2925             if ($currentgroup) {
2926                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2927                 $params[] = $currentgroup;
2928             } else {
2929                 $groupselect = "AND d.groupid = -1";
2930             }
2931         }
2932     } else {
2933         $groupselect = "";
2934     }
2936     $timelimit = "";
2938     if (!empty($CFG->forum_enabletimedposts)) {
2940         $modcontext = context_module::instance($cm->id);
2942         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2943             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2944             $params[] = $now;
2945             $params[] = $now;
2946             if (isloggedin()) {
2947                 $timelimit .= " OR d.userid = ?";
2948                 $params[] = $USER->id;
2949             }
2950             $timelimit .= ")";
2951         }
2952     }
2954     $sql = "SELECT COUNT(d.id)
2955               FROM {forum_discussions} d
2956                    JOIN {forum_posts} p ON p.discussion = d.id
2957              WHERE d.forum = ? AND p.parent = 0
2958                    $groupselect $timelimit";
2960     return $DB->get_field_sql($sql, $params);
2964 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2967 /**
2968  * @global object
2969  * @global object
2970  * @param int $courseid
2971  * @param string $type
2972  */
2973 function forum_get_course_forum($courseid, $type) {
2974 // How to set up special 1-per-course forums
2975     global $CFG, $DB, $OUTPUT, $USER;
2977     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
2978         // There should always only be ONE, but with the right combination of
2979         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2980         foreach ($forums as $forum) {
2981             return $forum;   // ie the first one
2982         }
2983     }
2985     // Doesn't exist, so create one now.
2986     $forum = new stdClass();
2987     $forum->course = $courseid;
2988     $forum->type = "$type";
2989     if (!empty($USER->htmleditor)) {
2990         $forum->introformat = $USER->htmleditor;
2991     }
2992     switch ($forum->type) {
2993         case "news":
2994             $forum->name  = get_string("namenews", "forum");
2995             $forum->intro = get_string("intronews", "forum");
2996             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2997             $forum->assessed = 0;
2998             if ($courseid == SITEID) {
2999                 $forum->name  = get_string("sitenews");
3000                 $forum->forcesubscribe = 0;
3001             }
3002             break;
3003         case "social":
3004             $forum->name  = get_string("namesocial", "forum");
3005             $forum->intro = get_string("introsocial", "forum");
3006             $forum->assessed = 0;
3007             $forum->forcesubscribe = 0;
3008             break;
3009         case "blog":
3010             $forum->name = get_string('blogforum', 'forum');
3011             $forum->intro = get_string('introblog', 'forum');
3012             $forum->assessed = 0;
3013             $forum->forcesubscribe = 0;
3014             break;
3015         default:
3016             echo $OUTPUT->notification("That forum type doesn't exist!");
3017             return false;
3018             break;
3019     }
3021     $forum->timemodified = time();
3022     $forum->id = $DB->insert_record("forum", $forum);
3024     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
3025         echo $OUTPUT->notification("Could not find forum module!!");
3026         return false;
3027     }
3028     $mod = new stdClass();
3029     $mod->course = $courseid;
3030     $mod->module = $module->id;
3031     $mod->instance = $forum->id;
3032     $mod->section = 0;
3033     include_once("$CFG->dirroot/course/lib.php");
3034     if (! $mod->coursemodule = add_course_module($mod) ) {
3035         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
3036         return false;
3037     }
3038     $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
3039     return $DB->get_record("forum", array("id" => "$forum->id"));
3042 /**
3043  * Print a forum post
3044  *
3045  * @global object
3046  * @global object
3047  * @uses FORUM_MODE_THREADED
3048  * @uses PORTFOLIO_FORMAT_PLAINHTML
3049  * @uses PORTFOLIO_FORMAT_FILE
3050  * @uses PORTFOLIO_FORMAT_RICHHTML
3051  * @uses PORTFOLIO_ADD_TEXT_LINK
3052  * @uses CONTEXT_MODULE
3053  * @param object $post The post to print.
3054  * @param object $discussion
3055  * @param object $forum
3056  * @param object $cm
3057  * @param object $course
3058  * @param boolean $ownpost Whether this post belongs to the current user.
3059  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3060  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3061  * @param string $footer Extra stuff to print after the message.
3062  * @param string $highlight Space-separated list of terms to highlight.
3063  * @param int $post_read true, false or -99. If we already know whether this user
3064  *          has read this post, pass that in, otherwise, pass in -99, and this
3065  *          function will work it out.
3066  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3067  *          the current user can't see this post, if this argument is true
3068  *          (the default) then print a dummy 'you can't see this post' post.
3069  *          If false, don't output anything at all.
3070  * @param bool|null $istracked
3071  * @return void
3072  */
3073 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3074                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3075     global $USER, $CFG, $OUTPUT;
3077     require_once($CFG->libdir . '/filelib.php');
3079     // String cache
3080     static $str;
3082     $modcontext = context_module::instance($cm->id);
3084     $post->course = $course->id;
3085     $post->forum  = $forum->id;
3086     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3087     if (!empty($CFG->enableplagiarism)) {
3088         require_once($CFG->libdir.'/plagiarismlib.php');
3089         $post->message .= plagiarism_get_links(array('userid' => $post->userid,
3090             'content' => $post->message,
3091             'cmid' => $cm->id,
3092             'course' => $post->course,
3093             'forum' => $post->forum));
3094     }
3096     // caching
3097     if (!isset($cm->cache)) {
3098         $cm->cache = new stdClass;
3099     }
3101     if (!isset($cm->cache->caps)) {
3102         $cm->cache->caps = array();
3103         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3104         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3105         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3106         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3107         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3108         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3109         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3110         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3111         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3112     }
3114     if (!isset($cm->uservisible)) {
3115         $cm->uservisible = \core_availability\info_module::is_user_visible($cm, 0, false);
3116     }
3118     if ($istracked && is_null($postisread)) {
3119         $postisread = forum_tp_is_post_read($USER->id, $post);
3120     }
3122     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
3123         $output = '';
3124         if (!$dummyifcantsee) {
3125             if ($return) {
3126                 return $output;
3127             }
3128             echo $output;
3129             return;
3130         }
3131         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3132         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix',
3133                                                        'role' => 'region',
3134                                                        'aria-label' => get_string('hiddenforumpost', 'forum')));
3135         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3136         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3137         if ($post->parent) {
3138             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3139         } else {
3140             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3141         }
3142         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class' => 'subject',
3143                                                                                            'role' => 'header')); // Subject.
3144         $output .= html_writer::tag('div', get_string('forumauthorhidden', 'forum'), array('class' => 'author',
3145                                                                                            'role' => 'header')); // Author.
3146         $output .= html_writer::end_tag('div');
3147         $output .= html_writer::end_tag('div'); // row
3148         $output .= html_writer::start_tag('div', array('class'=>'row'));
3149         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3150         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3151         $output .= html_writer::end_tag('div'); // row
3152         $output .= html_writer::end_tag('div'); // forumpost
3154         if ($return) {
3155             return $output;
3156         }
3157         echo $output;
3158         return;
3159     }
3161     if (empty($str)) {
3162         $str = new stdClass;
3163         $str->edit         = get_string('edit', 'forum');
3164         $str->delete       = get_string('delete', 'forum');
3165         $str->reply        = get_string('reply', 'forum');
3166         $str->parent       = get_string('parent', 'forum');
3167         $str->pruneheading = get_string('pruneheading', 'forum');
3168         $str->prune        = get_string('prune', 'forum');
3169         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3170         $str->markread     = get_string('markread', 'forum');
3171         $str->markunread   = get_string('markunread', 'forum');
3172     }
3174     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3176     // Build an object that represents the posting user
3177     $postuser = new stdClass;
3178     $postuserfields = explode(',', user_picture::fields());
3179     $postuser = username_load_fields_from_object($postuser, $post, null, $postuserfields);
3180     $postuser->id = $post->userid;
3181     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3182     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3184     // Prepare the groups the posting user belongs to
3185     if (isset($cm->cache->usersgroups)) {
3186         $groups = array();
3187         if (isset($cm->cache->usersgroups[$post->userid])) {
3188             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3189                 $groups[$gid] = $cm->cache->groups[$gid];
3190             }
3191         }
3192     } else {
3193         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3194     }
3196     // Prepare the attachements for the post, files then images
3197     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3199     // Determine if we need to shorten this post
3200     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3203     // Prepare an array of commands
3204     $commands = array();
3206     // Add a permalink.
3207     $permalink = new moodle_url($discussionlink);
3208     $permalink->set_anchor('p' . $post->id);
3209     $commands[] = array('url' => $permalink, 'text' => get_string('permalink', 'forum'));
3211     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3212     // Don't display the mark read / unread controls in this case.
3213     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3214         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3215         $text = $str->markunread;
3216         if (!$postisread) {
3217             $url->param('mark', 'read');
3218             $text = $str->markread;
3219         }
3220         if ($str->displaymode == FORUM_MODE_THREADED) {
3221             $url->param('parent', $post->parent);
3222         } else {
3223             $url->set_anchor('p'.$post->id);
3224         }
3225         $commands[] = array('url'=>$url, 'text'=>$text);
3226     }
3228     // Zoom in to the parent specifically
3229     if ($post->parent) {
3230         $url = new moodle_url($discussionlink);
3231         if ($str->displaymode == FORUM_MODE_THREADED) {
3232             $url->param('parent', $post->parent);
3233         } else {
3234             $url->set_anchor('p'.$post->parent);
3235         }
3236         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3237     }
3239     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3240     $age = time() - $post->created;
3241     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3242         $age = 0;
3243     }
3245     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3246         if (has_capability('moodle/course:manageactivities', $modcontext)) {
3247             // The first post in single simple is the forum description.
3248             $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
3249         }
3250     } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3251         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3252     }
3254     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3255         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3256     }
3258     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3259         // Do not allow deleting of first post in single simple type.
3260     } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3261         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3262     }
3264     if ($reply) {
3265         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
3266     }
3268     if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
3269         $p = array('postid' => $post->id);
3270         require_once($CFG->libdir.'/portfoliolib.php');
3271         $button = new portfolio_add_button();
3272         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
3273         if (empty($attachments)) {
3274             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3275         } else {
3276             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3277         }
3279         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3280         if (!empty($porfoliohtml)) {
3281             $commands[] = $porfoliohtml;
3282         }
3283     }
3284     // Finished building commands
3287     // Begin output
3289     $output  = '';
3291     if ($istracked) {
3292         if ($postisread) {
3293             $forumpostclass = ' read';
3294         } else {
3295             $forumpostclass = ' unread';
3296             $output .= html_writer::tag('a', '', array('name'=>'unread'));
3297         }
3298     } else {
3299         // ignore trackign status if not tracked or tracked param missing
3300         $forumpostclass = '';
3301     }
3303     $topicclass = '';
3304     if (empty($post->parent)) {
3305         $topicclass = ' firstpost starter';
3306     }
3308     if (!empty($post->lastpost)) {
3309         $forumpostclass .= ' lastpost';
3310     }
3312     $postbyuser = new stdClass;
3313     $postbyuser->post = $post->subject;
3314     $postbyuser->user = $postuser->fullname;
3315     $discussionbyuser = get_string('postbyuser', 'forum', $postbyuser);
3316     $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3317     $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass,
3318                                                    'role' => 'region',
3319                                                    'aria-label' => $discussionbyuser));
3320     $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
3321     $output .= html_writer::start_tag('div', array('class'=>'left picture'));
3322     $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
3323     $output .= html_writer::end_tag('div');
3326     $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
3328     $postsubject = $post->subject;
3329     if (empty($post->subjectnoformat)) {
3330         $postsubject = format_string($postsubject);
3331     }
3332     $output .= html_writer::tag('div', $postsubject, array('class'=>'subject',
3333                                                            'role' => 'heading',
3334                                                            'aria-level' => '2'));
3336     $by = new stdClass();
3337     $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
3338     $by->date = userdate($post->modified);
3339     $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author',
3340                                                                                        'role' => 'heading',
3341                                                                                        'aria-level' => '2'));
3343     $output .= html_writer::end_tag('div'); //topic
3344     $output .= html_writer::end_tag('div'); //row
3346     $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
3347     $output .= html_writer::start_tag('div', array('class'=>'left'));
3349     $groupoutput = '';
3350     if ($groups) {
3351         $groupoutput = print_group_picture($groups, $course->id, false, true, true);
3352     }
3353     if (empty($groupoutput)) {
3354         $groupoutput = '&nbsp;';
3355     }
3356     $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
3358     $output .= html_writer::end_tag('div'); //left side
3359     $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
3360     $output .= html_writer::start_tag('div', array('class'=>'content'));
3362     $options = new stdClass;
3363     $options->para    = false;
3364     $options->trusted = $post->messagetrust;
3365     $options->context = $modcontext;
3366     if ($shortenpost) {
3367         // Prepare shortened version by filtering the text then shortening it.
3368         $postclass    = 'shortenedpost';
3369         $postcontent  = format_text($post->message, $post->messageformat, $options);
3370         $postcontent  = shorten_text($postcontent, $CFG->forum_shortpost);
3371         $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
3372         $postcontent .= html_writer::tag('div', '('.get_string('numwords', 'moodle', count_words($post->message)).')',
3373             array('class'=>'post-word-count'));
3374     } else {
3375         // Prepare whole post
3376         $postclass    = 'fullpost';
3377         $postcontent  = format_text($post->message, $post->messageformat, $options, $course->id);
3378         if (!empty($highlight)) {
3379             $postcontent = highlight($highlight, $postcontent);
3380         }
3381         if (!empty($forum->displaywordcount)) {
3382             $postcontent .= html_writer::tag('div', get_string('numwords', 'moodle', count_words($post->message)),
3383                 array('class'=>'post-word-count'));
3384         }
3385         $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
3386     }
3388     // Output the post content
3389     $output .= html_writer::tag('div', $postcontent, array('class'=>'posting '.$postclass));
3390     $output .= html_writer::end_tag('div'); // Content
3391     $output .= html_writer::end_tag('div'); // Content mask
3392     $output .= html_writer::end_tag('div'); // Row
3394     $output .= html_writer::start_tag('div', array('class'=>'row side'));
3395     $output .= html_writer::tag('div','&nbsp;', array('class'=>'left'));
3396     $output .= html_writer::start_tag('div', array('class'=>'options clearfix'));
3398     if (!empty($attachments)) {
3399         $output .= html_writer::tag('div', $attachments, array('class' => 'attachments'));
3400     }
3402     // Output ratings
3403     if (!empty($post->rating)) {
3404         $output .= html_writer::tag('div', $OUTPUT->render($post->rating), array('class'=>'forum-post-rating'));
3405     }
3407     // Output the commands
3408     $commandhtml = array();
3409     foreach ($commands as $command) {
3410         if (is_array($command)) {
3411             $commandhtml[] = html_writer::link($command['url'], $command['text']);
3412         } else {
3413             $commandhtml[] = $command;
3414         }
3415     }
3416     $output .= html_writer::tag('div', implode(' | ', $commandhtml), array('class'=>'commands'));
3418     // Output link to post if required
3419     if ($link && forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext)) {
3420         if ($post->replies == 1) {
3421             $replystring = get_string('repliesone', 'forum', $post->replies);
3422         } else {
3423             $replystring = get_string('repliesmany', 'forum', $post->replies);
3424         }
3425         if (!empty($discussion->unread) && $discussion->unread !== '-') {
3426             $replystring .= ' <span class="sep">/</span> <span class="unread">';
3427             if ($discussion->unread == 1) {
3428                 $replystring .= get_string('unreadpostsone', 'forum');
3429             } else {
3430                 $replystring .= get_string('unreadpostsnumber', 'forum', $discussion->unread);
3431             }
3432             $replystring .= '</span>';
3433         }