d400f4748052a32fb27fd824b061b815934b86e8
[moodle.git] / mod / forum / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * @package   mod_forum
19  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
20  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
21  */
23 defined('MOODLE_INTERNAL') || die();
25 /** Include required files */
26 require_once(__DIR__ . '/deprecatedlib.php');
27 require_once($CFG->libdir.'/filelib.php');
28 require_once($CFG->libdir.'/eventslib.php');
30 /// CONSTANTS ///////////////////////////////////////////////////////////
32 define('FORUM_MODE_FLATOLDEST', 1);
33 define('FORUM_MODE_FLATNEWEST', -1);
34 define('FORUM_MODE_THREADED', 2);
35 define('FORUM_MODE_NESTED', 3);
37 define('FORUM_CHOOSESUBSCRIBE', 0);
38 define('FORUM_FORCESUBSCRIBE', 1);
39 define('FORUM_INITIALSUBSCRIBE', 2);
40 define('FORUM_DISALLOWSUBSCRIBE',3);
42 /**
43  * FORUM_TRACKING_OFF - Tracking is not available for this forum.
44  */
45 define('FORUM_TRACKING_OFF', 0);
47 /**
48  * FORUM_TRACKING_OPTIONAL - Tracking is based on user preference.
49  */
50 define('FORUM_TRACKING_OPTIONAL', 1);
52 /**
53  * FORUM_TRACKING_FORCED - Tracking is on, regardless of user setting.
54  * Treated as FORUM_TRACKING_OPTIONAL if $CFG->forum_allowforcedreadtracking is off.
55  */
56 define('FORUM_TRACKING_FORCED', 2);
58 define('FORUM_MAILED_PENDING', 0);
59 define('FORUM_MAILED_SUCCESS', 1);
60 define('FORUM_MAILED_ERROR', 2);
62 if (!defined('FORUM_CRON_USER_CACHE')) {
63     /** Defines how many full user records are cached in forum cron. */
64     define('FORUM_CRON_USER_CACHE', 5000);
65 }
67 /// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
69 /**
70  * Given an object containing all the necessary data,
71  * (defined by the form in mod_form.php) this function
72  * will create a new instance and return the id number
73  * of the new instance.
74  *
75  * @param stdClass $forum add forum instance
76  * @param mod_forum_mod_form $mform
77  * @return int intance id
78  */
79 function forum_add_instance($forum, $mform = null) {
80     global $CFG, $DB;
82     $forum->timemodified = time();
84     if (empty($forum->assessed)) {
85         $forum->assessed = 0;
86     }
88     if (empty($forum->ratingtime) or empty($forum->assessed)) {
89         $forum->assesstimestart  = 0;
90         $forum->assesstimefinish = 0;
91     }
93     $forum->id = $DB->insert_record('forum', $forum);
94     $modcontext = context_module::instance($forum->coursemodule);
96     if ($forum->type == 'single') {  // Create related discussion.
97         $discussion = new stdClass();
98         $discussion->course        = $forum->course;
99         $discussion->forum         = $forum->id;
100         $discussion->name          = $forum->name;
101         $discussion->assessed      = $forum->assessed;
102         $discussion->message       = $forum->intro;
103         $discussion->messageformat = $forum->introformat;
104         $discussion->messagetrust  = trusttext_trusted(context_course::instance($forum->course));
105         $discussion->mailnow       = false;
106         $discussion->groupid       = -1;
108         $message = '';
110         $discussion->id = forum_add_discussion($discussion, null, $message);
112         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
113             // Ugly hack - we need to copy the files somehow.
114             $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
115             $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
117             $options = array('subdirs'=>true); // Use the same options as intro field!
118             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
119             $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
120         }
121     }
123     forum_grade_item_update($forum);
125     return $forum->id;
128 /**
129  * Handle changes following the creation of a forum instance.
130  * This function is typically called by the course_module_created observer.
131  *
132  * @param object $context the forum context
133  * @param stdClass $forum The forum object
134  * @return void
135  */
136 function forum_instance_created($context, $forum) {
137     if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
138         $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email');
139         foreach ($users as $user) {
140             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context);
141         }
142     }
145 /**
146  * Given an object containing all the necessary data,
147  * (defined by the form in mod_form.php) this function
148  * will update an existing instance with new data.
149  *
150  * @global object
151  * @param object $forum forum instance (with magic quotes)
152  * @return bool success
153  */
154 function forum_update_instance($forum, $mform) {
155     global $DB, $OUTPUT, $USER;
157     $forum->timemodified = time();
158     $forum->id           = $forum->instance;
160     if (empty($forum->assessed)) {
161         $forum->assessed = 0;
162     }
164     if (empty($forum->ratingtime) or empty($forum->assessed)) {
165         $forum->assesstimestart  = 0;
166         $forum->assesstimefinish = 0;
167     }
169     $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
171     // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
172     // if  scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
173     // for count and sum aggregation types the grade we check to make sure they do not exceed the scale (i.e. max score) when calculating the grade
174     if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
175         forum_update_grades($forum); // recalculate grades for the forum
176     }
178     if ($forum->type == 'single') {  // Update related discussion and post.
179         $discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC');
180         if (!empty($discussions)) {
181             if (count($discussions) > 1) {
182                 echo $OUTPUT->notification(get_string('warnformorepost', 'forum'));
183             }
184             $discussion = array_pop($discussions);
185         } else {
186             // try to recover by creating initial discussion - MDL-16262
187             $discussion = new stdClass();
188             $discussion->course          = $forum->course;
189             $discussion->forum           = $forum->id;
190             $discussion->name            = $forum->name;
191             $discussion->assessed        = $forum->assessed;
192             $discussion->message         = $forum->intro;
193             $discussion->messageformat   = $forum->introformat;
194             $discussion->messagetrust    = true;
195             $discussion->mailnow         = false;
196             $discussion->groupid         = -1;
198             $message = '';
200             forum_add_discussion($discussion, null, $message);
202             if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
203                 print_error('cannotadd', 'forum');
204             }
205         }
206         if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
207             print_error('cannotfindfirstpost', 'forum');
208         }
210         $cm         = get_coursemodule_from_instance('forum', $forum->id);
211         $modcontext = context_module::instance($cm->id, MUST_EXIST);
213         $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
214         $post->subject       = $forum->name;
215         $post->message       = $forum->intro;
216         $post->messageformat = $forum->introformat;
217         $post->messagetrust  = trusttext_trusted($modcontext);
218         $post->modified      = $forum->timemodified;
219         $post->userid        = $USER->id;    // MDL-18599, so that current teacher can take ownership of activities.
221         if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
222             // Ugly hack - we need to copy the files somehow.
223             $options = array('subdirs'=>true); // Use the same options as intro field!
224             $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
225         }
227         $DB->update_record('forum_posts', $post);
228         $discussion->name = $forum->name;
229         $DB->update_record('forum_discussions', $discussion);
230     }
232     $DB->update_record('forum', $forum);
234     $modcontext = context_module::instance($forum->coursemodule);
235     if (($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) && ($oldforum->forcesubscribe <> $forum->forcesubscribe)) {
236         $users = \mod_forum\subscriptions::get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
237         foreach ($users as $user) {
238             \mod_forum\subscriptions::subscribe_user($user->id, $forum, $modcontext);
239         }
240     }
242     forum_grade_item_update($forum);
244     return true;
248 /**
249  * Given an ID of an instance of this module,
250  * this function will permanently delete the instance
251  * and any data that depends on it.
252  *
253  * @global object
254  * @param int $id forum instance id
255  * @return bool success
256  */
257 function forum_delete_instance($id) {
258     global $DB;
260     if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
261         return false;
262     }
263     if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
264         return false;
265     }
266     if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
267         return false;
268     }
270     $context = context_module::instance($cm->id);
272     // now get rid of all files
273     $fs = get_file_storage();
274     $fs->delete_area_files($context->id);
276     $result = true;
278     // Delete digest and subscription preferences.
279     $DB->delete_records('forum_digests', array('forum' => $forum->id));
280     $DB->delete_records('forum_subscriptions', array('forum'=>$forum->id));
281     $DB->delete_records('forum_discussion_subs', array('forum' => $forum->id));
283     if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
284         foreach ($discussions as $discussion) {
285             if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
286                 $result = false;
287             }
288         }
289     }
291     forum_tp_delete_read_records(-1, -1, -1, $forum->id);
293     if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
294         $result = false;
295     }
297     forum_grade_item_delete($forum);
299     return $result;
303 /**
304  * Indicates API features that the forum supports.
305  *
306  * @uses FEATURE_GROUPS
307  * @uses FEATURE_GROUPINGS
308  * @uses FEATURE_MOD_INTRO
309  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
310  * @uses FEATURE_COMPLETION_HAS_RULES
311  * @uses FEATURE_GRADE_HAS_GRADE
312  * @uses FEATURE_GRADE_OUTCOMES
313  * @param string $feature
314  * @return mixed True if yes (some features may use other values)
315  */
316 function forum_supports($feature) {
317     switch($feature) {
318         case FEATURE_GROUPS:                  return true;
319         case FEATURE_GROUPINGS:               return true;
320         case FEATURE_MOD_INTRO:               return true;
321         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
322         case FEATURE_COMPLETION_HAS_RULES:    return true;
323         case FEATURE_GRADE_HAS_GRADE:         return true;
324         case FEATURE_GRADE_OUTCOMES:          return true;
325         case FEATURE_RATE:                    return true;
326         case FEATURE_BACKUP_MOODLE2:          return true;
327         case FEATURE_SHOW_DESCRIPTION:        return true;
328         case FEATURE_PLAGIARISM:              return true;
330         default: return null;
331     }
335 /**
336  * Obtains the automatic completion state for this forum based on any conditions
337  * in forum settings.
338  *
339  * @global object
340  * @global object
341  * @param object $course Course
342  * @param object $cm Course-module
343  * @param int $userid User ID
344  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
345  * @return bool True if completed, false if not. (If no conditions, then return
346  *   value depends on comparison type)
347  */
348 function forum_get_completion_state($course,$cm,$userid,$type) {
349     global $CFG,$DB;
351     // Get forum details
352     if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
353         throw new Exception("Can't find forum {$cm->instance}");
354     }
356     $result=$type; // Default return value
358     $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
359     $postcountsql="
360 SELECT
361     COUNT(1)
362 FROM
363     {forum_posts} fp
364     INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
365 WHERE
366     fp.userid=:userid AND fd.forum=:forumid";
368     if ($forum->completiondiscussions) {
369         $value = $forum->completiondiscussions <=
370                  $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
371         if ($type == COMPLETION_AND) {
372             $result = $result && $value;
373         } else {
374             $result = $result || $value;
375         }
376     }
377     if ($forum->completionreplies) {
378         $value = $forum->completionreplies <=
379                  $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
380         if ($type==COMPLETION_AND) {
381             $result = $result && $value;
382         } else {
383             $result = $result || $value;
384         }
385     }
386     if ($forum->completionposts) {
387         $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
388         if ($type == COMPLETION_AND) {
389             $result = $result && $value;
390         } else {
391             $result = $result || $value;
392         }
393     }
395     return $result;
398 /**
399  * Create a message-id string to use in the custom headers of forum notification emails
400  *
401  * message-id is used by email clients to identify emails and to nest conversations
402  *
403  * @param int $postid The ID of the forum post we are notifying the user about
404  * @param int $usertoid The ID of the user being notified
405  * @param string $hostname The server's hostname
406  * @return string A unique message-id
407  */
408 function forum_get_email_message_id($postid, $usertoid, $hostname) {
409     return '<'.hash('sha256',$postid.'to'.$usertoid).'@'.$hostname.'>';
412 /**
413  * Removes properties from user record that are not necessary
414  * for sending post notifications.
415  * @param stdClass $user
416  * @return void, $user parameter is modified
417  */
418 function forum_cron_minimise_user_record(stdClass $user) {
420     // We store large amount of users in one huge array,
421     // make sure we do not store info there we do not actually need
422     // in mail generation code or messaging.
424     unset($user->institution);
425     unset($user->department);
426     unset($user->address);
427     unset($user->city);
428     unset($user->url);
429     unset($user->currentlogin);
430     unset($user->description);
431     unset($user->descriptionformat);
434 /**
435  * Function to be run periodically according to the scheduled task.
436  *
437  * Finds all posts that have yet to be mailed out, and mails them
438  * out to all subscribers as well as other maintance tasks.
439  *
440  * NOTE: Since 2.7.2 this function is run by scheduled task rather
441  * than standard cron.
442  *
443  * @todo MDL-44734 The function will be split up into seperate tasks.
444  */
445 function forum_cron() {
446     global $CFG, $USER, $DB;
448     $site = get_site();
450     // All users that are subscribed to any post that needs sending,
451     // please increase $CFG->extramemorylimit on large sites that
452     // send notifications to a large number of users.
453     $users = array();
454     $userscount = 0; // Cached user counter - count($users) in PHP is horribly slow!!!
456     // Status arrays.
457     $mailcount  = array();
458     $errorcount = array();
460     // caches
461     $discussions        = array();
462     $forums             = array();
463     $courses            = array();
464     $coursemodules      = array();
465     $subscribedusers    = array();
466     $messageinboundhandlers = array();
468     // Posts older than 2 days will not be mailed.  This is to avoid the problem where
469     // cron has not been running for a long time, and then suddenly people are flooded
470     // with mail from the past few weeks or months
471     $timenow   = time();
472     $endtime   = $timenow - $CFG->maxeditingtime;
473     $starttime = $endtime - 48 * 3600;   // Two days earlier
475     // Get the list of forum subscriptions for per-user per-forum maildigest settings.
476     $digestsset = $DB->get_recordset('forum_digests', null, '', 'id, userid, forum, maildigest');
477     $digests = array();
478     foreach ($digestsset as $thisrow) {
479         if (!isset($digests[$thisrow->forum])) {
480             $digests[$thisrow->forum] = array();
481         }
482         $digests[$thisrow->forum][$thisrow->userid] = $thisrow->maildigest;
483     }
484     $digestsset->close();
486     // Create the generic messageinboundgenerator.
487     $messageinboundgenerator = new \core\message\inbound\address_manager();
488     $messageinboundgenerator->set_handler('\mod_forum\message\inbound\reply_handler');
490     if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
491         // Mark them all now as being mailed.  It's unlikely but possible there
492         // might be an error later so that a post is NOT actually mailed out,
493         // but since mail isn't crucial, we can accept this risk.  Doing it now
494         // prevents the risk of duplicated mails, which is a worse problem.
496         if (!forum_mark_old_posts_as_mailed($endtime)) {
497             mtrace('Errors occurred while trying to mark some posts as being mailed.');
498             return false;  // Don't continue trying to mail them, in case we are in a cron loop
499         }
501         // checking post validity, and adding users to loop through later
502         foreach ($posts as $pid => $post) {
504             $discussionid = $post->discussion;
505             if (!isset($discussions[$discussionid])) {
506                 if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
507                     $discussions[$discussionid] = $discussion;
508                     \mod_forum\subscriptions::fill_subscription_cache($discussion->forum);
509                     \mod_forum\subscriptions::fill_discussion_subscription_cache($discussion->forum);
511                 } else {
512                     mtrace('Could not find discussion ' . $discussionid);
513                     unset($posts[$pid]);
514                     continue;
515                 }
516             }
517             $forumid = $discussions[$discussionid]->forum;
518             if (!isset($forums[$forumid])) {
519                 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
520                     $forums[$forumid] = $forum;
521                 } else {
522                     mtrace('Could not find forum '.$forumid);
523                     unset($posts[$pid]);
524                     continue;
525                 }
526             }
527             $courseid = $forums[$forumid]->course;
528             if (!isset($courses[$courseid])) {
529                 if ($course = $DB->get_record('course', array('id' => $courseid))) {
530                     $courses[$courseid] = $course;
531                 } else {
532                     mtrace('Could not find course '.$courseid);
533                     unset($posts[$pid]);
534                     continue;
535                 }
536             }
537             if (!isset($coursemodules[$forumid])) {
538                 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
539                     $coursemodules[$forumid] = $cm;
540                 } else {
541                     mtrace('Could not find course module for forum '.$forumid);
542                     unset($posts[$pid]);
543                     continue;
544                 }
545             }
547             // Save the Inbound Message datakey here to reduce DB queries later.
548             $messageinboundgenerator->set_data($pid);
549             $messageinboundhandlers[$pid] = $messageinboundgenerator->fetch_data_key();
551             // Caching subscribed users of each forum.
552             if (!isset($subscribedusers[$forumid])) {
553                 $modcontext = context_module::instance($coursemodules[$forumid]->id);
554                 if ($subusers = \mod_forum\subscriptions::fetch_subscribed_users($forums[$forumid], 0, $modcontext, 'u.*', true)) {
556                     foreach ($subusers as $postuser) {
557                         // this user is subscribed to this forum
558                         $subscribedusers[$forumid][$postuser->id] = $postuser->id;
559                         $userscount++;
560                         if ($userscount > FORUM_CRON_USER_CACHE) {
561                             // Store minimal user info.
562                             $minuser = new stdClass();
563                             $minuser->id = $postuser->id;
564                             $users[$postuser->id] = $minuser;
565                         } else {
566                             // Cache full user record.
567                             forum_cron_minimise_user_record($postuser);
568                             $users[$postuser->id] = $postuser;
569                         }
570                     }
571                     // Release memory.
572                     unset($subusers);
573                     unset($postuser);
574                 }
575             }
576             $mailcount[$pid] = 0;
577             $errorcount[$pid] = 0;
578         }
579     }
581     if ($users && $posts) {
583         $urlinfo = parse_url($CFG->wwwroot);
584         $hostname = $urlinfo['host'];
586         foreach ($users as $userto) {
587             // Terminate if processing of any account takes longer than 2 minutes.
588             core_php_time_limit::raise(120);
590             mtrace('Processing user ' . $userto->id);
592             // Init user caches - we keep the cache for one cycle only, otherwise it could consume too much memory.
593             if (isset($userto->username)) {
594                 $userto = clone($userto);
595             } else {
596                 $userto = $DB->get_record('user', array('id' => $userto->id));
597                 forum_cron_minimise_user_record($userto);
598             }
599             $userto->viewfullnames = array();
600             $userto->canpost       = array();
601             $userto->markposts     = array();
603             // Setup this user so that the capabilities are cached, and environment matches receiving user.
604             cron_setup_user($userto);
606             // Reset the caches.
607             foreach ($coursemodules as $forumid => $unused) {
608                 $coursemodules[$forumid]->cache       = new stdClass();
609                 $coursemodules[$forumid]->cache->caps = array();
610                 unset($coursemodules[$forumid]->uservisible);
611             }
613             foreach ($posts as $pid => $post) {
614                 $discussion = $discussions[$post->discussion];
615                 $forum      = $forums[$discussion->forum];
616                 $course     = $courses[$forum->course];
617                 $cm         =& $coursemodules[$forum->id];
619                 // Do some checks to see if we can bail out now.
621                 // Only active enrolled users are in the list of subscribers.
622                 // This does not necessarily mean that the user is subscribed to the forum or to the discussion though.
623                 if (!isset($subscribedusers[$forum->id][$userto->id])) {
624                     // The user does not subscribe to this forum.
625                     continue;
626                 }
628                 if (!\mod_forum\subscriptions::is_subscribed($userto->id, $forum, $post->discussion, $coursemodules[$forum->id])) {
629                     // The user does not subscribe to this forum, or to this specific discussion.
630                     continue;
631                 }
633                 if ($subscriptiontime = \mod_forum\subscriptions::fetch_discussion_subscription($forum->id, $userto->id)) {
634                     // Skip posts if the user subscribed to the discussion after it was created.
635                     if (isset($subscriptiontime[$post->discussion]) && ($subscriptiontime[$post->discussion] > $post->created)) {
636                         continue;
637                     }
638                 }
640                 // Don't send email if the forum is Q&A and the user has not posted.
641                 // Initial topics are still mailed.
642                 if ($forum->type == 'qanda' && !forum_get_user_posted_time($discussion->id, $userto->id) && $pid != $discussion->firstpost) {
643                     mtrace('Did not email ' . $userto->id.' because user has not posted in discussion');
644                     continue;
645                 }
647                 // Get info about the sending user.
648                 if (array_key_exists($post->userid, $users)) {
649                     // We might know the user already.
650                     $userfrom = $users[$post->userid];
651                     if (!isset($userfrom->idnumber)) {
652                         // Minimalised user info, fetch full record.
653                         $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
654                         forum_cron_minimise_user_record($userfrom);
655                     }
657                 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
658                     forum_cron_minimise_user_record($userfrom);
659                     // Fetch only once if possible, we can add it to user list, it will be skipped anyway.
660                     if ($userscount <= FORUM_CRON_USER_CACHE) {
661                         $userscount++;
662                         $users[$userfrom->id] = $userfrom;
663                     }
664                 } else {
665                     mtrace('Could not find user ' . $post->userid . ', author of post ' . $post->id . '. Unable to send message.');
666                     continue;
667                 }
669                 // Note: If we want to check that userto and userfrom are not the same person this is probably the spot to do it.
671                 // Setup global $COURSE properly - needed for roles and languages.
672                 cron_setup_user($userto, $course);
674                 // Fill caches.
675                 if (!isset($userto->viewfullnames[$forum->id])) {
676                     $modcontext = context_module::instance($cm->id);
677                     $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
678                 }
679                 if (!isset($userto->canpost[$discussion->id])) {
680                     $modcontext = context_module::instance($cm->id);
681                     $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
682                 }
683                 if (!isset($userfrom->groups[$forum->id])) {
684                     if (!isset($userfrom->groups)) {
685                         $userfrom->groups = array();
686                         if (isset($users[$userfrom->id])) {
687                             $users[$userfrom->id]->groups = array();
688                         }
689                     }
690                     $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
691                     if (isset($users[$userfrom->id])) {
692                         $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
693                     }
694                 }
696                 // Make sure groups allow this user to see this email.
697                 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {
698                     // Groups are being used.
699                     if (!groups_group_exists($discussion->groupid)) {
700                         // Can't find group - be safe and don't this message.
701                         continue;
702                     }
704                     if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
705                         // Do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS.
706                         continue;
707                     }
708                 }
710                 // Make sure we're allowed to see the post.
711                 if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
712                     mtrace('User ' . $userto->id .' can not see ' . $post->id . '. Not sending message.');
713                     continue;
714                 }
716                 // OK so we need to send the email.
718                 // Does the user want this post in a digest?  If so postpone it for now.
719                 $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
721                 if ($maildigest > 0) {
722                     // This user wants the mails to be in digest form.
723                     $queue = new stdClass();
724                     $queue->userid       = $userto->id;
725                     $queue->discussionid = $discussion->id;
726                     $queue->postid       = $post->id;
727                     $queue->timemodified = $post->created;
728                     $DB->insert_record('forum_queue', $queue);
729                     continue;
730                 }
732                 // Prepare to actually send the post now, and build up the content.
734                 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
736                 $userfrom->customheaders = array (
737                     // Headers to make emails easier to track.
738                     'List-Id: "'        . $cleanforumname . '" <moodleforum' . $forum->id . '@' . $hostname.'>',
739                     'List-Help: '       . $CFG->wwwroot . '/mod/forum/view.php?f=' . $forum->id,
740                     'Message-ID: '      . forum_get_email_message_id($post->id, $userto->id, $hostname),
741                     'X-Course-Id: '     . $course->id,
742                     'X-Course-Name: '   . format_string($course->fullname, true),
744                     // Headers to help prevent auto-responders.
745                     'Precedence: Bulk',
746                     'X-Auto-Response-Suppress: All',
747                     'Auto-Submitted: auto-generated',
748                 );
750                 if ($post->parent) {
751                     // This post is a reply, so add headers for threading (see MDL-22551).
752                     $userfrom->customheaders[] = 'In-Reply-To: ' . forum_get_email_message_id($post->parent, $userto->id, $hostname);
753                     $userfrom->customheaders[] = 'References: '  . forum_get_email_message_id($post->parent, $userto->id, $hostname);
754                 }
756                 $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
758                 // Generate a reply-to address from using the Inbound Message handler.
759                 $replyaddress = null;
760                 if ($userto->canpost[$discussion->id] && array_key_exists($post->id, $messageinboundhandlers)) {
761                     $messageinboundgenerator->set_data($post->id, $messageinboundhandlers[$post->id]);
762                     $replyaddress = $messageinboundgenerator->generate($userto->id);
763                 }
765                 $a = new stdClass();
766                 $a->courseshortname = $shortname;
767                 $a->forumname = $cleanforumname;
768                 $a->subject = format_string($post->subject, true);
769                 $postsubject = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
770                 $posttext = forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false,
771                         $replyaddress);
772                 $posthtml = forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
773                         $replyaddress);
775                 // Send the post now!
776                 mtrace('Sending ', '');
778                 $eventdata = new stdClass();
779                 $eventdata->component           = 'mod_forum';
780                 $eventdata->name                = 'posts';
781                 $eventdata->userfrom            = $userfrom;
782                 $eventdata->userto              = $userto;
783                 $eventdata->subject             = $postsubject;
784                 $eventdata->fullmessage         = $posttext;
785                 $eventdata->fullmessageformat   = FORMAT_PLAIN;
786                 $eventdata->fullmessagehtml     = $posthtml;
787                 $eventdata->notification        = 1;
788                 $eventdata->replyto             = $replyaddress;
790                 // If forum_replytouser is not set then send mail using the noreplyaddress.
791                 if (empty($CFG->forum_replytouser)) {
792                     // Clone userfrom as it is referenced by $users.
793                     $cloneduserfrom = clone($userfrom);
794                     $cloneduserfrom->email = $CFG->noreplyaddress;
795                     $eventdata->userfrom = $cloneduserfrom;
796                 }
798                 $smallmessagestrings = new stdClass();
799                 $smallmessagestrings->user          = fullname($userfrom);
800                 $smallmessagestrings->forumname     = "$shortname: " . format_string($forum->name, true) . ": " . $discussion->name;
801                 $smallmessagestrings->message       = $post->message;
803                 // Make sure strings are in message recipients language.
804                 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
806                 $contexturl = new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id), 'p' . $post->id);
807                 $eventdata->contexturl = $contexturl->out();
808                 $eventdata->contexturlname = $discussion->name;
810                 $mailresult = message_send($eventdata);
811                 if (!$mailresult) {
812                     mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
813                             " ($userto->email) .. not trying again.");
814                     $errorcount[$post->id]++;
815                 } else {
816                     $mailcount[$post->id]++;
818                     // Mark post as read if forum_usermarksread is set off.
819                     if (!$CFG->forum_usermarksread) {
820                         $userto->markposts[$post->id] = $post->id;
821                     }
822                 }
824                 mtrace('post ' . $post->id . ': ' . $post->subject);
825             }
827             // Mark processed posts as read.
828             forum_tp_mark_posts_read($userto, $userto->markposts);
829             unset($userto);
830         }
831     }
833     if ($posts) {
834         foreach ($posts as $post) {
835             mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
836             if ($errorcount[$post->id]) {
837                 $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
838             }
839         }
840     }
842     // release some memory
843     unset($subscribedusers);
844     unset($mailcount);
845     unset($errorcount);
847     cron_setup_user();
849     $sitetimezone = $CFG->timezone;
851     // Now see if there are any digest mails waiting to be sent, and if we should send them
853     mtrace('Starting digest processing...');
855     core_php_time_limit::raise(300); // terminate if not able to fetch all digests in 5 minutes
857     if (!isset($CFG->digestmailtimelast)) {    // To catch the first time
858         set_config('digestmailtimelast', 0);
859     }
861     $timenow = time();
862     $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
864     // Delete any really old ones (normally there shouldn't be any)
865     $weekago = $timenow - (7 * 24 * 3600);
866     $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
867     mtrace ('Cleaned old digest records');
869     if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
871         mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
873         $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
875         if ($digestposts_rs->valid()) {
877             // We have work to do
878             $usermailcount = 0;
880             //caches - reuse the those filled before too
881             $discussionposts = array();
882             $userdiscussions = array();
884             foreach ($digestposts_rs as $digestpost) {
885                 if (!isset($posts[$digestpost->postid])) {
886                     if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
887                         $posts[$digestpost->postid] = $post;
888                     } else {
889                         continue;
890                     }
891                 }
892                 $discussionid = $digestpost->discussionid;
893                 if (!isset($discussions[$discussionid])) {
894                     if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
895                         $discussions[$discussionid] = $discussion;
896                     } else {
897                         continue;
898                     }
899                 }
900                 $forumid = $discussions[$discussionid]->forum;
901                 if (!isset($forums[$forumid])) {
902                     if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
903                         $forums[$forumid] = $forum;
904                     } else {
905                         continue;
906                     }
907                 }
909                 $courseid = $forums[$forumid]->course;
910                 if (!isset($courses[$courseid])) {
911                     if ($course = $DB->get_record('course', array('id' => $courseid))) {
912                         $courses[$courseid] = $course;
913                     } else {
914                         continue;
915                     }
916                 }
918                 if (!isset($coursemodules[$forumid])) {
919                     if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
920                         $coursemodules[$forumid] = $cm;
921                     } else {
922                         continue;
923                     }
924                 }
925                 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
926                 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
927             }
928             $digestposts_rs->close(); /// Finished iteration, let's close the resultset
930             // Data collected, start sending out emails to each user
931             foreach ($userdiscussions as $userid => $thesediscussions) {
933                 core_php_time_limit::raise(120); // terminate if processing of any account takes longer than 2 minutes
935                 cron_setup_user();
937                 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
939                 // First of all delete all the queue entries for this user
940                 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
942                 // Init user caches - we keep the cache for one cycle only,
943                 // otherwise it would unnecessarily consume memory.
944                 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
945                     $userto = clone($users[$userid]);
946                 } else {
947                     $userto = $DB->get_record('user', array('id' => $userid));
948                     forum_cron_minimise_user_record($userto);
949                 }
950                 $userto->viewfullnames = array();
951                 $userto->canpost       = array();
952                 $userto->markposts     = array();
954                 // Override the language and timezone of the "current" user, so that
955                 // mail is customised for the receiver.
956                 cron_setup_user($userto);
958                 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
960                 $headerdata = new stdClass();
961                 $headerdata->sitename = format_string($site->fullname, true);
962                 $headerdata->userprefs = $CFG->wwwroot.'/user/edit.php?id='.$userid.'&amp;course='.$site->id;
964                 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
965                 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
967                 $posthtml = "<head>";
968 /*                foreach ($CFG->stylesheets as $stylesheet) {
969                     //TODO: MDL-21120
970                     $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
971                 }*/
972                 $posthtml .= "</head>\n<body id=\"email\">\n";
973                 $posthtml .= '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p><br /><hr size="1" noshade="noshade" />';
975                 foreach ($thesediscussions as $discussionid) {
977                     core_php_time_limit::raise(120);   // to be reset for each post
979                     $discussion = $discussions[$discussionid];
980                     $forum      = $forums[$discussion->forum];
981                     $course     = $courses[$forum->course];
982                     $cm         = $coursemodules[$forum->id];
984                     //override language
985                     cron_setup_user($userto, $course);
987                     // Fill caches
988                     if (!isset($userto->viewfullnames[$forum->id])) {
989                         $modcontext = context_module::instance($cm->id);
990                         $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
991                     }
992                     if (!isset($userto->canpost[$discussion->id])) {
993                         $modcontext = context_module::instance($cm->id);
994                         $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
995                     }
997                     $strforums      = get_string('forums', 'forum');
998                     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
999                     $canreply       = $userto->canpost[$discussion->id];
1000                     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1002                     $posttext .= "\n \n";
1003                     $posttext .= '=====================================================================';
1004                     $posttext .= "\n \n";
1005                     $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1006                     if ($discussion->name != $forum->name) {
1007                         $posttext  .= " -> ".format_string($discussion->name,true);
1008                     }
1009                     $posttext .= "\n";
1010                     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1011                     $posttext .= "\n";
1013                     $posthtml .= "<p><font face=\"sans-serif\">".
1014                     "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
1015                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
1016                     "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
1017                     if ($discussion->name == $forum->name) {
1018                         $posthtml .= "</font></p>";
1019                     } else {
1020                         $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
1021                     }
1022                     $posthtml .= '<p>';
1024                     $postsarray = $discussionposts[$discussionid];
1025                     sort($postsarray);
1027                     foreach ($postsarray as $postid) {
1028                         $post = $posts[$postid];
1030                         if (array_key_exists($post->userid, $users)) { // we might know him/her already
1031                             $userfrom = $users[$post->userid];
1032                             if (!isset($userfrom->idnumber)) {
1033                                 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
1034                                 forum_cron_minimise_user_record($userfrom);
1035                             }
1037                         } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
1038                             forum_cron_minimise_user_record($userfrom);
1039                             if ($userscount <= FORUM_CRON_USER_CACHE) {
1040                                 $userscount++;
1041                                 $users[$userfrom->id] = $userfrom;
1042                             }
1044                         } else {
1045                             mtrace('Could not find user '.$post->userid);
1046                             continue;
1047                         }
1049                         if (!isset($userfrom->groups[$forum->id])) {
1050                             if (!isset($userfrom->groups)) {
1051                                 $userfrom->groups = array();
1052                                 if (isset($users[$userfrom->id])) {
1053                                     $users[$userfrom->id]->groups = array();
1054                                 }
1055                             }
1056                             $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
1057                             if (isset($users[$userfrom->id])) {
1058                                 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
1059                             }
1060                         }
1062                         // Headers to help prevent auto-responders.
1063                         $userfrom->customheaders = array(
1064                                 "Precedence: Bulk",
1065                                 'X-Auto-Response-Suppress: All',
1066                                 'Auto-Submitted: auto-generated',
1067                             );
1069                         $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
1070                         if ($maildigest == 2) {
1071                             // Subjects and link only
1072                             $posttext .= "\n";
1073                             $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1074                             $by = new stdClass();
1075                             $by->name = fullname($userfrom);
1076                             $by->date = userdate($post->modified);
1077                             $posttext .= "\n".format_string($post->subject,true).' '.get_string("bynameondate", "forum", $by);
1078                             $posttext .= "\n---------------------------------------------------------------------";
1080                             $by->name = "<a target=\"_blank\" href=\"$CFG->wwwroot/user/view.php?id=$userfrom->id&amp;course=$course->id\">$by->name</a>";
1081                             $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>';
1083                         } else {
1084                             // The full treatment
1085                             $posttext .= forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, true);
1086                             $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1088                         // Create an array of postid's for this user to mark as read.
1089                             if (!$CFG->forum_usermarksread) {
1090                                 $userto->markposts[$post->id] = $post->id;
1091                             }
1092                         }
1093                     }
1094                     $footerlinks = array();
1095                     if ($canunsubscribe) {
1096                         $footerlinks[] = "<a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">" . get_string("unsubscribe", "forum") . "</a>";
1097                     } else {
1098                         $footerlinks[] = get_string("everyoneissubscribed", "forum");
1099                     }
1100                     $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string("digestmailpost", "forum") . '</a>';
1101                     $posthtml .= "\n<div class='mdl-right'><font size=\"1\">" . implode('&nbsp;', $footerlinks) . '</font></div>';
1102                     $posthtml .= '<hr size="1" noshade="noshade" /></p>';
1103                 }
1104                 $posthtml .= '</body>';
1106                 if (empty($userto->mailformat) || $userto->mailformat != 1) {
1107                     // This user DOESN'T want to receive HTML
1108                     $posthtml = '';
1109                 }
1111                 $attachment = $attachname='';
1112                 // Directly email forum digests rather than sending them via messaging, use the
1113                 // site shortname as 'from name', the noreply address will be used by email_to_user.
1114                 $mailresult = email_to_user($userto, $site->shortname, $postsubject, $posttext, $posthtml, $attachment, $attachname);
1116                 if (!$mailresult) {
1117                     mtrace("ERROR: mod/forum/cron.php: Could not send out digest mail to user $userto->id ".
1118                         "($userto->email)... not trying again.");
1119                 } else {
1120                     mtrace("success.");
1121                     $usermailcount++;
1123                     // Mark post as read if forum_usermarksread is set off
1124                     forum_tp_mark_posts_read($userto, $userto->markposts);
1125                 }
1126             }
1127         }
1128     /// We have finishied all digest emails, update $CFG->digestmailtimelast
1129         set_config('digestmailtimelast', $timenow);
1130     }
1132     cron_setup_user();
1134     if (!empty($usermailcount)) {
1135         mtrace(get_string('digestsentusers', 'forum', $usermailcount));
1136     }
1138     if (!empty($CFG->forum_lastreadclean)) {
1139         $timenow = time();
1140         if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1141             set_config('forum_lastreadclean', $timenow);
1142             mtrace('Removing old forum read tracking info...');
1143             forum_tp_clean_read_records();
1144         }
1145     } else {
1146         set_config('forum_lastreadclean', time());
1147     }
1149     return true;
1152 /**
1153  * Builds and returns the body of the email notification in plain text.
1154  *
1155  * @global object
1156  * @global object
1157  * @uses CONTEXT_MODULE
1158  * @param object $course
1159  * @param object $cm
1160  * @param object $forum
1161  * @param object $discussion
1162  * @param object $post
1163  * @param object $userfrom
1164  * @param object $userto
1165  * @param boolean $bare
1166  * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
1167  * @return string The email body in plain text format.
1168  */
1169 function forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $bare = false, $replyaddress = null) {
1170     global $CFG, $USER;
1172     $modcontext = context_module::instance($cm->id);
1174     if (!isset($userto->viewfullnames[$forum->id])) {
1175         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1176     } else {
1177         $viewfullnames = $userto->viewfullnames[$forum->id];
1178     }
1180     if (!isset($userto->canpost[$discussion->id])) {
1181         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1182     } else {
1183         $canreply = $userto->canpost[$discussion->id];
1184     }
1186     $by = New stdClass;
1187     $by->name = fullname($userfrom, $viewfullnames);
1188     $by->date = userdate($post->modified, "", $userto->timezone);
1190     $strbynameondate = get_string('bynameondate', 'forum', $by);
1192     $strforums = get_string('forums', 'forum');
1194     $canunsubscribe = !\mod_forum\subscriptions::is_forcesubscribed($forum);
1196     $posttext = '';
1198     if (!$bare) {
1199         $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1200         $posttext  .= "$shortname -> $strforums -> ".format_string($forum->name,true);
1202         if ($discussion->name != $forum->name) {
1203             $posttext  .= " -> ".format_string($discussion->name,true);
1204         }
1205     }
1207     // add absolute file links
1208     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
1210     $posttext .= "\n";
1211     $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1212     $posttext .= format_string($post->subject,true);
1213     if ($bare) {
1214         $posttext .= " ($CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id#p$post->id)";
1215     }
1216     $posttext .= "\n".$strbynameondate."\n";
1217     $posttext .= "---------------------------------------------------------------------\n";
1218     $posttext .= format_text_email($post->message, $post->messageformat);
1219     $posttext .= "\n\n";
1220     $posttext .= forum_print_attachments($post, $cm, "text");
1221     $posttext .= "\n---------------------------------------------------------------------\n";
1223     if (!$bare) {
1224         if ($canreply) {
1225             $posttext .= get_string("postmailinfo", "forum", $shortname)."\n";
1226             $posttext .= "$CFG->wwwroot/mod/forum/post.php?reply=$post->id\n";
1227         }
1229         if ($canunsubscribe) {
1230             if (\mod_forum\subscriptions::is_subscribed($userto->id, $forum, null, $cm)) {
1231                 // If subscribed to this forum, offer the unsubscribe link.
1232                 $posttext .= get_string("unsubscribe", "forum");
1233                 $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\n";
1234             }
1235             // Always offer the unsubscribe from discussion link.
1236             $posttext .= get_string("unsubscribediscussion", "forum");
1237             $posttext .= ": $CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id&d=$discussion->id\n";
1238         }
1239     }
1241     $posttext .= get_string("digestmailpost", "forum");
1242     $posttext .= ": {$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}\n";
1244     if ($replyaddress) {
1245         $posttext .= "\n\n" . get_string('replytopostbyemail', 'mod_forum');
1246     }
1248     return $posttext;
1251 /**
1252  * Builds and returns the body of the email notification in html format.
1253  *
1254  * @global object
1255  * @param object $course
1256  * @param object $cm
1257  * @param object $forum
1258  * @param object $discussion
1259  * @param object $post
1260  * @param object $userfrom
1261  * @param object $userto
1262  * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
1263  * @return string The email text in HTML format
1264  */
1265 function forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $replyaddress = null) {
1266     global $CFG;
1268     if ($userto->mailformat != 1) {  // Needs to be HTML
1269         return '';
1270     }
1272     if (!isset($userto->canpost[$discussion->id])) {
1273         $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course);
1274     } else {
1275         $canreply = $userto->canpost[$discussion->id];
1276     }
1278     $strforums = get_string('forums', 'forum');
1279     $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
1280     $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
1282     $posthtml = '<head>';
1283 /*    foreach ($CFG->stylesheets as $stylesheet) {
1284         //TODO: MDL-21120
1285         $posthtml .= '<link rel="stylesheet" type="text/css" href="'.$stylesheet.'" />'."\n";
1286     }*/
1287     $posthtml .= '</head>';
1288     $posthtml .= "\n<body id=\"email\">\n\n";
1290     $posthtml .= '<div class="navbar">'.
1291     '<a target="_blank" href="'.$CFG->wwwroot.'/course/view.php?id='.$course->id.'">'.$shortname.'</a> &raquo; '.
1292     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/index.php?id='.$course->id.'">'.$strforums.'</a> &raquo; '.
1293     '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.format_string($forum->name,true).'</a>';
1294     if ($discussion->name == $forum->name) {
1295         $posthtml .= '</div>';
1296     } else {
1297         $posthtml .= ' &raquo; <a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id.'">'.
1298                      format_string($discussion->name,true).'</a></div>';
1299     }
1300     $posthtml .= forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto, false, $canreply, true, false);
1302     if ($replyaddress) {
1303         $posthtml .= html_writer::tag('p', get_string('replytopostbyemail', 'mod_forum'));
1304     }
1306     $footerlinks = array();
1307     if ($canunsubscribe) {
1308         if (\mod_forum\subscriptions::is_subscribed($userto->id, $forum, null, $cm)) {
1309             // If subscribed to this forum, offer the unsubscribe link.
1310             $unsublink = new moodle_url('/mod/forum/subscribe.php', array('id' => $forum->id));
1311             $footerlinks[] = html_writer::link($unsublink, get_string('unsubscribe', 'mod_forum'));
1312         }
1313         // Always offer the unsubscribe from discussion link.
1314         $unsublink = new moodle_url('/mod/forum/subscribe.php', array(
1315                 'id' => $forum->id,
1316                 'd' => $discussion->id,
1317             ));
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         list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2152                                                               'p.userid', 'u.id', 'u.firstname',
2153                                                               'u.lastname', 'p.modified', 'd.forum');
2154         $params = array_merge($params, $msparams);
2155     }
2157     $fromsql = "{forum_posts} p,
2158                   {forum_discussions} d,
2159                   {user} u";
2161     $selectsql = " $messagesearch
2162                AND p.discussion = d.id
2163                AND p.userid = u.id
2164                AND $selectdiscussion
2165                    $extrasql";
2167     $countsql = "SELECT COUNT(*)
2168                    FROM $fromsql
2169                   WHERE $selectsql";
2171     $allnames = get_all_user_name_fields(true, 'u');
2172     $searchsql = "SELECT p.*,
2173                          d.forum,
2174                          $allnames,
2175                          u.email,
2176                          u.picture,
2177                          u.imagealt
2178                     FROM $fromsql
2179                    WHERE $selectsql
2180                 ORDER BY p.modified DESC";
2182     $totalcount = $DB->count_records_sql($countsql, $params);
2184     return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
2187 /**
2188  * Returns a list of all new posts that have not been mailed yet
2189  *
2190  * @param int $starttime posts created after this time
2191  * @param int $endtime posts created before this
2192  * @param int $now used for timed discussions only
2193  * @return array
2194  */
2195 function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
2196     global $CFG, $DB;
2198     $params = array();
2199     $params['mailed'] = FORUM_MAILED_PENDING;
2200     $params['ptimestart'] = $starttime;
2201     $params['ptimeend'] = $endtime;
2202     $params['mailnow'] = 1;
2204     if (!empty($CFG->forum_enabletimedposts)) {
2205         if (empty($now)) {
2206             $now = time();
2207         }
2208         $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
2209         $params['dtimestart'] = $now;
2210         $params['dtimeend'] = $now;
2211     } else {
2212         $timedsql = "";
2213     }
2215     return $DB->get_records_sql("SELECT p.*, d.course, d.forum
2216                                  FROM {forum_posts} p
2217                                  JOIN {forum_discussions} d ON d.id = p.discussion
2218                                  WHERE p.mailed = :mailed
2219                                  AND p.created >= :ptimestart
2220                                  AND (p.created < :ptimeend OR p.mailnow = :mailnow)
2221                                  $timedsql
2222                                  ORDER BY p.modified ASC", $params);
2225 /**
2226  * Marks posts before a certain time as being mailed already
2227  *
2228  * @global object
2229  * @global object
2230  * @param int $endtime
2231  * @param int $now Defaults to time()
2232  * @return bool
2233  */
2234 function forum_mark_old_posts_as_mailed($endtime, $now=null) {
2235     global $CFG, $DB;
2237     if (empty($now)) {
2238         $now = time();
2239     }
2241     $params = array();
2242     $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
2243     $params['now'] = $now;
2244     $params['endtime'] = $endtime;
2245     $params['mailnow'] = 1;
2246     $params['mailedpending'] = FORUM_MAILED_PENDING;
2248     if (empty($CFG->forum_enabletimedposts)) {
2249         return $DB->execute("UPDATE {forum_posts}
2250                              SET mailed = :mailedsuccess
2251                              WHERE (created < :endtime OR mailnow = :mailnow)
2252                              AND mailed = :mailedpending", $params);
2253     } else {
2254         return $DB->execute("UPDATE {forum_posts}
2255                              SET mailed = :mailedsuccess
2256                              WHERE discussion NOT IN (SELECT d.id
2257                                                       FROM {forum_discussions} d
2258                                                       WHERE d.timestart > :now)
2259                              AND (created < :endtime OR mailnow = :mailnow)
2260                              AND mailed = :mailedpending", $params);
2261     }
2264 /**
2265  * Get all the posts for a user in a forum suitable for forum_print_post
2266  *
2267  * @global object
2268  * @global object
2269  * @uses CONTEXT_MODULE
2270  * @return array
2271  */
2272 function forum_get_user_posts($forumid, $userid) {
2273     global $CFG, $DB;
2275     $timedsql = "";
2276     $params = array($forumid, $userid);
2278     if (!empty($CFG->forum_enabletimedposts)) {
2279         $cm = get_coursemodule_from_instance('forum', $forumid);
2280         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2281             $now = time();
2282             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2283             $params[] = $now;
2284             $params[] = $now;
2285         }
2286     }
2288     $allnames = get_all_user_name_fields(true, 'u');
2289     return $DB->get_records_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
2290                               FROM {forum} f
2291                                    JOIN {forum_discussions} d ON d.forum = f.id
2292                                    JOIN {forum_posts} p       ON p.discussion = d.id
2293                                    JOIN {user} u              ON u.id = p.userid
2294                              WHERE f.id = ?
2295                                    AND p.userid = ?
2296                                    $timedsql
2297                           ORDER BY p.modified ASC", $params);
2300 /**
2301  * Get all the discussions user participated in
2302  *
2303  * @global object
2304  * @global object
2305  * @uses CONTEXT_MODULE
2306  * @param int $forumid
2307  * @param int $userid
2308  * @return array Array or false
2309  */
2310 function forum_get_user_involved_discussions($forumid, $userid) {
2311     global $CFG, $DB;
2313     $timedsql = "";
2314     $params = array($forumid, $userid);
2315     if (!empty($CFG->forum_enabletimedposts)) {
2316         $cm = get_coursemodule_from_instance('forum', $forumid);
2317         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2318             $now = time();
2319             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2320             $params[] = $now;
2321             $params[] = $now;
2322         }
2323     }
2325     return $DB->get_records_sql("SELECT DISTINCT d.*
2326                               FROM {forum} f
2327                                    JOIN {forum_discussions} d ON d.forum = f.id
2328                                    JOIN {forum_posts} p       ON p.discussion = d.id
2329                              WHERE f.id = ?
2330                                    AND p.userid = ?
2331                                    $timedsql", $params);
2334 /**
2335  * Get all the posts for a user in a forum suitable for forum_print_post
2336  *
2337  * @global object
2338  * @global object
2339  * @param int $forumid
2340  * @param int $userid
2341  * @return array of counts or false
2342  */
2343 function forum_count_user_posts($forumid, $userid) {
2344     global $CFG, $DB;
2346     $timedsql = "";
2347     $params = array($forumid, $userid);
2348     if (!empty($CFG->forum_enabletimedposts)) {
2349         $cm = get_coursemodule_from_instance('forum', $forumid);
2350         if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
2351             $now = time();
2352             $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2353             $params[] = $now;
2354             $params[] = $now;
2355         }
2356     }
2358     return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2359                              FROM {forum} f
2360                                   JOIN {forum_discussions} d ON d.forum = f.id
2361                                   JOIN {forum_posts} p       ON p.discussion = d.id
2362                                   JOIN {user} u              ON u.id = p.userid
2363                             WHERE f.id = ?
2364                                   AND p.userid = ?
2365                                   $timedsql", $params);
2368 /**
2369  * Given a log entry, return the forum post details for it.
2370  *
2371  * @global object
2372  * @global object
2373  * @param object $log
2374  * @return array|null
2375  */
2376 function forum_get_post_from_log($log) {
2377     global $CFG, $DB;
2379     $allnames = get_all_user_name_fields(true, 'u');
2380     if ($log->action == "add post") {
2382         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2383                                  FROM {forum_discussions} d,
2384                                       {forum_posts} p,
2385                                       {forum} f,
2386                                       {user} u
2387                                 WHERE p.id = ?
2388                                   AND d.id = p.discussion
2389                                   AND p.userid = u.id
2390                                   AND u.deleted <> '1'
2391                                   AND f.id = d.forum", array($log->info));
2394     } else if ($log->action == "add discussion") {
2396         return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
2397                                  FROM {forum_discussions} d,
2398                                       {forum_posts} p,
2399                                       {forum} f,
2400                                       {user} u
2401                                 WHERE d.id = ?
2402                                   AND d.firstpost = p.id
2403                                   AND p.userid = u.id
2404                                   AND u.deleted <> '1'
2405                                   AND f.id = d.forum", array($log->info));
2406     }
2407     return NULL;
2410 /**
2411  * Given a discussion id, return the first post from the discussion
2412  *
2413  * @global object
2414  * @global object
2415  * @param int $dicsussionid
2416  * @return array
2417  */
2418 function forum_get_firstpost_from_discussion($discussionid) {
2419     global $CFG, $DB;
2421     return $DB->get_record_sql("SELECT p.*
2422                              FROM {forum_discussions} d,
2423                                   {forum_posts} p
2424                             WHERE d.id = ?
2425                               AND d.firstpost = p.id ", array($discussionid));
2428 /**
2429  * Returns an array of counts of replies to each discussion
2430  *
2431  * @global object
2432  * @global object
2433  * @param int $forumid
2434  * @param string $forumsort
2435  * @param int $limit
2436  * @param int $page
2437  * @param int $perpage
2438  * @return array
2439  */
2440 function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
2441     global $CFG, $DB;
2443     if ($limit > 0) {
2444         $limitfrom = 0;
2445         $limitnum  = $limit;
2446     } else if ($page != -1) {
2447         $limitfrom = $page*$perpage;
2448         $limitnum  = $perpage;
2449     } else {
2450         $limitfrom = 0;
2451         $limitnum  = 0;
2452     }
2454     if ($forumsort == "") {
2455         $orderby = "";
2456         $groupby = "";
2458     } else {
2459         $orderby = "ORDER BY $forumsort";
2460         $groupby = ", ".strtolower($forumsort);
2461         $groupby = str_replace('desc', '', $groupby);
2462         $groupby = str_replace('asc', '', $groupby);
2463     }
2465     if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2466         $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
2467                   FROM {forum_posts} p
2468                        JOIN {forum_discussions} d ON p.discussion = d.id
2469                  WHERE p.parent > 0 AND d.forum = ?
2470               GROUP BY p.discussion";
2471         return $DB->get_records_sql($sql, array($forumid));
2473     } else {
2474         $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
2475                   FROM {forum_posts} p
2476                        JOIN {forum_discussions} d ON p.discussion = d.id
2477                  WHERE d.forum = ?
2478               GROUP BY p.discussion $groupby
2479               $orderby";
2480         return $DB->get_records_sql("SELECT * FROM ($sql) sq", array($forumid), $limitfrom, $limitnum);
2481     }
2484 /**
2485  * @global object
2486  * @global object
2487  * @global object
2488  * @staticvar array $cache
2489  * @param object $forum
2490  * @param object $cm
2491  * @param object $course
2492  * @return mixed
2493  */
2494 function forum_count_discussions($forum, $cm, $course) {
2495     global $CFG, $DB, $USER;
2497     static $cache = array();
2499     $now = round(time(), -2); // db cache friendliness
2501     $params = array($course->id);
2503     if (!isset($cache[$course->id])) {
2504         if (!empty($CFG->forum_enabletimedposts)) {
2505             $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2506             $params[] = $now;
2507             $params[] = $now;
2508         } else {
2509             $timedsql = "";
2510         }
2512         $sql = "SELECT f.id, COUNT(d.id) as dcount
2513                   FROM {forum} f
2514                        JOIN {forum_discussions} d ON d.forum = f.id
2515                  WHERE f.course = ?
2516                        $timedsql
2517               GROUP BY f.id";
2519         if ($counts = $DB->get_records_sql($sql, $params)) {
2520             foreach ($counts as $count) {
2521                 $counts[$count->id] = $count->dcount;
2522             }
2523             $cache[$course->id] = $counts;
2524         } else {
2525             $cache[$course->id] = array();
2526         }
2527     }
2529     if (empty($cache[$course->id][$forum->id])) {
2530         return 0;
2531     }
2533     $groupmode = groups_get_activity_groupmode($cm, $course);
2535     if ($groupmode != SEPARATEGROUPS) {
2536         return $cache[$course->id][$forum->id];
2537     }
2539     if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
2540         return $cache[$course->id][$forum->id];
2541     }
2543     require_once($CFG->dirroot.'/course/lib.php');
2545     $modinfo = get_fast_modinfo($course);
2547     $mygroups = $modinfo->get_groups($cm->groupingid);
2549     // add all groups posts
2550     $mygroups[-1] = -1;
2552     list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2553     $params[] = $forum->id;
2555     if (!empty($CFG->forum_enabletimedposts)) {
2556         $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
2557         $params[] = $now;
2558         $params[] = $now;
2559     } else {
2560         $timedsql = "";
2561     }
2563     $sql = "SELECT COUNT(d.id)
2564               FROM {forum_discussions} d
2565              WHERE d.groupid $mygroups_sql AND d.forum = ?
2566                    $timedsql";
2568     return $DB->get_field_sql($sql, $params);
2571 /**
2572  * Get all discussions in a forum
2573  *
2574  * @global object
2575  * @global object
2576  * @global object
2577  * @uses CONTEXT_MODULE
2578  * @uses VISIBLEGROUPS
2579  * @param object $cm
2580  * @param string $forumsort
2581  * @param bool $fullpost
2582  * @param int $unused
2583  * @param int $limit
2584  * @param bool $userlastmodified
2585  * @param int $page
2586  * @param int $perpage
2587  * @return array
2588  */
2589 function forum_get_discussions($cm, $forumsort="d.timemodified DESC", $fullpost=true, $unused=-1, $limit=-1, $userlastmodified=false, $page=-1, $perpage=0) {
2590     global $CFG, $DB, $USER;
2592     $timelimit = '';
2594     $now = round(time(), -2);
2595     $params = array($cm->instance);
2597     $modcontext = context_module::instance($cm->id);
2599     if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2600         return array();
2601     }
2603     if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2605         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2606             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2607             $params[] = $now;
2608             $params[] = $now;
2609             if (isloggedin()) {
2610                 $timelimit .= " OR d.userid = ?";
2611                 $params[] = $USER->id;
2612             }
2613             $timelimit .= ")";
2614         }
2615     }
2617     if ($limit > 0) {
2618         $limitfrom = 0;
2619         $limitnum  = $limit;
2620     } else if ($page != -1) {
2621         $limitfrom = $page*$perpage;
2622         $limitnum  = $perpage;
2623     } else {
2624         $limitfrom = 0;
2625         $limitnum  = 0;
2626     }
2628     $groupmode    = groups_get_activity_groupmode($cm);
2629     $currentgroup = groups_get_activity_group($cm);
2631     if ($groupmode) {
2632         if (empty($modcontext)) {
2633             $modcontext = context_module::instance($cm->id);
2634         }
2636         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2637             if ($currentgroup) {
2638                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2639                 $params[] = $currentgroup;
2640             } else {
2641                 $groupselect = "";
2642             }
2644         } else {
2645             //seprate groups without access all
2646             if ($currentgroup) {
2647                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2648                 $params[] = $currentgroup;
2649             } else {
2650                 $groupselect = "AND d.groupid = -1";
2651             }
2652         }
2653     } else {
2654         $groupselect = "";
2655     }
2658     if (empty($forumsort)) {
2659         $forumsort = "d.timemodified DESC";
2660     }
2661     if (empty($fullpost)) {
2662         $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2663     } else {
2664         $postdata = "p.*";
2665     }
2667     if (empty($userlastmodified)) {  // We don't need to know this
2668         $umfields = "";
2669         $umtable  = "";
2670     } else {
2671         $umfields = ', ' . get_all_user_name_fields(true, 'um', null, 'um');
2672         $umtable  = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
2673     }
2675     $allnames = get_all_user_name_fields(true, 'u');
2676     $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend, $allnames,
2677                    u.email, u.picture, u.imagealt $umfields
2678               FROM {forum_discussions} d
2679                    JOIN {forum_posts} p ON p.discussion = d.id
2680                    JOIN {user} u ON p.userid = u.id
2681                    $umtable
2682              WHERE d.forum = ? AND p.parent = 0
2683                    $timelimit $groupselect
2684           ORDER BY $forumsort";
2685     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2688 /**
2689  * Gets the neighbours (previous and next) of a discussion.
2690  *
2691  * The calculation is based on the timemodified of the discussion and does not handle
2692  * the neighbours having an identical timemodified. The reason is that we do not have any
2693  * other mean to sort the records, e.g. we cannot use IDs as a greater ID can have a lower
2694  * timemodified.
2695  *
2696  * Please note that this does not check whether or not the discussion passed is accessible
2697  * by the user, it simply uses it as a reference to find the neighbours. On the other hand,
2698  * the returned neighbours are checked and are accessible to the current user.
2699  *
2700  * @param object $cm The CM record.
2701  * @param object $discussion The discussion record.
2702  * @return array That always contains the keys 'prev' and 'next'. When there is a result
2703  *               they contain the record with minimal information such as 'id' and 'name'.
2704  *               When the neighbour is not found the value is false.
2705  */
2706 function forum_get_discussion_neighbours($cm, $discussion) {
2707     global $CFG, $DB, $USER;
2709     if ($cm->instance != $discussion->forum) {
2710         throw new coding_exception('Discussion is not part of the same forum.');
2711     }
2713     $neighbours = array('prev' => false, 'next' => false);
2714     $now = round(time(), -2);
2715     $params = array();
2717     $modcontext = context_module::instance($cm->id);
2718     $groupmode    = groups_get_activity_groupmode($cm);
2719     $currentgroup = groups_get_activity_group($cm);
2721     // Users must fulfill timed posts.
2722     $timelimit = '';
2723     if (!empty($CFG->forum_enabletimedposts)) {
2724         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2725             $timelimit = ' AND ((d.timestart <= :tltimestart AND (d.timeend = 0 OR d.timeend > :tltimeend))';
2726             $params['tltimestart'] = $now;
2727             $params['tltimeend'] = $now;
2728             if (isloggedin()) {
2729                 $timelimit .= ' OR d.userid = :tluserid';
2730                 $params['tluserid'] = $USER->id;
2731             }
2732             $timelimit .= ')';
2733         }
2734     }
2736     // Limiting to posts accessible according to groups.
2737     $groupselect = '';
2738     if ($groupmode) {
2739         if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $modcontext)) {
2740             if ($currentgroup) {
2741                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2742                 $params['groupid'] = $currentgroup;
2743             }
2744         } else {
2745             if ($currentgroup) {
2746                 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2747                 $params['groupid'] = $currentgroup;
2748             } else {
2749                 $groupselect = 'AND d.groupid = -1';
2750             }
2751         }
2752     }
2754     $params['forumid'] = $cm->instance;
2755     $params['discid'] = $discussion->id;
2756     $params['disctimemodified'] = $discussion->timemodified;
2758     $sql = "SELECT d.id, d.name, d.timemodified, d.groupid, d.timestart, d.timeend
2759               FROM {forum_discussions} d
2760              WHERE d.forum = :forumid
2761                AND d.id <> :discid
2762                    $timelimit
2763                    $groupselect";
2765     $prevsql = $sql . " AND d.timemodified < :disctimemodified
2766                    ORDER BY d.timemodified DESC";
2768     $nextsql = $sql . " AND d.timemodified > :disctimemodified
2769                    ORDER BY d.timemodified ASC";
2771     $neighbours['prev'] = $DB->get_record_sql($prevsql, $params, IGNORE_MULTIPLE);
2772     $neighbours['next'] = $DB->get_record_sql($nextsql, $params, IGNORE_MULTIPLE);
2774     return $neighbours;
2777 /**
2778  *
2779  * @global object
2780  * @global object
2781  * @global object
2782  * @uses CONTEXT_MODULE
2783  * @uses VISIBLEGROUPS
2784  * @param object $cm
2785  * @return array
2786  */
2787 function forum_get_discussions_unread($cm) {
2788     global $CFG, $DB, $USER;
2790     $now = round(time(), -2);
2791     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2793     $params = array();
2794     $groupmode    = groups_get_activity_groupmode($cm);
2795     $currentgroup = groups_get_activity_group($cm);
2797     if ($groupmode) {
2798         $modcontext = context_module::instance($cm->id);
2800         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2801             if ($currentgroup) {
2802                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2803                 $params['currentgroup'] = $currentgroup;
2804             } else {
2805                 $groupselect = "";
2806             }
2808         } else {
2809             //separate groups without access all
2810             if ($currentgroup) {
2811                 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2812                 $params['currentgroup'] = $currentgroup;
2813             } else {
2814                 $groupselect = "AND d.groupid = -1";
2815             }
2816         }
2817     } else {
2818         $groupselect = "";
2819     }
2821     if (!empty($CFG->forum_enabletimedposts)) {
2822         $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2823         $params['now1'] = $now;
2824         $params['now2'] = $now;
2825     } else {
2826         $timedsql = "";
2827     }
2829     $sql = "SELECT d.id, COUNT(p.id) AS unread
2830               FROM {forum_discussions} d
2831                    JOIN {forum_posts} p     ON p.discussion = d.id
2832                    LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
2833              WHERE d.forum = {$cm->instance}
2834                    AND p.modified >= :cutoffdate AND r.id is NULL
2835                    $groupselect
2836                    $timedsql
2837           GROUP BY d.id";
2838     $params['cutoffdate'] = $cutoffdate;
2840     if ($unreads = $DB->get_records_sql($sql, $params)) {
2841         foreach ($unreads as $unread) {
2842             $unreads[$unread->id] = $unread->unread;
2843         }
2844         return $unreads;
2845     } else {
2846         return array();
2847     }
2850 /**
2851  * @global object
2852  * @global object
2853  * @global object
2854  * @uses CONEXT_MODULE
2855  * @uses VISIBLEGROUPS
2856  * @param object $cm
2857  * @return array
2858  */
2859 function forum_get_discussions_count($cm) {
2860     global $CFG, $DB, $USER;
2862     $now = round(time(), -2);
2863     $params = array($cm->instance);
2864     $groupmode    = groups_get_activity_groupmode($cm);
2865     $currentgroup = groups_get_activity_group($cm);
2867     if ($groupmode) {
2868         $modcontext = context_module::instance($cm->id);
2870         if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2871             if ($currentgroup) {
2872                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2873                 $params[] = $currentgroup;
2874             } else {
2875                 $groupselect = "";
2876             }
2878         } else {
2879             //seprate groups without access all
2880             if ($currentgroup) {
2881                 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2882                 $params[] = $currentgroup;
2883             } else {
2884                 $groupselect = "AND d.groupid = -1";
2885             }
2886         }
2887     } else {
2888         $groupselect = "";
2889     }
2891     $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
2893     $timelimit = "";
2895     if (!empty($CFG->forum_enabletimedposts)) {
2897         $modcontext = context_module::instance($cm->id);
2899         if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2900             $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2901             $params[] = $now;
2902             $params[] = $now;
2903             if (isloggedin()) {
2904                 $timelimit .= " OR d.userid = ?";
2905                 $params[] = $USER->id;
2906             }
2907             $timelimit .= ")";
2908         }
2909     }
2911     $sql = "SELECT COUNT(d.id)
2912               FROM {forum_discussions} d
2913                    JOIN {forum_posts} p ON p.discussion = d.id
2914              WHERE d.forum = ? AND p.parent = 0
2915                    $groupselect $timelimit";
2917     return $DB->get_field_sql($sql, $params);
2921 // OTHER FUNCTIONS ///////////////////////////////////////////////////////////
2924 /**
2925  * @global object
2926  * @global object
2927  * @param int $courseid
2928  * @param string $type
2929  */
2930 function forum_get_course_forum($courseid, $type) {
2931 // How to set up special 1-per-course forums
2932     global $CFG, $DB, $OUTPUT, $USER;
2934     if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
2935         // There should always only be ONE, but with the right combination of
2936         // errors there might be more.  In this case, just return the oldest one (lowest ID).
2937         foreach ($forums as $forum) {
2938             return $forum;   // ie the first one
2939         }
2940     }
2942     // Doesn't exist, so create one now.
2943     $forum = new stdClass();
2944     $forum->course = $courseid;
2945     $forum->type = "$type";
2946     if (!empty($USER->htmleditor)) {
2947         $forum->introformat = $USER->htmleditor;
2948     }
2949     switch ($forum->type) {
2950         case "news":
2951             $forum->name  = get_string("namenews", "forum");
2952             $forum->intro = get_string("intronews", "forum");
2953             $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
2954             $forum->assessed = 0;
2955             if ($courseid == SITEID) {
2956                 $forum->name  = get_string("sitenews");
2957                 $forum->forcesubscribe = 0;
2958             }
2959             break;
2960         case "social":
2961             $forum->name  = get_string("namesocial", "forum");
2962             $forum->intro = get_string("introsocial", "forum");
2963             $forum->assessed = 0;
2964             $forum->forcesubscribe = 0;
2965             break;
2966         case "blog":
2967             $forum->name = get_string('blogforum', 'forum');
2968             $forum->intro = get_string('introblog', 'forum');
2969             $forum->assessed = 0;
2970             $forum->forcesubscribe = 0;
2971             break;
2972         default:
2973             echo $OUTPUT->notification("That forum type doesn't exist!");
2974             return false;
2975             break;
2976     }
2978     $forum->timemodified = time();
2979     $forum->id = $DB->insert_record("forum", $forum);
2981     if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
2982         echo $OUTPUT->notification("Could not find forum module!!");
2983         return false;
2984     }
2985     $mod = new stdClass();
2986     $mod->course = $courseid;
2987     $mod->module = $module->id;
2988     $mod->instance = $forum->id;
2989     $mod->section = 0;
2990     include_once("$CFG->dirroot/course/lib.php");
2991     if (! $mod->coursemodule = add_course_module($mod) ) {
2992         echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
2993         return false;
2994     }
2995     $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
2996     return $DB->get_record("forum", array("id" => "$forum->id"));
3000 /**
3001  * Given the data about a posting, builds up the HTML to display it and
3002  * returns the HTML in a string.  This is designed for sending via HTML email.
3003  *
3004  * @global object
3005  * @param object $course
3006  * @param object $cm
3007  * @param object $forum
3008  * @param object $discussion
3009  * @param object $post
3010  * @param object $userform
3011  * @param object $userto
3012  * @param bool $ownpost
3013  * @param bool $reply
3014  * @param bool $link
3015  * @param bool $rate
3016  * @param string $footer
3017  * @return string
3018  */
3019 function forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
3020                               $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
3022     global $CFG, $OUTPUT;
3024     $modcontext = context_module::instance($cm->id);
3026     if (!isset($userto->viewfullnames[$forum->id])) {
3027         $viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
3028     } else {
3029         $viewfullnames = $userto->viewfullnames[$forum->id];
3030     }
3032     // add absolute file links
3033     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3035     // format the post body
3036     $options = new stdClass();
3037     $options->para = true;
3038     $formattedtext = format_text($post->message, $post->messageformat, $options, $course->id);
3040     $output = '<table border="0" cellpadding="3" cellspacing="0" class="forumpost">';
3042     $output .= '<tr class="header"><td width="35" valign="top" class="picture left">';
3043     $output .= $OUTPUT->user_picture($userfrom, array('courseid'=>$course->id));
3044     $output .= '</td>';
3046     if ($post->parent) {
3047         $output .= '<td class="topic">';
3048     } else {
3049         $output .= '<td class="topic starter">';
3050     }
3051     $output .= '<div class="subject">'.format_string($post->subject).'</div>';
3053     $fullname = fullname($userfrom, $viewfullnames);
3054     $by = new stdClass();
3055     $by->name = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userfrom->id.'&amp;course='.$course->id.'">'.$fullname.'</a>';
3056     $by->date = userdate($post->modified, '', $userto->timezone);
3057     $output .= '<div class="author">'.get_string('bynameondate', 'forum', $by).'</div>';
3059     $output .= '</td></tr>';
3061     $output .= '<tr><td class="left side" valign="top">';
3063     if (isset($userfrom->groups)) {
3064         $groups = $userfrom->groups[$forum->id];
3065     } else {
3066         $groups = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
3067     }
3069     if ($groups) {
3070         $output .= print_group_picture($groups, $course->id, false, true, true);
3071     } else {
3072         $output .= '&nbsp;';
3073     }
3075     $output .= '</td><td class="content">';
3077     $attachments = forum_print_attachments($post, $cm, 'html');
3078     if ($attachments !== '') {
3079         $output .= '<div class="attachments">';
3080         $output .= $attachments;
3081         $output .= '</div>';
3082     }
3084     $output .= $formattedtext;
3086 // Commands
3087     $commands = array();
3089     if ($post->parent) {
3090         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.
3091                       $post->discussion.'&amp;parent='.$post->parent.'">'.get_string('parent', 'forum').'</a>';
3092     }
3094     if ($reply) {
3095         $commands[] = '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/post.php?reply='.$post->id.'">'.
3096                       get_string('reply', 'forum').'</a>';
3097     }
3099     $output .= '<div class="commands">';
3100     $output .= implode(' | ', $commands);
3101     $output .= '</div>';
3103 // Context link to post if required
3104     if ($link) {
3105         $output .= '<div class="link">';
3106         $output .= '<a target="_blank" href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$post->discussion.'#p'.$post->id.'">'.
3107                      get_string('postincontext', 'forum').'</a>';
3108         $output .= '</div>';
3109     }
3111     if ($footer) {
3112         $output .= '<div class="footer">'.$footer.'</div>';
3113     }
3114     $output .= '</td></tr></table>'."\n\n";
3116     return $output;
3119 /**
3120  * Print a forum post
3121  *
3122  * @global object
3123  * @global object
3124  * @uses FORUM_MODE_THREADED
3125  * @uses PORTFOLIO_FORMAT_PLAINHTML
3126  * @uses PORTFOLIO_FORMAT_FILE
3127  * @uses PORTFOLIO_FORMAT_RICHHTML
3128  * @uses PORTFOLIO_ADD_TEXT_LINK
3129  * @uses CONTEXT_MODULE
3130  * @param object $post The post to print.
3131  * @param object $discussion
3132  * @param object $forum
3133  * @param object $cm
3134  * @param object $course
3135  * @param boolean $ownpost Whether this post belongs to the current user.
3136  * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
3137  * @param boolean $link Just print a shortened version of the post as a link to the full post.
3138  * @param string $footer Extra stuff to print after the message.
3139  * @param string $highlight Space-separated list of terms to highlight.
3140  * @param int $post_read true, false or -99. If we already know whether this user
3141  *          has read this post, pass that in, otherwise, pass in -99, and this
3142  *          function will work it out.
3143  * @param boolean $dummyifcantsee When forum_user_can_see_post says that
3144  *          the current user can't see this post, if this argument is true
3145  *          (the default) then print a dummy 'you can't see this post' post.
3146  *          If false, don't output anything at all.
3147  * @param bool|null $istracked
3148  * @return void
3149  */
3150 function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
3151                           $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
3152     global $USER, $CFG, $OUTPUT;
3154     require_once($CFG->libdir . '/filelib.php');
3156     // String cache
3157     static $str;
3159     $modcontext = context_module::instance($cm->id);
3161     $post->course = $course->id;
3162     $post->forum  = $forum->id;
3163     $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
3164     if (!empty($CFG->enableplagiarism)) {
3165         require_once($CFG->libdir.'/plagiarismlib.php');
3166         $post->message .= plagiarism_get_links(array('userid' => $post->userid,
3167             'content' => $post->message,
3168             'cmid' => $cm->id,
3169             'course' => $post->course,
3170             'forum' => $post->forum));
3171     }
3173     // caching
3174     if (!isset($cm->cache)) {
3175         $cm->cache = new stdClass;
3176     }
3178     if (!isset($cm->cache->caps)) {
3179         $cm->cache->caps = array();
3180         $cm->cache->caps['mod/forum:viewdiscussion']   = has_capability('mod/forum:viewdiscussion', $modcontext);
3181         $cm->cache->caps['moodle/site:viewfullnames']  = has_capability('moodle/site:viewfullnames', $modcontext);
3182         $cm->cache->caps['mod/forum:editanypost']      = has_capability('mod/forum:editanypost', $modcontext);
3183         $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
3184         $cm->cache->caps['mod/forum:deleteownpost']    = has_capability('mod/forum:deleteownpost', $modcontext);
3185         $cm->cache->caps['mod/forum:deleteanypost']    = has_capability('mod/forum:deleteanypost', $modcontext);
3186         $cm->cache->caps['mod/forum:viewanyrating']    = has_capability('mod/forum:viewanyrating', $modcontext);
3187         $cm->cache->caps['mod/forum:exportpost']       = has_capability('mod/forum:exportpost', $modcontext);
3188         $cm->cache->caps['mod/forum:exportownpost']    = has_capability('mod/forum:exportownpost', $modcontext);
3189     }
3191     if (!isset($cm->uservisible)) {
3192         $cm->uservisible = \core_availability\info_module::is_user_visible($cm, 0, false);
3193     }
3195     if ($istracked && is_null($postisread)) {
3196         $postisread = forum_tp_is_post_read($USER->id, $post);
3197     }
3199     if (!forum_user_can_see_post($forum, $discussion, $post, NULL, $cm)) {
3200         $output = '';
3201         if (!$dummyifcantsee) {
3202             if ($return) {
3203                 return $output;
3204             }
3205             echo $output;
3206             return;
3207         }
3208         $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3209         $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix',
3210                                                        'role' => 'region',
3211                                                        'aria-label' => get_string('hiddenforumpost', 'forum')));
3212         $output .= html_writer::start_tag('div', array('class'=>'row header'));
3213         $output .= html_writer::tag('div', '', array('class'=>'left picture')); // Picture
3214         if ($post->parent) {
3215             $output .= html_writer::start_tag('div', array('class'=>'topic'));
3216         } else {
3217             $output .= html_writer::start_tag('div', array('class'=>'topic starter'));
3218         }
3219         $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class' => 'subject',
3220                                                                                            'role' => 'header')); // Subject.
3221         $output .= html_writer::tag('div', get_string('forumauthorhidden', 'forum'), array('class' => 'author',
3222                                                                                            'role' => 'header')); // Author.
3223         $output .= html_writer::end_tag('div');
3224         $output .= html_writer::end_tag('div'); // row
3225         $output .= html_writer::start_tag('div', array('class'=>'row'));
3226         $output .= html_writer::tag('div', '&nbsp;', array('class'=>'left side')); // Groups
3227         $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
3228         $output .= html_writer::end_tag('div'); // row
3229         $output .= html_writer::end_tag('div'); // forumpost
3231         if ($return) {
3232             return $output;
3233         }
3234         echo $output;
3235         return;
3236     }
3238     if (empty($str)) {
3239         $str = new stdClass;
3240         $str->edit         = get_string('edit', 'forum');
3241         $str->delete       = get_string('delete', 'forum');
3242         $str->reply        = get_string('reply', 'forum');
3243         $str->parent       = get_string('parent', 'forum');
3244         $str->pruneheading = get_string('pruneheading', 'forum');
3245         $str->prune        = get_string('prune', 'forum');
3246         $str->displaymode     = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
3247         $str->markread     = get_string('markread', 'forum');
3248         $str->markunread   = get_string('markunread', 'forum');
3249     }
3251     $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
3253     // Build an object that represents the posting user
3254     $postuser = new stdClass;
3255     $postuserfields = explode(',', user_picture::fields());
3256     $postuser = username_load_fields_from_object($postuser, $post, null, $postuserfields);
3257     $postuser->id = $post->userid;
3258     $postuser->fullname    = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
3259     $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
3261     // Prepare the groups the posting user belongs to
3262     if (isset($cm->cache->usersgroups)) {
3263         $groups = array();
3264         if (isset($cm->cache->usersgroups[$post->userid])) {
3265             foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
3266                 $groups[$gid] = $cm->cache->groups[$gid];
3267             }
3268         }
3269     } else {
3270         $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
3271     }
3273     // Prepare the attachements for the post, files then images
3274     list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
3276     // Determine if we need to shorten this post
3277     $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
3280     // Prepare an array of commands
3281     $commands = array();
3283     // SPECIAL CASE: The front page can display a news item post to non-logged in users.
3284     // Don't display the mark read / unread controls in this case.
3285     if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
3286         $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
3287         $text = $str->markunread;
3288         if (!$postisread) {
3289             $url->param('mark', 'read');
3290             $text = $str->markread;
3291         }
3292         if ($str->displaymode == FORUM_MODE_THREADED) {
3293             $url->param('parent', $post->parent);
3294         } else {
3295             $url->set_anchor('p'.$post->id);
3296         }
3297         $commands[] = array('url'=>$url, 'text'=>$text);
3298     }
3300     // Zoom in to the parent specifically
3301     if ($post->parent) {
3302         $url = new moodle_url($discussionlink);
3303         if ($str->displaymode == FORUM_MODE_THREADED) {
3304             $url->param('parent', $post->parent);
3305         } else {
3306             $url->set_anchor('p'.$post->parent);
3307         }
3308         $commands[] = array('url'=>$url, 'text'=>$str->parent);
3309     }
3311     // Hack for allow to edit news posts those are not displayed yet until they are displayed
3312     $age = time() - $post->created;
3313     if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
3314         $age = 0;
3315     }
3317     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3318         if (has_capability('moodle/course:manageactivities', $modcontext)) {
3319             // The first post in single simple is the forum description.
3320             $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
3321         }
3322     } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
3323         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
3324     }
3326     if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
3327         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
3328     }
3330     if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
3331         // Do not allow deleting of first post in single simple type.
3332     } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
3333         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
3334     }
3336     if ($reply) {
3337         $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
3338     }
3340     if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
3341         $p = array('postid' => $post->id);
3342         require_once($CFG->libdir.'/portfoliolib.php');
3343         $button = new portfolio_add_button();
3344         $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
3345         if (empty($attachments)) {
3346             $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
3347         } else {
3348             $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
3349         }
3351         $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
3352         if (!empty($porfoliohtml)) {
3353             $commands[] = $porfoliohtml;
3354         }
3355     }
3356     // Finished building commands
3359     // Begin output
3361     $output  = '';
3363     if ($istracked) {
3364         if ($postisread) {
3365             $forumpostclass = ' read';
3366         } else {
3367             $forumpostclass = ' unread';
3368             $output .= html_writer::tag('a', '', array('name'=>'unread'));
3369         }
3370     } else {
3371         // ignore trackign status if not tracked or tracked param missing
3372         $forumpostclass = '';
3373     }
3375     $topicclass = '';
3376     if (empty($post->parent)) {
3377         $topicclass = ' firstpost starter';
3378     }
3380     $postbyuser = new stdClass;
3381     $postbyuser->post = $post->subject;
3382     $postbyuser->user = $postuser->fullname;
3383     $discussionbyuser = get_string('postbyuser', 'forum', $postbyuser);
3384     $output .= html_writer::tag('a', '', array('id'=>'p'.$post->id));
3385     $output .= html_writer::start_tag('div', array('class'=>'forumpost clearfix'.$forumpostclass.$topicclass,
3386                                                    'role' => 'region',
3387                                                    'aria-label' => $discussionbyuser));
3388     $output .= html_writer::start_tag('div', array('class'=>'row header clearfix'));
3389     $output .= html_writer::start_tag('div', array('class'=>'left picture'));
3390     $output .= $OUTPUT->user_picture($postuser, array('courseid'=>$course->id));
3391     $output .= html_writer::end_tag('div');
3394     $output .= html_writer::start_tag('div', array('class'=>'topic'.$topicclass));
3396     $postsubject = $post->subject;
3397     if (empty($post->subjectnoformat)) {
3398         $postsubject = format_string($postsubject);
3399     }
3400     $output .= html_writer::tag('div', $postsubject, array('class'=>'subject',
3401                                                            'role' => 'heading',
3402                                                            'aria-level' => '2'));
3404     $by = new stdClass();
3405     $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
3406     $by->date = userdate($post->modified);
3407     $output .= html_writer::tag('div', get_string('bynameondate', 'forum', $by), array('class'=>'author',
3408                                                                                        'role' => 'heading',
3409                                                                                        'aria-level' => '2'));
3411     $output .= html_writer::end_tag('div'); //topic
3412     $output .= html_writer::end_tag('div'); //row
3414     $output .= html_writer::start_tag('div', array('class'=>'row maincontent clearfix'));
3415     $output .= html_writer::start_tag('div', array('class'=>'left'));
3417     $groupoutput = '';
3418     if ($groups) {
3419         $groupoutput = print_group_picture($groups, $course->id, false, true, true);
3420     }
3421     if (empty($groupoutput)) {
3422         $groupoutput = '&nbsp;';
3423     }
3424     $output .= html_writer::tag('div', $groupoutput, array('class'=>'grouppictures'));
3426     $output .= html_writer::end_tag('div'); //left side
3427     $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
3428     $output .= html_writer::start_tag('div', array('class'=>'content'));
3430     $options = new stdClass;
3431     $options->para    = false;
3432     $options->trusted = $post->messagetrust;
3433     $options->context = $modcontext;
3434     if ($shortenpost) {
3435         // Prepare shortened version by filtering the text then shortening it.
3436         $postclass    = 'shortenedpost';
3437         $postcontent  = format_text($post->message, $post->messageformat, $options);
3438         $postcontent  = shorten_text($postcontent, $CFG->forum_shortpost);
3439         $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
3440         $postcontent .= html_writer::tag('div', '('.get_string('numwords', 'moodle', count_words($post->message)).')',
3441             array('class'=>'post-word-count'));
3442     } else {
3443         // Prepare whole post
3444         $postclass    = 'fullpost';
3445         $postcontent  = format_text($post->message, $post->messageformat, $options, $course->id);
3446         if (!empty($highlight)) {
3447             $postcontent = highlight($highlight, $postcontent);
3448         }
3449         if (!empty($forum->displaywordcount)) {
3450             $postcontent .= html_writer::tag('div', get_string('numwords', 'moodle', count_words($post->message)),
3451                 array('class'=>'post-word-count'));
3452         }
3453         $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
3454     }
3456     // Output the post content
3457     $output .= html_writer::tag('div', $postcontent, array('class'=>'posting '.$postclass));
3458     $output .= html_writer::end_tag('div'); // Content
3459     $output .= html_writer::end_tag('div'); // Content mask
3460     $output .= html_writer::end_tag('div'); // Row
3462     $output .= html_writer::start_tag('div', array('class'=>'row side'));
3463     $output .= html_writer::tag('div','&nbsp;', array('class'=>'left'));
3464     $output .= html_writer::start_tag('div', array('class'=>'options clearfix'));
3466     if (!empty($attachments)) {
3467         $output .= html_writer::tag('div', $attachments, array('class' => 'attachments'));
3468     }
3470     // Output ratings
3471     if (!empty($post->rating)) {
3472         $output .= html_writer::tag('div', $OUTPUT->render($post->rating), array('class'=>'forum-post-rating'));
3473     }