MDL-29602 accesslib improvements
[moodle.git] / admin / tool / capability / 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  * For a given capability, show what permission it has for every role, and
19  * everywhere that it is overridden.
20  *
21  * @package    tool
22  * @subpackage capability
23  * @copyright  2008 Tim Hunt
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 require_once(dirname(__FILE__) . '/../../../config.php');
28 require_once($CFG->libdir.'/adminlib.php');
30 // Check permissions.
31 require_login();
32 $systemcontext = get_context_instance(CONTEXT_SYSTEM);
33 require_capability('moodle/role:manage', $systemcontext);
35 // Get URL parameters.
36 $capability = optional_param('capability', '', PARAM_CAPABILITY);
37 $roleids = optional_param_array('roles', array('0'), PARAM_INTEGER);
39 // Clean the passed in list of role ids. If 'All' selected as an option, or
40 // if none were selected, do all roles.
41 $allroles = get_all_roles();
42 $cleanedroleids = array();
43 foreach ($roleids as $roleid) {
44     if ($roleid == 0) {
45         $cleanedroleids = array_keys($allroles);
46         break;
47     }
48     if (array_key_exists($roleid, $allroles)) {
49         $cleanedroleids[] = $roleid;
50     }
51 }
52 if (empty($cleanedroleids)) {
53     $cleanedroleids = array_keys($allroles);
54 }
56 // Include the required JavaScript.
57 $PAGE->requires->js_init_call('M.tool_capability.init', array(get_string('search')));
59 // Log.
60 add_to_log(SITEID, "admin", "tool capability", "tool/capability/index.php?capability=$capability", $capability);
62 // Print the header.
63 admin_externalpage_setup('toolcapability');
64 echo $OUTPUT->header();
66 // Prepare the list of capabilities to choose from
67 $allcapabilities = fetch_context_capabilities($systemcontext);
68 $capabilitychoices = array();
69 foreach ($allcapabilities as $cap) {
70     $capabilitychoices[$cap->name] = $cap->name . ': ' . get_capability_string($cap->name);
71 }
73 // Prepare the list of roles to choose from
74 $rolechoices = array('0' => get_string('all'));
75 foreach ($allroles as $role) {
76     $rolechoices[$role->id] = $role->name;
77 }
78 if (count($cleanedroleids) == count($allroles)) {
79     // Select 'All', rather than each role individually.
80     $selectedroleids = array('0');
81 } else {
82     $selectedroleids = $cleanedroleids;
83 }
85 // Print the settings form.
86 echo $OUTPUT->box_start('generalbox boxwidthwide boxaligncenter');
87 echo '<form method="get" action="" id="settingsform"><div>';
88 echo $OUTPUT->heading(get_string('reportsettings', 'tool_capability'));
89 echo '<p id="intro">', get_string('intro', 'tool_capability') , '</p>';
90 echo '<p><label for="menucapability"> ' . get_string('capabilitylabel', 'tool_capability') . '</label></p>';
91 echo  html_writer::select($capabilitychoices, 'capability', $capability, array(''=>'choose'), array('size'=>10));
92 echo '<p><label for="menuroles"> ' . get_string('roleslabel', 'tool_capability') . '</label></p>';
93 echo  html_writer::select($rolechoices, 'roles[]', $selectedroleids, false, array('size'=>10, 'multiple'=>'multiple'));
94 echo '<p><input type="submit" id="settingssubmit" value="' . get_string('getreport', 'tool_capability') . '" /></p>';
95 echo '</div></form>';
96 echo $OUTPUT->box_end();
98 // If we have a capability, generate the report.
99 if ($capability) {
101     // Work out the bits needed for the SQL WHERE clauses.
102     $params = array($capability);
103     $sqlroletest = '';
104     if (count($cleanedroleids) != count($allroles)) {
105         list($sqlroletest, $roleparams) = $DB->get_in_or_equal($cleanedroleids);
106         $params = array_merge($params, $roleparams);
107         $sqlroletest = 'AND roleid ' . $sqlroletest;
108     }
110     // Get all the role_capabilities rows for this capability - that is, all
111     // role definitions, and all role overrides.
112     $rolecaps = $DB->get_records_sql("
113             SELECT id, roleid, contextid, permission
114             FROM {role_capabilities}
115             WHERE capability = ? $sqlroletest", $params);
117     // In order to display a nice tree of contexts, we need to get all the
118     // ancestors of all the contexts in the query we just did.
119     $relevantpaths = $DB->get_records_sql_menu("
120             SELECT DISTINCT con.path, 1
121             FROM {context} con JOIN {role_capabilities} rc ON rc.contextid = con.id
122             WHERE capability = ? $sqlroletest", $params);
123     $requiredcontexts = array($systemcontext->id);
124     foreach ($relevantpaths as $path => $notused) {
125         $requiredcontexts = array_merge($requiredcontexts, explode('/', trim($path, '/')));
126     }
127     $requiredcontexts = array_unique($requiredcontexts);
129     // Now load those contexts.
130     list($sqlcontexttest, $contextparams) = $DB->get_in_or_equal($requiredcontexts);
131     $contexts = get_sorted_contexts('ctx.id ' . $sqlcontexttest, $contextparams);
133     // Prepare some empty arrays to hold the data we are about to compute.
134     foreach ($contexts as $conid => $con) {
135         $contexts[$conid]->children = array();
136         $contexts[$conid]->rolecapabilities = array();
137     }
139     // Put the contexts into a tree structure.
140     foreach ($contexts as $conid => $con) {
141         $context = context::instance_by_id($conid);
142         $parentcontextid = get_parent_contextid($context);
143         if ($parentcontextid) {
144             $contexts[$parentcontextid]->children[] = $conid;
145         }
146     }
148     // Put the role capabilities into the context tree.
149     foreach ($rolecaps as $rolecap) {
150         $contexts[$rolecap->contextid]->rolecapabilities[$rolecap->roleid] = $rolecap->permission;
151     }
153     // Fill in any missing rolecaps for the system context.
154     foreach ($cleanedroleids as $roleid) {
155         if (!isset($contexts[$systemcontext->id]->rolecapabilities[$roleid])) {
156             $contexts[$systemcontext->id]->rolecapabilities[$roleid] = CAP_INHERIT;
157         }
158     }
160     // Print the report heading.
161     echo $OUTPUT->heading(get_string('reportforcapability', 'tool_capability', get_capability_string($capability)), 2, 'main', 'report');
162     if (count($cleanedroleids) != count($allroles)) {
163         $rolenames = array();
164         foreach ($cleanedroleids as $roleid) {
165             $rolenames[] = $allroles[$roleid]->name;
166         }
167         echo '<p>', get_string('forroles', 'tool_capability', implode(', ', $rolenames)), '</p>';
168     }
170     // Now, recursively print the contexts, and the role information.
171     print_report_tree($systemcontext->id, $contexts, $allroles);
174 // Footer.
175 echo $OUTPUT->footer();
177 function print_report_tree($contextid, $contexts, $allroles) {
178     global $CFG;
180     // Array for holding lang strings.
181     static $strpermissions = null;
182     if (is_null($strpermissions)) {
183         $strpermissions = array(
184             CAP_INHERIT => get_string('notset','role'),
185             CAP_ALLOW => get_string('allow','role'),
186             CAP_PREVENT => get_string('prevent','role'),
187             CAP_PROHIBIT => get_string('prohibit','role')
188         );
189     }
191     // Start the list item, and print the context name as a link to the place to
192     // make changes.
193     if ($contextid == get_system_context()->id) {
194         $url = "$CFG->wwwroot/$CFG->admin/roles/manage.php";
195         $title = get_string('changeroles', 'tool_capability');
196     } else {
197         $url = "$CFG->wwwroot/$CFG->admin/roles/override.php?contextid=$contextid";
198         $title = get_string('changeoverrides', 'tool_capability');
199     }
200     $context = context::instance_by_id($contextid);
201     echo '<h3><a href="' . $url . '" title="' . $title . '">', $context->get_context_name(), '</a></h3>';
203     // If there are any role overrides here, print them.
204     if (!empty($contexts[$contextid]->rolecapabilities)) {
205         $rowcounter = 0;
206         echo '<table class="generaltable rolecaps"><tbody>';
207         foreach ($allroles as $role) {
208             if (isset($contexts[$contextid]->rolecapabilities[$role->id])) {
209                 $permission = $contexts[$contextid]->rolecapabilities[$role->id];
210                 echo '<tr class="r' . ($rowcounter % 2) . '"><th class="cell">', $role->name,
211                         '</th><td class="cell">' . $strpermissions[$permission] . '</td></tr>';
212                 $rowcounter++;
213             }
214         }
215         echo '</tbody></table>';
216     }
218     // After we have done the site context, change the string for CAP_INHERIT
219     // from 'notset' to 'inherit'.
220     $strpermissions[CAP_INHERIT] = get_string('inherit','role');
222     // If there are any child contexts, print them recursively.
223     if (!empty($contexts[$contextid]->children)) {
224         echo '<ul>';
225         foreach ($contexts[$contextid]->children as $childcontextid) {
226             echo '<li>';
227             print_report_tree($childcontextid, $contexts, $allroles);
228             echo '</li>';
229         }
230         echo '</ul>';
231     }