Merge branch 'MDL-48054-master' of git://github.com/andrewnicols/moodle
[moodle.git] / mod / forum / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * @package   mod_forum
19  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
20  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21  */
23 defined('MOODLE_INTERNAL') || die();
25 /** Include required files */
26 require_once(__DIR__ . '/deprecatedlib.php');
27 require_once($CFG->libdir.'/filelib.php');
28 require_once($CFG->libdir.'/eventslib.php');
30 /// CONSTANTS ///////////////////////////////////////////////////////////
32 define('FORUM_MODE_FLATOLDEST', 1);
33 define('FORUM_MODE_FLATNEWEST', -1);
34 define('FORUM_MODE_THREADED', 2);
35 define('FORUM_MODE_NESTED', 3);
37 define('FORUM_CHOOSESUBSCRIBE', 0);
38 define('FORUM_FORCESUBSCRIBE', 1);
39 define('FORUM_INITIALSUBSCRIBE', 2);
40 define('FORUM_DISALLOWSUBSCRIBE',3);
42 /**
43  * FORUM_TRACKING_OFF - Tracking is not available for this forum.
44  */
45 define('FORUM_TRACKING_OFF', 0);
47 /**
48  * FORUM_TRACKING_OPTIONAL - Tracking is based on user preference.
49  */
50 define('FORUM_TRACKING_OPTIONAL', 1);
52 /**
53  * FORUM_TRACKING_FORCED - Tracking is on, regardless of user setting.
54  * Treated as FORUM_TRACKING_OPTIONAL if $CFG->forum_allowforcedreadtracking is off.
55  */
56 define('FORUM_TRACKING_FORCED', 2);
58 define('FORUM_MAILED_PENDING', 0);
59 define('FORUM_MAILED_SUCCESS', 1);
60 define('FORUM_MAILED_ERROR', 2);
62 if (!defined('FORUM_CRON_USER_CACHE')) {
63     /** Defines how many full user records are cached in forum cron. */
64     define('FORUM_CRON_USER_CACHE', 5000);
65 }
67 /// 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             // Caching subscribed users of each forum.
548             if (!isset($subscribedusers[$forumid])) {
549                 $modcontext = context_module::instance($coursemodules[$forumid]->id);
550                 if ($subusers = \mod_forum\subscriptions::fetch_subscribed_users($forums[$forumid], 0, $modcontext, 'u.*', true)) {
552                     // Save the Inbound Message datakey here to reduce DB queries later.
553                     $messageinboundgenerator->set_data($pid);
554                     $messageinboundhandlers[$pid] = $messageinboundgenerator->fetch_data_key();
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                     'Precedence: Bulk',
739                     'List-Id: "'        . $cleanforumname . '" <moodleforum' . $forum->id . '@' . $hostname.'>',
740                     'List-Help: '       . $CFG->wwwroot . '/mod/forum/view.php?f=' . $forum->id,
741                     'Message-ID: '      . forum_get_email_message_id($post->id, $userto->id, $hostname),
742                     'X-Course-Id: '     . $course->id,
743                     'X-Course-Name: '   . format_string($course->fullname, true)
744                 );
746                 if ($post->parent) {
747                     // This post is a reply, so add headers for threading (see MDL-22551).
748                     $userfrom->customheaders[] = 'In-Reply-To: ' . forum_get_email_message_id($post->parent, $userto->id, $hostname);
749                     $userfrom->customheaders[] = 'References: '  . forum_get_email_message_id($post->parent, $userto->id, $hostname);
750                 }
752                 $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
754                 // Generate a reply-to address from using the Inbound Message handler.
755                 $replyaddress = null;
756                 if ($userto->canpost[$discussion->id] && array_key_exists($post->id, $messageinboundhandlers)) {
757                     $messageinboundgenerator->set_data($post->id, $messageinboundhandlers[$post->id]);
758                     $replyaddress = $messageinboundgenerator->generate($userto->id);
759                 }
761                 $a = new stdClass();
762                 $a->courseshortname = $shortname;
763                 $a->forumname = $cleanforumname;
764                 $a->subject = format_string($post->subject, true);
765                 $postsubject = html_to_text(get_string('postmailsubject', 'forum', $a));
766                 $posttext = forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false,
767                         $replyaddress);
768                 $posthtml = forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
769                         $replyaddress);
771                 // Send the post now!
772                 mtrace('Sending ', '');
774                 $eventdata = new stdClass();
775                 $eventdata->component           = 'mod_forum';
776                 $eventdata->name                = 'posts';
777                 $eventdata->userfrom            = $userfrom;
778                 $eventdata->userto              = $userto;
779                 $eventdata->subject             = $postsubject;
780                 $eventdata->fullmessage         = $posttext;
781                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
782                 $eventdata->fullmessagehtml     = $posthtml;
783                 $eventdata->notification        = 1;
784                 $eventdata->replyto             = $replyaddress;
786                 // If forum_replytouser is not set then send mail using the noreplyaddress.
787                 if (empty($CFG->forum_replytouser)) {
788                     // Clone userfrom as it is referenced by $users.
789                     $cloneduserfrom = clone($userfrom);
790                     $cloneduserfrom->email = $CFG->noreplyaddress;
791                     $eventdata->userfrom = $cloneduserfrom;
792                 }
794                 $smallmessagestrings = new stdClass();
795                 $smallmessagestrings->user          = fullname($userfrom);
796                 $smallmessagestrings->forumname     = "$shortname: " . format_string($forum->name, true) . ": " . $discussion->name;
797                 $smallmessagestrings->message       = $post->message;
799                 // Make sure strings are in message recipients language.
800                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
802                 $contexturl = new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id), 'p' . $post->id);
803                 $eventdata->contexturl = $contexturl->out();
804                 $eventdata->contexturlname = $discussion->name;
806                 $mailresult = message_send($eventdata);
807                 if (!$mailresult) {
808                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
809                             " ($userto->email) .. not trying again.");
810                     $errorcount[$post->id]++;
811                 } else {
812                     $mailcount[$post->id]++;
814                     // Mark post as read if forum_usermarksread is set off.
815                     if (!$CFG->forum_usermarksread) {
816                         $userto->markposts[$post->id] = $post->id;
817                     }
818                 }
820                 mtrace('post ' . $post->id . ': ' . $post->subject);
821             }
823             // Mark processed posts as read.
824             forum_tp_mark_posts_read($userto, $userto->markposts);
825             unset($userto);
826         }
827     }
829     if ($posts) {
830         foreach ($posts as $post) {
831             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
832             if ($errorcount[$post->id]) {
833                 $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
834             }
835         }
836     }
838     // release some memory
839     unset($subscribedusers);
840     unset($mailcount);
841     unset($errorcount);
843     cron_setup_user();
845     $sitetimezone = $CFG->timezone;
847     // Now see if there are any digest mails waiting to be sent, and if we should send them
849     mtrace('Starting digest processing...');
851     core_php_time_limit::raise(300); // terminate if not able to fetch all digests in 5 minutes
853     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
854         set_config('digestmailtimelast', 0);
855     }
857     $timenow = time();
858     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
860     // Delete any really old ones (normally there shouldn't be any)
861     $weekago = $timenow - (7 * 24 * 3600);
862     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
863     mtrace ('Cleaned old digest records');
865     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
867         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
869         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
871         if ($digestposts_rs->valid()) {
873             // We have work to do
874             $usermailcount = 0;
876             //caches - reuse the those filled before too
877             $discussionposts = array();
878             $userdiscussions = array();
880             foreach ($digestposts_rs as $digestpost) {
881                 if (!isset($posts[$digestpost->postid])) {
882                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
883                         $posts[$digestpost->postid] = $post;
884                     } else {
885                         continue;
886                     }
887                 }
888                 $discussionid = $digestpost->discussionid;
889                 if (!isset($discussions[$discussionid])) {
890                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
891                         $discussions[$discussionid] = $discussion;
892                     } else {
893                         continue;
894                     }
895                 }
896                 $forumid = $discussions[$discussionid]->forum;
897                 if (!isset($forums[$forumid])) {
898                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
899                         $forums[$forumid] = $forum;
900                     } else {
901                         continue;
902                     }
903                 }
905                 $courseid = $forums[$forumid]->course;
906                 if (!isset($courses[$courseid])) {
907                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
908                         $courses[$courseid] = $course;
909                     } else {
910                         continue;
911                     }
912                 }
914                 if (!isset($coursemodules[$forumid])) {
915                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
916                         $coursemodules[$forumid] = $cm;
917                     } else {
918                         continue;
919                     }
920                 }
921                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
922                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
923             }
924             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
926             // Data collected, start sending out emails to each user
927             foreach ($userdiscussions as $userid => $thesediscussions) {
929                 core_php_time_limit::raise(120); // terminate if processing of any account takes longer than 2 minutes
931                 cron_setup_user();
933                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
935                 // First of all delete all the queue entries for this user
936                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
938                 // Init user caches - we keep the cache for one cycle only,
939                 // otherwise it would unnecessarily consume memory.
940                 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
941                     $userto = clone($users[$userid]);
942                 } else {
943                     $userto = $DB->get_record('user', array('id' => $userid));
944                     forum_cron_minimise_user_record($userto);
945                 }
946                 $userto->viewfullnames = array();
947                 $userto->canpost       = array();
948                 $userto->markposts     = array();
950                 // Override the language and timezone of the "current" user, so that
951                 // mail is customised for the receiver.
952                 cron_setup_user($userto);
954                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
956                 $headerdata = new stdClass();
957                 $headerdata->sitename = format_string($site->fullname, true);
958                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
960                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
961                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
963                 $posthtml = "<head>";
964 /*                foreach ($CFG->stylesheets as $stylesheet) {
965                     //TODO: MDL-21120
966                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
967                 }*/
968                 $posthtml .= "</head>\n<body id=\"email\">\n";
969                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
971                 foreach ($thesediscussions as $discussionid) {
973                     core_php_time_limit::raise(120);   // to be reset for each post
975                     $discussion = $discussions[$discussionid];
976                     $forum      = $forums[$discussion->forum];
977                     $course     = $courses[$forum->course];
978                     $cm         = $coursemodules[$forum->id];
980                     //override language
981                     cron_setup_user($userto, $course);
983                     // Fill caches
984                     if (!isset($userto->viewfullnames[$forum->id])) {
985                         $modcontext = context_module::instance($cm->id);
986                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
987                     }
988                     if (!isset($userto->canpost[$discussion->id])) {
989                         $modcontext = context_module::instance($cm->id);
990                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
991                     }
993                     $strforums      = get_string('forums', 'forum');
994                     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
995                     $canreply       = $userto->canpost[$discussion->id];
996                     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
998                     $posttext .= "\n \n";
999                     $posttext .= '=====================================================================';
1000                     $posttext .= "\n \n";
1001                     $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1002                     if ($discussion->name != $forum->name) {
1003                         $posttext  .= " -> ".format_string($discussion->name,true);
1004                     }
1005                     $posttext .= "\n";
1006                     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1007                     $posttext .= "\n";
1009                     $posthtml .= "<p><font face=\"sans-serif\">".
1010                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
1011                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
1012                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
1013                     if ($discussion->name == $forum->name) {
1014                         $posthtml .= "</font></p>";
1015                     } else {
1016                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
1017                     }
1018                     $posthtml .= '<p>';
1020                     $postsarray = $discussionposts[$discussionid];
1021                     sort($postsarray);
1023                     foreach ($postsarray as $postid) {
1024                         $post = $posts[$postid];
1026                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
1027                             $userfrom = $users[$post->userid];
1028                             if (!isset($userfrom->idnumber)) {
1029                                 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
1030                                 forum_cron_minimise_user_record($userfrom);
1031                             }
1033                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
1034                             forum_cron_minimise_user_record($userfrom);
1035                             if ($userscount <= FORUM_CRON_USER_CACHE) {
1036                                 $userscount++;
1037                                 $users[$userfrom->id] = $userfrom;
1038                             }
1040                         } else {
1041                             mtrace('Could not find user '.$post->userid);
1042                             continue;
1043                         }
1045                         if (!isset($userfrom->groups[$forum->id])) {
1046                             if (!isset($userfrom->groups)) {
1047                                 $userfrom->groups = array();
1048                                 if (isset($users[$userfrom->id])) {
1049                                     $users[$userfrom->id]->groups = array();
1050                                 }
1051                             }
1052                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
1053                             if (isset($users[$userfrom->id])) {
1054                                 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
1055                             }
1056                         }
1058                         $userfrom->customheaders = array ("Precedence: Bulk");
1060                         $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
1061                         if ($maildigest == 2) {
1062                             // Subjects and link only
1063                             $posttext .= "\n";
1064                             $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1065                             $by = new stdClass();
1066                             $by->name = fullname($userfrom);
1067                             $by->date = userdate($post->modified);
1068                             $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
1069                             $posttext .= "\n---------------------------------------------------------------------";
1071                             $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&amp;course=$course->id\">$by->name</a>";
1072                             $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>';
1074                         } else {
1075                             // The full treatment
1076                             $posttext .= forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, true);
1077                             $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1079                         // Create an array of postid's for this user to mark as read.
1080                             if (!$CFG->forum_usermarksread) {
1081                                 $userto->markposts[$post->id] = $post->id;
1082                             }
1083                         }
1084                     }
1085                     $footerlinks = array();
1086                     if ($canunsubscribe) {
1087                         $footerlinks[] = "<a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">" . get_string("unsubscribe", "forum") . "</a>";
1088                     } else {
1089                         $footerlinks[] = get_string("everyoneissubscribed", "forum");
1090                     }
1091                     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string("digestmailpost", "forum") . '</a>';
1092                     $posthtml .= "\n<div class='mdl-right'><font size=\"1\">" . implode('&nbsp;', $footerlinks) . '</font></div>';
1093                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
1094                 }
1095                 $posthtml .= '</body>';
1097                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
1098                     // This user DOESN'T want to receive HTML
1099                     $posthtml = '';
1100                 }
1102                 $attachment = $attachname='';
1103                 // Directly email forum digests rather than sending them via messaging, use the
1104                 // site shortname as 'from name', the noreply address will be used by email_to_user.
1105                 $mailresult = email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml, $attachment, $attachname);
1107                 if (!$mailresult) {
1108                     mtrace("ERROR: mod/forum/cron.php: Could not send out digest mail to user $userto->id ".
1109                         "($userto->email)... not trying again.");
1110                 } else {
1111                     mtrace("success.");
1112                     $usermailcount++;
1114                     // Mark post as read if forum_usermarksread is set off
1115                     forum_tp_mark_posts_read($userto, $userto->markposts);
1116                 }
1117             }
1118         }
1119     /// We have finishied all digest emails, update $CFG->digestmailtimelast
1120         set_config('digestmailtimelast', $timenow);
1121     }
1123     cron_setup_user();
1125     if (!empty($usermailcount)) {
1126         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
1127     }
1129     if (!empty($CFG->forum_lastreadclean)) {
1130         $timenow = time();
1131         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1132             set_config('forum_lastreadclean', $timenow);
1133             mtrace('Removing old forum read tracking info...');
1134             forum_tp_clean_read_records();
1135         }
1136     } else {
1137         set_config('forum_lastreadclean', time());
1138     }
1140     return true;
1143 /**
1144  * Builds and returns the body of the email notification in plain text.
1145  *
1146  * @global object
1147  * @global object
1148  * @uses CONTEXT_MODULE
1149  * @param object $course
1150  * @param object $cm
1151  * @param object $forum
1152  * @param object $discussion
1153  * @param object $post
1154  * @param object $userfrom
1155  * @param object $userto
1156  * @param boolean $bare
1157  * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
1158  * @return string The email body in plain text format.
1159  */
1160 function forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $bare = false, $replyaddress = null) {
1161     global $CFG, $USER;
1163     $modcontext = context_module::instance($cm->id);
1165     if (!isset($userto->viewfullnames[$forum->id])) {
1166         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1167     } else {
1168         $viewfullnames = $userto->viewfullnames[$forum->id];
1169     }
1171     if (!isset($userto->canpost[$discussion->id])) {
1172         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1173     } else {
1174         $canreply = $userto->canpost[$discussion->id];
1175     }
1177     $by = New stdClass;
1178     $by->name = fullname($userfrom, $viewfullnames);
1179     $by->date = userdate($post->modified, "", $userto->timezone);
1181     $strbynameondate = get_string('bynameondate', 'forum', $by);
1183     $strforums = get_string('forums', 'forum');
1185     $canunsubscribe = !\mod_forum\subscriptions::is_forcesubscribed($forum);
1187     $posttext = '';
1189     if ($replyaddress) {
1190         $posttext .= "--" . get_string('deleteoriginalonreply', 'mod_forum') . "--\n";
1191     }
1193     if (!$bare) {
1194         $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1195         $posttext  = "$shortname -> $strforums -> ".format_string($forum->name,true);
1197         if ($discussion->name != $forum->name) {
1198             $posttext  .= " -> ".format_string($discussion->name,true);
1199         }
1200     }
1202     // add absolute file links
1203     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
1205     $posttext .= "\n";
1206     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1207     $posttext .= "\n---------------------------------------------------------------------\n";
1208     $posttext .= format_string($post->subject,true);
1209     if ($bare) {
1210         $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
1211     }
1212     $posttext .= "\n".$strbynameondate."\n";
1213     $posttext .= "---------------------------------------------------------------------\n";
1214     $posttext .= format_text_email($post->message, $post->messageformat);
1215     $posttext .= "\n\n";
1216     $posttext .= forum_print_attachments($post, $cm, "text");
1218     if (!$bare) {
1219         if ($canreply) {
1220             $posttext .= "---------------------------------------------------------------------\n";
1221             $posttext .= get_string("postmailinfo", "forum", $shortname)."\n";
1222             $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
1223         }
1225         if ($canunsubscribe) {
1226             if (\mod_forum\subscriptions::is_subscribed($userto->id, $forum, null, $cm)) {
1227                 // If subscribed to this forum, offer the unsubscribe link.
1228                 $posttext .= "\n---------------------------------------------------------------------\n";
1229                 $posttext .= get_string("unsubscribe", "forum");
1230                 $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
1231             }
1232             // Always offer the unsubscribe from discussion link.
1233             $posttext .= "\n---------------------------------------------------------------------\n";
1234             $posttext .= get_string("unsubscribediscussion", "forum");
1235             $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?d=$discussion->id\n";
1236         }
1237     }
1239     $posttext .= "\n---------------------------------------------------------------------\n";
1240     $posttext .= get_string("digestmailpost", "forum");
1241     $posttext .= ": {$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}\n";
1243     if ($replyaddress) {
1244         $posttext .= "\n\n" . get_string('replytoforumpost', 'mod_forum');
1245     }
1247     return $posttext;
1250 /**
1251  * Builds and returns the body of the email notification in html format.
1252  *
1253  * @global object
1254  * @param object $course
1255  * @param object $cm
1256  * @param object $forum
1257  * @param object $discussion
1258  * @param object $post
1259  * @param object $userfrom
1260  * @param object $userto
1261  * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
1262  * @return string The email text in HTML format
1263  */
1264 function forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $replyaddress = null) {
1265     global $CFG;
1267     if ($userto->mailformat != 1) {  // Needs to be HTML
1268         return '';
1269     }
1271     if (!isset($userto->canpost[$discussion->id])) {
1272         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course);
1273     } else {
1274         $canreply = $userto->canpost[$discussion->id];
1275     }
1277     $strforums = get_string('forums', 'forum');
1278     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
1279     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1281     $posthtml = '<head>';
1282 /*    foreach ($CFG->stylesheets as $stylesheet) {
1283         //TODO: MDL-21120
1284         $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
1285     }*/
1286     $posthtml .= '</head>';
1287     $posthtml .= "\n<body id=\"email\">\n\n";
1289     if ($replyaddress) {
1290         $posttext .= "<p><em>--" . get_string('deleteoriginalonreply', 'mod_forum') . "--</em></p>";
1291     }
1293     $posthtml .= '<div class="navbar">'.
1294     '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$shortname.'</a> &raquo; '.
1295     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> &raquo; '.
1296     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
1297     if ($discussion->name == $forum->name) {
1298         $posthtml .= '</div>';
1299     } else {
1300         $posthtml .= ' &raquo; <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
1301                      format_string($discussion->name,true).'</a></div>';
1302     }
1303     $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1305     if ($replyaddress) {
1306         $posthtml .= html_writer::tag('p', get_string('replytoforumpost', 'mod_forum'));
1307     }
1309     $footerlinks = array();
1310     if ($canunsubscribe) {
1311         if (\mod_forum\subscriptions::is_subscribed($userto->id, $forum, null, $cm)) {
1312             // If subscribed to this forum, offer the unsubscribe link.
1313             $unsublink = new moodle_url('/mod/forum/subscribe.php', array('id' => $forum->id));
1314             $footerlinks[] = html_writer::link($unsublink, get_string('unsubscribe', 'mod_forum'));
1315         }
1316         // Always offer the unsubscribe from discussion link.
1317         $unsublink = new moodle_url('/mod/forum/subscribe.php', array('d' => $discussion->id));
1318         $footerlinks[] = html_writer::link($unsublink, get_string('unsubscribediscussion', 'mod_forum'));
1320         $footerlinks[] = '<a href="' . $CFG->wwwroot . '/mod/forum/unsubscribeall.php">' . get_string('unsubscribeall', 'forum') . '</a>';
1321     }
1322     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string('digestmailpost', 'forum') . '</a>';
1323     $posthtml .= '<hr /><div class="mdl-align unsubscribelink">' . implode('&nbsp;', $footerlinks) . '</div>';
1325     $posthtml .= '</body>';
1327     return $posthtml;
1331 /**
1332  *
1333  * @param object $course
1334  * @param object $user
1335  * @param object $mod TODO this is not used in this function, refactor
1336  * @param object $forum
1337  * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
1338  */
1339 function forum_user_outline($course, $user, $mod, $forum) {
1340     global $CFG;
1341     require_once("$CFG->libdir/gradelib.php");
1342     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1343     if (empty($grades->items[0]->grades)) {
1344         $grade = false;
1345     } else {
1346         $grade = reset($grades->items[0]->grades);
1347     }
1349     $count = forum_count_user_posts($forum->id, $user->id);
1351     if ($count && $count->postcount > 0) {
1352         $result = new stdClass();
1353         $result->info = get_string("numposts", "forum", $count->postcount);
1354         $result->time = $count->lastpost;
1355         if ($grade) {
1356             $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
1357         }
1358         return $result;
1359     } else if ($grade) {
1360         $result = new stdClass();
1361         $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
1363         //datesubmitted == time created. dategraded == time modified or time overridden
1364         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
1365         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
1366         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1367             $result->time = $grade->dategraded;
1368         } else {
1369             $result->time = $grade->datesubmitted;
1370         }
1372         return $result;
1373     }
1374     return NULL;
1378 /**
1379  * @global object
1380  * @global object
1381  * @param object $coure
1382  * @param object $user
1383  * @param object $mod
1384  * @param object $forum
1385  */
1386 function forum_user_complete($course, $user, $mod, $forum) {
1387     global $CFG,$USER, $OUTPUT;
1388     require_once("$CFG->libdir/gradelib.php");
1390     $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1391     if (!empty($grades->items[0]->grades)) {
1392         $grade = reset($grades->items[0]->grades);
1393         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1394         if ($grade->str_feedback) {
1395             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1396         }
1397     }
1399     if ($posts = forum_get_user_posts($forum->id, $user->id)) {
1401         if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
1402             print_error('invalidcoursemodule');
1403         }
1404         $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
1406         foreach ($posts as $post) {
1407             if (!isset($discussions[$post->discussion])) {
1408                 continue;
1409             }
1410             $discussion = $discussions[$post->discussion];
1412             forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
1413         }
1414     } else {
1415         echo "<p>".get_string("noposts", "forum")."</p>";
1416     }
1419 /**
1420  * Filters the forum discussions according to groups membership and config.
1421  *
1422  * @since  Moodle 2.8, 2.7.1, 2.6.4
1423  * @param  array $discussions Discussions with new posts array
1424  * @return array Forums with the number of new posts
1425  */
1426 function forum_filter_user_groups_discussions($discussions) {
1428     // Group the remaining discussions posts by their forumid.
1429     $filteredforums = array();
1431     // Discard not visible groups.
1432     foreach ($discussions as $discussion) {
1434         // Course data is already cached.
1435         $instances = get_fast_modinfo($discussion->course)->get_instances();
1436         $forum = $instances['forum'][$discussion->forum];
1438         // Continue if the user should not see this discussion.
1439         if (!forum_is_user_group_discussion($forum, $discussion->groupid)) {
1440             continue;
1441         }
1443         // Grouping results by forum.
1444         if (empty($filteredforums[$forum->instance])) {
1445             $filteredforums[$forum->instance] = new stdClass();
1446             $filteredforums[$forum->instance]->id = $forum->id;
1447             $filteredforums[$forum->instance]->count = 0;
1448         }
1449         $filteredforums[$forum->instance]->count += $discussion->count;
1451     }
1453     return $filteredforums;
1456 /**
1457  * Returns whether the discussion group is visible by the current user or not.
1458  *
1459  * @since Moodle 2.8, 2.7.1, 2.6.4
1460  * @param cm_info $cm The discussion course module
1461  * @param int $discussiongroupid The discussion groupid
1462  * @return bool
1463  */
1464 function forum_is_user_group_discussion(cm_info $cm, $discussiongroupid) {
1466     if ($discussiongroupid == -1 || $cm->effectivegroupmode != SEPARATEGROUPS) {
1467         return true;
1468     }
1470     if (isguestuser()) {
1471         return false;
1472     }
1474     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id)) ||
1475             in_array($discussiongroupid, $cm->get_modinfo()->get_groups($cm->groupingid))) {
1476         return true;
1477     }
1479     return false;
1482 /**
1483  * @global object
1484  * @global object
1485  * @global object
1486  * @param array $courses
1487  * @param array $htmlarray
1488  */
1489 function forum_print_overview($courses,&$htmlarray) {
1490     global $USER, $CFG, $DB, $SESSION;
1492     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1493         return array();
1494     }
1496     if (!$forums = get_all_instances_in_courses('forum',$courses)) {
1497         return;
1498     }
1500     // Courses to search for new posts
1501     $coursessqls = array();
1502     $params = array();
1503     foreach ($courses as $course) {
1505         // If the user has never entered into the course all posts are pending
1506         if ($course->lastaccess == 0) {
1507             $coursessqls[] = '(d.course = ?)';
1508             $params[] = $course->id;
1510         // Only posts created after the course last access
1511         } else {
1512             $coursessqls[] = '(d.course = ? AND p.created > ?)';
1513             $params[] = $course->id;
1514             $params[] = $course->lastaccess;
1515         }
1516     }
1517     $params[] = $USER->id;
1518     $coursessql = implode(' OR ', $coursessqls);
1520     $sql = "SELECT d.id, d.forum, d.course, d.groupid, COUNT(*) as count "
1521                 .'FROM {forum_discussions} d '
1522                 .'JOIN {forum_posts} p ON p.discussion = d.id '
1523                 ."WHERE ($coursessql) "
1524                 .'AND p.userid != ? '
1525                 .'GROUP BY d.id, d.forum, d.course, d.groupid '
1526                 .'ORDER BY d.course, d.forum';
1528     // Avoid warnings.
1529     if (!$discussions = $DB->get_records_sql($sql, $params)) {
1530         $discussions = array();
1531     }
1533     $forumsnewposts = forum_filter_user_groups_discussions($discussions);
1535     // also get all forum tracking stuff ONCE.
1536     $trackingforums = array();
1537     foreach ($forums as $forum) {
1538         if (forum_tp_can_track_forums($forum)) {
1539             $trackingforums[$forum->id] = $forum;
1540         }
1541     }
1543     if (count($trackingforums) > 0) {
1544         $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1545         $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
1546             ' FROM {forum_posts} p '.
1547             ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1548             ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
1549         $params = array($USER->id);
1551         foreach ($trackingforums as $track) {
1552             $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1553             $params[] = $track->id;
1554             if (isset($SESSION->currentgroup[$track->course])) {
1555                 $groupid =  $SESSION->currentgroup[$track->course];
1556             } else {
1557                 // get first groupid
1558                 $groupids = groups_get_all_groups($track->course, $USER->id);
1559                 if ($groupids) {
1560                     reset($groupids);
1561                     $groupid = key($groupids);
1562                     $SESSION->currentgroup[$track->course] = $groupid;
1563                 } else {
1564                     $groupid = 0;
1565                 }
1566                 unset($groupids);
1567             }
1568             $params[] = $groupid;
1569         }
1570         $sql = substr($sql,0,-3); // take off the last OR
1571         $sql .= ') AND p.modified >= ? AND r.id is NULL GROUP BY d.forum,d.course';
1572         $params[] = $cutoffdate;
1574         if (!$unread = $DB->get_records_sql($sql, $params)) {
1575             $unread = array();
1576         }
1577     } else {
1578         $unread = array();
1579     }
1581     if (empty($unread) and empty($forumsnewposts)) {
1582         return;
1583     }
1585     $strforum = get_string('modulename','forum');
1587     foreach ($forums as $forum) {
1588         $str = '';
1589         $count = 0;
1590         $thisunread = 0;
1591         $showunread = false;
1592         // either we have something from logs, or trackposts, or nothing.
1593         if (array_key_exists($forum->id, $forumsnewposts) && !empty($forumsnewposts[$forum->id])) {
1594             $count = $forumsnewposts[$forum->id]->count;
1595         }
1596         if (array_key_exists($forum->id,$unread)) {
1597             $thisunread = $unread[$forum->id]->count;
1598             $showunread = true;
1599         }
1600         if ($count > 0 || $thisunread > 0) {
1601             $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1602                 $forum->name.'</a></div>';
1603             $str .= '<div class="info"><span class="postsincelogin">';
1604             $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
1605             if (!empty($showunread)) {
1606                 $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
1607             }
1608             $str .= '</div></div>';
1609         }
1610         if (!empty($str)) {
1611             if (!array_key_exists($forum->course,$htmlarray)) {
1612                 $htmlarray[$forum->course] = array();
1613             }
1614             if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1615                 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1616             }
1617             $htmlarray[$forum->course]['forum'] .= $str;
1618         }
1619     }
1622 /**
1623  * Given a course and a date, prints a summary of all the new
1624  * messages posted in the course since that date
1625  *
1626  * @global object
1627  * @global object
1628  * @global object
1629  * @uses CONTEXT_MODULE
1630  * @uses VISIBLEGROUPS
1631  * @param object $course
1632  * @param bool $viewfullnames capability
1633  * @param int $timestart
1634  * @return bool success
1635  */
1636 function forum_print_recent_activity($course, $viewfullnames, $timestart) {
1637     global $CFG, $USER, $DB, $OUTPUT;
1639     // do not use log table if possible, it may be huge and is expensive to join with other tables
1641     $allnamefields = user_picture::fields('u', null, 'duserid');
1642     if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
1643                                               d.timestart, d.timeend, $allnamefields
1644                                          FROM {forum_posts} p
1645                                               JOIN {forum_discussions} d ON d.id = p.discussion
1646                                               JOIN {forum} f             ON f.id = d.forum
1647                                               JOIN {user} u              ON u.id = p.userid
1648                                         WHERE p.created > ? AND f.course = ?
1649                                      ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
1650          return false;
1651     }
1653     $modinfo = get_fast_modinfo($course);
1655     $groupmodes = array();
1656     $cms    = array();
1658     $strftimerecent = get_string('strftimerecent');
1660     $printposts = array();
1661     foreach ($posts as $post) {
1662         if (!isset($modinfo->instances['forum'][$post->forum])) {
1663             // not visible
1664             continue;
1665         }
1666         $cm = $modinfo->instances['forum'][$post->forum];
1667         if (!$cm->uservisible) {
1668             continue;
1669         }
1670         $context = context_module::instance($cm->id);
1672         if (!has_capability('mod/forum:viewdiscussion', $context)) {
1673             continue;
1674         }
1676         if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1677           and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
1678             if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1679                 continue;
1680             }
1681         }
1683         // Check that the user can see the discussion.
1684         if (forum_is_user_group_discussion($cm, $post->groupid)) {
1685             $printposts[] = $post;
1686         }
1688     }
1689     unset($posts);
1691     if (!$printposts) {
1692         return false;
1693     }
1695     echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
1696     echo "\n<ul class='unlist'>\n";
1698     foreach ($printposts as $post) {
1699         $subjectclass = empty($post->parent) ? ' bold' : '';
1701         echo '<li><div class="head">'.
1702                '<div class="date">'.userdate($post->modified, $strftimerecent).'</div>'.
1703                '<div class="name">'.fullname($post, $viewfullnames).'</div>'.
1704              '</div>';
1705         echo '<div class="info'.$subjectclass.'">';
1706         if (empty($post->parent)) {
1707             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'">';
1708         } else {
1709             echo '"<a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'&amp;parent='.$post->parent.'#p'.$post->id.'">';
1710         }
1711         $post->subject = break_up_long_words(format_string($post->subject, true));
1712         echo $post->subject;
1713         echo "</a>\"</div></li>\n";
1714     }
1716     echo "</ul>\n";
1718     return true;
1721 /**
1722  * Return grade for given user or all users.
1723  *
1724  * @global object
1725  * @global object
1726  * @param object $forum
1727  * @param int $userid optional user id, 0 means all users
1728  * @return array array of grades, false if none
1729  */
1730 function forum_get_user_grades($forum, $userid = 0) {
1731     global $CFG;
1733     require_once($CFG->dirroot.'/rating/lib.php');
1735     $ratingoptions = new stdClass;
1736     $ratingoptions->component = 'mod_forum';
1737     $ratingoptions->ratingarea = 'post';
1739     //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1740     $ratingoptions->modulename = 'forum';
1741     $ratingoptions->moduleid   = $forum->id;
1742     $ratingoptions->userid = $userid;
1743     $ratingoptions->aggregationmethod = $forum->assessed;
1744     $ratingoptions->scaleid = $forum->scale;
1745     $ratingoptions->itemtable = 'forum_posts';
1746     $ratingoptions->itemtableusercolumn = 'userid';
1748     $rm = new rating_manager();
1749     return $rm->get_user_grades($ratingoptions);
1752 /**
1753  * Update activity grades
1754  *
1755  * @category grade
1756  * @param object $forum
1757  * @param int $userid specific user only, 0 means all
1758  * @param boolean $nullifnone return null if grade does not exist
1759  * @return void
1760  */
1761 function forum_update_grades($forum, $userid=0, $nullifnone=true) {
1762     global $CFG, $DB;
1763     require_once($CFG->libdir.'/gradelib.php');
1765     if (!$forum->assessed) {
1766         forum_grade_item_update($forum);
1768     } else if ($grades = forum_get_user_grades($forum, $userid)) {
1769         forum_grade_item_update($forum, $grades);
1771     } else if ($userid and $nullifnone) {
1772         $grade = new stdClass();
1773         $grade->userid   = $userid;
1774         $grade->rawgrade = NULL;
1775         forum_grade_item_update($forum, $grade);
1777     } else {
1778         forum_grade_item_update($forum);
1779     }
1782 /**
1783  * Create/update grade item for given forum
1784  *
1785  * @category grade
1786  * @uses GRADE_TYPE_NONE
1787  * @uses GRADE_TYPE_VALUE
1788  * @uses GRADE_TYPE_SCALE
1789  * @param stdClass $forum Forum object with extra cmidnumber
1790  * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
1791  * @return int 0 if ok
1792  */
1793 function forum_grade_item_update($forum, $grades=NULL) {
1794     global $CFG;
1795     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1796         require_once($CFG->libdir.'/gradelib.php');
1797     }
1799     $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
1801     if (!$forum->assessed or $forum->scale == 0) {
1802         $params['gradetype'] = GRADE_TYPE_NONE;
1804     } else if ($forum->scale > 0) {
1805         $params['gradetype'] = GRADE_TYPE_VALUE;
1806         $params['grademax']  = $forum->scale;
1807         $params['grademin']  = 0;
1809     } else if ($forum->scale < 0) {
1810         $params['gradetype'] = GRADE_TYPE_SCALE;
1811         $params['scaleid']   = -$forum->scale;
1812     }
1814     if ($grades  === 'reset') {
1815         $params['reset'] = true;
1816         $grades = NULL;
1817     }
1819     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
1822 /**
1823  * Delete grade item for given forum
1824  *
1825  * @category grade
1826  * @param stdClass $forum Forum object
1827  * @return grade_item
1828  */
1829 function forum_grade_item_delete($forum) {
1830     global $CFG;
1831     require_once($CFG->libdir.'/gradelib.php');
1833     return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
1837 /**
1838  * This function returns if a scale is being used by one forum
1839  *
1840  * @global object
1841  * @param int $forumid
1842  * @param int $scaleid negative number
1843  * @return bool
1844  */
1845 function forum_scale_used ($forumid,$scaleid) {
1846     global $DB;
1847     $return = false;
1849     $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
1851     if (!empty($rec) && !empty($scaleid)) {
1852         $return = true;
1853     }
1855     return $return;
1858 /**
1859  * Checks if scale is being used by any instance of forum
1860  *
1861  * This is used to find out if scale used anywhere
1862  *
1863  * @global object
1864  * @param $scaleid int
1865  * @return boolean True if the scale is used by any forum
1866  */
1867 function forum_scale_used_anywhere($scaleid) {
1868     global $DB;
1869     if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
1870         return true;
1871     } else {
1872         return false;
1873     }
1876 // SQL FUNCTIONS ///////////////////////////////////////////////////////////
1878 /**
1879  * Gets a post with all info ready for forum_print_post
1880  * Most of these joins are just to get the forum id
1881  *
1882  * @global object
1883  * @global object
1884  * @param int $postid
1885  * @return mixed array of posts or false
1886  */
1887 function forum_get_post_full($postid) {
1888     global $CFG, $DB;
1890     $allnames = get_all_user_name_fields(true, 'u');
1891     return $DB->get_record_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
1892                              FROM {forum_posts} p
1893                                   JOIN {forum_discussions} d ON p.discussion = d.id
1894                                   LEFT JOIN {user} u ON p.userid = u.id
1895                             WHERE p.id = ?", array($postid));
1898 /**
1899  * Gets all posts in discussion including top parent.
1900  *
1901  * @global object
1902  * @global object
1903  * @global object
1904  * @param int $discussionid
1905  * @param string $sort
1906  * @param bool $tracking does user track the forum?
1907  * @return array of posts
1908  */
1909 function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
1910     global $CFG, $DB, $USER;
1912     $tr_sel  = "";
1913     $tr_join = "";
1914     $params = array();
1916     if ($tracking) {
1917         $now = time();
1918         $cutoffdate = $now - ($CFG->forum_oldpostdays * 24 * 3600);
1919         $tr_sel  = ", fr.id AS postread";
1920         $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1921         $params[] = $USER->id;
1922     }
1924     $allnames = get_all_user_name_fields(true, 'u');
1925     $params[] = $discussionid;
1926     if (!$posts = $DB->get_records_sql("SELECT p.*, $allnames, u.email, u.picture, u.imagealt $tr_sel
1927                                      FROM {forum_posts} p
1928                                           LEFT JOIN {user} u ON p.userid = u.id
1929                                           $tr_join
1930                                     WHERE p.discussion = ?
1931                                  ORDER BY $sort", $params)) {
1932         return array();
1933     }
1935     foreach ($posts as $pid=>$p) {
1936         if ($tracking) {
1937             if (forum_tp_is_post_old($p)) {
1938                  $posts[$pid]->postread = true;
1939             }
1940         }
1941         if (!$p->parent) {
1942             continue;
1943         }
1944         if (!isset($posts[$p->parent])) {
1945             continue; // parent does not exist??
1946         }
1947         if (!isset($posts[$p->parent]->children)) {
1948             $posts[$p->parent]->children = array();
1949         }
1950         $posts[$p->parent]->children[$pid] =& $posts[$pid];
1951     }
1953     return $posts;
1956 /**
1957  * An array of forum objects that the user is allowed to read/search through.
1958  *
1959  * @global object
1960  * @global object
1961  * @global object
1962  * @param int $userid
1963  * @param int $courseid if 0, we look for forums throughout the whole site.
1964  * @return array of forum objects, or false if no matches
1965  *         Forum objects have the following attributes:
1966  *         id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1967  *         viewhiddentimedposts
1968  */
1969 function forum_get_readable_forums($userid, $courseid=0) {
1971     global $CFG, $DB, $USER;
1972     require_once($CFG->dirroot.'/course/lib.php');
1974     if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
1975         print_error('notinstalled', 'forum');
1976     }
1978     if ($courseid) {
1979         $courses = $DB->get_records('course', array('id' => $courseid));
1980     } else {
1981         // If no course is specified, then the user can see SITE + his courses.
1982         $courses1 = $DB->get_records('course', array('id' => SITEID));
1983         $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
1984         $courses = array_merge($courses1, $courses2);
1985     }
1986     if (!$courses) {
1987         return array();
1988     }
1990     $readableforums = array();
1992     foreach ($courses as $course) {
1994         $modinfo = get_fast_modinfo($course);
1996         if (empty($modinfo->instances['forum'])) {
1997             // hmm, no forums?
1998             continue;
1999         }
2001         $courseforums = $DB->get_records('forum', array('course' => $course->id));
2003         foreach ($modinfo->instances['forum'] as $forumid => $cm) {
2004             if (!$cm->uservisible or !isset($courseforums[$forumid])) {
2005                 continue;
2006             }
2007             $context = context_module::instance($cm->id);
2008             $forum = $courseforums[$forumid];
2009             $forum->context = $context;
2010             $forum->cm = $cm;
2012             if (!has_capability('mod/forum:viewdiscussion', $context)) {
2013                 continue;
2014             }
2016          /// group access
2017             if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2019                 $forum->onlygroups = $modinfo->get_groups($cm->groupingid);
2020                 $forum->onlygroups[] = -1;
2021             }
2023         /// hidden timed discussions
2024             $forum->viewhiddentimedposts = true;
2025             if (!empty($CFG->forum_enabletimedposts)) {
2026                 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
2027                     $forum->viewhiddentimedposts = false;
2028                 }
2029             }
2031         /// qanda access
2032             if ($forum->type == 'qanda'
2033                     && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2035                 // We need to check whether the user has posted in the qanda forum.
2036                 $forum->onlydiscussions = array();  // Holds discussion ids for the discussions
2037                                                     // the user is allowed to see in this forum.
2038                 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
2039                     foreach ($discussionspostedin as $d) {
2040                         $forum->onlydiscussions[] = $d->id;
2041                     }
2042                 }
2043             }
2045             $readableforums[$forum->id] = $forum;
2046         }
2048         unset($modinfo);
2050     } // End foreach $courses
2052     return $readableforums;
2055 /**
2056  * Returns a list of posts found using an array of search terms.
2057  *
2058  * @global object
2059  * @global object
2060  * @global object
2061  * @param array $searchterms array of search terms, e.g. word +word -word
2062  * @param int $courseid if 0, we search through the whole site
2063  * @param int $limitfrom
2064  * @param int $limitnum
2065  * @param int &$totalcount
2066  * @param string $extrasql
2067  * @return array|bool Array of posts found or false
2068  */
2069 function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
2070                             &$totalcount, $extrasql='') {
2071     global $CFG, $DB, $USER;
2072     require_once($CFG->libdir.'/searchlib.php');
2074     $forums = forum_get_readable_forums($USER->id, $courseid);
2076     if (count($forums) == 0) {
2077         $totalcount = 0;
2078         return false;
2079     }
2081     $now = round(time(), -2); // db friendly
2083     $fullaccess = array();
2084     $where = array();
2085     $params = array();
2087     foreach ($forums as $forumid => $forum) {
2088         $select = array();
2090         if (!$forum->viewhiddentimedposts) {
2091             $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
2092             $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
2093         }
2095         $cm = $forum->cm;
2096         $context = $forum->context;
2098         if ($forum->type == 'qanda'
2099             && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2100             if (!empty($forum->onlydiscussions)) {
2101                 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
2102                 $params = array_merge($params, $discussionid_params);
2103                 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
2104             } else {
2105                 $select[] = "p.parent = 0";
2106             }
2107         }
2109         if (!empty($forum->onlygroups)) {
2110             list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
2111             $params = array_merge($params, $groupid_params);
2112             $select[] = "d.groupid $groupid_sql";
2113         }
2115         if ($select) {
2116             $selects = implode(" AND ", $select);
2117             $where[] = "(d.forum = :forum{$forumid} AND $selects)";
2118             $params['forum'.$forumid] = $forumid;
2119         } else {
2120             $fullaccess[] = $forumid;
2121         }
2122     }
2124     if ($fullaccess) {
2125         list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
2126         $params = array_merge($params, $fullid_params);
2127         $where[] = "(d.forum $fullid_sql)";
2128     }
2130     $selectdiscussion = "(".implode(" OR ", $where).")";
2132     $messagesearch = '';
2133     $searchstring = '';
2135     // Need to concat these back together for parser to work.
2136     foreach($searchterms as $searchterm){
2137         if ($searchstring != '') {
2138             $searchstring .= ' ';
2139         }
2140         $searchstring .= $searchterm;
2141     }
2143     // We need to allow quoted strings for the search. The quotes *should* be stripped
2144     // by the parser, but this should be examined carefully for security implications.
2145     $searchstring = str_replace("\\\"","\"",$searchstring);
2146     $parser = new search_parser();
2147     $lexer = new search_lexer($parser);
2149     if ($lexer->parse($searchstring)) {
2150         $parsearray = $parser->get_parsed_array();
2151     // Experimental feature under 1.8! MDL-8830
2152     // Use alternative text searches if defined
2153     // This feature only works under mysql until properly implemented for other DBs
2154     // Requires manual creation of text index for forum_posts before enabling it:
2155     // CREATE FULLTEXT INDEX foru_post_tix ON [prefix]forum_posts (subject, message)
2156     // Experimental feature under 1.8! MDL-8830
2157         if (!empty($CFG->forum_usetextsearches)) {
2158             list($messagesearch, $msparams) = search_generate_text_SQL($parsearray, 'p.message', 'p.subject',
2159                                                  'p.userid', 'u.id', 'u.firstname',
2160                                                  'u.lastname', 'p.modified', 'd.forum');
2161         } else {
2162             list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2163                                                  'p.userid', 'u.id', 'u.firstname',
2164                                                  'u.lastname', 'p.modified', 'd.forum');
2165         }
2166         $params = array_merge($params, $msparams);
2167     }
2169     $fromsql = "{forum_posts} p,
2170                   {forum_discussions} d,
2171                   {user} u";
2173     $selectsql = " $messagesearch
2174                AND p.discussion = d.id
2175                AND p.userid = u.id
2176                AND $selectdiscussion
2177                    $extrasql";
2179     $countsql = "SELECT COUNT(*)
2180                    FROM $fromsql
2181                   WHERE $selectsql";
2183     $allnames = get_all_user_name_fields(true, 'u');
2184     $searchsql = "SELECT p.*,
2185                          d.forum,
2186                          $allnames,
2187                          u.email,
2188                          u.picture,
2189                          u.imagealt
2190                     FROM $fromsql
2191                    WHERE $selectsql
2192                 ORDER BY p.modified DESC";
2194     $totalcount = $DB->count_records_sql($countsql, $params);
2196     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2199 /**
2200  * Returns a list of all new posts that have not been mailed yet
2201  *
2202  * @param int $starttime posts created after this time
2203  * @param int $endtime posts created before this
2204  * @param int $now used for timed discussions only
2205  * @return array
2206  */
2207 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2208     global $CFG, $DB;
2210     $params = array();
2211     $params['mailed'] = FORUM_MAILED_PENDING;
2212     $params['ptimestart'] = $starttime;
2213     $params['ptimeend'] = $endtime;
2214     $params['mailnow'] = 1;
2216     if (!empty($CFG->forum_enabletimedposts)) {
2217         if (empty($now)) {
2218             $now = time();
2219         }
2220         $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
2221         $params['dtimestart'] = $now;
2222         $params['dtimeend'] = $now;
2223     } else {
2224         $timedsql = "";
2225     }
2227     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2228                                  FROM {forum_posts} p
2229                                  JOIN {forum_discussions} d ON d.id = p.discussion
2230                                  WHERE p.mailed = :mailed
2231                                  AND p.created >= :ptimestart
2232                                  AND (p.created < :ptimeend OR p.mailnow = :mailnow)
2233                                  $timedsql
2234                                  ORDER BY p.modified ASC", $params);
2237 /**
2238  * Marks posts before a certain time as being mailed already
2239  *
2240  * @global object
2241  * @global object
2242  * @param int $endtime
2243  * @param int $now Defaults to time()
2244  * @return bool
2245  */
2246 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2247     global $CFG, $DB;
2249     if (empty($now)) {
2250         $now = time();
2251     }
2253     $params = array();
2254     $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
2255     $params['now'] = $now;
2256     $params['endtime'] = $endtime;
2257     $params['mailnow'] = 1;
2258     $params['mailedpending'] = FORUM_MAILED_PENDING;
2260     if (empty($CFG->forum_enabletimedposts)) {
2261         return $DB->execute("UPDATE {forum_posts}
2262                              SET mailed = :mailedsuccess
2263                              WHERE (created < :endtime OR mailnow = :mailnow)
2264                              AND mailed = :mailedpending", $params);
2265     } else {
2266         return $DB->execute("UPDATE {forum_posts}
2267                              SET mailed = :mailedsuccess
2268                              WHERE discussion NOT IN (SELECT d.id
2269                                                       FROM {forum_discussions} d
2270                                                       WHERE d.timestart > :now)
2271                              AND (created < :endtime OR mailnow = :mailnow)
2272                              AND mailed = :mailedpending", $params);
2273     }
2276 /**
2277  * Get all the posts for a user in a forum suitable for forum_print_post
2278  *
2279  * @global object
2280  * @global object
2281  * @uses CONTEXT_MODULE
2282  * @return array
2283  */
2284 function forum_get_user_posts($forumid, $userid) {
2285     global $CFG, $DB;
2287     $timedsql = "";
2288     $params = array($forumid, $userid);
2290     if (!empty($CFG->forum_enabletimedposts)) {
2291         $cm = get_coursemodule_from_instance('forum', $forumid);
2292         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2293             $now = time();
2294             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2295             $params[] = $now;
2296             $params[] = $now;
2297         }
2298     }
2300     $allnames = get_all_user_name_fields(true, 'u');
2301     return $DB->get_records_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
2302                               FROM {forum} f
2303                                    JOIN {forum_discussions} d ON d.forum = f.id
2304                                    JOIN {forum_posts} p       ON p.discussion = d.id
2305                                    JOIN {user} u              ON u.id = p.userid
2306                              WHERE f.id = ?
2307                                    AND p.userid = ?
2308                                    $timedsql
2309                           ORDER BY p.modified ASC", $params);
2312 /**
2313  * Get all the discussions user participated in
2314  *
2315  * @global object
2316  * @global object
2317  * @uses CONTEXT_MODULE
2318  * @param int $forumid
2319  * @param int $userid
2320  * @return array Array or false
2321  */
2322 function forum_get_user_involved_discussions($forumid, $userid) {
2323     global $CFG, $DB;
2325     $timedsql = "";
2326     $params = array($forumid, $userid);
2327     if (!empty($CFG->forum_enabletimedposts)) {
2328         $cm = get_coursemodule_from_instance('forum', $forumid);
2329         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2330             $now = time();
2331             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2332             $params[] = $now;
2333             $params[] = $now;
2334         }
2335     }
2337     return $DB->get_records_sql("SELECT DISTINCT d.*
2338                               FROM {forum} f
2339                                    JOIN {forum_discussions} d ON d.forum = f.id
2340                                    JOIN {forum_posts} p       ON p.discussion = d.id
2341                              WHERE f.id = ?
2342                                    AND p.userid = ?
2343                                    $timedsql", $params);
2346 /**
2347  * Get all the posts for a user in a forum suitable for forum_print_post
2348  *
2349  * @global object
2350  * @global object
2351  * @param int $forumid
2352  * @param int $userid
2353  * @return array of counts or false
2354  */
2355 function forum_count_user_posts($forumid, $userid) {
2356     global $CFG, $DB;
2358     $timedsql = "";
2359     $params = array($forumid, $userid);
2360     if (!empty($CFG->forum_enabletimedposts)) {
2361         $cm = get_coursemodule_from_instance('forum', $forumid);
2362         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2363             $now = time();
2364             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2365             $params[] = $now;
2366             $params[] = $now;
2367         }
2368     }
2370     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2371                              FROM {forum} f
2372                                   JOIN {forum_discussions} d ON d.forum = f.id
2373                                   JOIN {forum_posts} p       ON p.discussion = d.id
2374                                   JOIN {user} u              ON u.id = p.userid
2375                             WHERE f.id = ?
2376                                   AND p.userid = ?
2377                                   $timedsql", $params);
2380 /**
2381  * Given a log entry, return the forum post details for it.
2382  *
2383  * @global object
2384  * @global object
2385  * @param object $log
2386  * @return array|null
2387  */
2388 function forum_get_post_from_log($log) {
2389     global $CFG, $DB;
2391     $allnames = get_all_user_name_fields(true, 'u');
2392     if ($log->action == "add post") {
2394         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2395                                  FROM {forum_discussions} d,
2396                                       {forum_posts} p,
2397                                       {forum} f,
2398                                       {user} u
2399                                 WHERE p.id = ?
2400                                   AND d.id = p.discussion
2401                                   AND p.userid = u.id
2402                                   AND u.deleted <> '1'
2403                                   AND f.id = d.forum", array($log->info));
2406     } else if ($log->action == "add discussion") {
2408         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2409                                  FROM {forum_discussions} d,
2410                                       {forum_posts} p,
2411                                       {forum} f,
2412                                       {user} u
2413                                 WHERE d.id = ?
2414                                   AND d.firstpost = p.id
2415                                   AND p.userid = u.id
2416                                   AND u.deleted <> '1'
2417                                   AND f.id = d.forum", array($log->info));
2418     }
2419     return NULL;
2422 /**
2423  * Given a discussion id, return the first post from the discussion
2424  *
2425  * @global object
2426  * @global object
2427  * @param int $dicsussionid
2428  * @return array
2429  */
2430 function forum_get_firstpost_from_discussion($discussionid) {
2431     global $CFG, $DB;
2433     return $DB->get_record_sql("SELECT p.*
2434                              FROM {forum_discussions} d,
2435                                   {forum_posts} p
2436                             WHERE d.id = ?
2437                               AND d.firstpost = p.id ", array($discussionid));
2440 /**
2441  * Returns an array of counts of replies to each discussion
2442  *
2443  * @global object
2444  * @global object
2445  * @param int $forumid
2446  * @param string $forumsort
2447  * @param int $limit
2448  * @param int $page
2449  * @param int $perpage
2450  * @return array
2451  */
2452 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2453     global $CFG, $DB;
2455     if ($limit > 0) {
2456         $limitfrom = 0;
2457         $limitnum  = $limit;
2458     } else if ($page != -1) {
2459         $limitfrom = $page*$perpage;
2460         $limitnum  = $perpage;
2461     } else {
2462         $limitfrom = 0;
2463         $limitnum  = 0;
2464     }
2466     if ($forumsort == "") {
2467         $orderby = "";
2468         $groupby = "";
2470     } else {
2471         $orderby = "ORDER BY $forumsort";
2472         $groupby = ", ".strtolower($forumsort);
2473         $groupby = str_replace('desc', '', $groupby);
2474         $groupby = str_replace('asc', '', $groupby);
2475     }
2477     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2478         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2479                   FROM {forum_posts} p
2480                        JOIN {forum_discussions} d ON p.discussion = d.id
2481                  WHERE p.parent > 0 AND d.forum = ?
2482               GROUP BY p.discussion";
2483         return $DB->get_records_sql($sql, array($forumid));
2485     } else {
2486         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2487                   FROM {forum_posts} p
2488                        JOIN {forum_discussions} d ON p.discussion = d.id
2489                  WHERE d.forum = ?
2490               GROUP BY p.discussion $groupby
2491               $orderby";
2492         return $DB->get_records_sql("SELECT * FROM ($sql) sq", array($forumid), $limitfrom, $limitnum);
2493     }
2496 /**
2497  * @global object
2498  * @global object
2499  * @global object
2500  * @staticvar array $cache
2501  * @param object $forum
2502  * @param object $cm
2503  * @param object $course
2504  * @return mixed
2505  */
2506 function forum_count_discussions($forum, $cm, $course) {
2507     global $CFG, $DB, $USER;
2509     static $cache = array();
2511     $now = round(time(), -2); // db cache friendliness
2513     $params = array($course->id);
2515     if (!isset($cache[$course->id])) {
2516         if (!empty($CFG->forum_enabletimedposts)) {
2517             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2518             $params[] = $now;
2519             $params[] = $now;
2520         } else {
2521             $timedsql = "";
2522         }
2524         $sql = "SELECT f.id, COUNT(d.id) as dcount
2525                   FROM {forum} f
2526                        JOIN {forum_discussions} d ON d.forum = f.id
2527                  WHERE f.course = ?
2528                        $timedsql
2529               GROUP BY f.id";
2531         if ($counts = $DB->get_records_sql($sql, $params)) {
2532             foreach ($counts as $count) {
2533                 $counts[$count->id] = $count->dcount;
2534             }
2535             $cache[$course->id] = $counts;
2536         } else {
2537             $cache[$course->id] = array();
2538         }
2539     }
2541     if (empty($cache[$course->id][$forum->id])) {
2542         return 0;
2543     }
2545     $groupmode = groups_get_activity_groupmode($cm, $course);
2547     if ($groupmode != SEPARATEGROUPS) {
2548         return $cache[$course->id][$forum->id];
2549     }
2551     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
2552         return $cache[$course->id][$forum->id];
2553     }
2555     require_once($CFG->dirroot.'/course/lib.php');
2557     $modinfo = get_fast_modinfo($course);
2559     $mygroups = $modinfo->get_groups($cm->groupingid);
2561     // add all groups posts
2562     $mygroups[-1] = -1;
2564     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2565     $params[] = $forum->id;
2567     if (!empty($CFG->forum_enabletimedposts)) {
2568         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2569         $params[] = $now;
2570         $params[] = $now;
2571     } else {
2572         $timedsql = "";
2573     }
2575     $sql = "SELECT COUNT(d.id)
2576               FROM {forum_discussions} d
2577              WHERE d.groupid $mygroups_sql AND d.forum = ?
2578                    $timedsql";
2580     return $DB->get_field_sql($sql, $params);
2583 /**
2584  * Get all discussions in a forum
2585  *
2586  * @global object
2587  * @global object
2588  * @global object
2589  * @uses CONTEXT_MODULE
2590  * @uses VISIBLEGROUPS
2591  * @param object $cm
2592  * @param string $forumsort
2593  * @param bool $fullpost
2594  * @param int $unused
2595  * @param int $limit
2596  * @param bool $userlastmodified
2597  * @param int $page
2598  * @param int $perpage
2599  * @return array
2600  */
2601 function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
2602     global $CFG, $DB, $USER;
2604     $timelimit = '';
2606     $now = round(time(), -2);
2607     $params = array($cm->instance);
2609     $modcontext = context_module::instance($cm->id);
2611     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2612         return array();
2613     }
2615     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2617         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2618             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2619             $params[] = $now;
2620             $params[] = $now;
2621             if (isloggedin()) {
2622                 $timelimit .= " OR d.userid = ?";
2623                 $params[] = $USER->id;
2624             }
2625             $timelimit .= ")";
2626         }
2627     }
2629     if ($limit > 0) {
2630         $limitfrom = 0;
2631         $limitnum  = $limit;
2632     } else if ($page != -1) {
2633         $limitfrom = $page*$perpage;
2634         $limitnum  = $perpage;
2635     } else {
2636         $limitfrom = 0;
2637         $limitnum  = 0;
2638     }
2640     $groupmode    = groups_get_activity_groupmode($cm);
2641     $currentgroup = groups_get_activity_group($cm);
2643     if ($groupmode) {
2644         if (empty($modcontext)) {
2645             $modcontext = context_module::instance($cm->id);
2646         }
2648         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2649             if ($currentgroup) {
2650                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2651                 $params[] = $currentgroup;
2652             } else {
2653                 $groupselect = "";
2654             }
2656         } else {
2657             //seprate groups without access all
2658             if ($currentgroup) {
2659                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2660                 $params[] = $currentgroup;
2661             } else {
2662                 $groupselect = "AND d.groupid = -1";
2663             }
2664         }
2665     } else {
2666         $groupselect = "";
2667     }
2670     if (empty($forumsort)) {
2671         $forumsort = "d.timemodified DESC";
2672     }
2673     if (empty($fullpost)) {
2674         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2675     } else {
2676         $postdata = "p.*";
2677     }
2679     if (empty($userlastmodified)) {  // We don't need to know this
2680         $umfields = "";
2681         $umtable  = "";
2682     } else {
2683         $umfields = ', ' . get_all_user_name_fields(true, 'um', null, 'um');
2684         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2685     }
2687     $allnames = get_all_user_name_fields(true, 'u');
2688     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend, $allnames,
2689                    u.email, u.picture, u.imagealt $umfields
2690               FROM {forum_discussions} d
2691                    JOIN {forum_posts} p ON p.discussion = d.id
2692                    JOIN {user} u ON p.userid = u.id
2693                    $umtable
2694              WHERE d.forum = ? AND p.parent = 0
2695                    $timelimit $groupselect
2696           ORDER BY $forumsort";
2697     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2700 /**
2701  * Gets the neighbours (previous and next) of a discussion.
2702  *
2703  * The calculation is based on the timemodified of the discussion and does not handle
2704  * the neighbours having an identical timemodified. The reason is that we do not have any
2705  * other mean to sort the records, e.g. we cannot use IDs as a greater ID can have a lower
2706  * timemodified.
2707  *
2708  * Please note that this does not check whether or not the discussion passed is accessible
2709  * by the user, it simply uses it as a reference to find the neighbours. On the other hand,
2710  * the returned neighbours are checked and are accessible to the current user.
2711  *
2712  * @param object $cm The CM record.
2713  * @param object $discussion The discussion record.
2714  * @return array That always contains the keys 'prev' and 'next'. When there is a result
2715  *               they contain the record with minimal information such as 'id' and 'name'.
2716  *               When the neighbour is not found the value is false.
2717  */
2718 function forum_get_discussion_neighbours($cm, $discussion) {
2719     global $CFG, $DB, $USER;
2721     if ($cm->instance != $discussion->forum) {
2722         throw new coding_exception('Discussion is not part of the same forum.');
2723     }
2725     $neighbours = array('prev' => false, 'next' => false);
2726     $now = round(time(), -2);
2727     $params = array();
2729     $modcontext = context_module::instance($cm->id);
2730     $groupmode    = groups_get_activity_groupmode($cm);
2731     $currentgroup = groups_get_activity_group($cm);
2733     // Users must fulfill timed posts.
2734     $timelimit = '';
2735     if (!empty($CFG->forum_enabletimedposts)) {
2736         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2737             $timelimit = ' AND ((d.timestart <= :tltimestart AND (d.timeend = 0 OR d.timeend > :tltimeend))';
2738             $params['tltimestart'] = $now;
2739             $params['tltimeend'] = $now;
2740             if (isloggedin()) {
2741                 $timelimit .= ' OR d.userid = :tluserid';
2742                 $params['tluserid'] = $USER->id;
2743             }
2744             $timelimit .= ')';
2745         }
2746     }
2748     // Limiting to posts accessible according to groups.
2749     $groupselect = '';
2750     if ($groupmode) {
2751         if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $modcontext)) {
2752             if ($currentgroup) {
2753                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2754                 $params['groupid'] = $currentgroup;
2755             }
2756         } else {
2757             if ($currentgroup) {
2758                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2759                 $params['groupid'] = $currentgroup;
2760             } else {
2761                 $groupselect = 'AND d.groupid = -1';
2762             }
2763         }
2764     }
2766     $params['forumid'] = $cm->instance;
2767     $params['discid'] = $discussion->id;
2768     $params['disctimemodified'] = $discussion->timemodified;
2770     $sql = "SELECT d.id, d.name, d.timemodified, d.groupid, d.timestart, d.timeend
2771               FROM {forum_discussions} d
2772              WHERE d.forum = :forumid
2773                AND d.id <> :discid
2774                    $timelimit
2775                    $groupselect";
2777     $prevsql = $sql . " AND d.timemodified < :disctimemodified
2778                    ORDER BY d.timemodified DESC";
2780     $nextsql = $sql . " AND d.timemodified > :disctimemodified
2781                    ORDER BY d.timemodified ASC";
2783     $neighbours['prev'] = $DB->get_record_sql($prevsql, $params, IGNORE_MULTIPLE);
2784     $neighbours['next'] = $DB->get_record_sql($nextsql, $params, IGNORE_MULTIPLE);
2786     return $neighbours;
2789 /**
2790  *
2791  * @global object
2792  * @global object
2793  * @global object
2794  * @uses CONTEXT_MODULE
2795  * @uses VISIBLEGROUPS
2796  * @param object $cm
2797  * @return array
2798  */
2799 function forum_get_discussions_unread($cm) {
2800     global $CFG, $DB, $USER;
2802     $now = round(time(), -2);
2803     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2805     $params = array();
2806     $groupmode    = groups_get_activity_groupmode($cm);
2807     $currentgroup = groups_get_activity_group($cm);
2809     if ($groupmode) {
2810         $modcontext = context_module::instance($cm->id);
2812         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2813             if ($currentgroup) {
2814                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2815                 $params['currentgroup'] = $currentgroup;
2816             } else {
2817                 $groupselect = "";
2818             }
2820         } else {
2821             //separate groups without access all
2822             if ($currentgroup) {
2823                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2824                 $params['currentgroup'] = $currentgroup;
2825             } else {
2826                 $groupselect = "AND d.groupid = -1";
2827             }
2828         }
2829     } else {
2830         $groupselect = "";
2831     }
2833     if (!empty($CFG->forum_enabletimedposts)) {
2834         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2835         $params['now1'] = $now;
2836         $params['now2'] = $now;
2837     } else {
2838         $timedsql = "";
2839     }
2841     $sql = "SELECT d.id, COUNT(p.id) AS unread
2842               FROM {forum_discussions} d
2843                    JOIN {forum_posts} p     ON p.discussion = d.id
2844                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2845              WHERE d.forum = {$cm->instance}
2846                    AND p.modified >= :cutoffdate AND r.id is NULL
2847                    $groupselect
2848                    $timedsql
2849           GROUP BY d.id";
2850     $params['cutoffdate'] = $cutoffdate;
2852     if ($unreads = $DB->get_records_sql($sql, $params)) {
2853         foreach ($unreads as $unread) {
2854             $unreads[$unread->id] = $unread->unread;
2855         }
2856         return $unreads;
2857     } else {
2858         return array();
2859     }
2862 /**
2863  * @global object
2864  * @global object
2865  * @global object
2866  * @uses CONEXT_MODULE
2867  * @uses VISIBLEGROUPS
2868  * @param object $cm
2869  * @return array
2870  */
2871 function forum_get_discussions_count($cm) {
2872     global $CFG, $DB, $USER;
2874     $now = round(time(), -2);
2875     $params = array($cm->instance);
2876     $groupmode    = groups_get_activity_groupmode($cm);
2877     $currentgroup = groups_get_activity_group($cm);
2879     if ($groupmode) {
2880         $modcontext = context_module::instance($cm->id);
2882         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2883             if ($currentgroup) {
2884                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2885                 $params[] = $currentgroup;
2886             } else {
2887                 $groupselect = "";
2888             }
2890         } else {
2891             //seprate groups without access all
2892             if ($currentgroup) {
2893                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2894                 $params[] = $currentgroup;
2895             } else {
2896                 $groupselect = "AND d.groupid = -1";
2897             }
2898         }
2899     } else {
2900         $groupselect = "";
2901     }
2903     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2905     $timelimit = "";
2907     if (!empty($CFG->forum_enabletimedposts)) {
2909         $modcontext = context_module::instance($cm->id);
2911         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2912             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2913             $params[] = $now;
2914             $params[] = $now;
2915             if (isloggedin()) {
2916                 $timelimit .= " OR d.userid = ?";
2917                 $params[] = $USER->id;
2918             }
2919             $timelimit .= ")";
2920         }
2921     }
2923     $sql = "SELECT COUNT(d.id)
2924               FROM {forum_discussions} d
2925                    JOIN {forum_posts} p ON p.discussion = d.id
2926              WHERE d.forum = ? AND p.parent = 0
2927                    $groupselect $timelimit";
2929     return $DB->get_field_sql($sql, $params);
2933 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2936 /**
2937  * @global object
2938  * @global object
2939  * @param int $courseid
2940  * @param string $type
2941  */
2942 function forum_get_course_forum($courseid, $type) {
2943 // How to set up special 1-per-course forums
2944     global $CFG, $DB, $OUTPUT, $USER;
2946     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
2947         // There should always only be ONE, but with the right combination of
2948         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2949         foreach ($forums as $forum) {
2950             return $forum;   // ie the first one
2951         }
2952     }
2954     // Doesn't exist, so create one now.
2955     $forum = new stdClass();
2956     $forum->course = $courseid;
2957     $forum->type = "$type";
2958     if (!empty($USER->htmleditor)) {
2959         $forum->introformat = $USER->htmleditor;
2960     }
2961     switch ($forum->type) {
2962         case "news":
2963             $forum->name  = get_string("namenews", "forum");
2964             $forum->intro = get_string("intronews", "forum");
2965             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2966             $forum->assessed = 0;
2967             if ($courseid == SITEID) {
2968                 $forum->name  = get_string("sitenews");
2969                 $forum->forcesubscribe = 0;
2970             }
2971             break;
2972         case "social":
2973             $forum->name  = get_string("namesocial", "forum");
2974             $forum->intro = get_string("introsocial", "forum");
2975             $forum->assessed = 0;
2976             $forum->forcesubscribe = 0;
2977             break;
2978         case "blog":
2979             $forum->name = get_string('blogforum', 'forum');
2980             $forum->intro = get_string('introblog', 'forum');
2981             $forum->assessed = 0;
2982             $forum->forcesubscribe = 0;
2983             break;
2984         default:
2985             echo $OUTPUT->notification("That forum type doesn't exist!");
2986             return false;
2987             break;
2988     }
2990     $forum->timemodified = time();
2991     $forum->id = $DB->insert_record("forum", $forum);
2993     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
2994         echo $OUTPUT->notification("Could not find forum module!!");
2995         return false;
2996     }
2997     $mod = new stdClass();
2998     $mod->course = $courseid;
2999     $mod->module = $module->id;
3000     $mod->instance = $forum->id;
3001     $mod->section = 0;
3002     include_once("$CFG->dirroot/course/lib.php");
3003     if (! $mod->coursemodule = add_course_module($mod) ) {
3004         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
3005         return false;
3006     }
3007     $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
3008     return $DB->get_record("forum", array("id" => "$forum->id"));
3012 /**
3013  * Given the data about a posting, builds up the HTML to display it and
3014  * returns the HTML in a string.  This is designed for sending via HTML email.
3015  *
3016  * @global object
3017  * @param object $course
3018  * @param object $cm
3019  * @param object $forum
3020  * @param object $discussion
3021  * @param object $post
3022  * @param object $userform
3023  * @param object $userto
3024  * @param bool $ownpost
3025  * @param bool $reply
3026  * @param bool $link
3027  * @param bool $rate
3028  * @param string $footer
3029  * @return string
3030  */
3031 function forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
3032                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
3034     global $CFG, $OUTPUT;
3036     $modcontext = context_module::instance($cm->id);
3038     if (!isset($userto->viewfullnames[$forum->id])) {
3039         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
3040     } else {
3041         $viewfullnames = $userto->viewfullnames[$forum->id];
3042     }
3044     // add absolute file links
3045     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3047     // format the post body
3048     $options = new stdClass();
3049     $options->para = true;
3050     $formattedtext = format_text($post->message, $post->messageformat, $options, $course->id);
3052     $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
3054     $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
3055     $output .= $OUTPUT->user_picture($userfrom, array('courseid'=>$course->id));
3056     $output .= '</td>';
3058     if ($post->parent) {
3059         $output .= '<td class="topic">';
3060     } else {
3061         $output .= '<td class="topic starter">';
3062     }
3063     $output .= '<div class="subject">'.format_string($post->subject).'</div>';
3065     $fullname = fullname($userfrom, $viewfullnames);
3066     $by = new stdClass();
3067     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
3068     $by->date = userdate($post->modified, '', $userto->timezone);
3069     $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
3071     $output .= '</td></tr>';
3073     $output .= '<tr><td class="left side" valign="top">';
3075     if (isset($userfrom->groups)) {
3076         $groups = $userfrom->groups[$forum->id];
3077     } else {
3078         $groups = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
3079     }
3081     if ($groups) {
3082         $output .= print_group_picture($groups, $course->id, false, true, true);
3083     } else {
3084         $output .= '&nbsp;';
3085     }
3087     $output .= '</td><td class="content">';
3089     $attachments = forum_print_attachments($post, $cm, 'html');
3090     if ($attachments !== '') {
3091         $output .= '<div class="attachments">';
3092         $output .= $attachments;
3093         $output .= '</div>';
3094     }
3096     $output .= $formattedtext;
3098 // Commands
3099     $commands = array();
3101     if ($post->parent) {
3102         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
3103                       $post->discussion.'&amp;parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
3104     }
3106     if ($reply) {
3107         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
3108                       get_string('reply', 'forum').'</a>';
3109     }
3111     $output .= '<div class="commands">';
3112     $output .= implode(' | ', $commands);
3113     $output .= '</div>';
3115 // Context link to post if required
3116     if ($link) {
3117         $output .= '<div class="link">';
3118         $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
3119                      get_string('postincontext', 'forum').'</a>';
3120         $output .= '</div>';
3121     }
3123     if ($footer) {
3124         $output .= '<div class="footer">'.$footer.'</div>';
3125     }
3126     $output .= '</td></tr></table>'."\n\n";
3128     return $output;
3131 /**
3132  * Print a forum post
3133  *
3134  * @global object
3135  * @global object
3136  * @uses FORUM_MODE_THREADED
3137  * @uses PORTFOLIO_FORMAT_PLAINHTML
3138  * @uses PORTFOLIO_FORMAT_FILE
3139  * @uses PORTFOLIO_FORMAT_RICHHTML
3140  * @uses PORTFOLIO_ADD_TEXT_LINK
3141  * @uses CONTEXT_MODULE
3142  * @param object $post The post to print.
3143  * @param object $discussion
3144  * @param object $forum
3145  * @param object $cm
3146  * @param object $course
3147  * @param boolean $ownpost Whether this post belongs to the current user.
3148  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3149  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3150  * @param string $footer Extra stuff to print after the message.
3151  * @param string $highlight Space-separated list of terms to highlight.
3152  * @param int $post_read true, false or -99. If we already know whether this user
3153  *          has read this post, pass that in, otherwise, pass in -99, and this
3154  *          function will work it out.
3155  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3156  *          the current user can't see this post, if this argument is true
3157  *          (the default) then print a dummy 'you can't see this post' post.
3158  *          If false, don't output anything at all.
3159  * @param bool|null $istracked
3160  * @return void
3161  */
3162 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3163                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3164     global $USER, $CFG, $OUTPUT;
3166     require_once($CFG->libdir . '/filelib.php');
3168     // String cache
3169     static $str;
3171     $modcontext = context_module::instance($cm->id);
3173     $post->course = $course->id;
3174     $post->forum  = $forum->id;
3175     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3176     if (!empty($CFG->enableplagiarism)) {
3177         require_once($CFG->libdir.'/plagiarismlib.php');
3178         $post->message .= plagiarism_get_links(array('userid' => $post->userid,
3179             'content' => $post->message,
3180             'cmid' => $cm->id,
3181             'course' => $post->course,
3182             'forum' => $post->forum));
3183     }
3185     // caching
3186     if (!isset($cm->cache)) {
3187         $cm->cache = new stdClass;
3188     }
3190     if (!isset($cm->cache->caps)) {
3191         $cm->cache->caps = array();
3192         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3193         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3194         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3195         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3196         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3197         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3198         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3199         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3200         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3201     }
3203     if (!isset($cm->uservisible)) {
3204         $cm->uservisible = \core_availability\info_module::is_user_visible($cm, 0, false);
3205     }
3207     if ($istracked && is_null($postisread)) {
3208         $postisread = forum_tp_is_post_read($USER->id, $post);
3209     }
3211     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
3212         $output = '';
3213         if (!$dummyifcantsee) {
3214             if ($return) {
3215                 return $output;
3216             }
3217             echo $output;
3218             return;
3219         }
3220         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3221         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix',
3222                                                        'role' => 'region',
3223                                                        'aria-label' => get_string('hiddenforumpost', 'forum')));
3224         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3225         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3226         if ($post->parent) {
3227             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3228         } else {
3229             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3230         }
3231         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class' => 'subject',
3232                                                                                            'role' => 'header')); // Subject.
3233         $output .= html_writer::tag('div', get_string('forumauthorhidden', 'forum'), array('class' => 'author',
3234                                                                                            'role' => 'header')); // Author.
3235         $output .= html_writer::end_tag('div');
3236         $output .= html_writer::end_tag('div'); // row
3237         $output .= html_writer::start_tag('div', array('class'=>'row'));
3238         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3239         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3240         $output .= html_writer::end_tag('div'); // row
3241         $output .= html_writer::end_tag('div'); // forumpost
3243         if ($return) {
3244             return $output;
3245         }
3246         echo $output;
3247         return;
3248     }
3250     if (empty($str)) {
3251         $str = new stdClass;
3252         $str->edit         = get_string('edit', 'forum');
3253         $str->delete       = get_string('delete', 'forum');
3254         $str->reply        = get_string('reply', 'forum');
3255         $str->parent       = get_string('parent', 'forum');
3256         $str->pruneheading = get_string('pruneheading', 'forum');
3257         $str->prune        = get_string('prune', 'forum');
3258         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3259         $str->markread     = get_string('markread', 'forum');
3260         $str->markunread   = get_string('markunread', 'forum');
3261     }
3263     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3265     // Build an object that represents the posting user
3266     $postuser = new stdClass;
3267     $postuserfields = explode(',', user_picture::fields());
3268     $postuser = username_load_fields_from_object($postuser, $post, null, $postuserfields);
3269     $postuser->id = $post->userid;
3270     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3271     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3273     // Prepare the groups the posting user belongs to
3274     if (isset($cm->cache->usersgroups)) {
3275         $groups = array();
3276         if (isset($cm->cache->usersgroups[$post->userid])) {
3277             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3278                 $groups[$gid] = $cm->cache->groups[$gid];
3279             }
3280         }
3281     } else {
3282         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3283     }
3285     // Prepare the attachements for the post, files then images
3286     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3288     // Determine if we need to shorten this post
3289     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3292     // Prepare an array of commands
3293     $commands = array();
3295     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3296     // Don't display the mark read / unread controls in this case.
3297     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3298         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3299         $text = $str->markunread;
3300         if (!$postisread) {
3301             $url->param('mark', 'read');
3302             $text = $str->markread;
3303         }
3304         if ($str->displaymode == FORUM_MODE_THREADED) {
3305             $url->param('parent', $post->parent);
3306         } else {
3307             $url->set_anchor('p'.$post->id);
3308         }
3309         $commands[] = array('url'=>$url, 'text'=>$text);
3310     }
3312     // Zoom in to the parent specifically
3313     if ($post->parent) {
3314         $url = new moodle_url($discussionlink);
3315         if ($str->displaymode == FORUM_MODE_THREADED) {
3316             $url->param('parent', $post->parent);
3317         } else {
3318             $url->set_anchor('p'.$post->parent);
3319         }
3320         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3321     }
3323     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3324     $age = time() - $post->created;
3325     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3326         $age = 0;
3327     }
3329     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3330         if (has_capability('moodle/course:manageactivities', $modcontext)) {
3331             // The first post in single simple is the forum description.
3332             $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
3333         }
3334     } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3335         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3336     }
3338     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3339         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3340     }
3342     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3343         // Do not allow deleting of first post in single simple type.
3344     } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3345         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3346     }
3348     if ($reply) {
3349         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
3350     }
3352     if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
3353         $p = array('postid' => $post->id);
3354         require_once($CFG->libdir.'/portfoliolib.php');
3355         $button = new portfolio_add_button();
3356         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
3357         if (empty($attachments)) {
3358             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3359         } else {
3360             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3361         }
3363         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3364         if (!empty($porfoliohtml)) {
3365             $commands[] = $porfoliohtml;
3366         }
3367     }
3368     // Finished building commands
3371     // Begin output
3373     $output  = '';
3375     if ($istracked) {
3376         if ($postisread) {
3377             $forumpostclass = ' read';
3378         } else {
3379             $forumpostclass = ' unread';
3380             $output .= html_writer::tag('a', '', array('name'=>'unread'));
3381         }
3382     } else {
3383         // ignore trackign status if not tracked or tracked param missing
3384         $forumpostclass = '';
3385     }
3387     $topicclass = '';
3388     if (empty($post->parent)) {
3389         $topicclass = ' firstpost starter';
3390     }
3392     $postbyuser = new stdClass;
3393     $postbyuser->post = $post->subject;
3394     $postbyuser->user = $postuser->fullname;
3395     $discussionbyuser = get_string('postbyuser', 'forum', $postbyuser);
3396     $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3397     $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass,
3398                                                    'role' => 'region',
3399                                                    'aria-label' => $discussionbyuser));
3400     $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
3401     $output .= html_writer::start_tag('div', array('class'=>'left picture'));
3402     $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
3403     $output .= html_writer::end_tag('div');
3406     $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
3408     $postsubject = $post->subject;
3409     if (empty($post->subjectnoformat)) {
3410         $postsubject = format_string($postsubject);
3411     }
3412     $output .= html_writer::tag('div', $postsubject, array('class'=>'subject',
3413                                                            'role' => 'heading',
3414                                                            'aria-level' => '2'));
3416     $by = new stdClass();
3417     $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
3418     $by->date = userdate($post->modified);
3419     $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author',
3420                                                                                        'role' => 'heading',
3421                                                                                        'aria-level' => '2'));
3423     $output .= html_writer::end_tag('div'); //topic
3424     $output .= html_writer::end_tag('div'); //row
3426     $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
3427     $output .= html_writer::start_tag('div', array('class'=>'left'));
3429     $groupoutput = '';
3430     if ($groups) {
3431         $groupoutput = print_group_picture($groups, $course->id, false, true, true);
3432     }
3433     if (empty($groupoutput)) {
3434         $groupoutput = '&nbsp;';
3435     }
3436     $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
3438     $output .= html_writer::end_tag('div'); //left side
3439     $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
3440     $output .= html_writer::start_tag('div', array('class'=>'content'));
3442     $options = new stdClass;
3443     $options->para    = false;
3444     $options->trusted = $post->messagetrust;
3445     $options->context = $modcontext;
3446     if ($shortenpost) {
3447         // Prepare shortened version by filtering the text then shortening it.
3448         $postclass    = 'shortenedpost';
3449         $postcontent  = format_text($post->message, $post->messageformat, $options);
3450         $postcontent  = shorten_text($postcontent, $CFG->forum_shortpost);
3451         $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
3452         $postcontent .= html_writer::tag('div', '('.get_string('numwords', 'moodle', count_words($post->message)).')',
3453             array('class'=>'post-word-count'));
3454     } else {
3455         // Prepare whole post
3456         $postclass    = 'fullpost';
3457         $postcontent  = format_text($post->message, $post->messageformat, $options, $course->id);
3458         if (!empty($highlight)) {
3459             $postcontent = highlight($highlight, $postcontent);
3460         }
3461         if (!empty($forum->displaywordcount)) {
3462             $postcontent .= html_writer::tag('div', get_string('numwords', 'moodle', count_words($post->message)),
3463                 array('class'=>'post-word-count'));
3464         }
3465         $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
3466     }
3468     // Output the post content
3469     $output .= html_writer: