L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

accesslib: MDL-17647, MDL-17648 and MDL-17649 Bug fix, improvement and unit test.

Browse Source 
MDL-17647 was referring to moodle/site:candoanything insstead of moodle/site:doanything

MDL-17648 Let get_users_by_capability take an array of capabilities, like has_any_capability

MDL-17649 get_users_by_capability must have unit tests (HEAD only).

The unit tests were briefly working (apart from the system context, which I had to set up by hand in the test contexts table). Then I made the mistake of trying to upgrade the test tables, and it all went horribly wrong (MDL-17644).
This commit is contained in:
tjhunt
2008-12-15 06:22:18 +00:00
parent 081cce7325
commit 212235d3e2
2 changed files with 208 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/accesslib.php
+26 -23
View File
@@ -675,6 +675,7 @@ function path_inaccessdata($path, $accessdata) {
* AND that role has moodle/legacy:guest === 1...
* THEN we act as if we hadn't seen it.
*
* Note that this function must be kept in synch with has_capability_in_accessdata.
*
* To Do:
*
@@ -4579,7 +4580,10 @@ function get_default_course_role($course) {
* on some DBs.
*
* @param $context - object
* @param $capability - string capability
* @param $capability - string capability, or an array of capabilities, in which
* case users having any of those capabilities will be returned.
* For performance reasons, you are advised to put the capability
* that the user is most likely to have first.
* @param $fields - fields to be pulled
* @param $sort - the sort order
* @param $limitfrom - number of records to skip (offset)
@@ -4617,7 +4621,11 @@ function get_users_by_capability($context, $capability, $fields='', $sort='',
}
// What roles/rolecaps are interesting?
$caps = array($capability);
if (is_array($capability)) {
$caps = $capability;
} else {
$caps = array($capability);
}
if ($doanything === true) {
$caps[] = 'moodle/site:doanything';
$doanything_join='';
@@ -4647,15 +4655,15 @@ function get_users_by_capability($context, $capability, $fields='', $sort='',
$negperm = false; // has any negative (<0) permission?
$roleids = array();
list($caps, $params) = $DB->get_in_or_equal($caps, SQL_PARAMS_NAMED, 'cap0');
list($capstest, $params) = $DB->get_in_or_equal($caps, SQL_PARAMS_NAMED, 'cap0');
$params['capany'] = 'moodle/site:doanything';
$sql = "SELECT rc.id, rc.roleid, rc.permission, rc.capability,
ctx.depth AS ctxdepth, ctx.contextlevel AS ctxlevel
FROM {role_capabilities} rc
JOIN {context} ctx on rc.contextid = ctx.id
$doanything_join
WHERE rc.capability $caps AND ctx.id IN ($ctxids)
$doanything_join
WHERE rc.capability $capstest AND ctx.id IN ($ctxids)
$doanything_cond
ORDER BY rc.roleid ASC, ctx.depth ASC";
@@ -4911,7 +4919,7 @@ function get_users_by_capability($context, $capability, $fields='', $sort='',
// (last rec or last in page), trigger the check-permission idiom
// - the check permission idiom will
// - add the default enrolment if needed
// - call has_capability_from_rarc(), which based on RAs and RCs will return a bool
// - call has_any_capability_from_rarc(), which based on RAs and RCs will return a bool
// (should be fairly tight code ;-) )
// - if the user has permission, all is good, just $c++ (counter)
// - ...else, decrease the counter - so pagination is kept straight,
@@ -4954,7 +4962,7 @@ function get_users_by_capability($context, $capability, $fields='', $sort='',
$ras[] = array( 'roleid' => $CFG->defaultuserroleid,
'depth' => 1 );
}
if (has_capability_from_rarc($ras, $roleperms, $capability, $doanything)) {
if (has_any_capability_from_rarc($ras, $roleperms, $caps)) {
$c++;
} else {
// remove the user from the result set,
@@ -4999,7 +5007,7 @@ function get_users_by_capability($context, $capability, $fields='', $sort='',
$ras[] = array( 'roleid' => $CFG->defaultuserroleid,
'depth' => 1 );
}
if (!has_capability_from_rarc($ras, $roleperms, $capability, $doanything)) {
if (!has_any_capability_from_rarc($ras, $roleperms, $caps)) {
// remove the user from the result set,
// only if we are 'in the page'
if ($limitfrom === 0 || $c >= $limitfrom) {
@@ -5014,33 +5022,28 @@ function get_users_by_capability($context, $capability, $fields='', $sort='',
}
/**
* Fast (fast!) utility function to resolve if a capability is granted,
* based on Role Assignments and Role Capabilities.
* Fast (fast!) utility function to resolve if any of a list of capabilities is
* granted, based on Role Assignments and Role Capabilities.
*
* Used (at least) by get_users_by_capability().
*
* If PHP had fast built-in memoize functions, we could
* add a $contextid parameter and memoize the return values.
*
* Note that this function must be kept in synch with has_capability_in_accessdata.
*
* @param array $ras - role assignments
* @param array $roleperms - role permissions
* @param string $capability - name of the capability
* @param bool $doanything
* @param string $capabilities - array of capability names
* @return boolean
*
*/
function has_capability_from_rarc($ras, $roleperms, $capability, $doanything) {
function has_any_capability_from_rarc($ras, $roleperms, $caps) {
// Mini-state machine, using $hascap
// $hascap[ 'moodle/foo:bar' ]->perm = CAP_SOMETHING (numeric constant)
// $hascap[ 'moodle/foo:bar' ]->radepth = depth of the role assignment that set it
// $hascap[ 'moodle/foo:bar' ]->rcdepth = depth of the rolecap that set it
// -- when resolving conflicts, we need to look into radepth first, if unresolved
$caps = array($capability);
if ($doanything) {
$caps[] = 'moodle/site:candoanything';
}
$hascap = array();
//
@@ -5110,10 +5113,10 @@ function has_capability_from_rarc($ras, $roleperms, $capability, $doanything) {
$hascap[$cap]->perm += $rp->perm;
}
}
if ((isset($hascap[$capability]->perm) and $hascap[$capability]->perm > 0)
or ($doanything and isset($hascap['moodle/site:candoanything'])
and $hascap['moodle/site:candoanything']->perm > 0)) {
return true;
foreach ($caps as $capability) {
if (isset($hascap[$capability]) && $hascap[$capability]->perm > 0) {
return true;
}
}
return false;
}