enrol/users.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  * Main course enrolment management UI, this is not compatible with frontpage course.
  19  *
  20  * @package    core
  21  * @subpackage enrol
  22  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 require('../config.php');
  27 require_once("$CFG->dirroot/enrol/locallib.php");
  28 require_once("$CFG->dirroot/enrol/users_forms.php");
  29 require_once("$CFG->dirroot/enrol/renderer.php");
  30 require_once("$CFG->dirroot/group/lib.php");
  31
  32 $id      = required_param('id', PARAM_INT); // course id
  33 $action  = optional_param('action', '', PARAM_ALPHANUMEXT);
  34 $filter  = optional_param('ifilter', 0, PARAM_INT);
  35 $search  = optional_param('search', '', PARAM_RAW);
  36 $role    = optional_param('role', 0, PARAM_INT);
  37
  38 // When users reset the form, redirect back to first page without other params.
  39 if (optional_param('resetbutton', '', PARAM_RAW) !== '') {
  40     redirect('users.php?id=' . $id);
  41 }
  42
  43 $course = $DB->get_record('course', array('id'=>$id), '*', MUST_EXIST);
  44 $context = context_course::instance($course->id, MUST_EXIST);
  45
  46 if ($course->id == SITEID) {
  47     redirect(new moodle_url('/'));
  48 }
  49
  50 require_login($course);
  51 require_capability('moodle/course:enrolreview', $context);
  52 $PAGE->set_pagelayout('admin');
  53
  54 $manager = new course_enrolment_manager($PAGE, $course, $filter, $role, $search);
  55 $table = new course_enrolment_users_table($manager, $PAGE);
  56 $PAGE->set_url('/enrol/users.php', $manager->get_url_params()+$table->get_url_params());
  57 navigation_node::override_active_url(new moodle_url('/enrol/users.php', array('id' => $id)));
  58
  59 // Check if there is an action to take
  60 if ($action) {
  61
  62     // Check if the page is confirmed (and sesskey is correct)
  63     $confirm = optional_param('confirm', false, PARAM_BOOL) && confirm_sesskey();
  64
  65     $actiontaken = false;
  66     $pagetitle = '';
  67     $pageheading = '';
  68     $mform = null;
  69     $pagecontent = null;
  70
  71     switch ($action) {
  72         /**
  73          * Removes a role from the user with this course
  74          */
  75         case 'unassign':
  76             if (has_capability('moodle/role:assign', $manager->get_context())) {
  77                 $role = required_param('role', PARAM_INT);
  78                 $user = required_param('user', PARAM_INT);
  79                 if ($confirm && $manager->unassign_role_from_user($user, $role)) {
  80                     redirect($PAGE->url);
  81                 } else {
  82                     $user = $DB->get_record('user', array('id'=>$user), '*', MUST_EXIST);
  83                     $allroles = $manager->get_all_roles();
  84                     $role = $allroles[$role];
  85                     $yesurl = new moodle_url($PAGE->url, array('action'=>'unassign', 'role'=>$role->id, 'user'=>$user->id, 'confirm'=>1, 'sesskey'=>sesskey()));
  86                     $message = get_string('unassignconfirm', 'role', array('user'=>fullname($user, true), 'role'=>$role->localname));
  87                     $pagetitle = get_string('unassignarole', 'role', $role->localname);
  88                     $pagecontent = $OUTPUT->confirm($message, $yesurl, $PAGE->url);
  89                 }
  90                 $actiontaken = true;
  91             }
  92             break;
  93         /**
  94          * Assigns a new role to a user enrolled within this course.
  95          * A user must be enrolled in the course in order for this script to action
  96          */
  97         case 'assign':
  98             $user = $DB->get_record('user', array('id'=>required_param('user', PARAM_INT)), '*', MUST_EXIST);
  99             if (is_enrolled($context, $user) && has_capability('moodle/role:assign', $manager->get_context())) {
 100                 $mform = new enrol_users_assign_form(NULL, array('user'=>$user, 'course'=>$course, 'assignable'=>$manager->get_assignable_roles()));
 101                 $mform->set_data($PAGE->url->params());
 102                 $data = $mform->get_data();
 103                 if ($mform->is_cancelled() || ($data && array_key_exists($data->roleid, $manager->get_assignable_roles()) && $manager->assign_role_to_user($data->roleid, $user->id))) {
 104                     redirect($PAGE->url);
 105                 } else {
 106                     $pagetitle = get_string('assignroles', 'role');
 107                 }
 108                 $actiontaken = true;
 109             }
 110             break;
 111         /**
 112          * Removes the user from the given group
 113          */
 114         case 'removemember':
 115             if (has_capability('moodle/course:managegroups', $manager->get_context())) {
 116                 $groupid = required_param('group', PARAM_INT);
 117                 $userid  = required_param('user', PARAM_INT);
 118                 $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
 119                 if ($confirm && $manager->remove_user_from_group($user, $groupid)) {
 120                     redirect($PAGE->url);
 121                 } else {
 122                     $group = $manager->get_group($groupid);
 123                     if (!$group) {
 124                         break;
 125                     }
 126                     $yesurl = new moodle_url($PAGE->url, array('action'=>'removemember', 'group'=>$groupid, 'user'=>$userid, 'confirm'=>1, 'sesskey'=>sesskey()));
 127                     $message = get_string('removefromgroupconfirm', 'group', array('user'=>fullname($user, true), 'group'=>$group->name));
 128                     $pagetitle = get_string('removefromgroup', 'group', $group->name);
 129                     $pagecontent = $OUTPUT->confirm($message, $yesurl, $PAGE->url);
 130                 }
 131                 $actiontaken = true;
 132             }
 133             break;
 134         /**
 135          * Makes the user a member of a given group
 136          */
 137         case 'addmember':
 138             if (has_capability('moodle/course:managegroups', $manager->get_context())) {
 139                 $userid = required_param('user', PARAM_INT);
 140                 $user = $DB->get_record('user', array('id'=>$userid), '*', MUST_EXIST);
 141
 142                 $mform = new enrol_users_addmember_form(NULL, array('user'=>$user, 'course'=>$course, 'allgroups'=>$manager->get_all_groups()));
 143                 $mform->set_data($PAGE->url->params());
 144                 $data = $mform->get_data();
 145                 if ($mform->is_cancelled() || ($data && $manager->add_user_to_group($user, $data->groupid))) {
 146                     redirect($PAGE->url);
 147                 } else {
 148                     $pagetitle = get_string('addgroup', 'group');
 149                 }
 150                 $actiontaken = true;
 151             }
 152             break;
 153     }
 154
 155     // If we took an action display we need to display something special.
 156     if ($actiontaken) {
 157         if (empty($pageheading)) {
 158             $pageheading = $pagetitle;
 159         }
 160         $PAGE->set_title($pagetitle);
 161         $PAGE->set_heading($pageheading);
 162         echo $OUTPUT->header();
 163         echo $OUTPUT->heading(fullname($user));
 164         if (!is_null($mform)) {
 165             $mform->display();
 166         } else {
 167             echo $pagecontent;
 168         }
 169         echo $OUTPUT->footer();
 170         exit;
 171     }
 172 }
 173
 174
 175 $renderer = $PAGE->get_renderer('core_enrol');
 176 $userdetails = array (
 177     'picture' => false,
 178     'firstname' => get_string('firstname'),
 179     'lastname' => get_string('lastname'),
 180 );
 181 $extrafields = get_extra_user_fields($context);
 182 foreach ($extrafields as $field) {
 183     $userdetails[$field] = get_user_field_name($field);
 184 }
 185
 186 $fields = array(
 187     'userdetails' => $userdetails,
 188     'lastseen' => get_string('lastaccess'),
 189     'role' => get_string('roles', 'role'),
 190     'group' => get_string('groups', 'group'),
 191     'enrol' => get_string('enrolmentinstances', 'enrol')
 192 );
 193
 194 // Remove hidden fields if the user has no access
 195 if (!has_capability('moodle/course:viewhiddenuserfields', $context)) {
 196     $hiddenfields = array_flip(explode(',', $CFG->hiddenuserfields));
 197     if (isset($hiddenfields['lastaccess'])) {
 198         unset($fields['lastseen']);
 199     }
 200     if (isset($hiddenfields['groups'])) {
 201         unset($fields['group']);
 202     }
 203 }
 204
 205 $filterform = new enrol_users_filter_form('users.php', array('manager' => $manager, 'id' => $id),
 206         'get', '', array('id' => 'filterform'));
 207 $filterform->set_data(array('search' => $search, 'ifilter' => $filter, 'role' => $role));
 208
 209 $table->set_fields($fields, $renderer);
 210
 211 $canassign = has_capability('moodle/role:assign', $manager->get_context());
 212 $users = $manager->get_users_for_display($manager, $table->sort, $table->sortdirection, $table->page, $table->perpage);
 213 foreach ($users as $userid=>&$user) {
 214     $user['picture'] = $OUTPUT->render($user['picture']);
 215     $user['role'] = $renderer->user_roles_and_actions($userid, $user['roles'], $manager->get_assignable_roles(), $canassign, $PAGE->url);
 216     $user['group'] = $renderer->user_groups_and_actions($userid, $user['groups'], $manager->get_all_groups(), has_capability('moodle/course:managegroups', $manager->get_context()), $PAGE->url);
 217     $user['enrol'] = $renderer->user_enrolments_and_actions($user['enrolments']);
 218 }
 219 $table->set_total_users($manager->get_total_users());
 220 $table->set_users($users);
 221
 222 $PAGE->set_title($PAGE->course->fullname.': '.get_string('totalenrolledusers', 'enrol', $manager->get_total_users()));
 223 $PAGE->set_heading($PAGE->title);
 224
 225 echo $OUTPUT->header();
 226 echo $OUTPUT->heading(get_string('enrolledusers', 'enrol'));
 227 echo $renderer->render_course_enrolment_users_table($table, $filterform);
 228 echo $OUTPUT->footer();