5122bdb4c782198046d8fd962d3e1093070fc2fe
[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_enrolled()
37  * - is_viewing()
38  * - is_guest()
39  * - is_siteadmin()
40  * - isguestuser()
41  * - isloggedin()
42  *
43  * What courses has this user access to?
44  * - get_enrolled_users()
45  *
46  * What users can do X in this context?
47  * - get_enrolled_users() - at and bellow course context
48  * - get_users_by_capability() - above course context
49  *
50  * Modify roles
51  * - role_assign()
52  * - role_unassign()
53  * - role_unassign_all()
54  *
55  * Advanced - for internal use only
56  * - load_all_capabilities()
57  * - reload_all_capabilities()
58  * - has_capability_in_accessdata()
59  * - get_user_access_sitewide()
60  * - load_course_context()
61  * - load_role_access_by_context()
62  * - etc.
63  *
64  * <b>Name conventions</b>
65  *
66  * "ctx" means context
67  *
68  * <b>accessdata</b>
69  *
70  * Access control data is held in the "accessdata" array
71  * which - for the logged-in user, will be in $USER->access
72  *
73  * For other users can be generated and passed around (but may also be cached
74  * against userid in $ACCESSLIB_PRIVATE->accessdatabyuser).
75  *
76  * $accessdata is a multidimensional array, holding
77  * role assignments (RAs), role-capabilities-perm sets
78  * (role defs) and a list of courses we have loaded
79  * data for.
80  *
81  * Things are keyed on "contextpaths" (the path field of
82  * the context table) for fast walking up/down the tree.
83  * <code>
84  * $accessdata['ra'][$contextpath] = array($roleid=>$roleid)
85  *                  [$contextpath] = array($roleid=>$roleid)
86  *                  [$contextpath] = array($roleid=>$roleid)
87  * </code>
88  *
89  * Role definitions are stored like this
90  * (no cap merge is done - so it's compact)
91  *
92  * <code>
93  * $accessdata['rdef']["$contextpath:$roleid"]['mod/forum:viewpost'] = 1
94  *                                            ['mod/forum:editallpost'] = -1
95  *                                            ['mod/forum:startdiscussion'] = -1000
96  * </code>
97  *
98  * See how has_capability_in_accessdata() walks up the tree.
99  *
100  * First we only load rdef and ra down to the course level, but not below.
101  * This keeps accessdata small and compact. Below-the-course ra/rdef
102  * are loaded as needed. We keep track of which courses we have loaded ra/rdef in
103  * <code>
104  * $accessdata['loaded'] = array($courseid1=>1, $courseid2=>1)
105  * </code>
106  *
107  * <b>Stale accessdata</b>
108  *
109  * For the logged-in user, accessdata is long-lived.
110  *
111  * On each pageload we load $ACCESSLIB_PRIVATE->dirtycontexts which lists
112  * context paths affected by changes. Any check at-or-below
113  * a dirty context will trigger a transparent reload of accessdata.
114  *
115  * Changes at the system level will force the reload for everyone.
116  *
117  * <b>Default role caps</b>
118  * The default role assignment is not in the DB, so we
119  * add it manually to accessdata.
120  *
121  * This means that functions that work directly off the
122  * DB need to ensure that the default role caps
123  * are dealt with appropriately.
124  *
125  * @package    core_access
126  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
127  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
128  */
130 defined('MOODLE_INTERNAL') || die();
132 /** No capability change */
133 define('CAP_INHERIT', 0);
134 /** Allow permission, overrides CAP_PREVENT defined in parent contexts */
135 define('CAP_ALLOW', 1);
136 /** Prevent permission, overrides CAP_ALLOW defined in parent contexts */
137 define('CAP_PREVENT', -1);
138 /** Prohibit permission, overrides everything in current and child contexts */
139 define('CAP_PROHIBIT', -1000);
141 /** System context level - only one instance in every system */
142 define('CONTEXT_SYSTEM', 10);
143 /** User context level -  one instance for each user describing what others can do to user */
144 define('CONTEXT_USER', 30);
145 /** Course category context level - one instance for each category */
146 define('CONTEXT_COURSECAT', 40);
147 /** Course context level - one instances for each course */
148 define('CONTEXT_COURSE', 50);
149 /** Course module context level - one instance for each course module */
150 define('CONTEXT_MODULE', 70);
151 /**
152  * Block context level - one instance for each block, sticky blocks are tricky
153  * because ppl think they should be able to override them at lower contexts.
154  * Any other context level instance can be parent of block context.
155  */
156 define('CONTEXT_BLOCK', 80);
158 /** Capability allow management of trusts - NOT IMPLEMENTED YET - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
159 define('RISK_MANAGETRUST', 0x0001);
160 /** Capability allows changes in system configuration - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
161 define('RISK_CONFIG',      0x0002);
162 /** Capability allows user to add scripted content - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
163 define('RISK_XSS',         0x0004);
164 /** Capability allows access to personal user information - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
165 define('RISK_PERSONAL',    0x0008);
166 /** Capability allows users to add content others may see - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
167 define('RISK_SPAM',        0x0010);
168 /** capability allows mass delete of data belonging to other users - see {@link http://docs.moodle.org/dev/Hardening_new_Roles_system} */
169 define('RISK_DATALOSS',    0x0020);
171 /** rolename displays - the name as defined in the role definition, localised if name empty */
172 define('ROLENAME_ORIGINAL', 0);
173 /** rolename displays - the name as defined by a role alias at the course level, falls back to ROLENAME_ORIGINAL if alias not present */
174 define('ROLENAME_ALIAS', 1);
175 /** rolename displays - Both, like this:  Role alias (Original) */
176 define('ROLENAME_BOTH', 2);
177 /** rolename displays - the name as defined in the role definition and the shortname in brackets */
178 define('ROLENAME_ORIGINALANDSHORT', 3);
179 /** rolename displays - the name as defined by a role alias, in raw form suitable for editing */
180 define('ROLENAME_ALIAS_RAW', 4);
181 /** rolename displays - the name is simply short role name */
182 define('ROLENAME_SHORT', 5);
184 if (!defined('CONTEXT_CACHE_MAX_SIZE')) {
185     /** maximum size of context cache - it is possible to tweak this config.php or in any script before inclusion of context.php */
186     define('CONTEXT_CACHE_MAX_SIZE', 2500);
189 /**
190  * Although this looks like a global variable, it isn't really.
191  *
192  * It is just a private implementation detail to accesslib that MUST NOT be used elsewhere.
193  * It is used to cache various bits of data between function calls for performance reasons.
194  * Sadly, a PHP global variable is the only way to implement this, without rewriting everything
195  * as methods of a class, instead of functions.
196  *
197  * @access private
198  * @global stdClass $ACCESSLIB_PRIVATE
199  * @name $ACCESSLIB_PRIVATE
200  */
201 global $ACCESSLIB_PRIVATE;
202 $ACCESSLIB_PRIVATE = new stdClass();
203 $ACCESSLIB_PRIVATE->dirtycontexts    = null;    // Dirty contexts cache, loaded from DB once per page
204 $ACCESSLIB_PRIVATE->accessdatabyuser = array(); // Holds the cache of $accessdata structure for users (including $USER)
205 $ACCESSLIB_PRIVATE->rolepermissions  = array(); // role permissions cache - helps a lot with mem usage
206 $ACCESSLIB_PRIVATE->capabilities     = null;    // detailed information about the capabilities
208 /**
209  * Clears accesslib's private caches. ONLY BE USED BY UNIT TESTS
210  *
211  * This method should ONLY BE USED BY UNIT TESTS. It clears all of
212  * accesslib's private caches. You need to do this before setting up test data,
213  * and also at the end of the tests.
214  *
215  * @access private
216  * @return void
217  */
218 function accesslib_clear_all_caches_for_unit_testing() {
219     global $USER;
220     if (!PHPUNIT_TEST) {
221         throw new coding_exception('You must not call clear_all_caches outside of unit tests.');
222     }
224     accesslib_clear_all_caches(true);
226     unset($USER->access);
229 /**
230  * Clears accesslib's private caches. ONLY BE USED FROM THIS LIBRARY FILE!
231  *
232  * This reset does not touch global $USER.
233  *
234  * @access private
235  * @param bool $resetcontexts
236  * @return void
237  */
238 function accesslib_clear_all_caches($resetcontexts) {
239     global $ACCESSLIB_PRIVATE;
241     $ACCESSLIB_PRIVATE->dirtycontexts    = null;
242     $ACCESSLIB_PRIVATE->accessdatabyuser = array();
243     $ACCESSLIB_PRIVATE->rolepermissions  = array();
244     $ACCESSLIB_PRIVATE->capabilities     = null;
246     if ($resetcontexts) {
247         context_helper::reset_caches();
248     }
251 /**
252  * Gets the accessdata for role "sitewide" (system down to course)
253  *
254  * @access private
255  * @param int $roleid
256  * @return array
257  */
258 function get_role_access($roleid) {
259     global $DB, $ACCESSLIB_PRIVATE;
261     /* Get it in 1 DB query...
262      * - relevant role caps at the root and down
263      *   to the course level - but not below
264      */
266     //TODO: MUC - this could be cached in shared memory to speed up first page loading, web crawlers, etc.
268     $accessdata = get_empty_accessdata();
270     $accessdata['ra']['/'.SYSCONTEXTID] = array((int)$roleid => (int)$roleid);
272     // Overrides for the role IN ANY CONTEXTS down to COURSE - not below -.
274     /*
275     $sql = "SELECT ctx.path,
276                    rc.capability, rc.permission
277               FROM {context} ctx
278               JOIN {role_capabilities} rc ON rc.contextid = ctx.id
279          LEFT JOIN {context} cctx
280                    ON (cctx.contextlevel = ".CONTEXT_COURSE." AND ctx.path LIKE ".$DB->sql_concat('cctx.path',"'/%'").")
281              WHERE rc.roleid = ? AND cctx.id IS NULL";
282     $params = array($roleid);
283     */
285     // Note: the commented out query is 100% accurate but slow, so let's cheat instead by hardcoding the blocks mess directly.
287     $sql = "SELECT COALESCE(ctx.path, bctx.path) AS path, rc.capability, rc.permission
288               FROM {role_capabilities} rc
289          LEFT JOIN {context} ctx ON (ctx.id = rc.contextid AND ctx.contextlevel <= ".CONTEXT_COURSE.")
290          LEFT JOIN ({context} bctx
291                     JOIN {block_instances} bi ON (bi.id = bctx.instanceid)
292                     JOIN {context} pctx ON (pctx.id = bi.parentcontextid AND pctx.contextlevel < ".CONTEXT_COURSE.")
293                    ) ON (bctx.id = rc.contextid AND bctx.contextlevel = ".CONTEXT_BLOCK.")
294              WHERE rc.roleid = :roleid AND (ctx.id IS NOT NULL OR bctx.id IS NOT NULL)";
295     $params = array('roleid'=>$roleid);
297     // we need extra caching in CLI scripts and cron
298     $rs = $DB->get_recordset_sql($sql, $params);
299     foreach ($rs as $rd) {
300         $k = "{$rd->path}:{$roleid}";
301         $accessdata['rdef'][$k][$rd->capability] = (int)$rd->permission;
302     }
303     $rs->close();
305     // share the role definitions
306     foreach ($accessdata['rdef'] as $k=>$unused) {
307         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
308             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $accessdata['rdef'][$k];
309         }
310         $accessdata['rdef_count']++;
311         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
312     }
314     return $accessdata;
317 /**
318  * Get the default guest role, this is used for guest account,
319  * search engine spiders, etc.
320  *
321  * @return stdClass role record
322  */
323 function get_guest_role() {
324     global $CFG, $DB;
326     if (empty($CFG->guestroleid)) {
327         if ($roles = $DB->get_records('role', array('archetype'=>'guest'))) {
328             $guestrole = array_shift($roles);   // Pick the first one
329             set_config('guestroleid', $guestrole->id);
330             return $guestrole;
331         } else {
332             debugging('Can not find any guest role!');
333             return false;
334         }
335     } else {
336         if ($guestrole = $DB->get_record('role', array('id'=>$CFG->guestroleid))) {
337             return $guestrole;
338         } else {
339             // somebody is messing with guest roles, remove incorrect setting and try to find a new one
340             set_config('guestroleid', '');
341             return get_guest_role();
342         }
343     }
346 /**
347  * Check whether a user has a particular capability in a given context.
348  *
349  * For example:
350  *      $context = context_module::instance($cm->id);
351  *      has_capability('mod/forum:replypost', $context)
352  *
353  * By default checks the capabilities of the current user, but you can pass a
354  * different userid. By default will return true for admin users, but you can override that with the fourth argument.
355  *
356  * Guest and not-logged-in users can never get any dangerous capability - that is any write capability
357  * or capabilities with XSS, config or data loss risks.
358  *
359  * @category access
360  *
361  * @param string $capability the name of the capability to check. For example mod/forum:view
362  * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
363  * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
364  * @param boolean $doanything If false, ignores effect of admin role assignment
365  * @return boolean true if the user has this capability. Otherwise false.
366  */
367 function has_capability($capability, context $context, $user = null, $doanything = true) {
368     global $USER, $CFG, $SCRIPT, $ACCESSLIB_PRIVATE;
370     if (during_initial_install()) {
371         if ($SCRIPT === "/$CFG->admin/index.php" or $SCRIPT === "/$CFG->admin/cli/install.php" or $SCRIPT === "/$CFG->admin/cli/install_database.php") {
372             // we are in an installer - roles can not work yet
373             return true;
374         } else {
375             return false;
376         }
377     }
379     if (strpos($capability, 'moodle/legacy:') === 0) {
380         throw new coding_exception('Legacy capabilities can not be used any more!');
381     }
383     if (!is_bool($doanything)) {
384         throw new coding_exception('Capability parameter "doanything" is wierd, only true or false is allowed. This has to be fixed in code.');
385     }
387     // capability must exist
388     if (!$capinfo = get_capability_info($capability)) {
389         debugging('Capability "'.$capability.'" was not found! This has to be fixed in code.');
390         return false;
391     }
393     if (!isset($USER->id)) {
394         // should never happen
395         $USER->id = 0;
396         debugging('Capability check being performed on a user with no ID.', DEBUG_DEVELOPER);
397     }
399     // make sure there is a real user specified
400     if ($user === null) {
401         $userid = $USER->id;
402     } else {
403         $userid = is_object($user) ? $user->id : $user;
404     }
406     // make sure forcelogin cuts off not-logged-in users if enabled
407     if (!empty($CFG->forcelogin) and $userid == 0) {
408         return false;
409     }
411     // make sure the guest account and not-logged-in users never get any risky caps no matter what the actual settings are.
412     if (($capinfo->captype === 'write') or ($capinfo->riskbitmask & (RISK_XSS | RISK_CONFIG | RISK_DATALOSS))) {
413         if (isguestuser($userid) or $userid == 0) {
414             return false;
415         }
416     }
418     // somehow make sure the user is not deleted and actually exists
419     if ($userid != 0) {
420         if ($userid == $USER->id and isset($USER->deleted)) {
421             // this prevents one query per page, it is a bit of cheating,
422             // but hopefully session is terminated properly once user is deleted
423             if ($USER->deleted) {
424                 return false;
425             }
426         } else {
427             if (!context_user::instance($userid, IGNORE_MISSING)) {
428                 // no user context == invalid userid
429                 return false;
430             }
431         }
432     }
434     // context path/depth must be valid
435     if (empty($context->path) or $context->depth == 0) {
436         // this should not happen often, each upgrade tries to rebuild the context paths
437         debugging('Context id '.$context->id.' does not have valid path, please use build_context_path()');
438         if (is_siteadmin($userid)) {
439             return true;
440         } else {
441             return false;
442         }
443     }
445     // Find out if user is admin - it is not possible to override the doanything in any way
446     // and it is not possible to switch to admin role either.
447     if ($doanything) {
448         if (is_siteadmin($userid)) {
449             if ($userid != $USER->id) {
450                 return true;
451             }
452             // make sure switchrole is not used in this context
453             if (empty($USER->access['rsw'])) {
454                 return true;
455             }
456             $parts = explode('/', trim($context->path, '/'));
457             $path = '';
458             $switched = false;
459             foreach ($parts as $part) {
460                 $path .= '/' . $part;
461                 if (!empty($USER->access['rsw'][$path])) {
462                     $switched = true;
463                     break;
464                 }
465             }
466             if (!$switched) {
467                 return true;
468             }
469             //ok, admin switched role in this context, let's use normal access control rules
470         }
471     }
473     // Careful check for staleness...
474     $context->reload_if_dirty();
476     if ($USER->id == $userid) {
477         if (!isset($USER->access)) {
478             load_all_capabilities();
479         }
480         $access =& $USER->access;
482     } else {
483         // make sure user accessdata is really loaded
484         get_user_accessdata($userid, true);
485         $access =& $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
486     }
489     // Load accessdata for below-the-course context if necessary,
490     // all contexts at and above all courses are already loaded
491     if ($context->contextlevel != CONTEXT_COURSE and $coursecontext = $context->get_course_context(false)) {
492         load_course_context($userid, $coursecontext, $access);
493     }
495     return has_capability_in_accessdata($capability, $context, $access);
498 /**
499  * Check if the user has any one of several capabilities from a list.
500  *
501  * This is just a utility method that calls has_capability in a loop. Try to put
502  * the capabilities that most users are likely to have first in the list for best
503  * performance.
504  *
505  * @category access
506  * @see has_capability()
507  *
508  * @param array $capabilities an array of capability names.
509  * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
510  * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
511  * @param boolean $doanything If false, ignore effect of admin role assignment
512  * @return boolean true if the user has any of these capabilities. Otherwise false.
513  */
514 function has_any_capability(array $capabilities, context $context, $user = null, $doanything = true) {
515     foreach ($capabilities as $capability) {
516         if (has_capability($capability, $context, $user, $doanything)) {
517             return true;
518         }
519     }
520     return false;
523 /**
524  * Check if the user has all the capabilities in a list.
525  *
526  * This is just a utility method that calls has_capability in a loop. Try to put
527  * the capabilities that fewest users are likely to have first in the list for best
528  * performance.
529  *
530  * @category access
531  * @see has_capability()
532  *
533  * @param array $capabilities an array of capability names.
534  * @param context $context the context to check the capability in. You normally get this with instance method of a context class.
535  * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
536  * @param boolean $doanything If false, ignore effect of admin role assignment
537  * @return boolean true if the user has all of these capabilities. Otherwise false.
538  */
539 function has_all_capabilities(array $capabilities, context $context, $user = null, $doanything = true) {
540     foreach ($capabilities as $capability) {
541         if (!has_capability($capability, $context, $user, $doanything)) {
542             return false;
543         }
544     }
545     return true;
548 /**
549  * Is course creator going to have capability in a new course?
550  *
551  * This is intended to be used in enrolment plugins before or during course creation,
552  * do not use after the course is fully created.
553  *
554  * @category access
555  *
556  * @param string $capability the name of the capability to check.
557  * @param context $context course or category context where is course going to be created
558  * @param integer|stdClass $user A user id or object. By default (null) checks the permissions of the current user.
559  * @return boolean true if the user will have this capability.
560  *
561  * @throws coding_exception if different type of context submitted
562  */
563 function guess_if_creator_will_have_course_capability($capability, context $context, $user = null) {
564     global $CFG;
566     if ($context->contextlevel != CONTEXT_COURSE and $context->contextlevel != CONTEXT_COURSECAT) {
567         throw new coding_exception('Only course or course category context expected');
568     }
570     if (has_capability($capability, $context, $user)) {
571         // User already has the capability, it could be only removed if CAP_PROHIBIT
572         // was involved here, but we ignore that.
573         return true;
574     }
576     if (!has_capability('moodle/course:create', $context, $user)) {
577         return false;
578     }
580     if (!enrol_is_enabled('manual')) {
581         return false;
582     }
584     if (empty($CFG->creatornewroleid)) {
585         return false;
586     }
588     if ($context->contextlevel == CONTEXT_COURSE) {
589         if (is_viewing($context, $user, 'moodle/role:assign') or is_enrolled($context, $user, 'moodle/role:assign')) {
590             return false;
591         }
592     } else {
593         if (has_capability('moodle/course:view', $context, $user) and has_capability('moodle/role:assign', $context, $user)) {
594             return false;
595         }
596     }
598     // Most likely they will be enrolled after the course creation is finished,
599     // does the new role have the required capability?
600     list($neededroles, $forbiddenroles) = get_roles_with_cap_in_context($context, $capability);
601     return isset($neededroles[$CFG->creatornewroleid]);
604 /**
605  * Check if the user is an admin at the site level.
606  *
607  * Please note that use of proper capabilities is always encouraged,
608  * this function is supposed to be used from core or for temporary hacks.
609  *
610  * @category access
611  *
612  * @param  int|stdClass  $user_or_id user id or user object
613  * @return bool true if user is one of the administrators, false otherwise
614  */
615 function is_siteadmin($user_or_id = null) {
616     global $CFG, $USER;
618     if ($user_or_id === null) {
619         $user_or_id = $USER;
620     }
622     if (empty($user_or_id)) {
623         return false;
624     }
625     if (!empty($user_or_id->id)) {
626         $userid = $user_or_id->id;
627     } else {
628         $userid = $user_or_id;
629     }
631     // Because this script is called many times (150+ for course page) with
632     // the same parameters, it is worth doing minor optimisations. This static
633     // cache stores the value for a single userid, saving about 2ms from course
634     // page load time without using significant memory. As the static cache
635     // also includes the value it depends on, this cannot break unit tests.
636     static $knownid, $knownresult, $knownsiteadmins;
637     if ($knownid === $userid && $knownsiteadmins === $CFG->siteadmins) {
638         return $knownresult;
639     }
640     $knownid = $userid;
641     $knownsiteadmins = $CFG->siteadmins;
643     $siteadmins = explode(',', $CFG->siteadmins);
644     $knownresult = in_array($userid, $siteadmins);
645     return $knownresult;
648 /**
649  * Returns true if user has at least one role assign
650  * of 'coursecontact' role (is potentially listed in some course descriptions).
651  *
652  * @param int $userid
653  * @return bool
654  */
655 function has_coursecontact_role($userid) {
656     global $DB, $CFG;
658     if (empty($CFG->coursecontact)) {
659         return false;
660     }
661     $sql = "SELECT 1
662               FROM {role_assignments}
663              WHERE userid = :userid AND roleid IN ($CFG->coursecontact)";
664     return $DB->record_exists_sql($sql, array('userid'=>$userid));
667 /**
668  * Does the user have a capability to do something?
669  *
670  * Walk the accessdata array and return true/false.
671  * Deals with prohibits, role switching, aggregating
672  * capabilities, etc.
673  *
674  * The main feature of here is being FAST and with no
675  * side effects.
676  *
677  * Notes:
678  *
679  * Switch Role merges with default role
680  * ------------------------------------
681  * If you are a teacher in course X, you have at least
682  * teacher-in-X + defaultloggedinuser-sitewide. So in the
683  * course you'll have techer+defaultloggedinuser.
684  * We try to mimic that in switchrole.
685  *
686  * Permission evaluation
687  * ---------------------
688  * Originally there was an extremely complicated way
689  * to determine the user access that dealt with
690  * "locality" or role assignments and role overrides.
691  * Now we simply evaluate access for each role separately
692  * and then verify if user has at least one role with allow
693  * and at the same time no role with prohibit.
694  *
695  * @access private
696  * @param string $capability
697  * @param context $context
698  * @param array $accessdata
699  * @return bool
700  */
701 function has_capability_in_accessdata($capability, context $context, array &$accessdata) {
702     global $CFG;
704     // Build $paths as a list of current + all parent "paths" with order bottom-to-top
705     $path = $context->path;
706     $paths = array($path);
707     while($path = rtrim($path, '0123456789')) {
708         $path = rtrim($path, '/');
709         if ($path === '') {
710             break;
711         }
712         $paths[] = $path;
713     }
715     $roles = array();
716     $switchedrole = false;
718     // Find out if role switched
719     if (!empty($accessdata['rsw'])) {
720         // From the bottom up...
721         foreach ($paths as $path) {
722             if (isset($accessdata['rsw'][$path])) {
723                 // Found a switchrole assignment - check for that role _plus_ the default user role
724                 $roles = array($accessdata['rsw'][$path]=>null, $CFG->defaultuserroleid=>null);
725                 $switchedrole = true;
726                 break;
727             }
728         }
729     }
731     if (!$switchedrole) {
732         // get all users roles in this context and above
733         foreach ($paths as $path) {
734             if (isset($accessdata['ra'][$path])) {
735                 foreach ($accessdata['ra'][$path] as $roleid) {
736                     $roles[$roleid] = null;
737                 }
738             }
739         }
740     }
742     // Now find out what access is given to each role, going bottom-->up direction
743     $allowed = false;
744     foreach ($roles as $roleid => $ignored) {
745         foreach ($paths as $path) {
746             if (isset($accessdata['rdef']["{$path}:$roleid"][$capability])) {
747                 $perm = (int)$accessdata['rdef']["{$path}:$roleid"][$capability];
748                 if ($perm === CAP_PROHIBIT) {
749                     // any CAP_PROHIBIT found means no permission for the user
750                     return false;
751                 }
752                 if (is_null($roles[$roleid])) {
753                     $roles[$roleid] = $perm;
754                 }
755             }
756         }
757         // CAP_ALLOW in any role means the user has a permission, we continue only to detect prohibits
758         $allowed = ($allowed or $roles[$roleid] === CAP_ALLOW);
759     }
761     return $allowed;
764 /**
765  * A convenience function that tests has_capability, and displays an error if
766  * the user does not have that capability.
767  *
768  * NOTE before Moodle 2.0, this function attempted to make an appropriate
769  * require_login call before checking the capability. This is no longer the case.
770  * You must call require_login (or one of its variants) if you want to check the
771  * user is logged in, before you call this function.
772  *
773  * @see has_capability()
774  *
775  * @param string $capability the name of the capability to check. For example mod/forum:view
776  * @param context $context the context to check the capability in. You normally get this with context_xxxx::instance().
777  * @param int $userid A user id. By default (null) checks the permissions of the current user.
778  * @param bool $doanything If false, ignore effect of admin role assignment
779  * @param string $errormessage The error string to to user. Defaults to 'nopermissions'.
780  * @param string $stringfile The language file to load the error string from. Defaults to 'error'.
781  * @return void terminates with an error if the user does not have the given capability.
782  */
783 function require_capability($capability, context $context, $userid = null, $doanything = true,
784                             $errormessage = 'nopermissions', $stringfile = '') {
785     if (!has_capability($capability, $context, $userid, $doanything)) {
786         throw new required_capability_exception($context, $capability, $errormessage, $stringfile);
787     }
790 /**
791  * Return a nested array showing role assignments
792  * all relevant role capabilities for the user at
793  * site/course_category/course levels
794  *
795  * We do _not_ delve deeper than courses because the number of
796  * overrides at the module/block levels can be HUGE.
797  *
798  * [ra]   => [/path][roleid]=roleid
799  * [rdef] => [/path:roleid][capability]=permission
800  *
801  * @access private
802  * @param int $userid - the id of the user
803  * @return array access info array
804  */
805 function get_user_access_sitewide($userid) {
806     global $CFG, $DB, $ACCESSLIB_PRIVATE;
808     /* Get in a few cheap DB queries...
809      * - role assignments
810      * - relevant role caps
811      *   - above and within this user's RAs
812      *   - below this user's RAs - limited to course level
813      */
815     // raparents collects paths & roles we need to walk up the parenthood to build the minimal rdef
816     $raparents = array();
817     $accessdata = get_empty_accessdata();
819     // start with the default role
820     if (!empty($CFG->defaultuserroleid)) {
821         $syscontext = context_system::instance();
822         $accessdata['ra'][$syscontext->path][(int)$CFG->defaultuserroleid] = (int)$CFG->defaultuserroleid;
823         $raparents[$CFG->defaultuserroleid][$syscontext->id] = $syscontext->id;
824     }
826     // load the "default frontpage role"
827     if (!empty($CFG->defaultfrontpageroleid)) {
828         $frontpagecontext = context_course::instance(get_site()->id);
829         if ($frontpagecontext->path) {
830             $accessdata['ra'][$frontpagecontext->path][(int)$CFG->defaultfrontpageroleid] = (int)$CFG->defaultfrontpageroleid;
831             $raparents[$CFG->defaultfrontpageroleid][$frontpagecontext->id] = $frontpagecontext->id;
832         }
833     }
835     // preload every assigned role at and above course context
836     $sql = "SELECT ctx.path, ra.roleid, ra.contextid
837               FROM {role_assignments} ra
838               JOIN {context} ctx
839                    ON ctx.id = ra.contextid
840          LEFT JOIN {block_instances} bi
841                    ON (ctx.contextlevel = ".CONTEXT_BLOCK." AND bi.id = ctx.instanceid)
842          LEFT JOIN {context} bpctx
843                    ON (bpctx.id = bi.parentcontextid)
844              WHERE ra.userid = :userid
845                    AND (ctx.contextlevel <= ".CONTEXT_COURSE." OR bpctx.contextlevel < ".CONTEXT_COURSE.")";
846     $params = array('userid'=>$userid);
847     $rs = $DB->get_recordset_sql($sql, $params);
848     foreach ($rs as $ra) {
849         // RAs leafs are arrays to support multi-role assignments...
850         $accessdata['ra'][$ra->path][(int)$ra->roleid] = (int)$ra->roleid;
851         $raparents[$ra->roleid][$ra->contextid] = $ra->contextid;
852     }
853     $rs->close();
855     if (empty($raparents)) {
856         return $accessdata;
857     }
859     // now get overrides of interesting roles in all interesting child contexts
860     // hopefully we will not run out of SQL limits here,
861     // users would have to have very many roles at/above course context...
862     $sqls = array();
863     $params = array();
865     static $cp = 0;
866     foreach ($raparents as $roleid=>$ras) {
867         $cp++;
868         list($sqlcids, $cids) = $DB->get_in_or_equal($ras, SQL_PARAMS_NAMED, 'c'.$cp.'_');
869         $params = array_merge($params, $cids);
870         $params['r'.$cp] = $roleid;
871         $sqls[] = "(SELECT ctx.path, rc.roleid, rc.capability, rc.permission
872                      FROM {role_capabilities} rc
873                      JOIN {context} ctx
874                           ON (ctx.id = rc.contextid)
875                      JOIN {context} pctx
876                           ON (pctx.id $sqlcids
877                               AND (ctx.id = pctx.id
878                                    OR ctx.path LIKE ".$DB->sql_concat('pctx.path',"'/%'")."
879                                    OR pctx.path LIKE ".$DB->sql_concat('ctx.path',"'/%'")."))
880                 LEFT JOIN {block_instances} bi
881                           ON (ctx.contextlevel = ".CONTEXT_BLOCK." AND bi.id = ctx.instanceid)
882                 LEFT JOIN {context} bpctx
883                           ON (bpctx.id = bi.parentcontextid)
884                     WHERE rc.roleid = :r{$cp}
885                           AND (ctx.contextlevel <= ".CONTEXT_COURSE." OR bpctx.contextlevel < ".CONTEXT_COURSE.")
886                    )";
887     }
889     // fixed capability order is necessary for rdef dedupe
890     $rs = $DB->get_recordset_sql(implode("\nUNION\n", $sqls). "ORDER BY capability", $params);
892     foreach ($rs as $rd) {
893         $k = $rd->path.':'.$rd->roleid;
894         $accessdata['rdef'][$k][$rd->capability] = (int)$rd->permission;
895     }
896     $rs->close();
898     // share the role definitions
899     foreach ($accessdata['rdef'] as $k=>$unused) {
900         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
901             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $accessdata['rdef'][$k];
902         }
903         $accessdata['rdef_count']++;
904         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
905     }
907     return $accessdata;
910 /**
911  * Add to the access ctrl array the data needed by a user for a given course.
912  *
913  * This function injects all course related access info into the accessdata array.
914  *
915  * @access private
916  * @param int $userid the id of the user
917  * @param context_course $coursecontext course context
918  * @param array $accessdata accessdata array (modified)
919  * @return void modifies $accessdata parameter
920  */
921 function load_course_context($userid, context_course $coursecontext, &$accessdata) {
922     global $DB, $CFG, $ACCESSLIB_PRIVATE;
924     if (empty($coursecontext->path)) {
925         // weird, this should not happen
926         return;
927     }
929     if (isset($accessdata['loaded'][$coursecontext->instanceid])) {
930         // already loaded, great!
931         return;
932     }
934     $roles = array();
936     if (empty($userid)) {
937         if (!empty($CFG->notloggedinroleid)) {
938             $roles[$CFG->notloggedinroleid] = $CFG->notloggedinroleid;
939         }
941     } else if (isguestuser($userid)) {
942         if ($guestrole = get_guest_role()) {
943             $roles[$guestrole->id] = $guestrole->id;
944         }
946     } else {
947         // Interesting role assignments at, above and below the course context
948         list($parentsaself, $params) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'pc_');
949         $params['userid'] = $userid;
950         $params['children'] = $coursecontext->path."/%";
951         $sql = "SELECT ra.*, ctx.path
952                   FROM {role_assignments} ra
953                   JOIN {context} ctx ON ra.contextid = ctx.id
954                  WHERE ra.userid = :userid AND (ctx.id $parentsaself OR ctx.path LIKE :children)";
955         $rs = $DB->get_recordset_sql($sql, $params);
957         // add missing role definitions
958         foreach ($rs as $ra) {
959             $accessdata['ra'][$ra->path][(int)$ra->roleid] = (int)$ra->roleid;
960             $roles[$ra->roleid] = $ra->roleid;
961         }
962         $rs->close();
964         // add the "default frontpage role" when on the frontpage
965         if (!empty($CFG->defaultfrontpageroleid)) {
966             $frontpagecontext = context_course::instance(get_site()->id);
967             if ($frontpagecontext->id == $coursecontext->id) {
968                 $roles[$CFG->defaultfrontpageroleid] = $CFG->defaultfrontpageroleid;
969             }
970         }
972         // do not forget the default role
973         if (!empty($CFG->defaultuserroleid)) {
974             $roles[$CFG->defaultuserroleid] = $CFG->defaultuserroleid;
975         }
976     }
978     if (!$roles) {
979         // weird, default roles must be missing...
980         $accessdata['loaded'][$coursecontext->instanceid] = 1;
981         return;
982     }
984     // now get overrides of interesting roles in all interesting contexts (this course + children + parents)
985     $params = array('c'=>$coursecontext->id);
986     list($parentsaself, $rparams) = $DB->get_in_or_equal($coursecontext->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'pc_');
987     $params = array_merge($params, $rparams);
988     list($roleids, $rparams) = $DB->get_in_or_equal($roles, SQL_PARAMS_NAMED, 'r_');
989     $params = array_merge($params, $rparams);
991     $sql = "SELECT ctx.path, rc.roleid, rc.capability, rc.permission
992                  FROM {role_capabilities} rc
993                  JOIN {context} ctx
994                       ON (ctx.id = rc.contextid)
995                  JOIN {context} cctx
996                       ON (cctx.id = :c
997                           AND (ctx.id $parentsaself OR ctx.path LIKE ".$DB->sql_concat('cctx.path',"'/%'")."))
998                 WHERE rc.roleid $roleids
999              ORDER BY rc.capability"; // fixed capability order is necessary for rdef dedupe
1000     $rs = $DB->get_recordset_sql($sql, $params);
1002     $newrdefs = array();
1003     foreach ($rs as $rd) {
1004         $k = $rd->path.':'.$rd->roleid;
1005         if (isset($accessdata['rdef'][$k])) {
1006             continue;
1007         }
1008         $newrdefs[$k][$rd->capability] = (int)$rd->permission;
1009     }
1010     $rs->close();
1012     // share new role definitions
1013     foreach ($newrdefs as $k=>$unused) {
1014         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
1015             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $newrdefs[$k];
1016         }
1017         $accessdata['rdef_count']++;
1018         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
1019     }
1021     $accessdata['loaded'][$coursecontext->instanceid] = 1;
1023     // we want to deduplicate the USER->access from time to time, this looks like a good place,
1024     // because we have to do it before the end of session
1025     dedupe_user_access();
1028 /**
1029  * Add to the access ctrl array the data needed by a role for a given context.
1030  *
1031  * The data is added in the rdef key.
1032  * This role-centric function is useful for role_switching
1033  * and temporary course roles.
1034  *
1035  * @access private
1036  * @param int $roleid the id of the user
1037  * @param context $context needs path!
1038  * @param array $accessdata accessdata array (is modified)
1039  * @return array
1040  */
1041 function load_role_access_by_context($roleid, context $context, &$accessdata) {
1042     global $DB, $ACCESSLIB_PRIVATE;
1044     /* Get the relevant rolecaps into rdef
1045      * - relevant role caps
1046      *   - at ctx and above
1047      *   - below this ctx
1048      */
1050     if (empty($context->path)) {
1051         // weird, this should not happen
1052         return;
1053     }
1055     list($parentsaself, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'pc_');
1056     $params['roleid'] = $roleid;
1057     $params['childpath'] = $context->path.'/%';
1059     $sql = "SELECT ctx.path, rc.capability, rc.permission
1060               FROM {role_capabilities} rc
1061               JOIN {context} ctx ON (rc.contextid = ctx.id)
1062              WHERE rc.roleid = :roleid AND (ctx.id $parentsaself OR ctx.path LIKE :childpath)
1063           ORDER BY rc.capability"; // fixed capability order is necessary for rdef dedupe
1064     $rs = $DB->get_recordset_sql($sql, $params);
1066     $newrdefs = array();
1067     foreach ($rs as $rd) {
1068         $k = $rd->path.':'.$roleid;
1069         if (isset($accessdata['rdef'][$k])) {
1070             continue;
1071         }
1072         $newrdefs[$k][$rd->capability] = (int)$rd->permission;
1073     }
1074     $rs->close();
1076     // share new role definitions
1077     foreach ($newrdefs as $k=>$unused) {
1078         if (!isset($ACCESSLIB_PRIVATE->rolepermissions[$k])) {
1079             $ACCESSLIB_PRIVATE->rolepermissions[$k] = $newrdefs[$k];
1080         }
1081         $accessdata['rdef_count']++;
1082         $accessdata['rdef'][$k] =& $ACCESSLIB_PRIVATE->rolepermissions[$k];
1083     }
1086 /**
1087  * Returns empty accessdata structure.
1088  *
1089  * @access private
1090  * @return array empt accessdata
1091  */
1092 function get_empty_accessdata() {
1093     $accessdata               = array(); // named list
1094     $accessdata['ra']         = array();
1095     $accessdata['rdef']       = array();
1096     $accessdata['rdef_count'] = 0;       // this bloody hack is necessary because count($array) is slooooowwww in PHP
1097     $accessdata['rdef_lcc']   = 0;       // rdef_count during the last compression
1098     $accessdata['loaded']     = array(); // loaded course contexts
1099     $accessdata['time']       = time();
1100     $accessdata['rsw']        = array();
1102     return $accessdata;
1105 /**
1106  * Get accessdata for a given user.
1107  *
1108  * @access private
1109  * @param int $userid
1110  * @param bool $preloadonly true means do not return access array
1111  * @return array accessdata
1112  */
1113 function get_user_accessdata($userid, $preloadonly=false) {
1114     global $CFG, $ACCESSLIB_PRIVATE, $USER;
1116     if (!empty($USER->access['rdef']) and empty($ACCESSLIB_PRIVATE->rolepermissions)) {
1117         // share rdef from USER session with rolepermissions cache in order to conserve memory
1118         foreach ($USER->access['rdef'] as $k=>$v) {
1119             $ACCESSLIB_PRIVATE->rolepermissions[$k] =& $USER->access['rdef'][$k];
1120         }
1121         $ACCESSLIB_PRIVATE->accessdatabyuser[$USER->id] = $USER->access;
1122     }
1124     if (!isset($ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
1125         if (empty($userid)) {
1126             if (!empty($CFG->notloggedinroleid)) {
1127                 $accessdata = get_role_access($CFG->notloggedinroleid);
1128             } else {
1129                 // weird
1130                 return get_empty_accessdata();
1131             }
1133         } else if (isguestuser($userid)) {
1134             if ($guestrole = get_guest_role()) {
1135                 $accessdata = get_role_access($guestrole->id);
1136             } else {
1137                 //weird
1138                 return get_empty_accessdata();
1139             }
1141         } else {
1142             $accessdata = get_user_access_sitewide($userid); // includes default role and frontpage role
1143         }
1145         $ACCESSLIB_PRIVATE->accessdatabyuser[$userid] = $accessdata;
1146     }
1148     if ($preloadonly) {
1149         return;
1150     } else {
1151         return $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
1152     }
1155 /**
1156  * Try to minimise the size of $USER->access by eliminating duplicate override storage,
1157  * this function looks for contexts with the same overrides and shares them.
1158  *
1159  * @access private
1160  * @return void
1161  */
1162 function dedupe_user_access() {
1163     global $USER;
1165     if (CLI_SCRIPT) {
1166         // no session in CLI --> no compression necessary
1167         return;
1168     }
1170     if (empty($USER->access['rdef_count'])) {
1171         // weird, this should not happen
1172         return;
1173     }
1175     // the rdef is growing only, we never remove stuff from it, the rdef_lcc helps us to detect new stuff in rdef
1176     if ($USER->access['rdef_count'] - $USER->access['rdef_lcc'] > 10) {
1177         // do not compress after each change, wait till there is more stuff to be done
1178         return;
1179     }
1181     $hashmap = array();
1182     foreach ($USER->access['rdef'] as $k=>$def) {
1183         $hash = sha1(serialize($def));
1184         if (isset($hashmap[$hash])) {
1185             $USER->access['rdef'][$k] =& $hashmap[$hash];
1186         } else {
1187             $hashmap[$hash] =& $USER->access['rdef'][$k];
1188         }
1189     }
1191     $USER->access['rdef_lcc'] = $USER->access['rdef_count'];
1194 /**
1195  * A convenience function to completely load all the capabilities
1196  * for the current user. It is called from has_capability() and functions change permissions.
1197  *
1198  * Call it only _after_ you've setup $USER and called check_enrolment_plugins();
1199  * @see check_enrolment_plugins()
1200  *
1201  * @access private
1202  * @return void
1203  */
1204 function load_all_capabilities() {
1205     global $USER;
1207     // roles not installed yet - we are in the middle of installation
1208     if (during_initial_install()) {
1209         return;
1210     }
1212     if (!isset($USER->id)) {
1213         // this should not happen
1214         $USER->id = 0;
1215     }
1217     unset($USER->access);
1218     $USER->access = get_user_accessdata($USER->id);
1220     // deduplicate the overrides to minimize session size
1221     dedupe_user_access();
1223     // Clear to force a refresh
1224     unset($USER->mycourses);
1226     // init/reset internal enrol caches - active course enrolments and temp access
1227     $USER->enrol = array('enrolled'=>array(), 'tempguest'=>array());
1230 /**
1231  * A convenience function to completely reload all the capabilities
1232  * for the current user when roles have been updated in a relevant
1233  * context -- but PRESERVING switchroles and loginas.
1234  * This function resets all accesslib and context caches.
1235  *
1236  * That is - completely transparent to the user.
1237  *
1238  * Note: reloads $USER->access completely.
1239  *
1240  * @access private
1241  * @return void
1242  */
1243 function reload_all_capabilities() {
1244     global $USER, $DB, $ACCESSLIB_PRIVATE;
1246     // copy switchroles
1247     $sw = array();
1248     if (!empty($USER->access['rsw'])) {
1249         $sw = $USER->access['rsw'];
1250     }
1252     accesslib_clear_all_caches(true);
1253     unset($USER->access);
1254     $ACCESSLIB_PRIVATE->dirtycontexts = array(); // prevent dirty flags refetching on this page
1256     load_all_capabilities();
1258     foreach ($sw as $path => $roleid) {
1259         if ($record = $DB->get_record('context', array('path'=>$path))) {
1260             $context = context::instance_by_id($record->id);
1261             role_switch($roleid, $context);
1262         }
1263     }
1266 /**
1267  * Adds a temp role to current USER->access array.
1268  *
1269  * Useful for the "temporary guest" access we grant to logged-in users.
1270  * This is useful for enrol plugins only.
1271  *
1272  * @since 2.2
1273  * @param context_course $coursecontext
1274  * @param int $roleid
1275  * @return void
1276  */
1277 function load_temp_course_role(context_course $coursecontext, $roleid) {
1278     global $USER, $SITE;
1280     if (empty($roleid)) {
1281         debugging('invalid role specified in load_temp_course_role()');
1282         return;
1283     }
1285     if ($coursecontext->instanceid == $SITE->id) {
1286         debugging('Can not use temp roles on the frontpage');
1287         return;
1288     }
1290     if (!isset($USER->access)) {
1291         load_all_capabilities();
1292     }
1294     $coursecontext->reload_if_dirty();
1296     if (isset($USER->access['ra'][$coursecontext->path][$roleid])) {
1297         return;
1298     }
1300     // load course stuff first
1301     load_course_context($USER->id, $coursecontext, $USER->access);
1303     $USER->access['ra'][$coursecontext->path][(int)$roleid] = (int)$roleid;
1305     load_role_access_by_context($roleid, $coursecontext, $USER->access);
1308 /**
1309  * Removes any extra guest roles from current USER->access array.
1310  * This is useful for enrol plugins only.
1311  *
1312  * @since 2.2
1313  * @param context_course $coursecontext
1314  * @return void
1315  */
1316 function remove_temp_course_roles(context_course $coursecontext) {
1317     global $DB, $USER, $SITE;
1319     if ($coursecontext->instanceid == $SITE->id) {
1320         debugging('Can not use temp roles on the frontpage');
1321         return;
1322     }
1324     if (empty($USER->access['ra'][$coursecontext->path])) {
1325         //no roles here, weird
1326         return;
1327     }
1329     $sql = "SELECT DISTINCT ra.roleid AS id
1330               FROM {role_assignments} ra
1331              WHERE ra.contextid = :contextid AND ra.userid = :userid";
1332     $ras = $DB->get_records_sql($sql, array('contextid'=>$coursecontext->id, 'userid'=>$USER->id));
1334     $USER->access['ra'][$coursecontext->path] = array();
1335     foreach($ras as $r) {
1336         $USER->access['ra'][$coursecontext->path][(int)$r->id] = (int)$r->id;
1337     }
1340 /**
1341  * Returns array of all role archetypes.
1342  *
1343  * @return array
1344  */
1345 function get_role_archetypes() {
1346     return array(
1347         'manager'        => 'manager',
1348         'coursecreator'  => 'coursecreator',
1349         'editingteacher' => 'editingteacher',
1350         'teacher'        => 'teacher',
1351         'student'        => 'student',
1352         'guest'          => 'guest',
1353         'user'           => 'user',
1354         'frontpage'      => 'frontpage'
1355     );
1358 /**
1359  * Assign the defaults found in this capability definition to roles that have
1360  * the corresponding legacy capabilities assigned to them.
1361  *
1362  * @param string $capability
1363  * @param array $legacyperms an array in the format (example):
1364  *                      'guest' => CAP_PREVENT,
1365  *                      'student' => CAP_ALLOW,
1366  *                      'teacher' => CAP_ALLOW,
1367  *                      'editingteacher' => CAP_ALLOW,
1368  *                      'coursecreator' => CAP_ALLOW,
1369  *                      'manager' => CAP_ALLOW
1370  * @return boolean success or failure.
1371  */
1372 function assign_legacy_capabilities($capability, $legacyperms) {
1374     $archetypes = get_role_archetypes();
1376     foreach ($legacyperms as $type => $perm) {
1378         $systemcontext = context_system::instance();
1379         if ($type === 'admin') {
1380             debugging('Legacy type admin in access.php was renamed to manager, please update the code.');
1381             $type = 'manager';
1382         }
1384         if (!array_key_exists($type, $archetypes)) {
1385             print_error('invalidlegacy', '', '', $type);
1386         }
1388         if ($roles = get_archetype_roles($type)) {
1389             foreach ($roles as $role) {
1390                 // Assign a site level capability.
1391                 if (!assign_capability($capability, $perm, $role->id, $systemcontext->id)) {
1392                     return false;
1393                 }
1394             }
1395         }
1396     }
1397     return true;
1400 /**
1401  * Verify capability risks.
1402  *
1403  * @param stdClass $capability a capability - a row from the capabilities table.
1404  * @return boolean whether this capability is safe - that is, whether people with the
1405  *      safeoverrides capability should be allowed to change it.
1406  */
1407 function is_safe_capability($capability) {
1408     return !((RISK_DATALOSS | RISK_MANAGETRUST | RISK_CONFIG | RISK_XSS | RISK_PERSONAL) & $capability->riskbitmask);
1411 /**
1412  * Get the local override (if any) for a given capability in a role in a context
1413  *
1414  * @param int $roleid
1415  * @param int $contextid
1416  * @param string $capability
1417  * @return stdClass local capability override
1418  */
1419 function get_local_override($roleid, $contextid, $capability) {
1420     global $DB;
1421     return $DB->get_record('role_capabilities', array('roleid'=>$roleid, 'capability'=>$capability, 'contextid'=>$contextid));
1424 /**
1425  * Returns context instance plus related course and cm instances
1426  *
1427  * @param int $contextid
1428  * @return array of ($context, $course, $cm)
1429  */
1430 function get_context_info_array($contextid) {
1431     global $DB;
1433     $context = context::instance_by_id($contextid, MUST_EXIST);
1434     $course  = null;
1435     $cm      = null;
1437     if ($context->contextlevel == CONTEXT_COURSE) {
1438         $course = $DB->get_record('course', array('id'=>$context->instanceid), '*', MUST_EXIST);
1440     } else if ($context->contextlevel == CONTEXT_MODULE) {
1441         $cm = get_coursemodule_from_id('', $context->instanceid, 0, false, MUST_EXIST);
1442         $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
1444     } else if ($context->contextlevel == CONTEXT_BLOCK) {
1445         $parent = $context->get_parent_context();
1447         if ($parent->contextlevel == CONTEXT_COURSE) {
1448             $course = $DB->get_record('course', array('id'=>$parent->instanceid), '*', MUST_EXIST);
1449         } else if ($parent->contextlevel == CONTEXT_MODULE) {
1450             $cm = get_coursemodule_from_id('', $parent->instanceid, 0, false, MUST_EXIST);
1451             $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
1452         }
1453     }
1455     return array($context, $course, $cm);
1458 /**
1459  * Function that creates a role
1460  *
1461  * @param string $name role name
1462  * @param string $shortname role short name
1463  * @param string $description role description
1464  * @param string $archetype
1465  * @return int id or dml_exception
1466  */
1467 function create_role($name, $shortname, $description, $archetype = '') {
1468     global $DB;
1470     if (strpos($archetype, 'moodle/legacy:') !== false) {
1471         throw new coding_exception('Use new role archetype parameter in create_role() instead of old legacy capabilities.');
1472     }
1474     // verify role archetype actually exists
1475     $archetypes = get_role_archetypes();
1476     if (empty($archetypes[$archetype])) {
1477         $archetype = '';
1478     }
1480     // Insert the role record.
1481     $role = new stdClass();
1482     $role->name        = $name;
1483     $role->shortname   = $shortname;
1484     $role->description = $description;
1485     $role->archetype   = $archetype;
1487     //find free sortorder number
1488     $role->sortorder = $DB->get_field('role', 'MAX(sortorder) + 1', array());
1489     if (empty($role->sortorder)) {
1490         $role->sortorder = 1;
1491     }
1492     $id = $DB->insert_record('role', $role);
1494     return $id;
1497 /**
1498  * Function that deletes a role and cleanups up after it
1499  *
1500  * @param int $roleid id of role to delete
1501  * @return bool always true
1502  */
1503 function delete_role($roleid) {
1504     global $DB;
1506     // first unssign all users
1507     role_unassign_all(array('roleid'=>$roleid));
1509     // cleanup all references to this role, ignore errors
1510     $DB->delete_records('role_capabilities',   array('roleid'=>$roleid));
1511     $DB->delete_records('role_allow_assign',   array('roleid'=>$roleid));
1512     $DB->delete_records('role_allow_assign',   array('allowassign'=>$roleid));
1513     $DB->delete_records('role_allow_override', array('roleid'=>$roleid));
1514     $DB->delete_records('role_allow_override', array('allowoverride'=>$roleid));
1515     $DB->delete_records('role_names',          array('roleid'=>$roleid));
1516     $DB->delete_records('role_context_levels', array('roleid'=>$roleid));
1518     // Get role record before it's deleted.
1519     $role = $DB->get_record('role', array('id'=>$roleid));
1521     // Finally delete the role itself.
1522     $DB->delete_records('role', array('id'=>$roleid));
1524     // Trigger event.
1525     $event = \core\event\role_deleted::create(
1526         array(
1527             'context' => context_system::instance(),
1528             'objectid' => $roleid,
1529             'other' =>
1530                 array(
1531                     'shortname' => $role->shortname,
1532                     'description' => $role->description,
1533                     'archetype' => $role->archetype
1534                 )
1535             )
1536         );
1537     $event->add_record_snapshot('role', $role);
1538     $event->trigger();
1540     return true;
1543 /**
1544  * Function to write context specific overrides, or default capabilities.
1545  *
1546  * NOTE: use $context->mark_dirty() after this
1547  *
1548  * @param string $capability string name
1549  * @param int $permission CAP_ constants
1550  * @param int $roleid role id
1551  * @param int|context $contextid context id
1552  * @param bool $overwrite
1553  * @return bool always true or exception
1554  */
1555 function assign_capability($capability, $permission, $roleid, $contextid, $overwrite = false) {
1556     global $USER, $DB;
1558     if ($contextid instanceof context) {
1559         $context = $contextid;
1560     } else {
1561         $context = context::instance_by_id($contextid);
1562     }
1564     if (empty($permission) || $permission == CAP_INHERIT) { // if permission is not set
1565         unassign_capability($capability, $roleid, $context->id);
1566         return true;
1567     }
1569     $existing = $DB->get_record('role_capabilities', array('contextid'=>$context->id, 'roleid'=>$roleid, 'capability'=>$capability));
1571     if ($existing and !$overwrite) {   // We want to keep whatever is there already
1572         return true;
1573     }
1575     $cap = new stdClass();
1576     $cap->contextid    = $context->id;
1577     $cap->roleid       = $roleid;
1578     $cap->capability   = $capability;
1579     $cap->permission   = $permission;
1580     $cap->timemodified = time();
1581     $cap->modifierid   = empty($USER->id) ? 0 : $USER->id;
1583     if ($existing) {
1584         $cap->id = $existing->id;
1585         $DB->update_record('role_capabilities', $cap);
1586     } else {
1587         if ($DB->record_exists('context', array('id'=>$context->id))) {
1588             $DB->insert_record('role_capabilities', $cap);
1589         }
1590     }
1591     return true;
1594 /**
1595  * Unassign a capability from a role.
1596  *
1597  * NOTE: use $context->mark_dirty() after this
1598  *
1599  * @param string $capability the name of the capability
1600  * @param int $roleid the role id
1601  * @param int|context $contextid null means all contexts
1602  * @return boolean true or exception
1603  */
1604 function unassign_capability($capability, $roleid, $contextid = null) {
1605     global $DB;
1607     if (!empty($contextid)) {
1608         if ($contextid instanceof context) {
1609             $context = $contextid;
1610         } else {
1611             $context = context::instance_by_id($contextid);
1612         }
1613         // delete from context rel, if this is the last override in this context
1614         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid, 'contextid'=>$context->id));
1615     } else {
1616         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid));
1617     }
1618     return true;
1621 /**
1622  * Get the roles that have a given capability assigned to it
1623  *
1624  * This function does not resolve the actual permission of the capability.
1625  * It just checks for permissions and overrides.
1626  * Use get_roles_with_cap_in_context() if resolution is required.
1627  *
1628  * @param string $capability capability name (string)
1629  * @param string $permission optional, the permission defined for this capability
1630  *                      either CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT. Defaults to null which means any.
1631  * @param stdClass $context null means any
1632  * @return array of role records
1633  */
1634 function get_roles_with_capability($capability, $permission = null, $context = null) {
1635     global $DB;
1637     if ($context) {
1638         $contexts = $context->get_parent_context_ids(true);
1639         list($insql, $params) = $DB->get_in_or_equal($contexts, SQL_PARAMS_NAMED, 'ctx');
1640         $contextsql = "AND rc.contextid $insql";
1641     } else {
1642         $params = array();
1643         $contextsql = '';
1644     }
1646     if ($permission) {
1647         $permissionsql = " AND rc.permission = :permission";
1648         $params['permission'] = $permission;
1649     } else {
1650         $permissionsql = '';
1651     }
1653     $sql = "SELECT r.*
1654               FROM {role} r
1655              WHERE r.id IN (SELECT rc.roleid
1656                               FROM {role_capabilities} rc
1657                              WHERE rc.capability = :capname
1658                                    $contextsql
1659                                    $permissionsql)";
1660     $params['capname'] = $capability;
1663     return $DB->get_records_sql($sql, $params);
1666 /**
1667  * This function makes a role-assignment (a role for a user in a particular context)
1668  *
1669  * @param int $roleid the role of the id
1670  * @param int $userid userid
1671  * @param int|context $contextid id of the context
1672  * @param string $component example 'enrol_ldap', defaults to '' which means manual assignment,
1673  * @param int $itemid id of enrolment/auth plugin
1674  * @param string $timemodified defaults to current time
1675  * @return int new/existing id of the assignment
1676  */
1677 function role_assign($roleid, $userid, $contextid, $component = '', $itemid = 0, $timemodified = '') {
1678     global $USER, $DB;
1680     // first of all detect if somebody is using old style parameters
1681     if ($contextid === 0 or is_numeric($component)) {
1682         throw new coding_exception('Invalid call to role_assign(), code needs to be updated to use new order of parameters');
1683     }
1685     // now validate all parameters
1686     if (empty($roleid)) {
1687         throw new coding_exception('Invalid call to role_assign(), roleid can not be empty');
1688     }
1690     if (empty($userid)) {
1691         throw new coding_exception('Invalid call to role_assign(), userid can not be empty');
1692     }
1694     if ($itemid) {
1695         if (strpos($component, '_') === false) {
1696             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as"enrol_" when itemid specified', 'component:'.$component);
1697         }
1698     } else {
1699         $itemid = 0;
1700         if ($component !== '' and strpos($component, '_') === false) {
1701             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
1702         }
1703     }
1705     if (!$DB->record_exists('user', array('id'=>$userid, 'deleted'=>0))) {
1706         throw new coding_exception('User ID does not exist or is deleted!', 'userid:'.$userid);
1707     }
1709     if ($contextid instanceof context) {
1710         $context = $contextid;
1711     } else {
1712         $context = context::instance_by_id($contextid, MUST_EXIST);
1713     }
1715     if (!$timemodified) {
1716         $timemodified = time();
1717     }
1719     // Check for existing entry
1720     $ras = $DB->get_records('role_assignments', array('roleid'=>$roleid, 'contextid'=>$context->id, 'userid'=>$userid, 'component'=>$component, 'itemid'=>$itemid), 'id');
1722     if ($ras) {
1723         // role already assigned - this should not happen
1724         if (count($ras) > 1) {
1725             // very weird - remove all duplicates!
1726             $ra = array_shift($ras);
1727             foreach ($ras as $r) {
1728                 $DB->delete_records('role_assignments', array('id'=>$r->id));
1729             }
1730         } else {
1731             $ra = reset($ras);
1732         }
1734         // actually there is no need to update, reset anything or trigger any event, so just return
1735         return $ra->id;
1736     }
1738     // Create a new entry
1739     $ra = new stdClass();
1740     $ra->roleid       = $roleid;
1741     $ra->contextid    = $context->id;
1742     $ra->userid       = $userid;
1743     $ra->component    = $component;
1744     $ra->itemid       = $itemid;
1745     $ra->timemodified = $timemodified;
1746     $ra->modifierid   = empty($USER->id) ? 0 : $USER->id;
1748     $ra->id = $DB->insert_record('role_assignments', $ra);
1750     // mark context as dirty - again expensive, but needed
1751     $context->mark_dirty();
1753     if (!empty($USER->id) && $USER->id == $userid) {
1754         // If the user is the current user, then do full reload of capabilities too.
1755         reload_all_capabilities();
1756     }
1758     $event = \core\event\role_assigned::create(
1759         array('context'=>$context, 'objectid'=>$ra->roleid, 'relateduserid'=>$ra->userid,
1760             'other'=>array('id'=>$ra->id, 'component'=>$ra->component, 'itemid'=>$ra->itemid)));
1761     $event->add_record_snapshot('role_assignments', $ra);
1762     $event->trigger();
1764     return $ra->id;
1767 /**
1768  * Removes one role assignment
1769  *
1770  * @param int $roleid
1771  * @param int  $userid
1772  * @param int  $contextid
1773  * @param string $component
1774  * @param int  $itemid
1775  * @return void
1776  */
1777 function role_unassign($roleid, $userid, $contextid, $component = '', $itemid = 0) {
1778     // first make sure the params make sense
1779     if ($roleid == 0 or $userid == 0 or $contextid == 0) {
1780         throw new coding_exception('Invalid call to role_unassign(), please use role_unassign_all() when removing multiple role assignments');
1781     }
1783     if ($itemid) {
1784         if (strpos($component, '_') === false) {
1785             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as "enrol_" when itemid specified', 'component:'.$component);
1786         }
1787     } else {
1788         $itemid = 0;
1789         if ($component !== '' and strpos($component, '_') === false) {
1790             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
1791         }
1792     }
1794     role_unassign_all(array('roleid'=>$roleid, 'userid'=>$userid, 'contextid'=>$contextid, 'component'=>$component, 'itemid'=>$itemid), false, false);
1797 /**
1798  * Removes multiple role assignments, parameters may contain:
1799  *   'roleid', 'userid', 'contextid', 'component', 'enrolid'.
1800  *
1801  * @param array $params role assignment parameters
1802  * @param bool $subcontexts unassign in subcontexts too
1803  * @param bool $includemanual include manual role assignments too
1804  * @return void
1805  */
1806 function role_unassign_all(array $params, $subcontexts = false, $includemanual = false) {
1807     global $USER, $CFG, $DB;
1809     if (!$params) {
1810         throw new coding_exception('Missing parameters in role_unsassign_all() call');
1811     }
1813     $allowed = array('roleid', 'userid', 'contextid', 'component', 'itemid');
1814     foreach ($params as $key=>$value) {
1815         if (!in_array($key, $allowed)) {
1816             throw new coding_exception('Unknown role_unsassign_all() parameter key', 'key:'.$key);
1817         }
1818     }
1820     if (isset($params['component']) and $params['component'] !== '' and strpos($params['component'], '_') === false) {
1821         throw new coding_exception('Invalid component paramter in role_unsassign_all() call', 'component:'.$params['component']);
1822     }
1824     if ($includemanual) {
1825         if (!isset($params['component']) or $params['component'] === '') {
1826             throw new coding_exception('include manual parameter requires component parameter in role_unsassign_all() call');
1827         }
1828     }
1830     if ($subcontexts) {
1831         if (empty($params['contextid'])) {
1832             throw new coding_exception('subcontexts paramtere requires component parameter in role_unsassign_all() call');
1833         }
1834     }
1836     $ras = $DB->get_records('role_assignments', $params);
1837     foreach($ras as $ra) {
1838         $DB->delete_records('role_assignments', array('id'=>$ra->id));
1839         if ($context = context::instance_by_id($ra->contextid, IGNORE_MISSING)) {
1840             // this is a bit expensive but necessary
1841             $context->mark_dirty();
1842             // If the user is the current user, then do full reload of capabilities too.
1843             if (!empty($USER->id) && $USER->id == $ra->userid) {
1844                 reload_all_capabilities();
1845             }
1846             $event = \core\event\role_unassigned::create(
1847                 array('context'=>$context, 'objectid'=>$ra->roleid, 'relateduserid'=>$ra->userid,
1848                     'other'=>array('id'=>$ra->id, 'component'=>$ra->component, 'itemid'=>$ra->itemid)));
1849             $event->add_record_snapshot('role_assignments', $ra);
1850             $event->trigger();
1851         }
1852     }
1853     unset($ras);
1855     // process subcontexts
1856     if ($subcontexts and $context = context::instance_by_id($params['contextid'], IGNORE_MISSING)) {
1857         if ($params['contextid'] instanceof context) {
1858             $context = $params['contextid'];
1859         } else {
1860             $context = context::instance_by_id($params['contextid'], IGNORE_MISSING);
1861         }
1863         if ($context) {
1864             $contexts = $context->get_child_contexts();
1865             $mparams = $params;
1866             foreach($contexts as $context) {
1867                 $mparams['contextid'] = $context->id;
1868                 $ras = $DB->get_records('role_assignments', $mparams);
1869                 foreach($ras as $ra) {
1870                     $DB->delete_records('role_assignments', array('id'=>$ra->id));
1871                     // this is a bit expensive but necessary
1872                     $context->mark_dirty();
1873                     // If the user is the current user, then do full reload of capabilities too.
1874                     if (!empty($USER->id) && $USER->id == $ra->userid) {
1875                         reload_all_capabilities();
1876                     }
1877                     $event = \core\event\role_unassigned::create(
1878                         array('context'=>$context, 'objectid'=>$ra->roleid, 'relateduserid'=>$ra->userid,
1879                             'other'=>array('id'=>$ra->id, 'component'=>$ra->component, 'itemid'=>$ra->itemid)));
1880                     $event->add_record_snapshot('role_assignments', $ra);
1881                     $event->trigger();
1882                 }
1883             }
1884         }
1885     }
1887     // do this once more for all manual role assignments
1888     if ($includemanual) {
1889         $params['component'] = '';
1890         role_unassign_all($params, $subcontexts, false);
1891     }
1894 /**
1895  * Determines if a user is currently logged in
1896  *
1897  * @category   access
1898  *
1899  * @return bool
1900  */
1901 function isloggedin() {
1902     global $USER;
1904     return (!empty($USER->id));
1907 /**
1908  * Determines if a user is logged in as real guest user with username 'guest'.
1909  *
1910  * @category   access
1911  *
1912  * @param int|object $user mixed user object or id, $USER if not specified
1913  * @return bool true if user is the real guest user, false if not logged in or other user
1914  */
1915 function isguestuser($user = null) {
1916     global $USER, $DB, $CFG;
1918     // make sure we have the user id cached in config table, because we are going to use it a lot
1919     if (empty($CFG->siteguest)) {
1920         if (!$guestid = $DB->get_field('user', 'id', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
1921             // guest does not exist yet, weird
1922             return false;
1923         }
1924         set_config('siteguest', $guestid);
1925     }
1926     if ($user === null) {
1927         $user = $USER;
1928     }
1930     if ($user === null) {
1931         // happens when setting the $USER
1932         return false;
1934     } else if (is_numeric($user)) {
1935         return ($CFG->siteguest == $user);
1937     } else if (is_object($user)) {
1938         if (empty($user->id)) {
1939             return false; // not logged in means is not be guest
1940         } else {
1941             return ($CFG->siteguest == $user->id);
1942         }
1944     } else {
1945         throw new coding_exception('Invalid user parameter supplied for isguestuser() function!');
1946     }
1949 /**
1950  * Does user have a (temporary or real) guest access to course?
1951  *
1952  * @category   access
1953  *
1954  * @param context $context
1955  * @param stdClass|int $user
1956  * @return bool
1957  */
1958 function is_guest(context $context, $user = null) {
1959     global $USER;
1961     // first find the course context
1962     $coursecontext = $context->get_course_context();
1964     // make sure there is a real user specified
1965     if ($user === null) {
1966         $userid = isset($USER->id) ? $USER->id : 0;
1967     } else {
1968         $userid = is_object($user) ? $user->id : $user;
1969     }
1971     if (isguestuser($userid)) {
1972         // can not inspect or be enrolled
1973         return true;
1974     }
1976     if (has_capability('moodle/course:view', $coursecontext, $user)) {
1977         // viewing users appear out of nowhere, they are neither guests nor participants
1978         return false;
1979     }
1981     // consider only real active enrolments here
1982     if (is_enrolled($coursecontext, $user, '', true)) {
1983         return false;
1984     }
1986     return true;
1989 /**
1990  * Returns true if the user has moodle/course:view capability in the course,
1991  * this is intended for admins, managers (aka small admins), inspectors, etc.
1992  *
1993  * @category   access
1994  *
1995  * @param context $context
1996  * @param int|stdClass $user if null $USER is used
1997  * @param string $withcapability extra capability name
1998  * @return bool
1999  */
2000 function is_viewing(context $context, $user = null, $withcapability = '') {
2001     // first find the course context
2002     $coursecontext = $context->get_course_context();
2004     if (isguestuser($user)) {
2005         // can not inspect
2006         return false;
2007     }
2009     if (!has_capability('moodle/course:view', $coursecontext, $user)) {
2010         // admins are allowed to inspect courses
2011         return false;
2012     }
2014     if ($withcapability and !has_capability($withcapability, $context, $user)) {
2015         // site admins always have the capability, but the enrolment above blocks
2016         return false;
2017     }
2019     return true;
2022 /**
2023  * Returns true if user is enrolled (is participating) in course
2024  * this is intended for students and teachers.
2025  *
2026  * Since 2.2 the result for active enrolments and current user are cached.
2027  *
2028  * @package   core_enrol
2029  * @category  access
2030  *
2031  * @param context $context
2032  * @param int|stdClass $user if null $USER is used, otherwise user object or id expected
2033  * @param string $withcapability extra capability name
2034  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2035  * @return bool
2036  */
2037 function is_enrolled(context $context, $user = null, $withcapability = '', $onlyactive = false) {
2038     global $USER, $DB;
2040     // first find the course context
2041     $coursecontext = $context->get_course_context();
2043     // make sure there is a real user specified
2044     if ($user === null) {
2045         $userid = isset($USER->id) ? $USER->id : 0;
2046     } else {
2047         $userid = is_object($user) ? $user->id : $user;
2048     }
2050     if (empty($userid)) {
2051         // not-logged-in!
2052         return false;
2053     } else if (isguestuser($userid)) {
2054         // guest account can not be enrolled anywhere
2055         return false;
2056     }
2058     if ($coursecontext->instanceid == SITEID) {
2059         // everybody participates on frontpage
2060     } else {
2061         // try cached info first - the enrolled flag is set only when active enrolment present
2062         if ($USER->id == $userid) {
2063             $coursecontext->reload_if_dirty();
2064             if (isset($USER->enrol['enrolled'][$coursecontext->instanceid])) {
2065                 if ($USER->enrol['enrolled'][$coursecontext->instanceid] > time()) {
2066                     if ($withcapability and !has_capability($withcapability, $context, $userid)) {
2067                         return false;
2068                     }
2069                     return true;
2070                 }
2071             }
2072         }
2074         if ($onlyactive) {
2075             // look for active enrolments only
2076             $until = enrol_get_enrolment_end($coursecontext->instanceid, $userid);
2078             if ($until === false) {
2079                 return false;
2080             }
2082             if ($USER->id == $userid) {
2083                 if ($until == 0) {
2084                     $until = ENROL_MAX_TIMESTAMP;
2085                 }
2086                 $USER->enrol['enrolled'][$coursecontext->instanceid] = $until;
2087                 if (isset($USER->enrol['tempguest'][$coursecontext->instanceid])) {
2088                     unset($USER->enrol['tempguest'][$coursecontext->instanceid]);
2089                     remove_temp_course_roles($coursecontext);
2090                 }
2091             }
2093         } else {
2094             // any enrolment is good for us here, even outdated, disabled or inactive
2095             $sql = "SELECT 'x'
2096                       FROM {user_enrolments} ue
2097                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2098                       JOIN {user} u ON u.id = ue.userid
2099                      WHERE ue.userid = :userid AND u.deleted = 0";
2100             $params = array('userid'=>$userid, 'courseid'=>$coursecontext->instanceid);
2101             if (!$DB->record_exists_sql($sql, $params)) {
2102                 return false;
2103             }
2104         }
2105     }
2107     if ($withcapability and !has_capability($withcapability, $context, $userid)) {
2108         return false;
2109     }
2111     return true;
2114 /**
2115  * Returns true if the user is able to access the course.
2116  *
2117  * This function is in no way, shape, or form a substitute for require_login.
2118  * It should only be used in circumstances where it is not possible to call require_login
2119  * such as the navigation.
2120  *
2121  * This function checks many of the methods of access to a course such as the view
2122  * capability, enrollments, and guest access. It also makes use of the cache
2123  * generated by require_login for guest access.
2124  *
2125  * The flags within the $USER object that are used here should NEVER be used outside
2126  * of this function can_access_course and require_login. Doing so WILL break future
2127  * versions.
2128  *
2129  * @param stdClass $course record
2130  * @param stdClass|int|null $user user record or id, current user if null
2131  * @param string $withcapability Check for this capability as well.
2132  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2133  * @return boolean Returns true if the user is able to access the course
2134  */
2135 function can_access_course(stdClass $course, $user = null, $withcapability = '', $onlyactive = false) {
2136     global $DB, $USER;
2138     // this function originally accepted $coursecontext parameter
2139     if ($course instanceof context) {
2140         if ($course instanceof context_course) {
2141             debugging('deprecated context parameter, please use $course record');
2142             $coursecontext = $course;
2143             $course = $DB->get_record('course', array('id'=>$coursecontext->instanceid));
2144         } else {
2145             debugging('Invalid context parameter, please use $course record');
2146             return false;
2147         }
2148     } else {
2149         $coursecontext = context_course::instance($course->id);
2150     }
2152     if (!isset($USER->id)) {
2153         // should never happen
2154         $USER->id = 0;
2155         debugging('Course access check being performed on a user with no ID.', DEBUG_DEVELOPER);
2156     }
2158     // make sure there is a user specified
2159     if ($user === null) {
2160         $userid = $USER->id;
2161     } else {
2162         $userid = is_object($user) ? $user->id : $user;
2163     }
2164     unset($user);
2166     if ($withcapability and !has_capability($withcapability, $coursecontext, $userid)) {
2167         return false;
2168     }
2170     if ($userid == $USER->id) {
2171         if (!empty($USER->access['rsw'][$coursecontext->path])) {
2172             // the fact that somebody switched role means they can access the course no matter to what role they switched
2173             return true;
2174         }
2175     }
2177     if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext, $userid)) {
2178         return false;
2179     }
2181     if (is_viewing($coursecontext, $userid)) {
2182         return true;
2183     }
2185     if ($userid != $USER->id) {
2186         // for performance reasons we do not verify temporary guest access for other users, sorry...
2187         return is_enrolled($coursecontext, $userid, '', $onlyactive);
2188     }
2190     // === from here we deal only with $USER ===
2192     $coursecontext->reload_if_dirty();
2194     if (isset($USER->enrol['enrolled'][$course->id])) {
2195         if ($USER->enrol['enrolled'][$course->id] > time()) {
2196             return true;
2197         }
2198     }
2199     if (isset($USER->enrol['tempguest'][$course->id])) {
2200         if ($USER->enrol['tempguest'][$course->id] > time()) {
2201             return true;
2202         }
2203     }
2205     if (is_enrolled($coursecontext, $USER, '', $onlyactive)) {
2206         return true;
2207     }
2209     // if not enrolled try to gain temporary guest access
2210     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2211     $enrols = enrol_get_plugins(true);
2212     foreach($instances as $instance) {
2213         if (!isset($enrols[$instance->enrol])) {
2214             continue;
2215         }
2216         // Get a duration for the guest access, a timestamp in the future, 0 (always) or false.
2217         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2218         if ($until !== false and $until > time()) {
2219             $USER->enrol['tempguest'][$course->id] = $until;
2220             return true;
2221         }
2222     }
2223     if (isset($USER->enrol['tempguest'][$course->id])) {
2224         unset($USER->enrol['tempguest'][$course->id]);
2225         remove_temp_course_roles($coursecontext);
2226     }
2228     return false;
2231 /**
2232  * Returns array with sql code and parameters returning all ids
2233  * of users enrolled into course.
2234  *
2235  * This function is using 'eu[0-9]+_' prefix for table names and parameters.
2236  *
2237  * @package   core_enrol
2238  * @category  access
2239  *
2240  * @param context $context
2241  * @param string $withcapability
2242  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2243  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2244  * @return array list($sql, $params)
2245  */
2246 function get_enrolled_sql(context $context, $withcapability = '', $groupid = 0, $onlyactive = false) {
2247     global $DB, $CFG;
2249     // use unique prefix just in case somebody makes some SQL magic with the result
2250     static $i = 0;
2251     $i++;
2252     $prefix = 'eu'.$i.'_';
2254     // first find the course context
2255     $coursecontext = $context->get_course_context();
2257     $isfrontpage = ($coursecontext->instanceid == SITEID);
2259     $joins  = array();
2260     $wheres = array();
2261     $params = array();
2263     list($contextids, $contextpaths) = get_context_info_list($context);
2265     // get all relevant capability info for all roles
2266     if ($withcapability) {
2267         list($incontexts, $cparams) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED, 'ctx');
2268         $cparams['cap'] = $withcapability;
2270         $defs = array();
2271         $sql = "SELECT rc.id, rc.roleid, rc.permission, ctx.path
2272                   FROM {role_capabilities} rc
2273                   JOIN {context} ctx on rc.contextid = ctx.id
2274                  WHERE rc.contextid $incontexts AND rc.capability = :cap";
2275         $rcs = $DB->get_records_sql($sql, $cparams);
2276         foreach ($rcs as $rc) {
2277             $defs[$rc->path][$rc->roleid] = $rc->permission;
2278         }
2280         $access = array();
2281         if (!empty($defs)) {
2282             foreach ($contextpaths as $path) {
2283                 if (empty($defs[$path])) {
2284                     continue;
2285                 }
2286                 foreach($defs[$path] as $roleid => $perm) {
2287                     if ($perm == CAP_PROHIBIT) {
2288                         $access[$roleid] = CAP_PROHIBIT;
2289                         continue;
2290                     }
2291                     if (!isset($access[$roleid])) {
2292                         $access[$roleid] = (int)$perm;
2293                     }
2294                 }
2295             }
2296         }
2298         unset($defs);
2300         // make lists of roles that are needed and prohibited
2301         $needed     = array(); // one of these is enough
2302         $prohibited = array(); // must not have any of these
2303         foreach ($access as $roleid => $perm) {
2304             if ($perm == CAP_PROHIBIT) {
2305                 unset($needed[$roleid]);
2306                 $prohibited[$roleid] = true;
2307             } else if ($perm == CAP_ALLOW and empty($prohibited[$roleid])) {
2308                 $needed[$roleid] = true;
2309             }
2310         }
2312         $defaultuserroleid      = isset($CFG->defaultuserroleid) ? $CFG->defaultuserroleid : 0;
2313         $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid) ? $CFG->defaultfrontpageroleid : 0;
2315         $nobody = false;
2317         if ($isfrontpage) {
2318             if (!empty($prohibited[$defaultuserroleid]) or !empty($prohibited[$defaultfrontpageroleid])) {
2319                 $nobody = true;
2320             } else if (!empty($needed[$defaultuserroleid]) or !empty($needed[$defaultfrontpageroleid])) {
2321                 // everybody not having prohibit has the capability
2322                 $needed = array();
2323             } else if (empty($needed)) {
2324                 $nobody = true;
2325             }
2326         } else {
2327             if (!empty($prohibited[$defaultuserroleid])) {
2328                 $nobody = true;
2329             } else if (!empty($needed[$defaultuserroleid])) {
2330                 // everybody not having prohibit has the capability
2331                 $needed = array();
2332             } else if (empty($needed)) {
2333                 $nobody = true;
2334             }
2335         }
2337         if ($nobody) {
2338             // nobody can match so return some SQL that does not return any results
2339             $wheres[] = "1 = 2";
2341         } else {
2343             if ($needed) {
2344                 $ctxids = implode(',', $contextids);
2345                 $roleids = implode(',', array_keys($needed));
2346                 $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))";
2347             }
2349             if ($prohibited) {
2350                 $ctxids = implode(',', $contextids);
2351                 $roleids = implode(',', array_keys($prohibited));
2352                 $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))";
2353                 $wheres[] = "{$prefix}ra4.id IS NULL";
2354             }
2356             if ($groupid) {
2357                 $joins[] = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = {$prefix}u.id AND {$prefix}gm.groupid = :{$prefix}gmid)";
2358                 $params["{$prefix}gmid"] = $groupid;
2359             }
2360         }
2362     } else {
2363         if ($groupid) {
2364             $joins[] = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = {$prefix}u.id AND {$prefix}gm.groupid = :{$prefix}gmid)";
2365             $params["{$prefix}gmid"] = $groupid;
2366         }
2367     }
2369     $wheres[] = "{$prefix}u.deleted = 0 AND {$prefix}u.id <> :{$prefix}guestid";
2370     $params["{$prefix}guestid"] = $CFG->siteguest;
2372     if ($isfrontpage) {
2373         // all users are "enrolled" on the frontpage
2374     } else {
2375         $joins[] = "JOIN {user_enrolments} {$prefix}ue ON {$prefix}ue.userid = {$prefix}u.id";
2376         $joins[] = "JOIN {enrol} {$prefix}e ON ({$prefix}e.id = {$prefix}ue.enrolid AND {$prefix}e.courseid = :{$prefix}courseid)";
2377         $params[$prefix.'courseid'] = $coursecontext->instanceid;
2379         if ($onlyactive) {
2380             $wheres[] = "{$prefix}ue.status = :{$prefix}active AND {$prefix}e.status = :{$prefix}enabled";
2381             $wheres[] = "{$prefix}ue.timestart < :{$prefix}now1 AND ({$prefix}ue.timeend = 0 OR {$prefix}ue.timeend > :{$prefix}now2)";
2382             $now = round(time(), -2); // rounding helps caching in DB
2383             $params = array_merge($params, array($prefix.'enabled'=>ENROL_INSTANCE_ENABLED,
2384                                                  $prefix.'active'=>ENROL_USER_ACTIVE,
2385                                                  $prefix.'now1'=>$now, $prefix.'now2'=>$now));
2386         }
2387     }
2389     $joins = implode("\n", $joins);
2390     $wheres = "WHERE ".implode(" AND ", $wheres);
2392     $sql = "SELECT DISTINCT {$prefix}u.id
2393               FROM {user} {$prefix}u
2394             $joins
2395            $wheres";
2397     return array($sql, $params);
2400 /**
2401  * Returns list of users enrolled into course.
2402  *
2403  * @package   core_enrol
2404  * @category  access
2405  *
2406  * @param context $context
2407  * @param string $withcapability
2408  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2409  * @param string $userfields requested user record fields
2410  * @param string $orderby
2411  * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
2412  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
2413  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2414  * @return array of user records
2415  */
2416 function get_enrolled_users(context $context, $withcapability = '', $groupid = 0, $userfields = 'u.*', $orderby = null,
2417         $limitfrom = 0, $limitnum = 0, $onlyactive = false) {
2418     global $DB;
2420     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid, $onlyactive);
2421     $sql = "SELECT $userfields
2422               FROM {user} u
2423               JOIN ($esql) je ON je.id = u.id
2424              WHERE u.deleted = 0";
2426     if ($orderby) {
2427         $sql = "$sql ORDER BY $orderby";
2428     } else {
2429         list($sort, $sortparams) = users_order_by_sql('u');
2430         $sql = "$sql ORDER BY $sort";
2431         $params = array_merge($params, $sortparams);
2432     }
2434     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
2437 /**
2438  * Counts list of users enrolled into course (as per above function)
2439  *
2440  * @package   core_enrol
2441  * @category  access
2442  *
2443  * @param context $context
2444  * @param string $withcapability
2445  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2446  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2447  * @return array of user records
2448  */
2449 function count_enrolled_users(context $context, $withcapability = '', $groupid = 0, $onlyactive = false) {
2450     global $DB;
2452     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid, $onlyactive);
2453     $sql = "SELECT count(u.id)
2454               FROM {user} u
2455               JOIN ($esql) je ON je.id = u.id
2456              WHERE u.deleted = 0";
2458     return $DB->count_records_sql($sql, $params);
2461 /**
2462  * Loads the capability definitions for the component (from file).
2463  *
2464  * Loads the capability definitions for the component (from file). If no
2465  * capabilities are defined for the component, we simply return an empty array.
2466  *
2467  * @access private
2468  * @param string $component full plugin name, examples: 'moodle', 'mod_forum'
2469  * @return array array of capabilities
2470  */
2471 function load_capability_def($component) {
2472     $defpath = core_component::get_component_directory($component).'/db/access.php';
2474     $capabilities = array();
2475     if (file_exists($defpath)) {
2476         require($defpath);
2477         if (!empty(${$component.'_capabilities'})) {
2478             // BC capability array name
2479             // since 2.0 we prefer $capabilities instead - it is easier to use and matches db/* files
2480             debugging('componentname_capabilities array is deprecated, please use $capabilities array only in access.php files');
2481             $capabilities = ${$component.'_capabilities'};
2482         }
2483     }
2485     return $capabilities;
2488 /**
2489  * Gets the capabilities that have been cached in the database for this component.
2490  *
2491  * @access private
2492  * @param string $component - examples: 'moodle', 'mod_forum'
2493  * @return array array of capabilities
2494  */
2495 function get_cached_capabilities($component = 'moodle') {
2496     global $DB;
2497     return $DB->get_records('capabilities', array('component'=>$component));
2500 /**
2501  * Returns default capabilities for given role archetype.
2502  *
2503  * @param string $archetype role archetype
2504  * @return array
2505  */
2506 function get_default_capabilities($archetype) {
2507     global $DB;
2509     if (!$archetype) {
2510         return array();
2511     }
2513     $alldefs = array();
2514     $defaults = array();
2515     $components = array();
2516     $allcaps = $DB->get_records('capabilities');
2518     foreach ($allcaps as $cap) {
2519         if (!in_array($cap->component, $components)) {
2520             $components[] = $cap->component;
2521             $alldefs = array_merge($alldefs, load_capability_def($cap->component));
2522         }
2523     }
2524     foreach($alldefs as $name=>$def) {
2525         // Use array 'archetypes if available. Only if not specified, use 'legacy'.
2526         if (isset($def['archetypes'])) {
2527             if (isset($def['archetypes'][$archetype])) {
2528                 $defaults[$name] = $def['archetypes'][$archetype];
2529             }
2530         // 'legacy' is for backward compatibility with 1.9 access.php
2531         } else {
2532             if (isset($def['legacy'][$archetype])) {
2533                 $defaults[$name] = $def['legacy'][$archetype];
2534             }
2535         }
2536     }
2538     return $defaults;
2541 /**
2542  * Return default roles that can be assigned, overridden or switched
2543  * by give role archetype.
2544  *
2545  * @param string $type  assign|override|switch
2546  * @param string $archetype
2547  * @return array of role ids
2548  */
2549 function get_default_role_archetype_allows($type, $archetype) {
2550     global $DB;
2552     if (empty($archetype)) {
2553         return array();
2554     }
2556     $roles = $DB->get_records('role');
2557     $archetypemap = array();
2558     foreach ($roles as $role) {
2559         if ($role->archetype) {
2560             $archetypemap[$role->archetype][$role->id] = $role->id;
2561         }
2562     }
2564     $defaults = array(
2565         'assign' => array(
2566             'manager'        => array('manager', 'coursecreator', 'editingteacher', 'teacher', 'student'),
2567             'coursecreator'  => array(),
2568             'editingteacher' => array('teacher', 'student'),
2569             'teacher'        => array(),
2570             'student'        => array(),
2571             'guest'          => array(),
2572             'user'           => array(),
2573             'frontpage'      => array(),
2574         ),
2575         'override' => array(
2576             'manager'        => array('manager', 'coursecreator', 'editingteacher', 'teacher', 'student', 'guest', 'user', 'frontpage'),
2577             'coursecreator'  => array(),
2578             'editingteacher' => array('teacher', 'student', 'guest'),
2579             'teacher'        => array(),
2580             'student'        => array(),
2581             'guest'          => array(),
2582             'user'           => array(),
2583             'frontpage'      => array(),
2584         ),
2585         'switch' => array(
2586             'manager'        => array('editingteacher', 'teacher', 'student', 'guest'),
2587             'coursecreator'  => array(),
2588             'editingteacher' => array('teacher', 'student', 'guest'),
2589             'teacher'        => array('student', 'guest'),
2590             'student'        => array(),
2591             'guest'          => array(),
2592             'user'           => array(),
2593             'frontpage'      => array(),
2594         ),
2595     );
2597     if (!isset($defaults[$type][$archetype])) {
2598         debugging("Unknown type '$type'' or archetype '$archetype''");
2599         return array();
2600     }
2602     $return = array();
2603     foreach ($defaults[$type][$archetype] as $at) {
2604         if (isset($archetypemap[$at])) {
2605             foreach ($archetypemap[$at] as $roleid) {
2606                 $return[$roleid] = $roleid;
2607             }
2608         }
2609     }
2611     return $return;
2614 /**
2615  * Reset role capabilities to default according to selected role archetype.
2616  * If no archetype selected, removes all capabilities.
2617  *
2618  * @param int $roleid
2619  * @return void
2620  */
2621 function reset_role_capabilities($roleid) {
2622     global $DB;
2624     $role = $DB->get_record('role', array('id'=>$roleid), '*', MUST_EXIST);
2625     $defaultcaps = get_default_capabilities($role->archetype);
2627     $systemcontext = context_system::instance();
2629     $DB->delete_records('role_capabilities',
2630             array('roleid'=>$roleid, 'contextid' => $systemcontext->id));
2632     foreach($defaultcaps as $cap=>$permission) {
2633         assign_capability($cap, $permission, $roleid, $systemcontext->id);
2634     }
2637 /**
2638  * Updates the capabilities table with the component capability definitions.
2639  * If no parameters are given, the function updates the core moodle
2640  * capabilities.
2641  *
2642  * Note that the absence of the db/access.php capabilities definition file
2643  * will cause any stored capabilities for the component to be removed from
2644  * the database.
2645  *
2646  * @access private
2647  * @param string $component examples: 'moodle', 'mod/forum', 'block/quiz_results'
2648  * @return boolean true if success, exception in case of any problems
2649  */
2650 function update_capabilities($component = 'moodle') {
2651     global $DB, $OUTPUT;
2653     $storedcaps = array();
2655     $filecaps = load_capability_def($component);
2656     foreach($filecaps as $capname=>$unused) {
2657         if (!preg_match('|^[a-z]+/[a-z_0-9]+:[a-z_0-9]+$|', $capname)) {
2658             debugging("Coding problem: Invalid capability name '$capname', use 'clonepermissionsfrom' field for migration.");
2659         }
2660     }
2662     $cachedcaps = get_cached_capabilities($component);
2663     if ($cachedcaps) {
2664         foreach ($cachedcaps as $cachedcap) {
2665             array_push($storedcaps, $cachedcap->name);
2666             // update risk bitmasks and context levels in existing capabilities if needed
2667             if (array_key_exists($cachedcap->name, $filecaps)) {
2668                 if (!array_key_exists('riskbitmask', $filecaps[$cachedcap->name])) {
2669                     $filecaps[$cachedcap->name]['riskbitmask'] = 0; // no risk if not specified
2670                 }
2671                 if ($cachedcap->captype != $filecaps[$cachedcap->name]['captype']) {
2672                     $updatecap = new stdClass();
2673                     $updatecap->id = $cachedcap->id;
2674                     $updatecap->captype = $filecaps[$cachedcap->name]['captype'];
2675                     $DB->update_record('capabilities', $updatecap);
2676                 }
2677                 if ($cachedcap->riskbitmask != $filecaps[$cachedcap->name]['riskbitmask']) {
2678                     $updatecap = new stdClass();
2679                     $updatecap->id = $cachedcap->id;
2680                     $updatecap->riskbitmask = $filecaps[$cachedcap->name]['riskbitmask'];
2681                     $DB->update_record('capabilities', $updatecap);
2682                 }
2684                 if (!array_key_exists('contextlevel', $filecaps[$cachedcap->name])) {
2685                     $filecaps[$cachedcap->name]['contextlevel'] = 0; // no context level defined
2686                 }
2687                 if ($cachedcap->contextlevel != $filecaps[$cachedcap->name]['contextlevel']) {
2688                     $updatecap = new stdClass();
2689                     $updatecap->id = $cachedcap->id;
2690                     $updatecap->contextlevel = $filecaps[$cachedcap->name]['contextlevel'];
2691                     $DB->update_record('capabilities', $updatecap);
2692                 }
2693             }
2694         }
2695     }
2697     // Are there new capabilities in the file definition?
2698     $newcaps = array();
2700     foreach ($filecaps as $filecap => $def) {
2701         if (!$storedcaps ||
2702                 ($storedcaps && in_array($filecap, $storedcaps) === false)) {
2703             if (!array_key_exists('riskbitmask', $def)) {
2704                 $def['riskbitmask'] = 0; // no risk if not specified
2705             }
2706             $newcaps[$filecap] = $def;
2707         }
2708     }
2709     // Add new capabilities to the stored definition.
2710     $existingcaps = $DB->get_records_menu('capabilities', array(), 'id', 'id, name');
2711     foreach ($newcaps as $capname => $capdef) {
2712         $capability = new stdClass();
2713         $capability->name         = $capname;
2714         $capability->captype      = $capdef['captype'];
2715         $capability->contextlevel = $capdef['contextlevel'];
2716         $capability->component    = $component;
2717         $capability->riskbitmask  = $capdef['riskbitmask'];
2719         $DB->insert_record('capabilities', $capability, false);
2721         if (isset($capdef['clonepermissionsfrom']) && in_array($capdef['clonepermissionsfrom'], $existingcaps)){
2722             if ($rolecapabilities = $DB->get_records('role_capabilities', array('capability'=>$capdef['clonepermissionsfrom']))){
2723                 foreach ($rolecapabilities as $rolecapability){
2724                     //assign_capability will update rather than insert if capability exists
2725                     if (!assign_capability($capname, $rolecapability->permission,
2726                                             $rolecapability->roleid, $rolecapability->contextid, true)){
2727                          echo $OUTPUT->notification('Could not clone capabilities for '.$capname);
2728                     }
2729                 }
2730             }
2731         // we ignore archetype key if we have cloned permissions
2732         } else if (isset($capdef['archetypes']) && is_array($capdef['archetypes'])) {
2733             assign_legacy_capabilities($capname, $capdef['archetypes']);
2734         // 'legacy' is for backward compatibility with 1.9 access.php
2735         } else if (isset($capdef['legacy']) && is_array($capdef['legacy'])) {
2736             assign_legacy_capabilities($capname, $capdef['legacy']);
2737         }
2738     }
2739     // Are there any capabilities that have been removed from the file
2740     // definition that we need to delete from the stored capabilities and
2741     // role assignments?
2742     capabilities_cleanup($component, $filecaps);
2744     // reset static caches
2745     accesslib_clear_all_caches(false);
2747     return true;
2750 /**
2751  * Deletes cached capabilities that are no longer needed by the component.
2752  * Also unassigns these capabilities from any roles that have them.
2753  * NOTE: this function is called from lib/db/upgrade.php
2754  *
2755  * @access private
2756  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
2757  * @param array $newcapdef array of the new capability definitions that will be
2758  *                     compared with the cached capabilities
2759  * @return int number of deprecated capabilities that have been removed
2760  */
2761 function capabilities_cleanup($component, $newcapdef = null) {
2762     global $DB;
2764     $removedcount = 0;
2766     if ($cachedcaps = get_cached_capabilities($component)) {
2767         foreach ($cachedcaps as $cachedcap) {
2768             if (empty($newcapdef) ||
2769                         array_key_exists($cachedcap->name, $newcapdef) === false) {
2771                 // Remove from capabilities cache.
2772                 $DB->delete_records('capabilities', array('name'=>$cachedcap->name));
2773                 $removedcount++;
2774                 // Delete from roles.
2775                 if ($roles = get_roles_with_capability($cachedcap->name)) {
2776                     foreach($roles as $role) {
2777                         if (!unassign_capability($cachedcap->name, $role->id)) {
2778                             print_error('cannotunassigncap', 'error', '', (object)array('cap'=>$cachedcap->name, 'role'=>$role->name));
2779                         }
2780                     }
2781                 }
2782             } // End if.
2783         }
2784     }
2785     return $removedcount;
2788 /**
2789  * Returns an array of all the known types of risk
2790  * The array keys can be used, for example as CSS class names, or in calls to
2791  * print_risk_icon. The values are the corresponding RISK_ constants.
2792  *
2793  * @return array all the known types of risk.
2794  */
2795 function get_all_risks() {
2796     return array(
2797         'riskmanagetrust' => RISK_MANAGETRUST,
2798         'riskconfig'      => RISK_CONFIG,
2799         'riskxss'         => RISK_XSS,
2800         'riskpersonal'    => RISK_PERSONAL,
2801         'riskspam'        => RISK_SPAM,
2802         'riskdataloss'    => RISK_DATALOSS,
2803     );
2806 /**
2807  * Return a link to moodle docs for a given capability name
2808  *
2809  * @param stdClass $capability a capability - a row from the mdl_capabilities table.
2810  * @return string the human-readable capability name as a link to Moodle Docs.
2811  */
2812 function get_capability_docs_link($capability) {
2813     $url = get_docs_url('Capabilities/' . $capability->name);
2814     return '<a onclick="this.target=\'docspopup\'" href="' . $url . '">' . get_capability_string($capability->name) . '</a>';
2817 /**
2818  * This function pulls out all the resolved capabilities (overrides and
2819  * defaults) of a role used in capability overrides in contexts at a given
2820  * context.
2821  *
2822  * @param int $roleid
2823  * @param context $context
2824  * @param string $cap capability, optional, defaults to ''
2825  * @return array Array of capabilities
2826  */
2827 function role_context_capabilities($roleid, context $context, $cap = '') {
2828     global $DB;
2830     $contexts = $context->get_parent_context_ids(true);
2831     $contexts = '('.implode(',', $contexts).')';
2833     $params = array($roleid);
2835     if ($cap) {
2836         $search = " AND rc.capability = ? ";
2837         $params[] = $cap;
2838     } else {
2839         $search = '';
2840     }
2842     $sql = "SELECT rc.*
2843               FROM {role_capabilities} rc, {context} c
2844              WHERE rc.contextid in $contexts
2845                    AND rc.roleid = ?
2846                    AND rc.contextid = c.id $search
2847           ORDER BY c.contextlevel DESC, rc.capability DESC";
2849     $capabilities = array();
2851     if ($records = $DB->get_records_sql($sql, $params)) {
2852         // We are traversing via reverse order.
2853         foreach ($records as $record) {
2854             // If not set yet (i.e. inherit or not set at all), or currently we have a prohibit
2855             if (!isset($capabilities[$record->capability]) || $record->permission<-500) {
2856                 $capabilities[$record->capability] = $record->permission;
2857             }
2858         }
2859     }
2860     return $capabilities;
2863 /**
2864  * Constructs array with contextids as first parameter and context paths,
2865  * in both cases bottom top including self.
2866  *
2867  * @access private
2868  * @param context $context
2869  * @return array
2870  */
2871 function get_context_info_list(context $context) {
2872     $contextids = explode('/', ltrim($context->path, '/'));
2873     $contextpaths = array();
2874     $contextids2 = $contextids;
2875     while ($contextids2) {
2876         $contextpaths[] = '/' . implode('/', $contextids2);
2877         array_pop($contextids2);
2878     }
2879     return array($contextids, $contextpaths);
2882 /**
2883  * Check if context is the front page context or a context inside it
2884  *
2885  * Returns true if this context is the front page context, or a context inside it,
2886  * otherwise false.
2887  *
2888  * @param context $context a context object.
2889  * @return bool
2890  */
2891 function is_inside_frontpage(context $context) {
2892     $frontpagecontext = context_course::instance(SITEID);
2893     return strpos($context->path . '/', $frontpagecontext->path . '/') === 0;
2896 /**
2897  * Returns capability information (cached)
2898  *
2899  * @param string $capabilityname
2900  * @return stdClass or null if capability not found
2901  */
2902 function get_capability_info($capabilityname) {
2903     global $ACCESSLIB_PRIVATE, $DB; // one request per page only
2905     //TODO: MUC - this could be cached in shared memory, it would eliminate 1 query per page
2907     if (empty($ACCESSLIB_PRIVATE->capabilities)) {
2908         $ACCESSLIB_PRIVATE->capabilities = array();
2909         $caps = $DB->get_records('capabilities', array(), 'id, name, captype, riskbitmask');
2910         foreach ($caps as $cap) {
2911             $capname = $cap->name;
2912             unset($cap->id);
2913             unset($cap->name);
2914             $cap->riskbitmask = (int)$cap->riskbitmask;
2915             $ACCESSLIB_PRIVATE->capabilities[$capname] = $cap;
2916         }
2917     }
2919     return isset($ACCESSLIB_PRIVATE->capabilities[$capabilityname]) ? $ACCESSLIB_PRIVATE->capabilities[$capabilityname] : null;
2922 /**
2923  * Returns the human-readable, translated version of the capability.
2924  * Basically a big switch statement.
2925  *
2926  * @param string $capabilityname e.g. mod/choice:readresponses
2927  * @return string
2928  */
2929 function get_capability_string($capabilityname) {
2931     // Typical capability name is 'plugintype/pluginname:capabilityname'
2932     list($type, $name, $capname) = preg_split('|[/:]|', $capabilityname);
2934     if ($type === 'moodle') {
2935         $component = 'core_role';
2936     } else if ($type === 'quizreport') {
2937         //ugly hack!!
2938         $component = 'quiz_'.$name;
2939     } else {
2940         $component = $type.'_'.$name;
2941     }
2943     $stringname = $name.':'.$capname;
2945     if ($component === 'core_role' or get_string_manager()->string_exists($stringname, $component)) {
2946         return get_string($stringname, $component);
2947     }
2949     $dir = core_component::get_component_directory($component);
2950     if (!file_exists($dir)) {
2951         // plugin broken or does not exist, do not bother with printing of debug message
2952         return $capabilityname.' ???';
2953     }
2955     // something is wrong in plugin, better print debug
2956     return get_string($stringname, $component);
2959 /**
2960  * This gets the mod/block/course/core etc strings.
2961  *
2962  * @param string $component
2963  * @param int $contextlevel
2964  * @return string|bool String is success, false if failed
2965  */
2966 function get_component_string($component, $contextlevel) {
2968     if ($component === 'moodle' or $component === 'core') {
2969         switch ($contextlevel) {
2970             // TODO: this should probably use context level names instead
2971             case CONTEXT_SYSTEM:    return get_string('coresystem');
2972             case CONTEXT_USER:      return get_string('users');
2973             case CONTEXT_COURSECAT: return get_string('categories');
2974             case CONTEXT_COURSE:    return get_string('course');
2975             case CONTEXT_MODULE:    return get_string('activities');
2976             case CONTEXT_BLOCK:     return get_string('block');
2977             default:                print_error('unknowncontext');
2978         }
2979     }
2981     list($type, $name) = core_component::normalize_component($component);
2982     $dir = core_component::get_plugin_directory($type, $name);
2983     if (!file_exists($dir)) {
2984         // plugin not installed, bad luck, there is no way to find the name
2985         return $component.' ???';
2986     }
2988     switch ($type) {
2989         // TODO: this is really hacky, anyway it should be probably moved to lib/pluginlib.php
2990         case 'quiz':         return get_string($name.':componentname', $component);// insane hack!!!
2991         case 'repository':   return get_string('repository', 'repository').': '.get_string('pluginname', $component);
2992         case 'gradeimport':  return get_string('gradeimport', 'grades').': '.get_string('pluginname', $component);
2993         case 'gradeexport':  return get_string('gradeexport', 'grades').': '.get_string('pluginname', $component);
2994         case 'gradereport':  return get_string('gradereport', 'grades').': '.get_string('pluginname', $component);
2995         case 'webservice':   return get_string('webservice', 'webservice').': '.get_string('pluginname', $component);
2996         case 'block':        return get_string('block').': '.get_string('pluginname', basename($component));
2997         case 'mod':
2998             if (get_string_manager()->string_exists('pluginname', $component)) {
2999                 return get_string('activity').': '.get_string('pluginname', $component);
3000             } else {
3001                 return get_string('activity').': '.get_string('modulename', $component);
3002             }
3003         default: return get_string('pluginname', $component);
3004     }
3007 /**
3008  * Gets the list of roles assigned to this context and up (parents)
3009  * from the list of roles that are visible on user profile page
3010  * and participants page.
3011  *
3012  * @param context $context
3013  * @return array
3014  */
3015 function get_profile_roles(context $context) {
3016     global $CFG, $DB;
3018     if (empty($CFG->profileroles)) {
3019         return array();
3020     }
3022     list($rallowed, $params) = $DB->get_in_or_equal(explode(',', $CFG->profileroles), SQL_PARAMS_NAMED, 'a');
3023     list($contextlist, $cparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'p');
3024     $params = array_merge($params, $cparams);
3026     if ($coursecontext = $context->get_course_context(false)) {
3027         $params['coursecontext'] = $coursecontext->id;
3028     } else {
3029         $params['coursecontext'] = 0;
3030     }
3032     $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder, rn.name AS coursealias
3033               FROM {role_assignments} ra, {role} r
3034          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3035              WHERE r.id = ra.roleid
3036                    AND ra.contextid $contextlist
3037                    AND r.id $rallowed
3038           ORDER BY r.sortorder ASC";
3040     return $DB->get_records_sql($sql, $params);
3043 /**
3044  * Gets the list of roles assigned to this context and up (parents)
3045  *
3046  * @param context $context
3047  * @return array
3048  */
3049 function get_roles_used_in_context(context $context) {
3050     global $DB;
3052     list($contextlist, $params) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'cl');
3054     if ($coursecontext = $context->get_course_context(false)) {
3055         $params['coursecontext'] = $coursecontext->id;
3056     } else {
3057         $params['coursecontext'] = 0;
3058     }
3060     $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder, rn.name AS coursealias
3061               FROM {role_assignments} ra, {role} r
3062          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3063              WHERE r.id = ra.roleid
3064                    AND ra.contextid $contextlist
3065           ORDER BY r.sortorder ASC";
3067     return $DB->get_records_sql($sql, $params);
3070 /**
3071  * This function is used to print roles column in user profile page.
3072  * It is using the CFG->profileroles to limit the list to only interesting roles.
3073  * (The permission tab has full details of user role assignments.)
3074  *
3075  * @param int $userid
3076  * @param int $courseid
3077  * @return string
3078  */
3079 function get_user_roles_in_course($userid, $courseid) {
3080     global $CFG, $DB;
3082     if (empty($CFG->profileroles)) {
3083         return '';
3084     }
3086     if ($courseid == SITEID) {
3087         $context = context_system::instance();
3088     } else {
3089         $context = context_course::instance($courseid);
3090     }
3092     if (empty($CFG->profileroles)) {
3093         return array();
3094     }
3096     list($rallowed, $params) = $DB->get_in_or_equal(explode(',', $CFG->profileroles), SQL_PARAMS_NAMED, 'a');
3097     list($contextlist, $cparams) = $DB->get_in_or_equal($context->get_parent_context_ids(true), SQL_PARAMS_NAMED, 'p');
3098     $params = array_merge($params, $cparams);
3100     if ($coursecontext = $context->get_course_context(false)) {
3101         $params['coursecontext'] = $coursecontext->id;
3102     } else {
3103         $params['coursecontext'] = 0;
3104     }
3106     $sql = "SELECT DISTINCT r.id, r.name, r.shortname, r.sortorder, rn.name AS coursealias
3107               FROM {role_assignments} ra, {role} r
3108          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3109              WHERE r.id = ra.roleid
3110                    AND ra.contextid $contextlist
3111                    AND r.id $rallowed
3112                    AND ra.userid = :userid
3113           ORDER BY r.sortorder ASC";
3114     $params['userid'] = $userid;
3116     $rolestring = '';
3118     if ($roles = $DB->get_records_sql($sql, $params)) {
3119         $rolenames = role_fix_names($roles, $context, ROLENAME_ALIAS, true);   // Substitute aliases
3121         foreach ($rolenames as $roleid => $rolename) {
3122             $rolenames[$roleid] = '<a href="'.$CFG->wwwroot.'/user/index.php?contextid='.$context->id.'&amp;roleid='.$roleid.'">'.$rolename.'</a>';
3123         }
3124         $rolestring = implode(',', $rolenames);
3125     }
3127     return $rolestring;
3130 /**
3131  * Checks if a user can assign users to a particular role in this context
3132  *
3133  * @param context $context
3134  * @param int $targetroleid - the id of the role you want to assign users to
3135  * @return boolean
3136  */
3137 function user_can_assign(context $context, $targetroleid) {
3138     global $DB;
3140     // First check to see if the user is a site administrator.
3141     if (is_siteadmin()) {
3142         return true;
3143     }
3145     // Check if user has override capability.
3146     // If not return false.
3147     if (!has_capability('moodle/role:assign', $context)) {
3148         return false;
3149     }
3150     // pull out all active roles of this user from this context(or above)
3151     if ($userroles = get_user_roles($context)) {
3152         foreach ($userroles as $userrole) {
3153             // if any in the role_allow_override table, then it's ok
3154             if ($DB->get_record('role_allow_assign', array('roleid'=>$userrole->roleid, 'allowassign'=>$targetroleid))) {
3155                 return true;
3156             }
3157         }
3158     }
3160     return false;
3163 /**
3164  * Returns all site roles in correct sort order.
3165  *
3166  * Note: this method does not localise role names or descriptions,
3167  *       use role_get_names() if you need role names.
3168  *
3169  * @param context $context optional context for course role name aliases
3170  * @return array of role records with optional coursealias property
3171  */
3172 function get_all_roles(context $context = null) {
3173     global $DB;
3175     if (!$context or !$coursecontext = $context->get_course_context(false)) {
3176         $coursecontext = null;
3177     }
3179     if ($coursecontext) {
3180         $sql = "SELECT r.*, rn.name AS coursealias
3181                   FROM {role} r
3182              LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3183               ORDER BY r.sortorder ASC";
3184         return $DB->get_records_sql($sql, array('coursecontext'=>$coursecontext->id));
3186     } else {
3187         return $DB->get_records('role', array(), 'sortorder ASC');
3188     }
3191 /**
3192  * Returns roles of a specified archetype
3193  *
3194  * @param string $archetype
3195  * @return array of full role records
3196  */
3197 function get_archetype_roles($archetype) {
3198     global $DB;
3199     return $DB->get_records('role', array('archetype'=>$archetype), 'sortorder ASC');
3202 /**
3203  * Gets all the user roles assigned in this context, or higher contexts
3204  * this is mainly used when checking if a user can assign a role, or overriding a role
3205  * i.e. we need to know what this user holds, in order to verify against allow_assign and
3206  * allow_override tables
3207  *
3208  * @param context $context
3209  * @param int $userid
3210  * @param bool $checkparentcontexts defaults to true
3211  * @param string $order defaults to 'c.contextlevel DESC, r.sortorder ASC'
3212  * @return array
3213  */
3214 function get_user_roles(context $context, $userid = 0, $checkparentcontexts = true, $order = 'c.contextlevel DESC, r.sortorder ASC') {
3215     global $USER, $DB;
3217     if (empty($userid)) {
3218         if (empty($USER->id)) {
3219             return array();
3220         }
3221         $userid = $USER->id;
3222     }
3224     if ($checkparentcontexts) {
3225         $contextids = $context->get_parent_context_ids();
3226     } else {
3227         $contextids = array();
3228     }
3229     $contextids[] = $context->id;
3231     list($contextids, $params) = $DB->get_in_or_equal($contextids, SQL_PARAMS_QM);
3233     array_unshift($params, $userid);
3235     $sql = "SELECT ra.*, r.name, r.shortname
3236               FROM {role_assignments} ra, {role} r, {context} c
3237              WHERE ra.userid = ?
3238                    AND ra.roleid = r.id
3239                    AND ra.contextid = c.id
3240                    AND ra.contextid $contextids
3241           ORDER BY $order";
3243     return $DB->get_records_sql($sql ,$params);
3246 /**
3247  * Like get_user_roles, but adds in the authenticated user role, and the front
3248  * page roles, if applicable.
3249  *
3250  * @param context $context the context.
3251  * @param int $userid optional. Defaults to $USER->id
3252  * @return array of objects with fields ->userid, ->contextid and ->roleid.
3253  */
3254 function get_user_roles_with_special(context $context, $userid = 0) {
3255     global $CFG, $USER;
3257     if (empty($userid)) {
3258         if (empty($USER->id)) {
3259             return array();
3260         }
3261         $userid = $USER->id;
3262     }
3264     $ras = get_user_roles($context, $userid);
3266     // Add front-page role if relevant.
3267     $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid) ? $CFG->defaultfrontpageroleid : 0;
3268     $isfrontpage = ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID) ||
3269             is_inside_frontpage($context);
3270     if ($defaultfrontpageroleid && $isfrontpage) {
3271         $frontpagecontext = context_course::instance(SITEID);
3272         $ra = new stdClass();
3273         $ra->userid = $userid;
3274         $ra->contextid = $frontpagecontext->id;
3275         $ra->roleid = $defaultfrontpageroleid;
3276         $ras[] = $ra;
3277     }
3279     // Add authenticated user role if relevant.
3280     $defaultuserroleid      = isset($CFG->defaultuserroleid) ? $CFG->defaultuserroleid : 0;
3281     if ($defaultuserroleid && !isguestuser($userid)) {
3282         $systemcontext = context_system::instance();
3283         $ra = new stdClass();
3284         $ra->userid = $userid;
3285         $ra->contextid = $systemcontext->id;
3286         $ra->roleid = $defaultuserroleid;
3287         $ras[] = $ra;
3288     }
3290     return $ras;
3293 /**
3294  * Creates a record in the role_allow_override table
3295  *
3296  * @param int $sroleid source roleid
3297  * @param int $troleid target roleid
3298  * @return void
3299  */
3300 function allow_override($sroleid, $troleid) {
3301     global $DB;
3303     $record = new stdClass();
3304     $record->roleid        = $sroleid;
3305     $record->allowoverride = $troleid;
3306     $DB->insert_record('role_allow_override', $record);
3309 /**
3310  * Creates a record in the role_allow_assign table
3311  *
3312  * @param int $fromroleid source roleid
3313  * @param int $targetroleid target roleid
3314  * @return void
3315  */
3316 function allow_assign($fromroleid, $targetroleid) {
3317     global $DB;
3319     $record = new stdClass();
3320     $record->roleid      = $fromroleid;
3321     $record->allowassign = $targetroleid;
3322     $DB->insert_record('role_allow_assign', $record);
3325 /**
3326  * Creates a record in the role_allow_switch table
3327  *
3328  * @param int $fromroleid source roleid
3329  * @param int $targetroleid target roleid
3330  * @return void
3331  */
3332 function allow_switch($fromroleid, $targetroleid) {
3333     global $DB;
3335     $record = new stdClass();
3336     $record->roleid      = $fromroleid;
3337     $record->allowswitch = $targetroleid;
3338     $DB->insert_record('role_allow_switch', $record);
3341 /**
3342  * Gets a list of roles that this user can assign in this context
3343  *
3344  * @param context $context the context.
3345  * @param int $rolenamedisplay the type of role name to display. One of the
3346  *      ROLENAME_X constants. Default ROLENAME_ALIAS.
3347  * @param bool $withusercounts if true, count the number of users with each role.
3348  * @param integer|object $user A user id or object. By default (null) checks the permissions of the current user.
3349  * @return array if $withusercounts is false, then an array $roleid => $rolename.
3350  *      if $withusercounts is true, returns a list of three arrays,
3351  *      $rolenames, $rolecounts, and $nameswithcounts.
3352  */
3353 function get_assignable_roles(context $context, $rolenamedisplay = ROLENAME_ALIAS, $withusercounts = false, $user = null) {
3354     global $USER, $DB;
3356     // make sure there is a real user specified
3357     if ($user === null) {
3358         $userid = isset($USER->id) ? $USER->id : 0;
3359     } else {
3360         $userid = is_object($user) ? $user->id : $user;
3361     }
3363     if (!has_capability('moodle/role:assign', $context, $userid)) {
3364         if ($withusercounts) {
3365             return array(array(), array(), array());
3366         } else {
3367             return array();
3368         }
3369     }
3371     $params = array();
3372     $extrafields = '';
3374     if ($withusercounts) {
3375         $extrafields = ', (SELECT count(u.id)
3376                              FROM {role_assignments} cra JOIN {user} u ON cra.userid = u.id
3377                             WHERE cra.roleid = r.id AND cra.contextid = :conid AND u.deleted = 0
3378                           ) AS usercount';
3379         $params['conid'] = $context->id;
3380     }
3382     if (is_siteadmin($userid)) {
3383         // show all roles allowed in this context to admins
3384         $assignrestriction = "";
3385     } else {
3386         $parents = $context->get_parent_context_ids(true);
3387         $contexts = implode(',' , $parents);
3388         $assignrestriction = "JOIN (SELECT DISTINCT raa.allowassign AS id
3389                                       FROM {role_allow_assign} raa
3390                                       JOIN {role_assignments} ra ON ra.roleid = raa.roleid
3391                                      WHERE ra.userid = :userid AND ra.contextid IN ($contexts)
3392                                    ) ar ON ar.id = r.id";
3393         $params['userid'] = $userid;
3394     }
3395     $params['contextlevel'] = $context->contextlevel;
3397     if ($coursecontext = $context->get_course_context(false)) {
3398         $params['coursecontext'] = $coursecontext->id;
3399     } else {
3400         $params['coursecontext'] = 0; // no course aliases
3401         $coursecontext = null;
3402     }
3403     $sql = "SELECT r.id, r.name, r.shortname, rn.name AS coursealias $extrafields
3404               FROM {role} r
3405               $assignrestriction
3406               JOIN {role_context_levels} rcl ON (rcl.contextlevel = :contextlevel AND r.id = rcl.roleid)
3407          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3408           ORDER BY r.sortorder ASC";
3409     $roles = $DB->get_records_sql($sql, $params);
3411     $rolenames = role_fix_names($roles, $coursecontext, $rolenamedisplay, true);
3413     if (!$withusercounts) {
3414         return $rolenames;
3415     }
3417     $rolecounts = array();
3418     $nameswithcounts = array();
3419     foreach ($roles as $role) {
3420         $nameswithcounts[$role->id] = $rolenames[$role->id] . ' (' . $roles[$role->id]->usercount . ')';
3421         $rolecounts[$role->id] = $roles[$role->id]->usercount;
3422     }
3423     return array($rolenames, $rolecounts, $nameswithcounts);
3426 /**
3427  * Gets a list of roles that this user can switch to in a context
3428  *
3429  * Gets a list of roles that this user can switch to in a context, for the switchrole menu.
3430  * This function just process the contents of the role_allow_switch table. You also need to
3431  * test the moodle/role:switchroles to see if the user is allowed to switch in the first place.
3432  *
3433  * @param context $context a context.
3434  * @return array an array $roleid => $rolename.
3435  */
3436 function get_switchable_roles(context $context) {
3437     global $USER, $DB;
3439     $params = array();
3440     $extrajoins = '';
3441     $extrawhere = '';
3442     if (!is_siteadmin()) {
3443         // Admins are allowed to switch to any role with.
3444         // Others are subject to the additional constraint that the switch-to role must be allowed by
3445         // 'role_allow_switch' for some role they have assigned in this context or any parent.
3446         $parents = $context->get_parent_context_ids(true);
3447         $contexts = implode(',' , $parents);
3449         $extrajoins = "JOIN {role_allow_switch} ras ON ras.allowswitch = rc.roleid
3450         JOIN {role_assignments} ra ON ra.roleid = ras.roleid";
3451         $extrawhere = "WHERE ra.userid = :userid AND ra.contextid IN ($contexts)";
3452         $params['userid'] = $USER->id;
3453     }
3455     if ($coursecontext = $context->get_course_context(false)) {
3456         $params['coursecontext'] = $coursecontext->id;
3457     } else {
3458         $params['coursecontext'] = 0; // no course aliases
3459         $coursecontext = null;
3460     }
3462     $query = "
3463         SELECT r.id, r.name, r.shortname, rn.name AS coursealias
3464           FROM (SELECT DISTINCT rc.roleid
3465                   FROM {role_capabilities} rc
3466                   $extrajoins
3467                   $extrawhere) idlist
3468           JOIN {role} r ON r.id = idlist.roleid
3469      LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3470       ORDER BY r.sortorder";
3471     $roles = $DB->get_records_sql($query, $params);
3473     return role_fix_names($roles, $context, ROLENAME_ALIAS, true);
3476 /**
3477  * Gets a list of roles that this user can override in this context.
3478  *
3479  * @param context $context the context.
3480  * @param int $rolenamedisplay the type of role name to display. One of the
3481  *      ROLENAME_X constants. Default ROLENAME_ALIAS.
3482  * @param bool $withcounts if true, count the number of overrides that are set for each role.
3483  * @return array if $withcounts is false, then an array $roleid => $rolename.
3484  *      if $withusercounts is true, returns a list of three arrays,
3485  *      $rolenames, $rolecounts, and $nameswithcounts.
3486  */
3487 function get_overridable_roles(context $context, $rolenamedisplay = ROLENAME_ALIAS, $withcounts = false) {
3488     global $USER, $DB;
3490     if (!has_any_capability(array('moodle/role:safeoverride', 'moodle/role:override'), $context)) {
3491         if ($withcounts) {
3492             return array(array(), array(), array());
3493         } else {
3494             return array();
3495         }
3496     }
3498     $parents = $context->get_parent_context_ids(true);
3499     $contexts = implode(',' , $parents);
3501     $params = array();
3502     $extrafields = '';
3504     $params['userid'] = $USER->id;
3505     if ($withcounts) {
3506         $extrafields = ', (SELECT COUNT(rc.id) FROM {role_capabilities} rc
3507                 WHERE rc.roleid = ro.id AND rc.contextid = :conid) AS overridecount';
3508         $params['conid'] = $context->id;
3509     }
3511     if ($coursecontext = $context->get_course_context(false)) {
3512         $params['coursecontext'] = $coursecontext->id;
3513     } else {
3514         $params['coursecontext'] = 0; // no course aliases
3515         $coursecontext = null;
3516     }
3518     if (is_siteadmin()) {
3519         // show all roles to admins
3520         $roles = $DB->get_records_sql("
3521             SELECT ro.id, ro.name, ro.shortname, rn.name AS coursealias $extrafields
3522               FROM {role} ro
3523          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = ro.id)
3524           ORDER BY ro.sortorder ASC", $params);
3526     } else {
3527         $roles = $DB->get_records_sql("
3528             SELECT ro.id, ro.name, ro.shortname, rn.name AS coursealias $extrafields
3529               FROM {role} ro
3530               JOIN (SELECT DISTINCT r.id
3531                       FROM {role} r
3532                       JOIN {role_allow_override} rao ON r.id = rao.allowoverride
3533                       JOIN {role_assignments} ra ON rao.roleid = ra.roleid
3534                      WHERE ra.userid = :userid AND ra.contextid IN ($contexts)
3535                    ) inline_view ON ro.id = inline_view.id
3536          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = ro.id)
3537           ORDER BY ro.sortorder ASC", $params);
3538     }
3540     $rolenames = role_fix_names($roles, $context, $rolenamedisplay, true);
3542     if (!$withcounts) {
3543         return $rolenames;
3544     }
3546     $rolecounts = array();
3547     $nameswithcounts = array();
3548     foreach ($roles as $role) {
3549         $nameswithcounts[$role->id] = $rolenames[$role->id] . ' (' . $roles[$role->id]->overridecount . ')';
3550         $rolecounts[$role->id] = $roles[$role->id]->overridecount;
3551     }
3552     return array($rolenames, $rolecounts, $nameswithcounts);
3555 /**
3556  * Create a role menu suitable for default role selection in enrol plugins.
3557  *
3558  * @package    core_enrol
3559  *
3560  * @param context $context
3561  * @param int $addroleid current or default role - always added to list
3562  * @return array roleid=>localised role name
3563  */
3564 function get_default_enrol_roles(context $context, $addroleid = null) {
3565     global $DB;
3567     $params = array('contextlevel'=>CONTEXT_COURSE);
3569     if ($coursecontext = $context->get_course_context(false)) {
3570         $params['coursecontext'] = $coursecontext->id;
3571     } else {
3572         $params['coursecontext'] = 0; // no course names
3573         $coursecontext = null;
3574     }
3576     if ($addroleid) {
3577         $addrole = "OR r.id = :addroleid";
3578         $params['addroleid'] = $addroleid;
3579     } else {
3580         $addrole = "";
3581     }
3583     $sql = "SELECT r.id, r.name, r.shortname, rn.name AS coursealias
3584               FROM {role} r
3585          LEFT JOIN {role_context_levels} rcl ON (rcl.roleid = r.id AND rcl.contextlevel = :contextlevel)
3586          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
3587              WHERE rcl.id IS NOT NULL $addrole
3588           ORDER BY sortorder DESC";
3590     $roles = $DB->get_records_sql($sql, $params);
3592     return role_fix_names($roles, $context, ROLENAME_BOTH, true);
3595 /**
3596  * Return context levels where this role is assignable.
3597  *
3598  * @param integer $roleid the id of a role.
3599  * @return array list of the context levels at which this role may be assigned.
3600  */
3601 function get_role_contextlevels($roleid) {
3602     global $DB;
3603     return $DB->get_records_menu('role_context_levels', array('roleid' => $roleid),
3604             'contextlevel', 'id,contextlevel');
3607 /**
3608  * Return roles suitable for assignment at the specified context level.
3609  *
3610  * NOTE: this function name looks like a typo, should be probably get_roles_for_contextlevel()
3611  *
3612  * @param integer $contextlevel a contextlevel.
3613  * @return array list of role ids that are assignable at this context level.
3614  */
3615 function get_roles_for_contextlevels($contextlevel) {
3616     global $DB;
3617     return $DB->get_records_menu('role_context_levels', array('contextlevel' => $contextlevel),
3618             '', 'id,roleid');
3621 /**
3622  * Returns default context levels where roles can be assigned.
3623  *
3624  * @param string $rolearchetype one of the role archetypes - that is, one of the keys
3625  *      from the array returned by get_role_archetypes();
3626  * @return array list of the context levels at which this type of role may be assigned by default.
3627  */
3628 function get_default_contextlevels($rolearchetype) {
3629     static $defaults = array(
3630         'manager'        => array(CONTEXT_SYSTEM, CONTEXT_COURSECAT, CONTEXT_COURSE),
3631         'coursecreator'  => array(CONTEXT_SYSTEM, CONTEXT_COURSECAT),
3632         'editingteacher' => array(CONTEXT_COURSE, CONTEXT_MODULE),
3633         'teacher'        => array(CONTEXT_COURSE, CONTEXT_MODULE),
3634         'student'        => array(CONTEXT_COURSE, CONTEXT_MODULE),
3635         'guest'          => array(),
3636         'user'           => array(),
3637         'frontpage'      => array());
3639     if (isset($defaults[$rolearchetype])) {
3640         return $defaults[$rolearchetype];
3641     } else {
3642         return array();
3643     }
3646 /**
3647  * Set the context levels at which a particular role can be assigned.
3648  * Throws exceptions in case of error.
3649  *
3650  * @param integer $roleid the id of a role.
3651  * @param array $contextlevels the context levels at which this role should be assignable,
3652  *      duplicate levels are removed.
3653  * @return void
3654  */
3655 function set_role_contextlevels($roleid, array $contextlevels) {
3656     global $DB;
3657     $DB->delete_records('role_context_levels', array('roleid' => $roleid));
3658     $rcl = new stdClass();
3659     $rcl->roleid = $roleid;
3660     $contextlevels = array_unique($contextlevels);
3661     foreach ($contextlevels as $level) {
3662         $rcl->contextlevel = $level;
3663         $DB->insert_record('role_context_levels', $rcl, false, true);
3664     }
3667 /**
3668  * Who has this capability in this context?
3669  *
3670  * This can be a very expensive call - use sparingly and keep
3671  * the results if you are going to need them again soon.
3672  *
3673  * Note if $fields is empty this function attempts to get u.*
3674  * which can get rather large - and has a serious perf impact
3675  * on some DBs.
3676  *
3677  * @param context $context
3678  * @param string|array $capability - capability name(s)
3679  * @param string $fields - fields to be pulled. The user table is aliased to 'u'. u.id MUST be included.
3680  * @param string $sort - the sort order. Default is lastaccess time.
3681  * @param mixed $limitfrom - number of records to skip (offset)
3682  * @param mixed $limitnum - number of records to fetch
3683  * @param string|array $groups - single group or array of groups - only return
3684  *               users who are in one of these group(s).
3685  * @param string|array $exceptions - list of users to exclude, comma separated or array
3686  * @param bool $doanything_ignored not used any more, admin accounts are never returned
3687  * @param bool $view_ignored - use get_enrolled_sql() instead
3688  * @param bool $useviewallgroups if $groups is set the return users who
3689  *               have capability both $capability and moodle/site:accessallgroups
3690  *               in this context, as well as users who have $capability and who are
3691  *               in $groups.
3692  * @return array of user records
3693  */
3694 function get_users_by_capability(context $context, $capability, $fields = '', $sort = '', $limitfrom = '', $limitnum = '',
3695                                  $groups = '', $exceptions = '', $doanything_ignored = null, $view_ignored = null, $useviewallgroups = false) {
3696     global $CFG, $DB;
3698     $defaultuserroleid      = isset($CFG->defaultuserroleid) ? $CFG->defaultuserroleid : 0;
3699     $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid) ? $CFG->defaultfrontpageroleid : 0;
3701     $ctxids = trim($context->path, '/');
3702     $ctxids = str_replace('/', ',', $ctxids);
3704     // Context is the frontpage
3705     $iscoursepage = false; // coursepage other than fp
3706     $isfrontpage = false;
3707     if ($context->contextlevel == CONTEXT_COURSE) {
3708         if ($context->instanceid == SITEID) {
3709             $isfrontpage = true;
3710         } else {
3711             $iscoursepage = true;
3712         }
3713     }
3714     $isfrontpage = ($isfrontpage || is_inside_frontpage($context));
3716     $caps = (array)$capability;
3718     // construct list of context paths bottom-->top
3719     list($contextids, $paths) = get_context_info_list($context);
3721     // we need to find out all roles that have these capabilities either in definition or in overrides
3722     $defs = array();
3723     list($incontexts, $params) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED, 'con');
3724     list($incaps, $params2) = $DB->get_in_or_equal($caps, SQL_PARAMS_NAMED, 'cap');
3725     $params = array_merge($params, $params2);
3726     $sql = "SELECT rc.id, rc.roleid, rc.permission, rc.capability, ctx.path
3727               FROM {role_capabilities} rc
3728               JOIN {context} ctx on rc.contextid = ctx.id
3729              WHERE rc.contextid $incontexts AND rc.capability $incaps";
3731     $rcs = $DB->get_records_sql($sql, $params);
3732     foreach ($rcs as $rc) {
3733         $defs[$rc->capability][$rc->path][$rc->roleid] = $rc->permission;
3734     }
3736     // go through the permissions bottom-->top direction to evaluate the current permission,
3737     // first one wins (prohibit is an exception that always wins)
3738     $access = array();
3739     foreach ($caps as $cap) {
3740         foreach ($paths as $path) {
3741             if (empty($defs[$cap][$path])) {
3742                 continue;
3743             }
3744             foreach($defs[$cap][$path] as $roleid => $perm) {
3745                 if ($perm == CAP_PROHIBIT) {
3746                     $access[$cap][$roleid] = CAP_PROHIBIT;
3747                     continue;
3748                 }
3749                 if (!isset($access[$cap][$roleid])) {
3750                     $access[$cap][$roleid] = (int)$perm;
3751                 }
3752             }
3753         }
3754     }
3756     // make lists of roles that are needed and prohibited in this context
3757     $needed = array(); // one of these is enough
3758     $prohibited = array(); // must not have any of these
3759     foreach ($caps as $cap) {
3760         if (empty($access[$cap])) {
3761             continue;
3762         }
3763         foreach ($access[$cap] as $roleid => $perm) {
3764             if ($perm == CAP_PROHIBIT) {
3765                 unset($needed[$cap][$roleid]);
3766                 $prohibited[$cap][$roleid] = true;
3767             } else if ($perm == CAP_ALLOW and empty($prohibited[$cap][$roleid])) {
3768                 $needed[$cap][$roleid] = true;
3769             }
3770         }
3771         if (empty($needed[$cap]) or !empty($prohibited[$cap][$defaultuserroleid])) {
3772             // easy, nobody has the permission
3773             unset($needed[$cap]);
3774             unset($prohibited[$cap]);
3775         } else if ($isfrontpage and !empty($prohibited[$cap][$defaultfrontpageroleid])) {
3776             // everybody is disqualified on the frontpage
3777             unset($needed[$cap]);
3778             unset($prohibited[$cap]);
3779         }
3780         if (empty($prohibited[$cap])) {
3781             unset($prohibited[$cap]);
3782         }
3783     }
3785     if (empty($needed)) {
3786         // there can not be anybody if no roles match this request
3787         return array();
3788     }
3790     if (empty($prohibited)) {
3791         // we can compact the needed roles
3792         $n = array();
3793         foreach ($needed as $cap) {
3794             foreach ($cap as $roleid=>$unused) {
3795                 $n[$roleid] = true;
3796             }
3797         }
3798         $needed = array('any'=>$n);
3799         unset($n);
3800     }
3802     // ***** Set up default fields ******
3803     if (empty($fields)) {
3804         if ($iscoursepage) {
3805             $fields = 'u.*, ul.timeaccess AS lastaccess';
3806         } else {
3807             $fields = 'u.*';
3808         }
3809     } else {
3810         if ($CFG->debugdeveloper && strpos($fields, 'u.*') === false && strpos($fields, 'u.id') === false) {
3811             debugging('u.id must be included in the list of fields passed to get_users_by_capability().', DEBUG_DEVELOPER);
3812         }
3813     }
3815     // Set up default sort
3816     if (empty($sort)) { // default to course lastaccess or just lastaccess
3817         if ($iscoursepage) {
3818             $sort = 'ul.timeaccess';
3819         } else {
3820             $sort = 'u.lastaccess';
3821         }
3822     }
3824     // Prepare query clauses
3825     $wherecond = array();
3826     $params    = array();
3827     $joins     = array();
3829     // User lastaccess JOIN
3830     if ((strpos($sort, 'ul.timeaccess') === false) and (strpos($fields, 'ul.timeaccess') === false)) {
3831          // user_lastaccess is not required MDL-13810
3832     } else {
3833         if ($iscoursepage) {
3834             $joins[] = "LEFT OUTER JOIN {user_lastaccess} ul ON (ul.userid = u.id AND ul.courseid = {$context->instanceid})";
3835         } else {
3836             throw new coding_exception('Invalid sort in get_users_by_capability(), ul.timeaccess allowed only for course contexts.');
3837         }
3838     }
3840     // We never return deleted users or guest account.
3841     $wherecond[] = "u.deleted = 0 AND u.id <> :guestid";
3842     $params['guestid'] = $CFG->siteguest;
3844     // Groups
3845     if ($groups) {
3846         $groups = (array)$groups;
3847         list($grouptest, $grpparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED, 'grp');
3848         $grouptest = "u.id IN (SELECT userid FROM {groups_members} gm WHERE gm.groupid $grouptest)";
3849         $params = array_merge($params, $grpparams);
3851         if ($useviewallgroups) {
3852             $viewallgroupsusers = get_users_by_capability($context, 'moodle/site:accessallgroups', 'u.id, u.id', '', '', '', '', $exceptions);
3853             if (!empty($viewallgroupsusers)) {
3854                 $wherecond[] =  "($grouptest OR u.id IN (" . implode(',', array_keys($viewallgroupsusers)) . '))';
3855             } else {
3856                 $wherecond[] =  "($grouptest)";
3857             }
3858         } else {
3859             $wherecond[] =  "($grouptest)";
3860         }
3861     }
3863     // User exceptions
3864     if (!empty($exceptions)) {
3865         $exceptions = (array)$exceptions;
3866         list($exsql, $exparams) = $DB->get_in_or_equal($exceptions, SQL_PARAMS_NAMED, 'exc', false);
3867         $params = array_merge($params, $exparams);
3868         $wherecond[] = "u.id $exsql";
3869     }
3871     // now add the needed and prohibited roles conditions as joins
3872     if (!empty($needed['any'])) {
3873         // simple case - there are no prohibits involved
3874         if (!empty($needed['any'][$defaultuserroleid]) or ($isfrontpage and !empty($needed['any'][$defaultfrontpageroleid]))) {
3875             // everybody
3876         } else {
3877             $joins[] = "JOIN (SELECT DISTINCT userid
3878                                 FROM {role_assignments}
3879                                WHERE contextid IN ($ctxids)
3880                                      AND roleid IN (".implode(',', array_keys($needed['any'])) .")
3881                              ) ra ON ra.userid = u.id";
3882         }
3883     } else {
3884         $unions = array();
3885         $everybody = false;
3886         foreach ($needed as $cap=>$unused) {
3887             if (empty($prohibited[$cap])) {
3888                 if (!empty($needed[$cap][$defaultuserroleid]) or ($isfrontpage and !empty($needed[$cap][$defaultfrontpageroleid]))) {
3889                     $everybody = true;
3890                     break;
3891                 } else {
3892                     $unions[] = "SELECT userid
3893                                    FROM {role_assignments}
3894                                   WHERE contextid IN ($ctxids)
3895                                         AND roleid IN (".implode(',', array_keys($needed[$cap])) .")";
3896                 }
3897             } else {
3898                 if (!empty($prohibited[$cap][$defaultuserroleid]) or ($isfrontpage and !empty($prohibited[$cap][$defaultfrontpageroleid]))) {
3899                     // nobody can have this cap because it is prevented in default roles
3900                     continue;
3902                 } else if (!empty($needed[$cap][$defaultuserroleid]) or ($isfrontpage and !empty($needed[$cap][$defaultfrontpageroleid]))) {
3903                     // everybody except the prohibitted - hiding does not matter
3904                     $unions[] = "SELECT id AS userid
3905                                    FROM {user}
3906                                   WHERE id NOT IN (SELECT userid
3907                                                      FROM {role_assignments}
3908                                                     WHERE contextid IN ($ctxids)
3909                                                           AND roleid IN (".implode(',', array_keys($prohibited[$cap])) ."))";
3911                 } else {
3912                     $unions[] = "SELECT userid
3913                                    FROM {role_assignments}
3914                                   WHERE contextid IN ($ctxids)
3915                                         AND roleid IN (".implode(',', array_keys($needed[$cap])) .")
3916                                         AND roleid NOT IN (".implode(',', array_keys($prohibited[$cap])) .")";
3917                 }
3918             }
3919         }
3920         if (!$everybody) {
3921             if ($unions) {
3922                 $joins[] = "JOIN (SELECT DISTINCT userid FROM ( ".implode(' UNION ', $unions)." ) us) ra ON ra.userid = u.id";
3923             } else {
3924                 // only prohibits found - nobody can be matched
3925                 $wherecond[] = "1 = 2";
3926             }
3927         }
3928     }
3930     // Collect WHERE conditions and needed joins
3931     $where = implode(' AND ', $wherecond);
3932     if ($where !== '') {
3933         $where = 'WHERE ' . $where;
3934     }
3935     $joins = implode("\n", $joins);
3937     // Ok, let's get the users!
3938     $sql = "SELECT $fields
3939               FROM {user} u
3940             $joins
3941             $where
3942           ORDER BY $sort";
3944     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
3947 /**
3948  * Re-sort a users array based on a sorting policy
3949  *
3950  * Will re-sort a $users results array (from get_users_by_capability(), usually)
3951  * based on a sorting policy. This is to support the odd practice of
3952  * sorting teachers by 'authority', where authority was "lowest id of the role
3953  * assignment".
3954  *
3955  * Will execute 1 database query. Only suitable for small numbers of users, as it
3956  * uses an u.id IN() clause.
3957  *
3958  * Notes about the sorting criteria.
3959  *
3960  * As a default, we cannot rely on role.sortorder because then
3961  * admins/coursecreators will always win. That is why the sane
3962  * rule "is locality matters most", with sortorder as 2nd
3963  * consideration.
3964  *
3965  * If you want role.sortorder, use the 'sortorder' policy, and
3966  * name explicitly what roles you want to cover. It's probably
3967  * a good idea to see what roles have the capabilities you want
3968  * (array_diff() them against roiles that have 'can-do-anything'
3969  * to weed out admin-ish roles. Or fetch a list of roles from
3970  * variables like $CFG->coursecontact .
3971  *
3972  * @param array $users Users array, keyed on userid
3973  * @param context $context
3974  * @param array $roles ids of the roles to include, optional
3975  * @param string $sortpolicy defaults to locality, more about
3976  * @return array sorted copy of the array
3977  */
3978 function sort_by_roleassignment_authority($users, context $context, $roles = array(), $sortpolicy = 'locality') {
3979     global $DB;
3981     $userswhere = ' ra.userid IN (' . implode(',',array_keys($users)) . ')';
3982     $contextwhere = 'AND ra.contextid IN ('.str_replace('/', ',',substr($context->path, 1)).')';
3983     if (empty($roles)) {
3984         $roleswhere = '';
3985     } else {
3986         $roleswhere = ' AND ra.roleid IN ('.implode(',',$roles).')';
3987     }
3989     $sql = "SELECT ra.userid
3990               FROM {role_assignments} ra
3991               JOIN {role} r
3992                    ON ra.roleid=r.id
3993               JOIN {context} ctx
3994                    ON ra.contextid=ctx.id
3995              WHERE $userswhere
3996                    $contextwhere
3997                    $roleswhere";
3999     // Default 'locality' policy -- read PHPDoc notes
4000     // about sort policies...
4001     $orderby = 'ORDER BY '
4002                     .'ctx.depth DESC, '  /* locality wins */
4003                     .'r.sortorder ASC, ' /* rolesorting 2nd criteria */
4004                     .'ra.id';            /* role assignment order tie-breaker */
4005     if ($sortpolicy === 'sortorder') {
4006         $orderby = 'ORDER BY '
4007                         .'r.sortorder ASC, ' /* rolesorting 2nd criteria */
4008                         .'ra.id';            /* role assignment order tie-breaker */
4009     }
4011     $sortedids = $DB->get_fieldset_sql($sql . $orderby);
4012     $sortedusers = array();
4013     $seen = array();
4015     foreach ($sortedids as $id) {
4016         // Avoid duplicates
4017         if (isset($seen[$id])) {
4018             continue;
4019         }
4020         $seen[$id] = true;
4022         // assign
4023         $sortedusers[$id] = $users[$id];
4024     }
4025     return $sortedusers;
4028 /**
4029  * Gets all the users assigned this role in this context or higher
4030  *
4031  * @param int $roleid (can also be an array of ints!)
4032  * @param context $context
4033  * @param bool $parent if true, get list of users assigned in higher context too
4034  * @param string $fields fields from user (u.) , role assignment (ra) or role (r.)
4035  * @param string $sort sort from user (u.) , role assignment (ra.) or role (r.).
4036  *      null => use default sort from users_order_by_sql.
4037  * @param bool $all true means all, false means limit to enrolled users
4038  * @param string $group defaults to ''
4039  * @param mixed $limitfrom defaults to ''
4040  * @param mixed $limitnum defaults to ''
4041  * @param string $extrawheretest defaults to ''
4042  * @param array $whereorsortparams any paramter values used by $sort or $extrawheretest.
4043  * @return array
4044  */
4045 function get_role_users($roleid, context $context, $parent = false, $fields = '',
4046         $sort = null, $all = true, $group = '',
4047         $limitfrom = '', $limitnum = '', $extrawheretest = '', $whereorsortparams = array()) {
4048     global $DB;
4050     if (empty($fields)) {
4051         $allnames = get_all_user_name_fields(true, 'u');
4052         $fields = 'u.id, u.confirmed, u.username, '. $allnames . ', ' .
4053                   'u.maildisplay, u.mailformat, u.maildigest, u.email, u.emailstop, u.city, '.
4054                   'u.country, u.picture, u.idnumber, u.department, u.institution, '.
4055                   'u.lang, u.timezone, u.lastaccess, u.mnethostid, r.name AS rolename, r.sortorder, '.
4056                   'r.shortname AS roleshortname, rn.name AS rolecoursealias';
4057     }
4059     $parentcontexts = '';
4060     if ($parent) {
4061         $parentcontexts = substr($context->path, 1); // kill leading slash
4062         $parentcontexts = str_replace('/', ',', $parentcontexts);
4063         if ($parentcontexts !== '') {
4064             $parentcontexts = ' OR ra.contextid IN ('.$parentcontexts.' )';
4065         }
4066     }
4068     if ($roleid) {
4069         list($rids, $params) = $DB->get_in_or_equal($roleid, SQL_PARAMS_NAMED, 'r');
4070         $roleselect = "AND ra.roleid $rids";
4071     } else {
4072         $params = array();
4073         $roleselect = '';
4074     }
4076     if ($coursecontext = $context->get_course_context(false)) {
4077         $params['coursecontext'] = $coursecontext->id;
4078     } else {
4079         $params['coursecontext'] = 0;
4080     }
4082     if ($group) {
4083         $groupjoin   = "JOIN {groups_members} gm ON gm.userid = u.id";
4084         $groupselect = " AND gm.groupid = :groupid ";
4085         $params['groupid'] = $group;
4086     } else {
4087         $groupjoin   = '';
4088         $groupselect = '';
4089     }
4091     $params['contextid'] = $context->id;
4093     if ($extrawheretest) {
4094         $extrawheretest = ' AND ' . $extrawheretest;
4095     }
4097     if ($whereorsortparams) {
4098         $params = array_merge($params, $whereorsortparams);
4099     }
4101     if (!$sort) {
4102         list($sort, $sortparams) = users_order_by_sql('u');
4103         $params = array_merge($params, $sortparams);
4104     }
4106     if ($all === null) {
4107         // Previously null was used to indicate that parameter was not used.
4108         $all = true;
4109     }
4110     if (!$all and $coursecontext) {
4111         // Do not use get_enrolled_sql() here for performance reasons.
4112         $ejoin = "JOIN {user_enrolments} ue ON ue.userid = u.id
4113                   JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :ecourseid)";
4114         $params['ecourseid'] = $coursecontext->instanceid;
4115     } else {
4116         $ejoin = "";
4117     }
4119     $sql = "SELECT DISTINCT $fields, ra.roleid
4120               FROM {role_assignments} ra
4121               JOIN {user} u ON u.id = ra.userid
4122               JOIN {role} r ON ra.roleid = r.id
4123             $ejoin
4124          LEFT JOIN {role_names} rn ON (rn.contextid = :coursecontext AND rn.roleid = r.id)
4125         $groupjoin
4126              WHERE (ra.contextid = :contextid $parentcontexts)
4127                    $roleselect
4128                    $groupselect
4129                    $extrawheretest
4130           ORDER BY $sort";                  // join now so that we can just use fullname() later
4132     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
4135 /**
4136  * Counts all the users assigned this role in this context or higher
4137  *
4138  * @param int|array $roleid either int or an array of ints
4139  * @param context $context
4140  * @param bool $parent if true, get list of users assigned in higher context too
4141  * @return int Returns the result count
4142  */
4143 function count_role_users($roleid, context $context, $parent = false) {
4144     global $DB;
4146     if ($parent) {
4147         if ($contexts = $context->get_parent_context_ids()) {
4148             $parentcontexts = ' OR r.contextid IN ('.implode(',', $contexts).')';
4149         } else {
4150             $parentcontexts = '';
4151         }
4152     } else {
4153         $parentcontexts = '';
4154     }
4156     if ($roleid) {
4157         list($rids, $params) = $DB->get_in_or_equal($roleid, SQL_PARAMS_QM);
4158         $roleselect = "AND r.roleid $rids";
4159     } else {
4160         $params = array();
4161         $roleselect = '';
4162     }
4164     array_unshift($params, $context->id);
4166     $sql = "SELECT COUNT(u.id)
4167               FROM {role_assignments} r
4168               JOIN {user} u ON u.id = r.userid
4169              WHERE (r.contextid = ? $parentcontexts)
4170                    $roleselect
4171                    AND u.deleted = 0";
4173     return $DB->count_records_sql($sql, $params);
4176 /**
4177  * This function gets the list of courses that this user has a particular capability in.
4178  * It is still not very efficient.
4179  *
4180  * @param string $capability Capability in question
4181  * @param int $userid User ID or null for current user
4182  * @param bool $doanything True if 'doanything' is permitted (default)
4183  * @param string $fieldsexceptid Leave blank if you only need 'id' in the course records;
4184  *   otherwise use a comma-separated list of the fields you require, not including id
4185  * @param string $orderby If set, use a comma-separated list of fields from course
4186  *   table with sql modifiers (DESC) if needed
4187  * @return array Array of courses, may have zero entries. Or false if query failed.
4188  */
4189 function get_user_capability_course($capability, $userid = null, $doanything = true, $fieldsexceptid = '', $orderby = '') {
4190     global $DB;
4192     // Convert fields list and ordering
4193     $fieldlist = '';
4194     if ($fieldsexceptid) {
4195         $fields = explode(',', $fieldsexceptid);
4196         foreach($fields as $field) {
4197             $fieldlist .= ',c.'.$field;
4198         }
4199     }
4200     if ($orderby) {
4201         $fields = explode(',', $orderby);
4202         $orderby = '';
4203         foreach($fields as $field) {
4204             if ($orderby) {
4205                 $orderby .= ',';
4206             }
4207             $orderby .= 'c.'.$field;
4208         }
4209         $orderby = 'ORDER BY '.$orderby;
4210     }
4212     // Obtain a list of everything relevant about all courses including context.
4213     // Note the result can be used directly as a context (we are going to), the course
4214     // fields are just appended.
4216     $contextpreload = context_helper::get_preload_record_columns_sql('x');
4218     $courses = array();
4219     $rs = $DB->get_recordset_sql("SELECT c.id $fieldlist, $contextpreload
4220                                     FROM {course} c
4221                                     JOIN {context} x ON (c.id=x.instanceid AND x.contextlevel=".CONTEXT_COURSE.")
4222                                 $orderby");
4223     // Check capability for each course in turn
4224     foreach ($rs as $course) {
4225         context_helper::preload_from_record($course);
4226         $context = context_course::instance($course->id);
4227         if (has_capability($capability, $context, $userid, $doanything)) {
4228             // We've got the capability. Make the record look like a course record
4229             // and store it
4230             $courses[] = $course;
4231         }
4232     }
4233     $rs->close();
4234     return empty($courses) ? false : $courses;
4237 /**
4238  * This function finds the roles assigned directly to this context only
4239  * i.e. no roles in parent contexts
4240  *
4241  * @param context $context
4242  * @return array
4243  */
4244 function get_roles_on_exact_context(context $context) {
4245     global $DB;
4247     return $DB->get_records_sql("SELECT r.*
4248                                    FROM {role_assignments} ra, {role} r
4249                                   WHERE ra.roleid = r.id AND ra.contextid = ?",
4250                                 array($context->id));
4253 /**
4254  * Switches the current user to another role for the current session and only
4255  * in the given context.
4256  *
4257  * The caller *must* check
4258  * - that this op is allowed
4259  * - that the requested role can be switched to in this context (use get_switchable_roles)
4260  * - that the requested role is NOT $CFG->defaultuserroleid
4261  *
4262  * To "unswitch" pass 0 as the roleid.
4263  *
4264  * This function *will* modify $USER->access - beware
4265  *
4266  * @param integer $roleid the role to switch to.
4267  * @param context $context the context in which to perform the switch.
4268  * @return bool success or failure.
4269  */
4270 function role_switch($roleid, context $context) {
4271     global $USER;
4273     //
4274     // Plan of action
4275     //
4276     // - Add the ghost RA to $USER->access
4277     //   as $USER->access['rsw'][$path] = $roleid
4278     //
4279     // - Make sure $USER->access['rdef'] has the roledefs
4280     //   it needs to honour the switcherole
4281     //
4282     // Roledefs will get loaded "deep" here - down to the last child
4283     // context. Note that
4284     //
4285     // - When visiting subcontexts, our selective accessdata loading
4286     //   will still work fine - though those ra/rdefs will be ignored
4287     //   appropriately while the switch is in place
4288     //
4289     // - If a switcherole happens at a category with tons of courses
4290     //   (that have many overrides for switched-to role), the session
4291     //   will get... quite large. Sometimes you just can't win.
4292     //
4293     // To un-switch just unset($USER->access['rsw'][$path])
4294     //
4295     // Note: it is not possible to switch to roles that do not have course:view
4297     if (!isset($USER->access)) {
4298         load_all_capabilities();
4299     }
4302     // Add the switch RA
4303     if ($roleid == 0) {
4304       &nbs