Merge branch 'MDL-62077-master' of git://github.com/bmbrands/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     $completiontimeexpected = !empty($forum->completionexpected) ? $forum->completionexpected : null;
134     \core_completion\api::update_completion_date_event($forum->coursemodule, 'forum', $forum->id, $completiontimeexpected);
136     return $forum->id;
139 /**
140  * Handle changes following the creation of a forum instance.
141  * This function is typically called by the course_module_created observer.
142  *
143  * @param object $context the forum context
144  * @param stdClass $forum The forum object
145  * @return void
146  */
147 function forum_instance_created($context, $forum) {
148     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
149         $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email');
150         foreach ($users as $user) {
151             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context);
152         }
153     }
156 /**
157  * Given an object containing all the necessary data,
158  * (defined by the form in mod_form.php) this function
159  * will update an existing instance with new data.
160  *
161  * @global object
162  * @param object $forum forum instance (with magic quotes)
163  * @return bool success
164  */
165 function forum_update_instance($forum, $mform) {
166     global $DB, $OUTPUT, $USER;
168     $forum->timemodified = time();
169     $forum->id           = $forum->instance;
171     if (empty($forum->assessed)) {
172         $forum->assessed = 0;
173     }
175     if (empty($forum->ratingtime) or empty($forum->assessed)) {
176         $forum->assesstimestart  = 0;
177         $forum->assesstimefinish = 0;
178     }
180     $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
182     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
183     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
184     // 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
185     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
186         forum_update_grades($forum); // recalculate grades for the forum
187     }
189     if ($forum->type == 'single') {  // Update related discussion and post.
190         $discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC');
191         if (!empty($discussions)) {
192             if (count($discussions) > 1) {
193                 echo $OUTPUT->notification(get_string('warnformorepost', 'forum'));
194             }
195             $discussion = array_pop($discussions);
196         } else {
197             // try to recover by creating initial discussion - MDL-16262
198             $discussion = new stdClass();
199             $discussion->course          = $forum->course;
200             $discussion->forum           = $forum->id;
201             $discussion->name            = $forum->name;
202             $discussion->assessed        = $forum->assessed;
203             $discussion->message         = $forum->intro;
204             $discussion->messageformat   = $forum->introformat;
205             $discussion->messagetrust    = true;
206             $discussion->mailnow         = false;
207             $discussion->groupid         = -1;
209             $message = '';
211             forum_add_discussion($discussion, null, $message);
213             if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
214                 print_error('cannotadd', 'forum');
215             }
216         }
217         if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
218             print_error('cannotfindfirstpost', 'forum');
219         }
221         $cm         = get_coursemodule_from_instance('forum', $forum->id);
222         $modcontext = context_module::instance($cm->id, MUST_EXIST);
224         $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
225         $post->subject       = $forum->name;
226         $post->message       = $forum->intro;
227         $post->messageformat = $forum->introformat;
228         $post->messagetrust  = trusttext_trusted($modcontext);
229         $post->modified      = $forum->timemodified;
230         $post->userid        = $USER->id;    // MDL-18599, so that current teacher can take ownership of activities.
232         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
233             // Ugly hack - we need to copy the files somehow.
234             $options = array('subdirs'=>true); // Use the same options as intro field!
235             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
236         }
238         $DB->update_record('forum_posts', $post);
239         $discussion->name = $forum->name;
240         $DB->update_record('forum_discussions', $discussion);
241     }
243     $DB->update_record('forum', $forum);
245     $modcontext = context_module::instance($forum->coursemodule);
246     if (($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) && ($oldforum->forcesubscribe <> $forum->forcesubscribe)) {
247         $users = \mod_forum\subscriptions::get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
248         foreach ($users as $user) {
249             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $modcontext);
250         }
251     }
253     forum_grade_item_update($forum);
255     $completiontimeexpected = !empty($forum->completionexpected) ? $forum->completionexpected : null;
256     \core_completion\api::update_completion_date_event($forum->coursemodule, 'forum', $forum->id, $completiontimeexpected);
258     return true;
262 /**
263  * Given an ID of an instance of this module,
264  * this function will permanently delete the instance
265  * and any data that depends on it.
266  *
267  * @global object
268  * @param int $id forum instance id
269  * @return bool success
270  */
271 function forum_delete_instance($id) {
272     global $DB;
274     if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
275         return false;
276     }
277     if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
278         return false;
279     }
280     if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
281         return false;
282     }
284     $context = context_module::instance($cm->id);
286     // now get rid of all files
287     $fs = get_file_storage();
288     $fs->delete_area_files($context->id);
290     $result = true;
292     \core_completion\api::update_completion_date_event($cm->id, 'forum', $forum->id, null);
294     // Delete digest and subscription preferences.
295     $DB->delete_records('forum_digests', array('forum' => $forum->id));
296     $DB->delete_records('forum_subscriptions', array('forum'=>$forum->id));
297     $DB->delete_records('forum_discussion_subs', array('forum' => $forum->id));
299     if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
300         foreach ($discussions as $discussion) {
301             if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
302                 $result = false;
303             }
304         }
305     }
307     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
309     if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
310         $result = false;
311     }
313     forum_grade_item_delete($forum);
315     return $result;
319 /**
320  * Indicates API features that the forum supports.
321  *
322  * @uses FEATURE_GROUPS
323  * @uses FEATURE_GROUPINGS
324  * @uses FEATURE_MOD_INTRO
325  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
326  * @uses FEATURE_COMPLETION_HAS_RULES
327  * @uses FEATURE_GRADE_HAS_GRADE
328  * @uses FEATURE_GRADE_OUTCOMES
329  * @param string $feature
330  * @return mixed True if yes (some features may use other values)
331  */
332 function forum_supports($feature) {
333     switch($feature) {
334         case FEATURE_GROUPS:                  return true;
335         case FEATURE_GROUPINGS:               return true;
336         case FEATURE_MOD_INTRO:               return true;
337         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
338         case FEATURE_COMPLETION_HAS_RULES:    return true;
339         case FEATURE_GRADE_HAS_GRADE:         return true;
340         case FEATURE_GRADE_OUTCOMES:          return true;
341         case FEATURE_RATE:                    return true;
342         case FEATURE_BACKUP_MOODLE2:          return true;
343         case FEATURE_SHOW_DESCRIPTION:        return true;
344         case FEATURE_PLAGIARISM:              return true;
346         default: return null;
347     }
351 /**
352  * Obtains the automatic completion state for this forum based on any conditions
353  * in forum settings.
354  *
355  * @global object
356  * @global object
357  * @param object $course Course
358  * @param object $cm Course-module
359  * @param int $userid User ID
360  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
361  * @return bool True if completed, false if not. (If no conditions, then return
362  *   value depends on comparison type)
363  */
364 function forum_get_completion_state($course,$cm,$userid,$type) {
365     global $CFG,$DB;
367     // Get forum details
368     if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
369         throw new Exception("Can't find forum {$cm->instance}");
370     }
372     $result=$type; // Default return value
374     $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
375     $postcountsql="
376 SELECT
377     COUNT(1)
378 FROM
379     {forum_posts} fp
380     INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
381 WHERE
382     fp.userid=:userid AND fd.forum=:forumid";
384     if ($forum->completiondiscussions) {
385         $value = $forum->completiondiscussions <=
386                  $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
387         if ($type == COMPLETION_AND) {
388             $result = $result && $value;
389         } else {
390             $result = $result || $value;
391         }
392     }
393     if ($forum->completionreplies) {
394         $value = $forum->completionreplies <=
395                  $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
396         if ($type==COMPLETION_AND) {
397             $result = $result && $value;
398         } else {
399             $result = $result || $value;
400         }
401     }
402     if ($forum->completionposts) {
403         $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
404         if ($type == COMPLETION_AND) {
405             $result = $result && $value;
406         } else {
407             $result = $result || $value;
408         }
409     }
411     return $result;
414 /**
415  * Create a message-id string to use in the custom headers of forum notification emails
416  *
417  * message-id is used by email clients to identify emails and to nest conversations
418  *
419  * @param int $postid The ID of the forum post we are notifying the user about
420  * @param int $usertoid The ID of the user being notified
421  * @return string A unique message-id
422  */
423 function forum_get_email_message_id($postid, $usertoid) {
424     return generate_email_messageid(hash('sha256', $postid . 'to' . $usertoid));
427 /**
428  * Removes properties from user record that are not necessary
429  * for sending post notifications.
430  * @param stdClass $user
431  * @return void, $user parameter is modified
432  */
433 function forum_cron_minimise_user_record(stdClass $user) {
435     // We store large amount of users in one huge array,
436     // make sure we do not store info there we do not actually need
437     // in mail generation code or messaging.
439     unset($user->institution);
440     unset($user->department);
441     unset($user->address);
442     unset($user->city);
443     unset($user->url);
444     unset($user->currentlogin);
445     unset($user->description);
446     unset($user->descriptionformat);
449 /**
450  * Function to be run periodically according to the scheduled task.
451  *
452  * Finds all posts that have yet to be mailed out, and mails them
453  * out to all subscribers as well as other maintance tasks.
454  *
455  * NOTE: Since 2.7.2 this function is run by scheduled task rather
456  * than standard cron.
457  *
458  * @todo MDL-44734 The function will be split up into seperate tasks.
459  */
460 function forum_cron() {
461     global $CFG, $USER, $DB, $PAGE;
463     $site = get_site();
465     // The main renderers.
466     $htmlout = $PAGE->get_renderer('mod_forum', 'email', 'htmlemail');
467     $textout = $PAGE->get_renderer('mod_forum', 'email', 'textemail');
468     $htmldigestfullout = $PAGE->get_renderer('mod_forum', 'emaildigestfull', 'htmlemail');
469     $textdigestfullout = $PAGE->get_renderer('mod_forum', 'emaildigestfull', 'textemail');
470     $htmldigestbasicout = $PAGE->get_renderer('mod_forum', 'emaildigestbasic', 'htmlemail');
471     $textdigestbasicout = $PAGE->get_renderer('mod_forum', 'emaildigestbasic', 'textemail');
473     // All users that are subscribed to any post that needs sending,
474     // please increase $CFG->extramemorylimit on large sites that
475     // send notifications to a large number of users.
476     $users = array();
477     $userscount = 0; // Cached user counter - count($users) in PHP is horribly slow!!!
479     // Status arrays.
480     $mailcount  = array();
481     $errorcount = array();
483     // caches
484     $discussions        = array();
485     $forums             = array();
486     $courses            = array();
487     $coursemodules      = array();
488     $subscribedusers    = array();
489     $messageinboundhandlers = array();
491     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
492     // cron has not been running for a long time, and then suddenly people are flooded
493     // with mail from the past few weeks or months
494     $timenow   = time();
495     $endtime   = $timenow - $CFG->maxeditingtime;
496     $starttime = $endtime - 48 * 3600;   // Two days earlier
498     // Get the list of forum subscriptions for per-user per-forum maildigest settings.
499     $digestsset = $DB->get_recordset('forum_digests', null, '', 'id, userid, forum, maildigest');
500     $digests = array();
501     foreach ($digestsset as $thisrow) {
502         if (!isset($digests[$thisrow->forum])) {
503             $digests[$thisrow->forum] = array();
504         }
505         $digests[$thisrow->forum][$thisrow->userid] = $thisrow->maildigest;
506     }
507     $digestsset->close();
509     // Create the generic messageinboundgenerator.
510     $messageinboundgenerator = new \core\message\inbound\address_manager();
511     $messageinboundgenerator->set_handler('\mod_forum\message\inbound\reply_handler');
513     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
514         // Mark them all now as being mailed.  It's unlikely but possible there
515         // might be an error later so that a post is NOT actually mailed out,
516         // but since mail isn't crucial, we can accept this risk.  Doing it now
517         // prevents the risk of duplicated mails, which is a worse problem.
519         if (!forum_mark_old_posts_as_mailed($endtime)) {
520             mtrace('Errors occurred while trying to mark some posts as being mailed.');
521             return false;  // Don't continue trying to mail them, in case we are in a cron loop
522         }
524         // checking post validity, and adding users to loop through later
525         foreach ($posts as $pid => $post) {
527             $discussionid = $post->discussion;
528             if (!isset($discussions[$discussionid])) {
529                 if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
530                     $discussions[$discussionid] = $discussion;
531                     \mod_forum\subscriptions::fill_subscription_cache($discussion->forum);
532                     \mod_forum\subscriptions::fill_discussion_subscription_cache($discussion->forum);
534                 } else {
535                     mtrace('Could not find discussion ' . $discussionid);
536                     unset($posts[$pid]);
537                     continue;
538                 }
539             }
540             $forumid = $discussions[$discussionid]->forum;
541             if (!isset($forums[$forumid])) {
542                 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
543                     $forums[$forumid] = $forum;
544                 } else {
545                     mtrace('Could not find forum '.$forumid);
546                     unset($posts[$pid]);
547                     continue;
548                 }
549             }
550             $courseid = $forums[$forumid]->course;
551             if (!isset($courses[$courseid])) {
552                 if ($course = $DB->get_record('course', array('id' => $courseid))) {
553                     $courses[$courseid] = $course;
554                 } else {
555                     mtrace('Could not find course '.$courseid);
556                     unset($posts[$pid]);
557                     continue;
558                 }
559             }
560             if (!isset($coursemodules[$forumid])) {
561                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
562                     $coursemodules[$forumid] = $cm;
563                 } else {
564                     mtrace('Could not find course module for forum '.$forumid);
565                     unset($posts[$pid]);
566                     continue;
567                 }
568             }
570             $modcontext = context_module::instance($coursemodules[$forumid]->id);
572             // Save the Inbound Message datakey here to reduce DB queries later.
573             $messageinboundgenerator->set_data($pid);
574             $messageinboundhandlers[$pid] = $messageinboundgenerator->fetch_data_key();
576             // Caching subscribed users of each forum.
577             if (!isset($subscribedusers[$forumid])) {
578                 if ($subusers = \mod_forum\subscriptions::fetch_subscribed_users($forums[$forumid], 0, $modcontext, 'u.*', true)) {
580                     foreach ($subusers as $postuser) {
581                         // this user is subscribed to this forum
582                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
583                         $userscount++;
584                         if ($userscount > FORUM_CRON_USER_CACHE) {
585                             // Store minimal user info.
586                             $minuser = new stdClass();
587                             $minuser->id = $postuser->id;
588                             $users[$postuser->id] = $minuser;
589                         } else {
590                             // Cache full user record.
591                             forum_cron_minimise_user_record($postuser);
592                             $users[$postuser->id] = $postuser;
593                         }
594                     }
595                     // Release memory.
596                     unset($subusers);
597                     unset($postuser);
598                 }
599             }
600             $mailcount[$pid] = 0;
601             $errorcount[$pid] = 0;
602         }
603     }
605     if ($users && $posts) {
607         foreach ($users as $userto) {
608             // Terminate if processing of any account takes longer than 2 minutes.
609             core_php_time_limit::raise(120);
611             mtrace('Processing user ' . $userto->id);
613             // Init user caches - we keep the cache for one cycle only, otherwise it could consume too much memory.
614             if (isset($userto->username)) {
615                 $userto = clone($userto);
616             } else {
617                 $userto = $DB->get_record('user', array('id' => $userto->id));
618                 forum_cron_minimise_user_record($userto);
619             }
620             $userto->viewfullnames = array();
621             $userto->canpost       = array();
622             $userto->markposts     = array();
624             // Setup this user so that the capabilities are cached, and environment matches receiving user.
625             cron_setup_user($userto);
627             // Reset the caches.
628             foreach ($coursemodules as $forumid => $unused) {
629                 $coursemodules[$forumid]->cache       = new stdClass();
630                 $coursemodules[$forumid]->cache->caps = array();
631                 unset($coursemodules[$forumid]->uservisible);
632             }
634             foreach ($posts as $pid => $post) {
635                 $discussion = $discussions[$post->discussion];
636                 $forum      = $forums[$discussion->forum];
637                 $course     = $courses[$forum->course];
638                 $cm         =& $coursemodules[$forum->id];
640                 // Do some checks to see if we can bail out now.
642                 // Only active enrolled users are in the list of subscribers.
643                 // This does not necessarily mean that the user is subscribed to the forum or to the discussion though.
644                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
645                     // The user does not subscribe to this forum.
646                     continue;
647                 }
649                 if (!\mod_forum\subscriptions::is_subscribed($userto->id, $forum, $post->discussion, $coursemodules[$forum->id])) {
650                     // The user does not subscribe to this forum, or to this specific discussion.
651                     continue;
652                 }
654                 if ($subscriptiontime = \mod_forum\subscriptions::fetch_discussion_subscription($forum->id, $userto->id)) {
655                     // Skip posts if the user subscribed to the discussion after it was created.
656                     if (isset($subscriptiontime[$post->discussion]) && ($subscriptiontime[$post->discussion] > $post->created)) {
657                         continue;
658                     }
659                 }
661                 // Don't send email if the forum is Q&A and the user has not posted.
662                 // Initial topics are still mailed.
663                 if ($forum->type == 'qanda' && !forum_get_user_posted_time($discussion->id, $userto->id) && $pid != $discussion->firstpost) {
664                     mtrace('Did not email ' . $userto->id.' because user has not posted in discussion');
665                     continue;
666                 }
668                 // Get info about the sending user.
669                 if (array_key_exists($post->userid, $users)) {
670                     // We might know the user already.
671                     $userfrom = $users[$post->userid];
672                     if (!isset($userfrom->idnumber)) {
673                         // Minimalised user info, fetch full record.
674                         $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
675                         forum_cron_minimise_user_record($userfrom);
676                     }
678                 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
679                     forum_cron_minimise_user_record($userfrom);
680                     // Fetch only once if possible, we can add it to user list, it will be skipped anyway.
681                     if ($userscount <= FORUM_CRON_USER_CACHE) {
682                         $userscount++;
683                         $users[$userfrom->id] = $userfrom;
684                     }
685                 } else {
686                     mtrace('Could not find user ' . $post->userid . ', author of post ' . $post->id . '. Unable to send message.');
687                     continue;
688                 }
690                 // Note: If we want to check that userto and userfrom are not the same person this is probably the spot to do it.
692                 // Setup global $COURSE properly - needed for roles and languages.
693                 cron_setup_user($userto, $course);
695                 // Fill caches.
696                 if (!isset($userto->viewfullnames[$forum->id])) {
697                     $modcontext = context_module::instance($cm->id);
698                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
699                 }
700                 if (!isset($userto->canpost[$discussion->id])) {
701                     $modcontext = context_module::instance($cm->id);
702                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
703                 }
704                 if (!isset($userfrom->groups[$forum->id])) {
705                     if (!isset($userfrom->groups)) {
706                         $userfrom->groups = array();
707                         if (isset($users[$userfrom->id])) {
708                             $users[$userfrom->id]->groups = array();
709                         }
710                     }
711                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
712                     if (isset($users[$userfrom->id])) {
713                         $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
714                     }
715                 }
717                 // Make sure groups allow this user to see this email.
718                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {
719                     // Groups are being used.
720                     if (!groups_group_exists($discussion->groupid)) {
721                         // Can't find group - be safe and don't this message.
722                         continue;
723                     }
725                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
726                         // Do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS.
727                         continue;
728                     }
729                 }
731                 // Make sure we're allowed to see the post.
732                 if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
733                     mtrace('User ' . $userto->id .' can not see ' . $post->id . '. Not sending message.');
734                     continue;
735                 }
737                 // OK so we need to send the email.
739                 // Does the user want this post in a digest?  If so postpone it for now.
740                 $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
742                 if ($maildigest > 0) {
743                     // This user wants the mails to be in digest form.
744                     $queue = new stdClass();
745                     $queue->userid       = $userto->id;
746                     $queue->discussionid = $discussion->id;
747                     $queue->postid       = $post->id;
748                     $queue->timemodified = $post->created;
749                     $DB->insert_record('forum_queue', $queue);
750                     continue;
751                 }
753                 // Prepare to actually send the post now, and build up the content.
755                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
757                 $userfrom->customheaders = array (
758                     // Headers to make emails easier to track.
759                     'List-Id: "'        . $cleanforumname . '" ' . generate_email_messageid('moodleforum' . $forum->id),
760                     'List-Help: '       . $CFG->wwwroot . '/mod/forum/view.php?f=' . $forum->id,
761                     'Message-ID: '      . forum_get_email_message_id($post->id, $userto->id),
762                     'X-Course-Id: '     . $course->id,
763                     'X-Course-Name: '   . format_string($course->fullname, true),
765                     // Headers to help prevent auto-responders.
766                     'Precedence: Bulk',
767                     'X-Auto-Response-Suppress: All',
768                     'Auto-Submitted: auto-generated',
769                 );
771                 $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
773                 // Generate a reply-to address from using the Inbound Message handler.
774                 $replyaddress = null;
775                 if ($userto->canpost[$discussion->id] && array_key_exists($post->id, $messageinboundhandlers)) {
776                     $messageinboundgenerator->set_data($post->id, $messageinboundhandlers[$post->id]);
777                     $replyaddress = $messageinboundgenerator->generate($userto->id);
778                 }
780                 if (!isset($userto->canpost[$discussion->id])) {
781                     $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
782                 } else {
783                     $canreply = $userto->canpost[$discussion->id];
784                 }
786                 $data = new \mod_forum\output\forum_post_email(
787                         $course,
788                         $cm,
789                         $forum,
790                         $discussion,
791                         $post,
792                         $userfrom,
793                         $userto,
794                         $canreply
795                     );
797                 $userfrom->customheaders[] = sprintf('List-Unsubscribe: <%s>',
798                     $data->get_unsubscribediscussionlink());
800                 if (!isset($userto->viewfullnames[$forum->id])) {
801                     $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
802                 } else {
803                     $data->viewfullnames = $userto->viewfullnames[$forum->id];
804                 }
806                 // Not all of these variables are used in the default language
807                 // string but are made available to support custom subjects.
808                 $a = new stdClass();
809                 $a->subject = $data->get_subject();
810                 $a->forumname = $cleanforumname;
811                 $a->sitefullname = format_string($site->fullname);
812                 $a->siteshortname = format_string($site->shortname);
813                 $a->courseidnumber = $data->get_courseidnumber();
814                 $a->coursefullname = $data->get_coursefullname();
815                 $a->courseshortname = $data->get_coursename();
816                 $postsubject = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
818                 $rootid = forum_get_email_message_id($discussion->firstpost, $userto->id);
820                 if ($post->parent) {
821                     // This post is a reply, so add reply header (RFC 2822).
822                     $parentid = forum_get_email_message_id($post->parent, $userto->id);
823                     $userfrom->customheaders[] = "In-Reply-To: $parentid";
825                     // If the post is deeply nested we also reference the parent message id and
826                     // the root message id (if different) to aid threading when parts of the email
827                     // conversation have been deleted (RFC1036).
828                     if ($post->parent != $discussion->firstpost) {
829                         $userfrom->customheaders[] = "References: $rootid $parentid";
830                     } else {
831                         $userfrom->customheaders[] = "References: $parentid";
832                     }
833                 }
835                 // MS Outlook / Office uses poorly documented and non standard headers, including
836                 // Thread-Topic which overrides the Subject and shouldn't contain Re: or Fwd: etc.
837                 $a->subject = $discussion->name;
838                 $threadtopic = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
839                 $userfrom->customheaders[] = "Thread-Topic: $threadtopic";
840                 $userfrom->customheaders[] = "Thread-Index: " . substr($rootid, 1, 28);
842                 // Send the post now!
843                 mtrace('Sending ', '');
845                 $eventdata = new \core\message\message();
846                 $eventdata->courseid            = $course->id;
847                 $eventdata->component           = 'mod_forum';
848                 $eventdata->name                = 'posts';
849                 $eventdata->userfrom            = $userfrom;
850                 $eventdata->userto              = $userto;
851                 $eventdata->subject             = $postsubject;
852                 $eventdata->fullmessage         = $textout->render($data);
853                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
854                 $eventdata->fullmessagehtml     = $htmlout->render($data);
855                 $eventdata->notification        = 1;
856                 $eventdata->replyto             = $replyaddress;
857                 if (!empty($replyaddress)) {
858                     // Add extra text to email messages if they can reply back.
859                     $textfooter = "\n\n" . get_string('replytopostbyemail', 'mod_forum');
860                     $htmlfooter = html_writer::tag('p', get_string('replytopostbyemail', 'mod_forum'));
861                     $additionalcontent = array('fullmessage' => array('footer' => $textfooter),
862                                      'fullmessagehtml' => array('footer' => $htmlfooter));
863                     $eventdata->set_additional_content('email', $additionalcontent);
864                 }
866                 $smallmessagestrings = new stdClass();
867                 $smallmessagestrings->user          = fullname($userfrom);
868                 $smallmessagestrings->forumname     = "$shortname: " . format_string($forum->name, true) . ": " . $discussion->name;
869                 $smallmessagestrings->message       = $post->message;
871                 // Make sure strings are in message recipients language.
872                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
874                 $contexturl = new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id), 'p' . $post->id);
875                 $eventdata->contexturl = $contexturl->out();
876                 $eventdata->contexturlname = $discussion->name;
878                 $mailresult = message_send($eventdata);
879                 if (!$mailresult) {
880                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
881                             " ($userto->email) .. not trying again.");
882                     $errorcount[$post->id]++;
883                 } else {
884                     $mailcount[$post->id]++;
886                     // Mark post as read if forum_usermarksread is set off.
887                     if (!$CFG->forum_usermarksread) {
888                         $userto->markposts[$post->id] = $post->id;
889                     }
890                 }
892                 mtrace('post ' . $post->id . ': ' . $post->subject);
893             }
895             // Mark processed posts as read.
896             if (get_user_preferences('forum_markasreadonnotification', 1, $userto->id) == 1) {
897                 forum_tp_mark_posts_read($userto, $userto->markposts);
898             }
900             unset($userto);
901         }
902     }
904     if ($posts) {
905         foreach ($posts as $post) {
906             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
907             if ($errorcount[$post->id]) {
908                 $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
909             }
910         }
911     }
913     // release some memory
914     unset($subscribedusers);
915     unset($mailcount);
916     unset($errorcount);
918     cron_setup_user();
920     $sitetimezone = core_date::get_server_timezone();
922     // Now see if there are any digest mails waiting to be sent, and if we should send them
924     mtrace('Starting digest processing...');
926     core_php_time_limit::raise(300); // terminate if not able to fetch all digests in 5 minutes
928     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
929         set_config('digestmailtimelast', 0);
930     }
932     $timenow = time();
933     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
935     // Delete any really old ones (normally there shouldn't be any)
936     $weekago = $timenow - (7 * 24 * 3600);
937     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
938     mtrace ('Cleaned old digest records');
940     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
942         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
944         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
946         if ($digestposts_rs->valid()) {
948             // We have work to do
949             $usermailcount = 0;
951             //caches - reuse the those filled before too
952             $discussionposts = array();
953             $userdiscussions = array();
955             foreach ($digestposts_rs as $digestpost) {
956                 if (!isset($posts[$digestpost->postid])) {
957                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
958                         $posts[$digestpost->postid] = $post;
959                     } else {
960                         continue;
961                     }
962                 }
963                 $discussionid = $digestpost->discussionid;
964                 if (!isset($discussions[$discussionid])) {
965                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
966                         $discussions[$discussionid] = $discussion;
967                     } else {
968                         continue;
969                     }
970                 }
971                 $forumid = $discussions[$discussionid]->forum;
972                 if (!isset($forums[$forumid])) {
973                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
974                         $forums[$forumid] = $forum;
975                     } else {
976                         continue;
977                     }
978                 }
980                 $courseid = $forums[$forumid]->course;
981                 if (!isset($courses[$courseid])) {
982                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
983                         $courses[$courseid] = $course;
984                     } else {
985                         continue;
986                     }
987                 }
989                 if (!isset($coursemodules[$forumid])) {
990                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
991                         $coursemodules[$forumid] = $cm;
992                     } else {
993                         continue;
994                     }
995                 }
996                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
997                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
998             }
999             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
1001             // Data collected, start sending out emails to each user
1002             foreach ($userdiscussions as $userid => $thesediscussions) {
1004                 core_php_time_limit::raise(120); // terminate if processing of any account takes longer than 2 minutes
1006                 cron_setup_user();
1008                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
1010                 // First of all delete all the queue entries for this user
1011                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
1013                 // Init user caches - we keep the cache for one cycle only,
1014                 // otherwise it would unnecessarily consume memory.
1015                 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
1016                     $userto = clone($users[$userid]);
1017                 } else {
1018                     $userto = $DB->get_record('user', array('id' => $userid));
1019                     forum_cron_minimise_user_record($userto);
1020                 }
1021                 $userto->viewfullnames = array();
1022                 $userto->canpost       = array();
1023                 $userto->markposts     = array();
1025                 // Override the language and timezone of the "current" user, so that
1026                 // mail is customised for the receiver.
1027                 cron_setup_user($userto);
1029                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
1031                 $headerdata = new stdClass();
1032                 $headerdata->sitename = format_string($site->fullname, true);
1033                 $headerdata->userprefs = $CFG->wwwroot.'/user/forum.php?id='.$userid.'&amp;course='.$site->id;
1035                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
1036                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
1038                 $posthtml = '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p>'
1039                     . '<br /><hr size="1" noshade="noshade" />';
1041                 foreach ($thesediscussions as $discussionid) {
1043                     core_php_time_limit::raise(120);   // to be reset for each post
1045                     $discussion = $discussions[$discussionid];
1046                     $forum      = $forums[$discussion->forum];
1047                     $course     = $courses[$forum->course];
1048                     $cm         = $coursemodules[$forum->id];
1050                     //override language
1051                     cron_setup_user($userto, $course);
1053                     // Fill caches
1054                     if (!isset($userto->viewfullnames[$forum->id])) {
1055                         $modcontext = context_module::instance($cm->id);
1056                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
1057                     }
1058                     if (!isset($userto->canpost[$discussion->id])) {
1059                         $modcontext = context_module::instance($cm->id);
1060                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1061                     }
1063                     $strforums      = get_string('forums', 'forum');
1064                     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
1065                     $canreply       = $userto->canpost[$discussion->id];
1066                     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1068                     $posttext .= "\n \n";
1069                     $posttext .= '=====================================================================';
1070                     $posttext .= "\n \n";
1071                     $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1072                     if ($discussion->name != $forum->name) {
1073                         $posttext  .= " -> ".format_string($discussion->name,true);
1074                     }
1075                     $posttext .= "\n";
1076                     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1077                     $posttext .= "\n";
1079                     $posthtml .= "<p><font face=\"sans-serif\">".
1080                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
1081                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
1082                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
1083                     if ($discussion->name == $forum->name) {
1084                         $posthtml .= "</font></p>";
1085                     } else {
1086                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
1087                     }
1088                     $posthtml .= '<p>';
1090                     $postsarray = $discussionposts[$discussionid];
1091                     sort($postsarray);
1092                     $sentcount = 0;
1094                     foreach ($postsarray as $postid) {
1095                         $post = $posts[$postid];
1097                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
1098                             $userfrom = $users[$post->userid];
1099                             if (!isset($userfrom->idnumber)) {
1100                                 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
1101                                 forum_cron_minimise_user_record($userfrom);
1102                             }
1104                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
1105                             forum_cron_minimise_user_record($userfrom);
1106                             if ($userscount <= FORUM_CRON_USER_CACHE) {
1107                                 $userscount++;
1108                                 $users[$userfrom->id] = $userfrom;
1109                             }
1111                         } else {
1112                             mtrace('Could not find user '.$post->userid);
1113                             continue;
1114                         }
1116                         if (!isset($userfrom->groups[$forum->id])) {
1117                             if (!isset($userfrom->groups)) {
1118                                 $userfrom->groups = array();
1119                                 if (isset($users[$userfrom->id])) {
1120                                     $users[$userfrom->id]->groups = array();
1121                                 }
1122                             }
1123                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
1124                             if (isset($users[$userfrom->id])) {
1125                                 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
1126                             }
1127                         }
1129                         // Headers to help prevent auto-responders.
1130                         $userfrom->customheaders = array(
1131                                 "Precedence: Bulk",
1132                                 'X-Auto-Response-Suppress: All',
1133                                 'Auto-Submitted: auto-generated',
1134                             );
1136                         $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
1137                         if (!isset($userto->canpost[$discussion->id])) {
1138                             $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1139                         } else {
1140                             $canreply = $userto->canpost[$discussion->id];
1141                         }
1143                         $data = new \mod_forum\output\forum_post_email(
1144                                 $course,
1145                                 $cm,
1146                                 $forum,
1147                                 $discussion,
1148                                 $post,
1149                                 $userfrom,
1150                                 $userto,
1151                                 $canreply
1152                             );
1154                         if (!isset($userto->viewfullnames[$forum->id])) {
1155                             $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1156                         } else {
1157                             $data->viewfullnames = $userto->viewfullnames[$forum->id];
1158                         }
1160                         if ($maildigest == 2) {
1161                             // Subjects and link only.
1162                             $posttext .= $textdigestbasicout->render($data);
1163                             $posthtml .= $htmldigestbasicout->render($data);
1164                         } else {
1165                             // The full treatment.
1166                             $posttext .= $textdigestfullout->render($data);
1167                             $posthtml .= $htmldigestfullout->render($data);
1169                             // Create an array of postid's for this user to mark as read.
1170                             if (!$CFG->forum_usermarksread) {
1171                                 $userto->markposts[$post->id] = $post->id;
1172                             }
1173                         }
1174                         $sentcount++;
1175                     }
1176                     $footerlinks = array();
1177                     if ($canunsubscribe) {
1178                         $footerlinks[] = "<a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">" . get_string("unsubscribe", "forum") . "</a>";
1179                     } else {
1180                         $footerlinks[] = get_string("everyoneissubscribed", "forum");
1181                     }
1182                     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string("digestmailpost", "forum") . '</a>';
1183                     $posthtml .= "\n<div class='mdl-right'><font size=\"1\">" . implode('&nbsp;', $footerlinks) . '</font></div>';
1184                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
1185                 }
1187                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
1188                     // This user DOESN'T want to receive HTML
1189                     $posthtml = '';
1190                 }
1192                 $eventdata = new \core\message\message();
1193                 $eventdata->courseid            = SITEID;
1194                 $eventdata->component           = 'mod_forum';
1195                 $eventdata->name                = 'digests';
1196                 $eventdata->userfrom            = core_user::get_noreply_user();
1197                 $eventdata->userto              = $userto;
1198                 $eventdata->subject             = $postsubject;
1199                 $eventdata->fullmessage         = $posttext;
1200                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
1201                 $eventdata->fullmessagehtml     = $posthtml;
1202                 $eventdata->notification        = 1;
1203                 $eventdata->smallmessage        = get_string('smallmessagedigest', 'forum', $sentcount);
1204                 $mailresult = message_send($eventdata);
1206                 if (!$mailresult) {
1207                     mtrace("ERROR: mod/forum/cron.php: Could not send out digest mail to user $userto->id ".
1208                         "($userto->email)... not trying again.");
1209                 } else {
1210                     mtrace("success.");
1211                     $usermailcount++;
1213                     // Mark post as read if forum_usermarksread is set off
1214                     if (get_user_preferences('forum_markasreadonnotification', 1, $userto->id) == 1) {
1215                         forum_tp_mark_posts_read($userto, $userto->markposts);
1216                     }
1217                 }
1218             }
1219         }
1220     /// We have finishied all digest emails, update $CFG->digestmailtimelast
1221         set_config('digestmailtimelast', $timenow);
1222     }
1224     cron_setup_user();
1226     if (!empty($usermailcount)) {
1227         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
1228     }
1230     if (!empty($CFG->forum_lastreadclean)) {
1231         $timenow = time();
1232         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1233             set_config('forum_lastreadclean', $timenow);
1234             mtrace('Removing old forum read tracking info...');
1235             forum_tp_clean_read_records();
1236         }
1237     } else {
1238         set_config('forum_lastreadclean', time());
1239     }
1241     return true;
1244 /**
1245  *
1246  * @param object $course
1247  * @param object $user
1248  * @param object $mod TODO this is not used in this function, refactor
1249  * @param object $forum
1250  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
1251  */
1252 function forum_user_outline($course, $user, $mod, $forum) {
1253     global $CFG;
1254     require_once("$CFG->libdir/gradelib.php");
1255     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1256     if (empty($grades->items[0]->grades)) {
1257         $grade = false;
1258     } else {
1259         $grade = reset($grades->items[0]->grades);
1260     }
1262     $count = forum_count_user_posts($forum->id, $user->id);
1264     if ($count && $count->postcount > 0) {
1265         $result = new stdClass();
1266         $result->info = get_string("numposts", "forum", $count->postcount);
1267         $result->time = $count->lastpost;
1268         if ($grade) {
1269             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1270         }
1271         return $result;
1272     } else if ($grade) {
1273         $result = new stdClass();
1274         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1276         //datesubmitted == time created. dategraded == time modified or time overridden
1277         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1278         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1279         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1280             $result->time = $grade->dategraded;
1281         } else {
1282             $result->time = $grade->datesubmitted;
1283         }
1285         return $result;
1286     }
1287     return NULL;
1291 /**
1292  * @global object
1293  * @global object
1294  * @param object $coure
1295  * @param object $user
1296  * @param object $mod
1297  * @param object $forum
1298  */
1299 function forum_user_complete($course, $user, $mod, $forum) {
1300     global $CFG,$USER, $OUTPUT;
1301     require_once("$CFG->libdir/gradelib.php");
1303     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1304     if (!empty($grades->items[0]->grades)) {
1305         $grade = reset($grades->items[0]->grades);
1306         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1307         if ($grade->str_feedback) {
1308             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1309         }
1310     }
1312     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
1314         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
1315             print_error('invalidcoursemodule');
1316         }
1317         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1319         foreach ($posts as $post) {
1320             if (!isset($discussions[$post->discussion])) {
1321                 continue;
1322             }
1323             $discussion = $discussions[$post->discussion];
1325             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
1326         }
1327     } else {
1328         echo "<p>".get_string("noposts", "forum")."</p>";
1329     }
1332 /**
1333  * Filters the forum discussions according to groups membership and config.
1334  *
1335  * @deprecated since 3.3
1336  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
1337  * @since  Moodle 2.8, 2.7.1, 2.6.4
1338  * @param  array $discussions Discussions with new posts array
1339  * @return array Forums with the number of new posts
1340  */
1341 function forum_filter_user_groups_discussions($discussions) {
1343     debugging('The function forum_filter_user_groups_discussions() is now deprecated.', DEBUG_DEVELOPER);
1345     // Group the remaining discussions posts by their forumid.
1346     $filteredforums = array();
1348     // Discard not visible groups.
1349     foreach ($discussions as $discussion) {
1351         // Course data is already cached.
1352         $instances = get_fast_modinfo($discussion->course)->get_instances();
1353         $forum = $instances['forum'][$discussion->forum];
1355         // Continue if the user should not see this discussion.
1356         if (!forum_is_user_group_discussion($forum, $discussion->groupid)) {
1357             continue;
1358         }
1360         // Grouping results by forum.
1361         if (empty($filteredforums[$forum->instance])) {
1362             $filteredforums[$forum->instance] = new stdClass();
1363             $filteredforums[$forum->instance]->id = $forum->id;
1364             $filteredforums[$forum->instance]->count = 0;
1365         }
1366         $filteredforums[$forum->instance]->count += $discussion->count;
1368     }
1370     return $filteredforums;
1373 /**
1374  * Returns whether the discussion group is visible by the current user or not.
1375  *
1376  * @since Moodle 2.8, 2.7.1, 2.6.4
1377  * @param cm_info $cm The discussion course module
1378  * @param int $discussiongroupid The discussion groupid
1379  * @return bool
1380  */
1381 function forum_is_user_group_discussion(cm_info $cm, $discussiongroupid) {
1383     if ($discussiongroupid == -1 || $cm->effectivegroupmode != SEPARATEGROUPS) {
1384         return true;
1385     }
1387     if (isguestuser()) {
1388         return false;
1389     }
1391     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id)) ||
1392             in_array($discussiongroupid, $cm->get_modinfo()->get_groups($cm->groupingid))) {
1393         return true;
1394     }
1396     return false;
1399 /**
1400  * @deprecated since 3.3
1401  * @todo The final deprecation of this function will take place in Moodle 3.7 - see MDL-57487.
1402  * @global object
1403  * @global object
1404  * @global object
1405  * @param array $courses
1406  * @param array $htmlarray
1407  */
1408 function forum_print_overview($courses,&$htmlarray) {
1409     global $USER, $CFG, $DB, $SESSION;
1411     debugging('The function forum_print_overview() is now deprecated.', DEBUG_DEVELOPER);
1413     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1414         return array();
1415     }
1417     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1418         return;
1419     }
1421     // Courses to search for new posts
1422     $coursessqls = array();
1423     $params = array();
1424     foreach ($courses as $course) {
1426         // If the user has never entered into the course all posts are pending
1427         if ($course->lastaccess == 0) {
1428             $coursessqls[] = '(d.course = ?)';
1429             $params[] = $course->id;
1431         // Only posts created after the course last access
1432         } else {
1433             $coursessqls[] = '(d.course = ? AND p.created > ?)';
1434             $params[] = $course->id;
1435             $params[] = $course->lastaccess;
1436         }
1437     }
1438     $params[] = $USER->id;
1439     $coursessql = implode(' OR ', $coursessqls);
1441     $sql = "SELECT d.id, d.forum, d.course, d.groupid, COUNT(*) as count "
1442                 .'FROM {forum_discussions} d '
1443                 .'JOIN {forum_posts} p ON p.discussion = d.id '
1444                 ."WHERE ($coursessql) "
1445                 .'AND p.deleted <> 1 '
1446                 .'AND p.userid != ? '
1447                 .'AND (d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?)) '
1448                 .'GROUP BY d.id, d.forum, d.course, d.groupid '
1449                 .'ORDER BY d.course, d.forum';
1450     $params[] = time();
1451     $params[] = time();
1453     // Avoid warnings.
1454     if (!$discussions = $DB->get_records_sql($sql, $params)) {
1455         $discussions = array();
1456     }
1458     $forumsnewposts = forum_filter_user_groups_discussions($discussions);
1460     // also get all forum tracking stuff ONCE.
1461     $trackingforums = array();
1462     foreach ($forums as $forum) {
1463         if (forum_tp_can_track_forums($forum)) {
1464             $trackingforums[$forum->id] = $forum;
1465         }
1466     }
1468     if (count($trackingforums) > 0) {
1469         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1470         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1471             ' FROM {forum_posts} p '.
1472             ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1473             ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE p.deleted <> 1 AND (';
1474         $params = array($USER->id);
1476         foreach ($trackingforums as $track) {
1477             $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1478             $params[] = $track->id;
1479             if (isset($SESSION->currentgroup[$track->course])) {
1480                 $groupid =  $SESSION->currentgroup[$track->course];
1481             } else {
1482                 // get first groupid
1483                 $groupids = groups_get_all_groups($track->course, $USER->id);
1484                 if ($groupids) {
1485                     reset($groupids);
1486                     $groupid = key($groupids);
1487                     $SESSION->currentgroup[$track->course] = $groupid;
1488                 } else {
1489                     $groupid = 0;
1490                 }
1491                 unset($groupids);
1492             }
1493             $params[] = $groupid;
1494         }
1495         $sql = substr($sql,0,-3); // take off the last OR
1496         $sql .= ') AND p.modified >= ? AND r.id is NULL ';
1497         $sql .= 'AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)) ';
1498         $sql .= 'GROUP BY d.forum,d.course';
1499         $params[] = $cutoffdate;
1500         $params[] = time();
1501         $params[] = time();
1503         if (!$unread = $DB->get_records_sql($sql, $params)) {
1504             $unread = array();
1505         }
1506     } else {
1507         $unread = array();
1508     }
1510     if (empty($unread) and empty($forumsnewposts)) {
1511         return;
1512     }
1514     $strforum = get_string('modulename','forum');
1516     foreach ($forums as $forum) {
1517         $str = '';
1518         $count = 0;
1519         $thisunread = 0;
1520         $showunread = false;
1521         // either we have something from logs, or trackposts, or nothing.
1522         if (array_key_exists($forum->id, $forumsnewposts) && !empty($forumsnewposts[$forum->id])) {
1523             $count = $forumsnewposts[$forum->id]->count;
1524         }
1525         if (array_key_exists($forum->id,$unread)) {
1526             $thisunread = $unread[$forum->id]->count;
1527             $showunread = true;
1528         }
1529         if ($count > 0 || $thisunread > 0) {
1530             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1531                 $forum->name.'</a></div>';
1532             $str .= '<div class="info"><span class="postsincelogin">';
1533             $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
1534             if (!empty($showunread)) {
1535                 $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
1536             }
1537             $str .= '</div></div>';
1538         }
1539         if (!empty($str)) {
1540             if (!array_key_exists($forum->course,$htmlarray)) {
1541                 $htmlarray[$forum->course] = array();
1542             }
1543             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1544                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1545             }
1546             $htmlarray[$forum->course]['forum'] .= $str;
1547         }
1548     }
1551 /**
1552  * Given a course and a date, prints a summary of all the new
1553  * messages posted in the course since that date
1554  *
1555  * @global object
1556  * @global object
1557  * @global object
1558  * @uses CONTEXT_MODULE
1559  * @uses VISIBLEGROUPS
1560  * @param object $course
1561  * @param bool $viewfullnames capability
1562  * @param int $timestart
1563  * @return bool success
1564  */
1565 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1566     global $CFG, $USER, $DB, $OUTPUT;
1568     // do not use log table if possible, it may be huge and is expensive to join with other tables
1570     $allnamefields = user_picture::fields('u', null, 'duserid');
1571     if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1572                                               d.timestart, d.timeend, $allnamefields
1573                                          FROM {forum_posts} p
1574                                               JOIN {forum_discussions} d ON d.id = p.discussion
1575                                               JOIN {forum} f             ON f.id = d.forum
1576                                               JOIN {user} u              ON u.id = p.userid
1577                                         WHERE p.created > ? AND f.course = ? AND p.deleted <> 1
1578                                      ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
1579          return false;
1580     }
1582     $modinfo = get_fast_modinfo($course);
1584     $groupmodes = array();
1585     $cms    = array();
1587     $strftimerecent = get_string('strftimerecent');
1589     $printposts = array();
1590     foreach ($posts as $post) {
1591         if (!isset($modinfo->instances['forum'][$post->forum])) {
1592             // not visible
1593             continue;
1594         }
1595         $cm = $modinfo->instances['forum'][$post->forum];
1596         if (!$cm->uservisible) {
1597             continue;
1598         }
1599         $context = context_module::instance($cm->id);
1601         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1602             continue;
1603         }
1605         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1606           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1607             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1608                 continue;
1609             }
1610         }
1612         // Check that the user can see the discussion.
1613         if (forum_is_user_group_discussion($cm, $post->groupid)) {
1614             $printposts[] = $post;
1615         }
1617     }
1618     unset($posts);
1620     if (!$printposts) {
1621         return false;
1622     }
1624     echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
1625     $list = html_writer::start_tag('ul', ['class' => 'unlist']);
1627     foreach ($printposts as $post) {
1628         $subjectclass = empty($post->parent) ? ' bold' : '';
1629         $authorhidden = forum_is_author_hidden($post, (object) ['type' => $post->forumtype]);
1631         $list .= html_writer::start_tag('li');
1632         $list .= html_writer::start_div('head');
1633         $list .= html_writer::div(userdate($post->modified, $strftimerecent), 'date');
1634         if (!$authorhidden) {
1635             $list .= html_writer::div(fullname($post, $viewfullnames), 'name');
1636         }
1637         $list .= html_writer::end_div(); // Head.
1639         $list .= html_writer::start_div('info' . $subjectclass);
1640         $discussionurl = new moodle_url('/mod/forum/discuss.php', ['d' => $post->discussion]);
1641         if (!empty($post->parent)) {
1642             $discussionurl->param('parent', $post->parent);
1643             $discussionurl->set_anchor('p'. $post->id);
1644         }
1645         $post->subject = break_up_long_words(format_string($post->subject, true));
1646         $list .= html_writer::link($discussionurl, $post->subject);
1647         $list .= html_writer::end_div(); // Info.
1648         $list .= html_writer::end_tag('li');
1649     }
1651     $list .= html_writer::end_tag('ul');
1652     echo $list;
1654     return true;
1657 /**
1658  * Return grade for given user or all users.
1659  *
1660  * @global object
1661  * @global object
1662  * @param object $forum
1663  * @param int $userid optional user id, 0 means all users
1664  * @return array array of grades, false if none
1665  */
1666 function forum_get_user_grades($forum, $userid = 0) {
1667     global $CFG;
1669     require_once($CFG->dirroot.'/rating/lib.php');
1671     $ratingoptions = new stdClass;
1672     $ratingoptions->component = 'mod_forum';
1673     $ratingoptions->ratingarea = 'post';
1675     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1676     $ratingoptions->modulename = 'forum';
1677     $ratingoptions->moduleid   = $forum->id;
1678     $ratingoptions->userid = $userid;
1679     $ratingoptions->aggregationmethod = $forum->assessed;
1680     $ratingoptions->scaleid = $forum->scale;
1681     $ratingoptions->itemtable = 'forum_posts';
1682     $ratingoptions->itemtableusercolumn = 'userid';
1684     $rm = new rating_manager();
1685     return $rm->get_user_grades($ratingoptions);
1688 /**
1689  * Update activity grades
1690  *
1691  * @category grade
1692  * @param object $forum
1693  * @param int $userid specific user only, 0 means all
1694  * @param boolean $nullifnone return null if grade does not exist
1695  * @return void
1696  */
1697 function forum_update_grades($forum, $userid=0, $nullifnone=true) {
1698     global $CFG, $DB;
1699     require_once($CFG->libdir.'/gradelib.php');
1701     if (!$forum->assessed) {
1702         forum_grade_item_update($forum);
1704     } else if ($grades = forum_get_user_grades($forum, $userid)) {
1705         forum_grade_item_update($forum, $grades);
1707     } else if ($userid and $nullifnone) {
1708         $grade = new stdClass();
1709         $grade->userid   = $userid;
1710         $grade->rawgrade = NULL;
1711         forum_grade_item_update($forum, $grade);
1713     } else {
1714         forum_grade_item_update($forum);
1715     }
1718 /**
1719  * Create/update grade item for given forum
1720  *
1721  * @category grade
1722  * @uses GRADE_TYPE_NONE
1723  * @uses GRADE_TYPE_VALUE
1724  * @uses GRADE_TYPE_SCALE
1725  * @param stdClass $forum Forum object with extra cmidnumber
1726  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1727  * @return int 0 if ok
1728  */
1729 function forum_grade_item_update($forum, $grades=NULL) {
1730     global $CFG;
1731     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1732         require_once($CFG->libdir.'/gradelib.php');
1733     }
1735     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1737     if (!$forum->assessed or $forum->scale == 0) {
1738         $params['gradetype'] = GRADE_TYPE_NONE;
1740     } else if ($forum->scale > 0) {
1741         $params['gradetype'] = GRADE_TYPE_VALUE;
1742         $params['grademax']  = $forum->scale;
1743         $params['grademin']  = 0;
1745     } else if ($forum->scale < 0) {
1746         $params['gradetype'] = GRADE_TYPE_SCALE;
1747         $params['scaleid']   = -$forum->scale;
1748     }
1750     if ($grades  === 'reset') {
1751         $params['reset'] = true;
1752         $grades = NULL;
1753     }
1755     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1758 /**
1759  * Delete grade item for given forum
1760  *
1761  * @category grade
1762  * @param stdClass $forum Forum object
1763  * @return grade_item
1764  */
1765 function forum_grade_item_delete($forum) {
1766     global $CFG;
1767     require_once($CFG->libdir.'/gradelib.php');
1769     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1773 /**
1774  * This function returns if a scale is being used by one forum
1775  *
1776  * @global object
1777  * @param int $forumid
1778  * @param int $scaleid negative number
1779  * @return bool
1780  */
1781 function forum_scale_used ($forumid,$scaleid) {
1782     global $DB;
1783     $return = false;
1785     $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
1787     if (!empty($rec) && !empty($scaleid)) {
1788         $return = true;
1789     }
1791     return $return;
1794 /**
1795  * Checks if scale is being used by any instance of forum
1796  *
1797  * This is used to find out if scale used anywhere
1798  *
1799  * @global object
1800  * @param $scaleid int
1801  * @return boolean True if the scale is used by any forum
1802  */
1803 function forum_scale_used_anywhere($scaleid) {
1804     global $DB;
1805     if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
1806         return true;
1807     } else {
1808         return false;
1809     }
1812 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1814 /**
1815  * Gets a post with all info ready for forum_print_post
1816  * Most of these joins are just to get the forum id
1817  *
1818  * @global object
1819  * @global object
1820  * @param int $postid
1821  * @return mixed array of posts or false
1822  */
1823 function forum_get_post_full($postid) {
1824     global $CFG, $DB;
1826     $allnames = get_all_user_name_fields(true, 'u');
1827     return $DB->get_record_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
1828                              FROM {forum_posts} p
1829                                   JOIN {forum_discussions} d ON p.discussion = d.id
1830                                   LEFT JOIN {user} u ON p.userid = u.id
1831                             WHERE p.id = ?", array($postid));
1834 /**
1835  * Gets all posts in discussion including top parent.
1836  *
1837  * @global object
1838  * @global object
1839  * @global object
1840  * @param int $discussionid
1841  * @param string $sort
1842  * @param bool $tracking does user track the forum?
1843  * @return array of posts
1844  */
1845 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1846     global $CFG, $DB, $USER;
1848     $tr_sel  = "";
1849     $tr_join = "";
1850     $params = array();
1852     if ($tracking) {
1853         $tr_sel  = ", fr.id AS postread";
1854         $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1855         $params[] = $USER->id;
1856     }
1858     $allnames = get_all_user_name_fields(true, 'u');
1859     $params[] = $discussionid;
1860     if (!$posts = $DB->get_records_sql("SELECT p.*, $allnames, u.email, u.picture, u.imagealt $tr_sel
1861                                      FROM {forum_posts} p
1862                                           LEFT JOIN {user} u ON p.userid = u.id
1863                                           $tr_join
1864                                     WHERE p.discussion = ?
1865                                  ORDER BY $sort", $params)) {
1866         return array();
1867     }
1869     foreach ($posts as $pid=>$p) {
1870         if ($tracking) {
1871             if (forum_tp_is_post_old($p)) {
1872                  $posts[$pid]->postread = true;
1873             }
1874         }
1875         if (!$p->parent) {
1876             continue;
1877         }
1878         if (!isset($posts[$p->parent])) {
1879             continue; // parent does not exist??
1880         }
1881         if (!isset($posts[$p->parent]->children)) {
1882             $posts[$p->parent]->children = array();
1883         }
1884         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1885     }
1887     // Start with the last child of the first post.
1888     $post = &$posts[reset($posts)->id];
1890     $lastpost = false;
1891     while (!$lastpost) {
1892         if (!isset($post->children)) {
1893             $post->lastpost = true;
1894             $lastpost = true;
1895         } else {
1896              // Go to the last child of this post.
1897             $post = &$posts[end($post->children)->id];
1898         }
1899     }
1901     return $posts;
1904 /**
1905  * An array of forum objects that the user is allowed to read/search through.
1906  *
1907  * @global object
1908  * @global object
1909  * @global object
1910  * @param int $userid
1911  * @param int $courseid if 0, we look for forums throughout the whole site.
1912  * @return array of forum objects, or false if no matches
1913  *         Forum objects have the following attributes:
1914  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1915  *         viewhiddentimedposts
1916  */
1917 function forum_get_readable_forums($userid, $courseid=0) {
1919     global $CFG, $DB, $USER;
1920     require_once($CFG->dirroot.'/course/lib.php');
1922     if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
1923         print_error('notinstalled', 'forum');
1924     }
1926     if ($courseid) {
1927         $courses = $DB->get_records('course', array('id' => $courseid));
1928     } else {
1929         // If no course is specified, then the user can see SITE + his courses.
1930         $courses1 = $DB->get_records('course', array('id' => SITEID));
1931         $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
1932         $courses = array_merge($courses1, $courses2);
1933     }
1934     if (!$courses) {
1935         return array();
1936     }
1938     $readableforums = array();
1940     foreach ($courses as $course) {
1942         $modinfo = get_fast_modinfo($course);
1944         if (empty($modinfo->instances['forum'])) {
1945             // hmm, no forums?
1946             continue;
1947         }
1949         $courseforums = $DB->get_records('forum', array('course' => $course->id));
1951         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1952             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1953                 continue;
1954             }
1955             $context = context_module::instance($cm->id);
1956             $forum = $courseforums[$forumid];
1957             $forum->context = $context;
1958             $forum->cm = $cm;
1960             if (!has_capability('mod/forum:viewdiscussion', $context)) {
1961                 continue;
1962             }
1964          /// group access
1965             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
1967                 $forum->onlygroups = $modinfo->get_groups($cm->groupingid);
1968                 $forum->onlygroups[] = -1;
1969             }
1971         /// hidden timed discussions
1972             $forum->viewhiddentimedposts = true;
1973             if (!empty($CFG->forum_enabletimedposts)) {
1974                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1975                     $forum->viewhiddentimedposts = false;
1976                 }
1977             }
1979         /// qanda access
1980             if ($forum->type == 'qanda'
1981                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1983                 // We need to check whether the user has posted in the qanda forum.
1984                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
1985                                                     // the user is allowed to see in this forum.
1986                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1987                     foreach ($discussionspostedin as $d) {
1988                         $forum->onlydiscussions[] = $d->id;
1989                     }
1990                 }
1991             }
1993             $readableforums[$forum->id] = $forum;
1994         }
1996         unset($modinfo);
1998     } // End foreach $courses
2000     return $readableforums;
2003 /**
2004  * Returns a list of posts found using an array of search terms.
2005  *
2006  * @global object
2007  * @global object
2008  * @global object
2009  * @param array $searchterms array of search terms, e.g. word +word -word
2010  * @param int $courseid if 0, we search through the whole site
2011  * @param int $limitfrom
2012  * @param int $limitnum
2013  * @param int &$totalcount
2014  * @param string $extrasql
2015  * @return array|bool Array of posts found or false
2016  */
2017 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
2018                             &$totalcount, $extrasql='') {
2019     global $CFG, $DB, $USER;
2020     require_once($CFG->libdir.'/searchlib.php');
2022     $forums = forum_get_readable_forums($USER->id, $courseid);
2024     if (count($forums) == 0) {
2025         $totalcount = 0;
2026         return false;
2027     }
2029     $now = floor(time() / 60) * 60; // DB Cache Friendly.
2031     $fullaccess = array();
2032     $where = array();
2033     $params = array();
2035     foreach ($forums as $forumid => $forum) {
2036         $select = array();
2038         if (!$forum->viewhiddentimedposts) {
2039             $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
2040             $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
2041         }
2043         $cm = $forum->cm;
2044         $context = $forum->context;
2046         if ($forum->type == 'qanda'
2047             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2048             if (!empty($forum->onlydiscussions)) {
2049                 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
2050                 $params = array_merge($params, $discussionid_params);
2051                 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
2052             } else {
2053                 $select[] = "p.parent = 0";
2054             }
2055         }
2057         if (!empty($forum->onlygroups)) {
2058             list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
2059             $params = array_merge($params, $groupid_params);
2060             $select[] = "d.groupid $groupid_sql";
2061         }
2063         if ($select) {
2064             $selects = implode(" AND ", $select);
2065             $where[] = "(d.forum = :forum{$forumid} AND $selects)";
2066             $params['forum'.$forumid] = $forumid;
2067         } else {
2068             $fullaccess[] = $forumid;
2069         }
2070     }
2072     if ($fullaccess) {
2073         list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
2074         $params = array_merge($params, $fullid_params);
2075         $where[] = "(d.forum $fullid_sql)";
2076     }
2078     $selectdiscussion = "(".implode(" OR ", $where).")";
2080     $messagesearch = '';
2081     $searchstring = '';
2083     // Need to concat these back together for parser to work.
2084     foreach($searchterms as $searchterm){
2085         if ($searchstring != '') {
2086             $searchstring .= ' ';
2087         }
2088         $searchstring .= $searchterm;
2089     }
2091     // We need to allow quoted strings for the search. The quotes *should* be stripped
2092     // by the parser, but this should be examined carefully for security implications.
2093     $searchstring = str_replace("\\\"","\"",$searchstring);
2094     $parser = new search_parser();
2095     $lexer = new search_lexer($parser);
2097     if ($lexer->parse($searchstring)) {
2098         $parsearray = $parser->get_parsed_array();
2100         $tagjoins = '';
2101         $tagfields = [];
2102         $tagfieldcount = 0;
2103         foreach ($parsearray as $token) {
2104             if ($token->getType() == TOKEN_TAGS) {
2105                 for ($i = 0; $i <= substr_count($token->getValue(), ','); $i++) {
2106                     // Queries can only have a limited number of joins so set a limit sensible users won't exceed.
2107                     if ($tagfieldcount > 10) {
2108                         continue;
2109                     }
2110                     $tagjoins .= " LEFT JOIN {tag_instance} ti_$tagfieldcount
2111                                         ON p.id = ti_$tagfieldcount.itemid
2112                                             AND ti_$tagfieldcount.component = 'mod_forum'
2113                                             AND ti_$tagfieldcount.itemtype = 'forum_posts'";
2114                     $tagjoins .= " LEFT JOIN {tag} t_$tagfieldcount ON t_$tagfieldcount.id = ti_$tagfieldcount.tagid";
2115                     $tagfields[] = "t_$tagfieldcount.rawname";
2116                     $tagfieldcount++;
2117                 }
2118             }
2119         }
2120         list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2121                                                               'p.userid', 'u.id', 'u.firstname',
2122                                                               'u.lastname', 'p.modified', 'd.forum',
2123                                                               $tagfields);
2124         $params = array_merge($params, $msparams);
2125     }
2127     $fromsql = "{forum_posts} p
2128                   INNER JOIN {forum_discussions} d ON d.id = p.discussion
2129                   INNER JOIN {user} u ON u.id = p.userid $tagjoins";
2131     $selectsql = " $messagesearch
2132                AND p.discussion = d.id
2133                AND p.userid = u.id
2134                AND $selectdiscussion
2135                    $extrasql";
2137     $countsql = "SELECT COUNT(*)
2138                    FROM $fromsql
2139                   WHERE $selectsql";
2141     $allnames = get_all_user_name_fields(true, 'u');
2142     $searchsql = "SELECT p.*,
2143                          d.forum,
2144                          $allnames,
2145                          u.email,
2146                          u.picture,
2147                          u.imagealt
2148                     FROM $fromsql
2149                    WHERE $selectsql
2150                 ORDER BY p.modified DESC";
2152     $totalcount = $DB->count_records_sql($countsql, $params);
2154     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2157 /**
2158  * Returns a list of all new posts that have not been mailed yet
2159  *
2160  * @param int $starttime posts created after this time
2161  * @param int $endtime posts created before this
2162  * @param int $now used for timed discussions only
2163  * @return array
2164  */
2165 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2166     global $CFG, $DB;
2168     $params = array();
2169     $params['mailed'] = FORUM_MAILED_PENDING;
2170     $params['ptimestart'] = $starttime;
2171     $params['ptimeend'] = $endtime;
2172     $params['mailnow'] = 1;
2174     if (!empty($CFG->forum_enabletimedposts)) {
2175         if (empty($now)) {
2176             $now = time();
2177         }
2178         $selectsql = "AND (p.created >= :ptimestart OR d.timestart >= :pptimestart)";
2179         $params['pptimestart'] = $starttime;
2180         $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
2181         $params['dtimestart'] = $now;
2182         $params['dtimeend'] = $now;
2183     } else {
2184         $timedsql = "";
2185         $selectsql = "AND p.created >= :ptimestart";
2186     }
2188     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2189                                  FROM {forum_posts} p
2190                                  JOIN {forum_discussions} d ON d.id = p.discussion
2191                                  WHERE p.mailed = :mailed
2192                                  $selectsql
2193                                  AND (p.created < :ptimeend OR p.mailnow = :mailnow)
2194                                  $timedsql
2195                                  ORDER BY p.modified ASC", $params);
2198 /**
2199  * Marks posts before a certain time as being mailed already
2200  *
2201  * @global object
2202  * @global object
2203  * @param int $endtime
2204  * @param int $now Defaults to time()
2205  * @return bool
2206  */
2207 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2208     global $CFG, $DB;
2210     if (empty($now)) {
2211         $now = time();
2212     }
2214     $params = array();
2215     $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
2216     $params['now'] = $now;
2217     $params['endtime'] = $endtime;
2218     $params['mailnow'] = 1;
2219     $params['mailedpending'] = FORUM_MAILED_PENDING;
2221     if (empty($CFG->forum_enabletimedposts)) {
2222         return $DB->execute("UPDATE {forum_posts}
2223                              SET mailed = :mailedsuccess
2224                              WHERE (created < :endtime OR mailnow = :mailnow)
2225                              AND mailed = :mailedpending", $params);
2226     } else {
2227         return $DB->execute("UPDATE {forum_posts}
2228                              SET mailed = :mailedsuccess
2229                              WHERE discussion NOT IN (SELECT d.id
2230                                                       FROM {forum_discussions} d
2231                                                       WHERE d.timestart > :now)
2232                              AND (created < :endtime OR mailnow = :mailnow)
2233                              AND mailed = :mailedpending", $params);
2234     }
2237 /**
2238  * Get all the posts for a user in a forum suitable for forum_print_post
2239  *
2240  * @global object
2241  * @global object
2242  * @uses CONTEXT_MODULE
2243  * @return array
2244  */
2245 function forum_get_user_posts($forumid, $userid) {
2246     global $CFG, $DB;
2248     $timedsql = "";
2249     $params = array($forumid, $userid);
2251     if (!empty($CFG->forum_enabletimedposts)) {
2252         $cm = get_coursemodule_from_instance('forum', $forumid);
2253         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2254             $now = time();
2255             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2256             $params[] = $now;
2257             $params[] = $now;
2258         }
2259     }
2261     $allnames = get_all_user_name_fields(true, 'u');
2262     return $DB->get_records_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
2263                               FROM {forum} f
2264                                    JOIN {forum_discussions} d ON d.forum = f.id
2265                                    JOIN {forum_posts} p       ON p.discussion = d.id
2266                                    JOIN {user} u              ON u.id = p.userid
2267                              WHERE f.id = ?
2268                                    AND p.userid = ?
2269                                    $timedsql
2270                           ORDER BY p.modified ASC", $params);
2273 /**
2274  * Get all the discussions user participated in
2275  *
2276  * @global object
2277  * @global object
2278  * @uses CONTEXT_MODULE
2279  * @param int $forumid
2280  * @param int $userid
2281  * @return array Array or false
2282  */
2283 function forum_get_user_involved_discussions($forumid, $userid) {
2284     global $CFG, $DB;
2286     $timedsql = "";
2287     $params = array($forumid, $userid);
2288     if (!empty($CFG->forum_enabletimedposts)) {
2289         $cm = get_coursemodule_from_instance('forum', $forumid);
2290         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2291             $now = time();
2292             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2293             $params[] = $now;
2294             $params[] = $now;
2295         }
2296     }
2298     return $DB->get_records_sql("SELECT DISTINCT d.*
2299                               FROM {forum} f
2300                                    JOIN {forum_discussions} d ON d.forum = f.id
2301                                    JOIN {forum_posts} p       ON p.discussion = d.id
2302                              WHERE f.id = ?
2303                                    AND p.userid = ?
2304                                    $timedsql", $params);
2307 /**
2308  * Get all the posts for a user in a forum suitable for forum_print_post
2309  *
2310  * @global object
2311  * @global object
2312  * @param int $forumid
2313  * @param int $userid
2314  * @return array of counts or false
2315  */
2316 function forum_count_user_posts($forumid, $userid) {
2317     global $CFG, $DB;
2319     $timedsql = "";
2320     $params = array($forumid, $userid);
2321     if (!empty($CFG->forum_enabletimedposts)) {
2322         $cm = get_coursemodule_from_instance('forum', $forumid);
2323         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2324             $now = time();
2325             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2326             $params[] = $now;
2327             $params[] = $now;
2328         }
2329     }
2331     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2332                              FROM {forum} f
2333                                   JOIN {forum_discussions} d ON d.forum = f.id
2334                                   JOIN {forum_posts} p       ON p.discussion = d.id
2335                                   JOIN {user} u              ON u.id = p.userid
2336                             WHERE f.id = ?
2337                                   AND p.userid = ?
2338                                   $timedsql", $params);
2341 /**
2342  * Given a log entry, return the forum post details for it.
2343  *
2344  * @global object
2345  * @global object
2346  * @param object $log
2347  * @return array|null
2348  */
2349 function forum_get_post_from_log($log) {
2350     global $CFG, $DB;
2352     $allnames = get_all_user_name_fields(true, 'u');
2353     if ($log->action == "add post") {
2355         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2356                                  FROM {forum_discussions} d,
2357                                       {forum_posts} p,
2358                                       {forum} f,
2359                                       {user} u
2360                                 WHERE p.id = ?
2361                                   AND d.id = p.discussion
2362                                   AND p.userid = u.id
2363                                   AND u.deleted <> '1'
2364                                   AND f.id = d.forum", array($log->info));
2367     } else if ($log->action == "add discussion") {
2369         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2370                                  FROM {forum_discussions} d,
2371                                       {forum_posts} p,
2372                                       {forum} f,
2373                                       {user} u
2374                                 WHERE d.id = ?
2375                                   AND d.firstpost = p.id
2376                                   AND p.userid = u.id
2377                                   AND u.deleted <> '1'
2378                                   AND f.id = d.forum", array($log->info));
2379     }
2380     return NULL;
2383 /**
2384  * Given a discussion id, return the first post from the discussion
2385  *
2386  * @global object
2387  * @global object
2388  * @param int $dicsussionid
2389  * @return array
2390  */
2391 function forum_get_firstpost_from_discussion($discussionid) {
2392     global $CFG, $DB;
2394     return $DB->get_record_sql("SELECT p.*
2395                              FROM {forum_discussions} d,
2396                                   {forum_posts} p
2397                             WHERE d.id = ?
2398                               AND d.firstpost = p.id ", array($discussionid));
2401 /**
2402  * Returns an array of counts of replies to each discussion
2403  *
2404  * @global object
2405  * @global object
2406  * @param int $forumid
2407  * @param string $forumsort
2408  * @param int $limit
2409  * @param int $page
2410  * @param int $perpage
2411  * @return array
2412  */
2413 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2414     global $CFG, $DB;
2416     if ($limit > 0) {
2417         $limitfrom = 0;
2418         $limitnum  = $limit;
2419     } else if ($page != -1) {
2420         $limitfrom = $page*$perpage;
2421         $limitnum  = $perpage;
2422     } else {
2423         $limitfrom = 0;
2424         $limitnum  = 0;
2425     }
2427     if ($forumsort == "") {
2428         $orderby = "";
2429         $groupby = "";
2431     } else {
2432         $orderby = "ORDER BY $forumsort";
2433         $groupby = ", ".strtolower($forumsort);
2434         $groupby = str_replace('desc', '', $groupby);
2435         $groupby = str_replace('asc', '', $groupby);
2436     }
2438     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2439         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2440                   FROM {forum_posts} p
2441                        JOIN {forum_discussions} d ON p.discussion = d.id
2442                  WHERE p.parent > 0 AND d.forum = ?
2443               GROUP BY p.discussion";
2444         return $DB->get_records_sql($sql, array($forumid));
2446     } else {
2447         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2448                   FROM {forum_posts} p
2449                        JOIN {forum_discussions} d ON p.discussion = d.id
2450                  WHERE d.forum = ?
2451               GROUP BY p.discussion $groupby $orderby";
2452         return $DB->get_records_sql($sql, array($forumid), $limitfrom, $limitnum);
2453     }
2456 /**
2457  * @global object
2458  * @global object
2459  * @global object
2460  * @staticvar array $cache
2461  * @param object $forum
2462  * @param object $cm
2463  * @param object $course
2464  * @return mixed
2465  */
2466 function forum_count_discussions($forum, $cm, $course) {
2467     global $CFG, $DB, $USER;
2469     static $cache = array();
2471     $now = floor(time() / 60) * 60; // DB Cache Friendly.
2473     $params = array($course->id);
2475     if (!isset($cache[$course->id])) {
2476         if (!empty($CFG->forum_enabletimedposts)) {
2477             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2478             $params[] = $now;
2479             $params[] = $now;
2480         } else {
2481             $timedsql = "";
2482         }
2484         $sql = "SELECT f.id, COUNT(d.id) as dcount
2485                   FROM {forum} f
2486                        JOIN {forum_discussions} d ON d.forum = f.id
2487                  WHERE f.course = ?
2488                        $timedsql
2489               GROUP BY f.id";
2491         if ($counts = $DB->get_records_sql($sql, $params)) {
2492             foreach ($counts as $count) {
2493                 $counts[$count->id] = $count->dcount;
2494             }
2495             $cache[$course->id] = $counts;
2496         } else {
2497             $cache[$course->id] = array();
2498         }
2499     }
2501     if (empty($cache[$course->id][$forum->id])) {
2502         return 0;
2503     }
2505     $groupmode = groups_get_activity_groupmode($cm, $course);
2507     if ($groupmode != SEPARATEGROUPS) {
2508         return $cache[$course->id][$forum->id];
2509     }
2511     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
2512         return $cache[$course->id][$forum->id];
2513     }
2515     require_once($CFG->dirroot.'/course/lib.php');
2517     $modinfo = get_fast_modinfo($course);
2519     $mygroups = $modinfo->get_groups($cm->groupingid);
2521     // add all groups posts
2522     $mygroups[-1] = -1;
2524     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2525     $params[] = $forum->id;
2527     if (!empty($CFG->forum_enabletimedposts)) {
2528         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2529         $params[] = $now;
2530         $params[] = $now;
2531     } else {
2532         $timedsql = "";
2533     }
2535     $sql = "SELECT COUNT(d.id)
2536               FROM {forum_discussions} d
2537              WHERE d.groupid $mygroups_sql AND d.forum = ?
2538                    $timedsql";
2540     return $DB->get_field_sql($sql, $params);
2543 /**
2544  * Get all discussions in a forum
2545  *
2546  * @global object
2547  * @global object
2548  * @global object
2549  * @uses CONTEXT_MODULE
2550  * @uses VISIBLEGROUPS
2551  * @param object $cm
2552  * @param string $forumsort
2553  * @param bool $fullpost
2554  * @param int $unused
2555  * @param int $limit
2556  * @param bool $userlastmodified
2557  * @param int $page
2558  * @param int $perpage
2559  * @param int $groupid if groups enabled, get discussions for this group overriding the current group.
2560  *                     Use FORUM_POSTS_ALL_USER_GROUPS for all the user groups
2561  * @param int $updatedsince retrieve only discussions updated since the given time
2562  * @return array
2563  */
2564 function forum_get_discussions($cm, $forumsort="", $fullpost=true, $unused=-1, $limit=-1,
2565                                 $userlastmodified=false, $page=-1, $perpage=0, $groupid = -1,
2566                                 $updatedsince = 0) {
2567     global $CFG, $DB, $USER;
2569     $timelimit = '';
2571     $now = floor(time() / 60) * 60;
2572     $params = array($cm->instance);
2574     $modcontext = context_module::instance($cm->id);
2576     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2577         return array();
2578     }
2580     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2582         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2583             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2584             $params[] = $now;
2585             $params[] = $now;
2586             if (isloggedin()) {
2587                 $timelimit .= " OR d.userid = ?";
2588                 $params[] = $USER->id;
2589             }
2590             $timelimit .= ")";
2591         }
2592     }
2594     if ($limit > 0) {
2595         $limitfrom = 0;
2596         $limitnum  = $limit;
2597     } else if ($page != -1) {
2598         $limitfrom = $page*$perpage;
2599         $limitnum  = $perpage;
2600     } else {
2601         $limitfrom = 0;
2602         $limitnum  = 0;
2603     }
2605     $groupmode    = groups_get_activity_groupmode($cm);
2607     if ($groupmode) {
2609         if (empty($modcontext)) {
2610             $modcontext = context_module::instance($cm->id);
2611         }
2613         // Special case, we received a groupid to override currentgroup.
2614         if ($groupid > 0) {
2615             $course = get_course($cm->course);
2616             if (!groups_group_visible($groupid, $course, $cm)) {
2617                 // User doesn't belong to this group, return nothing.
2618                 return array();
2619             }
2620             $currentgroup = $groupid;
2621         } else if ($groupid === -1) {
2622             $currentgroup = groups_get_activity_group($cm);
2623         } else {
2624             // Get discussions for all groups current user can see.
2625             $currentgroup = null;
2626         }
2628         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2629             if ($currentgroup) {
2630                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2631                 $params[] = $currentgroup;
2632             } else {
2633                 $groupselect = "";
2634             }
2636         } else {
2637             // Separate groups.
2639             // Get discussions for all groups current user can see.
2640             if ($currentgroup === null) {
2641                 $mygroups = array_keys(groups_get_all_groups($cm->course, $USER->id, $cm->groupingid, 'g.id'));
2642                 if (empty($mygroups)) {
2643                      $groupselect = "AND d.groupid = -1";
2644                 } else {
2645                     list($insqlgroups, $inparamsgroups) = $DB->get_in_or_equal($mygroups);
2646                     $groupselect = "AND (d.groupid = -1 OR d.groupid $insqlgroups)";
2647                     $params = array_merge($params, $inparamsgroups);
2648                 }
2649             } else if ($currentgroup) {
2650                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2651                 $params[] = $currentgroup;
2652             } else {
2653                 $groupselect = "AND d.groupid = -1";
2654             }
2655         }
2656     } else {
2657         $groupselect = "";
2658     }
2659     if (empty($forumsort)) {
2660         $forumsort = forum_get_default_sort_order();
2661     }
2662     if (empty($fullpost)) {
2663         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2664     } else {
2665         $postdata = "p.*";
2666     }
2668     if (empty($userlastmodified)) {  // We don't need to know this
2669         $umfields = "";
2670         $umtable  = "";
2671     } else {
2672         $umfields = ', ' . get_all_user_name_fields(true, 'um', null, 'um') . ', um.email AS umemail, um.picture AS umpicture,
2673                         um.imagealt AS umimagealt';
2674         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2675     }
2677     $updatedsincesql = '';
2678     if (!empty($updatedsince)) {
2679         $updatedsincesql = 'AND d.timemodified > ?';
2680         $params[] = $updatedsince;
2681     }
2683     $allnames = get_all_user_name_fields(true, 'u');
2684     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend, d.pinned, $allnames,
2685                    u.email, u.picture, u.imagealt $umfields
2686               FROM {forum_discussions} d
2687                    JOIN {forum_posts} p ON p.discussion = d.id
2688                    JOIN {user} u ON p.userid = u.id
2689                    $umtable
2690              WHERE d.forum = ? AND p.parent = 0
2691                    $timelimit $groupselect $updatedsincesql
2692           ORDER BY $forumsort, d.id DESC";
2694     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2697 /**
2698  * Gets the neighbours (previous and next) of a discussion.
2699  *
2700  * The calculation is based on the timemodified when time modified or time created is identical
2701  * It will revert to using the ID to sort consistently. This is better tha skipping a discussion.
2702  *
2703  * For blog-style forums, the calculation is based on the original creation time of the
2704  * blog post.
2705  *
2706  * Please note that this does not check whether or not the discussion passed is accessible
2707  * by the user, it simply uses it as a reference to find the neighbours. On the other hand,
2708  * the returned neighbours are checked and are accessible to the current user.
2709  *
2710  * @param object $cm The CM record.
2711  * @param object $discussion The discussion record.
2712  * @param object $forum The forum instance record.
2713  * @return array That always contains the keys 'prev' and 'next'. When there is a result
2714  *               they contain the record with minimal information such as 'id' and 'name'.
2715  *               When the neighbour is not found the value is false.
2716  */
2717 function forum_get_discussion_neighbours($cm, $discussion, $forum) {
2718     global $CFG, $DB, $USER;
2720     if ($cm->instance != $discussion->forum or $discussion->forum != $forum->id or $forum->id != $cm->instance) {
2721         throw new coding_exception('Discussion is not part of the same forum.');
2722     }
2724     $neighbours = array('prev' => false, 'next' => false);
2725     $now = floor(time() / 60) * 60;
2726     $params = array();
2728     $modcontext = context_module::instance($cm->id);
2729     $groupmode    = groups_get_activity_groupmode($cm);
2730     $currentgroup = groups_get_activity_group($cm);
2732     // Users must fulfill timed posts.
2733     $timelimit = '';
2734     if (!empty($CFG->forum_enabletimedposts)) {
2735         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2736             $timelimit = ' AND ((d.timestart <= :tltimestart AND (d.timeend = 0 OR d.timeend > :tltimeend))';
2737             $params['tltimestart'] = $now;
2738             $params['tltimeend'] = $now;
2739             if (isloggedin()) {
2740                 $timelimit .= ' OR d.userid = :tluserid';
2741                 $params['tluserid'] = $USER->id;
2742             }
2743             $timelimit .= ')';
2744         }
2745     }
2747     // Limiting to posts accessible according to groups.
2748     $groupselect = '';
2749     if ($groupmode) {
2750         if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $modcontext)) {
2751             if ($currentgroup) {
2752                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2753                 $params['groupid'] = $currentgroup;
2754             }
2755         } else {
2756             if ($currentgroup) {
2757                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2758                 $params['groupid'] = $currentgroup;
2759             } else {
2760                 $groupselect = 'AND d.groupid = -1';
2761             }
2762         }
2763     }
2765     $params['forumid'] = $cm->instance;
2766     $params['discid1'] = $discussion->id;
2767     $params['discid2'] = $discussion->id;
2768     $params['discid3'] = $discussion->id;
2769     $params['discid4'] = $discussion->id;
2770     $params['disctimecompare1'] = $discussion->timemodified;
2771     $params['disctimecompare2'] = $discussion->timemodified;
2772     $params['pinnedstate1'] = (int) $discussion->pinned;
2773     $params['pinnedstate2'] = (int) $discussion->pinned;
2774     $params['pinnedstate3'] = (int) $discussion->pinned;
2775     $params['pinnedstate4'] = (int) $discussion->pinned;
2777     $sql = "SELECT d.id, d.name, d.timemodified, d.groupid, d.timestart, d.timeend
2778               FROM {forum_discussions} d
2779               JOIN {forum_posts} p ON d.firstpost = p.id
2780              WHERE d.forum = :forumid
2781                AND d.id <> :discid1
2782                    $timelimit
2783                    $groupselect";
2784     $comparefield = "d.timemodified";
2785     $comparevalue = ":disctimecompare1";
2786     $comparevalue2  = ":disctimecompare2";
2787     if (!empty($CFG->forum_enabletimedposts)) {
2788         // Here we need to take into account the release time (timestart)
2789         // if one is set, of the neighbouring posts and compare it to the
2790         // timestart or timemodified of *this* post depending on if the
2791         // release date of this post is in the future or not.
2792         // This stops discussions that appear later because of the
2793         // timestart value from being buried under discussions that were
2794         // made afterwards.
2795         $comparefield = "CASE WHEN d.timemodified < d.timestart
2796                                 THEN d.timestart ELSE d.timemodified END";
2797         if ($discussion->timemodified < $discussion->timestart) {
2798             // Normally we would just use the timemodified for sorting
2799             // discussion posts. However, when timed discussions are enabled,
2800             // then posts need to be sorted base on the later of timemodified
2801             // or the release date of the post (timestart).
2802             $params['disctimecompare1'] = $discussion->timestart;
2803             $params['disctimecompare2'] = $discussion->timestart;
2804         }
2805     }
2806     $orderbydesc = forum_get_default_sort_order(true, $comparefield, 'd', false);
2807     $orderbyasc = forum_get_default_sort_order(false, $comparefield, 'd', false);
2809     if ($forum->type === 'blog') {
2810          $subselect = "SELECT pp.created
2811                    FROM {forum_discussions} dd
2812                    JOIN {forum_posts} pp ON dd.firstpost = pp.id ";
2814          $subselectwhere1 = " WHERE dd.id = :discid3";
2815          $subselectwhere2 = " WHERE dd.id = :discid4";
2817          $comparefield = "p.created";
2819          $sub1 = $subselect.$subselectwhere1;
2820          $comparevalue = "($sub1)";
2822          $sub2 = $subselect.$subselectwhere2;
2823          $comparevalue2 = "($sub2)";
2825          $orderbydesc = "d.pinned, p.created DESC";
2826          $orderbyasc = "d.pinned, p.created ASC";
2827     }
2829     $prevsql = $sql . " AND ( (($comparefield < $comparevalue) AND :pinnedstate1 = d.pinned)
2830                          OR ($comparefield = $comparevalue2 AND (d.pinned = 0 OR d.pinned = :pinnedstate4) AND d.id < :discid2)
2831                          OR (d.pinned = 0 AND d.pinned <> :pinnedstate2))
2832                    ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbydesc, d.id DESC";
2834     $nextsql = $sql . " AND ( (($comparefield > $comparevalue) AND :pinnedstate1 = d.pinned)
2835                          OR ($comparefield = $comparevalue2 AND (d.pinned = 1 OR d.pinned = :pinnedstate4) AND d.id > :discid2)
2836                          OR (d.pinned = 1 AND d.pinned <> :pinnedstate2))
2837                    ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbyasc, d.id ASC";
2839     $neighbours['prev'] = $DB->get_record_sql($prevsql, $params, IGNORE_MULTIPLE);
2840     $neighbours['next'] = $DB->get_record_sql($nextsql, $params, IGNORE_MULTIPLE);
2841     return $neighbours;
2844 /**
2845  * Get the sql to use in the ORDER BY clause for forum discussions.
2846  *
2847  * This has the ordering take timed discussion windows into account.
2848  *
2849  * @param bool $desc True for DESC, False for ASC.
2850  * @param string $compare The field in the SQL to compare to normally sort by.
2851  * @param string $prefix The prefix being used for the discussion table.
2852  * @param bool $pinned sort pinned posts to the top
2853  * @return string
2854  */
2855 function forum_get_default_sort_order($desc = true, $compare = 'd.timemodified', $prefix = 'd', $pinned = true) {
2856     global $CFG;
2858     if (!empty($prefix)) {
2859         $prefix .= '.';
2860     }
2862     $dir = $desc ? 'DESC' : 'ASC';
2864     if ($pinned == true) {
2865         $pinned = "{$prefix}pinned DESC,";
2866     } else {
2867         $pinned = '';
2868     }
2870     $sort = "{$prefix}timemodified";
2871     if (!empty($CFG->forum_enabletimedposts)) {
2872         $sort = "CASE WHEN {$compare} < {$prefix}timestart
2873                  THEN {$prefix}timestart
2874                  ELSE {$compare}
2875                  END";
2876     }
2877     return "$pinned $sort $dir";
2880 /**
2881  *
2882  * @global object
2883  * @global object
2884  * @global object
2885  * @uses CONTEXT_MODULE
2886  * @uses VISIBLEGROUPS
2887  * @param object $cm
2888  * @return array
2889  */
2890 function forum_get_discussions_unread($cm) {
2891     global $CFG, $DB, $USER;
2893     $now = floor(time() / 60) * 60;
2894     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2896     $params = array();
2897     $groupmode    = groups_get_activity_groupmode($cm);
2898     $currentgroup = groups_get_activity_group($cm);
2900     if ($groupmode) {
2901         $modcontext = context_module::instance($cm->id);
2903         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2904             if ($currentgroup) {
2905                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2906                 $params['currentgroup'] = $currentgroup;
2907             } else {
2908                 $groupselect = "";
2909             }
2911         } else {
2912             //separate groups without access all
2913             if ($currentgroup) {
2914                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2915                 $params['currentgroup'] = $currentgroup;
2916             } else {
2917                 $groupselect = "AND d.groupid = -1";
2918             }
2919         }
2920     } else {
2921         $groupselect = "";
2922     }
2924     if (!empty($CFG->forum_enabletimedposts)) {
2925         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2926         $params['now1'] = $now;
2927         $params['now2'] = $now;
2928     } else {
2929         $timedsql = "";
2930     }
2932     $sql = "SELECT d.id, COUNT(p.id) AS unread
2933               FROM {forum_discussions} d
2934                    JOIN {forum_posts} p     ON p.discussion = d.id
2935                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2936              WHERE d.forum = {$cm->instance}
2937                    AND p.modified >= :cutoffdate AND r.id is NULL
2938                    $groupselect
2939                    $timedsql
2940           GROUP BY d.id";
2941     $params['cutoffdate'] = $cutoffdate;
2943     if ($unreads = $DB->get_records_sql($sql, $params)) {
2944         foreach ($unreads as $unread) {
2945             $unreads[$unread->id] = $unread->unread;
2946         }
2947         return $unreads;
2948     } else {
2949         return array();
2950     }
2953 /**
2954  * @global object
2955  * @global object
2956  * @global object
2957  * @uses CONEXT_MODULE
2958  * @uses VISIBLEGROUPS
2959  * @param object $cm
2960  * @return array
2961  */
2962 function forum_get_discussions_count($cm) {
2963     global $CFG, $DB, $USER;
2965     $now = floor(time() / 60) * 60;
2966     $params = array($cm->instance);
2967     $groupmode    = groups_get_activity_groupmode($cm);
2968     $currentgroup = groups_get_activity_group($cm);
2970     if ($groupmode) {
2971         $modcontext = context_module::instance($cm->id);
2973         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2974             if ($currentgroup) {
2975                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2976                 $params[] = $currentgroup;
2977             } else {
2978                 $groupselect = "";
2979             }
2981         } else {
2982             //seprate groups without access all
2983             if ($currentgroup) {
2984                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2985                 $params[] = $currentgroup;
2986             } else {
2987                 $groupselect = "AND d.groupid = -1";
2988             }
2989         }
2990     } else {
2991         $groupselect = "";
2992     }
2994     $timelimit = "";
2996     if (!empty($CFG->forum_enabletimedposts)) {
2998         $modcontext = context_module::instance($cm->id);
3000         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
3001             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
3002             $params[] = $now;
3003             $params[] = $now;
3004             if (isloggedin()) {
3005                 $timelimit .= " OR d.userid = ?";
3006                 $params[] = $USER->id;
3007             }
3008             $timelimit .= ")";
3009         }
3010     }
3012     $sql = "SELECT COUNT(d.id)
3013               FROM {forum_discussions} d
3014                    JOIN {forum_posts} p ON p.discussion = d.id
3015              WHERE d.forum = ? AND p.parent = 0
3016                    $groupselect $timelimit";
3018     return $DB->get_field_sql($sql, $params);
3022 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
3025 /**
3026  * @global object
3027  * @global object
3028  * @param int $courseid
3029  * @param string $type
3030  */
3031 function forum_get_course_forum($courseid, $type) {
3032 // How to set up special 1-per-course forums
3033     global $CFG, $DB, $OUTPUT, $USER;
3035     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
3036         // There should always only be ONE, but with the right combination of
3037         // errors there might be more.  In this case, just return the oldest one (lowest ID).
3038         foreach ($forums as $forum) {
3039             return $forum;   // ie the first one
3040         }
3041     }
3043     // Doesn't exist, so create one now.
3044     $forum = new stdClass();
3045     $forum->course = $courseid;
3046     $forum->type = "$type";
3047     if (!empty($USER->htmleditor)) {
3048         $forum->introformat = $USER->htmleditor;
3049     }
3050     switch ($forum->type) {
3051         case "news":
3052             $forum->name  = get_string("namenews", "forum");
3053             $forum->intro = get_string("intronews", "forum");
3054             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
3055             $forum->assessed = 0;
3056             if ($courseid == SITEID) {
3057                 $forum->name  = get_string("sitenews");
3058                 $forum->forcesubscribe = 0;
3059             }
3060             break;
3061         case "social":
3062             $forum->name  = get_string("namesocial", "forum");
3063             $forum->intro = get_string("introsocial", "forum");
3064             $forum->assessed = 0;
3065             $forum->forcesubscribe = 0;
3066             break;
3067         case "blog":
3068             $forum->name = get_string('blogforum', 'forum');
3069             $forum->intro = get_string('introblog', 'forum');
3070             $forum->assessed = 0;
3071             $forum->forcesubscribe = 0;
3072             break;
3073         default:
3074             echo $OUTPUT->notification("That forum type doesn't exist!");
3075             return false;
3076             break;
3077     }
3079     $forum->timemodified = time();
3080     $forum->id = $DB->insert_record("forum", $forum);
3082     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
3083         echo $OUTPUT->notification("Could not find forum module!!");
3084         return false;
3085     }
3086     $mod = new stdClass();
3087     $mod->course = $courseid;
3088     $mod->module = $module->id;
3089     $mod->instance = $forum->id;
3090     $mod->section = 0;
3091     include_once("$CFG->dirroot/course/lib.php");
3092     if (! $mod->coursemodule = add_course_module($mod) ) {
3093         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
3094         return false;
3095     }
3096     $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
3097     return $DB->get_record("forum", array("id" => "$forum->id"));
3100 /**
3101  * Print a forum post
3102  *
3103  * @global object
3104  * @global object
3105  * @uses FORUM_MODE_THREADED
3106  * @uses PORTFOLIO_FORMAT_PLAINHTML
3107  * @uses PORTFOLIO_FORMAT_FILE
3108  * @uses PORTFOLIO_FORMAT_RICHHTML
3109  * @uses PORTFOLIO_ADD_TEXT_LINK
3110  * @uses CONTEXT_MODULE
3111  * @param object $post The post to print.
3112  * @param object $discussion
3113  * @param object $forum
3114  * @param object $cm
3115  * @param object $course
3116  * @param boolean $ownpost Whether this post belongs to the current user.
3117  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3118  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3119  * @param string $footer Extra stuff to print after the message.
3120  * @param string $highlight Space-separated list of terms to highlight.
3121  * @param int $post_read true, false or -99. If we already know whether this user
3122  *          has read this post, pass that in, otherwise, pass in -99, and this
3123  *          function will work it out.
3124  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3125  *          the current user can't see this post, if this argument is true
3126  *          (the default) then print a dummy 'you can't see this post' post.
3127  *          If false, don't output anything at all.
3128  * @param bool|null $istracked
3129  * @return void
3130  */
3131 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3132                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3133     global $USER, $CFG, $OUTPUT;
3135     require_once($CFG->libdir . '/filelib.php');
3137     // String cache
3138     static $str;
3139     // This is an extremely hacky way to ensure we only print the 'unread' anchor
3140     // the first time we encounter an unread post on a page. Ideally this would
3141     // be moved into the caller somehow, and be better testable. But at the time
3142     // of dealing with this bug, this static workaround was the most surgical and
3143     // it fits together with only printing th unread anchor id once on a given page.
3144     static $firstunreadanchorprinted = false;
3146     $modcontext = context_module::instance($cm->id);
3148     $post->course = $course->id;
3149     $post->forum  = $forum->id;
3150     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3151     if (!empty($CFG->enableplagiarism)) {
3152         require_once($CFG->libdir.'/plagiarismlib.php');
3153         $post->message .= plagiarism_get_links(array('userid' => $post->userid,
3154             'content' => $post->message,
3155             'cmid' => $cm->id,
3156             'course' => $post->course,
3157             'forum' => $post->forum));
3158     }
3160     // caching
3161     if (!isset($cm->cache)) {
3162         $cm->cache = new stdClass;
3163     }
3165     if (!isset($cm->cache->caps)) {
3166         $cm->cache->caps = array();
3167         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3168         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3169         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3170         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3171         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3172         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3173         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3174         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3175         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3176     }
3178     if (!isset($cm->uservisible)) {
3179         $cm->uservisible = \core_availability\info_module::is_user_visible($cm, 0, false);
3180     }
3182     if ($istracked && is_null($postisread)) {
3183         $postisread = forum_tp_is_post_read($USER->id, $post);
3184     }
3186     if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm, false)) {
3187         // Do _not_ check the deleted flag - we need to display a different UI.
3188         $output = '';
3189         if (!$dummyifcantsee) {
3190             if ($return) {
3191                 return $output;
3192             }
3193             echo $output;
3194             return;
3195         }
3196         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3197         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix',
3198                                                        'role' => 'region',
3199                                                        'aria-label' => get_string('hiddenforumpost', 'forum')));
3200         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3201         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3202         if ($post->parent) {
3203             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3204         } else {
3205             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3206         }
3207         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class' => 'subject',
3208                                                                                            'role' => 'header')); // Subject.
3209         $output .= html_writer::tag('div', get_string('forumauthorhidden', 'forum'), array('class' => 'author',
3210                                                                                            'role' => 'header')); // Author.
3211         $output .= html_writer::end_tag('div');
3212         $output .= html_writer::end_tag('div'); // row
3213         $output .= html_writer::start_tag('div', array('class'=>'row'));
3214         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3215         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3216         $output .= html_writer::end_tag('div'); // row
3217         $output .= html_writer::end_tag('div'); // forumpost
3219         if ($return) {
3220             return $output;
3221         }
3222         echo $output;
3223         return;
3224     }
3226     if (!empty($post->deleted)) {
3227         // Note: Posts marked as deleted are still returned by the above forum_user_can_post because it is required for
3228         // nesting of posts.
3229         $output = '';
3230         if (!$dummyifcantsee) {
3231             if ($return) {
3232                 return $output;
3233             }
3234             echo $output;
3235             return;
3236         }
3237         $output .= html_writer::tag('a', '', [
3238                 'id' => "p{$post->id}",
3239             ]);
3240         $output .= html_writer::start_tag('div', [
3241                 'class' => 'forumpost clearfix',
3242                 'role' => 'region',
3243                 'aria-label' => get_string('forumbodydeleted', 'forum'),
3244             ]);
3246         $output .= html_writer::start_tag('div', array('class' => 'row header'));
3247         $output .= html_writer::tag('div', '', array('class' => 'left picture'));
3249         $classes = ['topic'];
3250         if (!empty($post->parent)) {
3251             $classes[] = 'starter';
3252         }
3253         $output .= html_writer::start_tag('div', ['class' => implode(' ', $classes)]);
3255         // Subject.
3256         $output .= html_writer::tag('div', get_string('forumsubjectdeleted', 'forum'), [
3257                 'class' => 'subject',
3258                 'role' => 'header',
3259             ]);
3261         // Author.
3262         $output .= html_writer::tag('div', '', [
3263                 'class' => 'author',
3264                 'role' => 'header',
3265             ]);
3267         $output .= html_writer::end_tag('div');
3268         $output .= html_writer::end_tag('div'); // End row.
3269         $output .= html_writer::start_tag('div', ['class' => 'row']);
3270         $output .= html_writer::tag('div', '&nbsp;', ['class' => 'left side']); // Groups.
3271         $output .= html_writer::tag('div', get_string('forumbodydeleted', 'forum'), ['class' => 'content']); // Content.
3272         $output .= html_writer::end_tag('div'); // End row.
3273         $output .= html_writer::end_tag('div'); // End forumpost.
3275         if ($return) {
3276             return $output;
3277         }
3278         echo $output;
3279         return;
3280     }
3282     if (empty($str)) {
3283         $str = new stdClass;
3284         $str->edit         = get_string('edit', 'forum');
3285         $str->delete       = get_string('delete', 'forum');
3286         $str->reply        = get_string('reply', 'forum');
3287         $str->parent       = get_string('parent', 'forum');
3288         $str->pruneheading = get_string('pruneheading', 'forum');
3289         $str->prune        = get_string('prune', 'forum');
3290         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3291         $str->markread     = get_string('markread', 'forum');
3292         $str->markunread   = get_string('markunread', 'forum');
3293     }
3295     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3297     // Build an object that represents the posting user
3298     $postuser = new stdClass;
3299     $postuserfields = explode(',', user_picture::fields());
3300     $postuser = username_load_fields_from_object($postuser, $post, null, $postuserfields);
3301     $postuser->id = $post->userid;
3302     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3303     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3305     // Prepare the groups the posting user belongs to
3306     if (isset($cm->cache->usersgroups)) {
3307         $groups = array();
3308         if (isset($cm->cache->usersgroups[$post->userid])) {
3309             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3310                 $groups[$gid] = $cm->cache->groups[$gid];
3311             }
3312         }
3313     } else {
3314         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3315     }
3317     // Prepare the attachements for the post, files then images
3318     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3320     // Determine if we need to shorten this post
3321     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3324     // Prepare an array of commands
3325     $commands = array();
3327     // Add a permalink.
3328     $permalink = new moodle_url($discussionlink);
3329     $permalink->set_anchor('p' . $post->id);
3330     $commands[] = array('url' => $permalink, 'text' => get_string('permalink', 'forum'));
3332     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3333     // Don't display the mark read / unread controls in this case.
3334     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3335         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3336         $text = $str->markunread;
3337         if (!$postisread) {
3338             $url->param('mark', 'read');
3339             $text = $str->markread;
3340         }
3341         if ($str->displaymode == FORUM_MODE_THREADED) {
3342             $url->param('parent', $post->parent);
3343         } else {
3344             $url->set_anchor('p'.$post->id);
3345         }
3346         $commands[] = array('url'=>$url, 'text'=>$text);
3347     }
3349     // Zoom in to the parent specifically
3350     if ($post->parent) {
3351         $url = new moodle_url($discussionlink);
3352         if ($str->displaymode == FORUM_MODE_THREADED) {
3353             $url->param('parent', $post->parent);
3354         } else {
3355             $url->set_anchor('p'.$post->parent);
3356         }
3357         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3358     }
3360     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3361     $age = time() - $post->created;
3362     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3363         $age = 0;
3364     }
3366     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3367         if (has_capability('moodle/course:manageactivities', $modcontext)) {
3368             // The first post in single simple is the forum description.
3369             $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
3370         }
3371     } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3372         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3373     }
3375     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3376         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3377     }
3379     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3380         // Do not allow deleting of first post in single simple type.
3381     } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3382         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3383     }
3385     if ($reply) {
3386         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
3387     }
3389     if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
3390         $p = array('postid' => $post->id);
3391         require_once($CFG->libdir.'/portfoliolib.php');
3392         $button = new portfolio_add_button();
3393         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
3394         if (empty($attachments)) {
3395             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3396         } else {
3397             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3398         }
3400         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3401         if (!empty($porfoliohtml)) {
3402             $commands[] = $porfoliohtml;
3403         }
3404     }
3405     // Finished building commands
3408     // Begin output
3410     $output  = '';
3412     if ($istracked) {
3413         if ($postisread) {
3414             $forumpostclass = ' read';
3415         } else {
3416             $forumpostclass = ' unread';
3417             // If this is the first unread post printed then give it an anchor and id of unread.
3418             if (!$firstunreadanchorprinted) {
3419                 $output .= html_writer::tag('a', '', array('id' => 'unread'));
3420                 $firstunreadanchorprinted = true;
3421             }
3422         }
3423     } else {
3424         // ignore trackign status if not tracked or tracked param missing
3425         $forumpostclass = '';
3426     }
3428     $topicclass = '';
3429     if (empty($post->parent)) {