2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * This file contains functions for managing user access
20 * <b>Public API vs internals</b>
22 * General users probably only care about
25 * - context_course::instance($courseid), context_module::instance($cm->id), context_coursecat::instance($catid)
26 * - context::instance_by_id($contextid)
27 * - $context->get_parent_contexts();
28 * - $context->get_child_contexts();
30 * Whether the user can do something...
32 * - has_any_capability()
33 * - has_all_capabilities()
34 * - require_capability()
35 * - require_login() (from moodlelib)
43 * What courses has this user access to?
44 * - get_enrolled_users()
46 * What users can do X in this context?
47 * - get_enrolled_users() - at and bellow course context
48 * - get_users_by_capability() - above course context
53 * - role_unassign_all()
55 * Advanced - for internal use only
56 * - load_all_capabilities()
57 * - reload_all_capabilities()
58 * - has_capability_in_accessdata()
59 * - get_user_roles_sitewide_accessdata()
62 * <b>Name conventions</b>
65 * "ra" means role assignment
66 * "rdef" means role definition
70 * Access control data is held in the "accessdata" array
71 * which - for the logged-in user, will be in $USER->access
73 * For other users can be generated and passed around (but may also be cached
74 * against userid in $ACCESSLIB_PRIVATE->accessdatabyuser).
76 * $accessdata is a multidimensional array, holding
77 * role assignments (RAs), role switches and initialization time.
79 * Things are keyed on "contextpaths" (the path field of
80 * the context table) for fast walking up/down the tree.
82 * $accessdata['ra'][$contextpath] = array($roleid=>$roleid)
83 * [$contextpath] = array($roleid=>$roleid)
84 * [$contextpath] = array($roleid=>$roleid)
87 * <b>Stale accessdata</b>
89 * For the logged-in user, accessdata is long-lived.
91 * On each pageload we load $ACCESSLIB_PRIVATE->dirtycontexts which lists
92 * context paths affected by changes. Any check at-or-below
93 * a dirty context will trigger a transparent reload of accessdata.
95 * Changes at the system level will force the reload for everyone.
97 * <b>Default role caps</b>
98 * The default role assignment is not in the DB, so we
99 * add it manually to accessdata.
101 * This means that functions that work directly off the
102 * DB need to ensure that the default role caps
103 * are dealt with appropriately.
105 * @package core_access
106 * @copyright 1999 onwards Martin Dougiamas http://dougiamas.com
107 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
110 defined('MOODLE_INTERNAL') ||
die();
112 /** No capability change */
113 define('CAP_INHERIT', 0);
114 /** Allow permission, overrides CAP_PREVENT defined in parent contexts */
115 define('CAP_ALLOW', 1);
116 /** Prevent permission, overrides CAP_ALLOW defined in parent contexts */
117 define('CAP_PREVENT', -1);
118 /** Prohibit permission, overrides everything in current and child contexts */
119 define('CAP_PROHIBIT', -1000);
121 /** System context level - only one instance in every system */
122 define('CONTEXT_SYSTEM', 10);
123 /** User context level - one instance for each user describing what others can do to user */
124 define('CONTEXT_USER', 30);
125 /** Course category context level - one instance for each category */
126 define('CONTEXT_COURSECAT', 40);
127 /** Course context level - one instances for each course */
128 define('CONTEXT_COURSE', 50);
129 /** Course module context level - one instance for each course module */
130 define('CONTEXT_MODULE', 70);
132 * Block context level - one instance for each block, sticky blocks are tricky
133 * because ppl think they should be able to override them at lower contexts.
134 * Any other context level instance can be parent of block context.
136 define('CONTEXT_BLOCK', 80);
138 /** Capability allow management of trusts - NOT IMPLEMENTED YET - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
139 define('RISK_MANAGETRUST', 0x0001);
140 /** Capability allows changes in system configuration - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
141 define('RISK_CONFIG', 0x0002);
142 /** Capability allows user to add scripted content - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
143 define('RISK_XSS', 0x0004);
144 /** Capability allows access to personal user information - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
145 define('RISK_PERSONAL', 0x0008);
146 /** Capability allows users to add content others may see - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
147 define('RISK_SPAM', 0x0010);
148 /** capability allows mass delete of data belonging to other users - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
149 define('RISK_DATALOSS', 0x0020);
151 /** rolename displays - the name as defined in the role definition, localised if name empty */
152 define('ROLENAME_ORIGINAL', 0);
153 /** rolename displays - the name as defined by a role alias at the course level, falls back to ROLENAME_ORIGINAL if alias not present */
154 define('ROLENAME_ALIAS', 1);
155 /** rolename displays - Both, like this: Role alias (Original) */
156 define('ROLENAME_BOTH', 2);
157 /** rolename displays - the name as defined in the role definition and the shortname in brackets */
158 define('ROLENAME_ORIGINALANDSHORT', 3);
159 /** rolename displays - the name as defined by a role alias, in raw form suitable for editing */
160 define('ROLENAME_ALIAS_RAW', 4);
161 /** rolename displays - the name is simply short role name */
162 define('ROLENAME_SHORT', 5);
164 if (!defined('CONTEXT_CACHE_MAX_SIZE')) {
165 /** maximum size of context cache - it is possible to tweak this config.php or in any script before inclusion of context.php */
166 define('CONTEXT_CACHE_MAX_SIZE', 2500);
170 * Although this looks like a global variable, it isn't really.
172 * It is just a private implementation detail to accesslib that MUST NOT be used elsewhere.
173 * It is used to cache various bits of data between function calls for performance reasons.
174 * Sadly, a PHP global variable is the only way to implement this, without rewriting everything
175 * as methods of a class, instead of functions.
178 * @global stdClass $ACCESSLIB_PRIVATE
179 * @name $ACCESSLIB_PRIVATE
181 global $ACCESSLIB_PRIVATE;
182 $ACCESSLIB_PRIVATE = new stdClass();
183 $ACCESSLIB_PRIVATE->cacheroledefs
= array(); // Holds site-wide role definitions.
184 $ACCESSLIB_PRIVATE->dirtycontexts
= null; // Dirty contexts cache, loaded from DB once per page
185 $ACCESSLIB_PRIVATE->dirtyusers
= null; // Dirty users cache, loaded from DB once per $USER->id
186 $ACCESSLIB_PRIVATE->accessdatabyuser
= array(); // Holds the cache of $accessdata structure for users (including $USER)
189 * Clears accesslib's private caches. ONLY BE USED BY UNIT TESTS
191 * This method should ONLY BE USED BY UNIT TESTS. It clears all of
192 * accesslib's private caches. You need to do this before setting up test data,
193 * and also at the end of the tests.
198 function accesslib_clear_all_caches_for_unit_testing() {
201 throw new coding_exception('You must not call clear_all_caches outside of unit tests.');
204 accesslib_clear_all_caches(true);
205 accesslib_reset_role_cache();
207 unset($USER->access
);
211 * Clears accesslib's private caches. ONLY BE USED FROM THIS LIBRARY FILE!
213 * This reset does not touch global $USER.
216 * @param bool $resetcontexts
219 function accesslib_clear_all_caches($resetcontexts) {
220 global $ACCESSLIB_PRIVATE;
222 $ACCESSLIB_PRIVATE->dirtycontexts
= null;
223 $ACCESSLIB_PRIVATE->dirtyusers
= null;
224 $ACCESSLIB_PRIVATE->accessdatabyuser
= array();
226 if ($resetcontexts) {
227 context_helper
::reset_caches();
232 * Full reset of accesslib's private role cache. ONLY TO BE USED FROM THIS LIBRARY FILE!
234 * This reset does not touch global $USER.
236 * Note: Only use this when the roles that need a refresh are unknown.
238 * @see accesslib_clear_role_cache()
243 function accesslib_reset_role_cache() {
244 global $ACCESSLIB_PRIVATE;
246 $ACCESSLIB_PRIVATE->cacheroledefs
= array();
247 $cache = cache
::make('core', 'roledefs');
252 * Clears accesslib's private cache of a specific role or roles. ONLY BE USED FROM THIS LIBRARY FILE!
254 * This reset does not touch global $USER.
257 * @param int|array $roles
260 function accesslib_clear_role_cache($roles) {
261 global $ACCESSLIB_PRIVATE;
263 if (!is_array($roles)) {
267 foreach ($roles as $role) {
268 if (isset($ACCESSLIB_PRIVATE->cacheroledefs
[$role])) {
269 unset($ACCESSLIB_PRIVATE->cacheroledefs
[$role]);
273 $cache = cache
::make('core', 'roledefs');
274 $cache->delete_many($roles);
278 * Role is assigned at system context.
284 function get_role_access($roleid) {
285 $accessdata = get_empty_accessdata();
286 $accessdata['ra']['/'.SYSCONTEXTID
] = array((int)$roleid => (int)$roleid);
291 * Fetch raw "site wide" role definitions.
292 * Even MUC static acceleration cache appears a bit slow for this.
293 * Important as can be hit hundreds of times per page.
295 * @param array $roleids List of role ids to fetch definitions for.
296 * @return array Complete definition for each requested role.
298 function get_role_definitions(array $roleids) {
299 global $ACCESSLIB_PRIVATE;
301 if (empty($roleids)) {
305 // Grab all keys we have not yet got in our static cache.
306 if ($uncached = array_diff($roleids, array_keys($ACCESSLIB_PRIVATE->cacheroledefs
))) {
307 $cache = cache
::make('core', 'roledefs');
308 foreach ($cache->get_many($uncached) as $roleid => $cachedroledef) {
309 if (is_array($cachedroledef)) {
310 $ACCESSLIB_PRIVATE->cacheroledefs
[$roleid] = $cachedroledef;
314 // Check we have the remaining keys from the MUC.
315 if ($uncached = array_diff($roleids, array_keys($ACCESSLIB_PRIVATE->cacheroledefs
))) {
316 $uncached = get_role_definitions_uncached($uncached);
317 $ACCESSLIB_PRIVATE->cacheroledefs +
= $uncached;
318 $cache->set_many($uncached);
322 // Return just the roles we need.
323 return array_intersect_key($ACCESSLIB_PRIVATE->cacheroledefs
, array_flip($roleids));
327 * Query raw "site wide" role definitions.
329 * @param array $roleids List of role ids to fetch definitions for.
330 * @return array Complete definition for each requested role.
332 function get_role_definitions_uncached(array $roleids) {
335 if (empty($roleids)) {
339 // Create a blank results array: even if a role has no capabilities,
340 // we need to ensure it is included in the results to show we have
341 // loaded all the capabilities that there are.
343 foreach ($roleids as $roleid) {
344 $rdefs[$roleid] = array();
347 // Load all the capabilities for these roles in all contexts.
348 list($sql, $params) = $DB->get_in_or_equal($roleids);
349 $sql = "SELECT ctx.path, rc.roleid, rc.capability, rc.permission
350 FROM {role_capabilities} rc
351 JOIN {context} ctx ON rc.contextid = ctx.id
352 JOIN {capabilities} cap ON rc.capability = cap.name
353 WHERE rc.roleid $sql";
354 $rs = $DB->get_recordset_sql($sql, $params);
356 // Store the capabilities into the expected data structure.
357 foreach ($rs as $rd) {
358 if (!isset($rdefs[$rd->roleid
][$rd->path
])) {
359 $rdefs[$rd->roleid
][$rd->path
] = array();
361 $rdefs[$rd->roleid
][$rd->path
][$rd->capability
] = (int) $rd->permission
;
366 // Sometimes (e.g. get_user_capability_course_helper::get_capability_info_at_each_context)
367 // we process role definitinons in a way that requires we see parent contexts
368 // before child contexts. This sort ensures that works (and is faster than
369 // sorting in the SQL query).
370 foreach ($rdefs as $roleid => $rdef) {
371 ksort($rdefs[$roleid]);
378 * Get the default guest role, this is used for guest account,
379 * search engine spiders, etc.
381 * @return stdClass role record
383 function get_guest_role() {
386 if (empty($CFG->guestroleid
)) {
387 if ($roles = $DB->get_records('role', array('archetype'=>'guest'))) {
388 $guestrole = array_shift($roles); // Pick the first one
389 set_config('guestroleid', $guestrole->id
);
392 debugging('Can not find any guest role!');
396 if ($guestrole = $DB->get_record('role', array('id'=>$CFG->guestroleid
))) {
399 // somebody is messing with guest roles, remove incorrect setting and try to find a new one
400 set_config('guestroleid', '');
401 return get_guest_role();
407 * Check whether a user has a particular capability in a given context.
410 * $context = context_module::instance($cm->id);
411 * has_capability('mod/forum:replypost', $context)
413 * By default checks the capabilities of the current user, but you can pass a
414 * different userid. By default will return true for admin users, but you can override that with the fourth argument.
416 * Guest and not-logged-in users can never get any dangerous capability - that is any write capability
417 * or capabilities with XSS, config or data loss risks.
421 * @param string $capability the name of the capability to check. For example mod/forum:view
422 * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
423 * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
424 * @param boolean $doanything If false, ignores effect of admin role assignment
425 * @return boolean true if the user has this capability. Otherwise false.
427 function has_capability($capability, context
$context, $user = null, $doanything = true) {
428 global $USER, $CFG, $SCRIPT, $ACCESSLIB_PRIVATE;
430 if (during_initial_install()) {
431 if ($SCRIPT === "/$CFG->admin/index.php"
432 or $SCRIPT === "/$CFG->admin/cli/install.php"
433 or $SCRIPT === "/$CFG->admin/cli/install_database.php"
434 or (defined('BEHAT_UTIL') and BEHAT_UTIL
)
435 or (defined('PHPUNIT_UTIL') and PHPUNIT_UTIL
)) {
436 // we are in an installer - roles can not work yet
443 if (strpos($capability, 'moodle/legacy:') === 0) {
444 throw new coding_exception('Legacy capabilities can not be used any more!');
447 if (!is_bool($doanything)) {
448 throw new coding_exception('Capability parameter "doanything" is wierd, only true or false is allowed. This has to be fixed in code.');
451 // capability must exist
452 if (!$capinfo = get_capability_info($capability)) {
453 debugging('Capability "'.$capability.'" was not found! This has to be fixed in code.');
457 if (!isset($USER->id
)) {
458 // should never happen
460 debugging('Capability check being performed on a user with no ID.', DEBUG_DEVELOPER
);
463 // make sure there is a real user specified
464 if ($user === null) {
467 $userid = is_object($user) ?
$user->id
: $user;
470 // make sure forcelogin cuts off not-logged-in users if enabled
471 if (!empty($CFG->forcelogin
) and $userid == 0) {
475 // make sure the guest account and not-logged-in users never get any risky caps no matter what the actual settings are.
476 if (($capinfo->captype
=== 'write') or ($capinfo->riskbitmask
& (RISK_XSS | RISK_CONFIG | RISK_DATALOSS
))) {
477 if (isguestuser($userid) or $userid == 0) {
482 // Check whether context locking is enabled.
483 if (!empty($CFG->contextlocking
)) {
484 if ($capinfo->captype
=== 'write' && $context->locked
) {
485 // Context locking applies to any write capability in a locked context.
486 // It does not apply to moodle/site:managecontextlocks - this is to allow context locking to be unlocked.
487 if ($capinfo->name
!== 'moodle/site:managecontextlocks') {
488 // It applies to all users who are not site admins.
489 // It also applies to site admins when contextlockappliestoadmin is set.
490 if (!is_siteadmin($userid) ||
!empty($CFG->contextlockappliestoadmin
)) {
497 // somehow make sure the user is not deleted and actually exists
499 if ($userid == $USER->id
and isset($USER->deleted
)) {
500 // this prevents one query per page, it is a bit of cheating,
501 // but hopefully session is terminated properly once user is deleted
502 if ($USER->deleted
) {
506 if (!context_user
::instance($userid, IGNORE_MISSING
)) {
507 // no user context == invalid userid
513 // context path/depth must be valid
514 if (empty($context->path
) or $context->depth
== 0) {
515 // this should not happen often, each upgrade tries to rebuild the context paths
516 debugging('Context id '.$context->id
.' does not have valid path, please use context_helper::build_all_paths()');
517 if (is_siteadmin($userid)) {
524 if (!empty($USER->loginascontext
)) {
525 // The current user is logged in as another user and can assume their identity at or below the `loginascontext`
526 // defined in the USER session.
527 // The user may not assume their identity at any other location.
528 if (!$USER->loginascontext
->is_parent_of($context, true)) {
529 // The context being checked is not the specified context, or one of its children.
534 // Find out if user is admin - it is not possible to override the doanything in any way
535 // and it is not possible to switch to admin role either.
537 if (is_siteadmin($userid)) {
538 if ($userid != $USER->id
) {
541 // make sure switchrole is not used in this context
542 if (empty($USER->access
['rsw'])) {
545 $parts = explode('/', trim($context->path
, '/'));
548 foreach ($parts as $part) {
549 $path .= '/' . $part;
550 if (!empty($USER->access
['rsw'][$path])) {
558 //ok, admin switched role in this context, let's use normal access control rules
562 // Careful check for staleness...
563 $context->reload_if_dirty();
565 if ($USER->id
== $userid) {
566 if (!isset($USER->access
)) {
567 load_all_capabilities();
569 $access =& $USER->access
;
572 // make sure user accessdata is really loaded
573 get_user_accessdata($userid, true);
574 $access =& $ACCESSLIB_PRIVATE->accessdatabyuser
[$userid];
577 return has_capability_in_accessdata($capability, $context, $access);
581 * Check if the user has any one of several capabilities from a list.
583 * This is just a utility method that calls has_capability in a loop. Try to put
584 * the capabilities that most users are likely to have first in the list for best
588 * @see has_capability()
590 * @param array $capabilities an array of capability names.
591 * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
592 * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
593 * @param boolean $doanything If false, ignore effect of admin role assignment
594 * @return boolean true if the user has any of these capabilities. Otherwise false.
596 function has_any_capability(array $capabilities, context
$context, $user = null, $doanything = true) {
597 foreach ($capabilities as $capability) {
598 if (has_capability($capability, $context, $user, $doanything)) {
606 * Check if the user has all the capabilities in a list.
608 * This is just a utility method that calls has_capability in a loop. Try to put
609 * the capabilities that fewest users are likely to have first in the list for best
613 * @see has_capability()
615 * @param array $capabilities an array of capability names.
616 * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
617 * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
618 * @param boolean $doanything If false, ignore effect of admin role assignment
619 * @return boolean true if the user has all of these capabilities. Otherwise false.
621 function has_all_capabilities(array $capabilities, context
$context, $user = null, $doanything = true) {
622 foreach ($capabilities as $capability) {
623 if (!has_capability($capability, $context, $user, $doanything)) {
631 * Is course creator going to have capability in a new course?
633 * This is intended to be used in enrolment plugins before or during course creation,
634 * do not use after the course is fully created.
638 * @param string $capability the name of the capability to check.
639 * @param context $context course or category context where is course going to be created
640 * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
641 * @return boolean true if the user will have this capability.
643 * @throws coding_exception if different type of context submitted
645 function guess_if_creator_will_have_course_capability($capability, context
$context, $user = null) {
648 if ($context->contextlevel
!= CONTEXT_COURSE
and $context->contextlevel
!= CONTEXT_COURSECAT
) {
649 throw new coding_exception('Only course or course category context expected');
652 if (has_capability($capability, $context, $user)) {
653 // User already has the capability, it could be only removed if CAP_PROHIBIT
654 // was involved here, but we ignore that.
658 if (!has_capability('moodle/course:create', $context, $user)) {
662 if (!enrol_is_enabled('manual')) {
666 if (empty($CFG->creatornewroleid
)) {
670 if ($context->contextlevel
== CONTEXT_COURSE
) {
671 if (is_viewing($context, $user, 'moodle/role:assign') or is_enrolled($context, $user, 'moodle/role:assign')) {
675 if (has_capability('moodle/course:view', $context, $user) and has_capability('moodle/role:assign', $context, $user)) {
680 // Most likely they will be enrolled after the course creation is finished,
681 // does the new role have the required capability?
682 list($neededroles, $forbiddenroles) = get_roles_with_cap_in_context($context, $capability);
683 return isset($neededroles[$CFG->creatornewroleid
]);
687 * Check if the user is an admin at the site level.
689 * Please note that use of proper capabilities is always encouraged,
690 * this function is supposed to be used from core or for temporary hacks.
694 * @param int|stdClass $user_or_id user id or user object
695 * @return bool true if user is one of the administrators, false otherwise
697 function is_siteadmin($user_or_id = null) {
700 if ($user_or_id === null) {
704 if (empty($user_or_id)) {
707 if (!empty($user_or_id->id
)) {
708 $userid = $user_or_id->id
;
710 $userid = $user_or_id;
713 // Because this script is called many times (150+ for course page) with
714 // the same parameters, it is worth doing minor optimisations. This static
715 // cache stores the value for a single userid, saving about 2ms from course
716 // page load time without using significant memory. As the static cache
717 // also includes the value it depends on, this cannot break unit tests.
718 static $knownid, $knownresult, $knownsiteadmins;
719 if ($knownid === $userid && $knownsiteadmins === $CFG->siteadmins
) {
723 $knownsiteadmins = $CFG->siteadmins
;
725 $siteadmins = explode(',', $CFG->siteadmins
);
726 $knownresult = in_array($userid, $siteadmins);
731 * Returns true if user has at least one role assign
732 * of 'coursecontact' role (is potentially listed in some course descriptions).
737 function has_coursecontact_role($userid) {
740 if (empty($CFG->coursecontact
)) {
744 FROM {role_assignments}
745 WHERE userid = :userid AND roleid IN ($CFG->coursecontact)";
746 return $DB->record_exists_sql($sql, array('userid'=>$userid));
750 * Does the user have a capability to do something?
752 * Walk the accessdata array and return true/false.
753 * Deals with prohibits, role switching, aggregating
756 * The main feature of here is being FAST and with no
761 * Switch Role merges with default role
762 * ------------------------------------
763 * If you are a teacher in course X, you have at least
764 * teacher-in-X + defaultloggedinuser-sitewide. So in the
765 * course you'll have techer+defaultloggedinuser.
766 * We try to mimic that in switchrole.
768 * Permission evaluation
769 * ---------------------
770 * Originally there was an extremely complicated way
771 * to determine the user access that dealt with
772 * "locality" or role assignments and role overrides.
773 * Now we simply evaluate access for each role separately
774 * and then verify if user has at least one role with allow
775 * and at the same time no role with prohibit.
778 * @param string $capability
779 * @param context $context
780 * @param array $accessdata
783 function has_capability_in_accessdata($capability, context
$context, array &$accessdata) {
786 // Build $paths as a list of current + all parent "paths" with order bottom-to-top
787 $path = $context->path
;
788 $paths = array($path);
789 while ($path = rtrim($path, '0123456789')) {
790 $path = rtrim($path, '/');
798 $switchedrole = false;
800 // Find out if role switched
801 if (!empty($accessdata['rsw'])) {
802 // From the bottom up...
803 foreach ($paths as $path) {
804 if (isset($accessdata['rsw'][$path])) {
805 // Found a switchrole assignment - check for that role _plus_ the default user role
806 $roles = array($accessdata['rsw'][$path]=>null, $CFG->defaultuserroleid
=>null);
807 $switchedrole = true;
813 if (!$switchedrole) {
814 // get all users roles in this context and above
815 foreach ($paths as $path) {
816 if (isset($accessdata['ra'][$path])) {
817 foreach ($accessdata['ra'][$path] as $roleid) {
818 $roles[$roleid] = null;
824 // Now find out what access is given to each role, going bottom-->up direction
825 $rdefs = get_role_definitions(array_keys($roles));
828 foreach ($roles as $roleid => $ignored) {
829 foreach ($paths as $path) {
830 if (isset($rdefs[$roleid][$path][$capability])) {
831 $perm = (int)$rdefs[$roleid][$path][$capability];
832 if ($perm === CAP_PROHIBIT
) {
833 // any CAP_PROHIBIT found means no permission for the user
836 if (is_null($roles[$roleid])) {
837 $roles[$roleid] = $perm;
841 // CAP_ALLOW in any role means the user has a permission, we continue only to detect prohibits
842 $allowed = ($allowed or $roles[$roleid] === CAP_ALLOW
);
849 * A convenience function that tests has_capability, and displays an error if
850 * the user does not have that capability.
852 * NOTE before Moodle 2.0, this function attempted to make an appropriate
853 * require_login call before checking the capability. This is no longer the case.
854 * You must call require_login (or one of its variants) if you want to check the
855 * user is logged in, before you call this function.
857 * @see has_capability()
859 * @param string $capability the name of the capability to check. For example mod/forum:view
860 * @param context $context the context to check the capability in. You normally get this with context_xxxx::instance().
861 * @param int $userid A user id. By default (null) checks the permissions of the current user.
862 * @param bool $doanything If false, ignore effect of admin role assignment
863 * @param string $errormessage The error string to to user. Defaults to 'nopermissions'.
864 * @param string $stringfile The language file to load the error string from. Defaults to 'error'.
865 * @return void terminates with an error if the user does not have the given capability.
867 function require_capability($capability, context
$context, $userid = null, $doanything = true,
868 $errormessage = 'nopermissions', $stringfile = '') {
869 if (!has_capability($capability, $context, $userid, $doanything)) {
870 throw new required_capability_exception($context, $capability, $errormessage, $stringfile);
875 * A convenience function that tests has_capability for a list of capabilities, and displays an error if
876 * the user does not have that capability.
878 * This is just a utility method that calls has_capability in a loop. Try to put
879 * the capabilities that fewest users are likely to have first in the list for best
883 * @see has_capability()
885 * @param array $capabilities an array of capability names.
886 * @param context $context the context to check the capability in. You normally get this with context_xxxx::instance().
887 * @param int $userid A user id. By default (null) checks the permissions of the current user.
888 * @param bool $doanything If false, ignore effect of admin role assignment
889 * @param string $errormessage The error string to to user. Defaults to 'nopermissions'.
890 * @param string $stringfile The language file to load the error string from. Defaults to 'error'.
891 * @return void terminates with an error if the user does not have the given capability.
893 function require_all_capabilities(array $capabilities, context
$context, $userid = null, $doanything = true,
894 $errormessage = 'nopermissions', $stringfile = ''): void
{
895 foreach ($capabilities as $capability) {
896 if (!has_capability($capability, $context, $userid, $doanything)) {
897 throw new required_capability_exception($context, $capability, $errormessage, $stringfile);
903 * Return a nested array showing all role assignments for the user.
904 * [ra] => [contextpath][roleid] = roleid
907 * @param int $userid - the id of the user
908 * @return array access info array
910 function get_user_roles_sitewide_accessdata($userid) {
913 $accessdata = get_empty_accessdata();
915 // start with the default role
916 if (!empty($CFG->defaultuserroleid
)) {
917 $syscontext = context_system
::instance();
918 $accessdata['ra'][$syscontext->path
][(int)$CFG->defaultuserroleid
] = (int)$CFG->defaultuserroleid
;
921 // load the "default frontpage role"
922 if (!empty($CFG->defaultfrontpageroleid
)) {
923 $frontpagecontext = context_course
::instance(get_site()->id
);
924 if ($frontpagecontext->path
) {
925 $accessdata['ra'][$frontpagecontext->path
][(int)$CFG->defaultfrontpageroleid
] = (int)$CFG->defaultfrontpageroleid
;
929 // Preload every assigned role.
930 $sql = "SELECT ctx.path, ra.roleid, ra.contextid
931 FROM {role_assignments} ra
932 JOIN {context} ctx ON ctx.id = ra.contextid
933 WHERE ra.userid = :userid";
935 $rs = $DB->get_recordset_sql($sql, array('userid' => $userid));
937 foreach ($rs as $ra) {
938 // RAs leafs are arrays to support multi-role assignments...
939 $accessdata['ra'][$ra->path
][(int)$ra->roleid
] = (int)$ra->roleid
;
948 * Returns empty accessdata structure.
951 * @return array empt accessdata
953 function get_empty_accessdata() {
954 $accessdata = array(); // named list
955 $accessdata['ra'] = array();
956 $accessdata['time'] = time();
957 $accessdata['rsw'] = array();
963 * Get accessdata for a given user.
967 * @param bool $preloadonly true means do not return access array
968 * @return array accessdata
970 function get_user_accessdata($userid, $preloadonly=false) {
971 global $CFG, $ACCESSLIB_PRIVATE, $USER;
973 if (isset($USER->access
)) {
974 $ACCESSLIB_PRIVATE->accessdatabyuser
[$USER->id
] = $USER->access
;
977 if (!isset($ACCESSLIB_PRIVATE->accessdatabyuser
[$userid])) {
978 if (empty($userid)) {
979 if (!empty($CFG->notloggedinroleid
)) {
980 $accessdata = get_role_access($CFG->notloggedinroleid
);
983 return get_empty_accessdata();
986 } else if (isguestuser($userid)) {
987 if ($guestrole = get_guest_role()) {
988 $accessdata = get_role_access($guestrole->id
);
991 return get_empty_accessdata();
995 // Includes default role and frontpage role.
996 $accessdata = get_user_roles_sitewide_accessdata($userid);
999 $ACCESSLIB_PRIVATE->accessdatabyuser
[$userid] = $accessdata;
1005 return $ACCESSLIB_PRIVATE->accessdatabyuser
[$userid];
1010 * A convenience function to completely load all the capabilities
1011 * for the current user. It is called from has_capability() and functions change permissions.
1013 * Call it only _after_ you've setup $USER and called check_enrolment_plugins();
1014 * @see check_enrolment_plugins()
1019 function load_all_capabilities() {
1022 // roles not installed yet - we are in the middle of installation
1023 if (during_initial_install()) {
1027 if (!isset($USER->id
)) {
1028 // this should not happen
1032 unset($USER->access
);
1033 $USER->access
= get_user_accessdata($USER->id
);
1035 // Clear to force a refresh
1036 unset($USER->mycourses
);
1038 // init/reset internal enrol caches - active course enrolments and temp access
1039 $USER->enrol
= array('enrolled'=>array(), 'tempguest'=>array());
1043 * A convenience function to completely reload all the capabilities
1044 * for the current user when roles have been updated in a relevant
1045 * context -- but PRESERVING switchroles and loginas.
1046 * This function resets all accesslib and context caches.
1048 * That is - completely transparent to the user.
1050 * Note: reloads $USER->access completely.
1055 function reload_all_capabilities() {
1056 global $USER, $DB, $ACCESSLIB_PRIVATE;
1060 if (!empty($USER->access
['rsw'])) {
1061 $sw = $USER->access
['rsw'];
1064 accesslib_clear_all_caches(true);
1065 unset($USER->access
);
1067 // Prevent dirty flags refetching on this page.
1068 $ACCESSLIB_PRIVATE->dirtycontexts
= array();
1069 $ACCESSLIB_PRIVATE->dirtyusers
= array($USER->id
=> false);
1071 load_all_capabilities();
1073 foreach ($sw as $path => $roleid) {
1074 if ($record = $DB->get_record('context', array('path'=>$path))) {
1075 $context = context
::instance_by_id($record->id
);
1076 if (has_capability('moodle/role:switchroles', $context)) {
1077 role_switch($roleid, $context);
1084 * Adds a temp role to current USER->access array.
1086 * Useful for the "temporary guest" access we grant to logged-in users.
1087 * This is useful for enrol plugins only.
1090 * @param context_course $coursecontext
1091 * @param int $roleid
1094 function load_temp_course_role(context_course
$coursecontext, $roleid) {
1095 global $USER, $SITE;
1097 if (empty($roleid)) {
1098 debugging('invalid role specified in load_temp_course_role()');
1102 if ($coursecontext->instanceid
== $SITE->id
) {
1103 debugging('Can not use temp roles on the frontpage');
1107 if (!isset($USER->access
)) {
1108 load_all_capabilities();
1111 $coursecontext->reload_if_dirty();
1113 if (isset($USER->access
['ra'][$coursecontext->path
][$roleid])) {
1117 $USER->access
['ra'][$coursecontext->path
][(int)$roleid] = (int)$roleid;
1121 * Removes any extra guest roles from current USER->access array.
1122 * This is useful for enrol plugins only.
1125 * @param context_course $coursecontext
1128 function remove_temp_course_roles(context_course
$coursecontext) {
1129 global $DB, $USER, $SITE;
1131 if ($coursecontext->instanceid
== $SITE->id
) {
1132 debugging('Can not use temp roles on the frontpage');
1136 if (empty($USER->access
['ra'][$coursecontext->path
])) {
1137 //no roles here, weird
1141 $sql = "SELECT DISTINCT ra.roleid AS id
1142 FROM {role_assignments} ra
1143 WHERE ra.contextid = :contextid AND ra.userid = :userid";
1144 $ras = $DB->get_records_sql($sql, array('contextid'=>$coursecontext->id
, 'userid'=>$USER->id
));
1146 $USER->access
['ra'][$coursecontext->path
] = array();
1147 foreach ($ras as $r) {
1148 $USER->access
['ra'][$coursecontext->path
][(int)$r->id
] = (int)$r->id
;
1153 * Returns array of all role archetypes.
1157 function get_role_archetypes() {
1159 'manager' => 'manager',
1160 'coursecreator' => 'coursecreator',
1161 'editingteacher' => 'editingteacher',
1162 'teacher' => 'teacher',
1163 'student' => 'student',
1166 'frontpage' => 'frontpage'
1171 * Assign the defaults found in this capability definition to roles that have
1172 * the corresponding legacy capabilities assigned to them.
1174 * @param string $capability
1175 * @param array $legacyperms an array in the format (example):
1176 * 'guest' => CAP_PREVENT,
1177 * 'student' => CAP_ALLOW,
1178 * 'teacher' => CAP_ALLOW,
1179 * 'editingteacher' => CAP_ALLOW,
1180 * 'coursecreator' => CAP_ALLOW,
1181 * 'manager' => CAP_ALLOW
1182 * @return boolean success or failure.
1184 function assign_legacy_capabilities($capability, $legacyperms) {
1186 $archetypes = get_role_archetypes();
1188 foreach ($legacyperms as $type => $perm) {
1190 $systemcontext = context_system
::instance();
1191 if ($type === 'admin') {
1192 debugging('Legacy type admin in access.php was renamed to manager, please update the code.');
1196 if (!array_key_exists($type, $archetypes)) {
1197 print_error('invalidlegacy', '', '', $type);
1200 if ($roles = get_archetype_roles($type)) {
1201 foreach ($roles as $role) {
1202 // Assign a site level capability.
1203 if (!assign_capability($capability, $perm, $role->id
, $systemcontext->id
)) {
1213 * Verify capability risks.
1215 * @param stdClass $capability a capability - a row from the capabilities table.
1216 * @return boolean whether this capability is safe - that is, whether people with the
1217 * safeoverrides capability should be allowed to change it.
1219 function is_safe_capability($capability) {
1220 return !((RISK_DATALOSS | RISK_MANAGETRUST | RISK_CONFIG | RISK_XSS | RISK_PERSONAL
) & $capability->riskbitmask
);
1224 * Get the local override (if any) for a given capability in a role in a context
1226 * @param int $roleid
1227 * @param int $contextid
1228 * @param string $capability
1229 * @return stdClass local capability override
1231 function get_local_override($roleid, $contextid, $capability) {
1234 return $DB->get_record_sql("
1236 FROM {role_capabilities} rc
1237 JOIN {capability} cap ON rc.capability = cap.name
1238 WHERE rc.roleid = :roleid AND rc.capability = :capability AND rc.contextid = :contextid", [
1239 'roleid' => $roleid,
1240 'contextid' => $contextid,
1241 'capability' => $capability,
1247 * Returns context instance plus related course and cm instances
1249 * @param int $contextid
1250 * @return array of ($context, $course, $cm)
1252 function get_context_info_array($contextid) {
1255 $context = context
::instance_by_id($contextid, MUST_EXIST
);
1259 if ($context->contextlevel
== CONTEXT_COURSE
) {
1260 $course = $DB->get_record('course', array('id'=>$context->instanceid
), '*', MUST_EXIST
);
1262 } else if ($context->contextlevel
== CONTEXT_MODULE
) {
1263 $cm = get_coursemodule_from_id('', $context->instanceid
, 0, false, MUST_EXIST
);
1264 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
1266 } else if ($context->contextlevel
== CONTEXT_BLOCK
) {
1267 $parent = $context->get_parent_context();
1269 if ($parent->contextlevel
== CONTEXT_COURSE
) {
1270 $course = $DB->get_record('course', array('id'=>$parent->instanceid
), '*', MUST_EXIST
);
1271 } else if ($parent->contextlevel
== CONTEXT_MODULE
) {
1272 $cm = get_coursemodule_from_id('', $parent->instanceid
, 0, false, MUST_EXIST
);
1273 $course = $DB->get_record('course', array('id'=>$cm->course
), '*', MUST_EXIST
);
1277 return array($context, $course, $cm);
1281 * Function that creates a role
1283 * @param string $name role name
1284 * @param string $shortname role short name
1285 * @param string $description role description
1286 * @param string $archetype
1287 * @return int id or dml_exception
1289 function create_role($name, $shortname, $description, $archetype = '') {
1292 if (strpos($archetype, 'moodle/legacy:') !== false) {
1293 throw new coding_exception('Use new role archetype parameter in create_role() instead of old legacy capabilities.');
1296 // verify role archetype actually exists
1297 $archetypes = get_role_archetypes();
1298 if (empty($archetypes[$archetype])) {
1302 // Insert the role record.
1303 $role = new stdClass();
1304 $role->name
= $name;
1305 $role->shortname
= $shortname;
1306 $role->description
= $description;
1307 $role->archetype
= $archetype;
1309 //find free sortorder number
1310 $role->sortorder
= $DB->get_field('role', 'MAX(sortorder) + 1', array());
1311 if (empty($role->sortorder
)) {
1312 $role->sortorder
= 1;
1314 $id = $DB->insert_record('role', $role);
1320 * Function that deletes a role and cleanups up after it
1322 * @param int $roleid id of role to delete
1323 * @return bool always true
1325 function delete_role($roleid) {
1328 // first unssign all users
1329 role_unassign_all(array('roleid'=>$roleid));
1331 // cleanup all references to this role, ignore errors
1332 $DB->delete_records('role_capabilities', array('roleid'=>$roleid));
1333 $DB->delete_records('role_allow_assign', array('roleid'=>$roleid));
1334 $DB->delete_records('role_allow_assign', array('allowassign'=>$roleid));
1335 $DB->delete_records('role_allow_override', array('roleid'=>$roleid));
1336 $DB->delete_records('role_allow_override', array('allowoverride'=>$roleid));
1337 $DB->delete_records('role_names', array('roleid'=>$roleid));
1338 $DB->delete_records('role_context_levels', array('roleid'=>$roleid));
1340 // Get role record before it's deleted.
1341 $role = $DB->get_record('role', array('id'=>$roleid));
1343 // Finally delete the role itself.
1344 $DB->delete_records('role', array('id'=>$roleid));
1347 $event = \core\event\role_deleted
::create(
1349 'context' => context_system
::instance(),
1350 'objectid' => $roleid,
1353 'shortname' => $role->shortname
,
1354 'description' => $role->description
,
1355 'archetype' => $role->archetype
1359 $event->add_record_snapshot('role', $role);
1362 // Reset any cache of this role, including MUC.
1363 accesslib_clear_role_cache($roleid);
1369 * Function to write context specific overrides, or default capabilities.
1371 * @param string $capability string name
1372 * @param int $permission CAP_ constants
1373 * @param int $roleid role id
1374 * @param int|context $contextid context id
1375 * @param bool $overwrite
1376 * @return bool always true or exception
1378 function assign_capability($capability, $permission, $roleid, $contextid, $overwrite = false) {
1381 if ($contextid instanceof context
) {
1382 $context = $contextid;
1384 $context = context
::instance_by_id($contextid);
1387 // Capability must exist.
1388 if (!$capinfo = get_capability_info($capability)) {
1389 throw new coding_exception("Capability '{$capability}' was not found! This has to be fixed in code.");
1392 if (empty($permission) ||
$permission == CAP_INHERIT
) { // if permission is not set
1393 unassign_capability($capability, $roleid, $context->id
);
1397 $existing = $DB->get_record('role_capabilities', array('contextid'=>$context->id
, 'roleid'=>$roleid, 'capability'=>$capability));
1399 if ($existing and !$overwrite) { // We want to keep whatever is there already
1403 $cap = new stdClass();
1404 $cap->contextid
= $context->id
;
1405 $cap->roleid
= $roleid;
1406 $cap->capability
= $capability;
1407 $cap->permission
= $permission;
1408 $cap->timemodified
= time();
1409 $cap->modifierid
= empty($USER->id
) ?
0 : $USER->id
;
1412 $cap->id
= $existing->id
;
1413 $DB->update_record('role_capabilities', $cap);
1415 if ($DB->record_exists('context', array('id'=>$context->id
))) {
1416 $DB->insert_record('role_capabilities', $cap);
1420 // Trigger capability_assigned event.
1421 \core\event\capability_assigned
::create([
1422 'userid' => $cap->modifierid
,
1423 'context' => $context,
1424 'objectid' => $roleid,
1426 'capability' => $capability,
1427 'oldpermission' => $existing->permission ?? CAP_INHERIT
,
1428 'permission' => $permission
1432 // Reset any cache of this role, including MUC.
1433 accesslib_clear_role_cache($roleid);
1439 * Unassign a capability from a role.
1441 * @param string $capability the name of the capability
1442 * @param int $roleid the role id
1443 * @param int|context $contextid null means all contexts
1444 * @return boolean true or exception
1446 function unassign_capability($capability, $roleid, $contextid = null) {
1449 // Capability must exist.
1450 if (!$capinfo = get_capability_info($capability)) {
1451 throw new coding_exception("Capability '{$capability}' was not found! This has to be fixed in code.");
1454 if (!empty($contextid)) {
1455 if ($contextid instanceof context
) {
1456 $context = $contextid;
1458 $context = context
::instance_by_id($contextid);
1460 // delete from context rel, if this is the last override in this context
1461 $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid, 'contextid'=>$context->id
));
1463 $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid));
1466 // Trigger capability_assigned event.
1467 \core\event\capability_unassigned
::create([
1468 'userid' => $USER->id
,
1469 'context' => $context ?? context_system
::instance(),
1470 'objectid' => $roleid,
1472 'capability' => $capability,
1476 // Reset any cache of this role, including MUC.
1477 accesslib_clear_role_cache($roleid);
1483 * Get the roles that have a given capability assigned to it
1485 * This function does not resolve the actual permission of the capability.
1486 * It just checks for permissions and overrides.
1487 * Use get_roles_with_cap_in_context() if resolution is required.
1489 * @param string $capability capability name (string)
1490 * @param string $permission optional, the permission defined for this capability
1491 * either CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT. Defaults to null which means any.
1492 * @param stdClass $context null means any
1493 * @return array of role records
1495 function get_roles_with_capability($capability, $permission = null, $context = null) {
1499 $contexts = $context->get_parent_context_ids(true);
1500 list($insql, $params) = $DB->get_in_or_equal($contexts, SQL_PARAMS_NAMED
, 'ctx');
1501 $contextsql = "AND rc.contextid $insql";
1508 $permissionsql = " AND rc.permission = :permission";
1509 $params['permission'] = $permission;
1511 $permissionsql = '';
1516 WHERE r.id IN (SELECT rc.roleid
1517 FROM {role_capabilities} rc
1518 JOIN {capabilities} cap ON rc.capability = cap.name
1519 WHERE rc.capability = :capname
1522 $params['capname'] = $capability;
1525 return $DB->get_records_sql($sql, $params);
1529 * This function makes a role-assignment (a role for a user in a particular context)
1531 * @param int $roleid the role of the id
1532 * @param int $userid userid
1533 * @param int|context $contextid id of the context
1534 * @param string $component example 'enrol_ldap', defaults to '' which means manual assignment,
1535 * @param int $itemid id of enrolment/auth plugin
1536 * @param string $timemodified defaults to current time
1537 * @return int new/existing id of the assignment
1539 function role_assign($roleid, $userid, $contextid, $component = '', $itemid = 0, $timemodified = '') {
1542 // first of all detect if somebody is using old style parameters
1543 if ($contextid === 0 or is_numeric($component)) {
1544 throw new coding_exception('Invalid call to role_assign(), code needs to be updated to use new order of parameters');
1547 // now validate all parameters
1548 if (empty($roleid)) {
1549 throw new coding_exception('Invalid call to role_assign(), roleid can not be empty');
1552 if (empty($userid)) {
1553 throw new coding_exception('Invalid call to role_assign(), userid can not be empty');
1557 if (strpos($component, '_') === false) {
1558 throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as"enrol_" when itemid specified', 'component:'.$component);
1562 if ($component !== '' and strpos($component, '_') === false) {
1563 throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
1567 if (!$DB->record_exists('user', array('id'=>$userid, 'deleted'=>0))) {
1568 throw new coding_exception('User ID does not exist or is deleted!', 'userid:'.$userid);
1571 if ($contextid instanceof context
) {
1572 $context = $contextid;
1574 $context = context
::instance_by_id($contextid, MUST_EXIST
);
1577 if (!$timemodified) {
1578 $timemodified = time();
1581 // Check for existing entry
1582 $ras = $DB->get_records('role_assignments', array('roleid'=>$roleid, 'contextid'=>$context->id
, 'userid'=>$userid, 'component'=>$component, 'itemid'=>$itemid), 'id');
1585 // role already assigned - this should not happen
1586 if (count($ras) > 1) {
1587 // very weird - remove all duplicates!
1588 $ra = array_shift($ras);
1589 foreach ($ras as $r) {
1590 $DB->delete_records('role_assignments', array('id'=>$r->id
));
1596 // actually there is no need to update, reset anything or trigger any event, so just return
1600 // Create a new entry
1601 $ra = new stdClass();
1602 $ra->roleid
= $roleid;
1603 $ra->contextid
= $context->id
;
1604 $ra->userid
= $userid;
1605 $ra->component
= $component;
1606 $ra->itemid
= $itemid;
1607 $ra->timemodified
= $timemodified;
1608 $ra->modifierid
= empty($USER->id
) ?
0 : $USER->id
;
1611 $ra->id
= $DB->insert_record('role_assignments', $ra);
1613 // Role assignments have changed, so mark user as dirty.
1614 mark_user_dirty($userid);
1616 core_course_category
::role_assignment_changed($roleid, $context);
1618 $event = \core\event\role_assigned
::create(array(
1619 'context' => $context,
1620 'objectid' => $ra->roleid
,
1621 'relateduserid' => $ra->userid
,
1624 'component' => $ra->component
,
1625 'itemid' => $ra->itemid
1628 $event->add_record_snapshot('role_assignments', $ra);
1635 * Removes one role assignment
1637 * @param int $roleid
1638 * @param int $userid
1639 * @param int $contextid
1640 * @param string $component
1641 * @param int $itemid
1644 function role_unassign($roleid, $userid, $contextid, $component = '', $itemid = 0) {
1645 // first make sure the params make sense
1646 if ($roleid == 0 or $userid == 0 or $contextid == 0) {
1647 throw new coding_exception('Invalid call to role_unassign(), please use role_unassign_all() when removing multiple role assignments');
1651 if (strpos($component, '_') === false) {
1652 throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as "enrol_" when itemid specified', 'component:'.$component);
1656 if ($component !== '' and strpos($component, '_') === false) {
1657 throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
1661 role_unassign_all(array('roleid'=>$roleid, 'userid'=>$userid, 'contextid'=>$contextid, 'component'=>$component, 'itemid'=>$itemid), false, false);
1665 * Removes multiple role assignments, parameters may contain:
1666 * 'roleid', 'userid', 'contextid', 'component', 'enrolid'.
1668 * @param array $params role assignment parameters
1669 * @param bool $subcontexts unassign in subcontexts too
1670 * @param bool $includemanual include manual role assignments too
1673 function role_unassign_all(array $params, $subcontexts = false, $includemanual = false) {
1674 global $USER, $CFG, $DB;
1677 throw new coding_exception('Missing parameters in role_unsassign_all() call');
1680 $allowed = array('roleid', 'userid', 'contextid', 'component', 'itemid');
1681 foreach ($params as $key=>$value) {
1682 if (!in_array($key, $allowed)) {
1683 throw new coding_exception('Unknown role_unsassign_all() parameter key', 'key:'.$key);
1687 if (isset($params['component']) and $params['component'] !== '' and strpos($params['component'], '_') === false) {
1688 throw new coding_exception('Invalid component paramter in role_unsassign_all() call', 'component:'.$params['component']);
1691 if ($includemanual) {
1692 if (!isset($params['component']) or $params['component'] === '') {
1693 throw new coding_exception('include manual parameter requires component parameter in role_unsassign_all() call');
1698 if (empty($params['contextid'])) {
1699 throw new coding_exception('subcontexts paramtere requires component parameter in role_unsassign_all() call');
1703 $ras = $DB->get_records('role_assignments', $params);
1704 foreach ($ras as $ra) {
1705 $DB->delete_records('role_assignments', array('id'=>$ra->id
));
1706 if ($context = context
::instance_by_id($ra->contextid
, IGNORE_MISSING
)) {
1707 // Role assignments have changed, so mark user as dirty.
1708 mark_user_dirty($ra->userid
);
1710 $event = \core\event\role_unassigned
::create(array(
1711 'context' => $context,
1712 'objectid' => $ra->roleid
,
1713 'relateduserid' => $ra->userid
,
1716 'component' => $ra->component
,
1717 'itemid' => $ra->itemid
1720 $event->add_record_snapshot('role_assignments', $ra);
1722 core_course_category
::role_assignment_changed($ra->roleid
, $context);
1727 // process subcontexts
1728 if ($subcontexts and $context = context
::instance_by_id($params['contextid'], IGNORE_MISSING
)) {
1729 if ($params['contextid'] instanceof context
) {
1730 $context = $params['contextid'];
1732 $context = context
::instance_by_id($params['contextid'], IGNORE_MISSING
);
1736 $contexts = $context->get_child_contexts();
1738 foreach ($contexts as $context) {
1739 $mparams['contextid'] = $context->id
;
1740 $ras = $DB->get_records('role_assignments', $mparams);
1741 foreach ($ras as $ra) {
1742 $DB->delete_records('role_assignments', array('id'=>$ra->id
));
1743 // Role assignments have changed, so mark user as dirty.
1744 mark_user_dirty($ra->userid
);
1746 $event = \core\event\role_unassigned
::create(
1747 array('context'=>$context, 'objectid'=>$ra->roleid
, 'relateduserid'=>$ra->userid
,
1748 'other'=>array('id'=>$ra->id
, 'component'=>$ra->component
, 'itemid'=>$ra->itemid
)));
1749 $event->add_record_snapshot('role_assignments', $ra);
1751 core_course_category
::role_assignment_changed($ra->roleid
, $context);
1757 // do this once more for all manual role assignments
1758 if ($includemanual) {
1759 $params['component'] = '';
1760 role_unassign_all($params, $subcontexts, false);
1765 * Mark a user as dirty (with timestamp) so as to force reloading of the user session.
1767 * @param int $userid
1770 function mark_user_dirty($userid) {
1771 global $CFG, $ACCESSLIB_PRIVATE;
1773 if (during_initial_install()) {
1777 // Throw exception if invalid userid is provided.
1778 if (empty($userid)) {
1779 throw new coding_exception('Invalid user parameter supplied for mark_user_dirty() function!');
1782 // Set dirty flag in database, set dirty field locally, and clear local accessdata cache.
1783 set_cache_flag('accesslib/dirtyusers', $userid, 1, time() +
$CFG->sessiontimeout
);
1784 $ACCESSLIB_PRIVATE->dirtyusers
[$userid] = 1;
1785 unset($ACCESSLIB_PRIVATE->accessdatabyuser
[$userid]);
1789 * Determines if a user is currently logged in
1795 function isloggedin() {
1798 return (!empty($USER->id
));
1802 * Determines if a user is logged in as real guest user with username 'guest'.
1806 * @param int|object $user mixed user object or id, $USER if not specified
1807 * @return bool true if user is the real guest user, false if not logged in or other user
1809 function isguestuser($user = null) {
1810 global $USER, $DB, $CFG;
1812 // make sure we have the user id cached in config table, because we are going to use it a lot
1813 if (empty($CFG->siteguest
)) {
1814 if (!$guestid = $DB->get_field('user', 'id', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id
))) {
1815 // guest does not exist yet, weird
1818 set_config('siteguest', $guestid);
1820 if ($user === null) {
1824 if ($user === null) {
1825 // happens when setting the $USER
1828 } else if (is_numeric($user)) {
1829 return ($CFG->siteguest
== $user);
1831 } else if (is_object($user)) {
1832 if (empty($user->id
)) {
1833 return false; // not logged in means is not be guest
1835 return ($CFG->siteguest
== $user->id
);
1839 throw new coding_exception('Invalid user parameter supplied for isguestuser() function!');
1844 * Does user have a (temporary or real) guest access to course?
1848 * @param context $context
1849 * @param stdClass|int $user
1852 function is_guest(context
$context, $user = null) {
1855 // first find the course context
1856 $coursecontext = $context->get_course_context();
1858 // make sure there is a real user specified
1859 if ($user === null) {
1860 $userid = isset($USER->id
) ?
$USER->id
: 0;
1862 $userid = is_object($user) ?
$user->id
: $user;
1865 if (isguestuser($userid)) {
1866 // can not inspect or be enrolled
1870 if (has_capability('moodle/course:view', $coursecontext, $user)) {
1871 // viewing users appear out of nowhere, they are neither guests nor participants
1875 // consider only real active enrolments here
1876 if (is_enrolled($coursecontext, $user, '', true)) {
1884 * Returns true if the user has moodle/course:view capability in the course,
1885 * this is intended for admins, managers (aka small admins), inspectors, etc.
1889 * @param context $context
1890 * @param int|stdClass $user if null $USER is used
1891 * @param string $withcapability extra capability name
1894 function is_viewing(context
$context, $user = null, $withcapability = '') {
1895 // first find the course context
1896 $coursecontext = $context->get_course_context();
1898 if (isguestuser($user)) {
1903 if (!has_capability('moodle/course:view', $coursecontext, $user)) {
1904 // admins are allowed to inspect courses
1908 if ($withcapability and !has_capability($withcapability, $context, $user)) {
1909 // site admins always have the capability, but the enrolment above blocks
1917 * Returns true if the user is able to access the course.
1919 * This function is in no way, shape, or form a substitute for require_login.
1920 * It should only be used in circumstances where it is not possible to call require_login
1921 * such as the navigation.
1923 * This function checks many of the methods of access to a course such as the view
1924 * capability, enrollments, and guest access. It also makes use of the cache
1925 * generated by require_login for guest access.
1927 * The flags within the $USER object that are used here should NEVER be used outside
1928 * of this function can_access_course and require_login. Doing so WILL break future
1931 * @param stdClass $course record
1932 * @param stdClass|int|null $user user record or id, current user if null
1933 * @param string $withcapability Check for this capability as well.
1934 * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1935 * @return boolean Returns true if the user is able to access the course
1937 function can_access_course(stdClass
$course, $user = null, $withcapability = '', $onlyactive = false) {
1940 // this function originally accepted $coursecontext parameter
1941 if ($course instanceof context
) {
1942 if ($course instanceof context_course
) {
1943 debugging('deprecated context parameter, please use $course record');
1944 $coursecontext = $course;
1945 $course = $DB->get_record('course', array('id'=>$coursecontext->instanceid
));
1947 debugging('Invalid context parameter, please use $course record');
1951 $coursecontext = context_course
::instance($course->id
);
1954 if (!isset($USER->id
)) {
1955 // should never happen
1957 debugging('Course access check being performed on a user with no ID.', DEBUG_DEVELOPER
);
1960 // make sure there is a user specified
1961 if ($user === null) {
1962 $userid = $USER->id
;
1964 $userid = is_object($user) ?
$user->id
: $user;
1968 if ($withcapability and !has_capability($withcapability, $coursecontext, $userid)) {
1972 if ($userid == $USER->id
) {
1973 if (!empty($USER->access
['rsw'][$coursecontext->path
])) {
1974 // the fact that somebody switched role means they can access the course no matter to what role they switched
1979 if (!$course->visible
and !has_capability('moodle/course:viewhiddencourses', $coursecontext, $userid)) {
1983 if (is_viewing($coursecontext, $userid)) {
1987 if ($userid != $USER->id
) {
1988 // for performance reasons we do not verify temporary guest access for other users, sorry...
1989 return is_enrolled($coursecontext, $userid, '', $onlyactive);
1992 // === from here we deal only with $USER ===
1994 $coursecontext->reload_if_dirty();
1996 if (isset($USER->enrol
['enrolled'][$course->id
])) {
1997 if ($USER->enrol
['enrolled'][$course->id
] > time()) {
2001 if (isset($USER->enrol
['tempguest'][$course->id
])) {
2002 if ($USER->enrol
['tempguest'][$course->id
] > time()) {
2007 if (is_enrolled($coursecontext, $USER, '', $onlyactive)) {
2011 if (!core_course_category
::can_view_course_info($course)) {
2012 // No guest access if user does not have capability to browse courses.
2016 // if not enrolled try to gain temporary guest access
2017 $instances = $DB->get_records('enrol', array('courseid'=>$course->id
, 'status'=>ENROL_INSTANCE_ENABLED
), 'sortorder, id ASC');
2018 $enrols = enrol_get_plugins(true);
2019 foreach ($instances as $instance) {
2020 if (!isset($enrols[$instance->enrol
])) {
2023 // Get a duration for the guest access, a timestamp in the future, 0 (always) or false.
2024 $until = $enrols[$instance->enrol
]->try_guestaccess($instance);
2025 if ($until !== false and $until > time()) {
2026 $USER->enrol
['tempguest'][$course->id
] = $until;
2030 if (isset($USER->enrol
['tempguest'][$course->id
])) {
2031 unset($USER->enrol
['tempguest'][$course->id
]);
2032 remove_temp_course_roles($coursecontext);
2039 * Loads the capability definitions for the component (from file).
2041 * Loads the capability definitions for the component (from file). If no
2042 * capabilities are defined for the component, we simply return an empty array.
2045 * @param string $component full plugin name, examples: 'moodle', 'mod_forum'
2046 * @return array array of capabilities
2048 function load_capability_def($component) {
2049 $defpath = core_component
::get_component_directory($component).'/db/access.php';
2051 $capabilities = array();
2052 if (file_exists($defpath)) {
2054 if (!empty($
{$component.'_capabilities'})) {
2055 // BC capability array name
2056 // since 2.0 we prefer $capabilities instead - it is easier to use and matches db/* files
2057 debugging('componentname_capabilities array is deprecated, please use $capabilities array only in access.php files');
2058 $capabilities = $
{$component.'_capabilities'};
2062 return $capabilities;
2066 * Gets the capabilities that have been cached in the database for this component.
2069 * @param string $component - examples: 'moodle', 'mod_forum'
2070 * @return array array of capabilities
2072 function get_cached_capabilities($component = 'moodle') {
2074 $caps = get_all_capabilities();
2075 $componentcaps = array();
2076 foreach ($caps as $cap) {
2077 if ($cap['component'] == $component) {
2078 $componentcaps[] = (object) $cap;
2081 return $componentcaps;
2085 * Returns default capabilities for given role archetype.
2087 * @param string $archetype role archetype
2090 function get_default_capabilities($archetype) {
2098 $defaults = array();
2099 $components = array();
2100 $allcaps = get_all_capabilities();
2102 foreach ($allcaps as $cap) {
2103 if (!in_array($cap['component'], $components)) {
2104 $components[] = $cap['component'];
2105 $alldefs = array_merge($alldefs, load_capability_def($cap['component']));
2108 foreach ($alldefs as $name=>$def) {
2109 // Use array 'archetypes if available. Only if not specified, use 'legacy'.
2110 if (isset($def['archetypes'])) {
2111 if (isset($def['archetypes'][$archetype])) {
2112 $defaults[$name] = $def['archetypes'][$archetype];
2114 // 'legacy' is for backward compatibility with 1.9 access.php
2116 if (isset($def['legacy'][$archetype])) {
2117 $defaults[$name] = $def['legacy'][$archetype];
2126 * Return default roles that can be assigned, overridden or switched
2127 * by give role archetype.
2129 * @param string $type assign|override|switch|view
2130 * @param string $archetype
2131 * @return array of role ids
2133 function get_default_role_archetype_allows($type, $archetype) {
2136 if (empty($archetype)) {
2140 $roles = $DB->get_records('role');
2141 $archetypemap = array();
2142 foreach ($roles as $role) {
2143 if ($role->archetype
) {
2144 $archetypemap[$role->archetype
][$role->id
] = $role->id
;
2150 'manager' => array('manager', 'coursecreator', 'editingteacher', 'teacher', 'student'),
2151 'coursecreator' => array(),
2152 'editingteacher' => array('teacher', 'student'),
2153 'teacher' => array(),
2154 'student' => array(),
2157 'frontpage' => array(),
2159 'override' => array(
2160 'manager' => array('manager', 'coursecreator', 'editingteacher', 'teacher', 'student', 'guest', 'user', 'frontpage'),
2161 'coursecreator' => array(),
2162 'editingteacher' => array('teacher', 'student', 'guest'),
2163 'teacher' => array(),
2164 'student' => array(),
2167 'frontpage' => array(),
2170 'manager' => array('editingteacher', 'teacher', 'student', 'guest'),
2171 'coursecreator' => array(),
2172 'editingteacher' => array('teacher', 'student', 'guest'),
2173 'teacher' => array('student', 'guest'),
2174 'student' => array(),
2177 'frontpage' => array(),
2180 'manager' => array('manager', 'coursecreator', 'editingteacher', 'teacher', 'student', 'guest', 'user', 'frontpage'),
2181 'coursecreator' => array('coursecreator', 'editingteacher', 'teacher', 'student'),
2182 'editingteacher' => array('coursecreator', 'editingteacher', 'teacher', 'student'),
2183 'teacher' => array('coursecreator', 'editingteacher', 'teacher', 'student'),
2184 'student' => array('coursecreator', 'editingteacher', 'teacher', 'student'),
2187 'frontpage' => array(),
2191 if (!isset($defaults[$type][$archetype])) {
2192 debugging("Unknown type '$type'' or archetype '$archetype''");
2197 foreach ($defaults[$type][$archetype] as $at) {
2198 if (isset($archetypemap[$at])) {
2199 foreach ($archetypemap[$at] as $roleid) {
2200 $return[$roleid] = $roleid;
2209 * Reset role capabilities to default according to selected role archetype.
2210 * If no archetype selected, removes all capabilities.
2212 * This applies to capabilities that are assigned to the role (that you could
2213 * edit in the 'define roles' interface), and not to any capability overrides
2214 * in different locations.
2216 * @param int $roleid ID of role to reset capabilities for
2218 function reset_role_capabilities($roleid) {
2221 $role = $DB->get_record('role', array('id'=>$roleid), '*', MUST_EXIST
);
2222 $defaultcaps = get_default_capabilities($role->archetype
);
2224 $systemcontext = context_system
::instance();
2226 $DB->delete_records('role_capabilities',
2227 array('roleid' => $roleid, 'contextid' => $systemcontext->id
));
2229 foreach ($defaultcaps as $cap=>$permission) {
2230 assign_capability($cap, $permission, $roleid, $systemcontext->id
);
2233 // Reset any cache of this role, including MUC.
2234 accesslib_clear_role_cache($roleid);
2238 * Updates the capabilities table with the component capability definitions.
2239 * If no parameters are given, the function updates the core moodle
2242 * Note that the absence of the db/access.php capabilities definition file
2243 * will cause any stored capabilities for the component to be removed from
2247 * @param string $component examples: 'moodle', 'mod_forum', 'block_activity_results'
2248 * @return boolean true if success, exception in case of any problems
2250 function update_capabilities($component = 'moodle') {
2251 global $DB, $OUTPUT;
2253 $storedcaps = array();
2255 $filecaps = load_capability_def($component);
2256 foreach ($filecaps as $capname=>$unused) {
2257 if (!preg_match('|^[a-z]+/[a-z_0-9]+:[a-z_0-9]+$|', $capname)) {
2258 debugging("Coding problem: Invalid capability name '$capname', use 'clonepermissionsfrom' field for migration.");
2262 // It is possible somebody directly modified the DB (according to accesslib_test anyway).
2263 // So ensure our updating is based on fresh data.
2264 cache
::make('core', 'capabilities')->delete('core_capabilities');
2266 $cachedcaps = get_cached_capabilities($component);
2268 foreach ($cachedcaps as $cachedcap) {
2269 array_push($storedcaps, $cachedcap->name
);
2270 // update risk bitmasks and context levels in existing capabilities if needed
2271 if (array_key_exists($cachedcap->name
, $filecaps)) {
2272 if (!array_key_exists('riskbitmask', $filecaps[$cachedcap->name
])) {
2273 $filecaps[$cachedcap->name
]['riskbitmask'] = 0; // no risk if not specified
2275 if ($cachedcap->captype
!= $filecaps[$cachedcap->name
]['captype']) {
2276 $updatecap = new stdClass();
2277 $updatecap->id
= $cachedcap->id
;
2278 $updatecap->captype
= $filecaps[$cachedcap->name
]['captype'];
2279 $DB->update_record('capabilities', $updatecap);
2281 if ($cachedcap->riskbitmask
!= $filecaps[$cachedcap->name
]['riskbitmask']) {
2282 $updatecap = new stdClass();
2283 $updatecap->id
= $cachedcap->id
;
2284 $updatecap->riskbitmask
= $filecaps[$cachedcap->name
]['riskbitmask'];
2285 $DB->update_record('capabilities', $updatecap);
2288 if (!array_key_exists('contextlevel', $filecaps[$cachedcap->name
])) {
2289 $filecaps[$cachedcap->name
]['contextlevel'] = 0; // no context level defined
2291 if ($cachedcap->contextlevel
!= $filecaps[$cachedcap->name
]['contextlevel']) {
2292 $updatecap = new stdClass();
2293 $updatecap->id
= $cachedcap->id
;
2294 $updatecap->contextlevel
= $filecaps[$cachedcap->name
]['contextlevel'];
2295 $DB->update_record('capabilities', $updatecap);
2301 // Flush the cached again, as we have changed DB.
2302 cache
::make('core', 'capabilities')->delete('core_capabilities');
2304 // Are there new capabilities in the file definition?
2307 foreach ($filecaps as $filecap => $def) {
2309 ($storedcaps && in_array($filecap, $storedcaps) === false)) {
2310 if (!array_key_exists('riskbitmask', $def)) {
2311 $def['riskbitmask'] = 0; // no risk if not specified
2313 $newcaps[$filecap] = $def;
2316 // Add new capabilities to the stored definition.
2317 $existingcaps = $DB->get_records_menu('capabilities', array(), 'id', 'id, name');
2318 foreach ($newcaps as $capname => $capdef) {
2319 $capability = new stdClass();
2320 $capability->name
= $capname;
2321 $capability->captype
= $capdef['captype'];
2322 $capability->contextlevel
= $capdef['contextlevel'];
2323 $capability->component
= $component;
2324 $capability->riskbitmask
= $capdef['riskbitmask'];
2326 $DB->insert_record('capabilities', $capability, false);
2328 // Flush the cached, as we have changed DB.
2329 cache
::make('core', 'capabilities')->delete('core_capabilities');
2331 if (isset($capdef['clonepermissionsfrom']) && in_array($capdef['clonepermissionsfrom'], $existingcaps)){
2332 if ($rolecapabilities = $DB->get_records('role_capabilities', array('capability'=>$capdef['clonepermissionsfrom']))){
2333 foreach ($rolecapabilities as $rolecapability){
2334 //assign_capability will update rather than insert if capability exists
2335 if (!assign_capability($capname, $rolecapability->permission
,
2336 $rolecapability->roleid
, $rolecapability->contextid
, true)){
2337 echo $OUTPUT->notification('Could not clone capabilities for '.$capname);
2341 // we ignore archetype key if we have cloned permissions
2342 } else if (isset($capdef['archetypes']) && is_array($capdef['archetypes'])) {
2343 assign_legacy_capabilities($capname, $capdef['archetypes']);
2344 // 'legacy' is for backward compatibility with 1.9 access.php
2345 } else if (isset($capdef['legacy']) && is_array($capdef['legacy'])) {
2346 assign_legacy_capabilities($capname, $capdef['legacy']);
2349 // Are there any capabilities that have been removed from the file
2350 // definition that we need to delete from the stored capabilities and
2351 // role assignments?
2352 capabilities_cleanup($component, $filecaps);
2354 // reset static caches
2355 accesslib_reset_role_cache();
2357 // Flush the cached again, as we have changed DB.
2358 cache
::make('core', 'capabilities')->delete('core_capabilities');
2364 * Deletes cached capabilities that are no longer needed by the component.
2365 * Also unassigns these capabilities from any roles that have them.
2366 * NOTE: this function is called from lib/db/upgrade.php
2369 * @param string $component examples: 'moodle', 'mod_forum', 'block_activity_results'
2370 * @param array $newcapdef array of the new capability definitions that will be
2371 * compared with the cached capabilities
2372 * @return int number of deprecated capabilities that have been removed
2374 function capabilities_cleanup($component, $newcapdef = null) {
2379 if ($cachedcaps = get_cached_capabilities($component)) {
2380 foreach ($cachedcaps as $cachedcap) {
2381 if (empty($newcapdef) ||
2382 array_key_exists($cachedcap->name
, $newcapdef) === false) {
2384 // Delete from roles.
2385 if ($roles = get_roles_with_capability($cachedcap->name
)) {
2386 foreach ($roles as $role) {
2387 if (!unassign_capability($cachedcap->name
, $role->id
)) {
2388 print_error('cannotunassigncap', 'error', '', (object)array('cap'=>$cachedcap->name
, 'role'=>$role->name
));
2393 // Remove from role_capabilities for any old ones.
2394 $DB->delete_records('role_capabilities', array('capability' => $cachedcap->name
));
2396 // Remove from capabilities cache.
2397 $DB->delete_records('capabilities', array('name' => $cachedcap->name
));
2402 if ($removedcount) {
2403 cache
::make('core', 'capabilities')->delete('core_capabilities');
2405 return $removedcount;
2409 * Returns an array of all the known types of risk
2410 * The array keys can be used, for example as CSS class names, or in calls to
2411 * print_risk_icon. The values are the corresponding RISK_ constants.
2413 * @return array all the known types of risk.
2415 function get_all_risks() {
2417 'riskmanagetrust' => RISK_MANAGETRUST
,
2418 'riskconfig' => RISK_CONFIG
,
2419 'riskxss' => RISK_XSS
,
2420 'riskpersonal' => RISK_PERSONAL
,
2421 'riskspam' => RISK_SPAM
,
2422 'riskdataloss' => RISK_DATALOSS
,
2427 * Return a link to moodle docs for a given capability name
2429 * @param stdClass $capability a capability - a row from the mdl_capabilities table.
2430 * @return string the human-readable capability name as a link to Moodle Docs.
2432 function get_capability_docs_link($capability) {
2433 $url = get_docs_url('Capabilities/' . $capability->name
);
2434 return '<a onclick="this.target=\'docspopup\'" href="' . $url . '">' . get_capability_string($capability->name
) . '</a>';
2438 * This function pulls out all the resolved capabilities (overrides and
2439 * defaults) of a role used in capability overrides in contexts at a given
2442 * @param int $roleid
2443 * @param context $context
2444 * @param string $cap capability, optional, defaults to ''
2445 * @return array Array of capabilities
2447 function role_context_capabilities($roleid, context
$context, $cap = '') {
2450 $contexts = $context->get_parent_context_ids(true);
2451 $contexts = '('.implode(',', $contexts).')';
2453 $params = array($roleid);
2456 $search = " AND rc.capability = ? ";
2463 FROM {role_capabilities} rc
2464 JOIN {context} c ON rc.contextid = c.id
2465 JOIN {capabilities} cap ON rc.capability = cap.name
2466 WHERE rc.contextid in $contexts
2469 ORDER BY c.contextlevel DESC, rc.capability DESC";
2471 $capabilities = array();
2473 if ($records = $DB->get_records_sql($sql, $params)) {
2474 // We are traversing via reverse order.
2475 foreach ($records as $record) {
2476 // If not set yet (i.e. inherit or not set at all), or currently we have a prohibit
2477 if (!isset($capabilities[$record->capability
]) ||
$record->permission
<-500) {
2478 $capabilities[$record->capability
] = $record->permission
;
2482 return $capabilities;
2486 * Constructs array with contextids as first parameter and context paths,
2487 * in both cases bottom top including self.
2490 * @param context $context
2493 function get_context_info_list(context
$context) {
2494 $contextids = explode('/', ltrim($context->path
, '/'));
2495 $contextpaths = array();
2496 $contextids2 = $contextids;
2497 while ($contextids2) {
2498 $contextpaths[] = '/' . implode('/', $contextids2);
2499 array_pop($contextids2);
2501 return array($contextids, $contextpaths);
2505 * Check if context is the front page context or a context inside it
2507 * Returns true if this context is the front page context, or a context inside it,
2510 * @param context $context a context object.
2513 function is_inside_frontpage(context
$context) {
2514 $frontpagecontext = context_course
::instance(SITEID
);
2515 return strpos($context->path
. '/', $frontpagecontext->path
. '/') === 0;
2519 * Returns capability information (cached)
2521 * @param string $capabilityname
2522 * @return stdClass or null if capability not found
2524 function get_capability_info($capabilityname) {
2525 $caps = get_all_capabilities();
2527 if (!isset($caps[$capabilityname])) {
2531 return (object) $caps[$capabilityname];
2535 * Returns all capabilitiy records, preferably from MUC and not database.
2537 * @return array All capability records indexed by capability name
2539 function get_all_capabilities() {
2541 $cache = cache
::make('core', 'capabilities');
2542 if (!$allcaps = $cache->get('core_capabilities')) {
2543 $rs = $DB->get_recordset('capabilities');
2545 foreach ($rs as $capability) {
2546 $capability->riskbitmask
= (int) $capability->riskbitmask
;
2547 $allcaps[$capability->name
] = (array) $capability;
2550 $cache->set('core_capabilities', $allcaps);
2556 * Returns the human-readable, translated version of the capability.
2557 * Basically a big switch statement.
2559 * @param string $capabilityname e.g. mod/choice:readresponses
2562 function get_capability_string($capabilityname) {
2564 // Typical capability name is 'plugintype/pluginname:capabilityname'
2565 list($type, $name, $capname) = preg_split('|[/:]|', $capabilityname);
2567 if ($type === 'moodle') {
2568 $component = 'core_role';
2569 } else if ($type === 'quizreport') {
2571 $component = 'quiz_'.$name;
2573 $component = $type.'_'.$name;
2576 $stringname = $name.':'.$capname;
2578 if ($component === 'core_role' or get_string_manager()->string_exists($stringname, $component)) {
2579 return get_string($stringname, $component);
2582 $dir = core_component
::get_component_directory($component);
2583 if (!file_exists($dir)) {
2584 // plugin broken or does not exist, do not bother with printing of debug message
2585 return $capabilityname.' ???';
2588 // something is wrong in plugin, better print debug
2589 return get_string($stringname, $component);
2593 * This gets the mod/block/course/core etc strings.
2595 * @param string $component
2596 * @param int $contextlevel
2597 * @return string|bool String is success, false if failed
2599 function get_component_string($component, $contextlevel) {
2601 if ($component === 'moodle' ||
$component === 'core') {
2602 return context_helper
::get_level_name($contextlevel);
2605 list($type, $name) = core_component
::normalize_component($component);
2606 $dir = core_component
::get_plugin_directory($type, $name);
2607 if (!file_exists($dir)) {
2608 // plugin not installed, bad luck, there is no way to find the name
2609 return $component . ' ???';
2612 // Some plugin types need an extra prefix to make the name easy to understand.
2615 $prefix = get_string('quizreport', 'quiz') . ': ';
2618 $prefix = get_string('repository', 'repository') . ': ';
2621 $prefix = get_string('gradeimport', 'grades') . ': ';
2624 $prefix = get_string('gradeexport', 'grades') . ': ';
2627 $prefix = get_string('gradereport', 'grades') . ': ';
2630 $prefix = get_string('webservice', 'webservice') . ': ';
2633 $prefix = get_string('block') . ': ';
2636 $prefix = get_string('activity') . ': ';
2639 // Default case, just use the plugin name.
2643 return $prefix . get_string('pluginname', $component);
2647 * Gets the list of roles assigned to this context and up (parents)
2648 * from the aggregation of:
2649 * a) the list of roles that are visible on user profile page and participants page (profileroles setting) and;
2650 * b) if applicable, those roles that are assigned in the context.
2652 * @param context $context
2655 function get_profile_roles(context
$context) {
2657 // If the current user can assign roles, then they can see all roles on the profile and participants page,
2658 // provided the roles are assigned to at least 1 user in the context. If not, only the policy-defined roles.
2659 if (has_capability('moodle/role:assign', $context)) {
2660 $rolesinscope = array_keys(get_all_roles($context));
2662 $rolesinscope = empty($CFG->profileroles
) ?
[] : array_map('trim', explode(',', $CFG->profileroles
));
2665 if (empty($rolesinscope)) {
2669 list($rallowed, $params) = $DB->get_in_or_equal($rolesinscope, SQL_PARAMS_NAMED
, 'a');
2670 list($contextlist, $cparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED
, 'p');
2671 $params = array_merge($params, $cparams);
2673 if ($coursecontext = $context->get_course_context(false)) {
2674 $params['coursecontext'] = $coursecontext->id
;
2676 $params['coursecontext'] = 0;
2679 $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder, rn.name AS coursealias
2680 FROM {role_assignments} ra, {role} r
2681 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
2682 WHERE r.id = ra.roleid
2683 AND ra.contextid $contextlist
2685 ORDER BY r.sortorder ASC";
2687 return $DB->get_records_sql($sql, $params);
2691 * Gets the list of roles assigned to this context and up (parents)
2693 * @param context $context
2694 * @param boolean $includeparents, false means without parents.
2697 function get_roles_used_in_context(context
$context, $includeparents = true) {
2700 if ($includeparents === true) {
2701 list($contextlist, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED
, 'cl');
2703 list($contextlist, $params) = $DB->get_in_or_equal($context->id
, SQL_PARAMS_NAMED
, 'cl');
2706 if ($coursecontext = $context->get_course_context(false)) {
2707 $params['coursecontext'] = $coursecontext->id
;
2709 $params['coursecontext'] = 0;
2712 $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder, rn.name AS coursealias
2713 FROM {role_assignments} ra, {role} r
2714 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
2715 WHERE r.id = ra.roleid
2716 AND ra.contextid $contextlist
2717 ORDER BY r.sortorder ASC";
2719 return $DB->get_records_sql($sql, $params);
2723 * This function is used to print roles column in user profile page.
2724 * It is using the CFG->profileroles to limit the list to only interesting roles.
2725 * (The permission tab has full details of user role assignments.)
2727 * @param int $userid
2728 * @param int $courseid
2731 function get_user_roles_in_course($userid, $courseid) {
2733 if ($courseid == SITEID
) {
2734 $context = context_system
::instance();
2736 $context = context_course
::instance($courseid);
2738 // If the current user can assign roles, then they can see all roles on the profile and participants page,
2739 // provided the roles are assigned to at least 1 user in the context. If not, only the policy-defined roles.
2740 if (has_capability('moodle/role:assign', $context)) {
2741 $rolesinscope = array_keys(get_all_roles($context));
2743 $rolesinscope = empty($CFG->profileroles
) ?
[] : array_map('trim', explode(',', $CFG->profileroles
));
2745 if (empty($rolesinscope)) {
2749 list($rallowed, $params) = $DB->get_in_or_equal($rolesinscope, SQL_PARAMS_NAMED
, 'a');
2750 list($contextlist, $cparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED
, 'p');
2751 $params = array_merge($params, $cparams);
2753 if ($coursecontext = $context->get_course_context(false)) {
2754 $params['coursecontext'] = $coursecontext->id
;
2756 $params['coursecontext'] = 0;
2759 $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder, rn.name AS coursealias
2760 FROM {role_assignments} ra, {role} r
2761 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
2762 WHERE r.id = ra.roleid
2763 AND ra.contextid $contextlist
2765 AND ra.userid = :userid
2766 ORDER BY r.sortorder ASC";
2767 $params['userid'] = $userid;
2771 if ($roles = $DB->get_records_sql($sql, $params)) {
2772 $viewableroles = get_viewable_roles($context, $userid);
2774 $rolenames = array();
2775 foreach ($roles as $roleid => $unused) {
2776 if (isset($viewableroles[$roleid])) {
2777 $url = new moodle_url('/user/index.php', ['contextid' => $context->id
, 'roleid' => $roleid]);
2778 $rolenames[] = '<a href="' . $url . '">' . $viewableroles[$roleid] . '</a>';
2781 $rolestring = implode(', ', $rolenames);
2788 * Checks if a user can assign users to a particular role in this context
2790 * @param context $context
2791 * @param int $targetroleid - the id of the role you want to assign users to
2794 function user_can_assign(context
$context, $targetroleid) {
2797 // First check to see if the user is a site administrator.
2798 if (is_siteadmin()) {
2802 // Check if user has override capability.
2803 // If not return false.
2804 if (!has_capability('moodle/role:assign', $context)) {
2807 // pull out all active roles of this user from this context(or above)
2808 if ($userroles = get_user_roles($context)) {
2809 foreach ($userroles as $userrole) {
2810 // if any in the role_allow_override table, then it's ok
2811 if ($DB->get_record('role_allow_assign', array('roleid'=>$userrole->roleid
, 'allowassign'=>$targetroleid))) {
2821 * Returns all site roles in correct sort order.
2823 * Note: this method does not localise role names or descriptions,
2824 * use role_get_names() if you need role names.
2826 * @param context $context optional context for course role name aliases
2827 * @return array of role records with optional coursealias property
2829 function get_all_roles(context
$context = null) {
2832 if (!$context or !$coursecontext = $context->get_course_context(false)) {
2833 $coursecontext = null;
2836 if ($coursecontext) {
2837 $sql = "SELECT r.*, rn.name AS coursealias
2839 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
2840 ORDER BY r.sortorder ASC";
2841 return $DB->get_records_sql($sql, array('coursecontext'=>$coursecontext->id
));
2844 return $DB->get_records('role', array(), 'sortorder ASC');
2849 * Returns roles of a specified archetype
2851 * @param string $archetype
2852 * @return array of full role records
2854 function get_archetype_roles($archetype) {
2856 return $DB->get_records('role', array('archetype'=>$archetype), 'sortorder ASC');
2860 * Gets all the user roles assigned in this context, or higher contexts for a list of users.
2862 * If you try using the combination $userids = [], $checkparentcontexts = true then this is likely
2863 * to cause an out-of-memory error on large Moodle sites, so this combination is deprecated and
2864 * outputs a warning, even though it is the default.
2866 * @param context $context
2867 * @param array $userids. An empty list means fetch all role assignments for the context.
2868 * @param bool $checkparentcontexts defaults to true
2869 * @param string $order defaults to 'c.contextlevel DESC, r.sortorder ASC'
2872 function get_users_roles(context
$context, $userids = [], $checkparentcontexts = true, $order = 'c.contextlevel DESC, r.sortorder ASC') {
2875 if (!$userids && $checkparentcontexts) {
2876 debugging('Please do not call get_users_roles() with $checkparentcontexts = true ' .
2877 'and $userids array not set. This combination causes large Moodle sites ' .
2878 'with lots of site-wide role assignemnts to run out of memory.', DEBUG_DEVELOPER
);
2881 if ($checkparentcontexts) {
2882 $contextids = $context->get_parent_context_ids();
2884 $contextids = array();
2886 $contextids[] = $context->id
;
2888 list($contextids, $params) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED
, 'con');
2890 // If userids was passed as an empty array, we fetch all role assignments for the course.
2891 if (empty($userids)) {
2892 $useridlist = ' IS NOT NULL ';
2895 list($useridlist, $uparams) = $DB->get_in_or_equal($userids, SQL_PARAMS_NAMED
, 'uids');
2898 $sql = "SELECT ra.*, r.name, r.shortname, ra.userid
2899 FROM {role_assignments} ra, {role} r, {context} c
2900 WHERE ra.userid $useridlist
2901 AND ra.roleid = r.id
2902 AND ra.contextid = c.id
2903 AND ra.contextid $contextids
2906 $all = $DB->get_records_sql($sql , array_merge($params, $uparams));
2908 // Return results grouped by userid.
2910 foreach ($all as $id => $record) {
2911 if (!isset($result[$record->userid
])) {
2912 $result[$record->userid
] = [];
2914 $result[$record->userid
][$record->id
] = $record;
2917 // Make sure all requested users are included in the result, even if they had no role assignments.
2918 foreach ($userids as $id) {
2919 if (!isset($result[$id])) {
2929 * Gets all the user roles assigned in this context, or higher contexts
2930 * this is mainly used when checking if a user can assign a role, or overriding a role
2931 * i.e. we need to know what this user holds, in order to verify against allow_assign and
2932 * allow_override tables
2934 * @param context $context
2935 * @param int $userid
2936 * @param bool $checkparentcontexts defaults to true
2937 * @param string $order defaults to 'c.contextlevel DESC, r.sortorder ASC'
2940 function get_user_roles(context
$context, $userid = 0, $checkparentcontexts = true, $order = 'c.contextlevel DESC, r.sortorder ASC') {
2943 if (empty($userid)) {
2944 if (empty($USER->id
)) {
2947 $userid = $USER->id
;
2950 if ($checkparentcontexts) {
2951 $contextids = $context->get_parent_context_ids();
2953 $contextids = array();
2955 $contextids[] = $context->id
;
2957 list($contextids, $params) = $DB->get_in_or_equal($contextids, SQL_PARAMS_QM
);
2959 array_unshift($params, $userid);
2961 $sql = "SELECT ra.*, r.name, r.shortname
2962 FROM {role_assignments} ra, {role} r, {context} c
2964 AND ra.roleid = r.id
2965 AND ra.contextid = c.id
2966 AND ra.contextid $contextids
2969 return $DB->get_records_sql($sql ,$params);
2973 * Like get_user_roles, but adds in the authenticated user role, and the front
2974 * page roles, if applicable.
2976 * @param context $context the context.
2977 * @param int $userid optional. Defaults to $USER->id
2978 * @return array of objects with fields ->userid, ->contextid and ->roleid.
2980 function get_user_roles_with_special(context
$context, $userid = 0) {
2983 if (empty($userid)) {
2984 if (empty($USER->id
)) {
2987 $userid = $USER->id
;
2990 $ras = get_user_roles($context, $userid);
2992 // Add front-page role if relevant.
2993 $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid
) ?
$CFG->defaultfrontpageroleid
: 0;
2994 $isfrontpage = ($context->contextlevel
== CONTEXT_COURSE
&& $context->instanceid
== SITEID
) ||
2995 is_inside_frontpage($context);
2996 if ($defaultfrontpageroleid && $isfrontpage) {
2997 $frontpagecontext = context_course
::instance(SITEID
);
2998 $ra = new stdClass();
2999 $ra->userid
= $userid;
3000 $ra->contextid
= $frontpagecontext->id
;
3001 $ra->roleid
= $defaultfrontpageroleid;
3005 // Add authenticated user role if relevant.
3006 $defaultuserroleid = isset($CFG->defaultuserroleid
) ?
$CFG->defaultuserroleid
: 0;
3007 if ($defaultuserroleid && !isguestuser($userid)) {
3008 $systemcontext = context_system
::instance();
3009 $ra = new stdClass();
3010 $ra->userid
= $userid;
3011 $ra->contextid
= $systemcontext->id
;
3012 $ra->roleid
= $defaultuserroleid;
3020 * Creates a record in the role_allow_override table
3022 * @param int $fromroleid source roleid
3023 * @param int $targetroleid target roleid
3026 function core_role_set_override_allowed($fromroleid, $targetroleid) {
3029 $record = new stdClass();
3030 $record->roleid
= $fromroleid;
3031 $record->allowoverride
= $targetroleid;
3032 $DB->insert_record('role_allow_override', $record);
3036 * Creates a record in the role_allow_assign table
3038 * @param int $fromroleid source roleid
3039 * @param int $targetroleid target roleid
3042 function core_role_set_assign_allowed($fromroleid, $targetroleid) {
3045 $record = new stdClass();
3046 $record->roleid
= $fromroleid;
3047 $record->allowassign
= $targetroleid;
3048 $DB->insert_record('role_allow_assign', $record);
3052 * Creates a record in the role_allow_switch table
3054 * @param int $fromroleid source roleid
3055 * @param int $targetroleid target roleid
3058 function core_role_set_switch_allowed($fromroleid, $targetroleid) {
3061 $record = new stdClass();
3062 $record->roleid
= $fromroleid;
3063 $record->allowswitch
= $targetroleid;
3064 $DB->insert_record('role_allow_switch', $record);
3068 * Creates a record in the role_allow_view table
3070 * @param int $fromroleid source roleid
3071 * @param int $targetroleid target roleid
3074 function core_role_set_view_allowed($fromroleid, $targetroleid) {
3077 $record = new stdClass();
3078 $record->roleid
= $fromroleid;
3079 $record->allowview
= $targetroleid;
3080 $DB->insert_record('role_allow_view', $record);
3084 * Gets a list of roles that this user can assign in this context
3086 * @param context $context the context.
3087 * @param int $rolenamedisplay the type of role name to display. One of the
3088 * ROLENAME_X constants. Default ROLENAME_ALIAS.
3089 * @param bool $withusercounts if true, count the number of users with each role.
3090 * @param integer|object $user A user id or object. By default (null) checks the permissions of the current user.
3091 * @return array if $withusercounts is false, then an array $roleid => $rolename.
3092 * if $withusercounts is true, returns a list of three arrays,
3093 * $rolenames, $rolecounts, and $nameswithcounts.
3095 function get_assignable_roles(context
$context, $rolenamedisplay = ROLENAME_ALIAS
, $withusercounts = false, $user = null) {
3098 // make sure there is a real user specified
3099 if ($user === null) {
3100 $userid = isset($USER->id
) ?
$USER->id
: 0;
3102 $userid = is_object($user) ?
$user->id
: $user;
3105 if (!has_capability('moodle/role:assign', $context, $userid)) {
3106 if ($withusercounts) {
3107 return array(array(), array(), array());
3116 if ($withusercounts) {
3117 $extrafields = ', (SELECT COUNT(DISTINCT u.id)
3118 FROM {role_assignments} cra JOIN {user} u ON cra.userid = u.id
3119 WHERE cra.roleid = r.id AND cra.contextid = :conid AND u.deleted = 0
3121 $params['conid'] = $context->id
;
3124 if (is_siteadmin($userid)) {
3125 // show all roles allowed in this context to admins
3126 $assignrestriction = "";
3128 $parents = $context->get_parent_context_ids(true);
3129 $contexts = implode(',' , $parents);
3130 $assignrestriction = "JOIN (SELECT DISTINCT raa.allowassign AS id
3131 FROM {role_allow_assign} raa
3132 JOIN {role_assignments} ra ON ra.roleid = raa.roleid
3133 WHERE ra.userid = :userid AND ra.contextid IN ($contexts)
3134 ) ar ON ar.id = r.id";
3135 $params['userid'] = $userid;
3137 $params['contextlevel'] = $context->contextlevel
;
3139 if ($coursecontext = $context->get_course_context(false)) {
3140 $params['coursecontext'] = $coursecontext->id
;
3142 $params['coursecontext'] = 0; // no course aliases
3143 $coursecontext = null;
3145 $sql = "SELECT r.id, r.name, r.shortname, rn.name AS coursealias $extrafields
3148 JOIN {role_context_levels} rcl ON (rcl.contextlevel = :contextlevel AND r.id = rcl.roleid)
3149 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3150 ORDER BY r.sortorder ASC";
3151 $roles = $DB->get_records_sql($sql, $params);
3153 $rolenames = role_fix_names($roles, $coursecontext, $rolenamedisplay, true);
3155 if (!$withusercounts) {
3159 $rolecounts = array();
3160 $nameswithcounts = array();
3161 foreach ($roles as $role) {
3162 $nameswithcounts[$role->id
] = $rolenames[$role->id
] . ' (' . $roles[$role->id
]->usercount
. ')';
3163 $rolecounts[$role->id
] = $roles[$role->id
]->usercount
;
3165 return array($rolenames, $rolecounts, $nameswithcounts);
3169 * Gets a list of roles that this user can switch to in a context
3171 * Gets a list of roles that this user can switch to in a context, for the switchrole menu.
3172 * This function just process the contents of the role_allow_switch table. You also need to
3173 * test the moodle/role:switchroles to see if the user is allowed to switch in the first place.
3175 * @param context $context a context.
3176 * @param int $rolenamedisplay the type of role name to display. One of the
3177 * ROLENAME_X constants. Default ROLENAME_ALIAS.
3178 * @return array an array $roleid => $rolename.
3180 function get_switchable_roles(context
$context, $rolenamedisplay = ROLENAME_ALIAS
) {
3183 // You can't switch roles without this capability.
3184 if (!has_capability('moodle/role:switchroles', $context)) {
3191 if (!is_siteadmin()) {
3192 // Admins are allowed to switch to any role with.
3193 // Others are subject to the additional constraint that the switch-to role must be allowed by
3194 // 'role_allow_switch' for some role they have assigned in this context or any parent.
3195 $parents = $context->get_parent_context_ids(true);
3196 $contexts = implode(',' , $parents);
3198 $extrajoins = "JOIN {role_allow_switch} ras ON ras.allowswitch = rc.roleid
3199 JOIN {role_assignments} ra ON ra.roleid = ras.roleid";
3200 $extrawhere = "WHERE ra.userid = :userid AND ra.contextid IN ($contexts)";
3201 $params['userid'] = $USER->id
;
3204 if ($coursecontext = $context->get_course_context(false)) {
3205 $params['coursecontext'] = $coursecontext->id
;
3207 $params['coursecontext'] = 0; // no course aliases
3208 $coursecontext = null;
3212 SELECT r.id, r.name, r.shortname, rn.name AS coursealias
3213 FROM (SELECT DISTINCT rc.roleid
3214 FROM {role_capabilities} rc
3218 JOIN {role} r ON r.id = idlist.roleid
3219 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3220 ORDER BY r.sortorder";
3221 $roles = $DB->get_records_sql($query, $params);
3223 return role_fix_names($roles, $context, $rolenamedisplay, true);
3227 * Gets a list of roles that this user can view in a context
3229 * @param context $context a context.
3230 * @param int $userid id of user.
3231 * @param int $rolenamedisplay the type of role name to display. One of the
3232 * ROLENAME_X constants. Default ROLENAME_ALIAS.
3233 * @return array an array $roleid => $rolename.
3235 function get_viewable_roles(context
$context, $userid = null, $rolenamedisplay = ROLENAME_ALIAS
) {
3238 if ($userid == null) {
3239 $userid = $USER->id
;
3245 if (!is_siteadmin()) {
3246 // Admins are allowed to view any role.
3247 // Others are subject to the additional constraint that the view role must be allowed by
3248 // 'role_allow_view' for some role they have assigned in this context or any parent.
3249 $contexts = $context->get_parent_context_ids(true);
3250 list($insql, $inparams) = $DB->get_in_or_equal($contexts, SQL_PARAMS_NAMED
);
3252 $extrajoins = "JOIN {role_allow_view} ras ON ras.allowview = r.id
3253 JOIN {role_assignments} ra ON ra.roleid = ras.roleid";
3254 $extrawhere = "WHERE ra.userid = :userid AND ra.contextid $insql";
3256 $params +
= $inparams;
3257 $params['userid'] = $userid;
3260 if ($coursecontext = $context->get_course_context(false)) {
3261 $params['coursecontext'] = $coursecontext->id
;
3263 $params['coursecontext'] = 0; // No course aliases.
3264 $coursecontext = null;
3268 SELECT r.id, r.name, r.shortname, rn.name AS coursealias, r.sortorder
3271 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3273 GROUP BY r.id, r.name, r.shortname, rn.name, r.sortorder
3274 ORDER BY r.sortorder";
3275 $roles = $DB->get_records_sql($query, $params);
3277 return role_fix_names($roles, $context, $rolenamedisplay, true);
3281 * Gets a list of roles that this user can override in this context.
3283 * @param context $context the context.
3284 * @param int $rolenamedisplay the type of role name to display. One of the
3285 * ROLENAME_X constants. Default ROLENAME_ALIAS.
3286 * @param bool $withcounts if true, count the number of overrides that are set for each role.
3287 * @return array if $withcounts is false, then an array $roleid => $rolename.
3288 * if $withusercounts is true, returns a list of three arrays,
3289 * $rolenames, $rolecounts, and $nameswithcounts.
3291 function get_overridable_roles(context
$context, $rolenamedisplay = ROLENAME_ALIAS
, $withcounts = false) {
3294 if (!has_any_capability(array('moodle/role:safeoverride', 'moodle/role:override'), $context)) {
3296 return array(array(), array(), array());
3302 $parents = $context->get_parent_context_ids(true);
3303 $contexts = implode(',' , $parents);
3308 $params['userid'] = $USER->id
;
3310 $extrafields = ', (SELECT COUNT(rc.id) FROM {role_capabilities} rc
3311 WHERE rc.roleid = ro.id AND rc.contextid = :conid) AS overridecount';
3312 $params['conid'] = $context->id
;
3315 if ($coursecontext = $context->get_course_context(false)) {
3316 $params['coursecontext'] = $coursecontext->id
;
3318 $params['coursecontext'] = 0; // no course aliases
3319 $coursecontext = null;
3322 if (is_siteadmin()) {
3323 // show all roles to admins
3324 $roles = $DB->get_records_sql("
3325 SELECT ro.id, ro.name, ro.shortname, rn.name AS coursealias $extrafields
3327 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = ro.id)
3328 ORDER BY ro.sortorder ASC", $params);
3331 $roles = $DB->get_records_sql("
3332 SELECT ro.id, ro.name, ro.shortname, rn.name AS coursealias $extrafields
3334 JOIN (SELECT DISTINCT r.id
3336 JOIN {role_allow_override} rao ON r.id = rao.allowoverride
3337 JOIN {role_assignments} ra ON rao.roleid = ra.roleid
3338 WHERE ra.userid = :userid AND ra.contextid IN ($contexts)
3339 ) inline_view ON ro.id = inline_view.id
3340 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = ro.id)
3341 ORDER BY ro.sortorder ASC", $params);
3344 $rolenames = role_fix_names($roles, $context, $rolenamedisplay, true);
3350 $rolecounts = array();
3351 $nameswithcounts = array();
3352 foreach ($roles as $role) {
3353 $nameswithcounts[$role->id
] = $rolenames[$role->id
] . ' (' . $roles[$role->id
]->overridecount
. ')';
3354 $rolecounts[$role->id
] = $roles[$role->id
]->overridecount
;
3356 return array($rolenames, $rolecounts, $nameswithcounts);
3360 * Create a role menu suitable for default role selection in enrol plugins.
3362 * @package core_enrol
3364 * @param context $context
3365 * @param int $addroleid current or default role - always added to list
3366 * @return array roleid=>localised role name
3368 function get_default_enrol_roles(context
$context, $addroleid = null) {
3371 $params = array('contextlevel'=>CONTEXT_COURSE
);
3373 if ($coursecontext = $context->get_course_context(false)) {
3374 $params['coursecontext'] = $coursecontext->id
;
3376 $params['coursecontext'] = 0; // no course names
3377 $coursecontext = null;
3381 $addrole = "OR r.id = :addroleid";
3382 $params['addroleid'] = $addroleid;
3387 $sql = "SELECT r.id, r.name, r.shortname, rn.name AS coursealias
3389 LEFT JOIN {role_context_levels} rcl ON (rcl.roleid = r.id AND rcl.contextlevel = :contextlevel)
3390 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3391 WHERE rcl.id IS NOT NULL $addrole
3392 ORDER BY sortorder DESC";
3394 $roles = $DB->get_records_sql($sql, $params);
3396 return role_fix_names($roles, $context, ROLENAME_BOTH
, true);
3400 * Return context levels where this role is assignable.
3402 * @param integer $roleid the id of a role.
3403 * @return array list of the context levels at which this role may be assigned.
3405 function get_role_contextlevels($roleid) {
3407 return $DB->get_records_menu('role_context_levels', array('roleid' => $roleid),
3408 'contextlevel', 'id,contextlevel');
3412 * Return roles suitable for assignment at the specified context level.
3414 * NOTE: this function name looks like a typo, should be probably get_roles_for_contextlevel()
3416 * @param integer $contextlevel a contextlevel.
3417 * @return array list of role ids that are assignable at this context level.
3419 function get_roles_for_contextlevels($contextlevel) {
3421 return $DB->get_records_menu('role_context_levels', array('contextlevel' => $contextlevel),
3426 * Returns default context levels where roles can be assigned.
3428 * @param string $rolearchetype one of the role archetypes - that is, one of the keys
3429 * from the array returned by get_role_archetypes();
3430 * @return array list of the context levels at which this type of role may be assigned by default.
3432 function get_default_contextlevels($rolearchetype) {
3433 static $defaults = array(
3434 'manager' => array(CONTEXT_SYSTEM
, CONTEXT_COURSECAT
, CONTEXT_COURSE
),
3435 'coursecreator' => array(CONTEXT_SYSTEM
, CONTEXT_COURSECAT
),
3436 'editingteacher' => array(CONTEXT_COURSE
, CONTEXT_MODULE
),
3437 'teacher' => array(CONTEXT_COURSE
, CONTEXT_MODULE
),
3438 'student' => array(CONTEXT_COURSE
, CONTEXT_MODULE
),
3441 'frontpage' => array());
3443 if (isset($defaults[$rolearchetype])) {
3444 return $defaults[$rolearchetype];
3451 * Set the context levels at which a particular role can be assigned.
3452 * Throws exceptions in case of error.
3454 * @param integer $roleid the id of a role.
3455 * @param array $contextlevels the context levels at which this role should be assignable,
3456 * duplicate levels are removed.
3459 function set_role_contextlevels($roleid, array $contextlevels) {
3461 $DB->delete_records('role_context_levels', array('roleid' => $roleid));
3462 $rcl = new stdClass();
3463 $rcl->roleid
= $roleid;
3464 $contextlevels = array_unique($contextlevels);
3465 foreach ($contextlevels as $level) {
3466 $rcl->contextlevel
= $level;
3467 $DB->insert_record('role_context_levels', $rcl, false, true);
3472 * Gets sql joins for finding users with capability in the given context.
3474 * @param context $context Context for the join.
3475 * @param string|array $capability Capability name or array of names.
3476 * If an array is provided then this is the equivalent of a logical 'OR',
3477 * i.e. the user needs to have one of these capabilities.
3478 * @param string $useridcolumn e.g. 'u.id'.
3479 * @return \core\dml\sql_join Contains joins, wheres, params.
3480 * This function will set ->cannotmatchanyrows if applicable.
3481 * This may let you skip doing a DB query.
3483 function get_with_capability_join(context
$context, $capability, $useridcolumn) {
3486 // Add a unique prefix to param names to ensure they are unique.
3489 $paramprefix = 'eu' . $i . '_';
3491 $defaultuserroleid = isset($CFG->defaultuserroleid
) ?
$CFG->defaultuserroleid
: 0;
3492 $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid
) ?
$CFG->defaultfrontpageroleid
: 0;
3494 $ctxids = trim($context->path
, '/');
3495 $ctxids = str_replace('/', ',', $ctxids);
3497 // Context is the frontpage
3498 $isfrontpage = $context->contextlevel
== CONTEXT_COURSE
&& $context->instanceid
== SITEID
;
3499 $isfrontpage = $isfrontpage ||
is_inside_frontpage($context);
3501 $caps = (array) $capability;
3503 // Construct list of context paths bottom --> top.
3504 list($contextids, $paths) = get_context_info_list($context);
3506 // We need to find out all roles that have these capabilities either in definition or in overrides.
3508 list($incontexts, $params) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED
, $paramprefix . 'con');
3509 list($incaps, $params2) = $DB->get_in_or_equal($caps, SQL_PARAMS_NAMED
, $paramprefix . 'cap');
3511 // Check whether context locking is enabled.
3512 // Filter out any write capability if this is the case.
3513 $excludelockedcaps = '';
3514 $excludelockedcapsparams = [];
3515 if (!empty($CFG->contextlocking
) && $context->locked
) {
3516 $excludelockedcaps = 'AND (cap.captype = :capread OR cap.name = :managelockscap)';
3517 $excludelockedcapsparams['capread'] = 'read';
3518 $excludelockedcapsparams['managelockscap'] = 'moodle/site:managecontextlocks';
3521 $params = array_merge($params, $params2, $excludelockedcapsparams);
3522 $sql = "SELECT rc.id, rc.roleid, rc.permission, rc.capability, ctx.path
3523 FROM {role_capabilities} rc
3524 JOIN {capabilities} cap ON rc.capability = cap.name
3525 JOIN {context} ctx on rc.contextid = ctx.id
3526 WHERE rc.contextid $incontexts AND rc.capability $incaps $excludelockedcaps";
3528 $rcs = $DB->get_records_sql($sql, $params);
3529 foreach ($rcs as $rc) {
3530 $defs[$rc->capability
][$rc->path
][$rc->roleid
] = $rc->permission
;
3533 // Go through the permissions bottom-->top direction to evaluate the current permission,
3534 // first one wins (prohibit is an exception that always wins).
3536 foreach ($caps as $cap) {
3537 foreach ($paths as $path) {
3538 if (empty($defs[$cap][$path])) {
3541 foreach ($defs[$cap][$path] as $roleid => $perm) {
3542 if ($perm == CAP_PROHIBIT
) {
3543 $access[$cap][$roleid] = CAP_PROHIBIT
;
3546 if (!isset($access[$cap][$roleid])) {
3547 $access[$cap][$roleid] = (int)$perm;
3553 // Make lists of roles that are needed and prohibited in this context.
3554 $needed = []; // One of these is enough.
3555 $prohibited = []; // Must not have any of these.
3556 foreach ($caps as $cap) {
3557 if (empty($access[$cap])) {
3560 foreach ($access[$cap] as $roleid => $perm) {
3561 if ($perm == CAP_PROHIBIT
) {
3562 unset($needed[$cap][$roleid]);
3563 $prohibited[$cap][$roleid] = true;
3564 } else if ($perm == CAP_ALLOW
and empty($prohibited[$cap][$roleid])) {
3565 $needed[$cap][$roleid] = true;
3568 if (empty($needed[$cap]) or !empty($prohibited[$cap][$defaultuserroleid])) {
3569 // Easy, nobody has the permission.
3570 unset($needed[$cap]);
3571 unset($prohibited[$cap]);
3572 } else if ($isfrontpage and !empty($prohibited[$cap][$defaultfrontpageroleid])) {
3573 // Everybody is disqualified on the frontpage.
3574 unset($needed[$cap]);
3575 unset($prohibited[$cap]);
3577 if (empty($prohibited[$cap])) {
3578 unset($prohibited[$cap]);
3582 if (empty($needed)) {
3583 // There can not be anybody if no roles match this request.
3584 return new \core\dml\
sql_join('', '1 = 2', [], true);
3587 if (empty($prohibited)) {
3588 // We can compact the needed roles.
3590 foreach ($needed as $cap) {
3591 foreach ($cap as $roleid => $unused) {
3595 $needed = ['any' => $n];
3599 // Prepare query clauses.
3603 $cannotmatchanyrows = false;
3605 // We never return deleted users or guest account.
3606 // Use a hack to get the deleted user column without an API change.
3607 $deletedusercolumn = substr($useridcolumn, 0, -2) . 'deleted';
3608 $wherecond[] = "$deletedusercolumn = 0 AND $useridcolumn <> :{$paramprefix}guestid";
3609 $params[$paramprefix . 'guestid'] = $CFG->siteguest
;
3611 // Now add the needed and prohibited roles conditions as joins.
3612 if (!empty($needed['any'])) {
3613 // Simple case - there are no prohibits involved.
3614 if (!empty($needed['any'][$defaultuserroleid]) ||
3615 ($isfrontpage && !empty($needed['any'][$defaultfrontpageroleid]))) {
3618 $joins[] = "JOIN (SELECT DISTINCT userid
3619 FROM {role_assignments}
3620 WHERE contextid IN ($ctxids)
3621 AND roleid IN (" . implode(',', array_keys($needed['any'])) . ")
3622 ) ra ON ra.userid = $useridcolumn";
3627 foreach ($needed as $cap => $unused) {
3628 if (empty($prohibited[$cap])) {
3629 if (!empty($needed[$cap][$defaultuserroleid]) ||
3630 ($isfrontpage && !empty($needed[$cap][$defaultfrontpageroleid]))) {
3634 $unions[] = "SELECT userid
3635 FROM {role_assignments}
3636 WHERE contextid IN ($ctxids)
3637 AND roleid IN (".implode(',', array_keys($needed[$cap])) .")";
3640 if (!empty($prohibited[$cap][$defaultuserroleid]) ||
3641 ($isfrontpage && !empty($prohibited[$cap][$defaultfrontpageroleid]))) {
3642 // Nobody can have this cap because it is prohibited in default roles.
3645 } else if (!empty($needed[$cap][$defaultuserroleid]) ||
3646 ($isfrontpage && !empty($needed[$cap][$defaultfrontpageroleid]))) {
3647 // Everybody except the prohibited - hiding does not matter.
3648 $unions[] = "SELECT id AS userid
3650 WHERE id NOT IN (SELECT userid
3651 FROM {role_assignments}
3652 WHERE contextid IN ($ctxids)
3653 AND roleid IN (" . implode(',', array_keys($prohibited[$cap])) . "))";
3656 $unions[] = "SELECT userid
3657 FROM {role_assignments}
3658 WHERE contextid IN ($ctxids) AND roleid IN (" . implode(',', array_keys($needed[$cap])) . ")
3661 FROM {role_assignments}
3662 WHERE contextid IN ($ctxids)
3663 AND roleid IN (" . implode(',', array_keys($prohibited[$cap])) . "))";
3671 SELECT DISTINCT userid
3673 " . implode("\n UNION \n", $unions) . "
3675 ) ra ON ra.userid = $useridcolumn";
3677 // Only prohibits found - nobody can be matched.
3678 $wherecond[] = "1 = 2";
3679 $cannotmatchanyrows = true;
3684 return new \core\dml\
sql_join(implode("\n", $joins), implode(" AND ", $wherecond), $params, $cannotmatchanyrows);
3688 * Who has this capability in this context?
3690 * This can be a very expensive call - use sparingly and keep
3691 * the results if you are going to need them again soon.
3693 * Note if $fields is empty this function attempts to get u.*
3694 * which can get rather large - and has a serious perf impact
3697 * @param context $context
3698 * @param string|array $capability - capability name(s)
3699 * @param string $fields - fields to be pulled. The user table is aliased to 'u'. u.id MUST be included.
3700 * @param string $sort - the sort order. Default is lastaccess time.
3701 * @param mixed $limitfrom - number of records to skip (offset)
3702 * @param mixed $limitnum - number of records to fetch
3703 * @param string|array $groups - single group or array of groups - only return
3704 * users who are in one of these group(s).
3705 * @param string|array $exceptions - list of users to exclude, comma separated or array
3706 * @param bool $notuseddoanything not used any more, admin accounts are never returned
3707 * @param bool $notusedview - use get_enrolled_sql() instead
3708 * @param bool $useviewallgroups if $groups is set the return users who
3709 * have capability both $capability and moodle/site:accessallgroups
3710 * in this context, as well as users who have $capability and who are
3712 * @return array of user records
3714 function get_users_by_capability(context
$context, $capability, $fields = '', $sort = '', $limitfrom = '', $limitnum = '',
3715 $groups = '', $exceptions = '', $notuseddoanything = null, $notusedview = null, $useviewallgroups = false) {
3718 // Context is a course page other than the frontpage.
3719 $iscoursepage = $context->contextlevel
== CONTEXT_COURSE
&& $context->instanceid
!= SITEID
;
3721 // Set up default fields list if necessary.
3722 if (empty($fields)) {
3723 if ($iscoursepage) {
3724 $fields = 'u.*, ul.timeaccess AS lastaccess';
3729 if ($CFG->debugdeveloper
&& strpos($fields, 'u.*') === false && strpos($fields, 'u.id') === false) {
3730 debugging('u.id must be included in the list of fields passed to get_users_by_capability().', DEBUG_DEVELOPER
);
3734 // Set up default sort if necessary.
3735 if (empty($sort)) { // default to course lastaccess or just lastaccess
3736 if ($iscoursepage) {
3737 $sort = 'ul.timeaccess';
3739 $sort = 'u.lastaccess';
3743 // Get the bits of SQL relating to capabilities.
3744 $sqljoin = get_with_capability_join($context, $capability, 'u.id');
3745 if ($sqljoin->cannotmatchanyrows
) {
3749 // Prepare query clauses.
3750 $wherecond = [$sqljoin->wheres
];
3751 $params = $sqljoin->params
;
3752 $joins = [$sqljoin->joins
];
3754 // Add user lastaccess JOIN, if required.
3755 if ((strpos($sort, 'ul.timeaccess') === false) and (strpos($fields, 'ul.timeaccess') === false)) {
3756 // Here user_lastaccess is not required MDL-13810.
3758 if ($iscoursepage) {
3759 $joins[] = "LEFT OUTER JOIN {user_lastaccess} ul ON (ul.userid = u.id AND ul.courseid = {$context->instanceid})";
3761 throw new coding_exception('Invalid sort in get_users_by_capability(), ul.timeaccess allowed only for course contexts.');
3767 $groups = (array)$groups;
3768 list($grouptest, $grpparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED
, 'grp');
3769 $joins[] = "LEFT OUTER JOIN (SELECT DISTINCT userid
3770 FROM {groups_members}
3771 WHERE groupid $grouptest
3772 ) gm ON gm.userid = u.id";
3774 $params = array_merge($params, $grpparams);
3776 $grouptest = 'gm.userid IS NOT NULL';
3777 if ($useviewallgroups) {
3778 $viewallgroupsusers = get_users_by_capability($context, 'moodle/site:accessallgroups', 'u.id, u.id', '', '', '', '', $exceptions);
3779 if (!empty($viewallgroupsusers)) {
3780 $grouptest .= ' OR u.id IN (' . implode(',', array_keys($viewallgroupsusers)) . ')';
3783 $wherecond[] = "($grouptest)";
3787 if (!empty($exceptions)) {
3788 $exceptions = (array)$exceptions;
3789 list($exsql, $exparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED
, 'exc', false);
3790 $params = array_merge($params, $exparams);
3791 $wherecond[] = "u.id $exsql";
3794 // Collect WHERE conditions and needed joins.
3795 $where = implode(' AND ', $wherecond);
3796 if ($where !== '') {
3797 $where = 'WHERE ' . $where;
3799 $joins = implode("\n", $joins);
3801 // Finally! we have all the bits, run the query.
3802 $sql = "SELECT $fields
3808 return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
3812 * Re-sort a users array based on a sorting policy
3814 * Will re-sort a $users results array (from get_users_by_capability(), usually)
3815 * based on a sorting policy. This is to support the odd practice of
3816 * sorting teachers by 'authority', where authority was "lowest id of the role
3819 * Will execute 1 database query. Only suitable for small numbers of users, as it
3820 * uses an u.id IN() clause.
3822 * Notes about the sorting criteria.
3824 * As a default, we cannot rely on role.sortorder because then
3825 * admins/coursecreators will always win. That is why the sane
3826 * rule "is locality matters most", with sortorder as 2nd
3829 * If you want role.sortorder, use the 'sortorder' policy, and
3830 * name explicitly what roles you want to cover. It's probably
3831 * a good idea to see what roles have the capabilities you want
3832 * (array_diff() them against roiles that have 'can-do-anything'
3833 * to weed out admin-ish roles. Or fetch a list of roles from
3834 * variables like $CFG->coursecontact .
3836 * @param array $users Users array, keyed on userid
3837 * @param context $context
3838 * @param array $roles ids of the roles to include, optional
3839 * @param string $sortpolicy defaults to locality, more about
3840 * @return array sorted copy of the array
3842 function sort_by_roleassignment_authority($users, context
$context, $roles = array(), $sortpolicy = 'locality') {
3845 $userswhere = ' ra.userid IN (' . implode(',',array_keys($users)) . ')';
3846 $contextwhere = 'AND ra.contextid IN ('.str_replace('/', ',',substr($context->path
, 1)).')';
3847 if (empty($roles)) {
3850 $roleswhere = ' AND ra.roleid IN ('.implode(',',$roles).')';
3853 $sql = "SELECT ra.userid
3854 FROM {role_assignments} ra
3858 ON ra.contextid=ctx.id
3863 // Default 'locality' policy -- read PHPDoc notes
3864 // about sort policies...
3865 $orderby = 'ORDER BY '
3866 .'ctx.depth DESC, ' /* locality wins */
3867 .'r.sortorder ASC, ' /* rolesorting 2nd criteria */
3868 .'ra.id'; /* role assignment order tie-breaker */
3869 if ($sortpolicy === 'sortorder') {
3870 $orderby = 'ORDER BY '
3871 .'r.sortorder ASC, ' /* rolesorting 2nd criteria */
3872 .'ra.id'; /* role assignment order tie-breaker */
3875 $sortedids = $DB->get_fieldset_sql($sql . $orderby);
3876 $sortedusers = array();
3879 foreach ($sortedids as $id) {
3881 if (isset($seen[$id])) {
3887 $sortedusers[$id] = $users[$id];
3889 return $sortedusers;
3893 * Gets all the users assigned this role in this context or higher
3895 * Note that moodle is based on capabilities and it is usually better
3896 * to check permissions than to check role ids as the capabilities
3897 * system is more flexible. If you really need, you can to use this
3898 * function but consider has_capability() as a possible substitute.
3900 * All $sort fields are added into $fields if not present there yet.
3902 * If $roleid is an array or is empty (all roles) you need to set $fields
3903 * (and $sort by extension) params according to it, as the first field
3904 * returned by the database should be unique (ra.id is the best candidate).
3906 * @param int $roleid (can also be an array of ints!)
3907 * @param context $context
3908 * @param bool $parent if true, get list of users assigned in higher context too
3909 * @param string $fields fields from user (u.) , role assignment (ra) or role (r.)
3910 * @param string $sort sort from user (u.) , role assignment (ra.) or role (r.).
3911 * null => use default sort from users_order_by_sql.
3912 * @param bool $all true means all, false means limit to enrolled users
3913 * @param string $group defaults to ''
3914 * @param mixed $limitfrom defaults to ''
3915 * @param mixed $limitnum defaults to ''
3916 * @param string $extrawheretest defaults to ''
3917 * @param array $whereorsortparams any paramter values used by $sort or $extrawheretest.
3920 function get_role_users($roleid, context
$context, $parent = false, $fields = '',
3921 $sort = null, $all = true, $group = '',
3922 $limitfrom = '', $limitnum = '', $extrawheretest = '', $whereorsortparams = array()) {
3925 if (empty($fields)) {
3926 $userfieldsapi = \core_user\fields
::for_name();
3927 $allnames = $userfieldsapi->get_sql('u', false, '', '', false)->selects
;
3928 $fields = 'u.id, u.confirmed, u.username, '. $allnames . ', ' .
3929 'u.maildisplay, u.mailformat, u.maildigest, u.email, u.emailstop, u.city, '.
3930 'u.country, u.picture, u.idnumber, u.department, u.institution, '.
3931 'u.lang, u.timezone, u.lastaccess, u.mnethostid, r.name AS rolename, r.sortorder, '.
3932 'r.shortname AS roleshortname, rn.name AS rolecoursealias';
3935 // Prevent wrong function uses.
3936 if ((empty($roleid) ||
is_array($roleid)) && strpos($fields, 'ra.id') !== 0) {
3937 debugging('get_role_users() without specifying one single roleid needs to be called prefixing ' .
3938 'role assignments id (ra.id) as unique field, you can use $fields param for it.');
3940 if (!empty($roleid)) {
3941 // Solving partially the issue when specifying multiple roles.
3943 foreach ($roleid as $id) {
3944 // Ignoring duplicated keys keeping the first user appearance.
3945 $users = $users +
get_role_users($id, $context, $parent, $fields, $sort, $all, $group,
3946 $limitfrom, $limitnum, $extrawheretest, $whereorsortparams);
3952 $parentcontexts = '';
3954 $parentcontexts = substr($context->path
, 1); // kill leading slash
3955 $parentcontexts = str_replace('/', ',', $parentcontexts);
3956 if ($parentcontexts !== '') {
3957 $parentcontexts = ' OR ra.contextid IN ('.$parentcontexts.' )';
3962 list($rids, $params) = $DB->get_in_or_equal($roleid, SQL_PARAMS_NAMED
, 'r');
3963 $roleselect = "AND ra.roleid $rids";
3969 if ($coursecontext = $context->get_course_context(false)) {
3970 $params['coursecontext'] = $coursecontext->id
;
3972 $params['coursecontext'] = 0;
3976 $groupjoin = "JOIN {groups_members} gm ON gm.userid = u.id";
3977 $groupselect = " AND gm.groupid = :groupid ";
3978 $params['groupid'] = $group;
3984 $params['contextid'] = $context->id
;
3986 if ($extrawheretest) {
3987 $extrawheretest = ' AND ' . $extrawheretest;
3990 if ($whereorsortparams) {
3991 $params = array_merge($params, $whereorsortparams);
3995 list($sort, $sortparams) = users_order_by_sql('u');
3996 $params = array_merge($params, $sortparams);
3999 // Adding the fields from $sort that are not present in $fields.
4000 $sortarray = preg_split('/,\s*/', $sort);
4001 $fieldsarray = preg_split('/,\s*/', $fields);
4003 // Discarding aliases from the fields.
4004 $fieldnames = array();
4005 foreach ($fieldsarray as $key => $field) {
4006 list($fieldnames[$key]) = explode(' ', $field);
4009 $addedfields = array();
4010 foreach ($sortarray as $sortfield) {
4011 // Throw away any additional arguments to the sort (e.g. ASC/DESC).
4012 list($sortfield) = explode(' ', $sortfield);
4013 list($tableprefix) = explode('.', $sortfield);
4014 $fieldpresent = false;
4015 foreach ($fieldnames as $fieldname) {
4016 if ($fieldname === $sortfield ||
$fieldname === $tableprefix.'.*') {
4017 $fieldpresent = true;
4022 if (!$fieldpresent) {
4023 $fieldsarray[] = $sortfield;
4024 $addedfields[] = $sortfield;
4028 $fields = implode(', ', $fieldsarray);
4029 if (!empty($addedfields)) {
4030 $addedfields = implode(', ', $addedfields);
4031 debugging('get_role_users() adding '.$addedfields.' to the query result because they were required by $sort but missing in $fields');
4034 if ($all === null) {
4035 // Previously null was used to indicate that parameter was not used.
4038 if (!$all and $coursecontext) {
4039 // Do not use get_enrolled_sql() here for performance reasons.
4040 $ejoin = "JOIN {user_enrolments} ue ON ue.userid = u.id
4041 JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :ecourseid)";
4042 $params['ecourseid'] = $coursecontext->instanceid
;
4047 $sql = "SELECT DISTINCT $fields, ra.roleid
4048 FROM {role_assignments} ra
4049 JOIN {user} u ON u.id = ra.userid
4050 JOIN {role} r ON ra.roleid = r.id
4052 LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
4054 WHERE (ra.contextid = :contextid $parentcontexts)
4058 ORDER BY $sort"; // join now so that we can just use fullname() later
4060 return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
4064 * Counts all the users assigned this role in this context or higher
4066 * @param int|array $roleid either int or an array of ints
4067 * @param context $context
4068 * @param bool $parent if true, get list of users assigned in higher context too
4069 * @return int Returns the result count
4071 function count_role_users($roleid, context
$context, $parent = false) {
4075 if ($contexts = $context->get_parent_context_ids()) {
4076 $parentcontexts = ' OR r.contextid IN ('.implode(',', $contexts).')';
4078 $parentcontexts = '';
4081 $parentcontexts = '';
4085 list($rids, $params) = $DB->get_in_or_equal($roleid, SQL_PARAMS_QM
);
4086 $roleselect = "AND r.roleid $rids";
4092 array_unshift($params, $context->id
);
4094 $sql = "SELECT COUNT(DISTINCT u.id)
4095 FROM {role_assignments} r
4096 JOIN {user} u ON u.id = r.userid
4097 WHERE (r.contextid = ? $parentcontexts)
4101 return $DB->count_records_sql($sql, $params);
4105 * This function gets the list of course and course category contexts that this user has a particular capability in.
4107 * It is now reasonably efficient, but bear in mind that if there are users who have the capability
4108 * everywhere, it may return an array of all contexts.
4110 * @param string $capability Capability in question
4111 * @param int $userid User ID or null for current user
4112 * @param bool $getcategories Wether to return also course_categories
4113 * @param bool $doanything True if 'doanything' is permitted (default)
4114 * @param string $coursefieldsexceptid Leave blank if you only need 'id' in the course records;
4115 * otherwise use a comma-separated list of the fields you require, not including id.
4116 * Add ctxid, ctxpath, ctxdepth etc to return course context information for preloading.
4117 * @param string $categoryfieldsexceptid Leave blank if you only need 'id' in the course records;
4118 * otherwise use a comma-separated list of the fields you require, not including id.
4119 * Add ctxid, ctxpath, ctxdepth etc to return course context information for preloading.
4120 * @param string $courseorderby If set, use a comma-separated list of fields from course
4121 * table with sql modifiers (DESC) if needed
4122 * @param string $categoryorderby If set, use a comma-separated list of fields from course_category
4123 * table with sql modifiers (DESC) if needed
4124 * @param int $limit Limit the number of courses to return on success. Zero equals all entries.
4125 * @return array Array of categories and courses.
4127 function get_user_capability_contexts(string $capability, bool $getcategories, $userid = null, $doanything = true,
4128 $coursefieldsexceptid = '', $categoryfieldsexceptid = '', $courseorderby = '',
4129 $categoryorderby = '', $limit = 0): array {
4132 // Default to current user.
4134 $userid = $USER->id
;
4137 if ($doanything && is_siteadmin($userid)) {
4138 // If the user is a site admin and $doanything is enabled then there is no need to restrict
4139 // the list of courses.
4140 $contextlimitsql = '';
4141 $contextlimitparams = [];
4143 // Gets SQL to limit contexts ('x' table) to those where the user has this capability.
4144 list ($contextlimitsql, $contextlimitparams) = \core\access\get_user_capability_course_helper
::get_sql(
4145 $userid, $capability);
4146 if (!$contextlimitsql) {
4147 // If the does not have this capability in any context, return false without querying.
4148 return [false, false];
4151 $contextlimitsql = 'WHERE' . $contextlimitsql;
4155 if ($getcategories) {
4156 $fieldlist = \core\access\get_user_capability_course_helper
::map_fieldnames($categoryfieldsexceptid);
4157 if ($categoryorderby) {
4158 $fields = explode(',', $categoryorderby);
4160 foreach ($fields as $field) {
4164 $orderby .= 'c.'.$field;
4166 $orderby = 'ORDER BY '.$orderby;
4168 $rs = $DB->get_recordset_sql("
4169 SELECT c.id $fieldlist
4170 FROM {course_categories} c
4171 JOIN {context} x ON c.id = x.instanceid AND x.contextlevel = ?
4173 $orderby", array_merge([CONTEXT_COURSECAT
], $contextlimitparams));
4174 $basedlimit = $limit;
4175 foreach ($rs as $category) {
4176 $categories[] = $category;
4178 if ($basedlimit == 0) {
4185 $fieldlist = \core\access\get_user_capability_course_helper
::map_fieldnames($coursefieldsexceptid);
4186 if ($courseorderby) {
4187 $fields = explode(',', $courseorderby);
4188 $courseorderby = '';
4189 foreach ($fields as $field) {
4190 if ($courseorderby) {
4191 $courseorderby .= ',';
4193 $courseorderby .= 'c.'.$field;
4195 $courseorderby = 'ORDER BY '.$courseorderby;
4197 $rs = $DB->get_recordset_sql("
4198 SELECT c.id $fieldlist
4200 JOIN {context} x ON c.id = x.instanceid AND x.contextlevel = ?
4202 $courseorderby", array_merge([CONTEXT_COURSE
], $contextlimitparams));
4203 foreach ($rs as $course) {
4204 $courses[] = $course;
4211 return [$categories, $courses];
4215 * This function gets the list of courses that this user has a particular capability in.
4217 * It is now reasonably efficient, but bear in mind that if there are users who have the capability
4218 * everywhere, it may return an array of all courses.
4220 * @param string $capability Capability in question
4221 * @param int $userid User ID or null for current user
4222 * @param bool $doanything True if 'doanything' is permitted (default)
4223 * @param string $fieldsexceptid Leave blank if you only need 'id' in the course records;
4224 * otherwise use a comma-separated list of the fields you require, not including id.
4225 * Add ctxid, ctxpath, ctxdepth etc to return course context information for preloading.
4226 * @param string $orderby If set, use a comma-separated list of fields from course
4227 * table with sql modifiers (DESC) if needed
4228 * @param int $limit Limit the number of courses to return on success. Zero equals all entries.
4229 * @return array|bool Array of courses, if none found false is returned.
4231 function get_user_capability_course($capability, $userid = null, $doanything = true, $fieldsexceptid = '',
4232 $orderby = '', $limit = 0) {
4233 list($categories, $courses) = get_user_capability_contexts(
4248 * Switches the current user to another role for the current session and only
4249 * in the given context.
4251 * The caller *must* check
4252 * - that this op is allowed
4253 * - that the requested role can be switched to in this context (use get_switchable_roles)
4254 * - that the requested role is NOT $CFG->defaultuserroleid
4256 * To "unswitch" pass 0 as the roleid.
4258 * This function *will* modify $USER->access - beware
4260 * @param integer $roleid the role to switch to.
4261 * @param context $context the context in which to perform the switch.
4262 * @return bool success or failure.
4264 function role_switch($roleid, context
$context) {
4267 // Add the ghost RA to $USER->access as $USER->access['rsw'][$path] = $roleid.
4268 // To un-switch just unset($USER->access['rsw'][$path]).
4270 // Note: it is not possible to switch to roles that do not have course:view
4272 if (!isset($USER->access
)) {
4273 load_all_capabilities();
4276 // Add the switch RA
4278 unset($USER->access
['rsw'][$context->path
]);
4282 $USER->access
['rsw'][$context->path
] = $roleid;
4288 * Checks if the user has switched roles within the given course.
4290 * Note: You can only switch roles within the course, hence it takes a course id
4291 * rather than a context. On that note Petr volunteered to implement this across
4292 * all other contexts, all requests for this should be forwarded to him ;)
4294 * @param int $courseid The id of the course to check
4295 * @return bool True if the user has switched roles within the course.
4297 function is_role_switched($courseid) {
4299 $context = context_course
::instance($courseid, MUST_EXIST
);
4300 return (!empty($USER->access
['rsw'][$context->path
]));
4304 * Get any role that has an override on exact context
4306 * @param context $context The context to check
4307 * @return array An array of roles
4309 function get_roles_with_override_on_context(context
$context) {
4312 return $DB->get_records_sql("SELECT r.*
4313 FROM {role_capabilities} rc, {role} r
4314 WHERE rc.roleid = r.id AND rc.contextid = ?",
4315 array($context->id
));
4319 * Get all capabilities for this role on this context (overrides)
4321 * @param stdClass $role
4322 * @param context $context
4325 function get_capabilities_from_role_on_context($role, context
$context) {
4328 return $DB->get_records_sql("SELECT *
4329 FROM {role_capabilities}
4330 WHERE contextid = ? AND roleid = ?",
4331 array($context->id
, $role->id
));
4335 * Find all user assignment of users for this role, on this context
4337 * @param stdClass $role
4338 * @param context $context
4341 function get_users_from_role_on_context($role, context
$context) {
4344 return $DB->get_records_sql("SELECT *
4345 FROM {role_assignments}
4346 WHERE contextid = ? AND roleid = ?",
4347 array($context->id
, $role->id
));
4351 * Simple function returning a boolean true if user has roles
4352 * in context or parent contexts, otherwise false.
4354 * @param int $userid
4355 * @param int $roleid
4356 * @param int $contextid empty means any context
4359 function user_has_role_assignment($userid, $roleid, $contextid = 0) {
4363 if (!$context = context
::instance_by_id($contextid, IGNORE_MISSING
)) {
4366 $parents = $context->get_parent_context_ids(true);
4367 list($contexts, $params) = $DB->get_in_or_equal($parents, SQL_PARAMS_NAMED
, 'r');
4368 $params['userid'] = $userid;
4369 $params['roleid'] = $roleid;
4371 $sql = "SELECT COUNT(ra.id)
4372 FROM {role_assignments} ra
4373 WHERE ra.userid = :userid AND ra.roleid = :roleid AND ra.contextid $contexts";
4375 $count = $DB->get_field_sql($sql, $params);
4376 return ($count > 0);
4379 return $DB->record_exists('role_assignments', array('userid'=>$userid, 'roleid'=>$roleid));
4384 * Get localised role name or alias if exists and format the text.
4386 * @param stdClass $role role object
4387 * - optional 'coursealias' property should be included for performance reasons if course context used
4388 * - description property is not required here
4389 * @param context|bool $context empty means system context
4390 * @param int $rolenamedisplay type of role name
4391 * @return string localised role name or course role name alias
4393 function role_get_name(stdClass
$role, $context = null, $rolenamedisplay = ROLENAME_ALIAS
) {
4396 if ($rolenamedisplay == ROLENAME_SHORT
) {
4397 return $role->shortname
;
4400 if (!$context or !$coursecontext = $context->get_course_context(false)) {
4401 $coursecontext = null;
4404 if ($coursecontext and !property_exists($role, 'coursealias') and ($rolenamedisplay == ROLENAME_ALIAS
or $rolenamedisplay == ROLENAME_BOTH
or $rolenamedisplay == ROLENAME_ALIAS_RAW
)) {
4405 $role = clone($role); // Do not modify parameters.
4406 if ($r = $DB->get_record('role_names', array('roleid'=>$role->id
, 'contextid'=>$coursecontext->id
))) {
4407 $role->coursealias
= $r->name
;
4409 $role->coursealias
= null;
4413 if ($rolenamedisplay == ROLENAME_ALIAS_RAW
) {
4414 if ($coursecontext) {
4415 return $role->coursealias
;
4421 if (trim($role->name
) !== '') {
4422 // For filtering always use context where was the thing defined - system for roles here.
4423 $original = format_string($role->name
, true, array('context'=>context_system
::instance()));
4426 // Empty role->name means we want to see localised role name based on shortname,
4427 // only default roles are supposed to be localised.
4428 switch ($role->shortname
) {
4429 case 'manager': $original = get_string('manager', 'role'); break;
4430 case 'coursecreator': $original = get_string('coursecreators'); break;
4431 case 'editingteacher': $original = get_string('defaultcourseteacher'); break;
4432 case 'teacher': $original = get_string('noneditingteacher'); break;
4433 case 'student': $original = get_string('defaultcoursestudent'); break;
4434 case 'guest': $original = get_string('guest'); break;
4435 case 'user': $original = get_string('authenticateduser'); break;
4436 case 'frontpage': $original = get_string('frontpageuser', 'role'); break;
4437 // We should not get here, the role UI should require the name for custom roles!
4438 default: $original = $role->shortname
; break;
4442 if ($rolenamedisplay == ROLENAME_ORIGINAL
) {
4446 if ($rolenamedisplay == ROLENAME_ORIGINALANDSHORT
) {
4447 return "$original ($role->shortname)";
4450 if ($rolenamedisplay == ROLENAME_ALIAS
) {
4451 if ($coursecontext and trim($role->coursealias
) !== '') {
4452 return format_string($role->coursealias
, true, array('context'=>$coursecontext));
4458 if ($rolenamedisplay == ROLENAME_BOTH
) {
4459 if ($coursecontext and trim($role->coursealias
) !== '') {
4460 return format_string($role->coursealias
, true, array('context'=>$coursecontext)) . " ($original)";
4466 throw new coding_exception('Invalid $rolenamedisplay parameter specified in role_get_name()');
4470 * Returns localised role description if available.
4471 * If the name is empty it tries to find the default role name using
4472 * hardcoded list of default role names or other methods in the future.
4474 * @param stdClass $role
4475 * @return string localised role name
4477 function role_get_description(stdClass
$role) {
4478 if (!html_is_blank($role->description
)) {
4479 return format_text($role->description
, FORMAT_HTML
, array('context'=>context_system
::instance()));
4482 switch ($role->shortname
) {
4483 case 'manager': return get_string('managerdescription', 'role');
4484 case 'coursecreator': return get_string('coursecreatorsdescription');
4485 case 'editingteacher': return get_string('defaultcourseteacherdescription');
4486 case 'teacher': return get_string('noneditingteacherdescription');
4487 case 'student': return get_string('defaultcoursestudentdescription');
4488 case 'guest': return get_string('guestdescription');
4489 case 'user': return get_string('authenticateduserdescription');
4490 case 'frontpage': return get_string('frontpageuserdescription', 'role');
4496 * Get all the localised role names for a context.
4498 * In new installs default roles have empty names, this function
4499 * add localised role names using current language pack.
4501 * @param context $context the context, null means system context
4502 * @param array of role objects with a ->localname field containing the context-specific role name.
4503 * @param int $rolenamedisplay
4504 * @param bool $returnmenu true means id=>localname, false means id=>rolerecord
4505 * @return array Array of context-specific role names, or role objects with a ->localname field added.
4507 function role_get_names(context
$context = null, $rolenamedisplay = ROLENAME_ALIAS
, $returnmenu = null) {
4508 return role_fix_names(get_all_roles($context), $context, $rolenamedisplay, $returnmenu);
4512 * Prepare list of roles for display, apply aliases and localise default role names.
4514 * @param array $roleoptions array roleid => roleobject (with optional coursealias), strings are accepted for backwards compatibility only
4515 * @param context $context the context, null means system context
4516 * @param int $rolenamedisplay
4517 * @param bool $returnmenu null means keep the same format as $roleoptions, true means id=>localname, false means id=>rolerecord
4518 * @return array Array of context-specific role names, or role objects with a ->localname field added.
4520 function role_fix_names($roleoptions, context
$context = null, $rolenamedisplay = ROLENAME_ALIAS
, $returnmenu = null) {
4523 if (empty($roleoptions)) {
4527 if (!$context or !$coursecontext = $context->get_course_context(false)) {
4528 $coursecontext = null;
4531 // We usually need all role columns...
4532 $first = reset($roleoptions);
4533 if ($returnmenu === null) {
4534 $returnmenu = !is_object($first);
4537 if (!is_object($first) or !property_exists($first, 'shortname')) {
4538 $allroles = get_all_roles($context);
4539 foreach ($roleoptions as $rid => $unused) {
4540 $roleoptions[$rid] = $allroles[$rid];
4544 // Inject coursealias if necessary.
4545 if ($coursecontext and ($rolenamedisplay == ROLENAME_ALIAS_RAW
or $rolenamedisplay == ROLENAME_ALIAS
or $rolenamedisplay == ROLENAME_BOTH
)) {
4546 $first = reset($roleoptions);
4547 if (!property_exists($first, 'coursealias')) {
4548 $aliasnames = $DB->get_records('role_names', array('contextid'=>$coursecontext->id
));
4549 foreach ($aliasnames as $alias) {
4550 if (isset($roleoptions[$alias->roleid
])) {
4551 $roleoptions[$alias->roleid
]->coursealias
= $alias->name
;
4557 // Add localname property.
4558 foreach ($roleoptions as $rid => $role) {
4559 $roleoptions[$rid]->localname
= role_get_name($role, $coursecontext, $rolenamedisplay);
4563 return $roleoptions;
4567 foreach ($roleoptions as $rid => $role) {
4568 $menu[$rid] = $role->localname
;
4575 * Aids in detecting if a new line is required when reading a new capability
4577 * This function helps admin/roles/manage.php etc to detect if a new line should be printed
4578 * when we read in a new capability.
4579 * Most of the time, if the 2 components are different we should print a new line, (e.g. course system->rss client)
4580 * but when we are in grade, all reports/import/export capabilities should be together
4582 * @param string $cap component string a
4583 * @param string $comp component string b
4584 * @param int $contextlevel
4585 * @return bool whether 2 component are in different "sections"
4587 function component_level_changed($cap, $comp, $contextlevel) {
4589 if (strstr($cap->component
, '/') && strstr($comp, '/')) {
4590 $compsa = explode('/', $cap->component
);
4591 $compsb = explode('/', $comp);
4593 // list of system reports
4594 if (($compsa[0] == 'report') && ($compsb[0] == 'report')) {
4598 // we are in gradebook, still
4599 if (($compsa[0] == 'gradeexport' ||
$compsa[0] == 'gradeimport' ||
$compsa[0] == 'gradereport') &&
4600 ($compsb[0] == 'gradeexport' ||
$compsb[0] == 'gradeimport' ||
$compsb[0] == 'gradereport')) {
4604 if (($compsa[0] == 'coursereport') && ($compsb[0] == 'coursereport')) {
4609 return ($cap->component
!= $comp ||
$cap->contextlevel
!= $contextlevel);
4613 * Fix the roles.sortorder field in the database, so it contains sequential integers,
4614 * and return an array of roleids in order.
4616 * @param array $allroles array of roles, as returned by get_all_roles();
4617 * @return array $role->sortorder =-> $role->id with the keys in ascending order.
4619 function fix_role_sortorder($allroles) {
4622 $rolesort = array();
4624 foreach ($allroles as $role) {
4625 $rolesort[$i] = $role->id
;
4626 if ($role->sortorder
!= $i) {
4627 $r = new stdClass();
4630 $DB->update_record('role', $r);
4631 $allroles[$role->id
]->sortorder
= $i;
4639 * Switch the sort order of two roles (used in admin/roles/manage.php).
4641 * @param stdClass $first The first role. Actually, only ->sortorder is used.
4642 * @param stdClass $second The second role. Actually, only ->sortorder is used.
4643 * @return boolean success or failure
4645 function switch_roles($first, $second) {
4647 $temp = $DB->get_field('role', 'MAX(sortorder) + 1', array());
4648 $result = $DB->set_field('role', 'sortorder', $temp, array('sortorder' => $first->sortorder
));
4649 $result = $result && $DB->set_field('role', 'sortorder', $first->sortorder
, array('sortorder' => $second->sortorder
));
4650 $result = $result && $DB->set_field('role', 'sortorder', $second->sortorder
, array('sortorder' => $temp));
4655 * Duplicates all the base definitions of a role
4657 * @param stdClass $sourcerole role to copy from
4658 * @param int $targetrole id of role to copy to
4660 function role_cap_duplicate($sourcerole, $targetrole) {
4663 $systemcontext = context_system
::instance();
4664 $caps = $DB->get_records_sql("SELECT *
4665 FROM {role_capabilities}
4666 WHERE roleid = ? AND contextid = ?",
4667 array($sourcerole->id
, $systemcontext->id
));
4668 // adding capabilities
4669 foreach ($caps as $cap) {
4671 $cap->roleid
= $targetrole;
4672 $DB->insert_record('role_capabilities', $cap);
4675 // Reset any cache of this role, including MUC.
4676 accesslib_clear_role_cache($targetrole);
4680 * Returns two lists, this can be used to find out if user has capability.
4681 * Having any needed role and no forbidden role in this context means
4682 * user has this capability in this context.
4683 * Use get_role_names_with_cap_in_context() if you need role names to display in the UI
4685 * @param stdClass $context
4686 * @param string $capability
4687 * @return array($neededroles, $forbiddenroles)
4689 function get_roles_with_cap_in_context($context, $capability) {
4692 $ctxids = trim($context->path
, '/'); // kill leading slash
4693 $ctxids = str_replace('/', ',', $ctxids);
4695 $sql = "SELECT rc.id, rc.roleid, rc.permission, ctx.depth
4696 FROM {role_capabilities} rc
4697 JOIN {context} ctx ON ctx.id = rc.contextid
4698 JOIN {capabilities} cap ON rc.capability = cap.name
4699 WHERE rc.capability = :cap AND ctx.id IN ($ctxids)
4700 ORDER BY rc.roleid ASC, ctx.depth DESC";
4701 $params = array('cap'=>$capability);
4703 if (!$capdefs = $DB->get_records_sql($sql, $params)) {
4704 // no cap definitions --> no capability
4705 return array(array(), array());
4708 $forbidden = array();
4710 foreach ($capdefs as $def) {
4711 if (isset($forbidden[$def->roleid
])) {
4714 if ($def->permission
== CAP_PROHIBIT
) {
4715 $forbidden[$def->roleid
] = $def->roleid
;
4716 unset($needed[$def->roleid
]);
4719 if (!isset($needed[$def->roleid
])) {
4720 if ($def->permission
== CAP_ALLOW
) {
4721 $needed[$def->roleid
] = true;
4722 } else if ($def->permission
== CAP_PREVENT
) {
4723 $needed[$def->roleid
] = false;
4729 // remove all those roles not allowing
4730 foreach ($needed as $key=>$value) {
4732 unset($needed[$key]);
4734 $needed[$key] = $key;
4738 return array($needed, $forbidden);
4742 * Returns an array of role IDs that have ALL of the the supplied capabilities
4743 * Uses get_roles_with_cap_in_context(). Returns $allowed minus $forbidden
4745 * @param stdClass $context
4746 * @param array $capabilities An array of capabilities
4747 * @return array of roles with all of the required capabilities
4749 function get_roles_with_caps_in_context($context, $capabilities) {
4750 $neededarr = array();
4751 $forbiddenarr = array();
4752 foreach ($capabilities as $caprequired) {
4753 list($neededarr[], $forbiddenarr[]) = get_roles_with_cap_in_context($context, $caprequired);
4756 $rolesthatcanrate = array();
4757 if (!empty($neededarr)) {
4758 foreach ($neededarr as $needed) {
4759 if (empty($rolesthatcanrate)) {
4760 $rolesthatcanrate = $needed;
4762 //only want roles that have all caps
4763 $rolesthatcanrate = array_intersect_key($rolesthatcanrate,$needed);
4767 if (!empty($forbiddenarr) && !empty($rolesthatcanrate)) {
4768 foreach ($forbiddenarr as $forbidden) {
4769 //remove any roles that are forbidden any of the caps
4770 $rolesthatcanrate = array_diff($rolesthatcanrate, $forbidden);
4773 return $rolesthatcanrate;
4777 * Returns an array of role names that have ALL of the the supplied capabilities
4778 * Uses get_roles_with_caps_in_context(). Returns $allowed minus $forbidden
4780 * @param stdClass $context
4781 * @param array $capabilities An array of capabilities
4782 * @return array of roles with all of the required capabilities
4784 function get_role_names_with_caps_in_context($context, $capabilities) {
4787 $rolesthatcanrate = get_roles_with_caps_in_context($context, $capabilities);
4788 $allroles = $DB->get_records('role', null, 'sortorder DESC');
4791 foreach ($rolesthatcanrate as $r) {
4792 $roles[$r] = $allroles[$r];
4795 return role_fix_names($roles, $context, ROLENAME_ALIAS
, true);
4799 * This function verifies the prohibit comes from this context
4800 * and there are no more prohibits in parent contexts.
4802 * @param int $roleid
4803 * @param context $context
4804 * @param string $capability name
4807 function prohibit_is_removable($roleid, context
$context, $capability) {
4810 $ctxids = trim($context->path
, '/'); // kill leading slash
4811 $ctxids = str_replace('/', ',', $ctxids);
4813 $params = array('roleid'=>$roleid, 'cap'=>$capability, 'prohibit'=>CAP_PROHIBIT
);
4815 $sql = "SELECT ctx.id
4816 FROM {role_capabilities} rc
4817 JOIN {context} ctx ON ctx.id = rc.contextid
4818 JOIN {capabilities} cap ON rc.capability = cap.name
4819 WHERE rc.roleid = :roleid AND rc.permission = :prohibit AND rc.capability = :cap AND ctx.id IN ($ctxids)
4820 ORDER BY ctx.depth DESC";
4822 if (!$prohibits = $DB->get_records_sql($sql, $params)) {
4823 // no prohibits == nothing to remove
4827 if (count($prohibits) > 1) {
4828 // more prohibits can not be removed
4832 return !empty($prohibits[$context->id
]);
4836 * More user friendly role permission changing,
4837 * it should produce as few overrides as possible.
4839 * @param int $roleid
4840 * @param stdClass $context
4841 * @param string $capname capability name
4842 * @param int $permission
4845 function role_change_permission($roleid, $context, $capname, $permission) {
4848 if ($permission == CAP_INHERIT
) {
4849 unassign_capability($capname, $roleid, $context->id
);
4853 $ctxids = trim($context->path
, '/'); // kill leading slash
4854 $ctxids = str_replace('/', ',', $ctxids);
4856 $params = array('roleid'=>$roleid, 'cap'=>$capname);
4858 $sql = "SELECT ctx.id, rc.permission, ctx.depth
4859 FROM {role_capabilities} rc
4860 JOIN {context} ctx ON ctx.id = rc.contextid
4861 JOIN {capabilities} cap ON rc.capability = cap.name
4862 WHERE rc.roleid = :roleid AND rc.capability = :cap AND ctx.id IN ($ctxids)
4863 ORDER BY ctx.depth DESC";
4865 if ($existing = $DB->get_records_sql($sql, $params)) {
4866 foreach ($existing as $e) {
4867 if ($e->permission
== CAP_PROHIBIT
) {
4868 // prohibit can not be overridden, no point in changing anything
4872 $lowest = array_shift($existing);
4873 if ($lowest->permission
== $permission) {
4874 // permission already set in this context or parent - nothing to do
4878 $parent = array_shift($existing);
4879 if ($parent->permission
== $permission) {
4880 // permission already set in parent context or parent - just unset in this context
4881 // we do this because we want as few overrides as possible for performance reasons
4882 unassign_capability($capname, $roleid, $context->id
);
4888 if ($permission == CAP_PREVENT
) {
4889 // nothing means role does not have permission
4894 // assign the needed capability
4895 assign_capability($capname, $permission, $roleid, $context->id
, true);
4900 * Basic moodle context abstraction class.
4902 * Google confirms that no other important framework is using "context" class,
4903 * we could use something else like mcontext or moodle_context, but we need to type
4904 * this very often which would be annoying and it would take too much space...
4906 * This class is derived from stdClass for backwards compatibility with
4907 * odl $context record that was returned from DML $DB->get_record()
4909 * @package core_access
4911 * @copyright Petr Skoda {@link http://skodak.org}
4912 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4915 * @property-read int $id context id
4916 * @property-read int $contextlevel CONTEXT_SYSTEM, CONTEXT_COURSE, etc.
4917 * @property-read int $instanceid id of related instance in each context
4918 * @property-read string $path path to context, starts with system context
4919 * @property-read int $depth
4921 abstract class context
extends stdClass
implements IteratorAggregate
{
4923 /** @var string Default sorting of capabilities in {@see get_capabilities} */
4924 protected const DEFAULT_CAPABILITY_SORT
= 'contextlevel, component, name';
4928 * Can be accessed publicly through $context->id
4935 * Can be accessed publicly through $context->contextlevel
4936 * @var int One of CONTEXT_* e.g. CONTEXT_COURSE, CONTEXT_MODULE
4938 protected $_contextlevel;
4941 * Id of the item this context is related to e.g. COURSE_CONTEXT => course.id
4942 * Can be accessed publicly through $context->instanceid
4945 protected $_instanceid;
4948 * The path to the context always starting from the system context
4949 * Can be accessed publicly through $context->path
4955 * The depth of the context in relation to parent contexts
4956 * Can be accessed publicly through $context->depth
4962 * Whether this context is locked or not.
4964 * Can be accessed publicly through $context->locked.
4971 * @var array Context caching info
4973 private static $cache_contextsbyid = array();
4976 * @var array Context caching info
4978 private static $cache_contexts = array();
4982 * Why do we do count contexts? Because count($array) is horribly slow for large arrays
4985 protected static $cache_count = 0;
4988 * @var array Context caching info
4990 protected static $cache_preloaded = array();
4993 * @var context_system The system context once initialised
4995 protected static $systemcontext = null;
4998 * Resets the cache to remove all data.
5001 protected static function reset_caches() {
5002 self
::$cache_contextsbyid = array();
5003 self
::$cache_contexts = array();
5004 self
::$cache_count = 0;
5005 self
::$cache_preloaded = array();
5007 self
::$systemcontext = null;
5011 * Adds a context to the cache. If the cache is full, discards a batch of
5015 * @param context $context New context to add
5018 protected static function cache_add(context
$context) {
5019 if (isset(self
::$cache_contextsbyid[$context->id
])) {
5020 // already cached, no need to do anything - this is relatively cheap, we do all this because count() is slow
5024 if (self
::$cache_count >= CONTEXT_CACHE_MAX_SIZE
) {
5026 foreach (self
::$cache_contextsbyid as $ctx) {
5029 // we want to keep the first contexts to be loaded on this page, hopefully they will be needed again later
5032 if ($i > (CONTEXT_CACHE_MAX_SIZE
/ 3)) {
5033 // we remove oldest third of the contexts to make room for more contexts
5036 unset(self
::$cache_contextsbyid[$ctx->id
]);
5037 unset(self
::$cache_contexts[$ctx->contextlevel
][$ctx->instanceid
]);
5038 self
::$cache_count--;
5042 self
::$cache_contexts[$context->contextlevel
][$context->instanceid
] = $context;
5043 self
::$cache_contextsbyid[$context->id
] = $context;
5044 self
::$cache_count++
;
5048 * Removes a context from the cache.
5051 * @param context $context Context object to remove
5054 protected static function cache_remove(context
$context) {
5055 if (!isset(self
::$cache_contextsbyid[$context->id
])) {
5056 // not cached, no need to do anything - this is relatively cheap, we do all this because count() is slow
5059 unset(self
::$cache_contexts[$context->contextlevel
][$context->instanceid
]);
5060 unset(self
::$cache_contextsbyid[$context->id
]);
5062 self
::$cache_count--;
5064 if (self
::$cache_count < 0) {
5065 self
::$cache_count = 0;
5070 * Gets a context from the cache.
5073 * @param int $contextlevel Context level
5074 * @param int $instance Instance ID
5075 * @return context|bool Context or false if not in cache
5077 protected static function cache_get($contextlevel, $instance) {
5078 if (isset(self
::$cache_contexts[$contextlevel][$instance])) {
5079 return self
::$cache_contexts[$contextlevel][$instance];
5085 * Gets a context from the cache based on its id.
5088 * @param int $id Context ID
5089 * @return context|bool Context or false if not in cache
5091 protected static function cache_get_by_id($id) {
5092 if (isset(self
::$cache_contextsbyid[$id])) {
5093 return self
::$cache_contextsbyid[$id];
5099 * Preloads context information from db record and strips the cached info.
5102 * @param stdClass $rec
5103 * @return void (modifies $rec)
5105 protected static function preload_from_record(stdClass
$rec) {
5106 $notenoughdata = false;
5107 $notenoughdata = $notenoughdata ||
empty($rec->ctxid
);
5108 $notenoughdata = $notenoughdata ||
empty($rec->ctxlevel
);
5109 $notenoughdata = $notenoughdata ||
!isset($rec->ctxinstance
);
5110 $notenoughdata = $notenoughdata ||
empty($rec->ctxpath
);
5111 $notenoughdata = $notenoughdata ||
empty($rec->ctxdepth
);
5112 $notenoughdata = $notenoughdata ||
!isset($rec->ctxlocked
);
5113 if ($notenoughdata) {
5114 // The record does not have enough data, passed here repeatedly or context does not exist yet.
5115 if (isset($rec->ctxid
) && !isset($rec->ctxlocked
)) {
5116 debugging('Locked value missing. Code is possibly not usings the getter properly.', DEBUG_DEVELOPER
);
5121 $record = (object) [
5122 'id' => $rec->ctxid
,
5123 'contextlevel' => $rec->ctxlevel
,
5124 'instanceid' => $rec->ctxinstance
,
5125 'path' => $rec->ctxpath
,
5126 'depth' => $rec->ctxdepth
,
5127 'locked' => $rec->ctxlocked
,
5131 unset($rec->ctxlevel
);
5132 unset($rec->ctxinstance
);
5133 unset($rec->ctxpath
);
5134 unset($rec->ctxdepth
);
5135 unset($rec->ctxlocked
);
5137 return context
::create_instance_from_record($record);
5141 // ====== magic methods =======
5144 * Magic setter method, we do not want anybody to modify properties from the outside
5145 * @param string $name
5146 * @param mixed $value
5148 public function __set($name, $value) {
5149 debugging('Can not change context instance properties!');
5153 * Magic method getter, redirects to read only values.
5154 * @param string $name
5157 public function __get($name) {
5161 case 'contextlevel':
5162 return $this->_contextlevel
;
5164 return $this->_instanceid
;
5166 return $this->_path
;
5168 return $this->_depth
;
5170 return $this->is_locked();
5173 debugging('Invalid context property accessed! '.$name);
5179 * Full support for isset on our magic read only properties.
5180 * @param string $name
5183 public function __isset($name) {
5186 return isset($this->_id
);
5187 case 'contextlevel':
5188 return isset($this->_contextlevel
);
5190 return isset($this->_instanceid
);
5192 return isset($this->_path
);
5194 return isset($this->_depth
);
5196 // Locked is always set.
5204 * All properties are read only, sorry.
5205 * @param string $name
5207 public function __unset($name) {
5208 debugging('Can not unset context instance properties!');
5211 // ====== implementing method from interface IteratorAggregate ======
5214 * Create an iterator because magic vars can't be seen by 'foreach'.
5216 * Now we can convert context object to array using convert_to_array(),
5217 * and feed it properly to json_encode().
5219 public function getIterator() {
5222 'contextlevel' => $this->contextlevel
,
5223 'instanceid' => $this->instanceid
,
5224 'path' => $this->path
,
5225 'depth' => $this->depth
,
5226 'locked' => $this->locked
,
5228 return new ArrayIterator($ret);
5231 // ====== general context methods ======
5234 * Constructor is protected so that devs are forced to
5235 * use context_xxx::instance() or context::instance_by_id().
5237 * @param stdClass $record
5239 protected function __construct(stdClass
$record) {
5240 $this->_id
= (int)$record->id
;
5241 $this->_contextlevel
= (int)$record->contextlevel
;
5242 $this->_instanceid
= $record->instanceid
;
5243 $this->_path
= $record->path
;
5244 $this->_depth
= $record->depth
;
5246 if (isset($record->locked
)) {
5247 $this->_locked
= $record->locked
;
5248 } else if (!during_initial_install() && !moodle_needs_upgrading()) {
5249 debugging('Locked value missing. Code is possibly not usings the getter properly.', DEBUG_DEVELOPER
);
5254 * This function is also used to work around 'protected' keyword problems in context_helper.
5256 * @param stdClass $record
5257 * @return context instance
5259 protected static function create_instance_from_record(stdClass
$record) {
5260 $classname = context_helper
::get_class_for_level($record->contextlevel
);
5262 if ($context = context
::cache_get_by_id($record->id
)) {
5266 $context = new $classname($record);
5267 context
::cache_add($context);
5273 * Copy prepared new contexts from temp table to context table,
5274 * we do this in db specific way for perf reasons only.
5277 protected static function merge_context_temp_table() {
5281 * - mysql does not allow to use FROM in UPDATE statements
5282 * - using two tables after UPDATE works in mysql, but might give unexpected
5283 * results in pg 8 (depends on configuration)
5284 * - using table alias in UPDATE does not work in pg < 8.2
5286 * Different code for each database - mostly for performance reasons
5289 $dbfamily = $DB->get_dbfamily();
5290 if ($dbfamily == 'mysql') {
5291 $updatesql = "UPDATE {context} ct, {context_temp} temp
5292 SET ct.path = temp.path,
5293 ct.depth = temp.depth,
5294 ct.locked = temp.locked
5295 WHERE ct.id = temp.id";
5296 } else if ($dbfamily == 'oracle') {
5297 $updatesql = "UPDATE {context} ct
5298 SET (ct.path, ct.depth, ct.locked) =
5299 (SELECT temp.path, temp.depth, temp.locked
5300 FROM {context_temp} temp
5301 WHERE temp.id=ct.id)
5302 WHERE EXISTS (SELECT 'x'
5303 FROM {context_temp} temp
5304 WHERE temp.id = ct.id)";
5305 } else if ($dbfamily == 'postgres' or $dbfamily == 'mssql') {
5306 $updatesql = "UPDATE {context}
5307 SET path = temp.path,
5309 locked = temp.locked
5310 FROM {context_temp} temp
5311 WHERE temp.id={context}.id";
5313 // sqlite and others
5314 $updatesql = "UPDATE {context}
5315 SET path = (SELECT path FROM {context_temp} WHERE id = {context}.id),
5316 depth = (SELECT depth FROM {context_temp} WHERE id = {context}.id),
5317 locked = (SELECT locked FROM {context_temp} WHERE id = {context}.id)
5318 WHERE id IN (SELECT id FROM {context_temp})";
5321 $DB->execute($updatesql);
5325 * Get a context instance as an object, from a given context id.
5328 * @param int $id context id
5329 * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
5330 * MUST_EXIST means throw exception if no record found
5331 * @return context|bool the context object or false if not found
5333 public static function instance_by_id($id, $strictness = MUST_EXIST
) {
5336 if (get_called_class() !== 'context' and get_called_class() !== 'context_helper') {
5337 // some devs might confuse context->id and instanceid, better prevent these mistakes completely
5338 throw new coding_exception('use only context::instance_by_id() for real context levels use ::instance() methods');
5341 if ($id == SYSCONTEXTID
) {
5342 return context_system
::instance(0, $strictness);
5345 if (is_array($id) or is_object($id) or empty($id)) {
5346 throw new coding_exception('Invalid context id specified context::instance_by_id()');
5349 if ($context = context
::cache_get_by_id($id)) {
5353 if ($record = $DB->get_record('context', array('id'=>$id), '*', $strictness)) {
5354 return context
::create_instance_from_record($record);
5361 * Update context info after moving context in the tree structure.
5363 * @param context $newparent
5366 public function update_moved(context
$newparent) {
5369 $frompath = $this->_path
;
5370 $newpath = $newparent->path
. '/' . $this->_id
;
5372 $trans = $DB->start_delegated_transaction();
5375 if (($newparent->depth +
1) != $this->_depth
) {
5376 $diff = $newparent->depth
- $this->_depth +
1;
5377 $setdepth = ", depth = depth + $diff";
5379 $sql = "UPDATE {context}
5383 $params = array($newpath, $this->_id
);
5384 $DB->execute($sql, $params);
5386 $this->_path
= $newpath;
5387 $this->_depth
= $newparent->depth +
1;
5389 $sql = "UPDATE {context}
5390 SET path = ".$DB->sql_concat("?", $DB->sql_substr("path", strlen($frompath)+
1))."
5393 $params = array($newpath, "{$frompath}/%");
5394 $DB->execute($sql, $params);
5396 $this->mark_dirty();
5398 context
::reset_caches();
5400 $trans->allow_commit();
5404 * Set whether this context has been locked or not.
5406 * @param bool $locked
5409 public function set_locked(bool $locked) {
5412 if ($this->_locked
== $locked) {
5416 $this->_locked
= $locked;
5417 $DB->set_field('context', 'locked', (int) $locked, ['id' => $this->id
]);
5418 $this->mark_dirty();
5421 $eventname = '\\core\\event\\context_locked';
5423 $eventname = '\\core\\event\\context_unlocked';
5425 $event = $eventname::create(['context' => $this, 'objectid' => $this->id
]);
5428 self
::reset_caches();
5434 * Remove all context path info and optionally rebuild it.
5436 * @param bool $rebuild
5439 public function reset_paths($rebuild = true) {
5443 $this->mark_dirty();
5445 $DB->set_field_select('context', 'depth', 0, "path LIKE '%/$this->_id/%'");
5446 $DB->set_field_select('context', 'path', NULL, "path LIKE '%/$this->_id/%'");
5447 if ($this->_contextlevel
!= CONTEXT_SYSTEM
) {
5448 $DB->set_field('context', 'depth', 0, array('id'=>$this->_id
));
5449 $DB->set_field('context', 'path', NULL, array('id'=>$this->_id
));
5451 $this->_path
= null;
5455 context_helper
::build_all_paths(false);
5458 context
::reset_caches();
5462 * Delete all data linked to content, do not delete the context record itself
5464 public function delete_content() {
5467 blocks_delete_all_for_context($this->_id
);
5468 filter_delete_all_for_context($this->_id
);
5470 require_once($CFG->dirroot
. '/comment/lib.php');
5471 comment
::delete_comments(array('contextid'=>$this->_id
));
5473 require_once($CFG->dirroot
.'/rating/lib.php');
5474 $delopt = new stdclass();
5475 $delopt->contextid
= $this->_id
;
5476 $rm = new rating_manager();
5477 $rm->delete_ratings($delopt);
5479 // delete all files attached to this context
5480 $fs = get_file_storage();
5481 $fs->delete_area_files($this->_id
);
5483 // Delete all repository instances attached to this context.
5484 require_once($CFG->dirroot
. '/repository/lib.php');
5485 repository
::delete_all_for_context($this->_id
);
5487 // delete all advanced grading data attached to this context
5488 require_once($CFG->dirroot
.'/grade/grading/lib.php');
5489 grading_manager
::delete_all_for_context($this->_id
);
5491 // now delete stuff from role related tables, role_unassign_all
5492 // and unenrol should be called earlier to do proper cleanup
5493 $DB->delete_records('role_assignments', array('contextid'=>$this->_id
));
5494 $DB->delete_records('role_names', array('contextid'=>$this->_id
));
5495 $this->delete_capabilities();
5499 * Unassign all capabilities from a context.
5501 public function delete_capabilities() {
5504 $ids = $DB->get_fieldset_select('role_capabilities', 'DISTINCT roleid', 'contextid = ?', array($this->_id
));
5506 $DB->delete_records('role_capabilities', array('contextid' => $this->_id
));
5508 // Reset any cache of these roles, including MUC.
5509 accesslib_clear_role_cache($ids);
5514 * Delete the context content and the context record itself
5516 public function delete() {
5519 if ($this->_contextlevel
<= CONTEXT_SYSTEM
) {
5520 throw new coding_exception('Cannot delete system context');
5523 // double check the context still exists
5524 if (!$DB->record_exists('context', array('id'=>$this->_id
))) {
5525 context
::cache_remove($this);
5529 $this->delete_content();
5530 $DB->delete_records('context', array('id'=>$this->_id
));
5531 // purge static context cache if entry present
5532 context
::cache_remove($this);
5534 // Inform search engine to delete data related to this context.
5535 \core_search\manager
::context_deleted($this);
5538 // ====== context level related methods ======
5541 * Utility method for context creation
5544 * @param int $contextlevel
5545 * @param int $instanceid
5546 * @param string $parentpath
5547 * @return stdClass context record
5549 protected static function insert_context_record($contextlevel, $instanceid, $parentpath) {
5552 $record = new stdClass();
5553 $record->contextlevel
= $contextlevel;
5554 $record->instanceid
= $instanceid;
5556 $record->path
= null; //not known before insert
5557 $record->locked
= 0;
5559 $record->id
= $DB->insert_record('context', $record);
5561 // now add path if known - it can be added later
5562 if (!is_null($parentpath)) {
5563 $record->path
= $parentpath.'/'.$record->id
;
5564 $record->depth
= substr_count($record->path
, '/');
5565 $DB->update_record('context', $record);
5572 * Returns human readable context identifier.
5574 * @param boolean $withprefix whether to prefix the name of the context with the
5575 * type of context, e.g. User, Course, Forum, etc.
5576 * @param boolean $short whether to use the short name of the thing. Only applies
5577 * to course contexts
5578 * @param boolean $escape Whether the returned name of the thing is to be
5579 * HTML escaped or not.
5580 * @return string the human readable context name.
5582 public function get_context_name($withprefix = true, $short = false, $escape = true) {
5583 // must be implemented in all context levels
5584 throw new coding_exception('can not get name of abstract context');
5588 * Whether the current context is locked.
5592 public function is_locked() {
5593 if ($this->_locked
) {
5597 if ($parent = $this->get_parent_context()) {
5598 return $parent->is_locked();
5605 * Returns the most relevant URL for this context.
5607 * @return moodle_url
5609 public abstract function get_url();
5612 * Returns array of relevant context capability records.
5614 * @param string $sort SQL order by snippet for sorting returned capabilities sensibly for display
5617 public abstract function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
);
5620 * Recursive function which, given a context, find all its children context ids.
5622 * For course category contexts it will return immediate children and all subcategory contexts.
5623 * It will NOT recurse into courses or subcategories categories.
5624 * If you want to do that, call it on the returned courses/categories.
5626 * When called for a course context, it will return the modules and blocks
5627 * displayed in the course page and blocks displayed on the module pages.
5629 * If called on a user/course/module context it _will_ populate the cache with the appropriate
5632 * @return array Array of child records
5634 public function get_child_contexts() {
5637 if (empty($this->_path
) or empty($this->_depth
)) {
5638 debugging('Can not find child contexts of context '.$this->_id
.' try rebuilding of context paths');
5642 $sql = "SELECT ctx.*
5644 WHERE ctx.path LIKE ?";
5645 $params = array($this->_path
.'/%');
5646 $records = $DB->get_records_sql($sql, $params);
5649 foreach ($records as $record) {
5650 $result[$record->id
] = context
::create_instance_from_record($record);
5657 * Determine if the current context is a parent of the possible child.
5659 * @param context $possiblechild
5660 * @param bool $includeself Whether to check the current context
5663 public function is_parent_of(context
$possiblechild, bool $includeself): bool {
5664 // A simple substring check is used on the context path.
5665 // The possible child's path is used as a haystack, with the current context as the needle.
5666 // The path is prefixed with '+' to ensure that the parent always starts at the top.
5667 // It is suffixed with '+' to ensure that parents are not included.
5668 // The needle always suffixes with a '/' to ensure that the contextid uses a complete match (i.e. 142/ instead of 14).
5669 // The haystack is suffixed with '/+' if $includeself is true to allow the current context to match.
5670 // The haystack is suffixed with '+' if $includeself is false to prevent the current context from matching.
5671 $haystacksuffix = $includeself ?
'/+' : '+';
5674 "+{$possiblechild->path}{$haystacksuffix}",
5677 return $strpos === 0;
5681 * Returns parent contexts of this context in reversed order, i.e. parent first,
5682 * then grand parent, etc.
5684 * @param bool $includeself true means include self too
5685 * @return array of context instances
5687 public function get_parent_contexts($includeself = false) {
5688 if (!$contextids = $this->get_parent_context_ids($includeself)) {
5692 // Preload the contexts to reduce DB calls.
5693 context_helper
::preload_contexts_by_id($contextids);
5696 foreach ($contextids as $contextid) {
5697 $parent = context
::instance_by_id($contextid, MUST_EXIST
);
5698 $result[$parent->id
] = $parent;
5705 * Determine if the current context is a child of the possible parent.
5707 * @param context $possibleparent
5708 * @param bool $includeself Whether to check the current context
5711 public function is_child_of(context
$possibleparent, bool $includeself): bool {
5712 // A simple substring check is used on the context path.
5713 // The current context is used as a haystack, with the possible parent as the needle.
5714 // The path is prefixed with '+' to ensure that the parent always starts at the top.
5715 // It is suffixed with '+' to ensure that children are not included.
5716 // The needle always suffixes with a '/' to ensure that the contextid uses a complete match (i.e. 142/ instead of 14).
5717 // The haystack is suffixed with '/+' if $includeself is true to allow the current context to match.
5718 // The haystack is suffixed with '+' if $includeself is false to prevent the current context from matching.
5719 $haystacksuffix = $includeself ?
'/+' : '+';
5722 "+{$this->path}{$haystacksuffix}",
5723 "+{$possibleparent->path}/"
5725 return $strpos === 0;
5729 * Returns parent context ids of this context in reversed order, i.e. parent first,
5730 * then grand parent, etc.
5732 * @param bool $includeself true means include self too
5733 * @return array of context ids
5735 public function get_parent_context_ids($includeself = false) {
5736 if (empty($this->_path
)) {
5740 $parentcontexts = trim($this->_path
, '/'); // kill leading slash
5741 $parentcontexts = explode('/', $parentcontexts);
5742 if (!$includeself) {
5743 array_pop($parentcontexts); // and remove its own id
5746 return array_reverse($parentcontexts);
5750 * Returns parent context paths of this context.
5752 * @param bool $includeself true means include self too
5753 * @return array of context paths
5755 public function get_parent_context_paths($includeself = false) {
5756 if (empty($this->_path
)) {
5760 $contextids = explode('/', $this->_path
);
5764 foreach ($contextids as $contextid) {
5766 $path .= '/' . $contextid;
5767 $paths[$contextid] = $path;
5771 if (!$includeself) {
5772 unset($paths[$this->_id
]);
5779 * Returns parent context
5783 public function get_parent_context() {
5784 if (empty($this->_path
) or $this->_id
== SYSCONTEXTID
) {
5788 $parentcontexts = trim($this->_path
, '/'); // kill leading slash
5789 $parentcontexts = explode('/', $parentcontexts);
5790 array_pop($parentcontexts); // self
5791 $contextid = array_pop($parentcontexts); // immediate parent
5793 return context
::instance_by_id($contextid, MUST_EXIST
);
5797 * Is this context part of any course? If yes return course context.
5799 * @param bool $strict true means throw exception if not found, false means return false if not found
5800 * @return context_course context of the enclosing course, null if not found or exception
5802 public function get_course_context($strict = true) {
5804 throw new coding_exception('Context does not belong to any course.');
5811 * Returns sql necessary for purging of stale context instances.
5814 * @return string cleanup SQL
5816 protected static function get_cleanup_sql() {
5817 throw new coding_exception('get_cleanup_sql() method must be implemented in all context levels');
5821 * Rebuild context paths and depths at context level.
5824 * @param bool $force
5827 protected static function build_paths($force) {
5828 throw new coding_exception('build_paths() method must be implemented in all context levels');
5832 * Create missing context instances at given level
5837 protected static function create_level_instances() {
5838 throw new coding_exception('create_level_instances() method must be implemented in all context levels');
5842 * Reset all cached permissions and definitions if the necessary.
5845 public function reload_if_dirty() {
5846 global $ACCESSLIB_PRIVATE, $USER;
5848 // Load dirty contexts list if needed
5850 if (!isset($ACCESSLIB_PRIVATE->dirtycontexts
)) {
5851 // we do not load dirty flags in CLI and cron
5852 $ACCESSLIB_PRIVATE->dirtycontexts
= array();
5855 if (!isset($USER->access
['time'])) {
5856 // Nothing has been loaded yet, so we do not need to check dirty flags now.
5860 // From skodak: No idea why -2 is there, server cluster time difference maybe...
5861 $changedsince = $USER->access
['time'] - 2;
5863 if (!isset($ACCESSLIB_PRIVATE->dirtycontexts
)) {
5864 $ACCESSLIB_PRIVATE->dirtycontexts
= get_cache_flags('accesslib/dirtycontexts', $changedsince);
5867 if (!isset($ACCESSLIB_PRIVATE->dirtyusers
[$USER->id
])) {
5868 $ACCESSLIB_PRIVATE->dirtyusers
[$USER->id
] = get_cache_flag('accesslib/dirtyusers', $USER->id
, $changedsince);
5874 if (!empty($ACCESSLIB_PRIVATE->dirtyusers
[$USER->id
])) {
5876 } else if (!empty($ACCESSLIB_PRIVATE->dirtycontexts
)) {
5877 $paths = $this->get_parent_context_paths(true);
5879 foreach ($paths as $path) {
5880 if (isset($ACCESSLIB_PRIVATE->dirtycontexts
[$path])) {
5888 // Reload all capabilities of USER and others - preserving loginas, roleswitches, etc.
5889 // Then cleanup any marks of dirtyness... at least from our short term memory!
5890 reload_all_capabilities();
5895 * Mark a context as dirty (with timestamp) so as to force reloading of the context.
5897 public function mark_dirty() {
5898 global $CFG, $USER, $ACCESSLIB_PRIVATE;
5900 if (during_initial_install()) {
5904 // only if it is a non-empty string
5905 if (is_string($this->_path
) && $this->_path
!== '') {
5906 set_cache_flag('accesslib/dirtycontexts', $this->_path
, 1, time()+
$CFG->sessiontimeout
);
5907 if (isset($ACCESSLIB_PRIVATE->dirtycontexts
)) {
5908 $ACCESSLIB_PRIVATE->dirtycontexts
[$this->_path
] = 1;
5911 $ACCESSLIB_PRIVATE->dirtycontexts
= array($this->_path
=> 1);
5913 if (isset($USER->access
['time'])) {
5914 $ACCESSLIB_PRIVATE->dirtycontexts
= get_cache_flags('accesslib/dirtycontexts', $USER->access
['time']-2);
5916 $ACCESSLIB_PRIVATE->dirtycontexts
= array($this->_path
=> 1);
5918 // flags not loaded yet, it will be done later in $context->reload_if_dirty()
5927 * Context maintenance and helper methods.
5929 * This is "extends context" is a bloody hack that tires to work around the deficiencies
5930 * in the "protected" keyword in PHP, this helps us to hide all the internals of context
5931 * level implementation from the rest of code, the code completion returns what developers need.
5933 * Thank you Tim Hunt for helping me with this nasty trick.
5935 * @package core_access
5937 * @copyright Petr Skoda {@link http://skodak.org}
5938 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5941 class context_helper
extends context
{
5944 * @var array An array mapping context levels to classes
5946 private static $alllevels;
5949 * Instance does not make sense here, only static use
5951 protected function __construct() {
5955 * Reset internal context levels array.
5957 public static function reset_levels() {
5958 self
::$alllevels = null;
5962 * Initialise context levels, call before using self::$alllevels.
5964 private static function init_levels() {
5967 if (isset(self
::$alllevels)) {
5970 self
::$alllevels = array(
5971 CONTEXT_SYSTEM
=> 'context_system',
5972 CONTEXT_USER
=> 'context_user',
5973 CONTEXT_COURSECAT
=> 'context_coursecat',
5974 CONTEXT_COURSE
=> 'context_course',
5975 CONTEXT_MODULE
=> 'context_module',
5976 CONTEXT_BLOCK
=> 'context_block',
5979 if (empty($CFG->custom_context_classes
)) {
5983 $levels = $CFG->custom_context_classes
;
5984 if (!is_array($levels)) {
5985 $levels = @unserialize
($levels);
5987 if (!is_array($levels)) {
5988 debugging('Invalid $CFG->custom_context_classes detected, value ignored.', DEBUG_DEVELOPER
);
5992 // Unsupported custom levels, use with care!!!
5993 foreach ($levels as $level => $classname) {
5994 self
::$alllevels[$level] = $classname;
5996 ksort(self
::$alllevels);
6000 * Returns a class name of the context level class
6003 * @param int $contextlevel (CONTEXT_SYSTEM, etc.)
6004 * @return string class name of the context class
6006 public static function get_class_for_level($contextlevel) {
6007 self
::init_levels();
6008 if (isset(self
::$alllevels[$contextlevel])) {
6009 return self
::$alllevels[$contextlevel];
6011 throw new coding_exception('Invalid context level specified');
6016 * Returns a list of all context levels
6019 * @return array int=>string (level=>level class name)
6021 public static function get_all_levels() {
6022 self
::init_levels();
6023 return self
::$alllevels;
6027 * Remove stale contexts that belonged to deleted instances.
6028 * Ideally all code should cleanup contexts properly, unfortunately accidents happen...
6033 public static function cleanup_instances() {
6035 self
::init_levels();
6038 foreach (self
::$alllevels as $level=>$classname) {
6039 $sqls[] = $classname::get_cleanup_sql();
6042 $sql = implode(" UNION ", $sqls);
6044 // it is probably better to use transactions, it might be faster too
6045 $transaction = $DB->start_delegated_transaction();
6047 $rs = $DB->get_recordset_sql($sql);
6048 foreach ($rs as $record) {
6049 $context = context
::create_instance_from_record($record);
6054 $transaction->allow_commit();
6058 * Create all context instances at the given level and above.
6061 * @param int $contextlevel null means all levels
6062 * @param bool $buildpaths
6065 public static function create_instances($contextlevel = null, $buildpaths = true) {
6066 self
::init_levels();
6067 foreach (self
::$alllevels as $level=>$classname) {
6068 if ($contextlevel and $level > $contextlevel) {
6069 // skip potential sub-contexts
6072 $classname::create_level_instances();
6074 $classname::build_paths(false);
6080 * Rebuild paths and depths in all context levels.
6083 * @param bool $force false means add missing only
6086 public static function build_all_paths($force = false) {
6087 self
::init_levels();
6088 foreach (self
::$alllevels as $classname) {
6089 $classname::build_paths($force);
6092 // reset static course cache - it might have incorrect cached data
6093 accesslib_clear_all_caches(true);
6097 * Resets the cache to remove all data.
6100 public static function reset_caches() {
6101 context
::reset_caches();
6105 * Returns all fields necessary for context preloading from user $rec.
6107 * This helps with performance when dealing with hundreds of contexts.
6110 * @param string $tablealias context table alias in the query
6111 * @return array (table.column=>alias, ...)
6113 public static function get_preload_record_columns($tablealias) {
6115 "$tablealias.id" => "ctxid",
6116 "$tablealias.path" => "ctxpath",
6117 "$tablealias.depth" => "ctxdepth",
6118 "$tablealias.contextlevel" => "ctxlevel",
6119 "$tablealias.instanceid" => "ctxinstance",
6120 "$tablealias.locked" => "ctxlocked",
6125 * Returns all fields necessary for context preloading from user $rec.
6127 * This helps with performance when dealing with hundreds of contexts.
6130 * @param string $tablealias context table alias in the query
6133 public static function get_preload_record_columns_sql($tablealias) {
6134 return "$tablealias.id AS ctxid, " .
6135 "$tablealias.path AS ctxpath, " .
6136 "$tablealias.depth AS ctxdepth, " .
6137 "$tablealias.contextlevel AS ctxlevel, " .
6138 "$tablealias.instanceid AS ctxinstance, " .
6139 "$tablealias.locked AS ctxlocked";
6143 * Preloads context information from db record and strips the cached info.
6145 * The db request has to contain all columns from context_helper::get_preload_record_columns().
6148 * @param stdClass $rec
6149 * @return void (modifies $rec)
6151 public static function preload_from_record(stdClass
$rec) {
6152 context
::preload_from_record($rec);
6156 * Preload a set of contexts using their contextid.
6158 * @param array $contextids
6160 public static function preload_contexts_by_id(array $contextids) {
6163 // Determine which contexts are not already cached.
6165 foreach ($contextids as $contextid) {
6166 if (!self
::cache_get_by_id($contextid)) {
6167 $tofetch[] = $contextid;
6171 if (count($tofetch) > 1) {
6172 // There are at least two to fetch.
6173 // There is no point only fetching a single context as this would be no more efficient than calling the existing code.
6174 list($insql, $inparams) = $DB->get_in_or_equal($tofetch, SQL_PARAMS_NAMED
);
6175 $ctxs = $DB->get_records_select('context', "id {$insql}", $inparams, '',
6176 \context_helper
::get_preload_record_columns_sql('{context}'));
6177 foreach ($ctxs as $ctx) {
6178 self
::preload_from_record($ctx);
6184 * Preload all contexts instances from course.
6186 * To be used if you expect multiple queries for course activities...
6189 * @param int $courseid
6191 public static function preload_course($courseid) {
6192 // Users can call this multiple times without doing any harm
6193 if (isset(context
::$cache_preloaded[$courseid])) {
6196 $coursecontext = context_course
::instance($courseid);
6197 $coursecontext->get_child_contexts();
6199 context
::$cache_preloaded[$courseid] = true;
6203 * Delete context instance
6206 * @param int $contextlevel
6207 * @param int $instanceid
6210 public static function delete_instance($contextlevel, $instanceid) {
6213 // double check the context still exists
6214 if ($record = $DB->get_record('context', array('contextlevel'=>$contextlevel, 'instanceid'=>$instanceid))) {
6215 $context = context
::create_instance_from_record($record);
6218 // we should try to purge the cache anyway
6223 * Returns the name of specified context level
6226 * @param int $contextlevel
6227 * @return string name of the context level
6229 public static function get_level_name($contextlevel) {
6230 $classname = context_helper
::get_class_for_level($contextlevel);
6231 return $classname::get_level_name();
6235 * Gets the current context to be used for navigation tree filtering.
6237 * @param context|null $context The current context to be checked against.
6238 * @return context|null the context that navigation tree filtering should use.
6240 public static function get_navigation_filter_context(?context
$context): ?context
{
6242 if (!empty($CFG->filternavigationwithsystemcontext
)) {
6243 return context_system
::instance();
6252 public function get_url() {
6258 * @param string $sort
6260 public function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
) {
6266 * System context class
6268 * @package core_access
6270 * @copyright Petr Skoda {@link http://skodak.org}
6271 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6274 class context_system
extends context
{
6276 * Please use context_system::instance() if you need the instance of context.
6278 * @param stdClass $record
6280 protected function __construct(stdClass
$record) {
6281 parent
::__construct($record);
6282 if ($record->contextlevel
!= CONTEXT_SYSTEM
) {
6283 throw new coding_exception('Invalid $record->contextlevel in context_system constructor.');
6288 * Returns human readable context level name.
6291 * @return string the human readable context level name.
6293 public static function get_level_name() {
6294 return get_string('coresystem');
6298 * Returns human readable context identifier.
6300 * @param boolean $withprefix does not apply to system context
6301 * @param boolean $short does not apply to system context
6302 * @param boolean $escape does not apply to system context
6303 * @return string the human readable context name.
6305 public function get_context_name($withprefix = true, $short = false, $escape = true) {
6306 return self
::get_level_name();
6310 * Returns the most relevant URL for this context.
6312 * @return moodle_url
6314 public function get_url() {
6315 return new moodle_url('/');
6319 * Returns array of relevant context capability records.
6321 * @param string $sort
6324 public function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
) {
6327 return $DB->get_records('capabilities', [], $sort);
6331 * Create missing context instances at system context
6334 protected static function create_level_instances() {
6335 // nothing to do here, the system context is created automatically in installer
6340 * Returns system context instance.
6343 * @param int $instanceid should be 0
6344 * @param int $strictness
6345 * @param bool $cache
6346 * @return context_system context instance
6348 public static function instance($instanceid = 0, $strictness = MUST_EXIST
, $cache = true) {
6351 if ($instanceid != 0) {
6352 debugging('context_system::instance(): invalid $id parameter detected, should be 0');
6355 // SYSCONTEXTID is cached in local cache to eliminate 1 query per page.
6356 if (defined('SYSCONTEXTID') and $cache) {
6357 if (!isset(context
::$systemcontext)) {
6358 $record = new stdClass();
6359 $record->id
= SYSCONTEXTID
;
6360 $record->contextlevel
= CONTEXT_SYSTEM
;
6361 $record->instanceid
= 0;
6362 $record->path
= '/'.SYSCONTEXTID
;
6364 $record->locked
= 0;
6365 context
::$systemcontext = new context_system($record);
6367 return context
::$systemcontext;
6371 // We ignore the strictness completely because system context must exist except during install.
6372 $record = $DB->get_record('context', array('contextlevel'=>CONTEXT_SYSTEM
), '*', MUST_EXIST
);
6373 } catch (dml_exception
$e) {
6374 //table or record does not exist
6375 if (!during_initial_install()) {
6376 // do not mess with system context after install, it simply must exist
6383 $record = new stdClass();
6384 $record->contextlevel
= CONTEXT_SYSTEM
;
6385 $record->instanceid
= 0;
6387 $record->path
= null; // Not known before insert.
6388 $record->locked
= 0;
6391 if ($DB->count_records('context')) {
6392 // contexts already exist, this is very weird, system must be first!!!
6395 if (defined('SYSCONTEXTID')) {
6396 // this would happen only in unittest on sites that went through weird 1.7 upgrade
6397 $record->id
= SYSCONTEXTID
;
6398 $DB->import_record('context', $record);
6399 $DB->get_manager()->reset_sequence('context');
6401 $record->id
= $DB->insert_record('context', $record);
6403 } catch (dml_exception
$e) {
6404 // can not create context - table does not exist yet, sorry
6409 if ($record->instanceid
!= 0) {
6410 // this is very weird, somebody must be messing with context table
6411 debugging('Invalid system context detected');
6414 if ($record->depth
!= 1 or $record->path
!= '/'.$record->id
) {
6415 // fix path if necessary, initial install or path reset
6417 $record->path
= '/'.$record->id
;
6418 $DB->update_record('context', $record);
6421 if (empty($record->locked
)) {
6422 $record->locked
= 0;
6425 if (!defined('SYSCONTEXTID')) {
6426 define('SYSCONTEXTID', $record->id
);
6429 context
::$systemcontext = new context_system($record);
6430 return context
::$systemcontext;
6434 * Returns all site contexts except the system context, DO NOT call on production servers!!
6436 * Contexts are not cached.
6440 public function get_child_contexts() {
6443 debugging('Fetching of system context child courses is strongly discouraged on production servers (it may eat all available memory)!');
6445 // Just get all the contexts except for CONTEXT_SYSTEM level
6446 // and hope we don't OOM in the process - don't cache
6449 WHERE contextlevel > ".CONTEXT_SYSTEM
;
6450 $records = $DB->get_records_sql($sql);
6453 foreach ($records as $record) {
6454 $result[$record->id
] = context
::create_instance_from_record($record);
6461 * Returns sql necessary for purging of stale context instances.
6464 * @return string cleanup SQL
6466 protected static function get_cleanup_sql() {
6477 * Rebuild context paths and depths at system context level.
6480 * @param bool $force
6482 protected static function build_paths($force) {
6485 /* note: ignore $force here, we always do full test of system context */
6487 // exactly one record must exist
6488 $record = $DB->get_record('context', array('contextlevel'=>CONTEXT_SYSTEM
), '*', MUST_EXIST
);
6490 if ($record->instanceid
!= 0) {
6491 debugging('Invalid system context detected');
6494 if (defined('SYSCONTEXTID') and $record->id
!= SYSCONTEXTID
) {
6495 debugging('Invalid SYSCONTEXTID detected');
6498 if ($record->depth
!= 1 or $record->path
!= '/'.$record->id
) {
6499 // fix path if necessary, initial install or path reset
6501 $record->path
= '/'.$record->id
;
6502 $DB->update_record('context', $record);
6507 * Set whether this context has been locked or not.
6509 * @param bool $locked
6512 public function set_locked(bool $locked) {
6513 throw new \
coding_exception('It is not possible to lock the system context');
6521 * User context class
6523 * @package core_access
6525 * @copyright Petr Skoda {@link http://skodak.org}
6526 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6529 class context_user
extends context
{
6531 * Please use context_user::instance($userid) if you need the instance of context.
6532 * Alternatively if you know only the context id use context::instance_by_id($contextid)
6534 * @param stdClass $record
6536 protected function __construct(stdClass
$record) {
6537 parent
::__construct($record);
6538 if ($record->contextlevel
!= CONTEXT_USER
) {
6539 throw new coding_exception('Invalid $record->contextlevel in context_user constructor.');
6544 * Returns human readable context level name.
6547 * @return string the human readable context level name.
6549 public static function get_level_name() {
6550 return get_string('user');
6554 * Returns human readable context identifier.
6556 * @param boolean $withprefix whether to prefix the name of the context with User
6557 * @param boolean $short does not apply to user context
6558 * @param boolean $escape does not apply to user context
6559 * @return string the human readable context name.
6561 public function get_context_name($withprefix = true, $short = false, $escape = true) {
6565 if ($user = $DB->get_record('user', array('id'=>$this->_instanceid
, 'deleted'=>0))) {
6567 $name = get_string('user').': ';
6569 $name .= fullname($user);
6575 * Returns the most relevant URL for this context.
6577 * @return moodle_url
6579 public function get_url() {
6582 if ($COURSE->id
== SITEID
) {
6583 $url = new moodle_url('/user/profile.php', array('id'=>$this->_instanceid
));
6585 $url = new moodle_url('/user/view.php', array('id'=>$this->_instanceid
, 'courseid'=>$COURSE->id
));
6591 * Returns array of relevant context capability records.
6593 * @param string $sort
6596 public function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
) {
6599 $extracaps = array('moodle/grade:viewall');
6600 list($extra, $params) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED
, 'cap');
6602 return $DB->get_records_select('capabilities', "contextlevel = :level OR name {$extra}",
6603 $params +
['level' => CONTEXT_USER
], $sort);
6607 * Returns user context instance.
6610 * @param int $userid id from {user} table
6611 * @param int $strictness
6612 * @return context_user context instance
6614 public static function instance($userid, $strictness = MUST_EXIST
) {
6617 if ($context = context
::cache_get(CONTEXT_USER
, $userid)) {
6621 if (!$record = $DB->get_record('context', array('contextlevel' => CONTEXT_USER
, 'instanceid' => $userid))) {
6622 if ($user = $DB->get_record('user', array('id' => $userid, 'deleted' => 0), 'id', $strictness)) {
6623 $record = context
::insert_context_record(CONTEXT_USER
, $user->id
, '/'.SYSCONTEXTID
, 0);
6628 $context = new context_user($record);
6629 context
::cache_add($context);
6637 * Create missing context instances at user context level
6640 protected static function create_level_instances() {
6643 $sql = "SELECT ".CONTEXT_USER
.", u.id
6646 AND NOT EXISTS (SELECT 'x'
6648 WHERE u.id = cx.instanceid AND cx.contextlevel=".CONTEXT_USER
.")";
6649 $contextdata = $DB->get_recordset_sql($sql);
6650 foreach ($contextdata as $context) {
6651 context
::insert_context_record(CONTEXT_USER
, $context->id
, null);
6653 $contextdata->close();
6657 * Returns sql necessary for purging of stale context instances.
6660 * @return string cleanup SQL
6662 protected static function get_cleanup_sql() {
6666 LEFT OUTER JOIN {user} u ON (c.instanceid = u.id AND u.deleted = 0)
6667 WHERE u.id IS NULL AND c.contextlevel = ".CONTEXT_USER
."
6674 * Rebuild context paths and depths at user context level.
6677 * @param bool $force
6679 protected static function build_paths($force) {
6682 // First update normal users.
6683 $path = $DB->sql_concat('?', 'id');
6684 $pathstart = '/' . SYSCONTEXTID
. '/';
6685 $params = array($pathstart);
6688 $where = "depth <> 2 OR path IS NULL OR path <> ({$path})";
6689 $params[] = $pathstart;
6691 $where = "depth = 0 OR path IS NULL";
6694 $sql = "UPDATE {context}
6697 WHERE contextlevel = " . CONTEXT_USER
. "
6699 $DB->execute($sql, $params);
6705 * Course category context class
6707 * @package core_access
6709 * @copyright Petr Skoda {@link http://skodak.org}
6710 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6713 class context_coursecat
extends context
{
6715 * Please use context_coursecat::instance($coursecatid) if you need the instance of context.
6716 * Alternatively if you know only the context id use context::instance_by_id($contextid)
6718 * @param stdClass $record
6720 protected function __construct(stdClass
$record) {
6721 parent
::__construct($record);
6722 if ($record->contextlevel
!= CONTEXT_COURSECAT
) {
6723 throw new coding_exception('Invalid $record->contextlevel in context_coursecat constructor.');
6728 * Returns human readable context level name.
6731 * @return string the human readable context level name.
6733 public static function get_level_name() {
6734 return get_string('category');
6738 * Returns human readable context identifier.
6740 * @param boolean $withprefix whether to prefix the name of the context with Category
6741 * @param boolean $short does not apply to course categories
6742 * @param boolean $escape Whether the returned name of the context is to be HTML escaped or not.
6743 * @return string the human readable context name.
6745 public function get_context_name($withprefix = true, $short = false, $escape = true) {
6749 if ($category = $DB->get_record('course_categories', array('id'=>$this->_instanceid
))) {
6751 $name = get_string('category').': ';
6754 $name .= format_string($category->name
, true, array('context' => $this, 'escape' => false));
6756 $name .= format_string($category->name
, true, array('context' => $this));
6763 * Returns the most relevant URL for this context.
6765 * @return moodle_url
6767 public function get_url() {
6768 return new moodle_url('/course/index.php', array('categoryid' => $this->_instanceid
));
6772 * Returns array of relevant context capability records.
6774 * @param string $sort
6777 public function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
) {
6780 return $DB->get_records_list('capabilities', 'contextlevel', [
6789 * Returns course category context instance.
6792 * @param int $categoryid id from {course_categories} table
6793 * @param int $strictness
6794 * @return context_coursecat context instance
6796 public static function instance($categoryid, $strictness = MUST_EXIST
) {
6799 if ($context = context
::cache_get(CONTEXT_COURSECAT
, $categoryid)) {
6803 if (!$record = $DB->get_record('context', array('contextlevel' => CONTEXT_COURSECAT
, 'instanceid' => $categoryid))) {
6804 if ($category = $DB->get_record('course_categories', array('id' => $categoryid), 'id,parent', $strictness)) {
6805 if ($category->parent
) {
6806 $parentcontext = context_coursecat
::instance($category->parent
);
6807 $record = context
::insert_context_record(CONTEXT_COURSECAT
, $category->id
, $parentcontext->path
);
6809 $record = context
::insert_context_record(CONTEXT_COURSECAT
, $category->id
, '/'.SYSCONTEXTID
, 0);
6815 $context = new context_coursecat($record);
6816 context
::cache_add($context);
6824 * Returns immediate child contexts of category and all subcategories,
6825 * children of subcategories and courses are not returned.
6829 public function get_child_contexts() {
6832 if (empty($this->_path
) or empty($this->_depth
)) {
6833 debugging('Can not find child contexts of context '.$this->_id
.' try rebuilding of context paths');
6837 $sql = "SELECT ctx.*
6839 WHERE ctx.path LIKE ? AND (ctx.depth = ? OR ctx.contextlevel = ?)";
6840 $params = array($this->_path
.'/%', $this->depth+
1, CONTEXT_COURSECAT
);
6841 $records = $DB->get_records_sql($sql, $params);
6844 foreach ($records as $record) {
6845 $result[$record->id
] = context
::create_instance_from_record($record);
6852 * Create missing context instances at course category context level
6855 protected static function create_level_instances() {
6858 $sql = "SELECT ".CONTEXT_COURSECAT
.", cc.id
6859 FROM {course_categories} cc
6860 WHERE NOT EXISTS (SELECT 'x'
6862 WHERE cc.id = cx.instanceid AND cx.contextlevel=".CONTEXT_COURSECAT
.")";
6863 $contextdata = $DB->get_recordset_sql($sql);
6864 foreach ($contextdata as $context) {
6865 context
::insert_context_record(CONTEXT_COURSECAT
, $context->id
, null);
6867 $contextdata->close();
6871 * Returns sql necessary for purging of stale context instances.
6874 * @return string cleanup SQL
6876 protected static function get_cleanup_sql() {
6880 LEFT OUTER JOIN {course_categories} cc ON c.instanceid = cc.id
6881 WHERE cc.id IS NULL AND c.contextlevel = ".CONTEXT_COURSECAT
."
6888 * Rebuild context paths and depths at course category context level.
6891 * @param bool $force
6893 protected static function build_paths($force) {
6896 if ($force or $DB->record_exists_select('context', "contextlevel = ".CONTEXT_COURSECAT
." AND (depth = 0 OR path IS NULL)")) {
6898 $ctxemptyclause = $emptyclause = '';
6900 $ctxemptyclause = "AND (ctx.path IS NULL OR ctx.depth = 0)";
6901 $emptyclause = "AND ({context}.path IS NULL OR {context}.depth = 0)";
6904 $base = '/'.SYSCONTEXTID
;
6906 // Normal top level categories
6907 $sql = "UPDATE {context}
6909 path=".$DB->sql_concat("'$base/'", 'id')."
6910 WHERE contextlevel=".CONTEXT_COURSECAT
."
6911 AND EXISTS (SELECT 'x'
6912 FROM {course_categories} cc
6913 WHERE cc.id = {context}.instanceid AND cc.depth=1)
6917 // Deeper categories - one query per depthlevel
6918 $maxdepth = $DB->get_field_sql("SELECT MAX(depth) FROM {course_categories}");
6919 for ($n=2; $n<=$maxdepth; $n++
) {
6920 $sql = "INSERT INTO {context_temp} (id, path, depth, locked)
6921 SELECT ctx.id, ".$DB->sql_concat('pctx.path', "'/'", 'ctx.id').", pctx.depth+1, ctx.locked
6923 JOIN {course_categories} cc ON (cc.id = ctx.instanceid AND ctx.contextlevel = ".CONTEXT_COURSECAT
." AND cc.depth = $n)
6924 JOIN {context} pctx ON (pctx.instanceid = cc.parent AND pctx.contextlevel = ".CONTEXT_COURSECAT
.")
6925 WHERE pctx.path IS NOT NULL AND pctx.depth > 0
6927 $trans = $DB->start_delegated_transaction();
6928 $DB->delete_records('context_temp');
6930 context
::merge_context_temp_table();
6931 $DB->delete_records('context_temp');
6932 $trans->allow_commit();
6941 * Course context class
6943 * @package core_access
6945 * @copyright Petr Skoda {@link http://skodak.org}
6946 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
6949 class context_course
extends context
{
6951 * Please use context_course::instance($courseid) if you need the instance of context.
6952 * Alternatively if you know only the context id use context::instance_by_id($contextid)
6954 * @param stdClass $record
6956 protected function __construct(stdClass
$record) {
6957 parent
::__construct($record);
6958 if ($record->contextlevel
!= CONTEXT_COURSE
) {
6959 throw new coding_exception('Invalid $record->contextlevel in context_course constructor.');
6964 * Returns human readable context level name.
6967 * @return string the human readable context level name.
6969 public static function get_level_name() {
6970 return get_string('course');
6974 * Returns human readable context identifier.
6976 * @param boolean $withprefix whether to prefix the name of the context with Course
6977 * @param boolean $short whether to use the short name of the thing.
6978 * @param bool $escape Whether the returned category name is to be HTML escaped or not.
6979 * @return string the human readable context name.
6981 public function get_context_name($withprefix = true, $short = false, $escape = true) {
6985 if ($this->_instanceid
== SITEID
) {
6986 $name = get_string('frontpage', 'admin');
6988 if ($course = $DB->get_record('course', array('id'=>$this->_instanceid
))) {
6990 $name = get_string('course').': ';
6994 $name .= format_string($course->shortname
, true, array('context' => $this, 'escape' => false));
6996 $name .= format_string($course->shortname
, true, array('context' => $this));
7000 $name .= format_string(get_course_display_name_for_list($course), true, array('context' => $this,
7001 'escape' => false));
7003 $name .= format_string(get_course_display_name_for_list($course), true, array('context' => $this));
7012 * Returns the most relevant URL for this context.
7014 * @return moodle_url
7016 public function get_url() {
7017 if ($this->_instanceid
!= SITEID
) {
7018 return new moodle_url('/course/view.php', array('id'=>$this->_instanceid
));
7021 return new moodle_url('/');
7025 * Returns array of relevant context capability records.
7027 * @param string $sort
7030 public function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
) {
7033 return $DB->get_records_list('capabilities', 'contextlevel', [
7041 * Is this context part of any course? If yes return course context.
7043 * @param bool $strict true means throw exception if not found, false means return false if not found
7044 * @return context_course context of the enclosing course, null if not found or exception
7046 public function get_course_context($strict = true) {
7051 * Returns course context instance.
7054 * @param int $courseid id from {course} table
7055 * @param int $strictness
7056 * @return context_course context instance
7058 public static function instance($courseid, $strictness = MUST_EXIST
) {
7061 if ($context = context
::cache_get(CONTEXT_COURSE
, $courseid)) {
7065 if (!$record = $DB->get_record('context', array('contextlevel' => CONTEXT_COURSE
, 'instanceid' => $courseid))) {
7066 if ($course = $DB->get_record('course', array('id' => $courseid), 'id,category', $strictness)) {
7067 if ($course->category
) {
7068 $parentcontext = context_coursecat
::instance($course->category
);
7069 $record = context
::insert_context_record(CONTEXT_COURSE
, $course->id
, $parentcontext->path
);
7071 $record = context
::insert_context_record(CONTEXT_COURSE
, $course->id
, '/'.SYSCONTEXTID
, 0);
7077 $context = new context_course($record);
7078 context
::cache_add($context);
7086 * Create missing context instances at course context level
7089 protected static function create_level_instances() {
7092 $sql = "SELECT ".CONTEXT_COURSE
.", c.id
7094 WHERE NOT EXISTS (SELECT 'x'
7096 WHERE c.id = cx.instanceid AND cx.contextlevel=".CONTEXT_COURSE
.")";
7097 $contextdata = $DB->get_recordset_sql($sql);
7098 foreach ($contextdata as $context) {
7099 context
::insert_context_record(CONTEXT_COURSE
, $context->id
, null);
7101 $contextdata->close();
7105 * Returns sql necessary for purging of stale context instances.
7108 * @return string cleanup SQL
7110 protected static function get_cleanup_sql() {
7114 LEFT OUTER JOIN {course} co ON c.instanceid = co.id
7115 WHERE co.id IS NULL AND c.contextlevel = ".CONTEXT_COURSE
."
7122 * Rebuild context paths and depths at course context level.
7125 * @param bool $force
7127 protected static function build_paths($force) {
7130 if ($force or $DB->record_exists_select('context', "contextlevel = ".CONTEXT_COURSE
." AND (depth = 0 OR path IS NULL)")) {
7132 $ctxemptyclause = $emptyclause = '';
7134 $ctxemptyclause = "AND (ctx.path IS NULL OR ctx.depth = 0)";
7135 $emptyclause = "AND ({context}.path IS NULL OR {context}.depth = 0)";
7138 $base = '/'.SYSCONTEXTID
;
7140 // Standard frontpage
7141 $sql = "UPDATE {context}
7143 path = ".$DB->sql_concat("'$base/'", 'id')."
7144 WHERE contextlevel = ".CONTEXT_COURSE
."
7145 AND EXISTS (SELECT 'x'
7147 WHERE c.id = {context}.instanceid AND c.category = 0)
7152 $sql = "INSERT INTO {context_temp} (id, path, depth, locked)
7153 SELECT ctx.id, ".$DB->sql_concat('pctx.path', "'/'", 'ctx.id').", pctx.depth+1, ctx.locked
7155 JOIN {course} c ON (c.id = ctx.instanceid AND ctx.contextlevel = ".CONTEXT_COURSE
." AND c.category <> 0)
7156 JOIN {context} pctx ON (pctx.instanceid = c.category AND pctx.contextlevel = ".CONTEXT_COURSECAT
.")
7157 WHERE pctx.path IS NOT NULL AND pctx.depth > 0
7159 $trans = $DB->start_delegated_transaction();
7160 $DB->delete_records('context_temp');
7162 context
::merge_context_temp_table();
7163 $DB->delete_records('context_temp');
7164 $trans->allow_commit();
7171 * Course module context class
7173 * @package core_access
7175 * @copyright Petr Skoda {@link http://skodak.org}
7176 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7179 class context_module
extends context
{
7181 * Please use context_module::instance($cmid) if you need the instance of context.
7182 * Alternatively if you know only the context id use context::instance_by_id($contextid)
7184 * @param stdClass $record
7186 protected function __construct(stdClass
$record) {
7187 parent
::__construct($record);
7188 if ($record->contextlevel
!= CONTEXT_MODULE
) {
7189 throw new coding_exception('Invalid $record->contextlevel in context_module constructor.');
7194 * Returns human readable context level name.
7197 * @return string the human readable context level name.
7199 public static function get_level_name() {
7200 return get_string('activitymodule');
7204 * Returns human readable context identifier.
7206 * @param boolean $withprefix whether to prefix the name of the context with the
7207 * module name, e.g. Forum, Glossary, etc.
7208 * @param boolean $short does not apply to module context
7209 * @param boolean $escape Whether the returned name of the context is to be HTML escaped or not.
7210 * @return string the human readable context name.
7212 public function get_context_name($withprefix = true, $short = false, $escape = true) {
7216 if ($cm = $DB->get_record_sql("SELECT cm.*, md.name AS modname
7217 FROM {course_modules} cm
7218 JOIN {modules} md ON md.id = cm.module
7219 WHERE cm.id = ?", array($this->_instanceid
))) {
7220 if ($mod = $DB->get_record($cm->modname
, array('id' => $cm->instance
))) {
7222 $name = get_string('modulename', $cm->modname
).': ';
7225 $name .= format_string($mod->name
, true, array('context' => $this, 'escape' => false));
7227 $name .= format_string($mod->name
, true, array('context' => $this));
7235 * Returns the most relevant URL for this context.
7237 * @return moodle_url
7239 public function get_url() {
7242 if ($modname = $DB->get_field_sql("SELECT md.name AS modname
7243 FROM {course_modules} cm
7244 JOIN {modules} md ON md.id = cm.module
7245 WHERE cm.id = ?", array($this->_instanceid
))) {
7246 return new moodle_url('/mod/' . $modname . '/view.php', array('id'=>$this->_instanceid
));
7249 return new moodle_url('/');
7253 * Returns array of relevant context capability records.
7255 * @param string $sort
7258 public function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
) {
7261 $cm = $DB->get_record('course_modules', array('id'=>$this->_instanceid
));
7262 $module = $DB->get_record('modules', array('id'=>$cm->module
));
7266 $modulepath = "{$CFG->dirroot}/mod/{$module->name}";
7267 if (file_exists("{$modulepath}/db/subplugins.json")) {
7268 $subplugins = (array) json_decode(file_get_contents("{$modulepath}/db/subplugins.json"))->plugintypes
;
7269 } else if (file_exists("{$modulepath}/db/subplugins.php")) {
7270 debugging('Use of subplugins.php has been deprecated. ' .
7271 'Please update your plugin to provide a subplugins.json file instead.',
7273 $subplugins = array(); // should be redefined in the file
7274 include("{$modulepath}/db/subplugins.php");
7277 if (!empty($subplugins)) {
7278 foreach (array_keys($subplugins) as $subplugintype) {
7279 foreach (array_keys(core_component
::get_plugin_list($subplugintype)) as $subpluginname) {
7280 $subcaps = array_merge($subcaps, array_keys(load_capability_def($subplugintype.'_'.$subpluginname)));
7285 $modfile = "{$modulepath}/lib.php";
7286 $extracaps = array();
7287 if (file_exists($modfile)) {
7288 include_once($modfile);
7289 $modfunction = $module->name
.'_get_extra_capabilities';
7290 if (function_exists($modfunction)) {
7291 $extracaps = $modfunction();
7295 $extracaps = array_merge($subcaps, $extracaps);
7297 list($extra, $params) = $DB->get_in_or_equal(
7298 $extracaps, SQL_PARAMS_NAMED
, 'cap0', true, '');
7299 if (!empty($extra)) {
7300 $extra = "OR name $extra";
7303 // Fetch the list of modules, and remove this one.
7304 $components = \core_component
::get_component_list();
7305 $componentnames = $components['mod'];
7306 unset($componentnames["mod_{$module->name}"]);
7307 $componentnames = array_keys($componentnames);
7309 // Exclude all other modules.
7310 list($notcompsql, $notcompparams) = $DB->get_in_or_equal($componentnames, SQL_PARAMS_NAMED
, 'notcomp', false);
7311 $params = array_merge($params, $notcompparams);
7314 // Exclude other component submodules.
7316 $ignorecomponents = [];
7317 foreach ($componentnames as $mod) {
7318 if ($subplugins = \core_component
::get_subplugins($mod)) {
7319 foreach (array_keys($subplugins) as $subplugintype) {
7320 $paramname = "notlike{$i}";
7321 $ignorecomponents[] = $DB->sql_like('component', ":{$paramname}", true, true, true);
7322 $params[$paramname] = "{$subplugintype}_%";
7327 $notlikesql = "(" . implode(' AND ', $ignorecomponents) . ")";
7331 WHERE (contextlevel = ".CONTEXT_MODULE
."
7332 AND component {$notcompsql}
7337 return $DB->get_records_sql($sql, $params);
7341 * Is this context part of any course? If yes return course context.
7343 * @param bool $strict true means throw exception if not found, false means return false if not found
7344 * @return context_course context of the enclosing course, null if not found or exception
7346 public function get_course_context($strict = true) {
7347 return $this->get_parent_context();
7351 * Returns module context instance.
7354 * @param int $cmid id of the record from {course_modules} table; pass cmid there, NOT id in the instance column
7355 * @param int $strictness
7356 * @return context_module context instance
7358 public static function instance($cmid, $strictness = MUST_EXIST
) {
7361 if ($context = context
::cache_get(CONTEXT_MODULE
, $cmid)) {
7365 if (!$record = $DB->get_record('context', array('contextlevel' => CONTEXT_MODULE
, 'instanceid' => $cmid))) {
7366 if ($cm = $DB->get_record('course_modules', array('id' => $cmid), 'id,course', $strictness)) {
7367 $parentcontext = context_course
::instance($cm->course
);
7368 $record = context
::insert_context_record(CONTEXT_MODULE
, $cm->id
, $parentcontext->path
);
7373 $context = new context_module($record);
7374 context
::cache_add($context);
7382 * Create missing context instances at module context level
7385 protected static function create_level_instances() {
7388 $sql = "SELECT ".CONTEXT_MODULE
.", cm.id
7389 FROM {course_modules} cm
7390 WHERE NOT EXISTS (SELECT 'x'
7392 WHERE cm.id = cx.instanceid AND cx.contextlevel=".CONTEXT_MODULE
.")";
7393 $contextdata = $DB->get_recordset_sql($sql);
7394 foreach ($contextdata as $context) {
7395 context
::insert_context_record(CONTEXT_MODULE
, $context->id
, null);
7397 $contextdata->close();
7401 * Returns sql necessary for purging of stale context instances.
7404 * @return string cleanup SQL
7406 protected static function get_cleanup_sql() {
7410 LEFT OUTER JOIN {course_modules} cm ON c.instanceid = cm.id
7411 WHERE cm.id IS NULL AND c.contextlevel = ".CONTEXT_MODULE
."
7418 * Rebuild context paths and depths at module context level.
7421 * @param bool $force
7423 protected static function build_paths($force) {
7426 if ($force or $DB->record_exists_select('context', "contextlevel = ".CONTEXT_MODULE
." AND (depth = 0 OR path IS NULL)")) {
7428 $ctxemptyclause = '';
7430 $ctxemptyclause = "AND (ctx.path IS NULL OR ctx.depth = 0)";
7433 $sql = "INSERT INTO {context_temp} (id, path, depth, locked)
7434 SELECT ctx.id, ".$DB->sql_concat('pctx.path', "'/'", 'ctx.id').", pctx.depth+1, ctx.locked
7436 JOIN {course_modules} cm ON (cm.id = ctx.instanceid AND ctx.contextlevel = ".CONTEXT_MODULE
.")
7437 JOIN {context} pctx ON (pctx.instanceid = cm.course AND pctx.contextlevel = ".CONTEXT_COURSE
.")
7438 WHERE pctx.path IS NOT NULL AND pctx.depth > 0
7440 $trans = $DB->start_delegated_transaction();
7441 $DB->delete_records('context_temp');
7443 context
::merge_context_temp_table();
7444 $DB->delete_records('context_temp');
7445 $trans->allow_commit();
7452 * Block context class
7454 * @package core_access
7456 * @copyright Petr Skoda {@link http://skodak.org}
7457 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7460 class context_block
extends context
{
7462 * Please use context_block::instance($blockinstanceid) if you need the instance of context.
7463 * Alternatively if you know only the context id use context::instance_by_id($contextid)
7465 * @param stdClass $record
7467 protected function __construct(stdClass
$record) {
7468 parent
::__construct($record);
7469 if ($record->contextlevel
!= CONTEXT_BLOCK
) {
7470 throw new coding_exception('Invalid $record->contextlevel in context_block constructor');
7475 * Returns human readable context level name.
7478 * @return string the human readable context level name.
7480 public static function get_level_name() {
7481 return get_string('block');
7485 * Returns human readable context identifier.
7487 * @param boolean $withprefix whether to prefix the name of the context with Block
7488 * @param boolean $short does not apply to block context
7489 * @param boolean $escape does not apply to block context
7490 * @return string the human readable context name.
7492 public function get_context_name($withprefix = true, $short = false, $escape = true) {
7496 if ($blockinstance = $DB->get_record('block_instances', array('id'=>$this->_instanceid
))) {
7498 require_once("$CFG->dirroot/blocks/moodleblock.class.php");
7499 require_once("$CFG->dirroot/blocks/$blockinstance->blockname/block_$blockinstance->blockname.php");
7500 $blockname = "block_$blockinstance->blockname";
7501 if ($blockobject = new $blockname()) {
7503 $name = get_string('block').': ';
7505 $name .= $blockobject->title
;
7513 * Returns the most relevant URL for this context.
7515 * @return moodle_url
7517 public function get_url() {
7518 $parentcontexts = $this->get_parent_context();
7519 return $parentcontexts->get_url();
7523 * Returns array of relevant context capability records.
7525 * @param string $sort
7528 public function get_capabilities(string $sort = self
::DEFAULT_CAPABILITY_SORT
) {
7531 $bi = $DB->get_record('block_instances', array('id' => $this->_instanceid
));
7533 $select = '(contextlevel = :level AND component = :component)';
7535 'level' => CONTEXT_BLOCK
,
7536 'component' => 'block_' . $bi->blockname
,
7539 $extracaps = block_method_result($bi->blockname
, 'get_extra_capabilities');
7541 list($extra, $extraparams) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED
, 'cap');
7542 $select .= " OR name $extra";
7543 $params = array_merge($params, $extraparams);
7546 return $DB->get_records_select('capabilities', $select, $params, $sort);
7550 * Is this context part of any course? If yes return course context.
7552 * @param bool $strict true means throw exception if not found, false means return false if not found
7553 * @return context_course context of the enclosing course, null if not found or exception
7555 public function get_course_context($strict = true) {
7556 $parentcontext = $this->get_parent_context();
7557 return $parentcontext->get_course_context($strict);
7561 * Returns block context instance.
7564 * @param int $blockinstanceid id from {block_instances} table.
7565 * @param int $strictness
7566 * @return context_block context instance
7568 public static function instance($blockinstanceid, $strictness = MUST_EXIST
) {
7571 if ($context = context
::cache_get(CONTEXT_BLOCK
, $blockinstanceid)) {
7575 if (!$record = $DB->get_record('context', array('contextlevel' => CONTEXT_BLOCK
, 'instanceid' => $blockinstanceid))) {
7576 if ($bi = $DB->get_record('block_instances', array('id' => $blockinstanceid), 'id,parentcontextid', $strictness)) {
7577 $parentcontext = context
::instance_by_id($bi->parentcontextid
);
7578 $record = context
::insert_context_record(CONTEXT_BLOCK
, $bi->id
, $parentcontext->path
);
7583 $context = new context_block($record);
7584 context
::cache_add($context);
7592 * Block do not have child contexts...
7595 public function get_child_contexts() {
7600 * Create missing context instances at block context level
7603 protected static function create_level_instances() {
7607 INSERT INTO {context} (
7613 FROM {block_instances} bi
7615 SELECT 'x' FROM {context} cx WHERE bi.id = cx.instanceid AND cx.contextlevel = :existingcontextlevel
7619 $DB->execute($sql, [
7620 'contextlevel' => CONTEXT_BLOCK
,
7621 'existingcontextlevel' => CONTEXT_BLOCK
,
7626 * Returns sql necessary for purging of stale context instances.
7629 * @return string cleanup SQL
7631 protected static function get_cleanup_sql() {
7635 LEFT OUTER JOIN {block_instances} bi ON c.instanceid = bi.id
7636 WHERE bi.id IS NULL AND c.contextlevel = ".CONTEXT_BLOCK
."
7643 * Rebuild context paths and depths at block context level.
7646 * @param bool $force
7648 protected static function build_paths($force) {
7651 if ($force or $DB->record_exists_select('context', "contextlevel = ".CONTEXT_BLOCK
." AND (depth = 0 OR path IS NULL)")) {
7653 $ctxemptyclause = '';
7655 $ctxemptyclause = "AND (ctx.path IS NULL OR ctx.depth = 0)";
7658 // pctx.path IS NOT NULL prevents fatal problems with broken block instances that point to invalid context parent
7659 $sql = "INSERT INTO {context_temp} (id, path, depth, locked)
7660 SELECT ctx.id, ".$DB->sql_concat('pctx.path', "'/'", 'ctx.id').", pctx.depth+1, ctx.locked
7662 JOIN {block_instances} bi ON (bi.id = ctx.instanceid AND ctx.contextlevel = ".CONTEXT_BLOCK
.")
7663 JOIN {context} pctx ON (pctx.id = bi.parentcontextid)
7664 WHERE (pctx.path IS NOT NULL AND pctx.depth > 0)
7666 $trans = $DB->start_delegated_transaction();
7667 $DB->delete_records('context_temp');
7669 context
::merge_context_temp_table();
7670 $DB->delete_records('context_temp');
7671 $trans->allow_commit();
7677 // ============== DEPRECATED FUNCTIONS ==========================================
7678 // Old context related functions were deprecated in 2.0, it is recommended
7679 // to use context classes in new code. Old function can be used when
7680 // creating patches that are supposed to be backported to older stable branches.
7681 // These deprecated functions will not be removed in near future,
7682 // before removing devs will be warned with a debugging message first,
7683 // then we will add error message and only after that we can remove the functions
7687 * Runs get_records select on context table and returns the result
7688 * Does get_records_select on the context table, and returns the results ordered
7689 * by contextlevel, and then the natural sort order within each level.
7690 * for the purpose of $select, you need to know that the context table has been
7691 * aliased to ctx, so for example, you can call get_sorted_contexts('ctx.depth = 3');
7693 * @param string $select the contents of the WHERE clause. Remember to do ctx.fieldname.
7694 * @param array $params any parameters required by $select.
7695 * @return array the requested context records.
7697 function get_sorted_contexts($select, $params = array()) {
7699 //TODO: we should probably rewrite all the code that is using this thing, the trouble is we MUST NOT modify the context instances...
7703 $select = 'WHERE ' . $select;
7705 return $DB->get_records_sql("
7708 LEFT JOIN {user} u ON ctx.contextlevel = " . CONTEXT_USER
. " AND u.id = ctx.instanceid
7709 LEFT JOIN {course_categories} cat ON ctx.contextlevel = " . CONTEXT_COURSECAT
. " AND cat.id = ctx.instanceid
7710 LEFT JOIN {course} c ON ctx.contextlevel = " . CONTEXT_COURSE
. " AND c.id = ctx.instanceid
7711 LEFT JOIN {course_modules} cm ON ctx.contextlevel = " . CONTEXT_MODULE
. " AND cm.id = ctx.instanceid
7712 LEFT JOIN {block_instances} bi ON ctx.contextlevel = " . CONTEXT_BLOCK
. " AND bi.id = ctx.instanceid
7714 ORDER BY ctx.contextlevel, bi.defaultregion, COALESCE(cat.sortorder, c.sortorder, cm.section, bi.defaultweight), u.lastname, u.firstname, cm.id
7719 * Given context and array of users, returns array of users whose enrolment status is suspended,
7720 * or enrolment has expired or has not started. Also removes those users from the given array
7722 * @param context $context context in which suspended users should be extracted.
7723 * @param array $users list of users.
7724 * @param array $ignoreusers array of user ids to ignore, e.g. guest
7725 * @return array list of suspended users.
7727 function extract_suspended_users($context, &$users, $ignoreusers=array()) {
7730 // Get active enrolled users.
7731 list($sql, $params) = get_enrolled_sql($context, null, null, true);
7732 $activeusers = $DB->get_records_sql($sql, $params);
7734 // Move suspended users to a separate array & remove from the initial one.
7736 if (sizeof($activeusers)) {
7737 foreach ($users as $userid => $user) {
7738 if (!array_key_exists($userid, $activeusers) && !in_array($userid, $ignoreusers)) {
7739 $susers[$userid] = $user;
7740 unset($users[$userid]);
7748 * Given context and array of users, returns array of user ids whose enrolment status is suspended,
7749 * or enrolment has expired or not started.
7751 * @param context $context context in which user enrolment is checked.
7752 * @param bool $usecache Enable or disable (default) the request cache
7753 * @return array list of suspended user id's.
7755 function get_suspended_userids(context
$context, $usecache = false) {
7759 $cache = cache
::make('core', 'suspended_userids');
7760 $susers = $cache->get($context->id
);
7761 if ($susers !== false) {
7766 $coursecontext = $context->get_course_context();
7769 // Front page users are always enrolled, so suspended list is empty.
7770 if ($coursecontext->instanceid
!= SITEID
) {
7771 list($sql, $params) = get_enrolled_sql($context, null, null, false, true);
7772 $susers = $DB->get_fieldset_sql($sql, $params);
7773 $susers = array_combine($susers, $susers);
7776 // Cache results for the remainder of this request.
7778 $cache->set($context->id
, $susers);
7785 * Gets sql for finding users with capability in the given context
7787 * @param context $context
7788 * @param string|array $capability Capability name or array of names.
7789 * If an array is provided then this is the equivalent of a logical 'OR',
7790 * i.e. the user needs to have one of these capabilities.
7791 * @return array($sql, $params)
7793 function get_with_capability_sql(context
$context, $capability) {
7796 $prefix = 'cu' . $i . '_';
7798 $capjoin = get_with_capability_join($context, $capability, $prefix . 'u.id');
7800 $sql = "SELECT DISTINCT {$prefix}u.id
7801 FROM {user} {$prefix}u
7803 WHERE {$prefix}u.deleted = 0 AND $capjoin->wheres";
7805 return array($sql, $capjoin->params
);