user/index.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/>.
  16
  17 /**
  18  * Lists all the users within a given course.
  19  *
  20  * @copyright 1999 Martin Dougiamas  http://dougiamas.com
  21  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22  * @package core_user
  23  */
  24
  25 require_once('../config.php');
  26 require_once($CFG->dirroot.'/user/lib.php');
  27 require_once($CFG->dirroot.'/course/lib.php');
  28 require_once($CFG->dirroot.'/notes/lib.php');
  29 require_once($CFG->libdir.'/tablelib.php');
  30 require_once($CFG->libdir.'/filelib.php');
  31 require_once($CFG->dirroot.'/enrol/locallib.php');
  32
  33 use core_table\local\filter\filter;
  34 use core_table\local\filter\integer_filter;
  35 use core_table\local\filter\string_filter;
  36
  37 define('DEFAULT_PAGE_SIZE', 20);
  38
  39 $page         = optional_param('page', 0, PARAM_INT); // Which page to show.
  40 $perpage      = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT); // How many per page.
  41 $contextid    = optional_param('contextid', 0, PARAM_INT); // One of this or.
  42 $courseid     = optional_param('id', 0, PARAM_INT); // This are required.
  43 $newcourse    = optional_param('newcourse', false, PARAM_BOOL);
  44 $roleid       = optional_param('roleid', 0, PARAM_INT);
  45 $urlgroupid   = optional_param('group', 0, PARAM_INT);
  46
  47 $PAGE->set_url('/user/index.php', array(
  48         'page' => $page,
  49         'perpage' => $perpage,
  50         'contextid' => $contextid,
  51         'id' => $courseid,
  52         'newcourse' => $newcourse));
  53
  54 if ($contextid) {
  55     $context = context::instance_by_id($contextid, MUST_EXIST);
  56     if ($context->contextlevel != CONTEXT_COURSE) {
  57         print_error('invalidcontext');
  58     }
  59     $course = $DB->get_record('course', array('id' => $context->instanceid), '*', MUST_EXIST);
  60 } else {
  61     $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
  62     $context = context_course::instance($course->id, MUST_EXIST);
  63 }
  64 // Not needed anymore.
  65 unset($contextid);
  66 unset($courseid);
  67
  68 require_login($course);
  69
  70 $systemcontext = context_system::instance();
  71 $isfrontpage = ($course->id == SITEID);
  72
  73 $frontpagectx = context_course::instance(SITEID);
  74
  75 if ($isfrontpage) {
  76     $PAGE->set_pagelayout('admin');
  77     course_require_view_participants($systemcontext);
  78 } else {
  79     $PAGE->set_pagelayout('incourse');
  80     course_require_view_participants($context);
  81 }
  82
  83 // Trigger events.
  84 user_list_view($course, $context);
  85
  86 $bulkoperations = has_capability('moodle/course:bulkmessaging', $context);
  87
  88 $PAGE->set_title("$course->shortname: ".get_string('participants'));
  89 $PAGE->set_heading($course->fullname);
  90 $PAGE->set_pagetype('course-view-participants');
  91 $PAGE->set_docs_path('enrol/users');
  92 $PAGE->add_body_class('path-user');                     // So we can style it independently.
  93 $PAGE->set_other_editing_capability('moodle/course:manageactivities');
  94
  95 // Expand the users node in the settings navigation when it exists because those pages
  96 // are related to this one.
  97 $node = $PAGE->settingsnav->find('users', navigation_node::TYPE_CONTAINER);
  98 if ($node) {
  99     $node->force_open();
 100 }
 101
 102 echo $OUTPUT->header();
 103
 104 $participanttable = new \core_user\table\participants("user-index-participants-{$course->id}");
 105
 106 // Manage enrolments.
 107 $manager = new course_enrolment_manager($PAGE, $course);
 108 $enrolbuttons = $manager->get_manual_enrol_buttons();
 109 $enrolrenderer = $PAGE->get_renderer('core_enrol');
 110 $enrolbuttonsout = '';
 111 foreach ($enrolbuttons as $enrolbutton) {
 112     $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
 113 }
 114
 115 echo $OUTPUT->render_participants_tertiary_nav($course, html_writer::div($enrolbuttonsout, '', [
 116     'data-region' => 'wrapper',
 117     'data-table-uniqueid' => $participanttable->uniqueid,
 118 ]));
 119
 120 echo $OUTPUT->heading(get_string('enrolledusers', 'enrol'));
 121
 122 $filterset = new \core_user\table\participants_filterset();
 123 $filterset->add_filter(new integer_filter('courseid', filter::JOINTYPE_DEFAULT, [(int)$course->id]));
 124
 125 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
 126 $filtergroupids = $urlgroupid ? [$urlgroupid] : [];
 127
 128 // Force group filtering if user should only see a subset of groups' users.
 129 if ($course->groupmode != NOGROUPS && !$canaccessallgroups) {
 130     if ($filtergroupids) {
 131         $filtergroupids = array_intersect(
 132             $filtergroupids,
 133             array_keys(groups_get_all_groups($course->id, $USER->id))
 134         );
 135     } else {
 136         $filtergroupids = array_keys(groups_get_all_groups($course->id, $USER->id));
 137     }
 138
 139     if (empty($filtergroupids)) {
 140         if ($course->groupmode == SEPARATEGROUPS) {
 141             // The user is not in a group so show message and exit.
 142             echo $OUTPUT->notification(get_string('notingroup'));
 143             echo $OUTPUT->footer();
 144             exit();
 145         } else {
 146             $filtergroupids = [(int) groups_get_course_group($course, true)];
 147         }
 148     }
 149 }
 150
 151 // Apply groups filter if included in URL or forced due to lack of capabilities.
 152 if (!empty($filtergroupids)) {
 153     $filterset->add_filter(new integer_filter('groups', filter::JOINTYPE_DEFAULT, $filtergroupids));
 154 }
 155
 156 // Display single group information if requested in the URL.
 157 if ($urlgroupid > 0 && ($course->groupmode != SEPARATEGROUPS || $canaccessallgroups)) {
 158     $grouprenderer = $PAGE->get_renderer('core_group');
 159     $groupdetailpage = new \core_group\output\group_details($urlgroupid);
 160     echo $grouprenderer->group_details($groupdetailpage);
 161 }
 162
 163 // Filter by role if passed via URL (used on profile page).
 164 if ($roleid) {
 165     $viewableroles = get_profile_roles($context);
 166
 167     // Apply filter if the user can view this role.
 168     if (array_key_exists($roleid, $viewableroles)) {
 169         $filterset->add_filter(new integer_filter('roles', filter::JOINTYPE_DEFAULT, [$roleid]));
 170     }
 171 }
 172
 173 // Render the user filters.
 174 $userrenderer = $PAGE->get_renderer('core_user');
 175 echo $userrenderer->participants_filter($context, $participanttable->uniqueid);
 176
 177 echo '<div class="userlist">';
 178
 179 // Do this so we can get the total number of rows.
 180 ob_start();
 181 $participanttable->set_filterset($filterset);
 182 $participanttable->out($perpage, true);
 183 $participanttablehtml = ob_get_contents();
 184 ob_end_clean();
 185
 186 echo html_writer::start_tag('form', [
 187     'action' => 'action_redir.php',
 188     'method' => 'post',
 189     'id' => 'participantsform',
 190     'data-course-id' => $course->id,
 191     'data-table-unique-id' => $participanttable->uniqueid,
 192 ]);
 193 echo '<div>';
 194 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
 195 echo '<input type="hidden" name="returnto" value="'.s($PAGE->url->out(false)).'" />';
 196
 197 echo html_writer::tag(
 198     'p',
 199     get_string('countparticipantsfound', 'core_user', $participanttable->totalrows),
 200     [
 201         'data-region' => 'participant-count',
 202     ]
 203 );
 204
 205 echo $participanttablehtml;
 206
 207 $bulkoptions = (object) [
 208     'uniqueid' => $participanttable->uniqueid,
 209 ];
 210
 211 if ($bulkoperations) {
 212     echo '<br /><div class="buttons"><div class="form-inline">';
 213
 214     echo html_writer::start_tag('div', array('class' => 'btn-group'));
 215
 216     if ($participanttable->get_page_size() < $participanttable->totalrows) {
 217         // Select all users, refresh table showing all users and mark them all selected.
 218         $label = get_string('selectalluserswithcount', 'moodle', $participanttable->totalrows);
 219         echo html_writer::empty_tag('input', [
 220             'type' => 'button',
 221             'id' => 'checkall',
 222             'class' => 'btn btn-secondary',
 223             'value' => $label,
 224             'data-target-page-size' => TABLE_SHOW_ALL_PAGE_SIZE,
 225         ]);
 226     }
 227     echo html_writer::end_tag('div');
 228     $displaylist = array();
 229     if (!empty($CFG->messaging) && has_all_capabilities(['moodle/site:sendmessage', 'moodle/course:bulkmessaging'], $context)) {
 230         $displaylist['#messageselect'] = get_string('messageselectadd');
 231     }
 232     if (!empty($CFG->enablenotes) && has_capability('moodle/notes:manage', $context) && $context->id != $frontpagectx->id) {
 233         $displaylist['#addgroupnote'] = get_string('addnewnote', 'notes');
 234     }
 235
 236     $params = ['operation' => 'download_participants'];
 237
 238     $downloadoptions = [];
 239     $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
 240     foreach ($formats as $format) {
 241         if ($format->is_enabled()) {
 242             $params = ['operation' => 'download_participants', 'dataformat' => $format->name];
 243             $url = new moodle_url('bulkchange.php', $params);
 244             $downloadoptions[$url->out(false)] = get_string('dataformat', $format->component);
 245         }
 246     }
 247
 248     if (!empty($downloadoptions)) {
 249         $displaylist[] = [get_string('downloadas', 'table') => $downloadoptions];
 250     }
 251
 252     if ($context->id != $frontpagectx->id) {
 253         $instances = $manager->get_enrolment_instances();
 254         $plugins = $manager->get_enrolment_plugins(false);
 255         foreach ($instances as $key => $instance) {
 256             if (!isset($plugins[$instance->enrol])) {
 257                 // Weird, some broken stuff in plugin.
 258                 continue;
 259             }
 260             $plugin = $plugins[$instance->enrol];
 261             $bulkoperations = $plugin->get_bulk_operations($manager);
 262
 263             $pluginoptions = [];
 264             foreach ($bulkoperations as $key => $bulkoperation) {
 265                 $params = ['plugin' => $plugin->get_name(), 'operation' => $key];
 266                 $url = new moodle_url('bulkchange.php', $params);
 267                 $pluginoptions[$url->out(false)] = $bulkoperation->get_title();
 268             }
 269             if (!empty($pluginoptions)) {
 270                 $name = get_string('pluginname', 'enrol_' . $plugin->get_name());
 271                 $displaylist[] = [$name => $pluginoptions];
 272             }
 273         }
 274     }
 275
 276     $selectactionparams = array(
 277         'id' => 'formactionid',
 278         'class' => 'ml-2',
 279         'data-action' => 'toggle',
 280         'data-togglegroup' => 'participants-table',
 281         'data-toggle' => 'action',
 282         'disabled' => 'disabled'
 283     );
 284     $label = html_writer::tag('label', get_string("withselectedusers"),
 285             ['for' => 'formactionid', 'class' => 'col-form-label d-inline']);
 286     $select = html_writer::select($displaylist, 'formaction', '', ['' => 'choosedots'], $selectactionparams);
 287     echo html_writer::tag('div', $label . $select);
 288
 289     echo '<input type="hidden" name="id" value="' . $course->id . '" />';
 290     echo '<div class="d-none" data-region="state-help-icon">' . $OUTPUT->help_icon('publishstate', 'notes') . '</div>';
 291     echo '</div></div></div>';
 292
 293     $bulkoptions->noteStateNames = note_get_state_names();
 294 }
 295 echo '</form>';
 296
 297 $PAGE->requires->js_call_amd('core_user/participants', 'init', [$bulkoptions]);
 298 echo '</div>';  // Userlist.
 299
 300 $enrolrenderer = $PAGE->get_renderer('core_enrol');
 301 // Need to re-generate the buttons to avoid having elements with duplicate ids on the page.
 302 $enrolbuttons = $manager->get_manual_enrol_buttons();
 303 $enrolbuttonsout = '';
 304 foreach ($enrolbuttons as $enrolbutton) {
 305     $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
 306 }
 307 echo html_writer::div($enrolbuttonsout, 'd-flex justify-content-end', [
 308     'data-region' => 'wrapper',
 309     'data-table-uniqueid' => $participanttable->uniqueid,
 310 ]);
 311
 312 echo $OUTPUT->footer();