Merge branch 'MDL-66900-39' of https://github.com/paulholden/moodle into MOODLE_39_STABLE
[moodle.git] / mod / forum / classes / local / renderers / discussion.php
1 <?php
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/>.
17 /**
18  * Discussion renderer.
19  *
20  * @package    mod_forum
21  * @copyright  2019 Ryan Wyllie <ryan@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 namespace mod_forum\local\renderers;
27 defined('MOODLE_INTERNAL') || die();
29 use mod_forum\local\entities\discussion as discussion_entity;
30 use mod_forum\local\entities\forum as forum_entity;
31 use mod_forum\local\entities\post as post_entity;
32 use mod_forum\local\entities\sorter as sorter_entity;
33 use mod_forum\local\factories\entity as entity_factory;
34 use mod_forum\local\factories\legacy_data_mapper as legacy_data_mapper_factory;
35 use mod_forum\local\factories\exporter as exporter_factory;
36 use mod_forum\local\factories\url as url_factory;
37 use mod_forum\local\factories\vault as vault_factory;
38 use mod_forum\local\managers\capability as capability_manager;
39 use mod_forum\local\renderers\posts as posts_renderer;
40 use core\output\notification;
41 use context;
42 use context_module;
43 use html_writer;
44 use moodle_exception;
45 use moodle_page;
46 use moodle_url;
47 use rating_manager;
48 use renderer_base;
49 use single_button;
50 use single_select;
51 use stdClass;
52 use url_select;
54 require_once($CFG->dirroot . '/mod/forum/lib.php');
56 /**
57  * Discussion renderer class.
58  *
59  * @copyright  2019 Ryan Wyllie <ryan@moodle.com>
60  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
61  */
62 class discussion {
63     /** @var forum_entity $forum The forum that the discussion belongs to */
64     private $forum;
65     /** @var discussion_entity $discussion The discussion entity */
66     private $discussion;
67     /** @var stdClass $discussionrecord Legacy discussion record */
68     private $discussionrecord;
69     /** @var stdClass $forumrecord Legacy forum record */
70     private $forumrecord;
71     /** @var int $displaymode The display mode to render the discussion in */
72     private $displaymode;
73     /** @var renderer_base $renderer Renderer base */
74     private $renderer;
75     /** @var posts_renderer $postsrenderer A posts renderer */
76     private $postsrenderer;
77     /** @var moodle_page $page The page this discussion is being rendered for */
78     private $page;
79     /** @var legacy_data_mapper_factory $legacydatamapperfactory Legacy data mapper factory */
80     private $legacydatamapperfactory;
81     /** @var exporter_factory $exporterfactory Exporter factory */
82     private $exporterfactory;
83     /** @var vault_factory $vaultfactory Vault factory */
84     private $vaultfactory;
85     /** @var url_factory $urlfactory URL factory */
86     private $urlfactory;
87     /** @var entity_factory $entityfactory Entity factory */
88     private $entityfactory;
89     /** @var capability_manager $capabilitymanager Capability manager */
90     private $capabilitymanager;
91     /** @var rating_manager $ratingmanager Rating manager */
92     private $ratingmanager;
93     /** @var moodle_url $baseurl The base URL for the discussion */
94     private $baseurl;
95     /** @var array $notifications List of HTML notifications to display */
96     private $notifications;
97     /** @var sorter_entity $exportedpostsorter Sorter for the exported posts */
98     private $exportedpostsorter;
99     /** @var callable $postprocessfortemplate Function to process exported posts before template rendering */
100     private $postprocessfortemplate;
102     /**
103      * Constructor.
104      *
105      * @param forum_entity $forum The forum that the discussion belongs to
106      * @param discussion_entity $discussion The discussion entity
107      * @param int $displaymode The display mode to render the discussion in
108      * @param renderer_base $renderer Renderer base
109      * @param posts_renderer $postsrenderer A posts renderer
110      * @param moodle_page $page The page this discussion is being rendered for
111      * @param legacy_data_mapper_factory $legacydatamapperfactory Legacy data mapper factory
112      * @param exporter_factory $exporterfactory Exporter factory
113      * @param vault_factory $vaultfactory Vault factory
114      * @param url_factory $urlfactory URL factory
115      * @param entity_factory $entityfactory Entity factory
116      * @param capability_manager $capabilitymanager Capability manager
117      * @param rating_manager $ratingmanager Rating manager
118      * @param sorter_entity $exportedpostsorter Sorter for the exported posts
119      * @param moodle_url $baseurl The base URL for the discussion
120      * @param array $notifications List of HTML notifications to display
121      * @param callable|null $postprocessfortemplate Post processing for template callback
122      */
123     public function __construct(
124         forum_entity $forum,
125         discussion_entity $discussion,
126         int $displaymode,
127         renderer_base $renderer,
128         posts_renderer $postsrenderer,
129         moodle_page $page,
130         legacy_data_mapper_factory $legacydatamapperfactory,
131         exporter_factory $exporterfactory,
132         vault_factory $vaultfactory,
133         url_factory $urlfactory,
134         entity_factory $entityfactory,
135         capability_manager $capabilitymanager,
136         rating_manager $ratingmanager,
137         sorter_entity $exportedpostsorter,
138         moodle_url $baseurl,
139         array $notifications = [],
140         callable $postprocessfortemplate = null
141     ) {
142         $this->forum = $forum;
143         $this->discussion = $discussion;
144         $this->displaymode = $displaymode;
145         $this->renderer = $renderer;
146         $this->postsrenderer = $postsrenderer;
147         $this->page = $page;
148         $this->baseurl = $baseurl;
149         $this->legacydatamapperfactory = $legacydatamapperfactory;
150         $this->exporterfactory = $exporterfactory;
151         $this->vaultfactory = $vaultfactory;
152         $this->urlfactory = $urlfactory;
153         $this->entityfactory = $entityfactory;
154         $this->capabilitymanager = $capabilitymanager;
155         $this->ratingmanager = $ratingmanager;
156         $this->notifications = $notifications;
158         $this->exportedpostsorter = $exportedpostsorter;
159         $this->postprocessfortemplate = $postprocessfortemplate;
161         $forumdatamapper = $this->legacydatamapperfactory->get_forum_data_mapper();
162         $this->forumrecord = $forumdatamapper->to_legacy_object($forum);
164         $discussiondatamapper = $this->legacydatamapperfactory->get_discussion_data_mapper();
165         $this->discussionrecord = $discussiondatamapper->to_legacy_object($discussion);
166     }
168     /**
169      * Render the discussion for the given user in the specified display mode.
170      *
171      * @param stdClass $user The user viewing the discussion
172      * @param post_entity $firstpost The first post in the discussion
173      * @param array $replies List of replies to the first post
174      * @return string HTML for the discussion
175      */
176     public function render(
177         stdClass $user,
178         post_entity $firstpost,
179         array $replies
180     ) : string {
181         global $CFG;
183         $displaymode = $this->displaymode;
184         $capabilitymanager = $this->capabilitymanager;
185         $urlfactory = $this->urlfactory;
186         $entityfactory = $this->entityfactory;
188         // Make sure we can render.
189         if (!$capabilitymanager->can_view_discussions($user)) {
190             throw new moodle_exception('noviewdiscussionspermission', 'mod_forum');
191         }
193         $posts = array_merge([$firstpost], array_values($replies));
195         if ($this->postprocessfortemplate !== null) {
196             $exporteddiscussion = ($this->postprocessfortemplate) ($this->discussion, $user, $this->forum);
197         } else {
198             $exporteddiscussion = $this->get_exported_discussion($user);
199         }
201         $hasanyactions = false;
202         $hasanyactions = $hasanyactions || $capabilitymanager->can_favourite_discussion($user);
203         $hasanyactions = $hasanyactions || $capabilitymanager->can_pin_discussions($user);
204         $hasanyactions = $hasanyactions || $capabilitymanager->can_manage_forum($user);
206         $exporteddiscussion = array_merge($exporteddiscussion, [
207             'notifications' => $this->get_notifications($user),
208             'html' => [
209                 'hasanyactions' => $hasanyactions,
210                 'posts' => $this->postsrenderer->render($user, [$this->forum], [$this->discussion], $posts),
211                 'modeselectorform' => $this->get_display_mode_selector_html($displaymode, $user),
212                 'subscribe' => null,
213                 'movediscussion' => null,
214                 'pindiscussion' => null,
215                 'neighbourlinks' => $this->get_neighbour_links_html(),
216                 'exportdiscussion' => !empty($CFG->enableportfolios) ? $this->get_export_discussion_html() : null
217             ]
218         ]);
220         $capabilities = (array) $exporteddiscussion['capabilities'];
222         if ($capabilities['move']) {
223             $exporteddiscussion['html']['movediscussion'] = $this->get_move_discussion_html();
224         }
226         if (!empty($user->id)) {
227             $loggedinuser = $entityfactory->get_author_from_stdClass($user);
228             $exporteddiscussion['loggedinuser'] = [
229                 'firstname' => $loggedinuser->get_first_name(),
230                 'fullname' => $loggedinuser->get_full_name(),
231                 'profileimageurl' => ($urlfactory->get_author_profile_image_url($loggedinuser, null))->out(false)
232             ];
233         }
235         if ($this->displaymode === FORUM_MODE_NESTED_V2) {
236             $template = 'mod_forum/forum_discussion_nested_v2';
237         } else {
238             $template = 'mod_forum/forum_discussion';
239         }
241         return $this->renderer->render_from_template($template, $exporteddiscussion);
242     }
244     /**
245      * Get the groups details for all groups available to the forum.
246      *
247      * @return  stdClass[]
248      */
249     private function get_groups_available_in_forum() : array {
250         $course = $this->forum->get_course_record();
251         $coursemodule = $this->forum->get_course_module_record();
253         return groups_get_all_groups($course->id, 0, $coursemodule->groupingid);
254     }
256     /**
257      * Get the exported discussion.
258      *
259      * @param stdClass $user The user viewing the discussion
260      * @return array
261      */
262     private function get_exported_discussion(stdClass $user) : array {
263         $discussionexporter = $this->exporterfactory->get_discussion_exporter(
264             $user,
265             $this->forum,
266             $this->discussion,
267             $this->get_groups_available_in_forum()
268         );
270         return (array) $discussionexporter->export($this->renderer);
271     }
273     /**
274      * Get the HTML for the display mode selector.
275      *
276      * @param int $displaymode The current display mode
277      * @param stdClass $user The current user
278      * @return string
279      */
280     private function get_display_mode_selector_html(int $displaymode, stdClass $user) : string {
281         $baseurl = $this->baseurl;
282         $select = new single_select(
283             $baseurl,
284             'mode',
285             forum_get_layout_modes(get_user_preferences('forum_useexperimentalui', false, $user)),
286             $displaymode,
287             null,
288             'mode'
289         );
290         $select->set_label(get_string('displaymode', 'forum'), ['class' => 'accesshide']);
292         return $this->renderer->render($select);
293     }
295     /**
296      * Get the HTML to render the move discussion selector and button.
297      *
298      * @return string
299      */
300     private function get_move_discussion_html() : ?string {
301         global $DB;
303         $forum = $this->forum;
304         $discussion = $this->discussion;
305         $courseid = $forum->get_course_id();
307         // Popup menu to move discussions to other forums. The discussion in a
308         // single discussion forum can't be moved.
309         $modinfo = get_fast_modinfo($courseid);
310         if (isset($modinfo->instances['forum'])) {
311             $forummenu = [];
312             // Check forum types and eliminate simple discussions.
313             $forumcheck = $DB->get_records('forum', ['course' => $courseid], '', 'id, type');
314             foreach ($modinfo->instances['forum'] as $forumcm) {
315                 if (!$forumcm->uservisible || !has_capability('mod/forum:startdiscussion',
316                     context_module::instance($forumcm->id))) {
317                     continue;
318                 }
319                 $section = $forumcm->sectionnum;
320                 $sectionname = get_section_name($courseid, $section);
321                 if (empty($forummenu[$section])) {
322                     $forummenu[$section] = [$sectionname => []];
323                 }
324                 $forumidcompare = $forumcm->instance != $forum->get_id();
325                 $forumtypecheck = $forumcheck[$forumcm->instance]->type !== 'single';
327                 if ($forumidcompare and $forumtypecheck) {
328                     $url = "/mod/forum/discuss.php?d={$discussion->get_id()}&move=$forumcm->instance&sesskey=".sesskey();
329                     $forummenu[$section][$sectionname][$url] = format_string($forumcm->name);
330                 }
331             }
332             if (!empty($forummenu)) {
333                 $html = '<div class="movediscussionoption">';
335                 $movebutton = get_string('move');
336                 if ($this->displaymode === FORUM_MODE_NESTED_V2) {
337                     // Move discussion selector will be rendered on the settings drawer. We won't output the button in this mode.
338                     $movebutton = null;
339                 }
340                 $select = new url_select($forummenu, '',
341                         ['/mod/forum/discuss.php?d=' . $discussion->get_id() => get_string("movethisdiscussionto", "forum")],
342                         'forummenu', $movebutton);
343                 $select->set_label(get_string('movethisdiscussionlabel', 'mod_forum'), [
344                     'class' => 'sr-only',
345                 ]);
346                 $html .= $this->renderer->render($select);
347                 $html .= "</div>";
348                 return $html;
349             }
350         }
352         return null;
353     }
355     /**
356      * Get the HTML to render the export discussion button.
357      *
358      * @return string|null
359      */
360     private function get_export_discussion_html() : ?string {
361         global $CFG;
363         require_once($CFG->libdir . '/portfoliolib.php');
364         $discussion = $this->discussion;
365         $button = new \portfolio_add_button();
366         $button->set_callback_options('forum_portfolio_caller', ['discussionid' => $discussion->get_id()], 'mod_forum');
367         $button = $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportdiscussion', 'mod_forum'));
368         return $button ?: null;
369     }
371     /**
372      * Get a list of notification HTML to render in the page.
373      *
374      * @param stdClass $user The user viewing the discussion
375      * @return string[]
376      */
377     private function get_notifications($user) : array {
378         $notifications = $this->notifications;
379         $discussion = $this->discussion;
380         $forum = $this->forum;
381         $renderer = $this->renderer;
383         if ($forum->is_cutoff_date_reached()) {
384             $notifications[] = (new notification(
385                     get_string('cutoffdatereached', 'forum'),
386                     notification::NOTIFY_INFO
387             ))->set_show_closebutton();
388         } else if ($forum->is_due_date_reached()) {
389             $notifications[] = (new notification(
390                     get_string('thisforumisdue', 'forum', userdate($forum->get_due_date())),
391                     notification::NOTIFY_INFO
392             ))->set_show_closebutton();
393         } else if ($forum->has_due_date()) {
394             $notifications[] = (new notification(
395                     get_string('thisforumhasduedate', 'forum', userdate($forum->get_due_date())),
396                     notification::NOTIFY_INFO
397             ))->set_show_closebutton();
398         }
400         if ($forum->is_discussion_locked($discussion)) {
401             $notifications[] = (new notification(
402                 get_string('discussionlocked', 'forum'),
403                 notification::NOTIFY_INFO
404             ))
405             ->set_extra_classes(['discussionlocked'])
406             ->set_show_closebutton();
407         }
409         if ($forum->get_type() == 'qanda') {
410             if ($this->capabilitymanager->must_post_before_viewing_discussion($user, $discussion)) {
411                 $notifications[] = (new notification(
412                     get_string('qandanotify', 'forum')
413                 ))->set_show_closebutton(true);
414             }
415         }
417         if ($forum->has_blocking_enabled()) {
418             $notifications[] = (new notification(
419                 get_string('thisforumisthrottled', 'forum', [
420                     'blockafter' => $forum->get_block_after(),
421                     'blockperiod' => get_string('secondstotime' . $forum->get_block_period())
422                 ])
423             ))->set_show_closebutton();
424         }
426         return array_map(function($notification) {
427             return $notification->export_for_template($this->renderer);
428         }, $notifications);
429     }
431     /**
432      * Get HTML to display the neighbour links.
433      *
434      * @return string
435      */
436     private function get_neighbour_links_html() : string {
437         $forum = $this->forum;
438         $coursemodule = $forum->get_course_module_record();
439         $neighbours = forum_get_discussion_neighbours($coursemodule, $this->discussionrecord, $this->forumrecord);
440         return $this->renderer->neighbouring_discussion_navigation($neighbours['prev'], $neighbours['next']);
441     }