<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* This file is used to display and organise forum subscribers
*
* @package mod_forum
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
require_once("../../config.php");
require_once("lib.php");
$id = required_param('id',PARAM_INT); // forum
$group = optional_param('group',0,PARAM_INT); // change of group
$edit = optional_param('edit',-1,PARAM_BOOL); // Turn editing on and off
$url = new moodle_url('/mod/forum/subscribers.php', array('id'=>$id));
if ($group !== 0) {
$url->param('group', $group);
}
< if ($edit !== 0) {
< $url->param('edit', $edit);
>
> if ($edit === 1) {
> $url->param('edit', 'on');
> } else {
> $url->param('edit', 'off');
}
>
$PAGE->set_url($url);
$forum = $DB->get_record('forum', array('id'=>$id), '*', MUST_EXIST);
$course = $DB->get_record('course', array('id'=>$forum->course), '*', MUST_EXIST);
if (! $cm = get_coursemodule_from_instance('forum', $forum->id, $course->id)) {
$cm->id = 0;
}
require_login($course, false, $cm);
$context = context_module::instance($cm->id);
if (!has_capability('mod/forum:viewsubscribers', $context)) {
print_error('nopermissiontosubscribe', 'forum');
}
unset($SESSION->fromdiscussion);
$params = array(
'context' => $context,
'other' => array('forumid' => $forum->id),
);
$event = \mod_forum\event\subscribers_viewed::create($params);
$event->trigger();
$forumoutput = $PAGE->get_renderer('mod_forum');
$currentgroup = groups_get_activity_group($cm);
$options = array('forumid'=>$forum->id, 'currentgroup'=>$currentgroup, 'context'=>$context);
$existingselector = new mod_forum_existing_subscriber_selector('existingsubscribers', $options);
$subscriberselector = new mod_forum_potential_subscriber_selector('potentialsubscribers', $options);
$subscriberselector->set_existing_subscribers($existingselector->find_users(''));
if (data_submitted()) {
require_sesskey();
$subscribe = (bool)optional_param('subscribe', false, PARAM_RAW);
$unsubscribe = (bool)optional_param('unsubscribe', false, PARAM_RAW);
/** It has to be one or the other, not both or neither */
if (!($subscribe xor $unsubscribe)) {
print_error('invalidaction');
}
if ($subscribe) {
$users = $subscriberselector->get_selected_users();
foreach ($users as $user) {
if (!\mod_forum\subscriptions::subscribe_user($user->id, $forum)) {
print_error('cannotaddsubscriber', 'forum', '', $user->id);
}
}
} else if ($unsubscribe) {
$users = $existingselector->get_selected_users();
foreach ($users as $user) {
if (!\mod_forum\subscriptions::unsubscribe_user($user->id, $forum)) {
print_error('cannotremovesubscriber', 'forum', '', $user->id);
}
}
}
$subscriberselector->invalidate_selected_users();
$existingselector->invalidate_selected_users();
$subscriberselector->set_existing_subscribers($existingselector->find_users(''));
}
$strsubscribers = get_string("subscribers", "forum");
< $PAGE->navbar->add($strsubscribers);
> $PAGE->navbar->add($strsubscribers, $url);
$PAGE->set_title($strsubscribers);
$PAGE->set_heading($COURSE->fullname);
< if (has_capability('mod/forum:managesubscriptions', $context) && \mod_forum\subscriptions::is_forcesubscribed($forum) === false) {
< if ($edit != -1) {
< $USER->subscriptionsediting = $edit;
< }
< $updatesubscriptionsbutton = forum_update_subscriptions_button($course->id, $id);
< } else {
< $updatesubscriptionsbutton = '';
< unset($USER->subscriptionsediting);
< }
>
> // Activate the secondary nav tab.
> $PAGE->set_secondary_active_tab("forumsubscriptions");
>
> // Output starts from here.
> $actionbar = new \mod_forum\output\subscription_actionbar($id, $url, $forum, $edit);
> $PAGE->activityheader->disable();
echo $OUTPUT->header();
> if (!$PAGE->has_secondary_navigation()) {
echo $OUTPUT->heading(get_string('forum', 'forum').' '.$strsubscribers);
< if (!empty($updatesubscriptionsbutton)) {
< echo \html_writer::div($updatesubscriptionsbutton, 'float-right');
}
< if (empty($USER->subscriptionsediting)) {
> echo $forumoutput->subscription_actionbar($actionbar);
>
> if ($edit === 1 && !\mod_forum\subscriptions::is_forcesubscribed($forum)) {
> echo $OUTPUT->heading(get_string('managesubscriptionson', 'forum'), 2);
> echo $forumoutput->subscriber_selection_form($existingselector, $subscriberselector);
> } else {
$subscribers = \mod_forum\subscriptions::fetch_subscribed_users($forum, $currentgroup, $context);
if (\mod_forum\subscriptions::is_forcesubscribed($forum)) {
$subscribers = mod_forum_filter_hidden_users($cm, $context, $subscribers);
}
echo $forumoutput->subscriber_overview($subscribers, $forum, $course);
< } else {
< echo $forumoutput->subscriber_selection_form($existingselector, $subscriberselector);
< }
< if (!empty($updatesubscriptionsbutton)) {
< echo $updatesubscriptionsbutton;
}
>
echo $OUTPUT->footer();
/**
* Filters a list of users for whether they can see a given activity.
* If the course module is hidden (closed-eye icon), then only users who have
* the permission to view hidden activities will appear in the output list.
*
* @todo MDL-48625 This filtering should be handled in core libraries instead.
*
* @param stdClass $cm the course module record of the activity.
* @param context_module $context the activity context, to save re-fetching it.
* @param array $users the list of users to filter.
* @return array the filtered list of users.
*/
function mod_forum_filter_hidden_users(stdClass $cm, context_module $context, array $users) {
if ($cm->visible) {
return $users;
} else {
// Filter for users that can view hidden activities.
$filteredusers = array();
$hiddenviewers = get_users_by_capability($context, 'moodle/course:viewhiddenactivities');
foreach ($hiddenviewers as $hiddenviewer) {
if (array_key_exists($hiddenviewer->id, $users)) {
$filteredusers[$hiddenviewer->id] = $users[$hiddenviewer->id];
}
}
return $filteredusers;
}
}