MDL-57677 mod_forum: Fix wrong user displayed as the last post's author
[moodle.git] / mod / forum / lib.php
CommitLineData
df1ba0f4 1<?php
df1ba0f4 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/>.
16
17/**
01030f1b
SH
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
df1ba0f4 21 */
22
bc196cbe
PS
23defined('MOODLE_INTERNAL') || die();
24
df1ba0f4 25/** Include required files */
39de876c 26require_once(__DIR__ . '/deprecatedlib.php');
f1e0649c 27require_once($CFG->libdir.'/filelib.php');
3b120e46 28require_once($CFG->libdir.'/eventslib.php');
7f6689e4 29
501cdbd8 30/// CONSTANTS ///////////////////////////////////////////////////////////
f93f848a 31
d3583b41 32define('FORUM_MODE_FLATOLDEST', 1);
33define('FORUM_MODE_FLATNEWEST', -1);
34define('FORUM_MODE_THREADED', 2);
35define('FORUM_MODE_NESTED', 3);
2e2e71a8 36
afef965e 37define('FORUM_CHOOSESUBSCRIBE', 0);
d3583b41 38define('FORUM_FORCESUBSCRIBE', 1);
39define('FORUM_INITIALSUBSCRIBE', 2);
098d27d4 40define('FORUM_DISALLOWSUBSCRIBE',3);
709f0ec8 41
bd8f5d45
EM
42/**
43 * FORUM_TRACKING_OFF - Tracking is not available for this forum.
44 */
eaf50aef 45define('FORUM_TRACKING_OFF', 0);
bd8f5d45
EM
46
47/**
48 * FORUM_TRACKING_OPTIONAL - Tracking is based on user preference.
49 */
eaf50aef 50define('FORUM_TRACKING_OPTIONAL', 1);
bd8f5d45
EM
51
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 */
56define('FORUM_TRACKING_FORCED', 2);
57
8076010d 58define('FORUM_MAILED_PENDING', 0);
da484043
MO
59define('FORUM_MAILED_SUCCESS', 1);
60define('FORUM_MAILED_ERROR', 2);
61
103f34d8
PS
62if (!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}
66
4f3a2d21
JL
67/**
68 * FORUM_POSTS_ALL_USER_GROUPS - All the posts in groups where the user is enrolled.
69 */
70define('FORUM_POSTS_ALL_USER_GROUPS', -2);
71
87b007b4
CF
72define('FORUM_DISCUSSION_PINNED', 1);
73define('FORUM_DISCUSSION_UNPINNED', 0);
74
caadf009 75/// STANDARD FUNCTIONS ///////////////////////////////////////////////////////////
76
0a4ac01b 77/**
78 * Given an object containing all the necessary data,
7cac0c4b 79 * (defined by the form in mod_form.php) this function
0a4ac01b 80 * will create a new instance and return the id number
81 * of the new instance.
df1ba0f4 82 *
6b04fdc0
PS
83 * @param stdClass $forum add forum instance
84 * @param mod_forum_mod_form $mform
6b7de0bb 85 * @return int intance id
3a5e1d06 86 */
6b04fdc0 87function forum_add_instance($forum, $mform = null) {
c18269c7 88 global $CFG, $DB;
caadf009 89
90 $forum->timemodified = time();
91
353228d8 92 if (empty($forum->assessed)) {
f2f56406 93 $forum->assessed = 0;
94 }
2b63df96 95
353228d8 96 if (empty($forum->ratingtime) or empty($forum->assessed)) {
98914efd 97 $forum->assesstimestart = 0;
98 $forum->assesstimefinish = 0;
99 }
caadf009 100
a8f3a651 101 $forum->id = $DB->insert_record('forum', $forum);
bf0f06b1 102 $modcontext = context_module::instance($forum->coursemodule);
cb9a975f 103
d3583b41 104 if ($forum->type == 'single') { // Create related discussion.
39790bd8 105 $discussion = new stdClass();
e2d7687f 106 $discussion->course = $forum->course;
107 $discussion->forum = $forum->id;
108 $discussion->name = $forum->name;
e2d7687f 109 $discussion->assessed = $forum->assessed;
6606c00f
MD
110 $discussion->message = $forum->intro;
111 $discussion->messageformat = $forum->introformat;
bf0f06b1 112 $discussion->messagetrust = trusttext_trusted(context_course::instance($forum->course));
e2d7687f 113 $discussion->mailnow = false;
114 $discussion->groupid = -1;
caadf009 115
dbf4d660 116 $message = '';
117
42776c94
PS
118 $discussion->id = forum_add_discussion($discussion, null, $message);
119
120 if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
a11aa38e 121 // Ugly hack - we need to copy the files somehow.
42776c94
PS
122 $discussion = $DB->get_record('forum_discussions', array('id'=>$discussion->id), '*', MUST_EXIST);
123 $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
124
a11aa38e
PS
125 $options = array('subdirs'=>true); // Use the same options as intro field!
126 $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
42776c94 127 $DB->set_field('forum_posts', 'message', $post->message, array('id'=>$post->id));
caadf009 128 }
129 }
8f0cd6ef 130
8e6775d8
AN
131 forum_grade_item_update($forum);
132
133 return $forum->id;
134}
135
136/**
137 * Handle changes following the creation of a forum instance.
138 * This function is typically called by the course_module_created observer.
139 *
140 * @param object $context the forum context
141 * @param stdClass $forum The forum object
142 * @return void
143 */
144function forum_instance_created($context, $forum) {
3c268f25 145 if ($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) {
59075a43 146 $users = \mod_forum\subscriptions::get_potential_subscribers($context, 0, 'u.id, u.email');
709f0ec8 147 foreach ($users as $user) {
59075a43 148 \mod_forum\subscriptions::subscribe_user($user->id, $forum, $context);
709f0ec8 149 }
150 }
caadf009 151}
152
13bbe067 153/**
0a4ac01b 154 * Given an object containing all the necessary data,
7cac0c4b 155 * (defined by the form in mod_form.php) this function
0a4ac01b 156 * will update an existing instance with new data.
df1ba0f4 157 *
158 * @global object
90f4745c 159 * @param object $forum forum instance (with magic quotes)
6b7de0bb 160 * @return bool success
90f4745c 161 */
42776c94 162function forum_update_instance($forum, $mform) {
862f5a49 163 global $DB, $OUTPUT, $USER;
c18269c7 164
caadf009 165 $forum->timemodified = time();
353228d8 166 $forum->id = $forum->instance;
caadf009 167
f0da6b85 168 if (empty($forum->assessed)) {
f2f56406 169 $forum->assessed = 0;
170 }
2b63df96 171
353228d8 172 if (empty($forum->ratingtime) or empty($forum->assessed)) {
98914efd 173 $forum->assesstimestart = 0;
174 $forum->assesstimefinish = 0;
175 }
176
c18269c7 177 $oldforum = $DB->get_record('forum', array('id'=>$forum->id));
13bbe067 178
179 // MDL-3942 - if the aggregation type or scale (i.e. max grade) changes then recalculate the grades for the entire forum
180 // if scale changes - do we need to recheck the ratings, if ratings higher than scale how do we want to respond?
181 // for count and sum aggregation types the grade we check to make sure they do not exceed the scale (i.e. max score) when calculating the grade
182 if (($oldforum->assessed<>$forum->assessed) or ($oldforum->scale<>$forum->scale)) {
183 forum_update_grades($forum); // recalculate grades for the forum
184 }
185
d3583b41 186 if ($forum->type == 'single') { // Update related discussion and post.
35b81f27
RT
187 $discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id), 'timemodified ASC');
188 if (!empty($discussions)) {
189 if (count($discussions) > 1) {
190 echo $OUTPUT->notification(get_string('warnformorepost', 'forum'));
191 }
192 $discussion = array_pop($discussions);
193 } else {
194 // try to recover by creating initial discussion - MDL-16262
195 $discussion = new stdClass();
196 $discussion->course = $forum->course;
197 $discussion->forum = $forum->id;
198 $discussion->name = $forum->name;
199 $discussion->assessed = $forum->assessed;
200 $discussion->message = $forum->intro;
201 $discussion->messageformat = $forum->introformat;
202 $discussion->messagetrust = true;
203 $discussion->mailnow = false;
204 $discussion->groupid = -1;
205
206 $message = '';
207
208 forum_add_discussion($discussion, null, $message);
209
210 if (! $discussion = $DB->get_record('forum_discussions', array('forum'=>$forum->id))) {
211 print_error('cannotadd', 'forum');
caadf009 212 }
213 }
c18269c7 214 if (! $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost))) {
12e57b92 215 print_error('cannotfindfirstpost', 'forum');
caadf009 216 }
217
6606c00f 218 $cm = get_coursemodule_from_instance('forum', $forum->id);
bf0f06b1 219 $modcontext = context_module::instance($cm->id, MUST_EXIST);
42776c94 220
a11aa38e 221 $post = $DB->get_record('forum_posts', array('id'=>$discussion->firstpost), '*', MUST_EXIST);
6606c00f
MD
222 $post->subject = $forum->name;
223 $post->message = $forum->intro;
224 $post->messageformat = $forum->introformat;
225 $post->messagetrust = trusttext_trusted($modcontext);
226 $post->modified = $forum->timemodified;
a11aa38e
PS
227 $post->userid = $USER->id; // MDL-18599, so that current teacher can take ownership of activities.
228
229 if ($mform and $draftid = file_get_submitted_draft_itemid('introeditor')) {
230 // Ugly hack - we need to copy the files somehow.
231 $options = array('subdirs'=>true); // Use the same options as intro field!
232 $post->message = file_save_draft_area_files($draftid, $modcontext->id, 'mod_forum', 'post', $post->id, $options, $post->message);
233 }
caadf009 234
a8d6ef8c 235 $DB->update_record('forum_posts', $post);
caadf009 236 $discussion->name = $forum->name;
a8d6ef8c 237 $DB->update_record('forum_discussions', $discussion);
caadf009 238 }
239
a8d6ef8c 240 $DB->update_record('forum', $forum);
353228d8 241
4a913724
GPL
242 $modcontext = context_module::instance($forum->coursemodule);
243 if (($forum->forcesubscribe == FORUM_INITIALSUBSCRIBE) && ($oldforum->forcesubscribe <> $forum->forcesubscribe)) {
59075a43 244 $users = \mod_forum\subscriptions::get_potential_subscribers($modcontext, 0, 'u.id, u.email', '');
4a913724 245 foreach ($users as $user) {
59075a43 246 \mod_forum\subscriptions::subscribe_user($user->id, $forum, $modcontext);
4a913724
GPL
247 }
248 }
249
353228d8 250 forum_grade_item_update($forum);
251
252 return true;
caadf009 253}
254
255
0a4ac01b 256/**
257 * Given an ID of an instance of this module,
258 * this function will permanently delete the instance
259 * and any data that depends on it.
df1ba0f4 260 *
261 * @global object
262 * @param int $id forum instance id
90f4745c 263 * @return bool success
0a4ac01b 264 */
caadf009 265function forum_delete_instance($id) {
c18269c7 266 global $DB;
caadf009 267
c18269c7 268 if (!$forum = $DB->get_record('forum', array('id'=>$id))) {
caadf009 269 return false;
270 }
455a8fed 271 if (!$cm = get_coursemodule_from_instance('forum', $forum->id)) {
272 return false;
273 }
274 if (!$course = $DB->get_record('course', array('id'=>$cm->course))) {
275 return false;
276 }
277
bf0f06b1 278 $context = context_module::instance($cm->id);
caadf009 279
fa686bc4 280 // now get rid of all files
281 $fs = get_file_storage();
455a8fed 282 $fs->delete_area_files($context->id);
fa686bc4 283
caadf009 284 $result = true;
285
361a41d3
AN
286 // Delete digest and subscription preferences.
287 $DB->delete_records('forum_digests', array('forum' => $forum->id));
288 $DB->delete_records('forum_subscriptions', array('forum'=>$forum->id));
289 $DB->delete_records('forum_discussion_subs', array('forum' => $forum->id));
290
c18269c7 291 if ($discussions = $DB->get_records('forum_discussions', array('forum'=>$forum->id))) {
caadf009 292 foreach ($discussions as $discussion) {
455a8fed 293 if (!forum_delete_discussion($discussion, true, $course, $cm, $forum)) {
caadf009 294 $result = false;
295 }
296 }
297 }
298
f37da850 299 forum_tp_delete_read_records(-1, -1, -1, $forum->id);
300
415f8c3e 301 if (!$DB->delete_records('forum', array('id'=>$forum->id))) {
caadf009 302 $result = false;
303 }
304
353228d8 305 forum_grade_item_delete($forum);
306
caadf009 307 return $result;
308}
309
310
4e781c7b 311/**
312 * Indicates API features that the forum supports.
313 *
df1ba0f4 314 * @uses FEATURE_GROUPS
315 * @uses FEATURE_GROUPINGS
df1ba0f4 316 * @uses FEATURE_MOD_INTRO
317 * @uses FEATURE_COMPLETION_TRACKS_VIEWS
318 * @uses FEATURE_COMPLETION_HAS_RULES
319 * @uses FEATURE_GRADE_HAS_GRADE
320 * @uses FEATURE_GRADE_OUTCOMES
4e781c7b 321 * @param string $feature
322 * @return mixed True if yes (some features may use other values)
323 */
324function forum_supports($feature) {
325 switch($feature) {
42f103be 326 case FEATURE_GROUPS: return true;
327 case FEATURE_GROUPINGS: return true;
dc5c2bd9 328 case FEATURE_MOD_INTRO: return true;
4e781c7b 329 case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
42f103be 330 case FEATURE_COMPLETION_HAS_RULES: return true;
331 case FEATURE_GRADE_HAS_GRADE: return true;
332 case FEATURE_GRADE_OUTCOMES: return true;
4bfdcfcf
EL
333 case FEATURE_RATE: return true;
334 case FEATURE_BACKUP_MOODLE2: return true;
3e4c2435 335 case FEATURE_SHOW_DESCRIPTION: return true;
50da4ddd 336 case FEATURE_PLAGIARISM: return true;
42f103be 337
49f6e5f4 338 default: return null;
4e781c7b 339 }
340}
341
342
343/**
344 * Obtains the automatic completion state for this forum based on any conditions
345 * in forum settings.
346 *
df1ba0f4 347 * @global object
348 * @global object
4e781c7b 349 * @param object $course Course
350 * @param object $cm Course-module
351 * @param int $userid User ID
352 * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
353 * @return bool True if completed, false if not. (If no conditions, then return
354 * value depends on comparison type)
355 */
356function forum_get_completion_state($course,$cm,$userid,$type) {
357 global $CFG,$DB;
358
359 // Get forum details
6093af9b 360 if (!($forum=$DB->get_record('forum',array('id'=>$cm->instance)))) {
4e781c7b 361 throw new Exception("Can't find forum {$cm->instance}");
362 }
363
364 $result=$type; // Default return value
365
366 $postcountparams=array('userid'=>$userid,'forumid'=>$forum->id);
367 $postcountsql="
5e7f2b0b 368SELECT
369 COUNT(1)
370FROM
371 {forum_posts} fp
49f6e5f4 372 INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
4e781c7b 373WHERE
374 fp.userid=:userid AND fd.forum=:forumid";
375
6093af9b 376 if ($forum->completiondiscussions) {
4e781c7b 377 $value = $forum->completiondiscussions <=
6093af9b 378 $DB->count_records('forum_discussions',array('forum'=>$forum->id,'userid'=>$userid));
379 if ($type == COMPLETION_AND) {
380 $result = $result && $value;
4e781c7b 381 } else {
6093af9b 382 $result = $result || $value;
4e781c7b 383 }
384 }
6093af9b 385 if ($forum->completionreplies) {
5e7f2b0b 386 $value = $forum->completionreplies <=
6093af9b 387 $DB->get_field_sql( $postcountsql.' AND fp.parent<>0',$postcountparams);
388 if ($type==COMPLETION_AND) {
389 $result = $result && $value;
4e781c7b 390 } else {
6093af9b 391 $result = $result || $value;
4e781c7b 392 }
393 }
6093af9b 394 if ($forum->completionposts) {
4e781c7b 395 $value = $forum->completionposts <= $DB->get_field_sql($postcountsql,$postcountparams);
6093af9b 396 if ($type == COMPLETION_AND) {
397 $result = $result && $value;
4e781c7b 398 } else {
6093af9b 399 $result = $result || $value;
4e781c7b 400 }
401 }
402
5e7f2b0b 403 return $result;
4e781c7b 404}
405
8260050d
AD
406/**
407 * Create a message-id string to use in the custom headers of forum notification emails
408 *
409 * message-id is used by email clients to identify emails and to nest conversations
410 *
411 * @param int $postid The ID of the forum post we are notifying the user about
412 * @param int $usertoid The ID of the user being notified
8260050d
AD
413 * @return string A unique message-id
414 */
54dceeed
BH
415function forum_get_email_message_id($postid, $usertoid) {
416 return generate_email_messageid(hash('sha256', $postid . 'to' . $usertoid));
1376b0dd 417}
4e781c7b 418
103f34d8
PS
419/**
420 * Removes properties from user record that are not necessary
421 * for sending post notifications.
422 * @param stdClass $user
423 * @return void, $user parameter is modified
424 */
425function forum_cron_minimise_user_record(stdClass $user) {
426
427 // We store large amount of users in one huge array,
428 // make sure we do not store info there we do not actually need
429 // in mail generation code or messaging.
430
431 unset($user->institution);
432 unset($user->department);
433 unset($user->address);
434 unset($user->city);
435 unset($user->url);
436 unset($user->currentlogin);
437 unset($user->description);
438 unset($user->descriptionformat);
439}
440
0a4ac01b 441/**
cae945d2
DP
442 * Function to be run periodically according to the scheduled task.
443 *
0a4ac01b 444 * Finds all posts that have yet to be mailed out, and mails them
cae945d2 445 * out to all subscribers as well as other maintance tasks.
df1ba0f4 446 *
cae945d2
DP
447 * NOTE: Since 2.7.2 this function is run by scheduled task rather
448 * than standard cron.
449 *
450 * @todo MDL-44734 The function will be split up into seperate tasks.
90f4745c 451 */
0fa18d5a 452function forum_cron() {
31793839 453 global $CFG, $USER, $DB, $PAGE;
857b798b 454
a974c799 455 $site = get_site();
456
31793839
AN
457 // The main renderers.
458 $htmlout = $PAGE->get_renderer('mod_forum', 'email', 'htmlemail');
459 $textout = $PAGE->get_renderer('mod_forum', 'email', 'textemail');
460 $htmldigestfullout = $PAGE->get_renderer('mod_forum', 'emaildigestfull', 'htmlemail');
461 $textdigestfullout = $PAGE->get_renderer('mod_forum', 'emaildigestfull', 'textemail');
462 $htmldigestbasicout = $PAGE->get_renderer('mod_forum', 'emaildigestbasic', 'htmlemail');
463 $textdigestbasicout = $PAGE->get_renderer('mod_forum', 'emaildigestbasic', 'textemail');
464
103f34d8
PS
465 // All users that are subscribed to any post that needs sending,
466 // please increase $CFG->extramemorylimit on large sites that
467 // send notifications to a large number of users.
a974c799 468 $users = array();
103f34d8 469 $userscount = 0; // Cached user counter - count($users) in PHP is horribly slow!!!
a974c799 470
49566c8a 471 // Status arrays.
a974c799 472 $mailcount = array();
473 $errorcount = array();
474
475 // caches
49566c8a
AN
476 $discussions = array();
477 $forums = array();
478 $courses = array();
479 $coursemodules = array();
480 $subscribedusers = array();
91223df6 481 $messageinboundhandlers = array();
ec2137ba 482
0a4ac01b 483 // Posts older than 2 days will not be mailed. This is to avoid the problem where
484 // cron has not been running for a long time, and then suddenly people are flooded
485 // with mail from the past few weeks or months
3ecca1ee 486 $timenow = time();
487 $endtime = $timenow - $CFG->maxeditingtime;
0a4ac01b 488 $starttime = $endtime - 48 * 3600; // Two days earlier
3ecca1ee 489
8e08c731
AN
490 // Get the list of forum subscriptions for per-user per-forum maildigest settings.
491 $digestsset = $DB->get_recordset('forum_digests', null, '', 'id, userid, forum, maildigest');
492 $digests = array();
493 foreach ($digestsset as $thisrow) {
494 if (!isset($digests[$thisrow->forum])) {
495 $digests[$thisrow->forum] = array();
496 }
497 $digests[$thisrow->forum][$thisrow->userid] = $thisrow->maildigest;
498 }
499 $digestsset->close();
500
91223df6
AN
501 // Create the generic messageinboundgenerator.
502 $messageinboundgenerator = new \core\message\inbound\address_manager();
503 $messageinboundgenerator->set_handler('\mod_forum\message\inbound\reply_handler');
504
90f4745c 505 if ($posts = forum_get_unmailed_posts($starttime, $endtime, $timenow)) {
0a4ac01b 506 // Mark them all now as being mailed. It's unlikely but possible there
507 // might be an error later so that a post is NOT actually mailed out,
508 // but since mail isn't crucial, we can accept this risk. Doing it now
509 // prevents the risk of duplicated mails, which is a worse problem.
16b4e5b6 510
5fac3a5e 511 if (!forum_mark_old_posts_as_mailed($endtime)) {
512 mtrace('Errors occurred while trying to mark some posts as being mailed.');
513 return false; // Don't continue trying to mail them, in case we are in a cron loop
514 }
515
516 // checking post validity, and adding users to loop through later
517 foreach ($posts as $pid => $post) {
518
a974c799 519 $discussionid = $post->discussion;
520 if (!isset($discussions[$discussionid])) {
4e445355 521 if ($discussion = $DB->get_record('forum_discussions', array('id'=> $post->discussion))) {
a974c799 522 $discussions[$discussionid] = $discussion;
49566c8a
AN
523 \mod_forum\subscriptions::fill_subscription_cache($discussion->forum);
524 \mod_forum\subscriptions::fill_discussion_subscription_cache($discussion->forum);
525
a974c799 526 } else {
49566c8a 527 mtrace('Could not find discussion ' . $discussionid);
a974c799 528 unset($posts[$pid]);
529 continue;
530 }
5fac3a5e 531 }
a974c799 532 $forumid = $discussions[$discussionid]->forum;
533 if (!isset($forums[$forumid])) {
4e445355 534 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
a974c799 535 $forums[$forumid] = $forum;
536 } else {
537 mtrace('Could not find forum '.$forumid);
538 unset($posts[$pid]);
539 continue;
540 }
5fac3a5e 541 }
a974c799 542 $courseid = $forums[$forumid]->course;
543 if (!isset($courses[$courseid])) {
4e445355 544 if ($course = $DB->get_record('course', array('id' => $courseid))) {
a974c799 545 $courses[$courseid] = $course;
546 } else {
547 mtrace('Could not find course '.$courseid);
548 unset($posts[$pid]);
549 continue;
550 }
5fac3a5e 551 }
a974c799 552 if (!isset($coursemodules[$forumid])) {
553 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
554 $coursemodules[$forumid] = $cm;
555 } else {
9c670df6 556 mtrace('Could not find course module for forum '.$forumid);
a974c799 557 unset($posts[$pid]);
558 continue;
559 }
560 }
561
e7f0b4d3
AN
562 // Save the Inbound Message datakey here to reduce DB queries later.
563 $messageinboundgenerator->set_data($pid);
564 $messageinboundhandlers[$pid] = $messageinboundgenerator->fetch_data_key();
565
49566c8a 566 // Caching subscribed users of each forum.
a974c799 567 if (!isset($subscribedusers[$forumid])) {
bf0f06b1 568 $modcontext = context_module::instance($coursemodules[$forumid]->id);
e3bbfb52 569 if ($subusers = \mod_forum\subscriptions::fetch_subscribed_users($forums[$forumid], 0, $modcontext, 'u.*', true)) {
91223df6 570
704ca25c 571 foreach ($subusers as $postuser) {
572 // this user is subscribed to this forum
a5cef9c8 573 $subscribedusers[$forumid][$postuser->id] = $postuser->id;
103f34d8
PS
574 $userscount++;
575 if ($userscount > FORUM_CRON_USER_CACHE) {
576 // Store minimal user info.
577 $minuser = new stdClass();
578 $minuser->id = $postuser->id;
579 $users[$postuser->id] = $minuser;
580 } else {
581 // Cache full user record.
582 forum_cron_minimise_user_record($postuser);
583 $users[$postuser->id] = $postuser;
584 }
704ca25c 585 }
103f34d8
PS
586 // Release memory.
587 unset($subusers);
588 unset($postuser);
a974c799 589 }
5fac3a5e 590 }
5fac3a5e 591 $mailcount[$pid] = 0;
592 $errorcount[$pid] = 0;
a974c799 593 }
5fac3a5e 594 }
caadf009 595
4dad2828 596 if ($users && $posts) {
edffca15 597
5fac3a5e 598 foreach ($users as $userto) {
49566c8a
AN
599 // Terminate if processing of any account takes longer than 2 minutes.
600 core_php_time_limit::raise(120);
a974c799 601
49566c8a 602 mtrace('Processing user ' . $userto->id);
caadf009 603
49566c8a 604 // Init user caches - we keep the cache for one cycle only, otherwise it could consume too much memory.
103f34d8
PS
605 if (isset($userto->username)) {
606 $userto = clone($userto);
607 } else {
608 $userto = $DB->get_record('user', array('id' => $userto->id));
609 forum_cron_minimise_user_record($userto);
610 }
df1c2c71 611 $userto->viewfullnames = array();
612 $userto->canpost = array();
90f4745c 613 $userto->markposts = array();
669f2499 614
49566c8a 615 // Setup this user so that the capabilities are cached, and environment matches receiving user.
103f34d8
PS
616 cron_setup_user($userto);
617
49566c8a
AN
618 // Reset the caches.
619 foreach ($coursemodules as $forumid => $unused) {
39790bd8 620 $coursemodules[$forumid]->cache = new stdClass();
9db5d080 621 $coursemodules[$forumid]->cache->caps = array();
622 unset($coursemodules[$forumid]->uservisible);
623 }
624
4dad2828 625 foreach ($posts as $pid => $post) {
a974c799 626 $discussion = $discussions[$post->discussion];
627 $forum = $forums[$discussion->forum];
628 $course = $courses[$forum->course];
90f4745c 629 $cm =& $coursemodules[$forum->id];
4dad2828 630
49566c8a
AN
631 // Do some checks to see if we can bail out now.
632
633 // Only active enrolled users are in the list of subscribers.
634 // This does not necessarily mean that the user is subscribed to the forum or to the discussion though.
a5cef9c8 635 if (!isset($subscribedusers[$forum->id][$userto->id])) {
49566c8a
AN
636 // The user does not subscribe to this forum.
637 continue;
638 }
639
4238983e 640 if (!\mod_forum\subscriptions::is_subscribed($userto->id, $forum, $post->discussion, $coursemodules[$forum->id])) {
49566c8a
AN
641 // The user does not subscribe to this forum, or to this specific discussion.
642 continue;
4dad2828 643 }
4dad2828 644
eb451c79
AN
645 if ($subscriptiontime = \mod_forum\subscriptions::fetch_discussion_subscription($forum->id, $userto->id)) {
646 // Skip posts if the user subscribed to the discussion after it was created.
647 if (isset($subscriptiontime[$post->discussion]) && ($subscriptiontime[$post->discussion] > $post->created)) {
648 continue;
649 }
650 }
651
49566c8a
AN
652 // Don't send email if the forum is Q&A and the user has not posted.
653 // Initial topics are still mailed.
1e966b8a 654 if ($forum->type == 'qanda' && !forum_get_user_posted_time($discussion->id, $userto->id) && $pid != $discussion->firstpost) {
49566c8a 655 mtrace('Did not email ' . $userto->id.' because user has not posted in discussion');
67fc4f00
DC
656 continue;
657 }
90f4745c 658
49566c8a
AN
659 // Get info about the sending user.
660 if (array_key_exists($post->userid, $users)) {
661 // We might know the user already.
a5cef9c8 662 $userfrom = $users[$post->userid];
103f34d8
PS
663 if (!isset($userfrom->idnumber)) {
664 // Minimalised user info, fetch full record.
665 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
666 forum_cron_minimise_user_record($userfrom);
667 }
668
4e445355 669 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
103f34d8
PS
670 forum_cron_minimise_user_record($userfrom);
671 // Fetch only once if possible, we can add it to user list, it will be skipped anyway.
672 if ($userscount <= FORUM_CRON_USER_CACHE) {
673 $userscount++;
674 $users[$userfrom->id] = $userfrom;
675 }
a5cef9c8 676 } else {
49566c8a 677 mtrace('Could not find user ' . $post->userid . ', author of post ' . $post->id . '. Unable to send message.');
a5cef9c8 678 continue;
679 }
680
49566c8a 681 // Note: If we want to check that userto and userfrom are not the same person this is probably the spot to do it.
505ab5aa 682
49566c8a 683 // Setup global $COURSE properly - needed for roles and languages.
e8b7114d 684 cron_setup_user($userto, $course);
4dad2828 685
49566c8a 686 // Fill caches.
df1c2c71 687 if (!isset($userto->viewfullnames[$forum->id])) {
bf0f06b1 688 $modcontext = context_module::instance($cm->id);
df1c2c71 689 $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
690 }
8b79a625 691 if (!isset($userto->canpost[$discussion->id])) {
bf0f06b1 692 $modcontext = context_module::instance($cm->id);
8b79a625 693 $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
df1c2c71 694 }
695 if (!isset($userfrom->groups[$forum->id])) {
696 if (!isset($userfrom->groups)) {
697 $userfrom->groups = array();
103f34d8
PS
698 if (isset($users[$userfrom->id])) {
699 $users[$userfrom->id]->groups = array();
700 }
df1c2c71 701 }
702 $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
103f34d8
PS
703 if (isset($users[$userfrom->id])) {
704 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
705 }
df1c2c71 706 }
9f2ded76 707
49566c8a
AN
708 // Make sure groups allow this user to see this email.
709 if ($discussion->groupid > 0 and $groupmode = groups_get_activity_groupmode($cm, $course)) {
710 // Groups are being used.
711 if (!groups_group_exists($discussion->groupid)) {
712 // Can't find group - be safe and don't this message.
713 continue;
5fac3a5e 714 }
918e9805 715
2c386f82 716 if (!groups_is_member($discussion->groupid) and !has_capability('moodle/site:accessallgroups', $modcontext)) {
49566c8a 717 // Do not send posts from other groups when in SEPARATEGROUPS or VISIBLEGROUPS.
38bd362a 718 continue;
9197e147 719 }
4dad2828 720 }
2b63df96 721
49566c8a
AN
722 // Make sure we're allowed to see the post.
723 if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
724 mtrace('User ' . $userto->id .' can not see ' . $post->id . '. Not sending message.');
4dad2828 725 continue;
726 }
727
728 // OK so we need to send the email.
729
730 // Does the user want this post in a digest? If so postpone it for now.
8e08c731
AN
731 $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
732
733 if ($maildigest > 0) {
49566c8a 734 // This user wants the mails to be in digest form.
39790bd8 735 $queue = new stdClass();
a974c799 736 $queue->userid = $userto->id;
4dad2828 737 $queue->discussionid = $discussion->id;
a974c799 738 $queue->postid = $post->id;
90f4745c 739 $queue->timemodified = $post->created;
fc29e51b 740 $DB->insert_record('forum_queue', $queue);
4dad2828 741 continue;
742 }
65b0e537 743
49566c8a 744 // Prepare to actually send the post now, and build up the content.
4dad2828 745
a974c799 746 $cleanforumname = str_replace('"', "'", strip_tags(format_string($forum->name)));
4dad2828 747
49566c8a
AN
748 $userfrom->customheaders = array (
749 // Headers to make emails easier to track.
54dceeed 750 'List-Id: "' . $cleanforumname . '" ' . generate_email_messageid('moodleforum' . $forum->id),
49566c8a 751 'List-Help: ' . $CFG->wwwroot . '/mod/forum/view.php?f=' . $forum->id,
54dceeed 752 'Message-ID: ' . forum_get_email_message_id($post->id, $userto->id),
49566c8a 753 'X-Course-Id: ' . $course->id,
c9fa2dee
AN
754 'X-Course-Name: ' . format_string($course->fullname, true),
755
756 // Headers to help prevent auto-responders.
757 'Precedence: Bulk',
758 'X-Auto-Response-Suppress: All',
759 'Auto-Submitted: auto-generated',
4dad2828 760 );
a974c799 761
bf0f06b1 762 $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
8ebbb06a 763
91223df6
AN
764 // Generate a reply-to address from using the Inbound Message handler.
765 $replyaddress = null;
766 if ($userto->canpost[$discussion->id] && array_key_exists($post->id, $messageinboundhandlers)) {
767 $messageinboundgenerator->set_data($post->id, $messageinboundhandlers[$post->id]);
768 $replyaddress = $messageinboundgenerator->generate($userto->id);
769 }
770
31793839
AN
771 if (!isset($userto->canpost[$discussion->id])) {
772 $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
773 } else {
774 $canreply = $userto->canpost[$discussion->id];
775 }
776
777 $data = new \mod_forum\output\forum_post_email(
778 $course,
779 $cm,
780 $forum,
781 $discussion,
782 $post,
783 $userfrom,
784 $userto,
785 $canreply
786 );
787
7898d616
BH
788 $userfrom->customheaders[] = sprintf('List-Unsubscribe: <%s>',
789 $data->get_unsubscribediscussionlink());
790
31793839
AN
791 if (!isset($userto->viewfullnames[$forum->id])) {
792 $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
793 } else {
794 $data->viewfullnames = $userto->viewfullnames[$forum->id];
795 }
796
091420f9
BH
797 // Not all of these variables are used in the default language
798 // string but are made available to support custom subjects.
013e85bb 799 $a = new stdClass();
31793839 800 $a->subject = $data->get_subject();
091420f9
BH
801 $a->forumname = $cleanforumname;
802 $a->sitefullname = format_string($site->fullname);
803 $a->siteshortname = format_string($site->shortname);
804 $a->courseidnumber = $data->get_courseidnumber();
805 $a->coursefullname = $data->get_coursefullname();
806 $a->courseshortname = $data->get_coursename();
28c0c4af 807 $postsubject = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
4dad2828 808
54dceeed 809 $rootid = forum_get_email_message_id($discussion->firstpost, $userto->id);
b1b480f9
BH
810
811 if ($post->parent) {
812 // This post is a reply, so add reply header (RFC 2822).
54dceeed 813 $parentid = forum_get_email_message_id($post->parent, $userto->id);
b1b480f9
BH
814 $userfrom->customheaders[] = "In-Reply-To: $parentid";
815
816 // If the post is deeply nested we also reference the parent message id and
817 // the root message id (if different) to aid threading when parts of the email
818 // conversation have been deleted (RFC1036).
819 if ($post->parent != $discussion->firstpost) {
820 $userfrom->customheaders[] = "References: $rootid $parentid";
821 } else {
822 $userfrom->customheaders[] = "References: $parentid";
823 }
824 }
825
826 // MS Outlook / Office uses poorly documented and non standard headers, including
827 // Thread-Topic which overrides the Subject and shouldn't contain Re: or Fwd: etc.
828 $a->subject = $discussion->name;
318e5cb3
BH
829 $threadtopic = html_to_text(get_string('postmailsubject', 'forum', $a), 0);
830 $userfrom->customheaders[] = "Thread-Topic: $threadtopic";
b1b480f9
BH
831 $userfrom->customheaders[] = "Thread-Index: " . substr($rootid, 1, 28);
832
4dad2828 833 // Send the post now!
4dad2828 834 mtrace('Sending ', '');
5e7f2b0b 835
9bb71899 836 $eventdata = new \core\message\message();
cc350fd9 837 $eventdata->courseid = $course->id;
49566c8a
AN
838 $eventdata->component = 'mod_forum';
839 $eventdata->name = 'posts';
840 $eventdata->userfrom = $userfrom;
841 $eventdata->userto = $userto;
842 $eventdata->subject = $postsubject;
31793839 843 $eventdata->fullmessage = $textout->render($data);
49566c8a 844 $eventdata->fullmessageformat = FORMAT_PLAIN;
31793839 845 $eventdata->fullmessagehtml = $htmlout->render($data);
49566c8a 846 $eventdata->notification = 1;
91223df6 847 $eventdata->replyto = $replyaddress;
9bb71899
AA
848 if (!empty($replyaddress)) {
849 // Add extra text to email messages if they can reply back.
850 $textfooter = "\n\n" . get_string('replytopostbyemail', 'mod_forum');
851 $htmlfooter = html_writer::tag('p', get_string('replytopostbyemail', 'mod_forum'));
852 $additionalcontent = array('fullmessage' => array('footer' => $textfooter),
853 'fullmessagehtml' => array('footer' => $htmlfooter));
854 $eventdata->set_additional_content('email', $additionalcontent);
855 }
e9c55e39 856
6ee2611c 857 $smallmessagestrings = new stdClass();
49566c8a
AN
858 $smallmessagestrings->user = fullname($userfrom);
859 $smallmessagestrings->forumname = "$shortname: " . format_string($forum->name, true) . ": " . $discussion->name;
860 $smallmessagestrings->message = $post->message;
861
862 // Make sure strings are in message recipients language.
4ffa1463 863 $eventdata->smallmessage = get_string_manager()->get_string('smallmessage', 'forum', $smallmessagestrings, $userto->lang);
14a0e7dd 864
49566c8a
AN
865 $contexturl = new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id), 'p' . $post->id);
866 $eventdata->contexturl = $contexturl->out();
14a0e7dd 867 $eventdata->contexturlname = $discussion->name;
3b120e46 868
505ab5aa 869 $mailresult = message_send($eventdata);
49566c8a 870 if (!$mailresult) {
505ab5aa 871 mtrace("Error: mod/forum/lib.php forum_cron(): Could not send out mail for id $post->id to user $userto->id".
49566c8a 872 " ($userto->email) .. not trying again.");
4dad2828 873 $errorcount[$post->id]++;
4dad2828 874 } else {
875 $mailcount[$post->id]++;
876
49566c8a 877 // Mark post as read if forum_usermarksread is set off.
90f4745c 878 if (!$CFG->forum_usermarksread) {
879 $userto->markposts[$post->id] = $post->id;
caadf009 880 }
aaf7a9dc 881 }
4dad2828 882
49566c8a 883 mtrace('post ' . $post->id . ': ' . $post->subject);
aaf7a9dc 884 }
90f4745c 885
49566c8a 886 // Mark processed posts as read.
64ebf395
AN
887 if (get_user_preferences('forum_markasreadonnotification', 1, $userto->id) == 1) {
888 forum_tp_mark_posts_read($userto, $userto->markposts);
889 }
890
103f34d8 891 unset($userto);
5fac3a5e 892 }
893 }
894
895 if ($posts) {
896 foreach ($posts as $post) {
16b4e5b6 897 mtrace($mailcount[$post->id]." users were sent post $post->id, '$post->subject'");
5fac3a5e 898 if ($errorcount[$post->id]) {
8076010d 899 $DB->set_field('forum_posts', 'mailed', FORUM_MAILED_ERROR, array('id' => $post->id));
a974c799 900 }
aaf7a9dc 901 }
902 }
903
8cb121cc 904 // release some memory
905 unset($subscribedusers);
906 unset($mailcount);
907 unset($errorcount);
908
e8b7114d 909 cron_setup_user();
ad9ff3d3 910
d6e7a63d 911 $sitetimezone = core_date::get_server_timezone();
944a2b28 912
0a4ac01b 913 // Now see if there are any digest mails waiting to be sent, and if we should send them
aaf7a9dc 914
f3c3a4d3 915 mtrace('Starting digest processing...');
916
3ef7279f 917 core_php_time_limit::raise(300); // terminate if not able to fetch all digests in 5 minutes
910b6fa7 918
8f0cd6ef 919 if (!isset($CFG->digestmailtimelast)) { // To catch the first time
ca8e8a10 920 set_config('digestmailtimelast', 0);
921 }
922
923 $timenow = time();
944a2b28 924 $digesttime = usergetmidnight($timenow, $sitetimezone) + ($CFG->digestmailtime * 3600);
ca8e8a10 925
f3c3a4d3 926 // Delete any really old ones (normally there shouldn't be any)
927 $weekago = $timenow - (7 * 24 * 3600);
2ac897cd 928 $DB->delete_records_select('forum_queue', "timemodified < ?", array($weekago));
910b6fa7 929 mtrace ('Cleaned old digest records');
9f2ded76 930
ca8e8a10 931 if ($CFG->digestmailtimelast < $digesttime and $timenow > $digesttime) {
b140ae85 932
b140ae85 933 mtrace('Sending forum digests: '.userdate($timenow, '', $sitetimezone));
934
4e445355 935 $digestposts_rs = $DB->get_recordset_select('forum_queue', "timemodified < ?", array($digesttime));
910b6fa7 936
4e445355 937 if ($digestposts_rs->valid()) {
8ad64455 938
aaf7a9dc 939 // We have work to do
940 $usermailcount = 0;
aaf7a9dc 941
a974c799 942 //caches - reuse the those filled before too
aaf7a9dc 943 $discussionposts = array();
944 $userdiscussions = array();
a974c799 945
4e445355 946 foreach ($digestposts_rs as $digestpost) {
a974c799 947 if (!isset($posts[$digestpost->postid])) {
4e445355 948 if ($post = $DB->get_record('forum_posts', array('id' => $digestpost->postid))) {
a974c799 949 $posts[$digestpost->postid] = $post;
950 } else {
951 continue;
952 }
953 }
954 $discussionid = $digestpost->discussionid;
955 if (!isset($discussions[$discussionid])) {
4e445355 956 if ($discussion = $DB->get_record('forum_discussions', array('id' => $discussionid))) {
a974c799 957 $discussions[$discussionid] = $discussion;
958 } else {
959 continue;
960 }
aaf7a9dc 961 }
a974c799 962 $forumid = $discussions[$discussionid]->forum;
963 if (!isset($forums[$forumid])) {
4e445355 964 if ($forum = $DB->get_record('forum', array('id' => $forumid))) {
a974c799 965 $forums[$forumid] = $forum;
966 } else {
967 continue;
968 }
969 }
970
971 $courseid = $forums[$forumid]->course;
972 if (!isset($courses[$courseid])) {
4e445355 973 if ($course = $DB->get_record('course', array('id' => $courseid))) {
a974c799 974 $courses[$courseid] = $course;
975 } else {
976 continue;
977 }
aaf7a9dc 978 }
a974c799 979
980 if (!isset($coursemodules[$forumid])) {
981 if ($cm = get_coursemodule_from_instance('forum', $forumid, $courseid)) {
982 $coursemodules[$forumid] = $cm;
983 } else {
984 continue;
985 }
aaf7a9dc 986 }
987 $userdiscussions[$digestpost->userid][$digestpost->discussionid] = $digestpost->discussionid;
988 $discussionposts[$digestpost->discussionid][$digestpost->postid] = $digestpost->postid;
989 }
4e445355 990 $digestposts_rs->close(); /// Finished iteration, let's close the resultset
aaf7a9dc 991
992 // Data collected, start sending out emails to each user
a974c799 993 foreach ($userdiscussions as $userid => $thesediscussions) {
aaf7a9dc 994
3ef7279f 995 core_php_time_limit::raise(120); // terminate if processing of any account takes longer than 2 minutes
aaf7a9dc 996
e8b7114d 997 cron_setup_user();
90f4745c 998
a974c799 999 mtrace(get_string('processingdigest', 'forum', $userid), '... ');
aaf7a9dc 1000
1001 // First of all delete all the queue entries for this user
4e445355 1002 $DB->delete_records_select('forum_queue', "userid = ? AND timemodified < ?", array($userid, $digesttime));
aaf7a9dc 1003
103f34d8
PS
1004 // Init user caches - we keep the cache for one cycle only,
1005 // otherwise it would unnecessarily consume memory.
1006 if (array_key_exists($userid, $users) and isset($users[$userid]->username)) {
1007 $userto = clone($users[$userid]);
1008 } else {
1009 $userto = $DB->get_record('user', array('id' => $userid));
1010 forum_cron_minimise_user_record($userto);
1011 }
df1c2c71 1012 $userto->viewfullnames = array();
1013 $userto->canpost = array();
90f4745c 1014 $userto->markposts = array();
df1c2c71 1015
103f34d8
PS
1016 // Override the language and timezone of the "current" user, so that
1017 // mail is customised for the receiver.
1018 cron_setup_user($userto);
1019
a974c799 1020 $postsubject = get_string('digestmailsubject', 'forum', format_string($site->shortname, true));
aaf7a9dc 1021
39790bd8 1022 $headerdata = new stdClass();
a974c799 1023 $headerdata->sitename = format_string($site->fullname, true);
d1a62a50 1024 $headerdata->userprefs = $CFG->wwwroot.'/user/forum.php?id='.$userid.'&amp;course='.$site->id;
aaf7a9dc 1025
1026 $posttext = get_string('digestmailheader', 'forum', $headerdata)."\n\n";
1027 $headerdata->userprefs = '<a target="_blank" href="'.$headerdata->userprefs.'">'.get_string('digestmailprefs', 'forum').'</a>';
9c674431 1028
efd42060
BH
1029 $posthtml = '<p>'.get_string('digestmailheader', 'forum', $headerdata).'</p>'
1030 . '<br /><hr size="1" noshade="noshade" />';
aaf7a9dc 1031
a974c799 1032 foreach ($thesediscussions as $discussionid) {
aaf7a9dc 1033
3ef7279f 1034 core_php_time_limit::raise(120); // to be reset for each post
a974c799 1035
1036 $discussion = $discussions[$discussionid];
1037 $forum = $forums[$discussion->forum];
1038 $course = $courses[$forum->course];
1039 $cm = $coursemodules[$forum->id];
65b0e537 1040
9152fc99 1041 //override language
e8b7114d 1042 cron_setup_user($userto, $course);
9152fc99 1043
df1c2c71 1044 // Fill caches
1045 if (!isset($userto->viewfullnames[$forum->id])) {
bf0f06b1 1046 $modcontext = context_module::instance($cm->id);
df1c2c71 1047 $userto->viewfullnames[$forum->id] = has_capability('moodle/site:viewfullnames', $modcontext);
1048 }
8b79a625 1049 if (!isset($userto->canpost[$discussion->id])) {
bf0f06b1 1050 $modcontext = context_module::instance($cm->id);
8b79a625 1051 $userto->canpost[$discussion->id] = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
df1c2c71 1052 }
caadf009 1053
de85c320 1054 $strforums = get_string('forums', 'forum');
59075a43 1055 $canunsubscribe = ! \mod_forum\subscriptions::is_forcesubscribed($forum);
8b79a625 1056 $canreply = $userto->canpost[$discussion->id];
bf0f06b1 1057 $shortname = format_string($course->shortname, true, array('context' => context_course::instance($course->id)));
de85c320 1058
aaf7a9dc 1059 $posttext .= "\n \n";
1060 $posttext .= '=====================================================================';
1061 $posttext .= "\n \n";
8ebbb06a 1062 $posttext .= "$shortname -> $strforums -> ".format_string($forum->name,true);
aaf7a9dc 1063 if ($discussion->name != $forum->name) {
c78ac798 1064 $posttext .= " -> ".format_string($discussion->name,true);
caadf009 1065 }
aaf7a9dc 1066 $posttext .= "\n";
3f213cd3
DNA
1067 $posttext .= $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
1068 $posttext .= "\n";
65b0e537 1069
aaf7a9dc 1070 $posthtml .= "<p><font face=\"sans-serif\">".
8ebbb06a 1071 "<a target=\"_blank\" href=\"$CFG->wwwroot/course/view.php?id=$course->id\">$shortname</a> -> ".
aaf7a9dc 1072 "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/index.php?id=$course->id\">$strforums</a> -> ".
3849dae8 1073 "<a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/view.php?f=$forum->id\">".format_string($forum->name,true)."</a>";
aaf7a9dc 1074 if ($discussion->name == $forum->name) {
1075 $posthtml .= "</font></p>";
caadf009 1076 } else {
c78ac798 1077 $posthtml .= " -> <a target=\"_blank\" href=\"$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id\">".format_string($discussion->name,true)."</a></font></p>";
caadf009 1078 }
aaf7a9dc 1079 $posthtml .= '<p>';
1080
e1c6dde1 1081 $postsarray = $discussionposts[$discussionid];
1082 sort($postsarray);
00999605 1083 $sentcount = 0;
e1c6dde1 1084
857b798b 1085 foreach ($postsarray as $postid) {
a974c799 1086 $post = $posts[$postid];
1087
1088 if (array_key_exists($post->userid, $users)) { // we might know him/her already
1089 $userfrom = $users[$post->userid];
103f34d8
PS
1090 if (!isset($userfrom->idnumber)) {
1091 $userfrom = $DB->get_record('user', array('id' => $userfrom->id));
1092 forum_cron_minimise_user_record($userfrom);
1093 }
1094
4e445355 1095 } else if ($userfrom = $DB->get_record('user', array('id' => $post->userid))) {
103f34d8
PS
1096 forum_cron_minimise_user_record($userfrom);
1097 if ($userscount <= FORUM_CRON_USER_CACHE) {
1098 $userscount++;
1099 $users[$userfrom->id] = $userfrom;
1100 }
1101
df1c2c71 1102 } else {
a974c799 1103 mtrace('Could not find user '.$post->userid);
aaf7a9dc 1104 continue;
1105 }
1106
df1c2c71 1107 if (!isset($userfrom->groups[$forum->id])) {
1108 if (!isset($userfrom->groups)) {
1109 $userfrom->groups = array();
103f34d8
PS
1110 if (isset($users[$userfrom->id])) {
1111 $users[$userfrom->id]->groups = array();
1112 }
df1c2c71 1113 }
1114 $userfrom->groups[$forum->id] = groups_get_all_groups($course->id, $userfrom->id, $cm->groupingid);
103f34d8
PS
1115 if (isset($users[$userfrom->id])) {
1116 $users[$userfrom->id]->groups[$forum->id] = $userfrom->groups[$forum->id];
1117 }
df1c2c71 1118 }
1119
c9fa2dee
AN
1120 // Headers to help prevent auto-responders.
1121 $userfrom->customheaders = array(
1122 "Precedence: Bulk",
1123 'X-Auto-Response-Suppress: All',
1124 'Auto-Submitted: auto-generated',
1125 );
857b798b 1126
8e08c731 1127 $maildigest = forum_get_user_maildigest_bulk($digests, $userto, $forum->id);
31793839
AN
1128 if (!isset($userto->canpost[$discussion->id])) {
1129 $canreply = forum_user_can_post($forum, $discussion, $userto, $cm, $course, $modcontext);
1130 } else {
1131 $canreply = $userto->canpost[$discussion->id];
1132 }
1133
1134 $data = new \mod_forum\output\forum_post_email(
1135 $course,
1136 $cm,
1137 $forum,
1138 $discussion,
1139 $post,
1140 $userfrom,
1141 $userto,
1142 $canreply
1143 );
1144
1145 if (!isset($userto->viewfullnames[$forum->id])) {
1146 $data->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
1147 } else {
1148 $data->viewfullnames = $userto->viewfullnames[$forum->id];
1149 }
857b798b 1150
31793839
AN
1151 if ($maildigest == 2) {
1152 // Subjects and link only.
1153 $posttext .= $textdigestbasicout->render($data);
1154 $posthtml .= $htmldigestbasicout->render($data);
857b798b 1155 } else {
31793839
AN
1156 // The full treatment.
1157 $posttext .= $textdigestfullout->render($data);
1158 $posthtml .= $htmldigestfullout->render($data);
df1c2c71 1159
31793839 1160 // Create an array of postid's for this user to mark as read.
90f4745c 1161 if (!$CFG->forum_usermarksread) {
1162 $userto->markposts[$post->id] = $post->id;
f37da850 1163 }
aaf7a9dc 1164 }
00999605 1165 $sentcount++;
aaf7a9dc 1166 }
b28118f6 1167 $footerlinks = array();
aaf7a9dc 1168 if ($canunsubscribe) {
b28118f6 1169 $footerlinks[] = "<a href=\"$CFG->wwwroot/mod/forum/subscribe.php?id=$forum->id\">" . get_string("unsubscribe", "forum") . "</a>";
857b798b 1170 } else {
b28118f6 1171 $footerlinks[] = get_string("everyoneissubscribed", "forum");
aaf7a9dc 1172 }
b28118f6
AN
1173 $footerlinks[] = "<a href='{$CFG->wwwroot}/mod/forum/index.php?id={$forum->course}'>" . get_string("digestmailpost", "forum") . '</a>';
1174 $posthtml .= "\n<div class='mdl-right'><font size=\"1\">" . implode('&nbsp;', $footerlinks) . '</font></div>';
aaf7a9dc 1175 $posthtml .= '<hr size="1" noshade="noshade" /></p>';
caadf009 1176 }
caadf009 1177
6d2e6936 1178 if (empty($userto->mailformat) || $userto->mailformat != 1) {
379a42cb 1179 // This user DOESN'T want to receive HTML
1180 $posthtml = '';
1181 }
5e7f2b0b 1182
00999605 1183 $eventdata = new \core\message\message();
880fc15b 1184 $eventdata->courseid = SITEID;
00999605
AN
1185 $eventdata->component = 'mod_forum';
1186 $eventdata->name = 'digests';
1187 $eventdata->userfrom = core_user::get_noreply_user();
1188 $eventdata->userto = $userto;
1189 $eventdata->subject = $postsubject;
1190 $eventdata->fullmessage = $posttext;
1191 $eventdata->fullmessageformat = FORMAT_PLAIN;
1192 $eventdata->fullmessagehtml = $posthtml;
1193 $eventdata->notification = 1;
1194 $eventdata->smallmessage = get_string('smallmessagedigest', 'forum', $sentcount);
1195 $mailresult = message_send($eventdata);
b58bd1a2
AD
1196
1197 if (!$mailresult) {
33c40cc6
DP
1198 mtrace("ERROR: mod/forum/cron.php: Could not send out digest mail to user $userto->id ".
1199 "($userto->email)... not trying again.");
aaf7a9dc 1200 } else {
b140ae85 1201 mtrace("success.");
aaf7a9dc 1202 $usermailcount++;
e3ff14ca 1203
90f4745c 1204 // Mark post as read if forum_usermarksread is set off
64ebf395
AN
1205 if (get_user_preferences('forum_markasreadonnotification', 1, $userto->id) == 1) {
1206 forum_tp_mark_posts_read($userto, $userto->markposts);
1207 }
3d94772d 1208 }
caadf009 1209 }
caadf009 1210 }
226a1d9d 1211 /// We have finishied all digest emails, update $CFG->digestmailtimelast
1212 set_config('digestmailtimelast', $timenow);
caadf009 1213 }
1214
e8b7114d 1215 cron_setup_user();
de85c320 1216
a974c799 1217 if (!empty($usermailcount)) {
b140ae85 1218 mtrace(get_string('digestsentusers', 'forum', $usermailcount));
aaf7a9dc 1219 }
1220
8ad64455 1221 if (!empty($CFG->forum_lastreadclean)) {
f37da850 1222 $timenow = time();
8ad64455 1223 if ($CFG->forum_lastreadclean + (24*3600) < $timenow) {
1224 set_config('forum_lastreadclean', $timenow);
8cb121cc 1225 mtrace('Removing old forum read tracking info...');
f37da850 1226 forum_tp_clean_read_records();
1227 }
1228 } else {
8ad64455 1229 set_config('forum_lastreadclean', time());
f37da850 1230 }
1231
caadf009 1232 return true;
1233}
1234
0a4ac01b 1235/**
13bbe067 1236 *
1670305d 1237 * @param object $course
1238 * @param object $user
1239 * @param object $mod TODO this is not used in this function, refactor
1240 * @param object $forum
1241 * @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
0a4ac01b 1242 */
caadf009 1243function forum_user_outline($course, $user, $mod, $forum) {
1a96363a
NC
1244 global $CFG;
1245 require_once("$CFG->libdir/gradelib.php");
1246 $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1247 if (empty($grades->items[0]->grades)) {
1248 $grade = false;
1249 } else {
1250 $grade = reset($grades->items[0]->grades);
1251 }
1252
1253 $count = forum_count_user_posts($forum->id, $user->id);
1254
1255 if ($count && $count->postcount > 0) {
39790bd8 1256 $result = new stdClass();
1a96363a
NC
1257 $result->info = get_string("numposts", "forum", $count->postcount);
1258 $result->time = $count->lastpost;
1259 if ($grade) {
1260 $result->info .= ', ' . get_string('grade') . ': ' . $grade->str_long_grade;
90f4745c 1261 }
1a96363a
NC
1262 return $result;
1263 } else if ($grade) {
39790bd8 1264 $result = new stdClass();
1a96363a 1265 $result->info = get_string('grade') . ': ' . $grade->str_long_grade;
4433f871
AD
1266
1267 //datesubmitted == time created. dategraded == time modified or time overridden
1268 //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
94a74f54 1269 //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
4433f871
AD
1270 if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
1271 $result->time = $grade->dategraded;
1272 } else {
1273 $result->time = $grade->datesubmitted;
1274 }
1275
1a96363a 1276 return $result;
caadf009 1277 }
1278 return NULL;
1279}
1280
1281
0a4ac01b 1282/**
df1ba0f4 1283 * @global object
1284 * @global object
1285 * @param object $coure
1286 * @param object $user
1287 * @param object $mod
1288 * @param object $forum
0a4ac01b 1289 */
caadf009 1290function forum_user_complete($course, $user, $mod, $forum) {
1a96363a
NC
1291 global $CFG,$USER, $OUTPUT;
1292 require_once("$CFG->libdir/gradelib.php");
1293
1294 $grades = grade_get_grades($course->id, 'mod', 'forum', $forum->id, $user->id);
1295 if (!empty($grades->items[0]->grades)) {
1296 $grade = reset($grades->items[0]->grades);
1297 echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
1298 if ($grade->str_feedback) {
1299 echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
1300 }
1301 }
caadf009 1302
1f48942e 1303 if ($posts = forum_get_user_posts($forum->id, $user->id)) {
e3ff14ca 1304
65bcf17b 1305 if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
12e57b92 1306 print_error('invalidcoursemodule');
65bcf17b 1307 }
90f4745c 1308 $discussions = forum_get_user_involved_discussions($forum->id, $user->id);
65bcf17b 1309
1310 foreach ($posts as $post) {
5e7f2b0b 1311 if (!isset($discussions[$post->discussion])) {
90f4745c 1312 continue;
1313 }
7a8d8f22 1314 $discussion = $discussions[$post->discussion];
5e7f2b0b 1315
63e87951 1316 forum_print_post($post, $discussion, $forum, $cm, $course, false, false, false);
5e7f2b0b 1317 }
caadf009 1318 } else {
41905731 1319 echo "<p>".get_string("noposts", "forum")."</p>";
caadf009 1320 }
caadf009 1321}
1322
8538c562
DM
1323/**
1324 * Filters the forum discussions according to groups membership and config.
1325 *
1326 * @since Moodle 2.8, 2.7.1, 2.6.4
1327 * @param array $discussions Discussions with new posts array
1328 * @return array Forums with the number of new posts
1329 */
1330function forum_filter_user_groups_discussions($discussions) {
c38965fb 1331
8538c562
DM
1332 // Group the remaining discussions posts by their forumid.
1333 $filteredforums = array();
c38965fb 1334
8538c562
DM
1335 // Discard not visible groups.
1336 foreach ($discussions as $discussion) {
c38965fb 1337
8538c562
DM
1338 // Course data is already cached.
1339 $instances = get_fast_modinfo($discussion->course)->get_instances();
1340 $forum = $instances['forum'][$discussion->forum];
5e7f2b0b 1341
8538c562
DM
1342 // Continue if the user should not see this discussion.
1343 if (!forum_is_user_group_discussion($forum, $discussion->groupid)) {
1344 continue;
1345 }
1346
1347 // Grouping results by forum.
1348 if (empty($filteredforums[$forum->instance])) {
1349 $filteredforums[$forum->instance] = new stdClass();
1350 $filteredforums[$forum->instance]->id = $forum->id;
1351 $filteredforums[$forum->instance]->count = 0;
1352 }
1353 $filteredforums[$forum->instance]->count += $discussion->count;
1354
1355 }
1356
1357 return $filteredforums;
1358}
1359
1360/**
1361 * Returns whether the discussion group is visible by the current user or not.
1362 *
1363 * @since Moodle 2.8, 2.7.1, 2.6.4
1364 * @param cm_info $cm The discussion course module
1365 * @param int $discussiongroupid The discussion groupid
1366 * @return bool
1367 */
1368function forum_is_user_group_discussion(cm_info $cm, $discussiongroupid) {
1369
1370 if ($discussiongroupid == -1 || $cm->effectivegroupmode != SEPARATEGROUPS) {
1371 return true;
1372 }
1373
1374 if (isguestuser()) {
1375 return false;
1376 }
1377
1378 if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id)) ||
1379 in_array($discussiongroupid, $cm->get_modinfo()->get_groups($cm->groupingid))) {
1380 return true;
1381 }
1382
1383 return false;
1384}
5e7f2b0b 1385
0a4ac01b 1386/**
df1ba0f4 1387 * @global object
1388 * @global object
1389 * @global object
1390 * @param array $courses
1391 * @param array $htmlarray
0a4ac01b 1392 */
185cfb09 1393function forum_print_overview($courses,&$htmlarray) {
261c6ef0 1394 global $USER, $CFG, $DB, $SESSION;
493f0820 1395
185cfb09 1396 if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1397 return array();
1398 }
f8716988 1399
185cfb09 1400 if (!$forums = get_all_instances_in_courses('forum',$courses)) {
f8716988 1401 return;
1402 }
185cfb09 1403
ba4ee840
DM
1404 // Courses to search for new posts
1405 $coursessqls = array();
4e445355 1406 $params = array();
185cfb09 1407 foreach ($courses as $course) {
ba4ee840
DM
1408
1409 // If the user has never entered into the course all posts are pending
1410 if ($course->lastaccess == 0) {
8538c562 1411 $coursessqls[] = '(d.course = ?)';
ba4ee840
DM
1412 $params[] = $course->id;
1413
1414 // Only posts created after the course last access
1415 } else {
8538c562 1416 $coursessqls[] = '(d.course = ? AND p.created > ?)';
ba4ee840
DM
1417 $params[] = $course->id;
1418 $params[] = $course->lastaccess;
1419 }
185cfb09 1420 }
4e445355 1421 $params[] = $USER->id;
ba4ee840
DM
1422 $coursessql = implode(' OR ', $coursessqls);
1423
8538c562
DM
1424 $sql = "SELECT d.id, d.forum, d.course, d.groupid, COUNT(*) as count "
1425 .'FROM {forum_discussions} d '
ba4ee840
DM
1426 .'JOIN {forum_posts} p ON p.discussion = d.id '
1427 ."WHERE ($coursessql) "
1428 .'AND p.userid != ? '
6667ebb9 1429 .'AND (d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?)) '
81ba2632
JH
1430 .'GROUP BY d.id, d.forum, d.course, d.groupid '
1431 .'ORDER BY d.course, d.forum';
6667ebb9
AN
1432 $params[] = time();
1433 $params[] = time();
2b63df96 1434
8538c562
DM
1435 // Avoid warnings.
1436 if (!$discussions = $DB->get_records_sql($sql, $params)) {
1437 $discussions = array();
185cfb09 1438 }
2b63df96 1439
8538c562
DM
1440 $forumsnewposts = forum_filter_user_groups_discussions($discussions);
1441
185cfb09 1442 // also get all forum tracking stuff ONCE.
1443 $trackingforums = array();
1444 foreach ($forums as $forum) {
1445 if (forum_tp_can_track_forums($forum)) {
1446 $trackingforums[$forum->id] = $forum;
1447 }
1448 }
2b63df96 1449
185cfb09 1450 if (count($trackingforums) > 0) {
1451 $cutoffdate = isset($CFG->forum_oldpostdays) ? (time() - ($CFG->forum_oldpostdays*24*60*60)) : 0;
1452 $sql = 'SELECT d.forum,d.course,COUNT(p.id) AS count '.
4e445355 1453 ' FROM {forum_posts} p '.
1454 ' JOIN {forum_discussions} d ON p.discussion = d.id '.
1455 ' LEFT JOIN {forum_read} r ON r.postid = p.id AND r.userid = ? WHERE (';
1456 $params = array($USER->id);
1457
d3553951 1458 foreach ($trackingforums as $track) {
4e445355 1459 $sql .= '(d.forum = ? AND (d.groupid = -1 OR d.groupid = 0 OR d.groupid = ?)) OR ';
1460 $params[] = $track->id;
261c6ef0 1461 if (isset($SESSION->currentgroup[$track->course])) {
1462 $groupid = $SESSION->currentgroup[$track->course];
1463 } else {
0209f964
PS
1464 // get first groupid
1465 $groupids = groups_get_all_groups($track->course, $USER->id);
1466 if ($groupids) {
1467 reset($groupids);
1468 $groupid = key($groupids);
261c6ef0 1469 $SESSION->currentgroup[$track->course] = $groupid;
1470 } else {
1471 $groupid = 0;
1472 }
0209f964 1473 unset($groupids);
261c6ef0 1474 }
1475 $params[] = $groupid;
185cfb09 1476 }
1477 $sql = substr($sql,0,-3); // take off the last OR
6667ebb9
AN
1478 $sql .= ') AND p.modified >= ? AND r.id is NULL ';
1479 $sql .= 'AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)) ';
1480 $sql .= 'GROUP BY d.forum,d.course';
4e445355 1481 $params[] = $cutoffdate;
6667ebb9
AN
1482 $params[] = time();
1483 $params[] = time();
185cfb09 1484
4e445355 1485 if (!$unread = $DB->get_records_sql($sql, $params)) {
185cfb09 1486 $unread = array();
1487 }
1488 } else {
1489 $unread = array();
95d71ad3 1490 }
185cfb09 1491
8538c562 1492 if (empty($unread) and empty($forumsnewposts)) {
9cba7a8c 1493 return;
1494 }
1495
1496 $strforum = get_string('modulename','forum');
9cba7a8c 1497
f8716988 1498 foreach ($forums as $forum) {
185cfb09 1499 $str = '';
f8716988 1500 $count = 0;
185cfb09 1501 $thisunread = 0;
f8716988 1502 $showunread = false;
1503 // either we have something from logs, or trackposts, or nothing.
8538c562
DM
1504 if (array_key_exists($forum->id, $forumsnewposts) && !empty($forumsnewposts[$forum->id])) {
1505 $count = $forumsnewposts[$forum->id]->count;
90558ec4 1506 }
185cfb09 1507 if (array_key_exists($forum->id,$unread)) {
1508 $thisunread = $unread[$forum->id]->count;
f8716988 1509 $showunread = true;
0d6b9d4f 1510 }
185cfb09 1511 if ($count > 0 || $thisunread > 0) {
e23800b7 1512 $str .= '<div class="overview forum"><div class="name">'.$strforum.': <a title="'.$strforum.'" href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
1513 $forum->name.'</a></div>';
6d641063 1514 $str .= '<div class="info"><span class="postsincelogin">';
54294601 1515 $str .= get_string('overviewnumpostssince', 'forum', $count)."</span>";
f8716988 1516 if (!empty($showunread)) {
54294601 1517 $str .= '<div class="unreadposts">'.get_string('overviewnumunread', 'forum', $thisunread).'</div>';
f8716988 1518 }
e23800b7 1519 $str .= '</div></div>';
f8716988 1520 }
2b63df96 1521 if (!empty($str)) {
185cfb09 1522 if (!array_key_exists($forum->course,$htmlarray)) {
1523 $htmlarray[$forum->course] = array();
1524 }
1525 if (!array_key_exists('forum',$htmlarray[$forum->course])) {
1526 $htmlarray[$forum->course]['forum'] = ''; // initialize, avoid warnings
1527 }
1528 $htmlarray[$forum->course]['forum'] .= $str;
1529 }
2b63df96 1530 }
0d6b9d4f 1531}
1532
0a4ac01b 1533/**
1534 * Given a course and a date, prints a summary of all the new
1535 * messages posted in the course since that date
df1ba0f4 1536 *
1537 * @global object
1538 * @global object
1539 * @global object
1540 * @uses CONTEXT_MODULE
1541 * @uses VISIBLEGROUPS
90f4745c 1542 * @param object $course
1543 * @param bool $viewfullnames capability
1544 * @param int $timestart
1545 * @return bool success
0a4ac01b 1546 */
dd97c328 1547function forum_print_recent_activity($course, $viewfullnames, $timestart) {
cb860491 1548 global $CFG, $USER, $DB, $OUTPUT;
caadf009 1549
dd97c328 1550 // do not use log table if possible, it may be huge and is expensive to join with other tables
caadf009 1551
dda60f88 1552 $allnamefields = user_picture::fields('u', null, 'duserid');
4e445355 1553 if (!$posts = $DB->get_records_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid,
dda60f88 1554 d.timestart, d.timeend, $allnamefields
4e445355 1555 FROM {forum_posts} p
1556 JOIN {forum_discussions} d ON d.id = p.discussion
1557 JOIN {forum} f ON f.id = d.forum
1558 JOIN {user} u ON u.id = p.userid
1559 WHERE p.created > ? AND f.course = ?
1560 ORDER BY p.id ASC", array($timestart, $course->id))) { // order by initial posting date
dd97c328 1561 return false;
1b5910c4 1562 }
1563
f20edd52 1564 $modinfo = get_fast_modinfo($course);
dcde9f02 1565
dd97c328 1566 $groupmodes = array();
1567 $cms = array();
d05956ac 1568
dd97c328 1569 $strftimerecent = get_string('strftimerecent');
d05956ac 1570
dd97c328 1571 $printposts = array();
1572 foreach ($posts as $post) {
1573 if (!isset($modinfo->instances['forum'][$post->forum])) {
1574 // not visible
1575 continue;
1576 }
1577 $cm = $modinfo->instances['forum'][$post->forum];
1578 if (!$cm->uservisible) {
1579 continue;
1580 }
bf0f06b1 1581 $context = context_module::instance($cm->id);
6b7de0bb 1582
1583 if (!has_capability('mod/forum:viewdiscussion', $context)) {
1584 continue;
1585 }
583b57b4 1586
dd97c328 1587 if (!empty($CFG->forum_enabletimedposts) and $USER->id != $post->duserid
1588 and (($post->timestart > 0 and $post->timestart > time()) or ($post->timeend > 0 and $post->timeend < time()))) {
6b7de0bb 1589 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
dd97c328 1590 continue;
ac1d9a22 1591 }
dd97c328 1592 }
583b57b4 1593
8538c562
DM
1594 // Check that the user can see the discussion.
1595 if (forum_is_user_group_discussion($cm, $post->groupid)) {
1596 $printposts[] = $post;
dd97c328 1597 }
8f7dc7f1 1598
dd97c328 1599 }
1600 unset($posts);
8f7dc7f1 1601
dd97c328 1602 if (!$printposts) {
1603 return false;
1604 }
1605
cb860491 1606 echo $OUTPUT->heading(get_string('newforumposts', 'forum').':', 3);
af0fc6a2 1607 $list = html_writer::start_tag('ul', ['class' => 'unlist']);
dd97c328 1608
1609 foreach ($printposts as $post) {
1610 $subjectclass = empty($post->parent) ? ' bold' : '';
af0fc6a2 1611 $authorhidden = forum_is_author_hidden($post, (object) ['type' => $post->forumtype]);
dd97c328 1612
af0fc6a2
JP
1613 $list .= html_writer::start_tag('li');
1614 $list .= html_writer::start_div('head');
1615 $list .= html_writer::div(userdate($post->modified, $strftimerecent), 'date');
1616 if (!$authorhidden) {
1617 $list .= html_writer::div(fullname($post, $viewfullnames), 'name');
1618 }
1619 $list .= html_writer::end_div(); // Head.
1620
1621 $list .= html_writer::start_div('info' . $subjectclass);
1622 $discussionurl = new moodle_url('/mod/forum/discuss.php', ['d' => $post->discussion]);
1623 if (!empty($post->parent)) {
1624 $discussionurl->param('parent', $post->parent);
1625 $discussionurl->set_anchor('p'. $post->id);
caadf009 1626 }
dd97c328 1627 $post->subject = break_up_long_words(format_string($post->subject, true));
af0fc6a2
JP
1628 $list .= html_writer::link($discussionurl, $post->subject);
1629 $list .= html_writer::end_div(); // Info.
1630 $list .= html_writer::end_tag('li');
caadf009 1631 }
dd97c328 1632
af0fc6a2
JP
1633 $list .= html_writer::end_tag('ul');
1634 echo $list;
dd97c328 1635
1636 return true;
caadf009 1637}
1638
353228d8 1639/**
1640 * Return grade for given user or all users.
1641 *
df1ba0f4 1642 * @global object
1643 * @global object
1644 * @param object $forum
353228d8 1645 * @param int $userid optional user id, 0 means all users
1646 * @return array array of grades, false if none
1647 */
2b04c41c 1648function forum_get_user_grades($forum, $userid = 0) {
63e87951 1649 global $CFG;
df997f84 1650
63e87951 1651 require_once($CFG->dirroot.'/rating/lib.php');
df997f84 1652
2b04c41c
SH
1653 $ratingoptions = new stdClass;
1654 $ratingoptions->component = 'mod_forum';
1655 $ratingoptions->ratingarea = 'post';
353228d8 1656
63e87951
AD
1657 //need these to work backwards to get a context id. Is there a better way to get contextid from a module instance?
1658 $ratingoptions->modulename = 'forum';
1659 $ratingoptions->moduleid = $forum->id;
63e87951
AD
1660 $ratingoptions->userid = $userid;
1661 $ratingoptions->aggregationmethod = $forum->assessed;
1662 $ratingoptions->scaleid = $forum->scale;
1663 $ratingoptions->itemtable = 'forum_posts';
1664 $ratingoptions->itemtableusercolumn = 'userid';
353228d8 1665
2b04c41c 1666 $rm = new rating_manager();
63e87951 1667 return $rm->get_user_grades($ratingoptions);
353228d8 1668}
caadf009 1669
0a4ac01b 1670/**
775f811a 1671 * Update activity grades
353228d8 1672 *
a153c9f2 1673 * @category grade
775f811a 1674 * @param object $forum
1675 * @param int $userid specific user only, 0 means all
6b7de0bb 1676 * @param boolean $nullifnone return null if grade does not exist
90f4745c 1677 * @return void
0a4ac01b 1678 */
775f811a 1679function forum_update_grades($forum, $userid=0, $nullifnone=true) {
4e445355 1680 global $CFG, $DB;
775f811a 1681 require_once($CFG->libdir.'/gradelib.php');
caadf009 1682
775f811a 1683 if (!$forum->assessed) {
1684 forum_grade_item_update($forum);
02ebf404 1685
775f811a 1686 } else if ($grades = forum_get_user_grades($forum, $userid)) {
1687 forum_grade_item_update($forum, $grades);
eafb9d9e 1688
775f811a 1689 } else if ($userid and $nullifnone) {
39790bd8 1690 $grade = new stdClass();
775f811a 1691 $grade->userid = $userid;
1692 $grade->rawgrade = NULL;
1693 forum_grade_item_update($forum, $grade);
02ebf404 1694
353228d8 1695 } else {
775f811a 1696 forum_grade_item_update($forum);
1697 }
1698}
1699
353228d8 1700/**
612607bd 1701 * Create/update grade item for given forum
353228d8 1702 *
a153c9f2 1703 * @category grade
df1ba0f4 1704 * @uses GRADE_TYPE_NONE
1705 * @uses GRADE_TYPE_VALUE
1706 * @uses GRADE_TYPE_SCALE
a153c9f2
AD
1707 * @param stdClass $forum Forum object with extra cmidnumber
1708 * @param mixed $grades Optional array/object of grade(s); 'reset' means reset grades in gradebook
612607bd 1709 * @return int 0 if ok
353228d8 1710 */
0b5a80a1 1711function forum_grade_item_update($forum, $grades=NULL) {
612607bd 1712 global $CFG;
1713 if (!function_exists('grade_update')) { //workaround for buggy PHP versions
1714 require_once($CFG->libdir.'/gradelib.php');
353228d8 1715 }
1716
612607bd 1717 $params = array('itemname'=>$forum->name, 'idnumber'=>$forum->cmidnumber);
353228d8 1718
5980d52f 1719 if (!$forum->assessed or $forum->scale == 0) {
612607bd 1720 $params['gradetype'] = GRADE_TYPE_NONE;
353228d8 1721
1722 } else if ($forum->scale > 0) {
1723 $params['gradetype'] = GRADE_TYPE_VALUE;
1724 $params['grademax'] = $forum->scale;
1725 $params['grademin'] = 0;
1726
1727 } else if ($forum->scale < 0) {
1728 $params['gradetype'] = GRADE_TYPE_SCALE;
1729 $params['scaleid'] = -$forum->scale;
1730 }
1731
0b5a80a1 1732 if ($grades === 'reset') {
1733 $params['reset'] = true;
1734 $grades = NULL;
1735 }
1736
1737 return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, $grades, $params);
353228d8 1738}
1739
1740/**
1741 * Delete grade item for given forum
1742 *
a153c9f2
AD
1743 * @category grade
1744 * @param stdClass $forum Forum object
1745 * @return grade_item
353228d8 1746 */
1747function forum_grade_item_delete($forum) {
612607bd 1748 global $CFG;
1749 require_once($CFG->libdir.'/gradelib.php');
1750
b67ec72f 1751 return grade_update('mod/forum', $forum->course, 'mod', 'forum', $forum->id, 0, NULL, array('deleted'=>1));
caadf009 1752}
1753
353228d8 1754
0a4ac01b 1755/**
90f4745c 1756 * This function returns if a scale is being used by one forum
df1ba0f4 1757 *
1758 * @global object
90f4745c 1759 * @param int $forumid
1760 * @param int $scaleid negative number
1761 * @return bool
0a4ac01b 1762 */
0f1a97c2 1763function forum_scale_used ($forumid,$scaleid) {
4e445355 1764 global $DB;
0f1a97c2 1765 $return = false;
65b0e537 1766
4e445355 1767 $rec = $DB->get_record("forum",array("id" => "$forumid","scale" => "-$scaleid"));
65b0e537 1768
fa22fd5f 1769 if (!empty($rec) && !empty($scaleid)) {
0f1a97c2 1770 $return = true;
1771 }
65b0e537 1772
0f1a97c2 1773 return $return;
1774}
1775
85c9ebb9 1776/**
1777 * Checks if scale is being used by any instance of forum
1778 *
1779 * This is used to find out if scale used anywhere
df1ba0f4 1780 *
1781 * @global object
85c9ebb9 1782 * @param $scaleid int
1783 * @return boolean True if the scale is used by any forum
1784 */
1785function forum_scale_used_anywhere($scaleid) {
4e445355 1786 global $DB;
1787 if ($scaleid and $DB->record_exists('forum', array('scale' => -$scaleid))) {
85c9ebb9 1788 return true;
1789 } else {
1790 return false;
1791 }
1792}
1793
0a4ac01b 1794// SQL FUNCTIONS ///////////////////////////////////////////////////////////
9fa49e22 1795
0a4ac01b 1796/**
1797 * Gets a post with all info ready for forum_print_post
1798 * Most of these joins are just to get the forum id
df1ba0f4 1799 *
1800 * @global object
1801 * @global object
90f4745c 1802 * @param int $postid
1803 * @return mixed array of posts or false
0a4ac01b 1804 */
1f48942e 1805function forum_get_post_full($postid) {
4e445355 1806 global $CFG, $DB;
1f48942e 1807
a327f25e
AG
1808 $allnames = get_all_user_name_fields(true, 'u');
1809 return $DB->get_record_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
4e445355 1810 FROM {forum_posts} p
1811 JOIN {forum_discussions} d ON p.discussion = d.id
1812 LEFT JOIN {user} u ON p.userid = u.id
1813 WHERE p.id = ?", array($postid));
1f48942e 1814}
1815
65bcf17b 1816/**
1817 * Gets all posts in discussion including top parent.
df1ba0f4 1818 *
1819 * @global object
1820 * @global object
1821 * @global object
90f4745c 1822 * @param int $discussionid
1823 * @param string $sort
1824 * @param bool $tracking does user track the forum?
1825 * @return array of posts
65bcf17b 1826 */
90f4745c 1827function forum_get_all_discussion_posts($discussionid, $sort, $tracking=false) {
4e445355 1828 global $CFG, $DB, $USER;
65bcf17b 1829
3c2bf848 1830 $tr_sel = "";
1831 $tr_join = "";
4e445355 1832 $params = array();
3c2bf848 1833
90f4745c 1834 if ($tracking) {
90f4745c 1835 $tr_sel = ", fr.id AS postread";
4e445355 1836 $tr_join = "LEFT JOIN {forum_read} fr ON (fr.postid = p.id AND fr.userid = ?)";
1837 $params[] = $USER->id;
90f4745c 1838 }
1839
a327f25e 1840 $allnames = get_all_user_name_fields(true, 'u');
4e445355 1841 $params[] = $discussionid;
a327f25e 1842 if (!$posts = $DB->get_records_sql("SELECT p.*, $allnames, u.email, u.picture, u.imagealt $tr_sel
4e445355 1843 FROM {forum_posts} p
1844 LEFT JOIN {user} u ON p.userid = u.id
90f4745c 1845 $tr_join
4e445355 1846 WHERE p.discussion = ?
1847 ORDER BY $sort", $params)) {
65bcf17b 1848 return array();
1849 }
1850
1851 foreach ($posts as $pid=>$p) {
90f4745c 1852 if ($tracking) {
1853 if (forum_tp_is_post_old($p)) {
6b7de0bb 1854 $posts[$pid]->postread = true;
90f4745c 1855 }
1856 }
65bcf17b 1857 if (!$p->parent) {
1858 continue;
1859 }
1860 if (!isset($posts[$p->parent])) {
1861 continue; // parent does not exist??
1862 }
1863 if (!isset($posts[$p->parent]->children)) {
1864 $posts[$p->parent]->children = array();
1865 }
1866 $posts[$p->parent]->children[$pid] =& $posts[$pid];
1867 }
1868
bfa7bece
AN
1869 // Start with the last child of the first post.
1870 $post = &$posts[reset($posts)->id];
1871
1872 $lastpost = false;
1873 while (!$lastpost) {
1874 if (!isset($post->children)) {
1875 $post->lastpost = true;
1876 $lastpost = true;
1877 } else {
1878 // Go to the last child of this post.
1879 $post = &$posts[end($post->children)->id];
1880 }
1881 }
1882
65bcf17b 1883 return $posts;
1884}
1885
42fb3c85 1886/**
1887 * An array of forum objects that the user is allowed to read/search through.
df1ba0f4 1888 *
1889 * @global object
1890 * @global object
1891 * @global object
1892 * @param int $userid
1893 * @param int $courseid if 0, we look for forums throughout the whole site.
42fb3c85 1894 * @return array of forum objects, or false if no matches
1895 * Forum objects have the following attributes:
1896 * id, type, course, cmid, cmvisible, cmgroupmode, accessallgroups,
1897 * viewhiddentimedposts
1898 */
1899function forum_get_readable_forums($userid, $courseid=0) {
2b63df96 1900
4e445355 1901 global $CFG, $DB, $USER;
6b7de0bb 1902 require_once($CFG->dirroot.'/course/lib.php');
2b63df96 1903
4e445355 1904 if (!$forummod = $DB->get_record('modules', array('name' => 'forum'))) {
12e57b92 1905 print_error('notinstalled', 'forum');
42fb3c85 1906 }
2b63df96 1907
42fb3c85 1908 if ($courseid) {
4e445355 1909 $courses = $DB->get_records('course', array('id' => $courseid));
42fb3c85 1910 } else {
65bcf17b 1911 // If no course is specified, then the user can see SITE + his courses.
4e445355 1912 $courses1 = $DB->get_records('course', array('id' => SITEID));
b1d5d015 1913 $courses2 = enrol_get_users_courses($userid, true, array('modinfo'));
6155150c 1914 $courses = array_merge($courses1, $courses2);
42fb3c85 1915 }
1916 if (!$courses) {
6b7de0bb 1917 return array();
42fb3c85 1918 }
1919
1920 $readableforums = array();
2b63df96 1921
6527b5c2 1922 foreach ($courses as $course) {
1923
f20edd52 1924 $modinfo = get_fast_modinfo($course);
2b63df96 1925
6b7de0bb 1926 if (empty($modinfo->instances['forum'])) {
1927 // hmm, no forums?
1928 continue;
1929 }
2b63df96 1930
4e445355 1931 $courseforums = $DB->get_records('forum', array('course' => $course->id));
2b63df96 1932
6b7de0bb 1933 foreach ($modinfo->instances['forum'] as $forumid => $cm) {
1934 if (!$cm->uservisible or !isset($courseforums[$forumid])) {
1935 continue;
1936 }
bf0f06b1 1937 $context = context_module::instance($cm->id);
6b7de0bb 1938 $forum = $courseforums[$forumid];
2e945910
AB
1939 $forum->context = $context;
1940 $forum->cm = $cm;
d50704bf 1941
6b7de0bb 1942 if (!has_capability('mod/forum:viewdiscussion', $context)) {
1943 continue;
1944 }
6527b5c2 1945
6b7de0bb 1946 /// group access
1947 if (groups_get_activity_groupmode($cm, $course) == SEPARATEGROUPS and !has_capability('moodle/site:accessallgroups', $context)) {
2c1bbbc5
MG
1948
1949 $forum->onlygroups = $modinfo->get_groups($cm->groupingid);
1950 $forum->onlygroups[] = -1;
6b7de0bb 1951 }
2b63df96 1952
6b7de0bb 1953 /// hidden timed discussions
1954 $forum->viewhiddentimedposts = true;
1955 if (!empty($CFG->forum_enabletimedposts)) {
1956 if (!has_capability('mod/forum:viewhiddentimedposts', $context)) {
1957 $forum->viewhiddentimedposts = false;
1958 }
1959 }
d50704bf 1960
6b7de0bb 1961 /// qanda access
1962 if ($forum->type == 'qanda'
1963 && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
2b63df96 1964
6b7de0bb 1965 // We need to check whether the user has posted in the qanda forum.
1966 $forum->onlydiscussions = array(); // Holds discussion ids for the discussions
1967 // the user is allowed to see in this forum.
1968 if ($discussionspostedin = forum_discussions_user_has_posted_in($forum->id, $USER->id)) {
1969 foreach ($discussionspostedin as $d) {
1970 $forum->onlydiscussions[] = $d->id;
d50704bf 1971 }
42fb3c85 1972 }
1973 }
6b7de0bb 1974
1975 $readableforums[$forum->id] = $forum;
42fb3c85 1976 }
6b7de0bb 1977
1978 unset($modinfo);
1979
42fb3c85 1980 } // End foreach $courses
2b63df96 1981
42fb3c85 1982 return $readableforums;
1983}
1984
bbbf2d40 1985/**
1986 * Returns a list of posts found using an array of search terms.
df1ba0f4 1987 *
1988 * @global object
1989 * @global object
1990 * @global object
1991 * @param array $searchterms array of search terms, e.g. word +word -word
1992 * @param int $courseid if 0, we search through the whole site
1993 * @param int $limitfrom
1994 * @param int $limitnum
1995 * @param int &$totalcount
1996 * @param string $extrasql
1997 * @return array|bool Array of posts found or false
42fb3c85 1998 */
2b63df96 1999function forum_search_posts($searchterms, $courseid=0, $limitfrom=0, $limitnum=50,
42fb3c85 2000 &$totalcount, $extrasql='') {
4e445355 2001 global $CFG, $DB, $USER;
42fb3c85 2002 require_once($CFG->libdir.'/searchlib.php');
2003
2004 $forums = forum_get_readable_forums($USER->id, $courseid);
2b63df96 2005
67875aa1 2006 if (count($forums) == 0) {
6b7de0bb 2007 $totalcount = 0;
67875aa1 2008 return false;
2009 }
42fb3c85 2010
6b7de0bb 2011 $now = round(time(), -2); // db friendly
2012
2013 $fullaccess = array();
2014 $where = array();
4e445355 2015 $params = array();
6b7de0bb 2016
2017 foreach ($forums as $forumid => $forum) {
2018 $select = array();
2019
2020 if (!$forum->viewhiddentimedposts) {
b1d5d015
PS
2021 $select[] = "(d.userid = :userid{$forumid} OR (d.timestart < :timestart{$forumid} AND (d.timeend = 0 OR d.timeend > :timeend{$forumid})))";
2022 $params = array_merge($params, array('userid'.$forumid=>$USER->id, 'timestart'.$forumid=>$now, 'timeend'.$forumid=>$now));
42fb3c85 2023 }
6b7de0bb 2024
2e945910
AB
2025 $cm = $forum->cm;
2026 $context = $forum->context;
ad9c22aa 2027
2028 if ($forum->type == 'qanda'
2029 && !has_capability('mod/forum:viewqandawithoutposting', $context)) {
6b7de0bb 2030 if (!empty($forum->onlydiscussions)) {
cf717dc2 2031 list($discussionid_sql, $discussionid_params) = $DB->get_in_or_equal($forum->onlydiscussions, SQL_PARAMS_NAMED, 'qanda'.$forumid.'_');
4e445355 2032 $params = array_merge($params, $discussionid_params);
2033 $select[] = "(d.id $discussionid_sql OR p.parent = 0)";
d50704bf 2034 } else {
6b7de0bb 2035 $select[] = "p.parent = 0";
d50704bf 2036 }
2037 }
6b7de0bb 2038
2039 if (!empty($forum->onlygroups)) {
cf717dc2 2040 list($groupid_sql, $groupid_params) = $DB->get_in_or_equal($forum->onlygroups, SQL_PARAMS_NAMED, 'grps'.$forumid.'_');
4e445355 2041 $params = array_merge($params, $groupid_params);
2042 $select[] = "d.groupid $groupid_sql";
42fb3c85 2043 }
6b7de0bb 2044
2045 if ($select) {
2046 $selects = implode(" AND ", $select);
b1d5d015
PS
2047 $where[] = "(d.forum = :forum{$forumid} AND $selects)";
2048 $params['forum'.$forumid] = $forumid;
6b7de0bb 2049 } else {
2050 $fullaccess[] = $forumid;
2051 }
2052 }
2053
2054 if ($fullaccess) {
cf717dc2 2055 list($fullid_sql, $fullid_params) = $DB->get_in_or_equal($fullaccess, SQL_PARAMS_NAMED, 'fula');
4e445355 2056 $params = array_merge($params, $fullid_params);
2057 $where[] = "(d.forum $fullid_sql)";
42fb3c85 2058 }
42fb3c85 2059
6b7de0bb 2060 $selectdiscussion = "(".implode(" OR ", $where).")";
42fb3c85 2061
42fb3c85 2062 $messagesearch = '';
2063 $searchstring = '';
2b63df96 2064
42fb3c85 2065 // Need to concat these back together for parser to work.
2066 foreach($searchterms as $searchterm){
2067 if ($searchstring != '') {
2068 $searchstring .= ' ';
2069 }
2070 $searchstring .= $searchterm;
2071 }
2072
2073 // We need to allow quoted strings for the search. The quotes *should* be stripped
2074 // by the parser, but this should be examined carefully for security implications.
2075 $searchstring = str_replace("\\\"","\"",$searchstring);
2076 $parser = new search_parser();
2077 $lexer = new search_lexer($parser);
2078
2079 if ($lexer->parse($searchstring)) {
2080 $parsearray = $parser->get_parsed_array();
2f194173
AN
2081 list($messagesearch, $msparams) = search_generate_SQL($parsearray, 'p.message', 'p.subject',
2082 'p.userid', 'u.id', 'u.firstname',
2083 'u.lastname', 'p.modified', 'd.forum');
004efe66 2084 $params = array_merge($params, $msparams);
42fb3c85 2085 }
2086
4e445355 2087 $fromsql = "{forum_posts} p,
2088 {forum_discussions} d,
2089 {user} u";
42fb3c85 2090
2091 $selectsql = " $messagesearch
2092 AND p.discussion = d.id
2093 AND p.userid = u.id
2094 AND $selectdiscussion
2095 $extrasql";
2096
2097 $countsql = "SELECT COUNT(*)
2098 FROM $fromsql
2099 WHERE $selectsql";
2100
a327f25e 2101 $allnames = get_all_user_name_fields(true, 'u');
7f094149 2102 $searchsql = "SELECT p.*,
42fb3c85 2103 d.forum,
a327f25e 2104 $allnames,
42fb3c85 2105 u.email,
8ba59d07 2106 u.picture,
ce7382c9 2107 u.imagealt
42fb3c85 2108 FROM $fromsql
2109 WHERE $selectsql
2110 ORDER BY p.modified DESC";
2111
4e445355 2112 $totalcount = $DB->count_records_sql($countsql, $params);
d50704bf 2113
4e445355 2114 return $DB->get_records_sql($searchsql, $params, $limitfrom, $limitnum);
42fb3c85 2115}
2116
0a4ac01b 2117/**
2118 * Returns a list of all new posts that have not been mailed yet
df1ba0f4 2119 *
df1ba0f4 2120 * @param int $starttime posts created after this time
2121 * @param int $endtime posts created before this
2122 * @param int $now used for timed discussions only
2123 * @return array
0a4ac01b 2124 */
90f4745c 2125function forum_get_unmailed_posts($starttime, $endtime, $now=null) {
4e445355 2126 global $CFG, $DB;
90f4745c 2127
8076010d
MN
2128 $params = array();
2129 $params['mailed'] = FORUM_MAILED_PENDING;
2130 $params['ptimestart'] = $starttime;
2131 $params['ptimeend'] = $endtime;
2132 $params['mailnow'] = 1;
2133
90f4745c 2134 if (!empty($CFG->forum_enabletimedposts)) {
2135 if (empty($now)) {
2136 $now = time();
2137 }
86a77c91
JM
2138 $selectsql = "AND (p.created >= :ptimestart OR d.timestart >= :pptimestart)";
2139 $params['pptimestart'] = $starttime;
8076010d
MN
2140 $timedsql = "AND (d.timestart < :dtimestart AND (d.timeend = 0 OR d.timeend > :dtimeend))";
2141 $params['dtimestart'] = $now;
2142 $params['dtimeend'] = $now;
90f4745c 2143 } else {
2144 $timedsql = "";
86a77c91 2145 $selectsql = "AND p.created >= :ptimestart";
90f4745c 2146 }
2147
4e445355 2148 return $DB->get_records_sql("SELECT p.*, d.course, d.forum
8076010d
MN
2149 FROM {forum_posts} p
2150 JOIN {forum_discussions} d ON d.id = p.discussion
2151 WHERE p.mailed = :mailed
86a77c91 2152 $selectsql
8076010d
MN
2153 AND (p.created < :ptimeend OR p.mailnow = :mailnow)
2154 $timedsql
2155 ORDER BY p.modified ASC", $params);
1f48942e 2156}
2157
0a4ac01b 2158/**
2159 * Marks posts before a certain time as being mailed already
df1ba0f4 2160 *
2161 * @global object
2162 * @global object
2163 * @param int $endtime
2164 * @param int $now Defaults to time()
2165 * @return bool
0a4ac01b 2166 */
90f4745c 2167function forum_mark_old_posts_as_mailed($endtime, $now=null) {
4e445355 2168 global $CFG, $DB;
8076010d 2169
90f4745c 2170 if (empty($now)) {
2171 $now = time();
2172 }
2173
8076010d
MN
2174 $params = array();
2175 $params['mailedsuccess'] = FORUM_MAILED_SUCCESS;
2176 $params['now'] = $now;
2177 $params['endtime'] = $endtime;
2178 $params['mailnow'] = 1;
2179 $params['mailedpending'] = FORUM_MAILED_PENDING;
2180
90f4745c 2181 if (empty($CFG->forum_enabletimedposts)) {
4e445355 2182 return $DB->execute("UPDATE {forum_posts}
8076010d
MN
2183 SET mailed = :mailedsuccess
2184 WHERE (created < :endtime OR mailnow = :mailnow)
2185 AND mailed = :mailedpending", $params);
0f620d4b 2186 } else {
4e445355 2187 return $DB->execute("UPDATE {forum_posts}
8076010d 2188 SET mailed = :mailedsuccess
90f4745c 2189 WHERE discussion NOT IN (SELECT d.id
8076010d
MN
2190 FROM {forum_discussions} d
2191 WHERE d.timestart > :now)
2192 AND (created < :endtime OR mailnow = :mailnow)
2193 AND mailed = :mailedpending", $params);
0f620d4b 2194 }
3ecca1ee 2195}
2196
0a4ac01b 2197/**
2198 * Get all the posts for a user in a forum suitable for forum_print_post
df1ba0f4 2199 *
2200 * @global object
2201 * @global object
2202 * @uses CONTEXT_MODULE
2203 * @return array
0a4ac01b 2204 */
1f48942e 2205function forum_get_user_posts($forumid, $userid) {
4e445355 2206 global $CFG, $DB;
1f48942e 2207
90f4745c 2208 $timedsql = "";
4e445355 2209 $params = array($forumid, $userid);
2210
90f4745c 2211 if (!empty($CFG->forum_enabletimedposts)) {
2212 $cm = get_coursemodule_from_instance('forum', $forumid);
bf0f06b1 2213 if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
90f4745c 2214 $now = time();
4e445355 2215 $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2216 $params[] = $now;
2217 $params[] = $now;
6b7de0bb 2218 }
90f4745c 2219 }
2220
a327f25e
AG
2221 $allnames = get_all_user_name_fields(true, 'u');
2222 return $DB->get_records_sql("SELECT p.*, d.forum, $allnames, u.email, u.picture, u.imagealt
4e445355 2223 FROM {forum} f
2224 JOIN {forum_discussions} d ON d.forum = f.id
2225 JOIN {forum_posts} p ON p.discussion = d.id
2226 JOIN {user} u ON u.id = p.userid
2227 WHERE f.id = ?
2228 AND p.userid = ?
90f4745c 2229 $timedsql
4e445355 2230 ORDER BY p.modified ASC", $params);
1f48942e 2231}
2232
90f4745c 2233/**
2234 * Get all the discussions user participated in
df1ba0f4 2235 *
2236 * @global object
2237 * @global object
2238 * @uses CONTEXT_MODULE
90f4745c 2239 * @param int $forumid
2240 * @param int $userid
df1ba0f4 2241 * @return array Array or false
90f4745c 2242 */
2243function forum_get_user_involved_discussions($forumid, $userid) {
4e445355 2244 global $CFG, $DB;
90f4745c 2245
2246 $timedsql = "";
4e445355 2247 $params = array($forumid, $userid);
90f4745c 2248 if (!empty($CFG->forum_enabletimedposts)) {
2249 $cm = get_coursemodule_from_instance('forum', $forumid);
bf0f06b1 2250 if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
90f4745c 2251 $now = time();
4e445355 2252 $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2253 $params[] = $now;
2254 $params[] = $now;
6b7de0bb 2255 }
90f4745c 2256 }
2257
4e445355 2258 return $DB->get_records_sql("SELECT DISTINCT d.*
2259 FROM {forum} f
2260 JOIN {forum_discussions} d ON d.forum = f.id
2261 JOIN {forum_posts} p ON p.discussion = d.id
2262 WHERE f.id = ?
2263 AND p.userid = ?
2264 $timedsql", $params);
90f4745c 2265}
2266
2267/**
2268 * Get all the posts for a user in a forum suitable for forum_print_post
df1ba0f4 2269 *
2270 * @global object
2271 * @global object
90f4745c 2272 * @param int $forumid
2273 * @param int $userid
2274 * @return array of counts or false
2275 */
2276function forum_count_user_posts($forumid, $userid) {
4e445355 2277 global $CFG, $DB;
90f4745c 2278
2279 $timedsql = "";
4e445355 2280 $params = array($forumid, $userid);
90f4745c 2281 if (!empty($CFG->forum_enabletimedposts)) {
2282 $cm = get_coursemodule_from_instance('forum', $forumid);
bf0f06b1 2283 if (!has_capability('mod/forum:viewhiddentimedposts' , context_module::instance($cm->id))) {
90f4745c 2284 $now = time();
4e445355 2285 $timedsql = "AND (d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?))";
2286 $params[] = $now;
2287 $params[] = $now;
6b7de0bb 2288 }
90f4745c 2289 }
2290
4e445355 2291 return $DB->get_record_sql("SELECT COUNT(p.id) AS postcount, MAX(p.modified) AS lastpost
2292 FROM {forum} f
2293 JOIN {forum_discussions} d ON d.forum = f.id
2294 JOIN {forum_posts} p ON p.discussion = d.id
2295 JOIN {user} u ON u.id = p.userid
2296 WHERE f.id = ?
2297 AND p.userid = ?
2298 $timedsql", $params);
90f4745c 2299}
2300
0a4ac01b 2301/**
2302 * Given a log entry, return the forum post details for it.
df1ba0f4 2303 *
2304 * @global object
2305 * @global object
2306 * @param object $log
2307 * @return array|null
0a4ac01b 2308 */
1f48942e 2309function forum_get_post_from_log($log) {
4e445355 2310 global $CFG, $DB;
1f48942e 2311
a327f25e 2312 $allnames = get_all_user_name_fields(true, 'u');
1f48942e 2313 if ($log->action == "add post") {
2314
a327f25e 2315 return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
4e445355 2316 FROM {forum_discussions} d,
2317 {forum_posts} p,
2318 {forum} f,
2319 {user} u
2320 WHERE p.id = ?
65b0e537 2321 AND d.id = p.discussion
2322 AND p.userid = u.id
8f7dc7f1 2323 AND u.deleted <> '1'
4e445355 2324 AND f.id = d.forum", array($log->info));
1f48942e 2325
2326
2327 } else if ($log->action == "add discussion") {
2328
a327f25e 2329 return $DB->get_record_sql("SELECT p.*, f.type AS forumtype, d.forum, d.groupid, $allnames, u.email, u.picture
4e445355 2330 FROM {forum_discussions} d,
2331 {forum_posts} p,
2332 {forum} f,
2333 {user} u
2334 WHERE d.id = ?
65b0e537 2335 AND d.firstpost = p.id
2336 AND p.userid = u.id
8f7dc7f1 2337 AND u.deleted <> '1'
4e445355 2338 AND f.id = d.forum", array($log->info));
1f48942e 2339 }
2340 return NULL;
2341}
2342
0a4ac01b 2343/**
2344 * Given a discussion id, return the first post from the discussion
df1ba0f4 2345 *
2346 * @global object
2347 * @global object
2348 * @param int $dicsussionid
2349 * @return array
0a4ac01b 2350 */
d05956ac 2351function forum_get_firstpost_from_discussion($discussionid) {
4e445355 2352 global $CFG, $DB;
d05956ac 2353
4e445355 2354 return $DB->get_record_sql("SELECT p.*
2355 FROM {forum_discussions} d,
2356 {forum_posts} p
2357 WHERE d.id = ?
2358 AND d.firstpost = p.id ", array($discussionid));
d05956ac 2359}
2360
0a4ac01b 2361/**
90f4745c 2362 * Returns an array of counts of replies to each discussion
df1ba0f4 2363 *
2364 * @global object
2365 * @global object
2366 * @param int $forumid
2367 * @param string $forumsort
2368 * @param int $limit
2369 * @param int $page
2370 * @param int $perpage
2371 * @return array
0a4ac01b 2372 */
90f4745c 2373function forum_count_discussion_replies($forumid, $forumsort="", $limit=-1, $page=-1, $perpage=0) {
4e445355 2374 global $CFG, $DB;
1f48942e 2375
90f4745c 2376 if ($limit > 0) {
2377 $limitfrom = 0;
2378 $limitnum = $limit;
2379 } else if ($page != -1) {
2380 $limitfrom = $page*$perpage;
2381 $limitnum = $perpage;
2382 } else {
2383 $limitfrom = 0;
2384 $limitnum = 0;
2385 }
2386
2387 if ($forumsort == "") {
2388 $orderby = "";
2389 $groupby = "";
2390
2391 } else {
2392 $orderby = "ORDER BY $forumsort";
2393 $groupby = ", ".strtolower($forumsort);
2394 $groupby = str_replace('desc', '', $groupby);
2395 $groupby = str_replace('asc', '', $groupby);
2396 }
2397
bfeb10b7 2398 if (($limitfrom == 0 and $limitnum == 0) or $forumsort == "") {
2399 $sql = "SELECT p.discussion, COUNT(p.id) AS replies, MAX(p.id) AS lastpostid
4e445355 2400 FROM {forum_posts} p
2401 JOIN {forum_discussions} d ON p.discussion = d.id
2402 WHERE p.parent > 0 AND d.forum = ?
bfeb10b7 2403 GROUP BY p.discussion";
4e445355 2404 return $DB->get_records_sql($sql, array($forumid));
bfeb10b7 2405
90f4745c 2406 } else {
bfeb10b7 2407 $sql = "SELECT p.discussion, (COUNT(p.id) - 1) AS replies, MAX(p.id) AS lastpostid
4e445355 2408 FROM {forum_posts} p
2409 JOIN {forum_discussions} d ON p.discussion = d.id
2410 WHERE d.forum = ?
38ec3fb0
AN
2411 GROUP BY p.discussion $groupby $orderby";
2412 return $DB->get_records_sql($sql, array($forumid), $limitfrom, $limitnum);
90f4745c 2413 }
2414}
2415
df1ba0f4 2416/**
2417 * @global object
2418 * @global object
2419 * @global object
2420 * @staticvar array $cache
2421 * @param object $forum
2422 * @param object $cm
2423 * @param object $course
2424 * @return mixed
2425 */
90f4745c 2426function forum_count_discussions($forum, $cm, $course) {
4e445355 2427 global $CFG, $DB, $USER;
90f4745c 2428
2429 static $cache = array();
2430
2431 $now = round(time(), -2); // db cache friendliness
2432
4e445355 2433 $params = array($course->id);
2434
90f4745c 2435 if (!isset($cache[$course->id])) {
2436 if (!empty($CFG->forum_enabletimedposts)) {
4e445355 2437 $timedsql = "AND d.timestart < ? AND (d.timeend = 0 OR d.timeend > ?)";
2438 $params[] = $now;
2439 $params[] = $now;
90f4745c 2440 } else {
2441 $timedsql = "";
2442 }
2443
2444 $sql = "SELECT f.id, COUNT(d.id) as dcount
4e445355 2445 FROM {forum} f
2446 JOIN {forum_discussions} d ON d.forum = f.id
2447 WHERE f.course = ?
90f4745c 2448 $timedsql
2449 GROUP BY f.id";
a48e8c4b 2450
4e445355 2451 if ($counts = $DB->get_records_sql($sql, $params)) {
90f4745c 2452 foreach ($counts as $count) {
2453 $counts[$count->id] = $count->dcount;
2454 }
2455 $cache[$course->id] = $counts;
2456 } else {
2457 $cache[$course->id] = array();
2458 }
a48e8c4b 2459 }
90f4745c 2460
2461 if (empty($cache[$course->id][$forum->id])) {
2462 return 0;
a48e8c4b 2463 }
90f4745c 2464
2465 $groupmode = groups_get_activity_groupmode($cm, $course);
2466
2467 if ($groupmode != SEPARATEGROUPS) {
2468 return $cache[$course->id][$forum->id];
1f48942e 2469 }
90f4745c 2470
bf0f06b1 2471 if (has_capability('moodle/site:accessallgroups', context_module::instance($cm->id))) {
90f4745c 2472 return $cache[$course->id][$forum->id];
2473 }
2474
2475 require_once($CFG->dirroot.'/course/lib.php');
2476
f20edd52 2477 $modinfo = get_fast_modinfo($course);
90f4745c 2478
2c1bbbc5 2479 $mygroups = $modinfo->get_groups($cm->groupingid);
90f4745c 2480
2481 // add all groups posts
2c1bbbc5 2482 $mygroups[-1] = -1;
4e445355 2483
2484 list($mygroups_sql, $params) = $DB->get_in_or_equal($mygroups);
2485 $params[] = $forum->id;
90f4745c 2486
2487 if (!empty($CFG->forum_enabletimedposts)) {
2488 $timedsql = "AND d.timestart < $now AND (d.timeend = 0 OR d.timeend > $now)";
4e445355 2489 $params[] = $now;
2490 $params[] = $now;
90f4745c 2491 } else {
2492 $timedsql = "";
2493 }
2494
2495 $sql = "SELECT COUNT(d.id)
4e445355 2496 FROM {forum_discussions} d
342650a7 2497 WHERE d.groupid $mygroups_sql AND d.forum = ?
90f4745c 2498 $timedsql";
2499
4e445355 2500 return $DB->get_field_sql($sql, $params);
1f48942e 2501}
2502
0a4ac01b 2503/**
2504 * Get all discussions in a forum
df1ba0f4 2505 *
2506 * @global object
2507 * @global object
2508 * @global object
2509 * @uses CONTEXT_MODULE
2510 * @uses VISIBLEGROUPS
2511 * @param object $cm
2512 * @param string $forumsort
2513 * @param bool $fullpost
2514 * @param int $unused
2515 * @param int $limit
2516 * @param bool $userlastmodified
2517 * @param int $page
2518 * @param int $perpage
4f3a2d21
JL
2519 * @param int $groupid if groups enabled, get discussions for this group overriding the current group.
2520 * Use FORUM_POSTS_ALL_USER_GROUPS for all the user groups
65b2669d 2521 * @param int $updatedsince retrieve only discussions updated since the given time
df1ba0f4 2522 * @return array
0a4ac01b 2523 */
1e366657 2524function forum_get_discussions($cm, $forumsort="", $fullpost=true, $unused=-1, $limit=-1,
02a73d76 2525 $userlastmodified=false, $page=-1, $perpage=0, $groupid = -1,
65b2669d 2526 $updatedsince = 0) {
4e445355 2527 global $CFG, $DB, $USER;
0fcac008 2528
3d284127 2529 $timelimit = '';
2530
90f4745c 2531 $now = round(time(), -2);
4e445355 2532 $params = array($cm->instance);
90f4745c 2533
bf0f06b1 2534 $modcontext = context_module::instance($cm->id);
2b63df96 2535
4436a63b 2536 if (!has_capability('mod/forum:viewdiscussion', $modcontext)) { /// User must have perms to view discussions
2537 return array();
2538 }
2539
2540 if (!empty($CFG->forum_enabletimedposts)) { /// Users must fulfill timed posts
2b63df96 2541
0468976c 2542 if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
4e445355 2543 $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2544 $params[] = $now;
2545 $params[] = $now;
90f4745c 2546 if (isloggedin()) {
4e445355 2547 $timelimit .= " OR d.userid = ?";
2548 $params[] = $USER->id;
3d284127 2549 }
90f4745c 2550 $timelimit .= ")";
fbc21e82 2551 }
fbc21e82 2552 }
1f48942e 2553
90f4745c 2554 if ($limit > 0) {
2555 $limitfrom = 0;
2556 $limitnum = $limit;
2557 } else if ($page != -1) {
2558 $limitfrom = $page*$perpage;
2559 $limitnum = $perpage;
2560 } else {
2561 $limitfrom = 0;
2562 $limitnum = 0;
90ec387a 2563 }
8f0cd6ef 2564
90f4745c 2565 $groupmode = groups_get_activity_groupmode($cm);
353228d8 2566
fffa8b35 2567 if ($groupmode) {
4f3a2d21 2568
fffa8b35 2569 if (empty($modcontext)) {
bf0f06b1 2570 $modcontext = context_module::instance($cm->id);
fffa8b35 2571 }
2572
4f3a2d21
JL
2573 // Special case, we received a groupid to override currentgroup.
2574 if ($groupid > 0) {
2575 $course = get_course($cm->course);
2576 if (!groups_group_visible($groupid, $course, $cm)) {
2577 // User doesn't belong to this group, return nothing.
2578 return array();
2579 }
2580 $currentgroup = $groupid;
2581 } else if ($groupid === -1) {
2582 $currentgroup = groups_get_activity_group($cm);
2583 } else {
2584 // Get discussions for all groups current user can see.
2585 $currentgroup = null;
2586 }
2587
fffa8b35 2588 if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2589 if ($currentgroup) {
4e445355 2590 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2591 $params[] = $currentgroup;
fffa8b35 2592 } else {
2593 $groupselect = "";
2594 }
2595
2596 } else {
4f3a2d21
JL
2597 // Separate groups.
2598
2599 // Get discussions for all groups current user can see.
2600 if ($currentgroup === null) {
2601 $mygroups = array_keys(groups_get_all_groups($cm->course, $USER->id, $cm->groupingid, 'g.id'));
2602 if (empty($mygroups)) {
2603 $groupselect = "AND d.groupid = -1";
2604 } else {
2605 list($insqlgroups, $inparamsgroups) = $DB->get_in_or_equal($mygroups);
2606 $groupselect = "AND (d.groupid = -1 OR d.groupid $insqlgroups)";
2607 $params = array_merge($params, $inparamsgroups);
2608 }
2609 } else if ($currentgroup) {
4e445355 2610 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2611 $params[] = $currentgroup;
fffa8b35 2612 } else {
2613 $groupselect = "AND d.groupid = -1";
2614 }
2615 }
353228d8 2616 } else {
02509fe6 2617 $groupselect = "";
2618 }
29507631 2619 if (empty($forumsort)) {
1e366657 2620 $forumsort = forum_get_default_sort_order();
29507631 2621 }
2ab968e9 2622 if (empty($fullpost)) {
b879effb 2623 $postdata = "p.id,p.subject,p.modified,p.discussion,p.userid";
2ab968e9 2624 } else {
2625 $postdata = "p.*";
2626 }
9197e147 2627
13597d01 2628 if (empty($userlastmodified)) { // We don't need to know this
fffa8b35 2629 $umfields = "";
2630 $umtable = "";
13597d01 2631 } else {
d85bedf7
JL
2632 $umfields = ', ' . get_all_user_name_fields(true, 'um', null, 'um') . ', um.email AS umemail, um.picture AS umpicture,
2633 um.imagealt AS umimagealt';
4e445355 2634 $umtable = " LEFT JOIN {user} um ON (d.usermodified = um.id)";
90f4745c 2635 }
2636
65b2669d
JL
2637 $updatedsincesql = '';
2638 if (!empty($updatedsince)) {
2639 $updatedsincesql = 'AND d.timemodified > ?';
2640 $params[] = $updatedsince;
2641 }
2642
a327f25e 2643 $allnames = get_all_user_name_fields(true, 'u');
5f219cf1 2644 $sql = "SELECT $postdata, d.name, d.timemodified, d.usermodified, d.groupid, d.timestart, d.timeend, d.pinned, $allnames,
a327f25e 2645 u.email, u.picture, u.imagealt $umfields
4e445355 2646 FROM {forum_discussions} d
2647 JOIN {forum_posts} p ON p.discussion = d.id
2648 JOIN {user} u ON p.userid = u.id
90f4745c 2649 $umtable
4e445355 2650 WHERE d.forum = ? AND p.parent = 0
65b2669d 2651 $timelimit $groupselect $updatedsincesql
5f219cf1 2652 ORDER BY $forumsort, d.id DESC";
65b2669d 2653
4e445355 2654 return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
90f4745c 2655}
2656
8d3a5ba1
FM
2657/**
2658 * Gets the neighbours (previous and next) of a discussion.
2659 *
5f219cf1
BK
2660 * The calculation is based on the timemodified when time modified or time created is identical
2661 * It will revert to using the ID to sort consistently. This is better tha skipping a discussion.
8d3a5ba1 2662 *
9e381efd
DM
2663 * For blog-style forums, the calculation is based on the original creation time of the
2664 * blog post.
2665 *
8d3a5ba1
FM
2666 * Please note that this does not check whether or not the discussion passed is accessible
2667 * by the user, it simply uses it as a reference to find the neighbours. On the other hand,
2668 * the returned neighbours are checked and are accessible to the current user.
2669 *
2670 * @param object $cm The CM record.
2671 * @param object $discussion The discussion record.
9e381efd 2672 * @param object $forum The forum instance record.
8d3a5ba1
FM
2673 * @return array That always contains the keys 'prev' and 'next'. When there is a result
2674 * they contain the record with minimal information such as 'id' and 'name'.
2675 * When the neighbour is not found the value is false.
2676 */
9e381efd 2677function forum_get_discussion_neighbours($cm, $discussion, $forum) {
8d3a5ba1
FM
2678 global $CFG, $DB, $USER;
2679
9e381efd 2680 if ($cm->instance != $discussion->forum or $discussion->forum != $forum->id or $forum->id != $cm->instance) {
8d3a5ba1
FM
2681 throw new coding_exception('Discussion is not part of the same forum.');
2682 }
2683
2684 $neighbours = array('prev' => false, 'next' => false);
2685 $now = round(time(), -2);
2686 $params = array();
2687
2688 $modcontext = context_module::instance($cm->id);
2689 $groupmode = groups_get_activity_groupmode($cm);
2690 $currentgroup = groups_get_activity_group($cm);
2691
2692 // Users must fulfill timed posts.
2693 $timelimit = '';
2694 if (!empty($CFG->forum_enabletimedposts)) {
2695 if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
2696 $timelimit = ' AND ((d.timestart <= :tltimestart AND (d.timeend = 0 OR d.timeend > :tltimeend))';
2697 $params['tltimestart'] = $now;
2698 $params['tltimeend'] = $now;
2699 if (isloggedin()) {
2700 $timelimit .= ' OR d.userid = :tluserid';
2701 $params['tluserid'] = $USER->id;
2702 }
2703 $timelimit .= ')';
2704 }
2705 }
2706
2707 // Limiting to posts accessible according to groups.
2708 $groupselect = '';
2709 if ($groupmode) {
2710 if ($groupmode == VISIBLEGROUPS || has_capability('moodle/site:accessallgroups', $modcontext)) {
2711 if ($currentgroup) {
2712 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2713 $params['groupid'] = $currentgroup;
2714 }
2715 } else {
2716 if ($currentgroup) {
2717 $groupselect = 'AND (d.groupid = :groupid OR d.groupid = -1)';
2718 $params['groupid'] = $currentgroup;
2719 } else {
2720 $groupselect = 'AND d.groupid = -1';
2721 }
2722 }
2723 }
2724
5f219cf1
BK
2725 $params['forumid'] = $cm->instance;
2726 $params['discid1'] = $discussion->id;
2727 $params['discid2'] = $discussion->id;
2728 $params['discid3'] = $discussion->id;
2729 $params['discid4'] = $discussion->id;
2730 $params['disctimecompare1'] = $discussion->timemodified;
2731 $params['disctimecompare2'] = $discussion->timemodified;
2732 $params['pinnedstate1'] = (int) $discussion->pinned;
2733 $params['pinnedstate2'] = (int) $discussion->pinned;
2734 $params['pinnedstate3'] = (int) $discussion->pinned;
2735 $params['pinnedstate4'] = (int) $discussion->pinned;
9e381efd 2736
5f219cf1
BK
2737 $sql = "SELECT d.id, d.name, d.timemodified, d.groupid, d.timestart, d.timeend
2738 FROM {forum_discussions} d
2739 JOIN {forum_posts} p ON d.firstpost = p.id
2740 WHERE d.forum = :forumid
2741 AND d.id <> :discid1
2742 $timelimit
2743 $groupselect";
2744 $comparefield = "d.timemodified";
2745 $comparevalue = ":disctimecompare1";
2746 $comparevalue2 = ":disctimecompare2";
2747 if (!empty($CFG->forum_enabletimedposts)) {
2748 // Here we need to take into account the release time (timestart)
2749 // if one is set, of the neighbouring posts and compare it to the
2750 // timestart or timemodified of *this* post depending on if the
2751 // release date of this post is in the future or not.
2752 // This stops discussions that appear later because of the
2753 // timestart value from being buried under discussions that were
2754 // made afterwards.
2755 $comparefield = "CASE WHEN d.timemodified < d.timestart
2756 THEN d.timestart ELSE d.timemodified END";
2757 if ($discussion->timemodified < $discussion->timestart) {
2758 // Normally we would just use the timemodified for sorting
2759 // discussion posts. However, when timed discussions are enabled,
2760 // then posts need to be sorted base on the later of timemodified
2761 // or the release date of the post (timestart).
2762 $params['disctimecompare1'] = $discussion->timestart;
2763 $params['disctimecompare2'] = $discussion->timestart;
2764 }
2765 }
2766 $orderbydesc = forum_get_default_sort_order(true, $comparefield, 'd', false);
2767 $orderbyasc = forum_get_default_sort_order(false, $comparefield, 'd', false);
9e381efd 2768
5f219cf1
BK
2769 if ($forum->type === 'blog') {
2770 $subselect = "SELECT pp.created
2771 FROM {forum_discussions} dd
2772 JOIN {forum_posts} pp ON dd.firstpost = pp.id ";
8d3a5ba1 2773
5f219cf1
BK
2774 $subselectwhere1 = " WHERE dd.id = :discid3";
2775 $subselectwhere2 = " WHERE dd.id = :discid4";
8d3a5ba1 2776
5f219cf1 2777 $comparefield = "p.created";
9e381efd 2778
5f219cf1
BK
2779 $sub1 = $subselect.$subselectwhere1;
2780 $comparevalue = "($sub1)";
9e381efd 2781
5f219cf1
BK
2782 $sub2 = $subselect.$subselectwhere2;
2783 $comparevalue2 = "($sub2)";
8d3a5ba1 2784
5f219cf1
BK
2785 $orderbydesc = "d.pinned, p.created DESC";
2786 $orderbyasc = "d.pinned, p.created ASC";
2787 }
1e366657 2788
5f219cf1
BK
2789 $prevsql = $sql . " AND ( (($comparefield < $comparevalue) AND :pinnedstate1 = d.pinned)
2790 OR ($comparefield = $comparevalue2 AND (d.pinned = 0 OR d.pinned = :pinnedstate4) AND d.id < :discid2)
2791 OR (d.pinned = 0 AND d.pinned <> :pinnedstate2))
2792 ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbydesc, d.id DESC";
9e381efd 2793
5f219cf1
BK
2794 $nextsql = $sql . " AND ( (($comparefield > $comparevalue) AND :pinnedstate1 = d.pinned)
2795 OR ($comparefield = $comparevalue2 AND (d.pinned = 1 OR d.pinned = :pinnedstate4) AND d.id > :discid2)
2796 OR (d.pinned = 1 AND d.pinned <> :pinnedstate2))
2797 ORDER BY CASE WHEN d.pinned = :pinnedstate3 THEN 1 ELSE 0 END DESC, $orderbyasc, d.id ASC";
8d3a5ba1 2798
5f219cf1
BK
2799 $neighbours['prev'] = $DB->get_record_sql($prevsql, $params, IGNORE_MULTIPLE);
2800 $neighbours['next'] = $DB->get_record_sql($nextsql, $params, IGNORE_MULTIPLE);
8d3a5ba1
FM
2801 return $neighbours;
2802}
2803
1e366657
AO
2804/**
2805 * Get the sql to use in the ORDER BY clause for forum discussions.
2806 *
2807 * This has the ordering take timed discussion windows into account.
2808 *
2809 * @param bool $desc True for DESC, False for ASC.
2810 * @param string $compare The field in the SQL to compare to normally sort by.
2811 * @param string $prefix The prefix being used for the discussion table.
5f219cf1 2812 * @param bool $pinned sort pinned posts to the top
1e366657
AO
2813 * @return string
2814 */
5f219cf1 2815function forum_get_default_sort_order($desc = true, $compare = 'd.timemodified', $prefix = 'd', $pinned = true) {
1e366657
AO
2816 global $CFG;
2817
2818 if (!empty($prefix)) {
2819 $prefix .= '.';
2820 }
2821
2822 $dir = $desc ? 'DESC' : 'ASC';
2823
5f219cf1
BK
2824 if ($pinned == true) {
2825 $pinned = "{$prefix}pinned DESC,";
2826 } else {
2827 $pinned = '';
2828 }
2829
1e366657
AO
2830 $sort = "{$prefix}timemodified";
2831 if (!empty($CFG->forum_enabletimedposts)) {
2832 $sort = "CASE WHEN {$compare} < {$prefix}timestart
2833 THEN {$prefix}timestart
2834 ELSE {$compare}
2835 END";
2836 }
5f219cf1 2837 return "$pinned $sort $dir";
1e366657
AO
2838}
2839
df1ba0f4 2840/**
2841 *
2842 * @global object
2843 * @global object
2844 * @global object
2845 * @uses CONTEXT_MODULE
2846 * @uses VISIBLEGROUPS
2847 * @param object $cm
2848 * @return array
2849 */
bfeb10b7 2850function forum_get_discussions_unread($cm) {
4e445355 2851 global $CFG, $DB, $USER;
90f4745c 2852
2853 $now = round(time(), -2);
ee151230 2854 $cutoffdate = $now - ($CFG->forum_oldpostdays*24*60*60);
35716b86 2855
ee151230 2856 $params = array();
90f4745c 2857 $groupmode = groups_get_activity_groupmode($cm);
2858 $currentgroup = groups_get_activity_group($cm);
2859
2860 if ($groupmode) {
bf0f06b1 2861 $modcontext = context_module::instance($cm->id);
90f4745c 2862
2863 if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2864 if ($currentgroup) {
ee151230
AD
2865 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2866 $params['currentgroup'] = $currentgroup;
90f4745c 2867 } else {
2868 $groupselect = "";
2869 }
2870
2871 } else {
ee151230 2872 //separate groups without access all
90f4745c 2873 if ($currentgroup) {
ee151230
AD
2874 $groupselect = "AND (d.groupid = :currentgroup OR d.groupid = -1)";
2875 $params['currentgroup'] = $currentgroup;
90f4745c 2876 } else {
2877 $groupselect = "AND d.groupid = -1";
2878 }
2879 }
2880 } else {
2881 $groupselect = "";
13597d01 2882 }
2883
90f4745c 2884 if (!empty($CFG->forum_enabletimedposts)) {
ee151230
AD
2885 $timedsql = "AND d.timestart < :now1 AND (d.timeend = 0 OR d.timeend > :now2)";
2886 $params['now1'] = $now;
2887 $params['now2'] = $now;
90f4745c 2888 } else {
2889 $timedsql = "";
2890 }
2891
2892 $sql = "SELECT d.id, COUNT(p.id) AS unread
4e445355 2893 FROM {forum_discussions} d
2894 JOIN {forum_posts} p ON p.discussion = d.id
2895 LEFT JOIN {forum_read} r ON (r.postid = p.id AND r.userid = $USER->id)
90f4745c 2896 WHERE d.forum = {$cm->instance}
ee151230 2897 AND p.modified >= :cutoffdate AND r.id is NULL
90f4745c 2898 $groupselect
4e445355 2899 $timedsql
bfeb10b7 2900 GROUP BY d.id";
ee151230
AD
2901 $params['cutoffdate'] = $cutoffdate;
2902
4e445355 2903 if ($unreads = $DB->get_records_sql($sql, $params)) {
90f4745c 2904 foreach ($unreads as $unread) {
2905 $unreads[$unread->id] = $unread->unread;
2906 }
2907 return $unreads;
2908 } else {
2909 return array();
2910 }
1f48942e 2911}
2912
df1ba0f4 2913/**
2914 * @global object
2915 * @global object
2916 * @global object
2917 * @uses CONEXT_MODULE
2918 * @uses VISIBLEGROUPS
2919 * @param object $cm
2920 * @return array
2921 */
90f4745c 2922function forum_get_discussions_count($cm) {
4e445355 2923 global $CFG, $DB, $USER;
90f4745c 2924
2925 $now = round(time(), -2);
4e445355 2926 $params = array($cm->instance);
90f4745c 2927 $groupmode = groups_get_activity_groupmode($cm);
2928 $currentgroup = groups_get_activity_group($cm);
2929
2930 if ($groupmode) {
bf0f06b1 2931 $modcontext = context_module::instance($cm->id);
90f4745c 2932
2933 if ($groupmode == VISIBLEGROUPS or has_capability('moodle/site:accessallgroups', $modcontext)) {
2934 if ($currentgroup) {
4e445355 2935 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2936 $params[] = $currentgroup;
90f4745c 2937 } else {
2938 $groupselect = "";
2939 }
2940
2941 } else {
2942 //seprate groups without access all
2943 if ($currentgroup) {
4e445355 2944 $groupselect = "AND (d.groupid = ? OR d.groupid = -1)";
2945 $params[] = $currentgroup;
90f4745c 2946 } else {
2947 $groupselect = "AND d.groupid = -1";
2948 }
2949 }
2950 } else {
2951 $groupselect = "";
2952 }
2953
90f4745c 2954 $timelimit = "";
2955
2956 if (!empty($CFG->forum_enabletimedposts)) {
2957
bf0f06b1 2958 $modcontext = context_module::instance($cm->id);
90f4745c 2959
2960 if (!has_capability('mod/forum:viewhiddentimedposts', $modcontext)) {
4e445355 2961 $timelimit = " AND ((d.timestart <= ? AND (d.timeend = 0 OR d.timeend > ?))";
2962 $params[] = $now;
2963 $params[] = $now;
90f4745c 2964 if (isloggedin()) {
4e445355 2965 $timelimit .= " OR d.userid = ?";
2966 $params[] = $USER->id;
90f4745c 2967 }
2968 $timelimit .= ")";
2969 }
2970 }
2971
2972 $sql = "SELECT COUNT(d.id)
4e445355 2973 FROM {forum_discussions} d
2974 JOIN {forum_posts} p ON p.discussion = d.id
2975 WHERE d.forum = ? AND p.parent = 0
2976 $groupselect $timelimit";
90f4745c 2977
4e445355 2978 return $DB->get_field_sql($sql, $params);
90f4745c 2979}
1f48942e 2980
2981
0a4ac01b 2982// OTHER FUNCTIONS ///////////////////////////////////////////////////////////
f93f848a 2983
2984
df1ba0f4 2985/**
2986 * @global object
2987 * @global object
2988 * @param int $courseid
2989 * @param string $type
2990 */
11b0c469 2991function forum_get_course_forum($courseid, $type) {
2992// How to set up special 1-per-course forums
c112bc60 2993 global $CFG, $DB, $OUTPUT, $USER;
a6fcdf98 2994
4e445355 2995 if ($forums = $DB->get_records_select("forum", "course = ? AND type = ?", array($courseid, $type), "id ASC")) {
65b0e537 2996 // There should always only be ONE, but with the right combination of
29cbd93a 2997 // errors there might be more. In this case, just return the oldest one (lowest ID).
2998 foreach ($forums as $forum) {
2999 return $forum; // ie the first one
11b0c469 3000 }
8daaf761 3001 }
e6874d9f 3002
8daaf761 3003 // Doesn't exist, so create one now.
b85b25eb 3004 $forum = new stdClass();
8daaf761 3005 $forum->course = $courseid;
3006 $forum->type = "$type";
c112bc60
ARN
3007 if (!empty($USER->htmleditor)) {
3008 $forum->introformat = $USER->htmleditor;
3009 }
8daaf761 3010 switch ($forum->type) {
3011 case "news":
294ce987 3012 $forum->name = get_string("namenews", "forum");
3013 $forum->intro = get_string("intronews", "forum");
906fef94 3014 $forum->forcesubscribe = FORUM_FORCESUBSCRIBE;
8daaf761 3015 $forum->assessed = 0;
709f0ec8 3016 if ($courseid == SITEID) {
3017 $forum->name = get_string("sitenews");
3018 $forum->forcesubscribe = 0;
8f0cd6ef 3019 }
8daaf761 3020 break;
3021 case "social":
294ce987 3022 $forum->name = get_string("namesocial", "forum");
3023 $forum->intro = get_string("introsocial", "forum");
8daaf761 3024 $forum->assessed = 0;
3025 $forum->forcesubscribe = 0;
3026 break;
1c7b8b93
NC
3027 case "blog":
3028 $forum->name = get_string('blogforum', 'forum');
3029 $forum->intro = get_string('introblog', 'forum');
3030 $forum->assessed = 0;
3031 $forum->forcesubscribe = 0;
3032 break;
8daaf761 3033 default:
9146b979 3034 echo $OUTPUT->notification("That forum type doesn't exist!");
8daaf761 3035 return false;
3036 break;
3037 }
3038
3039 $forum->timemodified = time();
4e445355 3040 $forum->id = $DB->insert_record("forum", $forum);
8daaf761 3041
4e445355 3042 if (! $module = $DB->get_record("modules", array("name" => "forum"))) {
9146b979 3043 echo $OUTPUT->notification("Could not find forum module!!");
e1b5643f 3044 return false;
82aa0e8d 3045 }
39790bd8 3046 $mod = new stdClass();
e1b5643f 3047 $mod->course = $courseid;
3048 $mod->module = $module->id;
3049 $mod->instance = $forum->id;
3050 $mod->section = 0;
722e6ba9
MG
3051 include_once("$CFG->dirroot/course/lib.php");
3052 if (! $mod->coursemodule = add_course_module($mod) ) {
11cd754e 3053 echo $OUTPUT->notification("Could not add a new course module to the course '" . $courseid . "'");
e1b5643f 3054 return false;
3055 }
722e6ba9 3056 $sectionid = course_add_cm_to_section($courseid, $mod->coursemodule, 0);
4e445355 3057 return $DB->get_record("forum", array("id" => "$forum->id"));
82aa0e8d 3058}
3059
0a4ac01b 3060/**
21976af1 3061 * Print a forum post
65bcf17b 3062 *
df1ba0f4 3063 * @global object
3064 * @global object
3065 * @uses FORUM_MODE_THREADED
3066 * @uses PORTFOLIO_FORMAT_PLAINHTML
3067 * @uses PORTFOLIO_FORMAT_FILE
3068 * @uses PORTFOLIO_FORMAT_RICHHTML
3069 * @uses PORTFOLIO_ADD_TEXT_LINK
3070 * @uses CONTEXT_MODULE
21976af1 3071 * @param object $post The post to print.
df1ba0f4 3072 * @param object $discussion
3073 * @param object $forum
3074 * @param object $cm
3075 * @param object $course
21976af1 3076 * @param boolean $ownpost Whether this post belongs to the current user.
65bcf17b 3077 * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
21976af1 3078 * @param boolean $link Just print a shortened version of the post as a link to the full post.
21976af1 3079 * @param string $footer Extra stuff to print after the message.
3080 * @param string $highlight Space-separated list of terms to highlight.
3081 * @param int $post_read true, false or -99. If we already know whether this user
3082 * has read this post, pass that in, otherwise, pass in -99, and this
3083 * function will work it out.
3084 * @param boolean $dummyifcantsee When forum_user_can_see_post says that
65bcf17b 3085 * the current user can't see this post, if this argument is true
21976af1 3086 * (the default) then print a dummy 'you can't see this post' post.
3087 * If false, don't output anything at all.
df1ba0f4 3088 * @param bool|null $istracked
63e87951 3089 * @return void
0a4ac01b 3090 */
65bcf17b 3091function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
367a75fa 3092 $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
5d9827e4 3093 global $USER, $CFG, $OUTPUT;
501cdbd8 3094
99d19c13
PS
3095 require_once($CFG->libdir . '/filelib.php');
3096
367a75fa
SH
3097 // String cache
3098 static $str;
654e77e7
DP
3099 // This is an extremely hacky way to ensure we only print the 'unread' anchor
3100 // the first time we encounter an unread post on a page. Ideally this would
3101 // be moved into the caller somehow, and be better testable. But at the time
3102 // of dealing with this bug, this static workaround was the most surgical and
3103 // it fits together with only printing th unread anchor id once on a given page.
3104 static $firstunreadanchorprinted = false;
f37da850 3105
bf0f06b1 3106 $modcontext = context_module::instance($cm->id);
8d96a7b4 3107
65bcf17b 3108 $post->course = $course->id;
3109 $post->forum = $forum->id;
64f93798 3110 $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
103e7cba
KG
3111 if (!empty($CFG->enableplagiarism)) {
3112 require_once($CFG->libdir.'/plagiarismlib.php');
3113 $post->message .= plagiarism_get_links(array('userid' => $post->userid,
3114 'content' => $post->message,
3115 'cmid' => $cm->id,
3116 'course' => $post->course,
3117 'forum' => $post->forum));
3118 }
951e1073 3119
65bcf17b 3120 // caching
3121 if (!isset($cm->cache)) {
367a75fa 3122 $cm->cache = new stdClass;
65bcf17b 3123 }
13bbe067 3124
65bcf17b 3125 if (!isset($cm->cache->caps)) {
3126 $cm->cache->caps = array();
65bcf17b 3127 $cm->cache->caps['mod/forum:viewdiscussion'] = has_capability('mod/forum:viewdiscussion', $modcontext);
3128 $cm->cache->caps['moodle/site:viewfullnames'] = has_capability('moodle/site:viewfullnames', $modcontext);