MDL-48044 mod_forum: Preload icons for discussion subscription toggles
[moodle.git] / mod / forum / discuss.php
1 <?php
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/>.
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  */
27     require_once('../../config.php');
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
33     $mark   = optional_param('mark', '', PARAM_ALPHA);       // Used for tracking read posts if user initiated.
34     $postid = optional_param('postid', 0, PARAM_INT);        // Used for tracking read posts if user initiated.
36     $url = new moodle_url('/mod/forum/discuss.php', array('d'=>$d));
37     if ($parent !== 0) {
38         $url->param('parent', $parent);
39     }
40     $PAGE->set_url($url);
42     $discussion = $DB->get_record('forum_discussions', array('id' => $d), '*', MUST_EXIST);
43     $course = $DB->get_record('course', array('id' => $discussion->course), '*', MUST_EXIST);
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);
47     require_course_login($course, true, $cm);
49     // move this down fix for MDL-6926
50     require_once($CFG->dirroot.'/mod/forum/lib.php');
52     $modcontext = context_module::instance($cm->id);
53     require_capability('mod/forum:viewdiscussion', $modcontext, NULL, true, 'noviewdiscussionspermission', 'forum');
55     if (!empty($CFG->enablerssfeeds) && !empty($CFG->forum_enablerssfeeds) && $forum->rsstype && $forum->rssarticles) {
56         require_once("$CFG->libdir/rsslib.php");
58         $rsstitle = format_string($course->shortname, true, array('context' => context_course::instance($course->id))) . ': ' . format_string($forum->name);
59         rss_add_http_header($modcontext, 'mod_forum', $forum, $rsstitle);
60     }
62     // Move discussion if requested.
63     if ($move > 0 and confirm_sesskey()) {
64         $return = $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
66         if (!$forumto = $DB->get_record('forum', array('id' => $move))) {
67             print_error('cannotmovetonotexist', 'forum', $return);
68         }
70         require_capability('mod/forum:movediscussions', $modcontext);
72         if ($forum->type == 'single') {
73             print_error('cannotmovefromsingleforum', 'forum', $return);
74         }
76         if (!$forumto = $DB->get_record('forum', array('id' => $move))) {
77             print_error('cannotmovetonotexist', 'forum', $return);
78         }
80         if ($forumto->type == 'single') {
81             print_error('cannotmovetosingleforum', 'forum', $return);
82         }
84         // Get target forum cm and check it is visible to current user.
85         $modinfo = get_fast_modinfo($course);
86         $forums = $modinfo->get_instances_of('forum');
87         if (!array_key_exists($forumto->id, $forums)) {
88             print_error('cannotmovetonotfound', 'forum', $return);
89         }
90         $cmto = $forums[$forumto->id];
91         if (!$cmto->uservisible) {
92             print_error('cannotmovenotvisible', 'forum', $return);
93         }
95         $destinationctx = context_module::instance($cmto->id);
96         require_capability('mod/forum:startdiscussion', $destinationctx);
98         if (!forum_move_attachments($discussion, $forum->id, $forumto->id)) {
99             echo $OUTPUT->notification("Errors occurred while moving attachment directories - check your file permissions");
100         }
101         // For each subscribed user in this forum and discussion, copy over per-discussion subscriptions if required.
102         $discussiongroup = $discussion->groupid == -1 ? 0 : $discussion->groupid;
103         $potentialsubscribers = \mod_forum\subscriptions::fetch_subscribed_users(
104             $forum,
105             $discussiongroup,
106             $modcontext,
107             'u.id',
108             true
109         );
111         // Pre-seed the subscribed_discussion caches.
112         // Firstly for the forum being moved to.
113         \mod_forum\subscriptions::fill_subscription_cache($forumto->id);
114         // And also for the discussion being moved.
115         \mod_forum\subscriptions::fill_subscription_cache($forum->id);
116         $subscriptionchanges = array();
117         $subscriptiontime = time();
118         foreach ($potentialsubscribers as $subuser) {
119             $userid = $subuser->id;
120             $targetsubscription = \mod_forum\subscriptions::is_subscribed($userid, $forumto, null, $cmto);
121             if (\mod_forum\subscriptions::is_subscribed($userid, $forum, $discussion->id)) {
122                 if (!$targetsubscription) {
123                     $subscriptionchanges[$userid] = $subscriptiontime;
124                 }
125             } else {
126                 if ($targetsubscription) {
127                     $subscriptionchanges[$userid] = \mod_forum\subscriptions::FORUM_DISCUSSION_UNSUBSCRIBED;
128                 }
129             }
130         }
132         $DB->set_field('forum_discussions', 'forum', $forumto->id, array('id' => $discussion->id));
133         $DB->set_field('forum_read', 'forumid', $forumto->id, array('discussionid' => $discussion->id));
135         // Delete the existing per-discussion subscriptions and replace them with the newly calculated ones.
136         $DB->delete_records('forum_discussion_subs', array('discussion' => $discussion->id));
137         $newdiscussion = clone $discussion;
138         $newdiscussion->forum = $forumto->id;
139         foreach ($subscriptionchanges as $userid => $preference) {
140             if ($preference != \mod_forum\subscriptions::FORUM_DISCUSSION_UNSUBSCRIBED) {
141                 // Users must have viewdiscussion to a discussion.
142                 if (has_capability('mod/forum:viewdiscussion', $destinationctx, $userid)) {
143                     \mod_forum\subscriptions::subscribe_user_to_discussion($userid, $newdiscussion, $destinationctx);
144                 }
145             } else {
146                 \mod_forum\subscriptions::unsubscribe_user_from_discussion($userid, $newdiscussion, $destinationctx);
147             }
148         }
150         $params = array(
151             'context' => $destinationctx,
152             'objectid' => $discussion->id,
153             'other' => array(
154                 'fromforumid' => $forum->id,
155                 'toforumid' => $forumto->id,
156             )
157         );
158         $event = \mod_forum\event\discussion_moved::create($params);
159         $event->add_record_snapshot('forum_discussions', $discussion);
160         $event->add_record_snapshot('forum', $forum);
161         $event->add_record_snapshot('forum', $forumto);
162         $event->trigger();
164         // Delete the RSS files for the 2 forums to force regeneration of the feeds
165         require_once($CFG->dirroot.'/mod/forum/rsslib.php');
166         forum_rss_delete_file($forum);
167         forum_rss_delete_file($forumto);
169         redirect($return.'&moved=-1&sesskey='.sesskey());
170     }
172     $params = array(
173         'context' => $modcontext,
174         'objectid' => $discussion->id,
175     );
176     $event = \mod_forum\event\discussion_viewed::create($params);
177     $event->add_record_snapshot('forum_discussions', $discussion);
178     $event->add_record_snapshot('forum', $forum);
179     $event->trigger();
181     unset($SESSION->fromdiscussion);
183     if ($mode) {
184         set_user_preference('forum_displaymode', $mode);
185     }
187     $displaymode = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
189     if ($parent) {
190         // If flat AND parent, then force nested display this time
191         if ($displaymode == FORUM_MODE_FLATOLDEST or $displaymode == FORUM_MODE_FLATNEWEST) {
192             $displaymode = FORUM_MODE_NESTED;
193         }
194     } else {
195         $parent = $discussion->firstpost;
196     }
198     if (! $post = forum_get_post_full($parent)) {
199         print_error("notexists", 'forum', "$CFG->wwwroot/mod/forum/view.php?f=$forum->id");
200     }
202     if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm)) {
203         print_error('noviewdiscussionspermission', 'forum', "$CFG->wwwroot/mod/forum/view.php?id=$forum->id");
204     }
206     if ($mark == 'read' or $mark == 'unread') {
207         if ($CFG->forum_usermarksread && forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
208             if ($mark == 'read') {
209                 forum_tp_add_read_record($USER->id, $postid);
210             } else {
211                 // unread
212                 forum_tp_delete_read_records($USER->id, $postid);
213             }
214         }
215     }
217     $searchform = forum_search_form($course);
219     $forumnode = $PAGE->navigation->find($cm->id, navigation_node::TYPE_ACTIVITY);
220     if (empty($forumnode)) {
221         $forumnode = $PAGE->navbar;
222     } else {
223         $forumnode->make_active();
224     }
225     $node = $forumnode->add(format_string($discussion->name), new moodle_url('/mod/forum/discuss.php', array('d'=>$discussion->id)));
226     $node->display = false;
227     if ($node && $post->id != $discussion->firstpost) {
228         $node->add(format_string($post->subject), $PAGE->url);
229     }
231     $PAGE->set_title("$course->shortname: ".format_string($discussion->name));
232     $PAGE->set_heading($course->fullname);
233     $PAGE->set_button($searchform);
234     $renderer = $PAGE->get_renderer('mod_forum');
236     echo $OUTPUT->header();
238     echo $OUTPUT->heading(format_string($forum->name), 2);
239     echo $OUTPUT->heading(format_string($discussion->name), 3, 'discussionname');
241     if ((!isguestuser() && isloggedin()) && has_capability('mod/forum:viewdiscussion', $modcontext)) {
242         // Discussion subscription.
243         if (\mod_forum\subscriptions::is_subscribable($forum)) {
244             echo html_writer::div(
245                 forum_get_discussion_subscription_icon($forum, $post->discussion, null, true),
246                 'discussionsubscription'
247             );
248             echo forum_get_discussion_subscription_icon_preloaders();
249         }
250     }
253 /// Check to see if groups are being used in this forum
254 /// If so, make sure the current person is allowed to see this discussion
255 /// Also, if we know they should be able to reply, then explicitly set $canreply for performance reasons
257     $canreply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
258     if (!$canreply and $forum->type !== 'news') {
259         if (isguestuser() or !isloggedin()) {
260             $canreply = true;
261         }
262         if (!is_enrolled($modcontext) and !is_viewing($modcontext)) {
263             // allow guests and not-logged-in to see the link - they are prompted to log in after clicking the link
264             // normal users with temporary guest access see this link too, they are asked to enrol instead
265             $canreply = enrol_selfenrol_available($course->id);
266         }
267     }
269     // Output the links to neighbour discussions.
270     $neighbours = forum_get_discussion_neighbours($cm, $discussion);
271     $neighbourlinks = $renderer->neighbouring_discussion_navigation($neighbours['prev'], $neighbours['next']);
272     echo $neighbourlinks;
274 /// Print the controls across the top
275     echo '<div class="discussioncontrols clearfix">';
277     if (!empty($CFG->enableportfolios) && has_capability('mod/forum:exportdiscussion', $modcontext)) {
278         require_once($CFG->libdir.'/portfoliolib.php');
279         $button = new portfolio_add_button();
280         $button->set_callback_options('forum_portfolio_caller', array('discussionid' => $discussion->id), 'mod_forum');
281         $button = $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportdiscussion', 'mod_forum'));
282         $buttonextraclass = '';
283         if (empty($button)) {
284             // no portfolio plugin available.
285             $button = '&nbsp;';
286             $buttonextraclass = ' noavailable';
287         }
288         echo html_writer::tag('div', $button, array('class' => 'discussioncontrol exporttoportfolio'.$buttonextraclass));
289     } else {
290         echo html_writer::tag('div', '&nbsp;', array('class'=>'discussioncontrol nullcontrol'));
291     }
293     // groups selector not needed here
294     echo '<div class="discussioncontrol displaymode">';
295     forum_print_mode_form($discussion->id, $displaymode);
296     echo "</div>";
298     if ($forum->type != 'single'
299                 && has_capability('mod/forum:movediscussions', $modcontext)) {
301         echo '<div class="discussioncontrol movediscussion">';
302         // Popup menu to move discussions to other forums. The discussion in a
303         // single discussion forum can't be moved.
304         $modinfo = get_fast_modinfo($course);
305         if (isset($modinfo->instances['forum'])) {
306             $forummenu = array();
307             // Check forum types and eliminate simple discussions.
308             $forumcheck = $DB->get_records('forum', array('course' => $course->id),'', 'id, type');
309             foreach ($modinfo->instances['forum'] as $forumcm) {
310                 if (!$forumcm->uservisible || !has_capability('mod/forum:startdiscussion',
311                     context_module::instance($forumcm->id))) {
312                     continue;
313                 }
314                 $section = $forumcm->sectionnum;
315                 $sectionname = get_section_name($course, $section);
316                 if (empty($forummenu[$section])) {
317                     $forummenu[$section] = array($sectionname => array());
318                 }
319                 $forumidcompare = $forumcm->instance != $forum->id;
320                 $forumtypecheck = $forumcheck[$forumcm->instance]->type !== 'single';
321                 if ($forumidcompare and $forumtypecheck) {
322                     $url = "/mod/forum/discuss.php?d=$discussion->id&move=$forumcm->instance&sesskey=".sesskey();
323                     $forummenu[$section][$sectionname][$url] = format_string($forumcm->name);
324                 }
325             }
326             if (!empty($forummenu)) {
327                 echo '<div class="movediscussionoption">';
328                 $select = new url_select($forummenu, '',
329                         array(''=>get_string("movethisdiscussionto", "forum")),
330                         'forummenu', get_string('move'));
331                 echo $OUTPUT->render($select);
332                 echo "</div>";
333             }
334         }
335         echo "</div>";
336     }
337     echo '<div class="clearfloat">&nbsp;</div>';
338     echo "</div>";
340     if (!empty($forum->blockafter) && !empty($forum->blockperiod)) {
341         $a = new stdClass();
342         $a->blockafter  = $forum->blockafter;
343         $a->blockperiod = get_string('secondstotime'.$forum->blockperiod);
344         echo $OUTPUT->notification(get_string('thisforumisthrottled','forum',$a));
345     }
347     if ($forum->type == 'qanda' && !has_capability('mod/forum:viewqandawithoutposting', $modcontext) &&
348                 !forum_user_has_posted($forum->id,$discussion->id,$USER->id)) {
349         echo $OUTPUT->notification(get_string('qandanotify','forum'));
350     }
352     if ($move == -1 and confirm_sesskey()) {
353         echo $OUTPUT->notification(get_string('discussionmoved', 'forum', format_string($forum->name,true)));
354     }
356     $canrate = has_capability('mod/forum:rate', $modcontext);
357     forum_print_discussion($course, $cm, $forum, $discussion, $post, $displaymode, $canreply, $canrate);
359     echo $neighbourlinks;
361     // Add the subscription toggle JS.
362     $PAGE->requires->yui_module('moodle-mod_forum-subscriptiontoggle', 'Y.M.mod_forum.subscriptiontoggle.init');
364     echo $OUTPUT->footer();