MDL-67917 user: Add skeleton for new participants filter
[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 $groupparam   = 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 // Get the currently applied filters.
106 $filtersapplied = optional_param_array('unified-filters', [], PARAM_NOTAGS);
107 $filterwassubmitted = optional_param('unified-filter-submitted', 0, PARAM_BOOL);
109 // If they passed a role make sure they can view that role.
110 if ($roleid) {
111     $viewableroles = get_profile_roles($context);
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     }
121 // Default group ID.
122 $groupid = false;
123 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
124 if ($course->groupmode != NOGROUPS) {
125     if ($canaccessallgroups) {
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         }
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     }
141 $hasgroupfilter = false;
142 $lastaccess = 0;
143 $searchkeywords = [];
144 $enrolid = 0;
146 $participanttable = new \core_user\table\participants("user-index-participants-{$course->id}");
148 $filterset = new \core_user\table\participants_filterset();
149 $filterset->add_filter(new integer_filter('courseid', filter::JOINTYPE_DEFAULT, [(int)$course->id]));
150 $enrolfilter = new integer_filter('enrolments');
151 $groupfilter = new integer_filter('groups');
152 $keywordfilter = new string_filter('keywords');
153 $lastaccessfilter = new integer_filter('accesssince');
154 $rolefilter = new integer_filter('roles');
155 $statusfilter = new integer_filter('status');
157 foreach ($filtersapplied as $filter) {
158     $filtervalue = explode(':', $filter, 2);
159     $value = null;
160     if (count($filtervalue) == 2) {
161         $key = clean_param($filtervalue[0], PARAM_INT);
162         $value = clean_param($filtervalue[1], PARAM_INT);
163     } else {
164         // Search string.
165         $key = USER_FILTER_STRING;
166         $value = clean_param($filtervalue[0], PARAM_TEXT);
167     }
169     switch ($key) {
170         case USER_FILTER_ENROLMENT:
171             $enrolid = $value;
172             $enrolfilter->add_filter_value($value);
173             break;
174         case USER_FILTER_GROUP:
175             $groupid = $value;
176             $groupfilter->add_filter_value($value);
177             $hasgroupfilter = true;
178             break;
179         case USER_FILTER_LAST_ACCESS:
180             $lastaccess = $value;
181             $lastaccessfilter->add_filter_value($value);
182             break;
183         case USER_FILTER_ROLE:
184             $roleid = $value;
185             $rolefilter->add_filter_value($value);
186             break;
187         case USER_FILTER_STATUS:
188             // We only accept active/suspended statuses.
189             if ($value == ENROL_USER_ACTIVE || $value == ENROL_USER_SUSPENDED) {
190                 $status = $value;
191                 $statusfilter->add_filter_value($value);
192             }
193             break;
194         default:
195             // Search string.
196             $searchkeywords[] = $value;
197             $keywordfilter->add_filter_value($value);
198             break;
199     }
201 // If course supports groups we may need to set a default.
202 if (!empty($groupid)) {
203     if ($canaccessallgroups) {
204         // User can access all groups, let them filter by whatever was selected.
205         $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
206         $groupfilter->add_filter_value((int)$groupid);
207     } else if (!$filterwassubmitted && $course->groupmode == VISIBLEGROUPS) {
208         // If we are in a course with visible groups and the user has not submitted anything and does not have
209         // access to all groups, then set a default group.
210         $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
211         $groupfilter->add_filter_value((int)$groupid);
212     } else if (!$hasgroupfilter && $course->groupmode != VISIBLEGROUPS) {
213         // The user can't access all groups and has not set a group filter in a course where the groups are not visible
214         // then apply a default group filter.
215         $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
216         $groupfilter->add_filter_value((int)$groupid);
217     } else if (!$hasgroupfilter) { // No need for the group id to be set.
218         $groupid = false;
219     }
222 if ($groupid > 0 && ($course->groupmode != SEPARATEGROUPS || $canaccessallgroups)) {
223     $grouprenderer = $PAGE->get_renderer('core_group');
224     $groupdetailpage = new \core_group\output\group_details($groupid);
225     echo $grouprenderer->group_details($groupdetailpage);
228 // Should use this variable so that we don't break stuff every time a variable is added or changed.
229 $baseurl = new moodle_url('/user/index.php', array(
230         'contextid' => $context->id,
231         'id' => $course->id,
232         'perpage' => $perpage));
234 $participanttable = new \core_user\table\participants("user-index-participants-{$course->id}");
235 $participanttable->define_baseurl($baseurl);
237 // Manage enrolments.
238 $manager = new course_enrolment_manager($PAGE, $course);
239 $enrolbuttons = $manager->get_manual_enrol_buttons();
240 $enrolrenderer = $PAGE->get_renderer('core_enrol');
241 $enrolbuttonsout = '';
242 foreach ($enrolbuttons as $enrolbutton) {
243     $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
245 echo html_writer::div($enrolbuttonsout, 'float-right', [
246     'data-region' => 'wrapper',
247     'data-table-uniqueid' => $participanttable->uniqueid,
248 ]);
250 // Render the unified filter.
251 $renderer = $PAGE->get_renderer('core_user');
252 echo $renderer->unified_filter($course, $context, $filtersapplied, $baseurl);
254 // Render the user filters.
255 $userrenderer = $PAGE->get_renderer('core_user');
256 echo $userrenderer->participants_filter($context, $participanttable->uniqueid);
258 echo '<div class="userlist">';
260 // Add filters to the baseurl after creating unified_filter to avoid losing them.
261 foreach (array_unique($filtersapplied) as $filterix => $filter) {
262     $baseurl->param('unified-filters[' . $filterix . ']', $filter);
265 if (count($groupfilter)) {
266     $filterset->add_filter($groupfilter);
269 if (count($lastaccessfilter)) {
270     $filterset->add_filter($lastaccessfilter);
273 if (count($rolefilter)) {
274     $filterset->add_filter($rolefilter);
277 if (count($enrolfilter)) {
278     $filterset->add_filter($enrolfilter);
281 if (count($statusfilter)) {
282     $filterset->add_filter($statusfilter);
285 if (count($keywordfilter)) {
286     $filterset->add_filter($keywordfilter);
289 // Do this so we can get the total number of rows.
290 ob_start();
291 $participanttable->set_filterset($filterset);
292 $participanttable->out($perpage, true);
293 $participanttablehtml = ob_get_contents();
294 ob_end_clean();
296 if ($bulkoperations) {
297     echo html_writer::start_tag('form', [
298         'action' => 'action_redir.php',
299         'method' => 'post',
300         'id' => 'participantsform',
301         'data-course-id' => $course->id,
302         'data-table-unique-id' => $participanttable->uniqueid,
303         'data-table-default-per-page' => ($perpage < DEFAULT_PAGE_SIZE) ? $perpage : DEFAULT_PAGE_SIZE,
304     ]);
305     echo '<div>';
306     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
307     echo '<input type="hidden" name="returnto" value="'.s($PAGE->url->out(false)).'" />';
310 echo html_writer::tag(
311     'p',
312     get_string('countparticipantsfound', 'core_user', $participanttable->totalrows),
313     [
314         'data-region' => 'participant-count',
315     ]
316 );
318 echo $participanttablehtml;
320 $perpageurl = clone($baseurl);
321 $perpageurl->remove_params('perpage');
322 $perpagesize = DEFAULT_PAGE_SIZE;
323 $perpagevisible = false;
324 $perpagestring = '';
326 if ($perpage == SHOW_ALL_PAGE_SIZE && $participanttable->totalrows > DEFAULT_PAGE_SIZE) {
327     $perpageurl->param('perpage', $participanttable->totalrows);
328     $perpagesize = SHOW_ALL_PAGE_SIZE;
329     $perpagevisible = true;
330     $perpagestring = get_string('showperpage', '', DEFAULT_PAGE_SIZE);
331 } else if ($participanttable->get_page_size() < $participanttable->totalrows) {
332     $perpageurl->param('perpage', SHOW_ALL_PAGE_SIZE);
333     $perpagesize = SHOW_ALL_PAGE_SIZE;
334     $perpagevisible = true;
335     $perpagestring = get_string('showall', '', $participanttable->totalrows);
338 $perpageclasses = '';
339 if (!$perpagevisible) {
340     $perpageclasses = 'hidden';
342 echo $OUTPUT->container(html_writer::link(
343     $perpageurl,
344     $perpagestring,
345     [
346         'data-action' => 'showcount',
347         'data-target-page-size' => $perpagesize,
348         'class' => $perpageclasses,
349     ]
350 ), [], 'showall');
352 if ($bulkoperations) {
353     echo '<br /><div class="buttons"><div class="form-inline">';
355     echo html_writer::start_tag('div', array('class' => 'btn-group'));
357     if ($participanttable->get_page_size() < $participanttable->totalrows) {
358         // Select all users, refresh table showing all users and mark them all selected.
359         $label = get_string('selectalluserswithcount', 'moodle', $participanttable->totalrows);
360         echo html_writer::empty_tag('input', [
361             'type' => 'button',
362             'id' => 'checkall',
363             'class' => 'btn btn-secondary',
364             'value' => $label,
365             'data-target-page-size' => $participanttable->totalrows,
366         ]);
367     }
368     echo html_writer::end_tag('div');
369     $displaylist = array();
370     if (!empty($CFG->messaging)) {
371         $displaylist['#messageselect'] = get_string('messageselectadd');
372     }
373     if (!empty($CFG->enablenotes) && has_capability('moodle/notes:manage', $context) && $context->id != $frontpagectx->id) {
374         $displaylist['#addgroupnote'] = get_string('addnewnote', 'notes');
375     }
377     $params = ['operation' => 'download_participants'];
379     $downloadoptions = [];
380     $formats = core_plugin_manager::instance()->get_plugins_of_type('dataformat');
381     foreach ($formats as $format) {
382         if ($format->is_enabled()) {
383             $params = ['operation' => 'download_participants', 'dataformat' => $format->name];
384             $url = new moodle_url('bulkchange.php', $params);
385             $downloadoptions[$url->out(false)] = get_string('dataformat', $format->component);
386         }
387     }
389     if (!empty($downloadoptions)) {
390         $displaylist[] = [get_string('downloadas', 'table') => $downloadoptions];
391     }
393     if ($context->id != $frontpagectx->id) {
394         $instances = $manager->get_enrolment_instances();
395         $plugins = $manager->get_enrolment_plugins(false);
396         foreach ($instances as $key => $instance) {
397             if (!isset($plugins[$instance->enrol])) {
398                 // Weird, some broken stuff in plugin.
399                 continue;
400             }
401             $plugin = $plugins[$instance->enrol];
402             $bulkoperations = $plugin->get_bulk_operations($manager);
404             $pluginoptions = [];
405             foreach ($bulkoperations as $key => $bulkoperation) {
406                 $params = ['plugin' => $plugin->get_name(), 'operation' => $key];
407                 $url = new moodle_url('bulkchange.php', $params);
408                 $pluginoptions[$url->out(false)] = $bulkoperation->get_title();
409             }
410             if (!empty($pluginoptions)) {
411                 $name = get_string('pluginname', 'enrol_' . $plugin->get_name());
412                 $displaylist[] = [$name => $pluginoptions];
413             }
414         }
415     }
417     $selectactionparams = array(
418         'id' => 'formactionid',
419         'class' => 'ml-2',
420         'data-action' => 'toggle',
421         'data-togglegroup' => 'participants-table',
422         'data-toggle' => 'action',
423         'disabled' => 'disabled'
424     );
425     $label = html_writer::tag('label', get_string("withselectedusers"),
426             ['for' => 'formactionid', 'class' => 'col-form-label d-inline']);
427     $select = html_writer::select($displaylist, 'formaction', '', ['' => 'choosedots'], $selectactionparams);
428     echo html_writer::tag('div', $label . $select);
430     echo '<input type="hidden" name="id" value="' . $course->id . '" />';
431     echo '<div class="d-none" data-region="state-help-icon">' . $OUTPUT->help_icon('publishstate', 'notes') . '</div>';
432     echo '</div></div></div>';
433     echo '</form>';
435     $options = (object) [
436         'uniqueid' => $participanttable->uniqueid,
437         'noteStateNames' => note_get_state_names(),
438     ];
439     $PAGE->requires->js_call_amd('core_user/participants', 'init', [$options]);
442 echo '</div>';  // Userlist.
444 $enrolrenderer = $PAGE->get_renderer('core_enrol');
445 echo '<div class="float-right">';
446 // Need to re-generate the buttons to avoid having elements with duplicate ids on the page.
447 $enrolbuttons = $manager->get_manual_enrol_buttons();
448 foreach ($enrolbuttons as $enrolbutton) {
449     echo $enrolrenderer->render($enrolbutton);
451 echo '</div>';
453 if ($newcourse == 1) {
454     $str = get_string('proceedtocourse', 'enrol');
455     // The margin is to make it line up with the enrol users button when they are both on the same line.
456     $classes = 'my-1';
457     $url = course_get_url($course);
458     echo $OUTPUT->single_button($url, $str, 'GET', array('class' => $classes));
461 echo $OUTPUT->footer();