MDL-14817 fixing recent regressions
[moodle.git] / lib / accesslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file contains functions for managing user access
20  *
21  * <b>Public API vs internals</b>
22  *
23  * General users probably only care about
24  *
25  * Context handling
26  * - get_context_instance()
27  * - get_context_instance_by_id()
28  * - get_parent_contexts()
29  * - get_child_contexts()
30  *
31  * Whether the user can do something...
32  * - has_capability()
33  * - has_any_capability()
34  * - has_all_capabilities()
35  * - require_capability()
36  * - require_login() (from moodlelib)
37  *
38  * What courses has this user access to?
39  * - get_user_courses_bycap()
40  *
41  * What users can do X in this context?
42  * - get_users_by_capability()
43  *
44  * Enrol/unenrol
45  * - enrol_into_course()
46  * - role_assign()/role_unassign()
47  *
48  *
49  * Advanced use
50  * - load_all_capabilities()
51  * - reload_all_capabilities()
52  * - has_capability_in_accessdata()
53  * - is_siteadmin()
54  * - get_user_access_sitewide()
55  * - load_subcontext()
56  * - get_role_access_bycontext()
57  *
58  * <b>Name conventions</b>
59  *
60  * "ctx" means context
61  *
62  * <b>accessdata</b>
63  *
64  * Access control data is held in the "accessdata" array
65  * which - for the logged-in user, will be in $USER->access
66  *
67  * For other users can be generated and passed around (but may also be cached
68  * against userid in $ACCESSLIB_PRIVATE->accessdatabyuser.
69  *
70  * $accessdata is a multidimensional array, holding
71  * role assignments (RAs), role-capabilities-perm sets
72  * (role defs) and a list of courses we have loaded
73  * data for.
74  *
75  * Things are keyed on "contextpaths" (the path field of
76  * the context table) for fast walking up/down the tree.
77  * <code>
78  * $accessdata[ra][$contextpath]= array($roleid)
79  *                [$contextpath]= array($roleid)
80  *                [$contextpath]= array($roleid)
81  * </code>
82  *
83  * Role definitions are stored like this
84  * (no cap merge is done - so it's compact)
85  *
86  * <code>
87  * $accessdata[rdef][$contextpath:$roleid][mod/forum:viewpost] = 1
88  *                                        [mod/forum:editallpost] = -1
89  *                                        [mod/forum:startdiscussion] = -1000
90  * </code>
91  *
92  * See how has_capability_in_accessdata() walks up/down the tree.
93  *
94  * Normally - specially for the logged-in user, we only load
95  * rdef and ra down to the course level, but not below. This
96  * keeps accessdata small and compact. Below-the-course ra/rdef
97  * are loaded as needed. We keep track of which courses we
98  * have loaded ra/rdef in
99  * <code>
100  * $accessdata[loaded] = array($contextpath, $contextpath)
101  * </code>
102  *
103  * <b>Stale accessdata</b>
104  *
105  * For the logged-in user, accessdata is long-lived.
106  *
107  * On each pageload we load $ACCESSLIB_PRIVATE->dirtycontexts which lists
108  * context paths affected by changes. Any check at-or-below
109  * a dirty context will trigger a transparent reload of accessdata.
110  *
111  * Changes at the system level will force the reload for everyone.
112  *
113  * <b>Default role caps</b>
114  * The default role assignment is not in the DB, so we
115  * add it manually to accessdata.
116  *
117  * This means that functions that work directly off the
118  * DB need to ensure that the default role caps
119  * are dealt with appropriately.
120  *
121  * @package    core
122  * @subpackage role
123  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
124  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
125  */
127 defined('MOODLE_INTERNAL') || die();
129 /** permission definitions */
130 define('CAP_INHERIT', 0);
131 /** permission definitions */
132 define('CAP_ALLOW', 1);
133 /** permission definitions */
134 define('CAP_PREVENT', -1);
135 /** permission definitions */
136 define('CAP_PROHIBIT', -1000);
138 /** context definitions */
139 define('CONTEXT_SYSTEM', 10);
140 /** context definitions */
141 define('CONTEXT_USER', 30);
142 /** context definitions */
143 define('CONTEXT_COURSECAT', 40);
144 /** context definitions */
145 define('CONTEXT_COURSE', 50);
146 /** context definitions */
147 define('CONTEXT_MODULE', 70);
148 /** context definitions */
149 define('CONTEXT_BLOCK', 80);
151 /** capability risks - see {@link http://docs.moodle.org/en/Development:Hardening_new_Roles_system} */
152 define('RISK_MANAGETRUST', 0x0001);
153 /** capability risks - see {@link http://docs.moodle.org/en/Development:Hardening_new_Roles_system} */
154 define('RISK_CONFIG',      0x0002);
155 /** capability risks - see {@link http://docs.moodle.org/en/Development:Hardening_new_Roles_system} */
156 define('RISK_XSS',         0x0004);
157 /** capability risks - see {@link http://docs.moodle.org/en/Development:Hardening_new_Roles_system} */
158 define('RISK_PERSONAL',    0x0008);
159 /** capability risks - see {@link http://docs.moodle.org/en/Development:Hardening_new_Roles_system} */
160 define('RISK_SPAM',        0x0010);
161 /** capability risks - see {@link http://docs.moodle.org/en/Development:Hardening_new_Roles_system} */
162 define('RISK_DATALOSS',    0x0020);
164 /** rolename displays - the name as defined in the role definition */
165 define('ROLENAME_ORIGINAL', 0);
166 /** rolename displays - the name as defined by a role alias */
167 define('ROLENAME_ALIAS', 1);
168 /** rolename displays - Both, like this:  Role alias (Original)*/
169 define('ROLENAME_BOTH', 2);
170 /** rolename displays - the name as defined in the role definition and the shortname in brackets*/
171 define('ROLENAME_ORIGINALANDSHORT', 3);
172 /** rolename displays - the name as defined by a role alias, in raw form suitable for editing*/
173 define('ROLENAME_ALIAS_RAW', 4);
174 /** rolename displays - the name is simply short role name*/
175 define('ROLENAME_SHORT', 5);
177 /** size limit for context cache */
178 if (!defined('MAX_CONTEXT_CACHE_SIZE')) {
179     define('MAX_CONTEXT_CACHE_SIZE', 5000);
182 /**
183  * Although this looks like a global variable, it isn't really.
184  *
185  * It is just a private implementation detail to accesslib that MUST NOT be used elsewhere.
186  * It is used to cache various bits of data between function calls for performance reasons.
187  * Sadly, a PHP global variable is the only way to implement this, without rewriting everything
188  * as methods of a class, instead of functions.
189  *
190  * @global stdClass $ACCESSLIB_PRIVATE
191  * @name $ACCESSLIB_PRIVATE
192  */
193 global $ACCESSLIB_PRIVATE;
194 $ACCESSLIB_PRIVATE = new stdClass();
195 $ACCESSLIB_PRIVATE->contexts         = array(); // Cache of context objects by level and instance
196 $ACCESSLIB_PRIVATE->contextsbyid     = array(); // Cache of context objects by id
197 $ACCESSLIB_PRIVATE->systemcontext    = null; // Used in get_system_context
198 $ACCESSLIB_PRIVATE->dirtycontexts    = null; // Dirty contexts cache
199 $ACCESSLIB_PRIVATE->accessdatabyuser = array(); // Holds the $accessdata structure for users other than $USER
200 $ACCESSLIB_PRIVATE->roledefinitions  = array(); // role definitions cache - helps a lot with mem usage in cron
201 $ACCESSLIB_PRIVATE->croncache        = array(); // Used in get_role_access
202 $ACCESSLIB_PRIVATE->preloadedcourses = array(); // Used in preload_course_contexts.
203 $ACCESSLIB_PRIVATE->capabilities     = null; // detailed information about the capabilities
205 /**
206  * Clears accesslib's private caches. ONLY BE USED BY UNIT TESTS
207  *
208  * This method should ONLY BE USED BY UNIT TESTS. It clears all of
209  * accesslib's private caches. You need to do this before setting up test data,
210  * and also at the end of the tests.
211  */
212 function accesslib_clear_all_caches_for_unit_testing() {
213     global $UNITTEST, $USER, $ACCESSLIB_PRIVATE;
214     if (empty($UNITTEST->running)) {
215         throw new coding_exception('You must not call clear_all_caches outside of unit tests.');
216     }
217     $ACCESSLIB_PRIVATE->contexts         = array();
218     $ACCESSLIB_PRIVATE->contextsbyid     = array();
219     $ACCESSLIB_PRIVATE->systemcontext    = null;
220     $ACCESSLIB_PRIVATE->dirtycontexts    = null;
221     $ACCESSLIB_PRIVATE->accessdatabyuser = array();
222     $ACCESSLIB_PRIVATE->roledefinitions  = array();
223     $ACCESSLIB_PRIVATE->croncache        = array();
224     $ACCESSLIB_PRIVATE->preloadedcourses = array();
225     $ACCESSLIB_PRIVATE->capabilities     = null;
227     unset($USER->access);
230 /**
231  * Private function. Add a context object to accesslib's caches.
232  *
233  * @param object $context
234  * @return void
235  */
236 function cache_context($context) {
237     global $ACCESSLIB_PRIVATE;
239     // If there are too many items in the cache already, remove items until
240     // there is space
241     while (count($ACCESSLIB_PRIVATE->contextsbyid) >= MAX_CONTEXT_CACHE_SIZE) {
242         $first = reset($ACCESSLIB_PRIVATE->contextsbyid);
243         unset($ACCESSLIB_PRIVATE->contextsbyid[$first->id]);
244         unset($ACCESSLIB_PRIVATE->contexts[$first->contextlevel][$first->instanceid]);
245     }
247     $ACCESSLIB_PRIVATE->contexts[$context->contextlevel][$context->instanceid] = $context;
248     $ACCESSLIB_PRIVATE->contextsbyid[$context->id] = $context;
251 /**
252  * This is really slow!!! do not use above course context level
253  *
254  * @param int $roleid
255  * @param object $context
256  * @return array
257  */
258 function get_role_context_caps($roleid, $context) {
259     global $DB;
261     //this is really slow!!!! - do not use above course context level!
262     $result = array();
263     $result[$context->id] = array();
265     // first emulate the parent context capabilities merging into context
266     $searchcontexts = array_reverse(get_parent_contexts($context));
267     array_push($searchcontexts, $context->id);
268     foreach ($searchcontexts as $cid) {
269         if ($capabilities = $DB->get_records('role_capabilities', array('roleid'=>$roleid, 'contextid'=>$cid))) {
270             foreach ($capabilities as $cap) {
271                 if (!array_key_exists($cap->capability, $result[$context->id])) {
272                     $result[$context->id][$cap->capability] = 0;
273                 }
274                 $result[$context->id][$cap->capability] += $cap->permission;
275             }
276         }
277     }
279     // now go through the contexts bellow given context
280     $searchcontexts = array_keys(get_child_contexts($context));
281     foreach ($searchcontexts as $cid) {
282         if ($capabilities = $DB->get_records('role_capabilities', array('roleid'=>$roleid, 'contextid'=>$cid))) {
283             foreach ($capabilities as $cap) {
284                 if (!array_key_exists($cap->contextid, $result)) {
285                     $result[$cap->contextid] = array();
286                 }
287                 $result[$cap->contextid][$cap->capability] = $cap->permission;
288             }
289         }
290     }
292     return $result;
295 /**
296  * Gets the accessdata for role "sitewide" (system down to course)
297  *
298  * @param int $roleid
299  * @param array $accessdata defaults to null
300  * @return array
301  */
302 function get_role_access($roleid, $accessdata = null) {
303     global $CFG, $DB;
305     /* Get it in 1 cheap DB query...
306      * - relevant role caps at the root and down
307      *   to the course level - but not below
308      */
309     if (is_null($accessdata)) {
310         $accessdata           = array(); // named list
311         $accessdata['ra']     = array();
312         $accessdata['rdef']   = array();
313         $accessdata['loaded'] = array();
314     }
316     //
317     // Overrides for the role IN ANY CONTEXTS
318     // down to COURSE - not below -
319     //
320     $sql = "SELECT ctx.path,
321                    rc.capability, rc.permission
322               FROM {context} ctx
323               JOIN {role_capabilities} rc
324                    ON rc.contextid=ctx.id
325              WHERE rc.roleid = ?
326                    AND ctx.contextlevel <= ".CONTEXT_COURSE."
327           ORDER BY ctx.depth, ctx.path";
328     $params = array($roleid);
330     // we need extra caching in CLI scripts and cron
331     if (CLI_SCRIPT) {
332         global $ACCESSLIB_PRIVATE;
334         if (!isset($ACCESSLIB_PRIVATE->croncache[$roleid])) {
335             $ACCESSLIB_PRIVATE->croncache[$roleid] = array();
336             if ($rs = $DB->get_recordset_sql($sql, $params)) {
337                 foreach ($rs as $rd) {
338                     $ACCESSLIB_PRIVATE->croncache[$roleid][] = $rd;
339                 }
340                 $rs->close();
341             }
342         }
344         foreach ($ACCESSLIB_PRIVATE->croncache[$roleid] as $rd) {
345             $k = "{$rd->path}:{$roleid}";
346             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
347         }
349     } else {
350         if ($rs = $DB->get_recordset_sql($sql, $params)) {
351             foreach ($rs as $rd) {
352                 $k = "{$rd->path}:{$roleid}";
353                 $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
354             }
355             unset($rd);
356             $rs->close();
357         }
358     }
360     return $accessdata;
363 /**
364  * Gets the accessdata for role "sitewide" (system down to course)
365  *
366  * @param int $roleid
367  * @param array $accessdata defaults to null
368  * @return array
369  */
370 function get_default_frontpage_role_access($roleid, $accessdata = null) {
372     global $CFG, $DB;
374     $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
375     $base = '/'. SYSCONTEXTID .'/'. $frontpagecontext->id;
377     //
378     // Overrides for the role in any contexts related to the course
379     //
380     $sql = "SELECT ctx.path,
381                    rc.capability, rc.permission
382               FROM {context} ctx
383               JOIN {role_capabilities} rc
384                    ON rc.contextid=ctx.id
385              WHERE rc.roleid = ?
386                    AND (ctx.id = ".SYSCONTEXTID." OR ctx.path LIKE ?)
387                    AND ctx.contextlevel <= ".CONTEXT_COURSE."
388           ORDER BY ctx.depth, ctx.path";
389     $params = array($roleid, "$base/%");
391     if ($rs = $DB->get_recordset_sql($sql, $params)) {
392         foreach ($rs as $rd) {
393             $k = "{$rd->path}:{$roleid}";
394             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
395         }
396         unset($rd);
397         $rs->close();
398     }
400     return $accessdata;
404 /**
405  * Get the default guest role
406  *
407  * @return stdClass role
408  */
409 function get_guest_role() {
410     global $CFG, $DB;
412     if (empty($CFG->guestroleid)) {
413         if ($roles = $DB->get_records('role', array('archetype'=>'guest'))) {
414             $guestrole = array_shift($roles);   // Pick the first one
415             set_config('guestroleid', $guestrole->id);
416             return $guestrole;
417         } else {
418             debugging('Can not find any guest role!');
419             return false;
420         }
421     } else {
422         if ($guestrole = $DB->get_record('role', array('id'=>$CFG->guestroleid))) {
423             return $guestrole;
424         } else {
425             //somebody is messing with guest roles, remove incorrect setting and try to find a new one
426             set_config('guestroleid', '');
427             return get_guest_role();
428         }
429     }
432 /**
433  * Check whether a user has a particular capability in a given context.
434  *
435  * For example::
436  *      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
437  *      has_capability('mod/forum:replypost',$context)
438  *
439  * By default checks the capabilities of the current user, but you can pass a
440  * different userid. By default will return true for admin users, but you can override that with the fourth argument.
441  *
442  * Guest and not-logged-in users can never get any dangerous capability - that is any write capability
443  * or capabilities with XSS, config or data loss risks.
444  *
445  * @param string $capability the name of the capability to check. For example mod/forum:view
446  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
447  * @param integer|object $user A user id or object. By default (null) checks the permissions of the current user.
448  * @param boolean $doanything If false, ignores effect of admin role assignment
449  * @return boolean true if the user has this capability. Otherwise false.
450  */
451 function has_capability($capability, $context, $user = null, $doanything = true) {
452     global $USER, $CFG, $DB, $SCRIPT, $ACCESSLIB_PRIVATE;
454     if (during_initial_install()) {
455         if ($SCRIPT === "/$CFG->admin/index.php" or $SCRIPT === "/$CFG->admin/cliupgrade.php") {
456             // we are in an installer - roles can not work yet
457             return true;
458         } else {
459             return false;
460         }
461     }
463     if (strpos($capability, 'moodle/legacy:') === 0) {
464         throw new coding_exception('Legacy capabilities can not be used any more!');
465     }
467     // the original $CONTEXT here was hiding serious errors
468     // for security reasons do not reuse previous context
469     if (empty($context)) {
470         debugging('Incorrect context specified');
471         return false;
472     }
473     if (!is_bool($doanything)) {
474         throw new coding_exception('Capability parameter "doanything" is wierd ("'.$doanything.'"). This has to be fixed in code.');
475     }
477     // make sure there is a real user specified
478     if ($user === null) {
479         $userid = !empty($USER->id) ? $USER->id : 0;
480     } else {
481         $userid = !empty($user->id) ? $user->id : $user;
482     }
484     // capability must exist
485     if (!$capinfo = get_capability_info($capability)) {
486         debugging('Capability "'.$capability.'" was not found! This should be fixed in code.');
487         return false;
488     }
489     // make sure the guest account and not-logged-in users never get any risky caps no matter what the actual settings are.
490     if (($capinfo->captype === 'write') or ((int)$capinfo->riskbitmask & (RISK_XSS | RISK_CONFIG | RISK_DATALOSS))) {
491         if (isguestuser($userid) or $userid == 0) {
492             return false;
493         }
494     }
496     if (is_null($context->path) or $context->depth == 0) {
497         //this should not happen
498         $contexts = array(SYSCONTEXTID, $context->id);
499         $context->path = '/'.SYSCONTEXTID.'/'.$context->id;
500         debugging('Context id '.$context->id.' does not have valid path, please use build_context_path()', DEBUG_DEVELOPER);
502     } else {
503         $contexts = explode('/', $context->path);
504         array_shift($contexts);
505     }
507     if (CLI_SCRIPT && !isset($USER->access)) {
508         // In cron, some modules setup a 'fake' $USER,
509         // ensure we load the appropriate accessdata.
510         if (isset($ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
511             $ACCESSLIB_PRIVATE->dirtycontexts = null; //load fresh dirty contexts
512         } else {
513             load_user_accessdata($userid);
514             $ACCESSLIB_PRIVATE->dirtycontexts = array();
515         }
516         $USER->access = $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
518     } else if (isset($USER->id) && ($USER->id == $userid) && !isset($USER->access)) {
519         // caps not loaded yet - better to load them to keep BC with 1.8
520         // not-logged-in user or $USER object set up manually first time here
521         load_all_capabilities();
522         $ACCESSLIB_PRIVATE->accessdatabyuser = array(); // reset the cache for other users too, the dirty contexts are empty now
523         $ACCESSLIB_PRIVATE->roledefinitions = array();
524     }
526     // Load dirty contexts list if needed
527     if (!isset($ACCESSLIB_PRIVATE->dirtycontexts)) {
528         if (isset($USER->access['time'])) {
529             $ACCESSLIB_PRIVATE->dirtycontexts = get_dirty_contexts($USER->access['time']);
530         }
531         else {
532             $ACCESSLIB_PRIVATE->dirtycontexts = array();
533         }
534     }
536     // Careful check for staleness...
537     if (count($ACCESSLIB_PRIVATE->dirtycontexts) !== 0 and is_contextpath_dirty($contexts, $ACCESSLIB_PRIVATE->dirtycontexts)) {
538         // reload all capabilities - preserving loginas, roleswitches, etc
539         // and then cleanup any marks of dirtyness... at least from our short
540         // term memory! :-)
541         $ACCESSLIB_PRIVATE->accessdatabyuser = array();
542         $ACCESSLIB_PRIVATE->roledefinitions = array();
544         if (CLI_SCRIPT) {
545             load_user_accessdata($userid);
546             $USER->access = $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
547             $ACCESSLIB_PRIVATE->dirtycontexts = array();
549         } else {
550             reload_all_capabilities();
551         }
552     }
554     // Find out if user is admin - it is not possible to override the doanything in any way
555     // and it is not possible to switch to admin role either.
556     if ($doanything) {
557         if (is_siteadmin($userid)) {
558             if ($userid != $USER->id) {
559                 return true;
560             }
561             // make sure switchrole is not used in this context
562             if (empty($USER->access['rsw'])) {
563                 return true;
564             }
565             $parts = explode('/', trim($context->path, '/'));
566             $path = '';
567             $switched = false;
568             foreach ($parts as $part) {
569                 $path .= '/' . $part;
570                 if (!empty($USER->access['rsw'][$path])) {
571                     $switched = true;
572                     break;
573                 }
574             }
575             if (!$switched) {
576                 return true;
577             }
578             //ok, admin switched role in this context, let's use normal access control rules
579         }
580     }
582     // divulge how many times we are called
583     //// error_log("has_capability: id:{$context->id} path:{$context->path} userid:$userid cap:$capability");
585     if (isset($USER->id) && ($USER->id == $userid)) { // we must accept strings and integers in $userid
586         //
587         // For the logged in user, we have $USER->access
588         // which will have all RAs and caps preloaded for
589         // course and above contexts.
590         //
591         // Contexts below courses && contexts that do not
592         // hang from courses are loaded into $USER->access
593         // on demand, and listed in $USER->access[loaded]
594         //
595         if ($context->contextlevel <= CONTEXT_COURSE) {
596             // Course and above are always preloaded
597             return has_capability_in_accessdata($capability, $context, $USER->access);
598         }
599         // Load accessdata for below-the-course contexts
600         if (!path_inaccessdata($context->path,$USER->access)) {
601             // error_log("loading access for context {$context->path} for $capability at {$context->contextlevel} {$context->id}");
602             // $bt = debug_backtrace();
603             // error_log("bt {$bt[0]['file']} {$bt[0]['line']}");
604             load_subcontext($USER->id, $context, $USER->access);
605         }
606         return has_capability_in_accessdata($capability, $context, $USER->access);
607     }
609     if (!isset($ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
610         load_user_accessdata($userid);
611     }
613     if ($context->contextlevel <= CONTEXT_COURSE) {
614         // Course and above are always preloaded
615         return has_capability_in_accessdata($capability, $context, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid]);
616     }
617     // Load accessdata for below-the-course contexts as needed
618     if (!path_inaccessdata($context->path, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
619         // error_log("loading access for context {$context->path} for $capability at {$context->contextlevel} {$context->id}");
620         // $bt = debug_backtrace();
621         // error_log("bt {$bt[0]['file']} {$bt[0]['line']}");
622         load_subcontext($userid, $context, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid]);
623     }
624     return has_capability_in_accessdata($capability, $context, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid]);
627 /**
628  * Check if the user has any one of several capabilities from a list.
629  *
630  * This is just a utility method that calls has_capability in a loop. Try to put
631  * the capabilities that most users are likely to have first in the list for best
632  * performance.
633  *
634  * There are probably tricks that could be done to improve the performance here, for example,
635  * check the capabilities that are already cached first.
636  *
637  * @see has_capability()
638  * @param array $capabilities an array of capability names.
639  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
640  * @param integer $userid A user id. By default (null) checks the permissions of the current user.
641  * @param boolean $doanything If false, ignore effect of admin role assignment
642  * @return boolean true if the user has any of these capabilities. Otherwise false.
643  */
644 function has_any_capability($capabilities, $context, $userid = null, $doanything = true) {
645     if (!is_array($capabilities)) {
646         debugging('Incorrect $capabilities parameter in has_any_capabilities() call - must be an array');
647         return false;
648     }
649     foreach ($capabilities as $capability) {
650         if (has_capability($capability, $context, $userid, $doanything)) {
651             return true;
652         }
653     }
654     return false;
657 /**
658  * Check if the user has all the capabilities in a list.
659  *
660  * This is just a utility method that calls has_capability in a loop. Try to put
661  * the capabilities that fewest users are likely to have first in the list for best
662  * performance.
663  *
664  * There are probably tricks that could be done to improve the performance here, for example,
665  * check the capabilities that are already cached first.
666  *
667  * @see has_capability()
668  * @param array $capabilities an array of capability names.
669  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
670  * @param integer $userid A user id. By default (null) checks the permissions of the current user.
671  * @param boolean $doanything If false, ignore effect of admin role assignment
672  * @return boolean true if the user has all of these capabilities. Otherwise false.
673  */
674 function has_all_capabilities($capabilities, $context, $userid = null, $doanything = true) {
675     if (!is_array($capabilities)) {
676         debugging('Incorrect $capabilities parameter in has_all_capabilities() call - must be an array');
677         return false;
678     }
679     foreach ($capabilities as $capability) {
680         if (!has_capability($capability, $context, $userid, $doanything)) {
681             return false;
682         }
683     }
684     return true;
687 /**
688  * Check if the user is an admin at the site level.
689  *
690  * Please note that use of proper capabilities is always encouraged,
691  * this function is supposed to be used from core or for temporary hacks.
692  *
693  * @param   int|object  $user_or_id user id or user object
694  * @returns bool true if user is one of the administrators, false otherwise
695  */
696 function is_siteadmin($user_or_id = null) {
697     global $CFG, $USER;
699     if ($user_or_id === null) {
700         $user_or_id = $USER;
701     }
703     if (empty($user_or_id)) {
704         return false;
705     }
706     if (!empty($user_or_id->id)) {
707         // we support
708         $userid = $user_or_id->id;
709     } else {
710         $userid = $user_or_id;
711     }
713     $siteadmins = explode(',', $CFG->siteadmins);
714     return in_array($userid, $siteadmins);
717 /**
718  * Returns true if user has at least one role assign
719  * of 'coursecontact' role (is potentially listed in some course descriptions).
720  *
721  * @param $userid
722  * @return stdClass
723  */
724 function has_coursecontact_role($userid) {
725     global $DB, $CFG;
727     if (empty($CFG->coursecontact)) {
728         return false;
729     }
730     $sql = "SELECT 1
731               FROM {role_assignments}
732              WHERE userid = :userid AND roleid IN ($CFG->coursecontact)";
733     return $DB->record_exists_sql($sql, array('userid'=>$userid));
736 /**
737  * @param string $path
738  * @return string
739  */
740 function get_course_from_path($path) {
741     // assume that nothing is more than 1 course deep
742     if (preg_match('!^(/.+)/\d+$!', $path, $matches)) {
743         return $matches[1];
744     }
745     return false;
748 /**
749  * @param string $path
750  * @param array $accessdata
751  * @return bool
752  */
753 function path_inaccessdata($path, $accessdata) {
754     if (empty($accessdata['loaded'])) {
755         return false;
756     }
758     // assume that contexts hang from sys or from a course
759     // this will only work well with stuff that hangs from a course
760     if (in_array($path, $accessdata['loaded'], true)) {
761             // error_log("found it!");
762         return true;
763     }
764     $base = '/' . SYSCONTEXTID;
765     while (preg_match('!^(/.+)/\d+$!', $path, $matches)) {
766         $path = $matches[1];
767         if ($path === $base) {
768             return false;
769         }
770         if (in_array($path, $accessdata['loaded'], true)) {
771             return true;
772         }
773     }
774     return false;
777 /**
778  * Does the user have a capability to do something?
779  *
780  * Walk the accessdata array and return true/false.
781  * Deals with prohibits, roleswitching, aggregating
782  * capabilities, etc.
783  *
784  * The main feature of here is being FAST and with no
785  * side effects.
786  *
787  * Notes:
788  *
789  * Switch Roles exits early
790  * ------------------------
791  * cap checks within a switchrole need to exit early
792  * in our bottom up processing so they don't "see" that
793  * there are real RAs that can do all sorts of things.
794  *
795  * Switch Role merges with default role
796  * ------------------------------------
797  * If you are a teacher in course X, you have at least
798  * teacher-in-X + defaultloggedinuser-sitewide. So in the
799  * course you'll have techer+defaultloggedinuser.
800  * We try to mimic that in switchrole.
801  *
802  * Permission evaluation
803  * ---------------------
804  * Originally there was an extremely complicated way
805  * to determine the user access that dealt with
806  * "locality" or role assignments and role overrides.
807  * Now we simply evaluate access for each role separately
808  * and then verify if user has at least one role with allow
809  * and at the same time no role with prohibit.
810  *
811  * @param string $capability
812  * @param object $context
813  * @param array $accessdata
814  * @return bool
815  */
816 function has_capability_in_accessdata($capability, $context, array $accessdata) {
817     global $CFG;
819     if (empty($context->id)) {
820         throw new coding_exception('Invalid context specified');
821     }
823     // Build $paths as a list of current + all parent "paths" with order bottom-to-top
824     $contextids = explode('/', trim($context->path, '/'));
825     $paths = array($context->path);
826     while ($contextids) {
827         array_pop($contextids);
828         $paths[] = '/' . implode('/', $contextids);
829     }
830     unset($contextids);
832     $roles = array();
833     $switchedrole = false;
835     // Find out if role switched
836     if (!empty($accessdata['rsw'])) {
837         // From the bottom up...
838         foreach ($paths as $path) {
839             if (isset($accessdata['rsw'][$path])) {
840                 // Found a switchrole assignment - check for that role _plus_ the default user role
841                 $roles = array($accessdata['rsw'][$path]=>null, $CFG->defaultuserroleid=>null);
842                 $switchedrole = true;
843                 break;
844             }
845         }
846     }
848     if (!$switchedrole) {
849         // get all users roles in this context and above
850         foreach ($paths as $path) {
851             if (isset($accessdata['ra'][$path])) {
852                 foreach ($accessdata['ra'][$path] as $roleid) {
853                     $roles[$roleid] = null;
854                 }
855             }
856         }
857     }
859     // Now find out what access is given to each role, going bottom-->up direction
860     foreach ($roles as $roleid => $ignored) {
861         foreach ($paths as $path) {
862             if (isset($accessdata['rdef']["{$path}:$roleid"][$capability])) {
863                 $perm = (int)$accessdata['rdef']["{$path}:$roleid"][$capability];
864                 if ($perm === CAP_PROHIBIT or is_null($roles[$roleid])) {
865                     $roles[$roleid] = $perm;
866                 }
867             }
868         }
869     }
870     // any CAP_PROHIBIT found means no permission for the user
871     if (array_search(CAP_PROHIBIT, $roles) !== false) {
872         return false;
873     }
875     // at least one CAP_ALLOW means the user has a permission
876     return (array_search(CAP_ALLOW, $roles) !== false);
879 /**
880  * @param object $context
881  * @param array $accessdata
882  * @return array
883  */
884 function aggregate_roles_from_accessdata($context, $accessdata) {
886     $path = $context->path;
888     // build $contexts as a list of "paths" of the current
889     // contexts and parents with the order top-to-bottom
890     $contexts = array($path);
891     while (preg_match('!^(/.+)/\d+$!', $path, $matches)) {
892         $path = $matches[1];
893         array_unshift($contexts, $path);
894     }
896     $cc = count($contexts);
898     $roles = array();
899     // From the bottom up...
900     for ($n=$cc-1; $n>=0; $n--) {
901         $ctxp = $contexts[$n];
902         if (isset($accessdata['ra'][$ctxp]) && count($accessdata['ra'][$ctxp])) {
903             // Found assignments on this leaf
904             $addroles = $accessdata['ra'][$ctxp];
905             $roles    = array_merge($roles, $addroles);
906         }
907     }
909     return array_unique($roles);
912 /**
913  * A convenience function that tests has_capability, and displays an error if
914  * the user does not have that capability.
915  *
916  * NOTE before Moodle 2.0, this function attempted to make an appropriate
917  * require_login call before checking the capability. This is no longer the case.
918  * You must call require_login (or one of its variants) if you want to check the
919  * user is logged in, before you call this function.
920  *
921  * @see has_capability()
922  *
923  * @param string $capability the name of the capability to check. For example mod/forum:view
924  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
925  * @param integer $userid A user id. By default (null) checks the permissions of the current user.
926  * @param bool $doanything If false, ignore effect of admin role assignment
927  * @param string $errorstring The error string to to user. Defaults to 'nopermissions'.
928  * @param string $stringfile The language file to load the error string from. Defaults to 'error'.
929  * @return void terminates with an error if the user does not have the given capability.
930  */
931 function require_capability($capability, $context, $userid = null, $doanything = true,
932                             $errormessage = 'nopermissions', $stringfile = '') {
933     if (!has_capability($capability, $context, $userid, $doanything)) {
934         throw new required_capability_exception($context, $capability, $errormessage, $stringfile);
935     }
938 /**
939  * Get an array of courses where cap requested is available
940  * and user is enrolled, this can be relatively slow.
941  *
942  * @param string $capability - name of the capability
943  * @param array  $accessdata_ignored
944  * @param bool   $doanything_ignored
945  * @param string $sort - sorting fields - prefix each fieldname with "c."
946  * @param array  $fields - additional fields you are interested in...
947  * @param int    $limit_ignored
948  * @return array $courses - ordered array of course objects - see notes above
949  */
950 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
952     //TODO: this should be most probably deprecated
954     $courses = enrol_get_users_courses($userid, true, $fields, $sort);
955     foreach ($courses as $id=>$course) {
956         $context = get_context_instance(CONTEXT_COURSE, $id);
957         if (!has_capability($cap, $context, $userid)) {
958             unset($courses[$id]);
959         }
960     }
962     return $courses;
966 /**
967  * Return a nested array showing role assignments
968  * all relevant role capabilities for the user at
969  * site/course_category/course levels
970  *
971  * We do _not_ delve deeper than courses because the number of
972  * overrides at the module/block levels is HUGE.
973  *
974  * [ra]   => [/path/][]=roleid
975  * [rdef] => [/path/:roleid][capability]=permission
976  * [loaded] => array('/path', '/path')
977  *
978  * @param int $userid - the id of the user
979  * @return array
980  */
981 function get_user_access_sitewide($userid) {
982     global $CFG, $DB;
984     /* Get in 3 cheap DB queries...
985      * - role assignments
986      * - relevant role caps
987      *   - above and within this user's RAs
988      *   - below this user's RAs - limited to course level
989      */
991     $accessdata = array(); // named list
992     $accessdata['ra']     = array();
993     $accessdata['rdef']   = array();
994     $accessdata['loaded'] = array();
996     //
997     // Role assignments
998     //
999     $sql = "SELECT ctx.path, ra.roleid
1000               FROM {role_assignments} ra
1001               JOIN {context} ctx ON ctx.id=ra.contextid
1002              WHERE ra.userid = ? AND ctx.contextlevel <= ".CONTEXT_COURSE;
1003     $params = array($userid);
1004     $rs = $DB->get_recordset_sql($sql, $params);
1006     //
1007     // raparents collects paths & roles we need to walk up
1008     // the parenthood to build the rdef
1009     //
1010     $raparents = array();
1011     if ($rs) {
1012         foreach ($rs as $ra) {
1013             // RAs leafs are arrays to support multi
1014             // role assignments...
1015             if (!isset($accessdata['ra'][$ra->path])) {
1016                 $accessdata['ra'][$ra->path] = array();
1017             }
1018             $accessdata['ra'][$ra->path][$ra->roleid] = $ra->roleid;
1020             // Concatenate as string the whole path (all related context)
1021             // for this role. This is damn faster than using array_merge()
1022             // Will unique them later
1023             if (isset($raparents[$ra->roleid])) {
1024                 $raparents[$ra->roleid] .= $ra->path;
1025             } else {
1026                 $raparents[$ra->roleid] = $ra->path;
1027             }
1028         }
1029         unset($ra);
1030         $rs->close();
1031     }
1033     // Walk up the tree to grab all the roledefs
1034     // of interest to our user...
1035     //
1036     // NOTE: we use a series of IN clauses here - which
1037     // might explode on huge sites with very convoluted nesting of
1038     // categories... - extremely unlikely that the number of categories
1039     // and roletypes is so large that we hit the limits of IN()
1040     $clauses = '';
1041     $cparams = array();
1042     foreach ($raparents as $roleid=>$strcontexts) {
1043         $contexts = implode(',', array_unique(explode('/', trim($strcontexts, '/'))));
1044         if ($contexts ==! '') {
1045             if ($clauses) {
1046                 $clauses .= ' OR ';
1047             }
1048             $clauses .= "(roleid=? AND contextid IN ($contexts))";
1049             $cparams[] = $roleid;
1050         }
1051     }
1053     if ($clauses !== '') {
1054         $sql = "SELECT ctx.path, rc.roleid, rc.capability, rc.permission
1055                   FROM {role_capabilities} rc
1056                   JOIN {context} ctx ON rc.contextid=ctx.id
1057                  WHERE $clauses";
1059         unset($clauses);
1060         $rs = $DB->get_recordset_sql($sql, $cparams);
1062         if ($rs) {
1063             foreach ($rs as $rd) {
1064                 $k = "{$rd->path}:{$rd->roleid}";
1065                 $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1066             }
1067             unset($rd);
1068             $rs->close();
1069         }
1070     }
1072     //
1073     // Overrides for the role assignments IN SUBCONTEXTS
1074     // (though we still do _not_ go below the course level.
1075     //
1076     // NOTE that the JOIN w sctx is with 3-way triangulation to
1077     // catch overrides to the applicable role in any subcontext, based
1078     // on the path field of the parent.
1079     //
1080     $sql = "SELECT sctx.path, ra.roleid,
1081                    ctx.path AS parentpath,
1082                    rco.capability, rco.permission
1083               FROM {role_assignments} ra
1084               JOIN {context} ctx
1085                    ON ra.contextid=ctx.id
1086               JOIN {context} sctx
1087                    ON (sctx.path LIKE " . $DB->sql_concat('ctx.path',"'/%'"). " )
1088               JOIN {role_capabilities} rco
1089                    ON (rco.roleid=ra.roleid AND rco.contextid=sctx.id)
1090              WHERE ra.userid = ?
1091                    AND ctx.contextlevel <= ".CONTEXT_COURSECAT."
1092                    AND sctx.contextlevel <= ".CONTEXT_COURSE."
1093           ORDER BY sctx.depth, sctx.path, ra.roleid";
1094     $params = array($userid);
1095     $rs = $DB->get_recordset_sql($sql, $params);
1096     if ($rs) {
1097         foreach ($rs as $rd) {
1098             $k = "{$rd->path}:{$rd->roleid}";
1099             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1100         }
1101         unset($rd);
1102         $rs->close();
1103     }
1104     return $accessdata;
1107 /**
1108  * Add to the access ctrl array the data needed by a user for a given context
1109  *
1110  * @param integer $userid the id of the user
1111  * @param object $context needs path!
1112  * @param array $accessdata accessdata array
1113  * @return void
1114  */
1115 function load_subcontext($userid, $context, &$accessdata) {
1116     global $CFG, $DB;
1118     /* Get the additional RAs and relevant rolecaps
1119      * - role assignments - with role_caps
1120      * - relevant role caps
1121      *   - above this user's RAs
1122      *   - below this user's RAs - limited to course level
1123      */
1125     $base = "/" . SYSCONTEXTID;
1127     //
1128     // Replace $context with the target context we will
1129     // load. Normally, this will be a course context, but
1130     // may be a different top-level context.
1131     //
1132     // We have 3 cases
1133     //
1134     // - Course
1135     // - BLOCK/PERSON/USER/COURSE(sitecourse) hanging from SYSTEM
1136     // - BLOCK/MODULE/GROUP hanging from a course
1137     //
1138     // For course contexts, we _already_ have the RAs
1139     // but the cost of re-fetching is minimal so we don't care.
1140     //
1141     if ($context->contextlevel !== CONTEXT_COURSE
1142         && $context->path !== "$base/{$context->id}") {
1143         // Case BLOCK/MODULE/GROUP hanging from a course
1144         // Assumption: the course _must_ be our parent
1145         // If we ever see stuff nested further this needs to
1146         // change to do 1 query over the exploded path to
1147         // find out which one is the course
1148         $courses = explode('/',get_course_from_path($context->path));
1149         $targetid = array_pop($courses);
1150         $context = get_context_instance_by_id($targetid);
1152     }
1154     //
1155     // Role assignments in the context and below
1156     //
1157     $sql = "SELECT ctx.path, ra.roleid
1158               FROM {role_assignments} ra
1159               JOIN {context} ctx
1160                    ON ra.contextid=ctx.id
1161              WHERE ra.userid = ?
1162                    AND (ctx.path = ? OR ctx.path LIKE ?)
1163           ORDER BY ctx.depth, ctx.path, ra.roleid";
1164     $params = array($userid, $context->path, $context->path."/%");
1165     $rs = $DB->get_recordset_sql($sql, $params);
1167     //
1168     // Read in the RAs, preventing duplicates
1169     //
1170     if ($rs) {
1171         $localroles = array();
1172         $lastseen  = '';
1173         foreach ($rs as $ra) {
1174             if (!isset($accessdata['ra'][$ra->path])) {
1175                 $accessdata['ra'][$ra->path] = array();
1176             }
1177             // only add if is not a repeat caused
1178             // by capability join...
1179             // (this check is cheaper than in_array())
1180             if ($lastseen !== $ra->path.':'.$ra->roleid) {
1181                 $lastseen = $ra->path.':'.$ra->roleid;
1182                 $accessdata['ra'][$ra->path][$ra->roleid] = $ra->roleid;
1183                 array_push($localroles,           $ra->roleid);
1184             }
1185         }
1186         $rs->close();
1187     }
1189     //
1190     // Walk up and down the tree to grab all the roledefs
1191     // of interest to our user...
1192     //
1193     // NOTES
1194     // - we use IN() but the number of roles is very limited.
1195     //
1196     $courseroles    = aggregate_roles_from_accessdata($context, $accessdata);
1198     // Do we have any interesting "local" roles?
1199     $localroles = array_diff($localroles,$courseroles); // only "new" local roles
1200     $wherelocalroles='';
1201     if (count($localroles)) {
1202         // Role defs for local roles in 'higher' contexts...
1203         $contexts = substr($context->path, 1); // kill leading slash
1204         $contexts = str_replace('/', ',', $contexts);
1205         $localroleids = implode(',',$localroles);
1206         $wherelocalroles="OR (rc.roleid IN ({$localroleids})
1207                               AND ctx.id IN ($contexts))" ;
1208     }
1210     // We will want overrides for all of them
1211     $whereroles = '';
1212     if ($roleids  = implode(',',array_merge($courseroles,$localroles))) {
1213         $whereroles = "rc.roleid IN ($roleids) AND";
1214     }
1215     $sql = "SELECT ctx.path, rc.roleid, rc.capability, rc.permission
1216               FROM {role_capabilities} rc
1217               JOIN {context} ctx
1218                    ON rc.contextid=ctx.id
1219              WHERE ($whereroles
1220                     (ctx.id=? OR ctx.path LIKE ?))
1221                    $wherelocalroles
1222           ORDER BY ctx.depth ASC, ctx.path DESC, rc.roleid ASC ";
1223     $params = array($context->id, $context->path."/%");
1225     $newrdefs = array();
1226     if ($rs = $DB->get_recordset_sql($sql, $params)) {
1227         foreach ($rs as $rd) {
1228             $k = "{$rd->path}:{$rd->roleid}";
1229             if (!array_key_exists($k, $newrdefs)) {
1230                 $newrdefs[$k] = array();
1231             }
1232             $newrdefs[$k][$rd->capability] = $rd->permission;
1233         }
1234         $rs->close();
1235     } else {
1236         debugging('Bad SQL encountered!');
1237     }
1239     compact_rdefs($newrdefs);
1240     foreach ($newrdefs as $key=>$value) {
1241         $accessdata['rdef'][$key] =& $newrdefs[$key];
1242     }
1244     // error_log("loaded {$context->path}");
1245     $accessdata['loaded'][] = $context->path;
1248 /**
1249  * Add to the access ctrl array the data needed by a role for a given context.
1250  *
1251  * The data is added in the rdef key.
1252  *
1253  * This role-centric function is useful for role_switching
1254  * and to get an overview of what a role gets under a
1255  * given context and below...
1256  *
1257  * @param integer $roleid the id of the user
1258  * @param object $context needs path!
1259  * @param array $accessdata accessdata array null by default
1260  * @return array
1261  */
1262 function get_role_access_bycontext($roleid, $context, $accessdata = null) {
1263     global $CFG, $DB;
1265     /* Get the relevant rolecaps into rdef
1266      * - relevant role caps
1267      *   - at ctx and above
1268      *   - below this ctx
1269      */
1271     if (is_null($accessdata)) {
1272         $accessdata           = array(); // named list
1273         $accessdata['ra']     = array();
1274         $accessdata['rdef']   = array();
1275         $accessdata['loaded'] = array();
1276     }
1278     $contexts = substr($context->path, 1); // kill leading slash
1279     $contexts = str_replace('/', ',', $contexts);
1281     //
1282     // Walk up and down the tree to grab all the roledefs
1283     // of interest to our role...
1284     //
1285     // NOTE: we use an IN clauses here - which
1286     // might explode on huge sites with very convoluted nesting of
1287     // categories... - extremely unlikely that the number of nested
1288     // categories is so large that we hit the limits of IN()
1289     //
1290     $sql = "SELECT ctx.path, rc.capability, rc.permission
1291               FROM {role_capabilities} rc
1292               JOIN {context} ctx
1293                    ON rc.contextid=ctx.id
1294              WHERE rc.roleid=? AND
1295                    ( ctx.id IN ($contexts) OR
1296                     ctx.path LIKE ? )
1297           ORDER BY ctx.depth ASC, ctx.path DESC, rc.roleid ASC ";
1298     $params = array($roleid, $context->path."/%");
1300     if ($rs = $DB->get_recordset_sql($sql, $params)) {
1301         foreach ($rs as $rd) {
1302             $k = "{$rd->path}:{$roleid}";
1303             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1304         }
1305         $rs->close();
1306     }
1308     return $accessdata;
1311 /**
1312  * Load accessdata for a user into the $ACCESSLIB_PRIVATE->accessdatabyuser global
1313  *
1314  * Used by has_capability() - but feel free
1315  * to call it if you are about to run a BIG
1316  * cron run across a bazillion users.
1317  *
1318  * @param int $userid
1319  * @return array returns ACCESSLIB_PRIVATE->accessdatabyuser[userid]
1320  */
1321 function load_user_accessdata($userid) {
1322     global $CFG, $ACCESSLIB_PRIVATE;
1324     $base = '/'.SYSCONTEXTID;
1326     $accessdata = get_user_access_sitewide($userid);
1327     $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1328     //
1329     // provide "default role" & set 'dr'
1330     //
1331     if (!empty($CFG->defaultuserroleid)) {
1332         $accessdata = get_role_access($CFG->defaultuserroleid, $accessdata);
1333         if (!isset($accessdata['ra'][$base])) {
1334             $accessdata['ra'][$base] = array();
1335         }
1336         $accessdata['ra'][$base][$CFG->defaultuserroleid] = $CFG->defaultuserroleid;
1337         $accessdata['dr'] = $CFG->defaultuserroleid;
1338     }
1340     //
1341     // provide "default frontpage role"
1342     //
1343     if (!empty($CFG->defaultfrontpageroleid)) {
1344         $base = '/'. SYSCONTEXTID .'/'. $frontpagecontext->id;
1345         $accessdata = get_default_frontpage_role_access($CFG->defaultfrontpageroleid, $accessdata);
1346         if (!isset($accessdata['ra'][$base])) {
1347             $accessdata['ra'][$base] = array();
1348         }
1349         $accessdata['ra'][$base][$CFG->defaultfrontpageroleid] = $CFG->defaultfrontpageroleid;
1350     }
1351     // for dirty timestamps in cron
1352     $accessdata['time'] = time();
1354     $ACCESSLIB_PRIVATE->accessdatabyuser[$userid] = $accessdata;
1355     compact_rdefs($ACCESSLIB_PRIVATE->accessdatabyuser[$userid]['rdef']);
1357     return $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
1360 /**
1361  * Use shared copy of role definitions stored in ACCESSLIB_PRIVATE->roledefinitions;
1362  *
1363  * @param array $rdefs array of role definitions in contexts
1364  */
1365 function compact_rdefs(&$rdefs) {
1366     global $ACCESSLIB_PRIVATE;
1368     /*
1369      * This is a basic sharing only, we could also
1370      * use md5 sums of values. The main purpose is to
1371      * reduce mem in cron jobs - many users in $ACCESSLIB_PRIVATE->accessdatabyuser array.
1372      */
1374     foreach ($rdefs as $key => $value) {
1375         if (!array_key_exists($key, $ACCESSLIB_PRIVATE->roledefinitions)) {
1376             $ACCESSLIB_PRIVATE->roledefinitions[$key] = $rdefs[$key];
1377         }
1378         $rdefs[$key] =& $ACCESSLIB_PRIVATE->roledefinitions[$key];
1379     }
1382 /**
1383  * A convenience function to completely load all the capabilities
1384  * for the current user.   This is what gets called from complete_user_login()
1385  * for example. Call it only _after_ you've setup $USER and called
1386  * check_enrolment_plugins();
1387  * @see check_enrolment_plugins()
1388  *
1389  * @return void
1390  */
1391 function load_all_capabilities() {
1392     global $CFG, $ACCESSLIB_PRIVATE;
1394     //NOTE: we can not use $USER here because it may no be linked to $_SESSION['USER'] yet!
1396     // roles not installed yet - we are in the middle of installation
1397     if (during_initial_install()) {
1398         return;
1399     }
1401     $base = '/'.SYSCONTEXTID;
1403     if (isguestuser($_SESSION['USER'])) {
1404         $guest = get_guest_role();
1406         // Load the rdefs
1407         $_SESSION['USER']->access = get_role_access($guest->id);
1408         // Put the ghost enrolment in place...
1409         $_SESSION['USER']->access['ra'][$base] = array($guest->id => $guest->id);
1412     } else if (!empty($_SESSION['USER']->id)) { // can not use isloggedin() yet
1414         $accessdata = get_user_access_sitewide($_SESSION['USER']->id);
1416         //
1417         // provide "default role" & set 'dr'
1418         //
1419         if (!empty($CFG->defaultuserroleid)) {
1420             $accessdata = get_role_access($CFG->defaultuserroleid, $accessdata);
1421             if (!isset($accessdata['ra'][$base])) {
1422                 $accessdata['ra'][$base] = array();
1423             }
1424             $accessdata['ra'][$base][$CFG->defaultuserroleid] = $CFG->defaultuserroleid;
1425             $accessdata['dr'] = $CFG->defaultuserroleid;
1426         }
1428         $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1430         //
1431         // provide "default frontpage role"
1432         //
1433         if (!empty($CFG->defaultfrontpageroleid)) {
1434             $base = '/'. SYSCONTEXTID .'/'. $frontpagecontext->id;
1435             $accessdata = get_default_frontpage_role_access($CFG->defaultfrontpageroleid, $accessdata);
1436             if (!isset($accessdata['ra'][$base])) {
1437                 $accessdata['ra'][$base] = array();
1438             }
1439             $accessdata['ra'][$base][$CFG->defaultfrontpageroleid] = $CFG->defaultfrontpageroleid;
1440         }
1441         $_SESSION['USER']->access = $accessdata;
1443     } else if (!empty($CFG->notloggedinroleid)) {
1444         $_SESSION['USER']->access = get_role_access($CFG->notloggedinroleid);
1445         $_SESSION['USER']->access['ra'][$base] = array($CFG->notloggedinroleid => $CFG->notloggedinroleid);
1446     }
1448     // Timestamp to read dirty context timestamps later
1449     $_SESSION['USER']->access['time'] = time();
1450     $ACCESSLIB_PRIVATE->dirtycontexts = array();
1452     // Clear to force a refresh
1453     unset($_SESSION['USER']->mycourses);
1456 /**
1457  * A convenience function to completely reload all the capabilities
1458  * for the current user when roles have been updated in a relevant
1459  * context -- but PRESERVING switchroles and loginas.
1460  *
1461  * That is - completely transparent to the user.
1462  *
1463  * Note: rewrites $USER->access completely.
1464  *
1465  * @return void
1466  */
1467 function reload_all_capabilities() {
1468     global $USER, $DB;
1470     // error_log("reloading");
1471     // copy switchroles
1472     $sw = array();
1473     if (isset($USER->access['rsw'])) {
1474         $sw = $USER->access['rsw'];
1475         // error_log(print_r($sw,1));
1476     }
1478     unset($USER->access);
1479     unset($USER->mycourses);
1481     load_all_capabilities();
1483     foreach ($sw as $path => $roleid) {
1484         $context = $DB->get_record('context', array('path'=>$path));
1485         role_switch($roleid, $context);
1486     }
1490 /**
1491  * Adds a temp role to an accessdata array.
1492  *
1493  * Useful for the "temporary guest" access
1494  * we grant to logged-in users.
1495  *
1496  * Note - assumes a course context!
1497  *
1498  * @param object $content
1499  * @param int $roleid
1500  * @param array $accessdata
1501  * @return array Returns access data
1502  */
1503 function load_temp_role($context, $roleid, array $accessdata) {
1504     global $CFG, $DB;
1506     //
1507     // Load rdefs for the role in -
1508     // - this context
1509     // - all the parents
1510     // - and below - IOWs overrides...
1511     //
1513     // turn the path into a list of context ids
1514     $contexts = substr($context->path, 1); // kill leading slash
1515     $contexts = str_replace('/', ',', $contexts);
1517     $sql = "SELECT ctx.path, rc.capability, rc.permission
1518               FROM {context} ctx
1519               JOIN {role_capabilities} rc
1520                    ON rc.contextid=ctx.id
1521              WHERE (ctx.id IN ($contexts)
1522                     OR ctx.path LIKE ?)
1523                    AND rc.roleid = ?
1524           ORDER BY ctx.depth, ctx.path";
1525     $params = array($context->path."/%", $roleid);
1526     if ($rs = $DB->get_recordset_sql($sql, $params)) {
1527         foreach ($rs as $rd) {
1528             $k = "{$rd->path}:{$roleid}";
1529             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1530         }
1531         $rs->close();
1532     }
1534     //
1535     // Say we loaded everything for the course context
1536     // - which we just did - if the user gets a proper
1537     // RA in this session, this data will need to be reloaded,
1538     // but that is handled by the complete accessdata reload
1539     //
1540     array_push($accessdata['loaded'], $context->path);
1542     //
1543     // Add the ghost RA
1544     //
1545     if (!isset($accessdata['ra'][$context->path])) {
1546         $accessdata['ra'][$context->path] = array();
1547     }
1548     $accessdata['ra'][$context->path][$roleid] = $roleid;
1550     return $accessdata;
1553 /**
1554  * Removes any extra guest roles from accessdata
1555  * @param object $context
1556  * @param array $accessdata
1557  * @return array access data
1558  */
1559 function remove_temp_roles($context, array $accessdata) {
1560     global $DB, $USER;
1561     $sql = "SELECT DISTINCT ra.roleid AS id
1562               FROM {role_assignments} ra
1563              WHERE ra.contextid = :contextid AND ra.userid = :userid";
1564     $ras = $DB->get_records_sql($sql, array('contextid'=>$context->id, 'userid'=>$USER->id));
1566     if ($ras) {
1567         $accessdata['ra'][$context->path] = array_combine(array_keys($ras), array_keys($ras));
1568     } else {
1569         $accessdata['ra'][$context->path] = array();
1570     }
1572     return $accessdata;
1575 /**
1576  * Returns array of all role archetypes.
1577  *
1578  * @return array
1579  */
1580 function get_role_archetypes() {
1581     return array(
1582         'manager'        => 'manager',
1583         'coursecreator'  => 'coursecreator',
1584         'editingteacher' => 'editingteacher',
1585         'teacher'        => 'teacher',
1586         'student'        => 'student',
1587         'guest'          => 'guest',
1588         'user'           => 'user',
1589         'frontpage'      => 'frontpage'
1590     );
1593 /**
1594  * Assign the defaults found in this capability definition to roles that have
1595  * the corresponding legacy capabilities assigned to them.
1596  *
1597  * @param string $capability
1598  * @param array $legacyperms an array in the format (example):
1599  *                      'guest' => CAP_PREVENT,
1600  *                      'student' => CAP_ALLOW,
1601  *                      'teacher' => CAP_ALLOW,
1602  *                      'editingteacher' => CAP_ALLOW,
1603  *                      'coursecreator' => CAP_ALLOW,
1604  *                      'manager' => CAP_ALLOW
1605  * @return boolean success or failure.
1606  */
1607 function assign_legacy_capabilities($capability, $legacyperms) {
1609     $archetypes = get_role_archetypes();
1611     foreach ($legacyperms as $type => $perm) {
1613         $systemcontext = get_context_instance(CONTEXT_SYSTEM);
1614         if ($type === 'admin') {
1615             debugging('Legacy type admin in access.php was renamed to manager, please update the code.');
1616             $type = 'manager';
1617         }
1619         if (!array_key_exists($type, $archetypes)) {
1620             print_error('invalidlegacy', '', '', $type);
1621         }
1623         if ($roles = get_archetype_roles($type)) {
1624             foreach ($roles as $role) {
1625                 // Assign a site level capability.
1626                 if (!assign_capability($capability, $perm, $role->id, $systemcontext->id)) {
1627                     return false;
1628                 }
1629             }
1630         }
1631     }
1632     return true;
1635 /**
1636  * @param object $capability a capability - a row from the capabilities table.
1637  * @return boolean whether this capability is safe - that is, whether people with the
1638  *      safeoverrides capability should be allowed to change it.
1639  */
1640 function is_safe_capability($capability) {
1641     return !((RISK_DATALOSS | RISK_MANAGETRUST | RISK_CONFIG | RISK_XSS | RISK_PERSONAL) & $capability->riskbitmask);
1644 /**********************************
1645  * Context Manipulation functions *
1646  **********************************/
1648 /**
1649  * Context creation - internal implementation.
1650  *
1651  * Create a new context record for use by all roles-related stuff
1652  * assumes that the caller has done the homework.
1653  *
1654  * DO NOT CALL THIS DIRECTLY, instead use {@link get_context_instance}!
1655  *
1656  * @param int $contextlevel
1657  * @param int $instanceid
1658  * @param int $strictness
1659  * @return object newly created context
1660  */
1661 function create_context($contextlevel, $instanceid, $strictness = IGNORE_MISSING) {
1662     global $CFG, $DB;
1664     if ($contextlevel == CONTEXT_SYSTEM) {
1665         return get_system_context();
1666     }
1668     $context = new stdClass();
1669     $context->contextlevel = $contextlevel;
1670     $context->instanceid = $instanceid;
1672     // Define $context->path based on the parent
1673     // context. In other words... Who is your daddy?
1674     $basepath  = '/' . SYSCONTEXTID;
1675     $basedepth = 1;
1677     $result = true;
1678     $error_message = null;
1680     switch ($contextlevel) {
1681         case CONTEXT_COURSECAT:
1682             $sql = "SELECT ctx.path, ctx.depth
1683                       FROM {context}           ctx
1684                       JOIN {course_categories} cc
1685                            ON (cc.parent=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT.")
1686                      WHERE cc.id=?";
1687             $params = array($instanceid);
1688             if ($p = $DB->get_record_sql($sql, $params)) {
1689                 $basepath  = $p->path;
1690                 $basedepth = $p->depth;
1691             } else if ($category = $DB->get_record('course_categories', array('id'=>$instanceid), '*', $strictness)) {
1692                 if (empty($category->parent)) {
1693                     // ok - this is a top category
1694                 } else if ($parent = get_context_instance(CONTEXT_COURSECAT, $category->parent)) {
1695                     $basepath  = $parent->path;
1696                     $basedepth = $parent->depth;
1697                 } else {
1698                     // wrong parent category - no big deal, this can be fixed later
1699                     $basepath  = null;
1700                     $basedepth = 0;
1701                 }
1702             } else {
1703                 // incorrect category id
1704                 $error_message = "incorrect course category id ($instanceid)";
1705                 $result = false;
1706             }
1707             break;
1709         case CONTEXT_COURSE:
1710             $sql = "SELECT ctx.path, ctx.depth
1711                       FROM {context} ctx
1712                       JOIN {course}  c
1713                            ON (c.category=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT.")
1714                      WHERE c.id=? AND c.id !=" . SITEID;
1715             $params = array($instanceid);
1716             if ($p = $DB->get_record_sql($sql, $params)) {
1717                 $basepath  = $p->path;
1718                 $basedepth = $p->depth;
1719             } else if ($course = $DB->get_record('course', array('id'=>$instanceid), '*', $strictness)) {
1720                 if ($course->id == SITEID) {
1721                     //ok - no parent category
1722                 } else if ($parent = get_context_instance(CONTEXT_COURSECAT, $course->category)) {
1723                     $basepath  = $parent->path;
1724                     $basedepth = $parent->depth;
1725                 } else {
1726                     // wrong parent category of course - no big deal, this can be fixed later
1727                     $basepath  = null;
1728                     $basedepth = 0;
1729                 }
1730             } else if ($instanceid == SITEID) {
1731                 // no errors for missing site course during installation
1732                 return false;
1733             } else {
1734                 // incorrect course id
1735                 $error_message = "incorrect course id ($instanceid)";
1736                 $result = false;
1737             }
1738             break;
1740         case CONTEXT_MODULE:
1741             $sql = "SELECT ctx.path, ctx.depth
1742                       FROM {context}        ctx
1743                       JOIN {course_modules} cm
1744                            ON (cm.course=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
1745                      WHERE cm.id=?";
1746             $params = array($instanceid);
1747             if ($p = $DB->get_record_sql($sql, $params)) {
1748                 $basepath  = $p->path;
1749                 $basedepth = $p->depth;
1750             } else if ($cm = $DB->get_record('course_modules', array('id'=>$instanceid), '*', $strictness)) {
1751                 if ($parent = get_context_instance(CONTEXT_COURSE, $cm->course, $strictness)) {
1752                     $basepath  = $parent->path;
1753                     $basedepth = $parent->depth;
1754                 } else {
1755                     // course does not exist - modules can not exist without a course
1756                     $error_message = "course does not exist ($cm->course) - modules can not exist without a course";
1757                     $result = false;
1758                 }
1759             } else {
1760                 // cm does not exist
1761                 $error_message = "cm with id $instanceid does not exist";
1762                 $result = false;
1763             }
1764             break;
1766         case CONTEXT_BLOCK:
1767             $sql = "SELECT ctx.path, ctx.depth
1768                       FROM {context} ctx
1769                       JOIN {block_instances} bi ON (bi.parentcontextid=ctx.id)
1770                      WHERE bi.id = ?";
1771             $params = array($instanceid, CONTEXT_COURSE);
1772             if ($p = $DB->get_record_sql($sql, $params, '*', $strictness)) {
1773                 $basepath  = $p->path;
1774                 $basedepth = $p->depth;
1775             } else {
1776                 // block does not exist
1777                 $error_message = 'block or parent context does not exist';
1778                 $result = false;
1779             }
1780             break;
1781         case CONTEXT_USER:
1782             // default to basepath
1783             break;
1784     }
1786     // if grandparents unknown, maybe rebuild_context_path() will solve it later
1787     if ($basedepth != 0) {
1788         $context->depth = $basedepth+1;
1789     }
1791     if (!$result) {
1792         debugging('Error: could not insert new context level "'.
1793                   s($contextlevel).'", instance "'.
1794                   s($instanceid).'". ' . $error_message);
1796         return false;
1797     }
1799     $id = $DB->insert_record('context', $context);
1800     // can't set the full path till we know the id!
1801     if ($basedepth != 0 and !empty($basepath)) {
1802         $DB->set_field('context', 'path', $basepath.'/'. $id, array('id'=>$id));
1803     }
1804     return get_context_instance_by_id($id);
1807 /**
1808  * Returns system context or null if can not be created yet.
1809  *
1810  * @param bool $cache use caching
1811  * @return mixed system context or null
1812  */
1813 function get_system_context($cache = true) {
1814     global $DB, $ACCESSLIB_PRIVATE;
1815     if ($cache and defined('SYSCONTEXTID')) {
1816         if (is_null($ACCESSLIB_PRIVATE->systemcontext)) {
1817             $ACCESSLIB_PRIVATE->systemcontext = new stdClass();
1818             $ACCESSLIB_PRIVATE->systemcontext->id           = SYSCONTEXTID;
1819             $ACCESSLIB_PRIVATE->systemcontext->contextlevel = CONTEXT_SYSTEM;
1820             $ACCESSLIB_PRIVATE->systemcontext->instanceid   = 0;
1821             $ACCESSLIB_PRIVATE->systemcontext->path         = '/'.SYSCONTEXTID;
1822             $ACCESSLIB_PRIVATE->systemcontext->depth        = 1;
1823         }
1824         return $ACCESSLIB_PRIVATE->systemcontext;
1825     }
1826     try {
1827         $context = $DB->get_record('context', array('contextlevel'=>CONTEXT_SYSTEM));
1828     } catch (dml_exception $e) {
1829         //table does not exist yet, sorry
1830         return null;
1831     }
1833     if (!$context) {
1834         $context = new stdClass();
1835         $context->contextlevel = CONTEXT_SYSTEM;
1836         $context->instanceid   = 0;
1837         $context->depth        = 1;
1838         $context->path         = null; //not known before insert
1840         try {
1841             $context->id = $DB->insert_record('context', $context);
1842         } catch (dml_exception $e) {
1843             // can not create context yet, sorry
1844             return null;
1845         }
1846     }
1848     if (!isset($context->depth) or $context->depth != 1 or $context->instanceid != 0 or $context->path != '/'.$context->id) {
1849         $context->instanceid   = 0;
1850         $context->path         = '/'.$context->id;
1851         $context->depth        = 1;
1852         $DB->update_record('context', $context);
1853     }
1855     if (!defined('SYSCONTEXTID')) {
1856         define('SYSCONTEXTID', $context->id);
1857     }
1859     $ACCESSLIB_PRIVATE->systemcontext = $context;
1860     return $ACCESSLIB_PRIVATE->systemcontext;
1863 /**
1864  * Remove a context record and any dependent entries,
1865  * removes context from static context cache too
1866  *
1867  * @param int $level
1868  * @param int $instanceid
1869  * @param bool $deleterecord false means keep record for now
1870  * @return bool returns true or throws an exception
1871  */
1872 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1873     global $DB, $ACCESSLIB_PRIVATE, $CFG;
1875     // do not use get_context_instance(), because the related object might not exist,
1876     // or the context does not exist yet and it would be created now
1877     if ($context = $DB->get_record('context', array('contextlevel'=>$contextlevel, 'instanceid'=>$instanceid))) {
1878         // delete these first because they might fetch the context and try to recreate it!
1879         blocks_delete_all_for_context($context->id);
1880         filter_delete_all_for_context($context->id);
1882         require_once($CFG->dirroot . '/comment/lib.php');
1883         comment::delete_comments(array('contextid'=>$context->id));
1885         require_once($CFG->dirroot.'/rating/lib.php');
1886         $delopt = new stdclass();
1887         $delopt->contextid = $context->id;
1888         $rm = new rating_manager();
1889         $rm->delete_ratings($delopt);
1891         // delete all files attached to this context
1892         $fs = get_file_storage();
1893         $fs->delete_area_files($context->id);
1895         // now delete stuff from role related tables, role_unassign_all
1896         // and unenrol should be called earlier to do proper cleanup
1897         $DB->delete_records('role_assignments', array('contextid'=>$context->id));
1898         $DB->delete_records('role_capabilities', array('contextid'=>$context->id));
1899         $DB->delete_records('role_names', array('contextid'=>$context->id));
1901         // and finally it is time to delete the context record if requested
1902         if ($deleterecord) {
1903             $DB->delete_records('context', array('id'=>$context->id));
1904             // purge static context cache if entry present
1905             unset($ACCESSLIB_PRIVATE->contexts[$contextlevel][$instanceid]);
1906             unset($ACCESSLIB_PRIVATE->contextsbyid[$context->id]);
1907         }
1909         // do not mark dirty contexts if parents unknown
1910         if (!is_null($context->path) and $context->depth > 0) {
1911             mark_context_dirty($context->path);
1912         }
1913     }
1915     return true;
1918 /**
1919  * Precreates all contexts including all parents
1920  *
1921  * @param int $contextlevel empty means all
1922  * @param bool $buildpaths update paths and depths
1923  * @return void
1924  */
1925 function create_contexts($contextlevel = null, $buildpaths = true) {
1926     global $DB;
1928     //make sure system context exists
1929     $syscontext = get_system_context(false);
1931     if (empty($contextlevel) or $contextlevel == CONTEXT_COURSECAT
1932                              or $contextlevel == CONTEXT_COURSE
1933                              or $contextlevel == CONTEXT_MODULE
1934                              or $contextlevel == CONTEXT_BLOCK) {
1935         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1936                 SELECT ".CONTEXT_COURSECAT.", cc.id
1937                   FROM {course}_categories cc
1938                  WHERE NOT EXISTS (SELECT 'x'
1939                                      FROM {context} cx
1940                                     WHERE cc.id = cx.instanceid AND cx.contextlevel=".CONTEXT_COURSECAT.")";
1941         $DB->execute($sql);
1943     }
1945     if (empty($contextlevel) or $contextlevel == CONTEXT_COURSE
1946                              or $contextlevel == CONTEXT_MODULE
1947                              or $contextlevel == CONTEXT_BLOCK) {
1948         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1949                 SELECT ".CONTEXT_COURSE.", c.id
1950                   FROM {course} c
1951                  WHERE NOT EXISTS (SELECT 'x'
1952                                      FROM {context} cx
1953                                     WHERE c.id = cx.instanceid AND cx.contextlevel=".CONTEXT_COURSE.")";
1954         $DB->execute($sql);
1956     }
1958     if (empty($contextlevel) or $contextlevel == CONTEXT_MODULE
1959                              or $contextlevel == CONTEXT_BLOCK) {
1960         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1961                 SELECT ".CONTEXT_MODULE.", cm.id
1962                   FROM {course}_modules cm
1963                  WHERE NOT EXISTS (SELECT 'x'
1964                                      FROM {context} cx
1965                                     WHERE cm.id = cx.instanceid AND cx.contextlevel=".CONTEXT_MODULE.")";
1966         $DB->execute($sql);
1967     }
1969     if (empty($contextlevel) or $contextlevel == CONTEXT_USER
1970                              or $contextlevel == CONTEXT_BLOCK) {
1971         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1972                 SELECT ".CONTEXT_USER.", u.id
1973                   FROM {user} u
1974                  WHERE u.deleted=0
1975                    AND NOT EXISTS (SELECT 'x'
1976                                      FROM {context} cx
1977                                     WHERE u.id = cx.instanceid AND cx.contextlevel=".CONTEXT_USER.")";
1978         $DB->execute($sql);
1980     }
1982     if (empty($contextlevel) or $contextlevel == CONTEXT_BLOCK) {
1983         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1984                 SELECT ".CONTEXT_BLOCK.", bi.id
1985                   FROM {block_instances} bi
1986                  WHERE NOT EXISTS (SELECT 'x'
1987                                      FROM {context} cx
1988                                     WHERE bi.id = cx.instanceid AND cx.contextlevel=".CONTEXT_BLOCK.")";
1989         $DB->execute($sql);
1990     }
1992     if ($buildpaths) {
1993         build_context_path(false);
1994     }
1997 /**
1998  * Remove stale context records
1999  *
2000  * @return bool
2001  */
2002 function cleanup_contexts() {
2003     global $DB;
2005     $sql = "  SELECT c.contextlevel,
2006                      c.instanceid AS instanceid
2007                 FROM {context} c
2008                 LEFT OUTER JOIN {course}_categories t
2009                      ON c.instanceid = t.id
2010                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_COURSECAT."
2011             UNION
2012               SELECT c.contextlevel,
2013                      c.instanceid
2014                 FROM {context} c
2015                 LEFT OUTER JOIN {course} t
2016                      ON c.instanceid = t.id
2017                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_COURSE."
2018             UNION
2019               SELECT c.contextlevel,
2020                      c.instanceid
2021                 FROM {context} c
2022                 LEFT OUTER JOIN {course}_modules t
2023                      ON c.instanceid = t.id
2024                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_MODULE."
2025             UNION
2026               SELECT c.contextlevel,
2027                      c.instanceid
2028                 FROM {context} c
2029                 LEFT OUTER JOIN {user} t
2030                      ON c.instanceid = t.id
2031                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_USER."
2032             UNION
2033               SELECT c.contextlevel,
2034                      c.instanceid
2035                 FROM {context} c
2036                 LEFT OUTER JOIN {block_instances} t
2037                      ON c.instanceid = t.id
2038                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_BLOCK."
2039            ";
2041     // transactions used only for performance reasons here
2042     $transaction = $DB->start_delegated_transaction();
2044     if ($rs = $DB->get_recordset_sql($sql)) {
2045         foreach ($rs as $ctx) {
2046             delete_context($ctx->contextlevel, $ctx->instanceid);
2047         }
2048         $rs->close();
2049     }
2051     $transaction->allow_commit();
2052     return true;
2055 /**
2056  * Preloads all contexts relating to a course: course, modules. Block contexts
2057  * are no longer loaded here. The contexts for all the blocks on the current
2058  * page are now efficiently loaded by {@link block_manager::load_blocks()}.
2059  *
2060  * @param int $courseid Course ID
2061  * @return void
2062  */
2063 function preload_course_contexts($courseid) {
2064     global $DB, $ACCESSLIB_PRIVATE;
2066     // Users can call this multiple times without doing any harm
2067     global $ACCESSLIB_PRIVATE;
2068     if (array_key_exists($courseid, $ACCESSLIB_PRIVATE->preloadedcourses)) {
2069         return;
2070     }
2072     $params = array($courseid, $courseid, $courseid);
2073     $sql = "SELECT x.instanceid, x.id, x.contextlevel, x.path, x.depth
2074               FROM {course_modules} cm
2075               JOIN {context} x ON x.instanceid=cm.id
2076              WHERE cm.course=? AND x.contextlevel=".CONTEXT_MODULE."
2078          UNION ALL
2080             SELECT x.instanceid, x.id, x.contextlevel, x.path, x.depth
2081               FROM {context} x
2082              WHERE x.instanceid=? AND x.contextlevel=".CONTEXT_COURSE."";
2084     $rs = $DB->get_recordset_sql($sql, $params);
2085     foreach($rs as $context) {
2086         cache_context($context);
2087     }
2088     $rs->close();
2089     $ACCESSLIB_PRIVATE->preloadedcourses[$courseid] = true;
2092 /**
2093  * Get the context instance as an object. This function will create the
2094  * context instance if it does not exist yet.
2095  *
2096  * @todo Remove code branch from previous fix MDL-9016 which is no longer needed
2097  *
2098  * @param integer $level The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE.
2099  * @param integer $instance The instance id. For $level = CONTEXT_COURSE, this would be $course->id,
2100  *      for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0
2101  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
2102  *      MUST_EXIST means throw exception if no record or multiple records found
2103  * @return object The context object.
2104  */
2105 function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) {
2106     global $DB, $ACCESSLIB_PRIVATE;
2107     static $allowed_contexts = array(CONTEXT_SYSTEM, CONTEXT_USER, CONTEXT_COURSECAT, CONTEXT_COURSE, CONTEXT_MODULE, CONTEXT_BLOCK);
2109 /// System context has special cache
2110     if ($contextlevel == CONTEXT_SYSTEM) {
2111         return get_system_context();
2112     }
2114 /// check allowed context levels
2115     if (!in_array($contextlevel, $allowed_contexts)) {
2116         // fatal error, code must be fixed - probably typo or switched parameters
2117         print_error('invalidcourselevel');
2118     }
2120     if (!is_array($instance)) {
2121     /// Check the cache
2122         if (isset($ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance])) {  // Already cached
2123             return $ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance];
2124         }
2126     /// Get it from the database, or create it
2127         if (!$context = $DB->get_record('context', array('contextlevel'=>$contextlevel, 'instanceid'=>$instance))) {
2128             $context = create_context($contextlevel, $instance, $strictness);
2129         }
2131     /// Only add to cache if context isn't empty.
2132         if (!empty($context)) {
2133             cache_context($context);
2134         }
2136         return $context;
2137     }
2140 /// ok, somebody wants to load several contexts to save some db queries ;-)
2141     $instances = $instance;
2142     $result = array();
2144     foreach ($instances as $key=>$instance) {
2145     /// Check the cache first
2146         if (isset($ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance])) {  // Already cached
2147             $result[$instance] = $ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance];
2148             unset($instances[$key]);
2149             continue;
2150         }
2151     }
2153     if ($instances) {
2154         list($instanceids, $params) = $DB->get_in_or_equal($instances, SQL_PARAMS_QM);
2155         array_unshift($params, $contextlevel);
2156         $sql = "SELECT instanceid, id, contextlevel, path, depth
2157                   FROM {context}
2158                  WHERE contextlevel=? AND instanceid $instanceids";
2160         if (!$contexts = $DB->get_records_sql($sql, $params)) {
2161             $contexts = array();
2162         }
2164         foreach ($instances as $instance) {
2165             if (isset($contexts[$instance])) {
2166                 $context = $contexts[$instance];
2167             } else {
2168                 $context = create_context($contextlevel, $instance);
2169             }
2171             if (!empty($context)) {
2172                 cache_context($context);
2173             }
2175             $result[$instance] = $context;
2176         }
2177     }
2179     return $result;
2183 /**
2184  * Get a context instance as an object, from a given context id.
2185  *
2186  * @param int $id context id
2187  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
2188  *                        MUST_EXIST means throw exception if no record or multiple records found
2189  * @return stdClass|bool the context object or false if not found.
2190  */
2191 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
2192     global $DB, $ACCESSLIB_PRIVATE;
2194     if ($id == SYSCONTEXTID) {
2195         return get_system_context();
2196     }
2198     if (isset($ACCESSLIB_PRIVATE->contextsbyid[$id])) {  // Already cached
2199         return $ACCESSLIB_PRIVATE->contextsbyid[$id];
2200     }
2202     if ($context = $DB->get_record('context', array('id'=>$id), '*', $strictness)) {
2203         cache_context($context);
2204         return $context;
2205     }
2207     return false;
2211 /**
2212  * Get the local override (if any) for a given capability in a role in a context
2213  *
2214  * @param int $roleid
2215  * @param int $contextid
2216  * @param string $capability
2217  */
2218 function get_local_override($roleid, $contextid, $capability) {
2219     global $DB;
2220     return $DB->get_record('role_capabilities', array('roleid'=>$roleid, 'capability'=>$capability, 'contextid'=>$contextid));
2223 /**
2224  * Returns context instance plus related course and cm instances
2225  * @param int $contextid
2226  * @return array of ($context, $course, $cm)
2227  */
2228 function get_context_info_array($contextid) {
2229     global $DB;
2231     $context = get_context_instance_by_id($contextid, MUST_EXIST);
2232     $course  = null;
2233     $cm      = null;
2235     if ($context->contextlevel == CONTEXT_COURSE) {
2236         $course = $DB->get_record('course', array('id'=>$context->instanceid), '*', MUST_EXIST);
2238     } else if ($context->contextlevel == CONTEXT_MODULE) {
2239         $cm = get_coursemodule_from_id('', $context->instanceid, 0, false, MUST_EXIST);
2240         $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
2242     } else if ($context->contextlevel == CONTEXT_BLOCK) {
2243         $parentcontexts = get_parent_contexts($context, false);
2244         $parent = reset($parentcontexts);
2245         $parent = get_context_instance_by_id($parent);
2247         if ($parent->contextlevel == CONTEXT_COURSE) {
2248             $course = $DB->get_record('course', array('id'=>$parent->instanceid), '*', MUST_EXIST);
2249         } else if ($parent->contextlevel == CONTEXT_MODULE) {
2250             $cm = get_coursemodule_from_id('', $parent->instanceid, 0, false, MUST_EXIST);
2251             $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
2252         }
2253     }
2255     return array($context, $course, $cm);
2258 /**
2259  * Returns current course id or null if outside of course based on context parameter.
2260  * @param object $context
2261  * @return int|bool related course id or false
2262  */
2263 function get_courseid_from_context($context) {
2264     if ($context->contextlevel == CONTEXT_COURSE) {
2265         return $context->instanceid;
2266     }
2268     if ($context->contextlevel < CONTEXT_COURSE) {
2269         return false;
2270     }
2272     if ($context->contextlevel == CONTEXT_MODULE) {
2273         $parentcontexts = get_parent_contexts($context, false);
2274         $parent = reset($parentcontexts);
2275         $parent = get_context_instance_by_id($parent);
2276         return $parent->instanceid;
2277     }
2279     if ($context->contextlevel == CONTEXT_BLOCK) {
2280         $parentcontexts = get_parent_contexts($context, false);
2281         $parent = reset($parentcontexts);
2282         return get_courseid_from_context($parent);
2283     }
2285     return false;
2289 //////////////////////////////////////
2290 //    DB TABLE RELATED FUNCTIONS    //
2291 //////////////////////////////////////
2293 /**
2294  * function that creates a role
2295  *
2296  * @param string $name role name
2297  * @param string $shortname role short name
2298  * @param string $description role description
2299  * @param string $archetype
2300  * @return int id or dml_exception
2301  */
2302 function create_role($name, $shortname, $description, $archetype = '') {
2303     global $DB;
2305     if (strpos($archetype, 'moodle/legacy:') !== false) {
2306         throw new coding_exception('Use new role archetype parameter in create_role() instead of old legacy capabilities.');
2307     }
2309     // verify role archetype actually exists
2310     $archetypes = get_role_archetypes();
2311     if (empty($archetypes[$archetype])) {
2312         $archetype = '';
2313     }
2315     // Get the system context.
2316     $context = get_context_instance(CONTEXT_SYSTEM);
2318     // Insert the role record.
2319     $role = new stdClass();
2320     $role->name        = $name;
2321     $role->shortname   = $shortname;
2322     $role->description = $description;
2323     $role->archetype   = $archetype;
2325     //find free sortorder number
2326     $role->sortorder = $DB->get_field('role', 'MAX(sortorder) + 1', array());
2327     if (empty($role->sortorder)) {
2328         $role->sortorder = 1;
2329     }
2330     $id = $DB->insert_record('role', $role);
2332     return $id;
2335 /**
2336  * Function that deletes a role and cleanups up after it
2337  *
2338  * @param int $roleid id of role to delete
2339  * @return bool always true
2340  */
2341 function delete_role($roleid) {
2342     global $CFG, $DB;
2344     // first unssign all users
2345     role_unassign_all(array('roleid'=>$roleid));
2347     // cleanup all references to this role, ignore errors
2348     $DB->delete_records('role_capabilities',   array('roleid'=>$roleid));
2349     $DB->delete_records('role_allow_assign',   array('roleid'=>$roleid));
2350     $DB->delete_records('role_allow_assign',   array('allowassign'=>$roleid));
2351     $DB->delete_records('role_allow_override', array('roleid'=>$roleid));
2352     $DB->delete_records('role_allow_override', array('allowoverride'=>$roleid));
2353     $DB->delete_records('role_names',          array('roleid'=>$roleid));
2354     $DB->delete_records('role_context_levels', array('roleid'=>$roleid));
2356     // finally delete the role itself
2357     // get this before the name is gone for logging
2358     $rolename = $DB->get_field('role', 'name', array('id'=>$roleid));
2360     $DB->delete_records('role', array('id'=>$roleid));
2362     add_to_log(SITEID, 'role', 'delete', 'admin/roles/action=delete&roleid='.$roleid, $rolename, '');
2364     return true;
2367 /**
2368  * Function to write context specific overrides, or default capabilities.
2369  *
2370  * @param string $capability string name
2371  * @param int $permission CAP_ constants
2372  * @param int $roleid role id
2373  * @param int $contextid context id
2374  * @param bool $overwrite
2375  * @return bool always true or exception
2376  */
2377 function assign_capability($capability, $permission, $roleid, $contextid, $overwrite = false) {
2378     global $USER, $DB;
2380     if (empty($permission) || $permission == CAP_INHERIT) { // if permission is not set
2381         unassign_capability($capability, $roleid, $contextid);
2382         return true;
2383     }
2385     $existing = $DB->get_record('role_capabilities', array('contextid'=>$contextid, 'roleid'=>$roleid, 'capability'=>$capability));
2387     if ($existing and !$overwrite) {   // We want to keep whatever is there already
2388         return true;
2389     }
2391     $cap = new stdClass();
2392     $cap->contextid    = $contextid;
2393     $cap->roleid       = $roleid;
2394     $cap->capability   = $capability;
2395     $cap->permission   = $permission;
2396     $cap->timemodified = time();
2397     $cap->modifierid   = empty($USER->id) ? 0 : $USER->id;
2399     if ($existing) {
2400         $cap->id = $existing->id;
2401         $DB->update_record('role_capabilities', $cap);
2402     } else {
2403         $c = $DB->get_record('context', array('id'=>$contextid));
2404         $DB->insert_record('role_capabilities', $cap);
2405     }
2406     return true;
2409 /**
2410  * Unassign a capability from a role.
2411  *
2412  * @param string $capability the name of the capability
2413  * @param int $roleid the role id
2414  * @param int $contextid null means all contexts
2415  * @return boolean success or failure
2416  */
2417 function unassign_capability($capability, $roleid, $contextid = null) {
2418     global $DB;
2420     if (!empty($contextid)) {
2421         // delete from context rel, if this is the last override in this context
2422         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid, 'contextid'=>$contextid));
2423     } else {
2424         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid));
2425     }
2426     return true;
2430 /**
2431  * Get the roles that have a given capability assigned to it
2432  *
2433  * This function does not resolve the actual permission of the capability.
2434  * It just checks for permissions and overrides.
2435  * Use get_roles_with_cap_in_context() if resolution is required.
2436  *
2437  * @param string $capability - capability name (string)
2438  * @param string $permission - optional, the permission defined for this capability
2439  *                      either CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT. Defaults to null which means any.
2440  * @param stdClass $context, null means any
2441  * @return array of role objects
2442  */
2443 function get_roles_with_capability($capability, $permission = null, $context = null) {
2444     global $DB;
2446     if ($context) {
2447         $contexts = get_parent_contexts($context, true);
2448         list($insql, $params) = $DB->get_in_or_equal($contexts, SQL_PARAMS_NAMED, 'ctx000');
2449         $contextsql = "AND rc.contextid $insql";
2450     } else {
2451         $params = array();
2452         $contextsql = '';
2453     }
2455     if ($permission) {
2456         $permissionsql = " AND rc.permission = :permission";
2457         $params['permission'] = $permission;
2458     } else {
2459         $permissionsql = '';
2460     }
2462     $sql = "SELECT r.*
2463               FROM {role} r
2464              WHERE r.id IN (SELECT rc.roleid
2465                               FROM {role_capabilities} rc
2466                              WHERE rc.capability = :capname
2467                                    $contextsql
2468                                    $permissionsql)";
2469     $params['capname'] = $capability;
2472     return $DB->get_records_sql($sql, $params);
2476 /**
2477  * This function makes a role-assignment (a role for a user in a particular context)
2478  *
2479  * @param int $roleid the role of the id
2480  * @param int $userid userid
2481  * @param int $contextid id of the context
2482  * @param string $component example 'enrol_ldap', defaults to '' which means manual assignment,
2483  * @prama int $itemid id of enrolment/auth plugin
2484  * @param string $timemodified defaults to current time
2485  * @return int new/existing id of the assignment
2486  */
2487 function role_assign($roleid, $userid, $contextid, $component = '', $itemid = 0, $timemodified = '') {
2488     global $USER, $CFG, $DB;
2490     // first of all detect if somebody is using old style parameters
2491     if ($contextid === 0 or is_numeric($component)) {
2492         throw new coding_exception('Invalid call to role_assign(), code needs to be updated to use new order of parameters');
2493     }
2495     // now validate all parameters
2496     if (empty($roleid)) {
2497         throw new coding_exception('Invalid call to role_assign(), roleid can not be empty');
2498     }
2500     if (empty($userid)) {
2501         throw new coding_exception('Invalid call to role_assign(), userid can not be empty');
2502     }
2504     if ($itemid) {
2505         if (strpos($component, '_') === false) {
2506             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as"enrol_" when itemid specified', 'component:'.$component);
2507         }
2508     } else {
2509         $itemid = 0;
2510         if ($component !== '' and strpos($component, '_') === false) {
2511             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
2512         }
2513     }
2515     if (!$DB->record_exists('user', array('id'=>$userid, 'deleted'=>0))) {
2516         throw new coding_exception('User ID does not exist or is deleted!', 'userid:'.$userid);
2517         return false;
2518     }
2520     $context = get_context_instance_by_id($contextid, MUST_EXIST);
2522     if (!$timemodified) {
2523         $timemodified = time();
2524     }
2526 /// Check for existing entry
2527     $ras = $DB->get_records('role_assignments', array('roleid'=>$roleid, 'contextid'=>$context->id, 'userid'=>$userid, 'component'=>$component, 'itemid'=>$itemid), 'id');
2529     if ($ras) {
2530         // role already assigned - this should not happen
2531         if (count($ras) > 1) {
2532             //very weird - remove all duplicates!
2533             $ra = array_shift($ras);
2534             foreach ($ras as $r) {
2535                 $DB->delete_records('role_assignments', array('id'=>$r->id));
2536             }
2537         } else {
2538             $ra = reset($ras);
2539         }
2541         // actually there is no need to update, reset anything or trigger any event, so just return
2542         return $ra->id;
2543     }
2545     // Create a new entry
2546     $ra = new stdClass();
2547     $ra->roleid       = $roleid;
2548     $ra->contextid    = $context->id;
2549     $ra->userid       = $userid;
2550     $ra->component    = $component;
2551     $ra->itemid       = $itemid;
2552     $ra->timemodified = $timemodified;
2553     $ra->modifierid   = empty($USER->id) ? 0 : $USER->id;
2555     $ra->id = $DB->insert_record('role_assignments', $ra);
2557     // mark context as dirty - again expensive, but needed
2558     mark_context_dirty($context->path);
2560     if (!empty($USER->id) && $USER->id == $userid) {
2561         // If the user is the current user, then do full reload of capabilities too.
2562         load_all_capabilities();
2563     }
2565     events_trigger('role_assigned', $ra);
2567     return $ra->id;
2570 /**
2571  * Removes one role assignment
2572  *
2573  * @param int $roleid
2574  * @param int  $userid
2575  * @param int  $contextid
2576  * @param string $component
2577  * @param int  $itemid
2578  * @return void
2579  */
2580 function role_unassign($roleid, $userid, $contextid, $component = '', $itemid = 0) {
2581     global $USER, $CFG, $DB;
2583     // first make sure the params make sense
2584     if ($roleid == 0 or $userid == 0 or $contextid == 0) {
2585         throw new coding_exception('Invalid call to role_unassign(), please use role_unassign_all() when removing multiple role assignments');
2586     }
2588     if ($itemid) {
2589         if (strpos($component, '_') === false) {
2590             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as "enrol_" when itemid specified', 'component:'.$component);
2591         }
2592     } else {
2593         $itemid = 0;
2594         if ($component !== '' and strpos($component, '_') === false) {
2595             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
2596         }
2597     }
2599     role_unassign_all(array('roleid'=>$roleid, 'userid'=>$userid, 'contextid'=>$contextid, 'component'=>$component, 'itemid'=>$itemid), false, false);
2602 /**
2603  * Removes multiple role assignments, parameters may contain:
2604  *   'roleid', 'userid', 'contextid', 'component', 'enrolid'.
2605  *
2606  * @param array $params role assignment parameters
2607  * @param bool $subcontexts unassign in subcontexts too
2608  * @param bool $includmanual include manual role assignments too
2609  * @return void
2610  */
2611 function role_unassign_all(array $params, $subcontexts = false, $includemanual = false) {
2612     global $USER, $CFG, $DB;
2614     if (!$params) {
2615         throw new coding_exception('Missing parameters in role_unsassign_all() call');
2616     }
2618     $allowed = array('roleid', 'userid', 'contextid', 'component', 'itemid');
2619     foreach ($params as $key=>$value) {
2620         if (!in_array($key, $allowed)) {
2621             throw new coding_exception('Unknown role_unsassign_all() parameter key', 'key:'.$key);
2622         }
2623     }
2625     if (isset($params['component']) and $params['component'] !== '' and strpos($params['component'], '_') === false) {
2626         throw new coding_exception('Invalid component paramter in role_unsassign_all() call', 'component:'.$params['component']);
2627     }
2629     if ($includemanual) {
2630         if (!isset($params['component']) or $params['component'] === '') {
2631             throw new coding_exception('include manual parameter requires component parameter in role_unsassign_all() call');
2632         }
2633     }
2635     if ($subcontexts) {
2636         if (empty($params['contextid'])) {
2637             throw new coding_exception('subcontexts paramtere requires component parameter in role_unsassign_all() call');
2638         }
2639     }
2641     $ras = $DB->get_records('role_assignments', $params);
2642     foreach($ras as $ra) {
2643         $DB->delete_records('role_assignments', array('id'=>$ra->id));
2644         if ($context = get_context_instance_by_id($ra->contextid)) {
2645             // this is a bit expensive but necessary
2646             mark_context_dirty($context->path);
2647             /// If the user is the current user, then do full reload of capabilities too.
2648             if (!empty($USER->id) && $USER->id == $ra->userid) {
2649                 load_all_capabilities();
2650             }
2651         }
2652         events_trigger('role_unassigned', $ra);
2653     }
2654     unset($ras);
2656     // process subcontexts
2657     if ($subcontexts and $context = get_context_instance_by_id($params['contextid'])) {
2658         $contexts = get_child_contexts($context);
2659         $mparams = $params;
2660         foreach($contexts as $context) {
2661             $mparams['contextid'] = $context->id;
2662             $ras = $DB->get_records('role_assignments', $mparams);
2663             foreach($ras as $ra) {
2664                 $DB->delete_records('role_assignments', array('id'=>$ra->id));
2665                 // this is a bit expensive but necessary
2666                 mark_context_dirty($context->path);
2667                 /// If the user is the current user, then do full reload of capabilities too.
2668                 if (!empty($USER->id) && $USER->id == $ra->userid) {
2669                     load_all_capabilities();
2670                 }
2671                 events_trigger('role_unassigned', $ra);
2672             }
2673         }
2674     }
2676     // do this once more for all manual role assignments
2677     if ($includemanual) {
2678         $params['component'] = '';
2679         role_unassign_all($params, $subcontexts, false);
2680     }
2684 /**
2685  * Determines if a user is currently logged in
2686  *
2687  * @return bool
2688  */
2689 function isloggedin() {
2690     global $USER;
2692     return (!empty($USER->id));
2695 /**
2696  * Determines if a user is logged in as real guest user with username 'guest'.
2697  *
2698  * @param int|object $user mixed user object or id, $USER if not specified
2699  * @return bool true if user is the real guest user, false if not logged in or other user
2700  */
2701 function isguestuser($user = null) {
2702     global $USER, $DB, $CFG;
2704     // make sure we have the user id cached in config table, because we are going to use it a lot
2705     if (empty($CFG->siteguest)) {
2706         if (!$guestid = $DB->get_field('user', 'id', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
2707             // guest does not exist yet, weird
2708             return false;
2709         }
2710         set_config('siteguest', $guestid);
2711     }
2712     if ($user === null) {
2713         $user = $USER;
2714     }
2716     if ($user === null) {
2717         // happens when setting the $USER
2718         return false;
2720     } else if (is_numeric($user)) {
2721         return ($CFG->siteguest == $user);
2723     } else if (is_object($user)) {
2724         if (empty($user->id)) {
2725             return false; // not logged in means is not be guest
2726         } else {
2727             return ($CFG->siteguest == $user->id);
2728         }
2730     } else {
2731         throw new coding_exception('Invalid user parameter supplied for isguestuser() function!');
2732     }
2735 /**
2736  * Does user have a (temporary or real) guest access to course?
2737  *
2738  * @param stdClass $context
2739  * @param stdClass|int $user
2740  * @return bool
2741  */
2742 function is_guest($context, $user = null) {
2743     global $USER;
2745     // first find the course context
2746     $coursecontext = get_course_context($context);
2748     // make sure there is a real user specified
2749     if ($user === null) {
2750         $userid = !empty($USER->id) ? $USER->id : 0;
2751     } else {
2752         $userid = !empty($user->id) ? $user->id : $user;
2753     }
2755     if (isguestuser($userid)) {
2756         // can not inspect or be enrolled
2757         return true;
2758     }
2760     if (has_capability('moodle/course:view', $coursecontext, $user)) {
2761         // viewing users appear out of nowhere, they are neither guests nor participants
2762         return false;
2763     }
2765     // consider only real active enrolments here
2766     if (is_enrolled($coursecontext, $user, '', true)) {
2767         return false;
2768     }
2770     return true;
2774 /**
2775  * Returns true if the user has moodle/course:view capability in the course,
2776  * this is intended for admins, managers (aka small admins), inspectors, etc.
2777  *
2778  * @param stdClass $context
2779  * @param int|object $user, if null $USER is used
2780  * @param string $withcapability extra capability name
2781  * @return bool
2782  */
2783 function is_viewing($context, $user = null, $withcapability = '') {
2784     // first find the course context
2785     $coursecontext = get_course_context($context);
2787     if (isguestuser($user)) {
2788         // can not inspect
2789         return false;
2790     }
2792     if (!has_capability('moodle/course:view', $coursecontext, $user)) {
2793         // admins are allowed to inspect courses
2794         return false;
2795     }
2797     if ($withcapability and !has_capability($withcapability, $context, $user)) {
2798         // site admins always have the capability, but the enrolment above blocks
2799         return false;
2800     }
2802     return true;
2805 /**
2806  * Returns true if user is enrolled (is participating) in course
2807  * this is intended for students and teachers.
2808  *
2809  * @param object $context
2810  * @param int|object $user, if null $USER is used, otherwise user object or id expected
2811  * @param string $withcapability extra capability name
2812  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2813  * @return bool
2814  */
2815 function is_enrolled($context, $user = null, $withcapability = '', $onlyactive = false) {
2816     global $USER, $DB;
2818     // first find the course context
2819     $coursecontext = get_course_context($context);
2821     // make sure there is a real user specified
2822     if ($user === null) {
2823         $userid = !empty($USER->id) ? $USER->id : 0;
2824     } else {
2825         $userid = !empty($user->id) ? $user->id : $user;
2826     }
2828     if (empty($userid)) {
2829         // not-logged-in!
2830         return false;
2831     } else if (isguestuser($userid)) {
2832         // guest account can not be enrolled anywhere
2833         return false;
2834     }
2836     if ($coursecontext->instanceid == SITEID) {
2837         // everybody participates on frontpage
2838     } else {
2839         if ($onlyactive) {
2840             $sql = "SELECT ue.*
2841                       FROM {user_enrolments} ue
2842                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2843                       JOIN {user} u ON u.id = ue.userid
2844                      WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0";
2845             $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE, 'userid'=>$userid, 'courseid'=>$coursecontext->instanceid);
2846             // this result should be very small, better not do the complex time checks in sql for now ;-)
2847             $enrolments = $DB->get_records_sql($sql, $params);
2848             $now = time();
2849             // make sure the enrol period is ok
2850             $result = false;
2851             foreach ($enrolments as $e) {
2852                 if ($e->timestart > $now) {
2853                     continue;
2854                 }
2855                 if ($e->timeend and $e->timeend < $now) {
2856                     continue;
2857                 }
2858                 $result = true;
2859                 break;
2860             }
2861             if (!$result) {
2862                 return false;
2863             }
2865         } else {
2866             // any enrolment is good for us here, even outdated, disabled or inactive
2867             $sql = "SELECT 'x'
2868                       FROM {user_enrolments} ue
2869                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2870                       JOIN {user} u ON u.id = ue.userid
2871                      WHERE ue.userid = :userid AND u.deleted = 0";
2872             $params = array('userid'=>$userid, 'courseid'=>$coursecontext->instanceid);
2873             if (!$DB->record_exists_sql($sql, $params)) {
2874                 return false;
2875             }
2876         }
2877     }
2879     if ($withcapability and !has_capability($withcapability, $context, $userid)) {
2880         return false;
2881     }
2883     return true;
2886 /**
2887  * Returns array with sql code and parameters returning all ids
2888  * of users enrolled into course.
2889  *
2890  * This function is using 'eu[0-9]+_' prefix for table names and parameters.
2891  *
2892  * @param object $context
2893  * @param string $withcapability
2894  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2895  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2896  * @return array list($sql, $params)
2897  */
2898 function get_enrolled_sql($context, $withcapability = '', $groupid = 0, $onlyactive = false) {
2899     global $DB, $CFG;
2901     // use unique prefix just in case somebody makes some SQL magic with the result
2902     static $i = 0;
2903     $i++;
2904     $prefix = 'eu'.$i.'_';
2906     // first find the course context
2907     $coursecontext = get_course_context($context);
2909     $isfrontpage = ($coursecontext->instanceid == SITEID);
2911     $joins  = array();
2912     $wheres = array();
2913     $params = array();
2915     list($contextids, $contextpaths) = get_context_info_list($context);
2917     // get all relevant capability info for all roles
2918     if ($withcapability) {
2919         list($incontexts, $cparams) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED, 'ctx00');
2920         $cparams['cap'] = $withcapability;
2922         $defs = array();
2923         $sql = "SELECT rc.id, rc.roleid, rc.permission, ctx.path
2924                   FROM {role_capabilities} rc
2925                   JOIN {context} ctx on rc.contextid = ctx.id
2926                  WHERE rc.contextid $incontexts AND rc.capability = :cap";
2927         $rcs = $DB->get_records_sql($sql, $cparams);
2928         foreach ($rcs as $rc) {
2929             $defs[$rc->path][$rc->roleid] = $rc->permission;
2930         }
2932         $access = array();
2933         if (!empty($defs)) {
2934             foreach ($contextpaths as $path) {
2935                 if (empty($defs[$path])) {
2936                     continue;
2937                 }
2938                 foreach($defs[$path] as $roleid => $perm) {
2939                     if ($perm == CAP_PROHIBIT) {
2940                         $access[$roleid] = CAP_PROHIBIT;
2941                         continue;
2942                     }
2943                     if (!isset($access[$roleid])) {
2944                         $access[$roleid] = (int)$perm;
2945                     }
2946                 }
2947             }
2948         }
2950         unset($defs);
2952         // make lists of roles that are needed and prohibited
2953         $needed     = array(); // one of these is enough
2954         $prohibited = array(); // must not have any of these
2955         foreach ($access as $roleid => $perm) {
2956             if ($perm == CAP_PROHIBIT) {
2957                 unset($needed[$roleid]);
2958                 $prohibited[$roleid] = true;
2959             } else if ($perm == CAP_ALLOW and empty($prohibited[$roleid])) {
2960                 $needed[$roleid] = true;
2961             }
2962         }
2964         $defaultuserroleid      = isset($CFG->defaultuserroleid) ? $CFG->defaultuserroleid : null;
2965         $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid) ? $CFG->defaultfrontpageroleid : null;
2967         $nobody = false;
2969         if ($isfrontpage) {
2970             if (!empty($prohibited[$defaultuserroleid]) or !empty($prohibited[$defaultfrontpageroleid])) {
2971                 $nobody = true;
2972             } else if (!empty($needed[$defaultuserroleid]) or !empty($needed[$defaultfrontpageroleid])) {
2973                 // everybody not having prohibit has the capability
2974                 $needed = array();
2975             } else if (empty($needed)) {
2976                 $nobody = true;
2977             }
2978         } else {
2979             if (!empty($prohibited[$defaultuserroleid])) {
2980                 $nobody = true;
2981             } else if (!empty($needed[$defaultuserroleid])) {
2982                 // everybody not having prohibit has the capability
2983                 $needed = array();
2984             } else if (empty($needed)) {
2985                 $nobody = true;
2986             }
2987         }
2989         if ($nobody) {
2990             // nobody can match so return some SQL that does not return any results
2991             $wheres[] = "1 = 2";
2993         } else {
2995             if ($needed) {
2996                 $ctxids = implode(',', $contextids);
2997                 $roleids = implode(',', array_keys($needed));
2998                 $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))";
2999             }
3001             if ($prohibited) {
3002                 $ctxids = implode(',', $contextids);
3003                 $roleids = implode(',', array_keys($prohibited));
3004                 $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))";
3005                 $wheres[] = "{$prefix}ra4.id IS NULL";
3006             }
3008             if ($groupid) {
3009                 $joins[] = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = {$prefix}u.id AND {$prefix}gm.groupid = :{$prefix}gmid)";
3010                 $params["{$prefix}gmid"] = $groupid;
3011             }
3012         }
3014     } else {
3015         if ($groupid) {
3016             $joins[] = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = {$prefix}u.id AND {$prefix}gm.groupid = :{$prefix}gmid)";
3017             $params["{$prefix}gmid"] = $groupid;
3018         }
3019     }
3021     $wheres[] = "{$prefix}u.deleted = 0 AND {$prefix}u.id <> :{$prefix}guestid";
3022     $params["{$prefix}guestid"] = $CFG->siteguest;
3024     if ($isfrontpage) {
3025         // all users are "enrolled" on the frontpage
3026     } else {
3027         $joins[] = "JOIN {user_enrolments} {$prefix}ue ON {$prefix}ue.userid = {$prefix}u.id";
3028         $joins[] = "JOIN {enrol} {$prefix}e ON ({$prefix}e.id = {$prefix}ue.enrolid AND {$prefix}e.courseid = :{$prefix}courseid)";
3029         $params[$prefix.'courseid'] = $coursecontext->instanceid;
3031         if ($onlyactive) {
3032             $wheres[] = "{$prefix}ue.status = :{$prefix}active AND {$prefix}e.status = :{$prefix}enabled";
3033             $wheres[] = "{$prefix}ue.timestart < :{$prefix}now1 AND ({$prefix}ue.timeend = 0 OR {$prefix}ue.timeend > :{$prefix}now2)";
3034             $now = round(time(), -2); // rounding helps caching in DB
3035             $params = array_merge($params, array($prefix.'enabled'=>ENROL_INSTANCE_ENABLED,
3036                                                  $prefix.'active'=>ENROL_USER_ACTIVE,
3037                                                  $prefix.'now1'=>$now, $prefix.'now2'=>$now));
3038         }
3039     }
3041     $joins = implode("\n", $joins);
3042     $wheres = "WHERE ".implode(" AND ", $wheres);
3044     $sql = "SELECT DISTINCT {$prefix}u.id
3045                FROM {user} {$prefix}u
3046              $joins
3047             $wheres";
3049     return array($sql, $params);
3052 /**
3053  * Returns list of users enrolled into course.
3054  * @param object $context
3055  * @param string $withcapability
3056  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
3057  * @param string $userfields requested user record fields
3058  * @param string $orderby
3059  * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
3060  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
3061  * @return array of user records
3062  */
3063 function get_enrolled_users($context, $withcapability = '', $groupid = 0, $userfields = 'u.*', $orderby = '', $limitfrom = 0, $limitnum = 0) {
3064     global $DB;
3066     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid);
3067     $sql = "SELECT $userfields
3068               FROM {user} u
3069               JOIN ($esql) je ON je.id = u.id
3070              WHERE u.deleted = 0";
3072     if ($orderby) {
3073         $sql = "$sql ORDER BY $orderby";
3074     } else {
3075         $sql = "$sql ORDER BY u.lastname ASC, u.firstname ASC";
3076     }
3078     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
3081 /**
3082  * Counts list of users enrolled into course (as per above function)
3083  * @param object $context
3084  * @param string $withcapability
3085  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
3086  * @return array of user records
3087  */
3088 function count_enrolled_users($context, $withcapability = '', $groupid = 0) {
3089     global $DB;
3091     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid);
3092     $sql = "SELECT count(u.id)
3093               FROM {user} u
3094               JOIN ($esql) je ON je.id = u.id
3095              WHERE u.deleted = 0";
3097     return $DB->count_records_sql($sql, $params);
3101 /**
3102  * Loads the capability definitions for the component (from file).
3103  *
3104  * Loads the capability definitions for the component (from file). If no
3105  * capabilities are defined for the component, we simply return an empty array.
3106  *
3107  * @param string $component full plugin name, examples: 'moodle', 'mod_forum'
3108  * @return array array of capabilities
3109  */
3110 function load_capability_def($component) {
3111     $defpath = get_component_directory($component).'/db/access.php';
3113     $capabilities = array();
3114     if (file_exists($defpath)) {
3115         require($defpath);
3116         if (!empty(${$component.'_capabilities'})) {
3117             // BC capability array name
3118             // since 2.0 we prefer $capabilities instead - it is easier to use and matches db/* files
3119             debugging('componentname_capabilities array is deprecated, please use capabilities array only in access.php files');
3120             $capabilities = ${$component.'_capabilities'};
3121         }
3122     }
3124     return $capabilities;
3128 /**
3129  * Gets the capabilities that have been cached in the database for this component.
3130  * @param string $component - examples: 'moodle', 'mod_forum'
3131  * @return array array of capabilities
3132  */
3133 function get_cached_capabilities($component = 'moodle') {
3134     global $DB;
3135     return $DB->get_records('capabilities', array('component'=>$component));
3138 /**
3139  * Returns default capabilities for given role archetype.
3140  * @param string $archetype role archetype
3141  * @return array
3142  */
3143 function get_default_capabilities($archetype) {
3144     global $DB;
3146     if (!$archetype) {
3147         return array();
3148     }
3150     $alldefs = array();
3151     $defaults = array();
3152     $components = array();
3153     $allcaps = $DB->get_records('capabilities');
3155     foreach ($allcaps as $cap) {
3156         if (!in_array($cap->component, $components)) {
3157             $components[] = $cap->component;
3158             $alldefs = array_merge($alldefs, load_capability_def($cap->component));
3159         }
3160     }
3161     foreach($alldefs as $name=>$def) {
3162         // Use array 'archetypes if available. Only if not specified, use 'legacy'.
3163         if (isset($def['archetypes'])) {
3164             if (isset($def['archetypes'][$archetype])) {
3165                 $defaults[$name] = $def['archetypes'][$archetype];
3166             }
3167         // 'legacy' is for backward compatibility with 1.9 access.php
3168         } else {
3169             if (isset($def['legacy'][$archetype])) {
3170                 $defaults[$name] = $def['legacy'][$archetype];
3171             }
3172         }
3173     }
3175     return $defaults;
3178 /**
3179  * Reset role capabilities to default according to selected role archetype.
3180  * If no archetype selected, removes all capabilities.
3181  * @param int $roleid
3182  * @return void
3183  */
3184 function reset_role_capabilities($roleid) {
3185     global $DB;
3187     $role = $DB->get_record('role', array('id'=>$roleid), '*', MUST_EXIST);
3188     $defaultcaps = get_default_capabilities($role->archetype);
3190     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
3192     $DB->delete_records('role_capabilities', array('roleid'=>$roleid));
3194     foreach($defaultcaps as $cap=>$permission) {
3195         assign_capability($cap, $permission, $roleid, $sitecontext->id);
3196     }
3199 /**
3200  * Updates the capabilities table with the component capability definitions.
3201  * If no parameters are given, the function updates the core moodle
3202  * capabilities.
3203  *
3204  * Note that the absence of the db/access.php capabilities definition file
3205  * will cause any stored capabilities for the component to be removed from
3206  * the database.
3207  *
3208  * @param string $component examples: 'moodle', 'mod/forum', 'block/quiz_results'
3209  * @return boolean true if success, exception in case of any problems
3210  */
3211 function update_capabilities($component = 'moodle') {
3212     global $DB, $OUTPUT, $ACCESSLIB_PRIVATE;
3214     $storedcaps = array();
3216     $filecaps = load_capability_def($component);
3217     $cachedcaps = get_cached_capabilities($component);
3218     if ($cachedcaps) {
3219         foreach ($cachedcaps as $cachedcap) {
3220             array_push($storedcaps, $cachedcap->name);
3221             // update risk bitmasks and context levels in existing capabilities if needed
3222             if (array_key_exists($cachedcap->name, $filecaps)) {
3223                 if (!array_key_exists('riskbitmask', $filecaps[$cachedcap->name])) {
3224                     $filecaps[$cachedcap->name]['riskbitmask'] = 0; // no risk if not specified
3225                 }
3226                 if ($cachedcap->captype != $filecaps[$cachedcap->name]['captype']) {
3227                     $updatecap = new stdClass();
3228                     $updatecap->id = $cachedcap->id;
3229                     $updatecap->captype = $filecaps[$cachedcap->name]['captype'];
3230                     $DB->update_record('capabilities', $updatecap);
3231                 }
3232                 if ($cachedcap->riskbitmask != $filecaps[$cachedcap->name]['riskbitmask']) {
3233                     $updatecap = new stdClass();
3234                     $updatecap->id = $cachedcap->id;
3235                     $updatecap->riskbitmask = $filecaps[$cachedcap->name]['riskbitmask'];
3236                     $DB->update_record('capabilities', $updatecap);
3237                 }
3239                 if (!array_key_exists('contextlevel', $filecaps[$cachedcap->name])) {
3240                     $filecaps[$cachedcap->name]['contextlevel'] = 0; // no context level defined
3241                 }
3242                 if ($cachedcap->contextlevel != $filecaps[$cachedcap->name]['contextlevel']) {
3243                     $updatecap = new stdClass();
3244                     $updatecap->id = $cachedcap->id;
3245                     $updatecap->contextlevel = $filecaps[$cachedcap->name]['contextlevel'];
3246                     $DB->update_record('capabilities', $updatecap);
3247                 }
3248             }
3249         }
3250     }
3252     // Are there new capabilities in the file definition?
3253     $newcaps = array();
3255     foreach ($filecaps as $filecap => $def) {
3256         if (!$storedcaps ||
3257                 ($storedcaps && in_array($filecap, $storedcaps) === false)) {
3258             if (!array_key_exists('riskbitmask', $def)) {
3259                 $def['riskbitmask'] = 0; // no risk if not specified
3260             }
3261             $newcaps[$filecap] = $def;
3262         }
3263     }
3264     // Add new capabilities to the stored definition.
3265     foreach ($newcaps as $capname => $capdef) {
3266         $capability = new stdClass();
3267         $capability->name         = $capname;
3268         $capability->captype      = $capdef['captype'];
3269         $capability->contextlevel = $capdef['contextlevel'];
3270         $capability->component    = $component;
3271         $capability->riskbitmask  = $capdef['riskbitmask'];
3273         $DB->insert_record('capabilities', $capability, false);
3275         if (isset($capdef['clonepermissionsfrom']) && in_array($capdef['clonepermissionsfrom'], $storedcaps)){
3276             if ($rolecapabilities = $DB->get_records('role_capabilities', array('capability'=>$capdef['clonepermissionsfrom']))){
3277                 foreach ($rolecapabilities as $rolecapability){
3278                     //assign_capability will update rather than insert if capability exists
3279                     if (!assign_capability($capname, $rolecapability->permission,
3280                                             $rolecapability->roleid, $rolecapability->contextid, true)){
3281                          echo $OUTPUT->notification('Could not clone capabilities for '.$capname);
3282                     }
3283                 }
3284             }
3285         // we ignore archetype key if we have cloned permissions
3286         } else if (isset($capdef['archetypes']) && is_array($capdef['archetypes'])) {
3287             assign_legacy_capabilities($capname, $capdef['archetypes']);
3288         // 'legacy' is for backward compatibility with 1.9 access.php
3289         } else if (isset($capdef['legacy']) && is_array($capdef['legacy'])) {
3290             assign_legacy_capabilities($capname, $capdef['legacy']);
3291         }
3292     }
3293     // Are there any capabilities that have been removed from the file
3294     // definition that we need to delete from the stored capabilities and
3295     // role assignments?
3296     capabilities_cleanup($component, $filecaps);
3298     // reset static caches
3299     $ACCESSLIB_PRIVATE->capabilities = null;
3301     return true;
3305 /**
3306  * Deletes cached capabilities that are no longer needed by the component.
3307  * Also unassigns these capabilities from any roles that have them.
3308  *
3309  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
3310  * @param array $newcapdef array of the new capability definitions that will be
3311  *                     compared with the cached capabilities
3312  * @return int number of deprecated capabilities that have been removed
3313  */
3314 function capabilities_cleanup($component, $newcapdef = null) {
3315     global $DB;
3317     $removedcount = 0;
3319     if ($cachedcaps = get_cached_capabilities($component)) {
3320         foreach ($cachedcaps as $cachedcap) {
3321             if (empty($newcapdef) ||
3322                         array_key_exists($cachedcap->name, $newcapdef) === false) {
3324                 // Remove from capabilities cache.
3325                 $DB->delete_records('capabilities', array('name'=>$cachedcap->name));
3326                 $removedcount++;
3327                 // Delete from roles.
3328                 if ($roles = get_roles_with_capability($cachedcap->name)) {
3329                     foreach($roles as $role) {
3330                         if (!unassign_capability($cachedcap->name, $role->id)) {
3331                             print_error('cannotunassigncap', 'error', '', (object)array('cap'=>$cachedcap->name, 'role'=>$role->name));
3332                         }
3333                     }
3334                 }
3335             } // End if.
3336         }
3337     }
3338     return $removedcount;
3343 //////////////////
3344 // UI FUNCTIONS //
3345 //////////////////
3347 /**
3348  * @param integer $contextlevel $context->context level. One of the CONTEXT_... constants.
3349  * @return string the name for this type of context.
3350  */
3351 function get_contextlevel_name($contextlevel) {
3352     static $strcontextlevels = null;
3353     if (is_null($strcontextlevels)) {
3354         $strcontextlevels = array(
3355             CONTEXT_SYSTEM    => get_string('coresystem'),
3356             CONTEXT_USER      => get_string('user'),
3357             CONTEXT_COURSECAT => get_string('category'),
3358             CONTEXT_COURSE    => get_string('course'),
3359             CONTEXT_MODULE    => get_string('activitymodule'),
3360             CONTEXT_BLOCK     => get_string('block')
3361         );
3362     }
3363     return $strcontextlevels[$contextlevel];
3366 /**
3367  * Prints human readable context identifier.
3368  *
3369  * @param object $context the context.
3370  * @param boolean $withprefix whether to prefix the name of the context with the
3371  *      type of context, e.g. User, Course, Forum, etc.
3372  * @param boolean $short whether to user the short name of the thing. Only applies
3373  *      to course contexts
3374  * @return string the human readable context name.
3375  */
3376 function print_context_name($context, $withprefix = true, $short = false) {
3377     global $DB;
3379     $name = '';
3380     switch ($context->contextlevel) {
3382         case CONTEXT_SYSTEM:
3383             $name = get_string('coresystem');
3384             break;
3386         case CONTEXT_USER:
3387             if ($user = $DB->get_record('user', array('id'=>$context->instanceid))) {
3388                 if ($withprefix){
3389                     $name = get_string('user').': ';
3390                 }
3391                 $name .= fullname($user);
3392             }
3393             break;
3395         case CONTEXT_COURSECAT:
3396             if ($category = $DB->get_record('course_categories', array('id'=>$context->instanceid))) {
3397                 if ($withprefix){
3398                     $name = get_string('category').': ';
3399                 }
3400                 $name .=format_string($category->name);
3401             }
3402             break;
3404         case CONTEXT_COURSE:
3405             if ($context->instanceid == SITEID) {
3406                 $name = get_string('frontpage', 'admin');
3407             } else {
3408                 if ($course = $DB->get_record('course', array('id'=>$context->instanceid))) {
3409                     if ($withprefix){
3410                         $name = get_string('course').': ';
3411                     }
3412                     if ($short){
3413                         $name .= format_string($course->shortname);
3414                     } else {
3415                         $name .= format_string($course->fullname);
3416                    }
3417                 }
3418             }
3419             break;
3421         case CONTEXT_MODULE:
3422             if ($cm = $DB->get_record_sql('SELECT cm.*, md.name AS modname FROM {course_modules} cm ' .
3423                     'JOIN {modules} md ON md.id = cm.module WHERE cm.id = ?', array($context->instanceid))) {
3424                 if ($mod = $DB->get_record($cm->modname, array('id' => $cm->instance))) {
3425                         if ($withprefix){
3426                         $name = get_string('modulename', $cm->modname).': ';
3427                         }
3428                         $name .= $mod->name;
3429                     }
3430                 }
3431             break;
3433         case CONTEXT_BLOCK:
3434             if ($blockinstance = $DB->get_record('block_instances', array('id'=>$context->instanceid))) {
3435                 global $CFG;
3436                 require_once("$CFG->dirroot/blocks/moodleblock.class.php");
3437                 require_once("$CFG->dirroot/blocks/$blockinstance->blockname/block_$blockinstance->blockname.php");
3438                 $blockname = "block_$blockinstance->blockname";
3439                 if ($blockobject = new $blockname()) {
3440                     if ($withprefix){
3441                         $name = get_string('block').': ';
3442                     }
3443                     $name .= $blockobject->title;
3444                 }
3445             }
3446             break;
3448         default:
3449             print_error('unknowncontext');
3450             return false;
3451     }
3453     return $name;
3456 /**
3457  * Get a URL for a context, if there is a natural one. For example, for
3458  * CONTEXT_COURSE, this is the course page. For CONTEXT_USER it is the
3459  * user profile page.
3460  *
3461  * @param object $context the context.
3462  * @return moodle_url
3463  */
3464 function get_context_url($context) {
3465     global $COURSE, $DB;
3467     switch ($context->contextlevel) {
3468         case CONTEXT_USER:
3469             if ($COURSE->id == SITEID) {
3470                 $url = new moodle_url('/user/profile.php', array('id'=>$context->instanceid));
3471             } else {
3472                 $url = new moodle_url('/user/view.php', array('id'=>$context->instanceid, 'courseid'=>$COURSE->id));
3473             }
3474             return $url;;
3476         case CONTEXT_COURSECAT: // Coursecat -> coursecat or site
3477             return new moodle_url('/course/category.php', array('id'=>$context->instanceid));
3479         case CONTEXT_COURSE: // 1 to 1 to course cat
3480             if ($context->instanceid != SITEID) {
3481                 return new moodle_url('/course/view.php', array('id'=>$context->instanceid));
3482             }
3483             break;
3485         case CONTEXT_MODULE: // 1 to 1 to course
3486             if ($modname = $DB->get_field_sql('SELECT md.name AS modname FROM {course_modules} cm ' .
3487                     'JOIN {modules} md ON md.id = cm.module WHERE cm.id = ?', array($context->instanceid))) {
3488                 return new moodle_url('/mod/' . $modname . '/view.php', array('id'=>$context->instanceid));
3489             }
3490             break;
3492         case CONTEXT_BLOCK:
3493             $parentcontexts = get_parent_contexts($context, false);
3494             $parent = reset($parentcontexts);
3495             $parent = get_context_instance_by_id($parent);
3496             return get_context_url($parent);
3497     }
3499     return new moodle_url('/');
3502 /**
3503  * Returns an array of all the known types of risk
3504  * The array keys can be used, for example as CSS class names, or in calls to
3505  * print_risk_icon. The values are the corresponding RISK_ constants.
3506  *
3507  * @return array all the known types of risk.
3508  */
3509 function get_all_risks() {
3510     return array(
3511         'riskmanagetrust' => RISK_MANAGETRUST,
3512         'riskconfig'      => RISK_CONFIG,
3513         'riskxss'         => RISK_XSS,
3514         'riskpersonal'    => RISK_PERSONAL,
3515         'riskspam'        => RISK_SPAM,
3516         'riskdataloss'    => RISK_DATALOSS,
3517     );
3520 /**
3521  * Return a link to moodle docs for a given capability name
3522  *
3523  * @param object $capability a capability - a row from the mdl_capabilities table.
3524  * @return string the human-readable capability name as a link to Moodle Docs.
3525  */
3526 function get_capability_docs_link($capability) {
3527     global $CFG;
3528     $url = get_docs_url('Capabilities/' . $capability->name);
3529     return '<a onclick="this.target=\'docspopup\'" href="' . $url . '">' . get_capability_string($capability->name) . '</a>';
3532 /**
3533  * Extracts the relevant capabilities given a contextid.
3534  * All case based, example an instance of forum context.
3535  * Will fetch all forum related capabilities, while course contexts
3536  * Will fetch all capabilities
3537  *
3538  * capabilities
3539  * `name` varchar(150) NOT NULL,
3540  * `captype` varchar(50) NOT NULL,
3541  * `contextlevel` int(10) NOT NULL,
3542  * `component` varchar(100) NOT NULL,
3543  *
3544  * @param object context
3545  * @return array
3546  */
3547 function fetch_context_capabilities($context) {
3548     global $DB, $CFG;
3550     $sort = 'ORDER BY contextlevel,component,name';   // To group them sensibly for display
3552     $params = array();
3554     switch ($context->contextlevel) {
3556         case CONTEXT_SYSTEM: // all
3557             $SQL = "SELECT *
3558                       FROM {capabilities}";
3559         break;
3561         case CONTEXT_USER:
3562             $extracaps = array('moodle/grade:viewall');
3563             list($extra, $params) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED, 'cap0');
3564             $SQL = "SELECT *
3565                       FROM {capabilities}
3566                      WHERE contextlevel = ".CONTEXT_USER."
3567                            OR name $extra";
3568         break;
3570         case CONTEXT_COURSECAT: // course category context and bellow
3571             $SQL = "SELECT *
3572                       FROM {capabilities}
3573                      WHERE contextlevel IN (".CONTEXT_COURSECAT.",".CONTEXT_COURSE.",".CONTEXT_MODULE.",".CONTEXT_BLOCK.")";
3574         break;
3576         case CONTEXT_COURSE: // course context and bellow
3577             $SQL = "SELECT *
3578                       FROM {capabilities}
3579                      WHERE contextlevel IN (".CONTEXT_COURSE.",".CONTEXT_MODULE.",".CONTEXT_BLOCK.")";
3580         break;
3582         case CONTEXT_MODULE: // mod caps
3583             $cm = $DB->get_record('course_modules', array('id'=>$context->instanceid));
3584             $module = $DB->get_record('modules', array('id'=>$cm->module));
3586             $modfile = "$CFG->dirroot/mod/$module->name/lib.php";
3587             if (file_exists($modfile)) {
3588                 include_once($modfile);
3589                 $modfunction = $module->name.'_get_extra_capabilities';
3590                 if (function_exists($modfunction)) {
3591                     $extracaps = $modfunction();
3592                 }
3593             }
3594             if (empty($extracaps)) {
3595                 $extracaps = array();
3596             }
3598             // All modules allow viewhiddenactivities. This is so you can hide
3599             // the module then override to allow specific roles to see it.
3600             // The actual check is in course page so not module-specific
3601             $extracaps[]="moodle/course:viewhiddenactivities";
3602             list($extra, $params) = $DB->get_in_or_equal(
3603                 $extracaps, SQL_PARAMS_NAMED, 'cap0');
3604             $extra = "OR name $extra";
3606             $SQL = "SELECT *
3607                       FROM {capabilities}
3608                      WHERE (contextlevel = ".CONTEXT_MODULE."
3609                            AND component = :component)
3610                            $extra";
3611             $params['component'] = "mod_$module->name";
3612         break;
3614         case CONTEXT_BLOCK: // block caps
3615             $bi = $DB->get_record('block_instances', array('id' => $context->instanceid));
3617             $extra = '';
3618             $extracaps = block_method_result($bi->blockname, 'get_extra_capabilities');
3619             if ($extracaps) {
3620                 list($extra, $params) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED, 'cap0');
3621                 $extra = "OR name $extra";