MDL-68463 user: Remove old selectall attribute
[moodle.git] / user / index.php
CommitLineData
aa6c1ced 1<?php
a2ed6e69
SH
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
25require_once('../config.php');
0ff203b6 26require_once($CFG->dirroot.'/user/lib.php');
5fa2d502 27require_once($CFG->dirroot.'/course/lib.php');
b5b81de3 28require_once($CFG->dirroot.'/notes/lib.php');
a2ed6e69
SH
29require_once($CFG->libdir.'/tablelib.php');
30require_once($CFG->libdir.'/filelib.php');
a78ed71c 31require_once($CFG->dirroot.'/enrol/locallib.php');
a2ed6e69 32
8146335f
SL
33use core_table\local\filter\filter;
34use core_table\local\filter\integer_filter;
35use core_table\local\filter\string_filter;
8146335f 36
a2ed6e69
SH
37define('DEFAULT_PAGE_SIZE', 20);
38define('SHOW_ALL_PAGE_SIZE', 5000);
a2ed6e69
SH
39
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.
a2ed6e69
SH
42$contextid = optional_param('contextid', 0, PARAM_INT); // One of this or.
43$courseid = optional_param('id', 0, PARAM_INT); // This are required.
5fa2d502 44$newcourse = optional_param('newcourse', false, PARAM_BOOL);
fe214295 45$roleid = optional_param('roleid', 0, PARAM_INT);
9f33d5ac 46$groupparam = optional_param('group', 0, PARAM_INT);
a2ed6e69
SH
47
48$PAGE->set_url('/user/index.php', array(
49 'page' => $page,
50 'perpage' => $perpage,
a2ed6e69 51 'contextid' => $contextid,
5fa2d502
DW
52 'id' => $courseid,
53 'newcourse' => $newcourse));
a2ed6e69
SH
54
55if ($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.
66unset($contextid);
67unset($courseid);
f9903ed0 68
a2ed6e69 69require_login($course);
f9903ed0 70
a2ed6e69
SH
71$systemcontext = context_system::instance();
72$isfrontpage = ($course->id == SITEID);
f9903ed0 73
a2ed6e69 74$frontpagectx = context_course::instance(SITEID);
4f0c2d00 75
a2ed6e69
SH
76if ($isfrontpage) {
77 $PAGE->set_pagelayout('admin');
93b47710 78 course_require_view_participants($systemcontext);
a2ed6e69
SH
79} else {
80 $PAGE->set_pagelayout('incourse');
93b47710 81 course_require_view_participants($context);
a2ed6e69 82}
224aa44a 83
0ff203b6
JL
84// Trigger events.
85user_list_view($course, $context);
a2ed6e69
SH
86
87$bulkoperations = has_capability('moodle/course:bulkmessaging', $context);
88
a2ed6e69
SH
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');
2cb2ce61 94
b34fd2cc
DW
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);
98if ($node) {
b0b6ff3c 99 $node->force_open();
b34fd2cc
DW
100}
101
a2ed6e69 102echo $OUTPUT->header();
4e1f6047 103echo $OUTPUT->heading(get_string('participants'));
caa8363f 104
9651e491 105// Get the currently applied filters.
7cf4331a 106$filtersapplied = optional_param_array('unified-filters', [], PARAM_NOTAGS);
32e5109d 107$filterwassubmitted = optional_param('unified-filter-submitted', 0, PARAM_BOOL);
a78ed71c 108
fe214295
MN
109// If they passed a role make sure they can view that role.
110if ($roleid) {
111 $viewableroles = get_profile_roles($context);
112
113 // Check if the user can view this role.
114 if (array_key_exists($roleid, $viewableroles)) {
115 $filtersapplied[] = USER_FILTER_ROLE . ':' . $roleid;
116 } else {
117 $roleid = 0;
118 }
119}
120
9651e491
JP
121// Default group ID.
122$groupid = false;
123$canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
124if ($course->groupmode != NOGROUPS) {
125 if ($canaccessallgroups) {
9f33d5ac
MN
126 // Change the group if the user can access all groups and has specified group in the URL.
127 if ($groupparam) {
128 $groupid = $groupparam;
129 }
9651e491
JP
130 } else {
131 // Otherwise, get the user's default group.
132 $groupid = groups_get_course_group($course, true);
133 if ($course->groupmode == SEPARATEGROUPS && !$groupid) {
134 // The user is not in the group so show message and exit.
135 echo $OUTPUT->notification(get_string('notingroup'));
136 echo $OUTPUT->footer();
137 exit;
138 }
139 }
a2ed6e69 140}
9651e491
JP
141$hasgroupfilter = false;
142$lastaccess = 0;
143$searchkeywords = [];
9651e491 144$enrolid = 0;
8146335f
SL
145
146$filterset = new \core_user\table\participants_filterset();
147$filterset->add_filter(new integer_filter('courseid', filter::JOINTYPE_DEFAULT, [(int)$course->id]));
148$enrolfilter = new integer_filter('enrolments');
149$groupfilter = new integer_filter('groups');
150$keywordfilter = new string_filter('keywords');
151$lastaccessfilter = new integer_filter('accesssince');
152$rolefilter = new integer_filter('roles');
153$statusfilter = new integer_filter('status');
154
9651e491
JP
155foreach ($filtersapplied as $filter) {
156 $filtervalue = explode(':', $filter, 2);
157 $value = null;
158 if (count($filtervalue) == 2) {
159 $key = clean_param($filtervalue[0], PARAM_INT);
160 $value = clean_param($filtervalue[1], PARAM_INT);
161 } else {
162 // Search string.
a997dc9d
AN
163 $key = USER_FILTER_STRING;
164 $value = clean_param($filtervalue[0], PARAM_TEXT);
9651e491 165 }
99cca847 166
9651e491
JP
167 switch ($key) {
168 case USER_FILTER_ENROLMENT:
169 $enrolid = $value;
8146335f 170 $enrolfilter->add_filter_value($value);
9651e491
JP
171 break;
172 case USER_FILTER_GROUP:
173 $groupid = $value;
8146335f 174 $groupfilter->add_filter_value($value);
9651e491
JP
175 $hasgroupfilter = true;
176 break;
177 case USER_FILTER_LAST_ACCESS:
178 $lastaccess = $value;
8146335f 179 $lastaccessfilter->add_filter_value($value);
9651e491
JP
180 break;
181 case USER_FILTER_ROLE:
182 $roleid = $value;
8146335f 183 $rolefilter->add_filter_value($value);
9651e491
JP
184 break;
185 case USER_FILTER_STATUS:
186 // We only accept active/suspended statuses.
187 if ($value == ENROL_USER_ACTIVE || $value == ENROL_USER_SUSPENDED) {
188 $status = $value;
8146335f 189 $statusfilter->add_filter_value($value);
9651e491
JP
190 }
191 break;
192 default:
193 // Search string.
a997dc9d 194 $searchkeywords[] = $value;
8146335f 195 $keywordfilter->add_filter_value($value);
9651e491
JP
196 break;
197 }
a2ed6e69 198}
32e5109d 199// If course supports groups we may need to set a default.
58af736d 200if (!empty($groupid)) {
9f33d5ac
MN
201 if ($canaccessallgroups) {
202 // User can access all groups, let them filter by whatever was selected.
203 $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
ef4109d2 204 $groupfilter->add_filter_value((int)$groupid);
9f33d5ac
MN
205 } else if (!$filterwassubmitted && $course->groupmode == VISIBLEGROUPS) {
206 // If we are in a course with visible groups and the user has not submitted anything and does not have
207 // access to all groups, then set a default group.
32e5109d 208 $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
ef4109d2 209 $groupfilter->add_filter_value((int)$groupid);
9f33d5ac 210 } else if (!$hasgroupfilter && $course->groupmode != VISIBLEGROUPS) {
32e5109d
MN
211 // The user can't access all groups and has not set a group filter in a course where the groups are not visible
212 // then apply a default group filter.
213 $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
ef4109d2 214 $groupfilter->add_filter_value((int)$groupid);
32e5109d
MN
215 } else if (!$hasgroupfilter) { // No need for the group id to be set.
216 $groupid = false;
217 }
24c3db91 218}
a2ed6e69 219
5290d060 220if ($groupid > 0 && ($course->groupmode != SEPARATEGROUPS || $canaccessallgroups)) {
349b705d
AG
221 $grouprenderer = $PAGE->get_renderer('core_group');
222 $groupdetailpage = new \core_group\output\group_details($groupid);
223 echo $grouprenderer->group_details($groupdetailpage);
224}
225
9651e491
JP
226// Manage enrolments.
227$manager = new course_enrolment_manager($PAGE, $course);
228$enrolbuttons = $manager->get_manual_enrol_buttons();
229$enrolrenderer = $PAGE->get_renderer('core_enrol');
230$enrolbuttonsout = '';
231foreach ($enrolbuttons as $enrolbutton) {
232 $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
bc47b706 233}
5db1ce53 234echo html_writer::div($enrolbuttonsout, 'float-right');
bc47b706 235
9651e491
JP
236// Should use this variable so that we don't break stuff every time a variable is added or changed.
237$baseurl = new moodle_url('/user/index.php', array(
238 'contextid' => $context->id,
239 'id' => $course->id,
240 'perpage' => $perpage));
a2ed6e69 241
bb4a7923
SA
242// Render the unified filter.
243$renderer = $PAGE->get_renderer('core_user');
244echo $renderer->unified_filter($course, $context, $filtersapplied, $baseurl);
245
246echo '<div class="userlist">';
247
7fde8358 248// Add filters to the baseurl after creating unified_filter to avoid losing them.
89e27d99
JF
249foreach (array_unique($filtersapplied) as $filterix => $filter) {
250 $baseurl->param('unified-filters[' . $filterix . ']', $filter);
7fde8358 251}
8146335f
SL
252
253if (count($groupfilter)) {
254 $filterset->add_filter($groupfilter);
255}
256
257if (count($lastaccessfilter)) {
258 $filterset->add_filter($lastaccessfilter);
259}
260
261if (count($rolefilter)) {
262 $filterset->add_filter($rolefilter);
263}
264
265if (count($enrolfilter)) {
266 $filterset->add_filter($enrolfilter);
267}
268
269if (count($statusfilter)) {
270 $filterset->add_filter($statusfilter);
271}
272
273if (count($keywordfilter)) {
274 $filterset->add_filter($keywordfilter);
275}
276
ff475522 277$participanttable = new \core_user\table\participants("user-index-participants-{$course->id}");
8146335f 278$participanttable->set_filterset($filterset);
bc47b706 279$participanttable->define_baseurl($baseurl);
77c645df 280
bc47b706
MN
281// Do this so we can get the total number of rows.
282ob_start();
283$participanttable->out($perpage, true);
284$participanttablehtml = ob_get_contents();
285ob_end_clean();
3e219038 286
a2ed6e69 287if ($bulkoperations) {
bae72dd0
AN
288 echo html_writer::start_tag('form', [
289 'action' => 'action_redir.php',
290 'method' => 'post',
291 'id' => 'participantsform',
292 'data-course-id' => $course->id,
293 'data-table-unique-id' => $participanttable->uniqueid,
07c91064 294 'data-table-default-per-page' => ($perpage < DEFAULT_PAGE_SIZE) ? $perpage : DEFAULT_PAGE_SIZE,
bae72dd0 295 ]);
a2ed6e69
SH
296 echo '<div>';
297 echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
298 echo '<input type="hidden" name="returnto" value="'.s($PAGE->url->out(false)).'" />';
299}
77c645df 300
ed23725b
AN
301echo html_writer::tag(
302 'p',
303 get_string('countparticipantsfound', 'core_user', $participanttable->totalrows),
304 [
305 'data-region' => 'participant-count',
306 ]
307);
308
bc47b706 309echo $participanttablehtml;
4c7593ff 310
8dd42b38
AH
311$perpageurl = clone($baseurl);
312$perpageurl->remove_params('perpage');
bc47b706 313if ($perpage == SHOW_ALL_PAGE_SIZE && $participanttable->totalrows > DEFAULT_PAGE_SIZE) {
8dd42b38 314 $perpageurl->param('perpage', DEFAULT_PAGE_SIZE);
ed23725b
AN
315 echo $OUTPUT->container(html_writer::link(
316 $perpageurl,
317 get_string('showperpage', '', DEFAULT_PAGE_SIZE),
318 [
319 'data-action' => 'showcount',
320 'data-target-page-size' => DEFAULT_PAGE_SIZE,
321 ]
322 ), [], 'showall');
8dd42b38 323
bc47b706 324} else if ($participanttable->get_page_size() < $participanttable->totalrows) {
8dd42b38 325 $perpageurl->param('perpage', SHOW_ALL_PAGE_SIZE);
ed23725b
AN
326 echo $OUTPUT->container(html_writer::link(
327 $perpageurl,
328 get_string('showall', '', $participanttable->totalrows),
329 [
330 'data-action' => 'showcount',
331 'data-target-page-size' => SHOW_ALL_PAGE_SIZE,
332 ]
333 ),
334 [], 'showall');
8dd42b38
AH
335}
336
a2ed6e69 337if ($bulkoperations) {
8df785f9 338 echo '<br /><div class="buttons"><div class="form-inline">';
5b7c500a 339
b27c8d81 340 echo html_writer::start_tag('div', array('class' => 'btn-group'));
ed23725b 341
bc47b706 342 if ($participanttable->get_page_size() < $participanttable->totalrows) {
ed23725b 343 // Select all users, refresh table showing all users and mark them all selected.
bc47b706 344 $label = get_string('selectalluserswithcount', 'moodle', $participanttable->totalrows);
ed23725b
AN
345 echo html_writer::empty_tag('input', [
346 'type' => 'button',
347 'id' => 'checkall',
348 'class' => 'btn btn-secondary',
349 'value' => $label,
350 'data-target-page-size' => $participanttable->totalrows,
351 ]);
5b7c500a 352 }
b27c8d81 353 echo html_writer::end_tag('div');
a2ed6e69 354 $displaylist = array();
713934f9
ND
355 if (!empty($CFG->messaging)) {
356 $displaylist['#messageselect'] = get_string('messageselectadd');
357 }
a2ed6e69 358 if (!empty($CFG->enablenotes) && has_capability('moodle/notes:manage', $context) && $context->id != $frontpagectx->id) {
b5b81de3 359 $displaylist['#addgroupnote'] = get_string('addnewnote', 'notes');
a2ed6e69
SH
360 }
361
e5abe2af
LB
362 $params = ['operation' => 'download_participants'];
363
364 $downloadoptions = [];
365 $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
366 foreach ($formats as $format) {
367 if ($format->is_enabled()) {
368 $params = ['operation' => 'download_participants', 'dataformat' => $format->name];
369 $url = new moodle_url('bulkchange.php', $params);
370 $downloadoptions[$url->out(false)] = get_string('dataformat', $format->component);
371 }
372 }
373
374 if (!empty($downloadoptions)) {
375 $displaylist[] = [get_string('downloadas', 'table') => $downloadoptions];
376 }
377
ca560952 378 if ($context->id != $frontpagectx->id) {
f4ddc4ec
DW
379 $instances = $manager->get_enrolment_instances();
380 $plugins = $manager->get_enrolment_plugins(false);
381 foreach ($instances as $key => $instance) {
382 if (!isset($plugins[$instance->enrol])) {
383 // Weird, some broken stuff in plugin.
384 continue;
385 }
386 $plugin = $plugins[$instance->enrol];
ca560952
DW
387 $bulkoperations = $plugin->get_bulk_operations($manager);
388
389 $pluginoptions = [];
390 foreach ($bulkoperations as $key => $bulkoperation) {
391 $params = ['plugin' => $plugin->get_name(), 'operation' => $key];
392 $url = new moodle_url('bulkchange.php', $params);
393 $pluginoptions[$url->out(false)] = $bulkoperation->get_title();
394 }
395 if (!empty($pluginoptions)) {
396 $name = get_string('pluginname', 'enrol_' . $plugin->get_name());
397 $displaylist[] = [$name => $pluginoptions];
398 }
689ccae5
DW
399 }
400 }
401
df92be9d
JP
402 $selectactionparams = array(
403 'id' => 'formactionid',
404 'class' => 'ml-2',
405 'data-action' => 'toggle',
406 'data-togglegroup' => 'participants-table',
407 'data-toggle' => 'action',
408 'disabled' => empty($selectall)
409 );
8aecd857
SR
410 $label = html_writer::tag('label', get_string("withselectedusers"),
411 ['for' => 'formactionid', 'class' => 'col-form-label d-inline']);
412 $select = html_writer::select($displaylist, 'formaction', '', ['' => 'choosedots'], $selectactionparams);
413 echo html_writer::tag('div', $label . $select);
414
415 echo '<input type="hidden" name="id" value="' . $course->id . '" />';
bae72dd0 416 echo '<div class="d-none" data-region="state-help-icon">' . $OUTPUT->help_icon('publishstate', 'notes') . '</div>';
8df785f9 417 echo '</div></div></div>';
a2ed6e69
SH
418 echo '</form>';
419
bae72dd0
AN
420 $options = (object) [
421 'uniqueid' => $participanttable->uniqueid,
422 'noteStateNames' => note_get_state_names(),
423 ];
b5b81de3 424 $PAGE->requires->js_call_amd('core_user/participants', 'init', [$options]);
a2ed6e69 425}
b90e2f19 426
a2ed6e69 427echo '</div>'; // Userlist.
f9903ed0 428
a78ed71c 429$enrolrenderer = $PAGE->get_renderer('core_enrol');
5db1ce53 430echo '<div class="float-right">';
3dec4c6c
SR
431// Need to re-generate the buttons to avoid having elements with duplicate ids on the page.
432$enrolbuttons = $manager->get_manual_enrol_buttons();
a78ed71c
DW
433foreach ($enrolbuttons as $enrolbutton) {
434 echo $enrolrenderer->render($enrolbutton);
435}
436echo '</div>';
437
5fa2d502
DW
438if ($newcourse == 1) {
439 $str = get_string('proceedtocourse', 'enrol');
5fa2d502 440 // The margin is to make it line up with the enrol users button when they are both on the same line.
d470c68b 441 $classes = 'my-1';
5fa2d502
DW
442 $url = course_get_url($course);
443 echo $OUTPUT->single_button($url, $str, 'GET', array('class' => $classes));
444}
445
a2ed6e69 446echo $OUTPUT->footer();