MDL-64820 forum: convert discuss.php to new rendering

This commit is contained in:
Ryan Wyllie 2019-03-08 14:28:56 +08:00
parent 2646e9d6d2
commit 615680c5d8

View File

@ -40,42 +40,80 @@ if ($parent !== 0) {
}
$PAGE->set_url($url);
$discussion = $DB->get_record('forum_discussions', array('id' => $d), '*', MUST_EXIST);
$course = $DB->get_record('course', array('id' => $discussion->course), '*', MUST_EXIST);
$forum = $DB->get_record('forum', array('id' => $discussion->forum), '*', MUST_EXIST);
$cm = get_coursemodule_from_instance('forum', $forum->id, $course->id, false, MUST_EXIST);
$vaultfactory = mod_forum\local\container::get_vault_factory();
$discussionvault = $vaultfactory->get_discussion_vault();
$discussion = $discussionvault->get_from_id($d);
if (!$discussion) {
throw new \moodle_exception('Unable to find discussion with id ' . $discussionid);
}
$forumvault = $vaultfactory->get_forum_vault();
$forum = $forumvault->get_from_id($discussion->get_forum_id());
if (!$forum) {
throw new \moodle_exception('Unable to find forum with id ' . $discussion->get_forum_id());
}
$managerfactory = mod_forum\local\container::get_manager_factory();
$capabilitymanager = $managerfactory->get_capability_manager($forum);
$urlfactory = mod_forum\local\container::get_url_factory();
// Make sure we can render.
if (!$capabilitymanager->can_view_discussions($USER)) {
throw new moodle_exception('noviewdiscussionspermission', 'mod_forum');
}
$datamapperfactory = mod_forum\local\container::get_legacy_data_mapper_factory();
$forumdatamapper = $datamapperfactory->get_forum_data_mapper();
$forumrecord = $forumdatamapper->to_legacy_object($forum);
$discussiondatamapper = $datamapperfactory->get_discussion_data_mapper();
$discussionrecord = $discussiondatamapper->to_legacy_object($discussion);
$discussionviewurl = $urlfactory->get_discussion_view_url_from_discussion($discussion);
$course = $forum->get_course_record();
$cm = $forum->get_course_module_record();
require_course_login($course, true, $cm);
// move this down fix for MDL-6926
require_once($CFG->dirroot.'/mod/forum/lib.php');
require_once($CFG->dirroot . '/mod/forum/lib.php');
$modcontext = context_module::instance($cm->id);
require_capability('mod/forum:viewdiscussion', $modcontext, NULL, true, 'noviewdiscussionspermission', 'forum');
$modcontext = $forum->get_context();
if (!empty($CFG->enablerssfeeds) && !empty($CFG->forum_enablerssfeeds) && $forum->rsstype && $forum->rssarticles) {
if (
!empty($CFG->enablerssfeeds) &&
!empty($CFG->forum_enablerssfeeds) &&
$forum->get_rss_type() &&
$forum->get_rss_articles()
) {
require_once("$CFG->libdir/rsslib.php");
$rsstitle = format_string($course->shortname, true, array('context' => context_course::instance($course->id))) . ': ' . format_string($forum->name);
rss_add_http_header($modcontext, 'mod_forum', $forum, $rsstitle);
$rsstitle = format_string(
$course->shortname,
true,
['context' => context_course::instance($course->id)]
);
$rsstitle .= ': ' . format_string($forum->get_name());
rss_add_http_header($modcontext, 'mod_forum', $forumrecord, $rsstitle);
}
// Move discussion if requested.
if ($move > 0 and confirm_sesskey()) {
$return = $CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->id;
if ($move > 0 && confirm_sesskey()) {
$forumid = $forum->get_id();
$discussionid = $discussion->get_id();
$return = $discussionviewurl->out(false);
if (!$forumto = $DB->get_record('forum', array('id' => $move))) {
if (!$forumto = $DB->get_record('forum', ['id' => $move])) {
print_error('cannotmovetonotexist', 'forum', $return);
}
require_capability('mod/forum:movediscussions', $modcontext);
if ($forum->type == 'single') {
print_error('cannotmovefromsingleforum', 'forum', $return);
}
if (!$forumto = $DB->get_record('forum', array('id' => $move))) {
print_error('cannotmovetonotexist', 'forum', $return);
if (!$capabilitymanager->can_move_discussions($USER)) {
if ($forum->get_type() == 'single') {
print_error('cannotmovefromsingleforum', 'forum', $return);
} else {
print_error('nopermissions', 'error', $return, get_capability_string('mod/forum:movediscussions'));
}
}
if ($forumto->type == 'single') {
@ -88,6 +126,7 @@ if ($move > 0 and confirm_sesskey()) {
if (!array_key_exists($forumto->id, $forums)) {
print_error('cannotmovetonotfound', 'forum', $return);
}
$cmto = $forums[$forumto->id];
if (!$cmto->uservisible) {
print_error('cannotmovenotvisible', 'forum', $return);
@ -96,13 +135,13 @@ if ($move > 0 and confirm_sesskey()) {
$destinationctx = context_module::instance($cmto->id);
require_capability('mod/forum:startdiscussion', $destinationctx);
if (!forum_move_attachments($discussion, $forum->id, $forumto->id)) {
if (!forum_move_attachments($discussionrecord, $forumid, $forumto->id)) {
echo $OUTPUT->notification("Errors occurred while moving attachment directories - check your file permissions");
}
// For each subscribed user in this forum and discussion, copy over per-discussion subscriptions if required.
$discussiongroup = $discussion->groupid == -1 ? 0 : $discussion->groupid;
$discussiongroup = $discussion->get_group_id() == -1 ? 0 : $discussion->get_group_id();
$potentialsubscribers = \mod_forum\subscriptions::fetch_subscribed_users(
$forum,
$forumrecord,
$discussiongroup,
$modcontext,
'u.id',
@ -113,14 +152,14 @@ if ($move > 0 and confirm_sesskey()) {
// Firstly for the forum being moved to.
\mod_forum\subscriptions::fill_subscription_cache($forumto->id);
// And also for the discussion being moved.
\mod_forum\subscriptions::fill_subscription_cache($forum->id);
$subscriptionchanges = array();
\mod_forum\subscriptions::fill_subscription_cache($forumid);
$subscriptionchanges = [];
$subscriptiontime = time();
foreach ($potentialsubscribers as $subuser) {
$userid = $subuser->id;
$targetsubscription = \mod_forum\subscriptions::is_subscribed($userid, $forumto, null, $cmto);
$discussionsubscribed = \mod_forum\subscriptions::is_subscribed($userid, $forum, $discussion->id);
$forumsubscribed = \mod_forum\subscriptions::is_subscribed($userid, $forum);
$discussionsubscribed = \mod_forum\subscriptions::is_subscribed($userid, $forumrecord, $discussionid);
$forumsubscribed = \mod_forum\subscriptions::is_subscribed($userid, $forumrecord);
if ($forumsubscribed && !$discussionsubscribed && $targetsubscription) {
// The user has opted out of this discussion and the move would cause them to receive notifications again.
@ -133,12 +172,12 @@ if ($move > 0 and confirm_sesskey()) {
}
}
$DB->set_field('forum_discussions', 'forum', $forumto->id, array('id' => $discussion->id));
$DB->set_field('forum_read', 'forumid', $forumto->id, array('discussionid' => $discussion->id));
$DB->set_field('forum_discussions', 'forum', $forumto->id, ['id' => $discussionid]);
$DB->set_field('forum_read', 'forumid', $forumto->id, ['discussionid' => $discussionid]);
// Delete the existing per-discussion subscriptions and replace them with the newly calculated ones.
$DB->delete_records('forum_discussion_subs', array('discussion' => $discussion->id));
$newdiscussion = clone $discussion;
$DB->delete_records('forum_discussion_subs', ['discussion' => $discussionid]);
$newdiscussion = clone $discussionrecord;
$newdiscussion->forum = $forumto->id;
foreach ($subscriptionchanges as $userid => $preference) {
if ($preference != \mod_forum\subscriptions::FORUM_DISCUSSION_UNSUBSCRIBED) {
@ -151,52 +190,54 @@ if ($move > 0 and confirm_sesskey()) {
}
}
$params = array(
$params = [
'context' => $destinationctx,
'objectid' => $discussion->id,
'other' => array(
'fromforumid' => $forum->id,
'objectid' => $discussionid,
'other' => [
'fromforumid' => $forumid,
'toforumid' => $forumto->id,
)
);
]
];
$event = \mod_forum\event\discussion_moved::create($params);
$event->add_record_snapshot('forum_discussions', $discussion);
$event->add_record_snapshot('forum', $forum);
$event->add_record_snapshot('forum_discussions', $discussionrecord);
$event->add_record_snapshot('forum', $forumrecord);
$event->add_record_snapshot('forum', $forumto);
$event->trigger();
// Delete the RSS files for the 2 forums to force regeneration of the feeds
require_once($CFG->dirroot.'/mod/forum/rsslib.php');
forum_rss_delete_file($forum);
require_once($CFG->dirroot . '/mod/forum/rsslib.php');
forum_rss_delete_file($forumrecord);
forum_rss_delete_file($forumto);
redirect($return.'&move=-1&sesskey='.sesskey());
redirect($return . '&move=-1&sesskey=' . sesskey());
}
// Pin or unpin discussion if requested.
if ($pin !== -1 && confirm_sesskey()) {
require_capability('mod/forum:pindiscussions', $modcontext);
if (!$capabilitymanager->can_pin_discussions($USER)) {
print_error('nopermissions', 'error', $return, get_capability_string('mod/forum:pindiscussions'));
}
$params = array('context' => $modcontext, 'objectid' => $discussion->id, 'other' => array('forumid' => $forum->id));
$params = ['context' => $modcontext, 'objectid' => $discussion->get_id(), 'other' => ['forumid' => $forum->get_id()]];
switch ($pin) {
case FORUM_DISCUSSION_PINNED:
// Pin the discussion and trigger discussion pinned event.
forum_discussion_pin($modcontext, $forum, $discussion);
forum_discussion_pin($modcontext, $forumrecord, $discussionrecord);
break;
case FORUM_DISCUSSION_UNPINNED:
// Unpin the discussion and trigger discussion unpinned event.
forum_discussion_unpin($modcontext, $forum, $discussion);
forum_discussion_unpin($modcontext, $forumrecord, $discussionrecord);
break;
default:
echo $OUTPUT->notification("Invalid value when attempting to pin/unpin discussion");
break;
}
redirect(new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id)));
redirect($discussionviewurl->out(false));
}
// Trigger discussion viewed event.
forum_discussion_view($modcontext, $forum, $discussion);
forum_discussion_view($modcontext, $forumrecord, $discussionrecord);
unset($SESSION->fromdiscussion);
@ -212,19 +253,21 @@ if ($parent) {
$displaymode = FORUM_MODE_NESTED;
}
} else {
$parent = $discussion->firstpost;
$parent = $discussion->get_first_post_id();
}
if (! $post = forum_get_post_full($parent)) {
print_error("notexists", 'forum', "$CFG->wwwroot/mod/forum/view.php?f=$forum->id");
$postvault = $vaultfactory->get_post_vault();
if (!$post = $postvault->get_from_id($parent)) {
print_error("notexists", 'forum', "$CFG->wwwroot/mod/forum/view.php?f={$forum->get_id()}");
}
if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm, false)) {
print_error('noviewdiscussionspermission', 'forum', "$CFG->wwwroot/mod/forum/view.php?id=$forum->id");
if (!$capabilitymanager->can_view_post($USER, $discussion, $post)) {
print_error('noviewdiscussionspermission', 'forum', "$CFG->wwwroot/mod/forum/view.php?id={$forum->get_id()}");
}
if ($mark == 'read' or $mark == 'unread') {
if ($CFG->forum_usermarksread && forum_tp_can_track_forums($forum) && forum_tp_is_tracked($forum)) {
$istracked = forum_tp_is_tracked($forumrecord, $USER);
if ($mark == 'read'|| $mark == 'unread') {
if ($CFG->forum_usermarksread && forum_tp_can_track_forums($forumrecord) && $istracked) {
if ($mark == 'read') {
forum_tp_add_read_record($USER->id, $postid);
} else {
@ -242,163 +285,36 @@ if (empty($forumnode)) {
} else {
$forumnode->make_active();
}
$node = $forumnode->add(format_string($discussion->name), new moodle_url('/mod/forum/discuss.php', array('d'=>$discussion->id)));
$node = $forumnode->add(format_string($discussion->get_name()), $discussionviewurl);
$node->display = false;
if ($node && $post->id != $discussion->firstpost) {
$node->add(format_string($post->subject), $PAGE->url);
if ($node && $post->get_id() != $discussion->get_first_post_id()) {
$node->add(format_string($post->get_subject()), $PAGE->url);
}
$PAGE->set_title("$course->shortname: ".format_string($discussion->name));
$PAGE->set_title("$course->shortname: " . format_string($discussion->get_name()));
$PAGE->set_heading($course->fullname);
$PAGE->set_button($searchform);
$renderer = $PAGE->get_renderer('mod_forum');
$PAGE->set_button(forum_search_form($course));
echo $OUTPUT->header();
echo $OUTPUT->heading(format_string($forum->get_name()), 2);
echo $OUTPUT->heading(format_string($discussion->get_name()), 3, 'discussionname');
echo $OUTPUT->heading(format_string($forum->name), 2);
echo $OUTPUT->heading(format_string($discussion->name), 3, 'discussionname');
// is_guest should be used here as this also checks whether the user is a guest in the current course.
// Guests and visitors cannot subscribe - only enrolled users.
if ((!is_guest($modcontext, $USER) && isloggedin()) && has_capability('mod/forum:viewdiscussion', $modcontext)) {
// Discussion subscription.
if (\mod_forum\subscriptions::is_subscribable($forum)) {
echo html_writer::div(
forum_get_discussion_subscription_icon($forum, $post->discussion, null, true),
'discussionsubscription'
);
echo forum_get_discussion_subscription_icon_preloaders();
}
}
/// Check to see if groups are being used in this forum
/// If so, make sure the current person is allowed to see this discussion
/// Also, if we know they should be able to reply, then explicitly set $canreply for performance reasons
$canreply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
if (!$canreply and $forum->type !== 'news') {
if (isguestuser() or !isloggedin()) {
$canreply = true;
}
if (!is_enrolled($modcontext) and !is_viewing($modcontext)) {
// allow guests and not-logged-in to see the link - they are prompted to log in after clicking the link
// normal users with temporary guest access see this link too, they are asked to enrol instead
$canreply = enrol_selfenrol_available($course->id);
}
}
// Output the links to neighbour discussions.
$neighbours = forum_get_discussion_neighbours($cm, $discussion, $forum);
$neighbourlinks = $renderer->neighbouring_discussion_navigation($neighbours['prev'], $neighbours['next']);
echo $neighbourlinks;
/// Print the controls across the top
echo '<div class="discussioncontrols clearfix"><div class="controlscontainer m-b-1">';
if (!empty($CFG->enableportfolios) && has_capability('mod/forum:exportdiscussion', $modcontext)) {
require_once($CFG->libdir.'/portfoliolib.php');
$button = new portfolio_add_button();
$button->set_callback_options('forum_portfolio_caller', array('discussionid' => $discussion->id), 'mod_forum');
$button = $button->to_html(PORTFOLIO_ADD_FULL_FORM, get_string('exportdiscussion', 'mod_forum'));
$buttonextraclass = '';
if (empty($button)) {
// no portfolio plugin available.
$button = '&nbsp;';
$buttonextraclass = ' noavailable';
}
echo html_writer::tag('div', $button, array('class' => 'discussioncontrol exporttoportfolio'.$buttonextraclass));
} else {
echo html_writer::tag('div', '&nbsp;', array('class'=>'discussioncontrol nullcontrol'));
}
// groups selector not needed here
echo '<div class="discussioncontrol displaymode">';
forum_print_mode_form($discussion->id, $displaymode);
echo "</div>";
if ($forum->type != 'single'
&& has_capability('mod/forum:movediscussions', $modcontext)) {
echo '<div class="discussioncontrol movediscussion">';
// Popup menu to move discussions to other forums. The discussion in a
// single discussion forum can't be moved.
$modinfo = get_fast_modinfo($course);
if (isset($modinfo->instances['forum'])) {
$forummenu = array();
// Check forum types and eliminate simple discussions.
$forumcheck = $DB->get_records('forum', array('course' => $course->id),'', 'id, type');
foreach ($modinfo->instances['forum'] as $forumcm) {
if (!$forumcm->uservisible || !has_capability('mod/forum:startdiscussion',
context_module::instance($forumcm->id))) {
continue;
}
$section = $forumcm->sectionnum;
$sectionname = get_section_name($course, $section);
if (empty($forummenu[$section])) {
$forummenu[$section] = array($sectionname => array());
}
$forumidcompare = $forumcm->instance != $forum->id;
$forumtypecheck = $forumcheck[$forumcm->instance]->type !== 'single';
if ($forumidcompare and $forumtypecheck) {
$url = "/mod/forum/discuss.php?d=$discussion->id&move=$forumcm->instance&sesskey=".sesskey();
$forummenu[$section][$sectionname][$url] = format_string($forumcm->name);
}
}
if (!empty($forummenu)) {
echo '<div class="movediscussionoption">';
$select = new url_select($forummenu, '',
array('/mod/forum/discuss.php?d=' . $discussion->id => get_string("movethisdiscussionto", "forum")),
'forummenu', get_string('move'));
echo $OUTPUT->render($select);
echo "</div>";
}
}
echo "</div>";
}
if (has_capability('mod/forum:pindiscussions', $modcontext)) {
if ($discussion->pinned == FORUM_DISCUSSION_PINNED) {
$pinlink = FORUM_DISCUSSION_UNPINNED;
$pintext = get_string('discussionunpin', 'forum');
} else {
$pinlink = FORUM_DISCUSSION_PINNED;
$pintext = get_string('discussionpin', 'forum');
}
$button = new single_button(new moodle_url('discuss.php', array('pin' => $pinlink, 'd' => $discussion->id)), $pintext, 'post');
echo html_writer::tag('div', $OUTPUT->render($button), array('class' => 'discussioncontrol pindiscussion'));
}
echo "</div></div>";
if (forum_discussion_is_locked($forum, $discussion)) {
echo $OUTPUT->notification(get_string('discussionlocked', 'forum'),
\core\output\notification::NOTIFY_INFO . ' discussionlocked');
}
if (!empty($forum->blockafter) && !empty($forum->blockperiod)) {
$a = new stdClass();
$a->blockafter = $forum->blockafter;
$a->blockperiod = get_string('secondstotime'.$forum->blockperiod);
echo $OUTPUT->notification(get_string('thisforumisthrottled','forum',$a));
}
if ($forum->type == 'qanda' && !has_capability('mod/forum:viewqandawithoutposting', $modcontext) &&
!forum_user_has_posted($forum->id,$discussion->id,$USER->id)) {
echo $OUTPUT->notification(get_string('qandanotify', 'forum'));
}
$rendererfactory = mod_forum\local\container::get_renderer_factory();
$discussionrenderer = $rendererfactory->get_discussion_renderer($forum, $discussion, $displaymode);
$orderpostsby = $displaymode == FORUM_MODE_FLATNEWEST ? 'created DESC' : 'created ASC';
$replies = $postvault->get_replies_to_post($post, $orderpostsby);
$postids = array_map(function($post) {
return $post->get_id();
}, array_merge([$post], array_values($replies)));
if ($move == -1 and confirm_sesskey()) {
echo $OUTPUT->notification(get_string('discussionmoved', 'forum', format_string($forum->name,true)), 'notifysuccess');
$forumname = format_string($forum->get_name(), true);
echo $OUTPUT->notification(get_string('discussionmoved', 'forum', $forumname), 'notifysuccess');
}
$canrate = has_capability('mod/forum:rate', $modcontext);
forum_print_discussion($course, $cm, $forum, $discussion, $post, $displaymode, $canreply, $canrate);
echo $neighbourlinks;
// Add the subscription toggle JS.
$PAGE->requires->yui_module('moodle-mod_forum-subscriptiontoggle', 'Y.M.mod_forum.subscriptiontoggle.init');
echo $discussionrenderer->render($USER, $post, $replies);
echo $OUTPUT->footer();
if ($istracked && !$CFG->forum_usermarksread) {
forum_tp_mark_posts_read($USER, $postids);
}