MDL-34160 mod_forum: Add extra site and course vars to postmailsubject
[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                 if (!isset($userto->viewfullnames[$forum->id])) {
799                     $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
800                 } else {
801                     $data->viewfullnames = $userto->viewfullnames[$forum->id];
802                 }
804                 // Not all of these variables are used in the default language
805                 // string but are made available to support custom subjects.
806                 $a = new stdClass();
807                 $a->subject = $data->get_subject();
808                 $a->forumname = $cleanforumname;
809                 $a->sitefullname = format_string($site->fullname);
810                 $a->siteshortname = format_string($site->shortname);
811                 $a->courseidnumber = $data->get_courseidnumber();
812                 $a->coursefullname = $data->get_coursefullname();
813                 $a->courseshortname = $data->get_coursename();
814                 $postsubject = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
816                 // Send the post now!
817                 mtrace('Sending ', '');
819                 $eventdata = new \core\message\message();
820                 $eventdata->component           = 'mod_forum';
821                 $eventdata->name                = 'posts';
822                 $eventdata->userfrom            = $userfrom;
823                 $eventdata->userto              = $userto;
824                 $eventdata->subject             = $postsubject;
825                 $eventdata->fullmessage         = $textout->render($data);
826                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
827                 $eventdata->fullmessagehtml     = $htmlout->render($data);
828                 $eventdata->notification        = 1;
829                 $eventdata->replyto             = $replyaddress;
830                 if (!empty($replyaddress)) {
831                     // Add extra text to email messages if they can reply back.
832                     $textfooter = "\n\n" . get_string('replytopostbyemail', 'mod_forum');
833                     $htmlfooter = html_writer::tag('p', get_string('replytopostbyemail', 'mod_forum'));
834                     $additionalcontent = array('fullmessage' => array('footer' => $textfooter),
835                                      'fullmessagehtml' => array('footer' => $htmlfooter));
836                     $eventdata->set_additional_content('email', $additionalcontent);
837                 }
839                 // If forum_replytouser is not set then send mail using the noreplyaddress.
840                 if (empty($CFG->forum_replytouser)) {
841                     $eventdata->userfrom = core_user::get_noreply_user();
842                 }
844                 $smallmessagestrings = new stdClass();
845                 $smallmessagestrings->user          = fullname($userfrom);
846                 $smallmessagestrings->forumname     = "$shortname: " . format_string($forum->name, true) . ": " . $discussion->name;
847                 $smallmessagestrings->message       = $post->message;
849                 // Make sure strings are in message recipients language.
850                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
852                 $contexturl = new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id), 'p' . $post->id);
853                 $eventdata->contexturl = $contexturl->out();
854                 $eventdata->contexturlname = $discussion->name;
856                 $mailresult = message_send($eventdata);
857                 if (!$mailresult) {
858                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
859                             " ($userto->email) .. not trying again.");
860                     $errorcount[$post->id]++;
861                 } else {
862                     $mailcount[$post->id]++;
864                     // Mark post as read if forum_usermarksread is set off.
865                     if (!$CFG->forum_usermarksread) {
866                         $userto->markposts[$post->id] = $post->id;
867                     }
868                 }
870                 mtrace('post ' . $post->id . ': ' . $post->subject);
871             }
873             // Mark processed posts as read.
874             forum_tp_mark_posts_read($userto, $userto->markposts);
875             unset($userto);
876         }
877     }
879     if ($posts) {
880         foreach ($posts as $post) {
881             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
882             if ($errorcount[$post->id]) {
883                 $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
884             }
885         }
886     }
888     // release some memory
889     unset($subscribedusers);
890     unset($mailcount);
891     unset($errorcount);
893     cron_setup_user();
895     $sitetimezone = core_date::get_server_timezone();
897     // Now see if there are any digest mails waiting to be sent, and if we should send them
899     mtrace('Starting digest processing...');
901     core_php_time_limit::raise(300); // terminate if not able to fetch all digests in 5 minutes
903     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
904         set_config('digestmailtimelast', 0);
905     }
907     $timenow = time();
908     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
910     // Delete any really old ones (normally there shouldn't be any)
911     $weekago = $timenow - (7 * 24 * 3600);
912     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
913     mtrace ('Cleaned old digest records');
915     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
917         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
919         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
921         if ($digestposts_rs->valid()) {
923             // We have work to do
924             $usermailcount = 0;
926             //caches - reuse the those filled before too
927             $discussionposts = array();
928             $userdiscussions = array();
930             foreach ($digestposts_rs as $digestpost) {
931                 if (!isset($posts[$digestpost->postid])) {
932                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
933                         $posts[$digestpost->postid] = $post;
934                     } else {
935                         continue;
936                     }
937                 }
938                 $discussionid = $digestpost->discussionid;
939                 if (!isset($discussions[$discussionid])) {
940                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
941                         $discussions[$discussionid] = $discussion;
942                     } else {
943                         continue;
944                     }
945                 }
946                 $forumid = $discussions[$discussionid]->forum;
947                 if (!isset($forums[$forumid])) {
948                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
949                         $forums[$forumid] = $forum;
950                     } else {
951                         continue;
952                     }
953                 }
955                 $courseid = $forums[$forumid]->course;
956                 if (!isset($courses[$courseid])) {
957                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
958                         $courses[$courseid] = $course;
959                     } else {
960                         continue;
961                     }
962                 }
964                 if (!isset($coursemodules[$forumid])) {
965                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
966                         $coursemodules[$forumid] = $cm;
967                     } else {
968                         continue;
969                     }
970                 }
971                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
972                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
973             }
974             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
976             // Data collected, start sending out emails to each user
977             foreach ($userdiscussions as $userid => $thesediscussions) {
979                 core_php_time_limit::raise(120); // terminate if processing of any account takes longer than 2 minutes
981                 cron_setup_user();
983                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
985                 // First of all delete all the queue entries for this user
986                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
988                 // Init user caches - we keep the cache for one cycle only,
989                 // otherwise it would unnecessarily consume memory.
990                 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
991                     $userto = clone($users[$userid]);
992                 } else {
993                     $userto = $DB->get_record('user', array('id' => $userid));
994                     forum_cron_minimise_user_record($userto);
995                 }
996                 $userto->viewfullnames = array();
997                 $userto->canpost       = array();
998                 $userto->markposts     = array();
1000                 // Override the language and timezone of the "current" user, so that
1001                 // mail is customised for the receiver.
1002                 cron_setup_user($userto);
1004                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
1006                 $headerdata = new stdClass();
1007                 $headerdata->sitename = format_string($site->fullname, true);
1008                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
1010                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
1011                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
1013                 $posthtml = "<head>";
1014 /*                foreach ($CFG->stylesheets as $stylesheet) {
1015                     //TODO: MDL-21120
1016                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
1017                 }*/
1018                 $posthtml .= "</head>\n<body id=\"email\">\n";
1019                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
1021                 foreach ($thesediscussions as $discussionid) {
1023                     core_php_time_limit::raise(120);   // to be reset for each post
1025                     $discussion = $discussions[$discussionid];
1026                     $forum      = $forums[$discussion->forum];
1027                     $course     = $courses[$forum->course];
1028                     $cm         = $coursemodules[$forum->id];
1030                     //override language
1031                     cron_setup_user($userto, $course);
1033                     // Fill caches
1034                     if (!isset($userto->viewfullnames[$forum->id])) {
1035                         $modcontext = context_module::instance($cm->id);
1036                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
1037                     }
1038                     if (!isset($userto->canpost[$discussion->id])) {
1039                         $modcontext = context_module::instance($cm->id);
1040                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1041                     }
1043                     $strforums      = get_string('forums', 'forum');
1044                     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
1045                     $canreply       = $userto->canpost[$discussion->id];
1046                     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1048                     $posttext .= "\n \n";
1049                     $posttext .= '=====================================================================';
1050                     $posttext .= "\n \n";
1051                     $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1052                     if ($discussion->name != $forum->name) {
1053                         $posttext  .= " -> ".format_string($discussion->name,true);
1054                     }
1055                     $posttext .= "\n";
1056                     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1057                     $posttext .= "\n";
1059                     $posthtml .= "<p><font face=\"sans-serif\">".
1060                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
1061                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
1062                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
1063                     if ($discussion->name == $forum->name) {
1064                         $posthtml .= "</font></p>";
1065                     } else {
1066                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
1067                     }
1068                     $posthtml .= '<p>';
1070                     $postsarray = $discussionposts[$discussionid];
1071                     sort($postsarray);
1072                     $sentcount = 0;
1074                     foreach ($postsarray as $postid) {
1075                         $post = $posts[$postid];
1077                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
1078                             $userfrom = $users[$post->userid];
1079                             if (!isset($userfrom->idnumber)) {
1080                                 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
1081                                 forum_cron_minimise_user_record($userfrom);
1082                             }
1084                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
1085                             forum_cron_minimise_user_record($userfrom);
1086                             if ($userscount <= FORUM_CRON_USER_CACHE) {
1087                                 $userscount++;
1088                                 $users[$userfrom->id] = $userfrom;
1089                             }
1091                         } else {
1092                             mtrace('Could not find user '.$post->userid);
1093                             continue;
1094                         }
1096                         if (!isset($userfrom->groups[$forum->id])) {
1097                             if (!isset($userfrom->groups)) {
1098                                 $userfrom->groups = array();
1099                                 if (isset($users[$userfrom->id])) {
1100                                     $users[$userfrom->id]->groups = array();
1101                                 }
1102                             }
1103                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
1104                             if (isset($users[$userfrom->id])) {
1105                                 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
1106                             }
1107                         }
1109                         // Headers to help prevent auto-responders.
1110                         $userfrom->customheaders = array(
1111                                 "Precedence: Bulk",
1112                                 'X-Auto-Response-Suppress: All',
1113                                 'Auto-Submitted: auto-generated',
1114                             );
1116                         $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
1117                         if (!isset($userto->canpost[$discussion->id])) {
1118                             $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1119                         } else {
1120                             $canreply = $userto->canpost[$discussion->id];
1121                         }
1123                         $data = new \mod_forum\output\forum_post_email(
1124                                 $course,
1125                                 $cm,
1126                                 $forum,
1127                                 $discussion,
1128                                 $post,
1129                                 $userfrom,
1130                                 $userto,
1131                                 $canreply
1132                             );
1134                         if (!isset($userto->viewfullnames[$forum->id])) {
1135                             $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1136                         } else {
1137                             $data->viewfullnames = $userto->viewfullnames[$forum->id];
1138                         }
1140                         if ($maildigest == 2) {
1141                             // Subjects and link only.
1142                             $posttext .= $textdigestbasicout->render($data);
1143                             $posthtml .= $htmldigestbasicout->render($data);
1144                         } else {
1145                             // The full treatment.
1146                             $posttext .= $textdigestfullout->render($data);
1147                             $posthtml .= $htmldigestfullout->render($data);
1149                             // Create an array of postid's for this user to mark as read.
1150                             if (!$CFG->forum_usermarksread) {
1151                                 $userto->markposts[$post->id] = $post->id;
1152                             }
1153                         }
1154                         $sentcount++;
1155                     }
1156                     $footerlinks = array();
1157                     if ($canunsubscribe) {
1158                         $footerlinks[] = "<a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">" . get_string("unsubscribe", "forum") . "</a>";
1159                     } else {
1160                         $footerlinks[] = get_string("everyoneissubscribed", "forum");
1161                     }
1162                     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string("digestmailpost", "forum") . '</a>';
1163                     $posthtml .= "\n<div class='mdl-right'><font size=\"1\">" . implode('&nbsp;', $footerlinks) . '</font></div>';
1164                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
1165                 }
1166                 $posthtml .= '</body>';
1168                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
1169                     // This user DOESN'T want to receive HTML
1170                     $posthtml = '';
1171                 }
1173                 $eventdata = new \core\message\message();
1174                 $eventdata->component           = 'mod_forum';
1175                 $eventdata->name                = 'digests';
1176                 $eventdata->userfrom            = core_user::get_noreply_user();
1177                 $eventdata->userto              = $userto;
1178                 $eventdata->subject             = $postsubject;
1179                 $eventdata->fullmessage         = $posttext;
1180                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
1181                 $eventdata->fullmessagehtml     = $posthtml;
1182                 $eventdata->notification        = 1;
1183                 $eventdata->smallmessage        = get_string('smallmessagedigest', 'forum', $sentcount);
1184                 $mailresult = message_send($eventdata);
1186                 if (!$mailresult) {
1187                     mtrace("ERROR: mod/forum/cron.php: Could not send out digest mail to user $userto->id ".
1188                         "($userto->email)... not trying again.");
1189                 } else {
1190                     mtrace("success.");
1191                     $usermailcount++;
1193                     // Mark post as read if forum_usermarksread is set off
1194                     forum_tp_mark_posts_read($userto, $userto->markposts);
1195                 }
1196             }
1197         }
1198     /// We have finishied all digest emails, update $CFG->digestmailtimelast
1199         set_config('digestmailtimelast', $timenow);
1200     }
1202     cron_setup_user();
1204     if (!empty($usermailcount)) {
1205         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
1206     }
1208     if (!empty($CFG->forum_lastreadclean)) {
1209         $timenow = time();
1210         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1211             set_config('forum_lastreadclean', $timenow);
1212             mtrace('Removing old forum read tracking info...');
1213             forum_tp_clean_read_records();
1214         }
1215     } else {
1216         set_config('forum_lastreadclean', time());
1217     }
1219     return true;
1222 /**
1223  *
1224  * @param object $course
1225  * @param object $user
1226  * @param object $mod TODO this is not used in this function, refactor
1227  * @param object $forum
1228  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
1229  */
1230 function forum_user_outline($course, $user, $mod, $forum) {
1231     global $CFG;
1232     require_once("$CFG->libdir/gradelib.php");
1233     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1234     if (empty($grades->items[0]->grades)) {
1235         $grade = false;
1236     } else {
1237         $grade = reset($grades->items[0]->grades);
1238     }
1240     $count = forum_count_user_posts($forum->id, $user->id);
1242     if ($count && $count->postcount > 0) {
1243         $result = new stdClass();
1244         $result->info = get_string("numposts", "forum", $count->postcount);
1245         $result->time = $count->lastpost;
1246         if ($grade) {
1247             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1248         }
1249         return $result;
1250     } else if ($grade) {
1251         $result = new stdClass();
1252         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1254         //datesubmitted == time created. dategraded == time modified or time overridden
1255         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1256         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1257         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1258             $result->time = $grade->dategraded;
1259         } else {
1260             $result->time = $grade->datesubmitted;
1261         }
1263         return $result;
1264     }
1265     return NULL;
1269 /**
1270  * @global object
1271  * @global object
1272  * @param object $coure
1273  * @param object $user
1274  * @param object $mod
1275  * @param object $forum
1276  */
1277 function forum_user_complete($course, $user, $mod, $forum) {
1278     global $CFG,$USER, $OUTPUT;
1279     require_once("$CFG->libdir/gradelib.php");
1281     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1282     if (!empty($grades->items[0]->grades)) {
1283         $grade = reset($grades->items[0]->grades);
1284         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1285         if ($grade->str_feedback) {
1286             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1287         }
1288     }
1290     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
1292         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
1293             print_error('invalidcoursemodule');
1294         }
1295         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1297         foreach ($posts as $post) {
1298             if (!isset($discussions[$post->discussion])) {
1299                 continue;
1300             }
1301             $discussion = $discussions[$post->discussion];
1303             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
1304         }
1305     } else {
1306         echo "<p>".get_string("noposts", "forum")."</p>";
1307     }
1310 /**
1311  * Filters the forum discussions according to groups membership and config.
1312  *
1313  * @since  Moodle 2.8, 2.7.1, 2.6.4
1314  * @param  array $discussions Discussions with new posts array
1315  * @return array Forums with the number of new posts
1316  */
1317 function forum_filter_user_groups_discussions($discussions) {
1319     // Group the remaining discussions posts by their forumid.
1320     $filteredforums = array();
1322     // Discard not visible groups.
1323     foreach ($discussions as $discussion) {
1325         // Course data is already cached.
1326         $instances = get_fast_modinfo($discussion->course)->get_instances();
1327         $forum = $instances['forum'][$discussion->forum];
1329         // Continue if the user should not see this discussion.
1330         if (!forum_is_user_group_discussion($forum, $discussion->groupid)) {
1331             continue;
1332         }
1334         // Grouping results by forum.
1335         if (empty($filteredforums[$forum->instance])) {
1336             $filteredforums[$forum->instance] = new stdClass();
1337             $filteredforums[$forum->instance]->id = $forum->id;
1338             $filteredforums[$forum->instance]->count = 0;
1339         }
1340         $filteredforums[$forum->instance]->count += $discussion->count;
1342     }
1344     return $filteredforums;
1347 /**
1348  * Returns whether the discussion group is visible by the current user or not.
1349  *
1350  * @since Moodle 2.8, 2.7.1, 2.6.4
1351  * @param cm_info $cm The discussion course module
1352  * @param int $discussiongroupid The discussion groupid
1353  * @return bool
1354  */
1355 function forum_is_user_group_discussion(cm_info $cm, $discussiongroupid) {
1357     if ($discussiongroupid == -1 || $cm->effectivegroupmode != SEPARATEGROUPS) {
1358         return true;
1359     }
1361     if (isguestuser()) {
1362         return false;
1363     }
1365     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id)) ||
1366             in_array($discussiongroupid, $cm->get_modinfo()->get_groups($cm->groupingid))) {
1367         return true;
1368     }
1370     return false;
1373 /**
1374  * @global object
1375  * @global object
1376  * @global object
1377  * @param array $courses
1378  * @param array $htmlarray
1379  */
1380 function forum_print_overview($courses,&$htmlarray) {
1381     global $USER, $CFG, $DB, $SESSION;
1383     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1384         return array();
1385     }
1387     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1388         return;
1389     }
1391     // Courses to search for new posts
1392     $coursessqls = array();
1393     $params = array();
1394     foreach ($courses as $course) {
1396         // If the user has never entered into the course all posts are pending
1397         if ($course->lastaccess == 0) {
1398             $coursessqls[] = '(d.course = ?)';
1399             $params[] = $course->id;
1401         // Only posts created after the course last access
1402         } else {
1403             $coursessqls[] = '(d.course = ? AND p.created > ?)';
1404             $params[] = $course->id;
1405             $params[] = $course->lastaccess;
1406         }
1407     }
1408     $params[] = $USER->id;
1409     $coursessql = implode(' OR ', $coursessqls);
1411     $sql = "SELECT d.id, d.forum, d.course, d.groupid, COUNT(*) as count "
1412                 .'FROM {forum_discussions} d '
1413                 .'JOIN {forum_posts} p ON p.discussion = d.id '
1414                 ."WHERE ($coursessql) "
1415                 .'AND p.userid != ? '
1416                 .'AND (d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?)) '
1417                 .'GROUP BY d.id, d.forum, d.course, d.groupid '
1418                 .'ORDER BY d.course, d.forum';
1419     $params[] = time();
1420     $params[] = time();
1422     // Avoid warnings.
1423     if (!$discussions = $DB->get_records_sql($sql, $params)) {
1424         $discussions = array();
1425     }
1427     $forumsnewposts = forum_filter_user_groups_discussions($discussions);
1429     // also get all forum tracking stuff ONCE.
1430     $trackingforums = array();
1431     foreach ($forums as $forum) {
1432         if (forum_tp_can_track_forums($forum)) {
1433             $trackingforums[$forum->id] = $forum;
1434         }
1435     }
1437     if (count($trackingforums) > 0) {
1438         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1439         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1440             ' FROM {forum_posts} p '.
1441             ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1442             ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
1443         $params = array($USER->id);
1445         foreach ($trackingforums as $track) {
1446             $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1447             $params[] = $track->id;
1448             if (isset($SESSION->currentgroup[$track->course])) {
1449                 $groupid =  $SESSION->currentgroup[$track->course];
1450             } else {
1451                 // get first groupid
1452                 $groupids = groups_get_all_groups($track->course, $USER->id);
1453                 if ($groupids) {
1454                     reset($groupids);
1455                     $groupid = key($groupids);
1456                     $SESSION->currentgroup[$track->course] = $groupid;
1457                 } else {
1458                     $groupid = 0;
1459                 }
1460                 unset($groupids);
1461             }
1462             $params[] = $groupid;
1463         }
1464         $sql = substr($sql,0,-3); // take off the last OR
1465         $sql .= ') AND p.modified >= ? AND r.id is NULL ';
1466         $sql .= 'AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)) ';
1467         $sql .= 'GROUP BY d.forum,d.course';
1468         $params[] = $cutoffdate;
1469         $params[] = time();
1470         $params[] = time();
1472         if (!$unread = $DB->get_records_sql($sql, $params)) {
1473             $unread = array();
1474         }
1475     } else {
1476         $unread = array();
1477     }
1479     if (empty($unread) and empty($forumsnewposts)) {
1480         return;
1481     }
1483     $strforum = get_string('modulename','forum');
1485     foreach ($forums as $forum) {
1486         $str = '';
1487         $count = 0;
1488         $thisunread = 0;
1489         $showunread = false;
1490         // either we have something from logs, or trackposts, or nothing.
1491         if (array_key_exists($forum->id, $forumsnewposts) && !empty($forumsnewposts[$forum->id])) {
1492             $count = $forumsnewposts[$forum->id]->count;
1493         }
1494         if (array_key_exists($forum->id,$unread)) {
1495             $thisunread = $unread[$forum->id]->count;
1496             $showunread = true;
1497         }
1498         if ($count > 0 || $thisunread > 0) {
1499             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1500                 $forum->name.'</a></div>';
1501             $str .= '<div class="info"><span class="postsincelogin">';
1502             $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
1503             if (!empty($showunread)) {
1504                 $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
1505             }
1506             $str .= '</div></div>';
1507         }
1508         if (!empty($str)) {
1509             if (!array_key_exists($forum->course,$htmlarray)) {
1510                 $htmlarray[$forum->course] = array();
1511             }
1512             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1513                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1514             }
1515             $htmlarray[$forum->course]['forum'] .= $str;
1516         }
1517     }
1520 /**
1521  * Given a course and a date, prints a summary of all the new
1522  * messages posted in the course since that date
1523  *
1524  * @global object
1525  * @global object
1526  * @global object
1527  * @uses CONTEXT_MODULE
1528  * @uses VISIBLEGROUPS
1529  * @param object $course
1530  * @param bool $viewfullnames capability
1531  * @param int $timestart
1532  * @return bool success
1533  */
1534 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1535     global $CFG, $USER, $DB, $OUTPUT;
1537     // do not use log table if possible, it may be huge and is expensive to join with other tables
1539     $allnamefields = user_picture::fields('u', null, 'duserid');
1540     if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1541                                               d.timestart, d.timeend, $allnamefields
1542                                          FROM {forum_posts} p
1543                                               JOIN {forum_discussions} d ON d.id = p.discussion
1544                                               JOIN {forum} f             ON f.id = d.forum
1545                                               JOIN {user} u              ON u.id = p.userid
1546                                         WHERE p.created > ? AND f.course = ?
1547                                      ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
1548          return false;
1549     }
1551     $modinfo = get_fast_modinfo($course);
1553     $groupmodes = array();
1554     $cms    = array();
1556     $strftimerecent = get_string('strftimerecent');
1558     $printposts = array();
1559     foreach ($posts as $post) {
1560         if (!isset($modinfo->instances['forum'][$post->forum])) {
1561             // not visible
1562             continue;
1563         }
1564         $cm = $modinfo->instances['forum'][$post->forum];
1565         if (!$cm->uservisible) {
1566             continue;
1567         }
1568         $context = context_module::instance($cm->id);
1570         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1571             continue;
1572         }
1574         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1575           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1576             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1577                 continue;
1578             }
1579         }
1581         // Check that the user can see the discussion.
1582         if (forum_is_user_group_discussion($cm, $post->groupid)) {
1583             $printposts[] = $post;
1584         }
1586     }
1587     unset($posts);
1589     if (!$printposts) {
1590         return false;
1591     }
1593     echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
1594     echo "\n<ul class='unlist'>\n";
1596     foreach ($printposts as $post) {
1597         $subjectclass = empty($post->parent) ? ' bold' : '';
1599         echo '<li><div class="head">'.
1600                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1601                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1602              '</div>';
1603         echo '<div class="info'.$subjectclass.'">';
1604         if (empty($post->parent)) {
1605             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1606         } else {
1607             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1608         }
1609         $post->subject = break_up_long_words(format_string($post->subject, true));
1610         echo $post->subject;
1611         echo "</a>\"</div></li>\n";
1612     }
1614     echo "</ul>\n";
1616     return true;
1619 /**
1620  * Return grade for given user or all users.
1621  *
1622  * @global object
1623  * @global object
1624  * @param object $forum
1625  * @param int $userid optional user id, 0 means all users
1626  * @return array array of grades, false if none
1627  */
1628 function forum_get_user_grades($forum, $userid = 0) {
1629     global $CFG;
1631     require_once($CFG->dirroot.'/rating/lib.php');
1633     $ratingoptions = new stdClass;
1634     $ratingoptions->component = 'mod_forum';
1635     $ratingoptions->ratingarea = 'post';
1637     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1638     $ratingoptions->modulename = 'forum';
1639     $ratingoptions->moduleid   = $forum->id;
1640     $ratingoptions->userid = $userid;
1641     $ratingoptions->aggregationmethod = $forum->assessed;
1642     $ratingoptions->scaleid = $forum->scale;
1643     $ratingoptions->itemtable = 'forum_posts';
1644     $ratingoptions->itemtableusercolumn = 'userid';
1646     $rm = new rating_manager();
1647     return $rm->get_user_grades($ratingoptions);
1650 /**
1651  * Update activity grades
1652  *
1653  * @category grade
1654  * @param object $forum
1655  * @param int $userid specific user only, 0 means all
1656  * @param boolean $nullifnone return null if grade does not exist
1657  * @return void
1658  */
1659 function forum_update_grades($forum, $userid=0, $nullifnone=true) {
1660     global $CFG, $DB;
1661     require_once($CFG->libdir.'/gradelib.php');
1663     if (!$forum->assessed) {
1664         forum_grade_item_update($forum);
1666     } else if ($grades = forum_get_user_grades($forum, $userid)) {
1667         forum_grade_item_update($forum, $grades);
1669     } else if ($userid and $nullifnone) {
1670         $grade = new stdClass();
1671         $grade->userid   = $userid;
1672         $grade->rawgrade = NULL;
1673         forum_grade_item_update($forum, $grade);
1675     } else {
1676         forum_grade_item_update($forum);
1677     }
1680 /**
1681  * Create/update grade item for given forum
1682  *
1683  * @category grade
1684  * @uses GRADE_TYPE_NONE
1685  * @uses GRADE_TYPE_VALUE
1686  * @uses GRADE_TYPE_SCALE
1687  * @param stdClass $forum Forum object with extra cmidnumber
1688  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1689  * @return int 0 if ok
1690  */
1691 function forum_grade_item_update($forum, $grades=NULL) {
1692     global $CFG;
1693     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1694         require_once($CFG->libdir.'/gradelib.php');
1695     }
1697     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1699     if (!$forum->assessed or $forum->scale == 0) {
1700         $params['gradetype'] = GRADE_TYPE_NONE;
1702     } else if ($forum->scale > 0) {
1703         $params['gradetype'] = GRADE_TYPE_VALUE;
1704         $params['grademax']  = $forum->scale;
1705         $params['grademin']  = 0;
1707     } else if ($forum->scale < 0) {
1708         $params['gradetype'] = GRADE_TYPE_SCALE;
1709         $params['scaleid']   = -$forum->scale;
1710     }
1712     if ($grades  === 'reset') {
1713         $params['reset'] = true;
1714         $grades = NULL;
1715     }
1717     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1720 /**
1721  * Delete grade item for given forum
1722  *
1723  * @category grade
1724  * @param stdClass $forum Forum object
1725  * @return grade_item
1726  */
1727 function forum_grade_item_delete($forum) {
1728     global $CFG;
1729     require_once($CFG->libdir.'/gradelib.php');
1731     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1735 /**
1736  * This function returns if a scale is being used by one forum
1737  *
1738  * @global object
1739  * @param int $forumid
1740  * @param int $scaleid negative number
1741  * @return bool
1742  */
1743 function forum_scale_used ($forumid,$scaleid) {
1744     global $DB;
1745     $return = false;
1747     $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
1749     if (!empty($rec) && !empty($scaleid)) {
1750         $return = true;
1751     }
1753     return $return;
1756 /**
1757  * Checks if scale is being used by any instance of forum
1758  *
1759  * This is used to find out if scale used anywhere
1760  *
1761  * @global object
1762  * @param $scaleid int
1763  * @return boolean True if the scale is used by any forum
1764  */
1765 function forum_scale_used_anywhere($scaleid) {
1766     global $DB;
1767     if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
1768         return true;
1769     } else {
1770         return false;
1771     }
1774 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1776 /**
1777  * Gets a post with all info ready for forum_print_post
1778  * Most of these joins are just to get the forum id
1779  *
1780  * @global object
1781  * @global object
1782  * @param int $postid
1783  * @return mixed array of posts or false
1784  */
1785 function forum_get_post_full($postid) {
1786     global $CFG, $DB;
1788     $allnames = get_all_user_name_fields(true, 'u');
1789     return $DB->get_record_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
1790                              FROM {forum_posts} p
1791                                   JOIN {forum_discussions} d ON p.discussion = d.id
1792                                   LEFT JOIN {user} u ON p.userid = u.id
1793                             WHERE p.id = ?", array($postid));
1796 /**
1797  * Gets all posts in discussion including top parent.
1798  *
1799  * @global object
1800  * @global object
1801  * @global object
1802  * @param int $discussionid
1803  * @param string $sort
1804  * @param bool $tracking does user track the forum?
1805  * @return array of posts
1806  */
1807 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1808     global $CFG, $DB, $USER;
1810     $tr_sel  = "";
1811     $tr_join = "";
1812     $params = array();
1814     if ($tracking) {
1815         $now = time();
1816         $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
1817         $tr_sel  = ", fr.id AS postread";
1818         $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1819         $params[] = $USER->id;
1820     }
1822     $allnames = get_all_user_name_fields(true, 'u');
1823     $params[] = $discussionid;
1824     if (!$posts = $DB->get_records_sql("SELECT p.*, $allnames, u.email, u.picture, u.imagealt $tr_sel
1825                                      FROM {forum_posts} p
1826                                           LEFT JOIN {user} u ON p.userid = u.id
1827                                           $tr_join
1828                                     WHERE p.discussion = ?
1829                                  ORDER BY $sort", $params)) {
1830         return array();
1831     }
1833     foreach ($posts as $pid=>$p) {
1834         if ($tracking) {
1835             if (forum_tp_is_post_old($p)) {
1836                  $posts[$pid]->postread = true;
1837             }
1838         }
1839         if (!$p->parent) {
1840             continue;
1841         }
1842         if (!isset($posts[$p->parent])) {
1843             continue; // parent does not exist??
1844         }
1845         if (!isset($posts[$p->parent]->children)) {
1846             $posts[$p->parent]->children = array();
1847         }
1848         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1849     }
1851     // Start with the last child of the first post.
1852     $post = &$posts[reset($posts)->id];
1854     $lastpost = false;
1855     while (!$lastpost) {
1856         if (!isset($post->children)) {
1857             $post->lastpost = true;
1858             $lastpost = true;
1859         } else {
1860              // Go to the last child of this post.
1861             $post = &$posts[end($post->children)->id];
1862         }
1863     }
1865     return $posts;
1868 /**
1869  * An array of forum objects that the user is allowed to read/search through.
1870  *
1871  * @global object
1872  * @global object
1873  * @global object
1874  * @param int $userid
1875  * @param int $courseid if 0, we look for forums throughout the whole site.
1876  * @return array of forum objects, or false if no matches
1877  *         Forum objects have the following attributes:
1878  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1879  *         viewhiddentimedposts
1880  */
1881 function forum_get_readable_forums($userid, $courseid=0) {
1883     global $CFG, $DB, $USER;
1884     require_once($CFG->dirroot.'/course/lib.php');
1886     if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
1887         print_error('notinstalled', 'forum');
1888     }
1890     if ($courseid) {
1891         $courses = $DB->get_records('course', array('id' => $courseid));
1892     } else {
1893         // If no course is specified, then the user can see SITE + his courses.
1894         $courses1 = $DB->get_records('course', array('id' => SITEID));
1895         $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
1896         $courses = array_merge($courses1, $courses2);
1897     }
1898     if (!$courses) {
1899         return array();
1900     }
1902     $readableforums = array();
1904     foreach ($courses as $course) {
1906         $modinfo = get_fast_modinfo($course);
1908         if (empty($modinfo->instances['forum'])) {
1909             // hmm, no forums?
1910             continue;
1911         }
1913         $courseforums = $DB->get_records('forum', array('course' => $course->id));
1915         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1916             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1917                 continue;
1918             }
1919             $context = context_module::instance($cm->id);
1920             $forum = $courseforums[$forumid];
1921             $forum->context = $context;
1922             $forum->cm = $cm;
1924             if (!has_capability('mod/forum:viewdiscussion', $context)) {
1925                 continue;
1926             }
1928          /// group access
1929             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
1931                 $forum->onlygroups = $modinfo->get_groups($cm->groupingid);
1932                 $forum->onlygroups[] = -1;
1933             }
1935         /// hidden timed discussions
1936             $forum->viewhiddentimedposts = true;
1937             if (!empty($CFG->forum_enabletimedposts)) {
1938                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1939                     $forum->viewhiddentimedposts = false;
1940                 }
1941             }
1943         /// qanda access
1944             if ($forum->type == 'qanda'
1945                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
1947                 // We need to check whether the user has posted in the qanda forum.
1948                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
1949                                                     // the user is allowed to see in this forum.
1950                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1951                     foreach ($discussionspostedin as $d) {
1952                         $forum->onlydiscussions[] = $d->id;
1953                     }
1954                 }
1955             }
1957             $readableforums[$forum->id] = $forum;
1958         }
1960         unset($modinfo);
1962     } // End foreach $courses
1964     return $readableforums;
1967 /**
1968  * Returns a list of posts found using an array of search terms.
1969  *
1970  * @global object
1971  * @global object
1972  * @global object
1973  * @param array $searchterms array of search terms, e.g. word +word -word
1974  * @param int $courseid if 0, we search through the whole site
1975  * @param int $limitfrom
1976  * @param int $limitnum
1977  * @param int &$totalcount
1978  * @param string $extrasql
1979  * @return array|bool Array of posts found or false
1980  */
1981 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
1982                             &$totalcount, $extrasql='') {
1983     global $CFG, $DB, $USER;
1984     require_once($CFG->libdir.'/searchlib.php');
1986     $forums = forum_get_readable_forums($USER->id, $courseid);
1988     if (count($forums) == 0) {
1989         $totalcount = 0;
1990         return false;
1991     }
1993     $now = round(time(), -2); // db friendly
1995     $fullaccess = array();
1996     $where = array();
1997     $params = array();
1999     foreach ($forums as $forumid => $forum) {
2000         $select = array();
2002         if (!$forum->viewhiddentimedposts) {
2003             $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
2004             $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
2005         }
2007         $cm = $forum->cm;
2008         $context = $forum->context;
2010         if ($forum->type == 'qanda'
2011             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2012             if (!empty($forum->onlydiscussions)) {
2013                 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
2014                 $params = array_merge($params, $discussionid_params);
2015                 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
2016             } else {
2017                 $select[] = "p.parent = 0";
2018             }
2019         }
2021         if (!empty($forum->onlygroups)) {
2022             list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
2023             $params = array_merge($params, $groupid_params);
2024             $select[] = "d.groupid $groupid_sql";
2025         }
2027         if ($select) {
2028             $selects = implode(" AND ", $select);
2029             $where[] = "(d.forum = :forum{$forumid} AND $selects)";
2030             $params['forum'.$forumid] = $forumid;
2031         } else {
2032             $fullaccess[] = $forumid;
2033         }
2034     }
2036     if ($fullaccess) {
2037         list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
2038         $params = array_merge($params, $fullid_params);
2039         $where[] = "(d.forum $fullid_sql)";
2040     }
2042     $selectdiscussion = "(".implode(" OR ", $where).")";
2044     $messagesearch = '';
2045     $searchstring = '';
2047     // Need to concat these back together for parser to work.
2048     foreach($searchterms as $searchterm){
2049         if ($searchstring != '') {
2050             $searchstring .= ' ';
2051         }
2052         $searchstring .= $searchterm;
2053     }
2055     // We need to allow quoted strings for the search. The quotes *should* be stripped
2056     // by the parser, but this should be examined carefully for security implications.
2057     $searchstring = str_replace("\\\"","\"",$searchstring);
2058     $parser = new search_parser();
2059     $lexer = new search_lexer($parser);
2061     if ($lexer->parse($searchstring)) {
2062         $parsearray = $parser->get_parsed_array();
2063         list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2064                                                               'p.userid', 'u.id', 'u.firstname',
2065                                                               'u.lastname', 'p.modified', 'd.forum');
2066         $params = array_merge($params, $msparams);
2067     }
2069     $fromsql = "{forum_posts} p,
2070                   {forum_discussions} d,
2071                   {user} u";
2073     $selectsql = " $messagesearch
2074                AND p.discussion = d.id
2075                AND p.userid = u.id
2076                AND $selectdiscussion
2077                    $extrasql";
2079     $countsql = "SELECT COUNT(*)
2080                    FROM $fromsql
2081                   WHERE $selectsql";
2083     $allnames = get_all_user_name_fields(true, 'u');
2084     $searchsql = "SELECT p.*,
2085                          d.forum,
2086                          $allnames,
2087                          u.email,
2088                          u.picture,
2089                          u.imagealt
2090                     FROM $fromsql
2091                    WHERE $selectsql
2092                 ORDER BY p.modified DESC";
2094     $totalcount = $DB->count_records_sql($countsql, $params);
2096     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2099 /**
2100  * Returns a list of all new posts that have not been mailed yet
2101  *
2102  * @param int $starttime posts created after this time
2103  * @param int $endtime posts created before this
2104  * @param int $now used for timed discussions only
2105  * @return array
2106  */
2107 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2108     global $CFG, $DB;
2110     $params = array();
2111     $params['mailed'] = FORUM_MAILED_PENDING;
2112     $params['ptimestart'] = $starttime;
2113     $params['ptimeend'] = $endtime;
2114     $params['mailnow'] = 1;
2116     if (!empty($CFG->forum_enabletimedposts)) {
2117         if (empty($now)) {
2118             $now = time();
2119         }
2120         $selectsql = "AND (p.created >= :ptimestart OR d.timestart >= :pptimestart)";
2121         $params['pptimestart'] = $starttime;
2122         $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
2123         $params['dtimestart'] = $now;
2124         $params['dtimeend'] = $now;
2125     } else {
2126         $timedsql = "";
2127         $selectsql = "AND p.created >= :ptimestart";
2128     }
2130     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2131                                  FROM {forum_posts} p
2132                                  JOIN {forum_discussions} d ON d.id = p.discussion
2133                                  WHERE p.mailed = :mailed
2134                                  $selectsql
2135                                  AND (p.created < :ptimeend OR p.mailnow = :mailnow)
2136                                  $timedsql
2137                                  ORDER BY p.modified ASC", $params);
2140 /**
2141  * Marks posts before a certain time as being mailed already
2142  *
2143  * @global object
2144  * @global object
2145  * @param int $endtime
2146  * @param int $now Defaults to time()
2147  * @return bool
2148  */
2149 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2150     global $CFG, $DB;
2152     if (empty($now)) {
2153         $now = time();
2154     }
2156     $params = array();
2157     $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
2158     $params['now'] = $now;
2159     $params['endtime'] = $endtime;
2160     $params['mailnow'] = 1;
2161     $params['mailedpending'] = FORUM_MAILED_PENDING;
2163     if (empty($CFG->forum_enabletimedposts)) {
2164         return $DB->execute("UPDATE {forum_posts}
2165                              SET mailed = :mailedsuccess
2166                              WHERE (created < :endtime OR mailnow = :mailnow)
2167                              AND mailed = :mailedpending", $params);
2168     } else {
2169         return $DB->execute("UPDATE {forum_posts}
2170                              SET mailed = :mailedsuccess
2171                              WHERE discussion NOT IN (SELECT d.id
2172                                                       FROM {forum_discussions} d
2173                                                       WHERE d.timestart > :now)
2174                              AND (created < :endtime OR mailnow = :mailnow)
2175                              AND mailed = :mailedpending", $params);
2176     }
2179 /**
2180  * Get all the posts for a user in a forum suitable for forum_print_post
2181  *
2182  * @global object
2183  * @global object
2184  * @uses CONTEXT_MODULE
2185  * @return array
2186  */
2187 function forum_get_user_posts($forumid, $userid) {
2188     global $CFG, $DB;
2190     $timedsql = "";
2191     $params = array($forumid, $userid);
2193     if (!empty($CFG->forum_enabletimedposts)) {
2194         $cm = get_coursemodule_from_instance('forum', $forumid);
2195         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2196             $now = time();
2197             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2198             $params[] = $now;
2199             $params[] = $now;
2200         }
2201     }
2203     $allnames = get_all_user_name_fields(true, 'u');
2204     return $DB->get_records_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
2205                               FROM {forum} f
2206                                    JOIN {forum_discussions} d ON d.forum = f.id
2207                                    JOIN {forum_posts} p       ON p.discussion = d.id
2208                                    JOIN {user} u              ON u.id = p.userid
2209                              WHERE f.id = ?
2210                                    AND p.userid = ?
2211                                    $timedsql
2212                           ORDER BY p.modified ASC", $params);
2215 /**
2216  * Get all the discussions user participated in
2217  *
2218  * @global object
2219  * @global object
2220  * @uses CONTEXT_MODULE
2221  * @param int $forumid
2222  * @param int $userid
2223  * @return array Array or false
2224  */
2225 function forum_get_user_involved_discussions($forumid, $userid) {
2226     global $CFG, $DB;
2228     $timedsql = "";
2229     $params = array($forumid, $userid);
2230     if (!empty($CFG->forum_enabletimedposts)) {
2231         $cm = get_coursemodule_from_instance('forum', $forumid);
2232         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2233             $now = time();
2234             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2235             $params[] = $now;
2236             $params[] = $now;
2237         }
2238     }
2240     return $DB->get_records_sql("SELECT DISTINCT d.*
2241                               FROM {forum} f
2242                                    JOIN {forum_discussions} d ON d.forum = f.id
2243                                    JOIN {forum_posts} p       ON p.discussion = d.id
2244                              WHERE f.id = ?
2245                                    AND p.userid = ?
2246                                    $timedsql", $params);
2249 /**
2250  * Get all the posts for a user in a forum suitable for forum_print_post
2251  *
2252  * @global object
2253  * @global object
2254  * @param int $forumid
2255  * @param int $userid
2256  * @return array of counts or false
2257  */
2258 function forum_count_user_posts($forumid, $userid) {
2259     global $CFG, $DB;
2261     $timedsql = "";
2262     $params = array($forumid, $userid);
2263     if (!empty($CFG->forum_enabletimedposts)) {
2264         $cm = get_coursemodule_from_instance('forum', $forumid);
2265         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2266             $now = time();
2267             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2268             $params[] = $now;
2269             $params[] = $now;
2270         }
2271     }
2273     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2274                              FROM {forum} f
2275                                   JOIN {forum_discussions} d ON d.forum = f.id
2276                                   JOIN {forum_posts} p       ON p.discussion = d.id
2277                                   JOIN {user} u              ON u.id = p.userid
2278                             WHERE f.id = ?
2279                                   AND p.userid = ?
2280                                   $timedsql", $params);
2283 /**
2284  * Given a log entry, return the forum post details for it.
2285  *
2286  * @global object
2287  * @global object
2288  * @param object $log
2289  * @return array|null
2290  */
2291 function forum_get_post_from_log($log) {
2292     global $CFG, $DB;
2294     $allnames = get_all_user_name_fields(true, 'u');
2295     if ($log->action == "add post") {
2297         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2298                                  FROM {forum_discussions} d,
2299                                       {forum_posts} p,
2300                                       {forum} f,
2301                                       {user} u
2302                                 WHERE p.id = ?
2303                                   AND d.id = p.discussion
2304                                   AND p.userid = u.id
2305                                   AND u.deleted <> '1'
2306                                   AND f.id = d.forum", array($log->info));
2309     } else if ($log->action == "add discussion") {
2311         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2312                                  FROM {forum_discussions} d,
2313                                       {forum_posts} p,
2314                                       {forum} f,
2315                                       {user} u
2316                                 WHERE d.id = ?
2317                                   AND d.firstpost = p.id
2318                                   AND p.userid = u.id
2319                                   AND u.deleted <> '1'
2320                                   AND f.id = d.forum", array($log->info));
2321     }
2322     return NULL;
2325 /**
2326  * Given a discussion id, return the first post from the discussion
2327  *
2328  * @global object
2329  * @global object
2330  * @param int $dicsussionid
2331  * @return array
2332  */
2333 function forum_get_firstpost_from_discussion($discussionid) {
2334     global $CFG, $DB;
2336     return $DB->get_record_sql("SELECT p.*
2337                              FROM {forum_discussions} d,
2338                                   {forum_posts} p
2339                             WHERE d.id = ?
2340                               AND d.firstpost = p.id ", array($discussionid));
2343 /**
2344  * Returns an array of counts of replies to each discussion
2345  *
2346  * @global object
2347  * @global object
2348  * @param int $forumid
2349  * @param string $forumsort
2350  * @param int $limit
2351  * @param int $page
2352  * @param int $perpage
2353  * @return array
2354  */
2355 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2356     global $CFG, $DB;
2358     if ($limit > 0) {
2359         $limitfrom = 0;
2360         $limitnum  = $limit;
2361     } else if ($page != -1) {
2362         $limitfrom = $page*$perpage;
2363         $limitnum  = $perpage;
2364     } else {
2365         $limitfrom = 0;
2366         $limitnum  = 0;
2367     }
2369     if ($forumsort == "") {
2370         $orderby = "";
2371         $groupby = "";
2373     } else {
2374         $orderby = "ORDER BY $forumsort";
2375         $groupby = ", ".strtolower($forumsort);
2376         $groupby = str_replace('desc', '', $groupby);
2377         $groupby = str_replace('asc', '', $groupby);
2378     }
2380     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2381         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2382                   FROM {forum_posts} p
2383                        JOIN {forum_discussions} d ON p.discussion = d.id
2384                  WHERE p.parent > 0 AND d.forum = ?
2385               GROUP BY p.discussion";
2386         return $DB->get_records_sql($sql, array($forumid));
2388     } else {
2389         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2390                   FROM {forum_posts} p
2391                        JOIN {forum_discussions} d ON p.discussion = d.id
2392                  WHERE d.forum = ?
2393               GROUP BY p.discussion $groupby $orderby";
2394         return $DB->get_records_sql($sql, array($forumid), $limitfrom, $limitnum);
2395     }
2398 /**
2399  * @global object
2400  * @global object
2401  * @global object
2402  * @staticvar array $cache
2403  * @param object $forum
2404  * @param object $cm
2405  * @param object $course
2406  * @return mixed
2407  */
2408 function forum_count_discussions($forum, $cm, $course) {
2409     global $CFG, $DB, $USER;
2411     static $cache = array();
2413     $now = round(time(), -2); // db cache friendliness
2415     $params = array($course->id);
2417     if (!isset($cache[$course->id])) {
2418         if (!empty($CFG->forum_enabletimedposts)) {
2419             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2420             $params[] = $now;
2421             $params[] = $now;
2422         } else {
2423             $timedsql = "";
2424         }
2426         $sql = "SELECT f.id, COUNT(d.id) as dcount
2427                   FROM {forum} f
2428                        JOIN {forum_discussions} d ON d.forum = f.id
2429                  WHERE f.course = ?
2430                        $timedsql
2431               GROUP BY f.id";
2433         if ($counts = $DB->get_records_sql($sql, $params)) {
2434             foreach ($counts as $count) {
2435                 $counts[$count->id] = $count->dcount;
2436             }
2437             $cache[$course->id] = $counts;
2438         } else {
2439             $cache[$course->id] = array();
2440         }
2441     }
2443     if (empty($cache[$course->id][$forum->id])) {
2444         return 0;
2445     }
2447     $groupmode = groups_get_activity_groupmode($cm, $course);
2449     if ($groupmode != SEPARATEGROUPS) {
2450         return $cache[$course->id][$forum->id];
2451     }
2453     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
2454         return $cache[$course->id][$forum->id];
2455     }
2457     require_once($CFG->dirroot.'/course/lib.php');
2459     $modinfo = get_fast_modinfo($course);
2461     $mygroups = $modinfo->get_groups($cm->groupingid);
2463     // add all groups posts
2464     $mygroups[-1] = -1;
2466     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2467     $params[] = $forum->id;
2469     if (!empty($CFG->forum_enabletimedposts)) {
2470         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2471         $params[] = $now;
2472         $params[] = $now;
2473     } else {
2474         $timedsql = "";
2475     }
2477     $sql = "SELECT COUNT(d.id)
2478               FROM {forum_discussions} d
2479              WHERE d.groupid $mygroups_sql AND d.forum = ?
2480                    $timedsql";
2482     return $DB->get_field_sql($sql, $params);
2485 /**
2486  * Get all discussions in a forum
2487  *
2488  * @global object
2489  * @global object
2490  * @global object
2491  * @uses CONTEXT_MODULE
2492  * @uses VISIBLEGROUPS
2493  * @param object $cm
2494  * @param string $forumsort
2495  * @param bool $fullpost
2496  * @param int $unused
2497  * @param int $limit
2498  * @param bool $userlastmodified
2499  * @param int $page
2500  * @param int $perpage
2501  * @param int $groupid if groups enabled, get discussions for this group overriding the current group.
2502  *                     Use FORUM_POSTS_ALL_USER_GROUPS for all the user groups
2503  * @return array
2504  */
2505 function forum_get_discussions($cm, $forumsort="", $fullpost=true, $unused=-1, $limit=-1,
2506                                 $userlastmodified=false, $page=-1, $perpage=0, $groupid = -1) {
2507     global $CFG, $DB, $USER;
2509     $timelimit = '';
2511     $now = round(time(), -2);
2512     $params = array($cm->instance);
2514     $modcontext = context_module::instance($cm->id);
2516     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2517         return array();
2518     }
2520     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2522         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2523             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2524             $params[] = $now;
2525             $params[] = $now;
2526             if (isloggedin()) {
2527                 $timelimit .= " OR d.userid = ?";
2528                 $params[] = $USER->id;
2529             }
2530             $timelimit .= ")";
2531         }
2532     }
2534     if ($limit > 0) {
2535         $limitfrom = 0;
2536         $limitnum  = $limit;
2537     } else if ($page != -1) {
2538         $limitfrom = $page*$perpage;
2539         $limitnum  = $perpage;
2540     } else {
2541         $limitfrom = 0;
2542         $limitnum  = 0;
2543     }
2545     $groupmode    = groups_get_activity_groupmode($cm);
2547     if ($groupmode) {
2549         if (empty($modcontext)) {
2550             $modcontext = context_module::instance($cm->id);
2551         }
2553         // Special case, we received a groupid to override currentgroup.
2554         if ($groupid > 0) {
2555             $course = get_course($cm->course);
2556             if (!groups_group_visible($groupid, $course, $cm)) {
2557                 // User doesn't belong to this group, return nothing.
2558                 return array();
2559             }
2560             $currentgroup = $groupid;
2561         } else if ($groupid === -1) {
2562             $currentgroup = groups_get_activity_group($cm);
2563         } else {
2564             // Get discussions for all groups current user can see.
2565             $currentgroup = null;
2566         }
2568         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2569             if ($currentgroup) {
2570                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2571                 $params[] = $currentgroup;
2572             } else {
2573                 $groupselect = "";
2574             }
2576         } else {
2577             // Separate groups.
2579             // Get discussions for all groups current user can see.
2580             if ($currentgroup === null) {
2581                 $mygroups = array_keys(groups_get_all_groups($cm->course, $USER->id, $cm->groupingid, 'g.id'));
2582                 if (empty($mygroups)) {
2583                      $groupselect = "AND d.groupid = -1";
2584                 } else {
2585                     list($insqlgroups, $inparamsgroups) = $DB->get_in_or_equal($mygroups);
2586                     $groupselect = "AND (d.groupid = -1 OR d.groupid $insqlgroups)";
2587                     $params = array_merge($params, $inparamsgroups);
2588                 }
2589             } else if ($currentgroup) {
2590                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2591                 $params[] = $currentgroup;
2592             } else {
2593                 $groupselect = "AND d.groupid = -1";
2594             }
2595         }
2596     } else {
2597         $groupselect = "";
2598     }
2599     if (empty($forumsort)) {
2600         $forumsort = forum_get_default_sort_order();
2601     }
2602     if (empty($fullpost)) {
2603         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2604     } else {
2605         $postdata = "p.*";
2606     }
2608     if (empty($userlastmodified)) {  // We don't need to know this
2609         $umfields = "";
2610         $umtable  = "";
2611     } else {
2612         $umfields = ', ' . get_all_user_name_fields(true, 'um', null, 'um') . ', um.email AS umemail, um.picture AS umpicture,
2613                         um.imagealt AS umimagealt';
2614         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2615     }
2617     $allnames = get_all_user_name_fields(true, 'u');
2618     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend, d.pinned, $allnames,
2619                    u.email, u.picture, u.imagealt $umfields
2620               FROM {forum_discussions} d
2621                    JOIN {forum_posts} p ON p.discussion = d.id
2622                    JOIN {user} u ON p.userid = u.id
2623                    $umtable
2624              WHERE d.forum = ? AND p.parent = 0
2625                    $timelimit $groupselect
2626           ORDER BY $forumsort, d.id DESC";
2627     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2630 /**
2631  * Gets the neighbours (previous and next) of a discussion.
2632  *
2633  * The calculation is based on the timemodified when time modified or time created is identical
2634  * It will revert to using the ID to sort consistently. This is better tha skipping a discussion.
2635  *
2636  * For blog-style forums, the calculation is based on the original creation time of the
2637  * blog post.
2638  *
2639  * Please note that this does not check whether or not the discussion passed is accessible
2640  * by the user, it simply uses it as a reference to find the neighbours. On the other hand,
2641  * the returned neighbours are checked and are accessible to the current user.
2642  *
2643  * @param object $cm The CM record.
2644  * @param object $discussion The discussion record.
2645  * @param object $forum The forum instance record.
2646  * @return array That always contains the keys 'prev' and 'next'. When there is a result
2647  *               they contain the record with minimal information such as 'id' and 'name'.
2648  *               When the neighbour is not found the value is false.
2649  */
2650 function forum_get_discussion_neighbours($cm, $discussion, $forum) {
2651     global $CFG, $DB, $USER;
2653     if ($cm->instance != $discussion->forum or $discussion->forum != $forum->id or $forum->id != $cm->instance) {
2654         throw new coding_exception('Discussion is not part of the same forum.');
2655     }
2657     $neighbours = array('prev' => false, 'next' => false);
2658     $now = round(time(), -2);
2659     $params = array();
2661     $modcontext = context_module::instance($cm->id);
2662     $groupmode    = groups_get_activity_groupmode($cm);
2663     $currentgroup = groups_get_activity_group($cm);
2665     // Users must fulfill timed posts.
2666     $timelimit = '';
2667     if (!empty($CFG->forum_enabletimedposts)) {
2668         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2669             $timelimit = ' AND ((d.timestart <= :tltimestart AND (d.timeend = 0 OR d.timeend > :tltimeend))';
2670             $params['tltimestart'] = $now;
2671             $params['tltimeend'] = $now;
2672             if (isloggedin()) {
2673                 $timelimit .= ' OR d.userid = :tluserid';
2674                 $params['tluserid'] = $USER->id;
2675             }
2676             $timelimit .= ')';
2677         }
2678     }
2680     // Limiting to posts accessible according to groups.
2681     $groupselect = '';
2682     if ($groupmode) {
2683         if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $modcontext)) {
2684             if ($currentgroup) {
2685                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2686                 $params['groupid'] = $currentgroup;
2687             }
2688         } else {
2689             if ($currentgroup) {
2690                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2691                 $params['groupid'] = $currentgroup;
2692             } else {
2693                 $groupselect = 'AND d.groupid = -1';
2694             }
2695         }
2696     }
2698     $params['forumid'] = $cm->instance;
2699     $params['discid1'] = $discussion->id;
2700     $params['discid2'] = $discussion->id;
2701     $params['discid3'] = $discussion->id;
2702     $params['discid4'] = $discussion->id;
2703     $params['disctimecompare1'] = $discussion->timemodified;
2704     $params['disctimecompare2'] = $discussion->timemodified;
2705     $params['pinnedstate1'] = (int) $discussion->pinned;
2706     $params['pinnedstate2'] = (int) $discussion->pinned;
2707     $params['pinnedstate3'] = (int) $discussion->pinned;
2708     $params['pinnedstate4'] = (int) $discussion->pinned;
2710     $sql = "SELECT d.id, d.name, d.timemodified, d.groupid, d.timestart, d.timeend
2711               FROM {forum_discussions} d
2712               JOIN {forum_posts} p ON d.firstpost = p.id
2713              WHERE d.forum = :forumid
2714                AND d.id <> :discid1
2715                    $timelimit
2716                    $groupselect";
2717     $comparefield = "d.timemodified";
2718     $comparevalue = ":disctimecompare1";
2719     $comparevalue2  = ":disctimecompare2";
2720     if (!empty($CFG->forum_enabletimedposts)) {
2721         // Here we need to take into account the release time (timestart)
2722         // if one is set, of the neighbouring posts and compare it to the
2723         // timestart or timemodified of *this* post depending on if the
2724         // release date of this post is in the future or not.
2725         // This stops discussions that appear later because of the
2726         // timestart value from being buried under discussions that were
2727         // made afterwards.
2728         $comparefield = "CASE WHEN d.timemodified < d.timestart
2729                                 THEN d.timestart ELSE d.timemodified END";
2730         if ($discussion->timemodified < $discussion->timestart) {
2731             // Normally we would just use the timemodified for sorting
2732             // discussion posts. However, when timed discussions are enabled,
2733             // then posts need to be sorted base on the later of timemodified
2734             // or the release date of the post (timestart).
2735             $params['disctimecompare1'] = $discussion->timestart;
2736             $params['disctimecompare2'] = $discussion->timestart;
2737         }
2738     }
2739     $orderbydesc = forum_get_default_sort_order(true, $comparefield, 'd', false);
2740     $orderbyasc = forum_get_default_sort_order(false, $comparefield, 'd', false);
2742     if ($forum->type === 'blog') {
2743          $subselect = "SELECT pp.created
2744                    FROM {forum_discussions} dd
2745                    JOIN {forum_posts} pp ON dd.firstpost = pp.id ";
2747          $subselectwhere1 = " WHERE dd.id = :discid3";
2748          $subselectwhere2 = " WHERE dd.id = :discid4";
2750          $comparefield = "p.created";
2752          $sub1 = $subselect.$subselectwhere1;
2753          $comparevalue = "($sub1)";
2755          $sub2 = $subselect.$subselectwhere2;
2756          $comparevalue2 = "($sub2)";
2758          $orderbydesc = "d.pinned, p.created DESC";
2759          $orderbyasc = "d.pinned, p.created ASC";
2760     }
2762     $prevsql = $sql . " AND ( (($comparefield < $comparevalue) AND :pinnedstate1 = d.pinned)
2763                          OR ($comparefield = $comparevalue2 AND (d.pinned = 0 OR d.pinned = :pinnedstate4) AND d.id < :discid2)
2764                          OR (d.pinned = 0 AND d.pinned <> :pinnedstate2))
2765                    ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbydesc, d.id DESC";
2767     $nextsql = $sql . " AND ( (($comparefield > $comparevalue) AND :pinnedstate1 = d.pinned)
2768                          OR ($comparefield = $comparevalue2 AND (d.pinned = 1 OR d.pinned = :pinnedstate4) AND d.id > :discid2)
2769                          OR (d.pinned = 1 AND d.pinned <> :pinnedstate2))
2770                    ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbyasc, d.id ASC";
2772     $neighbours['prev'] = $DB->get_record_sql($prevsql, $params, IGNORE_MULTIPLE);
2773     $neighbours['next'] = $DB->get_record_sql($nextsql, $params, IGNORE_MULTIPLE);
2774     return $neighbours;
2777 /**
2778  * Get the sql to use in the ORDER BY clause for forum discussions.
2779  *
2780  * This has the ordering take timed discussion windows into account.
2781  *
2782  * @param bool $desc True for DESC, False for ASC.
2783  * @param string $compare The field in the SQL to compare to normally sort by.
2784  * @param string $prefix The prefix being used for the discussion table.
2785  * @param bool $pinned sort pinned posts to the top
2786  * @return string
2787  */
2788 function forum_get_default_sort_order($desc = true, $compare = 'd.timemodified', $prefix = 'd', $pinned = true) {
2789     global $CFG;
2791     if (!empty($prefix)) {
2792         $prefix .= '.';
2793     }
2795     $dir = $desc ? 'DESC' : 'ASC';
2797     if ($pinned == true) {
2798         $pinned = "{$prefix}pinned DESC,";
2799     } else {
2800         $pinned = '';
2801     }
2803     $sort = "{$prefix}timemodified";
2804     if (!empty($CFG->forum_enabletimedposts)) {
2805         $sort = "CASE WHEN {$compare} < {$prefix}timestart
2806                  THEN {$prefix}timestart
2807                  ELSE {$compare}
2808                  END";
2809     }
2810     return "$pinned $sort $dir";
2813 /**
2814  *
2815  * @global object
2816  * @global object
2817  * @global object
2818  * @uses CONTEXT_MODULE
2819  * @uses VISIBLEGROUPS
2820  * @param object $cm
2821  * @return array
2822  */
2823 function forum_get_discussions_unread($cm) {
2824     global $CFG, $DB, $USER;
2826     $now = round(time(), -2);
2827     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2829     $params = array();
2830     $groupmode    = groups_get_activity_groupmode($cm);
2831     $currentgroup = groups_get_activity_group($cm);
2833     if ($groupmode) {
2834         $modcontext = context_module::instance($cm->id);
2836         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2837             if ($currentgroup) {
2838                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2839                 $params['currentgroup'] = $currentgroup;
2840             } else {
2841                 $groupselect = "";
2842             }
2844         } else {
2845             //separate groups without access all
2846             if ($currentgroup) {
2847                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2848                 $params['currentgroup'] = $currentgroup;
2849             } else {
2850                 $groupselect = "AND d.groupid = -1";
2851             }
2852         }
2853     } else {
2854         $groupselect = "";
2855     }
2857     if (!empty($CFG->forum_enabletimedposts)) {
2858         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2859         $params['now1'] = $now;
2860         $params['now2'] = $now;
2861     } else {
2862         $timedsql = "";
2863     }
2865     $sql = "SELECT d.id, COUNT(p.id) AS unread
2866               FROM {forum_discussions} d
2867                    JOIN {forum_posts} p     ON p.discussion = d.id
2868                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2869              WHERE d.forum = {$cm->instance}
2870                    AND p.modified >= :cutoffdate AND r.id is NULL
2871                    $groupselect
2872                    $timedsql
2873           GROUP BY d.id";
2874     $params['cutoffdate'] = $cutoffdate;
2876     if ($unreads = $DB->get_records_sql($sql, $params)) {
2877         foreach ($unreads as $unread) {
2878             $unreads[$unread->id] = $unread->unread;
2879         }
2880         return $unreads;
2881     } else {
2882         return array();
2883     }
2886 /**
2887  * @global object
2888  * @global object
2889  * @global object
2890  * @uses CONEXT_MODULE
2891  * @uses VISIBLEGROUPS
2892  * @param object $cm
2893  * @return array
2894  */
2895 function forum_get_discussions_count($cm) {
2896     global $CFG, $DB, $USER;
2898     $now = round(time(), -2);
2899     $params = array($cm->instance);
2900     $groupmode    = groups_get_activity_groupmode($cm);
2901     $currentgroup = groups_get_activity_group($cm);
2903     if ($groupmode) {
2904         $modcontext = context_module::instance($cm->id);
2906         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2907             if ($currentgroup) {
2908                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2909                 $params[] = $currentgroup;
2910             } else {
2911                 $groupselect = "";
2912             }
2914         } else {
2915             //seprate groups without access all
2916             if ($currentgroup) {
2917                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2918                 $params[] = $currentgroup;
2919             } else {
2920                 $groupselect = "AND d.groupid = -1";
2921             }
2922         }
2923     } else {
2924         $groupselect = "";
2925     }
2927     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2929     $timelimit = "";
2931     if (!empty($CFG->forum_enabletimedposts)) {
2933         $modcontext = context_module::instance($cm->id);
2935         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2936             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2937             $params[] = $now;
2938             $params[] = $now;
2939             if (isloggedin()) {
2940                 $timelimit .= " OR d.userid = ?";
2941                 $params[] = $USER->id;
2942             }
2943             $timelimit .= ")";
2944         }
2945     }
2947     $sql = "SELECT COUNT(d.id)
2948               FROM {forum_discussions} d
2949                    JOIN {forum_posts} p ON p.discussion = d.id
2950              WHERE d.forum = ? AND p.parent = 0
2951                    $groupselect $timelimit";
2953     return $DB->get_field_sql($sql, $params);
2957 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2960 /**
2961  * @global object
2962  * @global object
2963  * @param int $courseid
2964  * @param string $type
2965  */
2966 function forum_get_course_forum($courseid, $type) {
2967 // How to set up special 1-per-course forums
2968     global $CFG, $DB, $OUTPUT, $USER;
2970     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
2971         // There should always only be ONE, but with the right combination of
2972         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2973         foreach ($forums as $forum) {
2974             return $forum;   // ie the first one
2975         }
2976     }
2978     // Doesn't exist, so create one now.
2979     $forum = new stdClass();
2980     $forum->course = $courseid;
2981     $forum->type = "$type";
2982     if (!empty($USER->htmleditor)) {
2983         $forum->introformat = $USER->htmleditor;
2984     }
2985     switch ($forum->type) {
2986         case "news":
2987             $forum->name  = get_string("namenews", "forum");
2988             $forum->intro = get_string("intronews", "forum");
2989             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2990             $forum->assessed = 0;
2991             if ($courseid == SITEID) {
2992                 $forum->name  = get_string("sitenews");
2993                 $forum->forcesubscribe = 0;
2994             }
2995             break;
2996         case "social":
2997             $forum->name  = get_string("namesocial", "forum");
2998             $forum->intro = get_string("introsocial", "forum");
2999             $forum->assessed = 0;
3000             $forum->forcesubscribe = 0;
3001             break;
3002         case "blog":
3003             $forum->name = get_string('blogforum', 'forum');
3004             $forum->intro = get_string('introblog', 'forum');
3005             $forum->assessed = 0;
3006             $forum->forcesubscribe = 0;
3007             break;
3008         default:
3009             echo $OUTPUT->notification("That forum type doesn't exist!");
3010             return false;
3011             break;
3012     }
3014     $forum->timemodified = time();
3015     $forum->id = $DB->insert_record("forum", $forum);
3017     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
3018         echo $OUTPUT->notification("Could not find forum module!!");
3019         return false;
3020     }
3021     $mod = new stdClass();
3022     $mod->course = $courseid;
3023     $mod->module = $module->id;
3024     $mod->instance = $forum->id;
3025     $mod->section = 0;
3026     include_once("$CFG->dirroot/course/lib.php");
3027     if (! $mod->coursemodule = add_course_module($mod) ) {
3028         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
3029         return false;
3030     }
3031     $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
3032     return $DB->get_record("forum", array("id" => "$forum->id"));
3035 /**
3036  * Print a forum post
3037  *
3038  * @global object
3039  * @global object
3040  * @uses FORUM_MODE_THREADED
3041  * @uses PORTFOLIO_FORMAT_PLAINHTML
3042  * @uses PORTFOLIO_FORMAT_FILE
3043  * @uses PORTFOLIO_FORMAT_RICHHTML
3044  * @uses PORTFOLIO_ADD_TEXT_LINK
3045  * @uses CONTEXT_MODULE
3046  * @param object $post The post to print.
3047  * @param object $discussion
3048  * @param object $forum
3049  * @param object $cm
3050  * @param object $course
3051  * @param boolean $ownpost Whether this post belongs to the current user.
3052  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3053  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3054  * @param string $footer Extra stuff to print after the message.
3055  * @param string $highlight Space-separated list of terms to highlight.
3056  * @param int $post_read true, false or -99. If we already know whether this user
3057  *          has read this post, pass that in, otherwise, pass in -99, and this
3058  *          function will work it out.
3059  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3060  *          the current user can't see this post, if this argument is true
3061  *          (the default) then print a dummy 'you can't see this post' post.
3062  *          If false, don't output anything at all.
3063  * @param bool|null $istracked
3064  * @return void
3065  */
3066 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3067                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3068     global $USER, $CFG, $OUTPUT;
3070     require_once($CFG->libdir . '/filelib.php');
3072     // String cache
3073     static $str;
3075     $modcontext = context_module::instance($cm->id);
3077     $post->course = $course->id;
3078     $post->forum  = $forum->id;
3079     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3080     if (!empty($CFG->enableplagiarism)) {
3081         require_once($CFG->libdir.'/plagiarismlib.php');
3082         $post->message .= plagiarism_get_links(array('userid' => $post->userid,
3083             'content' => $post->message,
3084             'cmid' => $cm->id,
3085             'course' => $post->course,
3086             'forum' => $post->forum));
3087     }
3089     // caching
3090     if (!isset($cm->cache)) {
3091         $cm->cache = new stdClass;
3092     }
3094     if (!isset($cm->cache->caps)) {
3095         $cm->cache->caps = array();
3096         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3097         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3098         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3099         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3100         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3101         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3102         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3103         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3104         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3105     }
3107     if (!isset($cm->uservisible)) {
3108         $cm->uservisible = \core_availability\info_module::is_user_visible($cm, 0, false);
3109     }
3111     if ($istracked && is_null($postisread)) {
3112         $postisread = forum_tp_is_post_read($USER->id, $post);
3113     }
3115     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
3116         $output = '';
3117         if (!$dummyifcantsee) {
3118             if ($return) {
3119                 return $output;
3120             }
3121             echo $output;
3122             return;
3123         }
3124         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3125         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix',
3126                                                        'role' => 'region',
3127                                                        'aria-label' => get_string('hiddenforumpost', 'forum')));
3128         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3129         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3130         if ($post->parent) {
3131             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3132         } else {
3133             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3134         }
3135         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class' => 'subject',
3136                                                                                            'role' => 'header')); // Subject.
3137         $output .= html_writer::tag('div', get_string('forumauthorhidden', 'forum'), array('class' => 'author',
3138                                                                                            'role' => 'header')); // Author.
3139         $output .= html_writer::end_tag('div');
3140         $output .= html_writer::end_tag('div'); // row
3141         $output .= html_writer::start_tag('div', array('class'=>'row'));
3142         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3143         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3144         $output .= html_writer::end_tag('div'); // row
3145         $output .= html_writer::end_tag('div'); // forumpost
3147         if ($return) {
3148             return $output;
3149         }
3150         echo $output;
3151         return;
3152     }
3154     if (empty($str)) {
3155         $str = new stdClass;
3156         $str->edit         = get_string('edit', 'forum');
3157         $str->delete       = get_string('delete', 'forum');
3158         $str->reply        = get_string('reply', 'forum');
3159         $str->parent       = get_string('parent', 'forum');
3160         $str->pruneheading = get_string('pruneheading', 'forum');
3161         $str->prune        = get_string('prune', 'forum');
3162         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3163         $str->markread     = get_string('markread', 'forum');
3164         $str->markunread   = get_string('markunread', 'forum');
3165     }
3167     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3169     // Build an object that represents the posting user
3170     $postuser = new stdClass;
3171     $postuserfields = explode(',', user_picture::fields());
3172     $postuser = username_load_fields_from_object($postuser, $post, null, $postuserfields);
3173     $postuser->id = $post->userid;
3174     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3175     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3177     // Prepare the groups the posting user belongs to
3178     if (isset($cm->cache->usersgroups)) {
3179         $groups = array();
3180         if (isset($cm->cache->usersgroups[$post->userid])) {
3181             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3182                 $groups[$gid] = $cm->cache->groups[$gid];
3183             }
3184         }
3185     } else {
3186         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3187     }
3189     // Prepare the attachements for the post, files then images
3190     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3192     // Determine if we need to shorten this post
3193     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3196     // Prepare an array of commands
3197     $commands = array();
3199     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3200     // Don't display the mark read / unread controls in this case.
3201     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3202         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3203         $text = $str->markunread;
3204         if (!$postisread) {
3205             $url->param('mark', 'read');
3206             $text = $str->markread;
3207         }
3208         if ($str->displaymode == FORUM_MODE_THREADED) {
3209             $url->param('parent', $post->parent);
3210         } else {
3211             $url->set_anchor('p'.$post->id);
3212         }
3213         $commands[] = array('url'=>$url, 'text'=>$text);
3214     }
3216     // Zoom in to the parent specifically
3217     if ($post->parent) {
3218         $url = new moodle_url($discussionlink);
3219         if ($str->displaymode == FORUM_MODE_THREADED) {
3220             $url->param('parent', $post->parent);
3221         } else {
3222             $url->set_anchor('p'.$post->parent);
3223         }
3224         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3225     }
3227     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3228     $age = time() - $post->created;
3229     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3230         $age = 0;
3231     }
3233     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3234         if (has_capability('moodle/course:manageactivities', $modcontext)) {
3235             // The first post in single simple is the forum description.
3236             $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
3237         }
3238     } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3239         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3240     }
3242     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3243         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3244     }
3246     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3247         // Do not allow deleting of first post in single simple type.
3248     } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3249         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3250     }
3252     if ($reply) {
3253         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
3254     }
3256     if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
3257         $p = array('postid' => $post->id);
3258         require_once($CFG->libdir.'/portfoliolib.php');
3259         $button = new portfolio_add_button();
3260         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
3261         if (empty($attachments)) {
3262             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3263         } else {
3264             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3265         }
3267         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3268         if (!empty($porfoliohtml)) {
3269             $commands[] = $porfoliohtml;
3270         }
3271     }
3272     // Finished building commands
3275     // Begin output
3277     $output  = '';
3279     if ($istracked) {
3280         if ($postisread) {
3281             $forumpostclass = ' read';
3282         } else {
3283             $forumpostclass = ' unread';
3284             $output .= html_writer::tag('a', '', array('name'=>'unread'));
3285         }
3286     } else {
3287         // ignore trackign status if not tracked or tracked param missing
3288         $forumpostclass = '';
3289     }
3291     $topicclass = '';
3292     if (empty($post->parent)) {
3293         $topicclass = ' firstpost starter';
3294     }
3296     if (!empty($post->lastpost)) {
3297         $forumpostclass .= ' lastpost';
3298     }
3300     $postbyuser = new stdClass;
3301     $postbyuser->post = $post->subject;
3302     $postbyuser->user = $postuser->fullname;
3303     $discussionbyuser = get_string('postbyuser', 'forum', $postbyuser);
3304     $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3305     $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass,
3306                                                    'role' => 'region',
3307                                                    'aria-label' => $discussionbyuser));
3308     $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
3309     $output .= html_writer::start_tag('div', array('class'=>'left picture'));
3310     $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
3311     $output .= html_writer::end_tag('div');
3314     $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
3316     $postsubject = $post->subject;
3317     if (empty($post->subjectnoformat)) {
3318         $postsubject = format_string($postsubject);
3319     }
3320     $output .= html_writer::tag('div', $postsubject, array('class'=>'subject',
3321                                                            'role' => 'heading',
3322                                                            'aria-level' => '2'));
3324     $by = new stdClass();
3325     $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
3326     $by->date = userdate($post->modified);
3327     $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author',
3328                                                                                        'role' => 'heading',
3329                                                                                        'aria-level' => '2'));
3331     $output .= html_writer::end_tag('div'); //topic
3332     $output .= html_writer::end_tag('div'); //row
3334     $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
3335     $output .= html_writer::start_tag('div', array('class'=>'left'));
3337     $groupoutput = '';
3338     if ($groups) {
3339         $groupoutput = print_group_picture($groups, $course->id, false, true, true);
3340     }
3341     if (empty($groupoutput)) {
3342         $groupoutput = '&nbsp;';
3343     }
3344     $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
3346     $output .= html_writer::end_tag('div'); //left side
3347     $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
3348     $output .= html_writer::start_tag('div', array('class'=>'content'));
3350     $options = new stdClass;
3351     $options->para    = false;
3352     $options->trusted = $post->messagetrust;
3353     $options->context = $modcontext;
3354     if ($shortenpost) {
3355         // Prepare shortened version by filtering the text then shortening it.
3356         $postclass    = 'shortenedpost';
3357         $postcontent  = format_text($post->message, $post->messageformat, $options);
3358         $postcontent  = shorten_text($postcontent, $CFG->forum_shortpost);
3359         $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
3360         $postcontent .= html_writer::tag('div', '('.get_string('numwords', 'moodle', count_words($post->message)).')',
3361             array('class'=>'post-word-count'));
3362     } else {
3363         // Prepare whole post
3364         $postclass    = 'fullpost';
3365         $postcontent  = format_text($post->message, $post->messageformat, $options, $course->id);
3366         if (!empty($highlight)) {
3367             $postcontent = highlight($highlight, $postcontent);
3368         }
3369         if (!empty($forum->displaywordcount)) {
3370             $postcontent .= html_writer::tag('div', get_string('numwords', 'moodle', count_words($post->message)),
3371                 array('class'=>'post-word-count'));
3372         }
3373         $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
3374     }
3376     // Output the post content
3377     $output .= html_writer::tag('div', $postcontent, array('class'=>'posting '.$postclass));
3378     $output .= html_writer::end_tag('div'); // Content
3379     $output .= html_writer::end_tag('div'); // Content mask
3380     $output .= html_writer::end_tag('div'); // Row
3382     $output .= html_writer::start_tag('div', array('class'=>'row side'));
3383     $output .= html_writer::tag('div','&nbsp;', array('class'=>'left'));
3384     $output .= html_writer::start_tag('div', array('class'=>'options clearfix'));
3386     if (!empty($attachments)) {
3387         $output .= html_writer::tag('div', $attachments, array('class' => 'attachments'));
3388     }
3390     // Output ratings
3391     if (!empty($post->rating)) {
3392         $output .= html_writer::tag('div', $OUTPUT->render($post->rating), array('class'=>'forum-post-rating'));
3393     }
3395     // Output the commands
3396     $commandhtml = array();
3397     foreach ($commands as $command) {
3398         if (is_array($command)) {
3399             $commandhtml[] = html_writer::link($command['url'], $command['text']);
3400         } else {
3401             $commandhtml[] = $command;
3402         }
3403     }
3404     $output .= html_writer::tag('div', implode(' | ', $commandhtml), array('class'=>'commands'));
3406     // Output link to post if required
3407     if ($link && forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext)) {
3408         if ($post->replies == 1) {
3409             $replystring = get_string('repliesone', 'forum', $post->replies);
3410         } else {
3411             $replystring = get_string('repliesmany', 'forum', $post->replies);
3412         }
3413         if (!empty($discussion->unread) && $discussion->unread !== '-') {
3414             $replystring .= ' <span class="sep">/</span> <span class="unread">';
3415             if ($discussion->unread == 1) {
3416                 $replystring .= get_string('unreadpostsone', 'forum');
3417             } else {
3418                 $replystring .= get_string('unreadpostsnumber', 'forum', $discussion->unread);
3419             }
3420             $replystring .= '</span>';
3421         }
3423         $output .= html_writer::start_tag('div', array('class'=>'link'));
3424         $output .= html_writer::link($discussionlink, get_string('discussthistopic', 'forum'));
3425         $output .= '&nbsp;('.$replystring.')';
3426         $output .= html_writer::end_tag('div'); // link
3427     }
3429     // Output footer if required
3430     if ($footer) {
3431         $output .= html_writer::tag('div', $footer, array('class'=>'footer'));
3432     }
3434     // Close remaining open divs
3435     $output .= html_writer::end_tag('div'); // content
3436     $output .= html_writer::end_tag('div'); // row
3437     $output .= html_writer::end_tag('div'); // forumpost