MDL-23927 do not use = 'guest' because we have CFG->siteguest AND it matches any...
[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 $ACCESSLIB_PRIVATE = new stdClass;
194 $ACCESSLIB_PRIVATE->contexts = array(); // Cache of context objects by level and instance
195 $ACCESSLIB_PRIVATE->contextsbyid = array(); // Cache of context objects by id
196 $ACCESSLIB_PRIVATE->systemcontext = NULL; // Used in get_system_context
197 $ACCESSLIB_PRIVATE->dirtycontexts = NULL; // Dirty contexts cache
198 $ACCESSLIB_PRIVATE->accessdatabyuser = array(); // Holds the $accessdata structure for users other than $USER
199 $ACCESSLIB_PRIVATE->roledefinitions = array(); // role definitions cache - helps a lot with mem usage in cron
200 $ACCESSLIB_PRIVATE->croncache = array(); // Used in get_role_access
201 $ACCESSLIB_PRIVATE->preloadedcourses = array(); // Used in preload_course_contexts.
202 $ACCESSLIB_PRIVATE->capabilities = NULL; // detailed information about the capabilities
204 /**
205  * Clears accesslib's private caches. ONLY BE USED BY UNIT TESTS
206  *
207  * This method should ONLY BE USED BY UNIT TESTS. It clears all of
208  * accesslib's private caches. You need to do this before setting up test data,
209  * and also at the end of the tests.
210  * @global object
211  * @global object
212  * @global object
213  */
214 function accesslib_clear_all_caches_for_unit_testing() {
215     global $UNITTEST, $USER, $ACCESSLIB_PRIVATE;
216     if (empty($UNITTEST->running)) {
217         throw new coding_exception('You must not call clear_all_caches outside of unit tests.');
218     }
219     $ACCESSLIB_PRIVATE->contexts = array();
220     $ACCESSLIB_PRIVATE->contextsbyid = array();
221     $ACCESSLIB_PRIVATE->systemcontext = NULL;
222     $ACCESSLIB_PRIVATE->dirtycontexts = NULL;
223     $ACCESSLIB_PRIVATE->accessdatabyuser = array();
224     $ACCESSLIB_PRIVATE->roledefinitions = array();
225     $ACCESSLIB_PRIVATE->croncache = array();
226     $ACCESSLIB_PRIVATE->preloadedcourses = array();
227     $ACCESSLIB_PRIVATE->capabilities = NULL;
229     unset($USER->access);
232 /**
233  * Private function. Add a context object to accesslib's caches.
234  * @global object
235  * @param object $context
236  */
237 function cache_context($context) {
238     global $ACCESSLIB_PRIVATE;
240     // If there are too many items in the cache already, remove items until
241     // there is space
242     while (count($ACCESSLIB_PRIVATE->contextsbyid) >= MAX_CONTEXT_CACHE_SIZE) {
243         $first = reset($ACCESSLIB_PRIVATE->contextsbyid);
244         unset($ACCESSLIB_PRIVATE->contextsbyid[$first->id]);
245         unset($ACCESSLIB_PRIVATE->contexts[$first->contextlevel][$first->instanceid]);
246     }
248     $ACCESSLIB_PRIVATE->contexts[$context->contextlevel][$context->instanceid] = $context;
249     $ACCESSLIB_PRIVATE->contextsbyid[$context->id] = $context;
252 /**
253  * This is really slow!!! do not use above course context level
254  *
255  * @global object
256  * @param int $roleid
257  * @param object $context
258  * @return array
259  */
260 function get_role_context_caps($roleid, $context) {
261     global $DB;
263     //this is really slow!!!! - do not use above course context level!
264     $result = array();
265     $result[$context->id] = array();
267     // first emulate the parent context capabilities merging into context
268     $searchcontexts = array_reverse(get_parent_contexts($context));
269     array_push($searchcontexts, $context->id);
270     foreach ($searchcontexts as $cid) {
271         if ($capabilities = $DB->get_records('role_capabilities', array('roleid'=>$roleid, 'contextid'=>$cid))) {
272             foreach ($capabilities as $cap) {
273                 if (!array_key_exists($cap->capability, $result[$context->id])) {
274                     $result[$context->id][$cap->capability] = 0;
275                 }
276                 $result[$context->id][$cap->capability] += $cap->permission;
277             }
278         }
279     }
281     // now go through the contexts bellow given context
282     $searchcontexts = array_keys(get_child_contexts($context));
283     foreach ($searchcontexts as $cid) {
284         if ($capabilities = $DB->get_records('role_capabilities', array('roleid'=>$roleid, 'contextid'=>$cid))) {
285             foreach ($capabilities as $cap) {
286                 if (!array_key_exists($cap->contextid, $result)) {
287                     $result[$cap->contextid] = array();
288                 }
289                 $result[$cap->contextid][$cap->capability] = $cap->permission;
290             }
291         }
292     }
294     return $result;
297 /**
298  * Gets the accessdata for role "sitewide" (system down to course)
299  *
300  * @global object
301  * @global object
302  * @param int $roleid
303  * @param array $accessdata defaults to NULL
304  * @return array
305  */
306 function get_role_access($roleid, $accessdata=NULL) {
308     global $CFG, $DB;
310     /* Get it in 1 cheap DB query...
311      * - relevant role caps at the root and down
312      *   to the course level - but not below
313      */
314     if (is_null($accessdata)) {
315         $accessdata           = array(); // named list
316         $accessdata['ra']     = array();
317         $accessdata['rdef']   = array();
318         $accessdata['loaded'] = array();
319     }
321     //
322     // Overrides for the role IN ANY CONTEXTS
323     // down to COURSE - not below -
324     //
325     $sql = "SELECT ctx.path,
326                    rc.capability, rc.permission
327               FROM {context} ctx
328               JOIN {role_capabilities} rc
329                    ON rc.contextid=ctx.id
330              WHERE rc.roleid = ?
331                    AND ctx.contextlevel <= ".CONTEXT_COURSE."
332           ORDER BY ctx.depth, ctx.path";
333     $params = array($roleid);
335     // we need extra caching in CLI scripts and cron
336     if (CLI_SCRIPT) {
337         global $ACCESSLIB_PRIVATE;
339         if (!isset($ACCESSLIB_PRIVATE->croncache[$roleid])) {
340             $ACCESSLIB_PRIVATE->croncache[$roleid] = array();
341             if ($rs = $DB->get_recordset_sql($sql, $params)) {
342                 foreach ($rs as $rd) {
343                     $ACCESSLIB_PRIVATE->croncache[$roleid][] = $rd;
344                 }
345                 $rs->close();
346             }
347         }
349         foreach ($ACCESSLIB_PRIVATE->croncache[$roleid] as $rd) {
350             $k = "{$rd->path}:{$roleid}";
351             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
352         }
354     } else {
355         if ($rs = $DB->get_recordset_sql($sql, $params)) {
356             foreach ($rs as $rd) {
357                 $k = "{$rd->path}:{$roleid}";
358                 $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
359             }
360             unset($rd);
361             $rs->close();
362         }
363     }
365     return $accessdata;
368 /**
369  * Gets the accessdata for role "sitewide" (system down to course)
370  *
371  * @global object
372  * @global object
373  * @param int $roleid
374  * @param array $accessdata defaults to NULL
375  * @return array
376  */
377 function get_default_frontpage_role_access($roleid, $accessdata=NULL) {
379     global $CFG, $DB;
381     $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
382     $base = '/'. SYSCONTEXTID .'/'. $frontpagecontext->id;
384     //
385     // Overrides for the role in any contexts related to the course
386     //
387     $sql = "SELECT ctx.path,
388                    rc.capability, rc.permission
389               FROM {context} ctx
390               JOIN {role_capabilities} rc
391                    ON rc.contextid=ctx.id
392              WHERE rc.roleid = ?
393                    AND (ctx.id = ".SYSCONTEXTID." OR ctx.path LIKE ?)
394                    AND ctx.contextlevel <= ".CONTEXT_COURSE."
395           ORDER BY ctx.depth, ctx.path";
396     $params = array($roleid, "$base/%");
398     if ($rs = $DB->get_recordset_sql($sql, $params)) {
399         foreach ($rs as $rd) {
400             $k = "{$rd->path}:{$roleid}";
401             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
402         }
403         unset($rd);
404         $rs->close();
405     }
407     return $accessdata;
411 /**
412  * Get the default guest role
413  *
414  * @global object
415  * @global object
416  * @return object role
417  */
418 function get_guest_role() {
419     global $CFG, $DB;
421     if (empty($CFG->guestroleid)) {
422         if ($roles = $DB->get_records('role', array('archetype'=>'guest'))) {
423             $guestrole = array_shift($roles);   // Pick the first one
424             set_config('guestroleid', $guestrole->id);
425             return $guestrole;
426         } else {
427             debugging('Can not find any guest role!');
428             return false;
429         }
430     } else {
431         if ($guestrole = $DB->get_record('role', array('id'=>$CFG->guestroleid))) {
432             return $guestrole;
433         } else {
434             //somebody is messing with guest roles, remove incorrect setting and try to find a new one
435             set_config('guestroleid', '');
436             return get_guest_role();
437         }
438     }
441 /**
442  * Check whether a user has a particular capability in a given context.
443  *
444  * For example::
445  *      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
446  *      has_capability('mod/forum:replypost',$context)
447  *
448  * By default checks the capabilities of the current user, but you can pass a
449  * different userid. By default will return true for admin users, but you can override that with the fourth argument.
450  *
451  * Guest and not-logged-in users can never get any dangerous capability - that is any write capability
452  * or capabilities with XSS, config or data loss risks.
453  *
454  * @param string $capability the name of the capability to check. For example mod/forum:view
455  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
456  * @param integer|object $user A user id or object. By default (NULL) checks the permissions of the current user.
457  * @param boolean $doanything If false, ignores effect of admin role assignment
458  * @return boolean true if the user has this capability. Otherwise false.
459  */
460 function has_capability($capability, $context, $user = NULL, $doanything=true) {
461     global $USER, $CFG, $DB, $SCRIPT, $ACCESSLIB_PRIVATE;
463     if (during_initial_install()) {
464         if ($SCRIPT === "/$CFG->admin/index.php" or $SCRIPT === "/$CFG->admin/cliupgrade.php") {
465             // we are in an installer - roles can not work yet
466             return true;
467         } else {
468             return false;
469         }
470     }
472     if (strpos($capability, 'moodle/legacy:') === 0) {
473         throw new coding_exception('Legacy capabilities can not be used any more!');
474     }
476     // the original $CONTEXT here was hiding serious errors
477     // for security reasons do not reuse previous context
478     if (empty($context)) {
479         debugging('Incorrect context specified');
480         return false;
481     }
482     if (!is_bool($doanything)) {
483         throw new coding_exception('Capability parameter "doanything" is wierd ("'.$doanything.'"). This has to be fixed in code.');
484     }
486     // make sure there is a real user specified
487     if ($user === NULL) {
488         $userid = !empty($USER->id) ? $USER->id : 0;
489     } else {
490         $userid = !empty($user->id) ? $user->id : $user;
491     }
493     // capability must exist
494     if (!$capinfo = get_capability_info($capability)) {
495         debugging('Capability "'.$capability.'" was not found! This should be fixed in code.');
496         return false;
497     }
498     // make sure the guest account and not-logged-in users never get any risky caps no matter what the actual settings are.
499     if (($capinfo->captype === 'write') or ((int)$capinfo->riskbitmask & (RISK_XSS | RISK_CONFIG | RISK_DATALOSS))) {
500         if (isguestuser($userid) or $userid == 0) {
501             return false;
502         }
503     }
505     if (is_null($context->path) or $context->depth == 0) {
506         //this should not happen
507         $contexts = array(SYSCONTEXTID, $context->id);
508         $context->path = '/'.SYSCONTEXTID.'/'.$context->id;
509         debugging('Context id '.$context->id.' does not have valid path, please use build_context_path()', DEBUG_DEVELOPER);
511     } else {
512         $contexts = explode('/', $context->path);
513         array_shift($contexts);
514     }
516     if (CLI_SCRIPT && !isset($USER->access)) {
517         // In cron, some modules setup a 'fake' $USER,
518         // ensure we load the appropriate accessdata.
519         if (isset($ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
520             $ACCESSLIB_PRIVATE->dirtycontexts = NULL; //load fresh dirty contexts
521         } else {
522             load_user_accessdata($userid);
523             $ACCESSLIB_PRIVATE->dirtycontexts = array();
524         }
525         $USER->access = $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
527     } else if (isset($USER->id) && ($USER->id == $userid) && !isset($USER->access)) {
528         // caps not loaded yet - better to load them to keep BC with 1.8
529         // not-logged-in user or $USER object set up manually first time here
530         load_all_capabilities();
531         $ACCESSLIB_PRIVATE->accessdatabyuser = array(); // reset the cache for other users too, the dirty contexts are empty now
532         $ACCESSLIB_PRIVATE->roledefinitions = array();
533     }
535     // Load dirty contexts list if needed
536     if (!isset($ACCESSLIB_PRIVATE->dirtycontexts)) {
537         if (isset($USER->access['time'])) {
538             $ACCESSLIB_PRIVATE->dirtycontexts = get_dirty_contexts($USER->access['time']);
539         }
540         else {
541             $ACCESSLIB_PRIVATE->dirtycontexts = array();
542         }
543     }
545     // Careful check for staleness...
546     if (count($ACCESSLIB_PRIVATE->dirtycontexts) !== 0 and is_contextpath_dirty($contexts, $ACCESSLIB_PRIVATE->dirtycontexts)) {
547         // reload all capabilities - preserving loginas, roleswitches, etc
548         // and then cleanup any marks of dirtyness... at least from our short
549         // term memory! :-)
550         $ACCESSLIB_PRIVATE->accessdatabyuser = array();
551         $ACCESSLIB_PRIVATE->roledefinitions = array();
553         if (CLI_SCRIPT) {
554             load_user_accessdata($userid);
555             $USER->access = $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
556             $ACCESSLIB_PRIVATE->dirtycontexts = array();
558         } else {
559             reload_all_capabilities();
560         }
561     }
563     // Find out if user is admin - it is not possible to override the doanything in any way
564     // and it is not possible to switch to admin role either.
565     if ($doanything) {
566         if (is_siteadmin($userid)) {
567             if ($userid != $USER->id) {
568                 return true;
569             }
570             // make sure switchrole is not used in this context
571             if (empty($USER->access['rsw'])) {
572                 return true;
573             }
574             $parts = explode('/', trim($context->path, '/'));
575             $path = '';
576             $switched = false;
577             foreach ($parts as $part) {
578                 $path .= '/' . $part;
579                 if (!empty($USER->access['rsw'][$path])) {
580                     $switched = true;
581                     break;
582                 }
583             }
584             if (!$switched) {
585                 return true;
586             }
587             //ok, admin switched role in this context, let's use normal access control rules
588         }
589     }
591     // divulge how many times we are called
592     //// error_log("has_capability: id:{$context->id} path:{$context->path} userid:$userid cap:$capability");
594     if (isset($USER->id) && ($USER->id == $userid)) { // we must accept strings and integers in $userid
595         //
596         // For the logged in user, we have $USER->access
597         // which will have all RAs and caps preloaded for
598         // course and above contexts.
599         //
600         // Contexts below courses && contexts that do not
601         // hang from courses are loaded into $USER->access
602         // on demand, and listed in $USER->access[loaded]
603         //
604         if ($context->contextlevel <= CONTEXT_COURSE) {
605             // Course and above are always preloaded
606             return has_capability_in_accessdata($capability, $context, $USER->access);
607         }
608         // Load accessdata for below-the-course contexts
609         if (!path_inaccessdata($context->path,$USER->access)) {
610             // error_log("loading access for context {$context->path} for $capability at {$context->contextlevel} {$context->id}");
611             // $bt = debug_backtrace();
612             // error_log("bt {$bt[0]['file']} {$bt[0]['line']}");
613             load_subcontext($USER->id, $context, $USER->access);
614         }
615         return has_capability_in_accessdata($capability, $context, $USER->access);
616     }
618     if (!isset($ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
619         load_user_accessdata($userid);
620     }
622     if ($context->contextlevel <= CONTEXT_COURSE) {
623         // Course and above are always preloaded
624         return has_capability_in_accessdata($capability, $context, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid]);
625     }
626     // Load accessdata for below-the-course contexts as needed
627     if (!path_inaccessdata($context->path, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid])) {
628         // error_log("loading access for context {$context->path} for $capability at {$context->contextlevel} {$context->id}");
629         // $bt = debug_backtrace();
630         // error_log("bt {$bt[0]['file']} {$bt[0]['line']}");
631         load_subcontext($userid, $context, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid]);
632     }
633     return has_capability_in_accessdata($capability, $context, $ACCESSLIB_PRIVATE->accessdatabyuser[$userid]);
636 /**
637  * Check if the user has any one of several capabilities from a list.
638  *
639  * This is just a utility method that calls has_capability in a loop. Try to put
640  * the capabilities that most users are likely to have first in the list for best
641  * performance.
642  *
643  * There are probably tricks that could be done to improve the performance here, for example,
644  * check the capabilities that are already cached first.
645  *
646  * @see has_capability()
647  * @param array $capabilities an array of capability names.
648  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
649  * @param integer $userid A user id. By default (NULL) checks the permissions of the current user.
650  * @param boolean $doanything If false, ignore effect of admin role assignment
651  * @return boolean true if the user has any of these capabilities. Otherwise false.
652  */
653 function has_any_capability($capabilities, $context, $userid=NULL, $doanything=true) {
654     if (!is_array($capabilities)) {
655         debugging('Incorrect $capabilities parameter in has_any_capabilities() call - must be an array');
656         return false;
657     }
658     foreach ($capabilities as $capability) {
659         if (has_capability($capability, $context, $userid, $doanything)) {
660             return true;
661         }
662     }
663     return false;
666 /**
667  * Check if the user has all the capabilities in a list.
668  *
669  * This is just a utility method that calls has_capability in a loop. Try to put
670  * the capabilities that fewest users are likely to have first in the list for best
671  * performance.
672  *
673  * There are probably tricks that could be done to improve the performance here, for example,
674  * check the capabilities that are already cached first.
675  *
676  * @see has_capability()
677  * @param array $capabilities an array of capability names.
678  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
679  * @param integer $userid A user id. By default (NULL) checks the permissions of the current user.
680  * @param boolean $doanything If false, ignore effect of admin role assignment
681  * @return boolean true if the user has all of these capabilities. Otherwise false.
682  */
683 function has_all_capabilities($capabilities, $context, $userid=NULL, $doanything=true) {
684     if (!is_array($capabilities)) {
685         debugging('Incorrect $capabilities parameter in has_all_capabilities() call - must be an array');
686         return false;
687     }
688     foreach ($capabilities as $capability) {
689         if (!has_capability($capability, $context, $userid, $doanything)) {
690             return false;
691         }
692     }
693     return true;
696 /**
697  * Check if the user is an admin at the site level.
698  *
699  * Please note that use of proper capabilities is always encouraged,
700  * this function is supposed to be used from core or for temporary hacks.
701  *
702  * @param   int|object  $user_or_id user id or user object
703  * @returns bool true if user is one of the administrators, false otherwise
704  */
705 function is_siteadmin($user_or_id = NULL) {
706     global $CFG, $USER;
708     if ($user_or_id === NULL) {
709         $user_or_id = $USER;
710     }
712     if (empty($user_or_id)) {
713         return false;
714     }
715     if (!empty($user_or_id->id)) {
716         // we support
717         $userid = $user_or_id->id;
718     } else {
719         $userid = $user_or_id;
720     }
722     $siteadmins = explode(',', $CFG->siteadmins);
723     return in_array($userid, $siteadmins);
726 /**
727  * Returns true if user has at least one role assign
728  * of 'coursecontact' role (is potentially listed in some course descriptions).
729  * @param $userid
730  * @return unknown_type
731  */
732 function has_coursecontact_role($userid) {
733     global $DB;
735     if (empty($CFG->coursecontact)) {
736         return false;
737     }
738     $sql = "SELECT 1
739               FROM {role_assignments}
740              WHERE userid = :userid AND roleid IN ($CFG->coursecontact)";
741     return $DB->record_exists($sql, array('userid'=>$userid));
744 /**
745  * @param string $path
746  * @return string
747  */
748 function get_course_from_path($path) {
749     // assume that nothing is more than 1 course deep
750     if (preg_match('!^(/.+)/\d+$!', $path, $matches)) {
751         return $matches[1];
752     }
753     return false;
756 /**
757  * @param string $path
758  * @param array $accessdata
759  * @return bool
760  */
761 function path_inaccessdata($path, $accessdata) {
762     if (empty($accessdata['loaded'])) {
763         return false;
764     }
766     // assume that contexts hang from sys or from a course
767     // this will only work well with stuff that hangs from a course
768     if (in_array($path, $accessdata['loaded'], true)) {
769             // error_log("found it!");
770         return true;
771     }
772     $base = '/' . SYSCONTEXTID;
773     while (preg_match('!^(/.+)/\d+$!', $path, $matches)) {
774         $path = $matches[1];
775         if ($path === $base) {
776             return false;
777         }
778         if (in_array($path, $accessdata['loaded'], true)) {
779             return true;
780         }
781     }
782     return false;
785 /**
786  * Does the user have a capability to do something?
787  *
788  * Walk the accessdata array and return true/false.
789  * Deals with prohibits, roleswitching, aggregating
790  * capabilities, etc.
791  *
792  * The main feature of here is being FAST and with no
793  * side effects.
794  *
795  * Notes:
796  *
797  * Switch Roles exits early
798  * ------------------------
799  * cap checks within a switchrole need to exit early
800  * in our bottom up processing so they don't "see" that
801  * there are real RAs that can do all sorts of things.
802  *
803  * Switch Role merges with default role
804  * ------------------------------------
805  * If you are a teacher in course X, you have at least
806  * teacher-in-X + defaultloggedinuser-sitewide. So in the
807  * course you'll have techer+defaultloggedinuser.
808  * We try to mimic that in switchrole.
809  *
810  * Permission evaluation
811  * ---------------------
812  * Originally there was an extremely complicated way
813  * to determine the user access that dealt with
814  * "locality" or role assignments and role overrides.
815  * Now we simply evaluate access for each role separately
816  * and then verify if user has at least one role with allow
817  * and at the same time no role with prohibit.
818  *
819  * @param string $capability
820  * @param object $context
821  * @param array $accessdata
822  * @return bool
823  */
824 function has_capability_in_accessdata($capability, $context, array $accessdata) {
825     global $CFG;
827     if (empty($context->id)) {
828         throw new coding_exception('Invalid context specified');
829     }
831     // Build $paths as a list of current + all parent "paths" with order bottom-to-top
832     $contextids = explode('/', trim($context->path, '/'));
833     $paths = array($context->path);
834     while ($contextids) {
835         array_pop($contextids);
836         $paths[] = '/' . implode('/', $contextids);
837     }
838     unset($contextids);
840     $roles = array();
841     $switchedrole = false;
843     // Find out if role switched
844     if (!empty($accessdata['rsw'])) {
845         // From the bottom up...
846         foreach ($paths as $path) {
847             if (isset($accessdata['rsw'][$path])) {
848                 // Found a switchrole assignment - check for that role _plus_ the default user role
849                 $roles = array($accessdata['rsw'][$path]=>NULL, $CFG->defaultuserroleid=>NULL);
850                 $switchedrole = true;
851                 break;
852             }
853         }
854     }
856     if (!$switchedrole) {
857         // get all users roles in this context and above
858         foreach ($paths as $path) {
859             if (isset($accessdata['ra'][$path])) {
860                 foreach ($accessdata['ra'][$path] as $roleid) {
861                     $roles[$roleid] = NULL;
862                 }
863             }
864         }
865     }
867     // Now find out what access is given to each role, going bottom-->up direction
868     foreach ($roles as $roleid => $ignored) {
869         foreach ($paths as $path) {
870             if (isset($accessdata['rdef']["{$path}:$roleid"][$capability])) {
871                 $perm = (int)$accessdata['rdef']["{$path}:$roleid"][$capability];
872                 if ($perm === CAP_PROHIBIT or is_null($roles[$roleid])) {
873                     $roles[$roleid] = $perm;
874                 }
875             }
876         }
877     }
878     // any CAP_PROHIBIT found means no permission for the user
879     if (array_search(CAP_PROHIBIT, $roles) !== false) {
880         return false;
881     }
883     // at least one CAP_ALLOW means the user has a permission
884     return (array_search(CAP_ALLOW, $roles) !== false);
887 /**
888  * @param object $context
889  * @param array $accessdata
890  * @return array
891  */
892 function aggregate_roles_from_accessdata($context, $accessdata) {
894     $path = $context->path;
896     // build $contexts as a list of "paths" of the current
897     // contexts and parents with the order top-to-bottom
898     $contexts = array($path);
899     while (preg_match('!^(/.+)/\d+$!', $path, $matches)) {
900         $path = $matches[1];
901         array_unshift($contexts, $path);
902     }
904     $cc = count($contexts);
906     $roles = array();
907     // From the bottom up...
908     for ($n=$cc-1;$n>=0;$n--) {
909         $ctxp = $contexts[$n];
910         if (isset($accessdata['ra'][$ctxp]) && count($accessdata['ra'][$ctxp])) {
911             // Found assignments on this leaf
912             $addroles = $accessdata['ra'][$ctxp];
913             $roles    = array_merge($roles, $addroles);
914         }
915     }
917     return array_unique($roles);
920 /**
921  * A convenience function that tests has_capability, and displays an error if
922  * the user does not have that capability.
923  *
924  * NOTE before Moodle 2.0, this function attempted to make an appropriate
925  * require_login call before checking the capability. This is no longer the case.
926  * You must call require_login (or one of its variants) if you want to check the
927  * user is logged in, before you call this function.
928  *
929  * @see has_capability()
930  *
931  * @param string $capability the name of the capability to check. For example mod/forum:view
932  * @param object $context the context to check the capability in. You normally get this with {@link get_context_instance}.
933  * @param integer $userid A user id. By default (NULL) checks the permissions of the current user.
934  * @param bool $doanything If false, ignore effect of admin role assignment
935  * @param string $errorstring The error string to to user. Defaults to 'nopermissions'.
936  * @param string $stringfile The language file to load the error string from. Defaults to 'error'.
937  * @return void terminates with an error if the user does not have the given capability.
938  */
939 function require_capability($capability, $context, $userid = NULL, $doanything = true,
940                             $errormessage = 'nopermissions', $stringfile = '') {
941     if (!has_capability($capability, $context, $userid, $doanything)) {
942         throw new required_capability_exception($context, $capability, $errormessage, $stringfile);
943     }
946 /**
947  * Get an array of courses where cap requested is available
948  * and user is enrolled, this can be relatively slow.
949  *
950  * @param string $capability - name of the capability
951  * @param array  $accessdata_ignored
952  * @param bool   $doanything_ignored
953  * @param string $sort - sorting fields - prefix each fieldname with "c."
954  * @param array  $fields - additional fields you are interested in...
955  * @param int    $limit_ignored
956  * @return array $courses - ordered array of course objects - see notes above
957  */
958 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort='c.sortorder ASC', $fields=NULL, $limit_ignored=0) {
960     //TODO: this should be most probably deprecated
962     $courses = enrol_get_users_courses($userid, true, $fields, $sort);
963     foreach ($courses as $id=>$course) {
964         $context = get_context_instance(CONTEXT_COURSE, $id);
965         if (!has_capability($cap, $context, $userid)) {
966             unset($courses[$id]);
967         }
968     }
970     return $courses;
974 /**
975  * Return a nested array showing role assignments
976  * all relevant role capabilities for the user at
977  * site/course_category/course levels
978  *
979  * We do _not_ delve deeper than courses because the number of
980  * overrides at the module/block levels is HUGE.
981  *
982  * [ra]   => [/path/][]=roleid
983  * [rdef] => [/path/:roleid][capability]=permission
984  * [loaded] => array('/path', '/path')
985  *
986  * @global object
987  * @global object
988  * @param $userid integer - the id of the user
989  */
990 function get_user_access_sitewide($userid) {
992     global $CFG, $DB;
994     /* Get in 3 cheap DB queries...
995      * - role assignments
996      * - relevant role caps
997      *   - above and within this user's RAs
998      *   - below this user's RAs - limited to course level
999      */
1001     $accessdata           = array(); // named list
1002     $accessdata['ra']     = array();
1003     $accessdata['rdef']   = array();
1004     $accessdata['loaded'] = array();
1006     //
1007     // Role assignments
1008     //
1009     $sql = "SELECT ctx.path, ra.roleid
1010               FROM {role_assignments} ra
1011               JOIN {context} ctx ON ctx.id=ra.contextid
1012              WHERE ra.userid = ? AND ctx.contextlevel <= ".CONTEXT_COURSE;
1013     $params = array($userid);
1014     $rs = $DB->get_recordset_sql($sql, $params);
1016     //
1017     // raparents collects paths & roles we need to walk up
1018     // the parenthood to build the rdef
1019     //
1020     $raparents = array();
1021     if ($rs) {
1022         foreach ($rs as $ra) {
1023             // RAs leafs are arrays to support multi
1024             // role assignments...
1025             if (!isset($accessdata['ra'][$ra->path])) {
1026                 $accessdata['ra'][$ra->path] = array();
1027             }
1028             array_push($accessdata['ra'][$ra->path], $ra->roleid);
1030             // Concatenate as string the whole path (all related context)
1031             // for this role. This is damn faster than using array_merge()
1032             // Will unique them later
1033             if (isset($raparents[$ra->roleid])) {
1034                 $raparents[$ra->roleid] .= $ra->path;
1035             } else {
1036                 $raparents[$ra->roleid] = $ra->path;
1037             }
1038         }
1039         unset($ra);
1040         $rs->close();
1041     }
1043     // Walk up the tree to grab all the roledefs
1044     // of interest to our user...
1045     //
1046     // NOTE: we use a series of IN clauses here - which
1047     // might explode on huge sites with very convoluted nesting of
1048     // categories... - extremely unlikely that the number of categories
1049     // and roletypes is so large that we hit the limits of IN()
1050     $clauses = '';
1051     $cparams = array();
1052     foreach ($raparents as $roleid=>$strcontexts) {
1053         $contexts = implode(',', array_unique(explode('/', trim($strcontexts, '/'))));
1054         if ($contexts ==! '') {
1055             if ($clauses) {
1056                 $clauses .= ' OR ';
1057             }
1058             $clauses .= "(roleid=? AND contextid IN ($contexts))";
1059             $cparams[] = $roleid;
1060         }
1061     }
1063     if ($clauses !== '') {
1064         $sql = "SELECT ctx.path, rc.roleid, rc.capability, rc.permission
1065                 FROM {role_capabilities} rc
1066                 JOIN {context} ctx
1067                   ON rc.contextid=ctx.id
1068                 WHERE $clauses";
1070         unset($clauses);
1071         $rs = $DB->get_recordset_sql($sql, $cparams);
1073         if ($rs) {
1074             foreach ($rs as $rd) {
1075                 $k = "{$rd->path}:{$rd->roleid}";
1076                 $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1077             }
1078             unset($rd);
1079             $rs->close();
1080         }
1081     }
1083     //
1084     // Overrides for the role assignments IN SUBCONTEXTS
1085     // (though we still do _not_ go below the course level.
1086     //
1087     // NOTE that the JOIN w sctx is with 3-way triangulation to
1088     // catch overrides to the applicable role in any subcontext, based
1089     // on the path field of the parent.
1090     //
1091     $sql = "SELECT sctx.path, ra.roleid,
1092                    ctx.path AS parentpath,
1093                    rco.capability, rco.permission
1094               FROM {role_assignments} ra
1095               JOIN {context} ctx
1096                    ON ra.contextid=ctx.id
1097               JOIN {context} sctx
1098                    ON (sctx.path LIKE " . $DB->sql_concat('ctx.path',"'/%'"). " )
1099               JOIN {role_capabilities} rco
1100                    ON (rco.roleid=ra.roleid AND rco.contextid=sctx.id)
1101              WHERE ra.userid = ?
1102                AND ctx.contextlevel <= ".CONTEXT_COURSECAT."
1103                AND sctx.contextlevel <= ".CONTEXT_COURSE."
1104           ORDER BY sctx.depth, sctx.path, ra.roleid";
1105     $params = array($userid);
1106     $rs = $DB->get_recordset_sql($sql, $params);
1107     if ($rs) {
1108         foreach ($rs as $rd) {
1109             $k = "{$rd->path}:{$rd->roleid}";
1110             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1111         }
1112         unset($rd);
1113         $rs->close();
1114     }
1115     return $accessdata;
1118 /**
1119  * Add to the access ctrl array the data needed by a user for a given context
1120  *
1121  * @global object
1122  * @global object
1123  * @param integer $userid the id of the user
1124  * @param object $context needs path!
1125  * @param array $accessdata accessdata array
1126  */
1127 function load_subcontext($userid, $context, &$accessdata) {
1129     global $CFG, $DB;
1131     /* Get the additional RAs and relevant rolecaps
1132      * - role assignments - with role_caps
1133      * - relevant role caps
1134      *   - above this user's RAs
1135      *   - below this user's RAs - limited to course level
1136      */
1138     $base = "/" . SYSCONTEXTID;
1140     //
1141     // Replace $context with the target context we will
1142     // load. Normally, this will be a course context, but
1143     // may be a different top-level context.
1144     //
1145     // We have 3 cases
1146     //
1147     // - Course
1148     // - BLOCK/PERSON/USER/COURSE(sitecourse) hanging from SYSTEM
1149     // - BLOCK/MODULE/GROUP hanging from a course
1150     //
1151     // For course contexts, we _already_ have the RAs
1152     // but the cost of re-fetching is minimal so we don't care.
1153     //
1154     if ($context->contextlevel !== CONTEXT_COURSE
1155         && $context->path !== "$base/{$context->id}") {
1156         // Case BLOCK/MODULE/GROUP hanging from a course
1157         // Assumption: the course _must_ be our parent
1158         // If we ever see stuff nested further this needs to
1159         // change to do 1 query over the exploded path to
1160         // find out which one is the course
1161         $courses = explode('/',get_course_from_path($context->path));
1162         $targetid = array_pop($courses);
1163         $context = get_context_instance_by_id($targetid);
1165     }
1167     //
1168     // Role assignments in the context and below
1169     //
1170     $sql = "SELECT ctx.path, ra.roleid
1171               FROM {role_assignments} ra
1172               JOIN {context} ctx
1173                    ON ra.contextid=ctx.id
1174              WHERE ra.userid = ?
1175                    AND (ctx.path = ? OR ctx.path LIKE ?)
1176           ORDER BY ctx.depth, ctx.path, ra.roleid";
1177     $params = array($userid, $context->path, $context->path."/%");
1178     $rs = $DB->get_recordset_sql($sql, $params);
1180     //
1181     // Read in the RAs, preventing duplicates
1182     //
1183     if ($rs) {
1184         $localroles = array();
1185         $lastseen  = '';
1186         foreach ($rs as $ra) {
1187             if (!isset($accessdata['ra'][$ra->path])) {
1188                 $accessdata['ra'][$ra->path] = array();
1189             }
1190             // only add if is not a repeat caused
1191             // by capability join...
1192             // (this check is cheaper than in_array())
1193             if ($lastseen !== $ra->path.':'.$ra->roleid) {
1194                 $lastseen = $ra->path.':'.$ra->roleid;
1195                 array_push($accessdata['ra'][$ra->path], $ra->roleid);
1196                 array_push($localroles,           $ra->roleid);
1197             }
1198         }
1199         $rs->close();
1200     }
1202     //
1203     // Walk up and down the tree to grab all the roledefs
1204     // of interest to our user...
1205     //
1206     // NOTES
1207     // - we use IN() but the number of roles is very limited.
1208     //
1209     $courseroles    = aggregate_roles_from_accessdata($context, $accessdata);
1211     // Do we have any interesting "local" roles?
1212     $localroles = array_diff($localroles,$courseroles); // only "new" local roles
1213     $wherelocalroles='';
1214     if (count($localroles)) {
1215         // Role defs for local roles in 'higher' contexts...
1216         $contexts = substr($context->path, 1); // kill leading slash
1217         $contexts = str_replace('/', ',', $contexts);
1218         $localroleids = implode(',',$localroles);
1219         $wherelocalroles="OR (rc.roleid IN ({$localroleids})
1220                               AND ctx.id IN ($contexts))" ;
1221     }
1223     // We will want overrides for all of them
1224     $whereroles = '';
1225     if ($roleids  = implode(',',array_merge($courseroles,$localroles))) {
1226         $whereroles = "rc.roleid IN ($roleids) AND";
1227     }
1228     $sql = "SELECT ctx.path, rc.roleid, rc.capability, rc.permission
1229               FROM {role_capabilities} rc
1230               JOIN {context} ctx
1231                    ON rc.contextid=ctx.id
1232              WHERE ($whereroles
1233                     (ctx.id=? OR ctx.path LIKE ?))
1234                    $wherelocalroles
1235           ORDER BY ctx.depth ASC, ctx.path DESC, rc.roleid ASC ";
1236     $params = array($context->id, $context->path."/%");
1238     $newrdefs = array();
1239     if ($rs = $DB->get_recordset_sql($sql, $params)) {
1240         foreach ($rs as $rd) {
1241             $k = "{$rd->path}:{$rd->roleid}";
1242             if (!array_key_exists($k, $newrdefs)) {
1243                 $newrdefs[$k] = array();
1244             }
1245             $newrdefs[$k][$rd->capability] = $rd->permission;
1246         }
1247         $rs->close();
1248     } else {
1249         debugging('Bad SQL encountered!');
1250     }
1252     compact_rdefs($newrdefs);
1253     foreach ($newrdefs as $key=>$value) {
1254         $accessdata['rdef'][$key] =& $newrdefs[$key];
1255     }
1257     // error_log("loaded {$context->path}");
1258     $accessdata['loaded'][] = $context->path;
1261 /**
1262  * Add to the access ctrl array the data needed by a role for a given context.
1263  *
1264  * The data is added in the rdef key.
1265  *
1266  * This role-centric function is useful for role_switching
1267  * and to get an overview of what a role gets under a
1268  * given context and below...
1269  *
1270  * @global object
1271  * @global object
1272  * @param integer $roleid the id of the user
1273  * @param object $context needs path!
1274  * @param array $accessdata accessdata array NULL by default
1275  * @return array
1276  */
1277 function get_role_access_bycontext($roleid, $context, $accessdata=NULL) {
1279     global $CFG, $DB;
1281     /* Get the relevant rolecaps into rdef
1282      * - relevant role caps
1283      *   - at ctx and above
1284      *   - below this ctx
1285      */
1287     if (is_null($accessdata)) {
1288         $accessdata           = array(); // named list
1289         $accessdata['ra']     = array();
1290         $accessdata['rdef']   = array();
1291         $accessdata['loaded'] = array();
1292     }
1294     $contexts = substr($context->path, 1); // kill leading slash
1295     $contexts = str_replace('/', ',', $contexts);
1297     //
1298     // Walk up and down the tree to grab all the roledefs
1299     // of interest to our role...
1300     //
1301     // NOTE: we use an IN clauses here - which
1302     // might explode on huge sites with very convoluted nesting of
1303     // categories... - extremely unlikely that the number of nested
1304     // categories is so large that we hit the limits of IN()
1305     //
1306     $sql = "SELECT ctx.path, rc.capability, rc.permission
1307               FROM {role_capabilities} rc
1308               JOIN {context} ctx
1309                    ON rc.contextid=ctx.id
1310              WHERE rc.roleid=? AND
1311                    ( ctx.id IN ($contexts) OR
1312                     ctx.path LIKE ? )
1313           ORDER BY ctx.depth ASC, ctx.path DESC, rc.roleid ASC ";
1314     $params = array($roleid, $context->path."/%");
1316     if ($rs = $DB->get_recordset_sql($sql, $params)) {
1317         foreach ($rs as $rd) {
1318             $k = "{$rd->path}:{$roleid}";
1319             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1320         }
1321         $rs->close();
1322     }
1324     return $accessdata;
1327 /**
1328  * Load accessdata for a user into the $ACCESSLIB_PRIVATE->accessdatabyuser global
1329  *
1330  * Used by has_capability() - but feel free
1331  * to call it if you are about to run a BIG
1332  * cron run across a bazillion users.
1333  *
1334  * @global object
1335  * @global object
1336  * @param int $userid
1337  * @return array returns ACCESSLIB_PRIVATE->accessdatabyuser[userid]
1338  */
1339 function load_user_accessdata($userid) {
1340     global $CFG, $ACCESSLIB_PRIVATE;
1342     $base = '/'.SYSCONTEXTID;
1344     $accessdata = get_user_access_sitewide($userid);
1345     $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1346     //
1347     // provide "default role" & set 'dr'
1348     //
1349     if (!empty($CFG->defaultuserroleid)) {
1350         $accessdata = get_role_access($CFG->defaultuserroleid, $accessdata);
1351         if (!isset($accessdata['ra'][$base])) {
1352             $accessdata['ra'][$base] = array($CFG->defaultuserroleid);
1353         } else {
1354             array_push($accessdata['ra'][$base], $CFG->defaultuserroleid);
1355         }
1356         $accessdata['dr'] = $CFG->defaultuserroleid;
1357     }
1359     //
1360     // provide "default frontpage role"
1361     //
1362     if (!empty($CFG->defaultfrontpageroleid)) {
1363         $base = '/'. SYSCONTEXTID .'/'. $frontpagecontext->id;
1364         $accessdata = get_default_frontpage_role_access($CFG->defaultfrontpageroleid, $accessdata);
1365         if (!isset($accessdata['ra'][$base])) {
1366             $accessdata['ra'][$base] = array($CFG->defaultfrontpageroleid);
1367         } else {
1368             array_push($accessdata['ra'][$base], $CFG->defaultfrontpageroleid);
1369         }
1370     }
1371     // for dirty timestamps in cron
1372     $accessdata['time'] = time();
1374     $ACCESSLIB_PRIVATE->accessdatabyuser[$userid] = $accessdata;
1375     compact_rdefs($ACCESSLIB_PRIVATE->accessdatabyuser[$userid]['rdef']);
1377     return $ACCESSLIB_PRIVATE->accessdatabyuser[$userid];
1380 /**
1381  * Use shared copy of role definitions stored in ACCESSLIB_PRIVATE->roledefinitions;
1382  *
1383  * @global object
1384  * @param array $rdefs array of role definitions in contexts
1385  */
1386 function compact_rdefs(&$rdefs) {
1387     global $ACCESSLIB_PRIVATE;
1389     /*
1390      * This is a basic sharing only, we could also
1391      * use md5 sums of values. The main purpose is to
1392      * reduce mem in cron jobs - many users in $ACCESSLIB_PRIVATE->accessdatabyuser array.
1393      */
1395     foreach ($rdefs as $key => $value) {
1396         if (!array_key_exists($key, $ACCESSLIB_PRIVATE->roledefinitions)) {
1397             $ACCESSLIB_PRIVATE->roledefinitions[$key] = $rdefs[$key];
1398         }
1399         $rdefs[$key] =& $ACCESSLIB_PRIVATE->roledefinitions[$key];
1400     }
1403 /**
1404  * A convenience function to completely load all the capabilities
1405  * for the current user.   This is what gets called from complete_user_login()
1406  * for example. Call it only _after_ you've setup $USER and called
1407  * check_enrolment_plugins();
1408  * @see check_enrolment_plugins()
1409  *
1410  * @global object
1411  * @global object
1412  * @global object
1413  */
1414 function load_all_capabilities() {
1415     global $USER, $CFG, $ACCESSLIB_PRIVATE;
1417     // roles not installed yet - we are in the middle of installation
1418     if (during_initial_install()) {
1419         return;
1420     }
1422     $base = '/'.SYSCONTEXTID;
1424     if (isguestuser()) {
1425         $guest = get_guest_role();
1427         // Load the rdefs
1428         $USER->access = get_role_access($guest->id);
1429         // Put the ghost enrolment in place...
1430         $USER->access['ra'][$base] = array($guest->id);
1433     } else if (isloggedin()) {
1435         $accessdata = get_user_access_sitewide($USER->id);
1437         //
1438         // provide "default role" & set 'dr'
1439         //
1440         if (!empty($CFG->defaultuserroleid)) {
1441             $accessdata = get_role_access($CFG->defaultuserroleid, $accessdata);
1442             if (!isset($accessdata['ra'][$base])) {
1443                 $accessdata['ra'][$base] = array($CFG->defaultuserroleid);
1444             } else {
1445                 array_push($accessdata['ra'][$base], $CFG->defaultuserroleid);
1446             }
1447             $accessdata['dr'] = $CFG->defaultuserroleid;
1448         }
1450         $frontpagecontext = get_context_instance(CONTEXT_COURSE, SITEID);
1452         //
1453         // provide "default frontpage role"
1454         //
1455         if (!empty($CFG->defaultfrontpageroleid)) {
1456             $base = '/'. SYSCONTEXTID .'/'. $frontpagecontext->id;
1457             $accessdata = get_default_frontpage_role_access($CFG->defaultfrontpageroleid, $accessdata);
1458             if (!isset($accessdata['ra'][$base])) {
1459                 $accessdata['ra'][$base] = array($CFG->defaultfrontpageroleid);
1460             } else {
1461                 array_push($accessdata['ra'][$base], $CFG->defaultfrontpageroleid);
1462             }
1463         }
1464         $USER->access = $accessdata;
1466     } else if (!empty($CFG->notloggedinroleid)) {
1467         $USER->access = get_role_access($CFG->notloggedinroleid);
1468         $USER->access['ra'][$base] = array($CFG->notloggedinroleid);
1469     }
1471     // Timestamp to read dirty context timestamps later
1472     $USER->access['time'] = time();
1473     $ACCESSLIB_PRIVATE->dirtycontexts = array();
1475     // Clear to force a refresh
1476     unset($USER->mycourses);
1479 /**
1480  * A convenience function to completely reload all the capabilities
1481  * for the current user when roles have been updated in a relevant
1482  * context -- but PRESERVING switchroles and loginas.
1483  *
1484  * That is - completely transparent to the user.
1485  *
1486  * Note: rewrites $USER->access completely.
1487  *
1488  * @global object
1489  * @global object
1490  */
1491 function reload_all_capabilities() {
1492     global $USER, $DB;
1494     // error_log("reloading");
1495     // copy switchroles
1496     $sw = array();
1497     if (isset($USER->access['rsw'])) {
1498         $sw = $USER->access['rsw'];
1499         // error_log(print_r($sw,1));
1500     }
1502     unset($USER->access);
1503     unset($USER->mycourses);
1505     load_all_capabilities();
1507     foreach ($sw as $path => $roleid) {
1508         $context = $DB->get_record('context', array('path'=>$path));
1509         role_switch($roleid, $context);
1510     }
1514 /**
1515  * Adds a temp role to an accessdata array.
1516  *
1517  * Useful for the "temporary guest" access
1518  * we grant to logged-in users.
1519  *
1520  * Note - assumes a course context!
1521  *
1522  * @param object $content
1523  * @param int $roleid
1524  * @param array $accessdata
1525  * @return array Returns access data
1526  */
1527 function load_temp_role($context, $roleid, array $accessdata) {
1528     global $CFG, $DB;
1530     //
1531     // Load rdefs for the role in -
1532     // - this context
1533     // - all the parents
1534     // - and below - IOWs overrides...
1535     //
1537     // turn the path into a list of context ids
1538     $contexts = substr($context->path, 1); // kill leading slash
1539     $contexts = str_replace('/', ',', $contexts);
1541     $sql = "SELECT ctx.path, rc.capability, rc.permission
1542               FROM {context} ctx
1543               JOIN {role_capabilities} rc
1544                    ON rc.contextid=ctx.id
1545              WHERE (ctx.id IN ($contexts)
1546                     OR ctx.path LIKE ?)
1547                    AND rc.roleid = ?
1548           ORDER BY ctx.depth, ctx.path";
1549     $params = array($context->path."/%", $roleid);
1550     if ($rs = $DB->get_recordset_sql($sql, $params)) {
1551         foreach ($rs as $rd) {
1552             $k = "{$rd->path}:{$roleid}";
1553             $accessdata['rdef'][$k][$rd->capability] = $rd->permission;
1554         }
1555         $rs->close();
1556     }
1558     //
1559     // Say we loaded everything for the course context
1560     // - which we just did - if the user gets a proper
1561     // RA in this session, this data will need to be reloaded,
1562     // but that is handled by the complete accessdata reload
1563     //
1564     array_push($accessdata['loaded'], $context->path);
1566     //
1567     // Add the ghost RA
1568     //
1569     if (isset($accessdata['ra'][$context->path])) {
1570         array_push($accessdata['ra'][$context->path], $roleid);
1571     } else {
1572         $accessdata['ra'][$context->path] = array($roleid);
1573     }
1575     return $accessdata;
1578 /**
1579  * Removes any extra guest roels from accessdata
1580  * @param object $context
1581  * @param array $accessdata
1582  * @return array access data
1583  */
1584 function remove_temp_roles($context, array $accessdata) {
1585     global $DB, $USER;
1586     $sql = "SELECT DISTINCT ra.roleid AS id
1587               FROM {role_assignments} ra
1588              WHERE ra.contextid = :contextid AND ra.userid = :userid";
1589     $ras = $DB->get_records_sql($sql, array('contextid'=>$context->id, 'userid'=>$USER->id));
1591     $accessdata['ra'][$context->path] = array_keys($ras);
1592     return $accessdata;
1595 /**
1596  * Returns array of all role archetypes.
1597  *
1598  * @return array
1599  */
1600 function get_role_archetypes() {
1601     return array(
1602         'manager'        => 'manager',
1603         'coursecreator'  => 'coursecreator',
1604         'editingteacher' => 'editingteacher',
1605         'teacher'        => 'teacher',
1606         'student'        => 'student',
1607         'guest'          => 'guest',
1608         'user'           => 'user',
1609         'frontpage'      => 'frontpage'
1610     );
1613 /**
1614  * Assign the defaults found in this capability definition to roles that have
1615  * the corresponding legacy capabilities assigned to them.
1616  *
1617  * @param string $capability
1618  * @param array $legacyperms an array in the format (example):
1619  *                      'guest' => CAP_PREVENT,
1620  *                      'student' => CAP_ALLOW,
1621  *                      'teacher' => CAP_ALLOW,
1622  *                      'editingteacher' => CAP_ALLOW,
1623  *                      'coursecreator' => CAP_ALLOW,
1624  *                      'manager' => CAP_ALLOW
1625  * @return boolean success or failure.
1626  */
1627 function assign_legacy_capabilities($capability, $legacyperms) {
1629     $archetypes = get_role_archetypes();
1631     foreach ($legacyperms as $type => $perm) {
1633         $systemcontext = get_context_instance(CONTEXT_SYSTEM);
1634         if ($type === 'admin') {
1635             debugging('Legacy type admin in access.php was renamed to manager, please update the code.');
1636             $type = 'manager';
1637         }
1639         if (!array_key_exists($type, $archetypes)) {
1640             print_error('invalidlegacy', '', '', $type);
1641         }
1643         if ($roles = get_archetype_roles($type)) {
1644             foreach ($roles as $role) {
1645                 // Assign a site level capability.
1646                 if (!assign_capability($capability, $perm, $role->id, $systemcontext->id)) {
1647                     return false;
1648                 }
1649             }
1650         }
1651     }
1652     return true;
1655 /**
1656  * @param object $capability a capability - a row from the capabilities table.
1657  * @return boolean whether this capability is safe - that is, whether people with the
1658  *      safeoverrides capability should be allowed to change it.
1659  */
1660 function is_safe_capability($capability) {
1661     return !((RISK_DATALOSS | RISK_MANAGETRUST | RISK_CONFIG | RISK_XSS | RISK_PERSONAL) & $capability->riskbitmask);
1664 /**********************************
1665  * Context Manipulation functions *
1666  **********************************/
1668 /**
1669  * Context creation - internal implementation.
1670  *
1671  * Create a new context record for use by all roles-related stuff
1672  * assumes that the caller has done the homework.
1673  *
1674  * DO NOT CALL THIS DIRECTLY, instead use {@link get_context_instance}!
1675  *
1676  * @param int $contextlevel
1677  * @param int $instanceid
1678  * @param int $strictness
1679  * @return object newly created context
1680  */
1681 function create_context($contextlevel, $instanceid, $strictness=IGNORE_MISSING) {
1683     global $CFG, $DB;
1685     if ($contextlevel == CONTEXT_SYSTEM) {
1686         return create_system_context();
1687     }
1689     $context = new object();
1690     $context->contextlevel = $contextlevel;
1691     $context->instanceid = $instanceid;
1693     // Define $context->path based on the parent
1694     // context. In other words... Who is your daddy?
1695     $basepath  = '/' . SYSCONTEXTID;
1696     $basedepth = 1;
1698     $result = true;
1699     $error_message = NULL;
1701     switch ($contextlevel) {
1702         case CONTEXT_COURSECAT:
1703             $sql = "SELECT ctx.path, ctx.depth
1704                       FROM {context}           ctx
1705                       JOIN {course_categories} cc
1706                            ON (cc.parent=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT.")
1707                      WHERE cc.id=?";
1708             $params = array($instanceid);
1709             if ($p = $DB->get_record_sql($sql, $params)) {
1710                 $basepath  = $p->path;
1711                 $basedepth = $p->depth;
1712             } else if ($category = $DB->get_record('course_categories', array('id'=>$instanceid), '*', $strictness)) {
1713                 if (empty($category->parent)) {
1714                     // ok - this is a top category
1715                 } else if ($parent = get_context_instance(CONTEXT_COURSECAT, $category->parent)) {
1716                     $basepath  = $parent->path;
1717                     $basedepth = $parent->depth;
1718                 } else {
1719                     // wrong parent category - no big deal, this can be fixed later
1720                     $basepath  = NULL;
1721                     $basedepth = 0;
1722                 }
1723             } else {
1724                 // incorrect category id
1725                 $error_message = "incorrect course category id ($instanceid)";
1726                 $result = false;
1727             }
1728             break;
1730         case CONTEXT_COURSE:
1731             $sql = "SELECT ctx.path, ctx.depth
1732                       FROM {context} ctx
1733                       JOIN {course}  c
1734                            ON (c.category=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSECAT.")
1735                      WHERE c.id=? AND c.id !=" . SITEID;
1736             $params = array($instanceid);
1737             if ($p = $DB->get_record_sql($sql, $params)) {
1738                 $basepath  = $p->path;
1739                 $basedepth = $p->depth;
1740             } else if ($course = $DB->get_record('course', array('id'=>$instanceid), '*', $strictness)) {
1741                 if ($course->id == SITEID) {
1742                     //ok - no parent category
1743                 } else if ($parent = get_context_instance(CONTEXT_COURSECAT, $course->category)) {
1744                     $basepath  = $parent->path;
1745                     $basedepth = $parent->depth;
1746                 } else {
1747                     // wrong parent category of course - no big deal, this can be fixed later
1748                     $basepath  = NULL;
1749                     $basedepth = 0;
1750                 }
1751             } else if ($instanceid == SITEID) {
1752                 // no errors for missing site course during installation
1753                 return false;
1754             } else {
1755                 // incorrect course id
1756                 $error_message = "incorrect course id ($instanceid)";
1757                 $result = false;
1758             }
1759             break;
1761         case CONTEXT_MODULE:
1762             $sql = "SELECT ctx.path, ctx.depth
1763                       FROM {context}        ctx
1764                       JOIN {course_modules} cm
1765                            ON (cm.course=ctx.instanceid AND ctx.contextlevel=".CONTEXT_COURSE.")
1766                      WHERE cm.id=?";
1767             $params = array($instanceid);
1768             if ($p = $DB->get_record_sql($sql, $params)) {
1769                 $basepath  = $p->path;
1770                 $basedepth = $p->depth;
1771             } else if ($cm = $DB->get_record('course_modules', array('id'=>$instanceid), '*', $strictness)) {
1772                 if ($parent = get_context_instance(CONTEXT_COURSE, $cm->course, $strictness)) {
1773                     $basepath  = $parent->path;
1774                     $basedepth = $parent->depth;
1775                 } else {
1776                     // course does not exist - modules can not exist without a course
1777                     $error_message = "course does not exist ($cm->course) - modules can not exist without a course";
1778                     $result = false;
1779                 }
1780             } else {
1781                 // cm does not exist
1782                 $error_message = "cm with id $instanceid does not exist";
1783                 $result = false;
1784             }
1785             break;
1787         case CONTEXT_BLOCK:
1788             $sql = "SELECT ctx.path, ctx.depth
1789                       FROM {context} ctx
1790                       JOIN {block_instances} bi ON (bi.parentcontextid=ctx.id)
1791                      WHERE bi.id = ?";
1792             $params = array($instanceid, CONTEXT_COURSE);
1793             if ($p = $DB->get_record_sql($sql, $params, '*', $strictness)) {
1794                 $basepath  = $p->path;
1795                 $basedepth = $p->depth;
1796             } else {
1797                 // block does not exist
1798                 $error_message = 'block or parent context does not exist';
1799                 $result = false;
1800             }
1801             break;
1802         case CONTEXT_USER:
1803             // default to basepath
1804             break;
1805     }
1807     // if grandparents unknown, maybe rebuild_context_path() will solve it later
1808     if ($basedepth != 0) {
1809         $context->depth = $basedepth+1;
1810     }
1812     if (!$result) {
1813         debugging('Error: could not insert new context level "'.
1814                   s($contextlevel).'", instance "'.
1815                   s($instanceid).'". ' . $error_message);
1817         return false;
1818     }
1820     $id = $DB->insert_record('context', $context);
1821     // can't set the full path till we know the id!
1822     if ($basedepth != 0 and !empty($basepath)) {
1823         $DB->set_field('context', 'path', $basepath.'/'. $id, array('id'=>$id));
1824     }
1825     return get_context_instance_by_id($id);
1828 /**
1829  * Returns system context or NULL if can not be created yet.
1830  *
1831  * @todo can not use get_record() because we do not know if query failed :-(
1832  * switch to get_record() later
1833  *
1834  * @global object
1835  * @global object
1836  * @param bool $cache use caching
1837  * @return mixed system context or NULL
1838  */
1839 function get_system_context($cache=true) {
1840     global $DB, $ACCESSLIB_PRIVATE;
1841     if ($cache and defined('SYSCONTEXTID')) {
1842         if (is_null($ACCESSLIB_PRIVATE->systemcontext)) {
1843             $ACCESSLIB_PRIVATE->systemcontext = new object();
1844             $ACCESSLIB_PRIVATE->systemcontext->id           = SYSCONTEXTID;
1845             $ACCESSLIB_PRIVATE->systemcontext->contextlevel = CONTEXT_SYSTEM;
1846             $ACCESSLIB_PRIVATE->systemcontext->instanceid   = 0;
1847             $ACCESSLIB_PRIVATE->systemcontext->path         = '/'.SYSCONTEXTID;
1848             $ACCESSLIB_PRIVATE->systemcontext->depth        = 1;
1849         }
1850         return $ACCESSLIB_PRIVATE->systemcontext;
1851     }
1852     try {
1853         $context = $DB->get_record('context', array('contextlevel'=>CONTEXT_SYSTEM));
1854     } catch (dml_exception $e) {
1855         //table does not exist yet, sorry
1856         return NULL;
1857     }
1859     if (!$context) {
1860         $context = new object();
1861         $context->contextlevel = CONTEXT_SYSTEM;
1862         $context->instanceid   = 0;
1863         $context->depth        = 1;
1864         $context->path         = NULL; //not known before insert
1866         try {
1867             $context->id = $DB->insert_record('context', $context);
1868         } catch (dml_exception $e) {
1869             // can not create context yet, sorry
1870             return NULL;
1871         }
1872     }
1874     if (!isset($context->depth) or $context->depth != 1 or $context->instanceid != 0 or $context->path != '/'.$context->id) {
1875         $context->instanceid   = 0;
1876         $context->path         = '/'.$context->id;
1877         $context->depth        = 1;
1878         $DB->update_record('context', $context);
1879     }
1881     if (!defined('SYSCONTEXTID')) {
1882         define('SYSCONTEXTID', $context->id);
1883     }
1885     $ACCESSLIB_PRIVATE->systemcontext = $context;
1886     return $ACCESSLIB_PRIVATE->systemcontext;
1889 /**
1890  * Remove a context record and any dependent entries,
1891  * removes context from static context cache too
1892  *
1893  * @param int $level
1894  * @param int $instanceid
1895  * @return bool returns true or throws an exception
1896  */
1897 function delete_context($contextlevel, $instanceid) {
1898     global $DB, $ACCESSLIB_PRIVATE, $CFG;
1900     // do not use get_context_instance(), because the related object might not exist,
1901     // or the context does not exist yet and it would be created now
1902     if ($context = $DB->get_record('context', array('contextlevel'=>$contextlevel, 'instanceid'=>$instanceid))) {
1903         $DB->delete_records('role_assignments', array('contextid'=>$context->id));
1904         $DB->delete_records('role_capabilities', array('contextid'=>$context->id));
1905         $DB->delete_records('context', array('id'=>$context->id));
1906         $DB->delete_records('role_names', array('contextid'=>$context->id));
1908         // delete all files attached to this context
1909         $fs = get_file_storage();
1910         $fs->delete_area_files($context->id);
1912         // do not mark dirty contexts if parents unknown
1913         if (!is_null($context->path) and $context->depth > 0) {
1914             mark_context_dirty($context->path);
1915         }
1917         // purge static context cache if entry present
1918         unset($ACCESSLIB_PRIVATE->contexts[$contextlevel][$instanceid]);
1919         unset($ACCESSLIB_PRIVATE->contextsbyid[$context->id]);
1921         blocks_delete_all_for_context($context->id);
1922         filter_delete_all_for_context($context->id);
1923     }
1925     return true;
1928 /**
1929  * Precreates all contexts including all parents
1930  *
1931  * @global object
1932  * @param int $contextlevel empty means all
1933  * @param bool $buildpaths update paths and depths
1934  * @return void
1935  */
1936 function create_contexts($contextlevel=NULL, $buildpaths=true) {
1937     global $DB;
1939     //make sure system context exists
1940     $syscontext = get_system_context(false);
1942     if (empty($contextlevel) or $contextlevel == CONTEXT_COURSECAT
1943                              or $contextlevel == CONTEXT_COURSE
1944                              or $contextlevel == CONTEXT_MODULE
1945                              or $contextlevel == CONTEXT_BLOCK) {
1946         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1947                 SELECT ".CONTEXT_COURSECAT.", cc.id
1948                   FROM {course}_categories cc
1949                  WHERE NOT EXISTS (SELECT 'x'
1950                                      FROM {context} cx
1951                                     WHERE cc.id = cx.instanceid AND cx.contextlevel=".CONTEXT_COURSECAT.")";
1952         $DB->execute($sql);
1954     }
1956     if (empty($contextlevel) or $contextlevel == CONTEXT_COURSE
1957                              or $contextlevel == CONTEXT_MODULE
1958                              or $contextlevel == CONTEXT_BLOCK) {
1959         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1960                 SELECT ".CONTEXT_COURSE.", c.id
1961                   FROM {course} c
1962                  WHERE NOT EXISTS (SELECT 'x'
1963                                      FROM {context} cx
1964                                     WHERE c.id = cx.instanceid AND cx.contextlevel=".CONTEXT_COURSE.")";
1965         $DB->execute($sql);
1967     }
1969     if (empty($contextlevel) or $contextlevel == CONTEXT_MODULE
1970                              or $contextlevel == CONTEXT_BLOCK) {
1971         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1972                 SELECT ".CONTEXT_MODULE.", cm.id
1973                   FROM {course}_modules cm
1974                  WHERE NOT EXISTS (SELECT 'x'
1975                                      FROM {context} cx
1976                                     WHERE cm.id = cx.instanceid AND cx.contextlevel=".CONTEXT_MODULE.")";
1977         $DB->execute($sql);
1978     }
1980     if (empty($contextlevel) or $contextlevel == CONTEXT_USER
1981                              or $contextlevel == CONTEXT_BLOCK) {
1982         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1983                 SELECT ".CONTEXT_USER.", u.id
1984                   FROM {user} u
1985                  WHERE u.deleted=0
1986                    AND NOT EXISTS (SELECT 'x'
1987                                      FROM {context} cx
1988                                     WHERE u.id = cx.instanceid AND cx.contextlevel=".CONTEXT_USER.")";
1989         $DB->execute($sql);
1991     }
1993     if (empty($contextlevel) or $contextlevel == CONTEXT_BLOCK) {
1994         $sql = "INSERT INTO {context} (contextlevel, instanceid)
1995                 SELECT ".CONTEXT_BLOCK.", bi.id
1996                   FROM {block_instances} bi
1997                  WHERE NOT EXISTS (SELECT 'x'
1998                                      FROM {context} cx
1999                                     WHERE bi.id = cx.instanceid AND cx.contextlevel=".CONTEXT_BLOCK.")";
2000         $DB->execute($sql);
2001     }
2003     if ($buildpaths) {
2004         build_context_path(false);
2005     }
2008 /**
2009  * Remove stale context records
2010  *
2011  * @global object
2012  * @return bool
2013  */
2014 function cleanup_contexts() {
2015     global $DB;
2017     $sql = "  SELECT c.contextlevel,
2018                      c.instanceid AS instanceid
2019                 FROM {context} c
2020                 LEFT OUTER JOIN {course}_categories t
2021                      ON c.instanceid = t.id
2022                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_COURSECAT."
2023             UNION
2024               SELECT c.contextlevel,
2025                      c.instanceid
2026                 FROM {context} c
2027                 LEFT OUTER JOIN {course} t
2028                      ON c.instanceid = t.id
2029                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_COURSE."
2030             UNION
2031               SELECT c.contextlevel,
2032                      c.instanceid
2033                 FROM {context} c
2034                 LEFT OUTER JOIN {course}_modules t
2035                      ON c.instanceid = t.id
2036                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_MODULE."
2037             UNION
2038               SELECT c.contextlevel,
2039                      c.instanceid
2040                 FROM {context} c
2041                 LEFT OUTER JOIN {user} t
2042                      ON c.instanceid = t.id
2043                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_USER."
2044             UNION
2045               SELECT c.contextlevel,
2046                      c.instanceid
2047                 FROM {context} c
2048                 LEFT OUTER JOIN {block_instances} t
2049                      ON c.instanceid = t.id
2050                WHERE t.id IS NULL AND c.contextlevel = ".CONTEXT_BLOCK."
2051            ";
2053     // transactions used only for performance reasons here
2054     $transaction = $DB->start_delegated_transaction();
2056     if ($rs = $DB->get_recordset_sql($sql)) {
2057         foreach ($rs as $ctx) {
2058             delete_context($ctx->contextlevel, $ctx->instanceid);
2059         }
2060         $rs->close();
2061     }
2063     $transaction->allow_commit();
2064     return true;
2067 /**
2068  * Preloads all contexts relating to a course: course, modules. Block contexts
2069  * are no longer loaded here. The contexts for all the blocks on the current
2070  * page are now efficiently loaded by {@link block_manager::load_blocks()}.
2071  *
2072  * @param int $courseid Course ID
2073  * @return void
2074  */
2075 function preload_course_contexts($courseid) {
2076     global $DB, $ACCESSLIB_PRIVATE;
2078     // Users can call this multiple times without doing any harm
2079     global $ACCESSLIB_PRIVATE;
2080     if (array_key_exists($courseid, $ACCESSLIB_PRIVATE->preloadedcourses)) {
2081         return;
2082     }
2084     $params = array($courseid, $courseid, $courseid);
2085     $sql = "SELECT x.instanceid, x.id, x.contextlevel, x.path, x.depth
2086               FROM {course_modules} cm
2087               JOIN {context} x ON x.instanceid=cm.id
2088              WHERE cm.course=? AND x.contextlevel=".CONTEXT_MODULE."
2090          UNION ALL
2092             SELECT x.instanceid, x.id, x.contextlevel, x.path, x.depth
2093               FROM {context} x
2094              WHERE x.instanceid=? AND x.contextlevel=".CONTEXT_COURSE."";
2096     $rs = $DB->get_recordset_sql($sql, $params);
2097     foreach($rs as $context) {
2098         cache_context($context);
2099     }
2100     $rs->close();
2101     $ACCESSLIB_PRIVATE->preloadedcourses[$courseid] = true;
2104 /**
2105  * Get the context instance as an object. This function will create the
2106  * context instance if it does not exist yet.
2107  *
2108  * @todo Remove code branch from previous fix MDL-9016 which is no longer needed
2109  *
2110  * @param integer $level The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE.
2111  * @param integer $instance The instance id. For $level = CONTEXT_COURSE, this would be $course->id,
2112  *      for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0
2113  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
2114  *      MUST_EXIST means throw exception if no record or multiple records found
2115  * @return object The context object.
2116  */
2117 function get_context_instance($contextlevel, $instance=0, $strictness=IGNORE_MISSING) {
2119     global $DB, $ACCESSLIB_PRIVATE;
2120     static $allowed_contexts = array(CONTEXT_SYSTEM, CONTEXT_USER, CONTEXT_COURSECAT, CONTEXT_COURSE, CONTEXT_MODULE, CONTEXT_BLOCK);
2122 /// System context has special cache
2123     if ($contextlevel == CONTEXT_SYSTEM) {
2124         return get_system_context();
2125     }
2127 /// check allowed context levels
2128     if (!in_array($contextlevel, $allowed_contexts)) {
2129         // fatal error, code must be fixed - probably typo or switched parameters
2130         print_error('invalidcourselevel');
2131     }
2133     if (!is_array($instance)) {
2134     /// Check the cache
2135         if (isset($ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance])) {  // Already cached
2136             return $ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance];
2137         }
2139     /// Get it from the database, or create it
2140         if (!$context = $DB->get_record('context', array('contextlevel'=>$contextlevel, 'instanceid'=>$instance))) {
2141             $context = create_context($contextlevel, $instance, $strictness);
2142         }
2144     /// Only add to cache if context isn't empty.
2145         if (!empty($context)) {
2146             cache_context($context);
2147         }
2149         return $context;
2150     }
2153 /// ok, somebody wants to load several contexts to save some db queries ;-)
2154     $instances = $instance;
2155     $result = array();
2157     foreach ($instances as $key=>$instance) {
2158     /// Check the cache first
2159         if (isset($ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance])) {  // Already cached
2160             $result[$instance] = $ACCESSLIB_PRIVATE->contexts[$contextlevel][$instance];
2161             unset($instances[$key]);
2162             continue;
2163         }
2164     }
2166     if ($instances) {
2167         list($instanceids, $params) = $DB->get_in_or_equal($instances, SQL_PARAMS_QM);
2168         array_unshift($params, $contextlevel);
2169         $sql = "SELECT instanceid, id, contextlevel, path, depth
2170                   FROM {context}
2171                  WHERE contextlevel=? AND instanceid $instanceids";
2173         if (!$contexts = $DB->get_records_sql($sql, $params)) {
2174             $contexts = array();
2175         }
2177         foreach ($instances as $instance) {
2178             if (isset($contexts[$instance])) {
2179                 $context = $contexts[$instance];
2180             } else {
2181                 $context = create_context($contextlevel, $instance);
2182             }
2184             if (!empty($context)) {
2185                 cache_context($context);
2186             }
2188             $result[$instance] = $context;
2189         }
2190     }
2192     return $result;
2196 /**
2197  * Get a context instance as an object, from a given context id.
2198  *
2199  * @param mixed $id a context id or array of ids.
2200  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
2201  *                        MUST_EXIST means throw exception if no record or multiple records found
2202  * @return mixed object, array of the context object, or false.
2203  */
2204 function get_context_instance_by_id($id, $strictness=IGNORE_MISSING) {
2205     global $DB, $ACCESSLIB_PRIVATE;
2207     if ($id == SYSCONTEXTID) {
2208         return get_system_context();
2209     }
2211     if (isset($ACCESSLIB_PRIVATE->contextsbyid[$id])) {  // Already cached
2212         return $ACCESSLIB_PRIVATE->contextsbyid[$id];
2213     }
2215     if ($context = $DB->get_record('context', array('id'=>$id), '*', $strictness)) {
2216         cache_context($context);
2217         return $context;
2218     }
2220     return false;
2224 /**
2225  * Get the local override (if any) for a given capability in a role in a context
2226  *
2227  * @global object
2228  * @param int $roleid
2229  * @param int $contextid
2230  * @param string $capability
2231  */
2232 function get_local_override($roleid, $contextid, $capability) {
2233     global $DB;
2234     return $DB->get_record('role_capabilities', array('roleid'=>$roleid, 'capability'=>$capability, 'contextid'=>$contextid));
2237 /**
2238  * Returns context instance plus related course and cm instances
2239  * @param int $contextid
2240  * @return array of ($context, $course, $cm)
2241  */
2242 function get_context_info_array($contextid) {
2243     global $DB;
2245     $context = get_context_instance_by_id($contextid, MUST_EXIST);
2246     $course  = NULL;
2247     $cm      = NULL;
2249     if ($context->contextlevel == CONTEXT_COURSE) {
2250         $course = $DB->get_record('course', array('id'=>$context->instanceid), '*', MUST_EXIST);
2252     } else if ($context->contextlevel == CONTEXT_MODULE) {
2253         $cm = get_coursemodule_from_id('', $context->instanceid, 0, false, MUST_EXIST);
2254         $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
2256     } else if ($context->contextlevel == CONTEXT_BLOCK) {
2257         $parentcontexts = get_parent_contexts($context, false);
2258         $parent = reset($parentcontexts);
2259         $parent = get_context_instance_by_id($parent);
2261         if ($parent->contextlevel == CONTEXT_COURSE) {
2262             $course = $DB->get_record('course', array('id'=>$parent->instanceid), '*', MUST_EXIST);
2263         } else if ($parent->contextlevel == CONTEXT_MODULE) {
2264             $cm = get_coursemodule_from_id('', $parent->instanceid, 0, false, MUST_EXIST);
2265             $course = $DB->get_record('course', array('id'=>$cm->course), '*', MUST_EXIST);
2266         }
2267     }
2269     return array($context, $course, $cm);
2272 /**
2273  * Returns current course id or null if outside of course based on context parameter.
2274  * @param object $context
2275  * @return int|bool related course id or false
2276  */
2277 function get_courseid_from_context($context) {
2278     if ($context->contextlevel == CONTEXT_COURSE) {
2279         return $context->instanceid;
2280     }
2282     if ($context->contextlevel < CONTEXT_COURSE) {
2283         return false;
2284     }
2286     if ($context->contextlevel == CONTEXT_MODULE) {
2287         $parentcontexts = get_parent_contexts($context, false);
2288         $parent = reset($parentcontexts);
2289         $parent = get_context_instance_by_id($parent);
2290         return $parent->instanceid;
2291     }
2293     if ($context->contextlevel == CONTEXT_BLOCK) {
2294         $parentcontexts = get_parent_contexts($context, false);
2295         $parent = reset($parentcontexts);
2296         return get_courseid_from_context($parent);
2297     }
2299     return false;
2303 //////////////////////////////////////
2304 //    DB TABLE RELATED FUNCTIONS    //
2305 //////////////////////////////////////
2307 /**
2308  * function that creates a role
2309  *
2310  * @global object
2311  * @param string $name role name
2312  * @param string $shortname role short name
2313  * @param string $description role description
2314  * @param string $archetype
2315  * @return mixed id or dml_exception
2316  */
2317 function create_role($name, $shortname, $description, $archetype='') {
2318     global $DB;
2320     if (strpos($archetype, 'moodle/legacy:') !== false) {
2321         throw new coding_exception('Use new role archetype parameter in create_role() instead of old legacy capabilities.');
2322     }
2324     // verify role archetype actually exists
2325     $archetypes = get_role_archetypes();
2326     if (empty($archetypes[$archetype])) {
2327         $archetype = '';
2328     }
2330     // Get the system context.
2331     $context = get_context_instance(CONTEXT_SYSTEM);
2333     // Insert the role record.
2334     $role = new object();
2335     $role->name        = $name;
2336     $role->shortname   = $shortname;
2337     $role->description = $description;
2338     $role->archetype   = $archetype;
2340     //find free sortorder number
2341     $role->sortorder = $DB->get_field('role', 'MAX(sortorder) + 1', array());
2342     if (empty($role->sortorder)) {
2343         $role->sortorder = 1;
2344     }
2345     $id = $DB->insert_record('role', $role);
2347     return $id;
2350 /**
2351  * Function that deletes a role and cleanups up after it
2352  *
2353  * @param int $roleid id of role to delete
2354  * @return bool always true
2355  */
2356 function delete_role($roleid) {
2357     global $CFG, $DB;
2359     // first unssign all users
2360     role_unassign_all(array('roleid'=>$roleid));
2362     // cleanup all references to this role, ignore errors
2363     $DB->delete_records('role_capabilities',   array('roleid'=>$roleid));
2364     $DB->delete_records('role_allow_assign',   array('roleid'=>$roleid));
2365     $DB->delete_records('role_allow_assign',   array('allowassign'=>$roleid));
2366     $DB->delete_records('role_allow_override', array('roleid'=>$roleid));
2367     $DB->delete_records('role_allow_override', array('allowoverride'=>$roleid));
2368     $DB->delete_records('role_names',          array('roleid'=>$roleid));
2369     $DB->delete_records('role_context_levels', array('roleid'=>$roleid));
2371     // finally delete the role itself
2372     // get this before the name is gone for logging
2373     $rolename = $DB->get_field('role', 'name', array('id'=>$roleid));
2375     $DB->delete_records('role', array('id'=>$roleid));
2377     add_to_log(SITEID, 'role', 'delete', 'admin/roles/action=delete&roleid='.$roleid, $rolename, '');
2379     return true;
2382 /**
2383  * Function to write context specific overrides, or default capabilities.
2384  *
2385  * @global object
2386  * @global object
2387  * @param string module string name
2388  * @param string capability string name
2389  * @param int contextid context id
2390  * @param int roleid role id
2391  * @param int permission int 1,-1 or -1000 should not be writing if permission is 0
2392  * @return bool
2393  */
2394 function assign_capability($capability, $permission, $roleid, $contextid, $overwrite=false) {
2395     global $USER, $DB;
2397     if (empty($permission) || $permission == CAP_INHERIT) { // if permission is not set
2398         unassign_capability($capability, $roleid, $contextid);
2399         return true;
2400     }
2402     $existing = $DB->get_record('role_capabilities', array('contextid'=>$contextid, 'roleid'=>$roleid, 'capability'=>$capability));
2404     if ($existing and !$overwrite) {   // We want to keep whatever is there already
2405         return true;
2406     }
2408     $cap = new object;
2409     $cap->contextid = $contextid;
2410     $cap->roleid = $roleid;
2411     $cap->capability = $capability;
2412     $cap->permission = $permission;
2413     $cap->timemodified = time();
2414     $cap->modifierid = empty($USER->id) ? 0 : $USER->id;
2416     if ($existing) {
2417         $cap->id = $existing->id;
2418         $DB->update_record('role_capabilities', $cap);
2419     } else {
2420         $c = $DB->get_record('context', array('id'=>$contextid));
2421         $DB->insert_record('role_capabilities', $cap);
2422     }
2423     return true;
2426 /**
2427  * Unassign a capability from a role.
2428  *
2429  * @global object
2430  * @param int $roleid the role id
2431  * @param string $capability the name of the capability
2432  * @return boolean success or failure
2433  */
2434 function unassign_capability($capability, $roleid, $contextid=NULL) {
2435     global $DB;
2437     if (!empty($contextid)) {
2438         // delete from context rel, if this is the last override in this context
2439         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid, 'contextid'=>$contextid));
2440     } else {
2441         $DB->delete_records('role_capabilities', array('capability'=>$capability, 'roleid'=>$roleid));
2442     }
2443     return true;
2447 /**
2448  * Get the roles that have a given capability assigned to it
2449  * Get the roles that have a given capability assigned to it. This function
2450  * does not resolve the actual permission of the capability. It just checks
2451  * for assignment only.
2452  *
2453  * @global object
2454  * @global object
2455  * @param string $capability - capability name (string)
2456  * @param string $permission - optional, the permission defined for this capability
2457  *                      either CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT. Defaults to NULL
2458  * @param object $contect
2459  * @return mixed array or role objects
2460  */
2461 function get_roles_with_capability($capability, $permission=NULL, $context=NULL) {
2462     global $CFG, $DB;
2464     $params = array();
2466     if ($context) {
2467         if ($contexts = get_parent_contexts($context)) {
2468             $listofcontexts = '('.implode(',', $contexts).')';
2469         } else {
2470             $sitecontext = get_context_instance(CONTEXT_SYSTEM);
2471             $listofcontexts = '('.$sitecontext->id.')'; // must be site
2472         }
2473         $contextstr = "AND (rc.contextid = ? OR  rc.contextid IN $listofcontexts)";
2474         $params[] = $context->id;
2475     } else {
2476         $contextstr = '';
2477     }
2479     $selectroles = "SELECT r.*
2480                       FROM {role} r,
2481                            {role_capabilities} rc
2482                      WHERE rc.capability = ?
2483                            AND rc.roleid = r.id $contextstr";
2485     array_unshift($params, $capability);
2487     if (isset($permission)) {
2488         $selectroles .= " AND rc.permission = ?";
2489         $params[] = $permission;
2490     }
2491     return $DB->get_records_sql($selectroles, $params);
2495 /**
2496  * This function makes a role-assignment (a role for a user in a particular context)
2497  *
2498  * @param int $roleid the role of the id
2499  * @param int $userid userid
2500  * @param int $contextid id of the context
2501  * @param string $component example 'enrol_ldap', defaults to '' which means manual assignment,
2502  * @prama int $itemid id of enrolment/auth plugin
2503  * @param string $timemodified defaults to current time
2504  * @return int new/existing id of the assignment
2505  */
2506 function role_assign($roleid, $userid, $contextid, $component = '', $itemid = 0, $timemodified = '') {
2507     global $USER, $CFG, $DB;
2509     // first of all detect if somebody is using old style parameters
2510     if ($contextid === 0 or is_numeric($component)) {
2511         throw new coding_exception('Invalid call to role_assign(), code needs to be updated to use new order of parameters');
2512     }
2514     // now validate all parameters
2515     if (empty($roleid)) {
2516         throw new coding_exception('Invalid call to role_assign(), roleid can not be empty');
2517     }
2519     if (empty($userid)) {
2520         throw new coding_exception('Invalid call to role_assign(), userid can not be empty');
2521     }
2523     if ($itemid) {
2524         if (strpos($component, '_') === false) {
2525             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as"enrol_" when itemid specified', 'component:'.$component);
2526         }
2527     } else {
2528         $itemid = 0;
2529         if ($component !== '' and strpos($component, '_') === false) {
2530             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
2531         }
2532     }
2534     if (!$DB->record_exists('user', array('id'=>$userid, 'deleted'=>0))) {
2535         throw new coding_exception('User ID does not exist or is deleted!', 'userid:'.$userid);
2536         return false;
2537     }
2539     $context = get_context_instance_by_id($contextid, MUST_EXIST);
2541     if (!$timemodified) {
2542         $timemodified = time();
2543     }
2545 /// Check for existing entry
2546     $ras = $DB->get_records('role_assignments', array('roleid'=>$roleid, 'contextid'=>$context->id, 'userid'=>$userid, 'component'=>$component, 'itemid'=>$itemid), 'id');
2548     if ($ras) {
2549         // role already assigned - this should not happen
2550         if (count($ras) > 1) {
2551             //very weird - remove all duplicates!
2552             $ra = array_shift($ras);
2553             foreach ($ras as $r) {
2554                 $DB->delete_records('role_assignments', array('id'=>$r->id));
2555             }
2556         } else {
2557             $ra = reset($ras);
2558         }
2560         // actually there is no need to update, reset anything or trigger any event, so just return
2561         return $ra->id;
2562     }
2564     // Create a new entry
2565     $ra = new object();
2566     $ra->roleid       = $roleid;
2567     $ra->contextid    = $context->id;
2568     $ra->userid       = $userid;
2569     $ra->component    = $component;
2570     $ra->itemid       = $itemid;
2571     $ra->timemodified = $timemodified;
2572     $ra->modifierid   = empty($USER->id) ? 0 : $USER->id;
2574     $ra->id = $DB->insert_record('role_assignments', $ra);
2576     // mark context as dirty - again expensive, but needed
2577     mark_context_dirty($context->path);
2579     if (!empty($USER->id) && $USER->id == $userid) {
2580         // If the user is the current user, then do full reload of capabilities too.
2581         load_all_capabilities();
2582     }
2584     events_trigger('role_assigned', $ra);
2586     return $ra->id;
2589 /**
2590  * Removes one role assignment
2591  *
2592  * @param int $roleid
2593  * @param int  $userid
2594  * @param int  $contextid
2595  * @param string $component
2596  * @param int  $itemid
2597  * @return void
2598  */
2599 function role_unassign($roleid, $userid, $contextid, $component = '', $itemid = 0) {
2600     global $USER, $CFG, $DB;
2602     // first make sure the params make sense
2603     if ($roleid == 0 or $userid == 0 or $contextid == 0) {
2604         throw new coding_exception('Invalid call to role_unassign(), please use role_unassign_all() when removing multiple role assignments');
2605     }
2607     if ($itemid) {
2608         if (strpos($component, '_') === false) {
2609             throw new coding_exception('Invalid call to role_assign(), component must start with plugin type such as "enrol_" when itemid specified', 'component:'.$component);
2610         }
2611     } else {
2612         $itemid = 0;
2613         if ($component !== '' and strpos($component, '_') === false) {
2614             throw new coding_exception('Invalid call to role_assign(), invalid component string', 'component:'.$component);
2615         }
2616     }
2618     role_unassign_all(array('roleid'=>$roleid, 'userid'=>$userid, 'contextid'=>$contextid, 'component'=>$component, 'itemid'=>$itemid), false, false);
2621 /**
2622  * Removes multiple role assignments, parameters may contain:
2623  *   'roleid', 'userid', 'contextid', 'component', 'enrolid'.
2624  *
2625  * @param array $params role assignment parameters
2626  * @param bool $subcontexts unassign in subcontexts too
2627  * @param bool $includmanual include manual role assignments too
2628  * @return void
2629  */
2630 function role_unassign_all(array $params, $subcontexts = false, $includemanual=false) {
2631     global $USER, $CFG, $DB;
2633     if (!$params) {
2634         throw new coding_exception('Missing parameters in role_unsassign_all() call');
2635     }
2637     $allowed = array('roleid', 'userid', 'contextid', 'component', 'itemid');
2638     foreach ($params as $key=>$value) {
2639         if (!in_array($key, $allowed)) {
2640             throw new coding_exception('Unknown role_unsassign_all() parameter key', 'key:'.$key);
2641         }
2642     }
2644     if (isset($params['component']) and $params['component'] !== '' and strpos($params['component'], '_') === false) {
2645         throw new coding_exception('Invalid component paramter in role_unsassign_all() call', 'component:'.$params['component']);
2646     }
2648     if ($includemanual) {
2649         if (!isset($params['component']) or $params['component'] === '') {
2650             throw new coding_exception('include manual parameter requires component parameter in role_unsassign_all() call');
2651         }
2652     }
2654     if ($subcontexts) {
2655         if (empty($params['contextid'])) {
2656             throw new coding_exception('subcontexts paramtere requires component parameter in role_unsassign_all() call');
2657         }
2658     }
2660     $ras = $DB->get_records('role_assignments', $params);
2661     foreach($ras as $ra) {
2662         $DB->delete_records('role_assignments', array('id'=>$ra->id));
2663         if ($context = get_context_instance_by_id($ra->contextid)) {
2664             // this is a bit expensive but necessary
2665             mark_context_dirty($context->path);
2666             /// If the user is the current user, then do full reload of capabilities too.
2667             if (!empty($USER->id) && $USER->id == $ra->userid) {
2668                 load_all_capabilities();
2669             }
2670         }
2671         events_trigger('role_unassigned', $ra);
2672     }
2673     unset($ras);
2675     // process subcontexts
2676     if ($subcontexts and $context = get_context_instance_by_id($params['contextid'])) {
2677         $contexts = get_child_contexts($context);
2678         $mparams = $params;
2679         foreach($contexts as $context) {
2680             $mparams['contextid'] = $context->id;
2681             $ras = $DB->get_records('role_assignments', $mparams);
2682             foreach($ras as $ra) {
2683                 $DB->delete_records('role_assignments', array('id'=>$ra->id));
2684                 // this is a bit expensive but necessary
2685                 mark_context_dirty($context->path);
2686                 /// If the user is the current user, then do full reload of capabilities too.
2687                 if (!empty($USER->id) && $USER->id == $ra->userid) {
2688                     load_all_capabilities();
2689                 }
2690                 events_trigger('role_unassigned', $ra);
2691             }
2692         }
2693     }
2695     // do this once more for all manual role assignments
2696     if ($includemanual) {
2697         $params['component'] = '';
2698         role_unassign_all($params, $subcontexts, false);
2699     }
2703 /**
2704  * Determines if a user is currently logged in
2705  *
2706  * @return bool
2707  */
2708 function isloggedin() {
2709     global $USER;
2711     return (!empty($USER->id));
2714 /**
2715  * Determines if a user is logged in as real guest user with username 'guest'.
2716  *
2717  * @param int|object $user mixed user object or id, $USER if not specified
2718  * @return bool true if user is the real guest user, false if not logged in or other user
2719  */
2720 function isguestuser($user = NULL) {
2721     global $USER, $DB, $CFG;
2723     // make sure we have the user id cached in config table, because we are going to use it a lot
2724     if (empty($CFG->siteguest)) {
2725         if (!$guestid = $DB->get_field('user', 'id', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
2726             // guest does not exist yet, weird
2727             return false;
2728         }
2729         set_config('siteguest', $guestid);
2730     }
2731     if ($user === NULL) {
2732         $user = $USER;
2733     }
2735     if ($user === NULL) {
2736         // happens when setting the $USER
2737         return false;
2739     } else if (is_numeric($user)) {
2740         return ($CFG->siteguest == $user);
2742     } else if (is_object($user)) {
2743         if (empty($user->id)) {
2744             return false; // not logged in means is not be guest
2745         } else {
2746             return ($CFG->siteguest == $user->id);
2747         }
2749     } else {
2750         throw new coding_exception('Invalid user parameter supplied for isguestuser() function!');
2751     }
2754 /**
2755  * Does user have a (temporary or real) guest access to course?
2756  *
2757  * @param object $context
2758  * @param object|int $user
2759  * @return bool
2760  */
2761 function is_guest($context, $user = NULL) {
2762     // first find the course context
2763     $coursecontext = get_course_context($context);
2765     // make sure there is a real user specified
2766     if ($user === NULL) {
2767         $userid = !empty($USER->id) ? $USER->id : 0;
2768     } else {
2769         $userid = !empty($user->id) ? $user->id : $user;
2770     }
2772     if (isguestuser($userid)) {
2773         // can not inspect or be enrolled
2774         return true;
2775     }
2777     if (has_capability('moodle/course:view', $coursecontext, $user)) {
2778         // viewing users appear out of nowhere, they are neither guests nor participants
2779         return false;
2780     }
2782     // consider only real active enrolments here
2783     if (is_enrolled($coursecontext, $user, '', true)) {
2784         return false;
2785     }
2787     return true;
2791 /**
2792  * Returns true if the user has moodle/course:view capability in the course,
2793  * this is intended for admins, managers (aka small admins), inspectors, etc.
2794  *
2795  * @param object $context
2796  * @param int|object $user, if NULL $USER is used
2797  * @param string $withcapability extra capability name
2798  * @return bool
2799  */
2800 function is_viewing($context, $user = NULL, $withcapability = '') {
2801     global $USER;
2803     // first find the course context
2804     $coursecontext = get_course_context($context);
2806     if (isguestuser($user)) {
2807         // can not inspect
2808         return false;
2809     }
2811     if (!has_capability('moodle/course:view', $coursecontext, $user)) {
2812         // admins are allowed to inspect courses
2813         return false;
2814     }
2816     if ($withcapability and !has_capability($withcapability, $context, $user)) {
2817         // site admins always have the capability, but the enrolment above blocks
2818         return false;
2819     }
2821     return true;
2824 /**
2825  * Returns true if user is enrolled (is participating) in course
2826  * this is intended for students and teachers.
2827  *
2828  * @param object $context
2829  * @param int|object $user, if NULL $USER is used, otherwise user object or id expected
2830  * @param string $withcapability extra capability name
2831  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2832  * @return bool
2833  */
2834 function is_enrolled($context, $user = NULL, $withcapability = '', $onlyactive = false) {
2835     global $USER, $DB;
2837     // first find the course context
2838     $coursecontext = get_course_context($context);
2840     // make sure there is a real user specified
2841     if ($user === NULL) {
2842         $userid = !empty($USER->id) ? $USER->id : 0;
2843     } else {
2844         $userid = !empty($user->id) ? $user->id : $user;
2845     }
2847     if (empty($userid)) {
2848         // not-logged-in!
2849         return false;
2850     } else if (isguestuser($userid)) {
2851         // guest account can not be enrolled anywhere
2852         return false;
2853     }
2855     if ($coursecontext->instanceid == SITEID) {
2856         // everybody participates on frontpage
2857     } else {
2858         if ($onlyactive) {
2859             $sql = "SELECT ue.*
2860                       FROM {user_enrolments} ue
2861                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2862                       JOIN {user} u ON u.id = ue.userid
2863                      WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0";
2864             $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE, 'userid'=>$userid, 'courseid'=>$coursecontext->instanceid);
2865             // this result should be very small, better not do the complex time checks in sql for now ;-)
2866             $enrolments = $DB->get_records_sql($sql, $params);
2867             $now = time();
2868             // make sure the enrol period is ok
2869             $result = false;
2870             foreach ($enrolments as $e) {
2871                 if ($e->timestart > $now) {
2872                     continue;
2873                 }
2874                 if ($e->timeend and $e->timeend < $now) {
2875                     continue;
2876                 }
2877                 $result = true;
2878                 break;
2879             }
2880             if (!$result) {
2881                 return false;
2882             }
2884         } else {
2885             // any enrolment is good for us here, even outdated, disabled or inactive
2886             $sql = "SELECT 'x'
2887                       FROM {user_enrolments} ue
2888                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2889                       JOIN {user} u ON u.id = ue.userid
2890                      WHERE ue.userid = :userid AND u.deleted = 0";
2891             $params = array('userid'=>$userid, 'courseid'=>$coursecontext->instanceid);
2892             if (!$DB->record_exists_sql($sql, $params)) {
2893                 return false;
2894             }
2895         }
2896     }
2898     if ($withcapability and !has_capability($withcapability, $context, $userid)) {
2899         return false;
2900     }
2902     return true;
2905 /**
2906  * Returns array with sql code and parameters returning all ids
2907  * of users enrolled into course.
2908  *
2909  * This function is using 'eu[0-9]+_' prefix for table names and parameters.
2910  *
2911  * @param object $context
2912  * @param string $withcapability
2913  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
2914  * @param bool $onlyactive consider only active enrolments in enabled plugins and time restrictions
2915  * @return array list($sql, $params)
2916  */
2917 function get_enrolled_sql($context, $withcapability = '', $groupid = 0, $onlyactive = false) {
2918     global $DB, $CFG;
2920     // use unique prefix just in case somebody makes some SQL magic with the result
2921     static $i = 0;
2922     $i++;
2923     $prefix = 'eu'.$i.'_';
2925     // first find the course context
2926     $coursecontext = get_course_context($context);
2928     $isfrontpage = ($coursecontext->instanceid == SITEID);
2930     $joins  = array();
2931     $wheres = array();
2932     $params = array();
2934     list($contextids, $contextpaths) = get_context_info_list($context);
2936     // get all relevant capability info for all roles
2937     if ($withcapability) {
2938         list($incontexts, $cparams) = $DB->get_in_or_equal($contextids, SQL_PARAMS_NAMED, 'ctx00');
2939         $cparams['cap'] = $withcapability;
2941         $defs = array();
2942         $sql = "SELECT rc.id, rc.roleid, rc.permission, ctx.path
2943                   FROM {role_capabilities} rc
2944                   JOIN {context} ctx on rc.contextid = ctx.id
2945                  WHERE rc.contextid $incontexts AND rc.capability = :cap";
2946         $rcs = $DB->get_records_sql($sql, $cparams);
2947         foreach ($rcs as $rc) {
2948             $defs[$rc->path][$rc->roleid] = $rc->permission;
2949         }
2951         $access = array();
2952         if (!empty($defs)) {
2953             foreach ($contextpaths as $path) {
2954                 if (empty($defs[$path])) {
2955                     continue;
2956                 }
2957                 foreach($defs[$path] as $roleid => $perm) {
2958                     if ($perm == CAP_PROHIBIT) {
2959                         $access[$roleid] = CAP_PROHIBIT;
2960                         continue;
2961                     }
2962                     if (!isset($access[$roleid])) {
2963                         $access[$roleid] = (int)$perm;
2964                     }
2965                 }
2966             }
2967         }
2969         unset($defs);
2971         // make lists of roles that are needed and prohibited
2972         $needed     = array(); // one of these is enough
2973         $prohibited = array(); // must not have any of these
2974         if ($withcapability) {
2975             foreach ($access as $roleid => $perm) {
2976                 if ($perm == CAP_PROHIBIT) {
2977                     unset($needed[$roleid]);
2978                     $prohibited[$roleid] = true;
2979                 } else if ($perm == CAP_ALLOW and empty($prohibited[$roleid])) {
2980                     $needed[$roleid] = true;
2981                 }
2982             }
2983         }
2985         $defaultuserroleid      = isset($CFG->defaultuserroleid) ? $CFG->defaultuserroleid : NULL;
2986         $defaultfrontpageroleid = isset($CFG->defaultfrontpageroleid) ? $CFG->defaultfrontpageroleid : NULL;
2988         $nobody = false;
2990         if ($isfrontpage) {
2991             if (!empty($prohibited[$defaultuserroleid]) or !empty($prohibited[$defaultfrontpageroleid])) {
2992                 $nobody = true;
2993             } else if (!empty($neded[$defaultuserroleid]) or !empty($neded[$defaultfrontpageroleid])) {
2994                 // everybody not having prohibit has the capability
2995                 $needed = array();
2996             } else if (empty($needed)) {
2997                 $nobody = true;
2998             }
2999         } else {
3000             if (!empty($prohibited[$defaultuserroleid])) {
3001                 $nobody = true;
3002             } else if (!empty($neded[$defaultuserroleid])) {
3003                 // everybody not having prohibit has the capability
3004                 $needed = array();
3005             } else if (empty($needed)) {
3006                 $nobody = true;
3007             }
3008         }
3010         if ($nobody) {
3011             // nobody can match so return some SQL that does not return any results
3012             $wheres[] = "1 = 2";
3014         } else {
3016             if ($needed) {
3017                 $ctxids = implode(',', $contextids);
3018                 $roleids = implode(',', array_keys($needed));
3019                 $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))";
3020             }
3022             if ($prohibited) {
3023                 $ctxids = implode(',', $contextids);
3024                 $roleids = implode(',', array_keys($prohibited));
3025                 $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))";
3026                 $wheres[] = "{$prefix}ra4.id IS NULL";
3027             }
3029             if ($groupid) {
3030                 $joins[] = "JOIN {groups_members} {$prefix}gm ON ({$prefix}gm.userid = {$prefix}u.id AND {$prefix}gm.id = :{$prefix}gmid)";
3031                 $params["{$prefix}gmid"] = $groupid;
3032             }
3033         }
3035     }
3037     $wheres[] = "{$prefix}u.deleted = 0 AND {$prefix}u.id <> :{$prefix}guestid";
3038     $params["{$prefix}guestid"] = $CFG->siteguest;
3040     if ($isfrontpage) {
3041         // all users are "enrolled" on the frontpage
3042     } else {
3043         $joins[] = "JOIN {user_enrolments} {$prefix}ue ON {$prefix}ue.userid = {$prefix}u.id";
3044         $joins[] = "JOIN {enrol} {$prefix}e ON ({$prefix}e.id = {$prefix}ue.enrolid AND {$prefix}e.courseid = :{$prefix}courseid)";
3045         $params[$prefix.'courseid'] = $coursecontext->instanceid;
3047         if ($onlyactive) {
3048             $wheres[] = "{$prefix}ue.status = :{$prefix}active AND {$prefix}e.status = :{$prefix}enabled";
3049             $wheres[] = "{$prefix}ue.timestart < :{$prefix}now1 AND ({$prefix}ue.timeend = 0 OR {$prefix}ue.timeend > :{$prefix}now2)";
3050             $now = round(time(), -2); // rounding helps caching in DB
3051             $params = array_merge($params, array($prefix.'enabled'=>ENROL_INSTANCE_ENABLED,
3052                                                  $prefix.'active'=>ENROL_USER_ACTIVE,
3053                                                  $prefix.'now1'=>$now, $prefix.'now2'=>$now));
3054         }
3055     }
3057     $joins = implode("\n", $joins);
3058     $wheres = "WHERE ".implode(" AND ", $wheres);
3060     $sql = "SELECT DISTINCT {$prefix}u.id
3061                FROM {user} {$prefix}u
3062              $joins
3063             $wheres";
3065     return array($sql, $params);
3068 /**
3069  * Returns list of users enrolled into course.
3070  * @param object $context
3071  * @param string $withcapability
3072  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
3073  * @param string $userfields requested user record fields
3074  * @param string $orderby
3075  * @param int $limitfrom return a subset of records, starting at this point (optional, required if $limitnum is set).
3076  * @param int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
3077  * @return array of user records
3078  */
3079 function get_enrolled_users($context, $withcapability = '', $groupid = 0, $userfields = 'u.*', $orderby = '', $limitfrom = 0, $limitnum = 0) {
3080     global $DB;
3082     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid);
3083     $sql = "SELECT $userfields
3084               FROM {user} u
3085               JOIN ($esql) je ON je.id = u.id
3086              WHERE u.deleted = 0";
3088     if ($orderby) {
3089         $sql = "$sql ORDER BY $orderby";
3090     } else {
3091         $sql = "$sql ORDER BY u.lastname ASC, u.firstname ASC";
3092     }
3094     return $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
3097 /**
3098  * Counts list of users enrolled into course (as per above function)
3099  * @param object $context
3100  * @param string $withcapability
3101  * @param int $groupid 0 means ignore groups, any other value limits the result by group id
3102  * @return array of user records
3103  */
3104 function count_enrolled_users($context, $withcapability = '', $groupid = 0) {
3105     global $DB;
3107     list($esql, $params) = get_enrolled_sql($context, $withcapability, $groupid);
3108     $sql = "SELECT count(u.id)
3109               FROM {user} u
3110               JOIN ($esql) je ON je.id = u.id
3111              WHERE u.deleted = 0";
3113     return $DB->count_records_sql($sql, $params);
3117 /**
3118  * Loads the capability definitions for the component (from file).
3119  *
3120  * Loads the capability definitions for the component (from file). If no
3121  * capabilities are defined for the component, we simply return an empty array.
3122  *
3123  * @global object
3124  * @param string $component full plugin name, examples: 'moodle', 'mod_forum'
3125  * @return array array of capabilities
3126  */
3127 function load_capability_def($component) {
3128     $defpath = get_component_directory($component).'/db/access.php';
3130     $capabilities = array();
3131     if (file_exists($defpath)) {
3132         require($defpath);
3133         if (!empty(${$component.'_capabilities'})) {
3134             // BC capability array name
3135             // since 2.0 we prefer $capabilities instead - it is easier to use and matches db/* files
3136             debugging('componentname_capabilities array is deprecated, please use capabilities array only in access.php files');
3137             $capabilities = ${$component.'_capabilities'};
3138         }
3139     }
3141     return $capabilities;
3145 /**
3146  * Gets the capabilities that have been cached in the database for this component.
3147  * @param string $component - examples: 'moodle', 'mod_forum'
3148  * @return array array of capabilities
3149  */
3150 function get_cached_capabilities($component='moodle') {
3151     global $DB;
3152     return $DB->get_records('capabilities', array('component'=>$component));
3155 /**
3156  * Returns default capabilities for given role archetype.
3157  * @param string $archetype role archetype
3158  * @return array
3159  */
3160 function get_default_capabilities($archetype) {
3161     global $DB;
3163     if (!$archetype) {
3164         return array();
3165     }
3167     $alldefs = array();
3168     $defaults = array();
3169     $components = array();
3170     $allcaps = $DB->get_records('capabilities');
3172     foreach ($allcaps as $cap) {
3173         if (!in_array($cap->component, $components)) {
3174             $components[] = $cap->component;
3175             $alldefs = array_merge($alldefs, load_capability_def($cap->component));
3176         }
3177     }
3178     foreach($alldefs as $name=>$def) {
3179         // Use array 'archetypes if available. Only if not specified, use 'legacy'.
3180         if (isset($def['archetypes'])) {
3181             if (isset($def['archetypes'][$archetype])) {
3182                 $defaults[$name] = $def['archetypes'][$archetype];
3183             }
3184         // 'legacy' is for backward compatibility with 1.9 access.php
3185         } else {
3186             if (isset($def['legacy'][$archetype])) {
3187                 $defaults[$name] = $def['legacy'][$archetype];
3188             }
3189         }
3190     }
3192     return $defaults;
3195 /**
3196  * Reset role capabilities to default according to selected role archetype.
3197  * If no archetype selected, removes all capabilities.
3198  * @param int $roleid
3199  */
3200 function reset_role_capabilities($roleid) {
3201     global $DB;
3203     $role = $DB->get_record('role', array('id'=>$roleid), '*', MUST_EXIST);
3204     $defaultcaps = get_default_capabilities($role->archetype);
3206     $sitecontext = get_context_instance(CONTEXT_SYSTEM);
3208     $DB->delete_records('role_capabilities', array('roleid'=>$roleid));
3210     foreach($defaultcaps as $cap=>$permission) {
3211         assign_capability($cap, $permission, $roleid, $sitecontext->id);
3212     }
3215 /**
3216  * Updates the capabilities table with the component capability definitions.
3217  * If no parameters are given, the function updates the core moodle
3218  * capabilities.
3219  *
3220  * Note that the absence of the db/access.php capabilities definition file
3221  * will cause any stored capabilities for the component to be removed from
3222  * the database.
3223  *
3224  * @global object
3225  * @param string $component examples: 'moodle', 'mod/forum', 'block/quiz_results'
3226  * @return boolean true if success, exception in case of any problems
3227  */
3228 function update_capabilities($component='moodle') {
3229     global $DB, $OUTPUT;
3231     $storedcaps = array();
3233     $filecaps = load_capability_def($component);
3234     $cachedcaps = get_cached_capabilities($component);
3235     if ($cachedcaps) {
3236         foreach ($cachedcaps as $cachedcap) {
3237             array_push($storedcaps, $cachedcap->name);
3238             // update risk bitmasks and context levels in existing capabilities if needed
3239             if (array_key_exists($cachedcap->name, $filecaps)) {
3240                 if (!array_key_exists('riskbitmask', $filecaps[$cachedcap->name])) {
3241                     $filecaps[$cachedcap->name]['riskbitmask'] = 0; // no risk if not specified
3242                 }
3243                 if ($cachedcap->captype != $filecaps[$cachedcap->name]['captype']) {
3244                     $updatecap = new object();
3245                     $updatecap->id = $cachedcap->id;
3246                     $updatecap->captype = $filecaps[$cachedcap->name]['captype'];
3247                     $DB->update_record('capabilities', $updatecap);
3248                 }
3249                 if ($cachedcap->riskbitmask != $filecaps[$cachedcap->name]['riskbitmask']) {
3250                     $updatecap = new object();
3251                     $updatecap->id = $cachedcap->id;
3252                     $updatecap->riskbitmask = $filecaps[$cachedcap->name]['riskbitmask'];
3253                     $DB->update_record('capabilities', $updatecap);
3254                 }
3256                 if (!array_key_exists('contextlevel', $filecaps[$cachedcap->name])) {
3257                     $filecaps[$cachedcap->name]['contextlevel'] = 0; // no context level defined
3258                 }
3259                 if ($cachedcap->contextlevel != $filecaps[$cachedcap->name]['contextlevel']) {
3260                     $updatecap = new object();
3261                     $updatecap->id = $cachedcap->id;
3262                     $updatecap->contextlevel = $filecaps[$cachedcap->name]['contextlevel'];
3263                     $DB->update_record('capabilities', $updatecap);
3264                 }
3265             }
3266         }
3267     }
3269     // Are there new capabilities in the file definition?
3270     $newcaps = array();
3272     foreach ($filecaps as $filecap => $def) {
3273         if (!$storedcaps ||
3274                 ($storedcaps && in_array($filecap, $storedcaps) === false)) {
3275             if (!array_key_exists('riskbitmask', $def)) {
3276                 $def['riskbitmask'] = 0; // no risk if not specified
3277             }
3278             $newcaps[$filecap] = $def;
3279         }
3280     }
3281     // Add new capabilities to the stored definition.
3282     foreach ($newcaps as $capname => $capdef) {
3283         $capability = new object();
3284         $capability->name = $capname;
3285         $capability->captype = $capdef['captype'];
3286         $capability->contextlevel = $capdef['contextlevel'];
3287         $capability->component = $component;
3288         $capability->riskbitmask = $capdef['riskbitmask'];
3290         $DB->insert_record('capabilities', $capability, false);
3292         if (isset($capdef['clonepermissionsfrom']) && in_array($capdef['clonepermissionsfrom'], $storedcaps)){
3293             if ($rolecapabilities = $DB->get_records('role_capabilities', array('capability'=>$capdef['clonepermissionsfrom']))){
3294                 foreach ($rolecapabilities as $rolecapability){
3295                     //assign_capability will update rather than insert if capability exists
3296                     if (!assign_capability($capname, $rolecapability->permission,
3297                                             $rolecapability->roleid, $rolecapability->contextid, true)){
3298                          echo $OUTPUT->notification('Could not clone capabilities for '.$capname);
3299                     }
3300                 }
3301             }
3302         // we ignore archetype key if we have cloned permissions
3303         } else if (isset($capdef['archetypes']) && is_array($capdef['archetypes'])) {
3304             assign_legacy_capabilities($capname, $capdef['archetypes']);
3305         // 'legacy' is for backward compatibility with 1.9 access.php
3306         } else if (isset($capdef['legacy']) && is_array($capdef['legacy'])) {
3307             assign_legacy_capabilities($capname, $capdef['legacy']);
3308         }
3309     }
3310     // Are there any capabilities that have been removed from the file
3311     // definition that we need to delete from the stored capabilities and
3312     // role assignments?
3313     capabilities_cleanup($component, $filecaps);
3315     // reset static caches
3316     $ACCESSLIB_PRIVATE->capabilities = NULL;
3318     return true;
3322 /**
3323  * Deletes cached capabilities that are no longer needed by the component.
3324  * Also unassigns these capabilities from any roles that have them.
3325  *
3326  * @global object
3327  * @param string $component examples: 'moodle', 'mod/forum', 'block/quiz_results'
3328  * @param array $newcapdef array of the new capability definitions that will be
3329  *                     compared with the cached capabilities
3330  * @return int number of deprecated capabilities that have been removed
3331  */
3332 function capabilities_cleanup($component, $newcapdef=NULL) {
3333     global $DB;
3335     $removedcount = 0;
3337     if ($cachedcaps = get_cached_capabilities($component)) {
3338         foreach ($cachedcaps as $cachedcap) {
3339             if (empty($newcapdef) ||
3340                         array_key_exists($cachedcap->name, $newcapdef) === false) {
3342                 // Remove from capabilities cache.
3343                 $DB->delete_records('capabilities', array('name'=>$cachedcap->name));
3344                 $removedcount++;
3345                 // Delete from roles.
3346                 if ($roles = get_roles_with_capability($cachedcap->name)) {
3347                     foreach($roles as $role) {
3348                         if (!unassign_capability($cachedcap->name, $role->id)) {
3349                             print_error('cannotunassigncap', 'error', '', (object)array('cap'=>$cachedcap->name, 'role'=>$role->name));
3350                         }
3351                     }
3352                 }
3353             } // End if.
3354         }
3355     }
3356     return $removedcount;
3361 //////////////////
3362 // UI FUNCTIONS //
3363 //////////////////
3365 /**
3366  * @param integer $contextlevel $context->context level. One of the CONTEXT_... constants.
3367  * @return string the name for this type of context.
3368  */
3369 function get_contextlevel_name($contextlevel) {
3370     static $strcontextlevels = NULL;
3371     if (is_null($strcontextlevels)) {
3372         $strcontextlevels = array(
3373             CONTEXT_SYSTEM => get_string('coresystem'),
3374             CONTEXT_USER => get_string('user'),
3375             CONTEXT_COURSECAT => get_string('category'),
3376             CONTEXT_COURSE => get_string('course'),
3377             CONTEXT_MODULE => get_string('activitymodule'),
3378             CONTEXT_BLOCK => get_string('block')
3379         );
3380     }
3381     return $strcontextlevels[$contextlevel];
3384 /**
3385  * Prints human readable context identifier.
3386  *
3387  * @global object
3388  * @param object $context the context.
3389  * @param boolean $withprefix whether to prefix the name of the context with the
3390  *      type of context, e.g. User, Course, Forum, etc.
3391  * @param boolean $short whether to user the short name of the thing. Only applies
3392  *      to course contexts
3393  * @return string the human readable context name.
3394  */
3395 function print_context_name($context, $withprefix = true, $short = false) {
3396     global $DB;
3398     $name = '';
3399     switch ($context->contextlevel) {
3401         case CONTEXT_SYSTEM:
3402             $name = get_string('coresystem');
3403             break;
3405         case CONTEXT_USER:
3406             if ($user = $DB->get_record('user', array('id'=>$context->instanceid))) {
3407                 if ($withprefix){
3408                     $name = get_string('user').': ';
3409                 }
3410                 $name .= fullname($user);
3411             }
3412             break;
3414         case CONTEXT_COURSECAT:
3415             if ($category = $DB->get_record('course_categories', array('id'=>$context->instanceid))) {
3416                 if ($withprefix){
3417                     $name = get_string('category').': ';
3418                 }
3419                 $name .=format_string($category->name);
3420             }
3421             break;
3423         case CONTEXT_COURSE:
3424             if ($context->instanceid == SITEID) {
3425                 $name = get_string('frontpage', 'admin');
3426             } else {
3427                 if ($course = $DB->get_record('course', array('id'=>$context->instanceid))) {
3428                     if ($withprefix){
3429                         $name = get_string('course').': ';
3430                     }
3431                     if ($short){
3432                         $name .= format_string($course->shortname);
3433                     } else {
3434                         $name .= format_string($course->fullname);
3435                    }
3436                 }
3437             }
3438             break;
3440         case CONTEXT_MODULE:
3441             if ($cm = $DB->get_record_sql('SELECT cm.*, md.name AS modname FROM {course_modules} cm ' .
3442                     'JOIN {modules} md ON md.id = cm.module WHERE cm.id = ?', array($context->instanceid))) {
3443                 if ($mod = $DB->get_record($cm->modname, array('id' => $cm->instance))) {
3444                         if ($withprefix){
3445                         $name = get_string('modulename', $cm->modname).': ';
3446                         }
3447                         $name .= $mod->name;
3448                     }
3449                 }
3450             break;
3452         case CONTEXT_BLOCK:
3453             if ($blockinstance = $DB->get_record('block_instances', array('id'=>$context->instanceid))) {
3454                 global $CFG;
3455                 require_once("$CFG->dirroot/blocks/moodleblock.class.php");
3456                 require_once("$CFG->dirroot/blocks/$blockinstance->blockname/block_$blockinstance->blockname.php");
3457                 $blockname = "block_$blockinstance->blockname";
3458                 if ($blockobject = new $blockname()) {
3459                     if ($withprefix){
3460                         $name = get_string('block').': ';
3461                     }
3462                     $name .= $blockobject->title;
3463                 }
3464             }
3465             break;
3467         default:
3468             print_error('unknowncontext');
3469             return false;
3470     }
3472     return $name;
3475 /**
3476  * Get a URL for a context, if there is a natural one. For example, for
3477  * CONTEXT_COURSE, this is the course page. For CONTEXT_USER it is the
3478  * user profile page.
3479  *
3480  * @param object $context the context.
3481  * @return moodle_url
3482  */
3483 function get_context_url($context) {
3484     global $COURSE, $DB;
3486     switch ($context->contextlevel) {
3487         case CONTEXT_USER:
3488             if ($COURSE->id == SITEID) {
3489                 $url = new moodle_url('/user/profile.php', array('id'=>$context->instanceid));
3490             } else {
3491                 $url = new moodle_url('/user/view.php', array('id'=>$context->instanceid, 'courseid'=>$COURSE->id));
3492             }
3493             return $url;;
3495         case CONTEXT_COURSECAT: // Coursecat -> coursecat or site
3496             return new moodle_url('/course/category.php', array('id'=>$context->instanceid));
3498         case CONTEXT_COURSE: // 1 to 1 to course cat
3499             if ($context->instanceid != SITEID) {
3500                 return new moodle_url('/course/view.php', array('id'=>$context->instanceid));
3501             }
3502             break;
3504         case CONTEXT_MODULE: // 1 to 1 to course
3505             if ($modname = $DB->get_field_sql('SELECT md.name AS modname FROM {course_modules} cm ' .
3506                     'JOIN {modules} md ON md.id = cm.module WHERE cm.id = ?', array($context->instanceid))) {
3507                 return new moodle_url('/mod/' . $modname . '/view.php', array('id'=>$context->instanceid));
3508             }
3509             break;
3511         case CONTEXT_BLOCK:
3512             $parentcontexts = get_parent_contexts($context, false);
3513             $parent = reset($parentcontexts);
3514             $parent = get_context_instance_by_id($parent);
3515             return get_context_url($parent);
3516     }
3518     return new moodle_url('/');
3521 /**
3522  * Returns an array of all the known types of risk
3523  * The array keys can be used, for example as CSS class names, or in calls to
3524  * print_risk_icon. The values are the corresponding RISK_ constants.
3525  *
3526  * @return array all the known types of risk.
3527  */
3528 function get_all_risks() {
3529     return array(
3530         'riskmanagetrust' => RISK_MANAGETRUST,
3531         'riskconfig' => RISK_CONFIG,
3532         'riskxss' => RISK_XSS,
3533         'riskpersonal' => RISK_PERSONAL,
3534         'riskspam' => RISK_SPAM,
3535         'riskdataloss' => RISK_DATALOSS,
3536     );
3539 /**
3540  * Return a link to moodle docs for a given capability name
3541  *
3542  * @global object
3543  * @param object $capability a capability - a row from the mdl_capabilities table.
3544  * @return string the human-readable capability name as a link to Moodle Docs.
3545  */
3546 function get_capability_docs_link($capability) {
3547     global $CFG;
3548     $url = get_docs_url('Capabilities/' . $capability->name);
3549     return '<a onclick="this.target=\'docspopup\'" href="' . $url . '">' . get_capability_string($capability->name) . '</a>';
3552 /**
3553  * Extracts the relevant capabilities given a contextid.
3554  * All case based, example an instance of forum context.
3555  * Will fetch all forum related capabilities, while course contexts
3556  * Will fetch all capabilities
3557  *
3558  * capabilities
3559  * `name` varchar(150) NOT NULL,
3560  * `captype` varchar(50) NOT NULL,
3561  * `contextlevel` int(10) NOT NULL,
3562  * `component` varchar(100) NOT NULL,
3563  *
3564  * @global object
3565  * @global object
3566  * @param object context
3567  * @return array
3568  */
3569 function fetch_context_capabilities($context) {
3570     global $DB, $CFG;
3572     $sort = 'ORDER BY contextlevel,component,name';   // To group them sensibly for display
3574     $params = array();
3576     switch ($context->contextlevel) {
3578         case CONTEXT_SYSTEM: // all
3579             $SQL = "SELECT *
3580                       FROM {capabilities}";
3581         break;
3583         case CONTEXT_USER:
3584             $extracaps = array('moodle/grade:viewall');
3585             list($extra, $params) = $DB->get_in_or_equal($extracaps, SQL_PARAMS_NAMED, 'cap0');
3586             $SQL = "SELECT *
3587                       FROM {capabilities}
3588                      WHERE contextlevel = ".CONTEXT_USER."
3589                            OR name $extra";
3590         break;
3592         case CONTEXT_COURSECAT: // course category context and bellow
3593             $SQL = "SELECT *
3594                       FROM {capabilities}
3595                      WHERE contextlevel IN (".CONTEXT_COURSECAT.",".CONTEXT_COURSE.",".CONTEXT_MODULE.",".CONTEXT_BLOCK.")";
3596         break;
3598         case CONTEXT_COURSE: // course context and bellow
3599             $SQL = "SELECT *
3600                       FROM {capabilities}
3601                      WHERE contextlevel IN (".CONTEXT_COURSE.",".CONTEXT_MODULE.",".CONTEXT_BLOCK.")";
3602         break;
3604         case CONTEXT_MODULE: // mod caps
3605             $cm = $DB->get_record('course_modules', array('id'=>$context->instanceid));
3606             $module = $DB->get_record('modules', array('id'=>$cm->module));
3608             $modfile = "$CFG->dirroot/mod/$module->name/lib.php";
3609             if (file_exists($modfile)) {
3610                 include_once($modfile);
3611                 $modfunction = $module->name.'_get_extra_capabilities';
3612                 if (function_exists($modfunction)) {
3613                     $extracaps = $modfunction();
3614                 }
3615             }
3616             if(empty($extracaps)) {
3617                 $extracaps = array();
3618             }
3620             // All modules allow viewhiddenactivities. This is so you can hide
3621             // the module then override to allow specific roles to see it.
3622             // The actual check is in course page so not module-specific
3623             $extracaps[]="moodle/course:viewhiddenactivities";
3624             list($extra, $params) = $DB->get_in_or_equal(
3625                 $extracaps, SQL_PARAMS_NAMED, 'cap0');
3626             $extra = "OR name $extra";
3628             $SQL = "SELECT *
3629                       FROM {capabilities}
3630                      WHERE (contextlevel = ".CONTEXT_MODULE."
3631                            AND component = :component)
3632                            $extra";
3633             $params['component'] = "mod_$module->name";
3634         break;
3636       &nb