Merge branch 'MDL-59832_master-v2' of git://github.com/markn86/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->libdir.'/tablelib.php');
29 require_once($CFG->libdir.'/filelib.php');
30 require_once($CFG->dirroot.'/enrol/locallib.php');
32 define('DEFAULT_PAGE_SIZE', 20);
33 define('SHOW_ALL_PAGE_SIZE', 5000);
34 define('USER_FILTER_ENROLMENT', 1);
35 define('USER_FILTER_GROUP', 2);
36 define('USER_FILTER_LAST_ACCESS', 3);
37 define('USER_FILTER_ROLE', 4);
38 define('USER_FILTER_STATUS', 5);
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.
47 $PAGE->set_url('/user/index.php', array(
48         'page' => $page,
49         'perpage' => $perpage,
50         'contextid' => $contextid,
51         'id' => $courseid,
52         'newcourse' => $newcourse));
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);
68 require_login($course);
70 $systemcontext = context_system::instance();
71 $isfrontpage = ($course->id == SITEID);
73 $frontpagectx = context_course::instance(SITEID);
75 if ($isfrontpage) {
76     $PAGE->set_pagelayout('admin');
77     if (!has_any_capability(['moodle/site:viewparticipants', 'moodle/course:enrolreview'], $systemcontext)) {
78         // We know they do not have any of the capabilities, so lets throw an exception using the capability with the least access.
79         throw new required_capability_exception($systemcontext, 'moodle/site:viewparticipants', 'nopermissions', '');
80     }
81 } else {
82     $PAGE->set_pagelayout('incourse');
83     if (!has_any_capability(['moodle/course:viewparticipants', 'moodle/course:enrolreview'], $context)) {
84         // We know they do not have any of the capabilities, so lets throw an exception using the capability with the least access.
85         throw new required_capability_exception($context, 'moodle/course:viewparticipants', 'nopermissions', '');
86     }
87 }
89 // Trigger events.
90 user_list_view($course, $context);
92 $bulkoperations = has_capability('moodle/course:bulkmessaging', $context);
94 $PAGE->set_title("$course->shortname: ".get_string('participants'));
95 $PAGE->set_heading($course->fullname);
96 $PAGE->set_pagetype('course-view-' . $course->format);
97 $PAGE->add_body_class('path-user');                     // So we can style it independently.
98 $PAGE->set_other_editing_capability('moodle/course:manageactivities');
100 // Expand the users node in the settings navigation when it exists because those pages
101 // are related to this one.
102 $node = $PAGE->settingsnav->find('users', navigation_node::TYPE_CONTAINER);
103 if ($node) {
104     $node->force_open();
107 echo $OUTPUT->header();
108 echo $OUTPUT->heading(get_string('participants'));
110 // Get the currently applied filters.
111 $filtersapplied = optional_param_array('unified-filters', [], PARAM_TEXT);
113 // Default group ID.
114 $groupid = false;
115 $canaccessallgroups = has_capability('moodle/site:accessallgroups', $context);
116 if ($course->groupmode != NOGROUPS) {
117     if ($canaccessallgroups) {
118         // If the user can see all groups, set default to 0.
119         $groupid = 0;
120     } else {
121         // Otherwise, get the user's default group.
122         $groupid = groups_get_course_group($course, true);
123         if ($course->groupmode == SEPARATEGROUPS && !$groupid) {
124             // The user is not in the group so show message and exit.
125             echo $OUTPUT->notification(get_string('notingroup'));
126             echo $OUTPUT->footer();
127             exit;
128         }
129     }
131 $hasgroupfilter = false;
132 $lastaccess = 0;
133 $searchkeywords = [];
134 $roleid = 0;
135 $enrolid = 0;
136 $status = -1;
137 foreach ($filtersapplied as $filter) {
138     $filtervalue = explode(':', $filter, 2);
139     $value = null;
140     if (count($filtervalue) == 2) {
141         $key = clean_param($filtervalue[0], PARAM_INT);
142         $value = clean_param($filtervalue[1], PARAM_INT);
143     } else {
144         // Search string.
145         $key = clean_param($filtervalue[0], PARAM_TEXT);
146     }
148     switch ($key) {
149         case USER_FILTER_ENROLMENT:
150             $enrolid = $value;
151             break;
152         case USER_FILTER_GROUP:
153             $groupid = $value;
154             $hasgroupfilter = true;
155             break;
156         case USER_FILTER_LAST_ACCESS:
157             $lastaccess = $value;
158             break;
159         case USER_FILTER_ROLE:
160             $roleid = $value;
161             break;
162         case USER_FILTER_STATUS:
163             // We only accept active/suspended statuses.
164             if ($value == ENROL_USER_ACTIVE || $value == ENROL_USER_SUSPENDED) {
165                 $status = $value;
166             }
167             break;
168         default:
169             // Search string.
170             if (!empty($key) && empty($value)) {
171                 $searchkeywords[] = $key;
172             }
173             break;
174     }
177 // If course supports groups, but the user can't access all groups and there's no group filter set, apply a default group filter.
178 if ($groupid !== false && !$canaccessallgroups && !$hasgroupfilter) {
179     $filtersapplied[] = USER_FILTER_GROUP . ':' . $groupid;
182 // Manage enrolments.
183 $manager = new course_enrolment_manager($PAGE, $course);
184 $enrolbuttons = $manager->get_manual_enrol_buttons();
185 $enrolrenderer = $PAGE->get_renderer('core_enrol');
186 $enrolbuttonsout = '';
187 foreach ($enrolbuttons as $enrolbutton) {
188     $enrolbuttonsout .= $enrolrenderer->render($enrolbutton);
190 echo html_writer::div($enrolbuttonsout, 'pull-right');
192 // Render the unified filter.
193 $renderer = $PAGE->get_renderer('core_user');
194 echo $renderer->unified_filter($course, $context, $filtersapplied);
196 echo '<div class="userlist">';
198 // Should use this variable so that we don't break stuff every time a variable is added or changed.
199 $baseurl = new moodle_url('/user/index.php', array(
200         'contextid' => $context->id,
201         'id' => $course->id,
202         'perpage' => $perpage));
204 $participanttable = new \core_user\participants_table($course->id, $groupid, $lastaccess, $roleid, $enrolid, $status,
205     $searchkeywords, $bulkoperations, $selectall);
206 $participanttable->define_baseurl($baseurl);
208 // Do this so we can get the total number of rows.
209 ob_start();
210 $participanttable->out($perpage, true);
211 $participanttablehtml = ob_get_contents();
212 ob_end_clean();
214 if ($bulkoperations) {
215     echo '<form action="action_redir.php" method="post" id="participantsform">';
216     echo '<div>';
217     echo '<input type="hidden" name="sesskey" value="'.sesskey().'" />';
218     echo '<input type="hidden" name="returnto" value="'.s($PAGE->url->out(false)).'" />';
221 echo $participanttablehtml;
223 $perpageurl = clone($baseurl);
224 $perpageurl->remove_params('perpage');
225 if ($perpage == SHOW_ALL_PAGE_SIZE && $participanttable->totalrows > DEFAULT_PAGE_SIZE) {
226     $perpageurl->param('perpage', DEFAULT_PAGE_SIZE);
227     echo $OUTPUT->container(html_writer::link($perpageurl, get_string('showperpage', '', DEFAULT_PAGE_SIZE)), array(), 'showall');
229 } else if ($participanttable->get_page_size() < $participanttable->totalrows) {
230     $perpageurl->param('perpage', SHOW_ALL_PAGE_SIZE);
231     echo $OUTPUT->container(html_writer::link($perpageurl, get_string('showall', '', $participanttable->totalrows)),
232         array(), 'showall');
235 if ($bulkoperations) {
236     echo '<br /><div class="buttons">';
238     if ($participanttable->get_page_size() < $participanttable->totalrows) {
239         $perpageurl = clone($baseurl);
240         $perpageurl->remove_params('perpage');
241         $perpageurl->param('perpage', SHOW_ALL_PAGE_SIZE);
242         $perpageurl->param('selectall', true);
243         $showalllink = $perpageurl;
244     } else {
245         $showalllink = false;
246     }
248     echo html_writer::start_tag('div', array('class' => 'btn-group'));
249     if ($participanttable->get_page_size() < $participanttable->totalrows) {
250         // Select all users, refresh page showing all users and mark them all selected.
251         $label = get_string('selectalluserswithcount', 'moodle', $participanttable->totalrows);
252         echo html_writer::tag('input', "", array('type' => 'button', 'id' => 'checkall', 'class' => 'btn btn-secondary',
253                 'value' => $label, 'data-showallink' => $showalllink));
254         // Select all users, mark all users on page as selected.
255         echo html_writer::tag('input', "", array('type' => 'button', 'id' => 'checkallonpage', 'class' => 'btn btn-secondary',
256         'value' => get_string('selectallusersonpage')));
257     } else {
258         echo html_writer::tag('input', "", array('type' => 'button', 'id' => 'checkallonpage', 'class' => 'btn btn-secondary',
259         'value' => get_string('selectall')));
260     }
262     echo html_writer::tag('input', "", array('type' => 'button', 'id' => 'checknone', 'class' => 'btn btn-secondary',
263         'value' => get_string('deselectall')));
264     echo html_writer::end_tag('div');
265     $displaylist = array();
266     $displaylist['messageselect.php'] = get_string('messageselectadd');
267     if (!empty($CFG->enablenotes) && has_capability('moodle/notes:manage', $context) && $context->id != $frontpagectx->id) {
268         $displaylist['addnote.php'] = get_string('addnewnote', 'notes');
269         $displaylist['groupaddnote.php'] = get_string('groupaddnewnote', 'notes');
270     }
272     if ($context->id != $frontpagectx->id) {
273         $instances = $manager->get_enrolment_instances();
274         $plugins = $manager->get_enrolment_plugins(false);
275         foreach ($instances as $key => $instance) {
276             if (!isset($plugins[$instance->enrol])) {
277                 // Weird, some broken stuff in plugin.
278                 continue;
279             }
280             $plugin = $plugins[$instance->enrol];
281             $bulkoperations = $plugin->get_bulk_operations($manager);
283             $pluginoptions = [];
284             foreach ($bulkoperations as $key => $bulkoperation) {
285                 $params = ['plugin' => $plugin->get_name(), 'operation' => $key];
286                 $url = new moodle_url('bulkchange.php', $params);
287                 $pluginoptions[$url->out(false)] = $bulkoperation->get_title();
288             }
289             if (!empty($pluginoptions)) {
290                 $name = get_string('pluginname', 'enrol_' . $plugin->get_name());
291                 $displaylist[] = [$name => $pluginoptions];
292             }
293         }
294     }
296     echo $OUTPUT->help_icon('withselectedusers');
297     echo html_writer::tag('label', get_string("withselectedusers"), array('for' => 'formactionid'));
298     echo html_writer::select($displaylist, 'formaction', '', array('' => 'choosedots'), array('id' => 'formactionid'));
300     echo '<input type="hidden" name="id" value="'.$course->id.'" />';
301     echo '<noscript style="display:inline">';
302     echo '<div><input type="submit" value="'.get_string('ok').'" /></div>';
303     echo '</noscript>';
304     echo '</div></div>';
305     echo '</form>';
307     $module = array('name' => 'core_user', 'fullpath' => '/user/module.js');
308     $PAGE->requires->js_init_call('M.core_user.init_participation', null, false, $module);
311 echo '</div>';  // Userlist.
313 $enrolrenderer = $PAGE->get_renderer('core_enrol');
314 echo '<div class="pull-right">';
315 foreach ($enrolbuttons as $enrolbutton) {
316     echo $enrolrenderer->render($enrolbutton);
318 echo '</div>';
320 if ($newcourse == 1) {
321     $str = get_string('proceedtocourse', 'enrol');
322     // Floated left so it goes under the enrol users button on mobile.
323     // The margin is to make it line up with the enrol users button when they are both on the same line.
324     $classes = 'm-y-1 pull-xs-left';
325     $url = course_get_url($course);
326     echo $OUTPUT->single_button($url, $str, 'GET', array('class' => $classes));
329 echo $OUTPUT->footer();