MDL-41851 mod_forum: Use noreply user when sending forum notifications
[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 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
69 /**
70  * Given an object containing all the necessary data,
71  * (defined by the form in mod_form.php) this function
72  * will create a new instance and return the id number
73  * of the new instance.
74  *
75  * @param stdClass $forum add forum instance
76  * @param mod_forum_mod_form $mform
77  * @return int intance id
78  */
79 function forum_add_instance($forum, $mform = null) {
80     global $CFG, $DB;
82     $forum->timemodified = time();
84     if (empty($forum->assessed)) {
85         $forum->assessed = 0;
86     }
88     if (empty($forum->ratingtime) or empty($forum->assessed)) {
89         $forum->assesstimestart  = 0;
90         $forum->assesstimefinish = 0;
91     }
93     $forum->id = $DB->insert_record('forum', $forum);
94     $modcontext = context_module::instance($forum->coursemodule);
96     if ($forum->type == 'single') {  // Create related discussion.
97         $discussion = new stdClass();
98         $discussion->course        = $forum->course;
99         $discussion->forum         = $forum->id;
100         $discussion->name          = $forum->name;
101         $discussion->assessed      = $forum->assessed;
102         $discussion->message       = $forum->intro;
103         $discussion->messageformat = $forum->introformat;
104         $discussion->messagetrust  = trusttext_trusted(context_course::instance($forum->course));
105         $discussion->mailnow       = false;
106         $discussion->groupid       = -1;
108         $message = '';
110         $discussion->id = forum_add_discussion($discussion, null, $message);
112         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
113             // Ugly hack - we need to copy the files somehow.
114             $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
115             $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
117             $options = array('subdirs'=>true); // Use the same options as intro field!
118             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
119             $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
120         }
121     }
123     forum_grade_item_update($forum);
125     return $forum->id;
128 /**
129  * Handle changes following the creation of a forum instance.
130  * This function is typically called by the course_module_created observer.
131  *
132  * @param object $context the forum context
133  * @param stdClass $forum The forum object
134  * @return void
135  */
136 function forum_instance_created($context, $forum) {
137     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
138         $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email');
139         foreach ($users as $user) {
140             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context);
141         }
142     }
145 /**
146  * Given an object containing all the necessary data,
147  * (defined by the form in mod_form.php) this function
148  * will update an existing instance with new data.
149  *
150  * @global object
151  * @param object $forum forum instance (with magic quotes)
152  * @return bool success
153  */
154 function forum_update_instance($forum, $mform) {
155     global $DB, $OUTPUT, $USER;
157     $forum->timemodified = time();
158     $forum->id           = $forum->instance;
160     if (empty($forum->assessed)) {
161         $forum->assessed = 0;
162     }
164     if (empty($forum->ratingtime) or empty($forum->assessed)) {
165         $forum->assesstimestart  = 0;
166         $forum->assesstimefinish = 0;
167     }
169     $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
171     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
172     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
173     // 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
174     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
175         forum_update_grades($forum); // recalculate grades for the forum
176     }
178     if ($forum->type == 'single') {  // Update related discussion and post.
179         $discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC');
180         if (!empty($discussions)) {
181             if (count($discussions) > 1) {
182                 echo $OUTPUT->notification(get_string('warnformorepost', 'forum'));
183             }
184             $discussion = array_pop($discussions);
185         } else {
186             // try to recover by creating initial discussion - MDL-16262
187             $discussion = new stdClass();
188             $discussion->course          = $forum->course;
189             $discussion->forum           = $forum->id;
190             $discussion->name            = $forum->name;
191             $discussion->assessed        = $forum->assessed;
192             $discussion->message         = $forum->intro;
193             $discussion->messageformat   = $forum->introformat;
194             $discussion->messagetrust    = true;
195             $discussion->mailnow         = false;
196             $discussion->groupid         = -1;
198             $message = '';
200             forum_add_discussion($discussion, null, $message);
202             if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
203                 print_error('cannotadd', 'forum');
204             }
205         }
206         if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
207             print_error('cannotfindfirstpost', 'forum');
208         }
210         $cm         = get_coursemodule_from_instance('forum', $forum->id);
211         $modcontext = context_module::instance($cm->id, MUST_EXIST);
213         $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
214         $post->subject       = $forum->name;
215         $post->message       = $forum->intro;
216         $post->messageformat = $forum->introformat;
217         $post->messagetrust  = trusttext_trusted($modcontext);
218         $post->modified      = $forum->timemodified;
219         $post->userid        = $USER->id;    // MDL-18599, so that current teacher can take ownership of activities.
221         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
222             // Ugly hack - we need to copy the files somehow.
223             $options = array('subdirs'=>true); // Use the same options as intro field!
224             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
225         }
227         $DB->update_record('forum_posts', $post);
228         $discussion->name = $forum->name;
229         $DB->update_record('forum_discussions', $discussion);
230     }
232     $DB->update_record('forum', $forum);
234     $modcontext = context_module::instance($forum->coursemodule);
235     if (($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) && ($oldforum->forcesubscribe <> $forum->forcesubscribe)) {
236         $users = \mod_forum\subscriptions::get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
237         foreach ($users as $user) {
238             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $modcontext);
239         }
240     }
242     forum_grade_item_update($forum);
244     return true;
248 /**
249  * Given an ID of an instance of this module,
250  * this function will permanently delete the instance
251  * and any data that depends on it.
252  *
253  * @global object
254  * @param int $id forum instance id
255  * @return bool success
256  */
257 function forum_delete_instance($id) {
258     global $DB;
260     if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
261         return false;
262     }
263     if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
264         return false;
265     }
266     if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
267         return false;
268     }
270     $context = context_module::instance($cm->id);
272     // now get rid of all files
273     $fs = get_file_storage();
274     $fs->delete_area_files($context->id);
276     $result = true;
278     // Delete digest and subscription preferences.
279     $DB->delete_records('forum_digests', array('forum' => $forum->id));
280     $DB->delete_records('forum_subscriptions', array('forum'=>$forum->id));
281     $DB->delete_records('forum_discussion_subs', array('forum' => $forum->id));
283     if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
284         foreach ($discussions as $discussion) {
285             if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
286                 $result = false;
287             }
288         }
289     }
291     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
293     if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
294         $result = false;
295     }
297     forum_grade_item_delete($forum);
299     return $result;
303 /**
304  * Indicates API features that the forum supports.
305  *
306  * @uses FEATURE_GROUPS
307  * @uses FEATURE_GROUPINGS
308  * @uses FEATURE_MOD_INTRO
309  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
310  * @uses FEATURE_COMPLETION_HAS_RULES
311  * @uses FEATURE_GRADE_HAS_GRADE
312  * @uses FEATURE_GRADE_OUTCOMES
313  * @param string $feature
314  * @return mixed True if yes (some features may use other values)
315  */
316 function forum_supports($feature) {
317     switch($feature) {
318         case FEATURE_GROUPS:                  return true;
319         case FEATURE_GROUPINGS:               return true;
320         case FEATURE_MOD_INTRO:               return true;
321         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
322         case FEATURE_COMPLETION_HAS_RULES:    return true;
323         case FEATURE_GRADE_HAS_GRADE:         return true;
324         case FEATURE_GRADE_OUTCOMES:          return true;
325         case FEATURE_RATE:                    return true;
326         case FEATURE_BACKUP_MOODLE2:          return true;
327         case FEATURE_SHOW_DESCRIPTION:        return true;
328         case FEATURE_PLAGIARISM:              return true;
330         default: return null;
331     }
335 /**
336  * Obtains the automatic completion state for this forum based on any conditions
337  * in forum settings.
338  *
339  * @global object
340  * @global object
341  * @param object $course Course
342  * @param object $cm Course-module
343  * @param int $userid User ID
344  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
345  * @return bool True if completed, false if not. (If no conditions, then return
346  *   value depends on comparison type)
347  */
348 function forum_get_completion_state($course,$cm,$userid,$type) {
349     global $CFG,$DB;
351     // Get forum details
352     if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
353         throw new Exception("Can't find forum {$cm->instance}");
354     }
356     $result=$type; // Default return value
358     $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
359     $postcountsql="
360 SELECT
361     COUNT(1)
362 FROM
363     {forum_posts} fp
364     INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
365 WHERE
366     fp.userid=:userid AND fd.forum=:forumid";
368     if ($forum->completiondiscussions) {
369         $value = $forum->completiondiscussions <=
370                  $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
371         if ($type == COMPLETION_AND) {
372             $result = $result && $value;
373         } else {
374             $result = $result || $value;
375         }
376     }
377     if ($forum->completionreplies) {
378         $value = $forum->completionreplies <=
379                  $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
380         if ($type==COMPLETION_AND) {
381             $result = $result && $value;
382         } else {
383             $result = $result || $value;
384         }
385     }
386     if ($forum->completionposts) {
387         $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
388         if ($type == COMPLETION_AND) {
389             $result = $result && $value;
390         } else {
391             $result = $result || $value;
392         }
393     }
395     return $result;
398 /**
399  * Create a message-id string to use in the custom headers of forum notification emails
400  *
401  * message-id is used by email clients to identify emails and to nest conversations
402  *
403  * @param int $postid The ID of the forum post we are notifying the user about
404  * @param int $usertoid The ID of the user being notified
405  * @param string $hostname The server's hostname
406  * @return string A unique message-id
407  */
408 function forum_get_email_message_id($postid, $usertoid, $hostname) {
409     return '<'.hash('sha256',$postid.'to'.$usertoid).'@'.$hostname.'>';
412 /**
413  * Removes properties from user record that are not necessary
414  * for sending post notifications.
415  * @param stdClass $user
416  * @return void, $user parameter is modified
417  */
418 function forum_cron_minimise_user_record(stdClass $user) {
420     // We store large amount of users in one huge array,
421     // make sure we do not store info there we do not actually need
422     // in mail generation code or messaging.
424     unset($user->institution);
425     unset($user->department);
426     unset($user->address);
427     unset($user->city);
428     unset($user->url);
429     unset($user->currentlogin);
430     unset($user->description);
431     unset($user->descriptionformat);
434 /**
435  * Function to be run periodically according to the scheduled task.
436  *
437  * Finds all posts that have yet to be mailed out, and mails them
438  * out to all subscribers as well as other maintance tasks.
439  *
440  * NOTE: Since 2.7.2 this function is run by scheduled task rather
441  * than standard cron.
442  *
443  * @todo MDL-44734 The function will be split up into seperate tasks.
444  */
445 function forum_cron() {
446     global $CFG, $USER, $DB;
448     $site = get_site();
450     // All users that are subscribed to any post that needs sending,
451     // please increase $CFG->extramemorylimit on large sites that
452     // send notifications to a large number of users.
453     $users = array();
454     $userscount = 0; // Cached user counter - count($users) in PHP is horribly slow!!!
456     // Status arrays.
457     $mailcount  = array();
458     $errorcount = array();
460     // caches
461     $discussions        = array();
462     $forums             = array();
463     $courses            = array();
464     $coursemodules      = array();
465     $subscribedusers    = array();
466     $messageinboundhandlers = array();
468     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
469     // cron has not been running for a long time, and then suddenly people are flooded
470     // with mail from the past few weeks or months
471     $timenow   = time();
472     $endtime   = $timenow - $CFG->maxeditingtime;
473     $starttime = $endtime - 48 * 3600;   // Two days earlier
475     // Get the list of forum subscriptions for per-user per-forum maildigest settings.
476     $digestsset = $DB->get_recordset('forum_digests', null, '', 'id, userid, forum, maildigest');
477     $digests = array();
478     foreach ($digestsset as $thisrow) {
479         if (!isset($digests[$thisrow->forum])) {
480             $digests[$thisrow->forum] = array();
481         }
482         $digests[$thisrow->forum][$thisrow->userid] = $thisrow->maildigest;
483     }
484     $digestsset->close();
486     // Create the generic messageinboundgenerator.
487     $messageinboundgenerator = new \core\message\inbound\address_manager();
488     $messageinboundgenerator->set_handler('\mod_forum\message\inbound\reply_handler');
490     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
491         // Mark them all now as being mailed.  It's unlikely but possible there
492         // might be an error later so that a post is NOT actually mailed out,
493         // but since mail isn't crucial, we can accept this risk.  Doing it now
494         // prevents the risk of duplicated mails, which is a worse problem.
496         if (!forum_mark_old_posts_as_mailed($endtime)) {
497             mtrace('Errors occurred while trying to mark some posts as being mailed.');
498             return false;  // Don't continue trying to mail them, in case we are in a cron loop
499         }
501         // checking post validity, and adding users to loop through later
502         foreach ($posts as $pid => $post) {
504             $discussionid = $post->discussion;
505             if (!isset($discussions[$discussionid])) {
506                 if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
507                     $discussions[$discussionid] = $discussion;
508                     \mod_forum\subscriptions::fill_subscription_cache($discussion->forum);
509                     \mod_forum\subscriptions::fill_discussion_subscription_cache($discussion->forum);
511                 } else {
512                     mtrace('Could not find discussion ' . $discussionid);
513                     unset($posts[$pid]);
514                     continue;
515                 }
516             }
517             $forumid = $discussions[$discussionid]->forum;
518             if (!isset($forums[$forumid])) {
519                 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
520                     $forums[$forumid] = $forum;
521                 } else {
522                     mtrace('Could not find forum '.$forumid);
523                     unset($posts[$pid]);
524                     continue;
525                 }
526             }
527             $courseid = $forums[$forumid]->course;
528             if (!isset($courses[$courseid])) {
529                 if ($course = $DB->get_record('course', array('id' => $courseid))) {
530                     $courses[$courseid] = $course;
531                 } else {
532                     mtrace('Could not find course '.$courseid);
533                     unset($posts[$pid]);
534                     continue;
535                 }
536             }
537             if (!isset($coursemodules[$forumid])) {
538                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
539                     $coursemodules[$forumid] = $cm;
540                 } else {
541                     mtrace('Could not find course module for forum '.$forumid);
542                     unset($posts[$pid]);
543                     continue;
544                 }
545             }
547             // Save the Inbound Message datakey here to reduce DB queries later.
548             $messageinboundgenerator->set_data($pid);
549             $messageinboundhandlers[$pid] = $messageinboundgenerator->fetch_data_key();
551             // Caching subscribed users of each forum.
552             if (!isset($subscribedusers[$forumid])) {
553                 $modcontext = context_module::instance($coursemodules[$forumid]->id);
554                 if ($subusers = \mod_forum\subscriptions::fetch_subscribed_users($forums[$forumid], 0, $modcontext, 'u.*', true)) {
556                     foreach ($subusers as $postuser) {
557                         // this user is subscribed to this forum
558                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
559                         $userscount++;
560                         if ($userscount > FORUM_CRON_USER_CACHE) {
561                             // Store minimal user info.
562                             $minuser = new stdClass();
563                             $minuser->id = $postuser->id;
564                             $users[$postuser->id] = $minuser;
565                         } else {
566                             // Cache full user record.
567                             forum_cron_minimise_user_record($postuser);
568                             $users[$postuser->id] = $postuser;
569                         }
570                     }
571                     // Release memory.
572                     unset($subusers);
573                     unset($postuser);
574                 }
575             }
576             $mailcount[$pid] = 0;
577             $errorcount[$pid] = 0;
578         }
579     }
581     if ($users && $posts) {
583         $urlinfo = parse_url($CFG->wwwroot);
584         $hostname = $urlinfo['host'];
586         foreach ($users as $userto) {
587             // Terminate if processing of any account takes longer than 2 minutes.
588             core_php_time_limit::raise(120);
590             mtrace('Processing user ' . $userto->id);
592             // Init user caches - we keep the cache for one cycle only, otherwise it could consume too much memory.
593             if (isset($userto->username)) {
594                 $userto = clone($userto);
595             } else {
596                 $userto = $DB->get_record('user', array('id' => $userto->id));
597                 forum_cron_minimise_user_record($userto);
598             }
599             $userto->viewfullnames = array();
600             $userto->canpost       = array();
601             $userto->markposts     = array();
603             // Setup this user so that the capabilities are cached, and environment matches receiving user.
604             cron_setup_user($userto);
606             // Reset the caches.
607             foreach ($coursemodules as $forumid => $unused) {
608                 $coursemodules[$forumid]->cache       = new stdClass();
609                 $coursemodules[$forumid]->cache->caps = array();
610                 unset($coursemodules[$forumid]->uservisible);
611             }
613             foreach ($posts as $pid => $post) {
614                 $discussion = $discussions[$post->discussion];
615                 $forum      = $forums[$discussion->forum];
616                 $course     = $courses[$forum->course];
617                 $cm         =& $coursemodules[$forum->id];
619                 // Do some checks to see if we can bail out now.
621                 // Only active enrolled users are in the list of subscribers.
622                 // This does not necessarily mean that the user is subscribed to the forum or to the discussion though.
623                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
624                     // The user does not subscribe to this forum.
625                     continue;
626                 }
628                 if (!\mod_forum\subscriptions::is_subscribed($userto->id, $forum, $post->discussion, $coursemodules[$forum->id])) {
629                     // The user does not subscribe to this forum, or to this specific discussion.
630                     continue;
631                 }
633                 if ($subscriptiontime = \mod_forum\subscriptions::fetch_discussion_subscription($forum->id, $userto->id)) {
634                     // Skip posts if the user subscribed to the discussion after it was created.
635                     if (isset($subscriptiontime[$post->discussion]) && ($subscriptiontime[$post->discussion] > $post->created)) {
636                         continue;
637                     }
638                 }
640                 // Don't send email if the forum is Q&A and the user has not posted.
641                 // Initial topics are still mailed.
642                 if ($forum->type == 'qanda' && !forum_get_user_posted_time($discussion->id, $userto->id) && $pid != $discussion->firstpost) {
643                     mtrace('Did not email ' . $userto->id.' because user has not posted in discussion');
644                     continue;
645                 }
647                 // Get info about the sending user.
648                 if (array_key_exists($post->userid, $users)) {
649                     // We might know the user already.
650                     $userfrom = $users[$post->userid];
651                     if (!isset($userfrom->idnumber)) {
652                         // Minimalised user info, fetch full record.
653                         $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
654                         forum_cron_minimise_user_record($userfrom);
655                     }
657                 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
658                     forum_cron_minimise_user_record($userfrom);
659                     // Fetch only once if possible, we can add it to user list, it will be skipped anyway.
660                     if ($userscount <= FORUM_CRON_USER_CACHE) {
661                         $userscount++;
662                         $users[$userfrom->id] = $userfrom;
663                     }
664                 } else {
665                     mtrace('Could not find user ' . $post->userid . ', author of post ' . $post->id . '. Unable to send message.');
666                     continue;
667                 }
669                 // Note: If we want to check that userto and userfrom are not the same person this is probably the spot to do it.
671                 // Setup global $COURSE properly - needed for roles and languages.
672                 cron_setup_user($userto, $course);
674                 // Fill caches.
675                 if (!isset($userto->viewfullnames[$forum->id])) {
676                     $modcontext = context_module::instance($cm->id);
677                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
678                 }
679                 if (!isset($userto->canpost[$discussion->id])) {
680                     $modcontext = context_module::instance($cm->id);
681                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
682                 }
683                 if (!isset($userfrom->groups[$forum->id])) {
684                     if (!isset($userfrom->groups)) {
685                         $userfrom->groups = array();
686                         if (isset($users[$userfrom->id])) {
687                             $users[$userfrom->id]->groups = array();
688                         }
689                     }
690                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
691                     if (isset($users[$userfrom->id])) {
692                         $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
693                     }
694                 }
696                 // Make sure groups allow this user to see this email.
697                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {
698                     // Groups are being used.
699                     if (!groups_group_exists($discussion->groupid)) {
700                         // Can't find group - be safe and don't this message.
701                         continue;
702                     }
704                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
705                         // Do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS.
706                         continue;
707                     }
708                 }
710                 // Make sure we're allowed to see the post.
711                 if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
712                     mtrace('User ' . $userto->id .' can not see ' . $post->id . '. Not sending message.');
713                     continue;
714                 }
716                 // OK so we need to send the email.
718                 // Does the user want this post in a digest?  If so postpone it for now.
719                 $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
721                 if ($maildigest > 0) {
722                     // This user wants the mails to be in digest form.
723                     $queue = new stdClass();
724                     $queue->userid       = $userto->id;
725                     $queue->discussionid = $discussion->id;
726                     $queue->postid       = $post->id;
727                     $queue->timemodified = $post->created;
728                     $DB->insert_record('forum_queue', $queue);
729                     continue;
730                 }
732                 // Prepare to actually send the post now, and build up the content.
734                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
736                 $userfrom->customheaders = array (
737                     // Headers to make emails easier to track.
738                     'List-Id: "'        . $cleanforumname . '" <moodleforum' . $forum->id . '@' . $hostname.'>',
739                     'List-Help: '       . $CFG->wwwroot . '/mod/forum/view.php?f=' . $forum->id,
740                     'Message-ID: '      . forum_get_email_message_id($post->id, $userto->id, $hostname),
741                     'X-Course-Id: '     . $course->id,
742                     'X-Course-Name: '   . format_string($course->fullname, true),
744                     // Headers to help prevent auto-responders.
745                     'Precedence: Bulk',
746                     'X-Auto-Response-Suppress: All',
747                     'Auto-Submitted: auto-generated',
748                 );
750                 if ($post->parent) {
751                     // This post is a reply, so add headers for threading (see MDL-22551).
752                     $userfrom->customheaders[] = 'In-Reply-To: ' . forum_get_email_message_id($post->parent, $userto->id, $hostname);
753                     $userfrom->customheaders[] = 'References: '  . forum_get_email_message_id($post->parent, $userto->id, $hostname);
754                 }
756                 $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
758                 // Generate a reply-to address from using the Inbound Message handler.
759                 $replyaddress = null;
760                 if ($userto->canpost[$discussion->id] && array_key_exists($post->id, $messageinboundhandlers)) {
761                     $messageinboundgenerator->set_data($post->id, $messageinboundhandlers[$post->id]);
762                     $replyaddress = $messageinboundgenerator->generate($userto->id);
763                 }
765                 $a = new stdClass();
766                 $a->courseshortname = $shortname;
767                 $a->forumname = $cleanforumname;
768                 $a->subject = format_string($post->subject, true);
769                 $postsubject = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
770                 $posttext = forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false,
771                         $replyaddress);
772                 $posthtml = forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
773                         $replyaddress);
775                 // Send the post now!
776                 mtrace('Sending ', '');
778                 $eventdata = new stdClass();
779                 $eventdata->component           = 'mod_forum';
780                 $eventdata->name                = 'posts';
781                 $eventdata->userfrom            = $userfrom;
782                 $eventdata->userto              = $userto;
783                 $eventdata->subject             = $postsubject;
784                 $eventdata->fullmessage         = $posttext;
785                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
786                 $eventdata->fullmessagehtml     = $posthtml;
787                 $eventdata->notification        = 1;
788                 $eventdata->replyto             = $replyaddress;
790                 // If forum_replytouser is not set then send mail using the noreplyaddress.
791                 if (empty($CFG->forum_replytouser)) {
792                     $eventdata->userfrom = core_user::get_noreply_user();
793                 }
795                 $smallmessagestrings = new stdClass();
796                 $smallmessagestrings->user          = fullname($userfrom);
797                 $smallmessagestrings->forumname     = "$shortname: " . format_string($forum->name, true) . ": " . $discussion->name;
798                 $smallmessagestrings->message       = $post->message;
800                 // Make sure strings are in message recipients language.
801                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
803                 $contexturl = new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id), 'p' . $post->id);
804                 $eventdata->contexturl = $contexturl->out();
805                 $eventdata->contexturlname = $discussion->name;
807                 $mailresult = message_send($eventdata);
808                 if (!$mailresult) {
809                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
810                             " ($userto->email) .. not trying again.");
811                     $errorcount[$post->id]++;
812                 } else {
813                     $mailcount[$post->id]++;
815                     // Mark post as read if forum_usermarksread is set off.
816                     if (!$CFG->forum_usermarksread) {
817                         $userto->markposts[$post->id] = $post->id;
818                     }
819                 }
821                 mtrace('post ' . $post->id . ': ' . $post->subject);
822             }
824             // Mark processed posts as read.
825             forum_tp_mark_posts_read($userto, $userto->markposts);
826             unset($userto);
827         }
828     }
830     if ($posts) {
831         foreach ($posts as $post) {
832             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
833             if ($errorcount[$post->id]) {
834                 $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
835             }
836         }
837     }
839     // release some memory
840     unset($subscribedusers);
841     unset($mailcount);
842     unset($errorcount);
844     cron_setup_user();
846     $sitetimezone = $CFG->timezone;
848     // Now see if there are any digest mails waiting to be sent, and if we should send them
850     mtrace('Starting digest processing...');
852     core_php_time_limit::raise(300); // terminate if not able to fetch all digests in 5 minutes
854     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
855         set_config('digestmailtimelast', 0);
856     }
858     $timenow = time();
859     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
861     // Delete any really old ones (normally there shouldn't be any)
862     $weekago = $timenow - (7 * 24 * 3600);
863     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
864     mtrace ('Cleaned old digest records');
866     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
868         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
870         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
872         if ($digestposts_rs->valid()) {
874             // We have work to do
875             $usermailcount = 0;
877             //caches - reuse the those filled before too
878             $discussionposts = array();
879             $userdiscussions = array();
881             foreach ($digestposts_rs as $digestpost) {
882                 if (!isset($posts[$digestpost->postid])) {
883                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
884                         $posts[$digestpost->postid] = $post;
885                     } else {
886                         continue;
887                     }
888                 }
889                 $discussionid = $digestpost->discussionid;
890                 if (!isset($discussions[$discussionid])) {
891                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
892                         $discussions[$discussionid] = $discussion;
893                     } else {
894                         continue;
895                     }
896                 }
897                 $forumid = $discussions[$discussionid]->forum;
898                 if (!isset($forums[$forumid])) {
899                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
900                         $forums[$forumid] = $forum;
901                     } else {
902                         continue;
903                     }
904                 }
906                 $courseid = $forums[$forumid]->course;
907                 if (!isset($courses[$courseid])) {
908                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
909                         $courses[$courseid] = $course;
910                     } else {
911                         continue;
912                     }
913                 }
915                 if (!isset($coursemodules[$forumid])) {
916                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
917                         $coursemodules[$forumid] = $cm;
918                     } else {
919                         continue;
920                     }
921                 }
922                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
923                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
924             }
925             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
927             // Data collected, start sending out emails to each user
928             foreach ($userdiscussions as $userid => $thesediscussions) {
930                 core_php_time_limit::raise(120); // terminate if processing of any account takes longer than 2 minutes
932                 cron_setup_user();
934                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
936                 // First of all delete all the queue entries for this user
937                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
939                 // Init user caches - we keep the cache for one cycle only,
940                 // otherwise it would unnecessarily consume memory.
941                 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
942                     $userto = clone($users[$userid]);
943                 } else {
944                     $userto = $DB->get_record('user', array('id' => $userid));
945                     forum_cron_minimise_user_record($userto);
946                 }
947                 $userto->viewfullnames = array();
948                 $userto->canpost       = array();
949                 $userto->markposts     = array();
951                 // Override the language and timezone of the "current" user, so that
952                 // mail is customised for the receiver.
953                 cron_setup_user($userto);
955                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
957                 $headerdata = new stdClass();
958                 $headerdata->sitename = format_string($site->fullname, true);
959                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
961                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
962                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
964                 $posthtml = "<head>";
965 /*                foreach ($CFG->stylesheets as $stylesheet) {
966                     //TODO: MDL-21120
967                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
968                 }*/
969                 $posthtml .= "</head>\n<body id=\"email\">\n";
970                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
972                 foreach ($thesediscussions as $discussionid) {
974                     core_php_time_limit::raise(120);   // to be reset for each post
976                     $discussion = $discussions[$discussionid];
977                     $forum      = $forums[$discussion->forum];
978                     $course     = $courses[$forum->course];
979                     $cm         = $coursemodules[$forum->id];
981                     //override language
982                     cron_setup_user($userto, $course);
984                     // Fill caches
985                     if (!isset($userto->viewfullnames[$forum->id])) {
986                         $modcontext = context_module::instance($cm->id);
987                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
988                     }
989                     if (!isset($userto->canpost[$discussion->id])) {
990                         $modcontext = context_module::instance($cm->id);
991                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
992                     }
994                     $strforums      = get_string('forums', 'forum');
995                     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
996                     $canreply       = $userto->canpost[$discussion->id];
997                     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
999                     $posttext .= "\n \n";
1000                     $posttext .= '=====================================================================';
1001                     $posttext .= "\n \n";
1002                     $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1003                     if ($discussion->name != $forum->name) {
1004                         $posttext  .= " -> ".format_string($discussion->name,true);
1005                     }
1006                     $posttext .= "\n";
1007                     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1008                     $posttext .= "\n";
1010                     $posthtml .= "<p><font face=\"sans-serif\">".
1011                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
1012                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
1013                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
1014                     if ($discussion->name == $forum->name) {
1015                         $posthtml .= "</font></p>";
1016                     } else {
1017                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
1018                     }
1019                     $posthtml .= '<p>';
1021                     $postsarray = $discussionposts[$discussionid];
1022                     sort($postsarray);
1024                     foreach ($postsarray as $postid) {
1025                         $post = $posts[$postid];
1027                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
1028                             $userfrom = $users[$post->userid];
1029                             if (!isset($userfrom->idnumber)) {
1030                                 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
1031                                 forum_cron_minimise_user_record($userfrom);
1032                             }
1034                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
1035                             forum_cron_minimise_user_record($userfrom);
1036                             if ($userscount <= FORUM_CRON_USER_CACHE) {
1037                                 $userscount++;
1038                                 $users[$userfrom->id] = $userfrom;
1039                             }
1041                         } else {
1042                             mtrace('Could not find user '.$post->userid);
1043                             continue;
1044                         }
1046                         if (!isset($userfrom->groups[$forum->id])) {
1047                             if (!isset($userfrom->groups)) {
1048                                 $userfrom->groups = array();
1049                                 if (isset($users[$userfrom->id])) {
1050                                     $users[$userfrom->id]->groups = array();
1051                                 }
1052                             }
1053                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
1054                             if (isset($users[$userfrom->id])) {
1055                                 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
1056                             }
1057                         }
1059                         // Headers to help prevent auto-responders.
1060                         $userfrom->customheaders = array(
1061                                 "Precedence: Bulk",
1062                                 'X-Auto-Response-Suppress: All',
1063                                 'Auto-Submitted: auto-generated',
1064                             );
1066                         $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
1067                         if ($maildigest == 2) {
1068                             // Subjects and link only
1069                             $posttext .= "\n";
1070                             $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1071                             $by = new stdClass();
1072                             $by->name = fullname($userfrom);
1073                             $by->date = userdate($post->modified);
1074                             $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
1075                             $posttext .= "\n---------------------------------------------------------------------";
1077                             $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&amp;course=$course->id\">$by->name</a>";
1078                             $posthtml .= '<div><a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'#p'.$post->id.'">'.format_string($post->subject,true).'</a> '.get_string("bynameondate", "forum", $by).'</div>';
1080                         } else {
1081                             // The full treatment
1082                             $posttext .= forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, true);
1083                             $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1085                         // Create an array of postid's for this user to mark as read.
1086                             if (!$CFG->forum_usermarksread) {
1087                                 $userto->markposts[$post->id] = $post->id;
1088                             }
1089                         }
1090                     }
1091                     $footerlinks = array();
1092                     if ($canunsubscribe) {
1093                         $footerlinks[] = "<a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">" . get_string("unsubscribe", "forum") . "</a>";
1094                     } else {
1095                         $footerlinks[] = get_string("everyoneissubscribed", "forum");
1096                     }
1097                     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string("digestmailpost", "forum") . '</a>';
1098                     $posthtml .= "\n<div class='mdl-right'><font size=\"1\">" . implode('&nbsp;', $footerlinks) . '</font></div>';
1099                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
1100                 }
1101                 $posthtml .= '</body>';
1103                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
1104                     // This user DOESN'T want to receive HTML
1105                     $posthtml = '';
1106                 }
1108                 $attachment = $attachname='';
1109                 // Directly email forum digests rather than sending them via messaging, use the
1110                 // site shortname as 'from name', the noreply address will be used by email_to_user.
1111                 $mailresult = email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml, $attachment, $attachname);
1113                 if (!$mailresult) {
1114                     mtrace("ERROR: mod/forum/cron.php: Could not send out digest mail to user $userto->id ".
1115                         "($userto->email)... not trying again.");
1116                 } else {
1117                     mtrace("success.");
1118                     $usermailcount++;
1120                     // Mark post as read if forum_usermarksread is set off
1121                     forum_tp_mark_posts_read($userto, $userto->markposts);
1122                 }
1123             }
1124         }
1125     /// We have finishied all digest emails, update $CFG->digestmailtimelast
1126         set_config('digestmailtimelast', $timenow);
1127     }
1129     cron_setup_user();
1131     if (!empty($usermailcount)) {
1132         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
1133     }
1135     if (!empty($CFG->forum_lastreadclean)) {
1136         $timenow = time();
1137         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1138             set_config('forum_lastreadclean', $timenow);
1139             mtrace('Removing old forum read tracking info...');
1140             forum_tp_clean_read_records();
1141         }
1142     } else {
1143         set_config('forum_lastreadclean', time());
1144     }
1146     return true;
1149 /**
1150  * Builds and returns the body of the email notification in plain text.
1151  *
1152  * @global object
1153  * @global object
1154  * @uses CONTEXT_MODULE
1155  * @param object $course
1156  * @param object $cm
1157  * @param object $forum
1158  * @param object $discussion
1159  * @param object $post
1160  * @param object $userfrom
1161  * @param object $userto
1162  * @param boolean $bare
1163  * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
1164  * @return string The email body in plain text format.
1165  */
1166 function forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $bare = false, $replyaddress = null) {
1167     global $CFG, $USER;
1169     $modcontext = context_module::instance($cm->id);
1171     if (!isset($userto->viewfullnames[$forum->id])) {
1172         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1173     } else {
1174         $viewfullnames = $userto->viewfullnames[$forum->id];
1175     }
1177     if (!isset($userto->canpost[$discussion->id])) {
1178         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1179     } else {
1180         $canreply = $userto->canpost[$discussion->id];
1181     }
1183     $by = New stdClass;
1184     $by->name = fullname($userfrom, $viewfullnames);
1185     $by->date = userdate($post->modified, "", $userto->timezone);
1187     $strbynameondate = get_string('bynameondate', 'forum', $by);
1189     $strforums = get_string('forums', 'forum');
1191     $canunsubscribe = !\mod_forum\subscriptions::is_forcesubscribed($forum);
1193     $posttext = '';
1195     if (!$bare) {
1196         $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1197         $posttext  .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1199         if ($discussion->name != $forum->name) {
1200             $posttext  .= " -> ".format_string($discussion->name,true);
1201         }
1202     }
1204     // add absolute file links
1205     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
1207     $posttext .= "\n";
1208     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1209     $posttext .= "\n---------------------------------------------------------------------\n";
1210     $posttext .= format_string($post->subject,true);
1211     if ($bare) {
1212         $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
1213     }
1214     $posttext .= "\n".$strbynameondate."\n";
1215     $posttext .= "---------------------------------------------------------------------\n";
1216     $posttext .= format_text_email($post->message, $post->messageformat);
1217     $posttext .= "\n\n";
1218     $posttext .= forum_print_attachments($post, $cm, "text");
1220     if (!$bare) {
1221         if ($canreply) {
1222             $posttext .= "---------------------------------------------------------------------\n";
1223             $posttext .= get_string("postmailinfo", "forum", $shortname)."\n";
1224             $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
1225         }
1227         if ($canunsubscribe) {
1228             if (\mod_forum\subscriptions::is_subscribed($userto->id, $forum, null, $cm)) {
1229                 // If subscribed to this forum, offer the unsubscribe link.
1230                 $posttext .= "\n---------------------------------------------------------------------\n";
1231                 $posttext .= get_string("unsubscribe", "forum");
1232                 $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
1233             }
1234             // Always offer the unsubscribe from discussion link.
1235             $posttext .= "\n---------------------------------------------------------------------\n";
1236             $posttext .= get_string("unsubscribediscussion", "forum");
1237             $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id&d=$discussion->id\n";
1238         }
1239     }
1241     $posttext .= "\n---------------------------------------------------------------------\n";
1242     $posttext .= get_string("digestmailpost", "forum");
1243     $posttext .= ": {$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}\n";
1245     if ($replyaddress) {
1246         $posttext .= "\n\n" . get_string('replytopostbyemail', 'mod_forum');
1247     }
1249     return $posttext;
1252 /**
1253  * Builds and returns the body of the email notification in html format.
1254  *
1255  * @global object
1256  * @param object $course
1257  * @param object $cm
1258  * @param object $forum
1259  * @param object $discussion
1260  * @param object $post
1261  * @param object $userfrom
1262  * @param object $userto
1263  * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
1264  * @return string The email text in HTML format
1265  */
1266 function forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $replyaddress = null) {
1267     global $CFG;
1269     if ($userto->mailformat != 1) {  // Needs to be HTML
1270         return '';
1271     }
1273     if (!isset($userto->canpost[$discussion->id])) {
1274         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course);
1275     } else {
1276         $canreply = $userto->canpost[$discussion->id];
1277     }
1279     $strforums = get_string('forums', 'forum');
1280     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
1281     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1283     $posthtml = '<head>';
1284 /*    foreach ($CFG->stylesheets as $stylesheet) {
1285         //TODO: MDL-21120
1286         $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
1287     }*/
1288     $posthtml .= '</head>';
1289     $posthtml .= "\n<body id=\"email\">\n\n";
1291     $posthtml .= '<div class="navbar">'.
1292     '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$shortname.'</a> &raquo; '.
1293     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> &raquo; '.
1294     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
1295     if ($discussion->name == $forum->name) {
1296         $posthtml .= '</div>';
1297     } else {
1298         $posthtml .= ' &raquo; <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
1299                      format_string($discussion->name,true).'</a></div>';
1300     }
1301     $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1303     if ($replyaddress) {
1304         $posthtml .= html_writer::tag('p', get_string('replytopostbyemail', 'mod_forum'));
1305     }
1307     $footerlinks = array();
1308     if ($canunsubscribe) {
1309         if (\mod_forum\subscriptions::is_subscribed($userto->id, $forum, null, $cm)) {
1310             // If subscribed to this forum, offer the unsubscribe link.
1311             $unsublink = new moodle_url('/mod/forum/subscribe.php', array('id' => $forum->id));
1312             $footerlinks[] = html_writer::link($unsublink, get_string('unsubscribe', 'mod_forum'));
1313         }
1314         // Always offer the unsubscribe from discussion link.
1315         $unsublink = new moodle_url('/mod/forum/subscribe.php', array(
1316                 'id' => $forum->id,
1317                 'd' => $discussion->id,
1318             ));
1319         $footerlinks[] = html_writer::link($unsublink, get_string('unsubscribediscussion', 'mod_forum'));
1321         $footerlinks[] = '<a href="' . $CFG->wwwroot . '/mod/forum/unsubscribeall.php">' . get_string('unsubscribeall', 'forum') . '</a>';
1322     }
1323     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string('digestmailpost', 'forum') . '</a>';
1324     $posthtml .= '<hr /><div class="mdl-align unsubscribelink">' . implode('&nbsp;', $footerlinks) . '</div>';
1326     $posthtml .= '</body>';
1328     return $posthtml;
1332 /**
1333  *
1334  * @param object $course
1335  * @param object $user
1336  * @param object $mod TODO this is not used in this function, refactor
1337  * @param object $forum
1338  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
1339  */
1340 function forum_user_outline($course, $user, $mod, $forum) {
1341     global $CFG;
1342     require_once("$CFG->libdir/gradelib.php");
1343     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1344     if (empty($grades->items[0]->grades)) {
1345         $grade = false;
1346     } else {
1347         $grade = reset($grades->items[0]->grades);
1348     }
1350     $count = forum_count_user_posts($forum->id, $user->id);
1352     if ($count && $count->postcount > 0) {
1353         $result = new stdClass();
1354         $result->info = get_string("numposts", "forum", $count->postcount);
1355         $result->time = $count->lastpost;
1356         if ($grade) {
1357             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1358         }
1359         return $result;
1360     } else if ($grade) {
1361         $result = new stdClass();
1362         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1364         //datesubmitted == time created. dategraded == time modified or time overridden
1365         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1366         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1367         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1368             $result->time = $grade->dategraded;
1369         } else {
1370             $result->time = $grade->datesubmitted;
1371         }
1373         return $result;
1374     }
1375     return NULL;
1379 /**
1380  * @global object
1381  * @global object
1382  * @param object $coure
1383  * @param object $user
1384  * @param object $mod
1385  * @param object $forum
1386  */
1387 function forum_user_complete($course, $user, $mod, $forum) {
1388     global $CFG,$USER, $OUTPUT;
1389     require_once("$CFG->libdir/gradelib.php");
1391     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1392     if (!empty($grades->items[0]->grades)) {
1393         $grade = reset($grades->items[0]->grades);
1394         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1395         if ($grade->str_feedback) {
1396             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1397         }
1398     }
1400     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
1402         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
1403             print_error('invalidcoursemodule');
1404         }
1405         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1407         foreach ($posts as $post) {
1408             if (!isset($discussions[$post->discussion])) {
1409                 continue;
1410             }
1411             $discussion = $discussions[$post->discussion];
1413             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
1414         }
1415     } else {
1416         echo "<p>".get_string("noposts", "forum")."</p>";
1417     }
1420 /**
1421  * Filters the forum discussions according to groups membership and config.
1422  *
1423  * @since  Moodle 2.8, 2.7.1, 2.6.4
1424  * @param  array $discussions Discussions with new posts array
1425  * @return array Forums with the number of new posts
1426  */
1427 function forum_filter_user_groups_discussions($discussions) {
1429     // Group the remaining discussions posts by their forumid.
1430     $filteredforums = array();
1432     // Discard not visible groups.
1433     foreach ($discussions as $discussion) {
1435         // Course data is already cached.
1436         $instances = get_fast_modinfo($discussion->course)->get_instances();
1437         $forum = $instances['forum'][$discussion->forum];
1439         // Continue if the user should not see this discussion.
1440         if (!forum_is_user_group_discussion($forum, $discussion->groupid)) {
1441             continue;
1442         }
1444         // Grouping results by forum.
1445         if (empty($filteredforums[$forum->instance])) {
1446             $filteredforums[$forum->instance] = new stdClass();
1447             $filteredforums[$forum->instance]->id = $forum->id;
1448             $filteredforums[$forum->instance]->count = 0;
1449         }
1450         $filteredforums[$forum->instance]->count += $discussion->count;
1452     }
1454     return $filteredforums;
1457 /**
1458  * Returns whether the discussion group is visible by the current user or not.
1459  *
1460  * @since Moodle 2.8, 2.7.1, 2.6.4
1461  * @param cm_info $cm The discussion course module
1462  * @param int $discussiongroupid The discussion groupid
1463  * @return bool
1464  */
1465 function forum_is_user_group_discussion(cm_info $cm, $discussiongroupid) {
1467     if ($discussiongroupid == -1 || $cm->effectivegroupmode != SEPARATEGROUPS) {
1468         return true;
1469     }
1471     if (isguestuser()) {
1472         return false;
1473     }
1475     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id)) ||
1476             in_array($discussiongroupid, $cm->get_modinfo()->get_groups($cm->groupingid))) {
1477         return true;
1478     }
1480     return false;
1483 /**
1484  * @global object
1485  * @global object
1486  * @global object
1487  * @param array $courses
1488  * @param array $htmlarray
1489  */
1490 function forum_print_overview($courses,&$htmlarray) {
1491     global $USER, $CFG, $DB, $SESSION;
1493     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1494         return array();
1495     }
1497     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1498         return;
1499     }
1501     // Courses to search for new posts
1502     $coursessqls = array();
1503     $params = array();
1504     foreach ($courses as $course) {
1506         // If the user has never entered into the course all posts are pending
1507         if ($course->lastaccess == 0) {
1508             $coursessqls[] = '(d.course = ?)';
1509             $params[] = $course->id;
1511         // Only posts created after the course last access
1512         } else {
1513             $coursessqls[] = '(d.course = ? AND p.created > ?)';
1514             $params[] = $course->id;
1515             $params[] = $course->lastaccess;
1516         }
1517     }
1518     $params[] = $USER->id;
1519     $coursessql = implode(' OR ', $coursessqls);
1521     $sql = "SELECT d.id, d.forum, d.course, d.groupid, COUNT(*) as count "
1522                 .'FROM {forum_discussions} d '
1523                 .'JOIN {forum_posts} p ON p.discussion = d.id '
1524                 ."WHERE ($coursessql) "
1525                 .'AND p.userid != ? '
1526                 .'GROUP BY d.id, d.forum, d.course, d.groupid '
1527                 .'ORDER BY d.course, d.forum';
1529     // Avoid warnings.
1530     if (!$discussions = $DB->get_records_sql($sql, $params)) {
1531         $discussions = array();
1532     }
1534     $forumsnewposts = forum_filter_user_groups_discussions($discussions);
1536     // also get all forum tracking stuff ONCE.
1537     $trackingforums = array();
1538     foreach ($forums as $forum) {
1539         if (forum_tp_can_track_forums($forum)) {
1540             $trackingforums[$forum->id] = $forum;
1541         }
1542     }
1544     if (count($trackingforums) > 0) {
1545         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1546         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1547             ' FROM {forum_posts} p '.
1548             ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1549             ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
1550         $params = array($USER->id);
1552         foreach ($trackingforums as $track) {
1553             $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1554             $params[] = $track->id;
1555             if (isset($SESSION->currentgroup[$track->course])) {
1556                 $groupid =  $SESSION->currentgroup[$track->course];
1557             } else {
1558                 // get first groupid
1559                 $groupids = groups_get_all_groups($track->course, $USER->id);
1560                 if ($groupids) {
1561                     reset($groupids);
1562                     $groupid = key($groupids);
1563                     $SESSION->currentgroup[$track->course] = $groupid;
1564                 } else {
1565                     $groupid = 0;
1566                 }
1567                 unset($groupids);
1568             }
1569             $params[] = $groupid;
1570         }
1571         $sql = substr($sql,0,-3); // take off the last OR
1572         $sql .= ') AND p.modified >= ? AND r.id is NULL GROUP BY d.forum,d.course';
1573         $params[] = $cutoffdate;
1575         if (!$unread = $DB->get_records_sql($sql, $params)) {
1576             $unread = array();
1577         }
1578     } else {
1579         $unread = array();
1580     }
1582     if (empty($unread) and empty($forumsnewposts)) {
1583         return;
1584     }
1586     $strforum = get_string('modulename','forum');
1588     foreach ($forums as $forum) {
1589         $str = '';
1590         $count = 0;
1591         $thisunread = 0;
1592         $showunread = false;
1593         // either we have something from logs, or trackposts, or nothing.
1594         if (array_key_exists($forum->id, $forumsnewposts) && !empty($forumsnewposts[$forum->id])) {
1595             $count = $forumsnewposts[$forum->id]->count;
1596         }
1597         if (array_key_exists($forum->id,$unread)) {
1598             $thisunread = $unread[$forum->id]->count;
1599             $showunread = true;
1600         }
1601         if ($count > 0 || $thisunread > 0) {
1602             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1603                 $forum->name.'</a></div>';
1604             $str .= '<div class="info"><span class="postsincelogin">';
1605             $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
1606             if (!empty($showunread)) {
1607                 $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
1608             }
1609             $str .= '</div></div>';
1610         }
1611         if (!empty($str)) {
1612             if (!array_key_exists($forum->course,$htmlarray)) {
1613                 $htmlarray[$forum->course] = array();
1614             }
1615             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1616                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1617             }
1618             $htmlarray[$forum->course]['forum'] .= $str;
1619         }
1620     }
1623 /**
1624  * Given a course and a date, prints a summary of all the new
1625  * messages posted in the course since that date
1626  *
1627  * @global object
1628  * @global object
1629  * @global object
1630  * @uses CONTEXT_MODULE
1631  * @uses VISIBLEGROUPS
1632  * @param object $course
1633  * @param bool $viewfullnames capability
1634  * @param int $timestart
1635  * @return bool success
1636  */
1637 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1638     global $CFG, $USER, $DB, $OUTPUT;
1640     // do not use log table if possible, it may be huge and is expensive to join with other tables
1642     $allnamefields = user_picture::fields('u', null, 'duserid');
1643     if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1644                                               d.timestart, d.timeend, $allnamefields
1645                                          FROM {forum_posts} p
1646                                               JOIN {forum_discussions} d ON d.id = p.discussion
1647                                               JOIN {forum} f             ON f.id = d.forum
1648                                               JOIN {user} u              ON u.id = p.userid
1649                                         WHERE p.created > ? AND f.course = ?
1650                                      ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
1651          return false;
1652     }
1654     $modinfo = get_fast_modinfo($course);
1656     $groupmodes = array();
1657     $cms    = array();
1659     $strftimerecent = get_string('strftimerecent');
1661     $printposts = array();
1662     foreach ($posts as $post) {
1663         if (!isset($modinfo->instances['forum'][$post->forum])) {
1664             // not visible
1665             continue;
1666         }
1667         $cm = $modinfo->instances['forum'][$post->forum];
1668         if (!$cm->uservisible) {
1669             continue;
1670         }
1671         $context = context_module::instance($cm->id);
1673         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1674             continue;
1675         }
1677         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1678           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1679             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1680                 continue;
1681             }
1682         }
1684         // Check that the user can see the discussion.
1685         if (forum_is_user_group_discussion($cm, $post->groupid)) {
1686             $printposts[] = $post;
1687         }
1689     }
1690     unset($posts);
1692     if (!$printposts) {
1693         return false;
1694     }
1696     echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
1697     echo "\n<ul class='unlist'>\n";
1699     foreach ($printposts as $post) {
1700         $subjectclass = empty($post->parent) ? ' bold' : '';
1702         echo '<li><div class="head">'.
1703                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1704                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1705              '</div>';
1706         echo '<div class="info'.$subjectclass.'">';
1707         if (empty($post->parent)) {
1708             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1709         } else {
1710             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1711         }
1712         $post->subject = break_up_long_words(format_string($post->subject, true));
1713         echo $post->subject;
1714         echo "</a>\"</div></li>\n";
1715     }
1717     echo "</ul>\n";
1719     return true;
1722 /**
1723  * Return grade for given user or all users.
1724  *
1725  * @global object
1726  * @global object
1727  * @param object $forum
1728  * @param int $userid optional user id, 0 means all users
1729  * @return array array of grades, false if none
1730  */
1731 function forum_get_user_grades($forum, $userid = 0) {
1732     global $CFG;
1734     require_once($CFG->dirroot.'/rating/lib.php');
1736     $ratingoptions = new stdClass;
1737     $ratingoptions->component = 'mod_forum';
1738     $ratingoptions->ratingarea = 'post';
1740     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1741     $ratingoptions->modulename = 'forum';
1742     $ratingoptions->moduleid   = $forum->id;
1743     $ratingoptions->userid = $userid;
1744     $ratingoptions->aggregationmethod = $forum->assessed;
1745     $ratingoptions->scaleid = $forum->scale;
1746     $ratingoptions->itemtable = 'forum_posts';
1747     $ratingoptions->itemtableusercolumn = 'userid';
1749     $rm = new rating_manager();
1750     return $rm->get_user_grades($ratingoptions);
1753 /**
1754  * Update activity grades
1755  *
1756  * @category grade
1757  * @param object $forum
1758  * @param int $userid specific user only, 0 means all
1759  * @param boolean $nullifnone return null if grade does not exist
1760  * @return void
1761  */
1762 function forum_update_grades($forum, $userid=0, $nullifnone=true) {
1763     global $CFG, $DB;
1764     require_once($CFG->libdir.'/gradelib.php');
1766     if (!$forum->assessed) {
1767         forum_grade_item_update($forum);
1769     } else if ($grades = forum_get_user_grades($forum, $userid)) {
1770         forum_grade_item_update($forum, $grades);
1772     } else if ($userid and $nullifnone) {
1773         $grade = new stdClass();
1774         $grade->userid   = $userid;
1775         $grade->rawgrade = NULL;
1776         forum_grade_item_update($forum, $grade);
1778     } else {
1779         forum_grade_item_update($forum);
1780     }
1783 /**
1784  * Create/update grade item for given forum
1785  *
1786  * @category grade
1787  * @uses GRADE_TYPE_NONE
1788  * @uses GRADE_TYPE_VALUE
1789  * @uses GRADE_TYPE_SCALE
1790  * @param stdClass $forum Forum object with extra cmidnumber
1791  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1792  * @return int 0 if ok
1793  */
1794 function forum_grade_item_update($forum, $grades=NULL) {
1795     global $CFG;
1796     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1797         require_once($CFG->libdir.'/gradelib.php');
1798     }
1800     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1802     if (!$forum->assessed or $forum->scale == 0) {
1803         $params['gradetype'] = GRADE_TYPE_NONE;
1805     } else if ($forum->scale > 0) {
1806         $params['gradetype'] = GRADE_TYPE_VALUE;
1807         $params['grademax']  = $forum->scale;
1808         $params['grademin']  = 0;
1810     } else if ($forum->scale < 0) {
1811         $params['gradetype'] = GRADE_TYPE_SCALE;
1812         $params['scaleid']   = -$forum->scale;
1813     }
1815     if ($grades  === 'reset') {
1816         $params['reset'] = true;
1817         $grades = NULL;
1818     }
1820     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1823 /**
1824  * Delete grade item for given forum
1825  *
1826  * @category grade
1827  * @param stdClass $forum Forum object
1828  * @return grade_item
1829  */
1830 function forum_grade_item_delete($forum) {
1831     global $CFG;
1832     require_once($CFG->libdir.'/gradelib.php');
1834     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1838 /**
1839  * This function returns if a scale is being used by one forum
1840  *
1841  * @global object
1842  * @param int $forumid
1843  * @param int $scaleid negative number
1844  * @return bool
1845  */
1846 function forum_scale_used ($forumid,$scaleid) {
1847     global $DB;
1848     $return = false;
1850     $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
1852     if (!empty($rec) && !empty($scaleid)) {
1853         $return = true;
1854     }
1856     return $return;
1859 /**
1860  * Checks if scale is being used by any instance of forum
1861  *
1862  * This is used to find out if scale used anywhere
1863  *
1864  * @global object
1865  * @param $scaleid int
1866  * @return boolean True if the scale is used by any forum
1867  */
1868 function forum_scale_used_anywhere($scaleid) {
1869     global $DB;
1870     if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
1871         return true;
1872     } else {
1873         return false;
1874     }
1877 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1879 /**
1880  * Gets a post with all info ready for forum_print_post
1881  * Most of these joins are just to get the forum id
1882  *
1883  * @global object
1884  * @global object
1885  * @param int $postid
1886  * @return mixed array of posts or false
1887  */
1888 function forum_get_post_full($postid) {
1889     global $CFG, $DB;
1891     $allnames = get_all_user_name_fields(true, 'u');
1892     return $DB->get_record_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
1893                              FROM {forum_posts} p
1894                                   JOIN {forum_discussions} d ON p.discussion = d.id
1895                                   LEFT JOIN {user} u ON p.userid = u.id
1896                             WHERE p.id = ?", array($postid));
1899 /**
1900  * Gets all posts in discussion including top parent.
1901  *
1902  * @global object
1903  * @global object
1904  * @global object
1905  * @param int $discussionid
1906  * @param string $sort
1907  * @param bool $tracking does user track the forum?
1908  * @return array of posts
1909  */
1910 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1911     global $CFG, $DB, $USER;
1913     $tr_sel  = "";
1914     $tr_join = "";
1915     $params = array();
1917     if ($tracking) {
1918         $now = time();
1919         $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
1920         $tr_sel  = ", fr.id AS postread";
1921         $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1922         $params[] = $USER->id;
1923     }
1925     $allnames = get_all_user_name_fields(true, 'u');
1926     $params[] = $discussionid;
1927     if (!$posts = $DB->get_records_sql("SELECT p.*, $allnames, u.email, u.picture, u.imagealt $tr_sel
1928                                      FROM {forum_posts} p
1929                                           LEFT JOIN {user} u ON p.userid = u.id
1930                                           $tr_join
1931                                     WHERE p.discussion = ?
1932                                  ORDER BY $sort", $params)) {
1933         return array();
1934     }
1936     foreach ($posts as $pid=>$p) {
1937         if ($tracking) {
1938             if (forum_tp_is_post_old($p)) {
1939                  $posts[$pid]->postread = true;
1940             }
1941         }
1942         if (!$p->parent) {
1943             continue;
1944         }
1945         if (!isset($posts[$p->parent])) {
1946             continue; // parent does not exist??
1947         }
1948         if (!isset($posts[$p->parent]->children)) {
1949             $posts[$p->parent]->children = array();
1950         }
1951         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1952     }
1954     return $posts;
1957 /**
1958  * An array of forum objects that the user is allowed to read/search through.
1959  *
1960  * @global object
1961  * @global object
1962  * @global object
1963  * @param int $userid
1964  * @param int $courseid if 0, we look for forums throughout the whole site.
1965  * @return array of forum objects, or false if no matches
1966  *         Forum objects have the following attributes:
1967  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1968  *         viewhiddentimedposts
1969  */
1970 function forum_get_readable_forums($userid, $courseid=0) {
1972     global $CFG, $DB, $USER;
1973     require_once($CFG->dirroot.'/course/lib.php');
1975     if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
1976         print_error('notinstalled', 'forum');
1977     }
1979     if ($courseid) {
1980         $courses = $DB->get_records('course', array('id' => $courseid));
1981     } else {
1982         // If no course is specified, then the user can see SITE + his courses.
1983         $courses1 = $DB->get_records('course', array('id' => SITEID));
1984         $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
1985         $courses = array_merge($courses1, $courses2);
1986     }
1987     if (!$courses) {
1988         return array();
1989     }
1991     $readableforums = array();
1993     foreach ($courses as $course) {
1995         $modinfo = get_fast_modinfo($course);
1997         if (empty($modinfo->instances['forum'])) {
1998             // hmm, no forums?
1999             continue;
2000         }
2002         $courseforums = $DB->get_records('forum', array('course' => $course->id));
2004         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
2005             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
2006                 continue;
2007             }
2008             $context = context_module::instance($cm->id);
2009             $forum = $courseforums[$forumid];
2010             $forum->context = $context;
2011             $forum->cm = $cm;
2013             if (!has_capability('mod/forum:viewdiscussion', $context)) {
2014                 continue;
2015             }
2017          /// group access
2018             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2020                 $forum->onlygroups = $modinfo->get_groups($cm->groupingid);
2021                 $forum->onlygroups[] = -1;
2022             }
2024         /// hidden timed discussions
2025             $forum->viewhiddentimedposts = true;
2026             if (!empty($CFG->forum_enabletimedposts)) {
2027                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
2028                     $forum->viewhiddentimedposts = false;
2029                 }
2030             }
2032         /// qanda access
2033             if ($forum->type == 'qanda'
2034                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2036                 // We need to check whether the user has posted in the qanda forum.
2037                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
2038                                                     // the user is allowed to see in this forum.
2039                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
2040                     foreach ($discussionspostedin as $d) {
2041                         $forum->onlydiscussions[] = $d->id;
2042                     }
2043                 }
2044             }
2046             $readableforums[$forum->id] = $forum;
2047         }
2049         unset($modinfo);
2051     } // End foreach $courses
2053     return $readableforums;
2056 /**
2057  * Returns a list of posts found using an array of search terms.
2058  *
2059  * @global object
2060  * @global object
2061  * @global object
2062  * @param array $searchterms array of search terms, e.g. word +word -word
2063  * @param int $courseid if 0, we search through the whole site
2064  * @param int $limitfrom
2065  * @param int $limitnum
2066  * @param int &$totalcount
2067  * @param string $extrasql
2068  * @return array|bool Array of posts found or false
2069  */
2070 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
2071                             &$totalcount, $extrasql='') {
2072     global $CFG, $DB, $USER;
2073     require_once($CFG->libdir.'/searchlib.php');
2075     $forums = forum_get_readable_forums($USER->id, $courseid);
2077     if (count($forums) == 0) {
2078         $totalcount = 0;
2079         return false;
2080     }
2082     $now = round(time(), -2); // db friendly
2084     $fullaccess = array();
2085     $where = array();
2086     $params = array();
2088     foreach ($forums as $forumid => $forum) {
2089         $select = array();
2091         if (!$forum->viewhiddentimedposts) {
2092             $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
2093             $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
2094         }
2096         $cm = $forum->cm;
2097         $context = $forum->context;
2099         if ($forum->type == 'qanda'
2100             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2101             if (!empty($forum->onlydiscussions)) {
2102                 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
2103                 $params = array_merge($params, $discussionid_params);
2104                 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
2105             } else {
2106                 $select[] = "p.parent = 0";
2107             }
2108         }
2110         if (!empty($forum->onlygroups)) {
2111             list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
2112             $params = array_merge($params, $groupid_params);
2113             $select[] = "d.groupid $groupid_sql";
2114         }
2116         if ($select) {
2117             $selects = implode(" AND ", $select);
2118             $where[] = "(d.forum = :forum{$forumid} AND $selects)";
2119             $params['forum'.$forumid] = $forumid;
2120         } else {
2121             $fullaccess[] = $forumid;
2122         }
2123     }
2125     if ($fullaccess) {
2126         list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
2127         $params = array_merge($params, $fullid_params);
2128         $where[] = "(d.forum $fullid_sql)";
2129     }
2131     $selectdiscussion = "(".implode(" OR ", $where).")";
2133     $messagesearch = '';
2134     $searchstring = '';
2136     // Need to concat these back together for parser to work.
2137     foreach($searchterms as $searchterm){
2138         if ($searchstring != '') {
2139             $searchstring .= ' ';
2140         }
2141         $searchstring .= $searchterm;
2142     }
2144     // We need to allow quoted strings for the search. The quotes *should* be stripped
2145     // by the parser, but this should be examined carefully for security implications.
2146     $searchstring = str_replace("\\\"","\"",$searchstring);
2147     $parser = new search_parser();
2148     $lexer = new search_lexer($parser);
2150     if ($lexer->parse($searchstring)) {
2151         $parsearray = $parser->get_parsed_array();
2152     // Experimental feature under 1.8! MDL-8830
2153     // Use alternative text searches if defined
2154     // This feature only works under mysql until properly implemented for other DBs
2155     // Requires manual creation of text index for forum_posts before enabling it:
2156     // CREATE FULLTEXT INDEX foru_post_tix ON [prefix]forum_posts (subject, message)
2157     // Experimental feature under 1.8! MDL-8830
2158         if (!empty($CFG->forum_usetextsearches)) {
2159             list($messagesearch, $msparams) = search_generate_text_SQL($parsearray, 'p.message', 'p.subject',
2160                                                  'p.userid', 'u.id', 'u.firstname',
2161                                                  'u.lastname', 'p.modified', 'd.forum');
2162         } else {
2163             list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2164                                                  'p.userid', 'u.id', 'u.firstname',
2165                                                  'u.lastname', 'p.modified', 'd.forum');
2166         }
2167         $params = array_merge($params, $msparams);
2168     }
2170     $fromsql = "{forum_posts} p,
2171                   {forum_discussions} d,
2172                   {user} u";
2174     $selectsql = " $messagesearch
2175                AND p.discussion = d.id
2176                AND p.userid = u.id
2177                AND $selectdiscussion
2178                    $extrasql";
2180     $countsql = "SELECT COUNT(*)
2181                    FROM $fromsql
2182                   WHERE $selectsql";
2184     $allnames = get_all_user_name_fields(true, 'u');
2185     $searchsql = "SELECT p.*,
2186                          d.forum,
2187                          $allnames,
2188                          u.email,
2189                          u.picture,
2190                          u.imagealt
2191                     FROM $fromsql
2192                    WHERE $selectsql
2193                 ORDER BY p.modified DESC";
2195     $totalcount = $DB->count_records_sql($countsql, $params);
2197     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2200 /**
2201  * Returns a list of all new posts that have not been mailed yet
2202  *
2203  * @param int $starttime posts created after this time
2204  * @param int $endtime posts created before this
2205  * @param int $now used for timed discussions only
2206  * @return array
2207  */
2208 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2209     global $CFG, $DB;
2211     $params = array();
2212     $params['mailed'] = FORUM_MAILED_PENDING;
2213     $params['ptimestart'] = $starttime;
2214     $params['ptimeend'] = $endtime;
2215     $params['mailnow'] = 1;
2217     if (!empty($CFG->forum_enabletimedposts)) {
2218         if (empty($now)) {
2219             $now = time();
2220         }
2221         $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
2222         $params['dtimestart'] = $now;
2223         $params['dtimeend'] = $now;
2224     } else {
2225         $timedsql = "";
2226     }
2228     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2229                                  FROM {forum_posts} p
2230                                  JOIN {forum_discussions} d ON d.id = p.discussion
2231                                  WHERE p.mailed = :mailed
2232                                  AND p.created >= :ptimestart
2233                                  AND (p.created < :ptimeend OR p.mailnow = :mailnow)
2234                                  $timedsql
2235                                  ORDER BY p.modified ASC", $params);
2238 /**
2239  * Marks posts before a certain time as being mailed already
2240  *
2241  * @global object
2242  * @global object
2243  * @param int $endtime
2244  * @param int $now Defaults to time()
2245  * @return bool
2246  */
2247 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2248     global $CFG, $DB;
2250     if (empty($now)) {
2251         $now = time();
2252     }
2254     $params = array();
2255     $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
2256     $params['now'] = $now;
2257     $params['endtime'] = $endtime;
2258     $params['mailnow'] = 1;
2259     $params['mailedpending'] = FORUM_MAILED_PENDING;
2261     if (empty($CFG->forum_enabletimedposts)) {
2262         return $DB->execute("UPDATE {forum_posts}
2263                              SET mailed = :mailedsuccess
2264                              WHERE (created < :endtime OR mailnow = :mailnow)
2265                              AND mailed = :mailedpending", $params);
2266     } else {
2267         return $DB->execute("UPDATE {forum_posts}
2268                              SET mailed = :mailedsuccess
2269                              WHERE discussion NOT IN (SELECT d.id
2270                                                       FROM {forum_discussions} d
2271                                                       WHERE d.timestart > :now)
2272                              AND (created < :endtime OR mailnow = :mailnow)
2273                              AND mailed = :mailedpending", $params);
2274     }
2277 /**
2278  * Get all the posts for a user in a forum suitable for forum_print_post
2279  *
2280  * @global object
2281  * @global object
2282  * @uses CONTEXT_MODULE
2283  * @return array
2284  */
2285 function forum_get_user_posts($forumid, $userid) {
2286     global $CFG, $DB;
2288     $timedsql = "";
2289     $params = array($forumid, $userid);
2291     if (!empty($CFG->forum_enabletimedposts)) {
2292         $cm = get_coursemodule_from_instance('forum', $forumid);
2293         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2294             $now = time();
2295             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2296             $params[] = $now;
2297             $params[] = $now;
2298         }
2299     }
2301     $allnames = get_all_user_name_fields(true, 'u');
2302     return $DB->get_records_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
2303                               FROM {forum} f
2304                                    JOIN {forum_discussions} d ON d.forum = f.id
2305                                    JOIN {forum_posts} p       ON p.discussion = d.id
2306                                    JOIN {user} u              ON u.id = p.userid
2307                              WHERE f.id = ?
2308                                    AND p.userid = ?
2309                                    $timedsql
2310                           ORDER BY p.modified ASC", $params);
2313 /**
2314  * Get all the discussions user participated in
2315  *
2316  * @global object
2317  * @global object
2318  * @uses CONTEXT_MODULE
2319  * @param int $forumid
2320  * @param int $userid
2321  * @return array Array or false
2322  */
2323 function forum_get_user_involved_discussions($forumid, $userid) {
2324     global $CFG, $DB;
2326     $timedsql = "";
2327     $params = array($forumid, $userid);
2328     if (!empty($CFG->forum_enabletimedposts)) {
2329         $cm = get_coursemodule_from_instance('forum', $forumid);
2330         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2331             $now = time();
2332             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2333             $params[] = $now;
2334             $params[] = $now;
2335         }
2336     }
2338     return $DB->get_records_sql("SELECT DISTINCT d.*
2339                               FROM {forum} f
2340                                    JOIN {forum_discussions} d ON d.forum = f.id
2341                                    JOIN {forum_posts} p       ON p.discussion = d.id
2342                              WHERE f.id = ?
2343                                    AND p.userid = ?
2344                                    $timedsql", $params);
2347 /**
2348  * Get all the posts for a user in a forum suitable for forum_print_post
2349  *
2350  * @global object
2351  * @global object
2352  * @param int $forumid
2353  * @param int $userid
2354  * @return array of counts or false
2355  */
2356 function forum_count_user_posts($forumid, $userid) {
2357     global $CFG, $DB;
2359     $timedsql = "";
2360     $params = array($forumid, $userid);
2361     if (!empty($CFG->forum_enabletimedposts)) {
2362         $cm = get_coursemodule_from_instance('forum', $forumid);
2363         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2364             $now = time();
2365             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2366             $params[] = $now;
2367             $params[] = $now;
2368         }
2369     }
2371     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2372                              FROM {forum} f
2373                                   JOIN {forum_discussions} d ON d.forum = f.id
2374                                   JOIN {forum_posts} p       ON p.discussion = d.id
2375                                   JOIN {user} u              ON u.id = p.userid
2376                             WHERE f.id = ?
2377                                   AND p.userid = ?
2378                                   $timedsql", $params);
2381 /**
2382  * Given a log entry, return the forum post details for it.
2383  *
2384  * @global object
2385  * @global object
2386  * @param object $log
2387  * @return array|null
2388  */
2389 function forum_get_post_from_log($log) {
2390     global $CFG, $DB;
2392     $allnames = get_all_user_name_fields(true, 'u');
2393     if ($log->action == "add post") {
2395         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2396                                  FROM {forum_discussions} d,
2397                                       {forum_posts} p,
2398                                       {forum} f,
2399                                       {user} u
2400                                 WHERE p.id = ?
2401                                   AND d.id = p.discussion
2402                                   AND p.userid = u.id
2403                                   AND u.deleted <> '1'
2404                                   AND f.id = d.forum", array($log->info));
2407     } else if ($log->action == "add discussion") {
2409         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2410                                  FROM {forum_discussions} d,
2411                                       {forum_posts} p,
2412                                       {forum} f,
2413                                       {user} u
2414                                 WHERE d.id = ?
2415                                   AND d.firstpost = p.id
2416                                   AND p.userid = u.id
2417                                   AND u.deleted <> '1'
2418                                   AND f.id = d.forum", array($log->info));
2419     }
2420     return NULL;
2423 /**
2424  * Given a discussion id, return the first post from the discussion
2425  *
2426  * @global object
2427  * @global object
2428  * @param int $dicsussionid
2429  * @return array
2430  */
2431 function forum_get_firstpost_from_discussion($discussionid) {
2432     global $CFG, $DB;
2434     return $DB->get_record_sql("SELECT p.*
2435                              FROM {forum_discussions} d,
2436                                   {forum_posts} p
2437                             WHERE d.id = ?
2438                               AND d.firstpost = p.id ", array($discussionid));
2441 /**
2442  * Returns an array of counts of replies to each discussion
2443  *
2444  * @global object
2445  * @global object
2446  * @param int $forumid
2447  * @param string $forumsort
2448  * @param int $limit
2449  * @param int $page
2450  * @param int $perpage
2451  * @return array
2452  */
2453 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2454     global $CFG, $DB;
2456     if ($limit > 0) {
2457         $limitfrom = 0;
2458         $limitnum  = $limit;
2459     } else if ($page != -1) {
2460         $limitfrom = $page*$perpage;
2461         $limitnum  = $perpage;
2462     } else {
2463         $limitfrom = 0;
2464         $limitnum  = 0;
2465     }
2467     if ($forumsort == "") {
2468         $orderby = "";
2469         $groupby = "";
2471     } else {
2472         $orderby = "ORDER BY $forumsort";
2473         $groupby = ", ".strtolower($forumsort);
2474         $groupby = str_replace('desc', '', $groupby);
2475         $groupby = str_replace('asc', '', $groupby);
2476     }
2478     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2479         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2480                   FROM {forum_posts} p
2481                        JOIN {forum_discussions} d ON p.discussion = d.id
2482                  WHERE p.parent > 0 AND d.forum = ?
2483               GROUP BY p.discussion";
2484         return $DB->get_records_sql($sql, array($forumid));
2486     } else {
2487         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2488                   FROM {forum_posts} p
2489                        JOIN {forum_discussions} d ON p.discussion = d.id
2490                  WHERE d.forum = ?
2491               GROUP BY p.discussion $groupby
2492               $orderby";
2493         return $DB->get_records_sql("SELECT * FROM ($sql) sq", array($forumid), $limitfrom, $limitnum);
2494     }
2497 /**
2498  * @global object
2499  * @global object
2500  * @global object
2501  * @staticvar array $cache
2502  * @param object $forum
2503  * @param object $cm
2504  * @param object $course
2505  * @return mixed
2506  */
2507 function forum_count_discussions($forum, $cm, $course) {
2508     global $CFG, $DB, $USER;
2510     static $cache = array();
2512     $now = round(time(), -2); // db cache friendliness
2514     $params = array($course->id);
2516     if (!isset($cache[$course->id])) {
2517         if (!empty($CFG->forum_enabletimedposts)) {
2518             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2519             $params[] = $now;
2520             $params[] = $now;
2521         } else {
2522             $timedsql = "";
2523         }
2525         $sql = "SELECT f.id, COUNT(d.id) as dcount
2526                   FROM {forum} f
2527                        JOIN {forum_discussions} d ON d.forum = f.id
2528                  WHERE f.course = ?
2529                        $timedsql
2530               GROUP BY f.id";
2532         if ($counts = $DB->get_records_sql($sql, $params)) {
2533             foreach ($counts as $count) {
2534                 $counts[$count->id] = $count->dcount;
2535             }
2536             $cache[$course->id] = $counts;
2537         } else {
2538             $cache[$course->id] = array();
2539         }
2540     }
2542     if (empty($cache[$course->id][$forum->id])) {
2543         return 0;
2544     }
2546     $groupmode = groups_get_activity_groupmode($cm, $course);
2548     if ($groupmode != SEPARATEGROUPS) {
2549         return $cache[$course->id][$forum->id];
2550     }
2552     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
2553         return $cache[$course->id][$forum->id];
2554     }
2556     require_once($CFG->dirroot.'/course/lib.php');
2558     $modinfo = get_fast_modinfo($course);
2560     $mygroups = $modinfo->get_groups($cm->groupingid);
2562     // add all groups posts
2563     $mygroups[-1] = -1;
2565     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2566     $params[] = $forum->id;
2568     if (!empty($CFG->forum_enabletimedposts)) {
2569         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2570         $params[] = $now;
2571         $params[] = $now;
2572     } else {
2573         $timedsql = "";
2574     }
2576     $sql = "SELECT COUNT(d.id)
2577               FROM {forum_discussions} d
2578              WHERE d.groupid $mygroups_sql AND d.forum = ?
2579                    $timedsql";
2581     return $DB->get_field_sql($sql, $params);
2584 /**
2585  * Get all discussions in a forum
2586  *
2587  * @global object
2588  * @global object
2589  * @global object
2590  * @uses CONTEXT_MODULE
2591  * @uses VISIBLEGROUPS
2592  * @param object $cm
2593  * @param string $forumsort
2594  * @param bool $fullpost
2595  * @param int $unused
2596  * @param int $limit
2597  * @param bool $userlastmodified
2598  * @param int $page
2599  * @param int $perpage
2600  * @return array
2601  */
2602 function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
2603     global $CFG, $DB, $USER;
2605     $timelimit = '';
2607     $now = round(time(), -2);
2608     $params = array($cm->instance);
2610     $modcontext = context_module::instance($cm->id);
2612     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2613         return array();
2614     }
2616     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2618         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2619             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2620             $params[] = $now;
2621             $params[] = $now;
2622             if (isloggedin()) {
2623                 $timelimit .= " OR d.userid = ?";
2624                 $params[] = $USER->id;
2625             }
2626             $timelimit .= ")";
2627         }
2628     }
2630     if ($limit > 0) {
2631         $limitfrom = 0;
2632         $limitnum  = $limit;
2633     } else if ($page != -1) {
2634         $limitfrom = $page*$perpage;
2635         $limitnum  = $perpage;
2636     } else {
2637         $limitfrom = 0;
2638         $limitnum  = 0;
2639     }
2641     $groupmode    = groups_get_activity_groupmode($cm);
2642     $currentgroup = groups_get_activity_group($cm);
2644     if ($groupmode) {
2645         if (empty($modcontext)) {
2646             $modcontext = context_module::instance($cm->id);
2647         }
2649         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2650             if ($currentgroup) {
2651                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2652                 $params[] = $currentgroup;
2653             } else {
2654                 $groupselect = "";
2655             }
2657         } else {
2658             //seprate groups without access all
2659             if ($currentgroup) {
2660                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2661                 $params[] = $currentgroup;
2662             } else {
2663                 $groupselect = "AND d.groupid = -1";
2664             }
2665         }
2666     } else {
2667         $groupselect = "";
2668     }
2671     if (empty($forumsort)) {
2672         $forumsort = "d.timemodified DESC";
2673     }
2674     if (empty($fullpost)) {
2675         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2676     } else {
2677         $postdata = "p.*";
2678     }
2680     if (empty($userlastmodified)) {  // We don't need to know this
2681         $umfields = "";
2682         $umtable  = "";
2683     } else {
2684         $umfields = ', ' . get_all_user_name_fields(true, 'um', null, 'um');
2685         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2686     }
2688     $allnames = get_all_user_name_fields(true, 'u');
2689     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend, $allnames,
2690                    u.email, u.picture, u.imagealt $umfields
2691               FROM {forum_discussions} d
2692                    JOIN {forum_posts} p ON p.discussion = d.id
2693                    JOIN {user} u ON p.userid = u.id
2694                    $umtable
2695              WHERE d.forum = ? AND p.parent = 0
2696                    $timelimit $groupselect
2697           ORDER BY $forumsort";
2698     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2701 /**
2702  * Gets the neighbours (previous and next) of a discussion.
2703  *
2704  * The calculation is based on the timemodified of the discussion and does not handle
2705  * the neighbours having an identical timemodified. The reason is that we do not have any
2706  * other mean to sort the records, e.g. we cannot use IDs as a greater ID can have a lower
2707  * timemodified.
2708  *
2709  * Please note that this does not check whether or not the discussion passed is accessible
2710  * by the user, it simply uses it as a reference to find the neighbours. On the other hand,
2711  * the returned neighbours are checked and are accessible to the current user.
2712  *
2713  * @param object $cm The CM record.
2714  * @param object $discussion The discussion record.
2715  * @return array That always contains the keys 'prev' and 'next'. When there is a result
2716  *               they contain the record with minimal information such as 'id' and 'name'.
2717  *               When the neighbour is not found the value is false.
2718  */
2719 function forum_get_discussion_neighbours($cm, $discussion) {
2720     global $CFG, $DB, $USER;
2722     if ($cm->instance != $discussion->forum) {
2723         throw new coding_exception('Discussion is not part of the same forum.');
2724     }
2726     $neighbours = array('prev' => false, 'next' => false);
2727     $now = round(time(), -2);
2728     $params = array();
2730     $modcontext = context_module::instance($cm->id);
2731     $groupmode    = groups_get_activity_groupmode($cm);
2732     $currentgroup = groups_get_activity_group($cm);
2734     // Users must fulfill timed posts.
2735     $timelimit = '';
2736     if (!empty($CFG->forum_enabletimedposts)) {
2737         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2738             $timelimit = ' AND ((d.timestart <= :tltimestart AND (d.timeend = 0 OR d.timeend > :tltimeend))';
2739             $params['tltimestart'] = $now;
2740             $params['tltimeend'] = $now;
2741             if (isloggedin()) {
2742                 $timelimit .= ' OR d.userid = :tluserid';
2743                 $params['tluserid'] = $USER->id;
2744             }
2745             $timelimit .= ')';
2746         }
2747     }
2749     // Limiting to posts accessible according to groups.
2750     $groupselect = '';
2751     if ($groupmode) {
2752         if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $modcontext)) {
2753             if ($currentgroup) {
2754                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2755                 $params['groupid'] = $currentgroup;
2756             }
2757         } else {
2758             if ($currentgroup) {
2759                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2760                 $params['groupid'] = $currentgroup;
2761             } else {
2762                 $groupselect = 'AND d.groupid = -1';
2763             }
2764         }
2765     }
2767     $params['forumid'] = $cm->instance;
2768     $params['discid'] = $discussion->id;
2769     $params['disctimemodified'] = $discussion->timemodified;
2771     $sql = "SELECT d.id, d.name, d.timemodified, d.groupid, d.timestart, d.timeend
2772               FROM {forum_discussions} d
2773              WHERE d.forum = :forumid
2774                AND d.id <> :discid
2775                    $timelimit
2776                    $groupselect";
2778     $prevsql = $sql . " AND d.timemodified < :disctimemodified
2779                    ORDER BY d.timemodified DESC";
2781     $nextsql = $sql . " AND d.timemodified > :disctimemodified
2782                    ORDER BY d.timemodified ASC";
2784     $neighbours['prev'] = $DB->get_record_sql($prevsql, $params, IGNORE_MULTIPLE);
2785     $neighbours['next'] = $DB->get_record_sql($nextsql, $params, IGNORE_MULTIPLE);
2787     return $neighbours;
2790 /**
2791  *
2792  * @global object
2793  * @global object
2794  * @global object
2795  * @uses CONTEXT_MODULE
2796  * @uses VISIBLEGROUPS
2797  * @param object $cm
2798  * @return array
2799  */
2800 function forum_get_discussions_unread($cm) {
2801     global $CFG, $DB, $USER;
2803     $now = round(time(), -2);
2804     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2806     $params = array();
2807     $groupmode    = groups_get_activity_groupmode($cm);
2808     $currentgroup = groups_get_activity_group($cm);
2810     if ($groupmode) {
2811         $modcontext = context_module::instance($cm->id);
2813         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2814             if ($currentgroup) {
2815                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2816                 $params['currentgroup'] = $currentgroup;
2817             } else {
2818                 $groupselect = "";
2819             }
2821         } else {
2822             //separate groups without access all
2823             if ($currentgroup) {
2824                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2825                 $params['currentgroup'] = $currentgroup;
2826             } else {
2827                 $groupselect = "AND d.groupid = -1";
2828             }
2829         }
2830     } else {
2831         $groupselect = "";
2832     }
2834     if (!empty($CFG->forum_enabletimedposts)) {
2835         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2836         $params['now1'] = $now;
2837         $params['now2'] = $now;
2838     } else {
2839         $timedsql = "";
2840     }
2842     $sql = "SELECT d.id, COUNT(p.id) AS unread
2843               FROM {forum_discussions} d
2844                    JOIN {forum_posts} p     ON p.discussion = d.id
2845                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2846              WHERE d.forum = {$cm->instance}
2847                    AND p.modified >= :cutoffdate AND r.id is NULL
2848                    $groupselect
2849                    $timedsql
2850           GROUP BY d.id";
2851     $params['cutoffdate'] = $cutoffdate;
2853     if ($unreads = $DB->get_records_sql($sql, $params)) {
2854         foreach ($unreads as $unread) {
2855             $unreads[$unread->id] = $unread->unread;
2856         }
2857         return $unreads;
2858     } else {
2859         return array();
2860     }
2863 /**
2864  * @global object
2865  * @global object
2866  * @global object
2867  * @uses CONEXT_MODULE
2868  * @uses VISIBLEGROUPS
2869  * @param object $cm
2870  * @return array
2871  */
2872 function forum_get_discussions_count($cm) {
2873     global $CFG, $DB, $USER;
2875     $now = round(time(), -2);
2876     $params = array($cm->instance);
2877     $groupmode    = groups_get_activity_groupmode($cm);
2878     $currentgroup = groups_get_activity_group($cm);
2880     if ($groupmode) {
2881         $modcontext = context_module::instance($cm->id);
2883         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2884             if ($currentgroup) {
2885                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2886                 $params[] = $currentgroup;
2887             } else {
2888                 $groupselect = "";
2889             }
2891         } else {
2892             //seprate groups without access all
2893             if ($currentgroup) {
2894                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2895                 $params[] = $currentgroup;
2896             } else {
2897                 $groupselect = "AND d.groupid = -1";
2898             }
2899         }
2900     } else {
2901         $groupselect = "";
2902     }
2904     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2906     $timelimit = "";
2908     if (!empty($CFG->forum_enabletimedposts)) {
2910         $modcontext = context_module::instance($cm->id);
2912         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2913             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2914             $params[] = $now;
2915             $params[] = $now;
2916             if (isloggedin()) {
2917                 $timelimit .= " OR d.userid = ?";
2918                 $params[] = $USER->id;
2919             }
2920             $timelimit .= ")";
2921         }
2922     }
2924     $sql = "SELECT COUNT(d.id)
2925               FROM {forum_discussions} d
2926                    JOIN {forum_posts} p ON p.discussion = d.id
2927              WHERE d.forum = ? AND p.parent = 0
2928                    $groupselect $timelimit";
2930     return $DB->get_field_sql($sql, $params);
2934 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2937 /**
2938  * @global object
2939  * @global object
2940  * @param int $courseid
2941  * @param string $type
2942  */
2943 function forum_get_course_forum($courseid, $type) {
2944 // How to set up special 1-per-course forums
2945     global $CFG, $DB, $OUTPUT, $USER;
2947     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
2948         // There should always only be ONE, but with the right combination of
2949         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2950         foreach ($forums as $forum) {
2951             return $forum;   // ie the first one
2952         }
2953     }
2955     // Doesn't exist, so create one now.
2956     $forum = new stdClass();
2957     $forum->course = $courseid;
2958     $forum->type = "$type";
2959     if (!empty($USER->htmleditor)) {
2960         $forum->introformat = $USER->htmleditor;
2961     }
2962     switch ($forum->type) {
2963         case "news":
2964             $forum->name  = get_string("namenews", "forum");
2965             $forum->intro = get_string("intronews", "forum");
2966             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2967             $forum->assessed = 0;
2968             if ($courseid == SITEID) {
2969                 $forum->name  = get_string("sitenews");
2970                 $forum->forcesubscribe = 0;
2971             }
2972             break;
2973         case "social":
2974             $forum->name  = get_string("namesocial", "forum");
2975             $forum->intro = get_string("introsocial", "forum");
2976             $forum->assessed = 0;
2977             $forum->forcesubscribe = 0;
2978             break;
2979         case "blog":
2980             $forum->name = get_string('blogforum', 'forum');
2981             $forum->intro = get_string('introblog', 'forum');
2982             $forum->assessed = 0;
2983             $forum->forcesubscribe = 0;
2984             break;
2985         default:
2986             echo $OUTPUT->notification("That forum type doesn't exist!");
2987             return false;
2988             break;
2989     }
2991     $forum->timemodified = time();
2992     $forum->id = $DB->insert_record("forum", $forum);
2994     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
2995         echo $OUTPUT->notification("Could not find forum module!!");
2996         return false;
2997     }
2998     $mod = new stdClass();
2999     $mod->course = $courseid;
3000     $mod->module = $module->id;
3001     $mod->instance = $forum->id;
3002     $mod->section = 0;
3003     include_once("$CFG->dirroot/course/lib.php");
3004     if (! $mod->coursemodule = add_course_module($mod) ) {
3005         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
3006         return false;
3007     }
3008     $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
3009     return $DB->get_record("forum", array("id" => "$forum->id"));
3013 /**
3014  * Given the data about a posting, builds up the HTML to display it and
3015  * returns the HTML in a string.  This is designed for sending via HTML email.
3016  *
3017  * @global object
3018  * @param object $course
3019  * @param object $cm
3020  * @param object $forum
3021  * @param object $discussion
3022  * @param object $post
3023  * @param object $userform
3024  * @param object $userto
3025  * @param bool $ownpost
3026  * @param bool $reply
3027  * @param bool $link
3028  * @param bool $rate
3029  * @param string $footer
3030  * @return string
3031  */
3032 function forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
3033                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
3035     global $CFG, $OUTPUT;
3037     $modcontext = context_module::instance($cm->id);
3039     if (!isset($userto->viewfullnames[$forum->id])) {
3040         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
3041     } else {
3042         $viewfullnames = $userto->viewfullnames[$forum->id];
3043     }
3045     // add absolute file links
3046     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3048     // format the post body
3049     $options = new stdClass();
3050     $options->para = true;
3051     $formattedtext = format_text($post->message, $post->messageformat, $options, $course->id);
3053     $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
3055     $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
3056     $output .= $OUTPUT->user_picture($userfrom, array('courseid'=>$course->id));
3057     $output .= '</td>';
3059     if ($post->parent) {
3060         $output .= '<td class="topic">';
3061     } else {
3062         $output .= '<td class="topic starter">';
3063     }
3064     $output .= '<div class="subject">'.format_string($post->subject).'</div>';
3066     $fullname = fullname($userfrom, $viewfullnames);
3067     $by = new stdClass();
3068     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
3069     $by->date = userdate($post->modified, '', $userto->timezone);
3070     $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
3072     $output .= '</td></tr>';
3074     $output .= '<tr><td class="left side" valign="top">';
3076     if (isset($userfrom->groups)) {
3077         $groups = $userfrom->groups[$forum->id];
3078     } else {
3079         $groups = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
3080     }
3082     if ($groups) {
3083         $output .= print_group_picture($groups, $course->id, false, true, true);
3084     } else {
3085         $output .= '&nbsp;';
3086     }
3088     $output .= '</td><td class="content">';
3090     $attachments = forum_print_attachments($post, $cm, 'html');
3091     if ($attachments !== '') {
3092         $output .= '<div class="attachments">';
3093         $output .= $attachments;
3094         $output .= '</div>';
3095     }
3097     $output .= $formattedtext;
3099 // Commands
3100     $commands = array();
3102     if ($post->parent) {
3103         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
3104                       $post->discussion.'&amp;parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
3105     }
3107     if ($reply) {
3108         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
3109                       get_string('reply', 'forum').'</a>';
3110     }
3112     $output .= '<div class="commands">';
3113     $output .= implode(' | ', $commands);
3114     $output .= '</div>';
3116 // Context link to post if required
3117     if ($link) {
3118         $output .= '<div class="link">';
3119         $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
3120                      get_string('postincontext', 'forum').'</a>';
3121         $output .= '</div>';
3122     }
3124     if ($footer) {
3125         $output .= '<div class="footer">'.$footer.'</div>';
3126     }
3127     $output .= '</td></tr></table>'."\n\n";
3129     return $output;
3132 /**
3133  * Print a forum post
3134  *
3135  * @global object
3136  * @global object
3137  * @uses FORUM_MODE_THREADED
3138  * @uses PORTFOLIO_FORMAT_PLAINHTML
3139  * @uses PORTFOLIO_FORMAT_FILE
3140  * @uses PORTFOLIO_FORMAT_RICHHTML
3141  * @uses PORTFOLIO_ADD_TEXT_LINK
3142  * @uses CONTEXT_MODULE
3143  * @param object $post The post to print.
3144  * @param object $discussion
3145  * @param object $forum
3146  * @param object $cm
3147  * @param object $course
3148  * @param boolean $ownpost Whether this post belongs to the current user.
3149  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3150  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3151  * @param string $footer Extra stuff to print after the message.
3152  * @param string $highlight Space-separated list of terms to highlight.
3153  * @param int $post_read true, false or -99. If we already know whether this user
3154  *          has read this post, pass that in, otherwise, pass in -99, and this
3155  *          function will work it out.
3156  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3157  *          the current user can't see this post, if this argument is true
3158  *          (the default) then print a dummy 'you can't see this post' post.
3159  *          If false, don't output anything at all.
3160  * @param bool|null $istracked
3161  * @return void
3162  */
3163 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3164                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3165     global $USER, $CFG, $OUTPUT;
3167     require_once($CFG->libdir . '/filelib.php');
3169     // String cache
3170     static $str;
3172     $modcontext = context_module::instance($cm->id);
3174     $post->course = $course->id;
3175     $post->forum  = $forum->id;
3176     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3177     if (!empty($CFG->enableplagiarism)) {
3178         require_once($CFG->libdir.'/plagiarismlib.php');
3179         $post->message .= plagiarism_get_links(array('userid' => $post->userid,
3180             'content' => $post->message,
3181             'cmid' => $cm->id,
3182             'course' => $post->course,
3183             'forum' => $post->forum));
3184     }
3186     // caching
3187     if (!isset($cm->cache)) {
3188         $cm->cache = new stdClass;
3189     }
3191     if (!isset($cm->cache->caps)) {
3192         $cm->cache->caps = array();
3193         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3194         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3195         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3196         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3197         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3198         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3199         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3200         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3201         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3202     }
3204     if (!isset($cm->uservisible)) {
3205         $cm->uservisible = \core_availability\info_module::is_user_visible($cm, 0, false);
3206     }
3208     if ($istracked && is_null($postisread)) {
3209         $postisread = forum_tp_is_post_read($USER->id, $post);
3210     }
3212     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
3213         $output = '';
3214         if (!$dummyifcantsee) {
3215             if ($return) {
3216                 return $output;
3217             }
3218             echo $output;
3219             return;
3220         }
3221         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3222         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix',
3223                                                        'role' => 'region',
3224                                                        'aria-label' => get_string('hiddenforumpost', 'forum')));
3225         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3226         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3227         if ($post->parent) {
3228             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3229         } else {
3230             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3231         }
3232         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class' => 'subject',
3233                                                                                            'role' => 'header')); // Subject.
3234         $output .= html_writer::tag('div', get_string('forumauthorhidden', 'forum'), array('class' => 'author',
3235                                                                                            'role' => 'header')); // Author.
3236         $output .= html_writer::end_tag('div');
3237         $output .= html_writer::end_tag('div'); // row
3238         $output .= html_writer::start_tag('div', array('class'=>'row'));
3239         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3240         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3241         $output .= html_writer::end_tag('div'); // row
3242         $output .= html_writer::end_tag('div'); // forumpost
3244         if ($return) {
3245             return $output;
3246         }
3247         echo $output;
3248         return;
3249     }
3251     if (empty($str)) {
3252         $str = new stdClass;
3253         $str->edit         = get_string('edit', 'forum');
3254         $str->delete       = get_string('delete', 'forum');
3255         $str->reply        = get_string('reply', 'forum');
3256         $str->parent       = get_string('parent', 'forum');
3257         $str->pruneheading = get_string('pruneheading', 'forum');
3258         $str->prune        = get_string('prune', 'forum');
3259         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3260         $str->markread     = get_string('markread', 'forum');
3261         $str->markunread   = get_string('markunread', 'forum');
3262     }
3264     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3266     // Build an object that represents the posting user
3267     $postuser = new stdClass;
3268     $postuserfields = explode(',', user_picture::fields());
3269     $postuser = username_load_fields_from_object($postuser, $post, null, $postuserfields);
3270     $postuser->id = $post->userid;
3271     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3272     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3274     // Prepare the groups the posting user belongs to
3275     if (isset($cm->cache->usersgroups)) {
3276         $groups = array();
3277         if (isset($cm->cache->usersgroups[$post->userid])) {
3278             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3279                 $groups[$gid] = $cm->cache->groups[$gid];
3280             }
3281         }
3282     } else {
3283         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3284     }
3286     // Prepare the attachements for the post, files then images
3287     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3289     // Determine if we need to shorten this post
3290     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3293     // Prepare an array of commands
3294     $commands = array();
3296     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3297     // Don't display the mark read / unread controls in this case.
3298     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3299         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3300         $text = $str->markunread;
3301         if (!$postisread) {
3302             $url->param('mark', 'read');
3303             $text = $str->markread;
3304         }
3305         if ($str->displaymode == FORUM_MODE_THREADED) {
3306             $url->param('parent', $post->parent);
3307         } else {
3308             $url->set_anchor('p'.$post->id);
3309         }
3310         $commands[] = array('url'=>$url, 'text'=>$text);
3311     }
3313     // Zoom in to the parent specifically
3314     if ($post->parent) {
3315         $url = new moodle_url($discussionlink);
3316         if ($str->displaymode == FORUM_MODE_THREADED) {
3317             $url->param('parent', $post->parent);
3318         } else {
3319             $url->set_anchor('p'.$post->parent);
3320         }
3321         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3322     }
3324     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3325     $age = time() - $post->created;
3326     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3327         $age = 0;
3328     }
3330     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3331         if (has_capability('moodle/course:manageactivities', $modcontext)) {
3332             // The first post in single simple is the forum description.
3333             $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
3334         }
3335     } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3336         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3337     }
3339     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3340         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3341     }
3343     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3344         // Do not allow deleting of first post in single simple type.
3345     } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3346         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3347     }
3349     if ($reply) {
3350         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
3351     }
3353     if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
3354         $p = array('postid' => $post->id);
3355         require_once($CFG->libdir.'/portfoliolib.php');
3356         $button = new portfolio_add_button();
3357         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
3358         if (empty($attachments)) {
3359             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3360         } else {
3361             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3362         }
3364         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3365         if (!empty($porfoliohtml)) {
3366             $commands[] = $porfoliohtml;
3367         }
3368     }
3369     // Finished building commands
3372     // Begin output
3374     $output  = '';
3376     if ($istracked) {
3377         if ($postisread) {
3378             $forumpostclass = ' read';
3379         } else {
3380             $forumpostclass = ' unread';
3381             $output .= html_writer::tag('a', '', array('name'=>'unread'));
3382         }
3383     } else {
3384         // ignore trackign status if not tracked or tracked param missing
3385         $forumpostclass = '';
3386     }
3388     $topicclass = '';
3389     if (empty($post->parent)) {
3390         $topicclass = ' firstpost starter';
3391     }
3393     $postbyuser = new stdClass;
3394     $postbyuser->post = $post->subject;
3395     $postbyuser->user = $postuser->fullname;
3396     $discussionbyuser = get_string('postbyuser', 'forum', $postbyuser);
3397     $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3398     $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass,
3399                                                    'role' => 'region',
3400                                                    'aria-label' => $discussionbyuser));
3401     $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
3402     $output .= html_writer::start_tag('div', array('class'=>'left picture'));
3403     $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
3404     $output .= html_writer::end_tag('div');
3407     $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
3409     $postsubject = $post->subject;
3410     if (empty($post->subjectnoformat)) {
3411         $postsubject = format_string($postsubject);
3412     }
3413     $output .= html_writer::tag('div', $postsubject, array('class'=>'subject',
3414                                                            'role' => 'heading',
3415                                                            'aria-level' => '2'));
3417     $by = new stdClass();
3418     $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
3419     $by->date = userdate($post->modified);
3420     $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author',
3421                                                                                        'role' => 'heading',
3422                                                                                        'aria-level' => '2'));
3424     $output .= html_writer::end_tag('div'); //topic
3425     $output .= html_writer::end_tag('div'); //row
3427     $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
3428     $output .= html_writer::start_tag('div', array('class'=>'left'));
3430     $groupoutput = '';
3431     if ($groups) {
3432         $groupoutput = print_group_picture($groups, $course->id, false, true, true);
3433     }
3434     if (empty($groupoutput)) {
3435         $groupoutput = '&nbsp;';
3436     }
3437     $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
3439     $output .= html_writer::end_tag('div'); //left side
3440     $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
3441     $output .= html_writer::start_tag('div', array('class'=>'content'));
3443     $options = new stdClass;
3444     $options->para    = false;
3445     $options->trusted = $post->messagetrust;
3446     $options->context = $modcontext;
3447     if ($shortenpost) {
3448         // Prepare shortened version by filtering the text then shortening it.
3449         $postclass    = 'shortenedpost';
3450         $postcontent  = format_text($post->message, $post->messageformat, $options);
3451         $postcontent  = shorten_text($postcontent, $CFG->forum_shortpost);
3452         $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
3453         $postcontent .= html_writer::tag('div', '('.get_string('numwords', 'moodle', count_words($post->message)).')',
3454             array('class'=>'post-word-count'));
3455     } else {
3456         // Prepare whole post
3457         $postclass    = 'fullpost';
3458         $postcontent  = format_text($post->message, $post->messageformat, $options, $course->id);
3459         if (!empty($highlight)) {
3460             $postcontent = highlight($highlight, $postcontent);
3461         }
3462         if (!empty($forum->displaywordcount)) {
3463             $postcontent .= html_writer::tag('div', get_string('numwords', 'moodle', count_words($post->message)),
3464                 array('class'=>'post-word-count'));
3465         }
3466         $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));