Merge branch 'MDL-69017-master' of git://github.com/andrewnicols/moodle
[moodle.git] / 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/>.
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  */
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');
33 use core_table\local\filter\filter;
34 use core_table\local\filter\integer_filter;
35 use core_table\local\filter\string_filter;
37 define('DEFAULT_PAGE_SIZE', 20);
38 define('SHOW_ALL_PAGE_SIZE', 5000);
40 $page         = optional_param('page', 0, PARAM_INT); // Which page to show.
41 $perpage      = optional_param('perpage', DEFAULT_PAGE_SIZE, PARAM_INT); // How many per page.
42 $contextid    = optional_param('contextid', 0, PARAM_INT); // One of this or.
43 $courseid     = optional_param('id', 0, PARAM_INT); // This are required.
44 $newcourse    = optional_param('newcourse', false, PARAM_BOOL);
45 $roleid       = optional_param('roleid', 0, PARAM_INT);
46 $urlgroupid   = optional_param('group', 0, PARAM_INT);
48 $PAGE->set_url('/user/index.php', array(
49         'page' => $page,
50         'perpage' => $perpage,
51         'contextid' => $contextid,
52         'id' => $courseid,
53         'newcourse' => $newcourse));
55 if ($contextid) {
56     $context = context::instance_by_id($contextid, MUST_EXIST);
57     if ($context->contextlevel != CONTEXT_COURSE) {
58         print_error('invalidcontext');
59     }
60     $course = $DB->get_record('course', array('id' => $context->instanceid), '*', MUST_EXIST);
61 } else {
62     $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
63     $context = context_course::instance($course->id, MUST_EXIST);
64 }
65 // Not needed anymore.
66 unset($contextid);
67 unset($courseid);
69 require_login($course);
71 $systemcontext = context_system::instance();
72 $isfrontpage = ($course->id == SITEID);
74 $frontpagectx = context_course::instance(SITEID);
76 if ($isfrontpage) {
77     $PAGE->set_pagelayout('admin');
78     course_require_view_participants($systemcontext);
79 } else {
80     $PAGE->set_pagelayout('incourse');
81     course_require_view_participants($context);
82 }
84 // Trigger events.
85 user_list_view($course, $context);
87 $bulkoperations = has_capability('moodle/course:bulkmessaging', $context);
89 $PAGE->set_title("$course->shortname: ".get_string('participants'));
90 $PAGE->set_heading($course->fullname);
91 $PAGE->set_pagetype('course-view-' . $course->format);
92 $PAGE->add_body_class('path-user');                     // So we can style it independently.
93 $PAGE->set_other_editing_capability('moodle/course:manageactivities');
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();
102 echo $OUTPUT->header();
103 echo $OUTPUT->heading(get_string('participants'));
105 $filterset = new \core_user\table\participants_filterset();
106 $filterset->add_filter(new integer_filter('courseid', filter::JOINTYPE_DEFAULT, [(int)$course->id]));
108 $participanttable = new \core_user\table\participants("user-index-participants-{$course->id}");
110 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
111 $filtergroupids = $urlgroupid ? [$urlgroupid] : [];
113 // Force group filtering if user should only see a subset of groups' users.
114 if ($course->groupmode != NOGROUPS && !$canaccessallgroups) {
115     if ($filtergroupids) {
116         $filtergroupids = array_intersect(
117             $filtergroupids,
118             array_keys(groups_get_all_groups($course->id, $USER->id))
119         );
120     } else {
121         $filtergroupids = array_keys(groups_get_all_groups($course->id, $USER->id));
122     }
124     if (empty($filtergroupids)) {
125         if ($course->groupmode == SEPARATEGROUPS) {
126             // The user is not in a group so show message and exit.
127             echo $OUTPUT->notification(get_string('notingroup'));
128             echo $OUTPUT->footer();
129             exit();
130         } else {
131             $filtergroupids = [(int) groups_get_course_group($course, true)];
132         }
133     }
136 // Apply groups filter if included in URL or forced due to lack of capabilities.
137 if (!empty($filtergroupids)) {
138     $filterset->add_filter(new integer_filter('groups', filter::JOINTYPE_DEFAULT, $filtergroupids));
141 // Display single group information if requested in the URL.
142 if ($urlgroupid > 0 && ($course->groupmode != SEPARATEGROUPS || $canaccessallgroups)) {
143     $grouprenderer = $PAGE->get_renderer('core_group');
144     $groupdetailpage = new \core_group\output\group_details($urlgroupid);
145     echo $grouprenderer->group_details($groupdetailpage);
148 // Filter by role if passed via URL (used on profile page).
149 if ($roleid) {
150     $viewableroles = get_profile_roles($context);
152     // Apply filter if the user can view this role.
153     if (array_key_exists($roleid, $viewableroles)) {
154         $filterset->add_filter(new integer_filter('roles', filter::JOINTYPE_DEFAULT, [$roleid]));
155     }
158 // Manage enrolments.
159 $manager = new course_enrolment_manager($PAGE, $course);
160 $enrolbuttons = $manager->get_manual_enrol_buttons();
161 $enrolrenderer = $PAGE->get_renderer('core_enrol');
162 $enrolbuttonsout = '';
163 foreach ($enrolbuttons as $enrolbutton) {
164     $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
167 echo html_writer::div($enrolbuttonsout, 'd-flex justify-content-end', [
168     'data-region' => 'wrapper',
169     'data-table-uniqueid' => $participanttable->uniqueid,
170 ]);
172 // Render the user filters.
173 $userrenderer = $PAGE->get_renderer('core_user');
174 echo $userrenderer->participants_filter($context, $participanttable->uniqueid);
176 echo '<div class="userlist">';
178 // Do this so we can get the total number of rows.
179 ob_start();
180 $participanttable->set_filterset($filterset);
181 $participanttable->out($perpage, true);
182 $participanttablehtml = ob_get_contents();
183 ob_end_clean();
185 echo html_writer::start_tag('form', [
186     'action' => 'action_redir.php',
187     'method' => 'post',
188     'id' => 'participantsform',
189     'data-course-id' => $course->id,
190     'data-table-unique-id' => $participanttable->uniqueid,
191     'data-table-default-per-page' => ($perpage < DEFAULT_PAGE_SIZE) ? $perpage : DEFAULT_PAGE_SIZE,
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)).'" />';
197 echo html_writer::tag(
198     'p',
199     get_string('countparticipantsfound', 'core_user', $participanttable->totalrows),
200     [
201         'data-region' => 'participant-count',
202     ]
203 );
205 echo $participanttablehtml;
207 $perpageurl = new moodle_url('/user/index.php', [
208     'contextid' => $context->id,
209     'id' => $course->id,
210 ]);
211 $perpagesize = DEFAULT_PAGE_SIZE;
212 $perpagevisible = false;
213 $perpagestring = '';
215 if ($perpage == SHOW_ALL_PAGE_SIZE && $participanttable->totalrows > DEFAULT_PAGE_SIZE) {
216     $perpageurl->param('perpage', $participanttable->totalrows);
217     $perpagesize = SHOW_ALL_PAGE_SIZE;
218     $perpagevisible = true;
219     $perpagestring = get_string('showperpage', '', DEFAULT_PAGE_SIZE);
220 } else if ($participanttable->get_page_size() < $participanttable->totalrows) {
221     $perpageurl->param('perpage', SHOW_ALL_PAGE_SIZE);
222     $perpagesize = SHOW_ALL_PAGE_SIZE;
223     $perpagevisible = true;
224     $perpagestring = get_string('showall', '', $participanttable->totalrows);
227 $perpageclasses = '';
228 if (!$perpagevisible) {
229     $perpageclasses = 'hidden';
231 echo $OUTPUT->container(html_writer::link(
232     $perpageurl,
233     $perpagestring,
234     [
235         'data-action' => 'showcount',
236         'data-target-page-size' => $perpagesize,
237         'class' => $perpageclasses,
238     ]
239 ), [], 'showall');
241 $bulkoptions = (object) [
242     'uniqueid' => $participanttable->uniqueid,
243 ];
245 if ($bulkoperations) {
246     echo '<br /><div class="buttons"><div class="form-inline">';
248     echo html_writer::start_tag('div', array('class' => 'btn-group'));
250     if ($participanttable->get_page_size() < $participanttable->totalrows) {
251         // Select all users, refresh table showing all users and mark them all selected.
252         $label = get_string('selectalluserswithcount', 'moodle', $participanttable->totalrows);
253         echo html_writer::empty_tag('input', [
254             'type' => 'button',
255             'id' => 'checkall',
256             'class' => 'btn btn-secondary',
257             'value' => $label,
258             'data-target-page-size' => $participanttable->totalrows,
259         ]);
260     }
261     echo html_writer::end_tag('div');
262     $displaylist = array();
263     if (!empty($CFG->messaging) && has_all_capabilities(['moodle/site:sendmessage', 'moodle/course:bulkmessaging'], $context)) {
264         $displaylist['#messageselect'] = get_string('messageselectadd');
265     }
266     if (!empty($CFG->enablenotes) && has_capability('moodle/notes:manage', $context) && $context->id != $frontpagectx->id) {
267         $displaylist['#addgroupnote'] = get_string('addnewnote', 'notes');
268     }
270     $params = ['operation' => 'download_participants'];
272     $downloadoptions = [];
273     $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
274     foreach ($formats as $format) {
275         if ($format->is_enabled()) {
276             $params = ['operation' => 'download_participants', 'dataformat' => $format->name];
277             $url = new moodle_url('bulkchange.php', $params);
278             $downloadoptions[$url->out(false)] = get_string('dataformat', $format->component);
279         }
280     }
282     if (!empty($downloadoptions)) {
283         $displaylist[] = [get_string('downloadas', 'table') => $downloadoptions];
284     }
286     if ($context->id != $frontpagectx->id) {
287         $instances = $manager->get_enrolment_instances();
288         $plugins = $manager->get_enrolment_plugins(false);
289         foreach ($instances as $key => $instance) {
290             if (!isset($plugins[$instance->enrol])) {
291                 // Weird, some broken stuff in plugin.
292                 continue;
293             }
294             $plugin = $plugins[$instance->enrol];
295             $bulkoperations = $plugin->get_bulk_operations($manager);
297             $pluginoptions = [];
298             foreach ($bulkoperations as $key => $bulkoperation) {
299                 $params = ['plugin' => $plugin->get_name(), 'operation' => $key];
300                 $url = new moodle_url('bulkchange.php', $params);
301                 $pluginoptions[$url->out(false)] = $bulkoperation->get_title();
302             }
303             if (!empty($pluginoptions)) {
304                 $name = get_string('pluginname', 'enrol_' . $plugin->get_name());
305                 $displaylist[] = [$name => $pluginoptions];
306             }
307         }
308     }
310     $selectactionparams = array(
311         'id' => 'formactionid',
312         'class' => 'ml-2',
313         'data-action' => 'toggle',
314         'data-togglegroup' => 'participants-table',
315         'data-toggle' => 'action',
316         'disabled' => 'disabled'
317     );
318     $label = html_writer::tag('label', get_string("withselectedusers"),
319             ['for' => 'formactionid', 'class' => 'col-form-label d-inline']);
320     $select = html_writer::select($displaylist, 'formaction', '', ['' => 'choosedots'], $selectactionparams);
321     echo html_writer::tag('div', $label . $select);
323     echo '<input type="hidden" name="id" value="' . $course->id . '" />';
324     echo '<div class="d-none" data-region="state-help-icon">' . $OUTPUT->help_icon('publishstate', 'notes') . '</div>';
325     echo '</div></div></div>';
327     $bulkoptions->noteStateNames = note_get_state_names();
329 echo '</form>';
331 $PAGE->requires->js_call_amd('core_user/participants', 'init', [$bulkoptions]);
332 echo '</div>';  // Userlist.
334 $enrolrenderer = $PAGE->get_renderer('core_enrol');
335 // Need to re-generate the buttons to avoid having elements with duplicate ids on the page.
336 $enrolbuttons = $manager->get_manual_enrol_buttons();
337 $enrolbuttonsout = '';
338 foreach ($enrolbuttons as $enrolbutton) {
339     $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
341 echo html_writer::div($enrolbuttonsout, 'd-flex justify-content-end', [
342     'data-region' => 'wrapper',
343     'data-table-uniqueid' => $participanttable->uniqueid,
344 ]);
346 if ($newcourse == 1) {
347     $str = get_string('proceedtocourse', 'enrol');
348     // The margin is to make it line up with the enrol users button when they are both on the same line.
349     $classes = 'my-1';
350     $url = course_get_url($course);
351     echo $OUTPUT->single_button($url, $str, 'GET', array('class' => $classes));
354 echo $OUTPUT->footer();