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