mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-03-14 17:09:47 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Roles/Caps: Return same result from current_user_can and user_can().

Browse Source 
Ensure `current_user_can()` and `user_can()` return the same results for logged out users. For core capabilities this changes `user_can( 0, 'exist' )` to return `true` rather than `false` in line with `current_user_can( 'exist' )` for logged out users.

Convert `current_user_can()` and `current_user_can_for_blog()` to wrapper functions ultimately calling `user_can()`.

Add anonymous user to primitive capability checks as appropriate. Convert `Tests_User_Capabilities::test_other_caps_for_all_roles()` to use a data provider and add tests to check whether user exists in the database (`WP_User::exists()`) as that intentionally differs from the `exist` capability.

Props jjj, johnbillion, peterwilsoncc, SergeyBiryukov, TimothyBlynJacobs.
Fixes #52076.



git-svn-id: https://develop.svn.wordpress.org/trunk@50490 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Peter Wilson 2021-03-04 00:12:55 +00:00
parent 58fff52e45
commit f2779be7f0
3 changed files with 96 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/wp-includes/capabilities.php
View File

@ -679,6 +679,7 @@ function map_meta_cap( $cap, $user_id, ...$args ) {
* @since 2.0.0
* @since 5.3.0 Formalized the existing and already documented `...$args` parameter
* by adding it to the function signature.
* @since 5.8.0 Converted to wrapper for the user_can() function.
*
* @see WP_User::has_cap()
* @see map_meta_cap()
@ -689,13 +690,7 @@ function map_meta_cap( $cap, $user_id, ...$args ) {
* passed, whether the current user has the given meta capability for the given object.
*/
function current_user_can( $capability, ...$args ) {
$current_user = wp_get_current_user();
if ( empty( $current_user ) ) {
return false;
}
return $current_user->has_cap( $capability, ...$args );
return user_can( wp_get_current_user(), $capability, ...$args );
}
/**
@ -714,6 +709,7 @@ function current_user_can( $capability, ...$args ) {
* @since 3.0.0
* @since 5.3.0 Formalized the existing and already documented `...$args` parameter
* by adding it to the function signature.
* @since 5.8.0 Wraps current_user_can() after switching to blog.
*
* @param int $blog_id Site ID.
* @param string $capability Capability name.
@ -723,16 +719,7 @@ function current_user_can( $capability, ...$args ) {
function current_user_can_for_blog( $blog_id, $capability, ...$args ) {
$switched = is_multisite() ? switch_to_blog( $blog_id ) : false;
$current_user = wp_get_current_user();
if ( empty( $current_user ) ) {
if ( $switched ) {
restore_current_blog();
}
return false;
}
$can = $current_user->has_cap( $capability, ...$args );
$can = current_user_can( $capability, ...$args );
if ( $switched ) {
restore_current_blog();
@ -805,8 +792,10 @@ function user_can( $user, $capability, ...$args ) {
$user = get_userdata( $user );
}
if ( ! $user || ! $user->exists() ) {
return false;
if ( empty( $user ) ) {
// User is logged out, create anonymous user object.
$user = new WP_User( 0 );
$user->init( new stdClass );
}
return $user->has_cap( $capability, ...$args );

3
src/wp-includes/class-wp-user.php
View File

@ -167,6 +167,9 @@ class WP_User {
* @param int $site_id Optional. The site ID to initialize for.
*/
public function init( $data, $site_id = '' ) {
if ( ! isset( $data->ID ) ) {
$data->ID = 0;
}
$this->data = $data;
$this->ID = (int) $data->ID;

110
tests/phpunit/tests/user/capabilities.php
View File

@ -12,6 +12,7 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
* @var WP_User[] $users
*/
protected static $users = array(
'anonymous' => null,
'administrator' => null,
'editor' => null,
'author' => null,
@ -31,6 +32,7 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
self::$users = array(
'anonymous' => new WP_User( 0 ),
'administrator' => $factory->user->create_and_get( array( 'role' => 'administrator' ) ),
'editor' => $factory->user->create_and_get( array( 'role' => 'editor' ) ),
'author' => $factory->user->create_and_get( array( 'role' => 'author' ) ),
@ -342,6 +344,26 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
return $data;
}
/**
* Data provider for testing a single site install's roles.
*
* @return array[] {
* Arguments for test.
*
* @type string $role The role to test for.
* }
*/
function data_single_site_roles_to_check() {
return array(
array( 'anonymous' ),
array( 'administrator' ),
array( 'editor' ),
array( 'author' ),
array( 'contributor' ),
array( 'subscriber' ),
);
}
protected function getAllCapsAndRoles() {
return $this->getPrimitiveCapsAndRoles() + $this->getMetaCapsAndRoles();
}
@ -391,9 +413,13 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
$this->assertFalse( defined( 'ALLOW_UNFILTERED_UPLOADS' ) );
foreach ( self::$users as $role => $user ) {
// Make sure the user is valid.
$this->assertTrue( $user->exists(), "User with {$role} role does not exist" );
if ( 'anonymous' === $role ) {
// The anonymous role does not exist.
$this->assertFalse( $user->exists(), "User with {$role} role should not exist" );
} else {
// Make sure the user is valid.
$this->assertTrue( $user->exists(), "User with {$role} role does not exist" );
}
$user_caps = $user->allcaps;
@ -563,24 +589,54 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
/**
* Test miscellaneous capabilities of all user roles.
*
* @dataProvider data_single_site_roles_to_check
*/
function test_other_caps_for_all_roles() {
foreach ( self::$users as $role => $user ) {
// Make sure the user is valid.
$this->assertTrue( $user->exists(), "User with {$role} role does not exist" );
function test_other_caps_for_all_roles( $role ) {
$user = self::$users[ $role ];
$old_id = wp_get_current_user()->ID;
wp_set_current_user( $user->ID );
// Make sure the role name is correct.
$this->assertSame( array( $role ), $user->roles, "User should only have the {$role} role" );
$this->assertFalse( $user->has_cap( 'start_a_fire' ), "User with the {$role} role should not have a custom capability" );
$this->assertFalse( user_can( $user, 'start_a_fire' ), "User with the {$role} role should not have a custom capability" );
$this->assertFalse( $user->has_cap( 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability" );
$this->assertFalse( user_can( $user, 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability" );
$this->assertTrue( $user->has_cap( 'exist' ), "User with the {$role} role should have the exist capability" );
$this->assertTrue( user_can( $user, 'exist' ), "User with the {$role} role should have the exist capability" );
// Make sure the role name is correct.
$expected_roles = array( $role );
if ( 'anonymous' === $role ) {
// Anonymous role does not exist, user roles should be empty.
$expected_roles = array();
}
$this->assertSame( $expected_roles, $user->roles, "User should only have the {$role} role" );
$this->assertFalse( $user->has_cap( 'start_a_fire' ), "User with the {$role} role should not have a custom capability (test via WP_User->has_cap() method)." );
$this->assertFalse( user_can( $user, 'start_a_fire' ), "User with the {$role} role should not have a custom capability (test by user object)." );
$this->assertFalse( user_can( $user->ID, 'start_a_fire' ), "User with the {$role} role should not have a custom capability (test by user ID)." );
$this->assertFalse( current_user_can( 'start_a_fire' ), "User with the {$role} role should not have a custom capability (test by current user)." );
$this->assertFalse( $user->has_cap( 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability (test via WP_User->has_cap() method)." );
$this->assertFalse( user_can( $user, 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability (test by user object)." );
$this->assertFalse( user_can( $user->ID, 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability (test by user ID)." );
$this->assertFalse( current_user_can( 'do_not_allow' ), "User with the {$role} role should not have the do_not_allow capability (test by current user)." );
$this->assertTrue( $user->has_cap( 'exist' ), "User with the {$role} role should have the exist capability (test via WP_User->has_cap() method)." );
$this->assertTrue( user_can( $user, 'exist' ), "User with the {$role} role should have the exist capability (test by user object)." );
$this->assertTrue( user_can( $user->ID, 'exist' ), "User with the {$role} role should have the exist capability (test by user ID)." );
$this->assertTrue( current_user_can( 'exist' ), "User with the {$role} role should have the exist capability (test by current user)." );
wp_set_current_user( $old_id );
}
/**
* Test user exists/does not exist as expected.
*
* @dataProvider data_single_site_roles_to_check
*/
function test_user_exists_in_database( $role ) {
$user = self::$users[ $role ];
$expected = true;
if ( 'anonymous' === $role ) {
$expected = false;
}
$this->assertSame( $expected, $user->exists() );
}
/**
@ -595,19 +651,23 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
$user->remove_cap( 'do_not_allow' );
$this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
# Test adding the cap to the user's role
$role_obj = get_role( $role );
$role_obj->add_cap( 'do_not_allow' );
$has_cap = $user->has_cap( 'do_not_allow' );
$role_obj->remove_cap( 'do_not_allow' );
$this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
# Test adding the cap via a filter
add_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
$has_cap = $user->has_cap( 'do_not_allow' );
remove_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
$this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
if ( 'anonymous' === $role ) {
// The anonymous role does not exist.
continue;
}
# Test adding the cap to the user's role
$role_obj = get_role( $role );
$role_obj->add_cap( 'do_not_allow' );
$has_cap = $user->has_cap( 'do_not_allow' );
$role_obj->remove_cap( 'do_not_allow' );
$this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
}
}