e75b0fd4ac62b03ea58a6f5dd9a3500c5c86d74c
[moodle.git] / admin / roles / override.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  * Lets you override role definitions in contexts.
19  *
20  * @package    core_role
21  * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require('../../config.php');
27 $contextid = required_param('contextid', PARAM_INT);
28 $roleid    = required_param('roleid', PARAM_INT);
30 list($context, $course, $cm) = get_context_info_array($contextid);
32 $url = new moodle_url('/admin/roles/override.php', array('contextid' => $contextid, 'roleid' => $roleid));
34 if ($course) {
35     $isfrontpage = ($course->id == SITEID);
36 } else {
37     $isfrontpage = false;
38     if ($context->contextlevel == CONTEXT_USER) {
39         $course = $DB->get_record('course', array('id'=>optional_param('courseid', SITEID, PARAM_INT)), '*', MUST_EXIST);
40         $user = $DB->get_record('user', array('id'=>$context->instanceid), '*', MUST_EXIST);
41         $url->param('courseid', $course->id);
42         $url->param('userid', $user->id);
43     } else {
44         $course = $SITE;
45     }
46 }
48 // Security first.
49 require_login($course, false, $cm);
50 $safeoverridesonly = false;
51 if (!has_capability('moodle/role:override', $context)) {
52     require_capability('moodle/role:safeoverride', $context);
53     $safeoverridesonly = true;
54 }
55 $PAGE->set_url($url);
56 $PAGE->set_context($context);
57 $PAGE->set_pagelayout('admin');
59 $courseid = $course->id;
61 $returnurl = new moodle_url('/admin/roles/permissions.php', array('contextid' => $context->id));
63 // Handle the cancel button.
64 if (optional_param('cancel', false, PARAM_BOOL)) {
65     redirect($returnurl);
66 }
68 $role = $DB->get_record('role', array('id'=>$roleid), '*', MUST_EXIST);
70 // These are needed early.
71 $assignableroles  = get_assignable_roles($context, ROLENAME_BOTH);
72 list($overridableroles, $overridecounts, $nameswithcounts) = get_overridable_roles($context, ROLENAME_BOTH, true);
74 // Work out an appropriate page title.
75 $contextname = $context->get_context_name();
76 $straction = get_string('overrideroles', 'core_role'); // Used by tabs.php.
77 $a = (object)array('context' => $contextname, 'role' => $overridableroles[$roleid]);
78 $title = get_string('overridepermissionsforrole', 'core_role', $a);
80 $currenttab = 'permissions';
82 $PAGE->set_title($title);
83 $PAGE->navbar->add($straction);
84 switch ($context->contextlevel) {
85     case CONTEXT_SYSTEM:
86         print_error('cannotoverridebaserole', 'error');
87         break;
88     case CONTEXT_USER:
89         $fullname = fullname($user, has_capability('moodle/site:viewfullnames', $context));
90         $PAGE->set_heading($fullname);
91         $showroles = 1;
92         break;
93     case CONTEXT_COURSECAT:
94         $PAGE->set_heading("$SITE->fullname: ".get_string("categories"));
95         break;
96     case CONTEXT_COURSE:
97         if ($isfrontpage) {
98             require_once($CFG->libdir.'/adminlib.php');
99             admin_externalpage_setup('frontpageroles', '', array(), $PAGE->url);
100         } else {
101             $PAGE->set_heading($course->fullname);
102         }
103         break;
104     case CONTEXT_MODULE:
105         $PAGE->set_heading($context->get_context_name(false));
106         $PAGE->set_cacheable(false);
107         break;
108     case CONTEXT_BLOCK:
109         $PAGE->set_heading($PAGE->course->fullname);
110         break;
113 // Make sure this user can override that role.
114 if (empty($overridableroles[$roleid])) {
115     $a = new stdClass;
116     $a->roleid = $roleid;
117     $a->context = $contextname;
118     print_error('cannotoverriderolehere', '', $context->get_url(), $a);
121 // If we are actually overriding a role, create the table object, and save changes if appropriate.
122 $overridestable = new core_role_override_permissions_table_advanced($context, $roleid, $safeoverridesonly);
123 $overridestable->read_submitted_permissions();
125 if (optional_param('savechanges', false, PARAM_BOOL) && confirm_sesskey()) {
126     $overridestable->save_changes();
127     $rolename = $overridableroles[$roleid];
128     // Trigger event.
129     $event = \core\event\role_capabilities_updated::create(
130         array(
131             'context' => $context,
132             'objectid' => $roleid,
133             'courseid' => $courseid
134         )
135     );
137     $event->set_legacy_logdata(
138         array(
139             $course->id, 'role', 'override', 'admin/roles/override.php?contextid=' . $context->id . '&roleid=' . $roleid,
140             $rolename, '', $USER->id
141         )
142     );
143     $event->add_record_snapshot('role', $role);
144     $event->trigger();
146     redirect($returnurl);
149 // Finally start page output.
150 echo $OUTPUT->header();
151 echo $OUTPUT->heading_with_help($title, 'overridepermissions', 'core_role');
153 // Show UI for overriding roles.
154 if (!empty($capabilities)) {
155     echo $OUTPUT->box(get_string('nocapabilitiesincontext', 'core_role'), 'generalbox boxaligncenter');
157 } else {
158     // Print the capabilities overrideable in this context.
159     echo $OUTPUT->box_start('generalbox capbox');
160     echo html_writer::start_tag('form', array('id'=>'overrideform', 'action'=>$PAGE->url->out(), 'method'=>'post'));
161     echo html_writer::start_tag('div');
162     echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey()));
163     echo html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'roleid', 'value'=>$roleid));
164     echo html_writer::tag('p', get_string('highlightedcellsshowinherit', 'core_role'), array('class'=>'overridenotice'));
166     $overridestable->display();
167     if ($overridestable->has_locked_capabilities()) {
168         echo '<p class="overridenotice">' . get_string('safeoverridenotice', 'core_role') . "</p>\n";
169     }
171     echo html_writer::start_tag('div', array('class'=>'submit_buttons'));
172     echo html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'savechanges', 'value'=>get_string('savechanges')));
173     echo html_writer::empty_tag('input', array('type'=>'submit', 'name'=>'cancel', 'value'=>get_string('cancel')));
174     echo html_writer::end_tag('div');
175     echo html_writer::end_tag('div');
176     echo html_writer::end_tag('form');
177     echo $OUTPUT->box_end();
180 // Print a form to swap roles, and a link back to the all roles list.
181 echo html_writer::start_tag('div', array('class'=>'backlink'));
182 $select = new single_select($PAGE->url, 'roleid', $nameswithcounts, $roleid, null);
183 $select->label = get_string('overrideanotherrole', 'core_role');
184 echo $OUTPUT->render($select);
185 echo html_writer::tag('p', html_writer::tag('a', get_string('backtoallroles', 'core_role'), array('href'=>$returnurl)));
186 echo html_writer::end_tag('div');
188 echo $OUTPUT->footer();