MDL-40062 mod_forum: discussion events
[moodle.git] / mod / forum / discuss.php
CommitLineData
1adbd2c3 1<?php
501cdbd8 2
8f685009
SH
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * Displays a post, and all the posts below it.
20 * If no post is given, displays all posts in a discussion
21 *
22 * @package mod-forum
23 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25 */
501cdbd8 26
65bcf17b 27 require_once('../../config.php');
65bcf17b 28
83da3d28 29 $d = required_param('d', PARAM_INT); // Discussion ID
30 $parent = optional_param('parent', 0, PARAM_INT); // If set, then display this post and all children.
31 $mode = optional_param('mode', 0, PARAM_INT); // If set, changes the layout of the thread
32 $move = optional_param('move', 0, PARAM_INT); // If set, moves this discussion to another forum
87b0b499 33 $mark = optional_param('mark', '', PARAM_ALPHA); // Used for tracking read posts if user initiated.
83da3d28 34 $postid = optional_param('postid', 0, PARAM_INT); // Used for tracking read posts if user initiated.
501cdbd8 35
a6855934 36 $url = new moodle_url('/mod/forum/discuss.php', array('d'=>$d));
8a876913
SH
37 if ($parent !== 0) {
38 $url->param('parent', $parent);
39 }
8a876913 40 $PAGE->set_url($url);
d3558659 41
01d0aceb 42 $discussion = $DB->get_record('forum_discussions', array('id' => $d), '*', MUST_EXIST);
74df2951 43 $course = $DB->get_record('course', array('id' => $discussion->course), '*', MUST_EXIST);
01d0aceb
SH
44 $forum = $DB->get_record('forum', array('id' => $discussion->forum), '*', MUST_EXIST);
45 $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id, false, MUST_EXIST);
68258534 46
bf553d9e 47 require_course_login($course, true, $cm);
50e07a49 48
4cabf99f 49 // move this down fix for MDL-6926
01d0aceb 50 require_once($CFG->dirroot.'/mod/forum/lib.php');
4cabf99f 51
bf0f06b1 52 $modcontext = context_module::instance($cm->id);
65bcf17b 53 require_capability('mod/forum:viewdiscussion', $modcontext, NULL, true, 'noviewdiscussionspermission', 'forum');
54
9e86f2e7
AD
55 if (!empty($CFG->enablerssfeeds) && !empty($CFG->forum_enablerssfeeds) && $forum->rsstype && $forum->rssarticles) {
56 require_once("$CFG->libdir/rsslib.php");
57
7a241d81 58 $rsstitle = format_string($course->shortname, true, array('context' => context_course::instance($course->id))) . ': ' . format_string($forum->name);
43b92251 59 rss_add_http_header($modcontext, 'mod_forum', $forum, $rsstitle);
9e86f2e7
AD
60 }
61
65bcf17b 62/// move discussion if requested
63 if ($move > 0 and confirm_sesskey()) {
a5f77de6 64 $return = $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
65bcf17b 65
66 require_capability('mod/forum:movediscussions', $modcontext);
1fc49f00 67
65bcf17b 68 if ($forum->type == 'single') {
12e57b92 69 print_error('cannotmovefromsingleforum', 'forum', $return);
83da3d28 70 }
65bcf17b 71
4e445355 72 if (!$forumto = $DB->get_record('forum', array('id' => $move))) {
12e57b92 73 print_error('cannotmovetonotexist', 'forum', $return);
83da3d28 74 }
7c900d5d 75
5fad08b4
CF
76 if ($forumto->type == 'single') {
77 print_error('cannotmovetosingleforum', 'forum', $return);
78 }
79
65bcf17b 80 if (!$cmto = get_coursemodule_from_instance('forum', $forumto->id, $course->id)) {
12e57b92 81 print_error('cannotmovetonotfound', 'forum', $return);
65bcf17b 82 }
83
84 if (!coursemodule_visible_for_user($cmto)) {
12e57b92 85 print_error('cannotmovenotvisible', 'forum', $return);
1fc49f00 86 }
65bcf17b 87
71595d00
DP
88 $destinationctx = context_module::instance($cmto->id);
89 require_capability('mod/forum:startdiscussion', $destinationctx);
ee8d825f 90
0faf6791 91 if (!forum_move_attachments($discussion, $forum->id, $forumto->id)) {
9146b979 92 echo $OUTPUT->notification("Errors occurred while moving attachment directories - check your file permissions");
65bcf17b 93 }
4e445355 94 $DB->set_field('forum_discussions', 'forum', $forumto->id, array('id' => $discussion->id));
95 $DB->set_field('forum_read', 'forumid', $forumto->id, array('discussionid' => $discussion->id));
71595d00
DP
96
97 $params = array(
98 'context' => $destinationctx,
99 'objectid' => $discussion->id,
100 'other' => array(
101 'fromforumid' => $forum->id,
102 'toforumid' => $forumto->id,
103 )
104 );
105 $event = \mod_forum\event\discussion_moved::create($params);
106 $event->add_record_snapshot('forum_discussions', $discussion);
107 $event->add_record_snapshot('forum', $forum);
108 $event->add_record_snapshot('forum', $forumto);
109 $event->trigger();
65bcf17b 110
a74bea12 111 // Delete the RSS files for the 2 forums to force regeneration of the feeds
54eb02a4 112 require_once($CFG->dirroot.'/mod/forum/rsslib.php');
a74bea12
AD
113 forum_rss_delete_file($forum);
114 forum_rss_delete_file($forumto);
65bcf17b 115
e4c5abdc 116 redirect($return.'&moved=-1&sesskey='.sesskey());
1fc49f00 117 }
118
71595d00
DP
119 $params = array(
120 'context' => $modcontext,
121 'objectid' => $discussion->id,
122 );
123 $event = \mod_forum\event\discussion_viewed::create($params);
124 $event->add_record_snapshot('forum_discussions', $discussion);
125 $event->add_record_snapshot('forum', $forum);
126 $event->trigger();
501cdbd8 127
128 unset($SESSION->fromdiscussion);
129
279826e2 130 if ($mode) {
f2d042c4 131 set_user_preference('forum_displaymode', $mode);
279826e2 132 }
501cdbd8 133
acb50c1b 134 $displaymode = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
501cdbd8 135
e92ea3d8 136 if ($parent) {
65bcf17b 137 // If flat AND parent, then force nested display this time
138 if ($displaymode == FORUM_MODE_FLATOLDEST or $displaymode == FORUM_MODE_FLATNEWEST) {
139 $displaymode = FORUM_MODE_NESTED;
e92ea3d8 140 }
141 } else {
501cdbd8 142 $parent = $discussion->firstpost;
501cdbd8 143 }
144
11b0c469 145 if (! $post = forum_get_post_full($parent)) {
12e57b92 146 print_error("notexists", 'forum', "$CFG->wwwroot/mod/forum/view.php?f=$forum->id");
501cdbd8 147 }
148
737aefb4
MN
149 if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
150 print_error('noviewdiscussionspermission', 'forum', "$CFG->wwwroot/mod/forum/view.php?id=$forum->id");
f37da850 151 }
152
65bcf17b 153 if ($mark == 'read' or $mark == 'unread') {
90f4745c 154 if ($CFG->forum_usermarksread && forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
65bcf17b 155 if ($mark == 'read') {
90f4745c 156 forum_tp_add_read_record($USER->id, $postid);
65bcf17b 157 } else {
158 // unread
159 forum_tp_delete_read_records($USER->id, $postid);
160 }
161 }
162 }
cef1ce6a 163
6f1cc8d6 164 $searchform = forum_search_form($course);
39790bd8 165
01d0aceb
SH
166 $forumnode = $PAGE->navigation->find($cm->id, navigation_node::TYPE_ACTIVITY);
167 if (empty($forumnode)) {
168 $forumnode = $PAGE->navbar;
169 } else {
c89fa3fe 170 $forumnode->make_active();
87a462ea 171 }
01d0aceb 172 $node = $forumnode->add(format_string($discussion->name), new moodle_url('/mod/forum/discuss.php', array('d'=>$discussion->id)));
c89fa3fe 173 $node->display = false;
01d0aceb
SH
174 if ($node && $post->id != $discussion->firstpost) {
175 $node->add(format_string($post->subject), $PAGE->url);
176 }
177
15ca5e5e 178 $PAGE->set_title("$course->shortname: ".format_string($discussion->name));
179 $PAGE->set_heading($course->fullname);
180 $PAGE->set_button($searchform);
181 echo $OUTPUT->header();
3eb032d7 182 echo $OUTPUT->heading(format_string($forum->name), 2);
c6d691dc 183
9197e147 184/// Check to see if groups are being used in this forum
185/// If so, make sure the current person is allowed to see this discussion
8b79a625 186/// Also, if we know they should be able to reply, then explicitly set $canreply for performance reasons
c6d691dc 187
8e18e1ec
PS
188 $canreply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
189 if (!$canreply and $forum->type !== 'news') {
190 if (isguestuser() or !isloggedin()) {
191 $canreply = true;
192 }
193 if (!is_enrolled($modcontext) and !is_viewing($modcontext)) {
194 // allow guests and not-logged-in to see the link - they are prompted to log in after clicking the link
195 // normal users with temporary guest access see this link too, they are asked to enrol instead
196 $canreply = enrol_selfenrol_available($course->id);
197 }
9197e147 198 }
199
c6d691dc 200/// Print the controls across the top
c00037cd 201 echo '<div class="discussioncontrols clearfix">';
c6d691dc 202
6708a1f5 203 if (!empty($CFG->enableportfolios) && has_capability('mod/forum:exportdiscussion', $modcontext)) {
24ba58ee 204 require_once($CFG->libdir.'/portfoliolib.php');
0d06b6fd 205 $button = new portfolio_add_button();
37743241 206 $button->set_callback_options('forum_portfolio_caller', array('discussionid' => $discussion->id), 'mod_forum');
f3cc571a
DM
207 $button = $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportdiscussion', 'mod_forum'));
208 $buttonextraclass = '';
209 if (empty($button)) {
210 // no portfolio plugin available.
211 $button = '&nbsp;';
212 $buttonextraclass = ' noavailable';
213 }
214 echo html_writer::tag('div', $button, array('class' => 'discussioncontrol exporttoportfolio'.$buttonextraclass));
f357d2f8
DM
215 } else {
216 echo html_writer::tag('div', '&nbsp;', array('class'=>'discussioncontrol nullcontrol'));
10ae55f9 217 }
218
f357d2f8
DM
219 // groups selector not needed here
220 echo '<div class="discussioncontrol displaymode">';
221 forum_print_mode_form($discussion->id, $displaymode);
222 echo "</div>";
223
cef1ce6a 224 if ($forum->type != 'single'
225 && has_capability('mod/forum:movediscussions', $modcontext)) {
65bcf17b 226
f357d2f8 227 echo '<div class="discussioncontrol movediscussion">';
cef1ce6a 228 // Popup menu to move discussions to other forums. The discussion in a
229 // single discussion forum can't be moved.
65bcf17b 230 $modinfo = get_fast_modinfo($course);
231 if (isset($modinfo->instances['forum'])) {
65bcf17b 232 $forummenu = array();
5fad08b4
CF
233 // Check forum types and eliminate simple discussions.
234 $forumcheck = $DB->get_records('forum', array('course' => $course->id),'', 'id, type');
65bcf17b 235 foreach ($modinfo->instances['forum'] as $forumcm) {
ee8d825f 236 if (!$forumcm->uservisible || !has_capability('mod/forum:startdiscussion',
bf0f06b1 237 context_module::instance($forumcm->id))) {
65bcf17b 238 continue;
fcc69042 239 }
65bcf17b 240 $section = $forumcm->sectionnum;
71a56e08 241 $sectionname = get_section_name($course, $section);
f1a3e072 242 if (empty($forummenu[$section])) {
7487c856 243 $forummenu[$section] = array($sectionname => array());
f1a3e072 244 }
5fad08b4
CF
245 $forumidcompare = $forumcm->instance != $forum->id;
246 $forumtypecheck = $forumcheck[$forumcm->instance]->type !== 'single';
247 if ($forumidcompare and $forumtypecheck) {
f1a3e072 248 $url = "/mod/forum/discuss.php?d=$discussion->id&move=$forumcm->instance&sesskey=".sesskey();
7487c856 249 $forummenu[$section][$sectionname][$url] = format_string($forumcm->name);
1fc49f00 250 }
251 }
252 if (!empty($forummenu)) {
12a24e00 253 echo '<div class="movediscussionoption">';
15e48a1a
SM
254 $select = new url_select($forummenu, '',
255 array(''=>get_string("movethisdiscussionto", "forum")),
256 'forummenu', get_string('move'));
f1a3e072 257 echo $OUTPUT->render($select);
1fc49f00 258 echo "</div>";
259 }
260 }
12a24e00 261 echo "</div>";
1fc49f00 262 }
12a24e00
RW
263 echo '<div class="clearfloat">&nbsp;</div>';
264 echo "</div>";
1fc49f00 265
a4f495bf 266 if (!empty($forum->blockafter) && !empty($forum->blockperiod)) {
39790bd8 267 $a = new stdClass();
65bcf17b 268 $a->blockafter = $forum->blockafter;
a4f495bf 269 $a->blockperiod = get_string('secondstotime'.$forum->blockperiod);
9146b979 270 echo $OUTPUT->notification(get_string('thisforumisthrottled','forum',$a));
a4f495bf 271 }
272
0468976c 273 if ($forum->type == 'qanda' && !has_capability('mod/forum:viewqandawithoutposting', $modcontext) &&
bbbf2d40 274 !forum_user_has_posted($forum->id,$discussion->id,$USER->id)) {
9146b979 275 echo $OUTPUT->notification(get_string('qandanotify','forum'));
098d27d4 276 }
277
65bcf17b 278 if ($move == -1 and confirm_sesskey()) {
9146b979 279 echo $OUTPUT->notification(get_string('discussionmoved', 'forum', format_string($forum->name,true)));
8de14dc7 280 }
281
65bcf17b 282 $canrate = has_capability('mod/forum:rate', $modcontext);
283 forum_print_discussion($course, $cm, $forum, $discussion, $post, $displaymode, $canreply, $canrate);
c6d691dc 284
396fb912 285 echo $OUTPUT->footer();
65bcf17b 286
501cdbd8 287
1adbd2c3 288