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