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