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