b7c0c94197067c7dab7ddc99fd079a8d3b9ca312
[moodle.git] / lib / accesslib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * This file contains functions for managing user access
19  *
20  * <b>Public API vs internals</b>
21  *
22  * General users probably only care about
23  *
24  * Context handling
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();
29  *
30  * Whether the user can do something...
31  * - has_capability()
32  * - has_any_capability()
33  * - has_all_capabilities()
34  * - require_capability()
35  * - require_login() (from moodlelib)
36  * - is_siteadmin()
37  *
38  * What courses has this user access to?
39  * - get_enrolled_users()
40  *
41  * What users can do X in this context?
42  * - get_users_by_capability()
43  *
44  * Modify roles
45  * - role_assign()
46  * - role_unassign()
47  * - role_unassign_all()
48  *
49  *
50  * Advanced - for internal use only
51  * - load_all_capabilities()
52  * - reload_all_capabilities()
53  * - has_capability_in_accessdata()
54  * - get_user_access_sitewide()
55  * - load_course_context()
56  * - load_role_access_by_context()
57  * - etc.
58  *
59  * <b>Name conventions</b>
60  *
61  * "ctx" means context
62  *
63  * <b>accessdata</b>
64  *
65  * Access control data is held in the "accessdata" array
66  * which - for the logged-in user, will be in $USER->access
67  *
68  * For other users can be generated and passed around (but may also be cached
69  * against userid in $ACCESSLIB_PRIVATE->accessdatabyuser).
70  *
71  * $accessdata is a multidimensional array, holding
72  * role assignments (RAs), role-capabilities-perm sets
73  * (role defs) and a list of courses we have loaded
74  * data for.
75  *
76  * Things are keyed on "contextpaths" (the path field of
77  * the context table) for fast walking up/down the tree.
78  * <code>
79  * $accessdata['ra'][$contextpath] = array($roleid=>$roleid)
80  *                  [$contextpath] = array($roleid=>$roleid)
81  *                  [$contextpath] = array($roleid=>$roleid)
82  * </code>
83  *
84  * Role definitions are stored like this
85  * (no cap merge is done - so it's compact)
86  *
87  * <code>
88  * $accessdata['rdef']["$contextpath:$roleid"]['mod/forum:viewpost'] = 1
89  *                                            ['mod/forum:editallpost'] = -1
90  *                                            ['mod/forum:startdiscussion'] = -1000
91  * </code>
92  *
93  * See how has_capability_in_accessdata() walks up the tree.
94  *
95  * First we only load rdef and ra down to the course level, but not below.
96  * This keeps accessdata small and compact. Below-the-course ra/rdef
97  * are loaded as needed. We keep track of which courses we have loaded ra/rdef in
98  * <code>
99  * $accessdata['loaded'] = array($courseid1=>1, $courseid2=>1)
100  * </code>
101  *
102  * <b>Stale accessdata</b>
103  *
104  * For the logged-in user, accessdata is long-lived.
105  *
106  * On each pageload we load $ACCESSLIB_PRIVATE->dirtycontexts which lists
107  * context paths affected by changes. Any check at-or-below
108  * a dirty context will trigger a transparent reload of accessdata.
109  *
110  * Changes at the system level will force the reload for everyone.
111  *
112  * <b>Default role caps</b>
113  * The default role assignment is not in the DB, so we
114  * add it manually to accessdata.
115  *
116  * This means that functions that work directly off the
117  * DB need to ensure that the default role caps
118  * are dealt with appropriately.
119  *
120  * @package    core
121  * @subpackage role
122  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
123  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
124  */
126 defined('MOODLE_INTERNAL') || die();
128 /** No capability change */
129 define('CAP_INHERIT', 0);
130 /** Allow permission, overrides CAP_PREVENT defined in parent contexts */
131 define('CAP_ALLOW', 1);
132 /** Prevent permission, overrides CAP_ALLOW defined in parent contexts */
133 define('CAP_PREVENT', -1);
134 /** Prohibit permission, overrides everything in current and child contexts */
135 define('CAP_PROHIBIT', -1000);
137 /** System context level - only one instance in every system */
138 define('CONTEXT_SYSTEM', 10);
139 /** User context level -  one instance for each user describing what others can do to user */
140 define('CONTEXT_USER', 30);
141 /** Course category context level - one instance for each category */
142 define('CONTEXT_COURSECAT', 40);
143 /** Course context level - one instances for each course */
144 define('CONTEXT_COURSE', 50);
145 /** Course module context level - one instance for each course module */
146 define('CONTEXT_MODULE', 70);
147 /**
148  * Block context level - one instance for each block, sticky blocks are tricky
149  * because ppl think they should be able to override them at lower contexts.
150  * Any other context level instance can be parent of block context.
151  */
152 define('CONTEXT_BLOCK', 80);
154 /** Capability allow management of trusts - NOT IMPLEMENTED YET - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
155 define('RISK_MANAGETRUST', 0x0001);
156 /** Capability allows changes in system configuration - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
157 define('RISK_CONFIG',      0x0002);
158 /** Capability allows user to add scritped content - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
159 define('RISK_XSS',         0x0004);
160 /** Capability allows access to personal user information - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
161 define('RISK_PERSONAL',    0x0008);
162 /** Capability allows users to add content otehrs may see - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
163 define('RISK_SPAM',        0x0010);
164 /** capability allows mass delete of data belonging to other users - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
165 define('RISK_DATALOSS',    0x0020);
167 /** rolename displays - the name as defined in the role definition */
168 define('ROLENAME_ORIGINAL', 0);
169 /** rolename displays - the name as defined by a role alias */
170 define('ROLENAME_ALIAS', 1);
171 /** rolename displays - Both, like this:  Role alias (Original) */
172 define('ROLENAME_BOTH', 2);
173 /** rolename displays - the name as defined in the role definition and the shortname in brackets */
174 define('ROLENAME_ORIGINALANDSHORT', 3);
175 /** rolename displays - the name as defined by a role alias, in raw form suitable for editing */
176 define('ROLENAME_ALIAS_RAW', 4);
177 /** rolename displays - the name is simply short role name */
178 define('ROLENAME_SHORT', 5);
180 /** maximum size of context cache - it is possible to tweak this config.php or in any script before inclusion of context.php */
181 if (!defined('CONTEXT_CACHE_MAX_SIZE')) {
182     define('CONTEXT_CACHE_MAX_SIZE', 2500);
185 /**
186  * Although this looks like a global variable, it isn't really.
187  *
188  * It is just a private implementation detail to accesslib that MUST NOT be used elsewhere.
189  * It is used to cache various bits of data between function calls for performance reasons.
190  * Sadly, a PHP global variable is the only way to implement this, without rewriting everything
191  * as methods of a class, instead of functions.
192  *
193  * @private
194  * @global stdClass $ACCESSLIB_PRIVATE
195  * @name $ACCESSLIB_PRIVATE
196  */
197 global $ACCESSLIB_PRIVATE;
198 $ACCESSLIB_PRIVATE = new stdClass();
199 $ACCESSLIB_PRIVATE->dirtycontexts    = null;    // Dirty contexts cache, loaded from DB once per page
200 $ACCESSLIB_PRIVATE->accessdatabyuser = array(); // Holds the cache of $accessdata structure for users (including $USER)
201 $ACCESSLIB_PRIVATE->rolepermissions  = array(); // role permissions cache - helps a lot with mem usage
202 $ACCESSLIB_PRIVATE->capabilities     = null;    // detailed information about the capabilities
204 /**
205  * Clears accesslib's private caches. ONLY BE USED BY UNIT TESTS
206  *
207  * This method should ONLY BE USED BY UNIT TESTS. It clears all of
208  * accesslib's private caches. You need to do this before setting up test data,
209  * and also at the end of the tests.
210  *
211  * @return void
212  */
213 function accesslib_clear_all_caches_for_unit_testing() {
214     global $UNITTEST, $USER;
215     if (empty($UNITTEST->running)) {
216         throw new coding_exception('You must not call clear_all_caches outside of unit tests.');
217     }
219     accesslib_clear_all_caches(true);
221     unset($USER->access);
224 /**
225  * Clears accesslib's private caches. ONLY BE USED FROM THIS LIBRARY FILE!
226  *
227  * This reset does not touch global $USER.
228  *
229  * @private
230  * @param bool $resetcontexts
231  * @return void
232  */
233 function accesslib_clear_all_caches($resetcontexts) {
234     global $ACCESSLIB_PRIVATE;
236     $ACCESSLIB_PRIVATE->dirtycontexts    = null;
237     $ACCESSLIB_PRIVATE->accessdatabyuser = array();
238     $ACCESSLIB_PRIVATE->rolepermissions  = array();
239     $ACCESSLIB_PRIVATE->capabilities     = null;
241     if ($resetcontexts) {
242         context_helper::reset_caches();
243     }
246 /**
247  * Gets the accessdata for role "sitewide" (system down to course)
248  *
249  * @private
250  * @param int $roleid
251  * @return array
252  */
253 function get_role_access($roleid) {
254     global $DB, $ACCESSLIB_PRIVATE;
256     /* Get it in 1 DB query...
257      * - relevant role caps at the root and down
258      *   to the course level - but not below
259      */
261     //TODO: MUC - this could be cached in shared memory to speed up first page loading, web crawlers, etc.
263     $accessdata = get_empty_accessdata();
265     $accessdata['ra']['/'.SYSCONTEXTID] = array((int)$roleid => (int)$roleid);
267     //
268     // Overrides for the role IN ANY CONTEXTS
269     // down to COURSE - not below -
270     //
271     $sql = "SELECT ctx.path,
272                    rc.capability, rc.permission
273               FROM {context} ctx
274               JOIN {role_capabilities} rc ON rc.contextid = ctx.id
275          LEFT JOIN {context} cctx
276                    ON (cctx.contextlevel = ".CONTEXT_COURSE." AND ctx.path LIKE ".$DB->sql_concat('cctx.path',"'/%'").")
277              WHERE rc.roleid = ? AND cctx.id IS NULL";
278     $params = array($roleid);
280     // we need extra caching in CLI scripts and cron
281     $rs = $DB->get_recordset_sql($sql, $params);
282     foreach ($rs as $rd) {
283         $k = "{$rd->path}:{$roleid}";
284         $accessdata['rdef'][$k][$rd->capability] = (int)$rd->permission;
285     }
286     $rs->close();
288     // share the role definitions
289     foreach ($accessdata['rdef'] as $k=>$unused) {
290         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
291             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $accessdata['rdef'][$k];
292         }
293         $accessdata['rdef_count']++;
294         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
295     }
297     return $accessdata;
300 /**
301  * Get the default guest role, this is used for guest account,
302  * search engine spiders, etc.
303  *
304  * @return stdClass role record
305  */
306 function get_guest_role() {
307     global $CFG, $DB;
309     if (empty($CFG->guestroleid)) {
310         if ($roles = $DB->get_records('role', array('archetype'=>'guest'))) {
311             $guestrole = array_shift($roles);   // Pick the first one
312             set_config('guestroleid', $guestrole->id);
313             return $guestrole;
314         } else {
315             debugging('Can not find any guest role!');
316             return false;
317         }
318     } else {
319         if ($guestrole = $DB->get_record('role', array('id'=>$CFG->guestroleid))) {
320             return $guestrole;
321         } else {
322             // somebody is messing with guest roles, remove incorrect setting and try to find a new one
323             set_config('guestroleid', '');
324             return get_guest_role();
325         }
326     }
329 /**
330  * Check whether a user has a particular capability in a given context.
331  *
332  * For example:
333  *      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
334  *      has_capability('mod/forum:replypost',$context)
335  *
336  * By default checks the capabilities of the current user, but you can pass a
337  * different userid. By default will return true for admin users, but you can override that with the fourth argument.
338  *
339  * Guest and not-logged-in users can never get any dangerous capability - that is any write capability
340  * or capabilities with XSS, config or data loss risks.
341  *
342  * @param string $capability the name of the capability to check. For example mod/forum:view
343  * @param context $context the context to check the capability in. You normally get this with {@link get_context_instance}.
344  * @param integer|object $user A user id or object. By default (null) checks the permissions of the current user.
345  * @param boolean $doanything If false, ignores effect of admin role assignment
346  * @return boolean true if the user has this capability. Otherwise false.
347  */
348 function has_capability($capability, context $context, $user = null, $doanything = true) {
349     global $USER, $CFG, $SCRIPT, $ACCESSLIB_PRIVATE;
351     if (during_initial_install()) {
352         if ($SCRIPT === "/$CFG->admin/index.php" or $SCRIPT === "/$CFG->admin/cli/install.php" or $SCRIPT === "/$CFG->admin/cli/install_database.php") {
353             // we are in an installer - roles can not work yet
354             return true;
355         } else {
356             return false;
357         }
358     }
360     if (strpos($capability, 'moodle/legacy:') === 0) {
361         throw new coding_exception('Legacy capabilities can not be used any more!');
362     }
364     if (!is_bool($doanything)) {
365         throw new coding_exception('Capability parameter "doanything" is wierd, only true or false is allowed. This has to be fixed in code.');
366     }
368     // capability must exist
369     if (!$capinfo = get_capability_info($capability)) {
370         debugging('Capability "'.$capability.'" was not found! This has to be fixed in code.');
371         return false;
372     }
374     if (!isset($USER->id)) {
375         // should never happen
376         $USER->id = 0;
377     }
379     // make sure there is a real user specified
380     if ($user === null) {
381         $userid = $USER->id;
382     } else {
383         $userid = is_object($user) ? $user->id : $user;
384     }
386     // make sure forcelogin cuts off not-logged-in users if enabled
387     if (!empty($CFG->forcelogin) and $userid == 0) {
388         return false;
389     }
391     // make sure the guest account and not-logged-in users never get any risky caps no matter what the actual settings are.
392     if (($capinfo->captype === 'write') or ($capinfo->riskbitmask & (RISK_XSS | RISK_CONFIG | RISK_DATALOSS))) {
393         if (isguestuser($userid) or $userid == 0) {
394             return false;
395         }
396     }
398     // somehow make sure the user is not deleted and actually exists
399     if ($userid != 0) {
400         if ($userid == $USER->id and isset($USER->deleted)) {
401             // this prevents one query per page, it is a bit of cheating,
402             // but hopefully session is terminated properly once user is deleted
403             if ($USER->deleted) {
404                 return false;
405             }
406         } else {
407             if (!context_user::instance($userid, IGNORE_MISSING)) {
408                 // no user context == invalid userid
409                 return false;
410             }
411         }
412     }
414     // context path/depth must be valid
415     if (empty($context->path) or $context->depth == 0) {
416         // this should not happen often, each upgrade tries to rebuild the context paths
417         debugging('Context id '.$context->id.' does not have valid path, please use build_context_path()');
418         if (is_siteadmin($userid)) {
419             return true;
420         } else {
421             return false;
422         }
423     }
425     // Find out if user is admin - it is not possible to override the doanything in any way
426     // and it is not possible to switch to admin role either.
427     if ($doanything) {
428         if (is_siteadmin($userid)) {
429             if ($userid != $USER->id) {
430                 return true;
431             }
432             // make sure switchrole is not used in this context
433             if (empty($USER->access['rsw'])) {
434                 return true;
435             }
436             $parts = explode('/', trim($context->path, '/'));
437             $path = '';
438             $switched = false;
439             foreach ($parts as $part) {
440                 $path .= '/' . $part;
441                 if (!empty($USER->access['rsw'][$path])) {
442                     $switched = true;
443                     break;
444                 }
445             }
446             if (!$switched) {
447                 return true;
448             }
449             //ok, admin switched role in this context, let's use normal access control rules
450         }
451     }
453     // Careful check for staleness...
454     $context->reload_if_dirty();
456     if ($USER->id == $userid) {
457         if (!isset($USER->access)) {
458             load_all_capabilities();
459         }
460         $access =& $USER->access;
462     } else {
463         // make sure user accessdata is really loaded
464         get_user_accessdata($userid, true);
465         $access =& $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
466     }
469     // Load accessdata for below-the-course context if necessary,
470     // all contexts at and above all courses are already loaded
471     if ($context->contextlevel != CONTEXT_COURSE and $coursecontext = $context->get_course_context(false)) {
472         load_course_context($userid, $coursecontext, $access);
473     }
475     return has_capability_in_accessdata($capability, $context, $access);
478 /**
479  * Check if the user has any one of several capabilities from a list.
480  *
481  * This is just a utility method that calls has_capability in a loop. Try to put
482  * the capabilities that most users are likely to have first in the list for best
483  * performance.
484  *
485  * @see has_capability()
486  * @param array $capabilities an array of capability names.
487  * @param context $context the context to check the capability in. You normally get this with {@link get_context_instance}.
488  * @param integer $userid A user id. By default (null) checks the permissions of the current user.
489  * @param boolean $doanything If false, ignore effect of admin role assignment
490  * @return boolean true if the user has any of these capabilities. Otherwise false.
491  */
492 function has_any_capability(array $capabilities, context $context, $userid = null, $doanything = true) {
493     foreach ($capabilities as $capability) {
494         if (has_capability($capability, $context, $userid, $doanything)) {
495             return true;
496         }
497     }
498     return false;
501 /**
502  * Check if the user has all the capabilities in a list.
503  *
504  * This is just a utility method that calls has_capability in a loop. Try to put
505  * the capabilities that fewest users are likely to have first in the list for best
506  * performance.
507  *
508  * @see has_capability()
509  * @param array $capabilities an array of capability names.
510  * @param context $context the context to check the capability in. You normally get this with {@link get_context_instance}.
511  * @param integer $userid A user id. By default (null) checks the permissions of the current user.
512  * @param boolean $doanything If false, ignore effect of admin role assignment
513  * @return boolean true if the user has all of these capabilities. Otherwise false.
514  */
515 function has_all_capabilities(array $capabilities, context $context, $userid = null, $doanything = true) {
516     foreach ($capabilities as $capability) {
517         if (!has_capability($capability, $context, $userid, $doanything)) {
518             return false;
519         }
520     }
521     return true;
524 /**
525  * Check if the user is an admin at the site level.
526  *
527  * Please note that use of proper capabilities is always encouraged,
528  * this function is supposed to be used from core or for temporary hacks.
529  *
530  * @param  int|stdClass  $user_or_id user id or user object
531  * @return bool true if user is one of the administrators, false otherwise
532  */
533 function is_siteadmin($user_or_id = null) {
534     global $CFG, $USER;
536     if ($user_or_id === null) {
537         $user_or_id = $USER;
538     }
540     if (empty($user_or_id)) {
541         return false;
542     }
543     if (!empty($user_or_id->id)) {
544         $userid = $user_or_id->id;
545     } else {
546         $userid = $user_or_id;
547     }
549     $siteadmins = explode(',', $CFG->siteadmins);
550     return in_array($userid, $siteadmins);
553 /**
554  * Returns true if user has at least one role assign
555  * of 'coursecontact' role (is potentially listed in some course descriptions).
556  *
557  * @param int $userid
558  * @return bool
559  */
560 function has_coursecontact_role($userid) {
561     global $DB, $CFG;
563     if (empty($CFG->coursecontact)) {
564         return false;
565     }
566     $sql = "SELECT 1
567               FROM {role_assignments}
568              WHERE userid = :userid AND roleid IN ($CFG->coursecontact)";
569     return $DB->record_exists_sql($sql, array('userid'=>$userid));
572 /**
573  * Does the user have a capability to do something?
574  *
575  * Walk the accessdata array and return true/false.
576  * Deals with prohibits, role switching, aggregating
577  * capabilities, etc.
578  *
579  * The main feature of here is being FAST and with no
580  * side effects.
581  *
582  * Notes:
583  *
584  * Switch Role merges with default role
585  * ------------------------------------
586  * If you are a teacher in course X, you have at least
587  * teacher-in-X + defaultloggedinuser-sitewide. So in the
588  * course you'll have techer+defaultloggedinuser.
589  * We try to mimic that in switchrole.
590  *
591  * Permission evaluation
592  * ---------------------
593  * Originally there was an extremely complicated way
594  * to determine the user access that dealt with
595  * "locality" or role assignments and role overrides.
596  * Now we simply evaluate access for each role separately
597  * and then verify if user has at least one role with allow
598  * and at the same time no role with prohibit.
599  *
600  * @private
601  * @param string $capability
602  * @param context $context
603  * @param array $accessdata
604  * @return bool
605  */
606 function has_capability_in_accessdata($capability, context $context, array &$accessdata) {
607     global $CFG;
609     // Build $paths as a list of current + all parent "paths" with order bottom-to-top
610     $path = $context->path;
611     $paths = array($path);
612     while($path = rtrim($path, '0123456789')) {
613         $path = rtrim($path, '/');
614         if ($path === '') {
615             break;
616         }
617         $paths[] = $path;
618     }
620     $roles = array();
621     $switchedrole = false;
623     // Find out if role switched
624     if (!empty($accessdata['rsw'])) {
625         // From the bottom up...
626         foreach ($paths as $path) {
627             if (isset($accessdata['rsw'][$path])) {
628                 // Found a switchrole assignment - check for that role _plus_ the default user role
629                 $roles = array($accessdata['rsw'][$path]=>null, $CFG->defaultuserroleid=>null);
630                 $switchedrole = true;
631                 break;
632             }
633         }
634     }
636     if (!$switchedrole) {
637         // get all users roles in this context and above
638         foreach ($paths as $path) {
639             if (isset($accessdata['ra'][$path])) {
640                 foreach ($accessdata['ra'][$path] as $roleid) {
641                     $roles[$roleid] = null;
642                 }
643             }
644         }
645     }
647     // Now find out what access is given to each role, going bottom-->up direction
648     $allowed = false;
649     foreach ($roles as $roleid => $ignored) {
650         foreach ($paths as $path) {
651             if (isset($accessdata['rdef']["{$path}:$roleid"][$capability])) {
652                 $perm = (int)$accessdata['rdef']["{$path}:$roleid"][$capability];
653                 if ($perm === CAP_PROHIBIT) {
654                     // any CAP_PROHIBIT found means no permission for the user
655                     return false;
656                 }
657                 if (is_null($roles[$roleid])) {
658                     $roles[$roleid] = $perm;
659                 }
660             }
661         }
662         // CAP_ALLOW in any role means the user has a permission, we continue only to detect prohibits
663         $allowed = ($allowed or $roles[$roleid] === CAP_ALLOW);
664     }
666     return $allowed;
669 /**
670  * A convenience function that tests has_capability, and displays an error if
671  * the user does not have that capability.
672  *
673  * NOTE before Moodle 2.0, this function attempted to make an appropriate
674  * require_login call before checking the capability. This is no longer the case.
675  * You must call require_login (or one of its variants) if you want to check the
676  * user is logged in, before you call this function.
677  *
678  * @see has_capability()
679  *
680  * @param string $capability the name of the capability to check. For example mod/forum:view
681  * @param context $context the context to check the capability in. You normally get this with {@link get_context_instance}.
682  * @param int $userid A user id. By default (null) checks the permissions of the current user.
683  * @param bool $doanything If false, ignore effect of admin role assignment
684  * @param string $errormessage The error string to to user. Defaults to 'nopermissions'.
685  * @param string $stringfile The language file to load the error string from. Defaults to 'error'.
686  * @return void terminates with an error if the user does not have the given capability.
687  */
688 function require_capability($capability, context $context, $userid = null, $doanything = true,
689                             $errormessage = 'nopermissions', $stringfile = '') {
690     if (!has_capability($capability, $context, $userid, $doanything)) {
691         throw new required_capability_exception($context, $capability, $errormessage, $stringfile);
692     }
695 /**
696  * Return a nested array showing role assignments
697  * all relevant role capabilities for the user at
698  * site/course_category/course levels
699  *
700  * We do _not_ delve deeper than courses because the number of
701  * overrides at the module/block levels can be HUGE.
702  *
703  * [ra]   => [/path][roleid]=roleid
704  * [rdef] => [/path:roleid][capability]=permission
705  *
706  * @private
707  * @param int $userid - the id of the user
708  * @return array access info array
709  */
710 function get_user_access_sitewide($userid) {
711     global $CFG, $DB, $ACCESSLIB_PRIVATE;
713     /* Get in a few cheap DB queries...
714      * - role assignments
715      * - relevant role caps
716      *   - above and within this user's RAs
717      *   - below this user's RAs - limited to course level
718      */
720     // raparents collects paths & roles we need to walk up the parenthood to build the minimal rdef
721     $raparents = array();
722     $accessdata = get_empty_accessdata();
724     // start with the default role
725     if (!empty($CFG->defaultuserroleid)) {
726         $syscontext = context_system::instance();
727         $accessdata['ra'][$syscontext->path][(int)$CFG->defaultuserroleid] = (int)$CFG->defaultuserroleid;
728         $raparents[$CFG->defaultuserroleid][$syscontext->id] = $syscontext->id;
729     }
731     // load the "default frontpage role"
732     if (!empty($CFG->defaultfrontpageroleid)) {
733         $frontpagecontext = context_course::instance(get_site()->id);
734         if ($frontpagecontext->path) {
735             $accessdata['ra'][$frontpagecontext->path][(int)$CFG->defaultfrontpageroleid] = (int)$CFG->defaultfrontpageroleid;
736             $raparents[$CFG->defaultfrontpageroleid][$frontpagecontext->id] = $frontpagecontext->id;
737         }
738     }
740     // preload every assigned role at and above course context
741     $sql = "SELECT ctx.path, ra.roleid, ra.contextid
742               FROM {role_assignments} ra
743               JOIN {context} ctx
744                    ON ctx.id = ra.contextid
745          LEFT JOIN {block_instances} bi
746                    ON (ctx.contextlevel = ".CONTEXT_BLOCK." AND bi.id = ctx.instanceid)
747          LEFT JOIN {context} bpctx
748                    ON (bpctx.id = bi.parentcontextid)
749              WHERE ra.userid = :userid
750                    AND (ctx.contextlevel <= ".CONTEXT_COURSE." OR bpctx.contextlevel < ".CONTEXT_COURSE.")";
751     $params = array('userid'=>$userid);
752     $rs = $DB->get_recordset_sql($sql, $params);
753     foreach ($rs as $ra) {
754         // RAs leafs are arrays to support multi-role assignments...
755         $accessdata['ra'][$ra->path][(int)$ra->roleid] = (int)$ra->roleid;
756         $raparents[$ra->roleid][$ra->contextid] = $ra->contextid;
757     }
758     $rs->close();
760     if (empty($raparents)) {
761         return $accessdata;
762     }
764     // now get overrides of interesting roles in all interesting child contexts
765     // hopefully we will not run out of SQL limits here,
766     // users would have to have very many roles at/above course context...
767     $sqls = array();
768     $params = array();
770     static $cp = 0;
771     foreach ($raparents as $roleid=>$ras) {
772         $cp++;
773         list($sqlcids, $cids) = $DB->get_in_or_equal($ras, SQL_PARAMS_NAMED, 'c'.$cp.'_');
774         $params = array_merge($params, $cids);
775         $params['r'.$cp] = $roleid;
776         $sqls[] = "(SELECT ctx.path, rc.roleid, rc.capability, rc.permission
777                      FROM {role_capabilities} rc
778                      JOIN {context} ctx
779                           ON (ctx.id = rc.contextid)
780                      JOIN {context} pctx
781                           ON (pctx.id $sqlcids
782                               AND (ctx.id = pctx.id
783                                    OR ctx.path LIKE ".$DB->sql_concat('pctx.path',"'/%'")."
784                                    OR pctx.path LIKE ".$DB->sql_concat('ctx.path',"'/%'")."))
785                 LEFT JOIN {block_instances} bi
786                           ON (ctx.contextlevel = ".CONTEXT_BLOCK." AND bi.id = ctx.instanceid)
787                 LEFT JOIN {context} bpctx
788                           ON (bpctx.id = bi.parentcontextid)
789                     WHERE rc.roleid = :r{$cp}
790                           AND (ctx.contextlevel <= ".CONTEXT_COURSE." OR bpctx.contextlevel < ".CONTEXT_COURSE.")
791                    )";
792     }
794     // fixed capability order is necessary for rdef dedupe
795     $rs = $DB->get_recordset_sql(implode("\nUNION\n", $sqls). "ORDER BY capability", $params);
797     foreach ($rs as $rd) {
798         $k = $rd->path.':'.$rd->roleid;
799         $accessdata['rdef'][$k][$rd->capability] = (int)$rd->permission;
800     }
801     $rs->close();
803     // share the role definitions
804     foreach ($accessdata['rdef'] as $k=>$unused) {
805         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
806             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $accessdata['rdef'][$k];
807         }
808         $accessdata['rdef_count']++;
809         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
810     }
812     return $accessdata;
815 /**
816  * Add to the access ctrl array the data needed by a user for a given course.
817  *
818  * This function injects all course related access info into the accessdata array.
819  *
820  * @private
821  * @param int $userid the id of the user
822  * @param context_course $coursecontext course context
823  * @param array $accessdata accessdata array (modified)
824  * @return void modifies $accessdata parameter
825  */
826 function load_course_context($userid, context_course $coursecontext, &$accessdata) {
827     global $DB, $CFG, $ACCESSLIB_PRIVATE;
829     if (empty($coursecontext->path)) {
830         // weird, this should not happen
831         return;
832     }
834     if (isset($accessdata['loaded'][$coursecontext->instanceid])) {
835         // already loaded, great!
836         return;
837     }
839     $roles = array();
841     if (empty($userid)) {
842         if (!empty($CFG->notloggedinroleid)) {
843             $roles[$CFG->notloggedinroleid] = $CFG->notloggedinroleid;
844         }
846     } else if (isguestuser($userid)) {
847         if ($guestrole = get_guest_role()) {
848             $roles[$guestrole->id] = $guestrole->id;
849         }
851     } else {
852         // Interesting role assignments at, above and below the course context
853         list($parentsaself, $params) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'pc_');
854         $params['userid'] = $userid;
855         $params['children'] = $coursecontext->path."/%";
856         $sql = "SELECT ra.*, ctx.path
857                   FROM {role_assignments} ra
858                   JOIN {context} ctx ON ra.contextid = ctx.id
859                  WHERE ra.userid = :userid AND (ctx.id $parentsaself OR ctx.path LIKE :children)";
860         $rs = $DB->get_recordset_sql($sql, $params);
862         // add missing role definitions
863         foreach ($rs as $ra) {
864             $accessdata['ra'][$ra->path][(int)$ra->roleid] = (int)$ra->roleid;
865             $roles[$ra->roleid] = $ra->roleid;
866         }
867         $rs->close();
869         // add the "default frontpage role" when on the frontpage
870         if (!empty($CFG->defaultfrontpageroleid)) {
871             $frontpagecontext = context_course::instance(get_site()->id);
872             if ($frontpagecontext->id == $coursecontext->id) {
873                 $roles[$CFG->defaultfrontpageroleid] = $CFG->defaultfrontpageroleid;
874             }
875         }
877         // do not forget the default role
878         if (!empty($CFG->defaultuserroleid)) {
879             $roles[$CFG->defaultuserroleid] = $CFG->defaultuserroleid;
880         }
881     }
883     if (!$roles) {
884         // weird, default roles must be missing...
885         $accessdata['loaded'][$coursecontext->instanceid] = 1;
886         return;
887     }
889     // now get overrides of interesting roles in all interesting contexts (this course + children + parents)
890     $params = array('c'=>$coursecontext->id);
891     list($parentsaself, $rparams) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'pc_');
892     $params = array_merge($params, $rparams);
893     list($roleids, $rparams) = $DB->get_in_or_equal($roles, SQL_PARAMS_NAMED, 'r_');
894     $params = array_merge($params, $rparams);
896     $sql = "SELECT ctx.path, rc.roleid, rc.capability, rc.permission
897                  FROM {role_capabilities} rc
898                  JOIN {context} ctx
899                       ON (ctx.id = rc.contextid)
900                  JOIN {context} cctx
901                       ON (cctx.id = :c
902                           AND (ctx.id $parentsaself OR ctx.path LIKE ".$DB->sql_concat('cctx.path',"'/%'")."))
903                 WHERE rc.roleid $roleids
904              ORDER BY rc.capability"; // fixed capability order is necessary for rdef dedupe
905     $rs = $DB->get_recordset_sql($sql, $params);
907     $newrdefs = array();
908     foreach ($rs as $rd) {
909         $k = $rd->path.':'.$rd->roleid;
910         if (isset($accessdata['rdef'][$k])) {
911             continue;
912         }
913         $newrdefs[$k][$rd->capability] = (int)$rd->permission;
914     }
915     $rs->close();
917     // share new role definitions
918     foreach ($newrdefs as $k=>$unused) {
919         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
920             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $newrdefs[$k];
921         }
922         $accessdata['rdef_count']++;
923         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
924     }
926     $accessdata['loaded'][$coursecontext->instanceid] = 1;
928     // we want to deduplicate the USER->access from time to time, this looks like a good place,
929     // because we have to do it before the end of session
930     dedupe_user_access();
933 /**
934  * Add to the access ctrl array the data needed by a role for a given context.
935  *
936  * The data is added in the rdef key.
937  * This role-centric function is useful for role_switching
938  * and temporary course roles.
939  *
940  * @private
941  * @param int $roleid the id of the user
942  * @param context $context needs path!
943  * @param array $accessdata accessdata array (is modified)
944  * @return array
945  */
946 function load_role_access_by_context($roleid, context $context, &$accessdata) {
947     global $DB, $ACCESSLIB_PRIVATE;
949     /* Get the relevant rolecaps into rdef
950      * - relevant role caps
951      *   - at ctx and above
952      *   - below this ctx
953      */
955     if (empty($context->path)) {
956         // weird, this should not happen
957         return;
958     }
960     list($parentsaself, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'pc_');
961     $params['roleid'] = $roleid;
962     $params['childpath'] = $context->path.'/%';
964     $sql = "SELECT ctx.path, rc.capability, rc.permission
965               FROM {role_capabilities} rc
966               JOIN {context} ctx ON (rc.contextid = ctx.id)
967              WHERE rc.roleid = :roleid AND (ctx.id $parentsaself OR ctx.path LIKE :childpath)
968           ORDER BY rc.capability"; // fixed capability order is necessary for rdef dedupe
969     $rs = $DB->get_recordset_sql($sql, $params);
971     $newrdefs = array();
972     foreach ($rs as $rd) {
973         $k = $rd->path.':'.$roleid;
974         if (isset($accessdata['rdef'][$k])) {
975             continue;
976         }
977         $newrdefs[$k][$rd->capability] = (int)$rd->permission;
978     }
979     $rs->close();
981     // share new role definitions
982     foreach ($newrdefs as $k=>$unused) {
983         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
984             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $newrdefs[$k];
985         }
986         $accessdata['rdef_count']++;
987         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
988     }
991 /**
992  * Returns empty accessdata structure.
993  *
994  * @private
995  * @return array empt accessdata
996  */
997 function get_empty_accessdata() {
998     $accessdata               = array(); // named list
999     $accessdata['ra']         = array();
1000     $accessdata['rdef']       = array();
1001     $accessdata['rdef_count'] = 0;       // this bloody hack is necessary because count($array) is slooooowwww in PHP
1002     $accessdata['rdef_lcc']   = 0;       // rdef_count during the last compression
1003     $accessdata['loaded']     = array(); // loaded course contexts
1004     $accessdata['time']       = time();
1006     return $accessdata;
1009 /**
1010  * Get accessdata for a given user.
1011  *
1012  * @private
1013  * @param int $userid
1014  * @param bool $preloadonly true means do not return access array
1015  * @return array accessdata
1016  */
1017 function get_user_accessdata($userid, $preloadonly=false) {
1018     global $CFG, $ACCESSLIB_PRIVATE, $USER;
1020     if (!empty($USER->acces['rdef']) and empty($ACCESSLIB_PRIVATE->rolepermissions)) {
1021         // share rdef from USER session with rolepermissions cache in order to conserve memory
1022         foreach($USER->acces['rdef'] as $k=>$v) {
1023             $ACCESSLIB_PRIVATE->rolepermissions[$k] =& $USER->acces['rdef'][$k];
1024         }
1025         $ACCESSLIB_PRIVATE->accessdatabyuser[$USER->id] = $USER->acces;
1026     }
1028     if (!isset($ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
1029         if (empty($userid)) {
1030             if (!empty($CFG->notloggedinroleid)) {
1031                 $accessdata = get_role_access($CFG->notloggedinroleid);
1032             } else {
1033                 // weird
1034                 return get_empty_accessdata();
1035             }
1037         } else if (isguestuser($userid)) {
1038             if ($guestrole = get_guest_role()) {
1039                 $accessdata = get_role_access($guestrole->id);
1040             } else {
1041                 //weird
1042                 return get_empty_accessdata();
1043             }
1045         } else {
1046             $accessdata = get_user_access_sitewide($userid); // includes default role and frontpage role
1047         }
1049         $ACCESSLIB_PRIVATE->accessdatabyuser[$userid] = $accessdata;
1050     }
1052     if ($preloadonly) {
1053         return;
1054     } else {
1055         return $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
1056     }
1059 /**
1060  * Try to minimise the size of $USER->access by eliminating duplicate override storage,
1061  * this function looks for contexts with the same overrides and shares them.
1062  *
1063  * @private
1064  * @return void
1065  */
1066 function dedupe_user_access() {
1067     global $USER;
1069     if (CLI_SCRIPT) {
1070         // no session in CLI --> no compression necessary
1071         return;
1072     }
1074     if (empty($USER->access['rdef_count'])) {
1075         // weird, this should not happen
1076         return;
1077     }
1079     // the rdef is growing only, we never remove stuff from it, the rdef_lcc helps us to detect new stuff in rdef
1080     if ($USER->access['rdef_count'] - $USER->access['rdef_lcc'] > 10) {
1081         // do not compress after each change, wait till there is more stuff to be done
1082         return;
1083     }
1085     $hashmap = array();
1086     foreach ($USER->access['rdef'] as $k=>$def) {
1087         $hash = sha1(serialize($def));
1088         if (isset($hashmap[$hash])) {
1089             $USER->access['rdef'][$k] =& $hashmap[$hash];
1090         } else {
1091             $hashmap[$hash] =& $USER->access['rdef'][$k];
1092         }
1093     }
1095     $USER->access['rdef_lcc'] = $USER->access['rdef_count'];
1098 /**
1099  * A convenience function to completely load all the capabilities
1100  * for the current user. It is called from has_capability() and functions change permissions.
1101  *
1102  * Call it only _after_ you've setup $USER and called check_enrolment_plugins();
1103  * @see check_enrolment_plugins()
1104  *
1105  * @private
1106  * @return void
1107  */
1108 function load_all_capabilities() {
1109     global $USER;
1111     // roles not installed yet - we are in the middle of installation
1112     if (during_initial_install()) {
1113         return;
1114     }
1116     if (!isset($USER->id)) {
1117         // this should not happen
1118         $USER->id = 0;
1119     }
1121     unset($USER->access);
1122     $USER->access = get_user_accessdata($USER->id);
1124     // deduplicate the overrides to minimize session size
1125     dedupe_user_access();
1127     // Clear to force a refresh
1128     unset($USER->mycourses);
1130     // init/reset internal enrol caches - active course enrolments and temp access
1131     $USER->enrol = array('enrolled'=>array(), 'tempguest'=>array());
1134 /**
1135  * A convenience function to completely reload all the capabilities
1136  * for the current user when roles have been updated in a relevant
1137  * context -- but PRESERVING switchroles and loginas.
1138  * This function resets all accesslib and context caches.
1139  *
1140  * That is - completely transparent to the user.
1141  *
1142  * Note: reloads $USER->access completely.
1143  *
1144  * @private
1145  * @return void
1146  */
1147 function reload_all_capabilities() {
1148     global $USER, $DB, $ACCESSLIB_PRIVATE;
1150     // copy switchroles
1151     $sw = array();
1152     if (isset($USER->access['rsw'])) {
1153         $sw = $USER->access['rsw'];
1154     }
1156     accesslib_clear_all_caches(true);
1157     unset($USER->access);
1158     $ACCESSLIB_PRIVATE->dirtycontexts = array(); // prevent dirty flags refetching on this page
1160     load_all_capabilities();
1162     foreach ($sw as $path => $roleid) {
1163         if ($record = $DB->get_record('context', array('path'=>$path))) {
1164             $context = context::instance_by_id($record->id);
1165             role_switch($roleid, $context);
1166         }
1167     }
1170 /**
1171  * Adds a temp role to current USER->access array.
1172  *
1173  * Useful for the "temporary guest" access we grant to logged-in users.
1174  * @since 2.2
1175  *
1176  * @param context_course $coursecontext
1177  * @param int $roleid
1178  * @return void
1179  */
1180 function load_temp_course_role(context_course $coursecontext, $roleid) {
1181     global $USER, $SITE;
1183     if (empty($roleid)) {
1184         debugging('invalid role specified in load_temp_course_role()');
1185         return;
1186     }
1188     if ($coursecontext->instanceid == $SITE->id) {
1189         debugging('Can not use temp roles on the frontpage');
1190         return;
1191     }
1193     if (!isset($USER->access)) {
1194         load_all_capabilities();
1195     }
1197     $coursecontext->reload_if_dirty();
1199     if (isset($USER->access['ra'][$coursecontext->path][$roleid])) {
1200         return;
1201     }
1203     // load course stuff first
1204     load_course_context($USER->id, $coursecontext, $USER->access);
1206     $USER->access['ra'][$coursecontext->path][(int)$roleid] = (int)$roleid;
1208     load_role_access_by_context($roleid, $coursecontext, $USER->access);
1211 /**
1212  * Removes any extra guest roles from current USER->access array.
1213  * @since 2.2
1214  *
1215  * @param context_course $coursecontext
1216  * @return void
1217  */
1218 function remove_temp_course_roles(context_course $coursecontext) {
1219     global $DB, $USER, $SITE;
1221     if ($coursecontext->instanceid == $SITE->id) {
1222         debugging('Can not use temp roles on the frontpage');
1223         return;
1224     }
1226     if (empty($USER->access['ra'][$coursecontext->path])) {
1227         //no roles here, weird
1228         return;
1229     }
1231     $sql = "SELECT DISTINCT ra.roleid AS id
1232               FROM {role_assignments} ra
1233              WHERE ra.contextid = :contextid AND ra.userid = :userid";
1234     $ras = $DB->get_records_sql($sql, array('contextid'=>$coursecontext->id, 'userid'=>$USER->id));
1236     $USER->access['ra'][$coursecontext->path] = array();
1237     foreach($ras as $r) {
1238         $USER->access['ra'][$coursecontext->path][(int)$r->id] = (int)$r->id;
1239     }
1242 /**
1243  * Returns array of all role archetypes.
1244  *
1245  * @return array
1246  */
1247 function get_role_archetypes() {
1248     return array(
1249         'manager'        => 'manager',
1250         'coursecreator'  => 'coursecreator',
1251         'editingteacher' => 'editingteacher',
1252         'teacher'        => 'teacher',
1253         'student'        => 'student',
1254         'guest'          => 'guest',
1255         'user'           => 'user',
1256         'frontpage'      => 'frontpage'
1257     );
1260 /**
1261  * Assign the defaults found in this capability definition to roles that have
1262  * the corresponding legacy capabilities assigned to them.
1263  *
1264  * @param string $capability
1265  * @param array $legacyperms an array in the format (example):
1266  *                      'guest' => CAP_PREVENT,
1267  *                      'student' => CAP_ALLOW,
1268  *                      'teacher' => CAP_ALLOW,
1269  *                      'editingteacher' => CAP_ALLOW,
1270  *                      'coursecreator' => CAP_ALLOW,
1271  *                      'manager' => CAP_ALLOW
1272  * @return boolean success or failure.
1273  */
1274 function assign_legacy_capabilities($capability, $legacyperms) {
1276     $archetypes = get_role_archetypes();
1278     foreach ($legacyperms as $type => $perm) {
1280         $systemcontext = context_system::instance();
1281         if ($type === 'admin') {
1282             debugging('Legacy type admin in access.php was renamed to manager, please update the code.');
1283             $type = 'manager';
1284         }
1286         if (!array_key_exists($type, $archetypes)) {
1287             print_error('invalidlegacy', '', '', $type);
1288         }
1290         if ($roles = get_archetype_roles($type)) {
1291             foreach ($roles as $role) {
1292                 // Assign a site level capability.
1293                 if (!assign_capability($capability, $perm, $role->id, $systemcontext->id)) {
1294                     return false;
1295                 }
1296             }
1297         }
1298     }
1299     return true;
1302 /**
1303  * Verify capability risks.
1304  *
1305  * @param object $capability a capability - a row from the capabilities table.
1306  * @return boolean whether this capability is safe - that is, whether people with the
1307  *      safeoverrides capability should be allowed to change it.
1308  */
1309 function is_safe_capability($capability) {
1310     return !((RISK_DATALOSS | RISK_MANAGETRUST | RISK_CONFIG | RISK_XSS | RISK_PERSONAL) & $capability->riskbitmask);
1313 /**
1314  * Get the local override (if any) for a given capability in a role in a context
1315  *
1316  * @param int $roleid
1317  * @param int $contextid
1318  * @param string $capability
1319  * @return stdClass local capability override
1320  */
1321 function get_local_override($roleid, $contextid, $capability) {
1322     global $DB;
1323     return $DB->get_record('role_capabilities', array('roleid'=>$roleid, 'capability'=>$capability, 'contextid'=>$contextid));
1326 /**
1327  * Returns context instance plus related course and cm instances
1328  *
1329  * @param int $contextid
1330  * @return array of ($context, $course, $cm)
1331  */
1332 function get_context_info_array($contextid) {
1333     global $DB;
1335     $context = context::instance_by_id($contextid, MUST_EXIST);
1336     $course  = null;
1337     $cm      = null;
1339     if ($context->contextlevel == CONTEXT_COURSE) {
1340         $course = $DB->get_record('course', array('id'=>$context->instanceid), '*', MUST_EXIST);
1342     } else if ($context->contextlevel == CONTEXT_MODULE) {
1343         $cm = get_coursemodule_from_id('', $context->instanceid, 0, false, MUST_EXIST);
1344         $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
1346     } else if ($context->contextlevel == CONTEXT_BLOCK) {
1347         $parent = $context->get_parent_context();
1349         if ($parent->contextlevel == CONTEXT_COURSE) {
1350             $course = $DB->get_record('course', array('id'=>$parent->instanceid), '*', MUST_EXIST);
1351         } else if ($parent->contextlevel == CONTEXT_MODULE) {
1352             $cm = get_coursemodule_from_id('', $parent->instanceid, 0, false, MUST_EXIST);
1353             $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
1354         }
1355     }
1357     return array($context, $course, $cm);
1360 /**
1361  * Function that creates a role
1362  *
1363  * @param string $name role name
1364  * @param string $shortname role short name
1365  * @param string $description role description
1366  * @param string $archetype
1367  * @return int id or dml_exception
1368  */
1369 function create_role($name, $shortname, $description, $archetype = '') {
1370     global $DB;
1372     if (strpos($archetype, 'moodle/legacy:') !== false) {
1373         throw new coding_exception('Use new role archetype parameter in create_role() instead of old legacy capabilities.');
1374     }
1376     // verify role archetype actually exists
1377     $archetypes = get_role_archetypes();
1378     if (empty($archetypes[$archetype])) {
1379         $archetype = '';
1380     }
1382     // Insert the role record.
1383     $role = new stdClass();
1384     $role->name        = $name;
1385     $role->shortname   = $shortname;
1386     $role->description = $description;
1387     $role->archetype   = $archetype;
1389     //find free sortorder number
1390     $role->sortorder = $DB->get_field('role', 'MAX(sortorder) + 1', array());
1391     if (empty($role->sortorder)) {
1392         $role->sortorder = 1;
1393     }
1394     $id = $DB->insert_record('role', $role);
1396     return $id;
1399 /**
1400  * Function that deletes a role and cleanups up after it
1401  *
1402  * @param int $roleid id of role to delete
1403  * @return bool always true
1404  */
1405 function delete_role($roleid) {
1406     global $DB;
1408     // first unssign all users
1409     role_unassign_all(array('roleid'=>$roleid));
1411     // cleanup all references to this role, ignore errors
1412     $DB->delete_records('role_capabilities',   array('roleid'=>$roleid));
1413     $DB->delete_records('role_allow_assign',   array('roleid'=>$roleid));
1414     $DB->delete_records('role_allow_assign',   array('allowassign'=>$roleid));
1415     $DB->delete_records('role_allow_override', array('roleid'=>$roleid));
1416     $DB->delete_records('role_allow_override', array('allowoverride'=>$roleid));
1417     $DB->delete_records('role_names',          array('roleid'=>$roleid));
1418     $DB->delete_records('role_context_levels', array('roleid'=>$roleid));
1420     // finally delete the role itself
1421     // get this before the name is gone for logging
1422     $rolename = $DB->get_field('role', 'name', array('id'=>$roleid));
1424     $DB->delete_records('role', array('id'=>$roleid));
1426     add_to_log(SITEID, 'role', 'delete', 'admin/roles/action=delete&roleid='.$roleid, $rolename, '');
1428     return true;
1431 /**
1432  * Function to write context specific overrides, or default capabilities.
1433  *
1434  * NOTE: use $context->mark_dirty() after this
1435  *
1436  * @param string $capability string name
1437  * @param int $permission CAP_ constants
1438  * @param int $roleid role id
1439  * @param int|context $contextid context id
1440  * @param bool $overwrite
1441  * @return bool always true or exception
1442  */
1443 function assign_capability($capability, $permission, $roleid, $contextid, $overwrite = false) {
1444     global $USER, $DB;
1446     if ($contextid instanceof context) {
1447         $context = $contextid;
1448     } else {
1449         $context = context::instance_by_id($contextid);
1450     }
1452     if (empty($permission) || $permission == CAP_INHERIT) { // if permission is not set
1453         unassign_capability($capability, $roleid, $context->id);
1454         return true;
1455     }
1457     $existing = $DB->get_record('role_capabilities', array('contextid'=>$context->id, 'roleid'=>$roleid, 'capability'=>$capability));
1459     if ($existing and !$overwrite) {   // We want to keep whatever is there already
1460         return true;
1461     }
1463     $cap = new stdClass();
1464     $cap->contextid    = $context->id;
1465     $cap->roleid       = $roleid;
1466     $cap->capability   = $capability;
1467     $cap->permission   = $permission;
1468     $cap->timemodified = time();
1469     $cap->modifierid   = empty($USER->id) ? 0 : $USER->id;
1471     if ($existing) {
1472         $cap->id = $existing->id;
1473         $DB->update_record('role_capabilities', $cap);
1474     } else {
1475         if ($DB->record_exists('context', array('id'=>$context->id))) {
1476             $DB->insert_record('role_capabilities', $cap);
1477         }
1478     }
1479     return true;
1482 /**
1483  * Unassign a capability from a role.
1484  *
1485  * NOTE: use $context->mark_dirty() after this
1486  *
1487  * @param string $capability the name of the capability
1488  * @param int $roleid the role id
1489  * @param int|context $contextid null means all contexts
1490  * @return boolean true or exception
1491  */
1492 function unassign_capability($capability, $roleid, $contextid = null) {
1493     global $DB;
1495     if (!empty($contextid)) {
1496         if ($contextid instanceof context) {
1497             $context = $contextid;
1498         } else {
1499             $context = context::instance_by_id($contextid);
1500         }
1501         // delete from context rel, if this is the last override in this context
1502         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid, 'contextid'=>$context->id));
1503     } else {
1504         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid));
1505     }
1506     return true;
1509 /**
1510  * Get the roles that have a given capability assigned to it
1511  *
1512  * This function does not resolve the actual permission of the capability.
1513  * It just checks for permissions and overrides.
1514  * Use get_roles_with_cap_in_context() if resolution is required.
1515  *
1516  * @param string $capability - capability name (string)
1517  * @param string $permission - optional, the permission defined for this capability
1518  *                      either CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT. Defaults to null which means any.
1519  * @param stdClass $context, null means any
1520  * @return array of role records
1521  */
1522 function get_roles_with_capability($capability, $permission = null, $context = null) {
1523     global $DB;
1525     if ($context) {
1526         $contexts = $context->get_parent_context_ids(true);
1527         list($insql, $params) = $DB->get_in_or_equal($contexts, SQL_PARAMS_NAMED, 'ctx');
1528         $contextsql = "AND rc.contextid $insql";
1529     } else {
1530         $params = array();
1531         $contextsql = '';
1532     }
1534     if ($permission) {
1535         $permissionsql = " AND rc.permission = :permission";
1536         $params['permission'] = $permission;
1537     } else {
1538         $permissionsql = '';
1539     }
1541     $sql = "SELECT r.*
1542               FROM {role} r
1543              WHERE r.id IN (SELECT rc.roleid
1544                               FROM {role_capabilities} rc
1545                              WHERE rc.capability = :capname
1546                                    $contextsql
1547                                    $permissionsql)";
1548     $params['capname'] = $capability;
1551     return $DB->get_records_sql($sql, $params);
1554 /**
1555  * This function makes a role-assignment (a role for a user in a particular context)
1556  *
1557  * @param int $roleid the role of the id
1558  * @param int $userid userid
1559  * @param int|context $contextid id of the context
1560  * @param string $component example 'enrol_ldap', defaults to '' which means manual assignment,
1561  * @param int $itemid id of enrolment/auth plugin
1562  * @param string $timemodified defaults to current time
1563  * @return int new/existing id of the assignment
1564  */
1565 function role_assign($roleid, $userid, $contextid, $component = '', $itemid = 0, $timemodified = '') {
1566     global $USER, $DB;
1568     // first of all detect if somebody is using old style parameters
1569     if ($contextid === 0 or is_numeric($component)) {
1570         throw new coding_exception('Invalid call to role_assign(), code needs to be updated to use new order of parameters');
1571     }
1573     // now validate all parameters
1574     if (empty($roleid)) {
1575         throw new coding_exception('Invalid call to role_assign(), roleid can not be empty');
1576     }
1578     if (empty($userid)) {
1579         throw new coding_exception('Invalid call to role_assign(), userid can not be empty');
1580     }
1582     if ($itemid) {
1583         if (strpos($component, '_') === false) {
1584             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as"enrol_" when itemid specified', 'component:'.$component);
1585         }
1586     } else {
1587         $itemid = 0;
1588         if ($component !== '' and strpos($component, '_') === false) {
1589             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
1590         }
1591     }
1593     if (!$DB->record_exists('user', array('id'=>$userid, 'deleted'=>0))) {
1594         throw new coding_exception('User ID does not exist or is deleted!', 'userid:'.$userid);
1595     }
1597     if ($contextid instanceof context) {
1598         $context = $contextid;
1599     } else {
1600         $context = context::instance_by_id($contextid, MUST_EXIST);
1601     }
1603     if (!$timemodified) {
1604         $timemodified = time();
1605     }
1607     // Check for existing entry
1608     // TODO: Revisit this sql_empty() use once Oracle bindings are improved. MDL-29765
1609     $component = ($component === '') ? $DB->sql_empty() : $component;
1610     $ras = $DB->get_records('role_assignments', array('roleid'=>$roleid, 'contextid'=>$context->id, 'userid'=>$userid, 'component'=>$component, 'itemid'=>$itemid), 'id');
1612     if ($ras) {
1613         // role already assigned - this should not happen
1614         if (count($ras) > 1) {
1615             // very weird - remove all duplicates!
1616             $ra = array_shift($ras);
1617             foreach ($ras as $r) {
1618                 $DB->delete_records('role_assignments', array('id'=>$r->id));
1619             }
1620         } else {
1621             $ra = reset($ras);
1622         }
1624         // actually there is no need to update, reset anything or trigger any event, so just return
1625         return $ra->id;
1626     }
1628     // Create a new entry
1629     $ra = new stdClass();
1630     $ra->roleid       = $roleid;
1631     $ra->contextid    = $context->id;
1632     $ra->userid       = $userid;
1633     $ra->component    = $component;
1634     $ra->itemid       = $itemid;
1635     $ra->timemodified = $timemodified;
1636     $ra->modifierid   = empty($USER->id) ? 0 : $USER->id;
1638     $ra->id = $DB->insert_record('role_assignments', $ra);
1640     // mark context as dirty - again expensive, but needed
1641     $context->mark_dirty();
1643     if (!empty($USER->id) && $USER->id == $userid) {
1644         // If the user is the current user, then do full reload of capabilities too.
1645         reload_all_capabilities();
1646     }
1648     events_trigger('role_assigned', $ra);
1650     return $ra->id;
1653 /**
1654  * Removes one role assignment
1655  *
1656  * @param int $roleid
1657  * @param int  $userid
1658  * @param int|context  $contextid
1659  * @param string $component
1660  * @param int  $itemid
1661  * @return void
1662  */
1663 function role_unassign($roleid, $userid, $contextid, $component = '', $itemid = 0) {
1664     // first make sure the params make sense
1665     if ($roleid == 0 or $userid == 0 or $contextid == 0) {
1666         throw new coding_exception('Invalid call to role_unassign(), please use role_unassign_all() when removing multiple role assignments');
1667     }
1669     if ($itemid) {
1670         if (strpos($component, '_') === false) {
1671             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as "enrol_" when itemid specified', 'component:'.$component);
1672         }
1673     } else {
1674         $itemid = 0;
1675         if ($component !== '' and strpos($component, '_') === false) {
1676             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
1677         }
1678     }
1680     role_unassign_all(array('roleid'=>$roleid, 'userid'=>$userid, 'contextid'=>$contextid, 'component'=>$component, 'itemid'=>$itemid), false, false);
1683 /**
1684  * Removes multiple role assignments, parameters may contain:
1685  *   'roleid', 'userid', 'contextid', 'component', 'enrolid'.
1686  *
1687  * @param array $params role assignment parameters
1688  * @param bool $subcontexts unassign in subcontexts too
1689  * @param bool $includemanual include manual role assignments too
1690  * @return void
1691  */
1692 function role_unassign_all(array $params, $subcontexts = false, $includemanual = false) {
1693     global $USER, $CFG, $DB;
1695     if (!$params) {
1696         throw new coding_exception('Missing parameters in role_unsassign_all() call');
1697     }
1699     $allowed = array('roleid', 'userid', 'contextid', 'component', 'itemid');
1700     foreach ($params as $key=>$value) {
1701         if (!in_array($key, $allowed)) {
1702             throw new coding_exception('Unknown role_unsassign_all() parameter key', 'key:'.$key);
1703         }
1704     }
1706     if (isset($params['component']) and $params['component'] !== '' and strpos($params['component'], '_') === false) {
1707         throw new coding_exception('Invalid component paramter in role_unsassign_all() call', 'component:'.$params['component']);
1708     }
1710     if ($includemanual) {
1711         if (!isset($params['component']) or $params['component'] === '') {
1712             throw new coding_exception('include manual parameter requires component parameter in role_unsassign_all() call');
1713         }
1714     }
1716     if ($subcontexts) {
1717         if (empty($params['contextid'])) {
1718             throw new coding_exception('subcontexts paramtere requires component parameter in role_unsassign_all() call');
1719         }
1720     }
1722     // TODO: Revisit this sql_empty() use once Oracle bindings are improved. MDL-29765
1723     if (isset($params['component'])) {
1724         $params['component'] = ($params['component'] === '') ? $DB->sql_empty() : $params['component'];
1725     }
1726     $ras = $DB->get_records('role_assignments', $params);
1727     foreach($ras as $ra) {
1728         $DB->delete_records('role_assignments', array('id'=>$ra->id));
1729         if ($context = context::instance_by_id($ra->contextid, IGNORE_MISSING)) {
1730             // this is a bit expensive but necessary
1731             $context->mark_dirty();
1732             /// If the user is the current user, then do full reload of capabilities too.
1733             if (!empty($USER->id) && $USER->id == $ra->userid) {
1734                 reload_all_capabilities();
1735             }
1736         }
1737         events_trigger('role_unassigned', $ra);
1738     }
1739     unset($ras);
1741     // process subcontexts
1742     if ($subcontexts and $context = context::instance_by_id($params['contextid'], IGNORE_MISSING)) {
1743         if ($params['contextid'] instanceof context) {
1744             $context = $params['contextid'];
1745         } else {
1746             $context = context::instance_by_id($params['contextid'], IGNORE_MISSING);
1747         }
1749         if ($context) {
1750             $contexts = $context->get_child_contexts();
1751             $mparams = $params;
1752             foreach($contexts as $context) {
1753                 $mparams['contextid'] = $context->id;
1754                 $ras = $DB->get_records('role_assignments', $mparams);
1755                 foreach($ras as $ra) {
1756                     $DB->delete_records('role_assignments', array('id'=>$ra->id));
1757                     // this is a bit expensive but necessary
1758                     $context->mark_dirty();
1759                     /// If the user is the current user, then do full reload of capabilities too.
1760                     if (!empty($USER->id) && $USER->id == $ra->userid) {
1761                         reload_all_capabilities();
1762                     }
1763                     events_trigger('role_unassigned', $ra);
1764                 }
1765             }
1766         }
1767     }
1769     // do this once more for all manual role assignments
1770     if ($includemanual) {
1771         $params['component'] = '';
1772         role_unassign_all($params, $subcontexts, false);
1773     }
1776 /**
1777  * Determines if a user is currently logged in
1778  *
1779  * @return bool
1780  */
1781 function isloggedin() {
1782     global $USER;
1784     return (!empty($USER->id));
1787 /**
1788  * Determines if a user is logged in as real guest user with username 'guest'.
1789  *
1790  * @param int|object $user mixed user object or id, $USER if not specified
1791  * @return bool true if user is the real guest user, false if not logged in or other user
1792  */
1793 function isguestuser($user = null) {
1794     global $USER, $DB, $CFG;
1796     // make sure we have the user id cached in config table, because we are going to use it a lot
1797     if (empty($CFG->siteguest)) {
1798         if (!$guestid = $DB->get_field('user', 'id', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
1799             // guest does not exist yet, weird
1800             return false;
1801         }
1802         set_config('siteguest', $guestid);
1803     }
1804     if ($user === null) {
1805         $user = $USER;
1806     }
1808     if ($user === null) {
1809         // happens when setting the $USER
1810         return false;
1812     } else if (is_numeric($user)) {
1813         return ($CFG->siteguest == $user);
1815     } else if (is_object($user)) {
1816         if (empty($user->id)) {
1817             return false; // not logged in means is not be guest
1818         } else {
1819             return ($CFG->siteguest == $user->id);
1820         }
1822     } else {
1823         throw new coding_exception('Invalid user parameter supplied for isguestuser() function!');
1824     }
1827 /**
1828  * Does user have a (temporary or real) guest access to course?
1829  *
1830  * @param context $context
1831  * @param stdClass|int $user
1832  * @return bool
1833  */
1834 function is_guest(context $context, $user = null) {
1835     global $USER;
1837     // first find the course context
1838     $coursecontext = $context->get_course_context();
1840     // make sure there is a real user specified
1841     if ($user === null) {
1842         $userid = isset($USER->id) ? $USER->id : 0;
1843     } else {
1844         $userid = is_object($user) ? $user->id : $user;
1845     }
1847     if (isguestuser($userid)) {
1848         // can not inspect or be enrolled
1849         return true;
1850     }
1852     if (has_capability('moodle/course:view', $coursecontext, $user)) {
1853         // viewing users appear out of nowhere, they are neither guests nor participants
1854         return false;
1855     }
1857     // consider only real active enrolments here
1858     if (is_enrolled($coursecontext, $user, '', true)) {
1859         return false;
1860     }
1862     return true;
1865 /**
1866  * Returns true if the user has moodle/course:view capability in the course,
1867  * this is intended for admins, managers (aka small admins), inspectors, etc.
1868  *
1869  * @param context $context
1870  * @param int|stdClass $user, if null $USER is used
1871  * @param string $withcapability extra capability name
1872  * @return bool
1873  */
1874 function is_viewing(context $context, $user = null, $withcapability = '') {
1875     // first find the course context
1876     $coursecontext = $context->get_course_context();
1878     if (isguestuser($user)) {
1879         // can not inspect
1880         return false;
1881     }
1883     if (!has_capability('moodle/course:view', $coursecontext, $user)) {
1884         // admins are allowed to inspect courses
1885         return false;
1886     }
1888     if ($withcapability and !has_capability($withcapability, $context, $user)) {
1889         // site admins always have the capability, but the enrolment above blocks
1890         return false;
1891     }
1893     return true;
1896 /**
1897  * Returns true if user is enrolled (is participating) in course
1898  * this is intended for students and teachers.
1899  *
1900  * Since 2.2 the result for active enrolments and current user are cached.
1901  *
1902  * @param context $context
1903  * @param int|stdClass $user, if null $USER is used, otherwise user object or id expected
1904  * @param string $withcapability extra capability name
1905  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
1906  * @return bool
1907  */
1908 function is_enrolled(context $context, $user = null, $withcapability = '', $onlyactive = false) {
1909     global $USER, $DB;
1911     // first find the course context
1912     $coursecontext = $context->get_course_context();
1914     // make sure there is a real user specified
1915     if ($user === null) {
1916         $userid = isset($USER->id) ? $USER->id : 0;
1917     } else {
1918         $userid = is_object($user) ? $user->id : $user;
1919     }
1921     if (empty($userid)) {
1922         // not-logged-in!
1923         return false;
1924     } else if (isguestuser($userid)) {
1925         // guest account can not be enrolled anywhere
1926         return false;
1927     }
1929     if ($coursecontext->instanceid == SITEID) {
1930         // everybody participates on frontpage
1931     } else {
1932         // try cached info first - the enrolled flag is set only when active enrolment present
1933         if ($USER->id == $userid) {
1934             $coursecontext->reload_if_dirty();
1935             if (isset($USER->enrol['enrolled'][$coursecontext->instanceid])) {
1936                 if ($USER->enrol['enrolled'][$coursecontext->instanceid] > time()) {
1937                     return true;
1938                 }
1939             }
1940         }
1942         if ($onlyactive) {
1943             // look for active enrolments only
1944             $until = enrol_get_enrolment_end($coursecontext->instanceid, $userid);
1946             if ($until === false) {
1947                 return false;
1948             }
1950             if ($USER->id == $userid) {
1951                 if ($until == 0) {
1952                     $until = ENROL_MAX_TIMESTAMP;
1953                 }
1954                 $USER->enrol['enrolled'][$coursecontext->instanceid] = $until;
1955                 if (isset($USER->enrol['tempguest'][$coursecontext->instanceid])) {
1956                     unset($USER->enrol['tempguest'][$coursecontext->instanceid]);
1957                     remove_temp_course_roles($coursecontext);
1958                 }
1959             }
1961         } else {
1962             // any enrolment is good for us here, even outdated, disabled or inactive
1963             $sql = "SELECT 'x'
1964                       FROM {user_enrolments} ue
1965                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
1966                       JOIN {user} u ON u.id = ue.userid
1967                      WHERE ue.userid = :userid AND u.deleted = 0";
1968             $params = array('userid'=>$userid, 'courseid'=>$coursecontext->instanceid);
1969             if (!$DB->record_exists_sql($sql, $params)) {
1970                 return false;
1971             }
1972         }
1973     }
1975     if ($withcapability and !has_capability($withcapability, $context, $userid)) {
1976         return false;
1977     }
1979     return true;
1982 /**
1983  * Returns true if the user is able to access the course.
1984  *
1985  * This function is in no way, shape, or form a substitute for require_login.
1986  * It should only be used in circumstances where it is not possible to call require_login
1987  * such as the navigation.
1988  *
1989  * This function checks many of the methods of access to a course such as the view
1990  * capability, enrollments, and guest access. It also makes use of the cache
1991  * generated by require_login for guest access.
1992  *
1993  * The flags within the $USER object that are used here should NEVER be used outside
1994  * of this function can_access_course and require_login. Doing so WILL break future
1995  * versions.
1996  *
1997  * @param stdClass $course record
1998  * @param stdClass|int|null $user user record or id, current user if null
1999  * @param string $withcapability Check for this capability as well.
2000  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2001  * @return boolean Returns true if the user is able to access the course
2002  */
2003 function can_access_course(stdClass $course, $user = null, $withcapability = '', $onlyactive = false) {
2004     global $DB, $USER;
2006     // this function originally accepted $coursecontext parameter
2007     if ($course instanceof context) {
2008         if ($course instanceof context_course) {
2009             debugging('deprecated context parameter, please use $course record');
2010             $coursecontext = $course;
2011             $course = $DB->get_record('course', array('id'=>$coursecontext->instanceid));
2012         } else {
2013             debugging('Invalid context parameter, please use $course record');
2014             return false;
2015         }
2016     } else {
2017         $coursecontext = context_course::instance($course->id);
2018     }
2020     if (!isset($USER->id)) {
2021         // should never happen
2022         $USER->id = 0;
2023     }
2025     // make sure there is a user specified
2026     if ($user === null) {
2027         $userid = $USER->id;
2028     } else {
2029         $userid = is_object($user) ? $user->id : $user;
2030     }
2031     unset($user);
2033     if ($withcapability and !has_capability($withcapability, $coursecontext, $userid)) {
2034         return false;
2035     }
2037     if ($userid == $USER->id) {
2038         if (!empty($USER->access['rsw'][$coursecontext->path])) {
2039             // the fact that somebody switched role means they can access the course no matter to what role they switched
2040             return true;
2041         }
2042     }
2044     if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext, $userid)) {
2045         return false;
2046     }
2048     if (is_viewing($coursecontext, $userid)) {
2049         return true;
2050     }
2052     if ($userid != $USER->id) {
2053         // for performance reasons we do not verify temporary guest access for other users, sorry...
2054         return is_enrolled($coursecontext, $userid, '', $onlyactive);
2055     }
2057     // === from here we deal only with $USER ===
2059     $coursecontext->reload_if_dirty();
2061     if (isset($USER->enrol['enrolled'][$course->id])) {
2062         if ($USER->enrol['enrolled'][$course->id] > time()) {
2063             return true;
2064         }
2065     }
2066     if (isset($USER->enrol['tempguest'][$course->id])) {
2067         if ($USER->enrol['tempguest'][$course->id] > time()) {
2068             return true;
2069         }
2070     }
2072     if (is_enrolled($coursecontext, $USER, '', $onlyactive)) {
2073         return true;
2074     }
2076     // if not enrolled try to gain temporary guest access
2077     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2078     $enrols = enrol_get_plugins(true);
2079     foreach($instances as $instance) {
2080         if (!isset($enrols[$instance->enrol])) {
2081             continue;
2082         }
2083         // Get a duration for the guest access, a timestamp in the future, 0 (always) or false.
2084         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2085         if ($until !== false and $until > time()) {
2086             $USER->enrol['tempguest'][$course->id] = $until;
2087             return true;
2088         }
2089     }
2090     if (isset($USER->enrol['tempguest'][$course->id])) {
2091         unset($USER->enrol['tempguest'][$course->id]);
2092         remove_temp_course_roles($coursecontext);
2093     }
2095     return false;
2098 /**
2099  * Returns array with sql code and parameters returning all ids
2100  * of users enrolled into course.
2101  *
2102  * This function is using 'eu[0-9]+_' prefix for table names and parameters.
2103  *
2104  * @param context $context
2105  * @param string $withcapability
2106  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2107  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2108  * @return array list($sql, $params)
2109  */
2110 function get_enrolled_sql(context $context, $withcapability = '', $groupid = 0, $onlyactive = false) {
2111     global $DB, $CFG;
2113     // use unique prefix just in case somebody makes some SQL magic with the result
2114     static $i = 0;
2115     $i++;
2116     $prefix = 'eu'.$i.'_';
2118     // first find the course context
2119     $coursecontext = $context->get_course_context();
2121     $isfrontpage = ($coursecontext->instanceid == SITEID);
2123     $joins  = array();
2124     $wheres = array();
2125     $params = array();
2127     list($contextids, $contextpaths) = get_context_info_list($context);
2129     // get all relevant capability info for all roles
2130     if ($withcapability) {
2131         list($incontexts, $cparams) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED, 'ctx');
2132         $cparams['cap'] = $withcapability;
2134         $defs = array();
2135         $sql = "SELECT rc.id, rc.roleid, rc.permission, ctx.path
2136                   FROM {role_capabilities} rc
2137                   JOIN {context} ctx on rc.contextid = ctx.id
2138                  WHERE rc.contextid $incontexts AND rc.capability = :cap";
2139         $rcs = $DB->get_records_sql($sql, $cparams);
2140         foreach ($rcs as $rc) {
2141             $defs[$rc->path][$rc->roleid] = $rc->permission;
2142         }
2144         $access = array();
2145         if (!empty($defs)) {
2146             foreach ($contextpaths as $path) {
2147                 if (empty($defs[$path])) {
2148                     continue;
2149                 }
2150                 foreach($defs[$path] as $roleid => $perm) {
2151                     if ($perm == CAP_PROHIBIT) {
2152                         $access[$roleid] = CAP_PROHIBIT;
2153                         continue;
2154                     }
2155                     if (!isset($access[$roleid])) {
2156                         $access[$roleid] = (int)$perm;
2157                     }
2158                 }
2159             }
2160         }
2162         unset($defs);
2164         // make lists of roles that are needed and prohibited
2165         $needed     = array(); // one of these is enough
2166         $prohibited = array(); // must not have any of these
2167         foreach ($access as $roleid => $perm) {
2168             if ($perm == CAP_PROHIBIT) {
2169                 unset($needed[$roleid]);
2170                 $prohibited[$roleid] = true;
2171             } else if ($perm == CAP_ALLOW and empty($prohibited[$roleid])) {
2172                 $needed[$roleid] = true;
2173             }
2174         }
2176         $defaultuserroleid      = isset($CFG->defaultuserroleid) ? $CFG->defaultuserroleid : 0;
2177         $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid) ? $CFG->defaultfrontpageroleid : 0;
2179         $nobody = false;
2181         if ($isfrontpage) {
2182             if (!empty($prohibited[$defaultuserroleid]) or !empty($prohibited[$defaultfrontpageroleid])) {
2183                 $nobody = true;
2184             } else if (!empty($needed[$defaultuserroleid]) or !empty($needed[$defaultfrontpageroleid])) {
2185                 // everybody not having prohibit has the capability
2186                 $needed = array();
2187             } else if (empty($needed)) {
2188                 $nobody = true;
2189             }
2190         } else {
2191             if (!empty($prohibited[$defaultuserroleid])) {
2192                 $nobody = true;
2193             } else if (!empty($needed[$defaultuserroleid])) {
2194                 // everybody not having prohibit has the capability
2195                 $needed = array();
2196             } else if (empty($needed)) {
2197                 $nobody = true;
2198             }
2199         }
2201         if ($nobody) {
2202             // nobody can match so return some SQL that does not return any results
2203             $wheres[] = "1 = 2";
2205         } else {
2207             if ($needed) {
2208                 $ctxids = implode(',', $contextids);
2209                 $roleids = implode(',', array_keys($needed));
2210                 $joins[] = "JOIN {role_assignments} {$prefix}ra3 ON ({$prefix}ra3.userid = {$prefix}u.id AND {$prefix}ra3.roleid IN ($roleids) AND {$prefix}ra3.contextid IN ($ctxids))";
2211             }
2213             if ($prohibited) {
2214                 $ctxids = implode(',', $contextids);
2215                 $roleids = implode(',', array_keys($prohibited));
2216                 $joins[] = "LEFT JOIN {role_assignments} {$prefix}ra4 ON ({$prefix}ra4.userid = {$prefix}u.id AND {$prefix}ra4.roleid IN ($roleids) AND {$prefix}ra4.contextid IN ($ctxids))";
2217                 $wheres[] = "{$prefix}ra4.id IS NULL";
2218             }
2220             if ($groupid) {
2221                 $joins[] = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = {$prefix}u.id AND {$prefix}gm.groupid = :{$prefix}gmid)";
2222                 $params["{$prefix}gmid"] = $groupid;
2223             }
2224         }
2226     } else {
2227         if ($groupid) {
2228             $joins[] = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = {$prefix}u.id AND {$prefix}gm.groupid = :{$prefix}gmid)";
2229             $params["{$prefix}gmid"] = $groupid;
2230         }
2231     }
2233     $wheres[] = "{$prefix}u.deleted = 0 AND {$prefix}u.id <> :{$prefix}guestid";
2234     $params["{$prefix}guestid"] = $CFG->siteguest;
2236     if ($isfrontpage) {
2237         // all users are "enrolled" on the frontpage
2238     } else {
2239         $joins[] = "JOIN {user_enrolments} {$prefix}ue ON {$prefix}ue.userid = {$prefix}u.id";
2240         $joins[] = "JOIN {enrol} {$prefix}e ON ({$prefix}e.id = {$prefix}ue.enrolid AND {$prefix}e.courseid = :{$prefix}courseid)";
2241         $params[$prefix.'courseid'] = $coursecontext->instanceid;
2243         if ($onlyactive) {
2244             $wheres[] = "{$prefix}ue.status = :{$prefix}active AND {$prefix}e.status = :{$prefix}enabled";
2245             $wheres[] = "{$prefix}ue.timestart < :{$prefix}now1 AND ({$prefix}ue.timeend = 0 OR {$prefix}ue.timeend > :{$prefix}now2)";
2246             $now = round(time(), -2); // rounding helps caching in DB
2247             $params = array_merge($params, array($prefix.'enabled'=>ENROL_INSTANCE_ENABLED,
2248                                                  $prefix.'active'=>ENROL_USER_ACTIVE,
2249                                                  $prefix.'now1'=>$now, $prefix.'now2'=>$now));
2250         }
2251     }
2253     $joins = implode("\n", $joins);
2254     $wheres = "WHERE ".implode(" AND ", $wheres);
2256     $sql = "SELECT DISTINCT {$prefix}u.id
2257               FROM {user} {$prefix}u
2258             $joins
2259            $wheres";
2261     return array($sql, $params);
2264 /**
2265  * Returns list of users enrolled into course.
2266  *
2267  * @param context $context
2268  * @param string $withcapability
2269  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2270  * @param string $userfields requested user record fields
2271  * @param string $orderby
2272  * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
2273  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
2274  * @return array of user records
2275  */
2276 function get_enrolled_users(context $context, $withcapability = '', $groupid = 0, $userfields = 'u.*', $orderby = '', $limitfrom = 0, $limitnum = 0) {
2277     global $DB;
2279     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid);
2280     $sql = "SELECT $userfields
2281               FROM {user} u
2282               JOIN ($esql) je ON je.id = u.id
2283              WHERE u.deleted = 0";
2285     if ($orderby) {
2286         $sql = "$sql ORDER BY $orderby";
2287     } else {
2288         $sql = "$sql ORDER BY u.lastname ASC, u.firstname ASC";
2289     }
2291     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2294 /**
2295  * Counts list of users enrolled into course (as per above function)
2296  *
2297  * @param context $context
2298  * @param string $withcapability
2299  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2300  * @return array of user records
2301  */
2302 function count_enrolled_users(context $context, $withcapability = '', $groupid = 0) {
2303     global $DB;
2305     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid);
2306     $sql = "SELECT count(u.id)
2307               FROM {user} u
2308               JOIN ($esql) je ON je.id = u.id
2309              WHERE u.deleted = 0";
2311     return $DB->count_records_sql($sql, $params);
2314 /**
2315  * Loads the capability definitions for the component (from file).
2316  *
2317  * Loads the capability definitions for the component (from file). If no
2318  * capabilities are defined for the component, we simply return an empty array.
2319  *
2320  * @param string $component full plugin name, examples: 'moodle', 'mod_forum'
2321  * @return array array of capabilities
2322  */
2323 function load_capability_def($component) {
2324     $defpath = get_component_directory($component).'/db/access.php';
2326     $capabilities = array();
2327     if (file_exists($defpath)) {
2328         require($defpath);
2329         if (!empty(${$component.'_capabilities'})) {
2330             // BC capability array name
2331             // since 2.0 we prefer $capabilities instead - it is easier to use and matches db/* files
2332             debugging('componentname_capabilities array is deprecated, please use $capabilities array only in access.php files');
2333             $capabilities = ${$component.'_capabilities'};
2334         }
2335     }
2337     return $capabilities;
2340 /**
2341  * Gets the capabilities that have been cached in the database for this component.
2342  *
2343  * @param string $component - examples: 'moodle', 'mod_forum'
2344  * @return array array of capabilities
2345  */
2346 function get_cached_capabilities($component = 'moodle') {
2347     global $DB;
2348     return $DB->get_records('capabilities', array('component'=>$component));
2351 /**
2352  * Returns default capabilities for given role archetype.
2353  *
2354  * @param string $archetype role archetype
2355  * @return array
2356  */
2357 function get_default_capabilities($archetype) {
2358     global $DB;
2360     if (!$archetype) {
2361         return array();
2362     }
2364     $alldefs = array();
2365     $defaults = array();
2366     $components = array();
2367     $allcaps = $DB->get_records('capabilities');
2369     foreach ($allcaps as $cap) {
2370         if (!in_array($cap->component, $components)) {
2371             $components[] = $cap->component;
2372             $alldefs = array_merge($alldefs, load_capability_def($cap->component));
2373         }
2374     }
2375     foreach($alldefs as $name=>$def) {
2376         // Use array 'archetypes if available. Only if not specified, use 'legacy'.
2377         if (isset($def['archetypes'])) {
2378             if (isset($def['archetypes'][$archetype])) {
2379                 $defaults[$name] = $def['archetypes'][$archetype];
2380             }
2381         // 'legacy' is for backward compatibility with 1.9 access.php
2382         } else {
2383             if (isset($def['legacy'][$archetype])) {
2384                 $defaults[$name] = $def['legacy'][$archetype];
2385             }
2386         }
2387     }
2389     return $defaults;
2392 /**
2393  * Reset role capabilities to default according to selected role archetype.
2394  * If no archetype selected, removes all capabilities.
2395  *
2396  * @param int $roleid
2397  * @return void
2398  */
2399 function reset_role_capabilities($roleid) {
2400     global $DB;
2402     $role = $DB->get_record('role', array('id'=>$roleid), '*', MUST_EXIST);
2403     $defaultcaps = get_default_capabilities($role->archetype);
2405     $systemcontext = context_system::instance();
2407     $DB->delete_records('role_capabilities', array('roleid'=>$roleid));
2409     foreach($defaultcaps as $cap=>$permission) {
2410         assign_capability($cap, $permission, $roleid, $systemcontext->id);
2411     }
2414 /**
2415  * Updates the capabilities table with the component capability definitions.
2416  * If no parameters are given, the function updates the core moodle
2417  * capabilities.
2418  *
2419  * Note that the absence of the db/access.php capabilities definition file
2420  * will cause any stored capabilities for the component to be removed from
2421  * the database.
2422  *
2423  * @param string $component examples: 'moodle', 'mod/forum', 'block/quiz_results'
2424  * @return boolean true if success, exception in case of any problems
2425  */
2426 function update_capabilities($component = 'moodle') {
2427     global $DB, $OUTPUT;
2429     $storedcaps = array();
2431     $filecaps = load_capability_def($component);
2432     foreach($filecaps as $capname=>$unused) {
2433         if (!preg_match('|^[a-z]+/[a-z_0-9]+:[a-z_0-9]+$|', $capname)) {
2434             debugging("Coding problem: Invalid capability name '$capname', use 'clonepermissionsfrom' field for migration.");
2435         }
2436     }
2438     $cachedcaps = get_cached_capabilities($component);
2439     if ($cachedcaps) {
2440         foreach ($cachedcaps as $cachedcap) {
2441             array_push($storedcaps, $cachedcap->name);
2442             // update risk bitmasks and context levels in existing capabilities if needed
2443             if (array_key_exists($cachedcap->name, $filecaps)) {
2444                 if (!array_key_exists('riskbitmask', $filecaps[$cachedcap->name])) {
2445                     $filecaps[$cachedcap->name]['riskbitmask'] = 0; // no risk if not specified
2446                 }
2447                 if ($cachedcap->captype != $filecaps[$cachedcap->name]['captype']) {
2448                     $updatecap = new stdClass();
2449                     $updatecap->id = $cachedcap->id;
2450                     $updatecap->captype = $filecaps[$cachedcap->name]['captype'];
2451                     $DB->update_record('capabilities', $updatecap);
2452                 }
2453                 if ($cachedcap->riskbitmask != $filecaps[$cachedcap->name]['riskbitmask']) {
2454                     $updatecap = new stdClass();
2455                     $updatecap->id = $cachedcap->id;
2456                     $updatecap->riskbitmask = $filecaps[$cachedcap->name]['riskbitmask'];
2457                     $DB->update_record('capabilities', $updatecap);
2458                 }
2460                 if (!array_key_exists('contextlevel', $filecaps[$cachedcap->name])) {
2461                     $filecaps[$cachedcap->name]['contextlevel'] = 0; // no context level defined
2462                 }
2463                 if ($cachedcap->contextlevel != $filecaps[$cachedcap->name]['contextlevel']) {
2464                     $updatecap = new stdClass();
2465                     $updatecap->id = $cachedcap->id;
2466                     $updatecap->contextlevel = $filecaps[$cachedcap->name]['contextlevel'];
2467                     $DB->update_record('capabilities', $updatecap);
2468                 }
2469             }
2470         }
2471     }
2473     // Are there new capabilities in the file definition?
2474     $newcaps = array();
2476     foreach ($filecaps as $filecap => $def) {
2477         if (!$storedcaps ||
2478                 ($storedcaps && in_array($filecap, $storedcaps) === false)) {
2479             if (!array_key_exists('riskbitmask', $def)) {
2480                 $def['riskbitmask'] = 0; // no risk if not specified
2481             }
2482             $newcaps[$filecap] = $def;
2483         }
2484     }
2485     // Add new capabilities to the stored definition.
2486     foreach ($newcaps as $capname => $capdef) {
2487         $capability = new stdClass();
2488         $capability->name         = $capname;
2489         $capability->captype      = $capdef['captype'];
2490         $capability->contextlevel = $capdef['contextlevel'];
2491         $capability->component    = $component;
2492         $capability->riskbitmask  = $capdef['riskbitmask'];
2494         $DB->insert_record('capabilities', $capability, false);
2496         if (isset($capdef['clonepermissionsfrom']) && in_array($capdef['clonepermissionsfrom'], $storedcaps)){
2497             if ($rolecapabilities = $DB->get_records('role_capabilities', array('capability'=>$capdef['clonepermissionsfrom']))){
2498                 foreach ($rolecapabilities as $rolecapability){
2499                     //assign_capability will update rather than insert if capability exists
2500                     if (!assign_capability($capname, $rolecapability->permission,
2501                                             $rolecapability->roleid, $rolecapability->contextid, true)){
2502                          echo $OUTPUT->notification('Could not clone capabilities for '.$capname);
2503                     }
2504                 }
2505             }
2506         // we ignore archetype key if we have cloned permissions
2507         } else if (isset($capdef['archetypes']) && is_array($capdef['archetypes'])) {
2508             assign_legacy_capabilities($capname, $capdef['archetypes']);
2509         // 'legacy' is for backward compatibility with 1.9 access.php
2510         } else if (isset($capdef['legacy']) && is_array($capdef['legacy'])) {
2511             assign_legacy_capabilities($capname, $capdef['legacy']);
2512         }
2513     }
2514     // Are there any capabilities that have been removed from the file
2515     // definition that we need to delete from the stored capabilities and
2516     // role assignments?
2517     capabilities_cleanup($component, $filecaps);
2519     // reset static caches
2520     accesslib_clear_all_caches(false);
2522     return true;
2525 /**
2526  * Deletes cached capabilities that are no longer needed by the component.
2527  * Also unassigns these capabilities from any roles that have them.
2528  *
2529  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
2530  * @param array $newcapdef array of the new capability definitions that will be
2531  *                     compared with the cached capabilities
2532  * @return int number of deprecated capabilities that have been removed
2533  */
2534 function capabilities_cleanup($component, $newcapdef = null) {
2535     global $DB;
2537     $removedcount = 0;
2539     if ($cachedcaps = get_cached_capabilities($component)) {
2540         foreach ($cachedcaps as $cachedcap) {
2541             if (empty($newcapdef) ||
2542                         array_key_exists($cachedcap->name, $newcapdef) === false) {
2544                 // Remove from capabilities cache.
2545                 $DB->delete_records('capabilities', array('name'=>$cachedcap->name));
2546                 $removedcount++;
2547                 // Delete from roles.
2548                 if ($roles = get_roles_with_capability($cachedcap->name)) {
2549                     foreach($roles as $role) {
2550                         if (!unassign_capability($cachedcap->name, $role->id)) {
2551                             print_error('cannotunassigncap', 'error', '', (object)array('cap'=>$cachedcap->name, 'role'=>$role->name));
2552                         }
2553                     }
2554                 }
2555             } // End if.
2556         }
2557     }
2558     return $removedcount;
2561 /**
2562  * Returns an array of all the known types of risk
2563  * The array keys can be used, for example as CSS class names, or in calls to
2564  * print_risk_icon. The values are the corresponding RISK_ constants.
2565  *
2566  * @return array all the known types of risk.
2567  */
2568 function get_all_risks() {
2569     return array(
2570         'riskmanagetrust' => RISK_MANAGETRUST,
2571         'riskconfig'      => RISK_CONFIG,
2572         'riskxss'         => RISK_XSS,
2573         'riskpersonal'    => RISK_PERSONAL,
2574         'riskspam'        => RISK_SPAM,
2575         'riskdataloss'    => RISK_DATALOSS,
2576     );
2579 /**
2580  * Return a link to moodle docs for a given capability name
2581  *
2582  * @param object $capability a capability - a row from the mdl_capabilities table.
2583  * @return string the human-readable capability name as a link to Moodle Docs.
2584  */
2585 function get_capability_docs_link($capability) {
2586     $url = get_docs_url('Capabilities/' . $capability->name);
2587     return '<a onclick="this.target=\'docspopup\'" href="' . $url . '">' . get_capability_string($capability->name) . '</a>';
2590 /**
2591  * This function pulls out all the resolved capabilities (overrides and
2592  * defaults) of a role used in capability overrides in contexts at a given
2593  * context.
2594  *
2595  * @param context $context
2596  * @param int $roleid
2597  * @param string $cap capability, optional, defaults to ''
2598  * @return array of capabilities
2599  */
2600 function role_context_capabilities($roleid, context $context, $cap = '') {
2601     global $DB;
2603     $contexts = $context->get_parent_context_ids(true);
2604     $contexts = '('.implode(',', $contexts).')';
2606     $params = array($roleid);
2608     if ($cap) {
2609         $search = " AND rc.capability = ? ";
2610         $params[] = $cap;
2611     } else {
2612         $search = '';
2613     }
2615     $sql = "SELECT rc.*
2616               FROM {role_capabilities} rc, {context} c
2617              WHERE rc.contextid in $contexts
2618                    AND rc.roleid = ?
2619                    AND rc.contextid = c.id $search
2620           ORDER BY c.contextlevel DESC, rc.capability DESC";
2622     $capabilities = array();
2624     if ($records = $DB->get_records_sql($sql, $params)) {
2625         // We are traversing via reverse order.
2626         foreach ($records as $record) {
2627             // If not set yet (i.e. inherit or not set at all), or currently we have a prohibit
2628             if (!isset($capabilities[$record->capability]) || $record->permission<-500) {
2629                 $capabilities[$record->capability] = $record->permission;
2630             }
2631         }
2632     }
2633     return $capabilities;
2636 /**
2637  * Constructs array with contextids as first parameter and context paths,
2638  * in both cases bottom top including self.
2639  *
2640  * @private
2641  * @param context $context
2642  * @return array
2643  */
2644 function get_context_info_list(context $context) {
2645     $contextids = explode('/', ltrim($context->path, '/'));
2646     $contextpaths = array();
2647     $contextids2 = $contextids;
2648     while ($contextids2) {
2649         $contextpaths[] = '/' . implode('/', $contextids2);
2650         array_pop($contextids2);
2651     }
2652     return array($contextids, $contextpaths);
2655 /**
2656  * Check if context is the front page context or a context inside it
2657  *
2658  * Returns true if this context is the front page context, or a context inside it,
2659  * otherwise false.
2660  *
2661  * @param context $context a context object.
2662  * @return bool
2663  */
2664 function is_inside_frontpage(context $context) {
2665     $frontpagecontext = context_course::instance(SITEID);
2666     return strpos($context->path . '/', $frontpagecontext->path . '/') === 0;
2669 /**
2670  * Returns capability information (cached)
2671  *
2672  * @param string $capabilityname
2673  * @return object or null if capability not found
2674  */
2675 function get_capability_info($capabilityname) {
2676     global $ACCESSLIB_PRIVATE, $DB; // one request per page only
2678     //TODO: MUC - this could be cached in shared memory, it would eliminate 1 query per page
2680     if (empty($ACCESSLIB_PRIVATE->capabilities)) {
2681         $ACCESSLIB_PRIVATE->capabilities = array();
2682         $caps = $DB->get_records('capabilities', array(), 'id, name, captype, riskbitmask');
2683         foreach ($caps as $cap) {
2684             $capname = $cap->name;
2685             unset($cap->id);
2686             unset($cap->name);
2687             $cap->riskbitmask = (int)$cap->riskbitmask;
2688             $ACCESSLIB_PRIVATE->capabilities[$capname] = $cap;
2689         }
2690     }
2692     return isset($ACCESSLIB_PRIVATE->capabilities[$capabilityname]) ? $ACCESSLIB_PRIVATE->capabilities[$capabilityname] : null;
2695 /**
2696  * Returns the human-readable, translated version of the capability.
2697  * Basically a big switch statement.
2698  *
2699  * @param string $capabilityname e.g. mod/choice:readresponses
2700  * @return string
2701  */
2702 function get_capability_string($capabilityname) {
2704     // Typical capability name is 'plugintype/pluginname:capabilityname'
2705     list($type, $name, $capname) = preg_split('|[/:]|', $capabilityname);
2707     if ($type === 'moodle') {
2708         $component = 'core_role';
2709     } else if ($type === 'quizreport') {
2710         //ugly hack!!
2711         $component = 'quiz_'.$name;
2712     } else {
2713         $component = $type.'_'.$name;
2714     }
2716     $stringname = $name.':'.$capname;
2718     if ($component === 'core_role' or get_string_manager()->string_exists($stringname, $component)) {
2719         return get_string($stringname, $component);
2720     }
2722     $dir = get_component_directory($component);
2723     if (!file_exists($dir)) {
2724         // plugin broken or does not exist, do not bother with printing of debug message
2725         return $capabilityname.' ???';
2726     }
2728     // something is wrong in plugin, better print debug
2729     return get_string($stringname, $component);
2732 /**
2733  * This gets the mod/block/course/core etc strings.
2734  *
2735  * @param string $component
2736  * @param int $contextlevel
2737  * @return string|bool String is success, false if failed
2738  */
2739 function get_component_string($component, $contextlevel) {
2741     if ($component === 'moodle' or $component === 'core') {
2742         switch ($contextlevel) {
2743             // TODO: this should probably use context level names instead
2744             case CONTEXT_SYSTEM:    return get_string('coresystem');
2745             case CONTEXT_USER:      return get_string('users');
2746             case CONTEXT_COURSECAT: return get_string('categories');
2747             case CONTEXT_COURSE:    return get_string('course');
2748             case CONTEXT_MODULE:    return get_string('activities');
2749             case CONTEXT_BLOCK:     return get_string('block');
2750             default:                print_error('unknowncontext');
2751         }
2752     }
2754     list($type, $name) = normalize_component($component);
2755     $dir = get_plugin_directory($type, $name);
2756     if (!file_exists($dir)) {
2757         // plugin not installed, bad luck, there is no way to find the name
2758         return $component.' ???';
2759     }
2761     switch ($type) {
2762         // TODO: this is really hacky, anyway it should be probably moved to lib/pluginlib.php
2763         case 'quiz':         return get_string($name.':componentname', $component);// insane hack!!!
2764         case 'repository':   return get_string('repository', 'repository').': '.get_string('pluginname', $component);
2765         case 'gradeimport':  return get_string('gradeimport', 'grades').': '.get_string('pluginname', $component);
2766         case 'gradeexport':  return get_string('gradeexport', 'grades').': '.get_string('pluginname', $component);
2767         case 'gradereport':  return get_string('gradereport', 'grades').': '.get_string('pluginname', $component);
2768         case 'webservice':   return get_string('webservice', 'webservice').': '.get_string('pluginname', $component);
2769         case 'block':        return get_string('block').': '.get_string('pluginname', basename($component));
2770         case 'mod':
2771             if (get_string_manager()->string_exists('pluginname', $component)) {
2772                 return get_string('activity').': '.get_string('pluginname', $component);
2773             } else {
2774                 return get_string('activity').': '.get_string('modulename', $component);
2775             }
2776         default: return get_string('pluginname', $component);
2777     }
2780 /**
2781  * Gets the list of roles assigned to this context and up (parents)
2782  * from the list of roles that are visible on user profile page
2783  * and participants page.
2784  *
2785  * @param context $context
2786  * @return array
2787  */
2788 function get_profile_roles(context $context) {
2789     global $CFG, $DB;
2791     if (empty($CFG->profileroles)) {
2792         return array();
2793     }
2795     list($rallowed, $params) = $DB->get_in_or_equal(explode(',', $CFG->profileroles), SQL_PARAMS_NAMED, 'a');
2796     list($contextlist, $cparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'p');
2797     $params = array_merge($params, $cparams);
2799     $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder
2800               FROM {role_assignments} ra, {role} r
2801              WHERE r.id = ra.roleid
2802                    AND ra.contextid $contextlist
2803                    AND r.id $rallowed
2804           ORDER BY r.sortorder ASC";
2806     return $DB->get_records_sql($sql, $params);
2809 /**
2810  * Gets the list of roles assigned to this context and up (parents)
2811  *
2812  * @param context $context
2813  * @return array
2814  */
2815 function get_roles_used_in_context(context $context) {
2816     global $DB;
2818     list($contextlist, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true));
2820     $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder
2821               FROM {role_assignments} ra, {role} r
2822              WHERE r.id = ra.roleid
2823                    AND ra.contextid $contextlist
2824           ORDER BY r.sortorder ASC";
2826     return $DB->get_records_sql($sql, $params);
2829 /**
2830  * This function is used to print roles column in user profile page.
2831  * It is using the CFG->profileroles to limit the list to only interesting roles.
2832  * (The permission tab has full details of user role assignments.)
2833  *
2834  * @param int $userid
2835  * @param int $courseid
2836  * @return string
2837  */
2838 function get_user_roles_in_course($userid, $courseid) {
2839     global $CFG, $DB;
2841     if (empty($CFG->profileroles)) {
2842         return '';
2843     }
2845     if ($courseid == SITEID) {
2846         $context = context_system::instance();
2847     } else {
2848         $context = context_course::instance($courseid);
2849     }
2851     if (empty($CFG->profileroles)) {
2852         return array();
2853     }
2855     list($rallowed, $params) = $DB->get_in_or_equal(explode(',', $CFG->profileroles), SQL_PARAMS_NAMED, 'a');
2856     list($contextlist, $cparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'p');
2857     $params = array_merge($params, $cparams);
2859     $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder
2860               FROM {role_assignments} ra, {role} r
2861              WHERE r.id = ra.roleid
2862                    AND ra.contextid $contextlist
2863                    AND r.id $rallowed
2864                    AND ra.userid = :userid
2865           ORDER BY r.sortorder ASC";
2866     $params['userid'] = $userid;
2868     $rolestring = '';
2870     if ($roles = $DB->get_records_sql($sql, $params)) {
2871         foreach ($roles as $userrole) {
2872             $rolenames[$userrole->id] = $userrole->name;
2873         }
2875         $rolenames = role_fix_names($rolenames, $context);   // Substitute aliases
2877         foreach ($rolenames as $roleid => $rolename) {
2878             $rolenames[$roleid] = '<a href="'.$CFG->wwwroot.'/user/index.php?contextid='.$context->id.'&amp;roleid='.$roleid.'">'.$rolename.'</a>';
2879         }
2880         $rolestring = implode(',', $rolenames);
2881     }
2883     return $rolestring;
2886 /**
2887  * Checks if a user can assign users to a particular role in this context
2888  *
2889  * @param context $context
2890  * @param int $targetroleid - the id of the role you want to assign users to
2891  * @return boolean
2892  */
2893 function user_can_assign(context $context, $targetroleid) {
2894     global $DB;
2896     // first check if user has override capability
2897     // if not return false;
2898     if (!has_capability('moodle/role:assign', $context)) {
2899         return false;
2900     }
2901     // pull out all active roles of this user from this context(or above)
2902     if ($userroles = get_user_roles($context)) {
2903         foreach ($userroles as $userrole) {
2904             // if any in the role_allow_override table, then it's ok
2905             if ($DB->get_record('role_allow_assign', array('roleid'=>$userrole->roleid, 'allowassign'=>$targetroleid))) {
2906                 return true;
2907             }
2908         }
2909     }
2911     return false;
2914 /**
2915  * Returns all site roles in correct sort order.
2916  *
2917  * @return array
2918  */
2919 function get_all_roles() {
2920     global $DB;
2921     return $DB->get_records('role', null, 'sortorder ASC');
2924 /**
2925  * Returns roles of a specified archetype
2926  *
2927  * @param string $archetype
2928  * @return array of full role records
2929  */
2930 function get_archetype_roles($archetype) {
2931     global $DB;
2932     return $DB->get_records('role', array('archetype'=>$archetype), 'sortorder ASC');
2935 /**
2936  * Gets all the user roles assigned in this context, or higher contexts
2937  * this is mainly used when checking if a user can assign a role, or overriding a role
2938  * i.e. we need to know what this user holds, in order to verify against allow_assign and
2939  * allow_override tables
2940  *
2941  * @param context $context
2942  * @param int $userid
2943  * @param bool $checkparentcontexts defaults to true
2944  * @param string $order defaults to 'c.contextlevel DESC, r.sortorder ASC'
2945  * @return array
2946  */
2947 function get_user_roles(context $context, $userid = 0, $checkparentcontexts = true, $order = 'c.contextlevel DESC, r.sortorder ASC') {
2948     global $USER, $DB;
2950     if (empty($userid)) {
2951         if (empty($USER->id)) {
2952             return array();
2953         }
2954         $userid = $USER->id;
2955     }
2957     if ($checkparentcontexts) {
2958         $contextids = $context->get_parent_context_ids();
2959     } else {
2960         $contextids = array();
2961     }
2962     $contextids[] = $context->id;
2964     list($contextids, $params) = $DB->get_in_or_equal($contextids, SQL_PARAMS_QM);
2966     array_unshift($params, $userid);
2968     $sql = "SELECT ra.*, r.name, r.shortname
2969               FROM {role_assignments} ra, {role} r, {context} c
2970              WHERE ra.userid = ?
2971                    AND ra.roleid = r.id
2972                    AND ra.contextid = c.id
2973                    AND ra.contextid $contextids
2974           ORDER BY $order";
2976     return $DB->get_records_sql($sql ,$params);
2979 /**
2980  * Creates a record in the role_allow_override table
2981  *
2982  * @param int $sroleid source roleid
2983  * @param int $troleid target roleid
2984  * @return void
2985  */
2986 function allow_override($sroleid, $troleid) {
2987     global $DB;
2989     $record = new stdClass();
2990     $record->roleid        = $sroleid;
2991     $record->allowoverride = $troleid;
2992     $DB->insert_record('role_allow_override', $record);
2995 /**
2996  * Creates a record in the role_allow_assign table
2997  *
2998  * @param int $fromroleid source roleid
2999  * @param int $targetroleid target roleid
3000  * @return void
3001  */
3002 function allow_assign($fromroleid, $targetroleid) {
3003     global $DB;
3005     $record = new stdClass();
3006     $record->roleid      = $fromroleid;
3007     $record->allowassign = $targetroleid;
3008     $DB->insert_record('role_allow_assign', $record);
3011 /**
3012  * Creates a record in the role_allow_switch table
3013  *
3014  * @param int $fromroleid source roleid
3015  * @param int $targetroleid target roleid
3016  * @return void
3017  */
3018 function allow_switch($fromroleid, $targetroleid) {
3019     global $DB;
3021     $record = new stdClass();
3022     $record->roleid      = $fromroleid;
3023     $record->allowswitch = $targetroleid;
3024     $DB->insert_record('role_allow_switch', $record);
3027 /**
3028  * Gets a list of roles that this user can assign in this context
3029  *
3030  * @param context $context the context.
3031  * @param int $rolenamedisplay the type of role name to display. One of the
3032  *      ROLENAME_X constants. Default ROLENAME_ALIAS.
3033  * @param bool $withusercounts if true, count the number of users with each role.
3034  * @param integer|object $user A user id or object. By default (null) checks the permissions of the current user.
3035  * @return array if $withusercounts is false, then an array $roleid => $rolename.
3036  *      if $withusercounts is true, returns a list of three arrays,
3037  *      $rolenames, $rolecounts, and $nameswithcounts.
3038  */
3039 function get_assignable_roles(context $context, $rolenamedisplay = ROLENAME_ALIAS, $withusercounts = false, $user = null) {
3040     global $USER, $DB;
3042     // make sure there is a real user specified
3043     if ($user === null) {
3044         $userid = isset($USER->id) ? $USER->id : 0;
3045     } else {
3046         $userid = is_object($user) ? $user->id : $user;
3047     }
3049     if (!has_capability('moodle/role:assign', $context, $userid)) {
3050         if ($withusercounts) {
3051             return array(array(), array(), array());
3052         } else {
3053             return array();
3054         }
3055     }
3057     $parents = $context->get_parent_context_ids(true);
3058     $contexts = implode(',' , $parents);
3060     $params = array();
3061     $extrafields = '';
3062     if ($rolenamedisplay == ROLENAME_ORIGINALANDSHORT or $rolenamedisplay == ROLENAME_SHORT) {
3063         $extrafields .= ', r.shortname';
3064     }
3066     if ($withusercounts) {
3067         $extrafields = ', (SELECT count(u.id)
3068                              FROM {role_assignments} cra JOIN {user} u ON cra.userid = u.id
3069                             WHERE cra.roleid = r.id AND cra.contextid = :conid AND u.deleted = 0
3070                           ) AS usercount';
3071         $params['conid'] = $context->id;
3072     }
3074     if (is_siteadmin($userid)) {
3075         // show all roles allowed in this context to admins
3076         $assignrestriction = "";
3077     } else {
3078         $assignrestriction = "JOIN (SELECT DISTINCT raa.allowassign AS id
3079                                       FROM {role_allow_assign} raa
3080                                       JOIN {role_assignments} ra ON ra.roleid = raa.roleid
3081                                      WHERE ra.userid = :userid AND ra.contextid IN ($contexts)
3082                                    ) ar ON ar.id = r.id";
3083         $params['userid'] = $userid;
3084     }
3085     $params['contextlevel'] = $context->contextlevel;
3086     $sql = "SELECT r.id, r.name $extrafields
3087               FROM {role} r
3088               $assignrestriction
3089               JOIN {role_context_levels} rcl ON r.id = rcl.roleid
3090              WHERE rcl.contextlevel = :contextlevel
3091           ORDER BY r.sortorder ASC";
3092     $roles = $DB->get_records_sql($sql, $params);
3094     $rolenames = array();
3095     foreach ($roles as $role) {
3096         if ($rolenamedisplay == ROLENAME_SHORT) {
3097             $rolenames[$role->id] = $role->shortname;
3098             continue;
3099         }
3100         $rolenames[$role->id] = $role->name;
3101         if ($rolenamedisplay == ROLENAME_ORIGINALANDSHORT) {
3102             $rolenames[$role->id] .= ' (' . $role->shortname . ')';
3103         }
3104     }
3105     if ($rolenamedisplay != ROLENAME_ORIGINALANDSHORT and $rolenamedisplay != ROLENAME_SHORT) {
3106         $rolenames = role_fix_names($rolenames, $context, $rolenamedisplay);
3107     }
3109     if (!$withusercounts) {
3110         return $rolenames;
3111     }
3113     $rolecounts = array();
3114     $nameswithcounts = array();
3115     foreach ($roles as $role) {
3116         $nameswithcounts[$role->id] = $rolenames[$role->id] . ' (' . $roles[$role->id]->usercount . ')';
3117         $rolecounts[$role->id] = $roles[$role->id]->usercount;
3118     }
3119     return array($rolenames, $rolecounts, $nameswithcounts);
3122 /**
3123  * Gets a list of roles that this user can switch to in a context
3124  *
3125  * Gets a list of roles that this user can switch to in a context, for the switchrole menu.
3126  * This function just process the contents of the role_allow_switch table. You also need to
3127  * test the moodle/role:switchroles to see if the user is allowed to switch in the first place.
3128  *
3129  * @param context $context a context.
3130  * @return array an array $roleid => $rolename.
3131  */
3132 function get_switchable_roles(context $context) {
3133     global $USER, $DB;
3135     $params = array();
3136     $extrajoins = '';
3137     $extrawhere = '';
3138     if (!is_siteadmin()) {
3139         // Admins are allowed to switch to any role with.
3140         // Others are subject to the additional constraint that the switch-to role must be allowed by
3141         // 'role_allow_switch' for some role they have assigned in this context or any parent.
3142         $parents = $context->get_parent_context_ids(true);
3143         $contexts = implode(',' , $parents);
3145         $extrajoins = "JOIN {role_allow_switch} ras ON ras.allowswitch = rc.roleid
3146         JOIN {role_assignments} ra ON ra.roleid = ras.roleid";
3147         $extrawhere = "WHERE ra.userid = :userid AND ra.contextid IN ($contexts)";
3148         $params['userid'] = $USER->id;
3149     }
3151     $query = "
3152         SELECT r.id, r.name
3153           FROM (SELECT DISTINCT rc.roleid
3154                   FROM {role_capabilities} rc
3155                   $extrajoins
3156                   $extrawhere) idlist
3157           JOIN {role} r ON r.id = idlist.roleid
3158       ORDER BY r.sortorder";
3160     $rolenames = $DB->get_records_sql_menu($query, $params);
3161     return role_fix_names($rolenames, $context, ROLENAME_ALIAS);
3164 /**
3165  * Gets a list of roles that this user can override in this context.
3166  *
3167  * @param context $context the context.
3168  * @param int $rolenamedisplay the type of role name to display. One of the
3169  *      ROLENAME_X constants. Default ROLENAME_ALIAS.
3170  * @param bool $withcounts if true, count the number of overrides that are set for each role.
3171  * @return array if $withcounts is false, then an array $roleid => $rolename.
3172  *      if $withusercounts is true, returns a list of three arrays,
3173  *      $rolenames, $rolecounts, and $nameswithcounts.
3174  */
3175 function get_overridable_roles(context $context, $rolenamedisplay = ROLENAME_ALIAS, $withcounts = false) {
3176     global $USER, $DB;
3178     if (!has_any_capability(array('moodle/role:safeoverride', 'moodle/role:override'), $context)) {
3179         if ($withcounts) {
3180             return array(array(), array(), array());
3181         } else {
3182             return array();
3183         }
3184     }
3186     $parents = $context->get_parent_context_ids(true);
3187     $contexts = implode(',' , $parents);
3189     $params = array();
3190     $extrafields = '';
3191     if ($rolenamedisplay == ROLENAME_ORIGINALANDSHORT) {
3192         $extrafields .= ', ro.shortname';
3193     }
3195     $params['userid'] = $USER->id;
3196     if ($withcounts) {
3197         $extrafields = ', (SELECT COUNT(rc.id) FROM {role_capabilities} rc
3198                 WHERE rc.roleid = ro.id AND rc.contextid = :conid) AS overridecount';
3199         $params['conid'] = $context->id;
3200     }
3202     if (is_siteadmin()) {
3203         // show all roles to admins
3204         $roles = $DB->get_records_sql("
3205             SELECT ro.id, ro.name$extrafields
3206               FROM {role} ro
3207           ORDER BY ro.sortorder ASC", $params);
3209     } else {
3210         $roles = $DB->get_records_sql("
3211             SELECT ro.id, ro.name$extrafields
3212               FROM {role} ro
3213               JOIN (SELECT DISTINCT r.id
3214                       FROM {role} r
3215                       JOIN {role_allow_override} rao ON r.id = rao.allowoverride
3216                       JOIN {role_assignments} ra ON rao.roleid = ra.roleid
3217                      WHERE ra.userid = :userid AND ra.contextid IN ($contexts)
3218                    ) inline_view ON ro.id = inline_view.id
3219           ORDER BY ro.sortorder ASC", $params);
3220     }
3222     $rolenames = array();
3223     foreach ($roles as $role) {
3224         $rolenames[$role->id] = $role->name;
3225         if ($rolenamedisplay == ROLENAME_ORIGINALANDSHORT) {
3226             $rolenames[$role->id] .= ' (' . $role->shortname . ')';
3227         }
3228     }
3229     if ($rolenamedisplay != ROLENAME_ORIGINALANDSHORT) {
3230         $rolenames = role_fix_names($rolenames, $context, $rolenamedisplay);
3231     }
3233     if (!$withcounts) {
3234         return $rolenames;
3237     $rolecounts = array();
3238     $nameswithcounts = array();
3239     foreach ($roles as $role) {
3240         $nameswithcounts[$role->id] = $rolenames[$role->id] . ' (' . $roles[$role->id]->overridecount . ')';
3241         $rolecounts[$role->id] = $roles[$role->id]->overridecount;
3242     }
3243     return array($rolenames, $rolecounts, $nameswithcounts);
3246 /**
3247  * Create a role menu suitable for default role selection in enrol plugins.
3248  * @param context $context
3249  * @param int $addroleid current or default role - always added to list
3250  * @return array roleid=>localised role name
3251  */
3252 function get_default_enrol_roles(context $context, $addroleid = null) {
3253     global $DB;
3255     $params = array('contextlevel'=>CONTEXT_COURSE);
3256     if ($addroleid) {
3257         $addrole = "OR r.id = :addroleid";
3258         $params['addroleid'] = $addroleid;
3259     } else {
3260         $addrole = "";
3261     }
3262     $sql = "SELECT r.id, r.name
3263               FROM {role} r
3264          LEFT JOIN {role_context_levels} rcl ON (rcl.roleid = r.id AND rcl.contextlevel = :contextlevel)
3265              WHERE rcl.id IS NOT NULL $addrole
3266           ORDER BY sortorder DESC";
3268     $roles = $DB->get_records_sql_menu($sql, $params);
3269     $roles = role_fix_names($roles, $context, ROLENAME_BOTH);
3271     return $roles;
3274 /**
3275  * Return context levels where this role is assignable.
3276  * @param integer $roleid the id of a role.
3277  * @return array list of the context levels at which this role may be assigned.
3278  */
3279 function get_role_contextlevels($roleid) {
3280     global $DB;
3281     return $DB->get_records_menu('role_context_levels', array('roleid' => $roleid),
3282             'contextlevel', 'id,contextlevel');
3285 /**
3286  * Return roles suitable for assignment at the specified context level.
3287  *
3288  * NOTE: this function name looks like a typo, should be probably get_roles_for_contextlevel()
3289  *
3290  * @param integer $contextlevel a contextlevel.
3291  * @return array list of role ids that are assignable at this context level.
3292  */
3293 function get_roles_for_contextlevels($contextlevel) {
3294     global $DB;
3295     return $DB->get_records_menu('role_context_levels', array('contextlevel' => $contextlevel),
3296             '', 'id,roleid');
3299 /**
3300  * Returns default context levels where roles can be assigned.
3301  *
3302  * @param string $rolearchetype one of the role archetypes - that is, one of the keys
3303  *      from the array returned by get_role_archetypes();
3304  * @return array list of the context levels at which this type of role may be assigned by default.
3305  */
3306 function get_default_contextlevels($rolearchetype) {
3307     static $defaults = array(
3308         'manager'        => array(CONTEXT_SYSTEM, CONTEXT_COURSECAT, CONTEXT_COURSE),
3309         'coursecreator'  => array(CONTEXT_SYSTEM, CONTEXT_COURSECAT),
3310         'editingteacher' => array(CONTEXT_COURSE, CONTEXT_MODULE),
3311         'teacher'        => array(CONTEXT_COURSE, CONTEXT_MODULE),
3312         'student'        => array(CONTEXT_COURSE, CONTEXT_MODULE),
3313         'guest'          => array(),
3314         'user'           => array(),
3315         'frontpage'      => array());
3317     if (isset($defaults[$rolearchetype])) {
3318         return $defaults[$rolearchetype];
3319     } else {
3320         return array();
3321     }
3324 /**
3325  * Set the context levels at which a particular role can be assigned.
3326  * Throws exceptions in case of error.
3327  *
3328  * @param integer $roleid the id of a role.
3329  * @param array $contextlevels the context levels at which this role should be assignable,
3330  *      duplicate levels are removed.
3331  * @return void
3332  */
3333 function set_role_contextlevels($roleid, array $contextlevels) {
3334     global $DB;
3335     $DB->delete_records('role_context_levels', array('roleid' => $roleid));
3336     $rcl = new stdClass();
3337     $rcl->roleid = $roleid;
3338     $contextlevels = array_unique($contextlevels);
3339     foreach ($contextlevels as $level) {
3340         $rcl->contextlevel = $level;
3341         $DB->insert_record('role_context_levels', $rcl, false, true);
3342     }
3345 /**
3346  * Who has this capability in this context?
3347  *
3348  * This can be a very expensive call - use sparingly and keep
3349  * the results if you are going to need them again soon.
3350  *
3351  * Note if $fields is empty this function attempts to get u.*
3352  * which can get rather large - and has a serious perf impact
3353  * on some DBs.
3354  *
3355  * @param context $context
3356  * @param string|array $capability - capability name(s)
3357  * @param string $fields - fields to be pulled. The user table is aliased to 'u'. u.id MUST be included.
3358  * @param string $sort - the sort order. Default is lastaccess time.
3359  * @param mixed $limitfrom - number of records to skip (offset)
3360  * @param mixed $limitnum - number of records to fetch
3361  * @param string|array $groups - single group or array of groups - only return
3362  *               users who are in one of these group(s).
3363  * @param string|array $exceptions - list of users to exclude, comma separated or array
3364  * @param bool $doanything_ignored not used any more, admin accounts are never returned
3365  * @param bool $view_ignored - use get_enrolled_sql() instead
3366  * @param bool $useviewallgroups if $groups is set the return users who
3367  *               have capability both $capability and moodle/site:accessallgroups
3368  *               in this context, as well as users who have $capability and who are
3369  *               in $groups.
3370  * @return mixed
3371  */
3372 function get_users_by_capability(context $context, $capability, $fields = '', $sort = '', $limitfrom = '', $limitnum = '',
3373                                  $groups = '', $exceptions = '', $doanything_ignored = null, $view_ignored = null, $useviewallgroups = false) {
3374     global $CFG, $DB;
3376     $defaultuserroleid      = isset($CFG->defaultuserroleid) ? $CFG->defaultuserroleid : 0;
3377     $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid) ? $CFG->defaultfrontpageroleid : 0;
3379     $ctxids = trim($context->path, '/');
3380     $ctxids = str_replace('/', ',', $ctxids);
3382     // Context is the frontpage
3383     $iscoursepage = false; // coursepage other than fp
3384     $isfrontpage = false;
3385     if ($context->contextlevel == CONTEXT_COURSE) {
3386         if ($context->instanceid == SITEID) {
3387             $isfrontpage = true;
3388         } else {
3389             $iscoursepage = true;
3390         }
3391     }
3392     $isfrontpage = ($isfrontpage || is_inside_frontpage($context));
3394     $caps = (array)$capability;
3396     // construct list of context paths bottom-->top
3397     list($contextids, $paths) = get_context_info_list($context);
3399     // we need to find out all roles that have these capabilities either in definition or in overrides
3400     $defs = array();
3401     list($incontexts, $params) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED, 'con');
3402     list($incaps, $params2) = $DB->get_in_or_equal($caps, SQL_PARAMS_NAMED, 'cap');
3403     $params = array_merge($params, $params2);
3404     $sql = "SELECT rc.id, rc.roleid, rc.permission, rc.capability, ctx.path
3405               FROM {role_capabilities} rc
3406               JOIN {context} ctx on rc.contextid = ctx.id
3407              WHERE rc.contextid $incontexts AND rc.capability $incaps";
3409     $rcs = $DB->get_records_sql($sql, $params);
3410     foreach ($rcs as $rc) {
3411         $defs[$rc->capability][$rc->path][$rc->roleid] = $rc->permission;
3412     }
3414     // go through the permissions bottom-->top direction to evaluate the current permission,
3415     // first one wins (prohibit is an exception that always wins)
3416     $access = array();
3417     foreach ($caps as $cap) {
3418         foreach ($paths as $path) {
3419             if (empty($defs[$cap][$path])) {
3420                 continue;
3421             }
3422             foreach($defs[$cap][$path] as $roleid => $perm) {
3423                 if ($perm == CAP_PROHIBIT) {
3424                     $access[$cap][$roleid] = CAP_PROHIBIT;
3425                     continue;
3426                 }
3427                 if (!isset($access[$cap][$roleid])) {
3428                     $access[$cap][$roleid] = (int)$perm;
3429                 }
3430             }
3431         }
3432     }
3434     // make lists of roles that are needed and prohibited in this context
3435     $needed = array(); // one of these is enough
3436     $prohibited = array(); // must not have any of these
3437     foreach ($caps as $cap) {
3438         if (empty($access[$cap])) {
3439             continue;
3440         }
3441         foreach ($access[$cap] as $roleid => $perm) {
3442             if ($perm == CAP_PROHIBIT) {
3443                 unset($needed[$cap][$roleid]);
3444                 $prohibited[$cap][$roleid] = true;
3445             } else if ($perm == CAP_ALLOW and empty($prohibited[$cap][$roleid])) {
3446                 $needed[$cap][$roleid] = true;
3447             }
3448         }
3449         if (empty($needed[$cap]) or !empty($prohibited[$cap][$defaultuserroleid])) {
3450             // easy, nobody has the permission
3451             unset($needed[$cap]);
3452             unset($prohibited[$cap]);
3453         } else if ($isfrontpage and !empty($prohibited[$cap][$defaultfrontpageroleid])) {
3454             // everybody is disqualified on the frontapge
3455             unset($needed[$cap]);
3456             unset($prohibited[$cap]);
3457         }
3458         if (empty($prohibited[$cap])) {
3459             unset($prohibited[$cap]);
3460         }
3461     }
3463     if (empty($needed)) {
3464         // there can not be anybody if no roles match this request
3465         return array();
3466     }
3468     if (empty($prohibited)) {
3469         // we can compact the needed roles
3470         $n = array();
3471         foreach ($needed as $cap) {
3472             foreach ($cap as $roleid=>$unused) {
3473                 $n[$roleid] = true;
3474             }
3475         }
3476         $needed = array('any'=>$n);
3477         unset($n);
3478     }
3480     /// ***** Set up default fields ******
3481     if (empty($fields)) {
3482         if ($iscoursepage) {
3483             $fields = 'u.*, ul.timeaccess AS lastaccess';
3484         } else {
3485             $fields = 'u.*';
3486         }
3487     } else {
3488         if (debugging('', DEBUG_DEVELOPER) && strpos($fields, 'u.*') === false && strpos($fields, 'u.id') === false) {
3489             debugging('u.id must be included in the list of fields passed to get_users_by_capability().', DEBUG_DEVELOPER);
3490         }
3491     }
3493     /// Set up default sort
3494     if (empty($sort)) { // default to course lastaccess or just lastaccess
3495         if ($iscoursepage) {
3496             $sort = 'ul.timeaccess';
3497         } else {
3498             $sort = 'u.lastaccess';
3499         }
3500     }
3502     // Prepare query clauses
3503     $wherecond = array();
3504     $params    = array();
3505     $joins     = array();
3507     // User lastaccess JOIN
3508     if ((strpos($sort, 'ul.timeaccess') === false) and (strpos($fields, 'ul.timeaccess') === false)) {
3509          // user_lastaccess is not required MDL-13810
3510     } else {
3511         if ($iscoursepage) {
3512             $joins[] = "LEFT OUTER JOIN {user_lastaccess} ul ON (ul.userid = u.id AND ul.courseid = {$context->instanceid})";
3513         } else {
3514             throw new coding_exception('Invalid sort in get_users_by_capability(), ul.timeaccess allowed only for course contexts.');
3515         }
3516     }
3518     /// We never return deleted users or guest account.
3519     $wherecond[] = "u.deleted = 0 AND u.id <> :guestid";
3520     $params['guestid'] = $CFG->siteguest;
3522     /// Groups
3523     if ($groups) {
3524         $groups = (array)$groups;
3525         list($grouptest, $grpparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED, 'grp');
3526         $grouptest = "u.id IN (SELECT userid FROM {groups_members} gm WHERE gm.groupid $grouptest)";
3527         $params = array_merge($params, $grpparams);
3529         if ($useviewallgroups) {
3530             $viewallgroupsusers = get_users_by_capability($context, 'moodle/site:accessallgroups', 'u.id, u.id', '', '', '', '', $exceptions);
3531             if (!empty($viewallgroupsusers)) {
3532                 $wherecond[] =  "($grouptest OR u.id IN (" . implode(',', array_keys($viewallgroupsusers)) . '))';
3533             } else {
3534                 $wherecond[] =  "($grouptest)";
3535             }
3536         } else {
3537             $wherecond[] =  "($grouptest)";
3538         }
3539     }
3541     /// User exceptions
3542     if (!empty($exceptions)) {
3543         $exceptions = (array)$exceptions;
3544         list($exsql, $exparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'exc', false);
3545         $params = array_merge($params, $exparams);
3546         $wherecond[] = "u.id $exsql";
3547     }
3549     // now add the needed and prohibited roles conditions as joins
3550     if (!empty($needed['any'])) {
3551         // simple case - there are no prohibits involved
3552         if (!empty($needed['any'][$defaultuserroleid]) or ($isfrontpage and !empty($needed['any'][$defaultfrontpageroleid]))) {
3553             // everybody
3554         } else {
3555             $joins[] = "JOIN (SELECT DISTINCT userid
3556                                 FROM {role_assignments}
3557                                WHERE contextid IN ($ctxids)
3558                                      AND roleid IN (".implode(',', array_keys($needed['any'])) .")
3559                              ) ra ON ra.userid = u.id";
3560         }
3561     } else {
3562         $unions = array();
3563         $everybody = false;
3564         foreach ($needed as $cap=>$unused) {
3565             if (empty($prohibited[$cap])) {
3566                 if (!empty($needed[$cap][$defaultuserroleid]) or ($isfrontpage and !empty($needed[$cap][$defaultfrontpageroleid]))) {
3567                     $everybody = true;
3568                     break;
3569                 } else {
3570                     $unions[] = "SELECT userid
3571                                    FROM {role_assignments}
3572                                   WHERE contextid IN ($ctxids)
3573                                         AND roleid IN (".implode(',', array_keys($needed[$cap])) .")";
3574                 }
3575             } else {
3576                 if (!empty($prohibited[$cap][$defaultuserroleid]) or ($isfrontpage and !empty($prohibited[$cap][$defaultfrontpageroleid]))) {
3577                     // nobody can have this cap because it is prevented in default roles
3578                     continue;
3580                 } else if (!empty($needed[$cap][$defaultuserroleid]) or ($isfrontpage and !empty($needed[$cap][$defaultfrontpageroleid]))) {
3581                     // everybody except the prohibitted - hiding does not matter
3582                     $unions[] = "SELECT id AS userid
3583                                    FROM {user}
3584                                   WHERE id NOT IN (SELECT userid
3585                                                      FROM {role_assignments}
3586                                                     WHERE contextid IN ($ctxids)
3587                                                           AND roleid IN (".implode(',', array_keys($prohibited[$cap])) ."))";
3589                 } else {
3590                     $unions[] = "SELECT userid
3591                                    FROM {role_assignments}
3592                                   WHERE contextid IN ($ctxids)
3593                                         AND roleid IN (".implode(',', array_keys($needed[$cap])) .")
3594                                         AND roleid NOT IN (".implode(',', array_keys($prohibited[$cap])) .")";
3595                 }
3596             }
3597         }
3598         if (!$everybody) {
3599             if ($unions) {
3600                 $joins[] = "JOIN (SELECT DISTINCT userid FROM ( ".implode(' UNION ', $unions)." ) us) ra ON ra.userid = u.id";
3601             } else {
3602                 // only prohibits found - nobody can be matched
3603                 $wherecond[] = "1 = 2";
3604             }
3605         }
3606     }
3608     // Collect WHERE conditions and needed joins
3609     $where = implode(' AND ', $wherecond);
3610     if ($where !== '') {
3611         $where = 'WHERE ' . $where;
3612     }
3613     $joins = implode("\n", $joins);
3615     /// Ok, let's get the users!
3616     $sql = "SELECT $fields
3617               FROM {user} u
3618             $joins
3619             $where
3620           ORDER BY $sort";
3622     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
3625 /**
3626  * Re-sort a users array based on a sorting policy
3627  *
3628  * Will re-sort a $users results array (from get_users_by_capability(), usually)
3629  * based on a sorting policy. This is to support the odd practice of
3630  * sorting teachers by 'authority', where authority was "lowest id of the role
3631  * assignment".
3632  *
3633  * Will execute 1 database query. Only suitable for small numbers of users, as it
3634  * uses an u.id IN() clause.
3635  *
3636  * Notes about the sorting criteria.
3637  *
3638  * As a default, we cannot rely on role.sortorder because then
3639  * admins/coursecreators will always win. That is why the sane
3640  * rule "is locality matters most", with sortorder as 2nd
3641  * consideration.
3642  *
3643  * If you want role.sortorder, use the 'sortorder' policy, and
3644  * name explicitly what roles you want to cover. It's probably
3645  * a good idea to see what roles have the capabilities you want
3646  * (array_diff() them against roiles that have 'can-do-anything'
3647  * to weed out admin-ish roles. Or fetch a list of roles from
3648  * variables like $CFG->coursecontact .
3649  *
3650  * @param array $users Users array, keyed on userid
3651  * @param context $context
3652  * @param array $roles ids of the roles to include, optional
3653  * @param string $sortpolicy defaults to locality, more about
3654  * @return array sorted copy of the array
3655  */