MDL-65786 mod_forum: re-adding the unread count to the social format
[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
54d38a73
MG
25require_once('../../config.php');
26
27$managerfactory = mod_forum\local\container::get_manager_factory();
28$legacydatamapperfactory = mod_forum\local\container::get_legacy_data_mapper_factory();
29$vaultfactory = mod_forum\local\container::get_vault_factory();
30$forumvault = $vaultfactory->get_forum_vault();
31$discussionvault = $vaultfactory->get_discussion_vault();
32$postvault = $vaultfactory->get_post_vault();
1a9c60e9 33$discussionlistvault = $vaultfactory->get_discussions_in_forum_vault();
54d38a73 34
bda290ee
RW
35$cmid = optional_param('id', 0, PARAM_INT);
36$forumid = optional_param('f', 0, PARAM_INT);
f30f46db
RW
37$mode = optional_param('mode', 0, PARAM_INT);
38$showall = optional_param('showall', '', PARAM_INT);
39$pageno = optional_param('page', 0, PARAM_INT);
40$search = optional_param('search', '', PARAM_CLEAN);
41$pageno = optional_param('p', $pageno, PARAM_INT);
54d38a73
MG
42$pagesize = optional_param('s', 0, PARAM_INT);
43$sortorder = optional_param('o', null, PARAM_INT);
54d38a73 44
bda290ee
RW
45if (!$cmid && !$forumid) {
46 print_error('missingparameter');
47}
48
1bfaeeb2
AN
49if ($cmid) {
50 $forum = $forumvault->get_from_course_module_id($cmid);
51 if (empty($forum)) {
52 throw new \moodle_exception('Unable to find forum with cmid ' . $cmid);
53 }
54} else {
55 $forum = $forumvault->get_from_id($forumid);
56 if (empty($forum)) {
57 throw new \moodle_exception('Unable to find forum with id ' . $forumid);
58 }
54d38a73
MG
59}
60
f30f46db
RW
61if (!empty($showall)) {
62 // The user wants to see all discussions.
63 $pageno = 0;
64 $pagesize = 0;
65}
66
54d38a73
MG
67$urlfactory = mod_forum\local\container::get_url_factory();
68$capabilitymanager = $managerfactory->get_capability_manager($forum);
69
bda290ee 70$url = $urlfactory->get_forum_view_url_from_forum($forum);
54d38a73
MG
71$PAGE->set_url($url);
72
73$course = $forum->get_course_record();
74$coursemodule = $forum->get_course_module_record();
75$cm = \cm_info::create($coursemodule);
76
77require_course_login($course, true, $cm);
78
79$PAGE->set_context($forum->get_context());
80$PAGE->set_title($forum->get_name());
81$PAGE->add_body_class('forumtype-' . $forum->get_type());
82$PAGE->set_heading($course->fullname);
f30f46db 83$PAGE->set_button(forum_search_form($course, $search));
54d38a73 84
bda290ee 85if (empty($cm->visible) && !has_capability('moodle/course:viewhiddenactivities', $forum->get_context())) {
54d38a73
MG
86 redirect(
87 $urlfactory->get_course_url_from_forum($forum),
88 get_string('activityiscurrentlyhidden'),
7aa6affa 89 null,
54d38a73
MG
90 \core\output\notification::NOTIFY_WARNING
91 );
92}
93
7aa6affa 94if (!$capabilitymanager->can_view_discussions($USER)) {
54d38a73
MG
95 redirect(
96 $urlfactory->get_course_url_from_forum($forum),
97 get_string('noviewdiscussionspermission', 'fourm'),
7aa6affa 98 null,
54d38a73
MG
99 \core\output\notification::NOTIFY_WARNING
100 );
101}
102
103// Mark viewed and trigger the course_module_viewed event.
104$forumdatamapper = $legacydatamapperfactory->get_forum_data_mapper();
e5a501de 105$forumrecord = $forumdatamapper->to_legacy_object($forum);
54d38a73 106forum_view(
e5a501de 107 $forumrecord,
54d38a73
MG
108 $forum->get_course_record(),
109 $forum->get_course_module_record(),
110 $forum->get_context()
111);
112
bda290ee
RW
113// Return here if we post or set subscription etc.
114$SESSION->fromdiscussion = qualified_me();
115
54d38a73
MG
116if (!empty($CFG->enablerssfeeds) && !empty($CFG->forum_enablerssfeeds) && $forum->get_rss_type() && $forum->get_rss_articles()) {
117 require_once("{$CFG->libdir}/rsslib.php");
118
119 $rsstitle = format_string($course->shortname, true, [
120 'context' => context_course::instance($course->id),
121 ]) . ': ' . format_string($forum->get_name());
e5a501de 122 rss_add_http_header($forum->get_context(), 'mod_forum', $forumrecord, $rsstitle);
54d38a73
MG
123}
124
125echo $OUTPUT->header();
126echo $OUTPUT->heading(format_string($forum->get_name()), 2);
127
128if ('single' !== $forum->get_type() && !empty($forum->get_intro())) {
54d38a73
MG
129 echo $OUTPUT->box(format_module_intro('forum', $forumrecord, $cm->id), 'generalbox', 'intro');
130}
131
132if ($mode) {
133 set_user_preference('forum_displaymode', $mode);
134}
135
136$displaymode = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
137
1a9c60e9
MG
138if ($sortorder) {
139 set_user_preference('forum_discussionlistsortorder', $sortorder);
140}
141
142$sortorder = get_user_preferences('forum_discussionlistsortorder', $discussionlistvault::SORTORDER_LASTPOST_DESC);
143
54d38a73
MG
144// Fetch the current groupid.
145$groupid = groups_get_activity_group($cm, true) ?: null;
146$rendererfactory = mod_forum\local\container::get_renderer_factory();
147switch ($forum->get_type()) {
148 case 'single':
149 $discussion = $discussionvault->get_last_discussion_in_forum($forum);
150 $discussioncount = $discussionvault->get_count_discussions_in_forum($forum);
1a9c60e9 151 $hasmultiplediscussions = $discussioncount > 1;
54d38a73
MG
152 $discussionsrenderer = $rendererfactory->get_single_discussion_list_renderer($forum, $discussion,
153 $hasmultiplediscussions, $displaymode);
154 $post = $postvault->get_from_id($discussion->get_first_post_id());
155 $orderpostsby = $displaymode == FORUM_MODE_FLATNEWEST ? 'created DESC' : 'created ASC';
bc4c7337
AN
156 $replies = $postvault->get_replies_to_post(
157 $USER,
158 $post,
159 $capabilitymanager->can_view_any_private_reply($USER),
160 $orderpostsby
161 );
54d38a73
MG
162 echo $discussionsrenderer->render($USER, $post, $replies);
163 break;
164 case 'blog':
165 $discussionsrenderer = $rendererfactory->get_blog_discussion_list_renderer($forum);
94552394 166 // Blog forums always show discussions newest first.
1a9c60e9
MG
167 echo $discussionsrenderer->render($USER, $cm, $groupid, $discussionlistvault::SORTORDER_CREATED_DESC,
168 $pageno, $pagesize);
54d38a73
MG
169 break;
170 default:
171 $discussionsrenderer = $rendererfactory->get_discussion_list_renderer($forum);
172 echo $discussionsrenderer->render($USER, $cm, $groupid, $sortorder, $pageno, $pagesize);
173}
174
175echo $OUTPUT->footer();