92f81e2bfdb96fc56bdf1eaea3b24540df7ce7b2
[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 $selectall    = optional_param('selectall', false, PARAM_BOOL); // When rendering checkboxes against users mark them all checked.
46 $roleid       = optional_param('roleid', 0, PARAM_INT);
47 $groupparam   = optional_param('group', 0, PARAM_INT);
49 $PAGE->set_url('/user/index.php', array(
50         'page' => $page,
51         'perpage' => $perpage,
52         'contextid' => $contextid,
53         'id' => $courseid,
54         'newcourse' => $newcourse));
56 if ($contextid) {
57     $context = context::instance_by_id($contextid, MUST_EXIST);
58     if ($context->contextlevel != CONTEXT_COURSE) {
59         print_error('invalidcontext');
60     }
61     $course = $DB->get_record('course', array('id' => $context->instanceid), '*', MUST_EXIST);
62 } else {
63     $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
64     $context = context_course::instance($course->id, MUST_EXIST);
65 }
66 // Not needed anymore.
67 unset($contextid);
68 unset($courseid);
70 require_login($course);
72 $systemcontext = context_system::instance();
73 $isfrontpage = ($course->id == SITEID);
75 $frontpagectx = context_course::instance(SITEID);
77 if ($isfrontpage) {
78     $PAGE->set_pagelayout('admin');
79     course_require_view_participants($systemcontext);
80 } else {
81     $PAGE->set_pagelayout('incourse');
82     course_require_view_participants($context);
83 }
85 // Trigger events.
86 user_list_view($course, $context);
88 $bulkoperations = has_capability('moodle/course:bulkmessaging', $context);
90 $PAGE->set_title("$course->shortname: ".get_string('participants'));
91 $PAGE->set_heading($course->fullname);
92 $PAGE->set_pagetype('course-view-' . $course->format);
93 $PAGE->add_body_class('path-user');                     // So we can style it independently.
94 $PAGE->set_other_editing_capability('moodle/course:manageactivities');
96 // Expand the users node in the settings navigation when it exists because those pages
97 // are related to this one.
98 $node = $PAGE->settingsnav->find('users', navigation_node::TYPE_CONTAINER);
99 if ($node) {
100     $node->force_open();
103 echo $OUTPUT->header();
104 echo $OUTPUT->heading(get_string('participants'));
106 // Get the currently applied filters.
107 $filtersapplied = optional_param_array('unified-filters', [], PARAM_NOTAGS);
108 $filterwassubmitted = optional_param('unified-filter-submitted', 0, PARAM_BOOL);
110 // If they passed a role make sure they can view that role.
111 if ($roleid) {
112     $viewableroles = get_profile_roles($context);
114     // Check if the user can view this role.
115     if (array_key_exists($roleid, $viewableroles)) {
116         $filtersapplied[] = USER_FILTER_ROLE . ':' . $roleid;
117     } else {
118         $roleid = 0;
119     }
122 // Default group ID.
123 $groupid = false;
124 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
125 if ($course->groupmode != NOGROUPS) {
126     if ($canaccessallgroups) {
127         // Change the group if the user can access all groups and has specified group in the URL.
128         if ($groupparam) {
129             $groupid = $groupparam;
130         }
131     } else {
132         // Otherwise, get the user's default group.
133         $groupid = groups_get_course_group($course, true);
134         if ($course->groupmode == SEPARATEGROUPS && !$groupid) {
135             // The user is not in the group so show message and exit.
136             echo $OUTPUT->notification(get_string('notingroup'));
137             echo $OUTPUT->footer();
138             exit;
139         }
140     }
142 $hasgroupfilter = false;
143 $lastaccess = 0;
144 $searchkeywords = [];
145 $enrolid = 0;
147 $filterset = new \core_user\table\participants_filterset();
148 $filterset->add_filter(new integer_filter('courseid', filter::JOINTYPE_DEFAULT, [(int)$course->id]));
149 $enrolfilter = new integer_filter('enrolments');
150 $groupfilter = new integer_filter('groups');
151 $keywordfilter = new string_filter('keywords');
152 $lastaccessfilter = new integer_filter('accesssince');
153 $rolefilter = new integer_filter('roles');
154 $statusfilter = new integer_filter('status');
156 foreach ($filtersapplied as $filter) {
157     $filtervalue = explode(':', $filter, 2);
158     $value = null;
159     if (count($filtervalue) == 2) {
160         $key = clean_param($filtervalue[0], PARAM_INT);
161         $value = clean_param($filtervalue[1], PARAM_INT);
162     } else {
163         // Search string.
164         $key = USER_FILTER_STRING;
165         $value = clean_param($filtervalue[0], PARAM_TEXT);
166     }
168     switch ($key) {
169         case USER_FILTER_ENROLMENT:
170             $enrolid = $value;
171             $enrolfilter->add_filter_value($value);
172             break;
173         case USER_FILTER_GROUP:
174             $groupid = $value;
175             $groupfilter->add_filter_value($value);
176             $hasgroupfilter = true;
177             break;
178         case USER_FILTER_LAST_ACCESS:
179             $lastaccess = $value;
180             $lastaccessfilter->add_filter_value($value);
181             break;
182         case USER_FILTER_ROLE:
183             $roleid = $value;
184             $rolefilter->add_filter_value($value);
185             break;
186         case USER_FILTER_STATUS:
187             // We only accept active/suspended statuses.
188             if ($value == ENROL_USER_ACTIVE || $value == ENROL_USER_SUSPENDED) {
189                 $status = $value;
190                 $statusfilter->add_filter_value($value);
191             }
192             break;
193         default:
194             // Search string.
195             $searchkeywords[] = $value;
196             $keywordfilter->add_filter_value($value);
197             break;
198     }
200 // If course supports groups we may need to set a default.
201 if (!empty($groupid)) {
202     if ($canaccessallgroups) {
203         // User can access all groups, let them filter by whatever was selected.
204         $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
205         $groupfilter->add_filter_value((int)$groupid);
206     } else if (!$filterwassubmitted && $course->groupmode == VISIBLEGROUPS) {
207         // If we are in a course with visible groups and the user has not submitted anything and does not have
208         // access to all groups, then set a default group.
209         $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
210         $groupfilter->add_filter_value((int)$groupid);
211     } else if (!$hasgroupfilter && $course->groupmode != VISIBLEGROUPS) {
212         // The user can't access all groups and has not set a group filter in a course where the groups are not visible
213         // then apply a default group filter.
214         $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
215         $groupfilter->add_filter_value((int)$groupid);
216     } else if (!$hasgroupfilter) { // No need for the group id to be set.
217         $groupid = false;
218     }
221 if ($groupid > 0 && ($course->groupmode != SEPARATEGROUPS || $canaccessallgroups)) {
222     $grouprenderer = $PAGE->get_renderer('core_group');
223     $groupdetailpage = new \core_group\output\group_details($groupid);
224     echo $grouprenderer->group_details($groupdetailpage);
227 // Manage enrolments.
228 $manager = new course_enrolment_manager($PAGE, $course);
229 $enrolbuttons = $manager->get_manual_enrol_buttons();
230 $enrolrenderer = $PAGE->get_renderer('core_enrol');
231 $enrolbuttonsout = '';
232 foreach ($enrolbuttons as $enrolbutton) {
233     $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
235 echo html_writer::div($enrolbuttonsout, 'float-right');
237 // Should use this variable so that we don't break stuff every time a variable is added or changed.
238 $baseurl = new moodle_url('/user/index.php', array(
239         'contextid' => $context->id,
240         'id' => $course->id,
241         'perpage' => $perpage));
243 // Render the unified filter.
244 $renderer = $PAGE->get_renderer('core_user');
245 echo $renderer->unified_filter($course, $context, $filtersapplied, $baseurl);
247 echo '<div class="userlist">';
249 // Add filters to the baseurl after creating unified_filter to avoid losing them.
250 foreach (array_unique($filtersapplied) as $filterix => $filter) {
251     $baseurl->param('unified-filters[' . $filterix . ']', $filter);
254 if (count($groupfilter)) {
255     $filterset->add_filter($groupfilter);
258 if (count($lastaccessfilter)) {
259     $filterset->add_filter($lastaccessfilter);
262 if (count($rolefilter)) {
263     $filterset->add_filter($rolefilter);
266 if (count($enrolfilter)) {
267     $filterset->add_filter($enrolfilter);
270 if (count($statusfilter)) {
271     $filterset->add_filter($statusfilter);
274 if (count($keywordfilter)) {
275     $filterset->add_filter($keywordfilter);
278 $participanttable = new \core_user\table\participants("user-index-participants-{$course->id}");
279 $participanttable->set_selectall($selectall);
280 $participanttable->set_filterset($filterset);
281 $participanttable->define_baseurl($baseurl);
283 // Do this so we can get the total number of rows.
284 ob_start();
285 $participanttable->out($perpage, true);
286 $participanttablehtml = ob_get_contents();
287 ob_end_clean();
289 echo html_writer::tag('p', get_string('participantscount', 'moodle', $participanttable->totalrows));
291 if ($bulkoperations) {
292     echo '<form action="action_redir.php" method="post" id="participantsform">';
293     echo '<div>';
294     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
295     echo '<input type="hidden" name="returnto" value="'.s($PAGE->url->out(false)).'" />';
298 echo $participanttablehtml;
300 $perpageurl = clone($baseurl);
301 $perpageurl->remove_params('perpage');
302 if ($perpage == SHOW_ALL_PAGE_SIZE && $participanttable->totalrows > DEFAULT_PAGE_SIZE) {
303     $perpageurl->param('perpage', DEFAULT_PAGE_SIZE);
304     echo $OUTPUT->container(html_writer::link($perpageurl, get_string('showperpage', '', DEFAULT_PAGE_SIZE)), array(), 'showall');
306 } else if ($participanttable->get_page_size() < $participanttable->totalrows) {
307     $perpageurl->param('perpage', SHOW_ALL_PAGE_SIZE);
308     echo $OUTPUT->container(html_writer::link($perpageurl, get_string('showall', '', $participanttable->totalrows)),
309         array(), 'showall');
312 if ($bulkoperations) {
313     echo '<br /><div class="buttons"><div class="form-inline">';
315     if ($participanttable->get_page_size() < $participanttable->totalrows) {
316         $perpageurl = clone($baseurl);
317         $perpageurl->remove_params('perpage');
318         $perpageurl->param('perpage', SHOW_ALL_PAGE_SIZE);
319         $perpageurl->param('selectall', true);
320         $showalllink = $perpageurl;
321     } else {
322         $showalllink = false;
323     }
325     echo html_writer::start_tag('div', array('class' => 'btn-group'));
326     if ($participanttable->get_page_size() < $participanttable->totalrows) {
327         // Select all users, refresh page showing all users and mark them all selected.
328         $label = get_string('selectalluserswithcount', 'moodle', $participanttable->totalrows);
329         echo html_writer::empty_tag('input', array('type' => 'button', 'id' => 'checkall', 'class' => 'btn btn-secondary',
330                 'value' => $label, 'data-showallink' => $showalllink));
331     }
332     echo html_writer::end_tag('div');
333     $displaylist = array();
334     if (!empty($CFG->messaging)) {
335         $displaylist['#messageselect'] = get_string('messageselectadd');
336     }
337     if (!empty($CFG->enablenotes) && has_capability('moodle/notes:manage', $context) && $context->id != $frontpagectx->id) {
338         $displaylist['#addgroupnote'] = get_string('addnewnote', 'notes');
339     }
341     $params = ['operation' => 'download_participants'];
343     $downloadoptions = [];
344     $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
345     foreach ($formats as $format) {
346         if ($format->is_enabled()) {
347             $params = ['operation' => 'download_participants', 'dataformat' => $format->name];
348             $url = new moodle_url('bulkchange.php', $params);
349             $downloadoptions[$url->out(false)] = get_string('dataformat', $format->component);
350         }
351     }
353     if (!empty($downloadoptions)) {
354         $displaylist[] = [get_string('downloadas', 'table') => $downloadoptions];
355     }
357     if ($context->id != $frontpagectx->id) {
358         $instances = $manager->get_enrolment_instances();
359         $plugins = $manager->get_enrolment_plugins(false);
360         foreach ($instances as $key => $instance) {
361             if (!isset($plugins[$instance->enrol])) {
362                 // Weird, some broken stuff in plugin.
363                 continue;
364             }
365             $plugin = $plugins[$instance->enrol];
366             $bulkoperations = $plugin->get_bulk_operations($manager);
368             $pluginoptions = [];
369             foreach ($bulkoperations as $key => $bulkoperation) {
370                 $params = ['plugin' => $plugin->get_name(), 'operation' => $key];
371                 $url = new moodle_url('bulkchange.php', $params);
372                 $pluginoptions[$url->out(false)] = $bulkoperation->get_title();
373             }
374             if (!empty($pluginoptions)) {
375                 $name = get_string('pluginname', 'enrol_' . $plugin->get_name());
376                 $displaylist[] = [$name => $pluginoptions];
377             }
378         }
379     }
381     $selectactionparams = array(
382         'id' => 'formactionid',
383         'class' => 'ml-2',
384         'data-action' => 'toggle',
385         'data-togglegroup' => 'participants-table',
386         'data-toggle' => 'action',
387         'disabled' => empty($selectall)
388     );
389     $label = html_writer::tag('label', get_string("withselectedusers"),
390             ['for' => 'formactionid', 'class' => 'col-form-label d-inline']);
391     $select = html_writer::select($displaylist, 'formaction', '', ['' => 'choosedots'], $selectactionparams);
392     echo html_writer::tag('div', $label . $select);
394     echo '<input type="hidden" name="id" value="' . $course->id . '" />';
395     echo '</div></div></div>';
396     echo '</form>';
398     $options = new stdClass();
399     $options->courseid = $course->id;
400     $options->noteStateNames = note_get_state_names();
401     $options->stateHelpIcon = $OUTPUT->help_icon('publishstate', 'notes');
402     $PAGE->requires->js_call_amd('core_user/participants', 'init', [$options]);
405 echo '</div>';  // Userlist.
407 $enrolrenderer = $PAGE->get_renderer('core_enrol');
408 echo '<div class="float-right">';
409 // Need to re-generate the buttons to avoid having elements with duplicate ids on the page.
410 $enrolbuttons = $manager->get_manual_enrol_buttons();
411 foreach ($enrolbuttons as $enrolbutton) {
412     echo $enrolrenderer->render($enrolbutton);
414 echo '</div>';
416 if ($newcourse == 1) {
417     $str = get_string('proceedtocourse', 'enrol');
418     // The margin is to make it line up with the enrol users button when they are both on the same line.
419     $classes = 'my-1';
420     $url = course_get_url($course);
421     echo $OUTPUT->single_button($url, $str, 'GET', array('class' => $classes));
424 echo $OUTPUT->footer();