admin/roles/usersroles.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * User roles report list all the users who have been assigned a particular
  20  * role in all contexts.
  21  *
  22  * @package    core
  23  * @subpackage role
  24  * @copyright  &copy; 2007 The Open University and others
  25  * @author     t.j.hunt@open.ac.uk and others
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28
  29 require_once(dirname(__FILE__) . '/../../config.php');
  30
  31 // Get params.
  32 $userid = required_param('userid', PARAM_INT);
  33 $courseid = required_param('courseid', PARAM_INT);
  34
  35 // Validate them and get the corresponding objects.
  36 $user = $DB->get_record('user', array('id' => $userid), '*', MUST_EXIST);
  37 $course = $DB->get_record('course', array('id' => $courseid), '*', MUST_EXIST);
  38
  39 $usercontext = get_context_instance(CONTEXT_USER, $user->id);
  40 $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id);
  41 $systemcontext = get_context_instance(CONTEXT_SYSTEM);
  42
  43 $baseurl = new moodle_url('/admin/roles/usersroles.php', array('userid'=>$userid, 'courseid'=>$courseid));
  44
  45 $PAGE->set_url($baseurl);
  46 $PAGE->set_context($coursecontext);
  47 $PAGE->set_pagelayout('admin');
  48
  49 /// Check login and permissions.
  50 require_login($course);
  51 $canview = has_any_capability(array('moodle/role:assign', 'moodle/role:safeoverride',
  52         'moodle/role:override', 'moodle/role:manage'), $usercontext);
  53 if (!$canview) {
  54     print_error('nopermissions', 'error', '', get_string('checkpermissions', 'role'));
  55 }
  56
  57 /// Now get the role assignments for this user.
  58 $sql = "SELECT
  59         ra.id, ra.userid, ra.contextid, ra.roleid, ra.component, ra.itemid,
  60         c.path,
  61         r.name AS rolename,
  62         COALESCE(rn.name, r.name) AS localname
  63     FROM
  64         {role_assignments} ra
  65         JOIN {context} c ON ra.contextid = c.id
  66         JOIN {role} r ON ra.roleid = r.id
  67         LEFT JOIN {role_names} rn ON rn.roleid = ra.roleid AND rn.contextid = ra.contextid
  68     WHERE
  69         ra.userid = ?
  70     "./*AND ra.active = 1*/"
  71     ORDER BY
  72         contextlevel DESC, contextid ASC, r.sortorder ASC";
  73 $roleassignments = $DB->get_records_sql($sql, array($user->id));
  74
  75 /// In order to display a nice tree of contexts, we need to get all the
  76 /// ancestors of all the contexts in the query we just did.
  77 $requiredcontexts = array();
  78 foreach ($roleassignments as $ra) {
  79     $requiredcontexts = array_merge($requiredcontexts, explode('/', trim($ra->path, '/')));
  80 }
  81 $requiredcontexts = array_unique($requiredcontexts);
  82
  83 /// Now load those contexts.
  84 if ($requiredcontexts) {
  85     list($sqlcontexttest, $contextparams) = $DB->get_in_or_equal($requiredcontexts);
  86     $contexts = get_sorted_contexts('ctx.id ' . $sqlcontexttest, $contextparams);
  87 } else {
  88     $contexts = array();
  89 }
  90
  91 /// Prepare some empty arrays to hold the data we are about to compute.
  92 foreach ($contexts as $conid => $con) {
  93     $contexts[$conid]->children = array();
  94     $contexts[$conid]->roleassignments = array();
  95 }
  96
  97 /// Put the contexts into a tree structure.
  98 foreach ($contexts as $conid => $con) {
  99     $context = context::instance_by_id($conid);
 100     $parentcontextid = get_parent_contextid($context);
 101     if ($parentcontextid) {
 102         $contexts[$parentcontextid]->children[] = $conid;
 103     }
 104 }
 105
 106 /// Put the role capabilities into the context tree.
 107 foreach ($roleassignments as $ra) {
 108     $contexts[$ra->contextid]->roleassignments[$ra->roleid] = $ra;
 109 }
 110
 111 $assignableroles = get_assignable_roles($usercontext, ROLENAME_BOTH);
 112 $overridableroles = get_overridable_roles($usercontext, ROLENAME_BOTH);
 113
 114 /// Print the header
 115 $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $coursecontext));
 116 $straction = get_string('thisusersroles', 'role');
 117 $title = get_string('xroleassignments', 'role', $fullname);
 118
 119 /// Course header
 120 $PAGE->set_title($title);
 121 if ($courseid != SITEID) {
 122     $PAGE->set_heading($fullname);
 123     if (has_capability('moodle/course:viewparticipants', $coursecontext)) {
 124         $PAGE->navbar->add(get_string('participants'),new moodle_url('/user/index.php', array('id'=>$courseid)));
 125     }
 126 } else {
 127     $PAGE->set_heading($course->fullname);
 128 }
 129 $PAGE->navbar->add($fullname, new moodle_url("$CFG->wwwroot/user/view.php", array('id'=>$userid,'course'=>$courseid)));
 130 $PAGE->navbar->add($straction);
 131 echo $OUTPUT->header();
 132 echo $OUTPUT->heading($title, 3);
 133 echo $OUTPUT->box_start('generalbox boxaligncenter boxwidthnormal');
 134
 135 // Display them.
 136 if (!$roleassignments) {
 137     echo '<p>', get_string('noroleassignments', 'role'), '</p>';
 138 } else {
 139     print_report_tree($systemcontext->id, $contexts, $systemcontext, $fullname);
 140 }
 141
 142 /// End of page.
 143 echo $OUTPUT->box_end();
 144 echo $OUTPUT->footer();
 145
 146 function print_report_tree($contextid, $contexts, $systemcontext, $fullname) {
 147     global $CFG, $OUTPUT;
 148
 149     // Only compute lang strings, etc once.
 150     static $stredit = null, $strcheckpermissions, $globalroleassigner, $assignurl, $checkurl;
 151     if (is_null($stredit)) {
 152         $stredit = get_string('edit');
 153         $strcheckpermissions = get_string('checkpermissions', 'role');
 154         $globalroleassigner = has_capability('moodle/role:assign', $systemcontext);
 155         $assignurl = $CFG->wwwroot . '/' . $CFG->admin . '/roles/assign.php';
 156         $checkurl = $CFG->wwwroot . '/' . $CFG->admin . '/roles/check.php';
 157     }
 158
 159     // Pull the current context into an array for convinience.
 160     $context = context::instance_by_id($contextid);
 161
 162     // Print the context name.
 163     echo $OUTPUT->heading($context->get_context_name(), 4, 'contextname');
 164
 165     // If there are any role assignments here, print them.
 166     foreach ($contexts[$contextid]->roleassignments as $ra) {
 167         $value = $ra->contextid . ',' . $ra->roleid;
 168         $inputid = 'unassign' . $value;
 169
 170         echo '<p>';
 171         if ($ra->rolename == $ra->localname) {
 172             echo strip_tags(format_string($ra->localname));
 173         } else {
 174             echo strip_tags(format_string($ra->localname . ' (' . $ra->rolename . ')'));
 175         }
 176         if (has_capability('moodle/role:assign', $context)) {
 177             $raurl = $assignurl . '?contextid=' . $ra->contextid . '&amp;roleid=' .
 178                     $ra->roleid . '&amp;removeselect[]=' . $ra->userid;
 179             $churl = $checkurl . '?contextid=' . $ra->contextid . '&amp;reportuser=' . $ra->userid;
 180             if ($context->contextlevel == CONTEXT_USER) {
 181                 $raurl .= '&amp;userid=' . $context->instanceid;
 182                 $churl .= '&amp;userid=' . $context->instanceid;
 183             }
 184             $a = new stdClass;
 185             $a->fullname = $fullname;
 186             $a->contextlevel = get_contextlevel_name($context->contextlevel);
 187             if ($context->contextlevel == CONTEXT_SYSTEM) {
 188                 $strgoto = get_string('gotoassignsystemroles', 'role');
 189                 $strcheck = get_string('checksystempermissionsfor', 'role', $a);
 190             } else {
 191                 $strgoto = get_string('gotoassignroles', 'role', $a);
 192                 $strcheck = get_string('checkuserspermissionshere', 'role', $a);
 193             }
 194             echo ' <a title="' . $strgoto . '" href="' . $raurl . '"><img class="iconsmall" src="' .
 195                     $OUTPUT->pix_url('t/edit') . '" alt="' . $stredit . '" /></a> ';
 196             echo ' <a title="' . $strcheck . '" href="' . $churl . '"><img class="iconsmall" src="' .
 197                     $OUTPUT->pix_url('t/preview') . '" alt="' . $strcheckpermissions . '" /></a> ';
 198             echo "</p>\n";
 199         }
 200     }
 201
 202     // If there are any child contexts, print them recursively.
 203     if (!empty($contexts[$contextid]->children)) {
 204         echo '<ul>';
 205         foreach ($contexts[$contextid]->children as $childcontextid) {
 206             echo '<li>';
 207             print_report_tree($childcontextid, $contexts, $systemcontext, $fullname);
 208             echo '</li>';
 209         }
 210         echo '</ul>';
 211     }
 212 }