MDL-71161 mod_folder: Display activity information output component
[moodle.git] / mod / forum / view.php
CommitLineData
1adbd2c3 1<?php
8f685009
SH
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/**
54d38a73
MG
18 * Displays the list of discussions in a forum.
19 *
01030f1b 20 * @package mod_forum
54d38a73 21 * @copyright 2019 Andrew Nicols <andrew@nicols.co.uk>
8f685009
SH
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
1d709d76
MM
25use mod_forum\grades\forum_gradeitem;
26
54d38a73
MG
27require_once('../../config.php');
28
29$managerfactory = mod_forum\local\container::get_manager_factory();
30$legacydatamapperfactory = mod_forum\local\container::get_legacy_data_mapper_factory();
31$vaultfactory = mod_forum\local\container::get_vault_factory();
32$forumvault = $vaultfactory->get_forum_vault();
33$discussionvault = $vaultfactory->get_discussion_vault();
34$postvault = $vaultfactory->get_post_vault();
1a9c60e9 35$discussionlistvault = $vaultfactory->get_discussions_in_forum_vault();
54d38a73 36
bda290ee
RW
37$cmid = optional_param('id', 0, PARAM_INT);
38$forumid = optional_param('f', 0, PARAM_INT);
f30f46db
RW
39$mode = optional_param('mode', 0, PARAM_INT);
40$showall = optional_param('showall', '', PARAM_INT);
41$pageno = optional_param('page', 0, PARAM_INT);
42$search = optional_param('search', '', PARAM_CLEAN);
43$pageno = optional_param('p', $pageno, PARAM_INT);
54d38a73
MG
44$pagesize = optional_param('s', 0, PARAM_INT);
45$sortorder = optional_param('o', null, PARAM_INT);
54d38a73 46
bda290ee
RW
47if (!$cmid && !$forumid) {
48 print_error('missingparameter');
49}
50
1bfaeeb2
AN
51if ($cmid) {
52 $forum = $forumvault->get_from_course_module_id($cmid);
53 if (empty($forum)) {
54 throw new \moodle_exception('Unable to find forum with cmid ' . $cmid);
55 }
56} else {
57 $forum = $forumvault->get_from_id($forumid);
58 if (empty($forum)) {
59 throw new \moodle_exception('Unable to find forum with id ' . $forumid);
60 }
54d38a73
MG
61}
62
f30f46db
RW
63if (!empty($showall)) {
64 // The user wants to see all discussions.
65 $pageno = 0;
66 $pagesize = 0;
67}
68
54d38a73
MG
69$urlfactory = mod_forum\local\container::get_url_factory();
70$capabilitymanager = $managerfactory->get_capability_manager($forum);
71
bda290ee 72$url = $urlfactory->get_forum_view_url_from_forum($forum);
54d38a73
MG
73$PAGE->set_url($url);
74
75$course = $forum->get_course_record();
76$coursemodule = $forum->get_course_module_record();
77$cm = \cm_info::create($coursemodule);
78
79require_course_login($course, true, $cm);
80
667e5fd9
RW
81$istypesingle = $forum->get_type() === 'single';
82$saveddisplaymode = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
15ecfac4
RW
83
84if ($mode) {
667e5fd9
RW
85 $displaymode = $mode;
86} else {
87 $displaymode = $saveddisplaymode;
15ecfac4
RW
88}
89
667e5fd9
RW
90if (get_user_preferences('forum_useexperimentalui', false)) {
91 if ($displaymode == FORUM_MODE_NESTED) {
92 $displaymode = FORUM_MODE_NESTED_V2;
93 }
94} else {
95 if ($displaymode == FORUM_MODE_NESTED_V2) {
96 $displaymode = FORUM_MODE_NESTED;
97 }
98}
99
100if ($displaymode != $saveddisplaymode) {
101 set_user_preference('forum_displaymode', $displaymode);
102}
15ecfac4 103
54d38a73
MG
104$PAGE->set_context($forum->get_context());
105$PAGE->set_title($forum->get_name());
7a2d4f54 106$PAGE->add_body_class('forumtype-' . $forum->get_type());
54d38a73 107$PAGE->set_heading($course->fullname);
2667acf1 108$PAGE->set_button(forum_search_form($course, $search));
1d709d76 109
2602c7bf 110if ($istypesingle && $displaymode == FORUM_MODE_NESTED_V2) {
9f2a68fe 111 $PAGE->add_body_class('nested-v2-display-mode reset-style');
667e5fd9
RW
112 $settingstrigger = $OUTPUT->render_from_template('mod_forum/settings_drawer_trigger', null);
113 $PAGE->add_header_action($settingstrigger);
15ecfac4
RW
114}
115
bda290ee 116if (empty($cm->visible) && !has_capability('moodle/course:viewhiddenactivities', $forum->get_context())) {
54d38a73
MG
117 redirect(
118 $urlfactory->get_course_url_from_forum($forum),
119 get_string('activityiscurrentlyhidden'),
7aa6affa 120 null,
54d38a73
MG
121 \core\output\notification::NOTIFY_WARNING
122 );
123}
124
7aa6affa 125if (!$capabilitymanager->can_view_discussions($USER)) {
54d38a73
MG
126 redirect(
127 $urlfactory->get_course_url_from_forum($forum),
2ddbc651 128 get_string('noviewdiscussionspermission', 'forum'),
7aa6affa 129 null,
54d38a73
MG
130 \core\output\notification::NOTIFY_WARNING
131 );
132}
133
134// Mark viewed and trigger the course_module_viewed event.
135$forumdatamapper = $legacydatamapperfactory->get_forum_data_mapper();
e5a501de 136$forumrecord = $forumdatamapper->to_legacy_object($forum);
54d38a73 137forum_view(
e5a501de 138 $forumrecord,
54d38a73
MG
139 $forum->get_course_record(),
140 $forum->get_course_module_record(),
141 $forum->get_context()
142);
143
bda290ee
RW
144// Return here if we post or set subscription etc.
145$SESSION->fromdiscussion = qualified_me();
146
54d38a73
MG
147if (!empty($CFG->enablerssfeeds) && !empty($CFG->forum_enablerssfeeds) && $forum->get_rss_type() && $forum->get_rss_articles()) {
148 require_once("{$CFG->libdir}/rsslib.php");
149
150 $rsstitle = format_string($course->shortname, true, [
151 'context' => context_course::instance($course->id),
152 ]) . ': ' . format_string($forum->get_name());
e5a501de 153 rss_add_http_header($forum->get_context(), 'mod_forum', $forumrecord, $rsstitle);
54d38a73
MG
154}
155
156echo $OUTPUT->header();
157echo $OUTPUT->heading(format_string($forum->get_name()), 2);
158
15ecfac4 159if (!$istypesingle && !empty($forum->get_intro())) {
54d38a73
MG
160 echo $OUTPUT->box(format_module_intro('forum', $forumrecord, $cm->id), 'generalbox', 'intro');
161}
162
1a9c60e9
MG
163if ($sortorder) {
164 set_user_preference('forum_discussionlistsortorder', $sortorder);
165}
166
167$sortorder = get_user_preferences('forum_discussionlistsortorder', $discussionlistvault::SORTORDER_LASTPOST_DESC);
168
54d38a73
MG
169// Fetch the current groupid.
170$groupid = groups_get_activity_group($cm, true) ?: null;
171$rendererfactory = mod_forum\local\container::get_renderer_factory();
172switch ($forum->get_type()) {
173 case 'single':
07d8669d 174 $forumgradeitem = forum_gradeitem::load_from_forum_entity($forum);
2667acf1 175 if ($capabilitymanager->can_grade($USER)) {
07d8669d 176
2667acf1
RW
177 if ($forumgradeitem->is_grading_enabled()) {
178 $groupid = groups_get_activity_group($cm, true) ?: null;
179 $gradeobj = (object) [
180 'contextid' => $forum->get_context()->id,
181 'cmid' => $cmid,
df9eefac 182 'name' => format_string($forum->get_name()),
2667acf1 183 'courseid' => $course->id,
df9eefac 184 'coursename' => format_string($course->shortname),
2667acf1
RW
185 'experimentaldisplaymode' => $displaymode == FORUM_MODE_NESTED_V2,
186 'groupid' => $groupid,
187 'gradingcomponent' => $forumgradeitem->get_grading_component_name(),
188 'gradingcomponentsubtype' => $forumgradeitem->get_grading_component_subtype(),
c2dc453f 189 'sendstudentnotifications' => $forum->should_notify_students_default_when_grade_for_forum(),
2667acf1
RW
190 ];
191 echo $OUTPUT->render_from_template('mod_forum/grades/grade_button', $gradeobj);
192 }
07d8669d
MM
193 } else {
194 if ($forumgradeitem->is_grading_enabled()) {
195 $groupid = groups_get_activity_group($cm, true) ?: null;
196 $gradeobj = (object) [
197 'contextid' => $forum->get_context()->id,
198 'cmid' => $cmid,
df9eefac 199 'name' => format_string($forum->get_name()),
07d8669d 200 'courseid' => $course->id,
df9eefac 201 'coursename' => format_string($course->shortname),
07d8669d
MM
202 'groupid' => $groupid,
203 'userid' => $USER->id,
204 'gradingcomponent' => $forumgradeitem->get_grading_component_name(),
205 'gradingcomponentsubtype' => $forumgradeitem->get_grading_component_subtype(),
206 ];
974db580 207 echo $OUTPUT->render_from_template('mod_forum/grades/view_grade_button', $gradeobj);
07d8669d 208 }
2667acf1 209 }
54d38a73
MG
210 $discussion = $discussionvault->get_last_discussion_in_forum($forum);
211 $discussioncount = $discussionvault->get_count_discussions_in_forum($forum);
1a9c60e9 212 $hasmultiplediscussions = $discussioncount > 1;
54d38a73
MG
213 $discussionsrenderer = $rendererfactory->get_single_discussion_list_renderer($forum, $discussion,
214 $hasmultiplediscussions, $displaymode);
215 $post = $postvault->get_from_id($discussion->get_first_post_id());
216 $orderpostsby = $displaymode == FORUM_MODE_FLATNEWEST ? 'created DESC' : 'created ASC';
bc4c7337
AN
217 $replies = $postvault->get_replies_to_post(
218 $USER,
219 $post,
220 $capabilitymanager->can_view_any_private_reply($USER),
221 $orderpostsby
222 );
54d38a73 223 echo $discussionsrenderer->render($USER, $post, $replies);
be1400c6
SR
224
225 if (!$CFG->forum_usermarksread && forum_tp_is_tracked($forumrecord, $USER)) {
226 $postids = array_map(function($post) {
227 return $post->get_id();
228 }, array_merge([$post], array_values($replies)));
229 forum_tp_mark_posts_read($USER, $postids);
230 }
54d38a73
MG
231 break;
232 case 'blog':
233 $discussionsrenderer = $rendererfactory->get_blog_discussion_list_renderer($forum);
94552394 234 // Blog forums always show discussions newest first.
1a9c60e9
MG
235 echo $discussionsrenderer->render($USER, $cm, $groupid, $discussionlistvault::SORTORDER_CREATED_DESC,
236 $pageno, $pagesize);
be1400c6
SR
237
238 if (!$CFG->forum_usermarksread && forum_tp_is_tracked($forumrecord, $USER)) {
239 $discussions = mod_forum_get_discussion_summaries($forum, $USER, $groupid, null, $pageno, $pagesize);
240 $firstpostids = array_map(function($discussion) {
241 return $discussion->get_first_post()->get_id();
242 }, array_values($discussions));
243 forum_tp_mark_posts_read($USER, $firstpostids);
244 }
54d38a73
MG
245 break;
246 default:
247 $discussionsrenderer = $rendererfactory->get_discussion_list_renderer($forum);
2667acf1 248 echo $discussionsrenderer->render($USER, $cm, $groupid, $sortorder, $pageno, $pagesize, $displaymode);
54d38a73
MG
249}
250
251echo $OUTPUT->footer();