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